From ea0a06016e318853026d54e4feffdd8f5e6719fc Mon Sep 17 00:00:00 2001 From: guilhermefleury Date: Tue, 19 May 2026 14:03:09 -0300 Subject: [PATCH] docs: add auto-generated blockchain RPC reference (Syscoin Core 5.0.5) --- docs/cli/blockchain/_category_.json | 4 + docs/cli/blockchain/dumptxoutset.mdx | 45 ++++++++++ docs/cli/blockchain/getbestblockhash.mdx | 32 +++++++ docs/cli/blockchain/getblock.mdx | 36 ++++++++ docs/cli/blockchain/getblockchaininfo.mdx | 49 +++++++++++ docs/cli/blockchain/getblockcount.mdx | 33 +++++++ docs/cli/blockchain/getblockfilter.mdx | 42 +++++++++ docs/cli/blockchain/getblockfrompeer.mdx | 47 ++++++++++ docs/cli/blockchain/getblockhash.mdx | 38 +++++++++ docs/cli/blockchain/getblockheader.mdx | 34 ++++++++ docs/cli/blockchain/getblockstats.mdx | 85 +++++++++++++++++++ docs/cli/blockchain/getchainlocks.mdx | 57 +++++++++++++ docs/cli/blockchain/getchainstates.mdx | 47 ++++++++++ docs/cli/blockchain/getchaintips.mdx | 47 ++++++++++ docs/cli/blockchain/getchaintxstats.mdx | 48 +++++++++++ docs/cli/blockchain/getdeploymentinfo.mdx | 66 ++++++++++++++ docs/cli/blockchain/getdifficulty.mdx | 32 +++++++ docs/cli/blockchain/getmempoolancestors.mdx | 33 +++++++ docs/cli/blockchain/getmempooldescendants.mdx | 33 +++++++ docs/cli/blockchain/getmempoolentry.mdx | 65 ++++++++++++++ docs/cli/blockchain/getmempoolinfo.mdx | 44 ++++++++++ docs/cli/blockchain/getrawmempool.mdx | 35 ++++++++ docs/cli/blockchain/gettxout.mdx | 40 +++++++++ docs/cli/blockchain/gettxoutproof.mdx | 41 +++++++++ docs/cli/blockchain/gettxoutsetinfo.mdx | 71 ++++++++++++++++ docs/cli/blockchain/gettxspendingprevout.mdx | 52 ++++++++++++ docs/cli/blockchain/importmempool.mdx | 51 +++++++++++ docs/cli/blockchain/loadtxoutset.mdx | 47 ++++++++++ docs/cli/blockchain/preciousblock.mdx | 42 +++++++++ docs/cli/blockchain/pruneblockchain.mdx | 37 ++++++++ docs/cli/blockchain/savemempool.mdx | 34 ++++++++ docs/cli/blockchain/scanblocks.mdx | 57 +++++++++++++ docs/cli/blockchain/scantxoutset.mdx | 49 +++++++++++ docs/cli/blockchain/verifychain.mdx | 45 ++++++++++ docs/cli/blockchain/verifytxoutproof.mdx | 35 ++++++++ 35 files changed, 1553 insertions(+) create mode 100644 docs/cli/blockchain/_category_.json create mode 100644 docs/cli/blockchain/dumptxoutset.mdx create mode 100644 docs/cli/blockchain/getbestblockhash.mdx create mode 100644 docs/cli/blockchain/getblock.mdx create mode 100644 docs/cli/blockchain/getblockchaininfo.mdx create mode 100644 docs/cli/blockchain/getblockcount.mdx create mode 100644 docs/cli/blockchain/getblockfilter.mdx create mode 100644 docs/cli/blockchain/getblockfrompeer.mdx create mode 100644 docs/cli/blockchain/getblockhash.mdx create mode 100644 docs/cli/blockchain/getblockheader.mdx create mode 100644 docs/cli/blockchain/getblockstats.mdx create mode 100644 docs/cli/blockchain/getchainlocks.mdx create mode 100644 docs/cli/blockchain/getchainstates.mdx create mode 100644 docs/cli/blockchain/getchaintips.mdx create mode 100644 docs/cli/blockchain/getchaintxstats.mdx create mode 100644 docs/cli/blockchain/getdeploymentinfo.mdx create mode 100644 docs/cli/blockchain/getdifficulty.mdx create mode 100644 docs/cli/blockchain/getmempoolancestors.mdx create mode 100644 docs/cli/blockchain/getmempooldescendants.mdx create mode 100644 docs/cli/blockchain/getmempoolentry.mdx create mode 100644 docs/cli/blockchain/getmempoolinfo.mdx create mode 100644 docs/cli/blockchain/getrawmempool.mdx create mode 100644 docs/cli/blockchain/gettxout.mdx create mode 100644 docs/cli/blockchain/gettxoutproof.mdx create mode 100644 docs/cli/blockchain/gettxoutsetinfo.mdx create mode 100644 docs/cli/blockchain/gettxspendingprevout.mdx create mode 100644 docs/cli/blockchain/importmempool.mdx create mode 100644 docs/cli/blockchain/loadtxoutset.mdx create mode 100644 docs/cli/blockchain/preciousblock.mdx create mode 100644 docs/cli/blockchain/pruneblockchain.mdx create mode 100644 docs/cli/blockchain/savemempool.mdx create mode 100644 docs/cli/blockchain/scanblocks.mdx create mode 100644 docs/cli/blockchain/scantxoutset.mdx create mode 100644 docs/cli/blockchain/verifychain.mdx create mode 100644 docs/cli/blockchain/verifytxoutproof.mdx diff --git a/docs/cli/blockchain/_category_.json b/docs/cli/blockchain/_category_.json new file mode 100644 index 00000000..86998dca --- /dev/null +++ b/docs/cli/blockchain/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Blockchain", + "position": 2 +} \ No newline at end of file diff --git a/docs/cli/blockchain/dumptxoutset.mdx b/docs/cli/blockchain/dumptxoutset.mdx new file mode 100644 index 00000000..9768bc2a --- /dev/null +++ b/docs/cli/blockchain/dumptxoutset.mdx @@ -0,0 +1,45 @@ +--- +title: dumptxoutset +sidebar_label: dumptxoutset +description: "Syscoin Core CLI reference: dumptxoutset" +--- + +# `dumptxoutset` + +Write the serialized UTXO set to disk. + +## Synopsis + +``` +dumptxoutset "path" +``` + +## Arguments + +``` +1. path (string, required) Path to the output file. If relative, will be prefixed by datadir. +``` + +## Result + +``` +{ (json object) + "coins_written" : n, (numeric) the number of coins written in the snapshot + "base_hash" : "hex", (string) the hash of the base of the snapshot + "base_height" : n, (numeric) the height of the base of the snapshot + "path" : "str", (string) the absolute path that the snapshot was written to + "pathjson" : "str", (string) the absolute path that the json snapshot was written to + "txoutset_hash" : "hex", (string) the hash of the UTXO set contents + "nchaintx" : n (numeric) the number of transactions in the chain up to and including the base block +} +``` + +## Examples + +``` +> syscoin-cli dumptxoutset utxo.dat +``` + +--- + +*Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getbestblockhash.mdx b/docs/cli/blockchain/getbestblockhash.mdx new file mode 100644 index 00000000..343ccffa --- /dev/null +++ b/docs/cli/blockchain/getbestblockhash.mdx @@ -0,0 +1,32 @@ +--- +title: getbestblockhash +sidebar_label: getbestblockhash +description: "Syscoin Core CLI reference: getbestblockhash" +--- + +# `getbestblockhash` + +Returns the hash of the best (tip) block in the most-work fully-validated chain. + +## Synopsis + +``` +getbestblockhash +``` + +## Result + +``` +"hex" (string) the block hash, hex-encoded +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getblock.mdx b/docs/cli/blockchain/getblock.mdx new file mode 100644 index 00000000..7c2de547 --- /dev/null +++ b/docs/cli/blockchain/getblock.mdx @@ -0,0 +1,36 @@ +--- +title: getblock +sidebar_label: getblock +description: "Syscoin Core CLI reference: getblock" +--- + +# `getblock` + +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. +If verbosity is 3, returns an Object with information about block `` and information about each transaction, including prevout information for inputs (only for unpruned blocks in the current best chain). + +## Synopsis + +``` +getblock "blockhash" ( verbosity ) +``` + +## Arguments + +``` +1. blockhash (string, required) The block hash +2. verbosity (numeric, optional, default=1) 0 for hex-encoded data, 1 for a JSON object, 2 for JSON object with transaction data, and 3 for JSON object with transaction data including prevout information for inputs +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getblockchaininfo.mdx b/docs/cli/blockchain/getblockchaininfo.mdx new file mode 100644 index 00000000..455c2ddb --- /dev/null +++ b/docs/cli/blockchain/getblockchaininfo.mdx @@ -0,0 +1,49 @@ +--- +title: getblockchaininfo +sidebar_label: getblockchaininfo +description: "Syscoin Core CLI reference: getblockchaininfo" +--- + +# `getblockchaininfo` + +Returns an object containing various state info regarding blockchain processing. + +## Synopsis + +``` +getblockchaininfo +``` + +## 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 + "time" : xxx, (numeric) The block time expressed in UNIX epoch time + "mediantime" : xxx, (numeric) The median block time expressed in UNIX epoch time + "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 + "pruneheight" : n, (numeric, optional) height of the last block pruned, plus one (only present if pruning is enabled) + "automatic_pruning" : true|false, (boolean, optional) whether automatic pruning is enabled (only present if pruning is enabled) + "prune_target_size" : n, (numeric, optional) the target size used by pruning (only present if automatic pruning is enabled) + "warnings" : "str" (string) any network and blockchain warnings +} +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getblockcount.mdx b/docs/cli/blockchain/getblockcount.mdx new file mode 100644 index 00000000..df3a57f0 --- /dev/null +++ b/docs/cli/blockchain/getblockcount.mdx @@ -0,0 +1,33 @@ +--- +title: getblockcount +sidebar_label: getblockcount +description: "Syscoin Core CLI reference: getblockcount" +--- + +# `getblockcount` + +Returns the height of the most-work fully-validated chain. +The genesis block has height 0. + +## Synopsis + +``` +getblockcount +``` + +## Result + +``` +n (numeric) The current block count +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getblockfilter.mdx b/docs/cli/blockchain/getblockfilter.mdx new file mode 100644 index 00000000..61fc4b79 --- /dev/null +++ b/docs/cli/blockchain/getblockfilter.mdx @@ -0,0 +1,42 @@ +--- +title: getblockfilter +sidebar_label: getblockfilter +description: "Syscoin Core CLI reference: getblockfilter" +--- + +# `getblockfilter` + +Retrieve a BIP 157 content filter for a particular block. + +## Synopsis + +``` +getblockfilter "blockhash" ( "filtertype" ) +``` + +## 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 + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getblockfrompeer.mdx b/docs/cli/blockchain/getblockfrompeer.mdx new file mode 100644 index 00000000..83415256 --- /dev/null +++ b/docs/cli/blockchain/getblockfrompeer.mdx @@ -0,0 +1,47 @@ +--- +title: getblockfrompeer +sidebar_label: getblockfrompeer +description: "Syscoin Core CLI reference: getblockfrompeer" +--- + +# `getblockfrompeer` + +Attempt to fetch block from a given peer. + +We must have the header for this block, e.g. using submitheader. +Subsequent calls for the same block may cause the response from the previous peer to be ignored. +Peers generally ignore requests for a stale block that they never fully verified, or one that is more than a month old. +When a peer does not respond with a block, we will disconnect. +Note: The block could be re-pruned as soon as it is received. + +Returns an empty JSON object if the request was successfully scheduled. + +## Synopsis + +``` +getblockfrompeer "blockhash" peer_id +``` + +## Arguments + +``` +1. blockhash (string, required) The block hash to try to fetch +2. peer_id (numeric, required) The peer to fetch it from (see getpeerinfo for peer IDs) +``` + +## Result + +``` +{} (empty JSON object) +``` + +## Examples + +``` +> syscoin-cli getblockfrompeer "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09" 0 +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getblockfrompeer", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09" 0]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getblockhash.mdx b/docs/cli/blockchain/getblockhash.mdx new file mode 100644 index 00000000..88e34112 --- /dev/null +++ b/docs/cli/blockchain/getblockhash.mdx @@ -0,0 +1,38 @@ +--- +title: getblockhash +sidebar_label: getblockhash +description: "Syscoin Core CLI reference: getblockhash" +--- + +# `getblockhash` + +Returns hash of block in best-block-chain at height provided. + +## Synopsis + +``` +getblockhash height +``` + +## Arguments + +``` +1. height (numeric, required) The height index +``` + +## Result + +``` +"hex" (string) The block hash +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getblockheader.mdx b/docs/cli/blockchain/getblockheader.mdx new file mode 100644 index 00000000..75f2254b --- /dev/null +++ b/docs/cli/blockchain/getblockheader.mdx @@ -0,0 +1,34 @@ +--- +title: getblockheader +sidebar_label: getblockheader +description: "Syscoin Core CLI reference: getblockheader" +--- + +# `getblockheader` + +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 ``. + +## Synopsis + +``` +getblockheader "blockhash" ( verbose ) +``` + +## 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 +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getblockstats.mdx b/docs/cli/blockchain/getblockstats.mdx new file mode 100644 index 00000000..561f8514 --- /dev/null +++ b/docs/cli/blockchain/getblockstats.mdx @@ -0,0 +1,85 @@ +--- +title: getblockstats +sidebar_label: getblockstats +description: "Syscoin Core CLI reference: getblockstats" +--- + +# `getblockstats` + +Compute per block statistics for a given window. All amounts are in satoshis. +It won't work for some heights with pruning. + +## Synopsis + +``` +getblockstats hash_or_height ( stats ) +``` + +## 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, optional) Average fee in the block + "avgfeerate" : n, (numeric, optional) Average feerate (in satoshis per virtual byte) + "avgtxsize" : n, (numeric, optional) Average transaction size + "blockhash" : "hex", (string, optional) The block hash (to check for potential reorgs) + "feerate_percentiles" : [ (json array, optional) 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, optional) The height of the block + "ins" : n, (numeric, optional) The number of inputs (excluding coinbase) + "maxfee" : n, (numeric, optional) Maximum fee in the block + "maxfeerate" : n, (numeric, optional) Maximum feerate (in satoshis per virtual byte) + "maxtxsize" : n, (numeric, optional) Maximum transaction size + "medianfee" : n, (numeric, optional) Truncated median fee in the block + "mediantime" : n, (numeric, optional) The block median time past + "mediantxsize" : n, (numeric, optional) Truncated median transaction size + "minfee" : n, (numeric, optional) Minimum fee in the block + "minfeerate" : n, (numeric, optional) Minimum feerate (in satoshis per virtual byte) + "mintxsize" : n, (numeric, optional) Minimum transaction size + "outs" : n, (numeric, optional) The number of outputs + "subsidy" : n, (numeric, optional) The block subsidy + "swtotal_size" : n, (numeric, optional) Total size of all segwit transactions + "swtotal_weight" : n, (numeric, optional) Total weight of all segwit transactions + "swtxs" : n, (numeric, optional) The number of segwit transactions + "time" : n, (numeric, optional) The block time + "total_out" : n, (numeric, optional) Total amount in all outputs (excluding coinbase and thus reward [ie subsidy + totalfee]) + "total_size" : n, (numeric, optional) Total size of all non-coinbase transactions + "total_weight" : n, (numeric, optional) Total weight of all non-coinbase transactions + "totalfee" : n, (numeric, optional) The fee total + "txs" : n, (numeric, optional) The number of transactions (including coinbase) + "utxo_increase" : n, (numeric, optional) The increase/decrease in the number of unspent outputs (not discounting op_return and similar) + "utxo_size_inc" : n, (numeric, optional) The increase/decrease in size for the utxo index (not discounting op_return and similar) + "utxo_increase_actual" : n, (numeric, optional) The increase/decrease in the number of unspent outputs, not counting unspendables + "utxo_size_inc_actual" : n (numeric, optional) The increase/decrease in size for the utxo index, not counting unspendables +} +``` + +## Examples + +``` +> syscoin-cli getblockstats '"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"' '["minfeerate","avgfeerate"]' +> syscoin-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:8370/ +> 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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getchainlocks.mdx b/docs/cli/blockchain/getchainlocks.mdx new file mode 100644 index 00000000..7653903f --- /dev/null +++ b/docs/cli/blockchain/getchainlocks.mdx @@ -0,0 +1,57 @@ +--- +title: getchainlocks +sidebar_label: getchainlocks +description: "Syscoin Core CLI reference: getchainlocks" +--- + +# `getchainlocks` + +Returns information about the active and the most recent chainlocks. +The active chainlock is the one that has enough signatures and the block +it tries to lock is known by our node. The recent chainlock might not have +enough signatures or its block might not be known by our node yet. +Throws an error if there is no known chainlock yet. + +## Synopsis + +``` +getchainlocks +``` + +## Result + +``` +{ (json object) + "recent_chainlock" : { (json object) Most recent chainlock information + "blockhash" : "hex", (string) Block Hash + "height" : n, (numeric) Block Height + "signature" : "hex", (string) Signature + "known_block" : true|false (boolean) Block Known + }, + "active_chainlock" : { (json object) Active chainlock information + "blockhash" : "hex", (string) Block Hash + "height" : n, (numeric) Block Height + "signers" : "str", (string) Signer + "signature" : "hex", (string) Signature + "shares" : [ (json array) + { (json object) Shares information + "quorumHash" : "hex", (string) Quorum Hash + "signers" : "str", (string) Signers + "signature" : "hex" (string) Signature + }, + ... + ] + } +} +``` + +## Examples + +``` +> syscoin-cli getchainlocks +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getchainlocks", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getchainstates.mdx b/docs/cli/blockchain/getchainstates.mdx new file mode 100644 index 00000000..2c8cd616 --- /dev/null +++ b/docs/cli/blockchain/getchainstates.mdx @@ -0,0 +1,47 @@ +--- +title: getchainstates +sidebar_label: getchainstates +description: "Syscoin Core CLI reference: getchainstates" +--- + +# `getchainstates` + +Return information about chainstates. + +## Synopsis + +``` +getchainstates +``` + +## Result + +``` +{ (json object) + "headers" : n, (numeric) the number of headers seen so far + "chainstates" : [ (json array) list of the chainstates ordered by work, with the most-work (active) chainstate last + { (json object) + "blocks" : n, (numeric) number of blocks in this chainstate + "bestblockhash" : "hex", (string) blockhash of the tip + "difficulty" : n, (numeric) difficulty of the tip + "verificationprogress" : n, (numeric) progress towards the network tip + "snapshot_blockhash" : "hex", (string, optional) the base block of the snapshot this chainstate is based on, if any + "coins_db_cache_bytes" : n, (numeric) size of the coinsdb cache + "coins_tip_cache_bytes" : n, (numeric) size of the coinstip cache + "validated" : true|false (boolean) whether the chainstate is fully validated. True if all blocks in the chainstate were validated, false if the chain is based on a snapshot and the snapshot has not yet been validated. + }, + ... + ] +} +``` + +## Examples + +``` +> syscoin-cli getchainstates +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getchainstates", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getchaintips.mdx b/docs/cli/blockchain/getchaintips.mdx new file mode 100644 index 00000000..d6673d2d --- /dev/null +++ b/docs/cli/blockchain/getchaintips.mdx @@ -0,0 +1,47 @@ +--- +title: getchaintips +sidebar_label: getchaintips +description: "Syscoin Core CLI reference: getchaintips" +--- + +# `getchaintips` + +Return information about all known tips in the block tree, including the main chain as well as orphaned branches. + +## Synopsis + +``` +getchaintips +``` + +## 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. "conflicting" This branch is conflicting via a chainlock invalidation + 6. "active" This is the tip of the active main chain, which is certainly valid + }, + ... +] +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getchaintxstats.mdx b/docs/cli/blockchain/getchaintxstats.mdx new file mode 100644 index 00000000..a6ed829c --- /dev/null +++ b/docs/cli/blockchain/getchaintxstats.mdx @@ -0,0 +1,48 @@ +--- +title: getchaintxstats +sidebar_label: getchaintxstats +description: "Syscoin Core CLI reference: getchaintxstats" +--- + +# `getchaintxstats` + +Compute statistics about the total number and rate of transactions in the chain. + +## Synopsis + +``` +getchaintxstats ( nblocks "blockhash" ) +``` + +## 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 + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getdeploymentinfo.mdx b/docs/cli/blockchain/getdeploymentinfo.mdx new file mode 100644 index 00000000..4a560f41 --- /dev/null +++ b/docs/cli/blockchain/getdeploymentinfo.mdx @@ -0,0 +1,66 @@ +--- +title: getdeploymentinfo +sidebar_label: getdeploymentinfo +description: "Syscoin Core CLI reference: getdeploymentinfo" +--- + +# `getdeploymentinfo` + +Returns an object containing various state info regarding deployments of consensus changes. + +## Synopsis + +``` +getdeploymentinfo ( "blockhash" ) +``` + +## Arguments + +``` +1. blockhash (string, optional, default="hash of current chain tip") The block hash at which to query deployment state +``` + +## Result + +``` +{ (json object) + "hash" : "str", (string) requested block hash (or tip) + "height" : n, (numeric) requested block height (or tip) + "deployments" : { (json object) + "xxxx" : { (json object) name of the deployment + "type" : "str", (string) one of "buried", "bip9" + "height" : n, (numeric, optional) 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 + "bip9" : { (json object, optional) status of bip9 softforks (only for "bip9" type) + "bit" : n, (numeric, optional) the bit (0-28) in the block version field used to signal this softfork (only for "started" and "locked_in" 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 + "min_activation_height" : n, (numeric) minimum height of blocks for which the rules may be enforced + "status" : "str", (string) status of deployment at specified block (one of "defined", "started", "locked_in", "active", "failed") + "since" : n, (numeric) height of the first block to which the status applies + "status_next" : "str", (string) status of deployment at the next block + "statistics" : { (json object, optional) numeric statistics about signalling for a softfork (only for "started" and "locked_in" status) + "period" : n, (numeric) the length in blocks of the signalling period + "threshold" : n, (numeric, optional) the number of blocks with the version bit set required to activate the feature (only for "started" status) + "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, optional) returns false if there are not enough blocks left in this period to pass activation threshold (only for "started" status) + }, + "signalling" : "str" (string, optional) indicates blocks that signalled with a # and blocks that did not with a - + } + }, + ... + } +} +``` + +## Examples + +``` +> syscoin-cli getdeploymentinfo +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "getdeploymentinfo", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getdifficulty.mdx b/docs/cli/blockchain/getdifficulty.mdx new file mode 100644 index 00000000..4295dcc3 --- /dev/null +++ b/docs/cli/blockchain/getdifficulty.mdx @@ -0,0 +1,32 @@ +--- +title: getdifficulty +sidebar_label: getdifficulty +description: "Syscoin Core CLI reference: getdifficulty" +--- + +# `getdifficulty` + +Returns the proof-of-work difficulty as a multiple of the minimum difficulty. + +## Synopsis + +``` +getdifficulty +``` + +## Result + +``` +n (numeric) the proof-of-work difficulty as a multiple of the minimum difficulty. +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getmempoolancestors.mdx b/docs/cli/blockchain/getmempoolancestors.mdx new file mode 100644 index 00000000..5ae4eed1 --- /dev/null +++ b/docs/cli/blockchain/getmempoolancestors.mdx @@ -0,0 +1,33 @@ +--- +title: getmempoolancestors +sidebar_label: getmempoolancestors +description: "Syscoin Core CLI reference: getmempoolancestors" +--- + +# `getmempoolancestors` + +If txid is in the mempool, returns all in-mempool ancestors. + +## Synopsis + +``` +getmempoolancestors "txid" ( verbose ) +``` + +## 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 +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/mempool.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/mempool.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getmempooldescendants.mdx b/docs/cli/blockchain/getmempooldescendants.mdx new file mode 100644 index 00000000..3183927f --- /dev/null +++ b/docs/cli/blockchain/getmempooldescendants.mdx @@ -0,0 +1,33 @@ +--- +title: getmempooldescendants +sidebar_label: getmempooldescendants +description: "Syscoin Core CLI reference: getmempooldescendants" +--- + +# `getmempooldescendants` + +If txid is in the mempool, returns all in-mempool descendants. + +## Synopsis + +``` +getmempooldescendants "txid" ( verbose ) +``` + +## 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 +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/mempool.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/mempool.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getmempoolentry.mdx b/docs/cli/blockchain/getmempoolentry.mdx new file mode 100644 index 00000000..eb4f5a18 --- /dev/null +++ b/docs/cli/blockchain/getmempoolentry.mdx @@ -0,0 +1,65 @@ +--- +title: getmempoolentry +sidebar_label: getmempoolentry +description: "Syscoin Core CLI reference: getmempoolentry" +--- + +# `getmempoolentry` + +Returns mempool data for given transaction + +## Synopsis + +``` +getmempoolentry "txid" +``` + +## 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. + "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) + "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) + "wtxid" : "hex", (string) hash of serialized transaction, including witness data + "fees" : { (json object) + "base" : n, (numeric) transaction fee, denominated in SYS + "modified" : n, (numeric) transaction fee with fee deltas used for mining priority, denominated in SYS + "ancestor" : n, (numeric) transaction fees of in-mempool ancestors (including this one) with fee deltas used for mining priority, denominated in SYS + "descendant" : n (numeric) transaction fees of in-mempool descendants (including this one) with fee deltas used for mining priority, denominated in SYS + }, + "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 signals BIP125 replaceability or has an unconfirmed ancestor signaling BIP125 replaceability. + + "unbroadcast" : true|false (boolean) Whether this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers) +} +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/mempool.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/mempool.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getmempoolinfo.mdx b/docs/cli/blockchain/getmempoolinfo.mdx new file mode 100644 index 00000000..648b7089 --- /dev/null +++ b/docs/cli/blockchain/getmempoolinfo.mdx @@ -0,0 +1,44 @@ +--- +title: getmempoolinfo +sidebar_label: getmempoolinfo +description: "Syscoin Core CLI reference: getmempoolinfo" +--- + +# `getmempoolinfo` + +Returns details on the active state of the TX memory pool. + +## Synopsis + +``` +getmempoolinfo +``` + +## Result + +``` +{ (json object) + "loaded" : true|false, (boolean) True if the initial load attempt of the persisted mempool finished + "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 SYS, ignoring modified fees through prioritisetransaction + "maxmempool" : n, (numeric) Maximum memory usage for the mempool + "mempoolminfee" : n, (numeric) Minimum fee rate in SYS/kvB for tx to be accepted. Is the maximum of minrelaytxfee and minimum mempool fee + "minrelaytxfee" : n, (numeric) Current minimum relay fee for transactions + "incrementalrelayfee" : n, (numeric) minimum fee rate increment for mempool limiting or replacement in SYS/kvB + "unbroadcastcount" : n, (numeric) Current number of transactions that haven't passed initial broadcast yet + "fullrbf" : true|false (boolean) True if the mempool accepts RBF without replaceability signaling inspection +} +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/mempool.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/mempool.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/getrawmempool.mdx b/docs/cli/blockchain/getrawmempool.mdx new file mode 100644 index 00000000..126ee479 --- /dev/null +++ b/docs/cli/blockchain/getrawmempool.mdx @@ -0,0 +1,35 @@ +--- +title: getrawmempool +sidebar_label: getrawmempool +description: "Syscoin Core CLI reference: getrawmempool" +--- + +# `getrawmempool` + +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. + +## Synopsis + +``` +getrawmempool ( verbose mempool_sequence ) +``` + +## 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. +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/mempool.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/mempool.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/gettxout.mdx b/docs/cli/blockchain/gettxout.mdx new file mode 100644 index 00000000..d499f3cf --- /dev/null +++ b/docs/cli/blockchain/gettxout.mdx @@ -0,0 +1,40 @@ +--- +title: gettxout +sidebar_label: gettxout +description: "Syscoin Core CLI reference: gettxout" +--- + +# `gettxout` + +Returns details about an unspent transaction output. + +## Synopsis + +``` +gettxout "txid" n ( include_mempool ) +``` + +## 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. +``` + +## Examples + +``` +Get unspent transactions +> syscoin-cli listunspent + +View the details +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/gettxoutproof.mdx b/docs/cli/blockchain/gettxoutproof.mdx new file mode 100644 index 00000000..6c8ace92 --- /dev/null +++ b/docs/cli/blockchain/gettxoutproof.mdx @@ -0,0 +1,41 @@ +--- +title: gettxoutproof +sidebar_label: gettxoutproof +description: "Syscoin Core CLI reference: gettxoutproof" +--- + +# `gettxoutproof` + +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). + +## Synopsis + +``` +gettxoutproof ["txid",...] ( "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. +``` + +--- + +*Source: [src/rpc/txoutproof.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/txoutproof.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/gettxoutsetinfo.mdx b/docs/cli/blockchain/gettxoutsetinfo.mdx new file mode 100644 index 00000000..80c664a8 --- /dev/null +++ b/docs/cli/blockchain/gettxoutsetinfo.mdx @@ -0,0 +1,71 @@ +--- +title: gettxoutsetinfo +sidebar_label: gettxoutsetinfo +description: "Syscoin Core CLI reference: gettxoutsetinfo" +--- + +# `gettxoutsetinfo` + +Returns statistics about the unspent transaction output set. +Note this call may take some time if you are not using coinstatsindex. + +## Synopsis + +``` +gettxoutsetinfo ( "hash_type" hash_or_height use_index ) +``` + +## Arguments + +``` +1. hash_type (string, optional, default="hash_serialized_3") Which UTXO set hash should be calculated. Options: 'hash_serialized_3' (the legacy algorithm), 'muhash', 'none'. +2. hash_or_height (string or numeric, optional, default=the current best block) 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_3" : "hex", (string, optional) The serialized hash (only present if 'hash_serialized_3' hash_type is chosen) + "muhash" : "hex", (string, optional) The serialized hash (only present if 'muhash' hash_type is chosen) + "transactions" : n, (numeric, optional) The number of transactions with unspent outputs (not available when coinstatsindex is used) + "disk_size" : n, (numeric, optional) 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, optional) The total amount of coins permanently excluded from the UTXO set (only available if coinstatsindex is used) + "block_info" : { (json object, optional) Info on amounts in the block at this block height (only available if coinstatsindex is used) + "prevout_spent" : n, (numeric) Total amount of all prevouts spent in this block + "coinbase" : n, (numeric) Coinbase subsidy amount of this block + "new_outputs_ex_coinbase" : n, (numeric) Total amount of new outputs created by this block + "unspendable" : n, (numeric) Total amount of unspendable outputs created in this block + "unspendables" : { (json object) Detailed view of the unspendable categories + "genesis_block" : n, (numeric) The unspendable amount of the Genesis block subsidy + "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 + +``` +> syscoin-cli gettxoutsetinfo +> syscoin-cli gettxoutsetinfo "none" +> syscoin-cli gettxoutsetinfo "none" 1000 +> syscoin-cli gettxoutsetinfo "none" '"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"' +> syscoin-cli -named gettxoutsetinfo hash_type='muhash' use_index='false' +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "gettxoutsetinfo", "params": []}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "gettxoutsetinfo", "params": ["none"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +> 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:8370/ +> 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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/gettxspendingprevout.mdx b/docs/cli/blockchain/gettxspendingprevout.mdx new file mode 100644 index 00000000..bb438a2b --- /dev/null +++ b/docs/cli/blockchain/gettxspendingprevout.mdx @@ -0,0 +1,52 @@ +--- +title: gettxspendingprevout +sidebar_label: gettxspendingprevout +description: "Syscoin Core CLI reference: gettxspendingprevout" +--- + +# `gettxspendingprevout` + +Scans the mempool to find transactions spending any of the given outputs + +## Synopsis + +``` +gettxspendingprevout [{"txid":"hex","vout":n},...] +``` + +## Arguments + +``` +1. outputs (json array, required) The transaction outputs that we want to check, and within each, the txid (string) vout (numeric). + [ + { (json object) + "txid": "hex", (string, required) The transaction id + "vout": n, (numeric, required) The output number + }, + ... + ] +``` + +## Result + +``` +[ (json array) + { (json object) + "txid" : "hex", (string) the transaction id of the checked output + "vout" : n, (numeric) the vout value of the checked output + "spendingtxid" : "hex" (string, optional) the transaction id of the mempool transaction spending this output (omitted if unspent) + }, + ... +] +``` + +## Examples + +``` +> syscoin-cli gettxspendingprevout "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":3}]" +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "gettxspendingprevout", "params": ["[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":3}]"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/mempool.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/mempool.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/importmempool.mdx b/docs/cli/blockchain/importmempool.mdx new file mode 100644 index 00000000..b854e8d7 --- /dev/null +++ b/docs/cli/blockchain/importmempool.mdx @@ -0,0 +1,51 @@ +--- +title: importmempool +sidebar_label: importmempool +description: "Syscoin Core CLI reference: importmempool" +--- + +# `importmempool` + +Import a mempool.dat file and attempt to add its contents to the mempool. +Warning: Importing untrusted files is dangerous, especially if metadata from the file is taken over. + +## Synopsis + +``` +importmempool "filepath" ( options ) +``` + +## Arguments + +``` +1. filepath (string, required) The mempool file +2. options (json object, optional) Options object that can be used to pass named arguments, listed below. + +Named Arguments: +use_current_time (boolean, optional, default=true) Whether to use the current system time or use the entry time metadata from the mempool file. + Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior. +apply_fee_delta_priority (boolean, optional, default=false) Whether to apply the fee delta metadata from the mempool file. + It will be added to any existing fee deltas. + The fee delta can be set by the prioritisetransaction RPC. + Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior. + Only set this bool if you understand what it does. +apply_unbroadcast_set (boolean, optional, default=false) Whether to apply the unbroadcast set metadata from the mempool file. + Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior. +``` + +## Result + +``` +{} (empty JSON object) +``` + +## Examples + +``` +> syscoin-cli importmempool /path/to/mempool.dat +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "importmempool", "params": [/path/to/mempool.dat]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/loadtxoutset.mdx b/docs/cli/blockchain/loadtxoutset.mdx new file mode 100644 index 00000000..54fdcc6a --- /dev/null +++ b/docs/cli/blockchain/loadtxoutset.mdx @@ -0,0 +1,47 @@ +--- +title: loadtxoutset +sidebar_label: loadtxoutset +description: "Syscoin Core CLI reference: loadtxoutset" +--- + +# `loadtxoutset` + +Load the serialized UTXO set from disk. +Once this snapshot is loaded, its contents will be deserialized into a second chainstate data structure, which is then used to sync to the network's tip. Meanwhile, the original chainstate will complete the initial block download process in the background, eventually validating up to the block that the snapshot is based upon. + +The result is a usable syscoind instance that is current with the network tip in a matter of minutes rather than hours. UTXO snapshot are typically obtained from third-party sources (HTTP, torrent, etc.) which is reasonable since their contents are always checked by hash. + +You can find more information on this process in the `assumeutxo` design document (``). + +## Synopsis + +``` +loadtxoutset "path" +``` + +## Arguments + +``` +1. path (string, required) path to the snapshot file. If relative, will be prefixed by datadir. +``` + +## Result + +``` +{ (json object) + "coins_loaded" : n, (numeric) the number of coins loaded from the snapshot + "tip_hash" : "hex", (string) the hash of the base of the snapshot + "base_height" : n, (numeric) the height of the base of the snapshot + "path" : "str" (string) the absolute path that the snapshot was loaded from +} +``` + +## Examples + +``` +> syscoin-cli loadtxoutset utxo.dat +``` + +--- + +*Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/preciousblock.mdx b/docs/cli/blockchain/preciousblock.mdx new file mode 100644 index 00000000..1d76ea14 --- /dev/null +++ b/docs/cli/blockchain/preciousblock.mdx @@ -0,0 +1,42 @@ +--- +title: preciousblock +sidebar_label: preciousblock +description: "Syscoin Core CLI reference: preciousblock" +--- + +# `preciousblock` + +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. + +## Synopsis + +``` +preciousblock "blockhash" +``` + +## Arguments + +``` +1. blockhash (string, required) the hash of the block to mark as precious +``` + +## Result + +``` +null (json null) +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/pruneblockchain.mdx b/docs/cli/blockchain/pruneblockchain.mdx new file mode 100644 index 00000000..aaf2a7a8 --- /dev/null +++ b/docs/cli/blockchain/pruneblockchain.mdx @@ -0,0 +1,37 @@ +--- +title: pruneblockchain +sidebar_label: pruneblockchain +description: "Syscoin Core CLI reference: pruneblockchain" +--- + +# `pruneblockchain` + +## Synopsis + +``` +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 + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/savemempool.mdx b/docs/cli/blockchain/savemempool.mdx new file mode 100644 index 00000000..941d8820 --- /dev/null +++ b/docs/cli/blockchain/savemempool.mdx @@ -0,0 +1,34 @@ +--- +title: savemempool +sidebar_label: savemempool +description: "Syscoin Core CLI reference: savemempool" +--- + +# `savemempool` + +Dumps the mempool to disk. It will fail until the previous dump is fully loaded. + +## Synopsis + +``` +savemempool +``` + +## Result + +``` +{ (json object) + "filename" : "str" (string) the directory and file where the mempool was saved +} +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/mempool.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/mempool.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/scanblocks.mdx b/docs/cli/blockchain/scanblocks.mdx new file mode 100644 index 00000000..e6cc5323 --- /dev/null +++ b/docs/cli/blockchain/scanblocks.mdx @@ -0,0 +1,57 @@ +--- +title: scanblocks +sidebar_label: scanblocks +description: "Syscoin Core CLI reference: scanblocks" +--- + +# `scanblocks` + +Return relevant blockhashes for given descriptors (requires blockfilterindex). +This call may take several minutes. Make sure to use no RPC timeout (syscoin-cli -rpcclienttimeout=0) + +## Synopsis + +``` +scanblocks "action" ( [scanobjects,...] start_height stop_height "filtertype" options ) +``` + +## 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, optional) 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]) + }, + ... + ] +3. start_height (numeric, optional, default=0) Height to start to scan from +4. stop_height (numeric, optional, default=chain tip) Height to stop to scan +5. filtertype (string, optional, default="basic") The type name of the filter +6. options (json object, optional) + { + "filter_false_positives": bool, (boolean, optional, default=false) Filter false positives (slower and may fail on pruned nodes). Otherwise they may occur at a rate of 1/M + } +``` + +## Examples + +``` +> syscoin-cli scanblocks start '["addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)"]' 300000 +> syscoin-cli scanblocks start '["addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)"]' 100 150 basic +> syscoin-cli scanblocks status +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "scanblocks", "params": ["start", ["addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)"], 300000]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "scanblocks", "params": ["start", ["addr(bcrt1q4u4nsgk6ug0sqz7r3rj9tykjxrsl0yy4d0wwte)"], 100, 150, "basic"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "scanblocks", "params": ["status"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/scantxoutset.mdx b/docs/cli/blockchain/scantxoutset.mdx new file mode 100644 index 00000000..ea4b823c --- /dev/null +++ b/docs/cli/blockchain/scantxoutset.mdx @@ -0,0 +1,49 @@ +--- +title: scantxoutset +sidebar_label: scantxoutset +description: "Syscoin Core CLI reference: scantxoutset" +--- + +# `scantxoutset` + +Scans the unspent transaction output set for entries that match certain output descriptors. + +## Synopsis + +``` +scantxoutset "action" ( [scanobjects,...] ) +``` + +## 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, optional) 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]) + }, + ... + ] +``` + +## Examples + +``` +> syscoin-cli scantxoutset start '["raw(76a91411b366edfc0a8b66feebae5c2e25a7b6a5d1cf3188ac)#fm24fxxy"]' +> syscoin-cli scantxoutset status +> syscoin-cli scantxoutset abort +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "scantxoutset", "params": ["start", ["raw(76a91411b366edfc0a8b66feebae5c2e25a7b6a5d1cf3188ac)#fm24fxxy"]]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "scantxoutset", "params": ["status"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "scantxoutset", "params": ["abort"]}' -H 'content-type: text/plain;' http://127.0.0.1:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/verifychain.mdx b/docs/cli/blockchain/verifychain.mdx new file mode 100644 index 00000000..89dc95d3 --- /dev/null +++ b/docs/cli/blockchain/verifychain.mdx @@ -0,0 +1,45 @@ +--- +title: verifychain +sidebar_label: verifychain +description: "Syscoin Core CLI reference: verifychain" +--- + +# `verifychain` + +Verifies blockchain database. + +## Synopsis + +``` +verifychain ( checklevel nblocks ) +``` + +## 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) Verification finished successfully. If false, check debug.log for reason. +``` + +## Examples + +``` +> syscoin-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:8370/ +``` + +--- + +*Source: [src/rpc/blockchain.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/blockchain.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.* diff --git a/docs/cli/blockchain/verifytxoutproof.mdx b/docs/cli/blockchain/verifytxoutproof.mdx new file mode 100644 index 00000000..55776629 --- /dev/null +++ b/docs/cli/blockchain/verifytxoutproof.mdx @@ -0,0 +1,35 @@ +--- +title: verifytxoutproof +sidebar_label: verifytxoutproof +description: "Syscoin Core CLI reference: verifytxoutproof" +--- + +# `verifytxoutproof` + +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 + +## Synopsis + +``` +verifytxoutproof "proof" +``` + +## 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 cannot be validated. + ... +] +``` + +--- + +*Source: [src/rpc/txoutproof.cpp](https://github.com/syscoin/syscoin/blob/master/src/rpc/txoutproof.cpp). Auto-generated from Syscoin Core 5.0.5 on 2026-05-19.*