Skip to content

Commit

Permalink
Devdoc RPC calls up-to-date as of 0.13.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Mirobit committed Dec 8, 2016
1 parent 5e54a9c commit 3285ca7
Show file tree
Hide file tree
Showing 42 changed files with 1,535 additions and 335 deletions.
18 changes: 18 additions & 0 deletions _autocrossref.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,8 @@ CVE-2012-2459:
'`addmultisigaddress` RPC': rpc addmultisigaddress
'`addnode`': rpc addnode
'`addnode` RPC': rpc addnode
'`addwitnessaddress`': rpc addwitnessaddress
'`addwitnessaddress` RPC': rpc addwitnessaddress
'`backupwallet`': rpc backupwallet
'`backupwallet` RPC': rpc backupwallet
'`clearbanned`': rpc clearbanned
Expand All @@ -207,8 +209,12 @@ CVE-2012-2459:
'`estimatefee` RPC': rpc estimatefee
'`estimatepriority`': rpc estimatepriority
'`estimatepriority` RPC': rpc estimatepriority
'`fundrawtransaction`': rpc fundrawtransaction
'`fundrawtransaction` RPC': rpc fundrawtransaction
'`generate`': rpc generate
'`generate` RPC': rpc generate
'`generatetoaddress`': rpc generatetoaddress
'`generatetoaddress` RPC': rpc generatetoaddress
'`getaccount`': rpc getaccount
'`getaccount` RPC': rpc getaccount
'`getaccountaddress`': rpc getaccountaddress
Expand Down Expand Up @@ -245,6 +251,12 @@ CVE-2012-2459:
'`gethashespersec` RPC': rpc gethashespersec
'`getinfo`': rpc getinfo
'`getinfo` RPC': rpc getinfo
'`getmempoolancestors`': rpc getmempoolancestors
'`getmempoolancestors` RPC': rpc getmempoolancestors
'`getmempooldescendants`': rpc getmempooldescendants
'`getmempooldescendants` RPC': rpc getmempooldescendants
'`getmempoolentry`': rpc getmempoolentry
'`getmempoolentry` RPC': rpc getmempoolentry
'`getmempoolinfo`': rpc getmempoolinfo
'`getmempoolinfo` RPC': rpc getmempoolinfo
'`getmininginfo`': rpc getmininginfo
Expand Down Expand Up @@ -289,6 +301,8 @@ CVE-2012-2459:
'`importaddress` RPC': rpc importaddress
'`importprivkey`': rpc importprivkey
'`importprivkey` RPC': rpc importprivkey
'`importprunedfunds`': rpc importprunedfunds
'`importprunedfunds` RPC': rpc importprunedfunds
'`importwallet`': rpc importwallet
'`importwallet` RPC': rpc importwallet
'`keypoolrefill`': rpc keypoolrefill
Expand Down Expand Up @@ -317,6 +331,8 @@ CVE-2012-2459:
'`move` RPC': rpc move
'`ping`': rpc ping
'`ping` RPC': rpc ping
'`removeprunedfunds`': rpc removeprunedfunds
'`removeprunedfunds` RPC': rpc removeprunedfunds
'`sendfrom`': rpc sendfrom
'`sendfrom` RPC': rpc sendfrom
'`sendheaders`': sendheaders message
Expand All @@ -338,6 +354,8 @@ CVE-2012-2459:
'`settxfee` RPC': rpc settxfee
'`signmessage`': rpc signmessage
'`signmessage` RPC': rpc signmessage
'`signmessagewithprivkey`': rpc signmessagewithprivkey
'`signmessagewithprivkey` RPC': rpc signmessagewithprivkey
'`signrawtransaction`': rpc signrawtransaction
'`signrawtransaction` RPC': rpc signrawtransaction
'`stop`': rpc stop
Expand Down
10 changes: 10 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ devsearches:
- 'AbandonTransaction': "/en/developer-reference#abandontransaction"
- 'AddMultiSigAddress': "/en/developer-reference#addmultisigaddress"
- 'AddNode': "/en/developer-reference#addnode"
- 'AddWitnessAddress': "/en/developer-reference#addwitnessaddress"
- 'BackupWallet': "/en/developer-reference#backupwallet"
- 'ClearBanned': "/en/developer-reference#clearbanned"
- 'CreateMultisig': "/en/developer-reference#createmultisig"
Expand All @@ -262,6 +263,9 @@ devsearches:
- 'EncryptWallet': "/en/developer-reference#encryptwallet"
- 'EstimateFee': "/en/developer-reference#estimatefee"
- 'EstimatePriority': "/en/developer-reference#estimatepriority"
- 'FundRawTransaction': "/en/developer-reference#fundrawtransaction"
- 'Generate': "/en/developer-reference#generate"
- 'GenerateToAddress': "/en/developer-reference#generatetoaddress"
- 'GetAccount': "/en/developer-reference#getaccount"
- 'GetAccountAddress': "/en/developer-reference#getaccountaddress"
- 'GetAddedNodeInfo': "/en/developer-reference#getaddednodeinfo"
Expand All @@ -281,6 +285,9 @@ devsearches:
- 'GetHashesPerSec': "/en/developer-reference#gethashespersec"
- 'GetInfo': "/en/developer-reference#getinfo"
- 'GetMempoolInfo': "/en/developer-reference#getmempoolinfo"
- 'GetMempoolEntry': "/en/developer-reference#getmempoolentry"
- 'GetMempoolAncestors': "/en/developer-reference#getmempoolancestors"
- 'GetMempoolDescendants': "/en/developer-reference#getmempooldescendants"
- 'GetMiningInfo': "/en/developer-reference#getmininginfo"
- 'GetNetTotals': "/en/developer-reference#getnettotals"
- 'GetNetworkHashPS': "/en/developer-reference#getnetworkhashps"
Expand All @@ -302,6 +309,7 @@ devsearches:
- 'Help': "/en/developer-reference#help"
- 'ImportAddress': "/en/developer-reference#importaddress"
- 'ImportPrivkey': "/en/developer-reference#importprivkey"
- 'ImportPrunedFunds': "/en/developer-reference#importprunedfunds"
- 'ImportWallet': "/en/developer-reference#importwallet"
- 'KeypoolRefill': "/en/developer-reference#keypoolrefill"
- 'ListAccounts': "/en/developer-reference#listaccounts"
Expand All @@ -316,6 +324,7 @@ devsearches:
- 'LockUnspent': "/en/developer-reference#lockunspent"
- 'Move': "/en/developer-reference#move"
- 'Ping': "/en/developer-reference#ping-rpc"
- 'RemovePrunedFunds': "/en/developer-reference#removeprunedfunds"
- 'SendFrom': "/en/developer-reference#sendfrom"
- 'SendMany': "/en/developer-reference#sendmany"
- 'SendRawTransaction': "/en/developer-reference#sendrawtransaction"
Expand All @@ -325,6 +334,7 @@ devsearches:
- 'SetGenerate': "/en/developer-reference#setgenerate"
- 'SetTxFee': "/en/developer-reference#settxfee"
- 'SignMessage': "/en/developer-reference#signmessage"
- 'SignMessageWithPrivKey': "/en/developer-reference#signmessagewithprivkey"
- 'SignRawTransaction': "/en/developer-reference#signrawtransaction"
- 'Stop': "/en/developer-reference#stop"
- 'SubmitBlock': "/en/developer-reference#submitblock"
Expand Down
54 changes: 35 additions & 19 deletions _includes/devdoc/bitcoin-core/rpcs/quick-ref.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
{% assign UPDATED_MASTER='**<abbr title="Updated in Bitcoin Core’s master branch (unreleased)">Updated in master</abbr>**' %}
{% assign DEPRECATED='**<abbr title="Deprecated; will be removed in a future version of Bitcoin Core">Deprecated</abbr>**' %}

