zec
/
zcash.rpc.github.io
mirror of https://github.com/zcash/zcash.rpc.github.io.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Replace HTML entities

This commit is contained in:
Karel Bilek 2018-03-09 02:41:52 +01:00
parent 42b8dc761a
commit 136be781e0
No known key found for this signature in database
GPG Key ID: 7006C66FDB36247C
108 changed files with 1106 additions and 1104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
abandontransaction.html
View File

@ -35,22 +35,22 @@
<div class="col-8"> <div class="col-8">
<h1>abandontransaction - Bitcoin RPC</h1> <h1>abandontransaction - Bitcoin RPC</h1>
<pre> <pre>
abandontransaction "txid" abandontransaction &#34;txid&#34;
Mark in-wallet transaction <txid> as abandoned Mark in-wallet transaction &lt;txid&gt; as abandoned
This will mark this transaction and all its in-wallet descendants as abandoned which will allow This will mark this transaction and all its in-wallet descendants as abandoned which will allow
for their inputs to be respent. It can be used to replace "stuck" or evicted transactions. for their inputs to be respent. It can be used to replace &#34;stuck&#34; or evicted transactions.
It only works on transactions which are not included in a block and are not currently in the mempool. It only works on transactions which are not included in a block and are not currently in the mempool.
It has no effect on transactions which are already conflicted or abandoned. It has no effect on transactions which are already conflicted or abandoned.
Arguments: Arguments:
1. "txid" (string, required) The transaction id 1. &#34;txid&#34; (string, required) The transaction id
Result: Result:
Examples: Examples:
> bitcoin-cli abandontransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" &gt; bitcoin-cli abandontransaction &#34;1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "abandontransaction", "params": ["1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;abandontransaction&#34;, &#34;params&#34;: [&#34;1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

6
abortrescan.html
View File

@ -42,13 +42,13 @@ Stops current wallet rescan triggered by an RPC call, e.g. by an importprivkey c
Examples: Examples:
Import a private key Import a private key
> bitcoin-cli importprivkey "mykey" &gt; bitcoin-cli importprivkey &#34;mykey&#34;
Abort the running wallet rescan Abort the running wallet rescan
> bitcoin-cli abortrescan &gt; bitcoin-cli abortrescan
As a JSON-RPC call As a JSON-RPC call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "abortrescan", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;abortrescan&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

22
addmultisigaddress.html
View File

