joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 17:56:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

RPC Developer reference updated based on 0.12.1

Browse source 
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.
This commit is contained in:
Michael Rotarius 2016-11-15 17:17:05 +01:00
parent 9e3d55b562
commit c7a99a6084
21 changed files with 791 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

43
_includes/devdoc/bitcoin-core/rpcs/quick-ref.md
View file

@ -19,18 +19,21 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
<!-- master -->
{% assign NEW_MASTER='**<abbr title="New in Bitcoin Core’s master branch (unreleased)">New in master</abbr>**' %}
{% assign UPDATED_MASTER='**<abbr title="Updated in Bitcoin Core’s 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 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 -->
{% assign NEW0_9_2='*<abbr title="New in Bitcoin Core v0.9.2">New in 0.9.2</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>*' %}
<!-- Bitcoin Core 0.9.0 March 2014 -->
{% assign NEW0_9_0='*<abbr title="New in Bitcoin Core v0.9.0">New in 0.9.0</abbr>*' %}
<!-- Bitcoin Core 0.12.0 February 2016 -->
{% 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
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 %}
* [GetBestBlockHash][rpc getbestblockhash]: {{summary_getBestBlockHash}} {{NEW0_9_0}}
* [GetBestBlockHash][rpc getbestblockhash]: {{summary_getBestBlockHash}}
* [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}}
* [GetBlockHash][rpc getblockhash]: {{summary_getBlockHash}}
* [GetBlockHeader][rpc getblockheader]: {{summary_getBlockHeader}} {{NEW0_12_0}}
* [GetChainTips][rpc getchaintips]: {{summary_getChainTips}} {{NEW0_10_0}}
* [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}}
* [GetTxOut][rpc gettxout]: {{summary_getTxOut}}
* [GetTxOutProof][rpc gettxoutproof]: {{summary_getTxOutProof}} {{NEW0_11_0}}
@ -107,12 +111,16 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
{% autocrossref %}
* [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}}
* [GetConnectionCount][rpc getconnectioncount]: {{summary_getConnectionCount}}
* [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}}
* [ListBanned][rpc listbanned]: {{summary_listBanned}} {{NEW0_12_0}}
* [Ping][rpc ping]: {{summary_ping-rpc}}
* [SetBan][rpc setban]: {{summary_setBan}} {{NEW0_12_0}}
{% endautocrossref %}
@ -122,7 +130,7 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
{% autocrossref %}
* [CreateRawTransaction][rpc createrawtransaction]: {{summary_createRawTransaction}}
* [CreateRawTransaction][rpc createrawtransaction]: {{summary_createRawTransaction}} {{UPDATED0_12_0}}
* [DecodeRawTransaction][rpc decoderawtransaction]: {{summary_decodeRawTransaction}}
* [DecodeScript][rpc decodescript]: {{summary_decodeScript}}
* [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
default.
* [AbandonTransaction][rpc abandontransaction]: {{summary_abandonTransaction}} {{NEW0_12_0}}
* [AddMultiSigAddress][rpc addmultisigaddress]: {{summary_addMultiSigAddress}}
* [BackupWallet][rpc backupwallet]: {{summary_backupWallet}}
* [DumpPrivKey][rpc dumpprivkey]: {{summary_dumpPrivKey}}
@ -168,9 +177,9 @@ default.
* [GetRawChangeAddress][rpc getrawchangeaddress]: {{summary_getRawChangeAddress}}
* [GetReceivedByAccount][rpc getreceivedbyaccount]: {{summary_getReceivedByAccount}}
* [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}}
* [GetWalletInfo][rpc getwalletinfo]: {{summary_getWalletInfo}} {{NEW0_9_2}}
* [GetWalletInfo][rpc getwalletinfo]: {{summary_getWalletInfo}}
* [ImportAddress][rpc importaddress]: {{summary_importAddress}} {{NEW0_10_0}}
* [ImportPrivKey][rpc importprivkey]: {{summary_importPrivKey}}
* [ImportWallet][rpc importwallet]: {{summary_importWallet}}
@ -181,7 +190,7 @@ default.
* [ListReceivedByAccount][rpc listreceivedbyaccount]: {{summary_listReceivedByAccount}} {{UPDATED0_10_0}}
* [ListReceivedByAddress][rpc listreceivedbyaddress]: {{summary_listReceivedByAddress}} {{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}}
* [LockUnspent][rpc lockunspent]: {{summary_lockUnspent}}
* [Move][rpc move]: {{summary_move}}

52
_includes/devdoc/bitcoin-core/rpcs/rpcs/abandontransaction.md Normal file
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 respend." %}
{% 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*
Disconnects following node from 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 %}

45
_includes/devdoc/bitcoin-core/rpcs/rpcs/clearbanned.md Normal file
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*
Disconnects following node from your node.
{% 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 %}

10
_includes/devdoc/bitcoin-core/rpcs/rpcs/createrawtransaction.md
View file

