Dev Docs: edits to 0.14.0 RPC update

This commit is contained in:
David A. Harding 2017-05-08 14:29:28 -04:00
parent ee3950ed12
commit 7a67a7c8cf
No known key found for this signature in database
GPG key ID: 4B29C30FF29EC4B7
14 changed files with 50 additions and 42 deletions

View file

@ -16,7 +16,7 @@ http://opensource.org/licenses/MIT.
*Requires wallet support. Wallet must be unlocked.* *Requires wallet support. Wallet must be unlocked.*
The `bumpfee` RPC {{summary_bumpFee}} The increased fee is deducted from the change output. The command fails if the change output is too small to increase the fee or The `bumpfee` RPC {{summary_bumpFee}} The increased fee is deducted from the change output. The command fails if the change output is too small to increase the fee or
if the wallet or mempool contains a transaction that spends one of the transactions outputs. The `-walletrbf` option needs to be enabled (default is `false`). if the wallet or mempool contains a transaction that spends one of the transaction's outputs. The `-walletrbf` option needs to be enabled (default is `false`).
*Parameter #1---The TXID of the transaction* *Parameter #1---The TXID of the transaction*
@ -39,17 +39,17 @@ if the wallet or mempool contains a transaction that spends one of the transacti
- n: "→ <br>`confTarget`" - n: "→ <br>`confTarget`"
t: "numeric (int)" t: "numeric (int)"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "The confirmation target in blocks. Based on this value the new fee will be calculated using estimatefee. If not set the default target of ´6´ blocks will be used" d: "The confirmation target in blocks. Based on this value the new fee will be calculated using the same code as the `estimatefee` RPC. If not set, the default target of ´6´ blocks will be used"
- n: "→ <br>`totalFee`" - n: "→ <br>`totalFee`"
t: "nummeric (bitcoins)" t: "numeric (satoshis)"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "The total fee to pay in satoshis (not the feerate). The actual fee can be higher in rare cases if the change output is close to the dust limit" d: "The total fee to pay in satoshis (not the feerate). The actual fee can be higher in rare cases if the change output is close to the dust limit"
- n: "→ <br>`replaceable`" - n: "→ <br>`replaceable`"
t: "bool" t: "bool"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "Whether the new transaction should still be BIP 125 replaceable. Even if set to `false` the transaction may still be replacable , for example if it has unconfirmed ancestors which are replaceable. The default is `true`" d: "Whether the new transaction should still be BIP 125 replaceable. Even if set to `false` the transaction may still be replacable, for example if it has unconfirmed ancestors which are replaceable. The default is `true`"
{% enditemplate %} {% enditemplate %}

View file

@ -13,33 +13,33 @@ http://opensource.org/licenses/MIT.
The `createrawtransaction` RPC {{summary_createRawTransaction}} The `createrawtransaction` RPC {{summary_createRawTransaction}}
*Parameter #1---references to previous outputs* *Parameter #1---Inputs*
{% itemplate ntpd1 %} {% itemplate ntpd1 %}
- n: "Inputs" - n: "Inputs"
t: "array" t: "array"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "An array of objects, each one being an unspent outpoint" d: "An array of objects, each one to be used as an input to the transaction"
- n: "→ Outpoint" - n: "→ Input"
t: "object" t: "object"
p: "Required<br>(1 or more)" p: "Required<br>(1 or more)"
d: "An object describing a particular unspent outpoint" d: "An object describing a particular input"
- n: "→ →<br>`txid`" - n: "→ →<br>`txid`"
t: "string (hex)" t: "string (hex)"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "The TXID of the outpoint encoded as hex in RPC byte order" d: "The TXID of the outpoint to be spent encoded as hex in RPC byte order"
- n: "→ →<br>`vout`" - n: "→ →<br>`vout`"
t: "number (int)" t: "number (int)"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "The output index number (vout) of the outpoint; the first output in a transaction is index `0`" d: "The output index number (vout) of the outpoint to be spent; the first output in a transaction is index `0`"
- n: "→ →<br>`Sequence`" - n: "→ →<br>`Sequence`"
t: "number (int)" t: "number (int)"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "The sequence number of the outpoint" d: "The sequence number to use for the input"
{% enditemplate %} {% enditemplate %}

View file

