diff --git a/Makefile b/Makefile index 5ab411f6..e26ffb2a 100644 --- a/Makefile +++ b/Makefile @@ -122,7 +122,7 @@ check-for-broken-kramdown-tables: ## Kramdown tables are easy to break. When broken, they produce a ## paragraph starting with a | (pipe). I can't imagine any reason we'd ## have a regular paragraph starting with a pipe, so error on any occurences. - $S grep '

|' _site/en/developer-* | eval $(ERROR_ON_OUTPUT) + $S grep ']*>|' _site/en/developer-* | eval $(ERROR_ON_OUTPUT) check-for-duplicate-header-ids: @@ -170,7 +170,8 @@ check-for-missing-rpc-summaries: ## Make sure the Quick Reference section has a summary for each RPC we ## have documented $S for f in _includes/ref/bitcoin-core/rpcs/rpcs/*.md ;\ - do grep -q "\[$$( grep '^##### ' $$f | sed 's/^##### *\([a-zA-Z]*\).*/\1/')\]\[" _includes/ref/bitcoin-core/rpcs/quick-ref.md || echo "missing summary for $$f" \ + do grep -q "\[$$( grep '^##### ' $$f | sed 's/^##### *\([a-zA-Z]*\).*/\1/')\]\[" _includes/ref/bitcoin-core/rpcs/quick-ref.md \ + || echo 'missing summary for '$$f', you need to add the summary to _includes/ref/bitcoin-core/rpcs/quick-ref.md and run make manual-updates' \ ; done | eval $(ERROR_ON_OUTPUT) manual-update-summaries-file: diff --git a/_includes/helpers/vars.md b/_includes/helpers/vars.md index f692d82f..e291a0e5 100644 --- a/_includes/helpers/vars.md +++ b/_includes/helpers/vars.md @@ -28,6 +28,7 @@ http://opensource.org/licenses/MIT. {% capture INCLUDE_SPEND_CONFIRMATIONS %}| Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Confirmations | number (int) | Optional
(0 or 1) | The minimum number of confirmations an incoming transaction must have for its outputs to be credited to this account's balance. Outgoing transactions are always counted, as are move transactions made with the `move` RPC. If an account doesn't have a balance high enough to pay for this transaction, the payment will be rejected. Use `0` to spend unconfirmed incoming payments. Default is `1` +{:.ntpd} ![Warning icon](/img/icons/icon_warning.svg) **Warning:** if account1 receives an unconfirmed payment and transfers @@ -63,10 +64,12 @@ bitcoins even if this parameter is set to `1` or higher.{% endcapture %} {% capture INCLUDE_CONFIRMATIONS_PARAMETER %}| Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- -| Confirmations | number (int) | Optional
(0 or 1) | The minimum number of confirmations an externally-generated transaction must have before it is counted towards the balance. Transactions generated by this node are counted immediately. Typically, externally-generated transactions are payments to this wallet and transactions generated by this node are payments to other wallets. Use `0` to count unconfirmed transactions. Default is `1`{% endcapture %} +| Confirmations | number (int) | Optional
(0 or 1) | The minimum number of confirmations an externally-generated transaction must have before it is counted towards the balance. Transactions generated by this node are counted immediately. Typically, externally-generated transactions are payments to this wallet and transactions generated by this node are payments to other wallets. Use `0` to count unconfirmed transactions. Default is `1` +{:.ntpd}{% endcapture %} {% capture INCLUDE_INCLUDE_WATCH_ONLY_PARAMETER %}| Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- -| Include Watch-Only | bool | Optional
(0 or 1) | *Added in Bitcoin Core 0.10.0*

If set to `true`, include watch-only addresses in details and calculations as if they were regular addresses belonging to the wallet. If set to `false` (the default), treat watch-only addresses as if they didn't belong to this wallet{% endcapture %} +| Include Watch-Only | bool | Optional
(0 or 1) | *Added in Bitcoin Core 0.10.0*

