From b1108d7826d78c2bf9092cdea70d849863e3677a Mon Sep 17 00:00:00 2001 From: Karel Bilek Date: Mon, 24 Sep 2018 11:19:34 +0700 Subject: [PATCH] RPC Docs: add 0.16.3 It is exactly the same as 0.16.2. --- _doc/en/0.16.3/index.html | 8 ++ .../rpc/blockchain/getbestblockhash.html | 19 +++++ _doc/en/0.16.3/rpc/blockchain/getblock.html | 60 ++++++++++++++ .../rpc/blockchain/getblockchaininfo.html | 59 +++++++++++++ .../0.16.3/rpc/blockchain/getblockcount.html | 19 +++++ .../0.16.3/rpc/blockchain/getblockhash.html | 22 +++++ .../0.16.3/rpc/blockchain/getblockheader.html | 43 ++++++++++ .../0.16.3/rpc/blockchain/getchaintips.html | 37 +++++++++ .../rpc/blockchain/getchaintxstats.html | 30 +++++++ .../0.16.3/rpc/blockchain/getdifficulty.html | 19 +++++ .../rpc/blockchain/getmempoolancestors.html | 47 +++++++++++ .../rpc/blockchain/getmempooldescendants.html | 47 +++++++++++ .../rpc/blockchain/getmempoolentry.html | 38 +++++++++ .../0.16.3/rpc/blockchain/getmempoolinfo.html | 26 ++++++ .../0.16.3/rpc/blockchain/getrawmempool.html | 48 +++++++++++ _doc/en/0.16.3/rpc/blockchain/gettxout.html | 46 ++++++++++ .../0.16.3/rpc/blockchain/gettxoutproof.html | 28 +++++++ .../rpc/blockchain/gettxoutsetinfo.html | 29 +++++++ .../0.16.3/rpc/blockchain/preciousblock.html | 25 ++++++ .../rpc/blockchain/pruneblockchain.html | 21 +++++ .../en/0.16.3/rpc/blockchain/savemempool.html | 16 ++++ .../en/0.16.3/rpc/blockchain/verifychain.html | 23 +++++ .../rpc/blockchain/verifytxoutproof.html | 19 +++++ _doc/en/0.16.3/rpc/control/getmemoryinfo.html | 34 ++++++++ _doc/en/0.16.3/rpc/control/help.html | 18 ++++ _doc/en/0.16.3/rpc/control/logging.html | 41 +++++++++ _doc/en/0.16.3/rpc/control/stop.html | 11 +++ _doc/en/0.16.3/rpc/control/uptime.html | 19 +++++ _doc/en/0.16.3/rpc/generating/generate.html | 24 ++++++ .../rpc/generating/generatetoaddress.html | 25 ++++++ _doc/en/0.16.3/rpc/index.html | 8 ++ .../0.16.3/rpc/mining/getblocktemplate.html | 83 +++++++++++++++++++ _doc/en/0.16.3/rpc/mining/getmininginfo.html | 28 +++++++ .../0.16.3/rpc/mining/getnetworkhashps.html | 25 ++++++ .../rpc/mining/prioritisetransaction.html | 26 ++++++ _doc/en/0.16.3/rpc/mining/submitblock.html | 23 +++++ _doc/en/0.16.3/rpc/network/addnode.html | 23 +++++ _doc/en/0.16.3/rpc/network/clearbanned.html | 16 ++++ .../en/0.16.3/rpc/network/disconnectnode.html | 26 ++++++ .../0.16.3/rpc/network/getaddednodeinfo.html | 35 ++++++++ .../rpc/network/getconnectioncount.html | 19 +++++ _doc/en/0.16.3/rpc/network/getnettotals.html | 33 ++++++++ .../en/0.16.3/rpc/network/getnetworkinfo.html | 48 +++++++++++ _doc/en/0.16.3/rpc/network/getpeerinfo.html | 59 +++++++++++++ _doc/en/0.16.3/rpc/network/listbanned.html | 16 ++++ _doc/en/0.16.3/rpc/network/ping.html | 18 ++++ _doc/en/0.16.3/rpc/network/setban.html | 23 +++++ .../0.16.3/rpc/network/setnetworkactive.html | 15 ++++ .../combinerawtransaction.html | 26 ++++++ .../rawtransactions/createrawtransaction.html | 45 ++++++++++ .../rawtransactions/decoderawtransaction.html | 61 ++++++++++++++ .../rpc/rawtransactions/decodescript.html | 32 +++++++ .../rawtransactions/fundrawtransaction.html | 70 ++++++++++++++++ .../rawtransactions/getrawtransaction.html | 83 +++++++++++++++++++ .../rawtransactions/sendrawtransaction.html | 34 ++++++++ .../rawtransactions/signrawtransaction.html | 63 ++++++++++++++ _doc/en/0.16.3/rpc/util/createmultisig.html | 38 +++++++++ _doc/en/0.16.3/rpc/util/estimatefee.html | 29 +++++++ _doc/en/0.16.3/rpc/util/estimatesmartfee.html | 42 ++++++++++ .../rpc/util/signmessagewithprivkey.html | 30 +++++++ _doc/en/0.16.3/rpc/util/validateaddress.html | 52 ++++++++++++ _doc/en/0.16.3/rpc/util/verifymessage.html | 34 ++++++++ .../0.16.3/rpc/wallet/abandontransaction.html | 25 ++++++ _doc/en/0.16.3/rpc/wallet/abortrescan.html | 23 +++++ .../0.16.3/rpc/wallet/addmultisigaddress.html | 44 ++++++++++ _doc/en/0.16.3/rpc/wallet/backupwallet.html | 19 +++++ _doc/en/0.16.3/rpc/wallet/bumpfee.html | 57 +++++++++++++ _doc/en/0.16.3/rpc/wallet/dumpprivkey.html | 24 ++++++ _doc/en/0.16.3/rpc/wallet/dumpwallet.html | 27 ++++++ _doc/en/0.16.3/rpc/wallet/encryptwallet.html | 37 +++++++++ _doc/en/0.16.3/rpc/wallet/getaccount.html | 22 +++++ .../0.16.3/rpc/wallet/getaccountaddress.html | 24 ++++++ .../rpc/wallet/getaddressesbyaccount.html | 25 ++++++ _doc/en/0.16.3/rpc/wallet/getbalance.html | 47 +++++++++++ _doc/en/0.16.3/rpc/wallet/getnewaddress.html | 25 ++++++ .../rpc/wallet/getrawchangeaddress.html | 23 +++++ .../rpc/wallet/getreceivedbyaccount.html | 33 ++++++++ .../rpc/wallet/getreceivedbyaddress.html | 33 ++++++++ _doc/en/0.16.3/rpc/wallet/gettransaction.html | 53 ++++++++++++ .../rpc/wallet/getunconfirmedbalance.html | 11 +++ _doc/en/0.16.3/rpc/wallet/getwalletinfo.html | 31 +++++++ _doc/en/0.16.3/rpc/wallet/importaddress.html | 36 ++++++++ _doc/en/0.16.3/rpc/wallet/importmulti.html | 47 +++++++++++ _doc/en/0.16.3/rpc/wallet/importprivkey.html | 37 +++++++++ .../0.16.3/rpc/wallet/importprunedfunds.html | 16 ++++ _doc/en/0.16.3/rpc/wallet/importpubkey.html | 31 +++++++ _doc/en/0.16.3/rpc/wallet/importwallet.html | 26 ++++++ _doc/en/0.16.3/rpc/wallet/keypoolrefill.html | 19 +++++ _doc/en/0.16.3/rpc/wallet/listaccounts.html | 36 ++++++++ .../rpc/wallet/listaddressgroupings.html | 31 +++++++ .../en/0.16.3/rpc/wallet/listlockunspent.html | 39 +++++++++ .../rpc/wallet/listreceivedbyaccount.html | 34 ++++++++ .../rpc/wallet/listreceivedbyaddress.html | 39 +++++++++ _doc/en/0.16.3/rpc/wallet/listsinceblock.html | 58 +++++++++++++ .../0.16.3/rpc/wallet/listtransactions.html | 71 ++++++++++++++++ _doc/en/0.16.3/rpc/wallet/listunspent.html | 59 +++++++++++++ _doc/en/0.16.3/rpc/wallet/listwallets.html | 22 +++++ _doc/en/0.16.3/rpc/wallet/lockunspent.html | 49 +++++++++++ _doc/en/0.16.3/rpc/wallet/move.html | 33 ++++++++ .../0.16.3/rpc/wallet/removeprunedfunds.html | 21 +++++ .../0.16.3/rpc/wallet/rescanblockchain.html | 26 ++++++ _doc/en/0.16.3/rpc/wallet/sendfrom.html | 40 +++++++++ _doc/en/0.16.3/rpc/wallet/sendmany.html | 54 ++++++++++++ _doc/en/0.16.3/rpc/wallet/sendtoaddress.html | 38 +++++++++ _doc/en/0.16.3/rpc/wallet/setaccount.html | 20 +++++ _doc/en/0.16.3/rpc/wallet/settxfee.html | 22 +++++ _doc/en/0.16.3/rpc/wallet/signmessage.html | 33 ++++++++ _doc/en/0.16.3/rpc/wallet/walletlock.html | 28 +++++++ .../0.16.3/rpc/wallet/walletpassphrase.html | 32 +++++++ .../rpc/wallet/walletpassphrasechange.html | 20 +++++ 110 files changed, 3664 insertions(+) create mode 100644 _doc/en/0.16.3/index.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/getbestblockhash.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/getblock.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/getblockchaininfo.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/getblockcount.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/getblockhash.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/getblockheader.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/getchaintips.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/getchaintxstats.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/getdifficulty.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/getmempoolancestors.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/getmempooldescendants.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/getmempoolentry.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/getmempoolinfo.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/getrawmempool.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/gettxout.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/gettxoutproof.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/gettxoutsetinfo.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/preciousblock.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/pruneblockchain.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/savemempool.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/verifychain.html create mode 100644 _doc/en/0.16.3/rpc/blockchain/verifytxoutproof.html create mode 100644 _doc/en/0.16.3/rpc/control/getmemoryinfo.html create mode 100644 _doc/en/0.16.3/rpc/control/help.html create mode 100644 _doc/en/0.16.3/rpc/control/logging.html create mode 100644 _doc/en/0.16.3/rpc/control/stop.html create mode 100644 _doc/en/0.16.3/rpc/control/uptime.html create mode 100644 _doc/en/0.16.3/rpc/generating/generate.html create mode 100644 _doc/en/0.16.3/rpc/generating/generatetoaddress.html create mode 100644 _doc/en/0.16.3/rpc/index.html create mode 100644 _doc/en/0.16.3/rpc/mining/getblocktemplate.html create mode 100644 _doc/en/0.16.3/rpc/mining/getmininginfo.html create mode 100644 _doc/en/0.16.3/rpc/mining/getnetworkhashps.html create mode 100644 _doc/en/0.16.3/rpc/mining/prioritisetransaction.html create mode 100644 _doc/en/0.16.3/rpc/mining/submitblock.html create mode 100644 _doc/en/0.16.3/rpc/network/addnode.html create mode 100644 _doc/en/0.16.3/rpc/network/clearbanned.html create mode 100644 _doc/en/0.16.3/rpc/network/disconnectnode.html create mode 100644 _doc/en/0.16.3/rpc/network/getaddednodeinfo.html create mode 100644 _doc/en/0.16.3/rpc/network/getconnectioncount.html create mode 100644 _doc/en/0.16.3/rpc/network/getnettotals.html create mode 100644 _doc/en/0.16.3/rpc/network/getnetworkinfo.html create mode 100644 _doc/en/0.16.3/rpc/network/getpeerinfo.html create mode 100644 _doc/en/0.16.3/rpc/network/listbanned.html create mode 100644 _doc/en/0.16.3/rpc/network/ping.html create mode 100644 _doc/en/0.16.3/rpc/network/setban.html create mode 100644 _doc/en/0.16.3/rpc/network/setnetworkactive.html create mode 100644 _doc/en/0.16.3/rpc/rawtransactions/combinerawtransaction.html create mode 100644 _doc/en/0.16.3/rpc/rawtransactions/createrawtransaction.html create mode 100644 _doc/en/0.16.3/rpc/rawtransactions/decoderawtransaction.html create mode 100644 _doc/en/0.16.3/rpc/rawtransactions/decodescript.html create mode 100644 _doc/en/0.16.3/rpc/rawtransactions/fundrawtransaction.html create mode 100644 _doc/en/0.16.3/rpc/rawtransactions/getrawtransaction.html create mode 100644 _doc/en/0.16.3/rpc/rawtransactions/sendrawtransaction.html create mode 100644 _doc/en/0.16.3/rpc/rawtransactions/signrawtransaction.html create mode 100644 _doc/en/0.16.3/rpc/util/createmultisig.html create mode 100644 _doc/en/0.16.3/rpc/util/estimatefee.html create mode 100644 _doc/en/0.16.3/rpc/util/estimatesmartfee.html create mode 100644 _doc/en/0.16.3/rpc/util/signmessagewithprivkey.html create mode 100644 _doc/en/0.16.3/rpc/util/validateaddress.html create mode 100644 _doc/en/0.16.3/rpc/util/verifymessage.html create mode 100644 _doc/en/0.16.3/rpc/wallet/abandontransaction.html create mode 100644 _doc/en/0.16.3/rpc/wallet/abortrescan.html create mode 100644 _doc/en/0.16.3/rpc/wallet/addmultisigaddress.html create mode 100644 _doc/en/0.16.3/rpc/wallet/backupwallet.html create mode 100644 _doc/en/0.16.3/rpc/wallet/bumpfee.html create mode 100644 _doc/en/0.16.3/rpc/wallet/dumpprivkey.html create mode 100644 _doc/en/0.16.3/rpc/wallet/dumpwallet.html create mode 100644 _doc/en/0.16.3/rpc/wallet/encryptwallet.html create mode 100644 _doc/en/0.16.3/rpc/wallet/getaccount.html create mode 100644 _doc/en/0.16.3/rpc/wallet/getaccountaddress.html create mode 100644 _doc/en/0.16.3/rpc/wallet/getaddressesbyaccount.html create mode 100644 _doc/en/0.16.3/rpc/wallet/getbalance.html create mode 100644 _doc/en/0.16.3/rpc/wallet/getnewaddress.html create mode 100644 _doc/en/0.16.3/rpc/wallet/getrawchangeaddress.html create mode 100644 _doc/en/0.16.3/rpc/wallet/getreceivedbyaccount.html create mode 100644 _doc/en/0.16.3/rpc/wallet/getreceivedbyaddress.html create mode 100644 _doc/en/0.16.3/rpc/wallet/gettransaction.html create mode 100644 _doc/en/0.16.3/rpc/wallet/getunconfirmedbalance.html create mode 100644 _doc/en/0.16.3/rpc/wallet/getwalletinfo.html create mode 100644 _doc/en/0.16.3/rpc/wallet/importaddress.html create mode 100644 _doc/en/0.16.3/rpc/wallet/importmulti.html create mode 100644 _doc/en/0.16.3/rpc/wallet/importprivkey.html create mode 100644 _doc/en/0.16.3/rpc/wallet/importprunedfunds.html create mode 100644 _doc/en/0.16.3/rpc/wallet/importpubkey.html create mode 100644 _doc/en/0.16.3/rpc/wallet/importwallet.html create mode 100644 _doc/en/0.16.3/rpc/wallet/keypoolrefill.html create mode 100644 _doc/en/0.16.3/rpc/wallet/listaccounts.html create mode 100644 _doc/en/0.16.3/rpc/wallet/listaddressgroupings.html create mode 100644 _doc/en/0.16.3/rpc/wallet/listlockunspent.html create mode 100644 _doc/en/0.16.3/rpc/wallet/listreceivedbyaccount.html create mode 100644 _doc/en/0.16.3/rpc/wallet/listreceivedbyaddress.html create mode 100644 _doc/en/0.16.3/rpc/wallet/listsinceblock.html create mode 100644 _doc/en/0.16.3/rpc/wallet/listtransactions.html create mode 100644 _doc/en/0.16.3/rpc/wallet/listunspent.html create mode 100644 _doc/en/0.16.3/rpc/wallet/listwallets.html create mode 100644 _doc/en/0.16.3/rpc/wallet/lockunspent.html create mode 100644 _doc/en/0.16.3/rpc/wallet/move.html create mode 100644 _doc/en/0.16.3/rpc/wallet/removeprunedfunds.html create mode 100644 _doc/en/0.16.3/rpc/wallet/rescanblockchain.html create mode 100644 _doc/en/0.16.3/rpc/wallet/sendfrom.html create mode 100644 _doc/en/0.16.3/rpc/wallet/sendmany.html create mode 100644 _doc/en/0.16.3/rpc/wallet/sendtoaddress.html create mode 100644 _doc/en/0.16.3/rpc/wallet/setaccount.html create mode 100644 _doc/en/0.16.3/rpc/wallet/settxfee.html create mode 100644 _doc/en/0.16.3/rpc/wallet/signmessage.html create mode 100644 _doc/en/0.16.3/rpc/wallet/walletlock.html create mode 100644 _doc/en/0.16.3/rpc/wallet/walletpassphrase.html create mode 100644 _doc/en/0.16.3/rpc/wallet/walletpassphrasechange.html diff --git a/_doc/en/0.16.3/index.html b/_doc/en/0.16.3/index.html new file mode 100644 index 000000000..3b16a86de --- /dev/null +++ b/_doc/en/0.16.3/index.html @@ -0,0 +1,8 @@ +--- +name: index +btcversion: 0.16.3 +btcgroup: index +permalink: en/doc/0.16.3/ +--- + + diff --git a/_doc/en/0.16.3/rpc/blockchain/getbestblockhash.html b/_doc/en/0.16.3/rpc/blockchain/getbestblockhash.html new file mode 100644 index 000000000..373e587e3 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/getbestblockhash.html @@ -0,0 +1,19 @@ +--- +name: getbestblockhash +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/getbestblockhash/ +--- + +getbestblockhash + +Returns the hash of the best (tip) block in the longest blockchain. + +Result: +"hex" (string) the block hash hex encoded + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/getblock.html b/_doc/en/0.16.3/rpc/blockchain/getblock.html new file mode 100644 index 000000000..0907333d2 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/getblock.html @@ -0,0 +1,60 @@ +--- +name: getblock +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/getblock/ +--- + +getblock "blockhash" ( verbosity ) + +If verbosity is 0, returns a string that is serialized, hex-encoded data for block 'hash'. +If verbosity is 1, returns an Object with information about block . +If verbosity is 2, returns an Object with information about block and information about each transaction. + +Arguments: +1. "blockhash" (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 + +Result (for verbosity = 0): +"data" (string) A string that is serialized, hex-encoded data for block 'hash'. + +Result (for verbosity = 1): +{ + "hash" : "hash", (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 + "size" : n, (numeric) The block size + "strippedsize" : n, (numeric) The block size excluding witness data + "weight" : n (numeric) The block weight as defined in BIP 141 + "height" : n, (numeric) The block height or index + "version" : n, (numeric) The block version + "versionHex" : "00000000", (string) The block version formatted in hexadecimal + "merkleroot" : "xxxx", (string) The merkle root + "tx" : [ (array of string) The transaction ids + "transactionid" (string) The transaction id + ,... + ], + "time" : 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) + "nonce" : n, (numeric) The nonce + "bits" : "1d00ffff", (string) The bits + "difficulty" : x.xxx, (numeric) The difficulty + "chainwork" : "xxxx", (string) Expected number of hashes required to produce the chain up to this block (in hex) + "nTx" : n, (numeric) The number of transactions in the block. + "previousblockhash" : "hash", (string) The hash of the previous block + "nextblockhash" : "hash" (string) The hash of the next block +} + +Result (for verbosity = 2): +{ + ..., Same output as verbosity = 1. + "tx" : [ (array of Objects) The transactions in the format of the getrawtransaction RPC. Different from verbosity = 1 "tx" result. + ,... + ], + ,... Same output as verbosity = 1. +} + +Examples: +> bitcoin-cli getblock "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/getblockchaininfo.html b/_doc/en/0.16.3/rpc/blockchain/getblockchaininfo.html new file mode 100644 index 000000000..fd120346d --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/getblockchaininfo.html @@ -0,0 +1,59 @@ +--- +name: getblockchaininfo +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/getblockchaininfo/ +--- + +getblockchaininfo +Returns an object containing various state info regarding blockchain processing. + +Result: +{ + "chain": "xxxx", (string) current network name as defined in BIP70 (main, test, regtest) + "blocks": xxxxxx, (numeric) the current number of blocks processed in the server + "headers": xxxxxx, (numeric) the current number of headers we have validated + "bestblockhash": "...", (string) the hash of the currently best block + "difficulty": xxxxxx, (numeric) the current difficulty + "mediantime": xxxxxx, (numeric) median time for the current best block + "verificationprogress": xxxx, (numeric) estimate of verification progress [0..1] + "initialblockdownload": 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 + "size_on_disk": xxxxxx, (numeric) the estimated size of the block and undo files on disk + "pruned": xx, (boolean) if the blocks are subject to pruning + "pruneheight": 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) + "prune_target_size": xxxxxx, (numeric) the target size used by pruning (only present if automatic pruning is enabled) + "softforks": [ (array) status of softforks in progress + { + "id": "xxxx", (string) name of softfork + "version": xx, (numeric) block version + "reject": { (object) progress toward rejecting pre-softfork blocks + "status": xx, (boolean) true if threshold reached + }, + }, ... + ], + "bip9_softforks": { (object) status of BIP9 softforks in progress + "xxxx" : { (string) name of the softfork + "status": "xxxx", (string) one of "defined", "started", "locked_in", "active", "failed" + "bit": xx, (numeric) the bit (0-28) in the block version field used to signal this softfork (only for "started" status) + "startTime": 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 + "since": 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) + "period": 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 + "elapsed": 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 + "possible": 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. +} + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/getblockcount.html b/_doc/en/0.16.3/rpc/blockchain/getblockcount.html new file mode 100644 index 000000000..c1af27691 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/getblockcount.html @@ -0,0 +1,19 @@ +--- +name: getblockcount +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/getblockcount/ +--- + +getblockcount + +Returns the number of blocks in the longest blockchain. + +Result: +n (numeric) The current block count + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/getblockhash.html b/_doc/en/0.16.3/rpc/blockchain/getblockhash.html new file mode 100644 index 000000000..323b9b485 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/getblockhash.html @@ -0,0 +1,22 @@ +--- +name: getblockhash +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/getblockhash/ +--- + +getblockhash height + +Returns hash of block in best-block-chain at height provided. + +Arguments: +1. height (numeric, required) The height index + +Result: +"hash" (string) The block hash + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/getblockheader.html b/_doc/en/0.16.3/rpc/blockchain/getblockheader.html new file mode 100644 index 000000000..e7b8c2bf3 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/getblockheader.html @@ -0,0 +1,43 @@ +--- +name: getblockheader +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/getblockheader/ +--- + +getblockheader "hash" ( verbose ) + +If verbose is false, returns a string that is serialized, hex-encoded data for blockheader 'hash'. +If verbose is true, returns an Object with information about blockheader . + +Arguments: +1. "hash" (string, required) The block hash +2. verbose (boolean, optional, default=true) true for a json object, false for the hex encoded data + +Result (for verbose = true): +{ + "hash" : "hash", (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 + "height" : n, (numeric) The block height or index + "version" : n, (numeric) The block version + "versionHex" : "00000000", (string) The block version formatted in hexadecimal + "merkleroot" : "xxxx", (string) The merkle root + "time" : 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) + "nonce" : n, (numeric) The nonce + "bits" : "1d00ffff", (string) The bits + "difficulty" : x.xxx, (numeric) The difficulty + "chainwork" : "0000...1f3" (string) Expected number of hashes required to produce the current chain (in hex) + "nTx" : n, (numeric) The number of transactions in the block. + "previousblockhash" : "hash", (string) The hash of the previous block + "nextblockhash" : "hash", (string) The hash of the next block +} + +Result (for verbose=false): +"data" (string) A string that is serialized, hex-encoded data for block 'hash'. + +Examples: +> bitcoin-cli getblockheader "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/getchaintips.html b/_doc/en/0.16.3/rpc/blockchain/getchaintips.html new file mode 100644 index 000000000..de1c86071 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/getchaintips.html @@ -0,0 +1,37 @@ +--- +name: getchaintips +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/getchaintips/ +--- + +getchaintips +Return information about all known tips in the block tree, including the main chain as well as orphaned branches. + +Result: +[ + { + "height": xxxx, (numeric) height of the chain tip + "hash": "xxxx", (string) block hash of the tip + "branchlen": 0 (numeric) zero for main chain + "status": "active" (string) "active" for the main chain + }, + { + "height": xxxx, + "hash": "xxxx", + "branchlen": 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) + } +] +Possible values for status: +1. "invalid" This branch contains at least one invalid block +2. "headers-only" 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 +4. "valid-fork" 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 + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/getchaintxstats.html b/_doc/en/0.16.3/rpc/blockchain/getchaintxstats.html new file mode 100644 index 000000000..939a55c47 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/getchaintxstats.html @@ -0,0 +1,30 @@ +--- +name: getchaintxstats +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/getchaintxstats/ +--- + +getchaintxstats ( nblocks blockhash ) + +Compute statistics about the total number and rate of transactions in the chain. + +Arguments: +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. + +Result: +{ + "time": 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. + "window_block_count": 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. + "window_interval": xxxxx, (numeric) The elapsed time in the window in seconds. Only returned if "window_block_count" is > 0. + "txrate": x.xx, (numeric) The average rate of transactions per second in the window. Only returned if "window_interval" is > 0. +} + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/getdifficulty.html b/_doc/en/0.16.3/rpc/blockchain/getdifficulty.html new file mode 100644 index 000000000..85efaf0b6 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/getdifficulty.html @@ -0,0 +1,19 @@ +--- +name: getdifficulty +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/getdifficulty/ +--- + +getdifficulty + +Returns the proof-of-work difficulty as a multiple of the minimum difficulty. + +Result: +n.nnn (numeric) the proof-of-work difficulty as a multiple of the minimum difficulty. + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/getmempoolancestors.html b/_doc/en/0.16.3/rpc/blockchain/getmempoolancestors.html new file mode 100644 index 000000000..c72ae68b6 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/getmempoolancestors.html @@ -0,0 +1,47 @@ +--- +name: getmempoolancestors +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/getmempoolancestors/ +--- + +getmempoolancestors txid (verbose) + +If txid is in the mempool, returns all in-mempool ancestors. + +Arguments: +1. "txid" (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 + +Result (for verbose=false): +[ (json array of strings) + "transactionid" (string) The transaction id of an in-mempool ancestor transaction + ,... +] + +Result (for verbose=true): +{ (json object) + "transactionid" : { (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. + "fee" : n, (numeric) transaction fee in BTC + "modifiedfee" : 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 + "height" : n, (numeric) block height when transaction entered pool + "descendantcount" : n, (numeric) number of in-mempool descendant transactions (including this one) + "descendantsize" : 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) + "ancestorcount" : n, (numeric) number of in-mempool ancestor transactions (including this one) + "ancestorsize" : 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) + "wtxid" : hash, (string) hash of serialized transaction, including witness data + "depends" : [ (array) unconfirmed transactions used as inputs for this transaction + "transactionid", (string) parent transaction id + ... ] + }, ... +} + +Examples: +> bitcoin-cli getmempoolancestors "mytxid" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/getmempooldescendants.html b/_doc/en/0.16.3/rpc/blockchain/getmempooldescendants.html new file mode 100644 index 000000000..e7b92b8bc --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/getmempooldescendants.html @@ -0,0 +1,47 @@ +--- +name: getmempooldescendants +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/getmempooldescendants/ +--- + +getmempooldescendants txid (verbose) + +If txid is in the mempool, returns all in-mempool descendants. + +Arguments: +1. "txid" (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 + +Result (for verbose=false): +[ (json array of strings) + "transactionid" (string) The transaction id of an in-mempool descendant transaction + ,... +] + +Result (for verbose=true): +{ (json object) + "transactionid" : { (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. + "fee" : n, (numeric) transaction fee in BTC + "modifiedfee" : 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 + "height" : n, (numeric) block height when transaction entered pool + "descendantcount" : n, (numeric) number of in-mempool descendant transactions (including this one) + "descendantsize" : 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) + "ancestorcount" : n, (numeric) number of in-mempool ancestor transactions (including this one) + "ancestorsize" : 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) + "wtxid" : hash, (string) hash of serialized transaction, including witness data + "depends" : [ (array) unconfirmed transactions used as inputs for this transaction + "transactionid", (string) parent transaction id + ... ] + }, ... +} + +Examples: +> bitcoin-cli getmempooldescendants "mytxid" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/getmempoolentry.html b/_doc/en/0.16.3/rpc/blockchain/getmempoolentry.html new file mode 100644 index 000000000..e6cb918ae --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/getmempoolentry.html @@ -0,0 +1,38 @@ +--- +name: getmempoolentry +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/getmempoolentry/ +--- + +getmempoolentry txid + +Returns mempool data for given transaction + +Arguments: +1. "txid" (string, required) The transaction id (must be in mempool) + +Result: +{ (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. + "fee" : n, (numeric) transaction fee in BTC + "modifiedfee" : 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 + "height" : n, (numeric) block height when transaction entered pool + "descendantcount" : n, (numeric) number of in-mempool descendant transactions (including this one) + "descendantsize" : 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) + "ancestorcount" : n, (numeric) number of in-mempool ancestor transactions (including this one) + "ancestorsize" : 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) + "wtxid" : hash, (string) hash of serialized transaction, including witness data + "depends" : [ (array) unconfirmed transactions used as inputs for this transaction + "transactionid", (string) parent transaction id + ... ] +} + +Examples: +> bitcoin-cli getmempoolentry "mytxid" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/getmempoolinfo.html b/_doc/en/0.16.3/rpc/blockchain/getmempoolinfo.html new file mode 100644 index 000000000..905d2ddd1 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/getmempoolinfo.html @@ -0,0 +1,26 @@ +--- +name: getmempoolinfo +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/getmempoolinfo/ +--- + +getmempoolinfo + +Returns details on the active state of the TX memory pool. + +Result: +{ + "size": 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 + "usage": xxxxx, (numeric) Total memory usage for the mempool + "maxmempool": 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 + "minrelaytxfee": xxxxx (numeric) Current minimum relay fee for transactions +} + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/getrawmempool.html b/_doc/en/0.16.3/rpc/blockchain/getrawmempool.html new file mode 100644 index 000000000..3d1df9a22 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/getrawmempool.html @@ -0,0 +1,48 @@ +--- +name: getrawmempool +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/getrawmempool/ +--- + +getrawmempool ( verbose ) + +Returns all transaction ids in memory pool as a json array of string transaction ids. + +Hint: use getmempoolentry to fetch a specific transaction from the mempool. + +Arguments: +1. verbose (boolean, optional, default=false) True for a json object, false for array of transaction ids + +Result: (for verbose = false): +[ (json array of string) + "transactionid" (string) The transaction id + ,... +] + +Result: (for verbose = true): +{ (json object) + "transactionid" : { (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. + "fee" : n, (numeric) transaction fee in BTC + "modifiedfee" : 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 + "height" : n, (numeric) block height when transaction entered pool + "descendantcount" : n, (numeric) number of in-mempool descendant transactions (including this one) + "descendantsize" : 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) + "ancestorcount" : n, (numeric) number of in-mempool ancestor transactions (including this one) + "ancestorsize" : 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) + "wtxid" : hash, (string) hash of serialized transaction, including witness data + "depends" : [ (array) unconfirmed transactions used as inputs for this transaction + "transactionid", (string) parent transaction id + ... ] + }, ... +} + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/gettxout.html b/_doc/en/0.16.3/rpc/blockchain/gettxout.html new file mode 100644 index 000000000..80c5dfbc5 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/gettxout.html @@ -0,0 +1,46 @@ +--- +name: gettxout +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/gettxout/ +--- + +gettxout "txid" n ( include_mempool ) + +Returns details about an unspent transaction output. + +Arguments: +1. "txid" (string, required) The transaction id +2. "n" (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. + +Result: +{ + "bestblock": "hash", (string) The hash of the block at the tip of the chain + "confirmations" : n, (numeric) The number of confirmations + "value" : x.xxx, (numeric) The transaction value in BTC + "scriptPubKey" : { (json object) + "asm" : "code", (string) + "hex" : "hex", (string) + "reqSigs" : n, (numeric) Number of required signatures + "type" : "pubkeyhash", (string) The type, eg pubkeyhash + "addresses" : [ (array of string) array of bitcoin addresses + "address" (string) bitcoin address + ,... + ] + }, + "coinbase" : true|false (boolean) Coinbase or not +} + +Examples: + +Get unspent transactions +> bitcoin-cli listunspent + +View the details +> bitcoin-cli gettxout "txid" 1 + +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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/gettxoutproof.html b/_doc/en/0.16.3/rpc/blockchain/gettxoutproof.html new file mode 100644 index 000000000..28376fbd1 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/gettxoutproof.html @@ -0,0 +1,28 @@ +--- +name: gettxoutproof +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/gettxoutproof/ +--- + +gettxoutproof ["txid",...] ( blockhash ) + +Returns a hex-encoded proof that "txid" was included in a block. + +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, +you need to maintain a transaction index, using the -txindex command line option or +specify the block in which the transaction is included manually (by blockhash). + +Arguments: +1. "txids" (string) A json array of txids to filter + [ + "txid" (string) A transaction hash + ,... + ] +2. "blockhash" (string, optional) If specified, looks for txid in the block with this hash + +Result: +"data" (string) A string that is a serialized, hex-encoded data for the proof. + + diff --git a/_doc/en/0.16.3/rpc/blockchain/gettxoutsetinfo.html b/_doc/en/0.16.3/rpc/blockchain/gettxoutsetinfo.html new file mode 100644 index 000000000..ed96ab97f --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/gettxoutsetinfo.html @@ -0,0 +1,29 @@ +--- +name: gettxoutsetinfo +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/gettxoutsetinfo/ +--- + +gettxoutsetinfo + +Returns statistics about the unspent transaction output set. +Note this call may take some time. + +Result: +{ + "height":n, (numeric) The current block height (index) + "bestblock": "hex", (string) The hash of the block at the tip of the chain + "transactions": n, (numeric) The number of transactions with unspent outputs + "txouts": n, (numeric) The number of unspent transaction outputs + "bogosize": n, (numeric) A meaningless metric for UTXO set size + "hash_serialized_2": "hash", (string) The serialized hash + "disk_size": n, (numeric) The estimated size of the chainstate on disk + "total_amount": x.xxx (numeric) The total amount +} + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/preciousblock.html b/_doc/en/0.16.3/rpc/blockchain/preciousblock.html new file mode 100644 index 000000000..270da3c62 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/preciousblock.html @@ -0,0 +1,25 @@ +--- +name: preciousblock +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/preciousblock/ +--- + +preciousblock "blockhash" + +Treats a block as if it were received before others with the same work. + +A later preciousblock call can override the effect of an earlier one. + +The effects of preciousblock are not retained across restarts. + +Arguments: +1. "blockhash" (string, required) the hash of the block to mark as precious + +Result: + +Examples: +> bitcoin-cli preciousblock "blockhash" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/pruneblockchain.html b/_doc/en/0.16.3/rpc/blockchain/pruneblockchain.html new file mode 100644 index 000000000..852f97ac4 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/pruneblockchain.html @@ -0,0 +1,21 @@ +--- +name: pruneblockchain +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/pruneblockchain/ +--- + +pruneblockchain + +Arguments: +1. "height" (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. + +Result: +n (numeric) Height of the last block pruned. + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/savemempool.html b/_doc/en/0.16.3/rpc/blockchain/savemempool.html new file mode 100644 index 000000000..f5254e48e --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/savemempool.html @@ -0,0 +1,16 @@ +--- +name: savemempool +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/savemempool/ +--- + +savemempool + +Dumps the mempool to disk. + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/verifychain.html b/_doc/en/0.16.3/rpc/blockchain/verifychain.html new file mode 100644 index 000000000..a15fed6a8 --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/verifychain.html @@ -0,0 +1,23 @@ +--- +name: verifychain +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/verifychain/ +--- + +verifychain ( checklevel nblocks ) + +Verifies blockchain database. + +Arguments: +1. checklevel (numeric, optional, 0-4, default=3) How thorough the block verification is. +2. nblocks (numeric, optional, default=6, 0=all) The number of blocks to check. + +Result: +true|false (boolean) Verified or not + +Examples: +> bitcoin-cli verifychain +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "verifychain", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ + + diff --git a/_doc/en/0.16.3/rpc/blockchain/verifytxoutproof.html b/_doc/en/0.16.3/rpc/blockchain/verifytxoutproof.html new file mode 100644 index 000000000..f7e93b97a --- /dev/null +++ b/_doc/en/0.16.3/rpc/blockchain/verifytxoutproof.html @@ -0,0 +1,19 @@ +--- +name: verifytxoutproof +btcversion: 0.16.3 +btcgroup: blockchain +permalink: en/doc/0.16.3/rpc/blockchain/verifytxoutproof/ +--- + +verifytxoutproof "proof" + +Verifies that a proof points to a transaction in a block, returning the transaction it commits to +and throwing an RPC error if the block is not in our best chain + +Arguments: +1. "proof" (string, required) The hex-encoded proof generated by gettxoutproof + +Result: +["txid"] (array, strings) The txid(s) which the proof commits to, or empty array if the proof can not be validated. + + diff --git a/_doc/en/0.16.3/rpc/control/getmemoryinfo.html b/_doc/en/0.16.3/rpc/control/getmemoryinfo.html new file mode 100644 index 000000000..bb482c1f4 --- /dev/null +++ b/_doc/en/0.16.3/rpc/control/getmemoryinfo.html @@ -0,0 +1,34 @@ +--- +name: getmemoryinfo +btcversion: 0.16.3 +btcgroup: control +permalink: en/doc/0.16.3/rpc/control/getmemoryinfo/ +--- + +getmemoryinfo ("mode") +Returns an object containing information about memory usage. +Arguments: +1. "mode" determines what kind of information is returned. This argument is optional, the default mode is "stats". + - "stats" 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+). + +Result (mode "stats"): +{ + "locked": { (json object) Information about locked memory manager + "used": xxxxx, (numeric) Number of bytes used + "free": xxxxx, (numeric) Number of bytes available in current arenas + "total": 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. + "chunks_used": xxxxx, (numeric) Number allocated chunks + "chunks_free": xxxxx, (numeric) Number unused chunks + } +} + +Result (mode "mallocinfo"): +"..." + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/control/help.html b/_doc/en/0.16.3/rpc/control/help.html new file mode 100644 index 000000000..c5bb6541e --- /dev/null +++ b/_doc/en/0.16.3/rpc/control/help.html @@ -0,0 +1,18 @@ +--- +name: help +btcversion: 0.16.3 +btcgroup: control +permalink: en/doc/0.16.3/rpc/control/help/ +--- + +help ( "command" ) + +List all commands, or get help for a specified command. + +Arguments: +1. "command" (string, optional) The command to get help on + +Result: +"text" (string) The help text + + diff --git a/_doc/en/0.16.3/rpc/control/logging.html b/_doc/en/0.16.3/rpc/control/logging.html new file mode 100644 index 000000000..df6cc6b10 --- /dev/null +++ b/_doc/en/0.16.3/rpc/control/logging.html @@ -0,0 +1,41 @@ +--- +name: logging +btcversion: 0.16.3 +btcgroup: control +permalink: en/doc/0.16.3/rpc/control/logging/ +--- + +logging ( ) +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 with arguments, adds or removes categories from debug logging and return the lists above. +The arguments are evaluated in order "include", "exclude". +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 +In addition, the following are available as category names with special meanings: + - "all", "1" : represent all logging categories. + - "none", "0" : even if other logging categories are specified, ignore all of them. + +Arguments: +1. "include" (array of strings, optional) A json array of categories to add debug logging + [ + "category" (string) the valid logging category + ,... + ] +2. "exclude" (array of strings, optional) A json array of categories to remove debug logging + [ + "category" (string) the valid logging category + ,... + ] + +Result: +{ (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 + ... +} + +Examples: +> bitcoin-cli logging "[\"all\"]" "[\"http\"]" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/control/stop.html b/_doc/en/0.16.3/rpc/control/stop.html new file mode 100644 index 000000000..9f7aaecd9 --- /dev/null +++ b/_doc/en/0.16.3/rpc/control/stop.html @@ -0,0 +1,11 @@ +--- +name: stop +btcversion: 0.16.3 +btcgroup: control +permalink: en/doc/0.16.3/rpc/control/stop/ +--- + +stop + +Stop Bitcoin server. + diff --git a/_doc/en/0.16.3/rpc/control/uptime.html b/_doc/en/0.16.3/rpc/control/uptime.html new file mode 100644 index 000000000..7a10fb93b --- /dev/null +++ b/_doc/en/0.16.3/rpc/control/uptime.html @@ -0,0 +1,19 @@ +--- +name: uptime +btcversion: 0.16.3 +btcgroup: control +permalink: en/doc/0.16.3/rpc/control/uptime/ +--- + +uptime + +Returns the total uptime of the server. + +Result: +ttt (numeric) The number of seconds that the server has been running + +Examples: +> bitcoin-cli uptime +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "uptime", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ + + diff --git a/_doc/en/0.16.3/rpc/generating/generate.html b/_doc/en/0.16.3/rpc/generating/generate.html new file mode 100644 index 000000000..62cfbabb7 --- /dev/null +++ b/_doc/en/0.16.3/rpc/generating/generate.html @@ -0,0 +1,24 @@ +--- +name: generate +btcversion: 0.16.3 +btcgroup: generating +permalink: en/doc/0.16.3/rpc/generating/generate/ +--- + +generate nblocks ( maxtries ) + +Mine up to nblocks blocks immediately (before the RPC call returns) to an address in the wallet. + +Arguments: +1. nblocks (numeric, required) How many blocks are generated immediately. +2. maxtries (numeric, optional) How many iterations to try (default = 1000000). + +Result: +[ blockhashes ] (array) hashes of blocks generated + +Examples: + +Generate 11 blocks +> bitcoin-cli generate 11 + + diff --git a/_doc/en/0.16.3/rpc/generating/generatetoaddress.html b/_doc/en/0.16.3/rpc/generating/generatetoaddress.html new file mode 100644 index 000000000..d061ebc69 --- /dev/null +++ b/_doc/en/0.16.3/rpc/generating/generatetoaddress.html @@ -0,0 +1,25 @@ +--- +name: generatetoaddress +btcversion: 0.16.3 +btcgroup: generating +permalink: en/doc/0.16.3/rpc/generating/generatetoaddress/ +--- + +generatetoaddress nblocks address (maxtries) + +Mine blocks immediately to a specified address (before the RPC call returns) + +Arguments: +1. nblocks (numeric, required) How many blocks are generated immediately. +2. address (string, required) The address to send the newly generated bitcoin to. +3. maxtries (numeric, optional) How many iterations to try (default = 1000000). + +Result: +[ blockhashes ] (array) hashes of blocks generated + +Examples: + +Generate 11 blocks to myaddress +> bitcoin-cli generatetoaddress 11 "myaddress" + + diff --git a/_doc/en/0.16.3/rpc/index.html b/_doc/en/0.16.3/rpc/index.html new file mode 100644 index 000000000..3028db645 --- /dev/null +++ b/_doc/en/0.16.3/rpc/index.html @@ -0,0 +1,8 @@ +--- +name: rpcindex +btcversion: 0.16.3 +btcgroup: index +permalink: en/doc/0.16.3/rpc/ +--- + + diff --git a/_doc/en/0.16.3/rpc/mining/getblocktemplate.html b/_doc/en/0.16.3/rpc/mining/getblocktemplate.html new file mode 100644 index 000000000..c71405319 --- /dev/null +++ b/_doc/en/0.16.3/rpc/mining/getblocktemplate.html @@ -0,0 +1,83 @@ +--- +name: getblocktemplate +btcversion: 0.16.3 +btcgroup: mining +permalink: en/doc/0.16.3/rpc/mining/getblocktemplate/ +--- + +getblocktemplate ( TemplateRequest ) + +If the request parameters include a 'mode' key, that is used to explicitly select between the default 'template' request or a 'proposal'. +It returns data needed to construct a block to work on. +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-0023.mediawiki + https://github.com/bitcoin/bips/blob/master/bip-0009.mediawiki#getblocktemplate_changes + https://github.com/bitcoin/bips/blob/master/bip-0145.mediawiki + +Arguments: +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 + "capabilities":[ (array, optional) A list of strings + "support" (string) client side supported feature, 'longpoll', 'coinbasetxn', 'coinbasevalue', 'proposal', 'serverlist', 'workid' + ,... + ], + "rules":[ (array, optional) A list of strings + "support" (string) client side supported softfork deployment + ,... + ] + } + + +Result: +{ + "version" : n, (numeric) The preferred block version + "rules" : [ "rulename", ... ], (array of strings) specific block rules that are to be enforced + "vbavailable" : { (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 + ,... + }, + "vbrequired" : n, (numeric) bit mask of versionbits the server requires set in submissions + "previousblockhash" : "xxxx", (string) The hash of current highest block + "transactions" : [ (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) + "txid" : "xxxx", (string) transaction id encoded in little-endian hexadecimal + "hash" : "xxxx", (string) hash encoded in little-endian hexadecimal (including witness data) + "depends" : [ (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 + ,... + ], + "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 + "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 + "weight" : 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 + } + ,... + ], + "coinbaseaux" : { (json object) data that should be included in the coinbase's scriptSig content + "flags" : "xx" (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) + "coinbasetxn" : { ... }, (json object) information for coinbase transaction + "target" : "xxxx", (string) The hash target + "mintime" : 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 + "value" (string) A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock' + ,... + ], + "noncerange" : "00000000ffffffff",(string) A range of valid nonces + "sigoplimit" : n, (numeric) limit of sigops in blocks + "sizelimit" : n, (numeric) limit of block size + "weightlimit" : n, (numeric) limit of block weight + "curtime" : ttt, (numeric) current timestamp in seconds since epoch (Jan 1 1970 GMT) + "bits" : "xxxxxxxx", (string) compressed target of next block + "height" : n (numeric) The height of the next block +} + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/mining/getmininginfo.html b/_doc/en/0.16.3/rpc/mining/getmininginfo.html new file mode 100644 index 000000000..5e5423085 --- /dev/null +++ b/_doc/en/0.16.3/rpc/mining/getmininginfo.html @@ -0,0 +1,28 @@ +--- +name: getmininginfo +btcversion: 0.16.3 +btcgroup: mining +permalink: en/doc/0.16.3/rpc/mining/getmininginfo/ +--- + +getmininginfo + +Returns a json object containing mining-related information. +Result: +{ + "blocks": nnn, (numeric) The current block + "currentblockweight": nnn, (numeric) The last block weight + "currentblocktx": nnn, (numeric) The last block transaction + "difficulty": xxx.xxxxx (numeric) The current difficulty + "networkhashps": nnn, (numeric) The network hashes per second + "pooledtx": n (numeric) The size of the mempool + "chain": "xxxx", (string) current network name as defined in BIP70 (main, test, regtest) + "warnings": "..." (string) any network and blockchain warnings + "errors": "..." (string) DEPRECATED. Same as warnings. Only shown when bitcoind is started with -deprecatedrpc=getmininginfo +} + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/mining/getnetworkhashps.html b/_doc/en/0.16.3/rpc/mining/getnetworkhashps.html new file mode 100644 index 000000000..9cfef0b8e --- /dev/null +++ b/_doc/en/0.16.3/rpc/mining/getnetworkhashps.html @@ -0,0 +1,25 @@ +--- +name: getnetworkhashps +btcversion: 0.16.3 +btcgroup: mining +permalink: en/doc/0.16.3/rpc/mining/getnetworkhashps/ +--- + +getnetworkhashps ( nblocks height ) + +Returns the estimated network hashes per second based on the last n blocks. +Pass in [blocks] to override # of blocks, -1 specifies since last difficulty change. +Pass in [height] to estimate the network speed at the time when a certain block was found. + +Arguments: +1. nblocks (numeric, optional, default=120) The number of blocks, or -1 for blocks since last difficulty change. +2. height (numeric, optional, default=-1) To estimate at the time of the given height. + +Result: +x (numeric) Hashes per second estimated + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/mining/prioritisetransaction.html b/_doc/en/0.16.3/rpc/mining/prioritisetransaction.html new file mode 100644 index 000000000..9bc69d077 --- /dev/null +++ b/_doc/en/0.16.3/rpc/mining/prioritisetransaction.html @@ -0,0 +1,26 @@ +--- +name: prioritisetransaction +btcversion: 0.16.3 +btcgroup: mining +permalink: en/doc/0.16.3/rpc/mining/prioritisetransaction/ +--- + +prioritisetransaction +Accepts the transaction into mined blocks at a higher (or lower) priority + +Arguments: +1. "txid" (string, required) The transaction id. +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. +3. fee_delta (numeric, required) The fee value (in satoshis) to add (or subtract, if negative). + The fee is not actually paid, only the algorithm for selecting transactions into a block + considers the transaction as it would have paid a higher (or lower) fee. + +Result: +true (boolean) Returns true + +Examples: +> bitcoin-cli prioritisetransaction "txid" 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/ + + diff --git a/_doc/en/0.16.3/rpc/mining/submitblock.html b/_doc/en/0.16.3/rpc/mining/submitblock.html new file mode 100644 index 000000000..afa325f5f --- /dev/null +++ b/_doc/en/0.16.3/rpc/mining/submitblock.html @@ -0,0 +1,23 @@ +--- +name: submitblock +btcversion: 0.16.3 +btcgroup: mining +permalink: en/doc/0.16.3/rpc/mining/submitblock/ +--- + +submitblock "hexdata" ( "dummy" ) + +Attempts to submit new block to network. +See https://en.bitcoin.it/wiki/BIP_0022 for full specification. + +Arguments +1. "hexdata" (string, required) the hex-encoded block data to submit +2. "dummy" (optional) dummy value, for compatibility with BIP22. This value is ignored. + +Result: + +Examples: +> bitcoin-cli submitblock "mydata" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/network/addnode.html b/_doc/en/0.16.3/rpc/network/addnode.html new file mode 100644 index 000000000..efbf19dda --- /dev/null +++ b/_doc/en/0.16.3/rpc/network/addnode.html @@ -0,0 +1,23 @@ +--- +name: addnode +btcversion: 0.16.3 +btcgroup: network +permalink: en/doc/0.16.3/rpc/network/addnode/ +--- + +addnode "node" "add|remove|onetry" + +Attempts to add or remove a node from the addnode list. +Or try a connection to a node once. +Nodes added using addnode (or -connect) are protected from DoS disconnection and are not required to be +full nodes/support SegWit as other outbound peers are (though such peers will not be synced from). + +Arguments: +1. "node" (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 + +Examples: +> bitcoin-cli addnode "192.168.0.6:8333" "onetry" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/network/clearbanned.html b/_doc/en/0.16.3/rpc/network/clearbanned.html new file mode 100644 index 000000000..468bfd04e --- /dev/null +++ b/_doc/en/0.16.3/rpc/network/clearbanned.html @@ -0,0 +1,16 @@ +--- +name: clearbanned +btcversion: 0.16.3 +btcgroup: network +permalink: en/doc/0.16.3/rpc/network/clearbanned/ +--- + +clearbanned + +Clear all banned IPs. + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/network/disconnectnode.html b/_doc/en/0.16.3/rpc/network/disconnectnode.html new file mode 100644 index 000000000..d39592c65 --- /dev/null +++ b/_doc/en/0.16.3/rpc/network/disconnectnode.html @@ -0,0 +1,26 @@ +--- +name: disconnectnode +btcversion: 0.16.3 +btcgroup: network +permalink: en/doc/0.16.3/rpc/network/disconnectnode/ +--- + +disconnectnode "[address]" [nodeid] + +Immediately disconnects from the specified peer node. + +Strictly one out of 'address' and 'nodeid' 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. + +Arguments: +1. "address" (string, optional) The IP address/port of the node +2. "nodeid" (number, optional) The node ID (see getpeerinfo for node IDs) + +Examples: +> bitcoin-cli disconnectnode "192.168.0.6:8333" +> bitcoin-cli disconnectnode "" 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/ +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/network/getaddednodeinfo.html b/_doc/en/0.16.3/rpc/network/getaddednodeinfo.html new file mode 100644 index 000000000..3c941a49b --- /dev/null +++ b/_doc/en/0.16.3/rpc/network/getaddednodeinfo.html @@ -0,0 +1,35 @@ +--- +name: getaddednodeinfo +btcversion: 0.16.3 +btcgroup: network +permalink: en/doc/0.16.3/rpc/network/getaddednodeinfo/ +--- + +getaddednodeinfo ( "node" ) + +Returns information about the given added node, or all added nodes +(note that onetry addnodes are not listed here) + +Arguments: +1. "node" (string, optional) If provided, return information about this specific node, otherwise all nodes are returned. + +Result: +[ + { + "addednode" : "192.168.0.201", (string) The node IP address or name (as provided to addnode) + "connected" : true|false, (boolean) If connected + "addresses" : [ (list of objects) Only when connected = true + { + "address" : "192.168.0.201:8333", (string) The bitcoin server IP and port we're connected to + "connected" : "outbound" (string) connection, inbound or outbound + } + ] + } + ,... +] + +Examples: +> bitcoin-cli getaddednodeinfo "192.168.0.201" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/network/getconnectioncount.html b/_doc/en/0.16.3/rpc/network/getconnectioncount.html new file mode 100644 index 000000000..39d849c5c --- /dev/null +++ b/_doc/en/0.16.3/rpc/network/getconnectioncount.html @@ -0,0 +1,19 @@ +--- +name: getconnectioncount +btcversion: 0.16.3 +btcgroup: network +permalink: en/doc/0.16.3/rpc/network/getconnectioncount/ +--- + +getconnectioncount + +Returns the number of connections to other nodes. + +Result: +n (numeric) The connection count + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/network/getnettotals.html b/_doc/en/0.16.3/rpc/network/getnettotals.html new file mode 100644 index 000000000..1e344d00b --- /dev/null +++ b/_doc/en/0.16.3/rpc/network/getnettotals.html @@ -0,0 +1,33 @@ +--- +name: getnettotals +btcversion: 0.16.3 +btcgroup: network +permalink: en/doc/0.16.3/rpc/network/getnettotals/ +--- + +getnettotals + +Returns information about network traffic, including bytes in, bytes out, +and current time. + +Result: +{ + "totalbytesrecv": n, (numeric) Total bytes received + "totalbytessent": n, (numeric) Total bytes sent + "timemillis": t, (numeric) Current UNIX time in milliseconds + "uploadtarget": + { + "timeframe": n, (numeric) Length of the measuring timeframe in seconds + "target": n, (numeric) Target in bytes + "target_reached": true|false, (boolean) True if target is reached + "serve_historical_blocks": true|false, (boolean) True if serving historical blocks + "bytes_left_in_cycle": t, (numeric) Bytes left in current time cycle + "time_left_in_cycle": t (numeric) Seconds left in current time cycle + } +} + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/network/getnetworkinfo.html b/_doc/en/0.16.3/rpc/network/getnetworkinfo.html new file mode 100644 index 000000000..d2af1a723 --- /dev/null +++ b/_doc/en/0.16.3/rpc/network/getnetworkinfo.html @@ -0,0 +1,48 @@ +--- +name: getnetworkinfo +btcversion: 0.16.3 +btcgroup: network +permalink: en/doc/0.16.3/rpc/network/getnetworkinfo/ +--- + +getnetworkinfo +Returns an object containing various state info regarding P2P networking. + +Result: +{ + "version": xxxxx, (numeric) the server version + "subversion": "/Satoshi:x.x.x/", (string) the server subversion string + "protocolversion": xxxxx, (numeric) the protocol version + "localservices": "xxxxxxxxxxxxxxxx", (string) the services we offer to the network + "localrelay": true|false, (bool) true if transaction relay is requested from peers + "timeoffset": xxxxx, (numeric) the time offset + "connections": xxxxx, (numeric) the number of connections + "networkactive": true|false, (bool) whether p2p networking is enabled + "networks": [ (array) information per network + { + "name": "xxx", (string) network (ipv4, ipv6 or onion) + "limited": true|false, (boolean) is the network limited using -onlynet? + "reachable": true|false, (boolean) is the network reachable? + "proxy": "host:port" (string) the proxy that is used for this network, or empty if none + "proxy_randomize_credentials": true|false, (string) Whether randomized credentials are used + } + ,... + ], + "relayfee": 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 + "localaddresses": [ (array) list of local addresses + { + "address": "xxxx", (string) network address + "port": xxx, (numeric) network port + "score": xxx (numeric) relative score + } + ,... + ] + "warnings": "..." (string) any network and blockchain warnings +} + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/network/getpeerinfo.html b/_doc/en/0.16.3/rpc/network/getpeerinfo.html new file mode 100644 index 000000000..c8aef1829 --- /dev/null +++ b/_doc/en/0.16.3/rpc/network/getpeerinfo.html @@ -0,0 +1,59 @@ +--- +name: getpeerinfo +btcversion: 0.16.3 +btcgroup: network +permalink: en/doc/0.16.3/rpc/network/getpeerinfo/ +--- + +getpeerinfo + +Returns data about each connected network node as a json array of objects. + +Result: +[ + { + "id": n, (numeric) Peer index + "addr":"host:port", (string) The IP address and port of the peer + "addrbind":"ip:port", (string) Bind address of the connection to the peer + "addrlocal":"ip:port", (string) Local address as reported by the peer + "services":"xxxxxxxxxxxxxxxx", (string) The services offered + "relaytxes":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 + "lastrecv": ttt, (numeric) The time in seconds since epoch (Jan 1 1970 GMT) of the last receive + "bytessent": n, (numeric) The total bytes sent + "bytesrecv": n, (numeric) The total bytes received + "conntime": ttt, (numeric) The connection time in seconds since epoch (Jan 1 1970 GMT) + "timeoffset": ttt, (numeric) The time offset in seconds + "pingtime": n, (numeric) ping time (if available) + "minping": n, (numeric) minimum observed ping time (if any at all) + "pingwait": n, (numeric) ping wait (if non-zero) + "version": v, (numeric) The peer version, such as 70001 + "subver": "/Satoshi:0.8.5/", (string) The string version + "inbound": 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 + "startingheight": n, (numeric) The starting height (block) of the peer + "banscore": n, (numeric) The ban score + "synced_headers": 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 + "inflight": [ + n, (numeric) The heights of blocks we're currently asking from this peer + ... + ], + "whitelisted": true|false, (boolean) Whether the peer is whitelisted + "bytessent_per_msg": { + "addr": n, (numeric) The total bytes sent aggregated by message type + ... + }, + "bytesrecv_per_msg": { + "addr": n, (numeric) The total bytes received aggregated by message type + ... + } + } + ,... +] + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/network/listbanned.html b/_doc/en/0.16.3/rpc/network/listbanned.html new file mode 100644 index 000000000..4ef0fe3e2 --- /dev/null +++ b/_doc/en/0.16.3/rpc/network/listbanned.html @@ -0,0 +1,16 @@ +--- +name: listbanned +btcversion: 0.16.3 +btcgroup: network +permalink: en/doc/0.16.3/rpc/network/listbanned/ +--- + +listbanned + +List all banned IPs/Subnets. + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/network/ping.html b/_doc/en/0.16.3/rpc/network/ping.html new file mode 100644 index 000000000..370edeae7 --- /dev/null +++ b/_doc/en/0.16.3/rpc/network/ping.html @@ -0,0 +1,18 @@ +--- +name: ping +btcversion: 0.16.3 +btcgroup: network +permalink: en/doc/0.16.3/rpc/network/ping/ +--- + +ping + +Requests that a ping be sent to all other nodes, to measure ping time. +Results provided in getpeerinfo, pingtime and pingwait fields are decimal seconds. +Ping command is handled in queue with all other commands, so it measures processing backlog, not just network ping. + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/network/setban.html b/_doc/en/0.16.3/rpc/network/setban.html new file mode 100644 index 000000000..7534a72b8 --- /dev/null +++ b/_doc/en/0.16.3/rpc/network/setban.html @@ -0,0 +1,23 @@ +--- +name: setban +btcversion: 0.16.3 +btcgroup: network +permalink: en/doc/0.16.3/rpc/network/setban/ +--- + +setban "subnet" "add|remove" (bantime) (absolute) + +Attempts to add or remove an IP/Subnet from the banned list. + +Arguments: +1. "subnet" (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 +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) +4. "absolute" (boolean, optional) If set, the bantime must be an absolute timestamp in seconds since epoch (Jan 1 1970 GMT) + +Examples: +> bitcoin-cli setban "192.168.0.6" "add" 86400 +> bitcoin-cli setban "192.168.0.0/24" "add" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/network/setnetworkactive.html b/_doc/en/0.16.3/rpc/network/setnetworkactive.html new file mode 100644 index 000000000..3d86144ca --- /dev/null +++ b/_doc/en/0.16.3/rpc/network/setnetworkactive.html @@ -0,0 +1,15 @@ +--- +name: setnetworkactive +btcversion: 0.16.3 +btcgroup: network +permalink: en/doc/0.16.3/rpc/network/setnetworkactive/ +--- + +setnetworkactive true|false + +Disable/enable all p2p network activity. + +Arguments: +1. "state" (boolean, required) true to enable networking, false to disable + + diff --git a/_doc/en/0.16.3/rpc/rawtransactions/combinerawtransaction.html b/_doc/en/0.16.3/rpc/rawtransactions/combinerawtransaction.html new file mode 100644 index 000000000..210b08495 --- /dev/null +++ b/_doc/en/0.16.3/rpc/rawtransactions/combinerawtransaction.html @@ -0,0 +1,26 @@ +--- +name: combinerawtransaction +btcversion: 0.16.3 +btcgroup: rawtransactions +permalink: en/doc/0.16.3/rpc/rawtransactions/combinerawtransaction/ +--- + +combinerawtransaction ["hexstring",...] + +Combine multiple partially signed transactions into one transaction. +The combined transaction may be another partially signed transaction or a +fully signed transaction. +Arguments: +1. "txs" (string) A json array of hex strings of partially signed transactions + [ + "hexstring" (string) A transaction hash + ,... + ] + +Result: +"hex" (string) The hex-encoded raw transaction with signature(s) + +Examples: +> bitcoin-cli combinerawtransaction ["myhex1", "myhex2", "myhex3"] + + diff --git a/_doc/en/0.16.3/rpc/rawtransactions/createrawtransaction.html b/_doc/en/0.16.3/rpc/rawtransactions/createrawtransaction.html new file mode 100644 index 000000000..9a9550bce --- /dev/null +++ b/_doc/en/0.16.3/rpc/rawtransactions/createrawtransaction.html @@ -0,0 +1,45 @@ +--- +name: createrawtransaction +btcversion: 0.16.3 +btcgroup: rawtransactions +permalink: en/doc/0.16.3/rpc/rawtransactions/createrawtransaction/ +--- + +createrawtransaction [{"txid":"id","vout":n},...] {"address":amount,"data":"hex",...} ( locktime ) ( replaceable ) + +Create a transaction spending the given inputs and creating new outputs. +Outputs can be addresses or data. +Returns hex-encoded raw transaction. +Note that the transaction's inputs are not signed, and +it is not stored in the wallet or transmitted to the network. + +Arguments: +1. "inputs" (array, required) A json array of json objects + [ + { + "txid":"id", (string, required) The transaction id + "vout":n, (numeric, required) The output number + "sequence":n (numeric, optional) The sequence number + } + ,... + ] +2. "outputs" (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 + "data": "hex" (string, required) The key is "data", the value is hex encoded data + ,... + } +3. locktime (numeric, optional, default=0) Raw locktime. Non-0 value also locktime-activates inputs +4. replaceable (boolean, optional, default=false) Marks this transaction as BIP125 replaceable. + 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: +"transaction" (string) hex string of the transaction + +Examples: +> bitcoin-cli createrawtransaction "[{\"txid\":\"myid\",\"vout\":0}]" "{\"address\":0.01}" +> bitcoin-cli createrawtransaction "[{\"txid\":\"myid\",\"vout\":0}]" "{\"data\":\"00010203\"}" +> 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/ +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/rawtransactions/decoderawtransaction.html b/_doc/en/0.16.3/rpc/rawtransactions/decoderawtransaction.html new file mode 100644 index 000000000..d86fd18c0 --- /dev/null +++ b/_doc/en/0.16.3/rpc/rawtransactions/decoderawtransaction.html @@ -0,0 +1,61 @@ +--- +name: decoderawtransaction +btcversion: 0.16.3 +btcgroup: rawtransactions +permalink: en/doc/0.16.3/rpc/rawtransactions/decoderawtransaction/ +--- + +decoderawtransaction "hexstring" ( iswitness ) + +Return a JSON object representing the serialized, hex-encoded transaction. + +Arguments: +1. "hexstring" (string, required) The transaction hex string +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 + +Result: +{ + "txid" : "id", (string) The transaction id + "hash" : "id", (string) The transaction hash (differs from txid for witness transactions) + "size" : n, (numeric) The transaction size + "vsize" : n, (numeric) The virtual transaction size (differs from size for witness transactions) + "version" : n, (numeric) The version + "locktime" : ttt, (numeric) The lock time + "vin" : [ (array of json objects) + { + "txid": "id", (string) The transaction id + "vout": n, (numeric) The output number + "scriptSig": { (json object) The script + "asm": "asm", (string) asm + "hex": "hex" (string) hex + }, + "txinwitness": ["hex", ...] (array of string) hex-encoded witness data (if any) + "sequence": n (numeric) The script sequence number + } + ,... + ], + "vout" : [ (array of json objects) + { + "value" : x.xxx, (numeric) The value in BTC + "n" : n, (numeric) index + "scriptPubKey" : { (json object) + "asm" : "asm", (string) the asm + "hex" : "hex", (string) the hex + "reqSigs" : n, (numeric) The required sigs + "type" : "pubkeyhash", (string) The type, eg 'pubkeyhash' + "addresses" : [ (json array of string) + "12tvKAXCxZjSmdNbao16dKXC8tRWfcF5oc" (string) bitcoin address + ,... + ] + } + } + ,... + ], +} + +Examples: +> bitcoin-cli decoderawtransaction "hexstring" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/rawtransactions/decodescript.html b/_doc/en/0.16.3/rpc/rawtransactions/decodescript.html new file mode 100644 index 000000000..f47362a73 --- /dev/null +++ b/_doc/en/0.16.3/rpc/rawtransactions/decodescript.html @@ -0,0 +1,32 @@ +--- +name: decodescript +btcversion: 0.16.3 +btcgroup: rawtransactions +permalink: en/doc/0.16.3/rpc/rawtransactions/decodescript/ +--- + +decodescript "hexstring" + +Decode a hex-encoded script. + +Arguments: +1. "hexstring" (string) the hex encoded script + +Result: +{ + "asm":"asm", (string) Script public key + "hex":"hex", (string) hex encoded public key + "type":"type", (string) The output type + "reqSigs": n, (numeric) The required signatures + "addresses": [ (json array of string) + "address" (string) bitcoin address + ,... + ], + "p2sh","address" (string) address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH). +} + +Examples: +> bitcoin-cli decodescript "hexstring" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/rawtransactions/fundrawtransaction.html b/_doc/en/0.16.3/rpc/rawtransactions/fundrawtransaction.html new file mode 100644 index 000000000..313c4e040 --- /dev/null +++ b/_doc/en/0.16.3/rpc/rawtransactions/fundrawtransaction.html @@ -0,0 +1,70 @@ +--- +name: fundrawtransaction +btcversion: 0.16.3 +btcgroup: rawtransactions +permalink: en/doc/0.16.3/rpc/rawtransactions/fundrawtransaction/ +--- + +fundrawtransaction "hexstring" ( options iswitness ) + +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. +No existing outputs will be modified unless "subtractFeeFromOutputs" is specified. +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. +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 +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. +Only pay-to-pubkey, multisig, and P2SH versions thereof are currently supported for watch-only + +Arguments: +1. "hexstring" (string, required) The hex string of the raw transaction +2. options (object, optional) + { + "changeAddress" (string, optional, default pool address) The bitcoin address to receive the change + "changePosition" (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. + "includeWatching" (boolean, optional, default false) Also select inputs which are watch only + "lockUnspents" (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 + "subtractFeeFromOutputs" (array, optional) A json array of integers. + 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. + 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. + [vout_index,...] + "replaceable" (boolean, optional) Marks this transaction as BIP125 replaceable. + Allows this transaction to be replaced by a transaction with higher fees + "conf_target" (numeric, optional) Confirmation target (in blocks) + "estimate_mode" (string, optional, default=UNSET) The fee estimate mode, must be one of: + "UNSET" + "ECONOMICAL" + "CONSERVATIVE" + } + for backward compatibility: passing in a true instead of an object will result in {"includeWatching":true} +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 + +Result: +{ + "hex": "value", (string) The resulting raw transaction (hex-encoded string) + "fee": n, (numeric) Fee in BTC the resulting transaction pays + "changepos": n (numeric) The position of the added change output, or -1 +} + +Examples: + +Create a transaction with no inputs +> bitcoin-cli createrawtransaction "[]" "{\"myaddress\":0.01}" + +Add sufficient unsigned inputs to meet the output value +> bitcoin-cli fundrawtransaction "rawtransactionhex" + +Sign the transaction +> bitcoin-cli signrawtransaction "fundedtransactionhex" + +Send the transaction +> bitcoin-cli sendrawtransaction "signedtransactionhex" + + diff --git a/_doc/en/0.16.3/rpc/rawtransactions/getrawtransaction.html b/_doc/en/0.16.3/rpc/rawtransactions/getrawtransaction.html new file mode 100644 index 000000000..19d528110 --- /dev/null +++ b/_doc/en/0.16.3/rpc/rawtransactions/getrawtransaction.html @@ -0,0 +1,83 @@ +--- +name: getrawtransaction +btcversion: 0.16.3 +btcgroup: rawtransactions +permalink: en/doc/0.16.3/rpc/rawtransactions/getrawtransaction/ +--- + +getrawtransaction "txid" ( verbose "blockhash" ) + +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 +is known, its hash can be provided even for nodes without -txindex. Note that if a blockhash is +provided, only that block will be searched and if the transaction is in the mempool or other +blocks, or if this node does not have the given block available, the transaction will not be found. +DEPRECATED: for now, it also works for transactions with unspent outputs. + +Return the raw transaction data. + +If verbose is 'true', returns an Object with information about 'txid'. +If verbose is 'false' or omitted, returns a string that is serialized, hex-encoded data for 'txid'. + +Arguments: +1. "txid" (string, required) The transaction id +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 + +Result (if verbose is not set or set to false): +"data" (string) The serialized, hex-encoded data for 'txid' + +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) + "hex" : "data", (string) The serialized, hex-encoded data for 'txid' + "txid" : "id", (string) The transaction id (same as provided) + "hash" : "id", (string) The transaction hash (differs from txid for witness transactions) + "size" : n, (numeric) The serialized transaction size + "vsize" : n, (numeric) The virtual transaction size (differs from size for witness transactions) + "version" : n, (numeric) The version + "locktime" : ttt, (numeric) The lock time + "vin" : [ (array of json objects) + { + "txid": "id", (string) The transaction id + "vout": n, (numeric) + "scriptSig": { (json object) The script + "asm": "asm", (string) asm + "hex": "hex" (string) hex + }, + "sequence": n (numeric) The script sequence number + "txinwitness": ["hex", ...] (array of string) hex-encoded witness data (if any) + } + ,... + ], + "vout" : [ (array of json objects) + { + "value" : x.xxx, (numeric) The value in BTC + "n" : n, (numeric) index + "scriptPubKey" : { (json object) + "asm" : "asm", (string) the asm + "hex" : "hex", (string) the hex + "reqSigs" : n, (numeric) The required sigs + "type" : "pubkeyhash", (string) The type, eg 'pubkeyhash' + "addresses" : [ (json array of string) + "address" (string) bitcoin address + ,... + ] + } + } + ,... + ], + "blockhash" : "hash", (string) the block hash + "confirmations" : n, (numeric) The confirmations + "time" : 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) +} + +Examples: +> bitcoin-cli getrawtransaction "mytxid" +> bitcoin-cli getrawtransaction "mytxid" 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/ +> bitcoin-cli getrawtransaction "mytxid" false "myblockhash" +> bitcoin-cli getrawtransaction "mytxid" true "myblockhash" + + diff --git a/_doc/en/0.16.3/rpc/rawtransactions/sendrawtransaction.html b/_doc/en/0.16.3/rpc/rawtransactions/sendrawtransaction.html new file mode 100644 index 000000000..6f46444b5 --- /dev/null +++ b/_doc/en/0.16.3/rpc/rawtransactions/sendrawtransaction.html @@ -0,0 +1,34 @@ +--- +name: sendrawtransaction +btcversion: 0.16.3 +btcgroup: rawtransactions +permalink: en/doc/0.16.3/rpc/rawtransactions/sendrawtransaction/ +--- + +sendrawtransaction "hexstring" ( allowhighfees ) + +Submits raw transaction (serialized, hex-encoded) to local node and network. + +Also see createrawtransaction and signrawtransaction calls. + +Arguments: +1. "hexstring" (string, required) The hex string of the raw transaction) +2. allowhighfees (boolean, optional, default=false) Allow high fees + +Result: +"hex" (string) The transaction hash in hex + +Examples: + +Create a transaction +> bitcoin-cli createrawtransaction "[{\"txid\" : \"mytxid\",\"vout\":0}]" "{\"myaddress\":0.01}" +Sign the transaction, and get back the hex +> bitcoin-cli signrawtransaction "myhex" + +Send the transaction (signed hex) +> bitcoin-cli sendrawtransaction "signedhex" + +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/ + + diff --git a/_doc/en/0.16.3/rpc/rawtransactions/signrawtransaction.html b/_doc/en/0.16.3/rpc/rawtransactions/signrawtransaction.html new file mode 100644 index 000000000..1ba245771 --- /dev/null +++ b/_doc/en/0.16.3/rpc/rawtransactions/signrawtransaction.html @@ -0,0 +1,63 @@ +--- +name: signrawtransaction +btcversion: 0.16.3 +btcgroup: rawtransactions +permalink: en/doc/0.16.3/rpc/rawtransactions/signrawtransaction/ +--- + +signrawtransaction "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] ["privatekey1",...] sighashtype ) + +Sign inputs for raw transaction (serialized, hex-encoded). +The second optional argument (may be null) is an array of previous transaction outputs that +this transaction depends on but may not yet be in the block chain. +The third optional argument (may be null) is an array of base58-encoded private +keys that, if given, will be the only keys used to sign the transaction. + + +Arguments: +1. "hexstring" (string, required) The transaction hex string +2. "prevtxs" (string, optional) An json array of previous dependent transaction outputs + [ (json array of json objects, or 'null' if none provided) + { + "txid":"id", (string, required) The transaction id + "vout":n, (numeric, required) The output number + "scriptPubKey": "hex", (string, required) script key + "redeemScript": "hex", (string, required for P2SH or P2WSH) redeem script + "amount": value (numeric, required) The amount spent + } + ,... + ] +3. "privkeys" (string, optional) A json array of base58-encoded private keys for signing + [ (json array of strings, or 'null' if none provided) + "privatekey" (string) private key in base58-encoding + ,... + ] +4. "sighashtype" (string, optional, default=ALL) The signature hash type. Must be one of + "ALL" + "NONE" + "SINGLE" + "ALL|ANYONECANPAY" + "NONE|ANYONECANPAY" + "SINGLE|ANYONECANPAY" + +Result: +{ + "hex" : "value", (string) The hex-encoded raw transaction with signature(s) + "complete" : true|false, (boolean) If the transaction has a complete set of signatures + "errors" : [ (json array of objects) Script verification errors (if there are any) + { + "txid" : "hash", (string) The hash of the referenced, previous transaction + "vout" : n, (numeric) The index of the output to spent and used as input + "scriptSig" : "hex", (string) The hex-encoded signature script + "sequence" : n, (numeric) Script sequence number + "error" : "text" (string) Verification or signing error related to the input + } + ,... + ] +} + +Examples: +> bitcoin-cli signrawtransaction "myhex" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/util/createmultisig.html b/_doc/en/0.16.3/rpc/util/createmultisig.html new file mode 100644 index 000000000..a434b5c94 --- /dev/null +++ b/_doc/en/0.16.3/rpc/util/createmultisig.html @@ -0,0 +1,38 @@ +--- +name: createmultisig +btcversion: 0.16.3 +btcgroup: util +permalink: en/doc/0.16.3/rpc/util/createmultisig/ +--- + +createmultisig nrequired ["key",...] + +Creates a multi-signature address with n signature of m keys required. +It returns a json object with the address and redeemScript. +DEPRECATION WARNING: Using addresses with createmultisig is deprecated. Clients must +transition to using addmultisigaddress to create multisig addresses with addresses known +to the wallet before upgrading to v0.17. To use the deprecated functionality, start bitcoind with -deprecatedrpc=createmultisig + +Arguments: +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 + [ + "key" (string) The hex-encoded public key + ,... + ] + +Result: +{ + "address":"multisigaddress", (string) The value of the new multisig address. + "redeemScript":"script" (string) The string value of the hex-encoded redemption script. +} + +Examples: + +Create a multisig address from 2 public keys +> bitcoin-cli createmultisig 2 "[\"03789ed0bb717d88f7d321a368d905e7430207ebbd82bd342cf11ae157a7ace5fd\",\"03dbc6764b8884a92e871274b87583e6d5c2a58819473e17e107ef3f6aa5a61626\"]" + +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/ + + diff --git a/_doc/en/0.16.3/rpc/util/estimatefee.html b/_doc/en/0.16.3/rpc/util/estimatefee.html new file mode 100644 index 000000000..419c70e6f --- /dev/null +++ b/_doc/en/0.16.3/rpc/util/estimatefee.html @@ -0,0 +1,29 @@ +--- +name: estimatefee +btcversion: 0.16.3 +btcgroup: util +permalink: en/doc/0.16.3/rpc/util/estimatefee/ +--- + +estimatefee nblocks + +DEPRECATED. Please use estimatesmartfee for more intelligent estimates. +Estimates the approximate fee per kilobyte needed for a transaction to begin +confirmation within nblocks blocks. Uses virtual transaction size of transaction +as defined in BIP 141 (witness data is discounted). + +Arguments: +1. nblocks (numeric, required) + +Result: +n (numeric) estimated fee-per-kilobyte + +A negative value is returned if not enough transactions and blocks +have been observed to make an estimate. +-1 is always returned for nblocks == 1 as it is impossible to calculate +a fee that is high enough to get reliably included in the next block. + +Example: +> bitcoin-cli estimatefee 6 + + diff --git a/_doc/en/0.16.3/rpc/util/estimatesmartfee.html b/_doc/en/0.16.3/rpc/util/estimatesmartfee.html new file mode 100644 index 000000000..b4c1df067 --- /dev/null +++ b/_doc/en/0.16.3/rpc/util/estimatesmartfee.html @@ -0,0 +1,42 @@ +--- +name: estimatesmartfee +btcversion: 0.16.3 +btcgroup: util +permalink: en/doc/0.16.3/rpc/util/estimatesmartfee/ +--- + +estimatesmartfee conf_target ("estimate_mode") + +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 +for which the estimate is valid. Uses virtual transaction size as defined +in BIP 141 (witness data is discounted). + +Arguments: +1. conf_target (numeric) Confirmation target in blocks (1 - 1008) +2. "estimate_mode" (string, optional, default=CONSERVATIVE) The fee estimate mode. + Whether to return a more conservative estimate which also satisfies + a longer history. A conservative estimate potentially returns a + higher feerate and is more likely to be sufficient for the desired + target, but is not as responsive to short term drops in the + prevailing fee market. Must be one of: + "UNSET" (defaults to CONSERVATIVE) + "ECONOMICAL" + "CONSERVATIVE" + +Result: +{ + "feerate" : x.x, (numeric, optional) estimate fee rate in BTC/kB + "errors": [ str... ] (json array of strings, optional) Errors encountered during processing + "blocks" : n (numeric) block number where estimate was found +} + +The request target will be clamped between 2 and the highest target +fee estimation is able to return based on how long it has been running. +An error is returned if not enough transactions and blocks +have been observed to make an estimate for any number of blocks. + +Example: +> bitcoin-cli estimatesmartfee 6 + + diff --git a/_doc/en/0.16.3/rpc/util/signmessagewithprivkey.html b/_doc/en/0.16.3/rpc/util/signmessagewithprivkey.html new file mode 100644 index 000000000..998b87f04 --- /dev/null +++ b/_doc/en/0.16.3/rpc/util/signmessagewithprivkey.html @@ -0,0 +1,30 @@ +--- +name: signmessagewithprivkey +btcversion: 0.16.3 +btcgroup: util +permalink: en/doc/0.16.3/rpc/util/signmessagewithprivkey/ +--- + +signmessagewithprivkey "privkey" "message" + +Sign a message with the private key of an address + +Arguments: +1. "privkey" (string, required) The private key to sign the message with. +2. "message" (string, required) The message to create a signature of. + +Result: +"signature" (string) The signature of the message encoded in base 64 + +Examples: + +Create the signature +> bitcoin-cli signmessagewithprivkey "privkey" "my message" + +Verify the signature +> bitcoin-cli verifymessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "signature" "my message" + +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/ + + diff --git a/_doc/en/0.16.3/rpc/util/validateaddress.html b/_doc/en/0.16.3/rpc/util/validateaddress.html new file mode 100644 index 000000000..c22a924a3 --- /dev/null +++ b/_doc/en/0.16.3/rpc/util/validateaddress.html @@ -0,0 +1,52 @@ +--- +name: validateaddress +btcversion: 0.16.3 +btcgroup: util +permalink: en/doc/0.16.3/rpc/util/validateaddress/ +--- + +validateaddress "address" + +Return information about the given bitcoin address. + +Arguments: +1. "address" (string, required) The bitcoin address to validate + +Result: +{ + "isvalid" : true|false, (boolean) If the address is valid or not. If not, this is the only property returned. + "address" : "address", (string) The bitcoin address validated + "scriptPubKey" : "hex", (string) The hex encoded scriptPubKey generated by the address + "ismine" : true|false, (boolean) If the address is yours or not + "iswatchonly" : true|false, (boolean) If the address is watchonly + "isscript" : true|false, (boolean, optional) If the address is P2SH or P2WSH. Not included for unknown witness types. + "iswitness" : true|false, (boolean) If the address is P2WPKH, P2WSH, or an unknown witness version + "witness_version" : version (number, optional) For all witness output types, gives the version number. + "witness_program" : "hex" (string, optional) For all witness output types, gives the script or key hash present in the address. + "script" : "type" (string, optional) The output script type. Only if "isscript" is true and the redeemscript is known. Possible types: nonstandard, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_keyhash, witness_v0_scripthash, witness_unknown + "hex" : "hex", (string, optional) The redeemscript for the P2SH or P2WSH address + "addresses" (string, optional) Array of addresses associated with the known redeemscript (only if "iswitness" is false). This field is superseded by the "pubkeys" field and the address inside "embedded". + [ + "address" + ,... + ] + "pubkeys" (string, optional) Array of pubkeys associated with the known redeemscript (only if "script" is "multisig") + [ + "pubkey" + ,... + ] + "sigsrequired" : xxxxx (numeric, optional) Number of signatures required to spend multisig output (only if "script" is "multisig") + "pubkey" : "publickeyhex", (string, optional) The hex value of the raw public key, for single-key addresses (possibly embedded in P2SH or P2WSH) + "embedded" : {...}, (object, optional) information about the address embedded in P2SH or P2WSH, if relevant and known. It includes all validateaddress output fields for the embedded address, excluding "isvalid", metadata ("timestamp", "hdkeypath", "hdmasterkeyid") and relation to the wallet ("ismine", "iswatchonly", "account"). + "iscompressed" : true|false, (boolean) If the address is compressed + "account" : "account" (string) DEPRECATED. The account associated with the address, "" is the default account + "timestamp" : timestamp, (number, optional) The creation time of the key if available in seconds since epoch (Jan 1 1970 GMT) + "hdkeypath" : "keypath" (string, optional) The HD keypath if the key is HD and available + "hdmasterkeyid" : "" (string, optional) The Hash160 of the HD master pubkey +} + +Examples: +> bitcoin-cli validateaddress "1PSSGeFHDnKNxiEyFrD1wcEaHr9hrQDDWc" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "validateaddress", "params": ["1PSSGeFHDnKNxiEyFrD1wcEaHr9hrQDDWc"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ + + diff --git a/_doc/en/0.16.3/rpc/util/verifymessage.html b/_doc/en/0.16.3/rpc/util/verifymessage.html new file mode 100644 index 000000000..f655aab37 --- /dev/null +++ b/_doc/en/0.16.3/rpc/util/verifymessage.html @@ -0,0 +1,34 @@ +--- +name: verifymessage +btcversion: 0.16.3 +btcgroup: util +permalink: en/doc/0.16.3/rpc/util/verifymessage/ +--- + +verifymessage "address" "signature" "message" + +Verify a signed message + +Arguments: +1. "address" (string, required) The bitcoin address to use for the signature. +2. "signature" (string, required) The signature provided by the signer in base 64 encoding (see signmessage). +3. "message" (string, required) The message that was signed. + +Result: +true|false (boolean) If the signature is verified or not. + +Examples: + +Unlock the wallet for 30 seconds +> bitcoin-cli walletpassphrase "mypassphrase" 30 + +Create the signature +> bitcoin-cli signmessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "my message" + +Verify the signature +> bitcoin-cli verifymessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "signature" "my message" + +As json rpc +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "verifymessage", "params": ["1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX", "signature", "my message"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/abandontransaction.html b/_doc/en/0.16.3/rpc/wallet/abandontransaction.html new file mode 100644 index 000000000..68debbba8 --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/abandontransaction.html @@ -0,0 +1,25 @@ +--- +name: abandontransaction +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/abandontransaction/ +--- + +abandontransaction "txid" + +Mark in-wallet transaction as abandoned +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. +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. + +Arguments: +1. "txid" (string, required) The transaction id + +Result: + +Examples: +> bitcoin-cli abandontransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/abortrescan.html b/_doc/en/0.16.3/rpc/wallet/abortrescan.html new file mode 100644 index 000000000..a7098f037 --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/abortrescan.html @@ -0,0 +1,23 @@ +--- +name: abortrescan +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/abortrescan/ +--- + +abortrescan + +Stops current wallet rescan triggered by an RPC call, e.g. by an importprivkey call. + +Examples: + +Import a private key +> bitcoin-cli importprivkey "mykey" + +Abort the running wallet rescan +> bitcoin-cli abortrescan + +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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/addmultisigaddress.html b/_doc/en/0.16.3/rpc/wallet/addmultisigaddress.html new file mode 100644 index 000000000..880d19337 --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/addmultisigaddress.html @@ -0,0 +1,44 @@ +--- +name: addmultisigaddress +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/addmultisigaddress/ +--- + +addmultisigaddress nrequired ["key",...] ( "account" "address_type" ) + +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. +This functionality is only intended for use with non-watchonly addresses. +See `importaddress` for watchonly p2sh address support. +If 'account' is specified (DEPRECATED), assign address to that account. + +Arguments: +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 + [ + "address" (string) bitcoin address or hex-encoded public key + ..., + ] +3. "account" (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. + +Result: +{ + "address":"multisigaddress", (string) The value of the new multisig address. + "redeemScript":"script" (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). + clients should transition to the new output api before upgrading to v0.17. +"address" (string) A bitcoin address associated with the keys. + +Examples: + +Add a multisig address from 2 addresses +> bitcoin-cli addmultisigaddress 2 "[\"16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\",\"171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\"]" + +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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/backupwallet.html b/_doc/en/0.16.3/rpc/wallet/backupwallet.html new file mode 100644 index 000000000..601da89c8 --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/backupwallet.html @@ -0,0 +1,19 @@ +--- +name: backupwallet +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/backupwallet/ +--- + +backupwallet "destination" + +Safely copies current wallet file to destination, which can be a directory or a path with filename. + +Arguments: +1. "destination" (string) The destination directory or file + +Examples: +> bitcoin-cli backupwallet "backup.dat" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/bumpfee.html b/_doc/en/0.16.3/rpc/wallet/bumpfee.html new file mode 100644 index 000000000..2cf786383 --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/bumpfee.html @@ -0,0 +1,57 @@ +--- +name: bumpfee +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/bumpfee/ +--- + +bumpfee "txid" ( options ) + +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. +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 +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. +By default, the new fee will be calculated automatically using 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. +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. + +Arguments: +1. txid (string, required) The txid to be bumped +2. options (object, optional) + { + "confTarget" (numeric, optional) Confirmation target (in blocks) + "totalFee" (numeric, optional) Total fee (NOT feerate) to pay, in satoshis. + 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 + the dust threshold. + "replaceable" (boolean, optional, default true) Whether the new transaction should still be + 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 + 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 + still be replaceable in practice, for example if it has unconfirmed ancestors which + are replaceable). + "estimate_mode" (string, optional, default=UNSET) The fee estimate mode, must be one of: + "UNSET" + "ECONOMICAL" + "CONSERVATIVE" + } + +Result: +{ + "txid": "value", (string) The id of the new transaction + "origfee": n, (numeric) Fee of the replaced transaction + "fee": n, (numeric) Fee of the new transaction + "errors": [ str... ] (json array of strings) Errors encountered during processing (may be empty) +} + +Examples: + +Bump the fee, get the new transaction's txid +> bitcoin-cli bumpfee + + diff --git a/_doc/en/0.16.3/rpc/wallet/dumpprivkey.html b/_doc/en/0.16.3/rpc/wallet/dumpprivkey.html new file mode 100644 index 000000000..33c0843e9 --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/dumpprivkey.html @@ -0,0 +1,24 @@ +--- +name: dumpprivkey +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/dumpprivkey/ +--- + +dumpprivkey "address" + +Reveals the private key corresponding to 'address'. +Then the importprivkey can be used with this output + +Arguments: +1. "address" (string, required) The bitcoin address for the private key + +Result: +"key" (string) The private key + +Examples: +> bitcoin-cli dumpprivkey "myaddress" +> bitcoin-cli importprivkey "mykey" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/dumpwallet.html b/_doc/en/0.16.3/rpc/wallet/dumpwallet.html new file mode 100644 index 000000000..8423d758d --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/dumpwallet.html @@ -0,0 +1,27 @@ +--- +name: dumpwallet +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/dumpwallet/ +--- + +dumpwallet "filename" + +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. +Note that if your wallet contains keys which are not derived from your HD seed (e.g. imported keys), these are not covered by +only backing up the seed itself, and must be backed up too (e.g. ensure you back up the whole dumpfile). + +Arguments: +1. "filename" (string, required) The filename with path (either absolute or relative to bitcoind) + +Result: +{ (json object) + "filename" : { (string) The filename with full absolute path +} + +Examples: +> bitcoin-cli dumpwallet "test" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/encryptwallet.html b/_doc/en/0.16.3/rpc/wallet/encryptwallet.html new file mode 100644 index 000000000..30ff93d39 --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/encryptwallet.html @@ -0,0 +1,37 @@ +--- +name: encryptwallet +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/encryptwallet/ +--- + +encryptwallet "passphrase" + +Encrypts the wallet with 'passphrase'. This is for first time encryption. +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. +Use the walletpassphrase call for this, and then walletlock call. +If the wallet is already encrypted, use the walletpassphrasechange call. +Note that this will shutdown the server. + +Arguments: +1. "passphrase" (string) The pass phrase to encrypt the wallet with. It must be at least 1 character, but should be long. + +Examples: + +Encrypt your wallet +> bitcoin-cli encryptwallet "my pass phrase" + +Now set the passphrase to use the wallet, such as for signing or sending bitcoin +> bitcoin-cli walletpassphrase "my pass phrase" + +Now we can do something like sign +> bitcoin-cli signmessage "address" "test message" + +Now lock the wallet again by removing the passphrase +> bitcoin-cli walletlock + +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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/getaccount.html b/_doc/en/0.16.3/rpc/wallet/getaccount.html new file mode 100644 index 000000000..6e8cb28a9 --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/getaccount.html @@ -0,0 +1,22 @@ +--- +name: getaccount +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/getaccount/ +--- + +getaccount "address" + +DEPRECATED. Returns the account associated with the given address. + +Arguments: +1. "address" (string, required) The bitcoin address for account lookup. + +Result: +"accountname" (string) the account address + +Examples: +> bitcoin-cli getaccount "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/getaccountaddress.html b/_doc/en/0.16.3/rpc/wallet/getaccountaddress.html new file mode 100644 index 000000000..cf9738b9b --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/getaccountaddress.html @@ -0,0 +1,24 @@ +--- +name: getaccountaddress +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/getaccountaddress/ +--- + +getaccountaddress "account" + +DEPRECATED. Returns the current Bitcoin address for receiving payments to this account. + +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. + +Result: +"address" (string) The account bitcoin address + +Examples: +> bitcoin-cli getaccountaddress +> bitcoin-cli getaccountaddress "" +> bitcoin-cli getaccountaddress "myaccount" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/getaddressesbyaccount.html b/_doc/en/0.16.3/rpc/wallet/getaddressesbyaccount.html new file mode 100644 index 000000000..bfc676673 --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/getaddressesbyaccount.html @@ -0,0 +1,25 @@ +--- +name: getaddressesbyaccount +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/getaddressesbyaccount/ +--- + +getaddressesbyaccount "account" + +DEPRECATED. Returns the list of addresses for the given account. + +Arguments: +1. "account" (string, required) The account name. + +Result: +[ (json array of string) + "address" (string) a bitcoin address associated with the given account + ,... +] + +Examples: +> bitcoin-cli getaddressesbyaccount "tabby" +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/getbalance.html b/_doc/en/0.16.3/rpc/wallet/getbalance.html new file mode 100644 index 000000000..81b7fd77b --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/getbalance.html @@ -0,0 +1,47 @@ +--- +name: getbalance +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/getbalance/ +--- + +getbalance ( "account" minconf include_watchonly ) + +If account is not specified, returns the server's total available balance. +The available balance is what the wallet considers currently spendable, and is +thus affected by options which limit spendability such as -spendzeroconfchange. +If account is specified (DEPRECATED), returns the balance in the account. +Note that the account "" is not the same as leaving the parameter out. +The server total may be different to the balance in the default "" account. + +Arguments: +1. "account" (string, optional) DEPRECATED. The account string may be given as a + specific account name to find the balance associated with wallet keys in + a named account, or as the empty string ("") to find the balance + associated with wallet keys not in any named account, or as "*" to find + the balance associated with all wallet keys regardless of account. + 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 + there are conflicting pending transactions (such as those created by + the bumpfee command), temporarily resulting in low or even negative + balances. In general, account balance calculation is not considered + reliable and has resulted in confusing outcomes, so it is recommended to + avoid passing this argument. +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') + +Result: +amount (numeric) The total amount in BTC received for this account. + +Examples: + +The total amount in the wallet with 1 or more confirmations +> bitcoin-cli getbalance + +The total amount in the wallet at least 6 blocks confirmed +> bitcoin-cli getbalance "*" 6 + +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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/getnewaddress.html b/_doc/en/0.16.3/rpc/wallet/getnewaddress.html new file mode 100644 index 000000000..dcbb484bd --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/getnewaddress.html @@ -0,0 +1,25 @@ +--- +name: getnewaddress +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/getnewaddress/ +--- + +getnewaddress ( "account" "address_type" ) + +Returns a new Bitcoin address for receiving payments. +If 'account' is specified (DEPRECATED), it is added to the address book +so payments received with the address will be credited to 'account'. + +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. +2. "address_type" (string, optional) The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -addresstype. + +Result: +"address" (string) The new bitcoin address + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/getrawchangeaddress.html b/_doc/en/0.16.3/rpc/wallet/getrawchangeaddress.html new file mode 100644 index 000000000..d53220924 --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/getrawchangeaddress.html @@ -0,0 +1,23 @@ +--- +name: getrawchangeaddress +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/getrawchangeaddress/ +--- + +getrawchangeaddress ( "address_type" ) + +Returns a new Bitcoin address, for receiving change. +This is for use with raw transactions, NOT normal use. + +Arguments: +1. "address_type" (string, optional) The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -changetype. + +Result: +"address" (string) The address + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/getreceivedbyaccount.html b/_doc/en/0.16.3/rpc/wallet/getreceivedbyaccount.html new file mode 100644 index 000000000..28326ce40 --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/getreceivedbyaccount.html @@ -0,0 +1,33 @@ +--- +name: getreceivedbyaccount +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/getreceivedbyaccount/ +--- + +getreceivedbyaccount "account" ( minconf ) + +DEPRECATED. Returns the total amount received by addresses with in transactions with at least [minconf] confirmations. + +Arguments: +1. "account" (string, required) The selected account, may be the default account using "". +2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times. + +Result: +amount (numeric) The total amount in BTC received for this account. + +Examples: + +Amount received by the default account with at least 1 confirmation +> bitcoin-cli getreceivedbyaccount "" + +Amount received at the tabby account including unconfirmed amounts with zero confirmations +> bitcoin-cli getreceivedbyaccount "tabby" 0 + +The amount with at least 6 confirmations +> bitcoin-cli getreceivedbyaccount "tabby" 6 + +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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/getreceivedbyaddress.html b/_doc/en/0.16.3/rpc/wallet/getreceivedbyaddress.html new file mode 100644 index 000000000..84c8013a5 --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/getreceivedbyaddress.html @@ -0,0 +1,33 @@ +--- +name: getreceivedbyaddress +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/getreceivedbyaddress/ +--- + +getreceivedbyaddress "address" ( minconf ) + +Returns the total amount received by the given address in transactions with at least minconf confirmations. + +Arguments: +1. "address" (string, required) The bitcoin address for transactions. +2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times. + +Result: +amount (numeric) The total amount in BTC received at this address. + +Examples: + +The amount from transactions with at least 1 confirmation +> bitcoin-cli getreceivedbyaddress "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" + +The amount including unconfirmed transactions, zero confirmations +> bitcoin-cli getreceivedbyaddress "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" 0 + +The amount with at least 6 confirmations +> bitcoin-cli getreceivedbyaddress "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" 6 + +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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/gettransaction.html b/_doc/en/0.16.3/rpc/wallet/gettransaction.html new file mode 100644 index 000000000..297753ac1 --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/gettransaction.html @@ -0,0 +1,53 @@ +--- +name: gettransaction +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/gettransaction/ +--- + +gettransaction "txid" ( include_watchonly ) + +Get detailed information about in-wallet transaction + +Arguments: +1. "txid" (string, required) The transaction id +2. "include_watchonly" (bool, optional, default=false) Whether to include watch-only addresses in balance calculation and details[] + +Result: +{ + "amount" : 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 + 'send' category of transactions. + "confirmations" : n, (numeric) The number of confirmations + "blockhash" : "hash", (string) The block hash + "blockindex" : 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) + "txid" : "transactionid", (string) The transaction id. + "time" : 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) + "bip125-replaceable": "yes|no|unknown", (string) Whether this transaction could be replaced due to BIP125 (replace-by-fee); + may be unknown for unconfirmed transactions not in the mempool + "details" : [ + { + "account" : "accountname", (string) DEPRECATED. The account name involved in the transaction, can be "" for the default account. + "address" : "address", (string) The bitcoin address involved in the transaction + "category" : "send|receive", (string) The category, either 'send' or 'receive' + "amount" : x.xxx, (numeric) The amount in BTC + "label" : "label", (string) A comment for the address/transaction, if any + "vout" : 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. + "abandoned": xxx (bool) 'true' if the transaction has been abandoned (inputs are respendable). Only available for the + 'send' category of transactions. + } + ,... + ], + "hex" : "data" (string) Raw data for transaction +} + +Examples: +> bitcoin-cli gettransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" +> bitcoin-cli gettransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" 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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/getunconfirmedbalance.html b/_doc/en/0.16.3/rpc/wallet/getunconfirmedbalance.html new file mode 100644 index 000000000..e1b87c8ac --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/getunconfirmedbalance.html @@ -0,0 +1,11 @@ +--- +name: getunconfirmedbalance +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/getunconfirmedbalance/ +--- + +getunconfirmedbalance +Returns the server's total unconfirmed balance + + diff --git a/_doc/en/0.16.3/rpc/wallet/getwalletinfo.html b/_doc/en/0.16.3/rpc/wallet/getwalletinfo.html new file mode 100644 index 000000000..c3346b682 --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/getwalletinfo.html @@ -0,0 +1,31 @@ +--- +name: getwalletinfo +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/getwalletinfo/ +--- + +getwalletinfo +Returns an object containing various wallet state info. + +Result: +{ + "walletname": xxxxx, (string) the wallet name + "walletversion": xxxxx, (numeric) the wallet version + "balance": xxxxxxx, (numeric) the total confirmed balance of the wallet in BTC + "unconfirmed_balance": xxx, (numeric) the total unconfirmed balance of the wallet in BTC + "immature_balance": xxxxxx, (numeric) the total immature balance of the wallet in BTC + "txcount": 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 + "keypoolsize": 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) + "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 + "paytxfee": x.xxxx, (numeric) the transaction fee configuration, set in BTC/kB + "hdmasterkeyid": "" (string, optional) the Hash160 of the HD master pubkey (only present when HD is enabled) +} + +Examples: +> 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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/importaddress.html b/_doc/en/0.16.3/rpc/wallet/importaddress.html new file mode 100644 index 000000000..cc0086545 --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/importaddress.html @@ -0,0 +1,36 @@ +--- +name: importaddress +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/importaddress/ +--- + +importaddress "address" ( "label" 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. + +Arguments: +1. "script" (string, required) The hex-encoded script (or address) +2. "label" (string, optional, default="") An optional label +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 + +Note: This call can take minutes to complete if rescan is true, during that time, other rpc calls +may report that the imported address exists but related transactions are still missing, leading to temporarily incorrect/bogus balances and unspent outputs until rescan completes. +If you have the full public key, you should call importpubkey instead of this. + +Note: If you import a non-standard raw script in hex form, outputs sending to it will be treated +as change, and not show up in many RPCs. + +Examples: + +Import a script with rescan +> bitcoin-cli importaddress "myscript" + +Import using a label without rescan +> bitcoin-cli importaddress "myscript" "testing" false + +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/ + + diff --git a/_doc/en/0.16.3/rpc/wallet/importmulti.html b/_doc/en/0.16.3/rpc/wallet/importmulti.html new file mode 100644 index 000000000..f4b45bc9b --- /dev/null +++ b/_doc/en/0.16.3/rpc/wallet/importmulti.html @@ -0,0 +1,47 @@ +--- +name: importmulti +btcversion: 0.16.3 +btcgroup: wallet +permalink: en/doc/0.16.3/rpc/wallet/importmulti/ +--- + +importmulti "requests" ( "options" ) + +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. + +Arguments: +1. requests (array, required) Data to be imported + [ (array of json objects) + { + "scriptPubKey": "