@ -35,41 +35,41 @@
<div class="col-8"> <div class="col-8">
<h1>addmultisigaddress - Bitcoin RPC</h1> <h1>addmultisigaddress - Bitcoin RPC</h1>
<pre> <pre>
addmultisigaddress nrequired ["key",...] ( "account" "address_type" ) addmultisigaddress nrequired [&#34;key&#34;,...] ( &#34;account&#34; &#34;address_type&#34; )
Add a nrequired-to-sign multisignature address to the wallet. Requires a new wallet backup. Add a nrequired-to-sign multisignature address to the wallet. Requires a new wallet backup.
Each key is a Bitcoin address or hex-encoded public key. Each key is a Bitcoin address or hex-encoded public key.
This functionality is only intended for use with non-watchonly addresses. This functionality is only intended for use with non-watchonly addresses.
See `importaddress` for watchonly p2sh address support. See `importaddress` for watchonly p2sh address support.
If 'account' is specified (DEPRECATED), assign address to that account. If &#39;account&#39; is specified (DEPRECATED), assign address to that account.
Arguments: Arguments:
1. nrequired (numeric, required) The number of required signatures out of the n keys or addresses. 1. nrequired (numeric, required) The number of required signatures out of the n keys or addresses.
2. "keys" (string, required) A json array of bitcoin addresses or hex-encoded public keys 2. &#34;keys&#34; (string, required) A json array of bitcoin addresses or hex-encoded public keys
[ [
"address" (string) bitcoin address or hex-encoded public key &#34;address&#34; (string) bitcoin address or hex-encoded public key
..., ...,
] ]
3. "account" (string, optional) DEPRECATED. An account to assign the addresses to. 3. &#34;account&#34; (string, optional) DEPRECATED. An account to assign the addresses to.
4. "address_type" (string, optional) The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -addresstype. 4. &#34;address_type&#34; (string, optional) The address type to use. Options are &#34;legacy&#34;, &#34;p2sh-segwit&#34;, and &#34;bech32&#34;. Default is set by -addresstype.
Result: Result:
{ {
"address":"multisigaddress", (string) The value of the new multisig address. &#34;address&#34;:&#34;multisigaddress&#34;, (string) The value of the new multisig address.
"redeemScript":"script" (string) The string value of the hex-encoded redemption script. &#34;redeemScript&#34;:&#34;script&#34; (string) The string value of the hex-encoded redemption script.
} }
Result (DEPRECATED. To see this result in v0.16 instead, please start bitcoind with -deprecatedrpc=addmultisigaddress). Result (DEPRECATED. To see this result in v0.16 instead, please start bitcoind with -deprecatedrpc=addmultisigaddress).
clients should transition to the new output api before upgrading to v0.17. clients should transition to the new output api before upgrading to v0.17.
"address" (string) A bitcoin address associated with the keys. &#34;address&#34; (string) A bitcoin address associated with the keys.
Examples: Examples:
Add a multisig address from 2 addresses Add a multisig address from 2 addresses
> bitcoin-cli addmultisigaddress 2 "[\"16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\",\"171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\"]" &gt; bitcoin-cli addmultisigaddress 2 &#34;[\&#34;16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\&#34;,\&#34;171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\&#34;]&#34;
As json rpc call As json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "addmultisigaddress", "params": [2, "[\"16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\",\"171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\"]"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;addmultisigaddress&#34;, &#34;params&#34;: [2, &#34;[\&#34;16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\&#34;,\&#34;171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\&#34;]&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

10
addnode.html
View File

@ -35,7 +35,7 @@
<div class="col-8"> <div class="col-8">
<h1>addnode - Bitcoin RPC</h1> <h1>addnode - Bitcoin RPC</h1>
<pre> <pre>
addnode "node" "add|remove|onetry" addnode &#34;node&#34; &#34;add|remove|onetry&#34;
Attempts to add or remove a node from the addnode list. Attempts to add or remove a node from the addnode list.
Or try a connection to a node once. Or try a connection to a node once.
@ -43,12 +43,12 @@ Nodes added using addnode (or -connect) are protected from DoS disconnection and
full nodes/support SegWit as other outbound peers are (though such peers will not be synced from). full nodes/support SegWit as other outbound peers are (though such peers will not be synced from).
Arguments: Arguments:
1. "node" (string, required) The node (see getpeerinfo for nodes) 1. &#34;node&#34; (string, required) The node (see getpeerinfo for nodes)
2. "command" (string, required) 'add' to add a node to the list, 'remove' to remove a node from the list, 'onetry' to try a connection to the node once 2. &#34;command&#34; (string, required) &#39;add&#39; to add a node to the list, &#39;remove&#39; to remove a node from the list, &#39;onetry&#39; to try a connection to the node once
Examples: Examples:
> bitcoin-cli addnode "192.168.0.6:8333" "onetry" &gt; bitcoin-cli addnode &#34;192.168.0.6:8333&#34; &#34;onetry&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "addnode", "params": ["192.168.0.6:8333", "onetry"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;addnode&#34;, &#34;params&#34;: [&#34;192.168.0.6:8333&#34;, &#34;onetry&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

8
backupwallet.html
View File

@ -35,16 +35,16 @@
<div class="col-8"> <div class="col-8">
<h1>backupwallet - Bitcoin RPC</h1> <h1>backupwallet - Bitcoin RPC</h1>
<pre> <pre>
backupwallet "destination" backupwallet &#34;destination&#34;
Safely copies current wallet file to destination, which can be a directory or a path with filename. Safely copies current wallet file to destination, which can be a directory or a path with filename.
Arguments: Arguments:
1. "destination" (string) The destination directory or file 1. &#34;destination&#34; (string) The destination directory or file
Examples: Examples:
> bitcoin-cli backupwallet "backup.dat" &gt; bitcoin-cli backupwallet &#34;backup.dat&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "backupwallet", "params": ["backup.dat"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;backupwallet&#34;, &#34;params&#34;: [&#34;backup.dat&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

2
bitcoin.go
View File

@ -1,6 +1,7 @@
package main package main
import ( import (
"html"
"io/ioutil" "io/ioutil"
"os/exec" "os/exec"
"strings" "strings"
@ -39,6 +40,7 @@ func main() {
} else { } else {
name := strings.Split(line, " ")[0] name := strings.Split(line, " ")[0]
desc := run("help", name) desc := run("help", name)
desc = html.EscapeString(desc)
comm := Command{ comm := Command{
name: name, name: name,
description: desc, description: desc,

32
bumpfee.html
View File

@ -35,54 +35,54 @@
<div class="col-8"> <div class="col-8">
<h1>bumpfee - Bitcoin RPC</h1> <h1>bumpfee - Bitcoin RPC</h1>
<pre> <pre>
bumpfee "txid" ( options ) bumpfee &#34;txid&#34; ( options )
Bumps the fee of an opt-in-RBF transaction T, replacing it with a new transaction B. Bumps the fee of an opt-in-RBF transaction T, replacing it with a new transaction B.
An opt-in RBF transaction with the given txid must be in the wallet. An opt-in RBF transaction with the given txid must be in the wallet.
The command will pay the additional fee by decreasing (or perhaps removing) its change output. The command will pay the additional fee by decreasing (or perhaps removing) its change output.
If the change output is not big enough to cover the increased fee, the command will currently fail If the change output is not big enough to cover the increased fee, the command will currently fail
instead of adding new inputs to compensate. (A future implementation could improve this.) instead of adding new inputs to compensate. (A future implementation could improve this.)
The command will fail if the wallet or mempool contains a transaction that spends one of T's outputs. The command will fail if the wallet or mempool contains a transaction that spends one of T&#39;s outputs.
By default, the new fee will be calculated automatically using estimatefee. By default, the new fee will be calculated automatically using estimatefee.
The user can specify a confirmation target for estimatefee. The user can specify a confirmation target for estimatefee.
Alternatively, the user can specify totalFee, or use RPC settxfee to set a higher fee rate. Alternatively, the user can specify totalFee, or use RPC settxfee to set a higher fee rate.
At a minimum, the new fee rate must be high enough to pay an additional new relay fee (incrementalfee At a minimum, the new fee rate must be high enough to pay an additional new relay fee (incrementalfee
returned by getnetworkinfo) to enter the node's mempool. returned by getnetworkinfo) to enter the node&#39;s mempool.
Arguments: Arguments:
1. txid (string, required) The txid to be bumped 1. txid (string, required) The txid to be bumped
2. options (object, optional) 2. options (object, optional)
{ {
"confTarget" (numeric, optional) Confirmation target (in blocks) &#34;confTarget&#34; (numeric, optional) Confirmation target (in blocks)
"totalFee" (numeric, optional) Total fee (NOT feerate) to pay, in satoshis. &#34;totalFee&#34; (numeric, optional) Total fee (NOT feerate) to pay, in satoshis.
In rare cases, the actual fee paid might be slightly higher than the specified In rare cases, the actual fee paid might be slightly higher than the specified
totalFee if the tx change output has to be removed because it is too close to totalFee if the tx change output has to be removed because it is too close to
the dust threshold. the dust threshold.
"replaceable" (boolean, optional, default true) Whether the new transaction should still be &#34;replaceable&#34; (boolean, optional, default true) Whether the new transaction should still be
marked bip-125 replaceable. If true, the sequence numbers in the transaction will marked bip-125 replaceable. If true, the sequence numbers in the transaction will
be left unchanged from the original. If false, any input sequence numbers in the be left unchanged from the original. If false, any input sequence numbers in the
original transaction that were less than 0xfffffffe will be increased to 0xfffffffe original transaction that were less than 0xfffffffe will be increased to 0xfffffffe
so the new transaction will not be explicitly bip-125 replaceable (though it may so the new transaction will not be explicitly bip-125 replaceable (though it may
still be replaceable in practice, for example if it has unconfirmed ancestors which still be replaceable in practice, for example if it has unconfirmed ancestors which
are replaceable). are replaceable).
"estimate_mode" (string, optional, default=UNSET) The fee estimate mode, must be one of: &#34;estimate_mode&#34; (string, optional, default=UNSET) The fee estimate mode, must be one of:
"UNSET" &#34;UNSET&#34;
"ECONOMICAL" &#34;ECONOMICAL&#34;
"CONSERVATIVE" &#34;CONSERVATIVE&#34;
} }
Result: Result:
{ {
"txid": "value", (string) The id of the new transaction &#34;txid&#34;: &#34;value&#34;, (string) The id of the new transaction
"origfee": n, (numeric) Fee of the replaced transaction &#34;origfee&#34;: n, (numeric) Fee of the replaced transaction
"fee": n, (numeric) Fee of the new transaction &#34;fee&#34;: n, (numeric) Fee of the new transaction
"errors": [ str... ] (json array of strings) Errors encountered during processing (may be empty) &#34;errors&#34;: [ str... ] (json array of strings) Errors encountered during processing (may be empty)
} }
Examples: Examples:
Bump the fee, get the new transaction's txid Bump the fee, get the new transaction&#39;s txid
> bitcoin-cli bumpfee <txid> &gt; bitcoin-cli bumpfee &lt;txid&gt;
</pre> </pre>
<hr> <hr>

4
clearbanned.html
View File

@ -40,8 +40,8 @@ clearbanned
Clear all banned IPs. Clear all banned IPs.
Examples: Examples:
> bitcoin-cli clearbanned &gt; bitcoin-cli clearbanned
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "clearbanned", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;clearbanned&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

10
combinerawtransaction.html
View File

@ -35,23 +35,23 @@
<div class="col-8"> <div class="col-8">
<h1>combinerawtransaction - Bitcoin RPC</h1> <h1>combinerawtransaction - Bitcoin RPC</h1>
<pre> <pre>
combinerawtransaction ["hexstring",...] combinerawtransaction [&#34;hexstring&#34;,...]
Combine multiple partially signed transactions into one transaction. Combine multiple partially signed transactions into one transaction.
The combined transaction may be another partially signed transaction or a The combined transaction may be another partially signed transaction or a
fully signed transaction. fully signed transaction.
Arguments: Arguments:
1. "txs" (string) A json array of hex strings of partially signed transactions 1. &#34;txs&#34; (string) A json array of hex strings of partially signed transactions
[ [
"hexstring" (string) A transaction hash &#34;hexstring&#34; (string) A transaction hash
,... ,...
] ]
Result: Result:
"hex" (string) The hex-encoded raw transaction with signature(s) &#34;hex&#34; (string) The hex-encoded raw transaction with signature(s)
Examples: Examples:
> bitcoin-cli combinerawtransaction ["myhex1", "myhex2", "myhex3"] &gt; bitcoin-cli combinerawtransaction [&#34;myhex1&#34;, &#34;myhex2&#34;, &#34;myhex3&#34;]
</pre> </pre>
<hr> <hr>

14
createmultisig.html
View File

@ -35,7 +35,7 @@
<div class="col-8"> <div class="col-8">
<h1>createmultisig - Bitcoin RPC</h1> <h1>createmultisig - Bitcoin RPC</h1>
<pre> <pre>
createmultisig nrequired ["key",...] createmultisig nrequired [&#34;key&#34;,...]
Creates a multi-signature address with n signature of m keys required. Creates a multi-signature address with n signature of m keys required.
It returns a json object with the address and redeemScript. It returns a json object with the address and redeemScript.
@ -45,25 +45,25 @@ to the wallet before upgrading to v0.17. To use the deprecated functionality, st
Arguments: Arguments:
1. nrequired (numeric, required) The number of required signatures out of the n keys or addresses. 1. nrequired (numeric, required) The number of required signatures out of the n keys or addresses.
2. "keys" (string, required) A json array of hex-encoded public keys 2. &#34;keys&#34; (string, required) A json array of hex-encoded public keys
[ [
"key" (string) The hex-encoded public key &#34;key&#34; (string) The hex-encoded public key
,... ,...
] ]
Result: Result:
{ {
"address":"multisigaddress", (string) The value of the new multisig address. &#34;address&#34;:&#34;multisigaddress&#34;, (string) The value of the new multisig address.
"redeemScript":"script" (string) The string value of the hex-encoded redemption script. &#34;redeemScript&#34;:&#34;script&#34; (string) The string value of the hex-encoded redemption script.
} }
Examples: Examples:
Create a multisig address from 2 public keys Create a multisig address from 2 public keys
> bitcoin-cli createmultisig 2 "[\"03789ed0bb717d88f7d321a368d905e7430207ebbd82bd342cf11ae157a7ace5fd\",\"03dbc6764b8884a92e871274b87583e6d5c2a58819473e17e107ef3f6aa5a61626\"]" &gt; bitcoin-cli createmultisig 2 &#34;[\&#34;03789ed0bb717d88f7d321a368d905e7430207ebbd82bd342cf11ae157a7ace5fd\&#34;,\&#34;03dbc6764b8884a92e871274b87583e6d5c2a58819473e17e107ef3f6aa5a61626\&#34;]&#34;
As a json rpc call As a json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "createmultisig", "params": [2, "[\"03789ed0bb717d88f7d321a368d905e7430207ebbd82bd342cf11ae157a7ace5fd\",\"03dbc6764b8884a92e871274b87583e6d5c2a58819473e17e107ef3f6aa5a61626\"]"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;createmultisig&#34;, &#34;params&#34;: [2, &#34;[\&#34;03789ed0bb717d88f7d321a368d905e7430207ebbd82bd342cf11ae157a7ace5fd\&#34;,\&#34;03dbc6764b8884a92e871274b87583e6d5c2a58819473e17e107ef3f6aa5a61626\&#34;]&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

28
createrawtransaction.html
View File

@ -35,28 +35,28 @@
<div class="col-8"> <div class="col-8">
<h1>createrawtransaction - Bitcoin RPC</h1> <h1>createrawtransaction - Bitcoin RPC</h1>
<pre> <pre>
createrawtransaction [{"txid":"id","vout":n},...] {"address":amount,"data":"hex",...} ( locktime ) ( replaceable ) createrawtransaction [{&#34;txid&#34;:&#34;id&#34;,&#34;vout&#34;:n},...] {&#34;address&#34;:amount,&#34;data&#34;:&#34;hex&#34;,...} ( locktime ) ( replaceable )
Create a transaction spending the given inputs and creating new outputs. Create a transaction spending the given inputs and creating new outputs.
Outputs can be addresses or data. Outputs can be addresses or data.
Returns hex-encoded raw transaction. Returns hex-encoded raw transaction.
Note that the transaction's inputs are not signed, and Note that the transaction&#39;s inputs are not signed, and
it is not stored in the wallet or transmitted to the network. it is not stored in the wallet or transmitted to the network.
Arguments: Arguments:
1. "inputs" (array, required) A json array of json objects 1. &#34;inputs&#34; (array, required) A json array of json objects
[ [
{ {
"txid":"id", (string, required) The transaction id &#34;txid&#34;:&#34;id&#34;, (string, required) The transaction id
"vout":n, (numeric, required) The output number &#34;vout&#34;:n, (numeric, required) The output number
"sequence":n (numeric, optional) The sequence number &#34;sequence&#34;:n (numeric, optional) The sequence number
} }
,... ,...
] ]
2. "outputs" (object, required) a json object with outputs 2. &#34;outputs&#34; (object, required) a json object with outputs
{ {
"address": x.xxx, (numeric or string, required) The key is the bitcoin address, the numeric value (can be string) is the BTC amount &#34;address&#34;: x.xxx, (numeric or string, required) The key is the bitcoin address, the numeric value (can be string) is the BTC amount
"data": "hex" (string, required) The key is "data", the value is hex encoded data &#34;data&#34;: &#34;hex&#34; (string, required) The key is &#34;data&#34;, the value is hex encoded data
,... ,...
} }
3. locktime (numeric, optional, default=0) Raw locktime. Non-0 value also locktime-activates inputs 3. locktime (numeric, optional, default=0) Raw locktime. Non-0 value also locktime-activates inputs
@ -64,13 +64,13 @@ Arguments:
Allows this transaction to be replaced by a transaction with higher fees. If provided, it is an error if explicit sequence numbers are incompatible. Allows this transaction to be replaced by a transaction with higher fees. If provided, it is an error if explicit sequence numbers are incompatible.
Result: Result:
"transaction" (string) hex string of the transaction &#34;transaction&#34; (string) hex string of the transaction
Examples: Examples:
> bitcoin-cli createrawtransaction "[{\"txid\":\"myid\",\"vout\":0}]" "{\"address\":0.01}" &gt; bitcoin-cli createrawtransaction &#34;[{\&#34;txid\&#34;:\&#34;myid\&#34;,\&#34;vout\&#34;:0}]&#34; &#34;{\&#34;address\&#34;:0.01}&#34;
> bitcoin-cli createrawtransaction "[{\"txid\":\"myid\",\"vout\":0}]" "{\"data\":\"00010203\"}" &gt; bitcoin-cli createrawtransaction &#34;[{\&#34;txid\&#34;:\&#34;myid\&#34;,\&#34;vout\&#34;:0}]&#34; &#34;{\&#34;data\&#34;:\&#34;00010203\&#34;}&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "createrawtransaction", "params": ["[{\"txid\":\"myid\",\"vout\":0}]", "{\"address\":0.01}"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;createrawtransaction&#34;, &#34;params&#34;: [&#34;[{\&#34;txid\&#34;:\&#34;myid\&#34;,\&#34;vout\&#34;:0}]&#34;, &#34;{\&#34;address\&#34;:0.01}&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "createrawtransaction", "params": ["[{\"txid\":\"myid\",\"vout\":0}]", "{\"data\":\"00010203\"}"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;createrawtransaction&#34;, &#34;params&#34;: [&#34;[{\&#34;txid\&#34;:\&#34;myid\&#34;,\&#34;vout\&#34;:0}]&#34;, &#34;{\&#34;data\&#34;:\&#34;00010203\&#34;}&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

56
decoderawtransaction.html
View File

@ -35,47 +35,47 @@
<div class="col-8"> <div class="col-8">
<h1>decoderawtransaction - Bitcoin RPC</h1> <h1>decoderawtransaction - Bitcoin RPC</h1>
<pre> <pre>
decoderawtransaction "hexstring" ( iswitness ) decoderawtransaction &#34;hexstring&#34; ( iswitness )
Return a JSON object representing the serialized, hex-encoded transaction. Return a JSON object representing the serialized, hex-encoded transaction.
Arguments: Arguments:
1. "hexstring" (string, required) The transaction hex string 1. &#34;hexstring&#34; (string, required) The transaction hex string
2. iswitness (boolean, optional) Whether the transaction hex is a serialized witness transaction 2. iswitness (boolean, optional) Whether the transaction hex is a serialized witness transaction
If iswitness is not present, heuristic tests will be used in decoding If iswitness is not present, heuristic tests will be used in decoding
Result: Result:
{ {
"txid" : "id", (string) The transaction id &#34;txid&#34; : &#34;id&#34;, (string) The transaction id
"hash" : "id", (string) The transaction hash (differs from txid for witness transactions) &#34;hash&#34; : &#34;id&#34;, (string) The transaction hash (differs from txid for witness transactions)
"size" : n, (numeric) The transaction size &#34;size&#34; : n, (numeric) The transaction size
"vsize" : n, (numeric) The virtual transaction size (differs from size for witness transactions) &#34;vsize&#34; : n, (numeric) The virtual transaction size (differs from size for witness transactions)
"version" : n, (numeric) The version &#34;version&#34; : n, (numeric) The version
"locktime" : ttt, (numeric) The lock time &#34;locktime&#34; : ttt, (numeric) The lock time
"vin" : [ (array of json objects) &#34;vin&#34; : [ (array of json objects)
{ {
"txid": "id", (string) The transaction id &#34;txid&#34;: &#34;id&#34;, (string) The transaction id
"vout": n, (numeric) The output number &#34;vout&#34;: n, (numeric) The output number
"scriptSig": { (json object) The script &#34;scriptSig&#34;: { (json object) The script
"asm": "asm", (string) asm &#34;asm&#34;: &#34;asm&#34;, (string) asm
"hex": "hex" (string) hex &#34;hex&#34;: &#34;hex&#34; (string) hex
}, },
"txinwitness": ["hex", ...] (array of string) hex-encoded witness data (if any) &#34;txinwitness&#34;: [&#34;hex&#34;, ...] (array of string) hex-encoded witness data (if any)
"sequence": n (numeric) The script sequence number &#34;sequence&#34;: n (numeric) The script sequence number
} }
,... ,...
], ],
"vout" : [ (array of json objects) &#34;vout&#34; : [ (array of json objects)
{ {
"value" : x.xxx, (numeric) The value in BTC &#34;value&#34; : x.xxx, (numeric) The value in BTC
"n" : n, (numeric) index &#34;n&#34; : n, (numeric) index
"scriptPubKey" : { (json object) &#34;scriptPubKey&#34; : { (json object)
"asm" : "asm", (string) the asm &#34;asm&#34; : &#34;asm&#34;, (string) the asm
"hex" : "hex", (string) the hex &#34;hex&#34; : &#34;hex&#34;, (string) the hex
"reqSigs" : n, (numeric) The required sigs &#34;reqSigs&#34; : n, (numeric) The required sigs
"type" : "pubkeyhash", (string) The type, eg 'pubkeyhash' &#34;type&#34; : &#34;pubkeyhash&#34;, (string) The type, eg &#39;pubkeyhash&#39;
"addresses" : [ (json array of string) &#34;addresses&#34; : [ (json array of string)
"12tvKAXCxZjSmdNbao16dKXC8tRWfcF5oc" (string) bitcoin address &#34;12tvKAXCxZjSmdNbao16dKXC8tRWfcF5oc&#34; (string) bitcoin address
,... ,...
] ]
} }
@ -85,8 +85,8 @@ Result:
} }
Examples: Examples:
> bitcoin-cli decoderawtransaction "hexstring" &gt; bitcoin-cli decoderawtransaction &#34;hexstring&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "decoderawtransaction", "params": ["hexstring"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;decoderawtransaction&#34;, &#34;params&#34;: [&#34;hexstring&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

22
decodescript.html
View File

@ -35,29 +35,29 @@
<div class="col-8"> <div class="col-8">
<h1>decodescript - Bitcoin RPC</h1> <h1>decodescript - Bitcoin RPC</h1>
<pre> <pre>
decodescript "hexstring" decodescript &#34;hexstring&#34;
Decode a hex-encoded script. Decode a hex-encoded script.
Arguments: Arguments:
1. "hexstring" (string) the hex encoded script 1. &#34;hexstring&#34; (string) the hex encoded script
Result: Result:
{ {
"asm":"asm", (string) Script public key &#34;asm&#34;:&#34;asm&#34;, (string) Script public key
"hex":"hex", (string) hex encoded public key &#34;hex&#34;:&#34;hex&#34;, (string) hex encoded public key
"type":"type", (string) The output type &#34;type&#34;:&#34;type&#34;, (string) The output type
"reqSigs": n, (numeric) The required signatures &#34;reqSigs&#34;: n, (numeric) The required signatures
"addresses": [ (json array of string) &#34;addresses&#34;: [ (json array of string)
"address" (string) bitcoin address &#34;address&#34; (string) bitcoin address
,... ,...
], ],
"p2sh","address" (string) address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH). &#34;p2sh&#34;,&#34;address&#34; (string) address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH).
} }
Examples: Examples:
> bitcoin-cli decodescript "hexstring" &gt; bitcoin-cli decodescript &#34;hexstring&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "decodescript", "params": ["hexstring"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;decodescript&#34;, &#34;params&#34;: [&#34;hexstring&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

18
disconnectnode.html
View File

@ -35,23 +35,23 @@
<div class="col-8"> <div class="col-8">
<h1>disconnectnode - Bitcoin RPC</h1> <h1>disconnectnode - Bitcoin RPC</h1>
<pre> <pre>
disconnectnode "[address]" [nodeid] disconnectnode &#34;[address]&#34; [nodeid]
Immediately disconnects from the specified peer node. Immediately disconnects from the specified peer node.
Strictly one out of 'address' and 'nodeid' can be provided to identify the node. Strictly one out of &#39;address&#39; and &#39;nodeid&#39; can be provided to identify the node.
To disconnect by nodeid, either set 'address' to the empty string, or call using the named 'nodeid' argument only. To disconnect by nodeid, either set &#39;address&#39; to the empty string, or call using the named &#39;nodeid&#39; argument only.
Arguments: Arguments:
1. "address" (string, optional) The IP address/port of the node 1. &#34;address&#34; (string, optional) The IP address/port of the node
2. "nodeid" (number, optional) The node ID (see getpeerinfo for node IDs) 2. &#34;nodeid&#34; (number, optional) The node ID (see getpeerinfo for node IDs)
Examples: Examples:
> bitcoin-cli disconnectnode "192.168.0.6:8333" &gt; bitcoin-cli disconnectnode &#34;192.168.0.6:8333&#34;
> bitcoin-cli disconnectnode "" 1 &gt; bitcoin-cli disconnectnode &#34;&#34; 1
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "disconnectnode", "params": ["192.168.0.6:8333"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;disconnectnode&#34;, &#34;params&#34;: [&#34;192.168.0.6:8333&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "disconnectnode", "params": ["", 1] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;disconnectnode&#34;, &#34;params&#34;: [&#34;&#34;, 1] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

14
dumpprivkey.html
View File

@ -35,21 +35,21 @@
<div class="col-8"> <div class="col-8">
<h1>dumpprivkey - Bitcoin RPC</h1> <h1>dumpprivkey - Bitcoin RPC</h1>
<pre> <pre>
dumpprivkey "address" dumpprivkey &#34;address&#34;
Reveals the private key corresponding to 'address'. Reveals the private key corresponding to &#39;address&#39;.
Then the importprivkey can be used with this output Then the importprivkey can be used with this output
Arguments: Arguments:
1. "address" (string, required) The bitcoin address for the private key 1. &#34;address&#34; (string, required) The bitcoin address for the private key
Result: Result:
"key" (string) The private key &#34;key&#34; (string) The private key
Examples: Examples:
> bitcoin-cli dumpprivkey "myaddress" &gt; bitcoin-cli dumpprivkey &#34;myaddress&#34;
> bitcoin-cli importprivkey "mykey" &gt; bitcoin-cli importprivkey &#34;mykey&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "dumpprivkey", "params": ["myaddress"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;dumpprivkey&#34;, &#34;params&#34;: [&#34;myaddress&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

10
dumpwallet.html
View File

@ -35,7 +35,7 @@
<div class="col-8"> <div class="col-8">
<h1>dumpwallet - Bitcoin RPC</h1> <h1>dumpwallet - Bitcoin RPC</h1>
<pre> <pre>
dumpwallet "filename" dumpwallet &#34;filename&#34;
Dumps all wallet keys in a human-readable format to a server-side file. This does not allow overwriting existing files. Dumps all wallet keys in a human-readable format to a server-side file. This does not allow overwriting existing files.
Imported scripts are included in the dumpfile, but corresponding BIP173 addresses, etc. may not be added automatically by importwallet. Imported scripts are included in the dumpfile, but corresponding BIP173 addresses, etc. may not be added automatically by importwallet.
@ -43,16 +43,16 @@ Note that if your wallet contains keys which are not derived from your HD seed (
only backing up the seed itself, and must be backed up too (e.g. ensure you back up the whole dumpfile). only backing up the seed itself, and must be backed up too (e.g. ensure you back up the whole dumpfile).
Arguments: Arguments:
1. "filename" (string, required) The filename with path (either absolute or relative to bitcoind) 1. &#34;filename&#34; (string, required) The filename with path (either absolute or relative to bitcoind)
Result: Result:
{ (json object) { (json object)
"filename" : { (string) The filename with full absolute path &#34;filename&#34; : { (string) The filename with full absolute path
} }
Examples: Examples:
> bitcoin-cli dumpwallet "test" &gt; bitcoin-cli dumpwallet &#34;test&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "dumpwallet", "params": ["test"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;dumpwallet&#34;, &#34;params&#34;: [&#34;test&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

16
encryptwallet.html
View File

@ -35,9 +35,9 @@
<div class="col-8"> <div class="col-8">
<h1>encryptwallet - Bitcoin RPC</h1> <h1>encryptwallet - Bitcoin RPC</h1>
<pre> <pre>
encryptwallet "passphrase" encryptwallet &#34;passphrase&#34;
Encrypts the wallet with 'passphrase'. This is for first time encryption. Encrypts the wallet with &#39;passphrase&#39;. This is for first time encryption.
After this, any calls that interact with private keys such as sending or signing After this, any calls that interact with private keys such as sending or signing
will require the passphrase to be set prior the making these calls. will require the passphrase to be set prior the making these calls.
Use the walletpassphrase call for this, and then walletlock call. Use the walletpassphrase call for this, and then walletlock call.
@ -45,24 +45,24 @@ If the wallet is already encrypted, use the walletpassphrasechange call.
Note that this will shutdown the server. Note that this will shutdown the server.
Arguments: Arguments:
1. "passphrase" (string) The pass phrase to encrypt the wallet with. It must be at least 1 character, but should be long. 1. &#34;passphrase&#34; (string) The pass phrase to encrypt the wallet with. It must be at least 1 character, but should be long.
Examples: Examples:
Encrypt your wallet Encrypt your wallet
> bitcoin-cli encryptwallet "my pass phrase" &gt; bitcoin-cli encryptwallet &#34;my pass phrase&#34;
Now set the passphrase to use the wallet, such as for signing or sending bitcoin Now set the passphrase to use the wallet, such as for signing or sending bitcoin
> bitcoin-cli walletpassphrase "my pass phrase" &gt; bitcoin-cli walletpassphrase &#34;my pass phrase&#34;
Now we can do something like sign Now we can do something like sign
> bitcoin-cli signmessage "address" "test message" &gt; bitcoin-cli signmessage &#34;address&#34; &#34;test message&#34;
Now lock the wallet again by removing the passphrase Now lock the wallet again by removing the passphrase
> bitcoin-cli walletlock &gt; bitcoin-cli walletlock
As a json rpc call As a json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "encryptwallet", "params": ["my pass phrase"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;encryptwallet&#34;, &#34;params&#34;: [&#34;my pass phrase&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

2
estimatefee.html
View File

@ -54,7 +54,7 @@ have been observed to make an estimate.
a fee that is high enough to get reliably included in the next block. a fee that is high enough to get reliably included in the next block.
Example: Example:
> bitcoin-cli estimatefee 6 &gt; bitcoin-cli estimatefee 6
</pre> </pre>
<hr> <hr>

18
estimatesmartfee.html
View File

@ -35,7 +35,7 @@
<div class="col-8"> <div class="col-8">
<h1>estimatesmartfee - Bitcoin RPC</h1> <h1>estimatesmartfee - Bitcoin RPC</h1>
<pre> <pre>
estimatesmartfee conf_target ("estimate_mode") estimatesmartfee conf_target (&#34;estimate_mode&#34;)
Estimates the approximate fee per kilobyte needed for a transaction to begin Estimates the approximate fee per kilobyte needed for a transaction to begin
confirmation within conf_target blocks if possible and return the number of blocks confirmation within conf_target blocks if possible and return the number of blocks
@ -44,21 +44,21 @@ in BIP 141 (witness data is discounted).
Arguments: Arguments:
1. conf_target (numeric) Confirmation target in blocks (1 - 1008) 1. conf_target (numeric) Confirmation target in blocks (1 - 1008)
2. "estimate_mode" (string, optional, default=CONSERVATIVE) The fee estimate mode. 2. &#34;estimate_mode&#34; (string, optional, default=CONSERVATIVE) The fee estimate mode.
Whether to return a more conservative estimate which also satisfies Whether to return a more conservative estimate which also satisfies
a longer history. A conservative estimate potentially returns a a longer history. A conservative estimate potentially returns a
higher feerate and is more likely to be sufficient for the desired higher feerate and is more likely to be sufficient for the desired
target, but is not as responsive to short term drops in the target, but is not as responsive to short term drops in the
prevailing fee market. Must be one of: prevailing fee market. Must be one of:
"UNSET" (defaults to CONSERVATIVE) &#34;UNSET&#34; (defaults to CONSERVATIVE)
"ECONOMICAL" &#34;ECONOMICAL&#34;
"CONSERVATIVE" &#34;CONSERVATIVE&#34;
Result: Result:
{ {
"feerate" : x.x, (numeric, optional) estimate fee rate in BTC/kB &#34;feerate&#34; : x.x, (numeric, optional) estimate fee rate in BTC/kB
"errors": [ str... ] (json array of strings, optional) Errors encountered during processing &#34;errors&#34;: [ str... ] (json array of strings, optional) Errors encountered during processing
"blocks" : n (numeric) block number where estimate was found &#34;blocks&#34; : n (numeric) block number where estimate was found
} }
The request target will be clamped between 2 and the highest target The request target will be clamped between 2 and the highest target
@ -67,7 +67,7 @@ An error is returned if not enough transactions and blocks
have been observed to make an estimate for any number of blocks. have been observed to make an estimate for any number of blocks.
Example: Example:
> bitcoin-cli estimatesmartfee 6 &gt; bitcoin-cli estimatesmartfee 6
</pre> </pre>
<hr> <hr>

50
fundrawtransaction.html
View File

@ -35,67 +35,67 @@
<div class="col-8"> <div class="col-8">
<h1>fundrawtransaction - Bitcoin RPC</h1> <h1>fundrawtransaction - Bitcoin RPC</h1>
<pre> <pre>
fundrawtransaction "hexstring" ( options iswitness ) fundrawtransaction &#34;hexstring&#34; ( options iswitness )
Add inputs to a transaction until it has enough in value to meet its out value. Add inputs to a transaction until it has enough in value to meet its out value.
This will not modify existing inputs, and will add at most one change output to the outputs. This will not modify existing inputs, and will add at most one change output to the outputs.
No existing outputs will be modified unless "subtractFeeFromOutputs" is specified. No existing outputs will be modified unless &#34;subtractFeeFromOutputs&#34; is specified.
Note that inputs which were signed may need to be resigned after completion since in/outputs have been added. Note that inputs which were signed may need to be resigned after completion since in/outputs have been added.
The inputs added will not be signed, use signrawtransaction for that. The inputs added will not be signed, use signrawtransaction for that.
Note that all existing inputs must have their previous output transaction be in the wallet. Note that all existing inputs must have their previous output transaction be in the wallet.
Note that all inputs selected must be of standard form and P2SH scripts must be Note that all inputs selected must be of standard form and P2SH scripts must be
in the wallet using importaddress or addmultisigaddress (to calculate fees). in the wallet using importaddress or addmultisigaddress (to calculate fees).
You can see whether this is the case by checking the "solvable" field in the listunspent output. You can see whether this is the case by checking the &#34;solvable&#34; field in the listunspent output.
Only pay-to-pubkey, multisig, and P2SH versions thereof are currently supported for watch-only Only pay-to-pubkey, multisig, and P2SH versions thereof are currently supported for watch-only
Arguments: Arguments:
1. "hexstring" (string, required) The hex string of the raw transaction 1. &#34;hexstring&#34; (string, required) The hex string of the raw transaction
2. options (object, optional) 2. options (object, optional)
{ {
"changeAddress" (string, optional, default pool address) The bitcoin address to receive the change &#34;changeAddress&#34; (string, optional, default pool address) The bitcoin address to receive the change
"changePosition" (numeric, optional, default random) The index of the change output &#34;changePosition&#34; (numeric, optional, default random) The index of the change output
"change_type" (string, optional) The output type to use. Only valid if changeAddress is not specified. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -changetype. &#34;change_type&#34; (string, optional) The output type to use. Only valid if changeAddress is not specified. Options are &#34;legacy&#34;, &#34;p2sh-segwit&#34;, and &#34;bech32&#34;. Default is set by -changetype.
"includeWatching" (boolean, optional, default false) Also select inputs which are watch only &#34;includeWatching&#34; (boolean, optional, default false) Also select inputs which are watch only
"lockUnspents" (boolean, optional, default false) Lock selected unspent outputs &#34;lockUnspents&#34; (boolean, optional, default false) Lock selected unspent outputs
"feeRate" (numeric, optional, default not set: makes wallet determine the fee) Set a specific fee rate in BTC/kB &#34;feeRate&#34; (numeric, optional, default not set: makes wallet determine the fee) Set a specific fee rate in BTC/kB
"subtractFeeFromOutputs" (array, optional) A json array of integers. &#34;subtractFeeFromOutputs&#34; (array, optional) A json array of integers.
The fee will be equally deducted from the amount of each specified output. The fee will be equally deducted from the amount of each specified output.
The outputs are specified by their zero-based index, before any change output is added. The outputs are specified by their zero-based index, before any change output is added.
Those recipients will receive less bitcoins than you enter in their corresponding amount field. Those recipients will receive less bitcoins than you enter in their corresponding amount field.
If no outputs are specified here, the sender pays the fee. If no outputs are specified here, the sender pays the fee.
[vout_index,...] [vout_index,...]
"replaceable" (boolean, optional) Marks this transaction as BIP125 replaceable. &#34;replaceable&#34; (boolean, optional) Marks this transaction as BIP125 replaceable.
Allows this transaction to be replaced by a transaction with higher fees Allows this transaction to be replaced by a transaction with higher fees
"conf_target" (numeric, optional) Confirmation target (in blocks) &#34;conf_target&#34; (numeric, optional) Confirmation target (in blocks)
"estimate_mode" (string, optional, default=UNSET) The fee estimate mode, must be one of: &#34;estimate_mode&#34; (string, optional, default=UNSET) The fee estimate mode, must be one of:
"UNSET" &#34;UNSET&#34;
"ECONOMICAL" &#34;ECONOMICAL&#34;
"CONSERVATIVE" &#34;CONSERVATIVE&#34;
} }
for backward compatibility: passing in a true instead of an object will result in {"includeWatching":true} for backward compatibility: passing in a true instead of an object will result in {&#34;includeWatching&#34;:true}
3. iswitness (boolean, optional) Whether the transaction hex is a serialized witness transaction 3. iswitness (boolean, optional) Whether the transaction hex is a serialized witness transaction
If iswitness is not present, heuristic tests will be used in decoding If iswitness is not present, heuristic tests will be used in decoding
Result: Result:
{ {
"hex": "value", (string) The resulting raw transaction (hex-encoded string) &#34;hex&#34;: &#34;value&#34;, (string) The resulting raw transaction (hex-encoded string)
"fee": n, (numeric) Fee in BTC the resulting transaction pays &#34;fee&#34;: n, (numeric) Fee in BTC the resulting transaction pays
"changepos": n (numeric) The position of the added change output, or -1 &#34;changepos&#34;: n (numeric) The position of the added change output, or -1
} }
Examples: Examples:
Create a transaction with no inputs Create a transaction with no inputs
> bitcoin-cli createrawtransaction "[]" "{\"myaddress\":0.01}" &gt; bitcoin-cli createrawtransaction &#34;[]&#34; &#34;{\&#34;myaddress\&#34;:0.01}&#34;
Add sufficient unsigned inputs to meet the output value Add sufficient unsigned inputs to meet the output value
> bitcoin-cli fundrawtransaction "rawtransactionhex" &gt; bitcoin-cli fundrawtransaction &#34;rawtransactionhex&#34;
Sign the transaction Sign the transaction
> bitcoin-cli signrawtransaction "fundedtransactionhex" &gt; bitcoin-cli signrawtransaction &#34;fundedtransactionhex&#34;
Send the transaction Send the transaction
> bitcoin-cli sendrawtransaction "signedtransactionhex" &gt; bitcoin-cli sendrawtransaction &#34;signedtransactionhex&#34;
</pre> </pre>
<hr> <hr>

2
generate.html
View File

@ -49,7 +49,7 @@ Result:
Examples: Examples:
Generate 11 blocks Generate 11 blocks
> bitcoin-cli generate 11 &gt; bitcoin-cli generate 11
</pre> </pre>
<hr> <hr>

2
generatetoaddress.html
View File

@ -50,7 +50,7 @@ Result:
Examples: Examples:
Generate 11 blocks to myaddress Generate 11 blocks to myaddress
> bitcoin-cli generatetoaddress 11 "myaddress" &gt; bitcoin-cli generatetoaddress 11 &#34;myaddress&#34;
</pre> </pre>
<hr> <hr>

10
getaccount.html
View File

@ -35,19 +35,19 @@
<div class="col-8"> <div class="col-8">
<h1>getaccount - Bitcoin RPC</h1> <h1>getaccount - Bitcoin RPC</h1>
<pre> <pre>
getaccount "address" getaccount &#34;address&#34;
DEPRECATED. Returns the account associated with the given address. DEPRECATED. Returns the account associated with the given address.
Arguments: Arguments:
1. "address" (string, required) The bitcoin address for account lookup. 1. &#34;address&#34; (string, required) The bitcoin address for account lookup.
Result: Result:
"accountname" (string) the account address &#34;accountname&#34; (string) the account address
Examples: Examples:
> bitcoin-cli getaccount "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" &gt; bitcoin-cli getaccount &#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaccount", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getaccount&#34;, &#34;params&#34;: [&#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

14
getaccountaddress.html
View File

@ -35,21 +35,21 @@
<div class="col-8"> <div class="col-8">
<h1>getaccountaddress - Bitcoin RPC</h1> <h1>getaccountaddress - Bitcoin RPC</h1>
<pre> <pre>
getaccountaddress "account" getaccountaddress &#34;account&#34;
DEPRECATED. Returns the current Bitcoin address for receiving payments to this account. DEPRECATED. Returns the current Bitcoin address for receiving payments to this account.
Arguments: Arguments:
1. "account" (string, required) The account name for the address. It can also be set to the empty string "" to represent the default account. The account does not need to exist, it will be created and a new address created if there is no account by the given name. 1. &#34;account&#34; (string, required) The account name for the address. It can also be set to the empty string &#34;&#34; to represent the default account. The account does not need to exist, it will be created and a new address created if there is no account by the given name.
Result: Result:
"address" (string) The account bitcoin address &#34;address&#34; (string) The account bitcoin address
Examples: Examples:
> bitcoin-cli getaccountaddress &gt; bitcoin-cli getaccountaddress
> bitcoin-cli getaccountaddress "" &gt; bitcoin-cli getaccountaddress &#34;&#34;
> bitcoin-cli getaccountaddress "myaccount" &gt; bitcoin-cli getaccountaddress &#34;myaccount&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaccountaddress", "params": ["myaccount"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getaccountaddress&#34;, &#34;params&#34;: [&#34;myaccount&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

18
getaddednodeinfo.html
View File

@ -35,23 +35,23 @@
<div class="col-8"> <div class="col-8">
<h1>getaddednodeinfo - Bitcoin RPC</h1> <h1>getaddednodeinfo - Bitcoin RPC</h1>
<pre> <pre>
getaddednodeinfo ( "node" ) getaddednodeinfo ( &#34;node&#34; )
Returns information about the given added node, or all added nodes Returns information about the given added node, or all added nodes
(note that onetry addnodes are not listed here) (note that onetry addnodes are not listed here)
Arguments: Arguments:
1. "node" (string, optional) If provided, return information about this specific node, otherwise all nodes are returned. 1. &#34;node&#34; (string, optional) If provided, return information about this specific node, otherwise all nodes are returned.
Result: Result:
[ [
{ {
"addednode" : "192.168.0.201", (string) The node IP address or name (as provided to addnode) &#34;addednode&#34; : &#34;192.168.0.201&#34;, (string) The node IP address or name (as provided to addnode)
"connected" : true|false, (boolean) If connected &#34;connected&#34; : true|false, (boolean) If connected
"addresses" : [ (list of objects) Only when connected = true &#34;addresses&#34; : [ (list of objects) Only when connected = true
{ {
"address" : "192.168.0.201:8333", (string) The bitcoin server IP and port we're connected to &#34;address&#34; : &#34;192.168.0.201:8333&#34;, (string) The bitcoin server IP and port we&#39;re connected to
"connected" : "outbound" (string) connection, inbound or outbound &#34;connected&#34; : &#34;outbound&#34; (string) connection, inbound or outbound
} }
] ]
} }
@ -59,8 +59,8 @@ Result:
] ]
Examples: Examples:
> bitcoin-cli getaddednodeinfo "192.168.0.201" &gt; bitcoin-cli getaddednodeinfo &#34;192.168.0.201&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddednodeinfo", "params": ["192.168.0.201"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getaddednodeinfo&#34;, &#34;params&#34;: [&#34;192.168.0.201&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

10
getaddressesbyaccount.html
View File

@ -35,22 +35,22 @@
<div class="col-8"> <div class="col-8">
<h1>getaddressesbyaccount - Bitcoin RPC</h1> <h1>getaddressesbyaccount - Bitcoin RPC</h1>
<pre> <pre>
getaddressesbyaccount "account" getaddressesbyaccount &#34;account&#34;
DEPRECATED. Returns the list of addresses for the given account. DEPRECATED. Returns the list of addresses for the given account.
Arguments: Arguments:
1. "account" (string, required) The account name. 1. &#34;account&#34; (string, required) The account name.
Result: Result:
[ (json array of string) [ (json array of string)
"address" (string) a bitcoin address associated with the given account &#34;address&#34; (string) a bitcoin address associated with the given account
,... ,...
] ]
Examples: Examples:
> bitcoin-cli getaddressesbyaccount "tabby" &gt; bitcoin-cli getaddressesbyaccount &#34;tabby&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddressesbyaccount", "params": ["tabby"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getaddressesbyaccount&#34;, &#34;params&#34;: [&#34;tabby&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

22
getbalance.html
View File

@ -35,20 +35,20 @@
<div class="col-8"> <div class="col-8">
<h1>getbalance - Bitcoin RPC</h1> <h1>getbalance - Bitcoin RPC</h1>
<pre> <pre>
getbalance ( "account" minconf include_watchonly ) getbalance ( &#34;account&#34; minconf include_watchonly )
If account is not specified, returns the server's total available balance. If account is not specified, returns the server&#39;s total available balance.
The available balance is what the wallet considers currently spendable, and is The available balance is what the wallet considers currently spendable, and is
thus affected by options which limit spendability such as -spendzeroconfchange. thus affected by options which limit spendability such as -spendzeroconfchange.
If account is specified (DEPRECATED), returns the balance in the account. If account is specified (DEPRECATED), returns the balance in the account.
Note that the account "" is not the same as leaving the parameter out. Note that the account &#34;&#34; is not the same as leaving the parameter out.
The server total may be different to the balance in the default "" account. The server total may be different to the balance in the default &#34;&#34; account.
Arguments: Arguments:
1. "account" (string, optional) DEPRECATED. The account string may be given as a 1. &#34;account&#34; (string, optional) DEPRECATED. The account string may be given as a
specific account name to find the balance associated with wallet keys in specific account name to find the balance associated with wallet keys in
a named account, or as the empty string ("") to find the balance a named account, or as the empty string (&#34;&#34;) to find the balance
associated with wallet keys not in any named account, or as "*" to find associated with wallet keys not in any named account, or as &#34;*&#34; to find
the balance associated with all wallet keys regardless of account. the balance associated with all wallet keys regardless of account.
When this option is specified, it calculates the balance in a different When this option is specified, it calculates the balance in a different
way than when it is not specified, and which can count spends twice when way than when it is not specified, and which can count spends twice when
@ -58,7 +58,7 @@ Arguments:
reliable and has resulted in confusing outcomes, so it is recommended to reliable and has resulted in confusing outcomes, so it is recommended to
avoid passing this argument. avoid passing this argument.
2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times. 2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times.
3. include_watchonly (bool, optional, default=false) Also include balance in watch-only addresses (see 'importaddress') 3. include_watchonly (bool, optional, default=false) Also include balance in watch-only addresses (see &#39;importaddress&#39;)
Result: Result:
amount (numeric) The total amount in BTC received for this account. amount (numeric) The total amount in BTC received for this account.
@ -66,13 +66,13 @@ amount (numeric) The total amount in BTC received for this account.
Examples: Examples:
The total amount in the wallet with 1 or more confirmations The total amount in the wallet with 1 or more confirmations
> bitcoin-cli getbalance &gt; bitcoin-cli getbalance
The total amount in the wallet at least 6 blocks confirmed The total amount in the wallet at least 6 blocks confirmed
> bitcoin-cli getbalance "*" 6 &gt; bitcoin-cli getbalance &#34;*&#34; 6
As a json rpc call As a json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getbalance", "params": ["*", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getbalance&#34;, &#34;params&#34;: [&#34;*&#34;, 6] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

6
getbestblockhash.html
View File

@ -40,11 +40,11 @@ getbestblockhash
Returns the hash of the best (tip) block in the longest blockchain. Returns the hash of the best (tip) block in the longest blockchain.
Result: Result:
"hex" (string) the block hash hex encoded &#34;hex&#34; (string) the block hash hex encoded
Examples: Examples:
> bitcoin-cli getbestblockhash &gt; bitcoin-cli getbestblockhash
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getbestblockhash", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getbestblockhash&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

56
getblock.html
View File

@ -35,56 +35,56 @@
<div class="col-8"> <div class="col-8">
<h1>getblock - Bitcoin RPC</h1> <h1>getblock - Bitcoin RPC</h1>
<pre> <pre>
getblock "blockhash" ( verbosity ) getblock &#34;blockhash&#34; ( verbosity )
If verbosity is 0, returns a string that is serialized, hex-encoded data for block 'hash'. If verbosity is 0, returns a string that is serialized, hex-encoded data for block &#39;hash&#39;.
If verbosity is 1, returns an Object with information about block <hash>. If verbosity is 1, returns an Object with information about block &lt;hash&gt;.
If verbosity is 2, returns an Object with information about block <hash> and information about each transaction. If verbosity is 2, returns an Object with information about block &lt;hash&gt; and information about each transaction.
Arguments: Arguments:
1. "blockhash" (string, required) The block hash 1. &#34;blockhash&#34; (string, required) The block hash
2. verbosity (numeric, optional, default=1) 0 for hex encoded data, 1 for a json object, and 2 for json object with transaction data 2. verbosity (numeric, optional, default=1) 0 for hex encoded data, 1 for a json object, and 2 for json object with transaction data
Result (for verbosity = 0): Result (for verbosity = 0):
"data" (string) A string that is serialized, hex-encoded data for block 'hash'. &#34;data&#34; (string) A string that is serialized, hex-encoded data for block &#39;hash&#39;.
Result (for verbosity = 1): Result (for verbosity = 1):
{ {
"hash" : "hash", (string) the block hash (same as provided) &#34;hash&#34; : &#34;hash&#34;, (string) the block hash (same as provided)
"confirmations" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain &#34;confirmations&#34; : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain
"size" : n, (numeric) The block size &#34;size&#34; : n, (numeric) The block size
"strippedsize" : n, (numeric) The block size excluding witness data &#34;strippedsize&#34; : n, (numeric) The block size excluding witness data
"weight" : n (numeric) The block weight as defined in BIP 141 &#34;weight&#34; : n (numeric) The block weight as defined in BIP 141
"height" : n, (numeric) The block height or index &#34;height&#34; : n, (numeric) The block height or index
"version" : n, (numeric) The block version &#34;version&#34; : n, (numeric) The block version
"versionHex" : "00000000", (string) The block version formatted in hexadecimal &#34;versionHex&#34; : &#34;00000000&#34;, (string) The block version formatted in hexadecimal
"merkleroot" : "xxxx", (string) The merkle root &#34;merkleroot&#34; : &#34;xxxx&#34;, (string) The merkle root
"tx" : [ (array of string) The transaction ids &#34;tx&#34; : [ (array of string) The transaction ids
"transactionid" (string) The transaction id &#34;transactionid&#34; (string) The transaction id
,... ,...
], ],
"time" : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT) &#34;time&#34; : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT)
"mediantime" : ttt, (numeric) The median block time in seconds since epoch (Jan 1 1970 GMT) &#34;mediantime&#34; : ttt, (numeric) The median block time in seconds since epoch (Jan 1 1970 GMT)
"nonce" : n, (numeric) The nonce &#34;nonce&#34; : n, (numeric) The nonce
"bits" : "1d00ffff", (string) The bits &#34;bits&#34; : &#34;1d00ffff&#34;, (string) The bits
"difficulty" : x.xxx, (numeric) The difficulty &#34;difficulty&#34; : x.xxx, (numeric) The difficulty
"chainwork" : "xxxx", (string) Expected number of hashes required to produce the chain up to this block (in hex) &#34;chainwork&#34; : &#34;xxxx&#34;, (string) Expected number of hashes required to produce the chain up to this block (in hex)
"previousblockhash" : "hash", (string) The hash of the previous block &#34;previousblockhash&#34; : &#34;hash&#34;, (string) The hash of the previous block
"nextblockhash" : "hash" (string) The hash of the next block &#34;nextblockhash&#34; : &#34;hash&#34; (string) The hash of the next block
} }
Result (for verbosity = 2): Result (for verbosity = 2):
{ {
..., Same output as verbosity = 1. ..., Same output as verbosity = 1.
"tx" : [ (array of Objects) The transactions in the format of the getrawtransaction RPC. Different from verbosity = 1 "tx" result. &#34;tx&#34; : [ (array of Objects) The transactions in the format of the getrawtransaction RPC. Different from verbosity = 1 &#34;tx&#34; result.
,... ,...
], ],
,... Same output as verbosity = 1. ,... Same output as verbosity = 1.
} }
Examples: Examples:
> bitcoin-cli getblock "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09" &gt; bitcoin-cli getblock &#34;00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblock", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getblock&#34;, &#34;params&#34;: [&#34;00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

70
getblockchaininfo.html
View File

@ -40,51 +40,51 @@ Returns an object containing various state info regarding blockchain processing.
Result: Result:
{ {
"chain": "xxxx", (string) current network name as defined in BIP70 (main, test, regtest) &#34;chain&#34;: &#34;xxxx&#34;, (string) current network name as defined in BIP70 (main, test, regtest)
"blocks": xxxxxx, (numeric) the current number of blocks processed in the server &#34;blocks&#34;: xxxxxx, (numeric) the current number of blocks processed in the server
"headers": xxxxxx, (numeric) the current number of headers we have validated &#34;headers&#34;: xxxxxx, (numeric) the current number of headers we have validated
"bestblockhash": "...", (string) the hash of the currently best block &#34;bestblockhash&#34;: &#34;...&#34;, (string) the hash of the currently best block
"difficulty": xxxxxx, (numeric) the current difficulty &#34;difficulty&#34;: xxxxxx, (numeric) the current difficulty
"mediantime": xxxxxx, (numeric) median time for the current best block &#34;mediantime&#34;: xxxxxx, (numeric) median time for the current best block
"verificationprogress": xxxx, (numeric) estimate of verification progress [0..1] &#34;verificationprogress&#34;: xxxx, (numeric) estimate of verification progress [0..1]
"initialblockdownload": xxxx, (bool) (debug information) estimate of whether this node is in Initial Block Download mode. &#34;initialblockdownload&#34;: xxxx, (bool) (debug information) estimate of whether this node is in Initial Block Download mode.
"chainwork": "xxxx" (string) total amount of work in active chain, in hexadecimal &#34;chainwork&#34;: &#34;xxxx&#34; (string) total amount of work in active chain, in hexadecimal
"size_on_disk": xxxxxx, (numeric) the estimated size of the block and undo files on disk &#34;size_on_disk&#34;: xxxxxx, (numeric) the estimated size of the block and undo files on disk
"pruned": xx, (boolean) if the blocks are subject to pruning &#34;pruned&#34;: xx, (boolean) if the blocks are subject to pruning
"pruneheight": xxxxxx, (numeric) lowest-height complete block stored (only present if pruning is enabled) &#34;pruneheight&#34;: xxxxxx, (numeric) lowest-height complete block stored (only present if pruning is enabled)
"automatic_pruning": xx, (boolean) whether automatic pruning is enabled (only present if pruning is enabled) &#34;automatic_pruning&#34;: xx, (boolean) whether automatic pruning is enabled (only present if pruning is enabled)
"prune_target_size": xxxxxx, (numeric) the target size used by pruning (only present if automatic pruning is enabled) &#34;prune_target_size&#34;: xxxxxx, (numeric) the target size used by pruning (only present if automatic pruning is enabled)
"softforks": [ (array) status of softforks in progress &#34;softforks&#34;: [ (array) status of softforks in progress
{ {
"id": "xxxx", (string) name of softfork &#34;id&#34;: &#34;xxxx&#34;, (string) name of softfork
"version": xx, (numeric) block version &#34;version&#34;: xx, (numeric) block version
"reject": { (object) progress toward rejecting pre-softfork blocks &#34;reject&#34;: { (object) progress toward rejecting pre-softfork blocks
"status": xx, (boolean) true if threshold reached &#34;status&#34;: xx, (boolean) true if threshold reached
}, },
}, ... }, ...
], ],
"bip9_softforks": { (object) status of BIP9 softforks in progress &#34;bip9_softforks&#34;: { (object) status of BIP9 softforks in progress
"xxxx" : { (string) name of the softfork &#34;xxxx&#34; : { (string) name of the softfork
"status": "xxxx", (string) one of "defined", "started", "locked_in", "active", "failed" &#34;status&#34;: &#34;xxxx&#34;, (string) one of &#34;defined&#34;, &#34;started&#34;, &#34;locked_in&#34;, &#34;active&#34;, &#34;failed&#34;
"bit": xx, (numeric) the bit (0-28) in the block version field used to signal this softfork (only for "started" status) &#34;bit&#34;: xx, (numeric) the bit (0-28) in the block version field used to signal this softfork (only for &#34;started&#34; status)
"startTime": xx, (numeric) the minimum median time past of a block at which the bit gains its meaning &#34;startTime&#34;: xx, (numeric) the minimum median time past of a block at which the bit gains its meaning
"timeout": xx, (numeric) the median time past of a block at which the deployment is considered failed if not yet locked in &#34;timeout&#34;: xx, (numeric) the median time past of a block at which the deployment is considered failed if not yet locked in
"since": xx, (numeric) height of the first block to which the status applies &#34;since&#34;: xx, (numeric) height of the first block to which the status applies
"statistics": { (object) numeric statistics about BIP9 signalling for a softfork (only for "started" status) &#34;statistics&#34;: { (object) numeric statistics about BIP9 signalling for a softfork (only for &#34;started&#34; status)
"period": xx, (numeric) the length in blocks of the BIP9 signalling period &#34;period&#34;: xx, (numeric) the length in blocks of the BIP9 signalling period
"threshold": xx, (numeric) the number of blocks with the version bit set required to activate the feature &#34;threshold&#34;: xx, (numeric) the number of blocks with the version bit set required to activate the feature
"elapsed": xx, (numeric) the number of blocks elapsed since the beginning of the current period &#34;elapsed&#34;: xx, (numeric) the number of blocks elapsed since the beginning of the current period
"count": xx, (numeric) the number of blocks with the version bit set in the current period &#34;count&#34;: xx, (numeric) the number of blocks with the version bit set in the current period
"possible": xx (boolean) returns false if there are not enough blocks left in this period to pass activation threshold &#34;possible&#34;: xx (boolean) returns false if there are not enough blocks left in this period to pass activation threshold
} }
} }
} }
"warnings" : "...", (string) any network and blockchain warnings. &#34;warnings&#34; : &#34;...&#34;, (string) any network and blockchain warnings.
} }
Examples: Examples:
> bitcoin-cli getblockchaininfo &gt; bitcoin-cli getblockchaininfo
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockchaininfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getblockchaininfo&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

4
getblockcount.html
View File

@ -43,8 +43,8 @@ Result:
n (numeric) The current block count n (numeric) The current block count
Examples: Examples:
> bitcoin-cli getblockcount &gt; bitcoin-cli getblockcount
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockcount", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getblockcount&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

6
getblockhash.html
View File

@ -43,11 +43,11 @@ Arguments:
1. height (numeric, required) The height index 1. height (numeric, required) The height index
Result: Result:
"hash" (string) The block hash &#34;hash&#34; (string) The block hash
Examples: Examples:
> bitcoin-cli getblockhash 1000 &gt; bitcoin-cli getblockhash 1000
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockhash", "params": [1000] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getblockhash&#34;, &#34;params&#34;: [1000] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

42
getblockheader.html
View File

@ -35,39 +35,39 @@
<div class="col-8"> <div class="col-8">
<h1>getblockheader - Bitcoin RPC</h1> <h1>getblockheader - Bitcoin RPC</h1>
<pre> <pre>
getblockheader "hash" ( verbose ) getblockheader &#34;hash&#34; ( verbose )
If verbose is false, returns a string that is serialized, hex-encoded data for blockheader 'hash'. If verbose is false, returns a string that is serialized, hex-encoded data for blockheader &#39;hash&#39;.
If verbose is true, returns an Object with information about blockheader <hash>. If verbose is true, returns an Object with information about blockheader &lt;hash&gt;.
Arguments: Arguments:
1. "hash" (string, required) The block hash 1. &#34;hash&#34; (string, required) The block hash
2. verbose (boolean, optional, default=true) true for a json object, false for the hex encoded data 2. verbose (boolean, optional, default=true) true for a json object, false for the hex encoded data
Result (for verbose = true): Result (for verbose = true):
{ {
"hash" : "hash", (string) the block hash (same as provided) &#34;hash&#34; : &#34;hash&#34;, (string) the block hash (same as provided)
"confirmations" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain &#34;confirmations&#34; : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain
"height" : n, (numeric) The block height or index &#34;height&#34; : n, (numeric) The block height or index
"version" : n, (numeric) The block version &#34;version&#34; : n, (numeric) The block version
"versionHex" : "00000000", (string) The block version formatted in hexadecimal &#34;versionHex&#34; : &#34;00000000&#34;, (string) The block version formatted in hexadecimal
"merkleroot" : "xxxx", (string) The merkle root &#34;merkleroot&#34; : &#34;xxxx&#34;, (string) The merkle root
"time" : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT) &#34;time&#34; : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT)
"mediantime" : ttt, (numeric) The median block time in seconds since epoch (Jan 1 1970 GMT) &#34;mediantime&#34; : ttt, (numeric) The median block time in seconds since epoch (Jan 1 1970 GMT)
"nonce" : n, (numeric) The nonce &#34;nonce&#34; : n, (numeric) The nonce
"bits" : "1d00ffff", (string) The bits &#34;bits&#34; : &#34;1d00ffff&#34;, (string) The bits
"difficulty" : x.xxx, (numeric) The difficulty &#34;difficulty&#34; : x.xxx, (numeric) The difficulty
"chainwork" : "0000...1f3" (string) Expected number of hashes required to produce the current chain (in hex) &#34;chainwork&#34; : &#34;0000...1f3&#34; (string) Expected number of hashes required to produce the current chain (in hex)
"previousblockhash" : "hash", (string) The hash of the previous block &#34;previousblockhash&#34; : &#34;hash&#34;, (string) The hash of the previous block
"nextblockhash" : "hash", (string) The hash of the next block &#34;nextblockhash&#34; : &#34;hash&#34;, (string) The hash of the next block
} }
Result (for verbose=false): Result (for verbose=false):
"data" (string) A string that is serialized, hex-encoded data for block 'hash'. &#34;data&#34; (string) A string that is serialized, hex-encoded data for block &#39;hash&#39;.
Examples: Examples:
> bitcoin-cli getblockheader "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09" &gt; bitcoin-cli getblockheader &#34;00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockheader", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getblockheader&#34;, &#34;params&#34;: [&#34;00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

78
getblocktemplate.html
View File

@ -37,7 +37,7 @@
<pre> <pre>
getblocktemplate ( TemplateRequest ) getblocktemplate ( TemplateRequest )
If the request parameters include a 'mode' key, that is used to explicitly select between the default 'template' request or a 'proposal'. If the request parameters include a &#39;mode&#39; key, that is used to explicitly select between the default &#39;template&#39; request or a &#39;proposal&#39;.
It returns data needed to construct a block to work on. It returns data needed to construct a block to work on.
For full specification, see BIPs 22, 23, 9, and 145: For full specification, see BIPs 22, 23, 9, and 145:
https://github.com/bitcoin/bips/blob/master/bip-0022.mediawiki https://github.com/bitcoin/bips/blob/master/bip-0022.mediawiki
@ -48,13 +48,13 @@ For full specification, see BIPs 22, 23, 9, and 145:
Arguments: Arguments:
1. template_request (json object, optional) A json object in the following spec 1. template_request (json object, optional) A json object in the following spec
{ {
"mode":"template" (string, optional) This must be set to "template", "proposal" (see BIP 23), or omitted &#34;mode&#34;:&#34;template&#34; (string, optional) This must be set to &#34;template&#34;, &#34;proposal&#34; (see BIP 23), or omitted
"capabilities":[ (array, optional) A list of strings &#34;capabilities&#34;:[ (array, optional) A list of strings
"support" (string) client side supported feature, 'longpoll', 'coinbasetxn', 'coinbasevalue', 'proposal', 'serverlist', 'workid' &#34;support&#34; (string) client side supported feature, &#39;longpoll&#39;, &#39;coinbasetxn&#39;, &#39;coinbasevalue&#39;, &#39;proposal&#39;, &#39;serverlist&#39;, &#39;workid&#39;
,... ,...
], ],
"rules":[ (array, optional) A list of strings &#34;rules&#34;:[ (array, optional) A list of strings
"support" (string) client side supported softfork deployment &#34;support&#34; (string) client side supported softfork deployment
,... ,...
] ]
} }
@ -62,53 +62,53 @@ Arguments:
Result: Result:
{ {
"version" : n, (numeric) The preferred block version &#34;version&#34; : n, (numeric) The preferred block version
"rules" : [ "rulename", ... ], (array of strings) specific block rules that are to be enforced &#34;rules&#34; : [ &#34;rulename&#34;, ... ], (array of strings) specific block rules that are to be enforced
"vbavailable" : { (json object) set of pending, supported versionbit (BIP 9) softfork deployments &#34;vbavailable&#34; : { (json object) set of pending, supported versionbit (BIP 9) softfork deployments
"rulename" : bitnumber (numeric) identifies the bit number as indicating acceptance and readiness for the named softfork rule &#34;rulename&#34; : bitnumber (numeric) identifies the bit number as indicating acceptance and readiness for the named softfork rule
,... ,...
}, },
"vbrequired" : n, (numeric) bit mask of versionbits the server requires set in submissions &#34;vbrequired&#34; : n, (numeric) bit mask of versionbits the server requires set in submissions
"previousblockhash" : "xxxx", (string) The hash of current highest block &#34;previousblockhash&#34; : &#34;xxxx&#34;, (string) The hash of current highest block
"transactions" : [ (array) contents of non-coinbase transactions that should be included in the next block &#34;transactions&#34; : [ (array) contents of non-coinbase transactions that should be included in the next block
{ {
"data" : "xxxx", (string) transaction data encoded in hexadecimal (byte-for-byte) &#34;data&#34; : &#34;xxxx&#34;, (string) transaction data encoded in hexadecimal (byte-for-byte)
"txid" : "xxxx", (string) transaction id encoded in little-endian hexadecimal &#34;txid&#34; : &#34;xxxx&#34;, (string) transaction id encoded in little-endian hexadecimal
"hash" : "xxxx", (string) hash encoded in little-endian hexadecimal (including witness data) &#34;hash&#34; : &#34;xxxx&#34;, (string) hash encoded in little-endian hexadecimal (including witness data)
"depends" : [ (array) array of numbers &#34;depends&#34; : [ (array) array of numbers
n (numeric) transactions before this one (by 1-based index in 'transactions' list) that must be present in the final block if this one is n (numeric) transactions before this one (by 1-based index in &#39;transactions&#39; list) that must be present in the final block if this one is
,... ,...
], ],
"fee": n, (numeric) difference in value between transaction inputs and outputs (in satoshis); for coinbase transactions, this is a negative Number of the total collected block fees (ie, not including the block subsidy); if key is not present, fee is unknown and clients MUST NOT assume there isn't one &#34;fee&#34;: n, (numeric) difference in value between transaction inputs and outputs (in satoshis); for coinbase transactions, this is a negative Number of the total collected block fees (ie, not including the block subsidy); if key is not present, fee is unknown and clients MUST NOT assume there isn&#39;t one
"sigops" : n, (numeric) total SigOps cost, as counted for purposes of block limits; if key is not present, sigop cost is unknown and clients MUST NOT assume it is zero &#34;sigops&#34; : n, (numeric) total SigOps cost, as counted for purposes of block limits; if key is not present, sigop cost is unknown and clients MUST NOT assume it is zero
"weight" : n, (numeric) total transaction weight, as counted for purposes of block limits &#34;weight&#34; : n, (numeric) total transaction weight, as counted for purposes of block limits
"required" : true|false (boolean) if provided and true, this transaction must be in the final block &#34;required&#34; : true|false (boolean) if provided and true, this transaction must be in the final block
} }
,... ,...
], ],
"coinbaseaux" : { (json object) data that should be included in the coinbase's scriptSig content &#34;coinbaseaux&#34; : { (json object) data that should be included in the coinbase&#39;s scriptSig content
"flags" : "xx" (string) key name is to be ignored, and value included in scriptSig &#34;flags&#34; : &#34;xx&#34; (string) key name is to be ignored, and value included in scriptSig
}, },
"coinbasevalue" : n, (numeric) maximum allowable input to coinbase transaction, including the generation award and transaction fees (in satoshis) &#34;coinbasevalue&#34; : n, (numeric) maximum allowable input to coinbase transaction, including the generation award and transaction fees (in satoshis)
"coinbasetxn" : { ... }, (json object) information for coinbase transaction &#34;coinbasetxn&#34; : { ... }, (json object) information for coinbase transaction
"target" : "xxxx", (string) The hash target &#34;target&#34; : &#34;xxxx&#34;, (string) The hash target
"mintime" : xxx, (numeric) The minimum timestamp appropriate for next block time in seconds since epoch (Jan 1 1970 GMT) &#34;mintime&#34; : xxx, (numeric) The minimum timestamp appropriate for next block time in seconds since epoch (Jan 1 1970 GMT)
"mutable" : [ (array of string) list of ways the block template may be changed &#34;mutable&#34; : [ (array of string) list of ways the block template may be changed
"value" (string) A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock' &#34;value&#34; (string) A way the block template may be changed, e.g. &#39;time&#39;, &#39;transactions&#39;, &#39;prevblock&#39;
,... ,...
], ],
"noncerange" : "00000000ffffffff",(string) A range of valid nonces &#34;noncerange&#34; : &#34;00000000ffffffff&#34;,(string) A range of valid nonces
"sigoplimit" : n, (numeric) limit of sigops in blocks &#34;sigoplimit&#34; : n, (numeric) limit of sigops in blocks
"sizelimit" : n, (numeric) limit of block size &#34;sizelimit&#34; : n, (numeric) limit of block size
"weightlimit" : n, (numeric) limit of block weight &#34;weightlimit&#34; : n, (numeric) limit of block weight
"curtime" : ttt, (numeric) current timestamp in seconds since epoch (Jan 1 1970 GMT) &#34;curtime&#34; : ttt, (numeric) current timestamp in seconds since epoch (Jan 1 1970 GMT)
"bits" : "xxxxxxxx", (string) compressed target of next block &#34;bits&#34; : &#34;xxxxxxxx&#34;, (string) compressed target of next block
"height" : n (numeric) The height of the next block &#34;height&#34; : n (numeric) The height of the next block
} }
Examples: Examples:
> bitcoin-cli getblocktemplate &gt; bitcoin-cli getblocktemplate
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblocktemplate", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getblocktemplate&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

30
getchaintips.html
View File

@ -41,28 +41,28 @@ Return information about all known tips in the block tree, including the main ch
Result: Result:
[ [
{ {
"height": xxxx, (numeric) height of the chain tip &#34;height&#34;: xxxx, (numeric) height of the chain tip
"hash": "xxxx", (string) block hash of the tip &#34;hash&#34;: &#34;xxxx&#34;, (string) block hash of the tip
"branchlen": 0 (numeric) zero for main chain &#34;branchlen&#34;: 0 (numeric) zero for main chain
"status": "active" (string) "active" for the main chain &#34;status&#34;: &#34;active&#34; (string) &#34;active&#34; for the main chain
}, },
{ {
"height": xxxx, &#34;height&#34;: xxxx,
"hash": "xxxx", &#34;hash&#34;: &#34;xxxx&#34;,
"branchlen": 1 (numeric) length of branch connecting the tip to the main chain &#34;branchlen&#34;: 1 (numeric) length of branch connecting the tip to the main chain
"status": "xxxx" (string) status of the chain (active, valid-fork, valid-headers, headers-only, invalid) &#34;status&#34;: &#34;xxxx&#34; (string) status of the chain (active, valid-fork, valid-headers, headers-only, invalid)
} }
] ]
Possible values for status: Possible values for status:
1. "invalid" This branch contains at least one invalid block 1. &#34;invalid&#34; This branch contains at least one invalid block
2. "headers-only" Not all blocks for this branch are available, but the headers are valid 2. &#34;headers-only&#34; Not all blocks for this branch are available, but the headers are valid
3. "valid-headers" All blocks are available for this branch, but they were never fully validated 3. &#34;valid-headers&#34; All blocks are available for this branch, but they were never fully validated
4. "valid-fork" This branch is not part of the active chain, but is fully validated 4. &#34;valid-fork&#34; This branch is not part of the active chain, but is fully validated
5. "active" This is the tip of the active main chain, which is certainly valid 5. &#34;active&#34; This is the tip of the active main chain, which is certainly valid
Examples: Examples:
> bitcoin-cli getchaintips &gt; bitcoin-cli getchaintips
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getchaintips", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getchaintips&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

18
getchaintxstats.html
View File

@ -41,21 +41,21 @@ Compute statistics about the total number and rate of transactions in the chain.
Arguments: Arguments:
1. nblocks (numeric, optional) Size of the window in number of blocks (default: one month). 1. nblocks (numeric, optional) Size of the window in number of blocks (default: one month).
2. "blockhash" (string, optional) The hash of the block that ends the window. 2. &#34;blockhash&#34; (string, optional) The hash of the block that ends the window.
Result: Result:
{ {
"time": xxxxx, (numeric) The timestamp for the final block in the window in UNIX format. &#34;time&#34;: xxxxx, (numeric) The timestamp for the final block in the window in UNIX format.
"txcount": xxxxx, (numeric) The total number of transactions in the chain up to that point. &#34;txcount&#34;: xxxxx, (numeric) The total number of transactions in the chain up to that point.
"window_block_count": xxxxx, (numeric) Size of the window in number of blocks. &#34;window_block_count&#34;: xxxxx, (numeric) Size of the window in number of blocks.
"window_tx_count": xxxxx, (numeric) The number of transactions in the window. Only returned if "window_block_count" is > 0. &#34;window_tx_count&#34;: xxxxx, (numeric) The number of transactions in the window. Only returned if &#34;window_block_count&#34; is &gt; 0.
"window_interval": xxxxx, (numeric) The elapsed time in the window in seconds. Only returned if "window_block_count" is > 0. &#34;window_interval&#34;: xxxxx, (numeric) The elapsed time in the window in seconds. Only returned if &#34;window_block_count&#34; is &gt; 0.
"txrate": x.xx, (numeric) The average rate of transactions per second in the window. Only returned if "window_interval" is > 0. &#34;txrate&#34;: x.xx, (numeric) The average rate of transactions per second in the window. Only returned if &#34;window_interval&#34; is &gt; 0.
} }
Examples: Examples:
> bitcoin-cli getchaintxstats &gt; bitcoin-cli getchaintxstats
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getchaintxstats", "params": [2016] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getchaintxstats&#34;, &#34;params&#34;: [2016] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

4
getconnectioncount.html
View File

@ -43,8 +43,8 @@ Result:
n (numeric) The connection count n (numeric) The connection count
Examples: Examples:
> bitcoin-cli getconnectioncount &gt; bitcoin-cli getconnectioncount
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getconnectioncount", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getconnectioncount&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

4
getdifficulty.html
View File

@ -43,8 +43,8 @@ Result:
n.nnn (numeric) the proof-of-work difficulty as a multiple of the minimum difficulty. n.nnn (numeric) the proof-of-work difficulty as a multiple of the minimum difficulty.
Examples: Examples:
> bitcoin-cli getdifficulty &gt; bitcoin-cli getdifficulty
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getdifficulty", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getdifficulty&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

32
getmemoryinfo.html
View File

@ -35,31 +35,31 @@
<div class="col-8"> <div class="col-8">
<h1>getmemoryinfo - Bitcoin RPC</h1> <h1>getmemoryinfo - Bitcoin RPC</h1>
<pre> <pre>
getmemoryinfo ("mode") getmemoryinfo (&#34;mode&#34;)
Returns an object containing information about memory usage. Returns an object containing information about memory usage.
Arguments: Arguments:
1. "mode" determines what kind of information is returned. This argument is optional, the default mode is "stats". 1. &#34;mode&#34; determines what kind of information is returned. This argument is optional, the default mode is &#34;stats&#34;.
- "stats" returns general statistics about memory usage in the daemon. - &#34;stats&#34; returns general statistics about memory usage in the daemon.
- "mallocinfo" returns an XML string describing low-level heap state (only available if compiled with glibc 2.10+). - &#34;mallocinfo&#34; returns an XML string describing low-level heap state (only available if compiled with glibc 2.10+).
Result (mode "stats"): Result (mode &#34;stats&#34;):
{ {
"locked": { (json object) Information about locked memory manager &#34;locked&#34;: { (json object) Information about locked memory manager
"used": xxxxx, (numeric) Number of bytes used &#34;used&#34;: xxxxx, (numeric) Number of bytes used
"free": xxxxx, (numeric) Number of bytes available in current arenas &#34;free&#34;: xxxxx, (numeric) Number of bytes available in current arenas
"total": xxxxxxx, (numeric) Total number of bytes managed &#34;total&#34;: xxxxxxx, (numeric) Total number of bytes managed
"locked": xxxxxx, (numeric) Amount of bytes that succeeded locking. If this number is smaller than total, locking pages failed at some point and key data could be swapped to disk. &#34;locked&#34;: xxxxxx, (numeric) Amount of bytes that succeeded locking. If this number is smaller than total, locking pages failed at some point and key data could be swapped to disk.
"chunks_used": xxxxx, (numeric) Number allocated chunks &#34;chunks_used&#34;: xxxxx, (numeric) Number allocated chunks
"chunks_free": xxxxx, (numeric) Number unused chunks &#34;chunks_free&#34;: xxxxx, (numeric) Number unused chunks
} }
} }
Result (mode "mallocinfo"): Result (mode &#34;mallocinfo&#34;):
"<malloc version="1">..." &#34;&lt;malloc version=&#34;1&#34;&gt;...&#34;
Examples: Examples:
> bitcoin-cli getmemoryinfo &gt; bitcoin-cli getmemoryinfo
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmemoryinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getmemoryinfo&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

38
getmempoolancestors.html
View File

@ -40,39 +40,39 @@ getmempoolancestors txid (verbose)
If txid is in the mempool, returns all in-mempool ancestors. If txid is in the mempool, returns all in-mempool ancestors.
Arguments: Arguments:
1. "txid" (string, required) The transaction id (must be in mempool) 1. &#34;txid&#34; (string, required) The transaction id (must be in mempool)
2. verbose (boolean, optional, default=false) True for a json object, false for array of transaction ids 2. verbose (boolean, optional, default=false) True for a json object, false for array of transaction ids
Result (for verbose=false): Result (for verbose=false):
[ (json array of strings) [ (json array of strings)
"transactionid" (string) The transaction id of an in-mempool ancestor transaction &#34;transactionid&#34; (string) The transaction id of an in-mempool ancestor transaction
,... ,...
] ]
Result (for verbose=true): Result (for verbose=true):
{ (json object) { (json object)
"transactionid" : { (json object) &#34;transactionid&#34; : { (json object)
"size" : n, (numeric) virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted. &#34;size&#34; : n, (numeric) virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted.
"fee" : n, (numeric) transaction fee in BTC &#34;fee&#34; : n, (numeric) transaction fee in BTC
"modifiedfee" : n, (numeric) transaction fee with fee deltas used for mining priority &#34;modifiedfee&#34; : n, (numeric) transaction fee with fee deltas used for mining priority
"time" : n, (numeric) local time transaction entered pool in seconds since 1 Jan 1970 GMT &#34;time&#34; : n, (numeric) local time transaction entered pool in seconds since 1 Jan 1970 GMT
"height" : n, (numeric) block height when transaction entered pool &#34;height&#34; : n, (numeric) block height when transaction entered pool
"descendantcount" : n, (numeric) number of in-mempool descendant transactions (including this one) &#34;descendantcount&#34; : n, (numeric) number of in-mempool descendant transactions (including this one)
"descendantsize" : n, (numeric) virtual transaction size of in-mempool descendants (including this one) &#34;descendantsize&#34; : n, (numeric) virtual transaction size of in-mempool descendants (including this one)
"descendantfees" : n, (numeric) modified fees (see above) of in-mempool descendants (including this one) &#34;descendantfees&#34; : n, (numeric) modified fees (see above) of in-mempool descendants (including this one)
"ancestorcount" : n, (numeric) number of in-mempool ancestor transactions (including this one) &#34;ancestorcount&#34; : n, (numeric) number of in-mempool ancestor transactions (including this one)
"ancestorsize" : n, (numeric) virtual transaction size of in-mempool ancestors (including this one) &#34;ancestorsize&#34; : n, (numeric) virtual transaction size of in-mempool ancestors (including this one)
"ancestorfees" : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one) &#34;ancestorfees&#34; : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one)
"wtxid" : hash, (string) hash of serialized transaction, including witness data &#34;wtxid&#34; : hash, (string) hash of serialized transaction, including witness data
"depends" : [ (array) unconfirmed transactions used as inputs for this transaction &#34;depends&#34; : [ (array) unconfirmed transactions used as inputs for this transaction
"transactionid", (string) parent transaction id &#34;transactionid&#34;, (string) parent transaction id
... ] ... ]
}, ... }, ...
} }
Examples: Examples:
> bitcoin-cli getmempoolancestors "mytxid" &gt; bitcoin-cli getmempoolancestors &#34;mytxid&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmempoolancestors", "params": ["mytxid"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getmempoolancestors&#34;, &#34;params&#34;: [&#34;mytxid&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

38
getmempooldescendants.html
View File

@ -40,39 +40,39 @@ getmempooldescendants txid (verbose)
If txid is in the mempool, returns all in-mempool descendants. If txid is in the mempool, returns all in-mempool descendants.
Arguments: Arguments:
1. "txid" (string, required) The transaction id (must be in mempool) 1. &#34;txid&#34; (string, required) The transaction id (must be in mempool)
2. verbose (boolean, optional, default=false) True for a json object, false for array of transaction ids 2. verbose (boolean, optional, default=false) True for a json object, false for array of transaction ids
Result (for verbose=false): Result (for verbose=false):
[ (json array of strings) [ (json array of strings)
"transactionid" (string) The transaction id of an in-mempool descendant transaction &#34;transactionid&#34; (string) The transaction id of an in-mempool descendant transaction
,... ,...
] ]
Result (for verbose=true): Result (for verbose=true):
{ (json object) { (json object)
"transactionid" : { (json object) &#34;transactionid&#34; : { (json object)
"size" : n, (numeric) virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted. &#34;size&#34; : n, (numeric) virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted.
"fee" : n, (numeric) transaction fee in BTC &#34;fee&#34; : n, (numeric) transaction fee in BTC
"modifiedfee" : n, (numeric) transaction fee with fee deltas used for mining priority &#34;modifiedfee&#34; : n, (numeric) transaction fee with fee deltas used for mining priority
"time" : n, (numeric) local time transaction entered pool in seconds since 1 Jan 1970 GMT &#34;time&#34; : n, (numeric) local time transaction entered pool in seconds since 1 Jan 1970 GMT
"height" : n, (numeric) block height when transaction entered pool &#34;height&#34; : n, (numeric) block height when transaction entered pool
"descendantcount" : n, (numeric) number of in-mempool descendant transactions (including this one) &#34;descendantcount&#34; : n, (numeric) number of in-mempool descendant transactions (including this one)
"descendantsize" : n, (numeric) virtual transaction size of in-mempool descendants (including this one) &#34;descendantsize&#34; : n, (numeric) virtual transaction size of in-mempool descendants (including this one)
"descendantfees" : n, (numeric) modified fees (see above) of in-mempool descendants (including this one) &#34;descendantfees&#34; : n, (numeric) modified fees (see above) of in-mempool descendants (including this one)
"ancestorcount" : n, (numeric) number of in-mempool ancestor transactions (including this one) &#34;ancestorcount&#34; : n, (numeric) number of in-mempool ancestor transactions (including this one)
"ancestorsize" : n, (numeric) virtual transaction size of in-mempool ancestors (including this one) &#34;ancestorsize&#34; : n, (numeric) virtual transaction size of in-mempool ancestors (including this one)
"ancestorfees" : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one) &#34;ancestorfees&#34; : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one)
"wtxid" : hash, (string) hash of serialized transaction, including witness data &#34;wtxid&#34; : hash, (string) hash of serialized transaction, including witness data
"depends" : [ (array) unconfirmed transactions used as inputs for this transaction &#34;depends&#34; : [ (array) unconfirmed transactions used as inputs for this transaction
"transactionid", (string) parent transaction id &#34;transactionid&#34;, (string) parent transaction id
... ] ... ]
}, ... }, ...
} }
Examples: Examples:
> bitcoin-cli getmempooldescendants "mytxid" &gt; bitcoin-cli getmempooldescendants &#34;mytxid&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmempooldescendants", "params": ["mytxid"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getmempooldescendants&#34;, &#34;params&#34;: [&#34;mytxid&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

34
getmempoolentry.html
View File

@ -40,30 +40,30 @@ getmempoolentry txid
Returns mempool data for given transaction Returns mempool data for given transaction
Arguments: Arguments:
1. "txid" (string, required) The transaction id (must be in mempool) 1. &#34;txid&#34; (string, required) The transaction id (must be in mempool)
Result: Result:
{ (json object) { (json object)
"size" : n, (numeric) virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted. &#34;size&#34; : n, (numeric) virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted.
"fee" : n, (numeric) transaction fee in BTC &#34;fee&#34; : n, (numeric) transaction fee in BTC
"modifiedfee" : n, (numeric) transaction fee with fee deltas used for mining priority &#34;modifiedfee&#34; : n, (numeric) transaction fee with fee deltas used for mining priority
"time" : n, (numeric) local time transaction entered pool in seconds since 1 Jan 1970 GMT &#34;time&#34; : n, (numeric) local time transaction entered pool in seconds since 1 Jan 1970 GMT
"height" : n, (numeric) block height when transaction entered pool &#34;height&#34; : n, (numeric) block height when transaction entered pool
"descendantcount" : n, (numeric) number of in-mempool descendant transactions (including this one) &#34;descendantcount&#34; : n, (numeric) number of in-mempool descendant transactions (including this one)
"descendantsize" : n, (numeric) virtual transaction size of in-mempool descendants (including this one) &#34;descendantsize&#34; : n, (numeric) virtual transaction size of in-mempool descendants (including this one)
"descendantfees" : n, (numeric) modified fees (see above) of in-mempool descendants (including this one) &#34;descendantfees&#34; : n, (numeric) modified fees (see above) of in-mempool descendants (including this one)
"ancestorcount" : n, (numeric) number of in-mempool ancestor transactions (including this one) &#34;ancestorcount&#34; : n, (numeric) number of in-mempool ancestor transactions (including this one)
"ancestorsize" : n, (numeric) virtual transaction size of in-mempool ancestors (including this one) &#34;ancestorsize&#34; : n, (numeric) virtual transaction size of in-mempool ancestors (including this one)
"ancestorfees" : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one) &#34;ancestorfees&#34; : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one)
"wtxid" : hash, (string) hash of serialized transaction, including witness data &#34;wtxid&#34; : hash, (string) hash of serialized transaction, including witness data
"depends" : [ (array) unconfirmed transactions used as inputs for this transaction &#34;depends&#34; : [ (array) unconfirmed transactions used as inputs for this transaction
"transactionid", (string) parent transaction id &#34;transactionid&#34;, (string) parent transaction id
... ] ... ]
} }
Examples: Examples:
> bitcoin-cli getmempoolentry "mytxid" &gt; bitcoin-cli getmempoolentry &#34;mytxid&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmempoolentry", "params": ["mytxid"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getmempoolentry&#34;, &#34;params&#34;: [&#34;mytxid&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