@ -46,7 +46,8 @@ bitcoin-cli -testnet disconnectnode 192.0.2.113:18333
Result (no output from `bitcoin-cli` because result is set to `null`). Result (no output from `bitcoin-cli` because result is set to `null`).
*See also* *See also*
* [AddNode][rpc addnode]: {{summary_getAddNode}}
* [AddNode][rpc addnode]: {{summary_addNode}}
* [GetAddedNodeInfo][rpc getaddednodeinfo]: {{summary_getAddedNodeInfo}} * [GetAddedNodeInfo][rpc getaddednodeinfo]: {{summary_getAddedNodeInfo}}
{% endautocrossref %} {% endautocrossref %}

View file

@ -107,9 +107,9 @@ ffff01405dc600000000001976a9140dfc8bafc8419853b34d5e072ad37d1a51\
{ {
"changeAddress": "15gJiApWFGTN2iTteQwQbqasdT6dwGWwv6", "changeAddress": "15gJiApWFGTN2iTteQwQbqasdT6dwGWwv6",
"changePosition" : "", "changePosition" : "",
"includeWatching" : false, "includeWatching" : false,
"lockUnspents" : true, "lockUnspents" : true,
"feeRate" : 0.0001 "feeRate" : 0.0001
} }
{% endhighlight %} {% endhighlight %}

View file