<!-- Bitcoin Core 0.13.1 September 2016 -->
{% assign UPDATED0_13_1='*<abbr title="Updated in Bitcoin Core v0.13.1">Updated in 0.13.1</abbr>*' %}

<!-- Bitcoin Core 0.13.0 August 2016 -->
{% assign NEW0_13_0='*<abbr title="New in Bitcoin Core v0.13.0">New in 0.13.0</abbr>*' %}
{% assign UPDATED0_13_0='*<abbr title="Updated in Bitcoin Core v0.13.0">Updated in 0.13.0</abbr>*' %}

<!-- Bitcoin Core 0.12.1 April 2016 -->
{% assign UPDATED0_12_1='*<abbr title="Updated in Bitcoin Core v0.12.1">Updated in 0.12.1</abbr>*' %}

Expand Down Expand Up @@ -56,8 +63,11 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
* [GetBlockHeader][rpc getblockheader]: {{summary_getBlockHeader}} {{NEW0_12_0}}
* [GetChainTips][rpc getchaintips]: {{summary_getChainTips}} {{NEW0_10_0}}
* [GetDifficulty][rpc getdifficulty]: {{summary_getDifficultly}}
* [GetMemPoolAncestors][rpc getmempoolancestors]: {{summary_getMemPoolAncestors}} {{NEW0_13_0}}
* [GetMemPoolDescendants][rpc getmempooldescendants]: {{summary_getMemPoolDescendants}} {{NEW0_13_0}}
* [GetMemPoolEntry][rpc getmempoolentry]: {{summary_getMemPoolEntry}} {{NEW0_13_0}}
* [GetMemPoolInfo][rpc getmempoolinfo]: {{summary_getMemPoolInfo}} {{NEW0_10_0}}, {{UPDATED0_12_0}}
* [GetRawMemPool][rpc getrawmempool]: {{summary_getRawMemPool}}
* [GetRawMemPool][rpc getrawmempool]: {{summary_getRawMemPool}} {{UPDATED0_13_0}}
* [GetTxOut][rpc gettxout]: {{summary_getTxOut}}
* [GetTxOutProof][rpc gettxoutproof]: {{summary_getTxOutProof}} {{NEW0_11_0}}
* [GetTxOutSetInfo][rpc gettxoutsetinfo]: {{summary_getTxOutSetInfo}}
Expand All @@ -84,9 +94,8 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.

