diff --git a/_doc/en/22.1.1/index.html b/_doc/en/22.1.1/index.html new file mode 100644 index 0000000..7736c37 --- /dev/null +++ b/_doc/en/22.1.1/index.html @@ -0,0 +1,9 @@ +--- +layout: doc +name: index +elemversion: 22.1.1 +elemgroup: index +permalink: /en/doc/22.1.1/ +--- + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getbestblockhash.html b/_doc/en/22.1.1/rpc/blockchain/getbestblockhash.html new file mode 100644 index 0000000..21ccca1 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getbestblockhash.html @@ -0,0 +1,20 @@ +--- +layout: doc +name: getbestblockhash +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/getbestblockhash/ +--- + +getbestblockhash + +Returns the hash of the best (tip) block in the most-work fully-validated chain. + +Result: +"hex" (string) the block hash, hex-encoded + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getblock.html b/_doc/en/22.1.1/rpc/blockchain/getblock.html new file mode 100644 index 0000000..a371040 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getblock.html @@ -0,0 +1,79 @@ +--- +layout: doc +name: getblock +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/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): +"hex" (string) A string that is serialized, hex-encoded data for block 'hash' + +Result (for verbosity = 1): +{ (json object) + "hash" : "hex", (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" : "hex", (string) The block version formatted in hexadecimal + "merkleroot" : "hex", (string) The merkle root + "tx" : [ (json array) The transaction ids + "hex", (string) The transaction id + ... + ], + "time" : xxx, (numeric) The block time expressed in UNIX epoch time + "mediantime" : xxx, (numeric) The median block time expressed in UNIX epoch time + "nonce" : n, (numeric) The nonce + "bits" : "hex", (string) The bits + "difficulty" : n, (numeric) The difficulty + "chainwork" : "hex", (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 + "signblock_witness_asm" : "str", (string) ASM of sign block witness data + "signblock_witness_hex" : "hex", (string) Hex of sign block witness data + "dynamic_parameters" : { (json object) Dynamic federation parameters in the block, if any + "current" : { (json object) enforced dynamic federation parameters. The signblockscript is published for each block, while others are published only at epoch start + "signblockscript" : "hex", (string) signblock script + "max_block_witness" : n, (numeric) Maximum serialized size of the block witness stack + "fedpegscript" : "hex", (string) fedpeg script + "extension_space" : [ (json array) array of hex-encoded strings + ... + ] + }, + "proposed" : { (json object) Proposed parameters. Uninforced. Must be published in full + ... same entries as current + } + }, + "previousblockhash" : "hex", (string, optional) The hash of the previous block (if available) + "nextblockhash" : "hex" (string, optional) The hash of the next block (if available) +} + +Result (for verbosity = 2): +{ (json object) + ..., Same output as verbosity = 1 + "tx" : [ (json array) + { (json object) + ..., The transactions in the format of the getrawtransaction RPC. Different from verbosity = 1 "tx" result + "fee" : n (numeric) The transaction fee in BTC, omitted if block undo data is not available + }, + ... + ] +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getblockchaininfo.html b/_doc/en/22.1.1/rpc/blockchain/getblockchaininfo.html new file mode 100644 index 0000000..baa1cd0 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getblockchaininfo.html @@ -0,0 +1,70 @@ +--- +layout: doc +name: getblockchaininfo +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/getblockchaininfo/ +--- + +getblockchaininfo +Returns an object containing various state info regarding blockchain processing. + +Result: +{ (json object) + "chain" : "str", (string) current network name (main, test, signet, regtest) + "blocks" : n, (numeric) the height of the most-work fully-validated chain. The genesis block has height 0 + "headers" : n, (numeric) the current number of headers we have validated + "bestblockhash" : "str", (string) the hash of the currently best block + "difficulty" : n, (numeric) the current difficulty + "mediantime" : n, (numeric) median time for the current best block + "verificationprogress" : n, (numeric) estimate of verification progress [0..1] + "initialblockdownload" : true|false, (boolean) (debug information) estimate of whether this node is in Initial Block Download mode + "chainwork" : "hex", (string) total amount of work in active chain, in hexadecimal + "size_on_disk" : n, (numeric) the estimated size of the block and undo files on disk + "pruned" : true|false, (boolean) if the blocks are subject to pruning + "current_params_root" : "hex", (string) the root of the currently active dynafed params + "signblock_asm" : "str", (string) ASM of sign block challenge data from genesis block + "signblock_hex" : "hex", (string) Hex of sign block challenge data from genesis block + "current_signblock_asm" : "str", (string) ASM of sign block challenge data enforced on the next block + "current_signblock_hex" : "hex", (string) Hex of sign block challenge data enforced on the next block + "max_block_witness" : n, (numeric) maximum sized block witness serialized size for the next block + "epoch_length" : n, (numeric) length of dynamic federations epoch, or signaling period + "total_valid_epochs" : n, (numeric) number of epochs a given fedpscript is valid for, defined per chain + "epoch_age" : n, (numeric) number of blocks into a dynamic federation epoch chain tip is. This number is between 0 to epoch_length-1 + "extension_space" : [ (json array) array of extension fields in dynamic blockheader + ... + ], + "pruneheight" : n, (numeric) lowest-height complete block stored (only present if pruning is enabled) + "automatic_pruning" : true|false, (boolean) whether automatic pruning is enabled (only present if pruning is enabled) + "prune_target_size" : n, (numeric) the target size used by pruning (only present if automatic pruning is enabled) + "softforks" : { (json object) status of softforks + "xxxx" : { (json object) name of the softfork + "type" : "str", (string) one of "buried", "bip9" + "bip9" : { (json object) status of bip9 softforks (only for "bip9" type) + "status" : "str", (string) one of "defined", "started", "locked_in", "active", "failed" + "bit" : n, (numeric) the bit (0-28) in the block version field used to signal this softfork (only for "started" status) + "start_time" : xxx, (numeric) the minimum median time past of a block at which the bit gains its meaning + "timeout" : xxx, (numeric) the median time past of a block at which the deployment is considered failed if not yet locked in + "since" : n, (numeric) height of the first block to which the status applies + "min_activation_height" : n, (numeric) minimum height of blocks for which the rules may be enforced + "statistics" : { (json object) numeric statistics about BIP9 signalling for a softfork (only for "started" status) + "period" : n, (numeric) the length in blocks of the BIP9 signalling period + "threshold" : n, (numeric) the number of blocks with the version bit set required to activate the feature + "elapsed" : n, (numeric) the number of blocks elapsed since the beginning of the current period + "count" : n, (numeric) the number of blocks with the version bit set in the current period + "possible" : true|false (boolean) returns false if there are not enough blocks left in this period to pass activation threshold + } + }, + "height" : n, (numeric) height of the first block which the rules are or will be enforced (only for "buried" type, or "bip9" type with "active" status) + "active" : true|false (boolean) true if the rules are enforced for the mempool and the next block + }, + ... + }, + "warnings" : "str" (string) any network and blockchain warnings +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getblockcount.html b/_doc/en/22.1.1/rpc/blockchain/getblockcount.html new file mode 100644 index 0000000..703191c --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getblockcount.html @@ -0,0 +1,21 @@ +--- +layout: doc +name: getblockcount +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/getblockcount/ +--- + +getblockcount + +Returns the height of the most-work fully-validated chain. +The genesis block has height 0. + +Result: +n (numeric) The current block count + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getblockfilter.html b/_doc/en/22.1.1/rpc/blockchain/getblockfilter.html new file mode 100644 index 0000000..66876a9 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getblockfilter.html @@ -0,0 +1,27 @@ +--- +layout: doc +name: getblockfilter +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/getblockfilter/ +--- + +getblockfilter "blockhash" ( "filtertype" ) + +Retrieve a BIP 157 content filter for a particular block. + +Arguments: +1. blockhash (string, required) The hash of the block +2. filtertype (string, optional, default="basic") The type name of the filter + +Result: +{ (json object) + "filter" : "hex", (string) the hex-encoded filter data + "header" : "hex" (string) the hex-encoded filter header +} + +Examples: +> elements-cli getblockfilter "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09" "basic" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getblockfilter", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09", "basic"]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getblockhash.html b/_doc/en/22.1.1/rpc/blockchain/getblockhash.html new file mode 100644 index 0000000..ba7dc9c --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getblockhash.html @@ -0,0 +1,23 @@ +--- +layout: doc +name: getblockhash +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/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: +"hex" (string) The block hash + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getblockheader.html b/_doc/en/22.1.1/rpc/blockchain/getblockheader.html new file mode 100644 index 0000000..a63cc54 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getblockheader.html @@ -0,0 +1,59 @@ +--- +layout: doc +name: getblockheader +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/getblockheader/ +--- + +getblockheader "blockhash" ( 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. blockhash (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): +{ (json object) + "hash" : "hex", (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" : "hex", (string) The block version formatted in hexadecimal + "merkleroot" : "hex", (string) The merkle root + "time" : xxx, (numeric) The block time expressed in UNIX epoch time + "mediantime" : xxx, (numeric) The median block time expressed in UNIX epoch time + "nonce" : n, (numeric) The nonce + "bits" : "hex", (string) The bits + "difficulty" : n, (numeric) The difficulty + "chainwork" : "hex", (string) Expected number of hashes required to produce the current chain + "nTx" : n, (numeric) The number of transactions in the block + "signblock_witness_asm" : "str", (string) ASM of sign block witness data + "signblock_witness_hex" : "hex", (string) Hex of sign block witness data + "dynamic_parameters" : { (json object) Dynamic federation parameters in the block, if any + "current" : { (json object) enforced dynamic federation parameters. The signblockscript is published for each block, while others are published only at epoch start + "signblockscript" : "hex", (string) signblock script + "max_block_witness" : n, (numeric) Maximum serialized size of the block witness stack + "fedpegscript" : "hex", (string) fedpeg script + "extension_space" : [ (json array) array of hex-encoded strings + ... + ] + }, + "proposed" : { (json object) Proposed parameters. Uninforced. Must be published in full + ... same entries as current + } + }, + "previousblockhash" : "hex", (string, optional) The hash of the previous block (if available) + "nextblockhash" : "hex" (string, optional) The hash of the next block (if available) +} + +Result (for verbose=false): +"hex" (string) A string that is serialized, hex-encoded data for block 'hash' + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getblockstats.html b/_doc/en/22.1.1/rpc/blockchain/getblockstats.html new file mode 100644 index 0000000..823df72 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getblockstats.html @@ -0,0 +1,68 @@ +--- +layout: doc +name: getblockstats +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/getblockstats/ +--- + +getblockstats hash_or_height ( stats ) + +Compute per block statistics for a given window. All amounts are in satoshis. +It won't work for some heights with pruning. + +Arguments: +1. hash_or_height (string or numeric, required) The block hash or height of the target block +2. stats (json array, optional, default=all values) Values to plot (see result below) + [ + "height", (string) Selected statistic + "time", (string) Selected statistic + ... + ] + +Result: +{ (json object) + "avgfee" : n, (numeric) Average fee in the block + "avgfeerate" : n, (numeric) Average feerate (in satoshis per virtual byte) + "avgtxsize" : n, (numeric) Average transaction size + "blockhash" : "hex", (string) The block hash (to check for potential reorgs) + "feerate_percentiles" : [ (json array) Feerates at the 10th, 25th, 50th, 75th, and 90th percentile weight unit (in satoshis per virtual byte) + n, (numeric) The 10th percentile feerate + n, (numeric) The 25th percentile feerate + n, (numeric) The 50th percentile feerate + n, (numeric) The 75th percentile feerate + n (numeric) The 90th percentile feerate + ], + "height" : n, (numeric) The height of the block + "ins" : n, (numeric) The number of inputs (excluding coinbase) + "maxfee" : n, (numeric) Maximum fee in the block + "maxfeerate" : n, (numeric) Maximum feerate (in satoshis per virtual byte) + "maxtxsize" : n, (numeric) Maximum transaction size + "medianfee" : n, (numeric) Truncated median fee in the block + "mediantime" : n, (numeric) The block median time past + "mediantxsize" : n, (numeric) Truncated median transaction size + "minfee" : n, (numeric) Minimum fee in the block + "minfeerate" : n, (numeric) Minimum feerate (in satoshis per virtual byte) + "mintxsize" : n, (numeric) Minimum transaction size + "outs" : n, (numeric) The number of outputs + "subsidy" : n, (numeric) The block subsidy + "swtotal_size" : n, (numeric) Total size of all segwit transactions + "swtotal_weight" : n, (numeric) Total weight of all segwit transactions + "swtxs" : n, (numeric) The number of segwit transactions + "time" : n, (numeric) The block time + "total_out" : n, (numeric) Total amount in all outputs (excluding coinbase and thus reward [ie subsidy + totalfee]) + "total_size" : n, (numeric) Total size of all non-coinbase transactions + "total_weight" : n, (numeric) Total weight of all non-coinbase transactions + "totalfee" : n, (numeric) The fee total + "txs" : n, (numeric) The number of transactions (including coinbase) + "utxo_increase" : n, (numeric) The increase/decrease in the number of unspent outputs + "utxo_size_inc" : n (numeric) The increase/decrease in size for the utxo index (not discounting op_return and similar) +} + +Examples: +> elements-cli getblockstats '"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"' '["minfeerate","avgfeerate"]' +> elements-cli getblockstats 1000 '["minfeerate","avgfeerate"]' +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getblockstats", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09", ["minfeerate","avgfeerate"]]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getblockstats", "params": [1000, ["minfeerate","avgfeerate"]]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getchaintips.html b/_doc/en/22.1.1/rpc/blockchain/getchaintips.html new file mode 100644 index 0000000..7277609 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getchaintips.html @@ -0,0 +1,33 @@ +--- +layout: doc +name: getchaintips +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/getchaintips/ +--- + +getchaintips +Return information about all known tips in the block tree, including the main chain as well as orphaned branches. + +Result: +[ (json array) + { (json object) + "height" : n, (numeric) height of the chain tip + "hash" : "hex", (string) block hash of the tip + "branchlen" : n, (numeric) zero for main chain, otherwise length of branch connecting the tip to the main chain + "status" : "str" (string) status of the chain, "active" for the main chain + 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: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getchaintxstats.html b/_doc/en/22.1.1/rpc/blockchain/getchaintxstats.html new file mode 100644 index 0000000..a70e23c --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getchaintxstats.html @@ -0,0 +1,33 @@ +--- +layout: doc +name: getchaintxstats +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/getchaintxstats/ +--- + +getchaintxstats ( nblocks "blockhash" ) + +Compute statistics about the total number and rate of transactions in the chain. + +Arguments: +1. nblocks (numeric, optional, default=one month) Size of the window in number of blocks +2. blockhash (string, optional, default=chain tip) The hash of the block that ends the window. + +Result: +{ (json object) + "time" : xxx, (numeric) The timestamp for the final block in the window, expressed in UNIX epoch time + "txcount" : n, (numeric) The total number of transactions in the chain up to that point + "window_final_block_hash" : "hex", (string) The hash of the final block in the window + "window_final_block_height" : n, (numeric) The height of the final block in the window. + "window_block_count" : n, (numeric) Size of the window in number of blocks + "window_tx_count" : n, (numeric, optional) The number of transactions in the window. Only returned if "window_block_count" is > 0 + "window_interval" : n, (numeric, optional) The elapsed time in the window in seconds. Only returned if "window_block_count" is > 0 + "txrate" : n (numeric, optional) The average rate of transactions per second in the window. Only returned if "window_interval" is > 0 +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getdifficulty.html b/_doc/en/22.1.1/rpc/blockchain/getdifficulty.html new file mode 100644 index 0000000..4b0e07f --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getdifficulty.html @@ -0,0 +1,20 @@ +--- +layout: doc +name: getdifficulty +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/getdifficulty/ +--- + +getdifficulty + +Returns the proof-of-work difficulty as a multiple of the minimum difficulty. + +Result: +n (numeric) the proof-of-work difficulty as a multiple of the minimum difficulty. + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getmempoolancestors.html b/_doc/en/22.1.1/rpc/blockchain/getmempoolancestors.html new file mode 100644 index 0000000..b802f1a --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getmempoolancestors.html @@ -0,0 +1,63 @@ +--- +layout: doc +name: getmempoolancestors +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/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) + "hex", (string) The transaction id of an in-mempool ancestor transaction + ... +] + +Result (for verbose = true): +{ (json object) + "transactionid" : { (json object) + "vsize" : 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. + "weight" : n, (numeric) transaction weight as defined in BIP 141. + "fee" : n, (numeric) transaction fee in BTC (DEPRECATED) + "modifiedfee" : n, (numeric) transaction fee with fee deltas used for mining priority (DEPRECATED) + "time" : xxx, (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) (DEPRECATED) + "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) (DEPRECATED) + "wtxid" : "hex", (string) hash of serialized transaction, including witness data + "fees" : { (json object) + "base" : n, (numeric) transaction fee in BTC + "modified" : n, (numeric) transaction fee with fee deltas used for mining priority in BTC + "ancestor" : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one) in BTC + "descendant" : n (numeric) modified fees (see above) of in-mempool descendants (including this one) in BTC + }, + "depends" : [ (json array) unconfirmed transactions used as inputs for this transaction + "hex", (string) parent transaction id + ... + ], + "spentby" : [ (json array) unconfirmed transactions spending outputs from this transaction + "hex", (string) child transaction id + ... + ], + "bip125-replaceable" : true|false, (boolean) Whether this transaction could be replaced due to BIP125 (replace-by-fee) + "unbroadcast" : true|false (boolean) Whether this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers) + }, + ... +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getmempooldescendants.html b/_doc/en/22.1.1/rpc/blockchain/getmempooldescendants.html new file mode 100644 index 0000000..8fe3fe3 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getmempooldescendants.html @@ -0,0 +1,63 @@ +--- +layout: doc +name: getmempooldescendants +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/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) + "hex", (string) The transaction id of an in-mempool descendant transaction + ... +] + +Result (for verbose = true): +{ (json object) + "transactionid" : { (json object) + "vsize" : 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. + "weight" : n, (numeric) transaction weight as defined in BIP 141. + "fee" : n, (numeric) transaction fee in BTC (DEPRECATED) + "modifiedfee" : n, (numeric) transaction fee with fee deltas used for mining priority (DEPRECATED) + "time" : xxx, (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) (DEPRECATED) + "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) (DEPRECATED) + "wtxid" : "hex", (string) hash of serialized transaction, including witness data + "fees" : { (json object) + "base" : n, (numeric) transaction fee in BTC + "modified" : n, (numeric) transaction fee with fee deltas used for mining priority in BTC + "ancestor" : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one) in BTC + "descendant" : n (numeric) modified fees (see above) of in-mempool descendants (including this one) in BTC + }, + "depends" : [ (json array) unconfirmed transactions used as inputs for this transaction + "hex", (string) parent transaction id + ... + ], + "spentby" : [ (json array) unconfirmed transactions spending outputs from this transaction + "hex", (string) child transaction id + ... + ], + "bip125-replaceable" : true|false, (boolean) Whether this transaction could be replaced due to BIP125 (replace-by-fee) + "unbroadcast" : true|false (boolean) Whether this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers) + }, + ... +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getmempoolentry.html b/_doc/en/22.1.1/rpc/blockchain/getmempoolentry.html new file mode 100644 index 0000000..b870ecc --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getmempoolentry.html @@ -0,0 +1,53 @@ +--- +layout: doc +name: getmempoolentry +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/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) + "vsize" : 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. + "weight" : n, (numeric) transaction weight as defined in BIP 141. + "fee" : n, (numeric) transaction fee in BTC (DEPRECATED) + "modifiedfee" : n, (numeric) transaction fee with fee deltas used for mining priority (DEPRECATED) + "time" : xxx, (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) (DEPRECATED) + "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) (DEPRECATED) + "wtxid" : "hex", (string) hash of serialized transaction, including witness data + "fees" : { (json object) + "base" : n, (numeric) transaction fee in BTC + "modified" : n, (numeric) transaction fee with fee deltas used for mining priority in BTC + "ancestor" : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one) in BTC + "descendant" : n (numeric) modified fees (see above) of in-mempool descendants (including this one) in BTC + }, + "depends" : [ (json array) unconfirmed transactions used as inputs for this transaction + "hex", (string) parent transaction id + ... + ], + "spentby" : [ (json array) unconfirmed transactions spending outputs from this transaction + "hex", (string) child transaction id + ... + ], + "bip125-replaceable" : true|false, (boolean) Whether this transaction could be replaced due to BIP125 (replace-by-fee) + "unbroadcast" : true|false (boolean) Whether this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers) +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getmempoolinfo.html b/_doc/en/22.1.1/rpc/blockchain/getmempoolinfo.html new file mode 100644 index 0000000..829c096 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getmempoolinfo.html @@ -0,0 +1,30 @@ +--- +layout: doc +name: getmempoolinfo +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/getmempoolinfo/ +--- + +getmempoolinfo + +Returns details on the active state of the TX memory pool. + +Result: +{ (json object) + "loaded" : true|false, (boolean) True if the mempool is fully loaded + "size" : n, (numeric) Current tx count + "bytes" : n, (numeric) Sum of all virtual transaction sizes as defined in BIP 141. Differs from actual serialized size because witness data is discounted + "usage" : n, (numeric) Total memory usage for the mempool + "total_fee" : n, (numeric) Total fees for the mempool in BTC, ignoring modified fees through prioritizetransaction + "maxmempool" : n, (numeric) Maximum memory usage for the mempool + "mempoolminfee" : n, (numeric) Minimum fee rate in BTC/kvB for tx to be accepted. Is the maximum of minrelaytxfee and minimum mempool fee + "minrelaytxfee" : n, (numeric) Current minimum relay fee for transactions + "unbroadcastcount" : n (numeric) Current number of transactions that haven't passed initial broadcast yet +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getrawmempool.html b/_doc/en/22.1.1/rpc/blockchain/getrawmempool.html new file mode 100644 index 0000000..5ab2cdc --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getrawmempool.html @@ -0,0 +1,74 @@ +--- +layout: doc +name: getrawmempool +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/getrawmempool/ +--- + +getrawmempool ( verbose mempool_sequence ) + +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 +2. mempool_sequence (boolean, optional, default=false) If verbose=false, returns a json object with transaction list and mempool sequence number attached. + +Result (for verbose = false): +[ (json array) + "hex", (string) The transaction id + ... +] + +Result (for verbose = true): +{ (json object) + "transactionid" : { (json object) + "vsize" : 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. + "weight" : n, (numeric) transaction weight as defined in BIP 141. + "fee" : n, (numeric) transaction fee in BTC (DEPRECATED) + "modifiedfee" : n, (numeric) transaction fee with fee deltas used for mining priority (DEPRECATED) + "time" : xxx, (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) (DEPRECATED) + "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) (DEPRECATED) + "wtxid" : "hex", (string) hash of serialized transaction, including witness data + "fees" : { (json object) + "base" : n, (numeric) transaction fee in BTC + "modified" : n, (numeric) transaction fee with fee deltas used for mining priority in BTC + "ancestor" : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one) in BTC + "descendant" : n (numeric) modified fees (see above) of in-mempool descendants (including this one) in BTC + }, + "depends" : [ (json array) unconfirmed transactions used as inputs for this transaction + "hex", (string) parent transaction id + ... + ], + "spentby" : [ (json array) unconfirmed transactions spending outputs from this transaction + "hex", (string) child transaction id + ... + ], + "bip125-replaceable" : true|false, (boolean) Whether this transaction could be replaced due to BIP125 (replace-by-fee) + "unbroadcast" : true|false (boolean) Whether this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers) + }, + ... +} + +Result (for verbose = false and mempool_sequence = true): +{ (json object) + "txids" : [ (json array) + "hex", (string) The transaction id + ... + ], + "mempool_sequence" : n (numeric) The mempool sequence value. +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/getsidechaininfo.html b/_doc/en/22.1.1/rpc/blockchain/getsidechaininfo.html new file mode 100644 index 0000000..a608216 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/getsidechaininfo.html @@ -0,0 +1,38 @@ +--- +layout: doc +name: getsidechaininfo +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/getsidechaininfo/ +--- + +getsidechaininfo +Returns an object containing various state info regarding sidechain functionality. + +Result: +{ (json object) + "fedpegscript" : "hex", (string) The fedpegscript from genesis block + "current_fedpegscripts" : [ (json array) The currently-enforced fedpegscripts in hex. Peg-ins for any entries on this list are honored by consensus and policy. Newest first. Two total entries are possible + "hex", (string) active fedpegscript + ... + ], + "current_fedpeg_programs" : [ (json array) The currently-enforced fedpegscript scriptPubKeys in hex. Prior to a transition this may be P2SH scriptpubkey, otherwise it will be a native segwit script. Results are paired in-order with current_fedpegscripts + "hex", (string) active fedpegscript scriptPubKeys + ... + ], + "pegged_asset" : "hex", (string) Pegged asset type + "min_peg_diff" : "str", (string) The minimum difficulty parent chain header target. Peg-in headers that have less work will be rejected as an anti-Dos measure + "parent_blockhash" : "hex", (string) The parent genesis blockhash as source of pegged-in funds + "parent_chain_has_pow" : true|false, (boolean) Whether parent chain has pow or signed blocks + "parent_chain_signblockscript_asm" : "str", (string) If the parent chain has signed blocks, its signblockscript in ASM + "parent_chain_signblockscript_hex" : "hex", (string) If the parent chain has signed blocks, its signblockscript in hex + "parent_pegged_asset" : "hex", (string) If the parent chain has Confidential Assets, the asset id of the pegged asset in that chain + "pegin_confirmation_depth" : n, (numeric) The number of mainchain confirmations required for a peg-in transaction to become valid + "enforce_pak" : true|false (boolean) If peg-out authorization is being enforced +} + +Examples: +> elements-cli getsidechaininfo +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getsidechaininfo", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/gettxout.html b/_doc/en/22.1.1/rpc/blockchain/gettxout.html new file mode 100644 index 0000000..e568109 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/gettxout.html @@ -0,0 +1,51 @@ +--- +layout: doc +name: gettxout +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/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, default=true) Whether to include the mempool. Note that an unspent output that is spent in the mempool won't appear. + +Result (If the UTXO was not found): +null (json null) + +Result (Otherwise): +{ (json object) + "bestblock" : "hex", (string) The hash of the block at the tip of the chain + "confirmations" : n, (numeric) The number of confirmations + "value" : n, (numeric) The transaction value in BTC + "scriptPubKey" : { (json object) + "asm" : "str", (string) + "hex" : "hex", (string) + "reqSigs" : n, (numeric, optional) (DEPRECATED, returned only if config option -deprecatedrpc=addresses is passed) Number of required signatures + "type" : "str", (string) The type, eg pubkeyhash + "address" : "str", (string, optional) bitcoin address (only if a well-defined address exists) + "addresses" : [ (json array, optional) (DEPRECATED, returned only if config option -deprecatedrpc=addresses is passed) Array of bitcoin addresses + "str", (string) bitcoin address + ... + ] + }, + "coinbase" : true|false (boolean) Coinbase or not +} + +Examples: + +Get unspent transactions +> elements-cli listunspent + +View the details +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/gettxoutproof.html b/_doc/en/22.1.1/rpc/blockchain/gettxoutproof.html new file mode 100644 index 0000000..49b04b1 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/gettxoutproof.html @@ -0,0 +1,29 @@ +--- +layout: doc +name: gettxoutproof +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/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 (json array, required) The txids to filter + [ + "txid", (string) A transaction hash + ... + ] +2. blockhash (string, optional) If specified, looks for txid in the block with this hash + +Result: +"str" (string) A string that is a serialized, hex-encoded data for the proof. + + diff --git a/_doc/en/22.1.1/rpc/blockchain/gettxoutsetinfo.html b/_doc/en/22.1.1/rpc/blockchain/gettxoutsetinfo.html new file mode 100644 index 0000000..5f801d0 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/gettxoutsetinfo.html @@ -0,0 +1,55 @@ +--- +layout: doc +name: gettxoutsetinfo +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/gettxoutsetinfo/ +--- + +gettxoutsetinfo ( "hash_type" hash_or_height use_index ) + +Returns statistics about the unspent transaction output set. +Note this call may take some time if you are not using coinstatsindex. + +Arguments: +1. hash_type (string, optional, default="hash_serialized_2") Which UTXO set hash should be calculated. Options: 'hash_serialized_2' (the legacy algorithm), 'muhash', 'none'. +2. hash_or_height (string or numeric, optional) The block hash or height of the target height (only available with coinstatsindex). +3. use_index (boolean, optional, default=true) Use coinstatsindex, if available. + +Result: +{ (json object) + "height" : n, (numeric) The block height (index) of the returned statistics + "bestblock" : "hex", (string) The hash of the block at which these statistics are calculated + "txouts" : n, (numeric) The number of unspent transaction outputs + "bogosize" : n, (numeric) Database-independent, meaningless metric indicating the UTXO set size + "hash_serialized_2" : "hex", (string, optional) The serialized hash (only present if 'hash_serialized_2' hash_type is chosen) + "muhash" : "hex", (string, optional) The serialized hash (only present if 'muhash' hash_type is chosen) + "transactions" : n, (numeric) The number of transactions with unspent outputs (not available when coinstatsindex is used) + "disk_size" : n, (numeric) The estimated size of the chainstate on disk (not available when coinstatsindex is used) + "total_amount" : n, (numeric) The total amount of coins in the UTXO set + "total_unspendable_amount" : n, (numeric) The total amount of coins permanently excluded from the UTXO set (only available if coinstatsindex is used) + "block_info" : { (json object) Info on amounts in the block at this block height (only available if coinstatsindex is used) + "prevout_spent" : n, (numeric) + "coinbase" : n, (numeric) + "new_outputs_ex_coinbase" : n, (numeric) + "unspendable" : n, (numeric) + "unspendables" : { (json object) Detailed view of the unspendable categories + "genesis_block" : n, (numeric) + "bip30" : n, (numeric) Transactions overridden by duplicates (no longer possible with BIP30) + "scripts" : n, (numeric) Amounts sent to scripts that are unspendable (for example OP_RETURN outputs) + "unclaimed_rewards" : n (numeric) Fee rewards that miners did not claim in their coinbase transaction + } + } +} + +Examples: +> elements-cli gettxoutsetinfo +> elements-cli gettxoutsetinfo "none" +> elements-cli gettxoutsetinfo "none" 1000 +> elements-cli gettxoutsetinfo "none" '"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"' +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "gettxoutsetinfo", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "gettxoutsetinfo", "params": ["none"]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "gettxoutsetinfo", "params": ["none", 1000]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "gettxoutsetinfo", "params": ["none", "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/preciousblock.html b/_doc/en/22.1.1/rpc/blockchain/preciousblock.html new file mode 100644 index 0000000..432bd3f --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/preciousblock.html @@ -0,0 +1,27 @@ +--- +layout: doc +name: preciousblock +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/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: +null (json null) + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/pruneblockchain.html b/_doc/en/22.1.1/rpc/blockchain/pruneblockchain.html new file mode 100644 index 0000000..15e95a9 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/pruneblockchain.html @@ -0,0 +1,22 @@ +--- +layout: doc +name: pruneblockchain +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/pruneblockchain/ +--- + +pruneblockchain height + +Arguments: +1. height (numeric, required) The block height to prune up to. May be set to a discrete height, or to a UNIX epoch time + 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: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/savemempool.html b/_doc/en/22.1.1/rpc/blockchain/savemempool.html new file mode 100644 index 0000000..71c33c6 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/savemempool.html @@ -0,0 +1,20 @@ +--- +layout: doc +name: savemempool +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/savemempool/ +--- + +savemempool + +Dumps the mempool to disk. It will fail until the previous dump is fully loaded. + +Result: +null (json null) + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/scantxoutset.html b/_doc/en/22.1.1/rpc/blockchain/scantxoutset.html new file mode 100644 index 0000000..b3a098b --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/scantxoutset.html @@ -0,0 +1,74 @@ +--- +layout: doc +name: scantxoutset +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/scantxoutset/ +--- + +scantxoutset "action" ( [scanobjects,...] ) + +Scans the unspent transaction output set for entries that match certain output descriptors. +Examples of output descriptors are: + addr(

) Outputs whose scriptPubKey corresponds to the specified address (does not include P2PK) + raw() Outputs whose scriptPubKey equals the specified hex scripts + combo() P2PK, P2PKH, P2WPKH, and P2SH-P2WPKH outputs for the given pubkey + pkh() P2PKH outputs for the given pubkey + sh(multi(,,,...)) P2SH-multisig outputs for the given threshold and pubkeys + +In the above, either refers to a fixed public key in hexadecimal notation, or to an xpub/xprv optionally followed by one +or more path elements separated by "/", and optionally ending in "/*" (unhardened), or "/*'" or "/*h" (hardened) to specify all +unhardened or hardened child keys. +In the latter case, a range needs to be specified by below if different from 1000. +For more information on output descriptors, see the documentation in the doc/descriptors.md file. + +Arguments: +1. action (string, required) The action to execute + "start" for starting a scan + "abort" for aborting the current scan (returns true when abort was successful) + "status" for progress report (in %) of the current scan +2. scanobjects (json array) Array of scan objects. Required for "start" action + Every scan object is either a string descriptor or an object: + [ + "descriptor", (string) An output descriptor + { (json object) An object with output descriptor and metadata + "desc": "str", (string, required) An output descriptor + "range": n or [n,n], (numeric or array, optional, default=1000) The range of HD chain indexes to explore (either end or [begin,end]) + }, + ... + ] + +Result (When action=='abort'): +true|false (boolean) + +Result (When action=='status' and no scan is in progress): +null (json null) + +Result (When action=='status' and scan is in progress): +{ (json object) + "progress" : n (numeric) The scan progress +} + +Result (When action=='start'): +{ (json object) + "success" : true|false, (boolean) Whether the scan was completed + "txouts" : n, (numeric) The number of unspent transaction outputs scanned + "height" : n, (numeric) The current block height (index) + "bestblock" : "hex", (string) The hash of the block at the tip of the chain + "unspents" : [ (json array) + { (json object) + "txid" : "hex", (string) The transaction id + "vout" : n, (numeric) The vout value + "scriptPubKey" : "hex", (string) The script key + "desc" : "str", (string) A specialized descriptor for the matched scriptPubKey + "amount" : n, (numeric) The total amount in BTC of the unspent output + "asset" : "hex", (string) The asset ID + "height" : n (numeric) Height of the unspent transaction output + }, + n, (numeric) The total amount of all found unspent unblinded outputs in BTC + ... + ], + "total_amount" : n (numeric) The total amount of all found unspent outputs in BTC +} + + diff --git a/_doc/en/22.1.1/rpc/blockchain/verifychain.html b/_doc/en/22.1.1/rpc/blockchain/verifychain.html new file mode 100644 index 0000000..4b58d32 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/verifychain.html @@ -0,0 +1,30 @@ +--- +layout: doc +name: verifychain +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/rpc/blockchain/verifychain/ +--- + +verifychain ( checklevel nblocks ) + +Verifies blockchain database. + +Arguments: +1. checklevel (numeric, optional, default=3, range=0-4) How thorough the block verification is: + - level 0 reads the blocks from disk + - level 1 verifies block validity + - level 2 verifies undo data + - level 3 checks disconnection of tip blocks + - level 4 tries to reconnect the blocks + - each level includes the checks of the previous levels +2. nblocks (numeric, optional, default=6, 0=all) The number of blocks to check. + +Result: +true|false (boolean) Verified or not + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/blockchain/verifytxoutproof.html b/_doc/en/22.1.1/rpc/blockchain/verifytxoutproof.html new file mode 100644 index 0000000..9b33806 --- /dev/null +++ b/_doc/en/22.1.1/rpc/blockchain/verifytxoutproof.html @@ -0,0 +1,23 @@ +--- +layout: doc +name: verifytxoutproof +elemversion: 22.1.1 +elemgroup: blockchain +permalink: /en/doc/22.1.1/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: +[ (json array) + "hex", (string) The txid(s) which the proof commits to, or empty array if the proof can not be validated. + ... +] + + diff --git a/_doc/en/22.1.1/rpc/control/getmemoryinfo.html b/_doc/en/22.1.1/rpc/control/getmemoryinfo.html new file mode 100644 index 0000000..a67170d --- /dev/null +++ b/_doc/en/22.1.1/rpc/control/getmemoryinfo.html @@ -0,0 +1,36 @@ +--- +layout: doc +name: getmemoryinfo +elemversion: 22.1.1 +elemgroup: control +permalink: /en/doc/22.1.1/rpc/control/getmemoryinfo/ +--- + +getmemoryinfo ( "mode" ) +Returns an object containing information about memory usage. + +Arguments: +1. mode (string, optional, default="stats") determines what kind of information is returned. + - "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"): +{ (json object) + "locked" : { (json object) Information about locked memory manager + "used" : n, (numeric) Number of bytes used + "free" : n, (numeric) Number of bytes available in current arenas + "total" : n, (numeric) Total number of bytes managed + "locked" : n, (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" : n, (numeric) Number allocated chunks + "chunks_free" : n (numeric) Number unused chunks + } +} + +Result (mode "mallocinfo"): +"str" (string) "..." + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/control/getrpcinfo.html b/_doc/en/22.1.1/rpc/control/getrpcinfo.html new file mode 100644 index 0000000..b9394a1 --- /dev/null +++ b/_doc/en/22.1.1/rpc/control/getrpcinfo.html @@ -0,0 +1,29 @@ +--- +layout: doc +name: getrpcinfo +elemversion: 22.1.1 +elemgroup: control +permalink: /en/doc/22.1.1/rpc/control/getrpcinfo/ +--- + +getrpcinfo + +Returns details of the RPC server. + +Result: +{ (json object) + "active_commands" : [ (json array) All active commands + { (json object) Information about an active command + "method" : "str", (string) The name of the RPC command + "duration" : n (numeric) The running time in microseconds + }, + ... + ], + "logpath" : "str" (string) The complete file path to the debug log +} + +Examples: +> elements-cli getrpcinfo +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getrpcinfo", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/control/help.html b/_doc/en/22.1.1/rpc/control/help.html new file mode 100644 index 0000000..1d72388 --- /dev/null +++ b/_doc/en/22.1.1/rpc/control/help.html @@ -0,0 +1,19 @@ +--- +layout: doc +name: help +elemversion: 22.1.1 +elemgroup: control +permalink: /en/doc/22.1.1/rpc/control/help/ +--- + +help ( "command" ) + +List all commands, or get help for a specified command. + +Arguments: +1. command (string, optional, default=all commands) The command to get help on + +Result: +"str" (string) The help text + + diff --git a/_doc/en/22.1.1/rpc/control/logging.html b/_doc/en/22.1.1/rpc/control/logging.html new file mode 100644 index 0000000..4118480 --- /dev/null +++ b/_doc/en/22.1.1/rpc/control/logging.html @@ -0,0 +1,42 @@ +--- +layout: doc +name: logging +elemversion: 22.1.1 +elemgroup: control +permalink: /en/doc/22.1.1/rpc/control/logging/ +--- + +logging ( ["include_category",...] ["exclude_category",...] ) +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, walletdb, rpc, estimatefee, addrman, selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej, libevent, coindb, qt, leveldb, validation, i2p, ipc +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 (json array, optional) The categories to add to debug logging + [ + "include_category", (string) the valid logging category + ... + ] +2. exclude (json array, optional) The categories to remove from debug logging + [ + "exclude_category", (string) the valid logging category + ... + ] + +Result: +{ (json object) keys are the logging categories, and values indicates its status + "category" : true|false, (boolean) if being debug logged or not. false:inactive, true:active + ... +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/control/stop.html b/_doc/en/22.1.1/rpc/control/stop.html new file mode 100644 index 0000000..b5af05c --- /dev/null +++ b/_doc/en/22.1.1/rpc/control/stop.html @@ -0,0 +1,15 @@ +--- +layout: doc +name: stop +elemversion: 22.1.1 +elemgroup: control +permalink: /en/doc/22.1.1/rpc/control/stop/ +--- + +stop + +Request a graceful shutdown of Elements Core. +Result: +"str" (string) A string with the content 'Elements Core stopping' + + diff --git a/_doc/en/22.1.1/rpc/control/uptime.html b/_doc/en/22.1.1/rpc/control/uptime.html new file mode 100644 index 0000000..393b2fe --- /dev/null +++ b/_doc/en/22.1.1/rpc/control/uptime.html @@ -0,0 +1,20 @@ +--- +layout: doc +name: uptime +elemversion: 22.1.1 +elemgroup: control +permalink: /en/doc/22.1.1/rpc/control/uptime/ +--- + +uptime + +Returns the total uptime of the server. + +Result: +n (numeric) The number of seconds that the server has been running + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/generating/combineblocksigs.html b/_doc/en/22.1.1/rpc/generating/combineblocksigs.html new file mode 100644 index 0000000..e222077 --- /dev/null +++ b/_doc/en/22.1.1/rpc/generating/combineblocksigs.html @@ -0,0 +1,34 @@ +--- +layout: doc +name: combineblocksigs +elemversion: 22.1.1 +elemgroup: generating +permalink: /en/doc/22.1.1/rpc/generating/combineblocksigs/ +--- + +combineblocksigs "blockhex" [{"pubkey":"hex","sig":"hex"},...] ( "witnessScript" ) + +Merges signatures on a block proposal + +Arguments: +1. blockhex (string, required) The hex-encoded block from getnewblockhex +2. signatures (json array, required) A json array of pubkey/signature pairs + [ + { (json object) + "pubkey": "hex", (string, required) The pubkey for the signature in hex + "sig": "hex", (string, required) A signature (in the form of a hex-encoded scriptSig) + }, + ... + ] +3. witnessScript (string, optional) The hex-encoded witnessScript for the signblockscript + +Result: +{ (json object) + "hex" : "hex", (string) the signed block + "complete" : true|false (boolean) whether the block is complete +} + +Examples: +> elements-cli combineblocksigs '[{"pubkey":"hex","sig":"hex"}, ...]' + + diff --git a/_doc/en/22.1.1/rpc/generating/consumecompactsketch.html b/_doc/en/22.1.1/rpc/generating/consumecompactsketch.html new file mode 100644 index 0000000..a792d2e --- /dev/null +++ b/_doc/en/22.1.1/rpc/generating/consumecompactsketch.html @@ -0,0 +1,29 @@ +--- +layout: doc +name: consumecompactsketch +elemversion: 22.1.1 +elemgroup: generating +permalink: /en/doc/22.1.1/rpc/generating/consumecompactsketch/ +--- + +consumecompactsketch "sketch" + +Takes hex representation of a proposed compact block sketch and fills it in +using mempool. Returns the block if complete, and a list +of missing transaction indices serialized as a native structure.NOTE: The latest instance of this call will have a partially filled block +cached in memory to be used in `consumegetblocktxn` to finalize the block. + +Arguments: +1. sketch (string, required) Hex string of compact block sketch. + +Result: +{ (json object) + "blockhex" : "hex", (string) The filled block hex. Only returns when block is final + "block_tx_req" : "hex", (string) The serialized structure of missing transaction indices, given to serving node + "found_tranasctions" : "hex" (string) The serialized list of found transactions to be used in finalizecompactblock +} + +Examples: +> elements-cli consumecompactsketch + + diff --git a/_doc/en/22.1.1/rpc/generating/consumegetblocktxn.html b/_doc/en/22.1.1/rpc/generating/consumegetblocktxn.html new file mode 100644 index 0000000..df4ebaf --- /dev/null +++ b/_doc/en/22.1.1/rpc/generating/consumegetblocktxn.html @@ -0,0 +1,21 @@ +--- +layout: doc +name: consumegetblocktxn +elemversion: 22.1.1 +elemgroup: generating +permalink: /en/doc/22.1.1/rpc/generating/consumegetblocktxn/ +--- + +consumegetblocktxn "full_block" "block_tx_req" +Consumes a transaction request for a compact block sketch. +Arguments: +1. full_block (string, required) Hex serialied block that corresponds to the block request `block_tx_req`. +2. block_tx_req (string, required) Hex serialied BlockTransactionsRequest, aka getblocktxn network message. + +Result: +"hex" (string) The serialized list of found transactions aka BlockTransactions + +Examples: +> elements-cli consumegetblocktxn + + diff --git a/_doc/en/22.1.1/rpc/generating/finalizecompactblock.html b/_doc/en/22.1.1/rpc/generating/finalizecompactblock.html new file mode 100644 index 0000000..008f8e0 --- /dev/null +++ b/_doc/en/22.1.1/rpc/generating/finalizecompactblock.html @@ -0,0 +1,22 @@ +--- +layout: doc +name: finalizecompactblock +elemversion: 22.1.1 +elemgroup: generating +permalink: /en/doc/22.1.1/rpc/generating/finalizecompactblock/ +--- + +finalizecompactblock "compact_hex" "block_transactions" "found_transactions" +Takes the two transaction lists, fills out the compact block and attempts to finalize it. +Arguments: +1. compact_hex (string, required) Hex serialized compact block. +2. block_transactions (string, required) Hex serialized BlockTransactions, the response to getblocktxn. +3. found_transactions (string, required) Hex serialized list of transactions that were found in response to receiving a compact sketch in `consumecompactsketch`. + +Result: +"hex" (string) The serialized final block + +Examples: +> elements-cli finalizecompactblock + + diff --git a/_doc/en/22.1.1/rpc/generating/generateblock.html b/_doc/en/22.1.1/rpc/generating/generateblock.html new file mode 100644 index 0000000..d37cf62 --- /dev/null +++ b/_doc/en/22.1.1/rpc/generating/generateblock.html @@ -0,0 +1,33 @@ +--- +layout: doc +name: generateblock +elemversion: 22.1.1 +elemgroup: generating +permalink: /en/doc/22.1.1/rpc/generating/generateblock/ +--- + +generateblock "output" ["rawtx/txid",...] + +Mine a block with a set of ordered transactions immediately to a specified address or descriptor (before the RPC call returns) + +Arguments: +1. output (string, required) The address or descriptor to send the newly generated bitcoin to. +2. transactions (json array, required) An array of hex strings which are either txids or raw transactions. + Txids must reference transactions currently in the mempool. + All transactions must be valid and in valid order, otherwise the block will be rejected. + [ + "rawtx/txid", (string) + ... + ] + +Result: +{ (json object) + "hash" : "hex" (string) hash of generated block +} + +Examples: + +Generate a block to myaddress, with txs rawtx and mempool_txid +> elements-cli generateblock "myaddress" '["rawtx", "mempool_txid"]' + + diff --git a/_doc/en/22.1.1/rpc/generating/generatetoaddress.html b/_doc/en/22.1.1/rpc/generating/generatetoaddress.html new file mode 100644 index 0000000..40d9c6b --- /dev/null +++ b/_doc/en/22.1.1/rpc/generating/generatetoaddress.html @@ -0,0 +1,31 @@ +--- +layout: doc +name: generatetoaddress +elemversion: 22.1.1 +elemgroup: generating +permalink: /en/doc/22.1.1/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, default=1000000) How many iterations to try. + +Result: +[ (json array) hashes of blocks generated + "hex", (string) blockhash + ... +] + +Examples: + +Generate 11 blocks to myaddress +> elements-cli generatetoaddress 11 "myaddress" +If you are using the Elements Core wallet, you can get a new address to send the newly generated bitcoin to with: +> elements-cli getnewaddress + + diff --git a/_doc/en/22.1.1/rpc/generating/generatetodescriptor.html b/_doc/en/22.1.1/rpc/generating/generatetodescriptor.html new file mode 100644 index 0000000..b460400 --- /dev/null +++ b/_doc/en/22.1.1/rpc/generating/generatetodescriptor.html @@ -0,0 +1,29 @@ +--- +layout: doc +name: generatetodescriptor +elemversion: 22.1.1 +elemgroup: generating +permalink: /en/doc/22.1.1/rpc/generating/generatetodescriptor/ +--- + +generatetodescriptor num_blocks "descriptor" ( maxtries ) + +Mine blocks immediately to a specified descriptor (before the RPC call returns) + +Arguments: +1. num_blocks (numeric, required) How many blocks are generated immediately. +2. descriptor (string, required) The descriptor to send the newly generated bitcoin to. +3. maxtries (numeric, optional, default=1000000) How many iterations to try. + +Result: +[ (json array) hashes of blocks generated + "hex", (string) blockhash + ... +] + +Examples: + +Generate 11 blocks to mydesc +> elements-cli generatetodescriptor 11 "mydesc" + + diff --git a/_doc/en/22.1.1/rpc/generating/getcompactsketch.html b/_doc/en/22.1.1/rpc/generating/getcompactsketch.html new file mode 100644 index 0000000..1e84bad --- /dev/null +++ b/_doc/en/22.1.1/rpc/generating/getcompactsketch.html @@ -0,0 +1,23 @@ +--- +layout: doc +name: getcompactsketch +elemversion: 22.1.1 +elemgroup: generating +permalink: /en/doc/22.1.1/rpc/generating/getcompactsketch/ +--- + +getcompactsketch "block_hex" + +Gets hex representation of a proposed compact block sketch. +It is consumed by `consumecompactsketch.` + +Arguments: +1. block_hex (string, required) Hex serialized block proposal from `getnewblockhex`. + +Result: +"str" (string) serialized block sketch + +Examples: +> elements-cli getcompactsketch + + diff --git a/_doc/en/22.1.1/rpc/generating/getnewblockhex.html b/_doc/en/22.1.1/rpc/generating/getnewblockhex.html new file mode 100644 index 0000000..dbbc7f4 --- /dev/null +++ b/_doc/en/22.1.1/rpc/generating/getnewblockhex.html @@ -0,0 +1,37 @@ +--- +layout: doc +name: getnewblockhex +elemversion: 22.1.1 +elemgroup: generating +permalink: /en/doc/22.1.1/rpc/generating/getnewblockhex/ +--- + +getnewblockhex ( min_tx_age proposed_parameters ["",...] ) + +Gets hex representation of a proposed, unmined new block + +Arguments: +1. min_tx_age (numeric, optional, default=0) How many seconds a transaction must have been in the mempool to be included in the block proposal. This may help with faster block convergence among functionaries using compact blocks. +2. proposed_parameters (json object) Parameters to be used in dynamic federations blocks as proposals. During a period of `-dynamic_epoch_length` blocks, 4/5 of total blocks must signal these parameters for the proposal to become activated in the next epoch. + { + "signblockscript": "hex", (string, required) Hex-encoded block signing script to propose + "max_block_witness": n, (numeric, required) Total size in witness bytes that are allowed in the dynamic federations block witness for blocksigning + "fedpegscript": "hex", (string, required) Hex-encoded fedpegscript for dynamic block proposal. This is interpreted as a v0 segwit witnessScript, and fills out the fedpeg_program as such. + "extension_space": [ (json array, required) Array of additional fields to embed in the dynamic blockheader. Has no consensus meaning aside from serialized size changes. This space is currently is only used for PAK enforcement. + "", (string, required) Hex encoded string for extension entries. + ... + ], + } +3. commit_data (json array) Array of data in hex to be committed to in additional coinbase outputs. + [ + "", (string, required) Hex encoded string for commit data + ... + ] + +Result: +"hex" (string) the block hex + +Examples: +> elements-cli getnewblockhex + + diff --git a/_doc/en/22.1.1/rpc/index.html b/_doc/en/22.1.1/rpc/index.html new file mode 100644 index 0000000..5477049 --- /dev/null +++ b/_doc/en/22.1.1/rpc/index.html @@ -0,0 +1,9 @@ +--- +layout: doc +name: rpcindex +elemversion: 22.1.1 +elemgroup: index +permalink: /en/doc/22.1.1/rpc/ +--- + + diff --git a/_doc/en/22.1.1/rpc/mining/getblocktemplate.html b/_doc/en/22.1.1/rpc/mining/getblocktemplate.html new file mode 100644 index 0000000..ee1a127 --- /dev/null +++ b/_doc/en/22.1.1/rpc/mining/getblocktemplate.html @@ -0,0 +1,94 @@ +--- +layout: doc +name: getblocktemplate +elemversion: 22.1.1 +elemgroup: mining +permalink: /en/doc/22.1.1/rpc/mining/getblocktemplate/ +--- + +getblocktemplate ( "template_request" ) + +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, default={}) Format of the template + { + "mode": "str", (string, optional) This must be set to "template", "proposal" (see BIP 23), or omitted + "capabilities": [ (json array, optional) A list of strings + "str", (string) client side supported feature, 'longpoll', 'coinbasevalue', 'proposal', 'serverlist', 'workid' + ... + ], + "rules": [ (json array, required) A list of strings + "segwit", (string, required) (literal) indicates client side segwit support + "str", (string) other client side supported softfork deployment + ... + ], + } + +Result (If the proposal was accepted with mode=='proposal'): +null (json null) + +Result (If the proposal was not accepted with mode=='proposal'): +"str" (string) According to BIP22 + +Result (Otherwise): +{ (json object) + "version" : n, (numeric) The preferred block version + "rules" : [ (json array) specific block rules that are to be enforced + "str", (string) name of a rule the client must understand to some extent; see BIP 9 for format + ... + ], + "vbavailable" : { (json object) set of pending, supported versionbit (BIP 9) softfork deployments + "rulename" : n, (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" : "str", (string) The hash of current highest block + "transactions" : [ (json array) contents of non-coinbase transactions that should be included in the next block + { (json object) + "data" : "hex", (string) transaction data encoded in hexadecimal (byte-for-byte) + "txid" : "hex", (string) transaction id encoded in little-endian hexadecimal + "hash" : "hex", (string) hash encoded in little-endian hexadecimal (including witness data) + "depends" : [ (json 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 + }, + ... + ], + "coinbaseaux" : { (json object) data that should be included in the coinbase's scriptSig content + "key" : "hex", (string) values must be in the coinbase (keys may be ignored) + ... + }, + "coinbasevalue" : n, (numeric) maximum allowable input to coinbase transaction, including the generation award and transaction fees (in satoshis) + "longpollid" : "str", (string) an id to include with a request to longpoll on an update to this template + "target" : "str", (string) The hash target + "mintime" : xxx, (numeric) The minimum timestamp appropriate for the next block time, expressed in UNIX epoch time + "mutable" : [ (json array) list of ways the block template may be changed + "str", (string) A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock' + ... + ], + "noncerange" : "hex", (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" : xxx, (numeric) current timestamp in UNIX epoch time + "bits" : "str", (string) compressed target of next block + "height" : n, (numeric) The height of the next block + "default_witness_commitment" : "str" (string, optional) a valid witness commitment for the unmodified block template +} + +Examples: +> elements-cli getblocktemplate '{"rules": ["segwit"]}' +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getblocktemplate", "params": [{"rules": ["segwit"]}]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/mining/getmininginfo.html b/_doc/en/22.1.1/rpc/mining/getmininginfo.html new file mode 100644 index 0000000..25682e2 --- /dev/null +++ b/_doc/en/22.1.1/rpc/mining/getmininginfo.html @@ -0,0 +1,28 @@ +--- +layout: doc +name: getmininginfo +elemversion: 22.1.1 +elemgroup: mining +permalink: /en/doc/22.1.1/rpc/mining/getmininginfo/ +--- + +getmininginfo + +Returns a json object containing mining-related information. +Result: +{ (json object) + "blocks" : n, (numeric) The current block + "currentblockweight" : n, (numeric, optional) The block weight of the last assembled block (only present if a block was ever assembled) + "currentblocktx" : n, (numeric, optional) The number of block transactions of the last assembled block (only present if a block was ever assembled) + "difficulty" : n, (numeric) The current difficulty + "networkhashps" : n, (numeric) The network hashes per second + "pooledtx" : n, (numeric) The size of the mempool + "chain" : "str", (string) current network name (main, test, signet, regtest) + "warnings" : "str" (string) any network and blockchain warnings +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/mining/getnetworkhashps.html b/_doc/en/22.1.1/rpc/mining/getnetworkhashps.html new file mode 100644 index 0000000..e97160f --- /dev/null +++ b/_doc/en/22.1.1/rpc/mining/getnetworkhashps.html @@ -0,0 +1,26 @@ +--- +layout: doc +name: getnetworkhashps +elemversion: 22.1.1 +elemgroup: mining +permalink: /en/doc/22.1.1/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: +n (numeric) Hashes per second estimated + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/mining/prioritisetransaction.html b/_doc/en/22.1.1/rpc/mining/prioritisetransaction.html new file mode 100644 index 0000000..e6ae533 --- /dev/null +++ b/_doc/en/22.1.1/rpc/mining/prioritisetransaction.html @@ -0,0 +1,28 @@ +--- +layout: doc +name: prioritisetransaction +elemversion: 22.1.1 +elemgroup: mining +permalink: /en/doc/22.1.1/rpc/mining/prioritisetransaction/ +--- + +prioritisetransaction "txid" ( dummy ) fee_delta +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). + Note, that this value is not a fee rate. It is a value to modify absolute fee of the TX. + 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|false (boolean) Returns true + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/mining/submitblock.html b/_doc/en/22.1.1/rpc/mining/submitblock.html new file mode 100644 index 0000000..d47076f --- /dev/null +++ b/_doc/en/22.1.1/rpc/mining/submitblock.html @@ -0,0 +1,28 @@ +--- +layout: doc +name: submitblock +elemversion: 22.1.1 +elemgroup: mining +permalink: /en/doc/22.1.1/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 (string, optional, default=ignored) dummy value, for compatibility with BIP22. This value is ignored. + +Result (If the block was accepted): +null (json null) + +Result (Otherwise): +"str" (string) According to BIP22 + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/mining/submitheader.html b/_doc/en/22.1.1/rpc/mining/submitheader.html new file mode 100644 index 0000000..4620b00 --- /dev/null +++ b/_doc/en/22.1.1/rpc/mining/submitheader.html @@ -0,0 +1,24 @@ +--- +layout: doc +name: submitheader +elemversion: 22.1.1 +elemgroup: mining +permalink: /en/doc/22.1.1/rpc/mining/submitheader/ +--- + +submitheader "hexdata" + +Decode the given hexdata as a header and submit it as a candidate chain tip if valid. +Throws when the header is invalid. + +Arguments: +1. hexdata (string, required) the hex-encoded block header data + +Result: +null (json null) None + +Examples: +> elements-cli submitheader "aabbcc" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "submitheader", "params": ["aabbcc"]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/mining/testproposedblock.html b/_doc/en/22.1.1/rpc/mining/testproposedblock.html new file mode 100644 index 0000000..df37180 --- /dev/null +++ b/_doc/en/22.1.1/rpc/mining/testproposedblock.html @@ -0,0 +1,23 @@ +--- +layout: doc +name: testproposedblock +elemversion: 22.1.1 +elemgroup: mining +permalink: /en/doc/22.1.1/rpc/mining/testproposedblock/ +--- + +testproposedblock "blockhex" ( acceptnonstd ) + +Checks a block proposal for validity, and that it extends chaintip + +Arguments: +1. blockhex (string, required) The hex-encoded block from getnewblockhex +2. acceptnonstd (boolean, optional) If set false, returns error if block contains non-standard transaction. Default is set via `-acceptnonstdtxn`. + +Result: +null (json null) + +Examples: +> elements-cli testproposedblock + + diff --git a/_doc/en/22.1.1/rpc/network/addnode.html b/_doc/en/22.1.1/rpc/network/addnode.html new file mode 100644 index 0000000..44bdb39 --- /dev/null +++ b/_doc/en/22.1.1/rpc/network/addnode.html @@ -0,0 +1,28 @@ +--- +layout: doc +name: addnode +elemversion: 22.1.1 +elemgroup: network +permalink: /en/doc/22.1.1/rpc/network/addnode/ +--- + +addnode "node" "command" + +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). +Addnode connections are limited to 8 at a time and are counted separately from the -maxconnections limit. + +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 + +Result: +null (json null) + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/network/clearbanned.html b/_doc/en/22.1.1/rpc/network/clearbanned.html new file mode 100644 index 0000000..4e1c02a --- /dev/null +++ b/_doc/en/22.1.1/rpc/network/clearbanned.html @@ -0,0 +1,20 @@ +--- +layout: doc +name: clearbanned +elemversion: 22.1.1 +elemgroup: network +permalink: /en/doc/22.1.1/rpc/network/clearbanned/ +--- + +clearbanned + +Clear all banned IPs. + +Result: +null (json null) + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/network/disconnectnode.html b/_doc/en/22.1.1/rpc/network/disconnectnode.html new file mode 100644 index 0000000..9772d23 --- /dev/null +++ b/_doc/en/22.1.1/rpc/network/disconnectnode.html @@ -0,0 +1,30 @@ +--- +layout: doc +name: disconnectnode +elemversion: 22.1.1 +elemgroup: network +permalink: /en/doc/22.1.1/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, default=fallback to nodeid) The IP address/port of the node +2. nodeid (numeric, optional, default=fallback to address) The node ID (see getpeerinfo for node IDs) + +Result: +null (json null) + +Examples: +> elements-cli disconnectnode "192.168.0.6:8333" +> elements-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:7041/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "disconnectnode", "params": ["", 1]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/network/getaddednodeinfo.html b/_doc/en/22.1.1/rpc/network/getaddednodeinfo.html new file mode 100644 index 0000000..fad9c82 --- /dev/null +++ b/_doc/en/22.1.1/rpc/network/getaddednodeinfo.html @@ -0,0 +1,37 @@ +--- +layout: doc +name: getaddednodeinfo +elemversion: 22.1.1 +elemgroup: network +permalink: /en/doc/22.1.1/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, default=all nodes) If provided, return information about this specific node, otherwise all nodes are returned. + +Result: +[ (json array) + { (json object) + "addednode" : "str", (string) The node IP address or name (as provided to addnode) + "connected" : true|false, (boolean) If connected + "addresses" : [ (json array) Only when connected = true + { (json object) + "address" : "str", (string) The bitcoin server IP and port we're connected to + "connected" : "str" (string) connection, inbound or outbound + }, + ... + ] + }, + ... +] + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/network/getconnectioncount.html b/_doc/en/22.1.1/rpc/network/getconnectioncount.html new file mode 100644 index 0000000..79ff03a --- /dev/null +++ b/_doc/en/22.1.1/rpc/network/getconnectioncount.html @@ -0,0 +1,20 @@ +--- +layout: doc +name: getconnectioncount +elemversion: 22.1.1 +elemgroup: network +permalink: /en/doc/22.1.1/rpc/network/getconnectioncount/ +--- + +getconnectioncount + +Returns the number of connections to other nodes. + +Result: +n (numeric) The connection count + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/network/getnettotals.html b/_doc/en/22.1.1/rpc/network/getnettotals.html new file mode 100644 index 0000000..f3703c5 --- /dev/null +++ b/_doc/en/22.1.1/rpc/network/getnettotals.html @@ -0,0 +1,33 @@ +--- +layout: doc +name: getnettotals +elemversion: 22.1.1 +elemgroup: network +permalink: /en/doc/22.1.1/rpc/network/getnettotals/ +--- + +getnettotals + +Returns information about network traffic, including bytes in, bytes out, +and current time. + +Result: +{ (json object) + "totalbytesrecv" : n, (numeric) Total bytes received + "totalbytessent" : n, (numeric) Total bytes sent + "timemillis" : xxx, (numeric) Current UNIX epoch time in milliseconds + "uploadtarget" : { (json object) + "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" : n, (numeric) Bytes left in current time cycle + "time_left_in_cycle" : n (numeric) Seconds left in current time cycle + } +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/network/getnetworkinfo.html b/_doc/en/22.1.1/rpc/network/getnetworkinfo.html new file mode 100644 index 0000000..44b23ea --- /dev/null +++ b/_doc/en/22.1.1/rpc/network/getnetworkinfo.html @@ -0,0 +1,55 @@ +--- +layout: doc +name: getnetworkinfo +elemversion: 22.1.1 +elemgroup: network +permalink: /en/doc/22.1.1/rpc/network/getnetworkinfo/ +--- + +getnetworkinfo +Returns an object containing various state info regarding P2P networking. + +Result: +{ (json object) + "version" : n, (numeric) the server version + "subversion" : "str", (string) the server subversion string + "protocolversion" : n, (numeric) the protocol version + "localservices" : "hex", (string) the services we offer to the network + "localservicesnames" : [ (json array) the services we offer to the network, in human-readable form + "str", (string) the service name + ... + ], + "localrelay" : true|false, (boolean) true if transaction relay is requested from peers + "timeoffset" : n, (numeric) the time offset + "connections" : n, (numeric) the total number of connections + "connections_in" : n, (numeric) the number of inbound connections + "connections_out" : n, (numeric) the number of outbound connections + "networkactive" : true|false, (boolean) whether p2p networking is enabled + "networks" : [ (json array) information per network + { (json object) + "name" : "str", (string) network (ipv4, ipv6, onion, i2p) + "limited" : true|false, (boolean) is the network limited using -onlynet? + "reachable" : true|false, (boolean) is the network reachable? + "proxy" : "str", (string) ("host:port") the proxy that is used for this network, or empty if none + "proxy_randomize_credentials" : true|false (boolean) Whether randomized credentials are used + }, + ... + ], + "relayfee" : n, (numeric) minimum relay fee rate for transactions in BTC/kvB + "incrementalfee" : n, (numeric) minimum fee rate increment for mempool limiting or BIP 125 replacement in BTC/kvB + "localaddresses" : [ (json array) list of local addresses + { (json object) + "address" : "str", (string) network address + "port" : n, (numeric) network port + "score" : n (numeric) relative score + }, + ... + ], + "warnings" : "str" (string) any network and blockchain warnings +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/network/getnodeaddresses.html b/_doc/en/22.1.1/rpc/network/getnodeaddresses.html new file mode 100644 index 0000000..b88a6cf --- /dev/null +++ b/_doc/en/22.1.1/rpc/network/getnodeaddresses.html @@ -0,0 +1,36 @@ +--- +layout: doc +name: getnodeaddresses +elemversion: 22.1.1 +elemgroup: network +permalink: /en/doc/22.1.1/rpc/network/getnodeaddresses/ +--- + +getnodeaddresses ( count "network" ) + +Return known addresses, which can potentially be used to find new nodes in the network. + +Arguments: +1. count (numeric, optional, default=1) The maximum number of addresses to return. Specify 0 to return all known addresses. +2. network (string, optional, default=all networks) Return only addresses of the specified network. Can be one of: ipv4, ipv6, onion, i2p. + +Result: +[ (json array) + { (json object) + "time" : xxx, (numeric) The UNIX epoch time when the node was last seen + "services" : n, (numeric) The services offered by the node + "address" : "str", (string) The address of the node + "port" : n, (numeric) The port number of the node + "network" : "str" (string) The network (ipv4, ipv6, onion, i2p) the node connected through + }, + ... +] + +Examples: +> elements-cli getnodeaddresses 8 +> elements-cli getnodeaddresses 4 "i2p" +> elements-cli -named getnodeaddresses network=onion count=12 +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getnodeaddresses", "params": [8]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getnodeaddresses", "params": [4, "i2p"]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/network/getpeerinfo.html b/_doc/en/22.1.1/rpc/network/getpeerinfo.html new file mode 100644 index 0000000..602e309 --- /dev/null +++ b/_doc/en/22.1.1/rpc/network/getpeerinfo.html @@ -0,0 +1,94 @@ +--- +layout: doc +name: getpeerinfo +elemversion: 22.1.1 +elemgroup: network +permalink: /en/doc/22.1.1/rpc/network/getpeerinfo/ +--- + +getpeerinfo + +Returns data about each connected network node as a json array of objects. + +Result: +[ (json array) + { (json object) + "id" : n, (numeric) Peer index + "addr" : "str", (string) (host:port) The IP address and port of the peer + "addrbind" : "str", (string) (ip:port) Bind address of the connection to the peer + "addrlocal" : "str", (string) (ip:port) Local address as reported by the peer + "network" : "str", (string) Network (ipv4, ipv6, onion, i2p, not_publicly_routable) + "mapped_as" : n, (numeric) The AS in the BGP route to the peer used for diversifying + peer selection (only available if the asmap config flag is set) + "services" : "hex", (string) The services offered + "servicesnames" : [ (json array) the services offered, in human-readable form + "str", (string) the service name if it is recognised + ... + ], + "relaytxes" : true|false, (boolean) Whether peer has asked us to relay transactions to it + "lastsend" : xxx, (numeric) The UNIX epoch time of the last send + "lastrecv" : xxx, (numeric) The UNIX epoch time of the last receive + "last_transaction" : xxx, (numeric) The UNIX epoch time of the last valid transaction received from this peer + "last_block" : xxx, (numeric) The UNIX epoch time of the last block received from this peer + "bytessent" : n, (numeric) The total bytes sent + "bytesrecv" : n, (numeric) The total bytes received + "conntime" : xxx, (numeric) The UNIX epoch time of the connection + "timeoffset" : n, (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" : n, (numeric) The peer version, such as 70001 + "subver" : "str", (string) The string version + "inbound" : true|false, (boolean) Inbound (true) or Outbound (false) + "bip152_hb_to" : true|false, (boolean) Whether we selected peer as (compact blocks) high-bandwidth peer + "bip152_hb_from" : true|false, (boolean) Whether peer selected us as (compact blocks) high-bandwidth peer + "startingheight" : n, (numeric) The starting height (block) of the peer + "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" : [ (json array) + n, (numeric) The heights of blocks we're currently asking from this peer + ... + ], + "permissions" : [ (json array) Any special permissions that have been granted to this peer + "str", (string) bloomfilter (allow requesting BIP37 filtered blocks and transactions), + noban (do not ban for misbehavior; implies download), + forcerelay (relay transactions that are already in the mempool; implies relay), + relay (relay even in -blocksonly mode, and unlimited transaction announcements), + mempool (allow requesting BIP35 mempool contents), + download (allow getheaders during IBD, no disconnect after maxuploadtarget limit), + addr (responses to GETADDR avoid hitting the cache and contain random records with the most up-to-date info). + + ... + ], + "minfeefilter" : n, (numeric) The minimum fee rate for transactions this peer accepts + "bytessent_per_msg" : { (json object) + "msg" : n, (numeric) The total bytes sent aggregated by message type + When a message type is not listed in this json object, the bytes sent are 0. + Only known message types can appear as keys in the object. + ... + }, + "bytesrecv_per_msg" : { (json object) + "msg" : n, (numeric) The total bytes received aggregated by message type + When a message type is not listed in this json object, the bytes received are 0. + Only known message types can appear as keys in the object and all bytes received + of unknown message types are listed under '*other*'. + ... + }, + "connection_type" : "str" (string) Type of connection: + outbound-full-relay (default automatic connections), + block-relay-only (does not relay transactions or addresses), + inbound (initiated by the peer), + manual (added via addnode RPC or -addnode/-connect configuration options), + addr-fetch (short-lived automatic connection for soliciting addresses), + feeler (short-lived automatic connection for testing addresses). + Please note this output is unlikely to be stable in upcoming releases as we iterate to + best capture connection behaviors. + }, + ... +] + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/network/listbanned.html b/_doc/en/22.1.1/rpc/network/listbanned.html new file mode 100644 index 0000000..8e78be5 --- /dev/null +++ b/_doc/en/22.1.1/rpc/network/listbanned.html @@ -0,0 +1,29 @@ +--- +layout: doc +name: listbanned +elemversion: 22.1.1 +elemgroup: network +permalink: /en/doc/22.1.1/rpc/network/listbanned/ +--- + +listbanned + +List all manually banned IPs/Subnets. + +Result: +[ (json array) + { (json object) + "address" : "str", (string) The IP/Subnet of the banned node + "ban_created" : xxx, (numeric) The UNIX epoch time the ban was created + "banned_until" : xxx, (numeric) The UNIX epoch time the ban expires + "ban_duration" : xxx, (numeric) The ban duration, in seconds + "time_remaining" : xxx (numeric) The time remaining until the ban expires, in seconds + }, + ... +] + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/network/ping.html b/_doc/en/22.1.1/rpc/network/ping.html new file mode 100644 index 0000000..8ff1849 --- /dev/null +++ b/_doc/en/22.1.1/rpc/network/ping.html @@ -0,0 +1,22 @@ +--- +layout: doc +name: ping +elemversion: 22.1.1 +elemgroup: network +permalink: /en/doc/22.1.1/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. + +Result: +null (json null) + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/network/setban.html b/_doc/en/22.1.1/rpc/network/setban.html new file mode 100644 index 0000000..facdffc --- /dev/null +++ b/_doc/en/22.1.1/rpc/network/setban.html @@ -0,0 +1,27 @@ +--- +layout: doc +name: setban +elemversion: 22.1.1 +elemgroup: network +permalink: /en/doc/22.1.1/rpc/network/setban/ +--- + +setban "subnet" "command" ( 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, default=0) 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, default=false) If set, the bantime must be an absolute timestamp expressed in UNIX epoch time + +Result: +null (json null) + +Examples: +> elements-cli setban "192.168.0.6" "add" 86400 +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/network/setnetworkactive.html b/_doc/en/22.1.1/rpc/network/setnetworkactive.html new file mode 100644 index 0000000..e3a3679 --- /dev/null +++ b/_doc/en/22.1.1/rpc/network/setnetworkactive.html @@ -0,0 +1,19 @@ +--- +layout: doc +name: setnetworkactive +elemversion: 22.1.1 +elemgroup: network +permalink: /en/doc/22.1.1/rpc/network/setnetworkactive/ +--- + +setnetworkactive state + +Disable/enable all p2p network activity. + +Arguments: +1. state (boolean, required) true to enable networking, false to disable + +Result: +true|false (boolean) The value that was passed in + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/analyzepsbt.html b/_doc/en/22.1.1/rpc/rawtransactions/analyzepsbt.html new file mode 100644 index 0000000..cddbf8e --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/analyzepsbt.html @@ -0,0 +1,55 @@ +--- +layout: doc +name: analyzepsbt +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/analyzepsbt/ +--- + +analyzepsbt "psbt" + +Analyzes and provides information about the current status of a PSBT and its inputs + +Arguments: +1. psbt (string, required) A base64 string of a PSBT + +Result: +{ (json object) + "inputs" : [ (json array) + { (json object) + "has_utxo" : true|false, (boolean) Whether a UTXO is provided + "is_final" : true|false, (boolean) Whether the input is finalized + "missing" : { (json object, optional) Things that are missing that are required to complete this input + "pubkeys" : [ (json array, optional) + "hex", (string) Public key ID, hash160 of the public key, of a public key whose BIP 32 derivation path is missing + ... + ], + "signatures" : [ (json array, optional) + "hex", (string) Public key ID, hash160 of the public key, of a public key whose signature is missing + ... + ], + "redeemscript" : "hex", (string, optional) Hash160 of the redeemScript that is missing + "witnessscript" : "hex" (string, optional) SHA256 of the witnessScript that is missing + }, + "next" : "str" (string, optional) Role of the next person that this input needs to go to + }, + ... + ], + "outputs" : [ (json array) + { (json object) + "blind" : true|false, (boolean) whether the output should be blinded + "status" : "str" (string) to what extent the output has been blinded + }, + ... + ], + "estimated_vsize" : n, (numeric, optional) Estimated vsize of the final signed transaction + "estimated_feerate" : n, (numeric, optional) Estimated feerate of the final signed transaction in BTC/kvB. Shown only if all UTXO slots in the PSBT have been filled + "fee" : n, (numeric, optional) The transaction fee paid. Shown only if all UTXO slots in the PSBT have been filled + "next" : "str", (string) Role of the next person that this psbt needs to go to + "error" : "str" (string, optional) Error message (if there is one) +} + +Examples: +> elements-cli analyzepsbt "psbt" + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/calculateasset.html b/_doc/en/22.1.1/rpc/rawtransactions/calculateasset.html new file mode 100644 index 0000000..36131f2 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/calculateasset.html @@ -0,0 +1,26 @@ +--- +layout: doc +name: calculateasset +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/calculateasset/ +--- + +calculateasset "txid" vout ( "asset_entropy" blind_reissuance ) + +Calculate the asset tags and reissuance asset tags for a given prevout and contract hash + +Arguments: +1. txid (string, required) Transaction id of the output that will be spent for this issuance. +2. vout (numeric, required) Output index of the output that will be spent for this issuance. +3. asset_entropy (string) Additional asset entropy to be included in the asset tag. This is the contract hash. +4. blind_reissuance (boolean, optional, default=true) Whether the reissuance asset tag will be blinded + +Result: +{ (json object) + "asset_tag" : "hex", (string) Calculated asset tag. + "reissuance_asset_tag" : "hex", (string) Asset tag for the reissuance tokens. + "final_asset_entropy" : "hex" (string) The calculated asset entropy that is needed for reissuance. +} + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/combinepsbt.html b/_doc/en/22.1.1/rpc/rawtransactions/combinepsbt.html new file mode 100644 index 0000000..1997579 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/combinepsbt.html @@ -0,0 +1,27 @@ +--- +layout: doc +name: combinepsbt +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/combinepsbt/ +--- + +combinepsbt ["psbt",...] + +Combine multiple partially signed Bitcoin transactions into one transaction. +Implements the Combiner role. + +Arguments: +1. txs (json array, required) The base64 strings of partially signed transactions + [ + "psbt", (string) A base64 string of a PSBT + ... + ] + +Result: +"str" (string) The base64-encoded partially signed transaction + +Examples: +> elements-cli combinepsbt '["mybase64_1", "mybase64_2", "mybase64_3"]' + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/combinerawtransaction.html b/_doc/en/22.1.1/rpc/rawtransactions/combinerawtransaction.html new file mode 100644 index 0000000..908440d --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/combinerawtransaction.html @@ -0,0 +1,27 @@ +--- +layout: doc +name: combinerawtransaction +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/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 (json array, required) The hex strings of partially signed transactions + [ + "hexstring", (string) A hex-encoded raw transaction + ... + ] + +Result: +"str" (string) The hex-encoded raw transaction with signature(s) + +Examples: +> elements-cli combinerawtransaction '["myhex1", "myhex2", "myhex3"]' + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/converttopsbt.html b/_doc/en/22.1.1/rpc/rawtransactions/converttopsbt.html new file mode 100644 index 0000000..d9a48cc --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/converttopsbt.html @@ -0,0 +1,36 @@ +--- +layout: doc +name: converttopsbt +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/converttopsbt/ +--- + +converttopsbt "hexstring" ( permitsigdata iswitness ) + +Converts a network serialized transaction to a PSBT. This should be used only with createrawtransaction and fundrawtransaction +createpsbt and walletcreatefundedpsbt should be used for new applications. + +Arguments: +1. hexstring (string, required) The hex string of a raw transaction +2. permitsigdata (boolean, optional, default=false) If true, any signatures in the input will be discarded and conversion + will continue. If false, RPC will fail if any signatures are present. +3. iswitness (boolean, optional, default=depends on heuristic tests) Whether the transaction hex is a serialized witness transaction. + If iswitness is not present, heuristic tests will be used in decoding. + If true, only witness deserialization will be tried. + If false, only non-witness deserialization will be tried. + This boolean should reflect whether the transaction has inputs + (e.g. fully valid, or on-chain transactions), if known by the caller. + +Result: +"str" (string) The resulting raw transaction (base64-encoded string) + +Examples: + +Create a transaction +> elements-cli createrawtransaction "[{\"txid\":\"myid\",\"vout\":0}]" "[{\"data\":\"00010203\"}]" + +Convert the transaction to a PSBT +> elements-cli converttopsbt "rawtransaction" + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/createpsbt.html b/_doc/en/22.1.1/rpc/rawtransactions/createpsbt.html new file mode 100644 index 0000000..d1d24df --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/createpsbt.html @@ -0,0 +1,59 @@ +--- +layout: doc +name: createpsbt +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/createpsbt/ +--- + +createpsbt [{"txid":"hex","vout":n,"sequence":n,"pegin_bitcoin_tx":"hex","pegin_txout_proof":"hex","pegin_claim_script":"hex","issuance_amount":n,"issuance_tokens":n,"asset_entropy":"hex","asset_blinding_nonce":"hex","blind_reissuance":bool},...] [{"address":amount,"blinder_index":n,"asset":"str",...},{"data":"hex"},...] ( locktime replaceable psbt_version ) + +Creates a transaction in the Partially Signed Transaction format. +Implements the Creator role. + +Arguments: +1. inputs (json array, required) The json objects + [ + { (json object) + "txid": "hex", (string, required) The transaction id + "vout": n, (numeric, required) The output number + "sequence": n, (numeric, optional, default=depends on the value of the 'replaceable' and 'locktime' arguments) The sequence number + "pegin_bitcoin_tx": "hex", (string, required) The raw bitcoin transaction (in hex) depositing bitcoin to the mainchain_address generated by getpeginaddress + "pegin_txout_proof": "hex", (string, required) A rawtxoutproof (in hex) generated by the mainchain daemon's `gettxoutproof` containing a proof of only bitcoin_tx + "pegin_claim_script": "hex", (string, required) The witness program generated by getpeginaddress. + "issuance_amount": n, (numeric) The amount to be issued + "issuance_tokens": n, (numeric) The number of asset issuance tokens to generate + "asset_entropy": "hex", (string) For new asset issuance, this is any additional entropy to be used in the asset tag calculation. For reissuance, this is the original asaset entropy + "asset_blinding_nonce": "hex", (string) Do not set for new asset issuance. For reissuance, this is the blinding factor for reissuance token output for the asset being reissued + "blind_reissuance": bool, (boolean, optional, default=true) Whether to mark the issuance input for blinding or not. Only affects issuances with re-issuance tokens. + }, + ... + ] +2. outputs (json array, required) The outputs (key-value pairs), where none of the keys are duplicated. + That is, each address can only appear once and there can only be one 'data' object. + For compatibility reasons, a dictionary, which holds the key-value pairs directly, is also + accepted as second parameter. + [ + { (json object) + "address": amount, (numeric or string, required) A key-value pair. The key (string) is the bitcoin address, the value (float or string) is the amount in BTC + "blinder_index": n, (numeric) The index of the input whose signer will blind this output. Must be provided if this output is to be blinded + "asset": "str", (string) The asset tag for this output if it is not the main chain asset + ... + }, + { (json object) + "data": "hex", (string, required) A key-value pair. The key must be "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. +5. psbt_version (numeric, optional, default=2) The PSBT version number to use. + +Result: +"str" (string) The resulting raw transaction (base64-encoded string) + +Examples: +> elements-cli createpsbt "[{\"txid\":\"myid\",\"vout\":0}]" "[{\"data\":\"00010203\"}]" + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/createrawtransaction.html b/_doc/en/22.1.1/rpc/rawtransactions/createrawtransaction.html new file mode 100644 index 0000000..661382e --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/createrawtransaction.html @@ -0,0 +1,67 @@ +--- +layout: doc +name: createrawtransaction +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/createrawtransaction/ +--- + +createrawtransaction [{"txid":"hex","vout":n,"sequence":n,"pegin_bitcoin_tx":"hex","pegin_txout_proof":"hex","pegin_claim_script":"hex"},...] [{"address":amount,"asset":"str",...},{"data":"hex"},{"vdata":"hex"},{"burn":"hex"},{"fee":amount},...] ( 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 (json array, required) The inputs + [ + { (json object) + "txid": "hex", (string, required) The transaction id + "vout": n, (numeric, required) The output number + "sequence": n, (numeric, optional, default=depends on the value of the 'replaceable' and 'locktime' arguments) The sequence number + "pegin_bitcoin_tx": "hex", (string, optional) (only for pegin inputs) The raw bitcoin transaction (in hex) depositing bitcoin to the mainchain_address generated by getpeginaddress + "pegin_txout_proof": "hex", (string, optional) (only for pegin inputs) A rawtxoutproof (in hex) generated by the mainchain daemon's `gettxoutproof` containing a proof of only bitcoin_tx + "pegin_claim_script": "hex", (string, optional) (only for pegin inputs) The claim script generated by getpeginaddress. + }, + ... + ] +2. outputs (json array, required) The outputs (key-value pairs), where none of the keys are duplicated. + That is, each address can only appear once and there can only be one 'data' object. + For compatibility reasons, a dictionary, which holds the key-value pairs directly, is also + accepted as second parameter. + [ + { (json object) + "address": amount, (numeric or string, required) A key-value pair. The key (string) is the bitcoin address, the value (float or string) is the amount in BTC + "asset": "str", (string) The asset tag for this output if it is not the main chain asset + ... + }, + { (json object) + "data": "hex", (string, required) A key-value pair. The key must be "data", the value is hex-encoded data + }, + { (json object) + "vdata": "hex", (string, required) The key is "vdata", the value is an array of hex encoded data + }, + { (json object) + "burn": "hex", (string, required) A key-value pair. The key must be "burn", the value is the amount that will be burned. + }, + { (json object) + "fee": amount, (numeric or string, required) The key is "fee", the value the fee output you want to add. + }, + ... + ] +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: +"hex" (string) hex string of the transaction + +Examples: +> elements-cli createrawtransaction "[{\"txid\":\"myid\",\"vout\":0}]" "[{\"address\":0.01}]" +> elements-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:7041/ +> 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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/decodepsbt.html b/_doc/en/22.1.1/rpc/rawtransactions/decodepsbt.html new file mode 100644 index 0000000..3483e03 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/decodepsbt.html @@ -0,0 +1,202 @@ +--- +layout: doc +name: decodepsbt +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/decodepsbt/ +--- + +decodepsbt "psbt" + +Return a JSON object representing the serialized, base64-encoded partially signed Bitcoin transaction. + +Note that for Elements, PSBTs (or PSET) follow the Partially Signed Elements Transaction specification. + +Arguments: +1. psbt (string, required) The PSBT base64 string + +Result: +{ (json object) + "tx" : { (json object) The decoded network-serialized unsigned transaction. + ... The layout is the same as the output of decoderawtransaction. + }, + "global_xpubs" : [ (json array) + { (json object) + "xpub" : "str", (string) The extended public key this path corresponds to + "master_fingerprint" : "hex", (string) The fingerprint of the master key + "path" : "str" (string) The path + }, + ... + ], + "tx_version" : n, (numeric) The version number of the unsigned transaction. Not to be confused with PSBT version + "fallback_locktime" : n, (numeric) The locktime to fallback to if no inputs specify a required locktime. + "input_count" : n, (numeric) The number of inputs in this psbt + "output_count" : n, (numeric) The number of outputs in this psbt. + "inputs_modifiable" : n, (numeric) Whether inputs can be modified + "outputs_modifiable" : n, (numeric) Whether outputs can be modified + "sighash_single_indexes" : [ (json array) The indexes which have SIGHASH_SINGLE signatures + n, (numeric) Index of an input with a SIGHASH_SINGLE signature + ... + ], + "psbt_version" : n, (numeric) The PSBT version number. Not to be confused with the unsigned transaction version + "scalar_offsets" : { (json object) The PSET scalar elements + "scalar" : "hex", (string) A scalar offset stored in the PSET + ... + }, + "proprietary" : { (json object) The global proprietary map + "" : { (json object) + "identifier" : "hex", (string) The hex string for the proprietary identifier + "subtype" : n, (numeric) The number for the subtype + "key" : "hex", (string) The hex for the key + "value" : "hex" (string) The hex for the value + } + }, + "unknown" : { (json object) The unknown global fields + "key" : "hex", (string) (key-value pair) An unknown key-value pair + ... + }, + "inputs" : [ (json array) + { (json object) + "non_witness_utxo" : { (json object, optional) Decoded network transaction for non-witness UTXOs + ... + }, + "witness_utxo" : { (json object, optional) Transaction output for witness UTXOs + "amount" : n, (numeric) The value in BTC + "scriptPubKey" : { (json object) + "asm" : "str", (string) The asm + "hex" : "hex", (string) The hex + "type" : "str", (string) The type, eg 'pubkeyhash' + "address" : "str" (string) Bitcoin address if there is one + } + }, + "partial_signatures" : { (json object, optional) + "pubkey" : "str", (string) The public key and signature that corresponds to it. + ... + }, + "sighash" : "str", (string, optional) The sighash type to be used + "redeem_script" : { (json object, optional) + "asm" : "str", (string) The asm + "hex" : "hex", (string) The hex + "type" : "str" (string) The type, eg 'pubkeyhash' + }, + "witness_script" : { (json object, optional) + "asm" : "str", (string) The asm + "hex" : "hex", (string) The hex + "type" : "str" (string) The type, eg 'pubkeyhash' + }, + "bip32_derivs" : [ (json array, optional) + { (json object, optional) The public key with the derivation path as the value. + "master_fingerprint" : "str", (string) The fingerprint of the master key + "path" : "str" (string) The path + }, + ... + ], + "final_scriptsig" : { (json object, optional) + "asm" : "str", (string) The asm + "hex" : "str" (string) The hex + }, + "final_scriptwitness" : [ (json array) + "hex", (string) hex-encoded witness data (if any) + ... + ], + "previous_txid" : "hex", (string) TXID of the transaction containing the output being spent by this input. + "previous_vout" : n, (numeric) Index of the output being spent + "sequence" : n, (numeric) Sequence number for this inputs + "time_locktime" : n, (numeric) Required time-based locktime for this input + "height_locktime" : n, (numeric) Required height-based locktime for this input + "issuance_value" : n, (numeric) The explicit value of the issuance in this input in BTC + "issuance_value_commitment" : "hex", (string) The commitment of the value of the issuance in this input. + "issuance_value_rangeproof" : "hex", (string) The rangeproof for the value commitment of the issuance in this input. + "blind_issuance_value_proof" : "hex", (string) Explicit value rangeproof that proves the issuance value commitment matches the value + "issuance_reissuance_amount" : n, (numeric) The explicit amount available for the reissuance output. + "issuance_reissuance_amount_commitment" : "hex", (string) The commitment of the reissuance amount. + "issuance_reissuance_amount_rangeproof" : "hex", (string) The rangeproof for the amount commitment of the reissuance amount. + "blind_reissuance_amount_proof" : "hex", (string) Explicit value rangeproof that proves the reissuance value commitment matches the reissuance value + "issuance_blinding_nonce" : "hex", (string) The blinding nonce for the issuance in this input. + "issuance_asset_entropy" : "hex", (string) The asset entropy for the issuance in this input. + "pegin_bitcoin_tx" : "hex", (string) The tx providing the peg-in in the format of the getrawtransaction RPC + "pegin_claim_script" : "hex", (string) The claim script for the peg-in input + "pegin_txout_proof" : "hex", (string) The tx providing the peg-in input + "pegin_genesis_hash" : "hex", (string) The hash of the genesis block for this peg-in + "pegin_value" : n, (numeric) The value of this peg-in. + "pegin_witness" : [ (json array) + "hex", (string) hex-encoded witness data (if any) + ... + ], + "utxo_rangeproof" : "hex", (string) The rangeproof for the UTXO + "explicit_value" : n, (numeric, optional) The explicit value for this input + "value_proof" : "hex", (string, optional) The explicit value proof for this input + "explicit_asset" : "hex", (string, optional) The explicit asset for this input + "asset_proof" : "hex", (string, optional) The explicit asset proof for this input + "blinded_issuance" : true|false, (boolean, optional) Whether the issuance should be blinded prior to signing + "unknown" : { (json object) The unknown global fields + "key" : "hex", (string) (key-value pair) An unknown key-value pair + ... + }, + "proprietary" : { (json object) The global proprietary map + "" : { (json object) + "identifier" : "hex", (string) The hex string for the proprietary identifier + "subtype" : n, (numeric) The number for the subtype + "key" : "hex", (string) The hex for the key + "value" : "hex" (string) The hex for the value + } + } + }, + ... + ], + "outputs" : [ (json array) + { (json object) + "redeem_script" : { (json object, optional) + "asm" : "str", (string) The asm + "hex" : "hex", (string) The hex + "type" : "str" (string) The type, eg 'pubkeyhash' + }, + "witness_script" : { (json object, optional) + "asm" : "str", (string) The asm + "hex" : "hex", (string) The hex + "type" : "str" (string) The type, eg 'pubkeyhash' + }, + "bip32_derivs" : [ (json array, optional) + { (json object) + "pubkey" : "str", (string) The public key this path corresponds to + "master_fingerprint" : "str", (string) The fingerprint of the master key + "path" : "str" (string) The path + }, + ... + ], + "amount" : n, (numeric) The amount (nValue) for this output + "script" : { (json object) The output script (scriptPubKey) for this output + ... The layout is the same as the output of scriptPubKeys in decoderawtransaction. + }, + "value_commitment" : "hex", (string) The blinded value of the output + "asset_commiment" : "hex", (string) The blinded asset id of the output + "asset" : "hex", (string) The explicit asset for the output + "rangeproof" : "hex", (string) The rangeproof for the output + "surjection_proof" : "hex", (string) The surjection proof for the output + "ecdh_pubkey" : "hex", (string) The ecdh pubkey for the output + "blinding_pubkey" : "hex", (string) The blinding pubkey for the output + "blind_value_proof" : "hex", (string) Explicit value rangeproof that proves the value commitment matches the value + "blind_asset_proof" : "hex", (string) Assert surjection proof that proves the assert commitment matches the asset + "status" : "str", (string) information about how the output has been blinded, if available + "unknown" : { (json object) The unknown global fields + "key" : "hex", (string) (key-value pair) An unknown key-value pair + ... + }, + "proprietary" : { (json object) The global proprietary map + "" : { (json object) + "identifier" : "hex", (string) The hex string for the proprietary identifier + "subtype" : n, (numeric) The number for the subtype + "key" : "hex", (string) The hex for the key + "value" : "hex" (string) The hex for the value + } + } + }, + ... + ], + "fee" : n (numeric, optional) The transaction fee paid if all UTXOs slots in the PSBT have been filled. +} + +Examples: +> elements-cli decodepsbt "psbt" + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/decoderawtransaction.html b/_doc/en/22.1.1/rpc/rawtransactions/decoderawtransaction.html new file mode 100644 index 0000000..11ffc05 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/decoderawtransaction.html @@ -0,0 +1,71 @@ +--- +layout: doc +name: decoderawtransaction +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/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, default=depends on heuristic tests) Whether the transaction hex is a serialized witness transaction. + If iswitness is not present, heuristic tests will be used in decoding. + If true, only witness deserialization will be tried. + If false, only non-witness deserialization will be tried. + This boolean should reflect whether the transaction has inputs + (e.g. fully valid, or on-chain transactions), if known by the caller. + +Result: +{ (json object) + "txid" : "hex", (string) The transaction id + "hash" : "hex", (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) + "weight" : n, (numeric) The transaction's weight (between vsize*4 - 3 and vsize*4) + "version" : n, (numeric) The version + "locktime" : xxx, (numeric) The lock time + "vin" : [ (json array) + { (json object) + "txid" : "hex", (string) The transaction id + "vout" : n, (numeric) The output number + "scriptSig" : { (json object) The script + "asm" : "str", (string) asm + "hex" : "hex" (string) hex + }, + "txinwitness" : [ (json array) + "hex", (string) hex-encoded witness data (if any) + ... + ], + "sequence" : n (numeric) The script sequence number + }, + ... + ], + "vout" : [ (json array) + { (json object) + "value" : n, (numeric) The value in BTC + "n" : n, (numeric) index + "scriptPubKey" : { (json object) + "asm" : "str", (string) the asm + "hex" : "hex", (string) the hex + "reqSigs" : n, (numeric, optional) (DEPRECATED, returned only if config option -deprecatedrpc=addresses is passed) Number of required signatures + "type" : "str", (string) The type, eg 'pubkeyhash' + "address" : "str", (string, optional) bitcoin address (only if a well-defined address exists) + "addresses" : [ (json array, optional) (DEPRECATED, returned only if config option -deprecatedrpc=addresses is passed) Array of bitcoin addresses + "str", (string) bitcoin address + ... + ] + } + }, + ... + ] +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/decodescript.html b/_doc/en/22.1.1/rpc/rawtransactions/decodescript.html new file mode 100644 index 0000000..4a8fe15 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/decodescript.html @@ -0,0 +1,45 @@ +--- +layout: doc +name: decodescript +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/decodescript/ +--- + +decodescript "hexstring" + +Decode a hex-encoded script. + +Arguments: +1. hexstring (string, required) the hex-encoded script + +Result: +{ (json object) + "asm" : "str", (string) Script public key + "type" : "str", (string) The output type (e.g. nonstandard, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_scripthash, witness_v0_keyhash, witness_v1_taproot, witness_unknown) + "address" : "str", (string, optional) bitcoin address (only if a well-defined address exists) + "reqSigs" : n, (numeric, optional) (DEPRECATED, returned only if config option -deprecatedrpc=addresses is passed) Number of required signatures + "addresses" : [ (json array, optional) (DEPRECATED, returned only if config option -deprecatedrpc=addresses is passed) Array of bitcoin addresses + "str", (string) bitcoin address + ... + ], + "p2sh" : "str", (string) address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH) + "segwit" : { (json object) Result of a witness script public key wrapping this redeem script (not returned if the script is a P2SH or witness) + "asm" : "str", (string) String representation of the script public key + "hex" : "hex", (string) Hex string of the script public key + "type" : "str", (string) The type of the script public key (e.g. witness_v0_keyhash or witness_v0_scripthash) + "address" : "str", (string, optional) bitcoin address (only if a well-defined address exists) + "reqSigs" : n, (numeric, optional) (DEPRECATED, returned only if config option -deprecatedrpc=addresses is passed) Number of required signatures + "addresses" : [ (json array, optional) (DEPRECATED, returned only if config option -deprecatedrpc=addresses is passed) Array of bitcoin addresses + "str", (string) segwit address + ... + ], + "p2sh-segwit" : "str" (string) address of the P2SH script wrapping this witness redeem script + } +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/finalizepsbt.html b/_doc/en/22.1.1/rpc/rawtransactions/finalizepsbt.html new file mode 100644 index 0000000..ef9db14 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/finalizepsbt.html @@ -0,0 +1,30 @@ +--- +layout: doc +name: finalizepsbt +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/finalizepsbt/ +--- + +finalizepsbt "psbt" ( extract ) +Finalize the inputs of a PSBT. If the transaction is fully signed, it will produce a +network serialized transaction which can be broadcast with sendrawtransaction. Otherwise a PSBT will be +created which has the final_scriptSig and final_scriptWitness fields filled for inputs that are complete. +Implements the Finalizer and Extractor roles. + +Arguments: +1. psbt (string, required) A base64 string of a PSBT +2. extract (boolean, optional, default=true) If true and the transaction is complete, + extract and return the complete transaction in normal network serialization instead of the PSBT. + +Result: +{ (json object) + "psbt" : "str", (string) The base64-encoded partially signed transaction if not extracted + "hex" : "hex", (string) The hex-encoded network transaction if extracted + "complete" : true|false (boolean) If the transaction has a complete set of signatures +} + +Examples: +> elements-cli finalizepsbt "psbt" + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/fundrawtransaction.html b/_doc/en/22.1.1/rpc/rawtransactions/fundrawtransaction.html new file mode 100644 index 0000000..c2a7bd2 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/fundrawtransaction.html @@ -0,0 +1,102 @@ +--- +layout: doc +name: fundrawtransaction +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/fundrawtransaction/ +--- + +fundrawtransaction "hexstring" ( options iswitness {"pubkeys":["pubkey",...],"scripts":["script",...],"descriptors":["descriptor",...]} ) + +If the transaction has no inputs, they will be automatically selected to meet its out value. +It 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 signrawtransactionwithkey + or signrawtransactionwithwallet 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 (json object, optional) for backward compatibility: passing in a true instead of an object will result in {"includeWatching":true} + { + "add_inputs": bool, (boolean, optional, default=true) For a transaction with existing inputs, automatically include more if they are not enough. + "include_unsafe": bool, (boolean, optional, default=false) Include inputs that are not safe to spend (unconfirmed transactions from outside keys and unconfirmed replacement transactions). + Warning: the resulting transaction may become invalid if one of the unsafe inputs disappears. + If that happens, you will need to fund the transaction with different inputs and republish it. + "changeAddress": "str", (string, optional, default=pool address) The address to receive the change + "changePosition": n, (numeric, optional, default=random) The index of the change output + "change_type": "str", (string, optional, default=set by -changetype) The output type to use. Only valid if changeAddress is not specified. Options are "legacy", "p2sh-segwit", and "bech32". + "includeWatching": bool, (boolean, optional, default=true for watch-only wallets, otherwise false) Also select inputs which are watch only. + Only solvable inputs can be used. Watch-only destinations are solvable if the public key and/or output script was imported, + e.g. with 'importpubkey' or 'importmulti' with the 'pubkeys' or 'desc' field. + "lockUnspents": bool, (boolean, optional, default=false) Lock selected unspent outputs + "fee_rate": amount, (numeric or string, optional, default=not set, fall back to wallet fee estimation) Specify a fee rate in sat/vB. + "feeRate": amount, (numeric or string, optional, default=not set, fall back to wallet fee estimation) Specify a fee rate in BTC/kvB. + "subtractFeeFromOutputs": [ (json array, optional, default=[]) The integers. + The fee will be equally deducted from the amount of each specified output. + Those recipients will receive less coins than you enter in their corresponding amount field. + If no outputs are specified here, the sender pays the fee. + vout_index, (numeric) The zero-based output index, before a change output is added. + ... + ], + "replaceable": bool, (boolean, optional, default=wallet default) Marks this transaction as BIP125 replaceable. + Allows this transaction to be replaced by a transaction with higher fees + "conf_target": n, (numeric, optional, default=wallet -txconfirmtarget) Confirmation target in blocks + "estimate_mode": "str", (string, optional, default="unset") The fee estimate mode, must be one of (case insensitive): + "unset" + "economical" + "conservative" + } +3. iswitness (boolean, optional, default=depends on heuristic tests) Whether the transaction hex is a serialized witness transaction. + If iswitness is not present, heuristic tests will be used in decoding. + If true, only witness deserialization will be tried. + If false, only non-witness deserialization will be tried. + This boolean should reflect whether the transaction has inputs + (e.g. fully valid, or on-chain transactions), if known by the caller. +4. solving_data (json object, optional) Keys and scripts needed for producing a final transaction with a dummy signature. Used for fee estimation during coin selection. + + { + "pubkeys": [ (json array, optional, default=empty array) A json array of public keys. + + "pubkey", (string) A public key + ... + ], + "scripts": [ (json array, optional, default=empty array) A json array of scripts. + + "script", (string) A script + ... + ], + "descriptors": [ (json array, optional, default=empty array) A json array of descriptors. + + "descriptor", (string) A descriptor + ... + ], + } + +Result: +{ (json object) + "hex" : "hex", (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 +> elements-cli createrawtransaction "[]" "{\"myaddress\":0.01}" + +Add sufficient unsigned inputs to meet the output value +> elements-cli fundrawtransaction "rawtransactionhex" + +Sign the transaction +> elements-cli signrawtransactionwithwallet "fundedtransactionhex" + +Send the transaction +> elements-cli sendrawtransaction "signedtransactionhex" + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/getrawtransaction.html b/_doc/en/22.1.1/rpc/rawtransactions/getrawtransaction.html new file mode 100644 index 0000000..e0cd9f4 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/getrawtransaction.html @@ -0,0 +1,99 @@ +--- +layout: doc +name: getrawtransaction +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/getrawtransaction/ +--- + +getrawtransaction "txid" ( verbose "blockhash" ) + +Return the raw transaction data. + +By default this function only works for mempool transactions. When called with a blockhash +argument, getrawtransaction will return the transaction if the specified block is available and +the transaction is found in that block. When called without a blockhash argument, getrawtransaction +will return the transaction if it is in the mempool, or if -txindex is enabled and the transaction +is in a block in the blockchain. + +Hint: Use gettransaction for wallet transactions. + +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 (boolean, 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): +"str" (string) The serialized, hex-encoded data for 'txid' + +Result (if verbose is set to true): +{ (json object) + "in_active_chain" : true|false, (boolean) Whether specified block is in the active chain or not (only present with explicit "blockhash" argument) + "hex" : "hex", (string) The serialized, hex-encoded data for 'txid' + "txid" : "hex", (string) The transaction id (same as provided) + "hash" : "hex", (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) + "weight" : n, (numeric) The transaction's weight (between vsize*4-3 and vsize*4) + "version" : n, (numeric) The version + "locktime" : xxx, (numeric) The lock time + "vin" : [ (json array) + { (json object) + "txid" : "hex", (string) The transaction id + "vout" : n, (numeric) The output number + "scriptSig" : { (json object) The script + "asm" : "str", (string) asm + "hex" : "hex" (string) hex + }, + "sequence" : n, (numeric) The script sequence number + "txinwitness" : [ (json array) + "hex", (string) hex-encoded witness data (if any) + ... + ] + }, + ... + ], + "vout" : [ (json array) + { (json object) + "value" : n, (numeric) The value in BTC + "n" : n, (numeric) index + "scriptPubKey" : { (json object) + "asm" : "str", (string) the asm + "hex" : "str", (string) the hex + "reqSigs" : n, (numeric, optional) (DEPRECATED, returned only if config option -deprecatedrpc=addresses is passed) Number of required signatures + "type" : "str", (string) The type, eg 'pubkeyhash' + "address" : "str", (string, optional) bitcoin address (only if a well-defined address exists) + "addresses" : [ (json array, optional) (DEPRECATED, returned only if config option -deprecatedrpc=addresses is passed) Array of bitcoin addresses + "str", (string) + ... + ], + "pegout_chain" : "hex", (string) (only pegout) Hash of genesis block of parent chain + "pegout_asm" : "str", (string) (only pegout) pegout scriptpubkey (asm) + "pegout_hex" : "hex", (string) (only pegout) pegout scriptpubkey (hex) + "pegout_type" : "str", (string) (only pegout) The pegout type, eg 'pubkeyhash' + "pegout_address" : "str", (string) (only pegout) + "pegout_addresses" : [ (json array, optional) (DEPRECATED, returned only if config option -deprecatedrpc=addresses is passed) + "str", (string) + ... + ] + } + }, + ... + ], + "blockhash" : "hex", (string) the block hash + "confirmations" : n, (numeric) The confirmations + "blocktime" : xxx, (numeric) The block time expressed in UNIX epoch time + "time" : n (numeric) Same as "blocktime" +} + +Examples: +> elements-cli getrawtransaction "mytxid" +> elements-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:7041/ +> elements-cli getrawtransaction "mytxid" false "myblockhash" +> elements-cli getrawtransaction "mytxid" true "myblockhash" + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/parsepsbt.html b/_doc/en/22.1.1/rpc/rawtransactions/parsepsbt.html new file mode 100644 index 0000000..d46caf1 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/parsepsbt.html @@ -0,0 +1,25 @@ +--- +layout: doc +name: parsepsbt +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/parsepsbt/ +--- + +parsepsbt "psbt" + +parse and print a PSBT. + +Arguments: +1. psbt (string, required) A base64 string of a PSBT + +Result: +{ (json object) + "psbt" : "str", (string) The base64-encoded partially signed transaction + "canonical" : true|false (boolean) Whether the input PSBT matches the output PSBT +} + +Examples: +> elements-cli parsepsbt "psbt" + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/rawblindrawtransaction.html b/_doc/en/22.1.1/rpc/rawtransactions/rawblindrawtransaction.html new file mode 100644 index 0000000..c74e98b --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/rawblindrawtransaction.html @@ -0,0 +1,46 @@ +--- +layout: doc +name: rawblindrawtransaction +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/rawblindrawtransaction/ +--- + +rawblindrawtransaction "hexstring" ["inputamountblinder",...] [inputamount,...] ["inputasset",...] ["inputassetblinder",...] ( "totalblinder" ignoreblindfail ) + +Convert one or more outputs of a raw transaction into confidential ones. +Returns the hex-encoded raw transaction. +The input raw transaction cannot have already-blinded outputs. +The output keys used can be specified by using a confidential address in createrawtransaction. +If an additional blinded output is required to make a balanced blinding, a 0-value unspendable output will be added. Since there is no access to the wallet the blinding pubkey from the last output with blinding key will be repeated. +You can not blind issuances with this call. + +Arguments: +1. hexstring (string, required) A hex-encoded raw transaction. +2. inputamountblinders (json array, required) An array with one entry per transaction input. + [ + "inputamountblinder", (string, required) A hex-encoded blinding factor, one for each input. Blinding factors can be found in the "blinder" output of listunspent. + ... + ] +3. inputamounts (json array, required) An array with one entry per transaction input. + [ + inputamount, (numeric or string, required) An amount for each input. + ... + ] +4. inputassets (json array, required) An array with one entry per transaction input. + [ + "inputasset", (string, required) A hex-encoded asset id, one for each input. + ... + ] +5. inputassetblinders (json array, required) An array with one entry per transaction input. + [ + "inputassetblinder", (string, required) A hex-encoded asset blinding factor, one for each input. + ... + ] +6. totalblinder (string, optional) Ignored for now. +7. ignoreblindfail (boolean, optional, default=true) Return a transaction even when a blinding attempt fails due to number of blinded inputs/outputs. + +Result: +"str" (string) hex string of the transaction + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/rawissueasset.html b/_doc/en/22.1.1/rpc/rawtransactions/rawissueasset.html new file mode 100644 index 0000000..ea13627 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/rawissueasset.html @@ -0,0 +1,40 @@ +--- +layout: doc +name: rawissueasset +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/rawissueasset/ +--- + +rawissueasset "transaction" [{"asset_amount":amount,"asset_address":"str","token_amount":amount,"token_address":"str","blind":bool,"contract_hash":"hex"},...] + +Create an asset by attaching issuances to transaction inputs. Returns the transaction hex. There must be as many inputs as issuances requested. The final transaction hex is the final version of the transaction appended to the last object in the array. + +Arguments: +1. transaction (string, required) Transaction in hex in which to include an issuance input. +2. issuances (json array, required) List of issuances to create. Each issuance must have one non-zero amount. + [ + { (json object, required) + "asset_amount": amount, (numeric or string, optional) Amount of asset to generate, if any. + "asset_address": "str", (string, optional) Destination address of generated asset. Required if `asset_amount` given. + "token_amount": amount, (numeric or string, optional) Amount of reissuance token to generate, if any. + "token_address": "str", (string, optional) Destination address of generated reissuance tokens. Required if `token_amount` given. + "blind": bool, (boolean, optional, default=true) Whether to mark the issuance input for blinding or not. Only affects issuances with re-issuance tokens. + "contract_hash": "hex", (string, optional, default="0000...0000") Contract hash that is put into issuance definition. Must be 32 bytes worth in hex string form. This will affect the asset id. + }, + ... + ] + +Result: +[ (json array) Results of issuances, in the order of `issuances` arguments + { (json object) + "hex" : "hex", (string) The transaction with issuances appended. Only appended to final index in returned array + "vin" : n, (numeric) The input position of the issuance in the transaction + "entropy" : "hex", (string) Entropy of the asset type + "asset" : "hex", (string) Asset type for issuance if known + "token" : "hex" (string) Token type for issuance + }, + ... +] + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/rawreissueasset.html b/_doc/en/22.1.1/rpc/rawtransactions/rawreissueasset.html new file mode 100644 index 0000000..0a5e9e0 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/rawreissueasset.html @@ -0,0 +1,32 @@ +--- +layout: doc +name: rawreissueasset +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/rawreissueasset/ +--- + +rawreissueasset "transaction" [{"asset_amount":amount,"asset_address":"str","input_index":n,"asset_blinder":"hex","entropy":"hex"},...] + +Re-issue an asset by attaching pseudo-inputs to transaction inputs, revealing the underlying reissuance token of the input. Returns the transaction hex. + +Arguments: +1. transaction (string, required) Transaction in hex in which to include an issuance input. +2. reissuances (json array, required) List of re-issuances to create. Each issuance must have one non-zero amount. + [ + { (json object, required) + "asset_amount": amount, (numeric or string, required) Amount of asset to generate, if any. + "asset_address": "str", (string, required) Destination address of generated asset. Required if `asset_amount` given. + "input_index": n, (numeric, required) The input position of the reissuance in the transaction. + "asset_blinder": "hex", (string, required) The blinding factor of the reissuance token output being spent. + "entropy": "hex", (string, required) The `entropy` returned during initial issuance for the asset being reissued. + }, + ... + ] + +Result: +{ (json object) + "hex" : "hex" (string) The transaction with reissuances appended +} + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/sendrawtransaction.html b/_doc/en/22.1.1/rpc/rawtransactions/sendrawtransaction.html new file mode 100644 index 0000000..7395bd9 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/sendrawtransaction.html @@ -0,0 +1,43 @@ +--- +layout: doc +name: sendrawtransaction +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/sendrawtransaction/ +--- + +sendrawtransaction "hexstring" ( maxfeerate ) + +Submit a raw transaction (serialized, hex-encoded) to local node and network. + +The transaction will be sent unconditionally to all peers, so using sendrawtransaction +for manual rebroadcast may degrade privacy by leaking the transaction's origin, as +nodes will normally not rebroadcast non-wallet transactions already in their mempool. + +A specific exception, RPC_TRANSACTION_ALREADY_IN_CHAIN, may throw if the transaction cannot be added to the mempool. + +Related RPCs: createrawtransaction, signrawtransactionwithkey + +Arguments: +1. hexstring (string, required) The hex string of the raw transaction +2. maxfeerate (numeric or string, optional, default="0.10") Reject transactions whose fee rate is higher than the specified value, expressed in BTC/kvB. + Set to 0 to accept any fee rate. + + +Result: +"hex" (string) The transaction hash in hex + +Examples: + +Create a transaction +> elements-cli createrawtransaction "[{\"txid\" : \"mytxid\",\"vout\":0}]" "{\"myaddress\":0.01}" +Sign the transaction, and get back the hex +> elements-cli signrawtransactionwithwallet "myhex" + +Send the transaction (signed hex) +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/signrawtransactionwithkey.html b/_doc/en/22.1.1/rpc/rawtransactions/signrawtransactionwithkey.html new file mode 100644 index 0000000..57db2e5 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/signrawtransactionwithkey.html @@ -0,0 +1,74 @@ +--- +layout: doc +name: signrawtransactionwithkey +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/signrawtransactionwithkey/ +--- + +signrawtransactionwithkey "hexstring" ["privatekey",...] ( [{"txid":"hex","vout":n,"scriptPubKey":"hex","redeemScript":"hex","witnessScript":"hex","amount":amount,"amountcommitment":"hex"},...] "sighashtype" ) + +Sign inputs for raw transaction (serialized, hex-encoded). +The second argument is an array of base58-encoded private +keys that will be the only keys used to sign the transaction. +The third 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. + +Arguments: +1. hexstring (string, required) The transaction hex string +2. privkeys (json array, required) The base58-encoded private keys for signing + [ + "privatekey", (string) private key in base58-encoding + ... + ] +3. prevtxs (json array, optional) The previous dependent transaction outputs + [ + { (json object) + "txid": "hex", (string, required) The transaction id + "vout": n, (numeric, required) The output number + "scriptPubKey": "hex", (string, required) script key + "redeemScript": "hex", (string) (required for P2SH) redeem script + "witnessScript": "hex", (string) (required for P2WSH or P2SH-P2WSH) witness script + "amount": amount, (numeric or string) The amount spent (required if non-confidential segwit output) + "amountcommitment": "hex", (string) The amount commitment spent (required if confidential segwit output) + }, + ... + ] +4. sighashtype (string, optional, default="DEFAULT") The signature hash type. Must be one of: + "DEFAULT" + "ALL" + "NONE" + "SINGLE" + "ALL|ANYONECANPAY" + "NONE|ANYONECANPAY" + "SINGLE|ANYONECANPAY" + "ALL|RANGEPROOF" + "NONE|RANGEPROOF" + "SINGLE|RANGEPROOF" + "ALL|ANYONECANPAY|RANGEPROOF" + "NONE|ANYONECANPAY|RANGEPROOF" + "SINGLE|ANYONECANPAY|RANGEPROOF" + + +Result: +{ (json object) + "hex" : "hex", (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, optional) Script verification errors (if there are any) + { (json object) + "txid" : "hex", (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" : "str" (string) Verification or signing error related to the input + }, + ... + ], + "warning" : "str" (string) Warning that a peg-in input signed may be immature. This could mean lack of connectivity to or misconfiguration of the daemon +} + +Examples: +> elements-cli signrawtransactionwithkey "myhex" "[\"key1\",\"key2\"]" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "signrawtransactionwithkey", "params": ["myhex", "[\"key1\",\"key2\"]"]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/testmempoolaccept.html b/_doc/en/22.1.1/rpc/rawtransactions/testmempoolaccept.html new file mode 100644 index 0000000..0313919 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/testmempoolaccept.html @@ -0,0 +1,64 @@ +--- +layout: doc +name: testmempoolaccept +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/testmempoolaccept/ +--- + +testmempoolaccept ["rawtx",...] ( maxfeerate ) + +Returns result of mempool acceptance tests indicating if raw transaction(s) (serialized, hex-encoded) would be accepted by mempool. + +If multiple transactions are passed in, parents must come before children and package policies apply: the transactions cannot conflict with any mempool transactions or each other. + +If one transaction fails, other transactions may not be fully validated (the 'allowed' key will be blank). + +The maximum number of transactions allowed is 25. + +This checks if transactions violate the consensus or policy rules. + +See sendrawtransaction call. + +Arguments: +1. rawtxs (json array, required) An array of hex strings of raw transactions. + [ + "rawtx", (string) + ... + ] +2. maxfeerate (numeric or string, optional, default="0.10") Reject transactions whose fee rate is higher than the specified value, expressed in BTC/kvB + + +Result: +[ (json array) The result of the mempool acceptance test for each raw transaction in the input array. + Returns results for each transaction in the same order they were passed in. + It is possible for transactions to not be fully validated ('allowed' unset) if another transaction failed. + + { (json object) + "txid" : "hex", (string) The transaction hash in hex + "wtxid" : "hex", (string) The transaction witness hash in hex + "package-error" : "str", (string) Package validation error, if any (only possible if rawtxs had more than 1 transaction). + "allowed" : true|false, (boolean) Whether this tx would be accepted to the mempool and pass client-specified maxfeerate.If not present, the tx was not fully validated due to a failure in another tx in the list. + "vsize" : 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 (only present when 'allowed' is true) + "fees" : { (json object) Transaction fees (only present if 'allowed' is true) + "base" : n (numeric) transaction fee in BTC + }, + "reject-reason" : "str" (string) Rejection string (only present when 'allowed' is false) + }, + ... +] + +Examples: + +Create a transaction +> elements-cli createrawtransaction "[{\"txid\" : \"mytxid\",\"vout\":0}]" "{\"myaddress\":0.01}" +Sign the transaction, and get back the hex +> elements-cli signrawtransactionwithwallet "myhex" + +Test acceptance of the transaction (signed hex) +> elements-cli testmempoolaccept '["signedhex"]' + +As a JSON-RPC call +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "testmempoolaccept", "params": [["signedhex"]]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/updatepsbtpegin.html b/_doc/en/22.1.1/rpc/rawtransactions/updatepsbtpegin.html new file mode 100644 index 0000000..0425169 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/updatepsbtpegin.html @@ -0,0 +1,28 @@ +--- +layout: doc +name: updatepsbtpegin +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/updatepsbtpegin/ +--- + +updatepsbtpegin "psbt" input ( value "bitcoin_tx" "txout_proof" "claim_script" "genesis_hash" ) + +Fill in Peg-in input data for a particular input in a PSBT. Data is filled if provided. + +Arguments: +1. psbt (string, required) The elements PSBT to update +2. input (numeric, required) The index of the input to update +3. value (numeric or string) The value of the peg-in +4. bitcoin_tx (string) The raw bitcoin transaction (in hex) depositing bitcoin to the mainchain_address generated by getpeginaddress +5. txout_proof (string) A rawtxoutproof (in hex) generated by the mainchain daemon'sgettxoutproof containing a proof of only bitcoin_tx +6. claim_script (string) The witness program generated by getpeginaddress. +7. genesis_hash (string) The hash of the genesis block of the chain the bitcoin_tx is in + +Result: +"str" (string) The resulting raw transaction (base64-encoded string) + +Examples: +> elements-cli updatepsbtpegin psbt 0 + + diff --git a/_doc/en/22.1.1/rpc/rawtransactions/utxoupdatepsbt.html b/_doc/en/22.1.1/rpc/rawtransactions/utxoupdatepsbt.html new file mode 100644 index 0000000..520aa67 --- /dev/null +++ b/_doc/en/22.1.1/rpc/rawtransactions/utxoupdatepsbt.html @@ -0,0 +1,31 @@ +--- +layout: doc +name: utxoupdatepsbt +elemversion: 22.1.1 +elemgroup: rawtransactions +permalink: /en/doc/22.1.1/rpc/rawtransactions/utxoupdatepsbt/ +--- + +utxoupdatepsbt "psbt" ( ["",{"desc":"str","range":n or [n,n]},...] ) + +Updates all segwit inputs and outputs in a PSBT with data from output descriptors, the UTXO set or the mempool. + +Arguments: +1. psbt (string, required) A base64 string of a PSBT +2. descriptors (json array, optional) An array of either strings or objects + [ + "", (string) An output descriptor + { (json object) An object with an output descriptor and extra information + "desc": "str", (string, required) An output descriptor + "range": n or [n,n], (numeric or array, optional, default=1000) Up to what index HD chains should be explored (either end or [begin,end]) + }, + ... + ] + +Result: +"str" (string) The base64-encoded partially signed transaction with inputs updated + +Examples: +> elements-cli utxoupdatepsbt "psbt" + + diff --git a/_doc/en/22.1.1/rpc/signer/enumeratesigners.html b/_doc/en/22.1.1/rpc/signer/enumeratesigners.html new file mode 100644 index 0000000..3329dd0 --- /dev/null +++ b/_doc/en/22.1.1/rpc/signer/enumeratesigners.html @@ -0,0 +1,24 @@ +--- +layout: doc +name: enumeratesigners +elemversion: 22.1.1 +elemgroup: signer +permalink: /en/doc/22.1.1/rpc/signer/enumeratesigners/ +--- + +enumeratesigners +Returns a list of external signers from -signer. +Result: +{ (json object) + "signers" : [ (json array) + "hex", (string) Master key fingerprint + "str", (string) Device name + ... + ] +} + +Examples: +> elements-cli enumeratesigners +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "enumeratesigners", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/util/createblindedaddress.html b/_doc/en/22.1.1/rpc/util/createblindedaddress.html new file mode 100644 index 0000000..95cfd47 --- /dev/null +++ b/_doc/en/22.1.1/rpc/util/createblindedaddress.html @@ -0,0 +1,28 @@ +--- +layout: doc +name: createblindedaddress +elemversion: 22.1.1 +elemgroup: util +permalink: /en/doc/22.1.1/rpc/util/createblindedaddress/ +--- + +createblindedaddress "address" "blinding_key" + +Creates a blinded address using the provided blinding key. + +Arguments: +1. address (string, required) The unblinded address to be blinded. +2. blinding_key (string, required) The blinding public key. This can be obtained for a given address using `getaddressinfo` (`confidential_key` field). + +Result: +"str" (string) The blinded address + +Examples: + +Create a blinded address +> elements-cli createblindedaddress HEZk3iQi1jC49bxUriTtynnXgWWWdAYx16 ec09811118b6febfa5ebe68642e5091c418fbace07e655da26b4a845a691fc2d + +As a json rpc call +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "createblindedaddress", "params": [HEZk3iQi1jC49bxUriTtynnXgWWWdAYx16, ec09811118b6febfa5ebe68642e5091c418fbace07e655da26b4a845a691fc2d]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/util/createmultisig.html b/_doc/en/22.1.1/rpc/util/createmultisig.html new file mode 100644 index 0000000..6aa9b89 --- /dev/null +++ b/_doc/en/22.1.1/rpc/util/createmultisig.html @@ -0,0 +1,38 @@ +--- +layout: doc +name: createmultisig +elemversion: 22.1.1 +elemgroup: util +permalink: /en/doc/22.1.1/rpc/util/createmultisig/ +--- + +createmultisig nrequired ["key",...] ( "address_type" ) + +Creates a multi-signature address with n signature of m keys required. +It returns a json object with the address and redeemScript. + +Arguments: +1. nrequired (numeric, required) The number of required signatures out of the n keys. +2. keys (json array, required) The hex-encoded public keys. + [ + "key", (string) The hex-encoded public key + ... + ] +3. address_type (string, optional, default="legacy") The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". + +Result: +{ (json object) + "address" : "str", (string) The value of the new multisig address. + "redeemScript" : "hex", (string) The string value of the hex-encoded redemption script. + "descriptor" : "str" (string) The descriptor for this multisig +} + +Examples: + +Create a multisig address from 2 public keys +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/util/deriveaddresses.html b/_doc/en/22.1.1/rpc/util/deriveaddresses.html new file mode 100644 index 0000000..de569a1 --- /dev/null +++ b/_doc/en/22.1.1/rpc/util/deriveaddresses.html @@ -0,0 +1,36 @@ +--- +layout: doc +name: deriveaddresses +elemversion: 22.1.1 +elemgroup: util +permalink: /en/doc/22.1.1/rpc/util/deriveaddresses/ +--- + +deriveaddresses "descriptor" ( range ) + +Derives one or more addresses corresponding to an output descriptor. +Examples of output descriptors are: + pkh() P2PKH outputs for the given pubkey + wpkh() Native segwit P2PKH outputs for the given pubkey + sh(multi(,,,...)) P2SH-multisig outputs for the given threshold and pubkeys + raw() Outputs whose scriptPubKey equals the specified hex scripts + +In the above, either refers to a fixed public key in hexadecimal notation, or to an xpub/xprv optionally followed by one +or more path elements separated by "/", where "h" represents a hardened child key. +For more information on output descriptors, see the documentation in the doc/descriptors.md file. + +Arguments: +1. descriptor (string, required) The descriptor. +2. range (numeric or array, optional) If a ranged descriptor is used, this specifies the end or the range (in [begin,end] notation) to derive. + +Result: +[ (json array) + "str", (string) the derived addresses + ... +] + +Examples: +First three native segwit receive addresses +> elements-cli deriveaddresses "wpkh([d34db33f/84h/0h/0h]xpub6DJ2dNUysrn5Vt36jH2KLBT2i1auw1tTSSomg8PhqNiUtx8QX2SvC9nrHu81fT41fvDUnhMjEzQgXnQjKEu3oaqMSzhSrHMxyyoEAmUHQbY/0/*)#cjjspncu" "[0,2]" + + diff --git a/_doc/en/22.1.1/rpc/util/dumpassetlabels.html b/_doc/en/22.1.1/rpc/util/dumpassetlabels.html new file mode 100644 index 0000000..3ed2b2f --- /dev/null +++ b/_doc/en/22.1.1/rpc/util/dumpassetlabels.html @@ -0,0 +1,22 @@ +--- +layout: doc +name: dumpassetlabels +elemversion: 22.1.1 +elemgroup: util +permalink: /en/doc/22.1.1/rpc/util/dumpassetlabels/ +--- + +dumpassetlabels + +Lists all known asset id/label pairs in this wallet. This list can be modified with `-assetdir` configuration argument. + +Result: +{ (json object) + ... the label for each asset id +} + +Examples: +> elements-cli dumpassetlabels +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "dumpassetlabels", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/util/estimatesmartfee.html b/_doc/en/22.1.1/rpc/util/estimatesmartfee.html new file mode 100644 index 0000000..f0decd7 --- /dev/null +++ b/_doc/en/22.1.1/rpc/util/estimatesmartfee.html @@ -0,0 +1,45 @@ +--- +layout: doc +name: estimatesmartfee +elemversion: 22.1.1 +elemgroup: util +permalink: /en/doc/22.1.1/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, required) 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 (case insensitive): + "unset" + "economical" + "conservative" + +Result: +{ (json object) + "feerate" : n, (numeric, optional) estimate fee rate in BTC/kvB (only present if no errors were encountered) + "errors" : [ (json array, optional) Errors encountered during processing (if there are any) + "str", (string) error + ... + ], + "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. +} + +Examples: +> elements-cli estimatesmartfee 6 + + diff --git a/_doc/en/22.1.1/rpc/util/getdescriptorinfo.html b/_doc/en/22.1.1/rpc/util/getdescriptorinfo.html new file mode 100644 index 0000000..576cba9 --- /dev/null +++ b/_doc/en/22.1.1/rpc/util/getdescriptorinfo.html @@ -0,0 +1,29 @@ +--- +layout: doc +name: getdescriptorinfo +elemversion: 22.1.1 +elemgroup: util +permalink: /en/doc/22.1.1/rpc/util/getdescriptorinfo/ +--- + +getdescriptorinfo "descriptor" + +Analyses a descriptor. + +Arguments: +1. descriptor (string, required) The descriptor. + +Result: +{ (json object) + "descriptor" : "str", (string) The descriptor in canonical form, without private keys + "checksum" : "str", (string) The checksum for the input descriptor + "isrange" : true|false, (boolean) Whether the descriptor is ranged + "issolvable" : true|false, (boolean) Whether the descriptor is solvable + "hasprivatekeys" : true|false (boolean) Whether the input descriptor contained at least one private key +} + +Examples: +Analyse a descriptor +> elements-cli getdescriptorinfo "wpkh([d34db33f/84h/0h/0h]0279be667ef9dcbbac55a06295Ce870b07029Bfcdb2dce28d959f2815b16f81798)" + + diff --git a/_doc/en/22.1.1/rpc/util/getindexinfo.html b/_doc/en/22.1.1/rpc/util/getindexinfo.html new file mode 100644 index 0000000..2c481a5 --- /dev/null +++ b/_doc/en/22.1.1/rpc/util/getindexinfo.html @@ -0,0 +1,30 @@ +--- +layout: doc +name: getindexinfo +elemversion: 22.1.1 +elemgroup: util +permalink: /en/doc/22.1.1/rpc/util/getindexinfo/ +--- + +getindexinfo ( "index_name" ) + +Returns the status of one or all available indices currently running in the node. + +Arguments: +1. index_name (string, optional) Filter results for an index with a specific name. + +Result: +{ (json object) + "name" : { (json object) The name of the index + "synced" : true|false, (boolean) Whether the index is synced or not + "best_block_height" : n (numeric) The block height to which the index is synced + } +} + +Examples: +> elements-cli getindexinfo +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getindexinfo", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ +> elements-cli getindexinfo txindex +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getindexinfo", "params": [txindex]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/util/getpakinfo.html b/_doc/en/22.1.1/rpc/util/getpakinfo.html new file mode 100644 index 0000000..605c47e --- /dev/null +++ b/_doc/en/22.1.1/rpc/util/getpakinfo.html @@ -0,0 +1,20 @@ +--- +layout: doc +name: getpakinfo +elemversion: 22.1.1 +elemgroup: util +permalink: /en/doc/22.1.1/rpc/util/getpakinfo/ +--- + +getpakinfo + +Returns relevant pegout authorization key (PAK) information about this node, both from blockchain data. + +Result: +{ (json object) + "block_paklist" : [ (json array) The PAK list loaded from latest epoch + ... + ] +} + + diff --git a/_doc/en/22.1.1/rpc/util/signmessagewithprivkey.html b/_doc/en/22.1.1/rpc/util/signmessagewithprivkey.html new file mode 100644 index 0000000..bbd40d2 --- /dev/null +++ b/_doc/en/22.1.1/rpc/util/signmessagewithprivkey.html @@ -0,0 +1,31 @@ +--- +layout: doc +name: signmessagewithprivkey +elemversion: 22.1.1 +elemgroup: util +permalink: /en/doc/22.1.1/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: +"str" (string) The signature of the message encoded in base 64 + +Examples: + +Create the signature +> elements-cli signmessagewithprivkey "privkey" "my message" + +Verify the signature +> elements-cli verifymessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "signature" "my message" + +As a JSON-RPC call +> 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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/util/tweakfedpegscript.html b/_doc/en/22.1.1/rpc/util/tweakfedpegscript.html new file mode 100644 index 0000000..e72e3b0 --- /dev/null +++ b/_doc/en/22.1.1/rpc/util/tweakfedpegscript.html @@ -0,0 +1,23 @@ +--- +layout: doc +name: tweakfedpegscript +elemversion: 22.1.1 +elemgroup: util +permalink: /en/doc/22.1.1/rpc/util/tweakfedpegscript/ +--- + +tweakfedpegscript "claim_script" ( "fedpegscript" ) + +Returns a tweaked fedpegscript. + +Arguments: +1. claim_script (string, required) Script to tweak the fedpegscript with. For example obtained as a result of getpeginaddress. +2. fedpegscript (string, optional) Fedpegscript to be used with the claim_script. By default this is the current fedpegscript. + +Result: +{ (json object) + "script" : "hex", (string) The fedpegscript tweaked with claim_script + "address" : "str" (string) The address corresponding to the tweaked fedpegscript +} + + diff --git a/_doc/en/22.1.1/rpc/util/validateaddress.html b/_doc/en/22.1.1/rpc/util/validateaddress.html new file mode 100644 index 0000000..f16b893 --- /dev/null +++ b/_doc/en/22.1.1/rpc/util/validateaddress.html @@ -0,0 +1,40 @@ +--- +layout: doc +name: validateaddress +elemversion: 22.1.1 +elemgroup: util +permalink: /en/doc/22.1.1/rpc/util/validateaddress/ +--- + +validateaddress "address" + +Return information about the given bitcoin address. + +Arguments: +1. address (string, required) The bitcoin address to validate + +Result: +{ (json object) + "isvalid" : true|false, (boolean) If the address is valid or not + "isvalid_parent" : true|false, (boolean) If the address is valid or not for parent chain + "address" : "str", (string) The bitcoin address validated + "scriptPubKey" : "hex", (string) The hex-encoded scriptPubKey generated by the address + "isscript" : true|false, (boolean) If the key is a script + "iswitness" : true|false, (boolean) If the address is a witness address + "witness_version" : n, (numeric, optional) The version number of the witness program + "witness_program" : "hex", (string, optional) The hex value of the witness program + "confidential_key" : "hex", (string) the raw blinding public key for that address, if any. "" if none + "unconfidential" : "str", (string) The address without confidentiality key + "parent_address_info" : { (json object) If the address isvalid_parent, this object contains details about the parent address type + "address" : "str", (string) + "scriptPubKey" : "hex" (string) + }, + "error" : "str", (string, optional) Error message, if any + "error_parent" : "str" (string, optional) Error message, if any +} + +Examples: +> elements-cli validateaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "validateaddress", "params": ["bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl"]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/util/verifymessage.html b/_doc/en/22.1.1/rpc/util/verifymessage.html new file mode 100644 index 0000000..3c2b0ee --- /dev/null +++ b/_doc/en/22.1.1/rpc/util/verifymessage.html @@ -0,0 +1,35 @@ +--- +layout: doc +name: verifymessage +elemversion: 22.1.1 +elemgroup: util +permalink: /en/doc/22.1.1/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 +> elements-cli walletpassphrase "mypassphrase" 30 + +Create the signature +> elements-cli signmessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "my message" + +Verify the signature +> elements-cli verifymessage "1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX" "signature" "my message" + +As a JSON-RPC call +> 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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/abandontransaction.html b/_doc/en/22.1.1/rpc/wallet/abandontransaction.html new file mode 100644 index 0000000..a20b95d --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/abandontransaction.html @@ -0,0 +1,27 @@ +--- +layout: doc +name: abandontransaction +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/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 abandoned. + +Arguments: +1. txid (string, required) The transaction id + +Result: +null (json null) + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/abortrescan.html b/_doc/en/22.1.1/rpc/wallet/abortrescan.html new file mode 100644 index 0000000..c97300b --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/abortrescan.html @@ -0,0 +1,28 @@ +--- +layout: doc +name: abortrescan +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/abortrescan/ +--- + +abortrescan + +Stops current wallet rescan triggered by an RPC call, e.g. by an importprivkey call. +Note: Use "getwalletinfo" to query the scanning progress. + +Result: +true|false (boolean) Whether the abort was successful + +Examples: + +Import a private key +> elements-cli importprivkey "mykey" + +Abort the running wallet rescan +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/addmultisigaddress.html b/_doc/en/22.1.1/rpc/wallet/addmultisigaddress.html new file mode 100644 index 0000000..c552160 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/addmultisigaddress.html @@ -0,0 +1,42 @@ +--- +layout: doc +name: addmultisigaddress +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/addmultisigaddress/ +--- + +addmultisigaddress nrequired ["key",...] ( "label" "address_type" ) + +Add an 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 'label' is specified, assign address to that label. + +Arguments: +1. nrequired (numeric, required) The number of required signatures out of the n keys or addresses. +2. keys (json array, required) The addresses or hex-encoded public keys + [ + "key", (string) address or hex-encoded public key + ... + ] +3. label (string, optional) A label to assign the addresses to. +4. address_type (string, optional, default=set by -addresstype) The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". + +Result: +{ (json object) + "address" : "str", (string) The value of the new multisig address + "redeemScript" : "hex", (string) The string value of the hex-encoded redemption script + "descriptor" : "str" (string) The descriptor for this multisig +} + +Examples: + +Add a multisig address from 2 addresses +> elements-cli addmultisigaddress 2 "[\"bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl\",\"bc1q02ad21edsxd23d32dfgqqsz4vv4nmtfzuklhy3\"]" + +As a JSON-RPC call +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "addmultisigaddress", "params": [2, "[\"bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl\",\"bc1q02ad21edsxd23d32dfgqqsz4vv4nmtfzuklhy3\"]"]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/backupwallet.html b/_doc/en/22.1.1/rpc/wallet/backupwallet.html new file mode 100644 index 0000000..0d628f6 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/backupwallet.html @@ -0,0 +1,23 @@ +--- +layout: doc +name: backupwallet +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/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, required) The destination directory or file + +Result: +null (json null) + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/blindrawtransaction.html b/_doc/en/22.1.1/rpc/wallet/blindrawtransaction.html new file mode 100644 index 0000000..722663a --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/blindrawtransaction.html @@ -0,0 +1,30 @@ +--- +layout: doc +name: blindrawtransaction +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/blindrawtransaction/ +--- + +blindrawtransaction "hexstring" ( ignoreblindfail ["assetcommitment",...] blind_issuances "totalblinder" ) + +Convert one or more outputs of a raw transaction into confidential ones using only wallet inputs. +Returns the hex-encoded raw transaction. +The output keys used can be specified by using a confidential address in createrawtransaction. +This call may add an additional 0-value unspendable output in order to balance the blinders. + +Arguments: +1. hexstring (string, required) A hex-encoded raw transaction. +2. ignoreblindfail (boolean, optional, default=true) Return a transaction even when a blinding attempt fails due to number of blinded inputs/outputs. +3. asset_commitments (json array, optional) An array of input asset generators. If provided, this list must be empty, or match the final input commitment list, including ordering, to make a valid surjection proof. This list does not include generators for issuances, as these assets are inherently unblinded. + [ + "assetcommitment", (string) A hex-encoded asset commitment, one for each input. Null commitments must be "". + ... + ] +4. blind_issuances (boolean, optional, default=true) Blind the issuances found in the raw transaction or not. All issuances will be blinded if true. +5. totalblinder (string) Ignored for now. + +Result: +"hex" (string) serialized transaction + + diff --git a/_doc/en/22.1.1/rpc/wallet/bumpfee.html b/_doc/en/22.1.1/rpc/wallet/bumpfee.html new file mode 100644 index 0000000..d3f9b19 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/bumpfee.html @@ -0,0 +1,65 @@ +--- +layout: doc +name: bumpfee +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/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 reducing change outputs or adding inputs when necessary. +It may add a new change output if one does not already exist. +All inputs in the original transaction will be included in the replacement transaction. +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 the estimatesmartfee RPC. +The user can specify a confirmation target for estimatesmartfee. +Alternatively, the user can specify a fee rate in sat/vB for the new transaction. +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. +* WARNING: before version 0.21, fee_rate was in BTC/kvB. As of 0.21, fee_rate is in sat/vB. * + +Arguments: +1. txid (string, required) The txid to be bumped +2. options (json object, optional) + { + "conf_target": n, (numeric, optional, default=wallet -txconfirmtarget) Confirmation target in blocks + + "fee_rate": amount, (numeric or string, optional, default=not set, fall back to wallet fee estimation) + Specify a fee rate in sat/vB instead of relying on the built-in fee estimator. + Must be at least 0.100 sat/vB higher than the current transaction fee rate. + WARNING: before version 0.21, fee_rate was in BTC/kvB. As of 0.21, fee_rate is in sat/vB. + + "replaceable": bool, (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": "str", (string, optional, default="unset") The fee estimate mode, must be one of (case insensitive): + "unset" + "economical" + "conservative" + } + +Result: +{ (json object) + "txid" : "hex", (string) The id of the new transaction. + "origfee" : n, (numeric) The fee of the replaced transaction. + "fee" : n, (numeric) The fee of the new transaction. + "errors" : [ (json array) Errors encountered during processing (may be empty). + "str", (string) + ... + ] +} + +Examples: + +Bump the fee, get the new transaction's txid +> elements-cli bumpfee + + diff --git a/_doc/en/22.1.1/rpc/wallet/claimpegin.html b/_doc/en/22.1.1/rpc/wallet/claimpegin.html new file mode 100644 index 0000000..f18d5b3 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/claimpegin.html @@ -0,0 +1,27 @@ +--- +layout: doc +name: claimpegin +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/claimpegin/ +--- + +claimpegin "bitcoin_tx" "txoutproof" ( "claim_script" ) + +Claim coins from the main chain by creating a pegin transaction with the necessary metadata after the corresponding Bitcoin transaction. +Note that the transaction will not be relayed unless it is buried at least 102 blocks deep. +If a transaction is not relayed it may require manual addition to a functionary mempool in order for it to be mined. + +Arguments: +1. bitcoin_tx (string, required) The raw bitcoin transaction (in hex) depositing bitcoin to the mainchain_address generated by getpeginaddress +2. txoutproof (string, required) A rawtxoutproof (in hex) generated by the mainchain daemon's `gettxoutproof` containing a proof of only bitcoin_tx +3. claim_script (string, optional) The witness program generated by getpeginaddress. Only needed if not in wallet. + +Result: +"hex" (string) txid of the resulting sidechain transaction + +Examples: +> elements-cli claimpegin "0200000002b80a99d63ca943d72141750d983a3eeda3a5c5a92aa962884ffb141eb49ffb4f000000006a473044022031ffe1d76decdfbbdb7e2ee6010e865a5134137c261e1921da0348b95a207f9e02203596b065c197e31bcc2f80575154774ac4e80acd7d812c91d93c4ca6a3636f27012102d2130dfbbae9bd27eee126182a39878ac4e117d0850f04db0326981f43447f9efeffffffb80a99d63ca943d72141750d983a3eeda3a5c5a92aa962884ffb141eb49ffb4f010000006b483045022100cf041ce0eb249ae5a6bc33c71c156549c7e5ad877ae39e2e3b9c8f1d81ed35060220472d4e4bcc3b7c8d1b34e467f46d80480959183d743dad73b1ed0e93ec9fd14f012103e73e8b55478ab9c5de22e2a9e73c3e6aca2c2e93cd2bad5dc4436a9a455a5c44feffffff0200e1f5050000000017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87e86cbe00000000001976a914a25fe72e7139fd3f61936b228d657b2548b3936a88acc0020000" "00000020976e918ed537b0f99028648f2a25c0bd4513644fb84d9cbe1108b4df6b8edf6ba715c424110f0934265bf8c5763d9cc9f1675a0f728b35b9bc5875f6806be3d19cd5b159ffff7f2000000000020000000224eab3da09d99407cb79f0089e3257414c4121cb85a320e1fd0f88678b6b798e0713a8d66544b6f631f9b6d281c71633fb91a67619b189a06bab09794d5554a60105" "0014058c769ffc7d12c35cddec87384506f536383f9c" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "claimpegin", "params": ["0200000002b80a99d63ca943d72141750d983a3eeda3a5c5a92aa962884ffb141eb49ffb4f000000006a473044022031ffe1d76decdfbbdb7e2ee6010e865a5134137c261e1921da0348b95a207f9e02203596b065c197e31bcc2f80575154774ac4e80acd7d812c91d93c4ca6a3636f27012102d2130dfbbae9bd27eee126182a39878ac4e117d0850f04db0326981f43447f9efeffffffb80a99d63ca943d72141750d983a3eeda3a5c5a92aa962884ffb141eb49ffb4f010000006b483045022100cf041ce0eb249ae5a6bc33c71c156549c7e5ad877ae39e2e3b9c8f1d81ed35060220472d4e4bcc3b7c8d1b34e467f46d80480959183d743dad73b1ed0e93ec9fd14f012103e73e8b55478ab9c5de22e2a9e73c3e6aca2c2e93cd2bad5dc4436a9a455a5c44feffffff0200e1f5050000000017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87e86cbe00000000001976a914a25fe72e7139fd3f61936b228d657b2548b3936a88acc0020000", "00000020976e918ed537b0f99028648f2a25c0bd4513644fb84d9cbe1108b4df6b8edf6ba715c424110f0934265bf8c5763d9cc9f1675a0f728b35b9bc5875f6806be3d19cd5b159ffff7f2000000000020000000224eab3da09d99407cb79f0089e3257414c4121cb85a320e1fd0f88678b6b798e0713a8d66544b6f631f9b6d281c71633fb91a67619b189a06bab09794d5554a60105", "0014058c769ffc7d12c35cddec87384506f536383f9c"]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/createrawpegin.html b/_doc/en/22.1.1/rpc/wallet/createrawpegin.html new file mode 100644 index 0000000..be712a3 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/createrawpegin.html @@ -0,0 +1,30 @@ +--- +layout: doc +name: createrawpegin +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/createrawpegin/ +--- + +createrawpegin "bitcoin_tx" "txoutproof" ( "claim_script" ) + +Creates a raw transaction to claim coins from the main chain by creating a pegin transaction with the necessary metadata after the corresponding Bitcoin transaction. +Note that this call will not sign the transaction. +If a transaction is not relayed it may require manual addition to a functionary mempool in order for it to be mined. + +Arguments: +1. bitcoin_tx (string, required) The raw bitcoin transaction (in hex) depositing bitcoin to the mainchain_address generated by getpeginaddress +2. txoutproof (string, required) A rawtxoutproof (in hex) generated by the mainchain daemon's `gettxoutproof` containing a proof of only bitcoin_tx +3. claim_script (string, optional) The witness program generated by getpeginaddress. Only needed if not in wallet. + +Result: +{ (json object) + "hex" : "str", (string) raw transaction data + "mature" : true|false (boolean) Whether the peg-in is mature (only included when validating peg-ins) +} + +Examples: +> elements-cli createrawpegin "0200000002b80a99d63ca943d72141750d983a3eeda3a5c5a92aa962884ffb141eb49ffb4f000000006a473044022031ffe1d76decdfbbdb7e2ee6010e865a5134137c261e1921da0348b95a207f9e02203596b065c197e31bcc2f80575154774ac4e80acd7d812c91d93c4ca6a3636f27012102d2130dfbbae9bd27eee126182a39878ac4e117d0850f04db0326981f43447f9efeffffffb80a99d63ca943d72141750d983a3eeda3a5c5a92aa962884ffb141eb49ffb4f010000006b483045022100cf041ce0eb249ae5a6bc33c71c156549c7e5ad877ae39e2e3b9c8f1d81ed35060220472d4e4bcc3b7c8d1b34e467f46d80480959183d743dad73b1ed0e93ec9fd14f012103e73e8b55478ab9c5de22e2a9e73c3e6aca2c2e93cd2bad5dc4436a9a455a5c44feffffff0200e1f5050000000017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87e86cbe00000000001976a914a25fe72e7139fd3f61936b228d657b2548b3936a88acc0020000", "00000020976e918ed537b0f99028648f2a25c0bd4513644fb84d9cbe1108b4df6b8edf6ba715c424110f0934265bf8c5763d9cc9f1675a0f728b35b9bc5875f6806be3d19cd5b159ffff7f2000000000020000000224eab3da09d99407cb79f0089e3257414c4121cb85a320e1fd0f88678b6b798e0713a8d66544b6f631f9b6d281c71633fb91a67619b189a06bab09794d5554a60105" "0014058c769ffc7d12c35cddec87384506f536383f9c" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "createrawpegin", "params": ["0200000002b80a99d63ca943d72141750d983a3eeda3a5c5a92aa962884ffb141eb49ffb4f000000006a473044022031ffe1d76decdfbbdb7e2ee6010e865a5134137c261e1921da0348b95a207f9e02203596b065c197e31bcc2f80575154774ac4e80acd7d812c91d93c4ca6a3636f27012102d2130dfbbae9bd27eee126182a39878ac4e117d0850f04db0326981f43447f9efeffffffb80a99d63ca943d72141750d983a3eeda3a5c5a92aa962884ffb141eb49ffb4f010000006b483045022100cf041ce0eb249ae5a6bc33c71c156549c7e5ad877ae39e2e3b9c8f1d81ed35060220472d4e4bcc3b7c8d1b34e467f46d80480959183d743dad73b1ed0e93ec9fd14f012103e73e8b55478ab9c5de22e2a9e73c3e6aca2c2e93cd2bad5dc4436a9a455a5c44feffffff0200e1f5050000000017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87e86cbe00000000001976a914a25fe72e7139fd3f61936b228d657b2548b3936a88acc0020000", "00000020976e918ed537b0f99028648f2a25c0bd4513644fb84d9cbe1108b4df6b8edf6ba715c424110f0934265bf8c5763d9cc9f1675a0f728b35b9bc5875f6806be3d19cd5b159ffff7f2000000000020000000224eab3da09d99407cb79f0089e3257414c4121cb85a320e1fd0f88678b6b798e0713a8d66544b6f631f9b6d281c71633fb91a67619b189a06bab09794d5554a60105", "0014058c769ffc7d12c35cddec87384506f536383f9c"]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/createwallet.html b/_doc/en/22.1.1/rpc/wallet/createwallet.html new file mode 100644 index 0000000..7ea94ee --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/createwallet.html @@ -0,0 +1,35 @@ +--- +layout: doc +name: createwallet +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/createwallet/ +--- + +createwallet "wallet_name" ( disable_private_keys blank "passphrase" avoid_reuse descriptors load_on_startup external_signer ) + +Creates and loads a new wallet. + +Arguments: +1. wallet_name (string, required) The name for the new wallet. If this is a path, the wallet will be created at the path location. +2. disable_private_keys (boolean, optional, default=false) Disable the possibility of private keys (only watchonlys are possible in this mode). +3. blank (boolean, optional, default=false) Create a blank wallet. A blank wallet has no keys or HD seed. One can be set using sethdseed. +4. passphrase (string, optional) Encrypt the wallet with this passphrase. +5. avoid_reuse (boolean, optional, default=false) Keep track of coin reuse, and treat dirty and clean coins differently with privacy considerations in mind. +6. descriptors (boolean, optional, default=false) Create a native descriptor wallet. The wallet will use descriptors internally to handle address creation +7. load_on_startup (boolean, optional) Save wallet name to persistent settings and load on startup. True to add wallet to startup list, false to remove, null to leave unchanged. +8. external_signer (boolean, optional, default=false) Use an external signer such as a hardware wallet. Requires -signer to be configured. Wallet creation will fail if keys cannot be fetched. Requires disable_private_keys and descriptors set to true. + +Result: +{ (json object) + "name" : "str", (string) The wallet name if created successfully. If the wallet was created using a full path, the wallet_name will be the full path. + "warning" : "str" (string) Warning message if wallet was not loaded cleanly. +} + +Examples: +> elements-cli createwallet "testwallet" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "createwallet", "params": ["testwallet"]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ +> bitcoin-cli -named createwallet wallet_name=descriptors avoid_reuse=true descriptors=true load_on_startup=true +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "createwallet", "params": {"wallet_name":"descriptors","avoid_reuse":true,"descriptors":true,"load_on_startup":true}}' -H 'content-type: text/plain;' http://127.0.0.1:8332/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/destroyamount.html b/_doc/en/22.1.1/rpc/wallet/destroyamount.html new file mode 100644 index 0000000..675925e --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/destroyamount.html @@ -0,0 +1,35 @@ +--- +layout: doc +name: destroyamount +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/destroyamount/ +--- + +destroyamount "asset" amount ( "comment" verbose ) + +Destroy an amount of a given asset. + + +Arguments: +1. asset (string, required) Hex asset id or asset label to destroy. +2. amount (numeric or string, required) The amount to destroy (8 decimals above the minimal unit). +3. comment (string, optional) A comment used to store what the transaction is for. + This is not part of the transaction, just kept in your wallet. +4. verbose (boolean, optional, default=false) If true, return extra information about the transaction. + +Result (if verbose is not set or set to false): +"hex" (string) the transaction id + +Result (if verbose is set to true): +{ (json object) + "transactionid" : "hex", (string) the transaction id + "fee reason" : "str" (string) The transaction fee reason. +} + +Examples: +> elements-cli destroyamount "bitcoin" 100 +> elements-cli destroyamount "bitcoin" 100 "destroy assets" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "destroyamount", "params": ["bitcoin" 100 "destroy assets"]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/dumpblindingkey.html b/_doc/en/22.1.1/rpc/wallet/dumpblindingkey.html new file mode 100644 index 0000000..317123c --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/dumpblindingkey.html @@ -0,0 +1,22 @@ +--- +layout: doc +name: dumpblindingkey +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/dumpblindingkey/ +--- + +dumpblindingkey "address" + +Dumps the private blinding key for a CT address in hex. +Note: If the address is not a CT address, looks for blinding key corresponding to this non-CT address. +Arguments: +1. address (string, required) The CT address + +Result: +"str" (string) the blinding key + +Examples: +> elements-cli dumpblindingkey "my address" + + diff --git a/_doc/en/22.1.1/rpc/wallet/dumpissuanceblindingkey.html b/_doc/en/22.1.1/rpc/wallet/dumpissuanceblindingkey.html new file mode 100644 index 0000000..8b082b0 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/dumpissuanceblindingkey.html @@ -0,0 +1,22 @@ +--- +layout: doc +name: dumpissuanceblindingkey +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/dumpissuanceblindingkey/ +--- + +dumpissuanceblindingkey "txid" vin + +Dumps the private blinding key for an asset issuance in wallet. +Arguments: +1. txid (string, required) The transaction id of the issuance +2. vin (numeric, required) The input number of the issuance in the transaction. + +Result: +"str" (string) the issuance blinding key + +Examples: +> elements-cli dumpissuanceblindingkey "", 0 + + diff --git a/_doc/en/22.1.1/rpc/wallet/dumpmasterblindingkey.html b/_doc/en/22.1.1/rpc/wallet/dumpmasterblindingkey.html new file mode 100644 index 0000000..353b67e --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/dumpmasterblindingkey.html @@ -0,0 +1,18 @@ +--- +layout: doc +name: dumpmasterblindingkey +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/dumpmasterblindingkey/ +--- + +dumpmasterblindingkey + +Dumps the master private blinding key in hex. +Result: +"str" (string) the master blinding key + +Examples: +> elements-cli dumpmasterblindingkey + + diff --git a/_doc/en/22.1.1/rpc/wallet/dumpprivkey.html b/_doc/en/22.1.1/rpc/wallet/dumpprivkey.html new file mode 100644 index 0000000..4e7d1a1 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/dumpprivkey.html @@ -0,0 +1,25 @@ +--- +layout: doc +name: dumpprivkey +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/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: +"str" (string) The private key + +Examples: +> elements-cli dumpprivkey "myaddress" +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/dumpwallet.html b/_doc/en/22.1.1/rpc/wallet/dumpwallet.html new file mode 100644 index 0000000..b2a9b17 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/dumpwallet.html @@ -0,0 +1,28 @@ +--- +layout: doc +name: dumpwallet +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/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 (absolute path recommended) + +Result: +{ (json object) + "filename" : "str" (string) The filename with full absolute path +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/encryptwallet.html b/_doc/en/22.1.1/rpc/wallet/encryptwallet.html new file mode 100644 index 0000000..59b3a7b --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/encryptwallet.html @@ -0,0 +1,40 @@ +--- +layout: doc +name: encryptwallet +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/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. + +Arguments: +1. passphrase (string, required) The pass phrase to encrypt the wallet with. It must be at least 1 character, but should be long. + +Result: +"str" (string) A string with further instructions + +Examples: + +Encrypt your wallet +> elements-cli encryptwallet "my pass phrase" + +Now set the passphrase to use the wallet, such as for signing or sending bitcoin +> elements-cli walletpassphrase "my pass phrase" + +Now we can do something like sign +> elements-cli signmessage "address" "test message" + +Now lock the wallet again by removing the passphrase +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/getaddressesbylabel.html b/_doc/en/22.1.1/rpc/wallet/getaddressesbylabel.html new file mode 100644 index 0000000..6f4e66b --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/getaddressesbylabel.html @@ -0,0 +1,28 @@ +--- +layout: doc +name: getaddressesbylabel +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/getaddressesbylabel/ +--- + +getaddressesbylabel "label" + +Returns the list of addresses assigned the specified label. + +Arguments: +1. label (string, required) The label. + +Result: +{ (json object) json object with addresses as keys + "address" : { (json object) json object with information about address + "purpose" : "str" (string) Purpose of address ("send" for sending address, "receive" for receiving address) + }, + ... +} + +Examples: +> elements-cli getaddressesbylabel "tabby" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getaddressesbylabel", "params": ["tabby"]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/getaddressinfo.html b/_doc/en/22.1.1/rpc/wallet/getaddressinfo.html new file mode 100644 index 0000000..c1acac8 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/getaddressinfo.html @@ -0,0 +1,64 @@ +--- +layout: doc +name: getaddressinfo +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/getaddressinfo/ +--- + +getaddressinfo "address" + +Return information about the given address. +Some of the information will only be present if the address is in the active wallet. + +Arguments: +1. address (string, required) The address for which to get information. + +Result: +{ (json object) + "address" : "str", (string) The address validated. + "scriptPubKey" : "hex", (string) The hex-encoded scriptPubKey generated by the address. + "ismine" : true|false, (boolean) If the address is yours. + "iswatchonly" : true|false, (boolean) If the address is watchonly. + "solvable" : true|false, (boolean) If we know how to spend coins sent to this address, ignoring the possible lack of private keys. + "desc" : "str", (string, optional) A descriptor for spending coins sent to this address (only when solvable). + "parent_desc" : "str", (string, optional) The descriptor used to derive this address if this is a descriptor wallet + "isscript" : true|false, (boolean) If the key is a script. + "ischange" : true|false, (boolean) If the address was used for change output. + "iswitness" : true|false, (boolean) If the address is a witness address. + "witness_version" : n, (numeric, optional) The version number of the witness program. + "witness_program" : "hex", (string, optional) The hex value of the witness program. + "script" : "str", (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 address. + "pubkeys" : [ (json array, optional) Array of pubkeys associated with the known redeemscript (only if script is multisig). + "str", (string) + ... + ], + "sigsrequired" : n, (numeric, optional) The number of signatures required to spend multisig output (only if script is multisig). + "pubkey" : "hex", (string, optional) The hex value of the raw public key for single-key addresses (possibly embedded in P2SH or P2WSH). + "embedded" : { (json object, optional) Information about the address embedded in P2SH or P2WSH, if relevant and known. + ... Includes all getaddressinfo output fields for the embedded address, excluding metadata (timestamp, hdkeypath, hdseedid) + and relation to the wallet (ismine, iswatchonly). + }, + "iscompressed" : true|false, (boolean, optional) If the pubkey is compressed. + "confidential_key" : "hex", (string) the raw blinding public key for that address, if any. "" if none + "unconfidential" : "str", (string) The address without confidentiality key + "confidential" : "str", (string) The address with wallet-stored confidentiality key if known. Only displayed for non-confidential address inputs + "timestamp" : xxx, (numeric, optional) The creation time of the key, if available, expressed in UNIX epoch time. + "hdkeypath" : "str", (string, optional) The HD keypath, if the key is HD and available. + "hdseedid" : "hex", (string, optional) The Hash160 of the HD seed. + "hdmasterfingerprint" : "hex", (string, optional) The fingerprint of the master key. + "labels" : [ (json array) Array of labels associated with the address. Currently limited to one label but returned + as an array to keep the API stable if multiple labels are enabled in the future. + "str", (string) Label name (defaults to ""). + ... + ] +} + +Examples: +> elements-cli getaddressinfo "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getaddressinfo", "params": ["bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl"]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/getbalance.html b/_doc/en/22.1.1/rpc/wallet/getbalance.html new file mode 100644 index 0000000..fe544f6 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/getbalance.html @@ -0,0 +1,44 @@ +--- +layout: doc +name: getbalance +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/getbalance/ +--- + +getbalance ( "dummy" minconf include_watchonly avoid_reuse "assetlabel" ) + +Returns the 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. + +Arguments: +1. dummy (string, optional) Remains for backward compatibility. Must be excluded or set to "*". +2. minconf (numeric, optional, default=0) Only include transactions confirmed at least this many times. +3. include_watchonly (boolean, optional, default=true for watch-only wallets, otherwise false) Also include balance in watch-only addresses (see 'importaddress') +4. avoid_reuse (boolean, optional, default=true) (only available if avoid_reuse wallet flag is set) Do not include balance in dirty outputs; addresses are considered dirty if they have previously been used in a transaction. +5. assetlabel (string, optional) Hex asset id or asset label for balance. + +Result: +{ (json object) The total amount, per asset if none is specified, in BTC received for this wallet. + ... the amount for each asset +} + +Result: +n (numeric) the total amount for the asset, if one is specified + +Result: +null (json null) + +Examples: + +The total amount in the wallet with 0 or more confirmations +> elements-cli getbalance + +The total amount in the wallet with at least 6 confirmations +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/getbalances.html b/_doc/en/22.1.1/rpc/wallet/getbalances.html new file mode 100644 index 0000000..acb2263 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/getbalances.html @@ -0,0 +1,31 @@ +--- +layout: doc +name: getbalances +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/getbalances/ +--- + +getbalances +Returns an object with all balances in BTC. + +Result: +{ (json object) + "mine" : { (json object) balances from outputs that the wallet can sign + "trusted" : n, (numeric) trusted balance (outputs created by the wallet or confirmed outputs) + "untrusted_pending" : n, (numeric) untrusted pending balance (outputs created by others that are in the mempool) + "immature" : n, (numeric) balance from immature coinbase outputs + "used" : n (numeric) (only present if avoid_reuse is set) balance from coins sent to addresses that were previously spent from (potentially privacy violating) + }, + "watchonly" : { (json object) watchonly balances (not present if wallet does not watch anything) + "trusted" : n, (numeric) trusted balance (outputs created by the wallet or confirmed outputs) + "untrusted_pending" : n, (numeric) untrusted pending balance (outputs created by others that are in the mempool) + "immature" : n (numeric) balance from immature coinbase outputs + } +} + +Examples: +> elements-cli getbalances +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getbalances", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/getnewaddress.html b/_doc/en/22.1.1/rpc/wallet/getnewaddress.html new file mode 100644 index 0000000..3b3603c --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/getnewaddress.html @@ -0,0 +1,28 @@ +--- +layout: doc +name: getnewaddress +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/getnewaddress/ +--- + +getnewaddress ( "label" "address_type" ) + +Returns a new address for receiving payments. +If 'label' is specified, it is added to the address book +so payments received with the address will be associated with 'label'. +When the wallet doesn't give blinded addresses by default (-blindedaddresses=0), +the address type "blech32" can still be used to get a blinded address. + +Arguments: +1. label (string, optional, default="") The label name for the address to be linked to. It can also be set to the empty string "" to represent the default label. The label does not need to exist, it will be created if there is no label by the given name. +2. address_type (string, optional, default=set by -addresstype) The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -addresstype. + +Result: +"str" (string) The new address + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/getpeginaddress.html b/_doc/en/22.1.1/rpc/wallet/getpeginaddress.html new file mode 100644 index 0000000..97aedfb --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/getpeginaddress.html @@ -0,0 +1,25 @@ +--- +layout: doc +name: getpeginaddress +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/getpeginaddress/ +--- + +getpeginaddress + +Returns information needed for claimpegin to move coins to the sidechain. +The user should send coins from their Bitcoin wallet to the mainchain_address returned. + +Result: +{ (json object) + "mainchain_address" : "str", (string) mainchain deposit address to send bitcoin to + "claim_script" : "hex" (string) claim script committed to by the mainchain address. This may be required in `claimpegin` to retrieve pegged-in funds + +} + +Examples: +> elements-cli getpeginaddress +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getpeginaddress", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/getrawchangeaddress.html b/_doc/en/22.1.1/rpc/wallet/getrawchangeaddress.html new file mode 100644 index 0000000..472e2a1 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/getrawchangeaddress.html @@ -0,0 +1,24 @@ +--- +layout: doc +name: getrawchangeaddress +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/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, default=set by -changetype) The address type to use. Options are "legacy", "p2sh-segwit", and "bech32". Default is set by -changetype. + +Result: +"str" (string) The address + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/getreceivedbyaddress.html b/_doc/en/22.1.1/rpc/wallet/getreceivedbyaddress.html new file mode 100644 index 0000000..8889986 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/getreceivedbyaddress.html @@ -0,0 +1,43 @@ +--- +layout: doc +name: getreceivedbyaddress +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/getreceivedbyaddress/ +--- + +getreceivedbyaddress "address" ( minconf "assetlabel" ) + +Returns the total amount received by the given address in transactions with at least minconf confirmations. + +Arguments: +1. address (string, required) The address for transactions. +2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times. +3. assetlabel (string, optional) Hex asset id or asset label for balance. + +Result: +{ (json object) The total amount, per asset if none is specified, in BTC received for this wallet. + ... the amount for each asset +} + +Result: +n (numeric) the total amount for the asset, if one is specified + +Result: +null (json null) + +Examples: + +The amount from transactions with at least 1 confirmation +> elements-cli getreceivedbyaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" + +The amount including unconfirmed transactions, zero confirmations +> elements-cli getreceivedbyaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" 0 + +The amount with at least 6 confirmations +> elements-cli getreceivedbyaddress "bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl" 6 + +As a JSON-RPC call +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getreceivedbyaddress", "params": ["bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl", 6]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/getreceivedbylabel.html b/_doc/en/22.1.1/rpc/wallet/getreceivedbylabel.html new file mode 100644 index 0000000..72fb3c6 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/getreceivedbylabel.html @@ -0,0 +1,43 @@ +--- +layout: doc +name: getreceivedbylabel +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/getreceivedbylabel/ +--- + +getreceivedbylabel "label" ( minconf "assetlabel" ) + +Returns the total amount received by addresses with in transactions with at least [minconf] confirmations. + +Arguments: +1. label (string, required) The selected label, may be the default label using "". +2. minconf (numeric, optional, default=1) Only include transactions confirmed at least this many times. +3. assetlabel (string, optional) Hex asset id or asset label for balance. + +Result: +{ (json object) The total amount, per asset if none is specified, in BTC received for this wallet. + ... the amount for each asset +} + +Result: +n (numeric) the total amount for the asset, if one is specified + +Result: +null (json null) + +Examples: + +Amount received by the default label with at least 1 confirmation +> elements-cli getreceivedbylabel "" + +Amount received at the tabby label including unconfirmed amounts with zero confirmations +> elements-cli getreceivedbylabel "tabby" 0 + +The amount with at least 6 confirmations +> elements-cli getreceivedbylabel "tabby" 6 + +As a JSON-RPC call +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getreceivedbylabel", "params": ["tabby", 6]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/gettransaction.html b/_doc/en/22.1.1/rpc/wallet/gettransaction.html new file mode 100644 index 0000000..680ec1a --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/gettransaction.html @@ -0,0 +1,74 @@ +--- +layout: doc +name: gettransaction +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/gettransaction/ +--- + +gettransaction "txid" ( include_watchonly verbose "assetlabel" ) + +Get detailed information about in-wallet transaction + +Arguments: +1. txid (string, required) The transaction id +2. include_watchonly (boolean, optional, default=true for watch-only wallets, otherwise false) Whether to include watch-only addresses in balance calculation and details[] +3. verbose (boolean, optional, default=false) Whether to include a `decoded` field containing the decoded transaction (equivalent to RPC decoderawtransaction) +4. assetlabel (string, optional) Hex asset id or asset label for balance. + +Result: +{ (json object) + "amount" : n, (numeric) The amount in BTC + "fee" : n, (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 for the transaction. Negative confirmations means the + transaction conflicted that many blocks ago. + "generated" : true|false, (boolean) Only present if transaction only input is a coinbase one. + "trusted" : true|false, (boolean) Only present if we consider transaction to be trusted and so safe to spend from. + "blockhash" : "hex", (string) The block hash containing the transaction. + "blockheight" : n, (numeric) The block height containing the transaction. + "blockindex" : n, (numeric) The index of the transaction in the block that includes it. + "blocktime" : xxx, (numeric) The block time expressed in UNIX epoch time. + "txid" : "hex", (string) The transaction id. + "walletconflicts" : [ (json array) Conflicting transaction ids. + "hex", (string) The transaction id. + ... + ], + "time" : xxx, (numeric) The transaction time expressed in UNIX epoch time. + "timereceived" : xxx, (numeric) The time received expressed in UNIX epoch time. + "comment" : "str", (string) If a comment is associated with the transaction, only present if not empty. + "bip125-replaceable" : "str", (string) ("yes|no|unknown") Whether this transaction could be replaced due to BIP125 (replace-by-fee); + may be unknown for unconfirmed transactions not in the mempool + "details" : [ (json array) + { (json object) + "involvesWatchonly" : true|false, (boolean) Only returns true if imported addresses were involved in transaction. + "address" : "str", (string) The address involved in the transaction. + "category" : "str", (string) The transaction category. + "send" Transactions sent. + "receive" Non-coinbase transactions received. + "generate" Coinbase transactions received with more than 100 confirmations. + "immature" Coinbase transactions received with 100 or fewer confirmations. + "orphan" Orphaned coinbase transactions received. + "amount" : n, (numeric) The amount in BTC + "label" : "str", (string) A comment for the address/transaction, if any + "vout" : n, (numeric) the vout value + "fee" : n, (numeric) The amount of the fee in BTC. This is negative and only available for the + 'send' category of transactions. + "abandoned" : true|false (boolean) 'true' if the transaction has been abandoned (inputs are respendable). Only available for the + 'send' category of transactions. + }, + ... + ], + "hex" : "hex", (string) Raw data for transaction + "decoded" : { (json object) Optional, the decoded transaction (only present when `verbose` is passed) + ... Equivalent to the RPC decoderawtransaction method, or the RPC getrawtransaction method when `verbose` is passed. + } +} + +Examples: +> elements-cli gettransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" +> elements-cli gettransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" true +> elements-cli gettransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" false 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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/getunconfirmedbalance.html b/_doc/en/22.1.1/rpc/wallet/getunconfirmedbalance.html new file mode 100644 index 0000000..5ba570c --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/getunconfirmedbalance.html @@ -0,0 +1,24 @@ +--- +layout: doc +name: getunconfirmedbalance +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/getunconfirmedbalance/ +--- + +getunconfirmedbalance +DEPRECATED +Identical to getbalances().mine.untrusted_pending + +Result: +{ (json object) The total amount, per asset if none is specified, in BTC received for this wallet. + ... the amount for each asset +} + +Result: +n (numeric) the total amount for the asset, if one is specified + +Result: +null (json null) + + diff --git a/_doc/en/22.1.1/rpc/wallet/getwalletinfo.html b/_doc/en/22.1.1/rpc/wallet/getwalletinfo.html new file mode 100644 index 0000000..d6b8673 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/getwalletinfo.html @@ -0,0 +1,40 @@ +--- +layout: doc +name: getwalletinfo +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/getwalletinfo/ +--- + +getwalletinfo +Returns an object containing various wallet state info. + +Result: +{ (json object) + "walletname" : "str", (string) the wallet name + "walletversion" : n, (numeric) the wallet version + "format" : "str", (string) the database format (bdb or sqlite) + "balance" : n, (numeric) DEPRECATED. Identical to getbalances().mine.trusted + "unconfirmed_balance" : n, (numeric) DEPRECATED. Identical to getbalances().mine.untrusted_pending + "immature_balance" : n, (numeric) DEPRECATED. Identical to getbalances().mine.immature + "txcount" : n, (numeric) the total number of transactions in the wallet + "keypoololdest" : xxx, (numeric) the UNIX epoch time of the oldest pre-generated key in the key pool. Legacy wallets only. + "keypoolsize" : n, (numeric) how many new keys are pre-generated (only counts external keys) + "keypoolsize_hd_internal" : n, (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" : xxx, (numeric, optional) the UNIX epoch time until which the wallet is unlocked for transfers, or 0 if the wallet is locked (only present for passphrase-encrypted wallets) + "paytxfee" : n, (numeric) the transaction fee configuration, set in BTC/kvB + "hdseedid" : "hex", (string, optional) the Hash160 of the HD seed (only present when HD is enabled) + "private_keys_enabled" : true|false, (boolean) false if privatekeys are disabled for this wallet (enforced watch-only wallet) + "avoid_reuse" : true|false, (boolean) whether this wallet tracks clean/dirty coins in terms of reuse + "scanning" : { (json object) current scanning details, or false if no scan is in progress + "duration" : n, (numeric) elapsed seconds since scan start + "progress" : n (numeric) scanning progress percentage [0.0, 1.0] + }, + "descriptors" : true|false (boolean) whether this wallet uses descriptors for scriptPubKey management +} + +Examples: +> elements-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:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/getwalletpakinfo.html b/_doc/en/22.1.1/rpc/wallet/getwalletpakinfo.html new file mode 100644 index 0000000..90aac1b --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/getwalletpakinfo.html @@ -0,0 +1,24 @@ +--- +layout: doc +name: getwalletpakinfo +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/getwalletpakinfo/ +--- + +getwalletpakinfo + +Returns relevant pegout authorization key (PAK) information about this wallet. Throws an error if initpegoutwallet` has not been invoked on this wallet. + +Result: +{ (json object) + "bip32_counter" : "str", (string) next index to be used by the wallet for `sendtomainchain` + "bitcoin_descriptor" : "str", (string) Bitcoin script descriptor loaded in the wallet for pegouts + "liquid_pak" : "hex", (string) pubkey corresponding to the Liquid PAK loaded in the wallet for pegouts + "liquid_pak_address" : "str", (string) corresponding address for `liquid_pak`. Useful for `dumpprivkey` for wallet backup or transfer + "address_lookahead" : [ (json array) the three next Bitcoin addresses the wallet will use for `sendtomainchain` based on the internal counter + "str" (string) + ] +} + + diff --git a/_doc/en/22.1.1/rpc/wallet/importaddress.html b/_doc/en/22.1.1/rpc/wallet/importaddress.html new file mode 100644 index 0000000..e36d123 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/importaddress.html @@ -0,0 +1,42 @@ +--- +layout: doc +name: importaddress +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/importaddress/ +--- + +importaddress "address" ( "label" rescan p2sh ) + +Adds an address or script (in hex) that can be watched as if it were in your wallet but cannot be used to spend. Requires a new wallet backup. + +Note: This call can take over an hour 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. +Hint: use importmulti to import more than one address. + +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. +Note: Use "getwalletinfo" to query the scanning progress. + +Arguments: +1. address (string, required) The Bitcoin address (or hex-encoded script) +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 + +Result: +null (json null) + +Examples: + +Import an address with rescan +> elements-cli importaddress "myaddress" + +Import using a label without rescan +> elements-cli importaddress "myaddress" "testing" false + +As a JSON-RPC call +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "importaddress", "params": ["myaddress", "testing", false]}' -H 'content-type: text/plain;' http://127.0.0.1:7041/ + + diff --git a/_doc/en/22.1.1/rpc/wallet/importblindingkey.html b/_doc/en/22.1.1/rpc/wallet/importblindingkey.html new file mode 100644 index 0000000..b712f6d --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/importblindingkey.html @@ -0,0 +1,22 @@ +--- +layout: doc +name: importblindingkey +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/importblindingkey/ +--- + +importblindingkey "address" "hexkey" + +Imports a private blinding key in hex for a CT address. +Arguments: +1. address (string, required) The CT address +2. hexkey (string, required) The blinding key in hex + +Result: +null (json null) + +Examples: +> elements-cli importblindingkey "my blinded CT address" + + diff --git a/_doc/en/22.1.1/rpc/wallet/importdescriptors.html b/_doc/en/22.1.1/rpc/wallet/importdescriptors.html new file mode 100644 index 0000000..51e3d10 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/importdescriptors.html @@ -0,0 +1,54 @@ +--- +layout: doc +name: importdescriptors +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/importdescriptors/ +--- + +importdescriptors "requests" + +Import descriptors. This will trigger a rescan of the blockchain based on the earliest timestamp of all descriptors being imported. Requires a new wallet backup. + +Note: This call can take over an hour to complete if using an early timestamp; during that time, other rpc calls +may report that the imported keys, addresses or scripts exist but related transactions are still missing. + +Arguments: +1. requests (json array, required) Data to be imported + [ + { (json object) + "desc": "str", (string, required) Descriptor to import. + "active": bool, (boolean, optional, default=false) Set this descriptor to be the active descriptor for the corresponding output type/externality + "range": n or [n,n], (numeric or array) If a ranged descriptor is used, this specifies the end or the range (in the form [begin,end]) to import + "next_index": n, (numeric) If a ranged descriptor is set to active, this specifies the next index to generate addresses from + "timestamp": timestamp | "now", (integer / string, required) Time from which to start rescanning the blockchain for this descriptor, in UNIX epoch time + Use the string "now" to substitute the current synced blockchain time. + "now" can be specified to bypass scanning, for outputs which are known to never have been used, and + 0 can be specified to scan the entire blockchain. Blocks up to 2 hours before the earliest timestamp + of all descriptors being imported will be scanned. + "internal": bool, (boolean, optional, default=false) Whether matching outputs should be treated as not incoming payments (e.g. change) + "label": "str", (string, optional, default="") Label to assign to the address, only allowed with internal=false + }, + ... + ] + +Result: +[ (json array) Response is an array with the same size as the input that has the execution result + { (json object) + "success" : true|false, (boolean) + "warnings" : [ (json array, optional) + "str", (string) + ... + ], + "error" : { (json object, optional) + ... JSONRPC error + } + }, + ... +] + +Examples: +> elements-cli importdescriptors '[{ "desc": "", "timestamp":1455191478, "internal": true }, { "desc": "", "label": "example 2", "timestamp": 1455191480 }]' +> elements-cli importdescriptors '[{ "desc": "", "timestamp":1455191478, "active": true, "range": [0,100], "label": "" }]' + + diff --git a/_doc/en/22.1.1/rpc/wallet/importissuanceblindingkey.html b/_doc/en/22.1.1/rpc/wallet/importissuanceblindingkey.html new file mode 100644 index 0000000..83e0d50 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/importissuanceblindingkey.html @@ -0,0 +1,23 @@ +--- +layout: doc +name: importissuanceblindingkey +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/importissuanceblindingkey/ +--- + +importissuanceblindingkey "txid" vin "blindingkey" + +Imports a private blinding key in hex for an asset issuance. +Arguments: +1. txid (string, required) The transaction id of the issuance +2. vin (numeric, required) The input number of the issuance in the transaction. +3. blindingkey (string, required) The blinding key in hex + +Result: +null (json null) + +Examples: +> elements-cli importblindingkey "my blinded CT address" + + diff --git a/_doc/en/22.1.1/rpc/wallet/importmasterblindingkey.html b/_doc/en/22.1.1/rpc/wallet/importmasterblindingkey.html new file mode 100644 index 0000000..4cc4dac --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/importmasterblindingkey.html @@ -0,0 +1,23 @@ +--- +layout: doc +name: importmasterblindingkey +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/importmasterblindingkey/ +--- + +importmasterblindingkey "hexkey" + +Imports a master private blinding key in hex for the wallet. +Note: wallets can only have one master blinding key at a time. Funds could be permanently lost if user doesn't know what they are doing. Recommended use is only for wallet recovery using this in conjunction with `sethdseed`. + +Arguments: +1. hexkey (string, required) The blinding key in hex + +Result: +null (json null) + +Examples: +> elements-cli importmasterblindingkey + + diff --git a/_doc/en/22.1.1/rpc/wallet/importmulti.html b/_doc/en/22.1.1/rpc/wallet/importmulti.html new file mode 100644 index 0000000..f969834 --- /dev/null +++ b/_doc/en/22.1.1/rpc/wallet/importmulti.html @@ -0,0 +1,74 @@ +--- +layout: doc +name: importmulti +elemversion: 22.1.1 +elemgroup: wallet +permalink: /en/doc/22.1.1/rpc/wallet/importmulti/ +--- + +importmulti "requests" ( "options" ) + +Import addresses/scripts (with private or public keys, redeem script (P2SH)), optionally rescanning the blockchain from the earliest creation time of the imported scripts. Requires a new wallet backup. +If an address/script is imported without all of the private keys required to spend from that address, it will be watchonly. The 'watchonly' option must be set to true in this case or a warning will be returned. +Conversely, if all the private keys are provided and the address/script is spendable, the watchonly option must be set to false, or a warning will be returned. + +Note: This call can take over an hour to complete if rescan is true, during that time, other rpc calls +may report that the imported keys, addresses or scripts exist but related transactions are still missing. +Note: Use "getwalletinfo" to query the scanning progress. + +Arguments: +1. requests (json array, required) Data to be imported + [ + { (json object) + "desc": "str", (string) Descriptor to import. If using descriptor, do not also provide address/scriptPubKey, scripts, or pubkeys + "scriptPubKey": "