From c7a99a6084ee5ff015fdd0ee70d0553c04f36985 Mon Sep 17 00:00:00 2001 From: Michael Rotarius Date: Tue, 15 Nov 2016 17:17:05 +0100 Subject: [PATCH] RPC Developer reference updated based on 0.12.1 I updated all changes to the RPC API from 0.11.0 to 0.12.1. An update based on 0.13.1 will follow soon. --- _autocrossref.yaml | 12 ++ _config.yml | 6 + .../devdoc/bitcoin-core/rpcs/quick-ref.md | 43 ++-- .../rpcs/rpcs/abandontransaction.md | 52 +++++ .../bitcoin-core/rpcs/rpcs/clearbanned.md | 45 +++++ .../rpcs/rpcs/createrawtransaction.md | 10 + .../bitcoin-core/rpcs/rpcs/disconnectnode.md | 52 +++++ .../rpcs/rpcs/getbestblockhash.md | 2 - .../rpcs/rpcs/getblockchaininfo.md | 170 +++++++++++++++- .../bitcoin-core/rpcs/rpcs/getblockheader.md | 183 ++++++++++++++++++ .../bitcoin-core/rpcs/rpcs/getmempoolinfo.md | 24 ++- .../bitcoin-core/rpcs/rpcs/getnetworkinfo.md | 2 - .../bitcoin-core/rpcs/rpcs/gettransaction.md | 3 +- .../bitcoin-core/rpcs/rpcs/getwalletinfo.md | 2 +- .../bitcoin-core/rpcs/rpcs/listbanned.md | 88 +++++++++ .../rpcs/rpcs/listtransactions.md | 27 ++- .../devdoc/bitcoin-core/rpcs/rpcs/setban.md | 83 ++++++++ _includes/helpers/summaries.md | 5 + _includes/helpers/vars.md | 5 + _includes/references.md | 6 + en/developer-reference.md | 12 ++ 21 files changed, 791 insertions(+), 41 deletions(-) create mode 100644 _includes/devdoc/bitcoin-core/rpcs/rpcs/abandontransaction.md create mode 100644 _includes/devdoc/bitcoin-core/rpcs/rpcs/clearbanned.md create mode 100644 _includes/devdoc/bitcoin-core/rpcs/rpcs/disconnectnode.md create mode 100644 _includes/devdoc/bitcoin-core/rpcs/rpcs/getblockheader.md create mode 100644 _includes/devdoc/bitcoin-core/rpcs/rpcs/listbanned.md create mode 100644 _includes/devdoc/bitcoin-core/rpcs/rpcs/setban.md diff --git a/_autocrossref.yaml b/_autocrossref.yaml index 59f52d02..bdf99d7a 100644 --- a/_autocrossref.yaml +++ b/_autocrossref.yaml @@ -177,12 +177,16 @@ BIP72: CVE-2012-2459: ## RPCs +'`abandontransaction`': rpc abandontransaction +'`abandontransaction` RPC': rpc abandontransaction '`addmultisigaddress`': rpc addmultisigaddress '`addmultisigaddress` RPC': rpc addmultisigaddress '`addnode`': rpc addnode '`addnode` RPC': rpc addnode '`backupwallet`': rpc backupwallet '`backupwallet` RPC': rpc backupwallet +'`clearbanned`': rpc clearbanned +'`clearbanned` RPC': rpc clearbanned '`createmultisig`': rpc createmultisig '`createmultisig` RPC': rpc createmultisig '`createrawtransaction`': rpc createrawtransaction @@ -191,6 +195,8 @@ CVE-2012-2459: '`decoderawtransaction` RPC': rpc decoderawtransaction '`decodescript`': rpc decodescript '`decodescript` RPC': rpc decodescript +'`disconnectnode`': rpc disconnectnode +'`disconnectnode` RPC': rpc disconnectnode '`dumpprivkey`': rpc dumpprivkey '`dumpprivkey` RPC': rpc dumpprivkey '`dumpwallet`': rpc dumpwallet @@ -223,6 +229,8 @@ CVE-2012-2459: '`getblockcount` RPC': rpc getblockcount '`getblockhash`': rpc getblockhash '`getblockhash` RPC': rpc getblockhash +'`getblockheader`': rpc getblockheader +'`getblockheader` RPC': rpc getblockheader '`getblocktemplate`': rpc getblocktemplate '`getblocktemplate` RPC': rpc getblocktemplate '`getchaintips`': rpc getchaintips @@ -289,6 +297,8 @@ CVE-2012-2459: '`listaccounts` RPC': rpc listaccounts '`listaddressgroupings`': rpc listaddressgroupings '`listaddressgroupings` RPC': rpc listaddressgroupings +'`listbanned`': rpc listbanned +'`listbanned` RPC': rpc listbanned '`listlockunspent`': rpc listlockunspent '`listlockunspent` RPC': rpc listlockunspent '`listreceivedbyaccount`': rpc listreceivedbyaccount @@ -320,6 +330,8 @@ CVE-2012-2459: '`sendtoaddress` RPC': rpc sendtoaddress '`setaccount`': rpc setaccount '`setaccount` RPC': rpc setaccount +'`setban`': rpc setban +'`setban` RPC': rpc setban '`setgenerate`': rpc setgenerate '`setgenerate` RPC': rpc setgenerate '`settxfee`': rpc settxfee diff --git a/_config.yml b/_config.yml index 3cc17823..ea87e555 100644 --- a/_config.yml +++ b/_config.yml @@ -247,13 +247,16 @@ devsearches: ## RPCs currently documented on Bitcoin.org. CamelCase names (with ## leading capital) for easier quick scanning "RPCs": + - 'AbandonTransaction': "/en/developer-reference#abandontransaction" - 'AddMultiSigAddress': "/en/developer-reference#addmultisigaddress" - 'AddNode': "/en/developer-reference#addnode" - 'BackupWallet': "/en/developer-reference#backupwallet" + - 'ClearBanned': "/en/developer-reference#clearbanned" - 'CreateMultisig': "/en/developer-reference#createmultisig" - 'CreateRawTransaction': "/en/developer-reference#createrawtransaction" - 'DecodeRawTransaction': "/en/developer-reference#decoderawtransaction" - 'DecodeScript': "/en/developer-reference#decodescript" + - 'DisconnectNode': "/en/developer-reference#disconnectnode" - 'DumpPrivKey': "/en/developer-reference#dumpprivkey" - 'DumpWallet': "/en/developer-reference#dumpwallet" - 'EncryptWallet': "/en/developer-reference#encryptwallet" @@ -269,6 +272,7 @@ devsearches: - 'GetBlockChainInfo': "/en/developer-reference#getblockchaininfo" - 'GetBlockCount': "/en/developer-reference#getblockcount" - 'GetBlockHash': "/en/developer-reference#getblockhash" + - 'GetBlockHeader': "/en/developer-reference#getblockheader" - 'GetBlockTemplate': "/en/developer-reference#getblocktemplate" - 'GetChainTips': "/en/developer-reference#getchaintips" - 'GetConnectionCount': "/en/developer-reference#getconnectioncount" @@ -302,6 +306,7 @@ devsearches: - 'KeypoolRefill': "/en/developer-reference#keypoolrefill" - 'ListAccounts': "/en/developer-reference#listaccounts" - 'ListAddressGroupings': "/en/developer-reference#listaddressgroupings" + - 'ListBanned': "/en/developer-reference#listbanned" - 'ListLockUnspent': "/en/developer-reference#listlockunspent" - 'ListReceivedByAccount': "/en/developer-reference#listreceivedbyaccount" - 'ListReceivedByAddress': "/en/developer-reference#listreceivedbyaddress" @@ -316,6 +321,7 @@ devsearches: - 'SendRawTransaction': "/en/developer-reference#sendrawtransaction" - 'SendToAddress': "/en/developer-reference#sendtoaddress" - 'SetAccount': "/en/developer-reference#setaccount" + - 'SetBan': "/en/developer-reference#setban" - 'SetGenerate': "/en/developer-reference#setgenerate" - 'SetTxFee': "/en/developer-reference#settxfee" - 'SignMessage': "/en/developer-reference#signmessage" diff --git a/_includes/devdoc/bitcoin-core/rpcs/quick-ref.md b/_includes/devdoc/bitcoin-core/rpcs/quick-ref.md index 57aef82f..b3a116fe 100644 --- a/_includes/devdoc/bitcoin-core/rpcs/quick-ref.md +++ b/_includes/devdoc/bitcoin-core/rpcs/quick-ref.md @@ -19,18 +19,21 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing. {% assign NEW_MASTER='**New in master**' %} {% assign UPDATED_MASTER='**Updated in master**' %} - - {% assign DEPRECATED='**Deprecated**' %} -{% assign NEW0_10_0='**New in 0.10.0**' %} -{% assign NEW0_11_0='**New in 0.11.0**' %} -{% assign UPDATED0_10_0='**Updated in 0.10.0**' %} - -{% assign NEW0_9_2='*New in 0.9.2*' %} + +{% assign UPDATED0_12_1='*Updated in 0.12.1*' %} - -{% assign NEW0_9_0='*New in 0.9.0*' %} + +{% assign NEW0_12_0='*New in 0.12.0*' %} +{% assign UPDATED0_12_0='*Updated in 0.12.0*' %} + + +{% assign NEW0_11_0='*New in 0.11.0*' %} + + +{% assign NEW0_10_0='*New in 0.10.0*' %} +{% assign UPDATED0_10_0='*Updated in 0.10.0*' %} to the specified file, which can be a directory or a path with filename." %} +{% assign summary_clearBanned="Clears list of banned nodes." %} {% assign summary_createMultiSig="creates a P2SH multi-signature address." %} {% assign summary_createRawTransaction="creates an unsigned serialized transaction that spends a previous output to a new output with a P2PKH or P2SH address. The transaction is not stored in the wallet or transmitted to the network." %} {% assign summary_decodeRawTransaction="decodes a serialized transaction hex string into a JSON object describing the transaction." %} @@ -23,6 +25,7 @@ This file is licensed under the terms of its source texts{%endcomment%} {% assign summary_getBlockChainInfo="provides information about the current state of the block chain." %} {% assign summary_getBlockCount="returns the number of blocks in the local best block chain." %} {% assign summary_getBlockHash="returns the header hash of a block at the given height in the local best block chain." %} +{% assign summary_getBlockHeader="gets a block header with a particular header hash from the local block database either as a JSON object or as a serialized block header." %} {% assign summary_getBlockTemplate="gets a block template or proposal for use with mining software." %} {% assign summary_getChainTips="returns information about the highest-height block (tip) of each local block chain." %} {% assign summary_getConnectionCount="returns the number of connections to other nodes." %} @@ -56,6 +59,7 @@ This file is licensed under the terms of its source texts{%endcomment%} {% assign summary_keyPoolRefill="fills the cache of unused pre-generated keys (the keypool)." %} {% assign summary_listAccounts="lists accounts and their balances." %} {% assign summary_listAddressGroupings="lists groups of addresses that may have had their common ownership made public by common use as inputs in the same transaction or from being used as change from a previous transaction." %} +{% assign summary_listBanned="lists all banned IPs/Subnets." %} {% assign summary_listLockUnspent="returns a list of temporarily unspendable (locked) outputs." %} {% assign summary_listReceivedByAccount="lists the total number of bitcoins received by each account." %} {% assign summary_listReceivedByAddress="lists the total number of bitcoins received by each address." %} @@ -74,6 +78,7 @@ This file is licensed under the terms of its source texts{%endcomment%} {% assign summary_sendRawTransaction="validates a transaction and broadcasts it to the peer-to-peer network." %} {% assign summary_sendToAddress="spends an amount to a given address." %} {% assign summary_setAccount="puts the specified address in the given account." %} +{% assign summary_setBan="attempts add or remove a IP/Subnet from the banned list." %} {% assign summary_setGenerate="enables or disables hashing to attempt to find the next block." %} {% assign summary_setTxFee="sets the transaction fee per kilobyte paid by transactions created by this wallet." %} {% assign summary_signMessage="signs a message with the private key of an address." %} diff --git a/_includes/helpers/vars.md b/_includes/helpers/vars.md index 86c24b41..5dd4fd92 100644 --- a/_includes/helpers/vars.md +++ b/_includes/helpers/vars.md @@ -93,6 +93,11 @@ http://opensource.org/licenses/MIT. p: "Required
(exactly 1)" d: "A Unix epoch time when the transaction was detected by the local node, or the time of the block on the local best block chain that included the transaction" +- n: "{{DEPTH}}
`bip125-replaceable`" + t: "string" + p: "Required
(exactly 1)" + d: "*Added in Bitcoin Core 0.12.0*