{% autocrossref %}

* [Generate][rpc generate]: {{summary_generate}} {{NEW_MASTER}}
* [GetGenerate][rpc getgenerate]: {{summary_getGenerate}}
* [SetGenerate][rpc setgenerate]: {{summary_setGenerate}} {{UPDATED_MASTER}}
* [Generate][rpc generate]: {{summary_generate}} {{NEW0_11_0}}, {{UPDATED0_13_0}}
* [GenerateToAddress][rpc generatetoaddress]: {{summary_generateToAddress}} {{NEW0_13_0}}

{% endautocrossref %}

Expand All @@ -97,7 +106,7 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
{% autocrossref %}

* [GetBlockTemplate][rpc getblocktemplate]: {{summary_getBlockTemplate}}
* [GetMiningInfo][rpc getmininginfo]: {{summary_getMiningInfo}} {{UPDATED_MASTER}}
* [GetMiningInfo][rpc getmininginfo]: {{summary_getMiningInfo}} {{UPDATED0_13_0}}
* [GetNetworkHashPS][rpc getnetworkhashps]: {{summary_getNetworkHashPS}}
* [PrioritiseTransaction][rpc prioritisetransaction]: {{summary_prioritiseTransaction}} {{NEW0_10_0}}
* [SubmitBlock][rpc submitblock]: {{summary_submitBlock}}
Expand All @@ -115,9 +124,9 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
* [DisconnectNode][rpc disconnectnode]: {{summary_disconnectNode}} {{NEW0_12_0}}
* [GetAddedNodeInfo][rpc getaddednodeinfo]: {{summary_getAddedNodeInfo}}
* [GetConnectionCount][rpc getconnectioncount]: {{summary_getConnectionCount}}
* [GetNetTotals][rpc getnettotals]: {{summary_getNetTotals}}
* [GetNetworkInfo][rpc getnetworkinfo]: {{summary_getNetworkInfo}} {{UPDATED0_10_0}}
* [GetPeerInfo][rpc getpeerinfo]: {{summary_getPeerInfo}} {{UPDATED0_10_0}}
* [GetNetTotals][rpc getnettotals]: {{summary_getNetTotals}} {{UPDATED0_12_0}}
* [GetNetworkInfo][rpc getnetworkinfo]: {{summary_getNetworkInfo}} {{UPDATED0_13_0}}
* [GetPeerInfo][rpc getpeerinfo]: {{summary_getPeerInfo}} {{UPDATED0_13_0}}
* [ListBanned][rpc listbanned]: {{summary_listBanned}} {{NEW0_12_0}}
* [Ping][rpc ping]: {{summary_ping-rpc}}
* [SetBan][rpc setban]: {{summary_setBan}} {{NEW0_12_0}}
Expand All @@ -131,6 +140,7 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
{% autocrossref %}

* [CreateRawTransaction][rpc createrawtransaction]: {{summary_createRawTransaction}} {{UPDATED0_12_0}}
* [FundRawTransaction][rpc fundrawtransaction]: {{summary_fundRawTransaction}} {{NEW0_12_0}}, {{UPDATED0_13_0}}
* [DecodeRawTransaction][rpc decoderawtransaction]: {{summary_decodeRawTransaction}}
* [DecodeScript][rpc decodescript]: {{summary_decodeScript}}
* [GetRawTransaction][rpc getrawtransaction]: {{summary_getRawTransaction}}
Expand All @@ -147,7 +157,7 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.