@ -53,6 +53,16 @@ The `createrawtransaction` RPC {{summary_createRawTransaction}}
{% 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*
{% itemplate ntpd1 %}

52
_includes/devdoc/bitcoin-core/rpcs/rpcs/disconnectnode.md Normal file
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 %}

2
_includes/devdoc/bitcoin-core/rpcs/rpcs/getbestblockhash.md
View file

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

170
_includes/devdoc/bitcoin-core/rpcs/rpcs/getblockchaininfo.md
View file

@ -11,8 +11,6 @@ http://opensource.org/licenses/MIT.
{% autocrossref %}
*Added in Bitcoin Core 0.9.2*
The `getblockchaininfo` RPC {{summary_getBlockChainInfo}}
*Parameters: none*
@ -50,6 +48,11 @@ The `getblockchaininfo` RPC {{summary_getBlockChainInfo}}
p: "Required<br>(exactly 1)"
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 difficulty of the highest-height block in the best block chain"
- n: "→<br>`verificationprogress`"
t: "number (real)"
p: "Required (exactly 1)"
@ -60,9 +63,119 @@ The `getblockchaininfo` RPC {{summary_getBlockChainInfo}}
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"
- 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 %}
*Example from Bitcoin Core 0.10.0*
*Example from Bitcoin Core 0.12.1*
{% highlight bash %}
bitcoin-cli -testnet getblockchaininfo
@ -72,13 +185,50 @@ Result:
{% highlight json %}
{
"chain" : "test",
"blocks" : 315280,
"headers" : 315280,
"bestblockhash" : "000000000ebb17fb455e897b8f3e343eea1b07d926476d00bc66e2c0342ed50f",
"difficulty" : 1.00000000,
"verificationprogress" : 1.00000778,
"chainwork" : "0000000000000000000000000000000000000000000000015e984b4fb9f9b350"
"chain": "main",
"blocks": 438737,
"headers": 438740,
"bestblockhash": "0000000000000000038c4b27ae0b591135bde8703ef53f6fa9aa5ec5f07db5a1",
"difficulty": 254620187304.0614,
"mediantime": 1479054813,
"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 %}

183
_includes/devdoc/bitcoin-core/rpcs/rpcs/getblockheader.md Normal file
View file

@ -0,0 +1,183 @@
{% 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>`size`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "The size of this block in serialized block format, counted in bytes"
- 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 value of the *time* field in the block header, indicating approximately when the block was created"
- 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 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 %}

24
_includes/devdoc/bitcoin-core/rpcs/rpcs/getmempoolinfo.md
View file

@ -35,9 +35,24 @@ The `getmempoolinfo` RPC {{summary_getMemPoolInfo}}
p: "Required<br>(exactly 1)"
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 total number of bytes in the transactions in the memory pool"
{% enditemplate %}
*Example from Bitcoin Core 0.10.0*
*Example from Bitcoin Core 0.12.0*
{% highlight bash %}
bitcoin-cli -testnet getmempoolinfo
@ -47,8 +62,11 @@ Result:
{% highlight json %}
{
"size" : 37,
"bytes" : 9423
"size": 1237,
"bytes": 591126,
"usage": 1900416,
"maxmempool": 300000000,
"mempoolminfee": 0.00000000
}
{% endhighlight %}

2
_includes/devdoc/bitcoin-core/rpcs/rpcs/getnetworkinfo.md
View file

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

3
_includes/devdoc/bitcoin-core/rpcs/rpcs/gettransaction.md
View file

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

2
_includes/devdoc/bitcoin-core/rpcs/rpcs/getwalletinfo.md
View file

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

88
_includes/devdoc/bitcoin-core/rpcs/rpcs/listbanned.md Normal file
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 %}

27
_includes/devdoc/bitcoin-core/rpcs/rpcs/listtransactions.md
View file

@ -21,7 +21,7 @@ The `listtransactions` RPC {{summary_listTransactions}}
- n: "Account"
t: "string"
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 %}
@ -96,6 +96,11 @@ The `listtransactions` RPC {{summary_listTransactions}}
t: "number (int)"
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"
- 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"
- n: "→ →<br>`generated`"
t: "bool"
@ -157,16 +162,26 @@ The `listtransactions` RPC {{summary_listTransactions}}
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"
- 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 %}
*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
address2" including watch-only addresses.
{% highlight bash %}
bitcoin-cli -testnet listtransactions \
"someone else's address2" 1 0 true
"" 1 0 true
{% endhighlight %}
Result:
@ -175,7 +190,7 @@ Result:
[
{
"involvesWatchonly" : true,
"account" : "someone else's address2",
"account" : "",
"address" : "n3GNqMveyvaPvUbH469vDRadqpJMPc84JA",
"category" : "receive",
"amount" : 0.00050000,
@ -188,7 +203,9 @@ Result:
"walletconflicts" : [
],
"time" : 1418695703,
"timereceived" : 1418925580
"timereceived" : 1418925580,
"bip125-replaceable" : "no",
"abandoned": false
}
]
{% endhighlight %}

83
_includes/devdoc/bitcoin-core/rpcs/rpcs/setban.md Normal file
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_addNode}}
*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*
Try connecting to 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 %}