@ -89,11 +89,11 @@ Result (real hostname and IP address replaced):
{% highlight json %} {% highlight json %}
[ [
{ {
"addednode" : "bitcoind.example.com:18333", "addednode" : "bitcoind.example.com:8333",
"connected" : true, "connected" : true,
"addresses" : [ "addresses" : [
{ {
"address" : "192.0.2.113:18333", "address" : "192.0.2.113:8333",
"connected" : "outbound" "connected" : "outbound"
} }
] ]

View file

@ -23,7 +23,7 @@ The `getblock` RPC {{summary_getBlock}}
{% enditemplate %} {% enditemplate %}
*Parameter #2---weather to getJSON or hex output* *Parameter #2---whether to get JSON or hex output*
{% itemplate ntpd1 %} {% itemplate ntpd1 %}
- n: "Format" - n: "Format"

View file

@ -55,7 +55,7 @@ The `getblockchaininfo` RPC {{summary_getBlockChainInfo}}
- n: "→<br>`verificationprogress`" - n: "→<br>`verificationprogress`"
t: "number (real)" t: "number (real)"
p: "Required (exactly 1)" p: "Required<br>(exactly 1)"
d: "Estimate of what percentage of the block chain transactions have been verified so far, starting at 0.0 and increasing to 1.0 for fully verified. May slightly exceed 1.0 when fully synced to account for transactions in the memory pool which have been verified before being included in a block" d: "Estimate of what percentage of the block chain transactions have been verified so far, starting at 0.0 and increasing to 1.0 for fully verified. May slightly exceed 1.0 when fully synced to account for transactions in the memory pool which have been verified before being included in a block"
- n: "→<br>`chainwork`" - n: "→<br>`chainwork`"

View file

@ -31,7 +31,7 @@ The `getrawtransaction` RPC {{summary_getRawTransaction}}
- n: "Format" - n: "Format"
t: "bool" t: "bool"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "*Updated in Bitcoin Core 0.14.0*<br><br>Set to `false` (the default) to return the serialized transaction as hex. Set to `true` to return a decoded transaction" d: "*Updated in Bitcoin Core 0.14.0*<br><br>Set to `false` (the default) to return the serialized transaction as hex. Set to `true` to return a decoded transaction. Before 0.14.0, use `0` and `1`, respectively"
{% enditemplate %} {% enditemplate %}

View file

@ -7,7 +7,7 @@ http://opensource.org/licenses/MIT.
##### ImportMulti ##### ImportMulti
{% include helpers/subhead-links.md %} {% include helpers/subhead-links.md %}
{% assign summary_importMulti="imports addresses/scripts (with private or public keys, redeem script (P2SH)) and rescans all addresses in one-shot-only (can be disabled via options)." %} {% assign summary_importMulti="imports addresses or scripts (with private keys, public keys, or P2SH redeem scripts) and optionally performs the minimum necessary rescan for all imports." %}
{% autocrossref %} {% autocrossref %}
@ -23,7 +23,7 @@ The `importmulti` RPC {{summary_importMulti}}
- n: "Imports" - n: "Imports"
t: "array" t: "array"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "An array of JSON objects, each one being an address/script to be imported" d: "An array of JSON objects, each one being an address or script to be imported"
- n: "→ Import" - n: "→ Import"
t: "object" t: "object"
@ -31,34 +31,39 @@ The `importmulti` RPC {{summary_importMulti}}
d: "A JSON object describing a particular import" d: "A JSON object describing a particular import"
- n: "→ →<br>`scriptPubKey`" - n: "→ →<br>`scriptPubKey`"
t: "string (hex) / object" t: "string (hex)"
p: "Required<br>(exactly 1)" p: "Optional<br>(0 or 1)"
d: "The script (string) or address (JSON) to be imported" d: "The script (string) to be imported. Must have either this field or `address` below"
- n: "→ →<br>`timestamp` / “now”" - n: "→ →<br>`address`"
t: "string (base58)"
p: "Optional<br>(0 or 1)"
d: "The P2PKH or P2SH address to be imported. Must have either this field or `scriptPubKey` above"
- n: "→ →<br>`timestamp`"
t: "number (int) / string" t: "number (int) / string"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "The creation time of the key in Unix epoch time or the string “now” to substitute the current synced blockchain time. The timestamp of the oldest key will determine how far back blockchain rescans need to begin. “now” can be specified to bypass scanning, for keys which are known to never have been used, and 0 can be specified to scan the entire blockchain. Blocks up to 2 hours before the earliest key creation time will be scanned" d: "The creation time of the key in Unix epoch time or the string “now” to substitute the current synced block chain time. The timestamp of the oldest key will determine how far back block chain rescans need to begin. Specify `now` to bypass scanning for keys which are known to never have been used. Specify `0` to scan the entire block chain. Blocks up to 2 hours before the earliest key creation time will be scanned"
- n: "→ →<br>`redeemscript`" - n: "→ →<br>`redeemscript`"
t: "string" t: "string"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "A redeem script. Only allowed if the scriptPubKey is a P2SH address or a P2SH scriptPubKey" d: "A redeem script. Only allowed if either the `address` field is a P2SH address or the `scriptPubKey` field is a P2SH scriptPubKey"
- n: "→ →<br>`pubkeys`" - n: "→ →<br>`pubkeys`"
t: "array" t: "array"
p: "Required<br>(exactly 1)" p: "Optional<br>(0 or 1)"
d: "Array of strings giving pubkeys that must occur in the output or redeemscript" d: "Array of strings giving pubkeys that must occur in the scriptPubKey or redeemscript"
- n: "→ →<br>`keys`" - n: "→ →<br>`keys`"
t: "array" t: "array"
p: "Required<br>(exactly 1)" p: "Optional<br>(0 or 1)"
d: "Array of strings giving private keys whose corresponding public keys must occur in the output or redeemscript" d: "Array of strings giving private keys whose corresponding public keys must occur in the scriptPubKey or redeemscript"
- n: "→ →<br>`internal`" - n: "→ →<br>`internal`"
t: "bool" t: "bool"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "Stating whether matching outputs should not be treated as incoming payments. The default is `false`" d: "Stating whether matching outputs should be treated as change rather than incoming payments. The default is `false`"
- n: "→ →<br>`watchonly`" - n: "→ →<br>`watchonly`"
t: "bool" t: "bool"
@ -83,7 +88,7 @@ The `importmulti` RPC {{summary_importMulti}}
- n: "→ <br>`rescan`" - n: "→ <br>`rescan`"
t: "bool" t: "bool"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "Set to `true` (the default) to rescan the entire local blockchain for transactions affecting any imported address or script. Set to `false` to not rescan after the import. Rescanning may take up to an hour." d: "Set to `true` (the default) to rescan the entire local block chain for transactions affecting any imported address or script. Set to `false` to not rescan after the import. Rescanning may take a considerable amount of time and may require re-downloading blocks if using block chain pruning"
{% enditemplate %} {% enditemplate %}

View file

@ -25,7 +25,7 @@ The `preciousblock` RPC {{summary_preciousBlock}} A later `preciousblock` call c
{% enditemplate %} {% enditemplate %}
*Result---`null` plus error on failed remove* *Result---`null` or error on failure*
{% itemplate ntpd1 %} {% itemplate ntpd1 %}
- n: "`result`" - n: "`result`"
@ -35,7 +35,7 @@ The `preciousblock` RPC {{summary_preciousBlock}} A later `preciousblock` call c
{% enditemplate %} {% enditemplate %}
*Examples from Bitcoin Core 0.14.1* *Example from Bitcoin Core 0.14.1*
{% highlight bash %} {% highlight bash %}
bitcoin-cli preciousblock 000000000000000001517a0bac70b8cd6f27ee\ bitcoin-cli preciousblock 000000000000000001517a0bac70b8cd6f27ee\

View file

@ -21,7 +21,7 @@ The `pruneblockchain` RPC {{summary_pruneBlockChain}} The `-prune` option needs
- n: "Height" - n: "Height"
t: "number (int)" t: "number (int)"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "The block height to prune up to. May be set to a discrete height, or a unix timestamp to prune blocks whose block time is at least 2 hours older than the provided timestamp" d: "The block height to prune up to. May be set to a particular height, or a unix timestamp to prune blocks whose block time is at least 2 hours older than the provided timestamp"
{% enditemplate %} {% enditemplate %}

View file

@ -25,7 +25,7 @@ The `setnetworkactive` RPC {{summary_setNetworkActive}}
{% enditemplate %} {% enditemplate %}
*Result---`null` plus error on failed remove* *Result---`null` or error on failure*
{% itemplate ntpd1 %} {% itemplate ntpd1 %}
- n: "`result`" - n: "`result`"
@ -35,7 +35,7 @@ The `setnetworkactive` RPC {{summary_setNetworkActive}}
{% enditemplate %} {% enditemplate %}
*Examples from Bitcoin Core 0.14.1* *Example from Bitcoin Core 0.14.1*
{% highlight bash %} {% highlight bash %}
bitcoin-cli setnetworkactive true bitcoin-cli setnetworkactive true
@ -45,4 +45,6 @@ Result (no output from `bitcoin-cli` because result is set to `null`).
*See also* *See also*
* [GetNetworkInfo][rpc getnetworkinfo]: {{summary_getNetworkInfo}}
{% endautocrossref %} {% endautocrossref %}

View file

@ -63,7 +63,7 @@ This file is licensed under the terms of its source texts{%endcomment%}
{% assign summary_getWork="was removed in Bitcoin Core 0.10.0." %} {% assign summary_getWork="was removed in Bitcoin Core 0.10.0." %}
{% assign summary_help="lists all available public RPC commands, or gets help for the specified RPC. Commands which are unavailable will not be listed, such as wallet RPCs if wallet support is disabled." %} {% assign summary_help="lists all available public RPC commands, or gets help for the specified RPC. Commands which are unavailable will not be listed, such as wallet RPCs if wallet support is disabled." %}
{% assign summary_importAddress="adds an address or pubkey script to the wallet without the associated private key, allowing you to watch for transactions affecting that address or pubkey script without being able to spend any of its outputs." %} {% assign summary_importAddress="adds an address or pubkey script to the wallet without the associated private key, allowing you to watch for transactions affecting that address or pubkey script without being able to spend any of its outputs." %}
{% assign summary_importMulti="imports addresses/scripts (with private or public keys, redeem script (P2SH)) and rescans all addresses in one-shot-only (can be disabled via options)." %} {% assign summary_importMulti="imports addresses or scripts (with private keys, public keys, or P2SH redeem scripts) and optionally performs the minimum necessary rescan for all imports." %}
{% assign summary_importPrivKey="adds a private key to your wallet. The key should be formatted in the wallet import format created by the `dumpprivkey` RPC." %} {% assign summary_importPrivKey="adds a private key to your wallet. The key should be formatted in the wallet import format created by the `dumpprivkey` RPC." %}
{% assign summary_importPrunedFunds="imports funds without the need of a rescan. Meant for use with pruned wallets." %} {% assign summary_importPrunedFunds="imports funds without the need of a rescan. Meant for use with pruned wallets." %}
{% assign summary_importWallet="imports private keys from a file in wallet dump file format (see the `dumpwallet` RPC). These keys will be added to the keys currently in the wallet. This call may need to rescan all or parts of the block chain for transactions affecting the newly-added keys, which may take several minutes." %} {% assign summary_importWallet="imports private keys from a file in wallet dump file format (see the `dumpwallet` RPC). These keys will be added to the keys currently in the wallet. This call may need to rescan all or parts of the block chain for transactions affecting the newly-added keys, which may take several minutes." %}

View file

@ -144,12 +144,12 @@ untrusted source.
{% include devdoc/bitcoin-core/rpcs/rpcs/getinfo.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/getinfo.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/getmemoryinfo.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/getmempoolancestors.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/getmempoolancestors.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/getmempooldescendants.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/getmempooldescendants.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/getmemoryinfo.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/getmempoolentry.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/getmempoolentry.md %}
{% include devdoc/bitcoin-core/rpcs/rpcs/getmempoolinfo.md %} {% include devdoc/bitcoin-core/rpcs/rpcs/getmempoolinfo.md %}