* [CreateMultiSig][rpc createmultisig]: {{summary_createMultiSig}}
* [EstimateFee][rpc estimatefee]: {{summary_estimateFee}} {{NEW0_10_0}}
* [EstimatePriority][rpc estimatepriority]: {{summary_estimatePriority}} {{NEW0_10_0}}
* [EstimatePriority][rpc estimatepriority]: {{summary_estimatePriority}} {{NEW0_10_0}}, {{DEPRECATED}}
* [ValidateAddress][rpc validateaddress]: {{summary_validateAddress}}
* [VerifyMessage][rpc verifymessage]: {{summary_verifyMessage}}

Expand All @@ -164,42 +174,46 @@ with [wallet support][]{:#term-wallet-support}{:.term}, which is the
default.

* [AbandonTransaction][rpc abandontransaction]: {{summary_abandonTransaction}} {{NEW0_12_0}}
* [AddWitnessAddress][rpc addwitnessaddress]: {{summary_addWitnessAddress}} {{NEW0_13_0}}
* [AddMultiSigAddress][rpc addmultisigaddress]: {{summary_addMultiSigAddress}}
* [BackupWallet][rpc backupwallet]: {{summary_backupWallet}}
* [DumpPrivKey][rpc dumpprivkey]: {{summary_dumpPrivKey}}
* [DumpWallet][rpc dumpwallet]: {{summary_dumpWallet}}
* [EncryptWallet][rpc encryptwallet]: {{summary_encryptWallet}}
* [GetAccountAddress][rpc getaccountaddress]: {{summary_getAccountAddress}}
* [GetAccountAddress][rpc getaccountaddress]: {{summary_getAccountAddress}} {{DEPRECATED}}
* [GetAccount][rpc getaccount]: {{summary_getAccount}}
* [GetAddressesByAccount][rpc getaddressesbyaccount]: {{summary_getAddressesByAccount}}
* [GetAddressesByAccount][rpc getaddressesbyaccount]: {{summary_getAddressesByAccount}} {{DEPRECATED}}
* [GetBalance][rpc getbalance]: {{summary_getBalance}}
* [GetNewAddress][rpc getnewaddress]: {{summary_getNewAddress}}
* [GetRawChangeAddress][rpc getrawchangeaddress]: {{summary_getRawChangeAddress}}
* [GetReceivedByAccount][rpc getreceivedbyaccount]: {{summary_getReceivedByAccount}}
* [GetReceivedByAccount][rpc getreceivedbyaccount]: {{summary_getReceivedByAccount}} {{DEPRECATED}}
* [GetReceivedByAddress][rpc getreceivedbyaddress]: {{summary_getReceivedByAddress}}
* [GetTransaction][rpc gettransaction]: {{summary_getTransaction}} {{UPDATED0_12_0}}
* [GetUnconfirmedBalance][rpc getunconfirmedbalance]: {{summary_getUnconfirmedBalance}}
* [GetWalletInfo][rpc getwalletinfo]: {{summary_getWalletInfo}}
* [ImportAddress][rpc importaddress]: {{summary_importAddress}} {{NEW0_10_0}}
* [ImportPrunedFunds][rpc importprunedfunds]: {{summary_importPrunedFunds}} {{NEW0_13_0}}
* [ImportPrivKey][rpc importprivkey]: {{summary_importPrivKey}}
* [ImportWallet][rpc importwallet]: {{summary_importWallet}}
* [KeyPoolRefill][rpc keypoolrefill]: {{summary_keyPoolRefill}}
* [ListAccounts][rpc listaccounts]: {{summary_listAccounts}} {{UPDATED0_10_0}}
* [ListAccounts][rpc listaccounts]: {{summary_listAccounts}} {{UPDATED0_10_0}}, {{DEPRECATED}}
* [ListAddressGroupings][rpc listaddressgroupings]: {{summary_listAddressGroupings}}
* [ListLockUnspent][rpc listlockunspent]: {{summary_listLockUnspent}}
* [ListReceivedByAccount][rpc listreceivedbyaccount]: {{summary_listReceivedByAccount}} {{UPDATED0_10_0}}
* [ListReceivedByAccount][rpc listreceivedbyaccount]: {{summary_listReceivedByAccount}} {{UPDATED0_10_0}}, {{DEPRECATED}}
* [ListReceivedByAddress][rpc listreceivedbyaddress]: {{summary_listReceivedByAddress}} {{UPDATED0_10_0}}
* [ListSinceBlock][rpc listsinceblock]: {{summary_listSinceBlock}} {{UPDATED0_10_0}}
* [ListTransactions][rpc listtransactions]: {{summary_listTransactions}} {{UPDATED0_12_1}}
* [ListUnspent][rpc listunspent]: {{summary_listUnspent}} {{UPDATED0_10_0}}
* [ListUnspent][rpc listunspent]: {{summary_listUnspent}} {{UPDATED0_13_0}}
* [LockUnspent][rpc lockunspent]: {{summary_lockUnspent}}
* [Move][rpc move]: {{summary_move}}
* [SendFrom][rpc sendfrom]: {{summary_sendFrom}}
* [Move][rpc move]: {{summary_move}} {{DEPRECATED}}
* [RemovePrunedFunds][rpc removeprunedfunds]: {{summary_removePrunedFunds}} {{NEW0_13_0}}
* [SendFrom][rpc sendfrom]: {{summary_sendFrom}} {{DEPRECATED}}
* [SendMany][rpc sendmany]: {{summary_sendMany}}
* [SendToAddress][rpc sendtoaddress]: {{summary_sendToAddress}}
* [SetAccount][rpc setaccount]: {{summary_setAccount}}
* [SetAccount][rpc setaccount]: {{summary_setAccount}} {{DEPRECATED}}
* [SetTxFee][rpc settxfee]: {{summary_setTxFee}}
* [SignMessage][rpc signmessage]: {{summary_signMessage}}
* [SignMessage][rpc signmessage]: {{summary_signMessage}}
* [SignMessageWithPrivKey][rpc signmessagewithprivkey]: {{summary_signMessageWithPrivKey}} {{NEW0_13_0}}
* [WalletLock][rpc walletlock]: {{summary_walletLock}}
* [WalletPassphrase][rpc walletpassphrase]: {{summary_walletPassphrase}}
* [WalletPassphraseChange][rpc walletpassphrasechange]: {{summary_walletPassphraseChange}}
Expand All @@ -212,7 +226,9 @@ default.

{% autocrossref %}

* [GetGenerate][rpc getgenerate]: {{summary_getGenerate}}
* [GetHashesPerSec][rpc gethashespersec]: {{summary_getHashesPerSec}}
* [GetWork][rpc getwork]: {{summary_getWork}}
* [SetGenerate][rpc setgenerate]: {{summary_setGenerate}}

{% endautocrossref %}
58 changes: 58 additions & 0 deletions _includes/devdoc/bitcoin-core/rpcs/rpcs/addwitnessaddress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
{% comment %}
This file is licensed under the MIT License (MIT) available on
http://opensource.org/licenses/MIT.
{% endcomment %}
{% assign filename="_includes/devdoc/bitcoin-core/rpcs/rpcs/addwitnessaddress.md" %}

##### AddWitnessAddress
{% include helpers/subhead-links.md %}

{% assign summary_addWitnessAddress="adds a witness address for a script (with pubkey or redeemscript known)." %}

{% autocrossref %}

*Added in Bitcoin Core 0.13.0*

*Requires wallet support. Requires an unlocked wallet or an
unencrypted wallet.*

The `addwitnessaddress` RPC {{summary_addWitnessAddress}}

*Parameter #1---the witness address*

{% itemplate ntpd1 %}
- n: "Address"
t: "string (base58)"
p: "Required<br>(exactly 1)"
d: "A witness address that gets added to a script. Needs to be in the wallet and uncompressed"

{% enditemplate %}

*Result---the witness script*

{% itemplate ntpd1 %}
- n: "`result`"
t: "string (base58)"
p: "Required<br>(exactly 1)"
d: "The value of the new address (P2SH of witness script)"

{% enditemplate %}

*Example from Bitcoin Core 0.13.1*

{% highlight bash %}
bitcoin-cli addwitnessaddress 1BRo7qrYHMPrzdBDzfjmzteBdYAyTMXW75
{% endhighlight %}

Result:

The RPC is disabled by default on mainet as long as Segregated Witness has not been activated.
`-walletprematurewitness` enables the RPC.

{% highlight text %}
3LfAujMsBHgQKoxLn59dVbeYPmfUrHSAQb
{% endhighlight %}

*See also*

{% endautocrossref %}
3 changes: 3 additions & 0 deletions _includes/devdoc/bitcoin-core/rpcs/rpcs/estimatepriority.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ http://opensource.org/licenses/MIT.

The `estimatepriority` RPC {{summary_estimatePriority}}

{{WARNING}} `estimatepriority` will be removed in a later version of Bitcoin
Core. Use the RPCs listed in the See Also subsection below instead.

Transaction priority is relative to a transaction's byte size.

*Parameter #1---how many blocks the transaction may wait before being included as a free high-priority transaction*
Expand Down
Loading

0 comments on commit 3285ca7

Please sign in to comment.