Merge pull request #1410 from Mirobit/refupdate11/16

RPC Developer reference updated based on 0.12.1
This commit is contained in:
Cøbra 2016-12-01 23:30:25 +00:00 committed by GitHub
commit c24a5aa2dd
21 changed files with 787 additions and 42 deletions

View file

@ -177,12 +177,16 @@ BIP72:
CVE-2012-2459: CVE-2012-2459:
## RPCs ## RPCs
'`abandontransaction`': rpc abandontransaction
'`abandontransaction` RPC': rpc abandontransaction
'`addmultisigaddress`': rpc addmultisigaddress '`addmultisigaddress`': rpc addmultisigaddress
'`addmultisigaddress` RPC': rpc addmultisigaddress '`addmultisigaddress` RPC': rpc addmultisigaddress
'`addnode`': rpc addnode '`addnode`': rpc addnode
'`addnode` RPC': rpc addnode '`addnode` RPC': rpc addnode
'`backupwallet`': rpc backupwallet '`backupwallet`': rpc backupwallet
'`backupwallet` RPC': rpc backupwallet '`backupwallet` RPC': rpc backupwallet
'`clearbanned`': rpc clearbanned
'`clearbanned` RPC': rpc clearbanned
'`createmultisig`': rpc createmultisig '`createmultisig`': rpc createmultisig
'`createmultisig` RPC': rpc createmultisig '`createmultisig` RPC': rpc createmultisig
'`createrawtransaction`': rpc createrawtransaction '`createrawtransaction`': rpc createrawtransaction
@ -191,6 +195,8 @@ CVE-2012-2459:
'`decoderawtransaction` RPC': rpc decoderawtransaction '`decoderawtransaction` RPC': rpc decoderawtransaction
'`decodescript`': rpc decodescript '`decodescript`': rpc decodescript
'`decodescript` RPC': rpc decodescript '`decodescript` RPC': rpc decodescript
'`disconnectnode`': rpc disconnectnode
'`disconnectnode` RPC': rpc disconnectnode
'`dumpprivkey`': rpc dumpprivkey '`dumpprivkey`': rpc dumpprivkey
'`dumpprivkey` RPC': rpc dumpprivkey '`dumpprivkey` RPC': rpc dumpprivkey
'`dumpwallet`': rpc dumpwallet '`dumpwallet`': rpc dumpwallet
@ -223,6 +229,8 @@ CVE-2012-2459:
'`getblockcount` RPC': rpc getblockcount '`getblockcount` RPC': rpc getblockcount
'`getblockhash`': rpc getblockhash '`getblockhash`': rpc getblockhash
'`getblockhash` RPC': rpc getblockhash '`getblockhash` RPC': rpc getblockhash
'`getblockheader`': rpc getblockheader
'`getblockheader` RPC': rpc getblockheader
'`getblocktemplate`': rpc getblocktemplate '`getblocktemplate`': rpc getblocktemplate
'`getblocktemplate` RPC': rpc getblocktemplate '`getblocktemplate` RPC': rpc getblocktemplate
'`getchaintips`': rpc getchaintips '`getchaintips`': rpc getchaintips
@ -289,6 +297,8 @@ CVE-2012-2459:
'`listaccounts` RPC': rpc listaccounts '`listaccounts` RPC': rpc listaccounts
'`listaddressgroupings`': rpc listaddressgroupings '`listaddressgroupings`': rpc listaddressgroupings
'`listaddressgroupings` RPC': rpc listaddressgroupings '`listaddressgroupings` RPC': rpc listaddressgroupings
'`listbanned`': rpc listbanned
'`listbanned` RPC': rpc listbanned
'`listlockunspent`': rpc listlockunspent '`listlockunspent`': rpc listlockunspent
'`listlockunspent` RPC': rpc listlockunspent '`listlockunspent` RPC': rpc listlockunspent
'`listreceivedbyaccount`': rpc listreceivedbyaccount '`listreceivedbyaccount`': rpc listreceivedbyaccount
@ -320,6 +330,8 @@ CVE-2012-2459:
'`sendtoaddress` RPC': rpc sendtoaddress '`sendtoaddress` RPC': rpc sendtoaddress
'`setaccount`': rpc setaccount '`setaccount`': rpc setaccount
'`setaccount` RPC': rpc setaccount '`setaccount` RPC': rpc setaccount
'`setban`': rpc setban
'`setban` RPC': rpc setban
'`setgenerate`': rpc setgenerate '`setgenerate`': rpc setgenerate
'`setgenerate` RPC': rpc setgenerate '`setgenerate` RPC': rpc setgenerate
'`settxfee`': rpc settxfee '`settxfee`': rpc settxfee

View file

@ -247,13 +247,16 @@ devsearches:
## RPCs currently documented on Bitcoin.org. CamelCase names (with ## RPCs currently documented on Bitcoin.org. CamelCase names (with
## leading capital) for easier quick scanning ## leading capital) for easier quick scanning
"RPCs": "RPCs":
- 'AbandonTransaction': "/en/developer-reference#abandontransaction"
- 'AddMultiSigAddress': "/en/developer-reference#addmultisigaddress" - 'AddMultiSigAddress': "/en/developer-reference#addmultisigaddress"
- 'AddNode': "/en/developer-reference#addnode" - 'AddNode': "/en/developer-reference#addnode"
- 'BackupWallet': "/en/developer-reference#backupwallet" - 'BackupWallet': "/en/developer-reference#backupwallet"
- 'ClearBanned': "/en/developer-reference#clearbanned"
- 'CreateMultisig': "/en/developer-reference#createmultisig" - 'CreateMultisig': "/en/developer-reference#createmultisig"
- 'CreateRawTransaction': "/en/developer-reference#createrawtransaction" - 'CreateRawTransaction': "/en/developer-reference#createrawtransaction"
- 'DecodeRawTransaction': "/en/developer-reference#decoderawtransaction" - 'DecodeRawTransaction': "/en/developer-reference#decoderawtransaction"
- 'DecodeScript': "/en/developer-reference#decodescript" - 'DecodeScript': "/en/developer-reference#decodescript"
- 'DisconnectNode': "/en/developer-reference#disconnectnode"
- 'DumpPrivKey': "/en/developer-reference#dumpprivkey" - 'DumpPrivKey': "/en/developer-reference#dumpprivkey"
- 'DumpWallet': "/en/developer-reference#dumpwallet" - 'DumpWallet': "/en/developer-reference#dumpwallet"
- 'EncryptWallet': "/en/developer-reference#encryptwallet" - 'EncryptWallet': "/en/developer-reference#encryptwallet"
@ -269,6 +272,7 @@ devsearches:
- 'GetBlockChainInfo': "/en/developer-reference#getblockchaininfo" - 'GetBlockChainInfo': "/en/developer-reference#getblockchaininfo"
- 'GetBlockCount': "/en/developer-reference#getblockcount" - 'GetBlockCount': "/en/developer-reference#getblockcount"
- 'GetBlockHash': "/en/developer-reference#getblockhash" - 'GetBlockHash': "/en/developer-reference#getblockhash"
- 'GetBlockHeader': "/en/developer-reference#getblockheader"
- 'GetBlockTemplate': "/en/developer-reference#getblocktemplate" - 'GetBlockTemplate': "/en/developer-reference#getblocktemplate"
- 'GetChainTips': "/en/developer-reference#getchaintips" - 'GetChainTips': "/en/developer-reference#getchaintips"
- 'GetConnectionCount': "/en/developer-reference#getconnectioncount" - 'GetConnectionCount': "/en/developer-reference#getconnectioncount"
@ -302,6 +306,7 @@ devsearches:
- 'KeypoolRefill': "/en/developer-reference#keypoolrefill" - 'KeypoolRefill': "/en/developer-reference#keypoolrefill"
- 'ListAccounts': "/en/developer-reference#listaccounts" - 'ListAccounts': "/en/developer-reference#listaccounts"
- 'ListAddressGroupings': "/en/developer-reference#listaddressgroupings" - 'ListAddressGroupings': "/en/developer-reference#listaddressgroupings"
- 'ListBanned': "/en/developer-reference#listbanned"
- 'ListLockUnspent': "/en/developer-reference#listlockunspent" - 'ListLockUnspent': "/en/developer-reference#listlockunspent"
- 'ListReceivedByAccount': "/en/developer-reference#listreceivedbyaccount" - 'ListReceivedByAccount': "/en/developer-reference#listreceivedbyaccount"
- 'ListReceivedByAddress': "/en/developer-reference#listreceivedbyaddress" - 'ListReceivedByAddress': "/en/developer-reference#listreceivedbyaddress"
@ -316,6 +321,7 @@ devsearches:
- 'SendRawTransaction': "/en/developer-reference#sendrawtransaction" - 'SendRawTransaction': "/en/developer-reference#sendrawtransaction"
- 'SendToAddress': "/en/developer-reference#sendtoaddress" - 'SendToAddress': "/en/developer-reference#sendtoaddress"
- 'SetAccount': "/en/developer-reference#setaccount" - 'SetAccount': "/en/developer-reference#setaccount"
- 'SetBan': "/en/developer-reference#setban"
- 'SetGenerate': "/en/developer-reference#setgenerate" - 'SetGenerate': "/en/developer-reference#setgenerate"
- 'SetTxFee': "/en/developer-reference#settxfee" - 'SetTxFee': "/en/developer-reference#settxfee"
- 'SignMessage': "/en/developer-reference#signmessage" - 'SignMessage': "/en/developer-reference#signmessage"