Indicates if a transaction is replaceable under BIP 125:
• `yes` is replaceable
• `no` not replaceable
• `unknown` for unconfirmed transactions not in the mempool" + - n: "{{DEPTH}}
`comment`" t: "string" p: "Optional
(0 or 1)" diff --git a/_includes/references.md b/_includes/references.md index 9ce26ee8..fdf11eba 100644 --- a/_includes/references.md +++ b/_includes/references.md @@ -66,13 +66,16 @@ http://opensource.org/licenses/MIT. [wallet support]: /en/developer-reference#term-wallet-support "A Bitcoin Core ./configure option that enables (default) or disables the wallet" {% comment %}{% endcomment %} +[rpc abandontransaction]: /en/developer-reference#abandontransaction [rpc addmultisigaddress]: /en/developer-reference#addmultisigaddress [rpc addnode]: /en/developer-reference#addnode [rpc backupwallet]: /en/developer-reference#backupwallet +[rpc clearbanned]: /en/developer-reference#clearbanned [rpc createmultisig]: /en/developer-reference#createmultisig [rpc createrawtransaction]: /en/developer-reference#createrawtransaction [rpc decoderawtransaction]: /en/developer-reference#decoderawtransaction [rpc decodescript]: /en/developer-reference#decodescript +[rpc disconnectnode]: /en/developer-reference#disconnectnode [rpc dumpprivkey]: /en/developer-reference#dumpprivkey [rpc dumpwallet]: /en/developer-reference#dumpwallet [rpc encryptwallet]: /en/developer-reference#encryptwallet @@ -89,6 +92,7 @@ http://opensource.org/licenses/MIT. [rpc getblockchaininfo]: /en/developer-reference#getblockchaininfo [rpc getblockcount]: /en/developer-reference#getblockcount [rpc getblockhash]: /en/developer-reference#getblockhash +[rpc getblockheader]: /en/developer-reference#getblockheader [rpc getblocktemplate]: /en/developer-reference#getblocktemplate [rpc getchaintips]: /en/developer-reference#getchaintips [rpc getconnectioncount]: /en/developer-reference#getconnectioncount @@ -122,6 +126,7 @@ http://opensource.org/licenses/MIT. [rpc keypoolrefill]: /en/developer-reference#keypoolrefill [rpc listaccounts]: /en/developer-reference#listaccounts [rpc listaddressgroupings]: /en/developer-reference#listaddressgroupings +[rpc listbanned]: /en/developer-reference#listbanned [rpc listlockunspent]: /en/developer-reference#listlockunspent [rpc listreceivedbyaccount]: /en/developer-reference#listreceivedbyaccount [rpc listreceivedbyaddress]: /en/developer-reference#listreceivedbyaddress @@ -137,6 +142,7 @@ http://opensource.org/licenses/MIT. [rpc sendrawtransaction]: /en/developer-reference#sendrawtransaction [rpc sendtoaddress]: /en/developer-reference#sendtoaddress [rpc setaccount]: /en/developer-reference#setaccount +[rpc setban]: /en/developer-reference#setban [rpc setgenerate]: /en/developer-reference#setgenerate [rpc settxfee]: /en/developer-reference#settxfee [rpc signmessage]: /en/developer-reference#signmessage diff --git a/en/developer-reference.md b/en/developer-reference.md index d8acf564..f2212a9f 100644 --- a/en/developer-reference.md +++ b/en/developer-reference.md @@ -68,12 +68,16 @@ create a cross-site scripting (XSS) exploit. To avoid problems, please treat block chain and memory pool data as an arbitrary input from an untrusted source. +{% include devdoc/bitcoin-core/rpcs/rpcs/abandontransaction.md %} + {% include devdoc/bitcoin-core/rpcs/rpcs/addmultisigaddress.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/addnode.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/backupwallet.md %} +{% include devdoc/bitcoin-core/rpcs/rpcs/clearbanned.md %} + {% include devdoc/bitcoin-core/rpcs/rpcs/createmultisig.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/createrawtransaction.md %} @@ -82,6 +86,8 @@ untrusted source. {% include devdoc/bitcoin-core/rpcs/rpcs/decodescript.md %} +{% include devdoc/bitcoin-core/rpcs/rpcs/disconnectnode.md %} + {% include devdoc/bitcoin-core/rpcs/rpcs/dumpprivkey.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/dumpwallet.md %} @@ -114,6 +120,8 @@ untrusted source. {% include devdoc/bitcoin-core/rpcs/rpcs/getblockhash.md %} +{% include devdoc/bitcoin-core/rpcs/rpcs/getblockheader.md %} + {% include devdoc/bitcoin-core/rpcs/rpcs/getblocktemplate.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/getchaintips.md %} @@ -180,6 +188,8 @@ untrusted source. {% include devdoc/bitcoin-core/rpcs/rpcs/listaddressgroupings.md %} +{% include devdoc/bitcoin-core/rpcs/rpcs/listbanned.md %} + {% include devdoc/bitcoin-core/rpcs/rpcs/listlockunspent.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/listreceivedbyaccount.md %} @@ -210,6 +220,8 @@ untrusted source. {% include devdoc/bitcoin-core/rpcs/rpcs/setaccount.md %} +{% include devdoc/bitcoin-core/rpcs/rpcs/setban.md %} + {% include devdoc/bitcoin-core/rpcs/rpcs/setgenerate.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/settxfee.md %}