If set to `true`, include watch-only addresses in details and calculations as if they were regular addresses belonging to the wallet. If set to `false` (the default), treat watch-only addresses as if they didn't belong to this wallet +{:.ntpd}{% endcapture %} {% assign WARNING="![Warning icon](/img/icons/icon_warning.svg) **Warning:**" %} diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/addmultisigaddress.md b/_includes/ref/bitcoin-core/rpcs/rpcs/addmultisigaddress.md index 0e435bbf..57803ea7 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/addmultisigaddress.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/addmultisigaddress.md @@ -20,6 +20,7 @@ The `addmultisigaddress` RPC {{summary_addMultiSigAddress}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Required | number (int) | Required
(exactly 1) | The minimum (*m*) number of signatures required to spend this m-of-n multisig script +{:.ntpd} *Parameter #2---the full public keys, or addresses for known public keys* @@ -27,18 +28,21 @@ The `addmultisigaddress` RPC {{summary_addMultiSigAddress}} |---------------------|-----------------|-----------------------------|---------------- | Keys Or Addresses | array | Required
(exactly 1) | An array of strings with each string being a public key or address | →
Key Or Address | string | Required
(1 or more) | A public key against which signatures will be checked. Alternatively, this may be a P2PKH address belonging to the wallet---the corresponding public key will be substituted. There must be at least as many keys as specified by the Required parameter, and there may be more keys +{:.ntpd} *Parameter #3---the account name* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Account | string | Optional
(0 or 1) | The account name in which the address should be stored. Default is the default account, "" (an empty string) +{:.ntpd} *Result---a P2SH address printed and stored in the wallet* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | string (base58) | Required
(exactly 1) | The P2SH multisig address. The address will also be added to the wallet, and outputs paying that address will be tracked by the wallet +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/addnode.md b/_includes/ref/bitcoin-core/rpcs/rpcs/addnode.md index 99d7db88..9ea3755d 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/addnode.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/addnode.md @@ -18,18 +18,21 @@ The `addnode` RPC {{summary_addNode}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Node | string | Required
(exactly 1) | The node to add as a string in the form of `:`. The IP address may be a hostname resolvable through DNS, an IPv4 address, an IPv4-as-IPv6 address, or an IPv6 address +{:.ntpd} *Parameter #2---whether to add or remove the node, or to try only once to connect* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Command | string | Required
(exactly 1) | What to do with the IP address above. Options are:
• `add` to add a node to the addnode list. This will not connect immediately if the outgoing connection slots are full
• `remove` to remove a node from the list. If currently connected, this will disconnect immediately
• `onetry` to immediately attempt connection to the node even if the outgoing connection slots are full; this will only attempt the connection once +{:.ntpd} *Result---`null` plus error on failed remove* | Name | Type | Presence | Description |------------------|-----------------|-----------------------------|---------------- | `result` | null | Required
(exactly 1) | Always JSON `null` whether the node was added, removed, tried-and-connected, or tried-and-not-connected. The JSON-RPC error field will be set only if you try removing a node that is not on the addnodes list +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/backupwallet.md b/_includes/ref/bitcoin-core/rpcs/rpcs/backupwallet.md index 8d4ae019..435ef65a 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/backupwallet.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/backupwallet.md @@ -20,12 +20,14 @@ The `backupwallet` RPC {{summary_backupWallet}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Destination | string | Required
(exactly 1) | A filename or directory name. If a filename, it will be created or overwritten. If a directory name, the file `wallet.dat` will be created or overwritten within that directory +{:.ntpd} *Result---`null` or error* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | null | Required
(exactly 1) | Always `null` whether success or failure. The JSON-RPC error and message fields will be set if a failure occurred +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/createmultisig.md b/_includes/ref/bitcoin-core/rpcs/rpcs/createmultisig.md index b1839290..87727664 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/createmultisig.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/createmultisig.md @@ -18,6 +18,7 @@ The `createmultisig` RPC {{summary_createMultiSig}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Required | number (int) | Required
(exactly 1) | The minimum (*m*) number of signatures required to spend this m-of-n multisig script +{:.ntpd} *Parameter #2---the full public keys, or addresses for known public keys* @@ -25,6 +26,7 @@ The `createmultisig` RPC {{summary_createMultiSig}} |---------------------|-----------------|-----------------------------|---------------- | Keys Or Addresses | array | Required
(exactly 1) | An array of strings with each string being a public key or address | →
Key Or Address | string | Required
(1 or more) | A public key against which signatures will be checked. If wallet support is enabled, this may be a P2PKH address belonging to the wallet---the corresponding public key will be substituted. There must be at least as many keys as specified by the Required parameter, and there may be more keys +{:.ntpd} *Result---P2SH address and hex-encoded redeem script* @@ -33,6 +35,7 @@ The `createmultisig` RPC {{summary_createMultiSig}} | `result` | object | Required
(exactly 1) | An object describing the multisig address | →
`address` | string (base58) | Required
(exactly 1) | The P2SH address for this multisig redeem script | →
`redeemScript` | string (hex) | Required
(exactly 1) | The multisig redeem script encoded as hex +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/createrawtransaction.md b/_includes/ref/bitcoin-core/rpcs/rpcs/createrawtransaction.md index 4be9e9e6..de4ea2b9 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/createrawtransaction.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/createrawtransaction.md @@ -21,6 +21,7 @@ The `createrawtransaction` RPC {{summary_createRawTransaction}} | → Outpoint | object | Required
(1 or more) | An object describing a particular unspent outpoint | → →
`txid` | string (hex) | Required
(exactly 1) | The TXID of the outpoint encoded as hex in RPC byte order | → →
`vout` | number (int) | Required
(exactly 1) | The output index number (vout) of the outpoint; the first output in a transaction is index `0` +{:.ntpd} *Parameter #2---P2PKH or P2SH addresses and amounts* @@ -28,12 +29,14 @@ The `createrawtransaction` RPC {{summary_createRawTransaction}} |---------------------|-----------------|-----------------------------|---------------- | Outputs | object | Required
(exactly 1) | The addresses and amounts to pay | →
Address/Amount | string : number (bitcoins) | Required
(1 or more) | A key/value pair with the address to pay as a string (key) and the amount to pay that address (value) in bitcoins +{:.ntpd} *Result---the unsigned raw transaction in hex* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | string | Required
(Exactly 1) | The resulting unsigned raw transaction in serialized transaction format encoded as hex. If the transaction couldn't be generated, this will be set to JSON `null` and the JSON-RPC error field may contain an error message +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/decoderawtransaction.md b/_includes/ref/bitcoin-core/rpcs/rpcs/decoderawtransaction.md index f260a0a1..50fc9e45 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/decoderawtransaction.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/decoderawtransaction.md @@ -18,6 +18,7 @@ The `decoderawtransaction` RPC {{summary_decodeRawTransaction}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Serialized Transaction | string (hex) | Required
(exactly 1) | The transaction to decode in serialized transaction format +{:.ntpd} *Result---the decoded transaction* @@ -25,6 +26,7 @@ The `decoderawtransaction` RPC {{summary_decodeRawTransaction}} |--------------------|-----------------|-----------------------------|---------------- | `result` | object | Required
(exactly 1) | An object describing the decoded transaction, or JSON `null` if the transaction could not be decoded {{INCLUDE_DECODE_RAW_TRANSACTION}} +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/decodescript.md b/_includes/ref/bitcoin-core/rpcs/rpcs/decodescript.md index 731b261d..9782e896 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/decodescript.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/decodescript.md @@ -18,6 +18,7 @@ The `decodescript` RPC {{summary_decodeScript}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Redeem Script | string (hex) | Required
(exactly 1) | The redeem script to decode as a hex-encoded serialized script +{:.ntpd} *Result---the decoded script* @@ -30,6 +31,7 @@ The `decodescript` RPC {{summary_decodeScript}} | →
`addresses` | array | Optional
(0 or 1) | A P2PKH addresses used in this script, or the computed P2PKH addresses of any pubkeys in this script. This array will not be returned for `nonstandard` script types | → →
Address | string | Required
(1 or more) | A P2PKH address | →
`p2sh` | string (hex) | Required
(exactly 1) | The P2SH address of this redeem script +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/dumpprivkey.md b/_includes/ref/bitcoin-core/rpcs/rpcs/dumpprivkey.md index 7d46732e..83b3fa35 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/dumpprivkey.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/dumpprivkey.md @@ -21,12 +21,14 @@ The `dumpprivkey` RPC {{summary_dumpPrivKey}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | P2PKH Address | string (base58) | Required
(exactly 1) | The P2PKH address corresponding to the private key you want returned. Must be the address corresponding to a private key in this wallet +{:.ntpd} *Result---the private key* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | string (base58) | Required
(exactly 1) | The private key encoded as base58check using wallet import format +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/dumpwallet.md b/_includes/ref/bitcoin-core/rpcs/rpcs/dumpwallet.md index 7080ebeb..0f1757c4 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/dumpwallet.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/dumpwallet.md @@ -21,12 +21,14 @@ The `dumpwallet` RPC {{summary_dumpWallet}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Filename | string | Required
(exactly 1) | The file in which the wallet dump will be placed. May be prefaced by an absolute file path. An existing file with that name will be overwritten +{:.ntpd} *Result---`null` or error* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | null | Required
(exactly 1) | Always `null` whether success or failure. The JSON-RPC error and message fields will be set if a failure occurred +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/encryptwallet.md b/_includes/ref/bitcoin-core/rpcs/rpcs/encryptwallet.md index fbf1991b..7fe6a331 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/encryptwallet.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/encryptwallet.md @@ -27,12 +27,14 @@ the `dumpwallet` RPC. | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Passphrase | string | Required
(exactly 1) | The passphrase to use for the encrypted wallet. Must be at least one character +{:.ntpd} *Result---a notice (with program shutdown)* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | string | Required
(exactly 1) | A notice that the server is stopping and that you need to make a new backup. The wallet is now encrypted +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/estimatefee.md b/_includes/ref/bitcoin-core/rpcs/rpcs/estimatefee.md index 309cc17c..7ea24d7c 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/estimatefee.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/estimatefee.md @@ -20,12 +20,14 @@ The `estimatefee` RPC {{summary_estimateFee}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Blocks | number (int) | Required
(exactly 1) | The maximum number of blocks a transaction should have to wait before it is predicted to be included in a block +{:.ntpd} *Result---the fee the transaction needs to pay per kilobyte* | Name | Type | Presence | Description |--------------------|-------------------|-----------------------------|---------------- | `result` | number (bitcoins) | Required
(exactly 1) | The estimated fee the transaction should pay in order to be included within the specified number of blocks. If the node doesn't have enough information to make an estimate, the value `-1` will be returned +{:.ntpd} *Examples from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/estimatepriority.md b/_includes/ref/bitcoin-core/rpcs/rpcs/estimatepriority.md index a6991787..ff754b86 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/estimatepriority.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/estimatepriority.md @@ -22,12 +22,14 @@ Transaction priority is relative to a transaction's byte size. | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Blocks | number (int) | Required
(exactly 1) | The maximum number of blocks a transaction should have to wait before it is predicted to be included in a block based purely on its priority +{:.ntpd} *Result---the priority a transaction needs* | Name | Type | Presence | Description |--------------------|-------------------|-----------------------------|---------------- | `result` | number (real) | Required
(exactly 1) | The estimated priority the transaction should have in order to be included within the specified number of blocks. If the node doesn't have enough information to make an estimate, the value `-1` will be returned +{:.ntpd} *Examples from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getaccount.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getaccount.md index ed2ec5bd..07e5e29f 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getaccount.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getaccount.md @@ -20,12 +20,14 @@ The `getaccount` RPC {{summary_getAccount}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Address | string (base58) | Required
(exactly 1) | A P2PKH or P2SH Bitcoin address belonging either to a specific account or the default account ("") +{:.ntpd} *Result---an account name* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | string | Required
(exactly 1) | The name of an account, or an empty string ("", the default account) +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getaccountaddress.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getaccountaddress.md index b33d8494..deb66320 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getaccountaddress.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getaccountaddress.md @@ -20,12 +20,14 @@ The `getaccountaddress` RPC {{summary_getAccountAddress}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Account | string | Required
(exactly 1) | The name of an account. Use an empty string ("") for the default account. If the account doesn't exist, it will be created +{:.ntpd} *Result---a bitcoin address* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | string (base58) | Required
(exactly 1) | An address, belonging to the account specified, which has not yet received any payments +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getaddednodeinfo.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getaddednodeinfo.md index 298e7a72..abba74a2 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getaddednodeinfo.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getaddednodeinfo.md @@ -18,12 +18,14 @@ The `getaddednodeinfo` RPC {{summary_getAddedNodeInfo}} | Name | Type | Presence | Description |------------------|--------------|-----------------------------|---------------- | Details | bool | Required
(exactly 1) | Set to `true` to display detailed information about each added node; set to `false` to only display the IP address or hostname and port added +{:.ntpd} *Parameter #2---what node to display information about* | Name | Type | Presence | Description |------------------|--------------|-----------------------------|---------------- | Node | string | Optional
(0 or 1) | The node to get information about in the same `:` format as the `addnode` RPC. If this parameter is not provided, information about all added nodes will be returned +{:.ntpd} *Result---a list of added nodes* @@ -37,6 +39,7 @@ The `getaddednodeinfo` RPC {{summary_getAddedNodeInfo}} | → → →
Address | object | Optional
(0 or more) | An object describing one of this node's addresses | → → → →
`address` | string | Required
(exactly 1) | An IP address and port number of the node. If the node was added using a DNS address, this will be the resolved IP address | → → → →
`connected` | string | Required
(exactly 1) | Whether or not the local node is connected to this addnode using this IP address. Valid values are:
• `false` for not connected
• `inbound` if the addnode connected to us
• `outbound` if we connected to the addnode +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getaddressesbyaccount.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getaddressesbyaccount.md index 2a35d58c..7d1728a6 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getaddressesbyaccount.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getaddressesbyaccount.md @@ -20,6 +20,7 @@ The `getaddressesbyaccount` RPC {{summary_getAddressesByAccount}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Account | string | Required
(exactly 1) | The name of the account containing the addresses to get. To get addresses from the default account, pass an empty string ("") +{:.ntpd} *Result---a list of addresses* @@ -27,6 +28,7 @@ The `getaddressesbyaccount` RPC {{summary_getAddressesByAccount}} |--------------------|-----------------|-----------------------------|---------------- | `result` | array | Required
(exactly 1) | An array containing all addresses belonging to the specified account. If the account has no addresses, the array will be empty | Address | string (base58) | Optional
(1 or more) | A P2PKH or P2SH address belonging to the account +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getbalance.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getbalance.md index 19caaaae..b6c86416 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getbalance.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getbalance.md @@ -20,6 +20,7 @@ The `getbalance` RPC {{summary_getBalance}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Account | string | Optional
(0 or 1) | The name of an account to get the balance for. An empty string ("") is the default account. The string `*` will get the balance for all accounts (this is the default behavior) +{:.ntpd} *Parameter #2---the minimum number of confirmations* @@ -34,6 +35,7 @@ The `getbalance` RPC {{summary_getBalance}} | Name | Type | Presence | Description |--------------------|-------------------|-----------------------------|---------------- | `result` | number (bitcoins) | Required
(exactly 1) | The balance of the account (or all accounts) in bitcoins +{:.ntpd} *Examples from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getbestblockhash.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getbestblockhash.md index 71c703e2..dfdbea74 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getbestblockhash.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getbestblockhash.md @@ -22,6 +22,7 @@ The `getbestblockhash` RPC {{summary_getBestBlockHash}} | Name | Type | Presence | Description |------------------|--------------|-----------------------------|---------------- | `result` | string (hex) | Required
(exactly 1) | The hash of the block header from the most recent block on the best block chain, encoded as hex in RPC byte order +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getblock.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getblock.md index a99f3b79..7e95842c 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getblock.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getblock.md @@ -18,18 +18,21 @@ The `getblock` RPC {{summary_getBlock}} | Name | Type | Presence | Description |------------------|--------------|-----------------------------|---------------- | Header Hash | string (hex) | Required
(exactly 1) | The hash of the header of the block to get, encoded as hex in RPC byte order +{:.ntpd} *Parameter #2---JSON or hex output* | Name | Type | Presence | Description |------------------|--------------|-----------------------------|---------------- | Format | bool | Optional
(0 or 1) | Set to `false` to get the block in serialized block format; set to `true` (the default) to get the decoded block as a JSON object +{:.ntpd} *Result (if format was `false`)---a serialized block* | Name | Type | Presence | Description |------------------|-------------------|-----------------------------|---------------- | `result` | string (hex)/null | Required
(exactly 1) | The requested block as a serialized block, encoded as hex, or JSON `null` if an error occurred +{:.ntpd} *Result (if format was `true` or omitted)---a JSON block* @@ -51,6 +54,7 @@ The `getblock` RPC {{summary_getBlock}} | →
`chainwork` | string (hex) | Required
(exactly 1) | The estimated number of block header hashes miners had to check from the genesis block to this block, encoded as big-endian hex | →
`previousblockhash` | string (hex) | Required
(exactly 1) | The hash of the header of the previous block, encoded as hex in RPC byte order | →
`nextblockhash` | string (hex) | Optional
(0 or 1) | The hash of the next block on the best block chain, if known, encoded as hex in RPC byte order +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getblockchaininfo.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getblockchaininfo.md index d1c76aed..d54622e4 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getblockchaininfo.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getblockchaininfo.md @@ -29,6 +29,7 @@ The `getblockchaininfo` RPC {{summary_getBlockChainInfo}} | →
`difficulty` | number (real) | Required
(exactly 1) | The difficulty of the highest-height block in the best block chain | →
`verificationprogress` | number (real) | Required (exactly 1) | 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 | →
`chainwork` | string (hex) | Required
(exactly 1) | The estimated number of block header hashes checked from the genesis block to this block, encoded as big-endian hex +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getblockcount.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getblockcount.md index c8ab2139..6ab7ecfd 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getblockcount.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getblockcount.md @@ -20,6 +20,7 @@ The `getblockcount` RPC {{summary_getBlockCount}} | Name | Type | Presence | Description |------------------|-----------------|-----------------------------|---------------- | `result` | number (int) | Required
(exactly 1) | The number of blocks in the local best block chain. For a new node with only the hardcoded genesis block, this number will be 0 +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getblockhash.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getblockhash.md index 1317f80b..08f746f9 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getblockhash.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getblockhash.md @@ -18,12 +18,14 @@ The `getblockhash` RPC {{summary_getBlockHash}} | Name | Type | Presence | Description |------------------|-----------------|-----------------------------|---------------- | Block Height | number (int) | Required
(exactly 1) | The height of the block whose header hash should be returned. The height of the hardcoded genesis block is 0 +{:.ntpd} *Result---the block header hash* | Name | Type | Presence | Description |------------------|-----------------|-----------------------------|---------------- | `result` | string (hex)/null | Required
(exactly 1) | The hash of the block at the requested height, encoded as hex in RPC byte order, or JSON `null` if an error occurred +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getchaintips.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getchaintips.md index 87b7c082..4c7352e0 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getchaintips.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getchaintips.md @@ -27,6 +27,7 @@ The `getchaintips` RPC {{summary_getChainTips}} | → →
`hash` | string (hex) | Required
(exactly 1) | The hash of the highest block in the chain, encoded as hex in RPC byte order | → →
`branchlen` | number (int) | Required
(exactly 1) | The number of blocks that are on this chain but not on the main chain. For the local best block chain, this will be `0`; for all other chains, it will be at least `1` | → →
`status` | string | Required
(exactly 1) | The status of this chain. Valid values are:
• `active` for the local best block chain
• `invalid` for a chain that contains one or more invalid blocks
• `headers-only` for a chain with valid headers whose corresponding blocks both haven't been validated and aren't stored locally
• `valid-headers` for a chain with valid headers whose corresponding blocks are stored locally, but which haven't been fully validated
• `valid-fork` for a chain which is fully validated but which isn't part of the local best block chain (it was probably the local best block chain at some point)
• `unknown` for a chain whose reason for not being the active chain is unknown +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getconnectioncount.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getconnectioncount.md index d422a06c..5d6aae79 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getconnectioncount.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getconnectioncount.md @@ -20,6 +20,7 @@ The `getconnectioncount` RPC {{summary_getConnectionCount}} | Name | Type | Presence | Description |------------------|-----------------|-----------------------------|---------------- | `result` | number (int) | Required
(exactly 1) | The total number of connections to other nodes (both inbound and outbound) +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getdifficulty.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getdifficulty.md index 4a23f77e..6f7bfd9d 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getdifficulty.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getdifficulty.md @@ -20,6 +20,7 @@ The `getdifficulty` RPC {{summary_getDifficulty}} | Name | Type | Presence | Description |------------------|-------------------|-----------------------------|---------------- | `result` | number (real) | Required
(exactly 1) | The difficulty of creating a block with the same target threshold (nBits) as the highest-height block in the local best block chain. The number is a a multiple of the minimum difficulty +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getgenerate.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getgenerate.md index be5b02a0..6b84105a 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getgenerate.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getgenerate.md @@ -22,6 +22,7 @@ The `getgenerate` RPC {{summary_getGenerate}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | bool | Required
(exactly 1) | Set to `true` if the server is set to generate blocks; set to `false` if it is not +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/gethashespersec.md b/_includes/ref/bitcoin-core/rpcs/rpcs/gethashespersec.md index 379ed775..23abbd63 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/gethashespersec.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/gethashespersec.md @@ -22,6 +22,7 @@ The `gethashespersec` RPC {{summary_getHashesPerSec}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | number (int) | Required
(exactly 1) | If generation is enabled, the number of hashes per second your computer most recently generated. If generation is disabled, the value `0` +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getinfo.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getinfo.md index 161e1009..b8053b57 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getinfo.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getinfo.md @@ -39,6 +39,7 @@ Core. Use the RPCs listed in the See Also subsection below instead. | →
`relayfee` | number (bitcoins) | Required
(exactly 1) | The minimum fee a low-priority transaction must pay in order for this node to accept it into its memory pool | →
`unlocked_until` | number (int) | Optional
(0 or 1) | The Unix epoch time when the wallet will automatically re-lock. Only displayed if wallet encryption is enabled. Set to `0` if wallet is currently locked | →
`errors` | string | Required
(exactly 1) | A plain-text description of any errors this node has encountered or detected. If there are no errors, an empty string will be returned. This is not related to the JSON-RPC `error` field +{:.ntpd} *Example from Bitcoin Core 0.10.0 with wallet support enabled* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getmempoolinfo.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getmempoolinfo.md index 84a1ec04..7672efdb 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getmempoolinfo.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getmempoolinfo.md @@ -24,6 +24,7 @@ The `getmempoolinfo` RPC {{summary_getMemPoolInfo}} | `result` | object | Required
(exactly 1) | A object containing information about the memory pool | →
`size` | number (int) | Required
(exactly 1) | The number of transactions currently in the memory pool | →
`bytes` | number (int) | Required
(exactly 1) | The total number of bytes in the transactions in the memory pool +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getmininginfo.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getmininginfo.md index aff8d41a..96909f98 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getmininginfo.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getmininginfo.md @@ -32,6 +32,7 @@ The `getmininginfo` RPC {{summary_getMiningInfo}} | →
`chain` | string | Required
(exactly 1) | Set to `main` for mainnet, `test` for testnet, and `regtest` for regtest | →
`generate` | bool | Optional
(0 or 1) | Set to `true` if generation is currently enabled; set to `false` if generation is currently disabled. Only returned if the node has wallet support enabled | →
`hashespersec` | number (int) | Optional
(0 or 1) | The approximate number of hashes per second this node is generating across all CPUs, if generation is enabled. Otherwise `0`. Only returned if the node has wallet support enabled +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getnettotals.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getnettotals.md index 730c395a..178adce2 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getnettotals.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getnettotals.md @@ -23,6 +23,7 @@ The `getnettotals` RPC {{summary_getNetTotals}} | →
`totalbytesrecv` | number (int) | Required
(exactly 1) | The total number of bytes received since the node was last restarted | →
`totalbytessent` | number (int) | Required
(exactly 1) | The total number of bytes sent since the node was last restarted | →
`timemillis` | number (int) | Required
(exactly 1) | Unix epoch time in milliseconds according to the operating system's clock (not the node adjusted time) +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getnetworkhashps.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getnetworkhashps.md index 37074975..04858195 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getnetworkhashps.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getnetworkhashps.md @@ -18,18 +18,21 @@ The `getnetworkhashps` RPC {{summary_getNetworkHashPS}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Blocks | number (int) | Optional
(0 or 1) | The number of blocks to average together for calculating the estimated hashes per second. Default is `120`. Use `-1` to average all blocks produced since the last difficulty change +{:.ntpd} *Parameter #2---block height* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Height | number (int) | Optional
(0 or 1) | The height of the last block to use for calculating the average. Defaults to `-1` for the highest-height block on the local best block chain. If the specified height is higher than the highest block on the local best block chain, it will be interpreted the same as `-1` +{:.ntpd} *Result---estimated hashes per second* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | number (int) | Required
(exactly 1) | The estimated number of hashes per second based on the parameters provided. May be 0 (for Height=`0`, the genesis block) or a negative value if the highest-height block averaged has a block header time earlier than the lowest-height block averaged +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getnetworkinfo.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getnetworkinfo.md index a41b1a2d..b4b46ccf 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getnetworkinfo.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getnetworkinfo.md @@ -41,6 +41,7 @@ The `getnetworkinfo` RPC {{summary_getNetworkInfo}} | → → → → →
`address` | string | Required
(exactly 1) | An IP address or .onion address this node believes it listens on. This may be manually configured, auto detected, or based on `version` messages this node received from its peers | → → → → →
`port` | number (int) | Required
(exactly 1) | The port number this node believes it listens on for the associated `address`. This may be manually configured, auto detected, or based on `version` messages this node received from its peers | → → → → →
`score` | number (int) | Required
(exactly 1) | The self-assigned score this node gives to this connection; higher scores means the node thinks this connection is better +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getnewaddress.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getnewaddress.md index 3cef169e..e3c2104d 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getnewaddress.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getnewaddress.md @@ -20,12 +20,14 @@ The `getnewaddress` RPC {{summary_getNewAddress}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Account | string | Optional
(0 or 1) | The name of the account to put the address in. The default is the default account, an empty string ("") +{:.ntpd} *Result---a bitcoin address never previously returned* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | string (base58) | Required
(exactly 1) | A P2PKH address which has not previously been returned by this RPC. The address will be marked as a receiving address in the wallet. The address may already have been part of the keypool, so other RPCs such as the `dumpwallet` RPC may have disclosed it previously. If the wallet is unlocked, its keypool will also be filled to its max (by default, 100 unused keys). If the wallet is locked and its keypool is empty, this RPC will fail +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getpeerinfo.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getpeerinfo.md index ccacdfdc..14b8e66d 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getpeerinfo.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getpeerinfo.md @@ -43,6 +43,7 @@ The `getpeerinfo` RPC {{summary_getPeerInfo}} | → →
`inflight` | array | Required
(exactly 1) | *Added in Bitcoin Core 0.10.0*

An array of blocks which have been requested from this peer. May be empty | → → →
Blocks | number (int) | Optional
(0 or more) | The height of a block being requested from the remote peer | → →
`whitelisted` | bool | Required
(exactly 1) | *Added in Bitcoin Core 0.10.0*

Set to `true` if the remote peer has been whitelisted; otherwise, set to `false`. Whitelisted peers will not be banned if their ban score exceeds the maximum (100 by default). By default, peers connecting from localhost are whitelisted +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getrawchangeaddress.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getrawchangeaddress.md index 57af7c5b..3227779d 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getrawchangeaddress.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getrawchangeaddress.md @@ -22,6 +22,7 @@ The `getrawchangeaddress` RPC {{summary_getRawChangeAddress}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | string (base58) | Required
(exactly 1) | A P2PKH address which has not previously been returned by this RPC. The address will be removed from the keypool but not marked as a receiving address, so RPCs such as the `dumpwallet` RPC will show it as a change address. The address may already have been part of the keypool, so other RPCs such as the `dumpwallet` RPC may have disclosed it previously. If the wallet is unlocked, its keypool will also be filled to its max (by default, 100 unused keys). If the wallet is locked and its keypool is empty, this RPC will fail +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getrawmempool.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getrawmempool.md index d3897900..381ff813 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getrawmempool.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getrawmempool.md @@ -18,6 +18,7 @@ The `getrawmempool` RPC {{summary_getRawMemPool}} | Name | Type | Presence | Description |------------------|-----------------|-----------------------------|---------------- | Format | bool | Optional
(0 or 1) | Set to `true` to get verbose output describing each transaction in the memory pool; set to `false` (the default) to only get an array of TXIDs for transactions in the memory pool +{:.ntpd} *Result (format `false`)---an array of TXIDs* @@ -25,6 +26,7 @@ The `getrawmempool` RPC {{summary_getRawMemPool}} |------------------|-----------------|-----------------------------|---------------- | `result` | array | Required
(exactly 1) | An array of TXIDs belonging to transactions in the memory pool. The array may be empty if there are no transactions in the memory pool | →
TXID | string | Optional
(0 or more) | The TXID of a transaction in the memory pool, encoded as hex in RPC byte order +{:.ntpd} *Result (format: `true`)---a JSON object describing each transaction* @@ -40,6 +42,7 @@ The `getrawmempool` RPC {{summary_getRawMemPool}} | → →
`currentpriority` | number (int) | Required
(exactly 1) | The current priority of the transaction | → →
`depends` | array | Required
(exactly 1) | An array holding TXIDs of unconfirmed transactions this transaction depends upon. Those transactions must be part of a block before this transaction can be added to a block, although all transactions may be included in the same block. The array may be empty | → → →
Depends TXID | string | Optional (0 or more) | The TXIDs of any unconfirmed transactions this transaction depends upon, encoded as hex in RPC byte order +{:.ntpd} *Examples from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getrawtransaction.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getrawtransaction.md index cc227f15..dea136d2 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getrawtransaction.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getrawtransaction.md @@ -18,24 +18,28 @@ The `getrawtransaction` RPC {{summary_getRawTransaction}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | TXID | string (hex) | Required
(exactly 1) | The TXID of the transaction to get, encoded as hex in RPC byte order +{:.ntpd} *Parameter #2---whether to get the serialized or decoded transaction* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Verbose | number (int) | Optional
(0 or 1) | Set to `0` (the default) to return the serialized transaction as hex. Set to `1` to return a decoded transaction +{:.ntpd} *Result (if transaction not found)---`null`* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | null | Required
(exactly 1) | If the transaction wasn't found, the result will be JSON `null`. This can occur because the transaction doesn't exist in the block chain or memory pool, or because it isn't part of the transaction index. See the Bitcoin Core `-help` entry for `-txindex` +{:.ntpd} *Result (if verbose=`0`)---the serialized transaction* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | string (hex) | Required
(exactly 1) | If the transaction was found, this will be the serialized transaction encoded as hex +{:.ntpd} *Result (if verbose=`1`)---the decoded transaction* @@ -47,6 +51,7 @@ The `getrawtransaction` RPC {{summary_getRawTransaction}} | →
`confirmations` | number (int) | Required
(exactly 1) | If the transaction has been included in a block on the local best block chain, this is how many confirmations it has. Otherwise, this is `0` | →
`time` | number (int) | Optional
(0 or 1) | If the transaction has been included in a block on the local best block chain, this is the block header time of that block (may be in the future) | →
`blocktime` | number (int) | Optional
(0 or 1) | This field is currently identical to the time field described above +{:.ntpd} *Examples from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getreceivedbyaccount.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getreceivedbyaccount.md index 7ecdf516..49435fae 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getreceivedbyaccount.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getreceivedbyaccount.md @@ -20,6 +20,7 @@ The `getreceivedbyaccount` RPC {{summary_getReceivedByAccount}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Account | string | Required
(exactly 1) | The name of the account containing the addresses to get. For the default account, use an empty string ("") +{:.ntpd} *Parameter #2---the minimum number of confirmations* @@ -30,6 +31,7 @@ The `getreceivedbyaccount` RPC {{summary_getReceivedByAccount}} | Name | Type | Presence | Description |--------------------|-------------------|-----------------------------|---------------- | `result` | number (bitcoins) | Required
(exactly 1) | The number of bitcoins received by the account. May be `0` +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getreceivedbyaddress.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getreceivedbyaddress.md index e33b01f6..6ddebe19 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getreceivedbyaddress.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getreceivedbyaddress.md @@ -20,6 +20,7 @@ The `getreceivedbyaddress` RPC {{summary_getReceivedByAddress}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Address | string | Required
(exactly 1) | The address whose transactions should be tallied +{:.ntpd} *Parameter #2---the minimum number of confirmations* @@ -30,6 +31,7 @@ The `getreceivedbyaddress` RPC {{summary_getReceivedByAddress}} | Name | Type | Presence | Description |--------------------|-------------------|-----------------------------|---------------- | `result` | number (bitcoins) | Required
(exactly 1) | The number of bitcoins received by the address, excluding coinbase transactions. May be `0` +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/gettransaction.md b/_includes/ref/bitcoin-core/rpcs/rpcs/gettransaction.md index fb1e6996..874b3047 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/gettransaction.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/gettransaction.md @@ -20,6 +20,7 @@ The `gettransaction` RPC {{summary_getTransaction}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | TXID | string (hex) | Required
(exactly 1) | The TXID of the transaction to get details about. The TXID must be encoded as hex in RPC byte order +{:.ntpd} *Parameter #2---whether to include watch-only addresses in details and calculations* @@ -41,6 +42,7 @@ The `gettransaction` RPC {{summary_getTransaction}} | → →
`vout` | number (int) | Required
(exactly 1) | *Added in Bitcoin Core 0.10.0*

For an output, the output index (vout) for this output in this transaction. For an input, the output index for the output being spent in its transaction. Because inputs list the output indexes from previous transactions, more than one entry in the details array may have the same output index | → →
`fee` | number (bitcoins) | Optional
(0 or 1) | If sending payment, the fee paid as a negative bitcoins value. May be `0`. Not returned if receiving payment | →
`hex` | string (hex) | Required
(exactly 1) | The transaction in serialized transaction format +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/gettxout.md b/_includes/ref/bitcoin-core/rpcs/rpcs/gettxout.md index bb6bc7fb..f89cf004 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/gettxout.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/gettxout.md @@ -18,6 +18,7 @@ The `gettxout` RPC {{summary_getTxOut}} | Name | Type | Presence | Description |------------------|-----------------|-----------------------------|---------------- | TXID | string (hex) | Required
(exactly 1) | The TXID of the transaction containing the output to get, encoded as hex in RPC byte order +{:.ntpd} *Parameter #2---the output index number (vout) of the output to get* @@ -25,12 +26,14 @@ The `gettxout` RPC {{summary_getTxOut}} | Name | Type | Presence | Description |------------------|-----------------|-----------------------------|---------------- | Vout | number (int) | Required
(exactly 1) | The output index number (vout) of the output within the transaction; the first output in a transaction is vout 0 +{:.ntpd} *Parameter #3---whether to display unconfirmed outputs from the memory pool* | Name | Type | Presence | Description |------------------|-----------------|-----------------------------|---------------- | Unconfirmed | bool | Optional
(0 or 1) | Set to `true` to display unconfirmed outputs from the memory pool; set to `false` (the default) to only display outputs from confirmed transactions +{:.ntpd} *Result---a description of the output* @@ -49,6 +52,7 @@ The `gettxout` RPC {{summary_getTxOut}} | → → →
Address | string | Required
(1 or more) | A P2PKH or P2SH address | →
`version` | number (int) | Required
(exactly 1) | The transaction version number of the transaction containing the pubkey script | →
`coinbase` | bool | Required
(exactly 1) | Set to `true` if the transaction output belonged to a coinbase transaction; set to `false` for all other transactions. Coinbase transactions need to have 101 confirmations before their outputs can be spent +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/gettxoutsetinfo.md b/_includes/ref/bitcoin-core/rpcs/rpcs/gettxoutsetinfo.md index c0c7d80d..3d4866ad 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/gettxoutsetinfo.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/gettxoutsetinfo.md @@ -27,6 +27,7 @@ The `gettxoutsetinfo` RPC {{summary_getTxOutSetInfo}} | →
`bytes_serialized` | number (int) | Required
(exactly 1) | The size of the serialized UTXO set in bytes; not counting overhead, this is the size of the `chainstate` directory in the Bitcoin Core configuration directory | →
`hash_serialized` | string (hex) | Required
(exactly 1) | A SHA256(SHA256()) hash of the serialized UTXO set; useful for comparing two nodes to see if they have the same set (they should, if they always used the same serialization format and currently have the same best block). The hash is encoded as hex in RPC byte order | →
`total_amount` | number (bitcoins) | Required
(exactly 1) | The total number of bitcoins in the UTXO set +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getunconfirmedbalance.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getunconfirmedbalance.md index 04d1ea47..16412f45 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getunconfirmedbalance.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getunconfirmedbalance.md @@ -22,6 +22,7 @@ The `getunconfirmedbalance` RPC {{summary_getUnconfirmedBalance}} | Name | Type | Presence | Description |--------------------|-------------------|-----------------------------|---------------- | `result` | number (bitcoins) | Required
(exactly 1) | The total number of bitcoins paid to this wallet in unconfirmed transactions +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/getwalletinfo.md b/_includes/ref/bitcoin-core/rpcs/rpcs/getwalletinfo.md index 9a10acf1..dc1dd719 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/getwalletinfo.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/getwalletinfo.md @@ -28,6 +28,7 @@ The `getwalletinfo` RPC {{summary_getWalletInfo}} | →
`keypoololdest` | number (int) | Required
(exactly 1) | The date as Unix epoch time when the oldest key in the wallet key pool was created; useful for only scanning blocks created since this date for transactions | →
`keypoolsize` | number (int) | Required
(exactly 1) | The number of keys in the wallet keypool | →
`unlocked_until` | number (int) | Optional
(0 or 1) | Only returned if the wallet was encrypted with the `encryptwallet` RPC. A Unix epoch date when the wallet will be locked, or `0` if the wallet is currently locked +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/help.md b/_includes/ref/bitcoin-core/rpcs/rpcs/help.md index 2a0bbc26..d88dced2 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/help.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/help.md @@ -18,12 +18,14 @@ The `help` RPC {{summary_help}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | RPC | string | Optional
(0 or 1) | The name of the RPC to get help for. If omitted, Bitcoin Core 0.9x will display an alphabetical list of commands; Bitcoin Core 0.10.0 will display a categorized list of commands +{:.ntpd} *Result---a list of RPCs or detailed help for a specific RPC* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | string | Required
(exactly 1) | The help text for the specified RPC or the list of commands. The `bitcoin-cli` command will parse this text and format it as human-readable text +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/importaddress.md b/_includes/ref/bitcoin-core/rpcs/rpcs/importaddress.md index 7003911b..4aac0e07 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/importaddress.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/importaddress.md @@ -20,24 +20,28 @@ The `importaddress` RPC {{summary_importAddress}} | Name | Type | Presence | Description |--------------------|------------------------|-----------------------------|---------------- | Address or Script | string (base58 or hex) | Required
(exactly 1) | Either a P2PKH or P2SH address encoded in base58check, or a pubkey script encoded as hex +{:.ntpd} *Parameter #2---The account into which to place the address or pubkey script* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Account | string | Optional
(0 or 1) | An account name into which the address should be placed. Default is the default account, an empty string("") +{:.ntpd} *Parameter #3---whether to rescan the block chain* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Rescan | bool | Optional
(0 or 1) | Set to `true` (the default) to rescan the entire local block database for transactions affecting any address or pubkey script in the wallet (including transaction affecting the newly-added address or pubkey script). Set to `false` to not rescan the block database (rescanning can be performed at any time by restarting Bitcoin Core with the `-rescan` command-line argument). Rescanning may take several minutes. Notes: if the address or pubkey script is already in the wallet, the block database will not be rescanned even if this parameter is set +{:.ntpd} *Result---`null` on success* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | null | Required
(exactly 1) | If the address or pubkey script is added to the wallet (or is already part of the wallet), JSON `null` will be returned +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/importprivkey.md b/_includes/ref/bitcoin-core/rpcs/rpcs/importprivkey.md index 1b7e272a..95331fe9 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/importprivkey.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/importprivkey.md @@ -20,24 +20,28 @@ The `importprivkey` RPC {{summary_importPrivKey}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Private Key | string (base58) | Required
(exactly 1) | The private key to import into the wallet encoded in base58check using wallet import format (WIF) +{:.ntpd} *Parameter #2---the account into which the key should be placed* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Account | string | Optional
(0 or 1) | The name of an account to which transactions involving the key should be assigned. The default is the default account, an empty string ("") +{:.ntpd} *Parameter #3---whether to rescan the block chain* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Rescan | bool | Optional
(0 or 1) | Set to `true` (the default) to rescan the entire local block database for transactions affecting any address or pubkey script in the wallet (including transaction affecting the newly-added address for this private key). Set to `false` to not rescan the block database (rescanning can be performed at any time by restarting Bitcoin Core with the `-rescan` command-line argument). Rescanning may take several minutes. Notes: if the address for this key is already in the wallet, the block database will not be rescanned even if this parameter is set +{:.ntpd} *Result---`null` on success* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | null | Required
(exactly 1) | If the private key is added to the wallet (or is already part of the wallet), JSON `null` will be returned +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/importwallet.md b/_includes/ref/bitcoin-core/rpcs/rpcs/importwallet.md index ce9566e2..913049e1 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/importwallet.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/importwallet.md @@ -21,12 +21,14 @@ The `importwallet` RPC {{summary_importWallet}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Filename | string | Required
(exactly 1) | The file to import. The path is relative to Bitcoin Core's working directory +{:.ntpd} *Result---`null` on success* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | null | Required
(exactly 1) | If all the keys in the file are added to the wallet (or are already part of the wallet), JSON `null` will be returned +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/keypoolrefill.md b/_includes/ref/bitcoin-core/rpcs/rpcs/keypoolrefill.md index 1024cb03..f1480472 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/keypoolrefill.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/keypoolrefill.md @@ -21,12 +21,14 @@ The `keypoolrefill` RPC {{summary_keyPoolRefill}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Key Pool Size | number (int) | Optional
(0 or 1) | The new size of the keypool; if the number of keys in the keypool is less than this number, new keys will be generated. Default is `100`. The value `0` also equals the default. The value specified is for this call only---the default keypool size is not changed +{:.ntpd} *Result---`null` on success* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | null | Required
(exactly 1) | If the keypool is successfully filled, JSON `null` will be returned +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/listaccounts.md b/_includes/ref/bitcoin-core/rpcs/rpcs/listaccounts.md index 5e2dda4e..f47817cb 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/listaccounts.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/listaccounts.md @@ -29,6 +29,7 @@ The `listaccounts` RPC {{summary_listAccounts}} |--------------------|-----------------|-----------------------------|---------------- | `result` | object | Required
(exactly 1) | A JSON array containing key/value pairs with account names and values. Must include, at the very least, the default account ("") | →
Account : Balance | string : number (bitcoins) | Required
(1 or more) | The name of an account as a string paired with the balance of the account as a number of bitcoins. The number of bitcoins may be negative if the account has spent more bitcoins than it received. Accounts with zero balances and zero transactions will be displayed +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/listaddressgroupings.md b/_includes/ref/bitcoin-core/rpcs/rpcs/listaddressgroupings.md index 48fc213b..da67576d 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/listaddressgroupings.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/listaddressgroupings.md @@ -27,6 +27,7 @@ The `listaddressgroupings` RPC {{summary_listAddressGroupings}} | → → →
Address | string (base58) | Required
(exactly 1) | The address in base58check format | → → →
Balance | number (bitcoins) | Required
(exactly 1) | The current spendable balance of the address, not counting unconfirmed transactions | → → →
Account | string | Optional
(0 or 1) | The account the address belongs to, if any. This field will not be returned for change addresses. The default account is an empty string ("") +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/listlockunspent.md b/_includes/ref/bitcoin-core/rpcs/rpcs/listlockunspent.md index e3819cc3..0e86ea18 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/listlockunspent.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/listlockunspent.md @@ -25,6 +25,7 @@ The `listlockunspent` RPC {{summary_listLockUnspent}} | →
Output | object | Optional
(1 or more) | An object describing a particular locked output | → →
`txid` | string (hex) | Required
(exactly 1) | The TXID of the transaction containing the locked output, encoded as hex in RPC byte order | → →
`vout` | number (int) | Required
(exactly 1) | The output index number (vout) of the locked output within the transaction. Output index `0` is the first output within the transaction +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/listreceivedbyaccount.md b/_includes/ref/bitcoin-core/rpcs/rpcs/listreceivedbyaccount.md index c0dbdcd7..46ee2432 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/listreceivedbyaccount.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/listreceivedbyaccount.md @@ -24,6 +24,7 @@ The `listreceivedbyaccount` RPC {{summary_listReceivedByAccount}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Include Empty | bool | Optional
(0 or 1) | Set to `true` to display accounts which have never received a payment. Set to `false` (the default) to only include accounts which have received a payment. Any account which has received a payment will be displayed even if its current balance is `0` +{:.ntpd} *Parameter #3---whether to include watch-only addresses in results* @@ -39,6 +40,7 @@ The `listreceivedbyaccount` RPC {{summary_listReceivedByAccount}} | → →
`account` | string | Required
(exactly 1) | The name of the account | → →
`amount`| number (bitcoins) | Required
(exactly 1) | The total amount received by this account in bitcoins | → →
`confirmations` | number (int) | Required
(exactly 1) | The number of confirmations received by the last transaction received by this account. May be `0` +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/listreceivedbyaddress.md b/_includes/ref/bitcoin-core/rpcs/rpcs/listreceivedbyaddress.md index 0033177d..8bc7257c 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/listreceivedbyaddress.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/listreceivedbyaddress.md @@ -24,6 +24,7 @@ The `listreceivedbyaddress` RPC {{summary_listReceivedByAddress}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Include Empty | bool | Optional
(0 or 1) | Set to `true` to display accounts which have never received a payment. Set to `false` (the default) to only include accounts which have received a payment. Any account which has received a payment will be displayed even if its current balance is `0` +{:.ntpd} *Parameter #3---whether to include watch-only addresses in results* @@ -42,6 +43,7 @@ The `listreceivedbyaddress` RPC {{summary_listReceivedByAddress}} | → →
`confirmations` | number (int) | Required
(exactly 1) | The number of confirmations of the latest transaction to the address. May be `0` for unconfirmed | → →
TXIDs | array | Required
(exactly 1) | An array of TXIDs belonging to transactions that pay the address | → → →
TXID | string | Optional
(0 or more) | The TXID of a transaction paying the address, encoded as hex in RPC byte order +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/listsinceblock.md b/_includes/ref/bitcoin-core/rpcs/rpcs/listsinceblock.md index d3d42e67..defe0f27 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/listsinceblock.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/listsinceblock.md @@ -20,12 +20,14 @@ The `listsinceblock` RPC {{summary_listSinceBlock}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Header Hash | string (hex) | Optional
(0 or 1) | The hash of a block header encoded as hex in RPC byte order. All transactions affecting the wallet which are not in that block or any earlier block will be returned, including unconfirmed transactions. Default is the hash of the genesis block, so all transactions affecting the wallet are returned by default +{:.ntpd} *Parameter #2---the target confirmations for the lastblock field* | Name | Type | Presence | Description |----------------------|-----------------|-----------------------------|---------------- | Target Confirmations | number (int) | Optional
(0 or 1) | Sets the lastblock field of the results to the header hash of a block with this many confirmations. This does not affect which transactions are returned. Default is `1`, so the hash of the most recent block on the local best block chain is returned +{:.ntpd} *Parameter #3---whether to include watch-only addresses in details and calculations* @@ -44,6 +46,7 @@ The `listsinceblock` RPC {{summary_listSinceBlock}} {{INCLUDE_F_LIST_TRANSACTIONS}} {{INCLUDE_F_LIST_TRANSACTIONS_F_FULL}} | →
`lastblock` | string (hex) | Required
(exactly 1) | The header hash of the block with the number of confirmations specified in the *target confirmations* parameter, encoded as hex in RPC byte order +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/listtransactions.md b/_includes/ref/bitcoin-core/rpcs/rpcs/listtransactions.md index eb836ae5..5cb6c47c 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/listtransactions.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/listtransactions.md @@ -20,18 +20,21 @@ The `listtransactions` RPC {{summary_listTransactions}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Account | string | Optional
(0 or 1) | 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 +{:.ntpd} *Parameter #2---the number of transactions to get* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Count | number (int) | Optional
(0 or 1) | The number of the most recent transactions to list. Default is `10` +{:.ntpd} *Parameter #3---the number of transactions to skip* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Skip | number (int) | Optional
(0 or 1) | The number of the most recent transactions which should not be returned. Allows for pagination of results. Default is `0` +{:.ntpd} *Parameter #4---whether to include watch-only addresses in details and calculations* @@ -62,6 +65,7 @@ The `listtransactions` RPC {{summary_listTransactions}} | → →
`comment` | string | Optional
(0 or 1) | For transaction originating with this wallet, a locally-stored comment added to the transaction. Only returned in regular payments if a comment was added. Always returned in *move* category payments. May be an empty string | → →
`to` | string | Optional
(0 or 1) | For transaction originating with this wallet, a locally-stored comment added to the transaction identifying who the transaction was sent to. Only returned if a comment-to was added. Never returned by *move* category payments. May be an empty string | → →
`otheraccount` | string | Optional
(0 or 1) | 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 +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/listunspent.md b/_includes/ref/bitcoin-core/rpcs/rpcs/listunspent.md index 697b3a4f..48145bfd 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/listunspent.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/listunspent.md @@ -22,12 +22,14 @@ the *spendable* field in the results described below. | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Minimum Confirmations | number (int) | Optional
(0 or 1) | The minimum number of confirmations the transaction containing an output must have in order to be returned. Use `0` to return outputs from unconfirmed transactions. Default is `1` +{:.ntpd} *Parameter #2---the maximum number of confirmations an output may have* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Maximum Confirmations | number (int) | Optional
(0 or 1) | The maximum number of confirmations the transaction containing an output may have in order to be returned. Default is `9999999` (~10 million) +{:.ntpd} *Parameter #3---the addresses an output must pay* @@ -35,6 +37,7 @@ the *spendable* field in the results described below. |--------------------|-----------------|-----------------------------|---------------- | Addresses | array | Optional
(0 or 1) | If present, only outputs which pay an address in this array will be returned | →
Address | string (base58) | Required
(1 or more) | A P2PKH or P2SH address +{:.ntpd} *Result---the list of unspent outputs* @@ -51,6 +54,7 @@ the *spendable* field in the results described below. | → →
`amount` | number (int) | Required
(exactly 1) | The amount paid to the output in bitcoins | → →
`confirmations` | number (int) | Required
(exactly 1) | The number of confirmations received for the transaction containing this output | → →
`spendable` | bool | Required
(exactly 1) | *Added in Bitcoin Core 0.10.0*

Set to `true` if the private key or keys needed to spend this output are part of the wallet. Set to `false` if not (such as for watch-only addresses) +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/lockunspent.md b/_includes/ref/bitcoin-core/rpcs/rpcs/lockunspent.md index 6820efe4..e76e12dc 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/lockunspent.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/lockunspent.md @@ -20,6 +20,7 @@ The `lockunspent` RPC {{summary_lockUnspent}} | Name | Type | Presence | Description |----------------------|-----------------|-----------------------------|---------------- | Lock Or Unlock | bool | Required
(exactly 1) | Set to `true` to lock the outputs specified in the following parameter. Set to `false` to unlock the outputs specified. If this is the only argument specified, all outputs will be unlocked (even if this is set to `false`) +{:.ntpd} *Parameter #2---the outputs to lock or unlock* @@ -29,12 +30,14 @@ The `lockunspent` RPC {{summary_lockUnspent}} | →
Output | object | Required
(1 or more) | An object describing a particular output | → →
`txid` | string | Required
(exactly 1) | The TXID of the transaction containing the output to lock or unlock, encoded as hex in internal byte order | → →
`vout` | number (int) | Required
(exactly 1) | The output index number (vout) of the output to lock or unlock. The first output in a transaction has an index of `0` +{:.ntpd} *Result---`true` if successful* | Name | Type | Presence | Description |----------------------|-----------------|-----------------------------|---------------- | `result` | bool | Required
(exactly 1) | Set to `true` if the outputs were successfully locked or unlocked +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/move.md b/_includes/ref/bitcoin-core/rpcs/rpcs/move.md index 76365a73..7afd572a 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/move.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/move.md @@ -25,36 +25,42 @@ account a balance that may exceed the number of bitcoins in the wallet | Name | Type | Presence | Description |----------------------|-----------------|-----------------------------|---------------- | From Account | string | Required
(exactly 1) | The name of the account to move the funds from +{:.ntpd} *Parameter #2---to account* | Name | Type | Presence | Description |----------------------|-----------------|-----------------------------|---------------- | To Account | string | Required
(exactly 1) | The name of the account to move the funds to +{:.ntpd} *Parameter #3---amount to move* | Name | Type | Presence | Description |----------------------|-------------------|-----------------------------|---------------- | Amount | number (bitcoins) | Required
(exactly 1) | The amount of bitcoins to move +{:.ntpd} *Parameter #4---an unused parameter* | Name | Type | Presence | Description |----------------------|-----------------|-----------------------------|---------------- | *Unused* | number (int) | Optional
(0 or 1) | This parameter is no longer used. If parameter #5 needs to be specified, this can be any integer +{:.ntpd} *Parameter #5---a comment* | Name | Type | Presence | Description |----------------------|-----------------|-----------------------------|---------------- | Comment | string | Optional
(0 or 1) | A comment to assign to this move payment +{:.ntpd} *Result---`true` on success* | Name | Type | Presence | Description |----------------------|-----------------|-----------------------------|---------------- | `result` | bool | Required
(exactly 1) | Set to `true` if the move was successful +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/ping.md b/_includes/ref/bitcoin-core/rpcs/rpcs/ping.md index 460e19c0..40916cfb 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/ping.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/ping.md @@ -20,6 +20,7 @@ The `ping` RPC {{summary_ping-rpc}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | null | Required | Always JSON `null` +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/prioritisetransaction.md b/_includes/ref/bitcoin-core/rpcs/rpcs/prioritisetransaction.md index ac7c31f5..d4f38ef8 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/prioritisetransaction.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/prioritisetransaction.md @@ -20,24 +20,28 @@ The `prioritisetransaction` RPC {{summary_prioritiseTransaction}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | TXID | string | Required
(exactly 1) | The TXID of the transaction whose virtual priority or fee you want to modify, encoded as hex in RPC byte order +{:.ntpd} *Parameter #2---the change to make to the virtual priority* | Name | Type | Presence | Description |--------------------|-------------------|-----------------------------|---------------- | Priority | number (real) | Required
(exactly 1) | If positive, the priority to add to the transaction in addition to its computed priority; if negative, the priority to subtract from the transaction's computed priory. Computed priority is the age of each input in days since it was added to the block chain as an output (coinage) times the value of the input in satoshis (value) divided by the size of the serialized transaction (size), which is `coinage * value / size` +{:.ntpd} *Parameter #3---the change to make to the virtual fee* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Fee | number (int) | Required
(exactly 1) | **Warning:** this value is in satoshis, not bitcoins

If positive, the virtual fee to add to the actual fee paid by the transaction; if negative, the virtual fee to subtract from the actual fee paid by the transaction. No change is made to the actual fee paid by the transaction +{:.ntpd} *Result---`true` if the priority is changed* | Name | Type | Presence | Description |--------------------|------------------|-----------------------------|---------------- | `result` | bool (true only) | Required
(exactly 1) | Always set to `true` if all three parameters are provided. Will not return an error if the TXID is not in the memory pool. If fewer or more than three arguments are provided, or if something goes wrong, will be set to `null` +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/sendfrom.md b/_includes/ref/bitcoin-core/rpcs/rpcs/sendfrom.md index 4a7fd0fb..289ade9a 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/sendfrom.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/sendfrom.md @@ -21,18 +21,21 @@ The `sendfrom` RPC {{summary_sendFrom}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | From Account | string | Required
(exactly 1) | The name of the account from which the bitcoins should be spent. Use an empty string ("") for the default account +{:.ntpd} *Parameter #2---to address* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | To Address | string | Required
(exactly 1) | A P2PKH or P2SH address to which the bitcoins should be sent +{:.ntpd} *Parameter #3---amount to spend* | Name | Type | Presence | Description |--------------------|-------------------|-----------------------------|--------------- | Amount | number (bitcoins) | Required
(exactly 1) | The amount to spend in bitcoins. Bitcoin Core will ensure the account has sufficient bitcoins to pay this amount (but the transaction fee paid is not included in the calculation, so an account can spend a total of its balance plus the transaction fee) +{:.ntpd} *Parameter #4---minimum confirmations* @@ -43,18 +46,21 @@ The `sendfrom` RPC {{summary_sendFrom}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Comment | string | Optional
(0 or 1) | A locally-stored (not broadcast) comment assigned to this transaction. Default is no comment +{:.ntpd} *Parameter #6---a comment about who the payment was sent to* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Comment To | string | Optional
(0 or 1) | A locally-stored (not broadcast) comment assigned to this transaction. Meant to be used for describing who the payment was sent to. Default is no comment +{:.ntpd} *Result---a TXID of the sent transaction* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | `result` | string | Required
(exactly 1) | The TXID of the sent transaction, encoded as hex in RPC byte order +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/sendmany.md b/_includes/ref/bitcoin-core/rpcs/rpcs/sendmany.md index 87e2b446..36bcd718 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/sendmany.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/sendmany.md @@ -21,6 +21,7 @@ The `sendmany` RPC {{summary_sendMany}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | From Account | string | Required
(exactly 1) | The name of the account from which the bitcoins should be spent. Use an empty string ("") for the default account. Bitcoin Core will ensure the account has sufficient bitcoins to pay the total amount in the *outputs* field described below (but the transaction fee paid is not included in the calculation, so an account can spend a total of its balance plus the transaction fee) +{:.ntpd} *Parameter #2---the addresses and amounts to pay* @@ -28,6 +29,7 @@ The `sendmany` RPC {{summary_sendMany}} |--------------------|-----------------|-----------------------------|--------------- | Outputs | object | Required
(exactly 1) | An object containing key/value pairs corresponding to the addresses and amounts to pay | →
Address/Amount | string (base58) : number (bitcoins) | Required
(1 or more) | A key/value pair with a base58check-encoded string containing the P2PKH or P2SH address to pay as the key, and an amount of bitcoins to pay as the value +{:.ntpd} *Parameter #3---minimum confirmations* @@ -38,12 +40,14 @@ The `sendmany` RPC {{summary_sendMany}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Comment | string | Optional
(0 or 1) | A locally-stored (not broadcast) comment assigned to this transaction. Default is no comment +{:.ntpd} *Result---a TXID of the sent transaction* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | `result` | string | Required
(exactly 1) | The TXID of the sent transaction, encoded as hex in RPC byte order +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/sendrawtransaction.md b/_includes/ref/bitcoin-core/rpcs/rpcs/sendrawtransaction.md index 2974af84..82e41de4 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/sendrawtransaction.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/sendrawtransaction.md @@ -18,18 +18,21 @@ The `sendrawtransaction` RPC {{summary_sendRawTransaction}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Transaction | string (hex) | Required
(exactly 1) | The serialized transaction to broadcast encoded as hex +{:.ntpd} *Parameter #2--whether to allow high fees** | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Allow High Fees | bool | Optional
(0 or 1) | Set to `true` to allow the transaction to pay a high transaction fee. Set to `false` (the default) to prevent Bitcoin Core from broadcasting the transaction if it includes a high fee. Transaction fees are the sum of the inputs minus the sum of the outputs, so this high fees check helps ensures user including a change address to return most of the difference back to themselves +{:.ntpd} *Result---a TXID or error message* | Name | Type | Presence | Description |--------------------|-------------------|-----------------------------|---------------- | `result` | null/string (hex) | Required
(exactly 1) | If the transaction was accepted by the node for broadcast, this will be the TXID of the transaction encoded as hex in RPC byte order. If the transaction was rejected by the node, this will set to `null`, the JSON-RPC error field will be set to a code, and the JSON-RPC message field may contain an informative error message +{:.ntpd} *Examples from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/sendtoaddress.md b/_includes/ref/bitcoin-core/rpcs/rpcs/sendtoaddress.md index 922ae10d..fe62bd2d 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/sendtoaddress.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/sendtoaddress.md @@ -21,30 +21,35 @@ The `sendtoaddress` RPC {{summary_sendToAddress}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | To Address | string | Required
(exactly 1) | A P2PKH or P2SH address to which the bitcoins should be sent +{:.ntpd} *Parameter #2---amount to spend* | Name | Type | Presence | Description |--------------------|-------------------|-----------------------------|--------------- | Amount | number (bitcoins) | Required
(exactly 1) | The amount to spent in bitcoins +{:.ntpd} *Parameter #3---a comment* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Comment | string | Optional
(0 or 1) | A locally-stored (not broadcast) comment assigned to this transaction. Default is no comment +{:.ntpd} *Parameter #4---a comment about who the payment was sent to* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Comment To | string | Optional
(0 or 1) | A locally-stored (not broadcast) comment assigned to this transaction. Meant to be used for describing who the payment was sent to. Default is no comment +{:.ntpd} *Result---a TXID of the sent transaction* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | `result` | string | Required
(exactly 1) | The TXID of the sent transaction, encoded as hex in RPC byte order +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/setaccount.md b/_includes/ref/bitcoin-core/rpcs/rpcs/setaccount.md index 2806b6ee..644d0c93 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/setaccount.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/setaccount.md @@ -20,18 +20,21 @@ The `setaccount` RPC {{summary_setAccount}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Address | string (base58) | Required
(exactly 1) | The P2PKH or P2SH address to put in the account. Must already belong to the wallet +{:.ntpd} *Parameter #2---an account* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Account | string | Required
(exactly 1) | The name of the account in which the address should be placed. May be the default account, an empty string ("") +{:.ntpd} *Result---`null` if successful* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | `result` | null | Required
(exactly 1) | Set to JSON `null` if the address was successfully placed in the account +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/setgenerate.md b/_includes/ref/bitcoin-core/rpcs/rpcs/setgenerate.md index d5645925..c11542e2 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/setgenerate.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/setgenerate.md @@ -20,24 +20,28 @@ The `setgenerate` RPC {{summary_setGenerate}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Enable/Disable | bool | Required
(exactly 1) | Set to `true` to enable generation; set to `false` to disable generation +{:.ntpd} *Parameter #2 (regular)---the number of processors to use* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Processors | number (int) | Optional
(0 or 1) | The number of processors to use. Defaults to `1`. Set to `-1` to use all processors +{:.ntpd} *Parameter #2 (regtest)---the number of blocks to generate* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Blocks | number (int) | Optional
(0 or 1) | In regtest mode, set to the number of blocks to generate. Defaults to `1` +{:.ntpd} *Result (regular)---generating is enabled* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | null | Required
(exactly 1) | Always JSON `null` +{:.ntpd} *Result (regtest)---the generated block header hashes* @@ -45,6 +49,7 @@ The `setgenerate` RPC {{summary_setGenerate}} |---------------------|-----------------|-----------------------------|---------------- | `result` | array/null | Required
(exactly 1) | An array containing the block header hashes of the generated blocks, or JSON `null` if no blocks were generated | →
Header Hashes | string (hex) | Required
(1 or more) | The hashes of the headers of the blocks generated in regtest mode, as hex in RPC byte order +{:.ntpd} *Examples from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/settxfee.md b/_includes/ref/bitcoin-core/rpcs/rpcs/settxfee.md index be4001ed..d9b54bbd 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/settxfee.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/settxfee.md @@ -20,12 +20,14 @@ The `settxfee` RPC {{summary_setTxFee}} | Name | Type | Presence | Description |------------------------------|-------------------|-----------------------------|--------------- | Transaction Fee Per Kilobyte | number (bitcoins) | Required
(exactly 1) | The transaction fee to pay, in bitcoins, for each kilobyte of transaction data. The value `0` will not be accepted. Be careful setting the fee too low---your transactions may not be relayed or included in blocks +{:.ntpd} *Result: `true` on success* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | `result` | bool (true) | Required
(exactly 1) | Set to `true` if the fee was successfully set +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/signmessage.md b/_includes/ref/bitcoin-core/rpcs/rpcs/signmessage.md index 0025a020..b62a12a9 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/signmessage.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/signmessage.md @@ -21,18 +21,21 @@ The `signmessage` RPC {{summary_signMessage}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Address | string (base58) | Required
(exactly 1) | A P2PKH address whose private key belongs to this wallet +{:.ntpd} *Parameter #2---the message to sign* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Message | string | Required
(exactly 1) | The message to sign +{:.ntpd} *Result---the message signature* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | `result` | string (base64) | Required
(exactly 1) | The signature of the message, encoded in base64. Note that Bitcoin Core before 0.10.0 creates signatures with random *k* values, so each time you sign the same message, it will create a different signature +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/signrawtransaction.md b/_includes/ref/bitcoin-core/rpcs/rpcs/signrawtransaction.md index 17273ba5..d7aa49bd 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/signrawtransaction.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/signrawtransaction.md @@ -18,6 +18,7 @@ The `signrawtransaction` RPC {{summary_signRawTransaction}} | Name | Type | Presence | Description |------------------|--------------|-----------------------------|---------------- | Transaction | string (hex | Required
(exactly 1) | The transaction to sign as a serialized transaction +{:.ntpd} *Parameter #2---unspent transaction output details* @@ -29,6 +30,7 @@ The `signrawtransaction` RPC {{summary_signRawTransaction}} | → →
`vout` | number (int) | Required
(exactly 1) | The index number of the output (vout) as it appeared in its transaction, with the first output being 0 | → →
`scriptPubKey` | string (hex) | Required
(exactly 1) | The output's pubkey script encoded as hex | → →
`redeemScript` | string (hex) | Optional
(0 or 1) | If the pubkey script was a script hash, this must be the corresponding redeem script +{:.ntpd} *Parameter #3---private keys for signing* @@ -36,12 +38,14 @@ The `signrawtransaction` RPC {{summary_signRawTransaction}} |------------------|-----------------|-----------------------------|------------- | Private Keys | array | Optional
(0 or 1) | An array holding private keys. If any keys are provided, only they will be used to sign the transaction (even if the wallet has other matching keys). If this array is empty or not used, and wallet support is enabled, keys from the wallet will be used | →
Key | string (base58) | Required
(1 or more) | A private key in base58check format to use to create a signature for this transaction +{:.ntpd} *Parameter #4---signature hash type* | Name | Type | Presence | Description |------------------|--------------|-----------------------------|------------- | SigHash | string | Optional
(0 or 1) | The type of signature hash to use for all of the signatures performed. (You must use separate calls to the `signrawtransaction` RPC if you want to use different signature hash types for different signatures. The allowed values are: `ALL`, `NONE`, `SINGLE`, `ALL|ANYONECANPAY`, `NONE|ANYONECANPAY`, and `SINGLE|ANYONECANPAY` +{:.ntpd} *Result---the transaction with any signatures made* @@ -50,6 +54,7 @@ The `signrawtransaction` RPC {{summary_signRawTransaction}} | `result` | object | Required
(exactly 1) | The results of the signature | →
`hex` | string (hex) | Required
(exactly 1) | The resulting serialized transaction encoded as hex with any signatures made inserted. If no signatures were made, this will be the same transaction provided in parameter #1 | →
`complete` | bool | Required
(exactly 1) | The value `true` if transaction is fully signed; the value `false` if more signatures are required +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/stop.md b/_includes/ref/bitcoin-core/rpcs/rpcs/stop.md index fd5e0a38..6eb80e0b 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/stop.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/stop.md @@ -20,6 +20,7 @@ The `stop` RPC {{summary_stop}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | string | Required
(exactly 1) | The string "Bitcoin server stopping" +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/submitblock.md b/_includes/ref/bitcoin-core/rpcs/rpcs/submitblock.md index 77c61b53..293a2417 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/submitblock.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/submitblock.md @@ -18,18 +18,21 @@ The `submitblock` RPC {{summary_submitBlock}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Block | string (hex) | Required
(exactly 1) | The full block to submit in serialized block format as hex +{:.ntpd} *Parameter #2---additional parameters* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Parameters | object | Optional
(0 or 1) | A JSON object containing extra parameters. Not used directly by Bitcoin Core and also not broadcast to the network. This is available for use by mining pools and other software. A common parameter is a `workid` string +{:.ntpd} *Result---`null` or error string* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | null/string | Required
(exactly 1) | If the block submission succeeded, set to JSON `null`. If submission failed, set to one of the following strings: `duplicate`, `duplicate-invalid`, `inconclusive`, or `rejected`. The JSON-RPC `error` field will still be set to `null` if submission failed for one of these reasons +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/validateaddress.md b/_includes/ref/bitcoin-core/rpcs/rpcs/validateaddress.md index 628399c4..7f7a6b40 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/validateaddress.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/validateaddress.md @@ -18,6 +18,7 @@ The `validateaddress` RPC {{summary_validateAddress}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Address | string (base58) | Required
(exactly 1) | The P2PKH or P2SH address to validate encoded in base58check format +{:.ntpd} *Result---information about the address* @@ -37,6 +38,7 @@ The `validateaddress` RPC {{summary_validateAddress}} | →
`pubkey` | string (hex) | Optional
(0 or 1) | The public key corresponding to this address. Only returned if the address is a P2PKH address in the wallet | →
`iscompressed` | bool | Optional
(0 or 1) | Set to `true` if a compressed public key or set to `false` if an uncompressed public key. Only returned if the address is a P2PKH address in the wallet | →
`account` | string | Optional
(0 or 1) | The account this address belong to. May be an empty string for the default account. Only returned if the address belongs to the wallet +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/verifychain.md b/_includes/ref/bitcoin-core/rpcs/rpcs/verifychain.md index 718bfc53..1d189db9 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/verifychain.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/verifychain.md @@ -18,18 +18,21 @@ The `verifychain` RPC {{summary_verifyChain}} | Name | Type | Presence | Description |------------------|-----------------|-----------------------------|---------------- | Check Level | number (int) | Optional
(0 or 1) | How thoroughly to check each block, from 0 to 4. Default is the level set with the `-checklevel` command line argument; if that isn't set, the default is `3`. Each higher level includes the tests from the lower levels

Levels are:
**0.** Read from disk to ensure the files are accessible
**1.** Ensure each block is valid
**2.** Make sure undo files can be read from disk and are in a valid format
**3.** Test each block undo to ensure it results in correct state
**4.** After undoing blocks, reconnect them to ensure they reconnect correctly +{:.ntpd} *Parameter #2---the number of blocks to check* | Name | Type | Presence | Description |------------------|-----------------|-----------------------------|---------------- | Number Of Blocks | number (int) | Optional
(0 or 1) | The number of blocks to verify. Set to `0` to check all blocks. Defaults to the value of the `-checkblocks` command-line argument; if that isn't set, the default is `288` +{:.ntpd} *Result---verification results* | Name | Type | Presence | Description |------------------|-----------------|-----------------------------|---------------- | `result` | bool | Required
(exactly 1) | Set to `true` if verified; set to `false` if verification failed for any reason +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/verifymessage.md b/_includes/ref/bitcoin-core/rpcs/rpcs/verifymessage.md index 600e56a7..936018a0 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/verifymessage.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/verifymessage.md @@ -18,24 +18,28 @@ The `verifymessage` RPC {{summary_verifyMessage}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Address | string (base58) | Required
(exactly 1) | The P2PKH address corresponding to the private key which made the signature. A P2PKH address is a hash of the public key corresponding to the private key which made the signature. When the ECDSA signature is checked, up to four possible ECDSA public keys will be reconstructed from from the signature; each key will be hashed and compared against the P2PKH address provided to see if any of them match. If there are no matches, signature validation will fail +{:.ntpd} *Parameter #2---the signature* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Signature | string (base64) | Required
(exactly 1) | The signature created by the signer encoded as base-64 (the format output by the `signmessage` RPC) +{:.ntpd} *Parameter #3---the message* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | Message | string | Required
(exactly 1) | The message exactly as it was signed (e.g. no extra whitespace) +{:.ntpd} *Result: `true`, `false`, or an error* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|---------------- | `result` | bool/null | Required
(exactly 1) | Set to `true` if the message was signed by a key corresponding to the provided P2PKH address; set to `false` if it was not signed by that key; set to JSON `null` if an error occurred +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/walletlock.md b/_includes/ref/bitcoin-core/rpcs/rpcs/walletlock.md index 9dd6b837..4d274401 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/walletlock.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/walletlock.md @@ -22,6 +22,7 @@ The `walletlock` RPC {{summary_walletLock}} | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | `result` | null | Required
(exactly 1) | Always set to JSON `null` +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/walletpassphrase.md b/_includes/ref/bitcoin-core/rpcs/rpcs/walletpassphrase.md index 18047c3e..bdc67ec6 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/walletpassphrase.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/walletpassphrase.md @@ -24,18 +24,21 @@ value of the passphrase parameter). | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Passphrase | string | Required
(exactly 1) | The passphrase that unlocks the wallet +{:.ntpd} *Parameter #2---the number of seconds to leave the wallet unlocked* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Seconds | number (int) | Required
(exactly 1) | The number of seconds after which the decryption key will be automatically deleted from memory +{:.ntpd} *Result---`null` on success* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | `result` | null | Required
(exactly 1) | Always set to JSON `null` +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/walletpassphrasechange.md b/_includes/ref/bitcoin-core/rpcs/rpcs/walletpassphrasechange.md index 460421f1..bf51d32b 100644 --- a/_includes/ref/bitcoin-core/rpcs/rpcs/walletpassphrasechange.md +++ b/_includes/ref/bitcoin-core/rpcs/rpcs/walletpassphrasechange.md @@ -24,18 +24,21 @@ value of the passphrase parameter). | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | Current Passphrase | string | Required
(exactly 1) | The current wallet passphrase +{:.ntpd} *Parameter #2---the new passphrase* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | New Passphrase | string | Required
(exactly 1) | The new passphrase for the wallet +{:.ntpd} *Result---`null` on success* | Name | Type | Presence | Description |--------------------|-----------------|-----------------------------|--------------- | `result` | null | Required
(exactly 1) | Always set to JSON `null` +{:.ntpd} *Example from Bitcoin Core 0.10.0* diff --git a/_includes/ref_core_rpc_intro.md b/_includes/ref_core_rpc_intro.md index 08835afb..f8294a8a 100644 --- a/_includes/ref_core_rpc_intro.md +++ b/_includes/ref_core_rpc_intro.md @@ -131,6 +131,7 @@ standard arguments: | →
`method` | string | Required
(exactly 1) | The RPC, such as `getbestblockhash`. See the RPC section for a list of available commands | →
`params` | array | Required
(exactly 1) | An array containing parameters for the RPC. May be an empty array if allowed by the particular RPC | → →
Parameter | *any* | Optional
(0 or more) | A parameter. May be any JSON type allowed by the particular RPC +{:.ntpd} In table above and in other tables describing JSON-RPC input and output, we use the following formatting @@ -200,6 +201,7 @@ The standard JSON-RPC 1.0 result format is described below: | → →
`code` | number (int) | Required
(exactly 1) | The error code as set by the returning function and defined in Bitcoin Core's [rpcprotocol.h][] | → →
`message` | string | Required
(exactly 1) | An attempt to describe the problem in human-readable text. May be an empty string (""). Bitcoin Core often returns help text with embedded newline strings ("\n"); `bitcoin-cli` can expand these to actual newlines | →
`id` | string | Required
(exactly 1) | The arbitrary string passed in when the RPC was called +{:.ntpd} For an example of the error output, here's the result after passing an invalid address to the `sendtoaddress` RPC diff --git a/_less/screen.less b/_less/screen.less index a64573cf..321355b8 100644 --- a/_less/screen.less +++ b/_less/screen.less @@ -838,6 +838,16 @@ table td,table th{ margin:0; overflow-y:visible; } +.toccontent table.ntpd tr td+td+td{ + white-space:nowrap; +} +.toccontent table.ntpd tr td+td+td+td{ + white-space:normal; +} +.toccontent table thead th{ + font-weight:normal; + border-bottom: 3px double #ddd; +} .anchorAf{ position:relative;