16
getmempoolinfo.html
View File

@ -41,17 +41,17 @@ Returns details on the active state of the TX memory pool.
Result: Result:
{ {
"size": xxxxx, (numeric) Current tx count &#34;size&#34;: xxxxx, (numeric) Current tx count
"bytes": xxxxx, (numeric) Sum of all virtual transaction sizes as defined in BIP 141. Differs from actual serialized size because witness data is discounted &#34;bytes&#34;: xxxxx, (numeric) Sum of all virtual transaction sizes as defined in BIP 141. Differs from actual serialized size because witness data is discounted
"usage": xxxxx, (numeric) Total memory usage for the mempool &#34;usage&#34;: xxxxx, (numeric) Total memory usage for the mempool
"maxmempool": xxxxx, (numeric) Maximum memory usage for the mempool &#34;maxmempool&#34;: xxxxx, (numeric) Maximum memory usage for the mempool
"mempoolminfee": xxxxx (numeric) Minimum fee rate in BTC/kB for tx to be accepted. Is the maximum of minrelaytxfee and minimum mempool fee &#34;mempoolminfee&#34;: xxxxx (numeric) Minimum fee rate in BTC/kB for tx to be accepted. Is the maximum of minrelaytxfee and minimum mempool fee
"minrelaytxfee": xxxxx (numeric) Current minimum relay fee for transactions &#34;minrelaytxfee&#34;: xxxxx (numeric) Current minimum relay fee for transactions
} }
Examples: Examples:
> bitcoin-cli getmempoolinfo &gt; bitcoin-cli getmempoolinfo
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmempoolinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getmempoolinfo&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