View file

@ -19,18 +19,21 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
<!-- master --> <!-- master -->
{% assign NEW_MASTER='**<abbr title="New in Bitcoin Cores master branch (unreleased)">New in master</abbr>**' %} {% assign NEW_MASTER='**<abbr title="New in Bitcoin Cores master branch (unreleased)">New in master</abbr>**' %}
{% assign UPDATED_MASTER='**<abbr title="Updated in Bitcoin Cores master branch (unreleased)">Updated in master</abbr>**' %} {% assign UPDATED_MASTER='**<abbr title="Updated in Bitcoin Cores master branch (unreleased)">Updated in master</abbr>**' %}
<!-- Bitcoin Core 0.10.0 expected January 2015 -->
{% assign DEPRECATED='**<abbr title="Deprecated; will be removed in a future version of Bitcoin Core">Deprecated</abbr>**' %} {% assign DEPRECATED='**<abbr title="Deprecated; will be removed in a future version of Bitcoin Core">Deprecated</abbr>**' %}
{% assign NEW0_10_0='**<abbr title="New in Bitcoin Core v0.10.0">New in 0.10.0</abbr>**' %}
{% assign NEW0_11_0='**<abbr title="New in Bitcoin Core v0.11.0">New in 0.11.0</abbr>**' %}
{% assign UPDATED0_10_0='**<abbr title="Updated in Bitcoin Core v0.10.0">Updated in 0.10.0</abbr>**' %}
<!-- Bitcoin Core 0.9.2 June 2014 --> <!-- Bitcoin Core 0.12.1 April 2016 -->
{% assign NEW0_9_2='*<abbr title="New in Bitcoin Core v0.9.2">New in 0.9.2</abbr>*' %} {% assign UPDATED0_12_1='*<abbr title="Updated in Bitcoin Core v0.12.1">Updated in 0.12.1</abbr>*' %}
<!-- Bitcoin Core 0.9.0 March 2014 --> <!-- Bitcoin Core 0.12.0 February 2016 -->
{% assign NEW0_9_0='*<abbr title="New in Bitcoin Core v0.9.0">New in 0.9.0</abbr>*' %} {% assign NEW0_12_0='*<abbr title="New in Bitcoin Core v0.12.0">New in 0.12.0</abbr>*' %}
{% assign UPDATED0_12_0='*<abbr title="Updated in Bitcoin Core v0.12.0">Updated in 0.12.0</abbr>*' %}
<!-- Bitcoin Core 0.11.0 July 2015 -->
{% assign NEW0_11_0='*<abbr title="New in Bitcoin Core v0.11.0">New in 0.11.0</abbr>*' %}
<!-- Bitcoin Core 0.10.0 February 2015 -->
{% assign NEW0_10_0='*<abbr title="New in Bitcoin Core v0.10.0">New in 0.10.0</abbr>*' %}
{% assign UPDATED0_10_0='*<abbr title="Updated in Bitcoin Core v0.10.0">Updated in 0.10.0</abbr>*' %}
<!-- the summaries used below are defined in the files for the <!-- the summaries used below are defined in the files for the
particular RPC and aggregated into this helper file by the makefile particular RPC and aggregated into this helper file by the makefile
@ -45,14 +48,15 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
{% autocrossref %} {% autocrossref %}
* [GetBestBlockHash][rpc getbestblockhash]: {{summary_getBestBlockHash}} {{NEW0_9_0}} * [GetBestBlockHash][rpc getbestblockhash]: {{summary_getBestBlockHash}}
* [GetBlock][rpc getblock]: {{summary_getBlock}} * [GetBlock][rpc getblock]: {{summary_getBlock}}
* [GetBlockChainInfo][rpc getblockchaininfo]: {{summary_getBlockChainInfo}} {{NEW0_9_2}}, {{UPDATED0_10_0}} * [GetBlockChainInfo][rpc getblockchaininfo]: {{summary_getBlockChainInfo}} {{UPDATED0_12_1}}
* [GetBlockCount][rpc getblockcount]: {{summary_getBlockCount}} * [GetBlockCount][rpc getblockcount]: {{summary_getBlockCount}}
* [GetBlockHash][rpc getblockhash]: {{summary_getBlockHash}} * [GetBlockHash][rpc getblockhash]: {{summary_getBlockHash}}
* [GetBlockHeader][rpc getblockheader]: {{summary_getBlockHeader}} {{NEW0_12_0}}
* [GetChainTips][rpc getchaintips]: {{summary_getChainTips}} {{NEW0_10_0}} * [GetChainTips][rpc getchaintips]: {{summary_getChainTips}} {{NEW0_10_0}}
* [GetDifficulty][rpc getdifficulty]: {{summary_getDifficultly}} * [GetDifficulty][rpc getdifficulty]: {{summary_getDifficultly}}
* [GetMemPoolInfo][rpc getmempoolinfo]: {{summary_getMemPoolInfo}} {{NEW0_10_0}} * [GetMemPoolInfo][rpc getmempoolinfo]: {{summary_getMemPoolInfo}} {{NEW0_10_0}}, {{UPDATED0_12_0}}
* [GetRawMemPool][rpc getrawmempool]: {{summary_getRawMemPool}} * [GetRawMemPool][rpc getrawmempool]: {{summary_getRawMemPool}}
* [GetTxOut][rpc gettxout]: {{summary_getTxOut}} * [GetTxOut][rpc gettxout]: {{summary_getTxOut}}
* [GetTxOutProof][rpc gettxoutproof]: {{summary_getTxOutProof}} {{NEW0_11_0}} * [GetTxOutProof][rpc gettxoutproof]: {{summary_getTxOutProof}} {{NEW0_11_0}}
@ -107,12 +111,16 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
{% autocrossref %} {% autocrossref %}
* [AddNode][rpc addnode]: {{summary_addNode}} * [AddNode][rpc addnode]: {{summary_addNode}}
* [ClearBanned][rpc clearbanned]: {{summary_clearBanned}} {{NEW0_12_0}}
* [DisconnectNode][rpc disconnectnode]: {{summary_disconnectNode}} {{NEW0_12_0}}
* [GetAddedNodeInfo][rpc getaddednodeinfo]: {{summary_getAddedNodeInfo}} * [GetAddedNodeInfo][rpc getaddednodeinfo]: {{summary_getAddedNodeInfo}}
* [GetConnectionCount][rpc getconnectioncount]: {{summary_getConnectionCount}} * [GetConnectionCount][rpc getconnectioncount]: {{summary_getConnectionCount}}
* [GetNetTotals][rpc getnettotals]: {{summary_getNetTotals}} * [GetNetTotals][rpc getnettotals]: {{summary_getNetTotals}}
* [GetNetworkInfo][rpc getnetworkinfo]: {{summary_getNetworkInfo}} {{NEW0_9_2}}, {{UPDATED0_10_0}} * [GetNetworkInfo][rpc getnetworkinfo]: {{summary_getNetworkInfo}} {{UPDATED0_10_0}}
* [GetPeerInfo][rpc getpeerinfo]: {{summary_getPeerInfo}} {{UPDATED0_10_0}} * [GetPeerInfo][rpc getpeerinfo]: {{summary_getPeerInfo}} {{UPDATED0_10_0}}
* [ListBanned][rpc listbanned]: {{summary_listBanned}} {{NEW0_12_0}}
* [Ping][rpc ping]: {{summary_ping-rpc}} * [Ping][rpc ping]: {{summary_ping-rpc}}
* [SetBan][rpc setban]: {{summary_setBan}} {{NEW0_12_0}}
{% endautocrossref %} {% endautocrossref %}
@ -122,7 +130,7 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
{% autocrossref %} {% autocrossref %}
* [CreateRawTransaction][rpc createrawtransaction]: {{summary_createRawTransaction}} * [CreateRawTransaction][rpc createrawtransaction]: {{summary_createRawTransaction}} {{UPDATED0_12_0}}
* [DecodeRawTransaction][rpc decoderawtransaction]: {{summary_decodeRawTransaction}} * [DecodeRawTransaction][rpc decoderawtransaction]: {{summary_decodeRawTransaction}}
* [DecodeScript][rpc decodescript]: {{summary_decodeScript}} * [DecodeScript][rpc decodescript]: {{summary_decodeScript}}
* [GetRawTransaction][rpc getrawtransaction]: {{summary_getRawTransaction}} * [GetRawTransaction][rpc getrawtransaction]: {{summary_getRawTransaction}}
@ -155,6 +163,7 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
with [wallet support][]{:#term-wallet-support}{:.term}, which is the with [wallet support][]{:#term-wallet-support}{:.term}, which is the
default. default.
* [AbandonTransaction][rpc abandontransaction]: {{summary_abandonTransaction}} {{NEW0_12_0}}
* [AddMultiSigAddress][rpc addmultisigaddress]: {{summary_addMultiSigAddress}} * [AddMultiSigAddress][rpc addmultisigaddress]: {{summary_addMultiSigAddress}}
* [BackupWallet][rpc backupwallet]: {{summary_backupWallet}} * [BackupWallet][rpc backupwallet]: {{summary_backupWallet}}
* [DumpPrivKey][rpc dumpprivkey]: {{summary_dumpPrivKey}} * [DumpPrivKey][rpc dumpprivkey]: {{summary_dumpPrivKey}}
@ -168,9 +177,9 @@ default.
* [GetRawChangeAddress][rpc getrawchangeaddress]: {{summary_getRawChangeAddress}} * [GetRawChangeAddress][rpc getrawchangeaddress]: {{summary_getRawChangeAddress}}
* [GetReceivedByAccount][rpc getreceivedbyaccount]: {{summary_getReceivedByAccount}} * [GetReceivedByAccount][rpc getreceivedbyaccount]: {{summary_getReceivedByAccount}}
* [GetReceivedByAddress][rpc getreceivedbyaddress]: {{summary_getReceivedByAddress}} * [GetReceivedByAddress][rpc getreceivedbyaddress]: {{summary_getReceivedByAddress}}
* [GetTransaction][rpc gettransaction]: {{summary_getTransaction}} {{UPDATED0_10_0}} * [GetTransaction][rpc gettransaction]: {{summary_getTransaction}} {{UPDATED0_12_0}}
* [GetUnconfirmedBalance][rpc getunconfirmedbalance]: {{summary_getUnconfirmedBalance}} * [GetUnconfirmedBalance][rpc getunconfirmedbalance]: {{summary_getUnconfirmedBalance}}
* [GetWalletInfo][rpc getwalletinfo]: {{summary_getWalletInfo}} {{NEW0_9_2}} * [GetWalletInfo][rpc getwalletinfo]: {{summary_getWalletInfo}}
* [ImportAddress][rpc importaddress]: {{summary_importAddress}} {{NEW0_10_0}} * [ImportAddress][rpc importaddress]: {{summary_importAddress}} {{NEW0_10_0}}
* [ImportPrivKey][rpc importprivkey]: {{summary_importPrivKey}} * [ImportPrivKey][rpc importprivkey]: {{summary_importPrivKey}}
* [ImportWallet][rpc importwallet]: {{summary_importWallet}} * [ImportWallet][rpc importwallet]: {{summary_importWallet}}
@ -181,7 +190,7 @@ default.
* [ListReceivedByAccount][rpc listreceivedbyaccount]: {{summary_listReceivedByAccount}} {{UPDATED0_10_0}} * [ListReceivedByAccount][rpc listreceivedbyaccount]: {{summary_listReceivedByAccount}} {{UPDATED0_10_0}}
* [ListReceivedByAddress][rpc listreceivedbyaddress]: {{summary_listReceivedByAddress}} {{UPDATED0_10_0}} * [ListReceivedByAddress][rpc listreceivedbyaddress]: {{summary_listReceivedByAddress}} {{UPDATED0_10_0}}
* [ListSinceBlock][rpc listsinceblock]: {{summary_listSinceBlock}} {{UPDATED0_10_0}} * [ListSinceBlock][rpc listsinceblock]: {{summary_listSinceBlock}} {{UPDATED0_10_0}}
* [ListTransactions][rpc listtransactions]: {{summary_listTransactions}} {{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_10_0}}
* [LockUnspent][rpc lockunspent]: {{summary_lockUnspent}} * [LockUnspent][rpc lockunspent]: {{summary_lockUnspent}}
* [Move][rpc move]: {{summary_move}} * [Move][rpc move]: {{summary_move}}

View file

@ -0,0 +1,52 @@
{% 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/abandontransaction.md" %}
##### AbandonTransaction
{% include helpers/subhead-links.md %}
{% assign summary_abandonTransaction="marks an in-wallet transaction and all its in-wallet descendants as abandoned. This allows their inputs to be respent." %}
{% autocrossref %}
*Added in Bitcoin Core 0.12.0*
The `abandontransaction` RPC {{summary_abandonTransaction}}
*Parameter #1---a transaction identifier (TXID)*
{% itemplate ntpd1 %}
- n: "TXID"
t: "string (hex)"
p: "Required<br>(exactly 1)"
d: "The TXID of the transaction that you want to abandon. The TXID must be encoded as hex in RPC byte order"
{% enditemplate %}
*Result---`null` on success*
{% itemplate ntpd1 %}
- n: "`result`"
t: "null"
p: "Required<br>(exactly 1)"
d: "JSON `null` when the transaction and all descendants were abandoned"
{% enditemplate %}
*Example from Bitcoin Core 0.13.1*
Abandons the transaction on your node.
{% highlight bash %}
bitcoin-cli abandontransaction fa3970c341c9f5de6ab13f128cbfec58d732e736a505fe32137ad551c799ecc4
{% endhighlight %}
Result (no output from `bitcoin-cli` because result is set to `null`).
*See also*
* [SendRawTransaction][rpc sendrawtransaction]: {{summary_sendRawTransaction}}
{% endautocrossref %}

View file

@ -0,0 +1,45 @@
{% 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/clearbanned.md" %}
##### ClearBanned
{% include helpers/subhead-links.md %}
{% assign summary_clearBanned="clears list of banned nodes." %}
{% autocrossref %}
*Added in Bitcoin Core 0.12.0*
The `clearbanned` RPC {{summary_clearBanned}}
*Parameters: none*
*Result---`null` on success*
{% itemplate ntpd1 %}
- n: "`result`"
t: "null"
p: "Required<br>(exactly 1)"
d: "JSON `null` when the list was cleared"
{% enditemplate %}
*Example from Bitcoin Core 0.13.1*
Clears the ban list.
{% highlight bash %}
bitcoin-cli clearbanned
{% endhighlight %}
Result (no output from `bitcoin-cli` because result is set to `null`).
*See also*
* [ListBanned][rpc listbanned]: {{summary_listBanned}}
* [SetBan][rpc setban]: {{summary_setBan}}
{% endautocrossref %}

View file

@ -53,6 +53,16 @@ The `createrawtransaction` RPC {{summary_createRawTransaction}}
{% enditemplate %} {% enditemplate %}
*Parameter #3---locktime*
{% itemplate ntpd1 %}
- n: "Locktime"
t: "numeric"
p: "Optional<br>(0 or 1)"
d: "*Added in Bitcoin Core 0.12.0*<br><br>Indicates the earliest time a transaction can be added to the block chain"
{% enditemplate %}
*Result---the unsigned raw transaction in hex* *Result---the unsigned raw transaction in hex*
{% itemplate ntpd1 %} {% itemplate ntpd1 %}

View file

@ -0,0 +1,52 @@
{% 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/disconnectnode.md" %}
##### DisconnectNode
{% include helpers/subhead-links.md %}
{% assign summary_disconnectnode="immediately disconnects from a specified node." %}
{% autocrossref %}
*Added in Bitcoin Core 0.12.0*
The `disconnectnode` RPC {{summary_disconnectNode}}
*Parameter #1---hostname/IP address and port of node to disconnect*
{% itemplate ntpd1 %}
- n: "Node"
t: "string"
p: "Required<br>(exactly 1)"
d: "The node you want to disconnect from as a string in the form of `<IP address>:<port>`. The IP address may be a hostname resolvable through DNS, an IPv4 address, an IPv4-as-IPv6 address, or an IPv6 address"
{% enditemplate %}
*Result---`null` on success or error on failed disconnect*
{% itemplate ntpd1 %}
- n: "`result`"
t: "null"
p: "Required<br>(exactly 1)"
d: "JSON `null` when the node was disconnected"
{% enditemplate %}
*Example from Bitcoin Core 0.12.1*
Disconnects following node from your node.
{% highlight bash %}
bitcoin-cli -testnet disconnectnode 192.0.2.113:18333
{% endhighlight %}
Result (no output from `bitcoin-cli` because result is set to `null`).
*See also*
* [GetAddedNodeInfo][rpc getaddednodeinfo]: {{summary_getAddedNodeInfo}}
{% endautocrossref %}

View file

@ -11,8 +11,6 @@ http://opensource.org/licenses/MIT.
{% autocrossref %} {% autocrossref %}
*Added in Bitcoin Core 0.9.0*
The `getbestblockhash` RPC {{summary_getBestBlockHash}} The `getbestblockhash` RPC {{summary_getBestBlockHash}}
*Parameters: none* *Parameters: none*

View file

@ -11,8 +11,6 @@ http://opensource.org/licenses/MIT.
{% autocrossref %} {% autocrossref %}
*Added in Bitcoin Core 0.9.2*
The `getblockchaininfo` RPC {{summary_getBlockChainInfo}} The `getblockchaininfo` RPC {{summary_getBlockChainInfo}}
*Parameters: none* *Parameters: none*
@ -50,6 +48,11 @@ The `getblockchaininfo` RPC {{summary_getBlockChainInfo}}
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "The difficulty of the highest-height block in the best block chain" d: "The difficulty of the highest-height block in the best block chain"
- n: "→<br>`mediantime`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "*Added in Bitcoin Core 0.12.0*<br><br>The median time of the 11 blocks before the most recent block on the blockchain. Used for validating transaction locktime under BIP113"
- n: "→<br>`verificationprogress`" - n: "→<br>`verificationprogress`"
t: "number (real)" t: "number (real)"
p: "Required (exactly 1)" p: "Required (exactly 1)"
@ -60,9 +63,119 @@ The `getblockchaininfo` RPC {{summary_getBlockChainInfo}}
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "The estimated number of block header hashes checked from the genesis block to this block, encoded as big-endian hex" d: "The estimated number of block header hashes checked from the genesis block to this block, encoded as big-endian hex"
- n: "→<br>`pruned`"
t: "bool"
p: "Required<br>(exactly 1)"
d: "*Added in Bitcoin Core 0.11.0*<br><br>Indicates if the blocks are subject to pruning"
- n: "→<br>`pruneheight`"
t: "number (int)"
p: "Optional<br>(0 or 1)"
d: "*Added in Bitcoin Core 0.11.0*<br><br>The lowest-height complete block stored if prunning is activated"
- n: "→<br>`softforks`"
t: "array"
p: "Required<br>(exactly 1)"
d: "*Added in Bitcoin Core 0.12.0*<br><br>An array of objects each describing a current or previous soft fork"
- n: "→ →<br>Softfork"
t: "object"
p: "Required<br>(3 or more)"
d: "A specific softfork"
- n: "→ → →<br>`id`"
t: "string"
p: "Required<br>(exactly 1)"
d: "The name of the softfork"
- n: "→ → →<br>`version`"
t: "numeric<br>(int)"
p: "Required<br>(exactly 1)"
d: "The block version used for the softfork"
- n: "→ → →<br>`enforce`"
t: "string : object"
p: "Optional<br>(0 or 1)"
d: "The progress toward enforcing the softfork rules for new-version blocks"
- n: "→ → → →<br>`status`"
t: "bool"
p: "Required<br>(exactly 1)"
d: "Indicates if the threshold was reached"
- n: "→ → → →<br>`found`"
t: "numeric<br>(int)"
p: "Optional<br>(0 or 1)"
d: "Number of blocks that support the softfork"
- n: "→ → → →<br>`required`"
t: "numeric<br>(int)"
p: "Optional<br>(0 or 1)"
d: "Number of blocks that are required to reach the threshold"
- n: "→ → → →<br>`window`"
t: "numeric<br>(int)"
p: "Optional<br>(0 or 1)"
d: "The maximum size of examined window of recent blocks"
- n: "→ → →<br>`reject`"
t: "object"
p: "Optional<br>(0 or 1)"
d: "The progress toward enforcing the softfork rules for new-version blocks"
- n: "→ → → →<br>`status`"
t: "bool"
p: "Optional<br>(0 or 1)"
d: "Indicates if the threshold was reached"
- n: "→ → → →<br>`found`"
t: "numeric<br>(int)"
p: "Optional<br>(0 or 1)"
d: "Number of blocks that support the softfork"
- n: "→ → → →<br>`required`"
t: "numeric<br>(int)"
p: "Optional<br>(0 or 1)"
d: "Number of blocks that are required to reach the threshold"
- n: "→ → → →<br>`window`"
t: "numeric<br>(int)"
p: "Optional<br>(0 or 1)"
d: "The maximum size of examined window of recent blocks"
- n: "→<br>`bip9_softforks`"
t: "object"
p: "Required<br>(exactly 1)"
d: "*Added in Bitcoin Core 0.12.1*<br><br>The status of BIP9 softforks in progress"
- n: "→ →<br>Name"
t: "string : object"
p: "Required<br>(2 or more)"
d: "A specific BIP9 softfork"
- n: "→ → →<br>`status`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Set to one of the following reasons:<br>`defined` if voting hasn't started yet<br>`started` if the voting has started <br>`locked_in` if the voting was successful but the softfort hasn't been activated yet<br>`active` if the softfork was activated<br>`failed` if the softfork has not receieved enough votes"
- n: "→ → →<br>`bit`"
t: "numeric<br>(int)"
p: "Optional<br>(0 or 1)"
d: "The bit (0-28) in the block version field used to signal this softfork. Field is only shown when status is `started`"
- n: "→ → →<br>`startTime`"
t: "numeric<br>(int)"
p: "Required<br>(exactly 1)"
d: "The Unix epoch time when the softfork voting begins"
- n: "→ → →<br>`timeout`"
t: "numeric<br>(int)"
p: "Required<br>(exactly 1)"
d: "The Unix epoch time at which the deployment is considered failed if not yet locked in"
{% enditemplate %} {% enditemplate %}
*Example from Bitcoin Core 0.10.0* *Example from Bitcoin Core 0.13.1*
{% highlight bash %} {% highlight bash %}
bitcoin-cli -testnet getblockchaininfo bitcoin-cli -testnet getblockchaininfo
@ -72,13 +185,50 @@ Result:
{% highlight json %} {% highlight json %}
{ {
"chain" : "test", "chain": "main",
"blocks" : 315280, "blocks": 438737,
"headers" : 315280, "headers": 438740,
"bestblockhash" : "000000000ebb17fb455e897b8f3e343eea1b07d926476d00bc66e2c0342ed50f", "bestblockhash": "0000000000000000038c4b27ae0b591135bde8703ef53f6fa9aa5ec5f07db5a1",
"difficulty" : 1.00000000, "difficulty": 254620187304.0614,
"verificationprogress" : 1.00000778, "mediantime": 1479054813,
"chainwork" : "0000000000000000000000000000000000000000000000015e984b4fb9f9b350" "verificationprogress": 0.9999893624230526,
"chainwork": "0000000000000000000000000000000000000000002e732c9db1d0bd82476ae6",
"pruned": false,
"softforks": [
{
"id": "bip34",
"version": 2,
"reject": {
"status": true
}
},
{
"id": "bip66",
"version": 3,
"reject": {
"status": true
}
},
{
"id": "bip65",
"version": 4,
"reject": {
"status": true
}
}
],
"bip9_softforks": {
"csv": {
"status": "active",
"startTime": 1462060800,
"timeout": 1493596800
},
"segwit": {
"status": "defined",
"startTime": 1479168000,
"timeout": 1510704000
}
}
} }
{% endhighlight %} {% endhighlight %}

View file

@ -0,0 +1,178 @@
{% 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/getblockheader.md" %}
##### GetBlockHeader
{% include helpers/subhead-links.md %}
{% 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." %}
{% autocrossref %}
*Added in Bitcoin Core 0.12.0*
The `getblockheader` RPC {{summary_getBlockHeader}}
*Parameter #1---header hash*
{% itemplate ntpd1 %}
- n: "Header Hash"
t: "string (hex)"
p: "Required<br>(exactly 1)"
d: "The hash of the block header to get, encoded as hex in RPC byte order"
{% enditemplate %}
*Parameter #2---JSON or hex output*
{% itemplate ntpd1 %}
- n: "Format"
t: "bool"
p: "Optional<br>(0 or 1)"
d: "Set to `false` to get the block header in serialized block format; set to `true` (the default) to get the decoded block header as a JSON object"
{% enditemplate %}
*Result (if format was `false`)---a serialized block header*
{% itemplate ntpd1 %}
- n: "`result`"
t: "string (hex)/null"
p: "Required<br>(exactly 1)"
d: "The requested block header as a serialized block, encoded as hex, or JSON `null` if an error occurred"
{% enditemplate %}
*Result (if format was `true` or omitted)---a JSON block header*
{% itemplate ntpd1 %}
- n: "`result`"
t: "object/null"
p: "Required<br>(exactly 1)"
d: "An object containing the requested block, or JSON `null` if an error occurred"
- n: "→<br>`hash`"
t: "string (hex)"
p: "Required<br>(exactly 1)"
d: "The hash of this block's block header encoded as hex in RPC byte order. This is the same as the hash provided in parameter #1"
- n: "→<br>`confirmations`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "The number of confirmations the transactions in this block have, starting at 1 when this block is at the tip of the best block chain. This score will be -1 if the the block is not part of the best block chain"
- n: "→<br>`height`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "The height of this block on its block chain"
- n: "→<br>`version`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "This block's version number. See [block version numbers][section block versions]"
- n: "→<br>`versionHex`"
t: "number (hex)"
p: "Required<br>(exactly 1)"
d: "This block's hex version number. See [block version numbers][section block versions]"
- n: "→<br>`merkleroot`"
t: "string (hex)"
p: "Required<br>(exactly 1)"
d: "The merkle root for this block, encoded as hex in RPC byte order"
- n: "→<br>`mediantime`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "The computed median time of the previous 11 blocks. Used for validating transaction locktime under BIP113"
- n: "→<br>`nonce`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "The nonce which was successful at turning this particular block into one that could be added to the best block chain"
- n: "→<br>`bits`"
t: "string (hex)"
p: "Required<br>(exactly 1)"
d: "The value of the *nBits* field in the block header, indicating the target threshold this block's header had to pass"
- n: "→<br>`difficulty`"
t: "number (real)"
p: "Required<br>(exactly 1)"
d: "The estimated amount of work done to find this block relative to the estimated amount of work done to find block 0"
- n: "→<br>`chainwork`"
t: "string (hex)"
p: "Required<br>(exactly 1)"
d: "The estimated number of block header hashes miners had to check from the genesis block to this block, encoded as big-endian hex"
- n: "→<br>`previousblockhash`"
t: "string (hex)"
p: "Optional<br>(0 or 1)"
d: "The hash of the header of the previous block, encoded as hex in RPC byte order. Not returned for genesis block"
- n: "→<br>`nextblockhash`"
t: "string (hex)"
p: "Optional<br>(0 or 1)"
d: "The hash of the next block on the best block chain, if known, encoded as hex in RPC byte order"
{% enditemplate %}
*Example from Bitcoin Core 0.12.1*
Get a block header in raw hex:
{% highlight bash %}
bitcoin-cli -testnet getblockheader \
00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09 \
false
{% endhighlight %}
Result (wrapped):
{% highlight text %}
010000007de867cc8adc5cc8fb6b898ca4462cf9fd667d7830a275277447e608\
00000000338f121232e169d3100edd82004dc2a1f0e1f030c6c488fa61eafa93\
0b0528fe021f7449ffff001d36b4af9a
{% endhighlight %}
Get the same block in JSON:
{% highlight bash %}
bitcoin-cli -testnet getblockheader \
00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09
{% endhighlight %}
Result:
{% highlight json %}
{
"hash": "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09",
"confirmations": 437926,
"height": 1000,
"version": 1,
"versionHex": "00000001",
"merkleroot": "fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33",
"time": 1232346882,
"mediantime": 1232344831,
"nonce": 2595206198,
"bits": "1d00ffff",
"difficulty": 1,
"chainwork": "000000000000000000000000000000000000000000000000000003e903e903e9",
"previousblockhash": "0000000008e647742775a230787d66fdf92c46a48c896bfbc85cdc8acc67e87d",
"nextblockhash": "00000000a2887344f8db859e372e7e4bc26b23b9de340f725afbf2edb265b4c6"
}
{% endhighlight %}
*See also*
* [GetBlock][rpc getblock]: {{summary_getBlock}}
* [GetBlockHash][rpc getblockhash]: {{summary_getBlockHash}}
* [GetBestBlockHash][rpc getbestblockhash]: {{summary_getBestBlockHash}}
{% endautocrossref %}

View file

@ -35,9 +35,24 @@ The `getmempoolinfo` RPC {{summary_getMemPoolInfo}}
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "The total number of bytes in the transactions in the memory pool" d: "The total number of bytes in the transactions in the memory pool"
- n: "→<br>`usage`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "*Added in Bitcoin Core 0.11.0*<br><br>Total memory usage for the mempool in bytes"
- n: "→<br>`maxmempool`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "*Added in Bitcoin Core 0.12.0*<br><br>Maximum memory usage for the mempool in bytes"
- n: "→<br>`mempoolminfee`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "*Added in Bitcoin Core 0.12.0*<br><br>The lowest fee per kilobyte paid by any transaction in the memory pool"
{% enditemplate %} {% enditemplate %}
*Example from Bitcoin Core 0.10.0* *Example from Bitcoin Core 0.12.0*
{% highlight bash %} {% highlight bash %}
bitcoin-cli -testnet getmempoolinfo bitcoin-cli -testnet getmempoolinfo
@ -47,8 +62,11 @@ Result:
{% highlight json %} {% highlight json %}
{ {
"size" : 37, "size": 1237,
"bytes" : 9423 "bytes": 591126,
"usage": 1900416,
"maxmempool": 300000000,
"mempoolminfee": 0.00000000
} }
{% endhighlight %} {% endhighlight %}

View file

@ -11,8 +11,6 @@ http://opensource.org/licenses/MIT.
{% autocrossref %} {% autocrossref %}
*Added in Bitcoin Core 0.9.2.*
The `getnetworkinfo` RPC {{summary_getNetworkInfo}} The `getnetworkinfo` RPC {{summary_getNetworkInfo}}
*Parameters: none* *Parameters: none*

View file

@ -98,7 +98,7 @@ The `gettransaction` RPC {{summary_getTransaction}}
{% enditemplate %} {% enditemplate %}
*Example from Bitcoin Core 0.10.0* *Example from Bitcoin Core 0.12.1*
{% highlight bash %} {% highlight bash %}
bitcoin-cli -testnet gettransaction \ bitcoin-cli -testnet gettransaction \
@ -120,6 +120,7 @@ Result:
], ],
"time" : 1396321351, "time" : 1396321351,
"timereceived" : 1418924711, "timereceived" : 1418924711,
"bip125-replaceable" : "no",
"details" : [ "details" : [
{ {
"account" : "", "account" : "",

View file

@ -11,7 +11,7 @@ http://opensource.org/licenses/MIT.
{% autocrossref %} {% autocrossref %}
*Requires wallet support. Added in Bitcoin Core 0.9.2.* *Requires wallet support.*
The `getwalletinfo` RPC {{summary_getWalletInfo}} The `getwalletinfo` RPC {{summary_getWalletInfo}}

View file

@ -0,0 +1,88 @@
{% 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/listbanned.md" %}
##### ListBanned
{% include helpers/subhead-links.md %}
{% assign summary_listBanned="lists all banned IPs/Subnets." %}
{% autocrossref %}
*Added in Bitcoin Core 0.12.0*
The `listbanned` RPC {{summary_listBanned}}
*Parameters: none*
*Result---information about each banned IP/Subnet*
{% itemplate ntpd1 %}
- n: "`result`"
t: "object"
p: "Required<br>(exactly 1)"
d: "An array of objects each describing one entry. If there are no entries in the ban list, the array will be empty"
- n: "→<br>Node"
t: "object"
p: "Optional<br>(0 or more)"
d: "A ban list entry"
- n: "→ →<br>`address`"
t: "string"
p: "Required<br>(exactly 1)"
d: "The IP/Subnet of the entry"
- n: "→ →<br>`banned_until`"
t: "number<br>(int)"
p: "Required<br>(exactly 1)"
d: "The Unix epoch time when the entry was added to the ban list"
- n: "→ →<br>`ban_created`"
t: "number<br>(int)"
p: "Required<br>(exactly 1)"
d: "The Unix epoch time until the IP/Subnet is banned"
- n: "→ →<br>`ban_reason`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Set to one of the following reasons:<br>`node misbehaving` if the node was banned by the client because of DoS violations<br>`manually added` if the node was manually banned by the user"
{% enditemplate %}
*Examples from Bitcoin Core 0.12.1*
The default (`false`):
{% highlight bash %}
bitcoin-cli listbanned
{% endhighlight %}
Result:
{% highlight json %}
[
{
"address": "83.84.25.82/32",
"banned_until": 1487269503,
"ban_created": 1478629503,
"ban_reason": "node misbehaving"
},
{
"address": "111.111.0.111/32",
"banned_until": 1487791655,
"ban_created": 1479151655,
"ban_reason": "manually added"
}
]
{% endhighlight %}
*See also*
* [SetBan][rpc setban]: {{summary_setBan}}
* [ClearBanned][rpc clearbanned]: {{summary_clearBanned}}
{% endautocrossref %}

View file

@ -1,4 +1,4 @@
{% comment %} {% comment %}
This file is licensed under the MIT License (MIT) available on This file is licensed under the MIT License (MIT) available on
http://opensource.org/licenses/MIT. http://opensource.org/licenses/MIT.
{% endcomment %} {% endcomment %}
@ -21,7 +21,7 @@ The `listtransactions` RPC {{summary_listTransactions}}
- n: "Account" - n: "Account"
t: "string" t: "string"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "The name of an account to get transactinos from. Use an empty string (\"\") to get transactions for the default account. Default is `*` to get transactions for all accounts" d: "The name of an account to get transactinos from. Use an empty string (\"\") to get transactions for the default account. Default is `*` to get transactions for all accounts. The account feature is deprecated"
{% enditemplate %} {% enditemplate %}
@ -97,6 +97,11 @@ The `listtransactions` RPC {{summary_listTransactions}}
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "The number of confirmations the transaction has received. Will be `0` for unconfirmed and `-1` for conflicted. Not returned for *move* category payments" d: "The number of confirmations the transaction has received. Will be `0` for unconfirmed and `-1` for conflicted. Not returned for *move* category payments"
- n: "→ →<br>`trusted`"
t: "bool"
p: "Optional<br>(0 or 1)"
d: "Indicates wether we consider the outputs of this unconfirmed transaction safe to spend. The field is only visible for unconfirmed transactions"
- n: "→ →<br>`generated`" - n: "→ →<br>`generated`"
t: "bool" t: "bool"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
@ -157,16 +162,26 @@ The `listtransactions` RPC {{summary_listTransactions}}
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "Only returned by *move* category payments. This is the account the bitcoins were moved from or moved to, as indicated by a negative or positive *amount* field in this payment" d: "Only returned by *move* category payments. This is the account the bitcoins were moved from or moved to, as indicated by a negative or positive *amount* field in this payment"
- n: "→ →<br>`bip125-replaceable`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Indicates if a transaction is replaceable under BIP125:<br>`yes` replaceable<br>`no` not replaceable<br>`unknown` for unconfirmed transactions not in the mempool"
- n: "→ →<br>`abandoned`"
t: "bool"
p: "Required<br>(exactly 1)"
d: "Indicates if a transaction is was abandoned:<br>`yes` if it was abandoned (inputs are respendable)<br>`no` if it was not abandoned"
{% enditemplate %} {% enditemplate %}
*Example from Bitcoin Core 0.10.0* *Example from Bitcoin Core 0.12.1*
List the most recent transaction from the account "someone else's List the most recent transaction from the account "someone else's
address2" including watch-only addresses. address2" including watch-only addresses.
{% highlight bash %} {% highlight bash %}
bitcoin-cli -testnet listtransactions \ bitcoin-cli -testnet listtransactions \
"someone else's address2" 1 0 true "" 1 0 true
{% endhighlight %} {% endhighlight %}
Result: Result:
@ -175,7 +190,7 @@ Result:
[ [
{ {
"involvesWatchonly" : true, "involvesWatchonly" : true,
"account" : "someone else's address2", "account" : "",
"address" : "n3GNqMveyvaPvUbH469vDRadqpJMPc84JA", "address" : "n3GNqMveyvaPvUbH469vDRadqpJMPc84JA",
"category" : "receive", "category" : "receive",
"amount" : 0.00050000, "amount" : 0.00050000,
@ -188,7 +203,9 @@ Result:
"walletconflicts" : [ "walletconflicts" : [
], ],
"time" : 1418695703, "time" : 1418695703,
"timereceived" : 1418925580 "timereceived" : 1418925580,
"bip125-replaceable" : "no",
"abandoned": false
} }
] ]
{% endhighlight %} {% endhighlight %}

View file

@ -0,0 +1,83 @@
{% 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/setban.md" %}
##### SetBan
{% include helpers/subhead-links.md %}
{% assign summary_setBan="attempts add or remove a IP/Subnet from the banned list." %}
{% autocrossref %}
*Added in Bitcoin Core 0.12.0*
The `setban` RPC {{summary_setBan}}
*Parameter #1---IP/Subnet of the node*
{% itemplate ntpd1 %}
- n: "IP(/Netmask)"
t: "string"
p: "Required<br>(exactly 1)"
d: "The node to add or remove as a string in the form of `<IP address>`. The IP address may be a hostname resolvable through DNS, an IPv4 address, an IPv4-as-IPv6 address, or an IPv6 address"
{% enditemplate %}
*Parameter #2---whether to add or remove the node*
{% itemplate ntpd1 %}
- n: "Command"
t: "string"
p: "Required<br>(exactly 1)"
d: "What to do with the IP/Subnet address above. Options are:<br>`add` to add a node to the addnode list<br>`remove` to remove a node from the list. If currently connected, this will disconnect immediately"
{% enditemplate %}
*Parameter #3---time how long the ip is banned*
{% itemplate ntpd1 %}
- n: "Bantime"
t: "numeric<br>(int)"
p: "Optional<br>(0 or 1)"
d: "Time in seconds how long (or until when if `absolute` is set) the entry is banned. The default is 24h which can also be overwritten by the -bantime startup argument"
{% enditemplate %}
*Parameter #4---whether a relative or absolute timestamp*
{% itemplate ntpd1 %}
- n: "Absolute"
t: "bool"
p: "Optional<br>(0 or 1)"
d: "If set, the bantime must be a absolute timestamp in seconds since epoch (Jan 1 1970 GMT)"
{% enditemplate %}
*Result---`null` on success*
{% itemplate ntpd1 %}
- n: "`result`"
t: "null"
p: "Required<br>(exactly 1)"
d: "Always JSON `null`"
{% enditemplate %}
*Example from Bitcoin Core 0.12.1*
Ban the following node.
{% highlight bash %}
bitcoin-cli -testnet setban 192.0.2.113:18333 add 2592000
{% endhighlight %}
Result (no output from `bitcoin-cli` because result is set to `null`).
*See also*
* [ListBanned][rpc listbanned]: {{summary_listBanned}}
* [ClearBanned][rpc clearbanned]: {{summary_clearBanned}}
{% endautocrossref %}

View file

@ -1,8 +1,10 @@
{%comment%}AUTOMATICALLY-GENERATED FILE: DO NOT EDIT THIS FILE {%comment%}AUTOMATICALLY-GENERATED FILE: DO NOT EDIT THIS FILE
This file is licensed under the terms of its source texts{%endcomment%} This file is licensed under the terms of its source texts{%endcomment%}
{% assign summary_abandonTransaction="marks an in-wallet transaction and all its in-wallet descendants as abandoned. This allows their inputs to be respend." %}
{% assign summary_addMultiSigAddress="adds a P2SH multisig address to the wallet." %} {% assign summary_addMultiSigAddress="adds a P2SH multisig address to the wallet." %}
{% assign summary_addNode="attempts to add or remove a node from the addnode list, or to try a connection to a node once." %} {% assign summary_addNode="attempts to add or remove a node from the addnode list, or to try a connection to a node once." %}
{% assign summary_backupWallet="safely copies `wallet.dat`<!--noref--> to the specified file, which can be a directory or a path with filename." %} {% assign summary_backupWallet="safely copies `wallet.dat`<!--noref--> 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_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_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." %} {% 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_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_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_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_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_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." %} {% 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_keyPoolRefill="fills the cache of unused pre-generated keys (the keypool)." %}
{% assign summary_listAccounts="lists accounts and their balances." %} {% 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_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_listLockUnspent="returns a list of temporarily unspendable (locked) outputs." %}
{% assign summary_listReceivedByAccount="lists the total number of bitcoins received by each account." %} {% 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." %} {% 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_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_sendToAddress="spends an amount to a given address." %}
{% assign summary_setAccount="puts the specified address in the given account." %} {% 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_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_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." %} {% assign summary_signMessage="signs a message with the private key of an address." %}

View file

@ -93,6 +93,11 @@ http://opensource.org/licenses/MIT.
p: "Required<br>(exactly 1)" p: "Required<br>(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" 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}}<br>`bip125-replaceable`"
t: "string"
p: "Required<br>(exactly 1)"
d: "*Added in Bitcoin Core 0.12.0*<br><br>Indicates if a transaction is replaceable under BIP 125:<br>`yes` is replaceable<br>`no` not replaceable<br>`unknown` for unconfirmed transactions not in the mempool"
- n: "{{DEPTH}}<br>`comment`" - n: "{{DEPTH}}<br>`comment`"
t: "string" t: "string"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"

View file

@ -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" [wallet support]: /en/developer-reference#term-wallet-support "A Bitcoin Core ./configure option that enables (default) or disables the wallet"
{% comment %}<!-- RPCs; alphabetical order -->{% endcomment %} {% comment %}<!-- RPCs; alphabetical order -->{% endcomment %}
[rpc abandontransaction]: /en/developer-reference#abandontransaction
[rpc addmultisigaddress]: /en/developer-reference#addmultisigaddress [rpc addmultisigaddress]: /en/developer-reference#addmultisigaddress
[rpc addnode]: /en/developer-reference#addnode [rpc addnode]: /en/developer-reference#addnode
[rpc backupwallet]: /en/developer-reference#backupwallet [rpc backupwallet]: /en/developer-reference#backupwallet
[rpc clearbanned]: /en/developer-reference#clearbanned
[rpc createmultisig]: /en/developer-reference#createmultisig [rpc createmultisig]: /en/developer-reference#createmultisig
[rpc createrawtransaction]: /en/developer-reference#createrawtransaction [rpc createrawtransaction]: /en/developer-reference#createrawtransaction
[rpc decoderawtransaction]: /en/developer-reference#decoderawtransaction [rpc decoderawtransaction]: /en/developer-reference#decoderawtransaction
[rpc decodescript]: /en/developer-reference#decodescript [rpc decodescript]: /en/developer-reference#decodescript
[rpc disconnectnode]: /en/developer-reference#disconnectnode
[rpc dumpprivkey]: /en/developer-reference#dumpprivkey [rpc dumpprivkey]: /en/developer-reference#dumpprivkey
[rpc dumpwallet]: /en/developer-reference#dumpwallet [rpc dumpwallet]: /en/developer-reference#dumpwallet
[rpc encryptwallet]: /en/developer-reference#encryptwallet [rpc encryptwallet]: /en/developer-reference#encryptwallet
@ -89,6 +92,7 @@ http://opensource.org/licenses/MIT.
[rpc getblockchaininfo]: /en/developer-reference#getblockchaininfo [rpc getblockchaininfo]: /en/developer-reference#getblockchaininfo
[rpc getblockcount]: /en/developer-reference#getblockcount [rpc getblockcount]: /en/developer-reference#getblockcount
[rpc getblockhash]: /en/developer-reference#getblockhash [rpc getblockhash]: /en/developer-reference#getblockhash
[rpc getblockheader]: /en/developer-reference#getblockheader
[rpc getblocktemplate]: /en/developer-reference#getblocktemplate [rpc getblocktemplate]: /en/developer-reference#getblocktemplate
[rpc getchaintips]: /en/developer-reference#getchaintips [rpc getchaintips]: /en/developer-reference#getchaintips
[rpc getconnectioncount]: /en/developer-reference#getconnectioncount [rpc getconnectioncount]: /en/developer-reference#getconnectioncount
@ -122,6 +126,7 @@ http://opensource.org/licenses/MIT.
[rpc keypoolrefill]: /en/developer-reference#keypoolrefill [rpc keypoolrefill]: /en/developer-reference#keypoolrefill
[rpc listaccounts]: /en/developer-reference#listaccounts [rpc listaccounts]: /en/developer-reference#listaccounts
[rpc listaddressgroupings]: /en/developer-reference#listaddressgroupings [rpc listaddressgroupings]: /en/developer-reference#listaddressgroupings
[rpc listbanned]: /en/developer-reference#listbanned
[rpc listlockunspent]: /en/developer-reference#listlockunspent [rpc listlockunspent]: /en/developer-reference#listlockunspent
[rpc listreceivedbyaccount]: /en/developer-reference#listreceivedbyaccount [rpc listreceivedbyaccount]: /en/developer-reference#listreceivedbyaccount
[rpc listreceivedbyaddress]: /en/developer-reference#listreceivedbyaddress [rpc listreceivedbyaddress]: /en/developer-reference#listreceivedbyaddress
@ -137,6 +142,7 @@ http://opensource.org/licenses/MIT.
[rpc sendrawtransaction]: /en/developer-reference#sendrawtransaction [rpc sendrawtransaction]: /en/developer-reference#sendrawtransaction
[rpc sendtoaddress]: /en/developer-reference#sendtoaddress [rpc sendtoaddress]: /en/developer-reference#sendtoaddress
[rpc setaccount]: /en/developer-reference#setaccount [rpc setaccount]: /en/developer-reference#setaccount
[rpc setban]: /en/developer-reference#setban
[rpc setgenerate]: /en/developer-reference#setgenerate [rpc setgenerate]: /en/developer-reference#setgenerate
[rpc settxfee]: /en/developer-reference#settxfee [rpc settxfee]: /en/developer-reference#settxfee
[rpc signmessage]: /en/developer-reference#signmessage [rpc signmessage]: /en/developer-reference#signmessage

View file

@ -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 treat block chain and memory pool data as an arbitrary input from an
untrusted source. untrusted source.
{% include devdoc/bitcoin-core/rpcs/rpcs/abandontransaction.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/addmultisigaddress.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/addmultisigaddress.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/addnode.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/addnode.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/backupwallet.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/createmultisig.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/createrawtransaction.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/decodescript.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/disconnectnode.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/dumpprivkey.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/dumpprivkey.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/dumpwallet.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/getblockhash.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/getblockheader.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/getblocktemplate.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/getblocktemplate.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/getchaintips.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/listaddressgroupings.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/listbanned.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/listlockunspent.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/listlockunspent.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/listreceivedbyaccount.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/setaccount.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/setban.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/setgenerate.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/setgenerate.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/settxfee.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/settxfee.md %}