22
getmininginfo.html
View File

@ -40,20 +40,20 @@ getmininginfo
Returns a json object containing mining-related information. Returns a json object containing mining-related information.
Result: Result:
{ {
"blocks": nnn, (numeric) The current block &#34;blocks&#34;: nnn, (numeric) The current block
"currentblockweight": nnn, (numeric) The last block weight &#34;currentblockweight&#34;: nnn, (numeric) The last block weight
"currentblocktx": nnn, (numeric) The last block transaction &#34;currentblocktx&#34;: nnn, (numeric) The last block transaction
"difficulty": xxx.xxxxx (numeric) The current difficulty &#34;difficulty&#34;: xxx.xxxxx (numeric) The current difficulty
"networkhashps": nnn, (numeric) The network hashes per second &#34;networkhashps&#34;: nnn, (numeric) The network hashes per second
"pooledtx": n (numeric) The size of the mempool &#34;pooledtx&#34;: n (numeric) The size of the mempool
"chain": "xxxx", (string) current network name as defined in BIP70 (main, test, regtest) &#34;chain&#34;: &#34;xxxx&#34;, (string) current network name as defined in BIP70 (main, test, regtest)
"warnings": "..." (string) any network and blockchain warnings &#34;warnings&#34;: &#34;...&#34; (string) any network and blockchain warnings
"errors": "..." (string) DEPRECATED. Same as warnings. Only shown when bitcoind is started with -deprecatedrpc=getmininginfo &#34;errors&#34;: &#34;...&#34; (string) DEPRECATED. Same as warnings. Only shown when bitcoind is started with -deprecatedrpc=getmininginfo
} }
Examples: Examples:
> bitcoin-cli getmininginfo &gt; bitcoin-cli getmininginfo
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getmininginfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getmininginfo&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

24
getnettotals.html
View File

@ -42,23 +42,23 @@ and current time.
Result: Result:
{ {
"totalbytesrecv": n, (numeric) Total bytes received &#34;totalbytesrecv&#34;: n, (numeric) Total bytes received
"totalbytessent": n, (numeric) Total bytes sent &#34;totalbytessent&#34;: n, (numeric) Total bytes sent
"timemillis": t, (numeric) Current UNIX time in milliseconds &#34;timemillis&#34;: t, (numeric) Current UNIX time in milliseconds
"uploadtarget": &#34;uploadtarget&#34;:
{ {
"timeframe": n, (numeric) Length of the measuring timeframe in seconds &#34;timeframe&#34;: n, (numeric) Length of the measuring timeframe in seconds
"target": n, (numeric) Target in bytes &#34;target&#34;: n, (numeric) Target in bytes
"target_reached": true|false, (boolean) True if target is reached &#34;target_reached&#34;: true|false, (boolean) True if target is reached
"serve_historical_blocks": true|false, (boolean) True if serving historical blocks &#34;serve_historical_blocks&#34;: true|false, (boolean) True if serving historical blocks
"bytes_left_in_cycle": t, (numeric) Bytes left in current time cycle &#34;bytes_left_in_cycle&#34;: t, (numeric) Bytes left in current time cycle
"time_left_in_cycle": t (numeric) Seconds left in current time cycle &#34;time_left_in_cycle&#34;: t (numeric) Seconds left in current time cycle
} }
} }
Examples: Examples:
> bitcoin-cli getnettotals &gt; bitcoin-cli getnettotals
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getnettotals", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getnettotals&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

4
getnetworkhashps.html
View File

@ -49,8 +49,8 @@ Result:
x (numeric) Hashes per second estimated x (numeric) Hashes per second estimated
Examples: Examples:
> bitcoin-cli getnetworkhashps &gt; bitcoin-cli getnetworkhashps
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getnetworkhashps", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getnetworkhashps&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

46
getnetworkinfo.html
View File

@ -40,40 +40,40 @@ Returns an object containing various state info regarding P2P networking.
Result: Result:
{ {
"version": xxxxx, (numeric) the server version &#34;version&#34;: xxxxx, (numeric) the server version
"subversion": "/Satoshi:x.x.x/", (string) the server subversion string &#34;subversion&#34;: &#34;/Satoshi:x.x.x/&#34;, (string) the server subversion string
"protocolversion": xxxxx, (numeric) the protocol version &#34;protocolversion&#34;: xxxxx, (numeric) the protocol version
"localservices": "xxxxxxxxxxxxxxxx", (string) the services we offer to the network &#34;localservices&#34;: &#34;xxxxxxxxxxxxxxxx&#34;, (string) the services we offer to the network
"localrelay": true|false, (bool) true if transaction relay is requested from peers &#34;localrelay&#34;: true|false, (bool) true if transaction relay is requested from peers
"timeoffset": xxxxx, (numeric) the time offset &#34;timeoffset&#34;: xxxxx, (numeric) the time offset
"connections": xxxxx, (numeric) the number of connections &#34;connections&#34;: xxxxx, (numeric) the number of connections
"networkactive": true|false, (bool) whether p2p networking is enabled &#34;networkactive&#34;: true|false, (bool) whether p2p networking is enabled
"networks": [ (array) information per network &#34;networks&#34;: [ (array) information per network
{ {
"name": "xxx", (string) network (ipv4, ipv6 or onion) &#34;name&#34;: &#34;xxx&#34;, (string) network (ipv4, ipv6 or onion)
"limited": true|false, (boolean) is the network limited using -onlynet? &#34;limited&#34;: true|false, (boolean) is the network limited using -onlynet?
"reachable": true|false, (boolean) is the network reachable? &#34;reachable&#34;: true|false, (boolean) is the network reachable?
"proxy": "host:port" (string) the proxy that is used for this network, or empty if none &#34;proxy&#34;: &#34;host:port&#34; (string) the proxy that is used for this network, or empty if none
"proxy_randomize_credentials": true|false, (string) Whether randomized credentials are used &#34;proxy_randomize_credentials&#34;: true|false, (string) Whether randomized credentials are used
} }
,... ,...
], ],
"relayfee": x.xxxxxxxx, (numeric) minimum relay fee for transactions in BTC/kB &#34;relayfee&#34;: x.xxxxxxxx, (numeric) minimum relay fee for transactions in BTC/kB
"incrementalfee": x.xxxxxxxx, (numeric) minimum fee increment for mempool limiting or BIP 125 replacement in BTC/kB &#34;incrementalfee&#34;: x.xxxxxxxx, (numeric) minimum fee increment for mempool limiting or BIP 125 replacement in BTC/kB
"localaddresses": [ (array) list of local addresses &#34;localaddresses&#34;: [ (array) list of local addresses
{ {
"address": "xxxx", (string) network address &#34;address&#34;: &#34;xxxx&#34;, (string) network address
"port": xxx, (numeric) network port &#34;port&#34;: xxx, (numeric) network port
"score": xxx (numeric) relative score &#34;score&#34;: xxx (numeric) relative score
} }
,... ,...
] ]
"warnings": "..." (string) any network and blockchain warnings &#34;warnings&#34;: &#34;...&#34; (string) any network and blockchain warnings
} }
Examples: Examples:
> bitcoin-cli getnetworkinfo &gt; bitcoin-cli getnetworkinfo
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getnetworkinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getnetworkinfo&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

16
getnewaddress.html
View File

@ -35,22 +35,22 @@
<div class="col-8"> <div class="col-8">
<h1>getnewaddress - Bitcoin RPC</h1> <h1>getnewaddress - Bitcoin RPC</h1>
<pre> <pre>
getnewaddress ( "account" "address_type" ) getnewaddress ( &#34;account&#34; &#34;address_type&#34; )
Returns a new Bitcoin address for receiving payments. Returns a new Bitcoin address for receiving payments.
If 'account' is specified (DEPRECATED), it is added to the address book If &#39;account&#39; is specified (DEPRECATED), it is added to the address book
so payments received with the address will be credited to 'account'. so payments received with the address will be credited to &#39;account&#39;.
Arguments: Arguments:
1. "account" (string, optional) DEPRECATED. The account name for the address to be linked to. If not provided, the default account "" is used. It can also be set to the empty string "" to represent the default account. The account does not need to exist, it will be created if there is no account by the given name. 1. &#34;account&#34; (string, optional) DEPRECATED. The account name for the address to be linked to. If not provided, the default account &#34;&#34; is used. It can also be set to the empty string &#34;&#34; to represent the default account. The account does not need to exist, it will be created if there is no account by the given name.
2. "address_type" (string, optional) The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -addresstype. 2. &#34;address_type&#34; (string, optional) The address type to use. Options are &#34;legacy&#34;, &#34;p2sh-segwit&#34;, and &#34;bech32&#34;. Default is set by -addresstype.
Result: Result:
"address" (string) The new bitcoin address &#34;address&#34; (string) The new bitcoin address
Examples: Examples:
> bitcoin-cli getnewaddress &gt; bitcoin-cli getnewaddress
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getnewaddress", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getnewaddress&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

64
getpeerinfo.html
View File

@ -42,40 +42,40 @@ Returns data about each connected network node as a json array of objects.
Result: Result:
[ [
{ {
"id": n, (numeric) Peer index &#34;id&#34;: n, (numeric) Peer index
"addr":"host:port", (string) The IP address and port of the peer &#34;addr&#34;:&#34;host:port&#34;, (string) The IP address and port of the peer
"addrbind":"ip:port", (string) Bind address of the connection to the peer &#34;addrbind&#34;:&#34;ip:port&#34;, (string) Bind address of the connection to the peer
"addrlocal":"ip:port", (string) Local address as reported by the peer &#34;addrlocal&#34;:&#34;ip:port&#34;, (string) Local address as reported by the peer
"services":"xxxxxxxxxxxxxxxx", (string) The services offered &#34;services&#34;:&#34;xxxxxxxxxxxxxxxx&#34;, (string) The services offered
"relaytxes":true|false, (boolean) Whether peer has asked us to relay transactions to it &#34;relaytxes&#34;:true|false, (boolean) Whether peer has asked us to relay transactions to it
"lastsend": ttt, (numeric) The time in seconds since epoch (Jan 1 1970 GMT) of the last send &#34;lastsend&#34;: ttt, (numeric) The time in seconds since epoch (Jan 1 1970 GMT) of the last send
"lastrecv": ttt, (numeric) The time in seconds since epoch (Jan 1 1970 GMT) of the last receive &#34;lastrecv&#34;: ttt, (numeric) The time in seconds since epoch (Jan 1 1970 GMT) of the last receive
"bytessent": n, (numeric) The total bytes sent &#34;bytessent&#34;: n, (numeric) The total bytes sent
"bytesrecv": n, (numeric) The total bytes received &#34;bytesrecv&#34;: n, (numeric) The total bytes received
"conntime": ttt, (numeric) The connection time in seconds since epoch (Jan 1 1970 GMT) &#34;conntime&#34;: ttt, (numeric) The connection time in seconds since epoch (Jan 1 1970 GMT)
"timeoffset": ttt, (numeric) The time offset in seconds &#34;timeoffset&#34;: ttt, (numeric) The time offset in seconds
"pingtime": n, (numeric) ping time (if available) &#34;pingtime&#34;: n, (numeric) ping time (if available)
"minping": n, (numeric) minimum observed ping time (if any at all) &#34;minping&#34;: n, (numeric) minimum observed ping time (if any at all)
"pingwait": n, (numeric) ping wait (if non-zero) &#34;pingwait&#34;: n, (numeric) ping wait (if non-zero)
"version": v, (numeric) The peer version, such as 7001 &#34;version&#34;: v, (numeric) The peer version, such as 7001
"subver": "/Satoshi:0.8.5/", (string) The string version &#34;subver&#34;: &#34;/Satoshi:0.8.5/&#34;, (string) The string version
"inbound": true|false, (boolean) Inbound (true) or Outbound (false) &#34;inbound&#34;: true|false, (boolean) Inbound (true) or Outbound (false)
"addnode": true|false, (boolean) Whether connection was due to addnode/-connect or if it was an automatic/inbound connection &#34;addnode&#34;: true|false, (boolean) Whether connection was due to addnode/-connect or if it was an automatic/inbound connection
"startingheight": n, (numeric) The starting height (block) of the peer &#34;startingheight&#34;: n, (numeric) The starting height (block) of the peer
"banscore": n, (numeric) The ban score &#34;banscore&#34;: n, (numeric) The ban score
"synced_headers": n, (numeric) The last header we have in common with this peer &#34;synced_headers&#34;: n, (numeric) The last header we have in common with this peer
"synced_blocks": n, (numeric) The last block we have in common with this peer &#34;synced_blocks&#34;: n, (numeric) The last block we have in common with this peer
"inflight": [ &#34;inflight&#34;: [
n, (numeric) The heights of blocks we're currently asking from this peer n, (numeric) The heights of blocks we&#39;re currently asking from this peer
... ...
], ],
"whitelisted": true|false, (boolean) Whether the peer is whitelisted &#34;whitelisted&#34;: true|false, (boolean) Whether the peer is whitelisted
"bytessent_per_msg": { &#34;bytessent_per_msg&#34;: {
"addr": n, (numeric) The total bytes sent aggregated by message type &#34;addr&#34;: n, (numeric) The total bytes sent aggregated by message type
... ...
}, },
"bytesrecv_per_msg": { &#34;bytesrecv_per_msg&#34;: {
"addr": n, (numeric) The total bytes received aggregated by message type &#34;addr&#34;: n, (numeric) The total bytes received aggregated by message type
... ...
} }
} }
@ -83,8 +83,8 @@ Result:
] ]
Examples: Examples:
> bitcoin-cli getpeerinfo &gt; bitcoin-cli getpeerinfo
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getpeerinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getpeerinfo&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

10
getrawchangeaddress.html
View File

@ -35,20 +35,20 @@
<div class="col-8"> <div class="col-8">
<h1>getrawchangeaddress - Bitcoin RPC</h1> <h1>getrawchangeaddress - Bitcoin RPC</h1>
<pre> <pre>
getrawchangeaddress ( "address_type" ) getrawchangeaddress ( &#34;address_type&#34; )
Returns a new Bitcoin address, for receiving change. Returns a new Bitcoin address, for receiving change.
This is for use with raw transactions, NOT normal use. This is for use with raw transactions, NOT normal use.
Arguments: Arguments:
1. "address_type" (string, optional) The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -changetype. 1. &#34;address_type&#34; (string, optional) The address type to use. Options are &#34;legacy&#34;, &#34;p2sh-segwit&#34;, and &#34;bech32&#34;. Default is set by -changetype.
Result: Result:
"address" (string) The address &#34;address&#34; (string) The address
Examples: Examples:
> bitcoin-cli getrawchangeaddress &gt; bitcoin-cli getrawchangeaddress
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrawchangeaddress", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getrawchangeaddress&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

36
getrawmempool.html
View File

@ -46,34 +46,34 @@ Arguments:
Result: (for verbose = false): Result: (for verbose = false):
[ (json array of string) [ (json array of string)
"transactionid" (string) The transaction id &#34;transactionid&#34; (string) The transaction id
,... ,...
] ]
Result: (for verbose = true): Result: (for verbose = true):
{ (json object) { (json object)
"transactionid" : { (json object) &#34;transactionid&#34; : { (json object)
"size" : n, (numeric) virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted. &#34;size&#34; : n, (numeric) virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted.
"fee" : n, (numeric) transaction fee in BTC &#34;fee&#34; : n, (numeric) transaction fee in BTC
"modifiedfee" : n, (numeric) transaction fee with fee deltas used for mining priority &#34;modifiedfee&#34; : n, (numeric) transaction fee with fee deltas used for mining priority
"time" : n, (numeric) local time transaction entered pool in seconds since 1 Jan 1970 GMT &#34;time&#34; : n, (numeric) local time transaction entered pool in seconds since 1 Jan 1970 GMT
"height" : n, (numeric) block height when transaction entered pool &#34;height&#34; : n, (numeric) block height when transaction entered pool
"descendantcount" : n, (numeric) number of in-mempool descendant transactions (including this one) &#34;descendantcount&#34; : n, (numeric) number of in-mempool descendant transactions (including this one)
"descendantsize" : n, (numeric) virtual transaction size of in-mempool descendants (including this one) &#34;descendantsize&#34; : n, (numeric) virtual transaction size of in-mempool descendants (including this one)
"descendantfees" : n, (numeric) modified fees (see above) of in-mempool descendants (including this one) &#34;descendantfees&#34; : n, (numeric) modified fees (see above) of in-mempool descendants (including this one)
"ancestorcount" : n, (numeric) number of in-mempool ancestor transactions (including this one) &#34;ancestorcount&#34; : n, (numeric) number of in-mempool ancestor transactions (including this one)
"ancestorsize" : n, (numeric) virtual transaction size of in-mempool ancestors (including this one) &#34;ancestorsize&#34; : n, (numeric) virtual transaction size of in-mempool ancestors (including this one)
"ancestorfees" : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one) &#34;ancestorfees&#34; : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one)
"wtxid" : hash, (string) hash of serialized transaction, including witness data &#34;wtxid&#34; : hash, (string) hash of serialized transaction, including witness data
"depends" : [ (array) unconfirmed transactions used as inputs for this transaction &#34;depends&#34; : [ (array) unconfirmed transactions used as inputs for this transaction
"transactionid", (string) parent transaction id &#34;transactionid&#34;, (string) parent transaction id
... ] ... ]
}, ... }, ...
} }
Examples: Examples:
> bitcoin-cli getrawmempool true &gt; bitcoin-cli getrawmempool true
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrawmempool", "params": [true] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getrawmempool&#34;, &#34;params&#34;: [true] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

82
getrawtransaction.html
View File

@ -35,7 +35,7 @@
<div class="col-8"> <div class="col-8">
<h1>getrawtransaction - Bitcoin RPC</h1> <h1>getrawtransaction - Bitcoin RPC</h1>
<pre> <pre>
getrawtransaction "txid" ( verbose "blockhash" ) getrawtransaction &#34;txid&#34; ( verbose &#34;blockhash&#34; )
NOTE: By default this function only works for mempool transactions. If the -txindex option is NOTE: By default this function only works for mempool transactions. If the -txindex option is
enabled, it also works for blockchain transactions. If the block which contains the transaction enabled, it also works for blockchain transactions. If the block which contains the transaction
@ -46,69 +46,69 @@ DEPRECATED: for now, it also works for transactions with unspent outputs.
Return the raw transaction data. Return the raw transaction data.
If verbose is 'true', returns an Object with information about 'txid'. If verbose is &#39;true&#39;, returns an Object with information about &#39;txid&#39;.
If verbose is 'false' or omitted, returns a string that is serialized, hex-encoded data for 'txid'. If verbose is &#39;false&#39; or omitted, returns a string that is serialized, hex-encoded data for &#39;txid&#39;.
Arguments: Arguments:
1. "txid" (string, required) The transaction id 1. &#34;txid&#34; (string, required) The transaction id
2. verbose (bool, optional, default=false) If false, return a string, otherwise return a json object 2. verbose (bool, optional, default=false) If false, return a string, otherwise return a json object
3. "blockhash" (string, optional) The block in which to look for the transaction 3. &#34;blockhash&#34; (string, optional) The block in which to look for the transaction
Result (if verbose is not set or set to false): Result (if verbose is not set or set to false):
"data" (string) The serialized, hex-encoded data for 'txid' &#34;data&#34; (string) The serialized, hex-encoded data for &#39;txid&#39;
Result (if verbose is set to true): Result (if verbose is set to true):
{ {
"in_active_chain": b, (bool) Whether specified block is in the active chain or not (only present with explicit "blockhash" argument) &#34;in_active_chain&#34;: b, (bool) Whether specified block is in the active chain or not (only present with explicit &#34;blockhash&#34; argument)
"hex" : "data", (string) The serialized, hex-encoded data for 'txid' &#34;hex&#34; : &#34;data&#34;, (string) The serialized, hex-encoded data for &#39;txid&#39;
"txid" : "id", (string) The transaction id (same as provided) &#34;txid&#34; : &#34;id&#34;, (string) The transaction id (same as provided)
"hash" : "id", (string) The transaction hash (differs from txid for witness transactions) &#34;hash&#34; : &#34;id&#34;, (string) The transaction hash (differs from txid for witness transactions)
"size" : n, (numeric) The serialized transaction size &#34;size&#34; : n, (numeric) The serialized transaction size
"vsize" : n, (numeric) The virtual transaction size (differs from size for witness transactions) &#34;vsize&#34; : n, (numeric) The virtual transaction size (differs from size for witness transactions)
"version" : n, (numeric) The version &#34;version&#34; : n, (numeric) The version
"locktime" : ttt, (numeric) The lock time &#34;locktime&#34; : ttt, (numeric) The lock time
"vin" : [ (array of json objects) &#34;vin&#34; : [ (array of json objects)
{ {
"txid": "id", (string) The transaction id &#34;txid&#34;: &#34;id&#34;, (string) The transaction id
"vout": n, (numeric) &#34;vout&#34;: n, (numeric)
"scriptSig": { (json object) The script &#34;scriptSig&#34;: { (json object) The script
"asm": "asm", (string) asm &#34;asm&#34;: &#34;asm&#34;, (string) asm
"hex": "hex" (string) hex &#34;hex&#34;: &#34;hex&#34; (string) hex
}, },
"sequence": n (numeric) The script sequence number &#34;sequence&#34;: n (numeric) The script sequence number
"txinwitness": ["hex", ...] (array of string) hex-encoded witness data (if any) &#34;txinwitness&#34;: [&#34;hex&#34;, ...] (array of string) hex-encoded witness data (if any)
} }
,... ,...
], ],
"vout" : [ (array of json objects) &#34;vout&#34; : [ (array of json objects)
{ {
"value" : x.xxx, (numeric) The value in BTC &#34;value&#34; : x.xxx, (numeric) The value in BTC
"n" : n, (numeric) index &#34;n&#34; : n, (numeric) index
"scriptPubKey" : { (json object) &#34;scriptPubKey&#34; : { (json object)
"asm" : "asm", (string) the asm &#34;asm&#34; : &#34;asm&#34;, (string) the asm
"hex" : "hex", (string) the hex &#34;hex&#34; : &#34;hex&#34;, (string) the hex
"reqSigs" : n, (numeric) The required sigs &#34;reqSigs&#34; : n, (numeric) The required sigs
"type" : "pubkeyhash", (string) The type, eg 'pubkeyhash' &#34;type&#34; : &#34;pubkeyhash&#34;, (string) The type, eg &#39;pubkeyhash&#39;
"addresses" : [ (json array of string) &#34;addresses&#34; : [ (json array of string)
"address" (string) bitcoin address &#34;address&#34; (string) bitcoin address
,... ,...
] ]
} }
} }
,... ,...
], ],
"blockhash" : "hash", (string) the block hash &#34;blockhash&#34; : &#34;hash&#34;, (string) the block hash
"confirmations" : n, (numeric) The confirmations &#34;confirmations&#34; : n, (numeric) The confirmations
"time" : ttt, (numeric) The transaction time in seconds since epoch (Jan 1 1970 GMT) &#34;time&#34; : ttt, (numeric) The transaction time in seconds since epoch (Jan 1 1970 GMT)
"blocktime" : ttt (numeric) The block time in seconds since epoch (Jan 1 1970 GMT) &#34;blocktime&#34; : ttt (numeric) The block time in seconds since epoch (Jan 1 1970 GMT)
} }
Examples: Examples:
> bitcoin-cli getrawtransaction "mytxid" &gt; bitcoin-cli getrawtransaction &#34;mytxid&#34;
> bitcoin-cli getrawtransaction "mytxid" true &gt; bitcoin-cli getrawtransaction &#34;mytxid&#34; true
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrawtransaction", "params": ["mytxid", true] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getrawtransaction&#34;, &#34;params&#34;: [&#34;mytxid&#34;, true] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
> bitcoin-cli getrawtransaction "mytxid" false "myblockhash" &gt; bitcoin-cli getrawtransaction &#34;mytxid&#34; false &#34;myblockhash&#34;
> bitcoin-cli getrawtransaction "mytxid" true "myblockhash" &gt; bitcoin-cli getrawtransaction &#34;mytxid&#34; true &#34;myblockhash&#34;
</pre> </pre>
<hr> <hr>

14
getreceivedbyaccount.html
View File

@ -35,12 +35,12 @@
<div class="col-8"> <div class="col-8">
<h1>getreceivedbyaccount - Bitcoin RPC</h1> <h1>getreceivedbyaccount - Bitcoin RPC</h1>
<pre> <pre>
getreceivedbyaccount "account" ( minconf ) getreceivedbyaccount &#34;account&#34; ( minconf )
DEPRECATED. Returns the total amount received by addresses with <account> in transactions with at least [minconf] confirmations. DEPRECATED. Returns the total amount received by addresses with &lt;account&gt; in transactions with at least [minconf] confirmations.
Arguments: Arguments:
1. "account" (string, required) The selected account, may be the default account using "". 1. &#34;account&#34; (string, required) The selected account, may be the default account using &#34;&#34;.
2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times. 2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times.
Result: Result:
@ -49,16 +49,16 @@ amount (numeric) The total amount in BTC received for this account.
Examples: Examples:
Amount received by the default account with at least 1 confirmation Amount received by the default account with at least 1 confirmation
> bitcoin-cli getreceivedbyaccount "" &gt; bitcoin-cli getreceivedbyaccount &#34;&#34;
Amount received at the tabby account including unconfirmed amounts with zero confirmations Amount received at the tabby account including unconfirmed amounts with zero confirmations
> bitcoin-cli getreceivedbyaccount "tabby" 0 &gt; bitcoin-cli getreceivedbyaccount &#34;tabby&#34; 0
The amount with at least 6 confirmations The amount with at least 6 confirmations
> bitcoin-cli getreceivedbyaccount "tabby" 6 &gt; bitcoin-cli getreceivedbyaccount &#34;tabby&#34; 6
As a json rpc call As a json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getreceivedbyaccount", "params": ["tabby", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getreceivedbyaccount&#34;, &#34;params&#34;: [&#34;tabby&#34;, 6] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

12
getreceivedbyaddress.html
View File

@ -35,12 +35,12 @@
<div class="col-8"> <div class="col-8">
<h1>getreceivedbyaddress - Bitcoin RPC</h1> <h1>getreceivedbyaddress - Bitcoin RPC</h1>
<pre> <pre>
getreceivedbyaddress "address" ( minconf ) getreceivedbyaddress &#34;address&#34; ( minconf )
Returns the total amount received by the given address in transactions with at least minconf confirmations. Returns the total amount received by the given address in transactions with at least minconf confirmations.
Arguments: Arguments:
1. "address" (string, required) The bitcoin address for transactions. 1. &#34;address&#34; (string, required) The bitcoin address for transactions.
2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times. 2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times.
Result: Result:
@ -49,16 +49,16 @@ amount (numeric) The total amount in BTC received at this address.
Examples: Examples:
The amount from transactions with at least 1 confirmation The amount from transactions with at least 1 confirmation
> bitcoin-cli getreceivedbyaddress "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" &gt; bitcoin-cli getreceivedbyaddress &#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX&#34;
The amount including unconfirmed transactions, zero confirmations The amount including unconfirmed transactions, zero confirmations
> bitcoin-cli getreceivedbyaddress "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" 0 &gt; bitcoin-cli getreceivedbyaddress &#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX&#34; 0
The amount with at least 6 confirmations The amount with at least 6 confirmations
> bitcoin-cli getreceivedbyaddress "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" 6 &gt; bitcoin-cli getreceivedbyaddress &#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX&#34; 6
As a json rpc call As a json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getreceivedbyaddress", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getreceivedbyaddress&#34;, &#34;params&#34;: [&#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX&#34;, 6] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

60
gettransaction.html
View File

@ -35,50 +35,50 @@
<div class="col-8"> <div class="col-8">
<h1>gettransaction - Bitcoin RPC</h1> <h1>gettransaction - Bitcoin RPC</h1>
<pre> <pre>
gettransaction "txid" ( include_watchonly ) gettransaction &#34;txid&#34; ( include_watchonly )
Get detailed information about in-wallet transaction <txid> Get detailed information about in-wallet transaction &lt;txid&gt;
Arguments: Arguments:
1. "txid" (string, required) The transaction id 1. &#34;txid&#34; (string, required) The transaction id
2. "include_watchonly" (bool, optional, default=false) Whether to include watch-only addresses in balance calculation and details[] 2. &#34;include_watchonly&#34; (bool, optional, default=false) Whether to include watch-only addresses in balance calculation and details[]
Result: Result:
{ {
"amount" : x.xxx, (numeric) The transaction amount in BTC &#34;amount&#34; : x.xxx, (numeric) The transaction amount in BTC
"fee": x.xxx, (numeric) The amount of the fee in BTC. This is negative and only available for the &#34;fee&#34;: x.xxx, (numeric) The amount of the fee in BTC. This is negative and only available for the
'send' category of transactions. &#39;send&#39; category of transactions.
"confirmations" : n, (numeric) The number of confirmations &#34;confirmations&#34; : n, (numeric) The number of confirmations
"blockhash" : "hash", (string) The block hash &#34;blockhash&#34; : &#34;hash&#34;, (string) The block hash
"blockindex" : xx, (numeric) The index of the transaction in the block that includes it &#34;blockindex&#34; : xx, (numeric) The index of the transaction in the block that includes it
"blocktime" : ttt, (numeric) The time in seconds since epoch (1 Jan 1970 GMT) &#34;blocktime&#34; : ttt, (numeric) The time in seconds since epoch (1 Jan 1970 GMT)
"txid" : "transactionid", (string) The transaction id. &#34;txid&#34; : &#34;transactionid&#34;, (string) The transaction id.
"time" : ttt, (numeric) The transaction time in seconds since epoch (1 Jan 1970 GMT) &#34;time&#34; : ttt, (numeric) The transaction time in seconds since epoch (1 Jan 1970 GMT)
"timereceived" : ttt, (numeric) The time received in seconds since epoch (1 Jan 1970 GMT) &#34;timereceived&#34; : ttt, (numeric) The time received in seconds since epoch (1 Jan 1970 GMT)
"bip125-replaceable": "yes|no|unknown", (string) Whether this transaction could be replaced due to BIP125 (replace-by-fee); &#34;bip125-replaceable&#34;: &#34;yes|no|unknown&#34;, (string) Whether this transaction could be replaced due to BIP125 (replace-by-fee);
may be unknown for unconfirmed transactions not in the mempool may be unknown for unconfirmed transactions not in the mempool
"details" : [ &#34;details&#34; : [
{ {
"account" : "accountname", (string) DEPRECATED. The account name involved in the transaction, can be "" for the default account. &#34;account&#34; : &#34;accountname&#34;, (string) DEPRECATED. The account name involved in the transaction, can be &#34;&#34; for the default account.
"address" : "address", (string) The bitcoin address involved in the transaction &#34;address&#34; : &#34;address&#34;, (string) The bitcoin address involved in the transaction
"category" : "send|receive", (string) The category, either 'send' or 'receive' &#34;category&#34; : &#34;send|receive&#34;, (string) The category, either &#39;send&#39; or &#39;receive&#39;
"amount" : x.xxx, (numeric) The amount in BTC &#34;amount&#34; : x.xxx, (numeric) The amount in BTC
"label" : "label", (string) A comment for the address/transaction, if any &#34;label&#34; : &#34;label&#34;, (string) A comment for the address/transaction, if any
"vout" : n, (numeric) the vout value &#34;vout&#34; : n, (numeric) the vout value
"fee": x.xxx, (numeric) The amount of the fee in BTC. This is negative and only available for the &#34;fee&#34;: x.xxx, (numeric) The amount of the fee in BTC. This is negative and only available for the
'send' category of transactions. &#39;send&#39; category of transactions.
"abandoned": xxx (bool) 'true' if the transaction has been abandoned (inputs are respendable). Only available for the &#34;abandoned&#34;: xxx (bool) &#39;true&#39; if the transaction has been abandoned (inputs are respendable). Only available for the
'send' category of transactions. &#39;send&#39; category of transactions.
} }
,... ,...
], ],
"hex" : "data" (string) Raw data for transaction &#34;hex&#34; : &#34;data&#34; (string) Raw data for transaction
} }
Examples: Examples:
> bitcoin-cli gettransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" &gt; bitcoin-cli gettransaction &#34;1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d&#34;
> bitcoin-cli gettransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" true &gt; bitcoin-cli gettransaction &#34;1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d&#34; true
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettransaction", "params": ["1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;gettransaction&#34;, &#34;params&#34;: [&#34;1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

36
gettxout.html
View File

@ -35,43 +35,43 @@
<div class="col-8"> <div class="col-8">
<h1>gettxout - Bitcoin RPC</h1> <h1>gettxout - Bitcoin RPC</h1>
<pre> <pre>
gettxout "txid" n ( include_mempool ) gettxout &#34;txid&#34; n ( include_mempool )
Returns details about an unspent transaction output. Returns details about an unspent transaction output.
Arguments: Arguments:
1. "txid" (string, required) The transaction id 1. &#34;txid&#34; (string, required) The transaction id
2. "n" (numeric, required) vout number 2. &#34;n&#34; (numeric, required) vout number
3. "include_mempool" (boolean, optional) Whether to include the mempool. Default: true. Note that an unspent output that is spent in the mempool won't appear. 3. &#34;include_mempool&#34; (boolean, optional) Whether to include the mempool. Default: true. Note that an unspent output that is spent in the mempool won&#39;t appear.
Result: Result:
{ {
"bestblock" : "hash", (string) the block hash &#34;bestblock&#34; : &#34;hash&#34;, (string) the block hash
"confirmations" : n, (numeric) The number of confirmations &#34;confirmations&#34; : n, (numeric) The number of confirmations
"value" : x.xxx, (numeric) The transaction value in BTC &#34;value&#34; : x.xxx, (numeric) The transaction value in BTC
"scriptPubKey" : { (json object) &#34;scriptPubKey&#34; : { (json object)
"asm" : "code", (string) &#34;asm&#34; : &#34;code&#34;, (string)
"hex" : "hex", (string) &#34;hex&#34; : &#34;hex&#34;, (string)
"reqSigs" : n, (numeric) Number of required signatures &#34;reqSigs&#34; : n, (numeric) Number of required signatures
"type" : "pubkeyhash", (string) The type, eg pubkeyhash &#34;type&#34; : &#34;pubkeyhash&#34;, (string) The type, eg pubkeyhash
"addresses" : [ (array of string) array of bitcoin addresses &#34;addresses&#34; : [ (array of string) array of bitcoin addresses
"address" (string) bitcoin address &#34;address&#34; (string) bitcoin address
,... ,...
] ]
}, },
"coinbase" : true|false (boolean) Coinbase or not &#34;coinbase&#34; : true|false (boolean) Coinbase or not
} }
Examples: Examples:
Get unspent transactions Get unspent transactions
> bitcoin-cli listunspent &gt; bitcoin-cli listunspent
View the details View the details
> bitcoin-cli gettxout "txid" 1 &gt; bitcoin-cli gettxout &#34;txid&#34; 1
As a json rpc call As a json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettxout", "params": ["txid", 1] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;gettxout&#34;, &#34;params&#34;: [&#34;txid&#34;, 1] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

12
gettxoutproof.html
View File

@ -35,9 +35,9 @@
<div class="col-8"> <div class="col-8">
<h1>gettxoutproof - Bitcoin RPC</h1> <h1>gettxoutproof - Bitcoin RPC</h1>
<pre> <pre>
gettxoutproof ["txid",...] ( blockhash ) gettxoutproof [&#34;txid&#34;,...] ( blockhash )
Returns a hex-encoded proof that "txid" was included in a block. Returns a hex-encoded proof that &#34;txid&#34; was included in a block.
NOTE: By default this function only works sometimes. This is when there is an NOTE: By default this function only works sometimes. This is when there is an
unspent output in the utxo for this transaction. To make it always work, unspent output in the utxo for this transaction. To make it always work,
@ -45,15 +45,15 @@ you need to maintain a transaction index, using the -txindex command line option
specify the block in which the transaction is included manually (by blockhash). specify the block in which the transaction is included manually (by blockhash).
Arguments: Arguments:
1. "txids" (string) A json array of txids to filter 1. &#34;txids&#34; (string) A json array of txids to filter
[ [
"txid" (string) A transaction hash &#34;txid&#34; (string) A transaction hash
,... ,...
] ]
2. "blockhash" (string, optional) If specified, looks for txid in the block with this hash 2. &#34;blockhash&#34; (string, optional) If specified, looks for txid in the block with this hash
Result: Result:
"data" (string) A string that is a serialized, hex-encoded data for the proof. &#34;data&#34; (string) A string that is a serialized, hex-encoded data for the proof.
</pre> </pre>
<hr> <hr>

20
gettxoutsetinfo.html
View File

@ -42,19 +42,19 @@ Note this call may take some time.
Result: Result:
{ {
"height":n, (numeric) The current block height (index) &#34;height&#34;:n, (numeric) The current block height (index)
"bestblock": "hex", (string) the best block hash hex &#34;bestblock&#34;: &#34;hex&#34;, (string) the best block hash hex
"transactions": n, (numeric) The number of transactions &#34;transactions&#34;: n, (numeric) The number of transactions
"txouts": n, (numeric) The number of output transactions &#34;txouts&#34;: n, (numeric) The number of output transactions
"bogosize": n, (numeric) A meaningless metric for UTXO set size &#34;bogosize&#34;: n, (numeric) A meaningless metric for UTXO set size
"hash_serialized_2": "hash", (string) The serialized hash &#34;hash_serialized_2&#34;: &#34;hash&#34;, (string) The serialized hash
"disk_size": n, (numeric) The estimated size of the chainstate on disk &#34;disk_size&#34;: n, (numeric) The estimated size of the chainstate on disk
"total_amount": x.xxx (numeric) The total amount &#34;total_amount&#34;: x.xxx (numeric) The total amount
} }
Examples: Examples:
> bitcoin-cli gettxoutsetinfo &gt; bitcoin-cli gettxoutsetinfo
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettxoutsetinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;gettxoutsetinfo&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

2
getunconfirmedbalance.html
View File

@ -36,7 +36,7 @@
<h1>getunconfirmedbalance - Bitcoin RPC</h1> <h1>getunconfirmedbalance - Bitcoin RPC</h1>
<pre> <pre>
getunconfirmedbalance getunconfirmedbalance
Returns the server's total unconfirmed balance Returns the server&#39;s total unconfirmed balance
</pre> </pre>
<hr> <hr>

28
getwalletinfo.html
View File

@ -40,23 +40,23 @@ Returns an object containing various wallet state info.
Result: Result:
{ {
"walletname": xxxxx, (string) the wallet name &#34;walletname&#34;: xxxxx, (string) the wallet name
"walletversion": xxxxx, (numeric) the wallet version &#34;walletversion&#34;: xxxxx, (numeric) the wallet version
"balance": xxxxxxx, (numeric) the total confirmed balance of the wallet in BTC &#34;balance&#34;: xxxxxxx, (numeric) the total confirmed balance of the wallet in BTC
"unconfirmed_balance": xxx, (numeric) the total unconfirmed balance of the wallet in BTC &#34;unconfirmed_balance&#34;: xxx, (numeric) the total unconfirmed balance of the wallet in BTC
"immature_balance": xxxxxx, (numeric) the total immature balance of the wallet in BTC &#34;immature_balance&#34;: xxxxxx, (numeric) the total immature balance of the wallet in BTC
"txcount": xxxxxxx, (numeric) the total number of transactions in the wallet &#34;txcount&#34;: xxxxxxx, (numeric) the total number of transactions in the wallet
"keypoololdest": xxxxxx, (numeric) the timestamp (seconds since Unix epoch) of the oldest pre-generated key in the key pool &#34;keypoololdest&#34;: xxxxxx, (numeric) the timestamp (seconds since Unix epoch) of the oldest pre-generated key in the key pool
"keypoolsize": xxxx, (numeric) how many new keys are pre-generated (only counts external keys) &#34;keypoolsize&#34;: xxxx, (numeric) how many new keys are pre-generated (only counts external keys)
"keypoolsize_hd_internal": xxxx, (numeric) how many new keys are pre-generated for internal use (used for change outputs, only appears if the wallet is using this feature, otherwise external keys are used) &#34;keypoolsize_hd_internal&#34;: xxxx, (numeric) how many new keys are pre-generated for internal use (used for change outputs, only appears if the wallet is using this feature, otherwise external keys are used)
"unlocked_until": ttt, (numeric) the timestamp in seconds since epoch (midnight Jan 1 1970 GMT) that the wallet is unlocked for transfers, or 0 if the wallet is locked &#34;unlocked_until&#34;: ttt, (numeric) the timestamp in seconds since epoch (midnight Jan 1 1970 GMT) that the wallet is unlocked for transfers, or 0 if the wallet is locked
"paytxfee": x.xxxx, (numeric) the transaction fee configuration, set in BTC/kB &#34;paytxfee&#34;: x.xxxx, (numeric) the transaction fee configuration, set in BTC/kB
"hdmasterkeyid": "<hash160>" (string, optional) the Hash160 of the HD master pubkey (only present when HD is enabled) &#34;hdmasterkeyid&#34;: &#34;&lt;hash160&gt;&#34; (string, optional) the Hash160 of the HD master pubkey (only present when HD is enabled)
} }
Examples: Examples:
> bitcoin-cli getwalletinfo &gt; bitcoin-cli getwalletinfo
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getwalletinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;getwalletinfo&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

6
help.html
View File

@ -35,15 +35,15 @@
<div class="col-8"> <div class="col-8">
<h1>help - Bitcoin RPC</h1> <h1>help - Bitcoin RPC</h1>
<pre> <pre>
help ( "command" ) help ( &#34;command&#34; )
List all commands, or get help for a specified command. List all commands, or get help for a specified command.
Arguments: Arguments:
1. "command" (string, optional) The command to get help on 1. &#34;command&#34; (string, optional) The command to get help on
Result: Result:
"text" (string) The help text &#34;text&#34; (string) The help text
</pre> </pre>
<hr> <hr>

12
importaddress.html
View File

@ -35,13 +35,13 @@
<div class="col-8"> <div class="col-8">
<h1>importaddress - Bitcoin RPC</h1> <h1>importaddress - Bitcoin RPC</h1>
<pre> <pre>
importaddress "address" ( "label" rescan p2sh ) importaddress &#34;address&#34; ( &#34;label&#34; rescan p2sh )
Adds a script (in hex) or address that can be watched as if it were in your wallet but cannot be used to spend. Requires a new wallet backup. Adds a script (in hex) or address that can be watched as if it were in your wallet but cannot be used to spend. Requires a new wallet backup.
Arguments: Arguments:
1. "script" (string, required) The hex-encoded script (or address) 1. &#34;script&#34; (string, required) The hex-encoded script (or address)
2. "label" (string, optional, default="") An optional label 2. &#34;label&#34; (string, optional, default=&#34;&#34;) An optional label
3. rescan (boolean, optional, default=true) Rescan the wallet for transactions 3. rescan (boolean, optional, default=true) Rescan the wallet for transactions
4. p2sh (boolean, optional, default=false) Add the P2SH version of the script as well 4. p2sh (boolean, optional, default=false) Add the P2SH version of the script as well
@ -55,13 +55,13 @@ as change, and not show up in many RPCs.
Examples: Examples:
Import a script with rescan Import a script with rescan
> bitcoin-cli importaddress "myscript" &gt; bitcoin-cli importaddress &#34;myscript&#34;
Import using a label without rescan Import using a label without rescan
> bitcoin-cli importaddress "myscript" "testing" false &gt; bitcoin-cli importaddress &#34;myscript&#34; &#34;testing&#34; false
As a JSON-RPC call As a JSON-RPC call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "importaddress", "params": ["myscript", "testing", false] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;importaddress&#34;, &#34;params&#34;: [&#34;myscript&#34;, &#34;testing&#34;, false] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

30
importmulti.html
View File

@ -35,7 +35,7 @@
<div class="col-8"> <div class="col-8">
<h1>importmulti - Bitcoin RPC</h1> <h1>importmulti - Bitcoin RPC</h1>
<pre> <pre>
importmulti "requests" ( "options" ) importmulti &#34;requests&#34; ( &#34;options&#34; )
Import addresses/scripts (with private or public keys, redeem script (P2SH)), rescanning all addresses in one-shot-only (rescan can be disabled via options). Requires a new wallet backup. Import addresses/scripts (with private or public keys, redeem script (P2SH)), rescanning all addresses in one-shot-only (rescan can be disabled via options). Requires a new wallet backup.
@ -43,36 +43,36 @@ Arguments:
1. requests (array, required) Data to be imported 1. requests (array, required) Data to be imported
[ (array of json objects) [ (array of json objects)
{ {
"scriptPubKey": "<script>" | { "address":"<address>" }, (string / json, required) Type of scriptPubKey (string for script, json for address) &#34;scriptPubKey&#34;: &#34;&lt;script&gt;&#34; | { &#34;address&#34;:&#34;&lt;address&gt;&#34; }, (string / json, required) Type of scriptPubKey (string for script, json for address)
"timestamp": timestamp | "now" , (integer / string, required) Creation time of the key in seconds since epoch (Jan 1 1970 GMT), &#34;timestamp&#34;: timestamp | &#34;now&#34; , (integer / string, required) Creation time of the key in seconds since epoch (Jan 1 1970 GMT),
or the string "now" to substitute the current synced blockchain time. The timestamp of the oldest or the string &#34;now&#34; to substitute the current synced blockchain time. The timestamp of the oldest
key will determine how far back blockchain rescans need to begin for missing wallet transactions. key will determine how far back blockchain rescans need to begin for missing wallet transactions.
"now" can be specified to bypass scanning, for keys which are known to never have been used, and &#34;now&#34; can be specified to bypass scanning, for keys which are known to never have been used, and
0 can be specified to scan the entire blockchain. Blocks up to 2 hours before the earliest key 0 can be specified to scan the entire blockchain. Blocks up to 2 hours before the earliest key
creation time of all keys being imported by the importmulti call will be scanned. creation time of all keys being imported by the importmulti call will be scanned.
"redeemscript": "<script>" , (string, optional) Allowed only if the scriptPubKey is a P2SH address or a P2SH scriptPubKey &#34;redeemscript&#34;: &#34;&lt;script&gt;&#34; , (string, optional) Allowed only if the scriptPubKey is a P2SH address or a P2SH scriptPubKey
"pubkeys": ["<pubKey>", ... ] , (array, optional) Array of strings giving pubkeys that must occur in the output or redeemscript &#34;pubkeys&#34;: [&#34;&lt;pubKey&gt;&#34;, ... ] , (array, optional) Array of strings giving pubkeys that must occur in the output or redeemscript
"keys": ["<key>", ... ] , (array, optional) Array of strings giving private keys whose corresponding public keys must occur in the output or redeemscript &#34;keys&#34;: [&#34;&lt;key&gt;&#34;, ... ] , (array, optional) Array of strings giving private keys whose corresponding public keys must occur in the output or redeemscript
"internal": <true> , (boolean, optional, default: false) Stating whether matching outputs should be treated as not incoming payments &#34;internal&#34;: &lt;true&gt; , (boolean, optional, default: false) Stating whether matching outputs should be treated as not incoming payments
"watchonly": <true> , (boolean, optional, default: false) Stating whether matching outputs should be considered watched even when they're not spendable, only allowed if keys are empty &#34;watchonly&#34;: &lt;true&gt; , (boolean, optional, default: false) Stating whether matching outputs should be considered watched even when they&#39;re not spendable, only allowed if keys are empty
"label": <label> , (string, optional, default: '') Label to assign to the address (aka account name, for now), only allowed with internal=false &#34;label&#34;: &lt;label&gt; , (string, optional, default: &#39;&#39;) Label to assign to the address (aka account name, for now), only allowed with internal=false
} }
,... ,...
] ]
2. options (json, optional) 2. options (json, optional)
{ {
"rescan": <false>, (boolean, optional, default: true) Stating if should rescan the blockchain after all imports &#34;rescan&#34;: &lt;false&gt;, (boolean, optional, default: true) Stating if should rescan the blockchain after all imports
} }
Note: This call can take minutes to complete if rescan is true, during that time, other rpc calls Note: This call can take minutes to complete if rescan is true, during that time, other rpc calls
may report that the imported keys, addresses or scripts exists but related transactions are still missing. may report that the imported keys, addresses or scripts exists but related transactions are still missing.
Examples: Examples:
> bitcoin-cli importmulti '[{ "scriptPubKey": { "address": "<my address>" }, "timestamp":1455191478 }, { "scriptPubKey": { "address": "<my 2nd address>" }, "label": "example 2", "timestamp": 1455191480 }]' &gt; bitcoin-cli importmulti &#39;[{ &#34;scriptPubKey&#34;: { &#34;address&#34;: &#34;&lt;my address&gt;&#34; }, &#34;timestamp&#34;:1455191478 }, { &#34;scriptPubKey&#34;: { &#34;address&#34;: &#34;&lt;my 2nd address&gt;&#34; }, &#34;label&#34;: &#34;example 2&#34;, &#34;timestamp&#34;: 1455191480 }]&#39;
> bitcoin-cli importmulti '[{ "scriptPubKey": { "address": "<my address>" }, "timestamp":1455191478 }]' '{ "rescan": false}' &gt; bitcoin-cli importmulti &#39;[{ &#34;scriptPubKey&#34;: { &#34;address&#34;: &#34;&lt;my address&gt;&#34; }, &#34;timestamp&#34;:1455191478 }]&#39; &#39;{ &#34;rescan&#34;: false}&#39;
Response is an array with the same size as the input that has the execution result : Response is an array with the same size as the input that has the execution result :
[{ "success": true } , { "success": false, "error": { "code": -1, "message": "Internal Server Error"} }, ... ] [{ &#34;success&#34;: true } , { &#34;success&#34;: false, &#34;error&#34;: { &#34;code&#34;: -1, &#34;message&#34;: &#34;Internal Server Error&#34;} }, ... ]
</pre> </pre>
<hr> <hr>

16
importprivkey.html
View File

@ -35,13 +35,13 @@
<div class="col-8"> <div class="col-8">
<h1>importprivkey - Bitcoin RPC</h1> <h1>importprivkey - Bitcoin RPC</h1>
<pre> <pre>
importprivkey "privkey" ( "label" ) ( rescan ) importprivkey &#34;privkey&#34; ( &#34;label&#34; ) ( rescan )
Adds a private key (as returned by dumpprivkey) to your wallet. Requires a new wallet backup. Adds a private key (as returned by dumpprivkey) to your wallet. Requires a new wallet backup.
Arguments: Arguments:
1. "privkey" (string, required) The private key (see dumpprivkey) 1. &#34;privkey&#34; (string, required) The private key (see dumpprivkey)
2. "label" (string, optional, default="") An optional label 2. &#34;label&#34; (string, optional, default=&#34;&#34;) An optional label
3. rescan (boolean, optional, default=true) Rescan the wallet for transactions 3. rescan (boolean, optional, default=true) Rescan the wallet for transactions
Note: This call can take minutes to complete if rescan is true, during that time, other rpc calls Note: This call can take minutes to complete if rescan is true, during that time, other rpc calls
@ -50,19 +50,19 @@ may report that the imported key exists but related transactions are still missi
Examples: Examples:
Dump a private key Dump a private key
> bitcoin-cli dumpprivkey "myaddress" &gt; bitcoin-cli dumpprivkey &#34;myaddress&#34;
Import the private key with rescan Import the private key with rescan
> bitcoin-cli importprivkey "mykey" &gt; bitcoin-cli importprivkey &#34;mykey&#34;
Import using a label and without rescan Import using a label and without rescan
> bitcoin-cli importprivkey "mykey" "testing" false &gt; bitcoin-cli importprivkey &#34;mykey&#34; &#34;testing&#34; false
Import using default blank label and without rescan Import using default blank label and without rescan
> bitcoin-cli importprivkey "mykey" "" false &gt; bitcoin-cli importprivkey &#34;mykey&#34; &#34;&#34; false
As a JSON-RPC call As a JSON-RPC call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "importprivkey", "params": ["mykey", "testing", false] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;importprivkey&#34;, &#34;params&#34;: [&#34;mykey&#34;, &#34;testing&#34;, false] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

4
importprunedfunds.html
View File

@ -40,8 +40,8 @@ importprunedfunds
Imports funds without rescan. Corresponding address or script must previously be included in wallet. Aimed towards pruned wallets. The end-user is responsible to import additional transactions that subsequently spend the imported outputs or rescan after the point in the blockchain the transaction is included. Imports funds without rescan. Corresponding address or script must previously be included in wallet. Aimed towards pruned wallets. The end-user is responsible to import additional transactions that subsequently spend the imported outputs or rescan after the point in the blockchain the transaction is included.
Arguments: Arguments:
1. "rawtransaction" (string, required) A raw transaction in hex funding an already-existing address in wallet 1. &#34;rawtransaction&#34; (string, required) A raw transaction in hex funding an already-existing address in wallet
2. "txoutproof" (string, required) The hex output from gettxoutproof that contains the transaction 2. &#34;txoutproof&#34; (string, required) The hex output from gettxoutproof that contains the transaction
</pre> </pre>
<hr> <hr>

12
importpubkey.html
View File

@ -35,13 +35,13 @@
<div class="col-8"> <div class="col-8">
<h1>importpubkey - Bitcoin RPC</h1> <h1>importpubkey - Bitcoin RPC</h1>
<pre> <pre>
importpubkey "pubkey" ( "label" rescan ) importpubkey &#34;pubkey&#34; ( &#34;label&#34; rescan )
Adds a public key (in hex) that can be watched as if it were in your wallet but cannot be used to spend. Requires a new wallet backup. Adds a public key (in hex) that can be watched as if it were in your wallet but cannot be used to spend. Requires a new wallet backup.
Arguments: Arguments:
1. "pubkey" (string, required) The hex-encoded public key 1. &#34;pubkey&#34; (string, required) The hex-encoded public key
2. "label" (string, optional, default="") An optional label 2. &#34;label&#34; (string, optional, default=&#34;&#34;) An optional label
3. rescan (boolean, optional, default=true) Rescan the wallet for transactions 3. rescan (boolean, optional, default=true) Rescan the wallet for transactions
Note: This call can take minutes to complete if rescan is true, during that time, other rpc calls Note: This call can take minutes to complete if rescan is true, during that time, other rpc calls
@ -50,13 +50,13 @@ may report that the imported pubkey exists but related transactions are still mi
Examples: Examples:
Import a public key with rescan Import a public key with rescan
> bitcoin-cli importpubkey "mypubkey" &gt; bitcoin-cli importpubkey &#34;mypubkey&#34;
Import using a label without rescan Import using a label without rescan
> bitcoin-cli importpubkey "mypubkey" "testing" false &gt; bitcoin-cli importpubkey &#34;mypubkey&#34; &#34;testing&#34; false
As a JSON-RPC call As a JSON-RPC call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "importpubkey", "params": ["mypubkey", "testing", false] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;importpubkey&#34;, &#34;params&#34;: [&#34;mypubkey&#34;, &#34;testing&#34;, false] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

10
importwallet.html
View File

@ -35,23 +35,23 @@
<div class="col-8"> <div class="col-8">
<h1>importwallet - Bitcoin RPC</h1> <h1>importwallet - Bitcoin RPC</h1>
<pre> <pre>
importwallet "filename" importwallet &#34;filename&#34;
Imports keys from a wallet dump file (see dumpwallet). Requires a new wallet backup to include imported keys. Imports keys from a wallet dump file (see dumpwallet). Requires a new wallet backup to include imported keys.
Arguments: Arguments:
1. "filename" (string, required) The wallet file 1. &#34;filename&#34; (string, required) The wallet file
Examples: Examples:
Dump the wallet Dump the wallet
> bitcoin-cli dumpwallet "test" &gt; bitcoin-cli dumpwallet &#34;test&#34;
Import the wallet Import the wallet
> bitcoin-cli importwallet "test" &gt; bitcoin-cli importwallet &#34;test&#34;
Import using the json rpc call Import using the json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "importwallet", "params": ["test"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;importwallet&#34;, &#34;params&#34;: [&#34;test&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

4
keypoolrefill.html
View File

@ -43,8 +43,8 @@ Arguments
1. newsize (numeric, optional, default=100) The new keypool size 1. newsize (numeric, optional, default=100) The new keypool size
Examples: Examples:
> bitcoin-cli keypoolrefill &gt; bitcoin-cli keypoolrefill
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "keypoolrefill", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;keypoolrefill&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

12
listaccounts.html
View File

@ -41,27 +41,27 @@ DEPRECATED. Returns Object that has account names as keys, account balances as v
Arguments: Arguments:
1. minconf (numeric, optional, default=1) Only include transactions with at least this many confirmations 1. minconf (numeric, optional, default=1) Only include transactions with at least this many confirmations
2. include_watchonly (bool, optional, default=false) Include balances in watch-only addresses (see 'importaddress') 2. include_watchonly (bool, optional, default=false) Include balances in watch-only addresses (see &#39;importaddress&#39;)
Result: Result:
{ (json object where keys are account names, and values are numeric balances { (json object where keys are account names, and values are numeric balances
"account": x.xxx, (numeric) The property name is the account name, and the value is the total balance for the account. &#34;account&#34;: x.xxx, (numeric) The property name is the account name, and the value is the total balance for the account.
... ...
} }
Examples: Examples:
List account balances where there at least 1 confirmation List account balances where there at least 1 confirmation
> bitcoin-cli listaccounts &gt; bitcoin-cli listaccounts
List account balances including zero confirmation transactions List account balances including zero confirmation transactions
> bitcoin-cli listaccounts 0 &gt; bitcoin-cli listaccounts 0
List account balances for 6 or more confirmations List account balances for 6 or more confirmations
> bitcoin-cli listaccounts 6 &gt; bitcoin-cli listaccounts 6
As json rpc call As json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listaccounts", "params": [6] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;listaccounts&#34;, &#34;params&#34;: [6] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

8
listaddressgroupings.html
View File

@ -45,9 +45,9 @@ Result:
[ [
[ [
[ [
"address", (string) The bitcoin address &#34;address&#34;, (string) The bitcoin address
amount, (numeric) The amount in BTC amount, (numeric) The amount in BTC
"account" (string, optional) DEPRECATED. The account &#34;account&#34; (string, optional) DEPRECATED. The account
] ]
,... ,...
] ]
@ -55,8 +55,8 @@ Result:
] ]
Examples: Examples:
> bitcoin-cli listaddressgroupings &gt; bitcoin-cli listaddressgroupings
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listaddressgroupings", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;listaddressgroupings&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

4
listbanned.html
View File

@ -40,8 +40,8 @@ listbanned
List all banned IPs/Subnets. List all banned IPs/Subnets.
Examples: Examples:
> bitcoin-cli listbanned &gt; bitcoin-cli listbanned
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listbanned", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;listbanned&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

14
listlockunspent.html
View File

@ -43,8 +43,8 @@ See the lockunspent call to lock and unlock transactions for spending.
Result: Result:
[ [
{ {
"txid" : "transactionid", (string) The transaction id locked &#34;txid&#34; : &#34;transactionid&#34;, (string) The transaction id locked
"vout" : n (numeric) The vout value &#34;vout&#34; : n (numeric) The vout value
} }
,... ,...
] ]
@ -52,19 +52,19 @@ Result:
Examples: Examples:
List the unspent transactions List the unspent transactions
> bitcoin-cli listunspent &gt; bitcoin-cli listunspent
Lock an unspent transaction Lock an unspent transaction
> bitcoin-cli lockunspent false "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]" &gt; bitcoin-cli lockunspent false &#34;[{\&#34;txid\&#34;:\&#34;a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\&#34;,\&#34;vout\&#34;:1}]&#34;
List the locked transactions List the locked transactions
> bitcoin-cli listlockunspent &gt; bitcoin-cli listlockunspent
Unlock the transaction again Unlock the transaction again
> bitcoin-cli lockunspent true "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]" &gt; bitcoin-cli lockunspent true &#34;[{\&#34;txid\&#34;:\&#34;a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\&#34;,\&#34;vout\&#34;:1}]&#34;
As a json rpc call As a json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listlockunspent", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;listlockunspent&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

20
listreceivedbyaccount.html
View File

@ -41,25 +41,25 @@ DEPRECATED. List balances by account.
Arguments: Arguments:
1. minconf (numeric, optional, default=1) The minimum number of confirmations before payments are included. 1. minconf (numeric, optional, default=1) The minimum number of confirmations before payments are included.
2. include_empty (bool, optional, default=false) Whether to include accounts that haven't received any payments. 2. include_empty (bool, optional, default=false) Whether to include accounts that haven&#39;t received any payments.
3. include_watchonly (bool, optional, default=false) Whether to include watch-only addresses (see 'importaddress'). 3. include_watchonly (bool, optional, default=false) Whether to include watch-only addresses (see &#39;importaddress&#39;).
Result: Result:
[ [
{ {
"involvesWatchonly" : true, (bool) Only returned if imported addresses were involved in transaction &#34;involvesWatchonly&#34; : true, (bool) Only returned if imported addresses were involved in transaction
"account" : "accountname", (string) The account name of the receiving account &#34;account&#34; : &#34;accountname&#34;, (string) The account name of the receiving account
"amount" : x.xxx, (numeric) The total amount received by addresses with this account &#34;amount&#34; : x.xxx, (numeric) The total amount received by addresses with this account
"confirmations" : n, (numeric) The number of confirmations of the most recent transaction included &#34;confirmations&#34; : n, (numeric) The number of confirmations of the most recent transaction included
"label" : "label" (string) A comment for the address/transaction, if any &#34;label&#34; : &#34;label&#34; (string) A comment for the address/transaction, if any
} }
,... ,...
] ]
Examples: Examples:
> bitcoin-cli listreceivedbyaccount &gt; bitcoin-cli listreceivedbyaccount
> bitcoin-cli listreceivedbyaccount 6 true &gt; bitcoin-cli listreceivedbyaccount 6 true
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listreceivedbyaccount", "params": [6, true, true] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;listreceivedbyaccount&#34;, &#34;params&#34;: [6, true, true] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

24
listreceivedbyaddress.html
View File

@ -41,19 +41,19 @@ List balances by receiving address.
Arguments: Arguments:
1. minconf (numeric, optional, default=1) The minimum number of confirmations before payments are included. 1. minconf (numeric, optional, default=1) The minimum number of confirmations before payments are included.
2. include_empty (bool, optional, default=false) Whether to include addresses that haven't received any payments. 2. include_empty (bool, optional, default=false) Whether to include addresses that haven&#39;t received any payments.
3. include_watchonly (bool, optional, default=false) Whether to include watch-only addresses (see 'importaddress'). 3. include_watchonly (bool, optional, default=false) Whether to include watch-only addresses (see &#39;importaddress&#39;).
Result: Result:
[ [
{ {
"involvesWatchonly" : true, (bool) Only returned if imported addresses were involved in transaction &#34;involvesWatchonly&#34; : true, (bool) Only returned if imported addresses were involved in transaction
"address" : "receivingaddress", (string) The receiving address &#34;address&#34; : &#34;receivingaddress&#34;, (string) The receiving address
"account" : "accountname", (string) DEPRECATED. The account of the receiving address. The default account is "". &#34;account&#34; : &#34;accountname&#34;, (string) DEPRECATED. The account of the receiving address. The default account is &#34;&#34;.
"amount" : x.xxx, (numeric) The total amount in BTC received by the address &#34;amount&#34; : x.xxx, (numeric) The total amount in BTC received by the address
"confirmations" : n, (numeric) The number of confirmations of the most recent transaction included &#34;confirmations&#34; : n, (numeric) The number of confirmations of the most recent transaction included
"label" : "label", (string) A comment for the address/transaction, if any &#34;label&#34; : &#34;label&#34;, (string) A comment for the address/transaction, if any
"txids": [ &#34;txids&#34;: [
n, (numeric) The ids of transactions received with the address n, (numeric) The ids of transactions received with the address
... ...
] ]
@ -62,9 +62,9 @@ Result:
] ]
Examples: Examples:
> bitcoin-cli listreceivedbyaddress &gt; bitcoin-cli listreceivedbyaddress
> bitcoin-cli listreceivedbyaddress 6 true &gt; bitcoin-cli listreceivedbyaddress 6 true
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listreceivedbyaddress", "params": [6, true, true] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;listreceivedbyaddress&#34;, &#34;params&#34;: [6, true, true] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

66
listsinceblock.html
View File

@ -35,55 +35,55 @@
<div class="col-8"> <div class="col-8">
<h1>listsinceblock - Bitcoin RPC</h1> <h1>listsinceblock - Bitcoin RPC</h1>
<pre> <pre>
listsinceblock ( "blockhash" target_confirmations include_watchonly include_removed ) listsinceblock ( &#34;blockhash&#34; target_confirmations include_watchonly include_removed )
Get all transactions in blocks since block [blockhash], or all transactions if omitted. Get all transactions in blocks since block [blockhash], or all transactions if omitted.
If "blockhash" is no longer a part of the main chain, transactions from the fork point onward are included. If &#34;blockhash&#34; is no longer a part of the main chain, transactions from the fork point onward are included.
Additionally, if include_removed is set, transactions affecting the wallet which were removed are returned in the "removed" array. Additionally, if include_removed is set, transactions affecting the wallet which were removed are returned in the &#34;removed&#34; array.
Arguments: Arguments:
1. "blockhash" (string, optional) The block hash to list transactions since 1. &#34;blockhash&#34; (string, optional) The block hash to list transactions since
2. target_confirmations: (numeric, optional, default=1) Return the nth block hash from the main chain. e.g. 1 would mean the best block hash. Note: this is not used as a filter, but only affects [lastblock] in the return value 2. target_confirmations: (numeric, optional, default=1) Return the nth block hash from the main chain. e.g. 1 would mean the best block hash. Note: this is not used as a filter, but only affects [lastblock] in the return value
3. include_watchonly: (bool, optional, default=false) Include transactions to watch-only addresses (see 'importaddress') 3. include_watchonly: (bool, optional, default=false) Include transactions to watch-only addresses (see &#39;importaddress&#39;)
4. include_removed: (bool, optional, default=true) Show transactions that were removed due to a reorg in the "removed" array 4. include_removed: (bool, optional, default=true) Show transactions that were removed due to a reorg in the &#34;removed&#34; array
(not guaranteed to work on pruned nodes) (not guaranteed to work on pruned nodes)
Result: Result:
{ {
"transactions": [ &#34;transactions&#34;: [
"account":"accountname", (string) DEPRECATED. The account name associated with the transaction. Will be "" for the default account. &#34;account&#34;:&#34;accountname&#34;, (string) DEPRECATED. The account name associated with the transaction. Will be &#34;&#34; for the default account.
"address":"address", (string) The bitcoin address of the transaction. Not present for move transactions (category = move). &#34;address&#34;:&#34;address&#34;, (string) The bitcoin address of the transaction. Not present for move transactions (category = move).
"category":"send|receive", (string) The transaction category. 'send' has negative amounts, 'receive' has positive amounts. &#34;category&#34;:&#34;send|receive&#34;, (string) The transaction category. &#39;send&#39; has negative amounts, &#39;receive&#39; has positive amounts.
"amount": x.xxx, (numeric) The amount in BTC. This is negative for the 'send' category, and for the 'move' category for moves &#34;amount&#34;: x.xxx, (numeric) The amount in BTC. This is negative for the &#39;send&#39; category, and for the &#39;move&#39; category for moves
outbound. It is positive for the 'receive' category, and for the 'move' category for inbound funds. outbound. It is positive for the &#39;receive&#39; category, and for the &#39;move&#39; category for inbound funds.
"vout" : n, (numeric) the vout value &#34;vout&#34; : n, (numeric) the vout value
"fee": x.xxx, (numeric) The amount of the fee in BTC. This is negative and only available for the 'send' category of transactions. &#34;fee&#34;: x.xxx, (numeric) The amount of the fee in BTC. This is negative and only available for the &#39;send&#39; category of transactions.
"confirmations": n, (numeric) The number of confirmations for the transaction. Available for 'send' and 'receive' category of transactions. &#34;confirmations&#34;: n, (numeric) The number of confirmations for the transaction. Available for &#39;send&#39; and &#39;receive&#39; category of transactions.
When it's < 0, it means the transaction conflicted that many blocks ago. When it&#39;s &lt; 0, it means the transaction conflicted that many blocks ago.
"blockhash": "hashvalue", (string) The block hash containing the transaction. Available for 'send' and 'receive' category of transactions. &#34;blockhash&#34;: &#34;hashvalue&#34;, (string) The block hash containing the transaction. Available for &#39;send&#39; and &#39;receive&#39; category of transactions.
"blockindex": n, (numeric) The index of the transaction in the block that includes it. Available for 'send' and 'receive' category of transactions. &#34;blockindex&#34;: n, (numeric) The index of the transaction in the block that includes it. Available for &#39;send&#39; and &#39;receive&#39; category of transactions.
"blocktime": xxx, (numeric) The block time in seconds since epoch (1 Jan 1970 GMT). &#34;blocktime&#34;: xxx, (numeric) The block time in seconds since epoch (1 Jan 1970 GMT).
"txid": "transactionid", (string) The transaction id. Available for 'send' and 'receive' category of transactions. &#34;txid&#34;: &#34;transactionid&#34;, (string) The transaction id. Available for &#39;send&#39; and &#39;receive&#39; category of transactions.
"time": xxx, (numeric) The transaction time in seconds since epoch (Jan 1 1970 GMT). &#34;time&#34;: xxx, (numeric) The transaction time in seconds since epoch (Jan 1 1970 GMT).
"timereceived": xxx, (numeric) The time received in seconds since epoch (Jan 1 1970 GMT). Available for 'send' and 'receive' category of transactions. &#34;timereceived&#34;: xxx, (numeric) The time received in seconds since epoch (Jan 1 1970 GMT). Available for &#39;send&#39; and &#39;receive&#39; category of transactions.
"bip125-replaceable": "yes|no|unknown", (string) Whether this transaction could be replaced due to BIP125 (replace-by-fee); &#34;bip125-replaceable&#34;: &#34;yes|no|unknown&#34;, (string) Whether this transaction could be replaced due to BIP125 (replace-by-fee);
may be unknown for unconfirmed transactions not in the mempool may be unknown for unconfirmed transactions not in the mempool
"abandoned": xxx, (bool) 'true' if the transaction has been abandoned (inputs are respendable). Only available for the 'send' category of transactions. &#34;abandoned&#34;: xxx, (bool) &#39;true&#39; if the transaction has been abandoned (inputs are respendable). Only available for the &#39;send&#39; category of transactions.
"comment": "...", (string) If a comment is associated with the transaction. &#34;comment&#34;: &#34;...&#34;, (string) If a comment is associated with the transaction.
"label" : "label" (string) A comment for the address/transaction, if any &#34;label&#34; : &#34;label&#34; (string) A comment for the address/transaction, if any
"to": "...", (string) If a comment to is associated with the transaction. &#34;to&#34;: &#34;...&#34;, (string) If a comment to is associated with the transaction.
], ],
"removed": [ &#34;removed&#34;: [
<structure is the same as "transactions" above, only present if include_removed=true> &lt;structure is the same as &#34;transactions&#34; above, only present if include_removed=true&gt;
Note: transactions that were readded in the active chain will appear as-is in this array, and may thus have a positive confirmation count. Note: transactions that were readded in the active chain will appear as-is in this array, and may thus have a positive confirmation count.
], ],
"lastblock": "lastblockhash" (string) The hash of the block (target_confirmations-1) from the best block on the main chain. This is typically used to feed back into listsinceblock the next time you call it. So you would generally use a target_confirmations of say 6, so you will be continually re-notified of transactions until they've reached 6 confirmations plus any new ones &#34;lastblock&#34;: &#34;lastblockhash&#34; (string) The hash of the block (target_confirmations-1) from the best block on the main chain. This is typically used to feed back into listsinceblock the next time you call it. So you would generally use a target_confirmations of say 6, so you will be continually re-notified of transactions until they&#39;ve reached 6 confirmations plus any new ones
} }
Examples: Examples:
> bitcoin-cli listsinceblock &gt; bitcoin-cli listsinceblock
> bitcoin-cli listsinceblock "000000000000000bacf66f7497b7dc45ef753ee9a7d38571037cdb1a57f663ad" 6 &gt; bitcoin-cli listsinceblock &#34;000000000000000bacf66f7497b7dc45ef753ee9a7d38571037cdb1a57f663ad&#34; 6
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listsinceblock", "params": ["000000000000000bacf66f7497b7dc45ef753ee9a7d38571037cdb1a57f663ad", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;listsinceblock&#34;, &#34;params&#34;: [&#34;000000000000000bacf66f7497b7dc45ef753ee9a7d38571037cdb1a57f663ad&#34;, 6] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

68
listtransactions.html
View File

@ -35,68 +35,68 @@
<div class="col-8"> <div class="col-8">
<h1>listtransactions - Bitcoin RPC</h1> <h1>listtransactions - Bitcoin RPC</h1>
<pre> <pre>
listtransactions ( "account" count skip include_watchonly) listtransactions ( &#34;account&#34; count skip include_watchonly)
Returns up to 'count' most recent transactions skipping the first 'from' transactions for account 'account'. Returns up to &#39;count&#39; most recent transactions skipping the first &#39;from&#39; transactions for account &#39;account&#39;.
Arguments: Arguments:
1. "account" (string, optional) DEPRECATED. The account name. Should be "*". 1. &#34;account&#34; (string, optional) DEPRECATED. The account name. Should be &#34;*&#34;.
2. count (numeric, optional, default=10) The number of transactions to return 2. count (numeric, optional, default=10) The number of transactions to return
3. skip (numeric, optional, default=0) The number of transactions to skip 3. skip (numeric, optional, default=0) The number of transactions to skip
4. include_watchonly (bool, optional, default=false) Include transactions to watch-only addresses (see 'importaddress') 4. include_watchonly (bool, optional, default=false) Include transactions to watch-only addresses (see &#39;importaddress&#39;)
Result: Result:
[ [
{ {
"account":"accountname", (string) DEPRECATED. The account name associated with the transaction. &#34;account&#34;:&#34;accountname&#34;, (string) DEPRECATED. The account name associated with the transaction.
It will be "" for the default account. It will be &#34;&#34; for the default account.
"address":"address", (string) The bitcoin address of the transaction. Not present for &#34;address&#34;:&#34;address&#34;, (string) The bitcoin address of the transaction. Not present for
move transactions (category = move). move transactions (category = move).
"category":"send|receive|move", (string) The transaction category. 'move' is a local (off blockchain) &#34;category&#34;:&#34;send|receive|move&#34;, (string) The transaction category. &#39;move&#39; is a local (off blockchain)
transaction between accounts, and not associated with an address, transaction between accounts, and not associated with an address,
transaction id or block. 'send' and 'receive' transactions are transaction id or block. &#39;send&#39; and &#39;receive&#39; transactions are
associated with an address, transaction id and block details associated with an address, transaction id and block details
"amount": x.xxx, (numeric) The amount in BTC. This is negative for the 'send' category, and for the &#34;amount&#34;: x.xxx, (numeric) The amount in BTC. This is negative for the &#39;send&#39; category, and for the
'move' category for moves outbound. It is positive for the 'receive' category, &#39;move&#39; category for moves outbound. It is positive for the &#39;receive&#39; category,
and for the 'move' category for inbound funds. and for the &#39;move&#39; category for inbound funds.
"label": "label", (string) A comment for the address/transaction, if any &#34;label&#34;: &#34;label&#34;, (string) A comment for the address/transaction, if any
"vout": n, (numeric) the vout value &#34;vout&#34;: n, (numeric) the vout value
"fee": x.xxx, (numeric) The amount of the fee in BTC. This is negative and only available for the &#34;fee&#34;: x.xxx, (numeric) The amount of the fee in BTC. This is negative and only available for the
'send' category of transactions. &#39;send&#39; category of transactions.
"confirmations": n, (numeric) The number of confirmations for the transaction. Available for 'send' and &#34;confirmations&#34;: n, (numeric) The number of confirmations for the transaction. Available for &#39;send&#39; and
'receive' category of transactions. Negative confirmations indicate the &#39;receive&#39; category of transactions. Negative confirmations indicate the
transaction conflicts with the block chain transaction conflicts with the block chain
"trusted": xxx, (bool) Whether we consider the outputs of this unconfirmed transaction safe to spend. &#34;trusted&#34;: xxx, (bool) Whether we consider the outputs of this unconfirmed transaction safe to spend.
"blockhash": "hashvalue", (string) The block hash containing the transaction. Available for 'send' and 'receive' &#34;blockhash&#34;: &#34;hashvalue&#34;, (string) The block hash containing the transaction. Available for &#39;send&#39; and &#39;receive&#39;
category of transactions. category of transactions.
"blockindex": n, (numeric) The index of the transaction in the block that includes it. Available for 'send' and 'receive' &#34;blockindex&#34;: n, (numeric) The index of the transaction in the block that includes it. Available for &#39;send&#39; and &#39;receive&#39;
category of transactions. category of transactions.
"blocktime": xxx, (numeric) The block time in seconds since epoch (1 Jan 1970 GMT). &#34;blocktime&#34;: xxx, (numeric) The block time in seconds since epoch (1 Jan 1970 GMT).
"txid": "transactionid", (string) The transaction id. Available for 'send' and 'receive' category of transactions. &#34;txid&#34;: &#34;transactionid&#34;, (string) The transaction id. Available for &#39;send&#39; and &#39;receive&#39; category of transactions.
"time": xxx, (numeric) The transaction time in seconds since epoch (midnight Jan 1 1970 GMT). &#34;time&#34;: xxx, (numeric) The transaction time in seconds since epoch (midnight Jan 1 1970 GMT).
"timereceived": xxx, (numeric) The time received in seconds since epoch (midnight Jan 1 1970 GMT). Available &#34;timereceived&#34;: xxx, (numeric) The time received in seconds since epoch (midnight Jan 1 1970 GMT). Available
for 'send' and 'receive' category of transactions. for &#39;send&#39; and &#39;receive&#39; category of transactions.
"comment": "...", (string) If a comment is associated with the transaction. &#34;comment&#34;: &#34;...&#34;, (string) If a comment is associated with the transaction.
"otheraccount": "accountname", (string) DEPRECATED. For the 'move' category of transactions, the account the funds came &#34;otheraccount&#34;: &#34;accountname&#34;, (string) DEPRECATED. For the &#39;move&#39; category of transactions, the account the funds came
from (for receiving funds, positive amounts), or went to (for sending funds, from (for receiving funds, positive amounts), or went to (for sending funds,
negative amounts). negative amounts).
"bip125-replaceable": "yes|no|unknown", (string) Whether this transaction could be replaced due to BIP125 (replace-by-fee); &#34;bip125-replaceable&#34;: &#34;yes|no|unknown&#34;, (string) Whether this transaction could be replaced due to BIP125 (replace-by-fee);
may be unknown for unconfirmed transactions not in the mempool may be unknown for unconfirmed transactions not in the mempool
"abandoned": xxx (bool) 'true' if the transaction has been abandoned (inputs are respendable). Only available for the &#34;abandoned&#34;: xxx (bool) &#39;true&#39; if the transaction has been abandoned (inputs are respendable). Only available for the
'send' category of transactions. &#39;send&#39; category of transactions.
} }
] ]
Examples: Examples:
List the most recent 10 transactions in the systems List the most recent 10 transactions in the systems
> bitcoin-cli listtransactions &gt; bitcoin-cli listtransactions
List transactions 100 to 120 List transactions 100 to 120
> bitcoin-cli listtransactions "*" 20 100 &gt; bitcoin-cli listtransactions &#34;*&#34; 20 100
As a json rpc call As a json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listtransactions", "params": ["*", 20, 100] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;listtransactions&#34;, &#34;params&#34;: [&#34;*&#34;, 20, 100] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

48
listunspent.html
View File

@ -35,7 +35,7 @@
<div class="col-8"> <div class="col-8">
<h1>listunspent - Bitcoin RPC</h1> <h1>listunspent - Bitcoin RPC</h1>
<pre> <pre>
listunspent ( minconf maxconf ["addresses",...] [include_unsafe] [query_options]) listunspent ( minconf maxconf [&#34;addresses&#34;,...] [include_unsafe] [query_options])
Returns array of unspent transaction outputs Returns array of unspent transaction outputs
with between minconf and maxconf (inclusive) confirmations. with between minconf and maxconf (inclusive) confirmations.
@ -44,35 +44,35 @@ Optionally filter to only include txouts paid to specified addresses.
Arguments: Arguments:
1. minconf (numeric, optional, default=1) The minimum confirmations to filter 1. minconf (numeric, optional, default=1) The minimum confirmations to filter
2. maxconf (numeric, optional, default=9999999) The maximum confirmations to filter 2. maxconf (numeric, optional, default=9999999) The maximum confirmations to filter
3. "addresses" (string) A json array of bitcoin addresses to filter 3. &#34;addresses&#34; (string) A json array of bitcoin addresses to filter
[ [
"address" (string) bitcoin address &#34;address&#34; (string) bitcoin address
,... ,...
] ]
4. include_unsafe (bool, optional, default=true) Include outputs that are not safe to spend 4. include_unsafe (bool, optional, default=true) Include outputs that are not safe to spend
See description of "safe" attribute below. See description of &#34;safe&#34; attribute below.
5. query_options (json, optional) JSON with query options 5. query_options (json, optional) JSON with query options
{ {
"minimumAmount" (numeric or string, default=0) Minimum value of each UTXO in BTC &#34;minimumAmount&#34; (numeric or string, default=0) Minimum value of each UTXO in BTC
"maximumAmount" (numeric or string, default=unlimited) Maximum value of each UTXO in BTC &#34;maximumAmount&#34; (numeric or string, default=unlimited) Maximum value of each UTXO in BTC
"maximumCount" (numeric or string, default=unlimited) Maximum number of UTXOs &#34;maximumCount&#34; (numeric or string, default=unlimited) Maximum number of UTXOs
"minimumSumAmount" (numeric or string, default=unlimited) Minimum sum value of all UTXOs in BTC &#34;minimumSumAmount&#34; (numeric or string, default=unlimited) Minimum sum value of all UTXOs in BTC
} }
Result Result
[ (array of json object) [ (array of json object)
{ {
"txid" : "txid", (string) the transaction id &#34;txid&#34; : &#34;txid&#34;, (string) the transaction id
"vout" : n, (numeric) the vout value &#34;vout&#34; : n, (numeric) the vout value
"address" : "address", (string) the bitcoin address &#34;address&#34; : &#34;address&#34;, (string) the bitcoin address
"account" : "account", (string) DEPRECATED. The associated account, or "" for the default account &#34;account&#34; : &#34;account&#34;, (string) DEPRECATED. The associated account, or &#34;&#34; for the default account
"scriptPubKey" : "key", (string) the script key &#34;scriptPubKey&#34; : &#34;key&#34;, (string) the script key
"amount" : x.xxx, (numeric) the transaction output amount in BTC &#34;amount&#34; : x.xxx, (numeric) the transaction output amount in BTC
"confirmations" : n, (numeric) The number of confirmations &#34;confirmations&#34; : n, (numeric) The number of confirmations
"redeemScript" : n (string) The redeemScript if scriptPubKey is P2SH &#34;redeemScript&#34; : n (string) The redeemScript if scriptPubKey is P2SH
"spendable" : xxx, (bool) Whether we have the private keys to spend this output &#34;spendable&#34; : xxx, (bool) Whether we have the private keys to spend this output
"solvable" : xxx, (bool) Whether we know how to spend this output, ignoring the lack of keys &#34;solvable&#34; : xxx, (bool) Whether we know how to spend this output, ignoring the lack of keys
"safe" : xxx (bool) Whether this output is considered safe to spend. Unconfirmed transactions &#34;safe&#34; : xxx (bool) Whether this output is considered safe to spend. Unconfirmed transactions
from outside keys and unconfirmed replacement transactions are considered unsafe from outside keys and unconfirmed replacement transactions are considered unsafe
and are not eligible for spending by fundrawtransaction and sendtoaddress. and are not eligible for spending by fundrawtransaction and sendtoaddress.
} }
@ -80,11 +80,11 @@ Result
] ]
Examples Examples
> bitcoin-cli listunspent &gt; bitcoin-cli listunspent
> bitcoin-cli listunspent 6 9999999 "[\"1PGFqEzfmQch1gKD3ra4k18PNj3tTUUSqg\",\"1LtvqCaApEdUGFkpKMM4MstjcaL4dKg8SP\"]" &gt; bitcoin-cli listunspent 6 9999999 &#34;[\&#34;1PGFqEzfmQch1gKD3ra4k18PNj3tTUUSqg\&#34;,\&#34;1LtvqCaApEdUGFkpKMM4MstjcaL4dKg8SP\&#34;]&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listunspent", "params": [6, 9999999 "[\"1PGFqEzfmQch1gKD3ra4k18PNj3tTUUSqg\",\"1LtvqCaApEdUGFkpKMM4MstjcaL4dKg8SP\"]"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;listunspent&#34;, &#34;params&#34;: [6, 9999999 &#34;[\&#34;1PGFqEzfmQch1gKD3ra4k18PNj3tTUUSqg\&#34;,\&#34;1LtvqCaApEdUGFkpKMM4MstjcaL4dKg8SP\&#34;]&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
> bitcoin-cli listunspent 6 9999999 '[]' true '{ "minimumAmount": 0.005 }' &gt; bitcoin-cli listunspent 6 9999999 &#39;[]&#39; true &#39;{ &#34;minimumAmount&#34;: 0.005 }&#39;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listunspent", "params": [6, 9999999, [] , true, { "minimumAmount": 0.005 } ] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;listunspent&#34;, &#34;params&#34;: [6, 9999999, [] , true, { &#34;minimumAmount&#34;: 0.005 } ] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

8
listwallets.html
View File

@ -37,17 +37,17 @@
<pre> <pre>
listwallets listwallets
Returns a list of currently loaded wallets. Returns a list of currently loaded wallets.
For full information on the wallet, use "getwalletinfo" For full information on the wallet, use &#34;getwalletinfo&#34;
Result: Result:
[ (json array of strings) [ (json array of strings)
"walletname" (string) the wallet name &#34;walletname&#34; (string) the wallet name
... ...
] ]
Examples: Examples:
> bitcoin-cli listwallets &gt; bitcoin-cli listwallets
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listwallets", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;listwallets&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

18
lockunspent.html
View File

@ -35,7 +35,7 @@
<div class="col-8"> <div class="col-8">
<h1>lockunspent - Bitcoin RPC</h1> <h1>lockunspent - Bitcoin RPC</h1>
<pre> <pre>
lockunspent unlock ([{"txid":"txid","vout":n},...]) lockunspent unlock ([{&#34;txid&#34;:&#34;txid&#34;,&#34;vout&#34;:n},...])
Updates list of temporarily unspendable outputs. Updates list of temporarily unspendable outputs.
Temporarily lock (unlock=false) or unlock (unlock=true) specified transaction outputs. Temporarily lock (unlock=false) or unlock (unlock=true) specified transaction outputs.
@ -47,11 +47,11 @@ Also see the listunspent call
Arguments: Arguments:
1. unlock (boolean, required) Whether to unlock (true) or lock (false) the specified transactions 1. unlock (boolean, required) Whether to unlock (true) or lock (false) the specified transactions
2. "transactions" (string, optional) A json array of objects. Each object the txid (string) vout (numeric) 2. &#34;transactions&#34; (string, optional) A json array of objects. Each object the txid (string) vout (numeric)
[ (json array of json objects) [ (json array of json objects)
{ {
"txid":"id", (string) The transaction id &#34;txid&#34;:&#34;id&#34;, (string) The transaction id
"vout": n (numeric) The output number &#34;vout&#34;: n (numeric) The output number
} }
,... ,...
] ]
@ -62,19 +62,19 @@ true|false (boolean) Whether the command was successful or not
Examples: Examples:
List the unspent transactions List the unspent transactions
> bitcoin-cli listunspent &gt; bitcoin-cli listunspent
Lock an unspent transaction Lock an unspent transaction
> bitcoin-cli lockunspent false "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]" &gt; bitcoin-cli lockunspent false &#34;[{\&#34;txid\&#34;:\&#34;a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\&#34;,\&#34;vout\&#34;:1}]&#34;
List the locked transactions List the locked transactions
> bitcoin-cli listlockunspent &gt; bitcoin-cli listlockunspent
Unlock the transaction again Unlock the transaction again
> bitcoin-cli lockunspent true "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]" &gt; bitcoin-cli lockunspent true &#34;[{\&#34;txid\&#34;:\&#34;a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\&#34;,\&#34;vout\&#34;:1}]&#34;
As a json rpc call As a json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "lockunspent", "params": [false, "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;lockunspent&#34;, &#34;params&#34;: [false, &#34;[{\&#34;txid\&#34;:\&#34;a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\&#34;,\&#34;vout\&#34;:1}]&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

22
logging.html
View File

@ -35,38 +35,38 @@
<div class="col-8"> <div class="col-8">
<h1>logging - Bitcoin RPC</h1> <h1>logging - Bitcoin RPC</h1>
<pre> <pre>
logging ( <include> <exclude> ) logging ( &lt;include&gt; &lt;exclude&gt; )
Gets and sets the logging configuration. Gets and sets the logging configuration.
When called without an argument, returns the list of categories with status that are currently being debug logged or not. When called without an argument, returns the list of categories with status that are currently being debug logged or not.
When called with arguments, adds or removes categories from debug logging and return the lists above. When called with arguments, adds or removes categories from debug logging and return the lists above.
The arguments are evaluated in order "include", "exclude". The arguments are evaluated in order &#34;include&#34;, &#34;exclude&#34;.
If an item is both included and excluded, it will thus end up being excluded. If an item is both included and excluded, it will thus end up being excluded.
The valid logging categories are: net, tor, mempool, http, bench, zmq, db, rpc, estimatefee, addrman, selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej, libevent, coindb, qt, leveldb The valid logging categories are: net, tor, mempool, http, bench, zmq, db, rpc, estimatefee, addrman, selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej, libevent, coindb, qt, leveldb
In addition, the following are available as category names with special meanings: In addition, the following are available as category names with special meanings:
- "all", "1" : represent all logging categories. - &#34;all&#34;, &#34;1&#34; : represent all logging categories.
- "none", "0" : even if other logging categories are specified, ignore all of them. - &#34;none&#34;, &#34;0&#34; : even if other logging categories are specified, ignore all of them.
Arguments: Arguments:
1. "include" (array of strings, optional) A json array of categories to add debug logging 1. &#34;include&#34; (array of strings, optional) A json array of categories to add debug logging
[ [
"category" (string) the valid logging category &#34;category&#34; (string) the valid logging category
,... ,...
] ]
2. "exclude" (array of strings, optional) A json array of categories to remove debug logging 2. &#34;exclude&#34; (array of strings, optional) A json array of categories to remove debug logging
[ [
"category" (string) the valid logging category &#34;category&#34; (string) the valid logging category
,... ,...
] ]
Result: Result:
{ (json object where keys are the logging categories, and values indicates its status { (json object where keys are the logging categories, and values indicates its status
"category": 0|1, (numeric) if being debug logged or not. 0:inactive, 1:active &#34;category&#34;: 0|1, (numeric) if being debug logged or not. 0:inactive, 1:active
... ...
} }
Examples: Examples:
> bitcoin-cli logging "[\"all\"]" "[\"http\"]" &gt; bitcoin-cli logging &#34;[\&#34;all\&#34;]&#34; &#34;[\&#34;http\&#34;]&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "logging", "params": [["all"], "[libevent]"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;logging&#34;, &#34;params&#34;: [[&#34;all&#34;], &#34;[libevent]&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

14
move.html
View File

@ -35,16 +35,16 @@
<div class="col-8"> <div class="col-8">
<h1>move - Bitcoin RPC</h1> <h1>move - Bitcoin RPC</h1>
<pre> <pre>
move "fromaccount" "toaccount" amount ( minconf "comment" ) move &#34;fromaccount&#34; &#34;toaccount&#34; amount ( minconf &#34;comment&#34; )
DEPRECATED. Move a specified amount from one account in your wallet to another. DEPRECATED. Move a specified amount from one account in your wallet to another.
Arguments: Arguments:
1. "fromaccount" (string, required) The name of the account to move funds from. May be the default account using "". 1. &#34;fromaccount&#34; (string, required) The name of the account to move funds from. May be the default account using &#34;&#34;.
2. "toaccount" (string, required) The name of the account to move funds to. May be the default account using "". 2. &#34;toaccount&#34; (string, required) The name of the account to move funds to. May be the default account using &#34;&#34;.
3. amount (numeric) Quantity of BTC to move between accounts. 3. amount (numeric) Quantity of BTC to move between accounts.
4. (dummy) (numeric, optional) Ignored. Remains for backward compatibility. 4. (dummy) (numeric, optional) Ignored. Remains for backward compatibility.
5. "comment" (string, optional) An optional comment, stored in the wallet only. 5. &#34;comment&#34; (string, optional) An optional comment, stored in the wallet only.
Result: Result:
true|false (boolean) true if successful. true|false (boolean) true if successful.
@ -52,13 +52,13 @@ true|false (boolean) true if successful.
Examples: Examples:
Move 0.01 BTC from the default account to the account named tabby Move 0.01 BTC from the default account to the account named tabby
> bitcoin-cli move "" "tabby" 0.01 &gt; bitcoin-cli move &#34;&#34; &#34;tabby&#34; 0.01
Move 0.01 BTC timotei to akiko with a comment and funds have 6 confirmations Move 0.01 BTC timotei to akiko with a comment and funds have 6 confirmations
> bitcoin-cli move "timotei" "akiko" 0.01 6 "happy birthday!" &gt; bitcoin-cli move &#34;timotei&#34; &#34;akiko&#34; 0.01 6 &#34;happy birthday!&#34;
As a json rpc call As a json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "move", "params": ["timotei", "akiko", 0.01, 6, "happy birthday!"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;move&#34;, &#34;params&#34;: [&#34;timotei&#34;, &#34;akiko&#34;, 0.01, 6, &#34;happy birthday!&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

4
ping.html
View File

@ -42,8 +42,8 @@ Results provided in getpeerinfo, pingtime and pingwait fields are decimal second
Ping command is handled in queue with all other commands, so it measures processing backlog, not just network ping. Ping command is handled in queue with all other commands, so it measures processing backlog, not just network ping.
Examples: Examples:
> bitcoin-cli ping &gt; bitcoin-cli ping
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "ping", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;ping&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

8
preciousblock.html
View File

@ -35,7 +35,7 @@
<div class="col-8"> <div class="col-8">
<h1>preciousblock - Bitcoin RPC</h1> <h1>preciousblock - Bitcoin RPC</h1>
<pre> <pre>
preciousblock "blockhash" preciousblock &#34;blockhash&#34;
Treats a block as if it were received before others with the same work. Treats a block as if it were received before others with the same work.
@ -44,13 +44,13 @@ A later preciousblock call can override the effect of an earlier one.
The effects of preciousblock are not retained across restarts. The effects of preciousblock are not retained across restarts.
Arguments: Arguments:
1. "blockhash" (string, required) the hash of the block to mark as precious 1. &#34;blockhash&#34; (string, required) the hash of the block to mark as precious
Result: Result:
Examples: Examples:
> bitcoin-cli preciousblock "blockhash" &gt; bitcoin-cli preciousblock &#34;blockhash&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "preciousblock", "params": ["blockhash"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;preciousblock&#34;, &#34;params&#34;: [&#34;blockhash&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

8
prioritisetransaction.html
View File

@ -35,11 +35,11 @@
<div class="col-8"> <div class="col-8">
<h1>prioritisetransaction - Bitcoin RPC</h1> <h1>prioritisetransaction - Bitcoin RPC</h1>
<pre> <pre>
prioritisetransaction <txid> <dummy value> <fee delta> prioritisetransaction &lt;txid&gt; &lt;dummy value&gt; &lt;fee delta&gt;
Accepts the transaction into mined blocks at a higher (or lower) priority Accepts the transaction into mined blocks at a higher (or lower) priority
Arguments: Arguments:
1. "txid" (string, required) The transaction id. 1. &#34;txid&#34; (string, required) The transaction id.
2. dummy (numeric, optional) API-Compatibility for previous API. Must be zero or null. 2. dummy (numeric, optional) API-Compatibility for previous API. Must be zero or null.
DEPRECATED. For forward compatibility use named arguments and omit this parameter. DEPRECATED. For forward compatibility use named arguments and omit this parameter.
3. fee_delta (numeric, required) The fee value (in satoshis) to add (or subtract, if negative). 3. fee_delta (numeric, required) The fee value (in satoshis) to add (or subtract, if negative).
@ -50,8 +50,8 @@ Result:
true (boolean) Returns true true (boolean) Returns true
Examples: Examples:
> bitcoin-cli prioritisetransaction "txid" 0.0 10000 &gt; bitcoin-cli prioritisetransaction &#34;txid&#34; 0.0 10000
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "prioritisetransaction", "params": ["txid", 0.0, 10000] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;prioritisetransaction&#34;, &#34;params&#34;: [&#34;txid&#34;, 0.0, 10000] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

6
pruneblockchain.html
View File

@ -38,15 +38,15 @@
pruneblockchain pruneblockchain
Arguments: Arguments:
1. "height" (numeric, required) The block height to prune up to. May be set to a discrete height, or a unix timestamp 1. &#34;height&#34; (numeric, required) The block height to prune up to. May be set to a discrete height, or a unix timestamp
to prune blocks whose block time is at least 2 hours older than the provided timestamp. to prune blocks whose block time is at least 2 hours older than the provided timestamp.
Result: Result:
n (numeric) Height of the last block pruned. n (numeric) Height of the last block pruned.
Examples: Examples:
> bitcoin-cli pruneblockchain 1000 &gt; bitcoin-cli pruneblockchain 1000
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "pruneblockchain", "params": [1000] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;pruneblockchain&#34;, &#34;params&#34;: [1000] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

8
removeprunedfunds.html
View File

@ -35,18 +35,18 @@
<div class="col-8"> <div class="col-8">
<h1>removeprunedfunds - Bitcoin RPC</h1> <h1>removeprunedfunds - Bitcoin RPC</h1>
<pre> <pre>
removeprunedfunds "txid" removeprunedfunds &#34;txid&#34;
Deletes the specified transaction from the wallet. Meant for use with pruned wallets and as a companion to importprunedfunds. This will affect wallet balances. Deletes the specified transaction from the wallet. Meant for use with pruned wallets and as a companion to importprunedfunds. This will affect wallet balances.
Arguments: Arguments:
1. "txid" (string, required) The hex-encoded id of the transaction you are deleting 1. &#34;txid&#34; (string, required) The hex-encoded id of the transaction you are deleting
Examples: Examples:
> bitcoin-cli removeprunedfunds "a8d0c0184dde994a09ec054286f1ce581bebf46446a512166eae7628734ea0a5" &gt; bitcoin-cli removeprunedfunds &#34;a8d0c0184dde994a09ec054286f1ce581bebf46446a512166eae7628734ea0a5&#34;
As a JSON-RPC call As a JSON-RPC call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "removeprunedfunds", "params": ["a8d0c0184dde994a09ec054286f1ce581bebf46446a512166eae7628734ea0a5"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;removeprunedfunds&#34;, &#34;params&#34;: [&#34;a8d0c0184dde994a09ec054286f1ce581bebf46446a512166eae7628734ea0a5&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

14
rescanblockchain.html
View File

@ -35,23 +35,23 @@
<div class="col-8"> <div class="col-8">
<h1>rescanblockchain - Bitcoin RPC</h1> <h1>rescanblockchain - Bitcoin RPC</h1>
<pre> <pre>
rescanblockchain ("start_height") ("stop_height") rescanblockchain (&#34;start_height&#34;) (&#34;stop_height&#34;)
Rescan the local blockchain for wallet related transactions. Rescan the local blockchain for wallet related transactions.
Arguments: Arguments:
1. "start_height" (numeric, optional) block height where the rescan should start 1. &#34;start_height&#34; (numeric, optional) block height where the rescan should start
2. "stop_height" (numeric, optional) the last block height that should be scanned 2. &#34;stop_height&#34; (numeric, optional) the last block height that should be scanned
Result: Result:
{ {
"start_height" (numeric) The block height where the rescan has started. If omitted, rescan started from the genesis block. &#34;start_height&#34; (numeric) The block height where the rescan has started. If omitted, rescan started from the genesis block.
"stop_height" (numeric) The height of the last rescanned block. If omitted, rescan stopped at the chain tip. &#34;stop_height&#34; (numeric) The height of the last rescanned block. If omitted, rescan stopped at the chain tip.
} }
Examples: Examples:
> bitcoin-cli rescanblockchain 100000 120000 &gt; bitcoin-cli rescanblockchain 100000 120000
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "rescanblockchain", "params": [100000, 120000] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;rescanblockchain&#34;, &#34;params&#34;: [100000, 120000] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

4
savemempool.html
View File

@ -40,8 +40,8 @@ savemempool
Dumps the mempool to disk. Dumps the mempool to disk.
Examples: Examples:
> bitcoin-cli savemempool &gt; bitcoin-cli savemempool
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "savemempool", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;savemempool&#34;, &#34;params&#34;: [] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

22
sendfrom.html
View File

@ -35,37 +35,37 @@
<div class="col-8"> <div class="col-8">
<h1>sendfrom - Bitcoin RPC</h1> <h1>sendfrom - Bitcoin RPC</h1>
<pre> <pre>
sendfrom "fromaccount" "toaddress" amount ( minconf "comment" "comment_to" ) sendfrom &#34;fromaccount&#34; &#34;toaddress&#34; amount ( minconf &#34;comment&#34; &#34;comment_to&#34; )
DEPRECATED (use sendtoaddress). Sent an amount from an account to a bitcoin address. DEPRECATED (use sendtoaddress). Sent an amount from an account to a bitcoin address.
Arguments: Arguments:
1. "fromaccount" (string, required) The name of the account to send funds from. May be the default account using "". 1. &#34;fromaccount&#34; (string, required) The name of the account to send funds from. May be the default account using &#34;&#34;.
Specifying an account does not influence coin selection, but it does associate the newly created Specifying an account does not influence coin selection, but it does associate the newly created
transaction with the account, so the account's balance computation and transaction history can reflect transaction with the account, so the account&#39;s balance computation and transaction history can reflect
the spend. the spend.
2. "toaddress" (string, required) The bitcoin address to send funds to. 2. &#34;toaddress&#34; (string, required) The bitcoin address to send funds to.
3. amount (numeric or string, required) The amount in BTC (transaction fee is added on top). 3. amount (numeric or string, required) The amount in BTC (transaction fee is added on top).
4. minconf (numeric, optional, default=1) Only use funds with at least this many confirmations. 4. minconf (numeric, optional, default=1) Only use funds with at least this many confirmations.
5. "comment" (string, optional) A comment used to store what the transaction is for. 5. &#34;comment&#34; (string, optional) A comment used to store what the transaction is for.
This is not part of the transaction, just kept in your wallet. This is not part of the transaction, just kept in your wallet.
6. "comment_to" (string, optional) An optional comment to store the name of the person or organization 6. &#34;comment_to&#34; (string, optional) An optional comment to store the name of the person or organization
to which you're sending the transaction. This is not part of the transaction, to which you&#39;re sending the transaction. This is not part of the transaction,
it is just kept in your wallet. it is just kept in your wallet.
Result: Result:
"txid" (string) The transaction id. &#34;txid&#34; (string) The transaction id.
Examples: Examples:
Send 0.01 BTC from the default account to the address, must have at least 1 confirmation Send 0.01 BTC from the default account to the address, must have at least 1 confirmation
> bitcoin-cli sendfrom "" "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" 0.01 &gt; bitcoin-cli sendfrom &#34;&#34; &#34;1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd&#34; 0.01
Send 0.01 from the tabby account to the given address, funds must have at least 6 confirmations Send 0.01 from the tabby account to the given address, funds must have at least 6 confirmations
> bitcoin-cli sendfrom "tabby" "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" 0.01 6 "donation" "seans outpost" &gt; bitcoin-cli sendfrom &#34;tabby&#34; &#34;1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd&#34; 0.01 6 &#34;donation&#34; &#34;seans outpost&#34;
As a json rpc call As a json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendfrom", "params": ["tabby", "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd", 0.01, 6, "donation", "seans outpost"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;sendfrom&#34;, &#34;params&#34;: [&#34;tabby&#34;, &#34;1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd&#34;, 0.01, 6, &#34;donation&#34;, &#34;seans outpost&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

30
sendmany.html
View File

@ -35,51 +35,51 @@
<div class="col-8"> <div class="col-8">
<h1>sendmany - Bitcoin RPC</h1> <h1>sendmany - Bitcoin RPC</h1>
<pre> <pre>
sendmany "fromaccount" {"address":amount,...} ( minconf "comment" ["address",...] replaceable conf_target "estimate_mode") sendmany &#34;fromaccount&#34; {&#34;address&#34;:amount,...} ( minconf &#34;comment&#34; [&#34;address&#34;,...] replaceable conf_target &#34;estimate_mode&#34;)
Send multiple times. Amounts are double-precision floating point numbers. Send multiple times. Amounts are double-precision floating point numbers.
Arguments: Arguments:
1. "fromaccount" (string, required) DEPRECATED. The account to send the funds from. Should be "" for the default account 1. &#34;fromaccount&#34; (string, required) DEPRECATED. The account to send the funds from. Should be &#34;&#34; for the default account
2. "amounts" (string, required) A json object with addresses and amounts 2. &#34;amounts&#34; (string, required) A json object with addresses and amounts
{ {
"address":amount (numeric or string) The bitcoin address is the key, the numeric amount (can be string) in BTC is the value &#34;address&#34;:amount (numeric or string) The bitcoin address is the key, the numeric amount (can be string) in BTC is the value
,... ,...
} }
3. minconf (numeric, optional, default=1) Only use the balance confirmed at least this many times. 3. minconf (numeric, optional, default=1) Only use the balance confirmed at least this many times.
4. "comment" (string, optional) A comment 4. &#34;comment&#34; (string, optional) A comment
5. subtractfeefrom (array, optional) A json array with addresses. 5. subtractfeefrom (array, optional) A json array with addresses.
The fee will be equally deducted from the amount of each selected address. The fee will be equally deducted from the amount of each selected address.
Those recipients will receive less bitcoins than you enter in their corresponding amount field. Those recipients will receive less bitcoins than you enter in their corresponding amount field.
If no addresses are specified here, the sender pays the fee. If no addresses are specified here, the sender pays the fee.
[ [
"address" (string) Subtract fee from this address &#34;address&#34; (string) Subtract fee from this address
,... ,...
] ]
6. replaceable (boolean, optional) Allow this transaction to be replaced by a transaction with higher fees via BIP 125 6. replaceable (boolean, optional) Allow this transaction to be replaced by a transaction with higher fees via BIP 125
7. conf_target (numeric, optional) Confirmation target (in blocks) 7. conf_target (numeric, optional) Confirmation target (in blocks)
8. "estimate_mode" (string, optional, default=UNSET) The fee estimate mode, must be one of: 8. &#34;estimate_mode&#34; (string, optional, default=UNSET) The fee estimate mode, must be one of:
"UNSET" &#34;UNSET&#34;
"ECONOMICAL" &#34;ECONOMICAL&#34;
"CONSERVATIVE" &#34;CONSERVATIVE&#34;
Result: Result:
"txid" (string) The transaction id for the send. Only 1 transaction is created regardless of &#34;txid&#34; (string) The transaction id for the send. Only 1 transaction is created regardless of
the number of addresses. the number of addresses.
Examples: Examples:
Send two amounts to two different addresses: Send two amounts to two different addresses:
> bitcoin-cli sendmany "" "{\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\":0.01,\"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\":0.02}" &gt; bitcoin-cli sendmany &#34;&#34; &#34;{\&#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\&#34;:0.01,\&#34;1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\&#34;:0.02}&#34;
Send two amounts to two different addresses setting the confirmation and comment: Send two amounts to two different addresses setting the confirmation and comment:
> bitcoin-cli sendmany "" "{\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\":0.01,\"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\":0.02}" 6 "testing" &gt; bitcoin-cli sendmany &#34;&#34; &#34;{\&#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\&#34;:0.01,\&#34;1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\&#34;:0.02}&#34; 6 &#34;testing&#34;
Send two amounts to two different addresses, subtract fee from amount: Send two amounts to two different addresses, subtract fee from amount:
> bitcoin-cli sendmany "" "{\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\":0.01,\"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\":0.02}" 1 "" "[\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\",\"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\"]" &gt; bitcoin-cli sendmany &#34;&#34; &#34;{\&#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\&#34;:0.01,\&#34;1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\&#34;:0.02}&#34; 1 &#34;&#34; &#34;[\&#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\&#34;,\&#34;1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\&#34;]&#34;
As a json rpc call As a json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendmany", "params": ["", {"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX":0.01,"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz":0.02}, 6, "testing"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;sendmany&#34;, &#34;params&#34;: [&#34;&#34;, {&#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX&#34;:0.01,&#34;1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz&#34;:0.02}, 6, &#34;testing&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

14
sendrawtransaction.html
View File

@ -35,31 +35,31 @@
<div class="col-8"> <div class="col-8">
<h1>sendrawtransaction - Bitcoin RPC</h1> <h1>sendrawtransaction - Bitcoin RPC</h1>
<pre> <pre>
sendrawtransaction "hexstring" ( allowhighfees ) sendrawtransaction &#34;hexstring&#34; ( allowhighfees )
Submits raw transaction (serialized, hex-encoded) to local node and network. Submits raw transaction (serialized, hex-encoded) to local node and network.
Also see createrawtransaction and signrawtransaction calls. Also see createrawtransaction and signrawtransaction calls.
Arguments: Arguments:
1. "hexstring" (string, required) The hex string of the raw transaction) 1. &#34;hexstring&#34; (string, required) The hex string of the raw transaction)
2. allowhighfees (boolean, optional, default=false) Allow high fees 2. allowhighfees (boolean, optional, default=false) Allow high fees
Result: Result:
"hex" (string) The transaction hash in hex &#34;hex&#34; (string) The transaction hash in hex
Examples: Examples:
Create a transaction Create a transaction
> bitcoin-cli createrawtransaction "[{\"txid\" : \"mytxid\",\"vout\":0}]" "{\"myaddress\":0.01}" &gt; bitcoin-cli createrawtransaction &#34;[{\&#34;txid\&#34; : \&#34;mytxid\&#34;,\&#34;vout\&#34;:0}]&#34; &#34;{\&#34;myaddress\&#34;:0.01}&#34;
Sign the transaction, and get back the hex Sign the transaction, and get back the hex
> bitcoin-cli signrawtransaction "myhex" &gt; bitcoin-cli signrawtransaction &#34;myhex&#34;
Send the transaction (signed hex) Send the transaction (signed hex)
> bitcoin-cli sendrawtransaction "signedhex" &gt; bitcoin-cli sendrawtransaction &#34;signedhex&#34;
As a json rpc call As a json rpc call
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendrawtransaction", "params": ["signedhex"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;sendrawtransaction&#34;, &#34;params&#34;: [&#34;signedhex&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

30
sendtoaddress.html
View File

@ -35,35 +35,35 @@
<div class="col-8"> <div class="col-8">
<h1>sendtoaddress - Bitcoin RPC</h1> <h1>sendtoaddress - Bitcoin RPC</h1>
<pre> <pre>
sendtoaddress "address" amount ( "comment" "comment_to" subtractfeefromamount replaceable conf_target "estimate_mode") sendtoaddress &#34;address&#34; amount ( &#34;comment&#34; &#34;comment_to&#34; subtractfeefromamount replaceable conf_target &#34;estimate_mode&#34;)
Send an amount to a given address. Send an amount to a given address.
Arguments: Arguments:
1. "address" (string, required) The bitcoin address to send to. 1. &#34;address&#34; (string, required) The bitcoin address to send to.
2. "amount" (numeric or string, required) The amount in BTC to send. eg 0.1 2. &#34;amount&#34; (numeric or string, required) The amount in BTC to send. eg 0.1
3. "comment" (string, optional) A comment used to store what the transaction is for. 3. &#34;comment&#34; (string, optional) A comment used to store what the transaction is for.
This is not part of the transaction, just kept in your wallet. This is not part of the transaction, just kept in your wallet.
4. "comment_to" (string, optional) A comment to store the name of the person or organization 4. &#34;comment_to&#34; (string, optional) A comment to store the name of the person or organization
to which you're sending the transaction. This is not part of the to which you&#39;re sending the transaction. This is not part of the
transaction, just kept in your wallet. transaction, just kept in your wallet.
5. subtractfeefromamount (boolean, optional, default=false) The fee will be deducted from the amount being sent. 5. subtractfeefromamount (boolean, optional, default=false) The fee will be deducted from the amount being sent.
The recipient will receive less bitcoins than you enter in the amount field. The recipient will receive less bitcoins than you enter in the amount field.
6. replaceable (boolean, optional) Allow this transaction to be replaced by a transaction with higher fees via BIP 125 6. replaceable (boolean, optional) Allow this transaction to be replaced by a transaction with higher fees via BIP 125
7. conf_target (numeric, optional) Confirmation target (in blocks) 7. conf_target (numeric, optional) Confirmation target (in blocks)
8. "estimate_mode" (string, optional, default=UNSET) The fee estimate mode, must be one of: 8. &#34;estimate_mode&#34; (string, optional, default=UNSET) The fee estimate mode, must be one of:
"UNSET" &#34;UNSET&#34;
"ECONOMICAL" &#34;ECONOMICAL&#34;
"CONSERVATIVE" &#34;CONSERVATIVE&#34;
Result: Result:
"txid" (string) The transaction id. &#34;txid&#34; (string) The transaction id.
Examples: Examples:
> bitcoin-cli sendtoaddress "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" 0.1 &gt; bitcoin-cli sendtoaddress &#34;1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd&#34; 0.1
> bitcoin-cli sendtoaddress "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" 0.1 "donation" "seans outpost" &gt; bitcoin-cli sendtoaddress &#34;1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd&#34; 0.1 &#34;donation&#34; &#34;seans outpost&#34;
> bitcoin-cli sendtoaddress "1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" 0.1 "" "" true &gt; bitcoin-cli sendtoaddress &#34;1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd&#34; 0.1 &#34;&#34; &#34;&#34; true
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendtoaddress", "params": ["1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd", 0.1, "donation", "seans outpost"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;sendtoaddress&#34;, &#34;params&#34;: [&#34;1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd&#34;, 0.1, &#34;donation&#34;, &#34;seans outpost&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

10
setaccount.html
View File

@ -35,17 +35,17 @@
<div class="col-8"> <div class="col-8">
<h1>setaccount - Bitcoin RPC</h1> <h1>setaccount - Bitcoin RPC</h1>
<pre> <pre>
setaccount "address" "account" setaccount &#34;address&#34; &#34;account&#34;
DEPRECATED. Sets the account associated with the given address. DEPRECATED. Sets the account associated with the given address.
Arguments: Arguments:
1. "address" (string, required) The bitcoin address to be associated with an account. 1. &#34;address&#34; (string, required) The bitcoin address to be associated with an account.
2. "account" (string, required) The account to assign the address to. 2. &#34;account&#34; (string, required) The account to assign the address to.
Examples: Examples:
> bitcoin-cli setaccount "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "tabby" &gt; bitcoin-cli setaccount &#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX&#34; &#34;tabby&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "setaccount", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX", "tabby"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;setaccount&#34;, &#34;params&#34;: [&#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX&#34;, &#34;tabby&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

16
setban.html
View File

@ -35,20 +35,20 @@
<div class="col-8"> <div class="col-8">
<h1>setban - Bitcoin RPC</h1> <h1>setban - Bitcoin RPC</h1>
<pre> <pre>
setban "subnet" "add|remove" (bantime) (absolute) setban &#34;subnet&#34; &#34;add|remove&#34; (bantime) (absolute)
Attempts to add or remove an IP/Subnet from the banned list. Attempts to add or remove an IP/Subnet from the banned list.
Arguments: Arguments:
1. "subnet" (string, required) The IP/Subnet (see getpeerinfo for nodes IP) with an optional netmask (default is /32 = single IP) 1. &#34;subnet&#34; (string, required) The IP/Subnet (see getpeerinfo for nodes IP) with an optional netmask (default is /32 = single IP)
2. "command" (string, required) 'add' to add an IP/Subnet to the list, 'remove' to remove an IP/Subnet from the list 2. &#34;command&#34; (string, required) &#39;add&#39; to add an IP/Subnet to the list, &#39;remove&#39; to remove an IP/Subnet from the list
3. "bantime" (numeric, optional) time in seconds how long (or until when if [absolute] is set) the IP is banned (0 or empty means using the default time of 24h which can also be overwritten by the -bantime startup argument) 3. &#34;bantime&#34; (numeric, optional) time in seconds how long (or until when if [absolute] is set) the IP is banned (0 or empty means using the default time of 24h which can also be overwritten by the -bantime startup argument)
4. "absolute" (boolean, optional) If set, the bantime must be an absolute timestamp in seconds since epoch (Jan 1 1970 GMT) 4. &#34;absolute&#34; (boolean, optional) If set, the bantime must be an absolute timestamp in seconds since epoch (Jan 1 1970 GMT)
Examples: Examples:
> bitcoin-cli setban "192.168.0.6" "add" 86400 &gt; bitcoin-cli setban &#34;192.168.0.6&#34; &#34;add&#34; 86400
> bitcoin-cli setban "192.168.0.0/24" "add" &gt; bitcoin-cli setban &#34;192.168.0.0/24&#34; &#34;add&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "setban", "params": ["192.168.0.6", "add", 86400] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;setban&#34;, &#34;params&#34;: [&#34;192.168.0.6&#34;, &#34;add&#34;, 86400] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

2
setnetworkactive.html
View File

@ -40,7 +40,7 @@ setnetworkactive true|false
Disable/enable all p2p network activity. Disable/enable all p2p network activity.
Arguments: Arguments:
1. "state" (boolean, required) true to enable networking, false to disable 1. &#34;state&#34; (boolean, required) true to enable networking, false to disable
</pre> </pre>
<hr> <hr>

4
settxfee.html
View File

@ -46,8 +46,8 @@ Result
true|false (boolean) Returns true if successful true|false (boolean) Returns true if successful
Examples: Examples:
> bitcoin-cli settxfee 0.00001 &gt; bitcoin-cli settxfee 0.00001
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "settxfee", "params": [0.00001] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;settxfee&#34;, &#34;params&#34;: [0.00001] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

16
signmessage.html
View File

@ -35,30 +35,30 @@
<div class="col-8"> <div class="col-8">
<h1>signmessage - Bitcoin RPC</h1> <h1>signmessage - Bitcoin RPC</h1>
<pre> <pre>
signmessage "address" "message" signmessage &#34;address&#34; &#34;message&#34;
Sign a message with the private key of an address Sign a message with the private key of an address
Arguments: Arguments:
1. "address" (string, required) The bitcoin address to use for the private key. 1. &#34;address&#34; (string, required) The bitcoin address to use for the private key.
2. "message" (string, required) The message to create a signature of. 2. &#34;message&#34; (string, required) The message to create a signature of.
Result: Result:
"signature" (string) The signature of the message encoded in base 64 &#34;signature&#34; (string) The signature of the message encoded in base 64
Examples: Examples:
Unlock the wallet for 30 seconds Unlock the wallet for 30 seconds
> bitcoin-cli walletpassphrase "mypassphrase" 30 &gt; bitcoin-cli walletpassphrase &#34;mypassphrase&#34; 30
Create the signature Create the signature
> bitcoin-cli signmessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "my message" &gt; bitcoin-cli signmessage &#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX&#34; &#34;my message&#34;
Verify the signature Verify the signature
> bitcoin-cli verifymessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "signature" "my message" &gt; bitcoin-cli verifymessage &#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX&#34; &#34;signature&#34; &#34;my message&#34;
As json rpc As json rpc
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "signmessage", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX", "my message"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;signmessage&#34;, &#34;params&#34;: [&#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX&#34;, &#34;my message&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

14
signmessagewithprivkey.html
View File

@ -35,27 +35,27 @@
<div class="col-8"> <div class="col-8">
<h1>signmessagewithprivkey - Bitcoin RPC</h1> <h1>signmessagewithprivkey - Bitcoin RPC</h1>
<pre> <pre>
signmessagewithprivkey "privkey" "message" signmessagewithprivkey &#34;privkey&#34; &#34;message&#34;
Sign a message with the private key of an address Sign a message with the private key of an address
Arguments: Arguments:
1. "privkey" (string, required) The private key to sign the message with. 1. &#34;privkey&#34; (string, required) The private key to sign the message with.
2. "message" (string, required) The message to create a signature of. 2. &#34;message&#34; (string, required) The message to create a signature of.
Result: Result:
"signature" (string) The signature of the message encoded in base 64 &#34;signature&#34; (string) The signature of the message encoded in base 64
Examples: Examples:
Create the signature Create the signature
> bitcoin-cli signmessagewithprivkey "privkey" "my message" &gt; bitcoin-cli signmessagewithprivkey &#34;privkey&#34; &#34;my message&#34;
Verify the signature Verify the signature
> bitcoin-cli verifymessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "signature" "my message" &gt; bitcoin-cli verifymessage &#34;1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX&#34; &#34;signature&#34; &#34;my message&#34;
As json rpc As json rpc
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "signmessagewithprivkey", "params": ["privkey", "my message"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;signmessagewithprivkey&#34;, &#34;params&#34;: [&#34;privkey&#34;, &#34;my message&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

58
signrawtransaction.html
View File

@ -35,7 +35,7 @@
<div class="col-8"> <div class="col-8">
<h1>signrawtransaction - Bitcoin RPC</h1> <h1>signrawtransaction - Bitcoin RPC</h1>
<pre> <pre>
signrawtransaction "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] ["privatekey1",...] sighashtype ) signrawtransaction &#34;hexstring&#34; ( [{&#34;txid&#34;:&#34;id&#34;,&#34;vout&#34;:n,&#34;scriptPubKey&#34;:&#34;hex&#34;,&#34;redeemScript&#34;:&#34;hex&#34;},...] [&#34;privatekey1&#34;,...] sighashtype )
Sign inputs for raw transaction (serialized, hex-encoded). Sign inputs for raw transaction (serialized, hex-encoded).
The second optional argument (may be null) is an array of previous transaction outputs that The second optional argument (may be null) is an array of previous transaction outputs that
@ -45,50 +45,50 @@ keys that, if given, will be the only keys used to sign the transaction.
Arguments: Arguments:
1. "hexstring" (string, required) The transaction hex string 1. &#34;hexstring&#34; (string, required) The transaction hex string
2. "prevtxs" (string, optional) An json array of previous dependent transaction outputs 2. &#34;prevtxs&#34; (string, optional) An json array of previous dependent transaction outputs
[ (json array of json objects, or 'null' if none provided) [ (json array of json objects, or &#39;null&#39; if none provided)
{ {
"txid":"id", (string, required) The transaction id &#34;txid&#34;:&#34;id&#34;, (string, required) The transaction id
"vout":n, (numeric, required) The output number &#34;vout&#34;:n, (numeric, required) The output number
"scriptPubKey": "hex", (string, required) script key &#34;scriptPubKey&#34;: &#34;hex&#34;, (string, required) script key
"redeemScript": "hex", (string, required for P2SH or P2WSH) redeem script &#34;redeemScript&#34;: &#34;hex&#34;, (string, required for P2SH or P2WSH) redeem script
"amount": value (numeric, required) The amount spent &#34;amount&#34;: value (numeric, required) The amount spent
} }
,... ,...
] ]
3. "privkeys" (string, optional) A json array of base58-encoded private keys for signing 3. &#34;privkeys&#34; (string, optional) A json array of base58-encoded private keys for signing
[ (json array of strings, or 'null' if none provided) [ (json array of strings, or &#39;null&#39; if none provided)
"privatekey" (string) private key in base58-encoding &#34;privatekey&#34; (string) private key in base58-encoding
,... ,...
] ]
4. "sighashtype" (string, optional, default=ALL) The signature hash type. Must be one of 4. &#34;sighashtype&#34; (string, optional, default=ALL) The signature hash type. Must be one of
"ALL" &#34;ALL&#34;
"NONE" &#34;NONE&#34;
"SINGLE" &#34;SINGLE&#34;
"ALL|ANYONECANPAY" &#34;ALL|ANYONECANPAY&#34;
"NONE|ANYONECANPAY" &#34;NONE|ANYONECANPAY&#34;
"SINGLE|ANYONECANPAY" &#34;SINGLE|ANYONECANPAY&#34;
Result: Result:
{ {
"hex" : "value", (string) The hex-encoded raw transaction with signature(s) &#34;hex&#34; : &#34;value&#34;, (string) The hex-encoded raw transaction with signature(s)
"complete" : true|false, (boolean) If the transaction has a complete set of signatures &#34;complete&#34; : true|false, (boolean) If the transaction has a complete set of signatures
"errors" : [ (json array of objects) Script verification errors (if there are any) &#34;errors&#34; : [ (json array of objects) Script verification errors (if there are any)
{ {
"txid" : "hash", (string) The hash of the referenced, previous transaction &#34;txid&#34; : &#34;hash&#34;, (string) The hash of the referenced, previous transaction
"vout" : n, (numeric) The index of the output to spent and used as input &#34;vout&#34; : n, (numeric) The index of the output to spent and used as input
"scriptSig" : "hex", (string) The hex-encoded signature script &#34;scriptSig&#34; : &#34;hex&#34;, (string) The hex-encoded signature script
"sequence" : n, (numeric) Script sequence number &#34;sequence&#34; : n, (numeric) Script sequence number
"error" : "text" (string) Verification or signing error related to the input &#34;error&#34; : &#34;text&#34; (string) Verification or signing error related to the input
} }
,... ,...
] ]
} }
Examples: Examples:
> bitcoin-cli signrawtransaction "myhex" &gt; bitcoin-cli signrawtransaction &#34;myhex&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "signrawtransaction", "params": ["myhex"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;signrawtransaction&#34;, &#34;params&#34;: [&#34;myhex&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

10
submitblock.html
View File

@ -35,20 +35,20 @@
<div class="col-8"> <div class="col-8">
<h1>submitblock - Bitcoin RPC</h1> <h1>submitblock - Bitcoin RPC</h1>
<pre> <pre>
submitblock "hexdata" ( "dummy" ) submitblock &#34;hexdata&#34; ( &#34;dummy&#34; )
Attempts to submit new block to network. Attempts to submit new block to network.
See https://en.bitcoin.it/wiki/BIP_0022 for full specification. See https://en.bitcoin.it/wiki/BIP_0022 for full specification.
Arguments Arguments
1. "hexdata" (string, required) the hex-encoded block data to submit 1. &#34;hexdata&#34; (string, required) the hex-encoded block data to submit
2. "dummy" (optional) dummy value, for compatibility with BIP22. This value is ignored. 2. &#34;dummy&#34; (optional) dummy value, for compatibility with BIP22. This value is ignored.
Result: Result:
Examples: Examples:
> bitcoin-cli submitblock "mydata" &gt; bitcoin-cli submitblock &#34;mydata&#34;
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "submitblock", "params": ["mydata"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ &gt; curl --user myusername --data-binary &#39;{&#34;jsonrpc&#34;: &#34;1.0&#34;, &#34;id&#34;:&#34;curltest&#34;, &#34;method&#34;: &#34;submitblock&#34;, &#34;params&#34;: [&#34;mydata&#34;] }&#39; -H &#39;content-type: text/plain;&#39; http://127.0.0.1:8332/
</pre> </pre>
<hr> <hr>

Some files were not shown because too many files have changed in this diff Show More