Blockchain RPCs#
GetBestBlockHash#
The getbestblockhash
RPC returns the header hash of the most recent block on the best blockchain.
Parameters: none
Result—hash of the tip from the best block chain
Name |
Type |
Presence |
Description |
---|---|---|---|
|
string (hex) |
Required |
The hash of the block header from the most recent block on the best block chain, encoded as hex in RPC byte order |
Example from Dash Core 0.12.2
dash-cli -testnet getbestblockhash
Result:
00000bafbc94add76cb75e2ec92894837288a481e5c005f6563d91623bf8bc2c
See also
GetBlock: gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.
GetBlockHash: returns the header hash of a block at the given height in the local best block chain.
DumpTxOutset#
Write the serialized UTXO set to disk.
Parameter #1—path to output file
Name |
Type |
Presence |
Description |
---|---|---|---|
path |
string (hex) |
Required |
Path to the output file. If relative, will be prefixed by datadir. |
Result
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object/null |
Required |
An object containing the requested block, or JSON |
→ |
number (int) |
Required |
the number of coins written in the snapshot |
→ |
string (hex) |
Required |
the hash of the base of the snapshot |
→ |
number (int) |
Required |
the height of the base of the snapshot |
→ |
string (str) |
Required |
the absolute path that the snapshot was written to |
Example from Dash Core 18.1.0
dash-cli dumptxoutset a
Result:
{
"coins_written": 4313775,
"base_hash": "000000000000000ef8f6b8f9b73ae4c516b961b7bbc01945b48d84b954ae68a1",
"base_height": 1412676,
"path": "/Users/username/Library/Application Support/DashCore/a"
}
GetBestChainLock#
The getbestchainlock
RPC returns the information about the best ChainLock.
Throws an error if there is no known ChainLock yet.
Parameters: none
Result
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object/null |
Required |
An object containing the requested block, or JSON |
→ |
string (hex) |
Required |
The hash of the block encoded as hex in RPC byte order |
→ |
number (int) |
Required |
The height of this block on its block chain |
→ |
string (hex) |
Required |
Added in Dash Core 0.17.0 |
→ |
boolean |
Required |
True if the block is known by this node |
Example from Dash Core 0.17.0
dash-cli -testnet getbestchainlock
Result:
{
"blockhash": "00000c0e7a866e67444813858b976886d839aff28f56dc178c92ed1390c97f4e",
"height": 405044,
"signature": "960ead08adcc3fcf5e576f9e6ad290251325db900d19d961f5ece398b5389390b8a44e8986199c201ac348a89bc8534a0f7153c61c54157a241c521131025e5054b7c4298065069e478abdaea4d6c861848061e32c0d903ddeb5ee6036e8ddcf",
"known_block": true
}
See also: none
GetBlock#
The getblock
RPC gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.
Parameter #1—block hash
Name |
Type |
Presence |
Description |
---|---|---|---|
Block Hash |
string (hex) |
Required |
The hash of the header of the block to get, encoded as hex in RPC byte order |
Parameter #2—whether to get JSON or hex output
Name |
Type |
Presence |
Description |
---|---|---|---|
Verbosity |
number (int) |
Optional |
Set to one of the following verbosity levels: |
Result (if verbosity was 0
)—a serialized block
Name |
Type |
Presence |
Description |
---|---|---|---|
|
string (hex)/null |
Required |
The requested block as a serialized block, encoded as hex, or JSON |
Result (if verbosity was 1
or omitted)—a JSON block with transaction hashes
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object/null |
Required |
An object containing the requested block, or JSON |
→ |
string (hex) |
Required |
The hash of this block’s block header encoded as hex in RPC byte order. This is the same as the hash provided in parameter #1 |
→ |
number (int) |
Required |
The number of confirmations the transactions in this block have, starting at 1 when this block is at the tip of the best block chain. This score will be -1 if the the block is not part of the best block chain |
→ |
number (int) |
Required |
The height of this block on its block chain |
→ |
number (int) |
Required |
This block’s version number. See block version numbers |
→ |
string (hex) |
Required |
Added in Bitcoin Core 0.13.0 |
→ |
string (hex) |
Required |
The merkle root for this block, encoded as hex in RPC byte order |
→ |
number (int) |
Required |
The value of the time field in the block header, indicating approximately when the block was created |
→ |
number (int) |
Required |
Added in Bitcoin Core 0.12.0 |
→ |
number (int) |
Required |
The nonce which was successful at turning this particular block into one that could be added to the best block chain |
→ |
string (hex) |
Required |
The value of the nBits field in the block header, indicating the target threshold this block’s header had to pass |
→ |
number (real) |
Required |
The estimated amount of work done to find this block relative to the estimated amount of work done to find block 0 |
→ |
string (hex) |
Required |
The estimated number of block header hashes miners had to check from the genesis block to this block, encoded as big-endian hex |
→ |
number (int) |
Required |
Added in Dash Core 0.16.0 |
→ |
string (hex) |
Optional |
The hash of the header of the previous block, encoded as hex in RPC byte order. Not returned for genesis block |
→ |
string (hex) |
Optional |
The hash of the next block on the best block chain, if known, encoded as hex in RPC byte order |
→ |
bool |
Required |
Added in Dash Core 0.14.0 |
→ |
number (int) |
Required |
The size of this block in serialized block format, counted in bytes |
→ |
array |
Required |
An array containing the TXIDs of all transactions in this block. The transactions appear in the array in the same order they appear in the serialized block |
→ → |
string (hex) |
Required |
The TXID of a transaction in this block, encoded as hex in RPC byte order |
→ |
object |
Required |
Coinbase special transaction details |
→ → |
number (int) |
Required |
The version of the Coinbase special transaction (CbTx) |
→ → |
number (int) |
Required |
The height of this block on its block chain |
→ → |
string (hex) |
Required |
The merkle root for the masternode list |
→ → |
string (hex) |
Required |
The merkle root for the quorum list |
→ → |
number (int) |
Required |
Added in Dash Core 20.0.0 |
→ → |
string (hex) |
Required |
Added in Dash Core 20.0.0 |
→ → |
number (real) |
Required |
Added in Dash Core 20.0.0 |
Result (if verbosity was 2
—a JSON block with full transaction details
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object/null |
Required |
An object containing the requested block, or JSON |
→ |
string (hex) |
Required |
The hash of this block’s block header encoded as hex in RPC byte order. This is the same as the hash provided in parameter #1 |
→ |
number (int) |
Required |
The number of confirmations the transactions in this block have, starting at 1 when this block is at the tip of the best block chain. This score will be -1 if the the block is not part of the best block chain |
→ |
number (int) |
Required |
The height of this block on its block chain |
→ |
number (int) |
Required |
This block’s version number. See block version numbers |
→ |
string (hex) |
Required |
Added in Bitcoin Core 0.13.0 |
→ |
string (hex) |
Required |
The merkle root for this block, encoded as hex in RPC byte order |
→ |
number (int) |
Required |
The value of the time field in the block header, indicating approximately when the block was created |
→ |
number (int) |
Required |
Added in Bitcoin Core 0.12.0 |
→ |
number (int) |
Required |
The nonce which was successful at turning this particular block into one that could be added to the best block chain |
→ |
string (hex) |
Required |
The value of the nBits field in the block header, indicating the target threshold this block’s header had to pass |
→ |
number (real) |
Required |
The estimated amount of work done to find this block relative to the estimated amount of work done to find block 0 |
→ |
string (hex) |
Required |
The estimated number of block header hashes miners had to check from the genesis block to this block, encoded as big-endian hex |
→ |
number (int) |
Required |
Added in Dash Core 0.16.0 |
→ |
string (hex) |
Optional |
The hash of the header of the previous block, encoded as hex in RPC byte order. Not returned for genesis block |
→ |
string (hex) |
Optional |
The hash of the next block on the best block chain, if known, encoded as hex in RPC byte order |
→ |
bool |
Required |
Added in Dash Core 0.14.0 |
→ |
number (int) |
Required |
The size of this block in serialized block format, counted in bytes |
→ |
array |
Required |
An array containing the details for all transactions in this block. The transactions appear in the array in the same order they appear in the serialized block |
→ → |
string (hex) |
Required |
The transaction’s TXID encoded as hex in RPC byte order |
→ → |
number (int) |
Required |
Added in Bitcoin Core 0.12.0 |
→ → |
number (int) |
Required |
The transaction format version number |
→ → |
number (int) |
Required |
Added in Dash Core 0.13.0.0 |
→ → |
number (int) |
Required |
The transaction’s locktime: either a Unix epoch date or block height; see the locktime parsing rules |
→ → |
array |
Required |
An array of objects with each object being an input vector (vin) for this transaction. Input objects will have the same order within the array as they have in the transaction, so the first input listed will be input 0 |
→ → → |
object |
Required |
An object describing one of this transaction’s inputs. May be a regular input or a coinbase |
→ → → → |
string |
Optional |
The TXID of the outpoint being spent, encoded as hex in RPC byte order. Not present if this is a coinbase transaction |
→ → → → |
number (int) |
Optional |
The output index number (vout) of the outpoint being spent. The first output in a transaction has an index of |
→ → → → |
object |
Optional |
An object describing the signature script of this input. Not present if this is a coinbase transaction |
→ → → → → |
string |
Required |
The signature script in decoded form with non-data-pushing opcodes listed |
→ → → → → |
string (hex) |
Required |
The signature script encoded as hex |
→ → → → |
string (hex) |
Optional |
The coinbase (similar to the hex field of a scriptSig) encoded as hex. Only present if this is a coinbase transaction |
→ → → → |
number (Dash) |
Optional |
The number of Dash paid to this output. May be |
→ → → → |
number (duffs) |
Optional |
The number of duffs paid to this output. May be |
→ → → → → |
string : array |
Optional |
The P2PKH or P2SH addresses used in this transaction, or the computed P2PKH address of any pubkeys in this transaction. This array will not be returned for |
→ → → → → → |
string |
Required |
A P2PKH or P2SH address |
→ → → → |
number (int) |
Required |
The input sequence number |
→ → |
array |
Required |
An array of objects each describing an output vector (vout) for this transaction. Output objects will have the same order within the array as they have in the transaction, so the first output listed will be output 0 |
→ → → |
object |
Required |
An object describing one of this transaction’s outputs |
→ → → → |
number (Dash) |
Required |
The number of Dash paid to this output. May be |
→ → → → |
number (duffs) |
Required |
The number of duffs paid to this output. May be |
→ → → → |
number (int) |
Required |
The output index number of this output within this transaction |
→ → → → |
object |
Required |
An object describing the pubkey script |
→ → → → → |
string |
Required |
The pubkey script in decoded form with non-data-pushing opcodes listed |
→ → → → → |
string (hex) |
Required |
The pubkey script encoded as hex |
→ → → → → |
number (int) |
Optional |
The number of signatures required; this is always |
→ → → → → |
string |
Optional |
The type of script. This will be one of the following: |
→ → → → → |
string : array |
Optional |
The P2PKH or P2SH addresses used in this transaction, or the computed P2PKH address of any pubkeys in this transaction. This array will not be returned for |
→ → → → → → |
string |
Required |
A P2PKH or P2SH address |
→ → |
number (int) |
Optional |
Added in Dash Core 0.13.0.0 |
→ → |
string (hex) |
Optional |
Added in Dash Core 0.13.0.0 |
→ → |
number |
Optional |
The transaction fee in DASH, omitted if block undo data is not available |
→ → |
bool |
Required |
If set to |
→ → |
bool |
Required |
If set to |
→ |
object |
Required |
Coinbase special transaction details |
→ → |
number (int) |
Required |
The version of the Coinbase special transaction (CbTx) |
→ → |
number (int) |
Required |
The height of this block on its block chain |
→ → |
string (hex) |
Required |
The merkle root for the masternode list |
→ → |
string (hex) |
Required |
The merkle root for the quorum list |
→ → |
number (int) |
Required |
Added in Dash Core 20.0.0 |
→ → |
string (hex) |
Required |
Added in Dash Core 20.0.0 |
→ → |
number (real) |
Required |
Added in Dash Core 20.0.0 |
Example from Dash Core 21.0.0
Get a block in raw hex:
dash-cli -testnet getblock \
00000379fb0a60210eb58e736775784b4e0491ae23b65f7916988f9d780a9f93 \
0
Result (wrapped):
00000020fdd8c7fa1c64fe932918d0a5c40209ab155f738291dec38c9e39690c\
22000000cac98c66d5f8828ec72b68a24d61e354a19434fa0569707b90e5cd47\
fefdd7653d425d6541f3031e468a050001030005000100000000000000000000\
00000000000000000000000000000000000000000000ffffffff060326ff0d01\
01ffffffff0283706e04000000001976a914c69a0bda7daaae481be8def95e5f\
347a1d00a4b488ac89514b0d000000001976a91421eca01872dbfce4bf20886a\
004f6caaa69c1ff788ac00000000af030026ff0d00581474bac547d8c933eb30\
4e1c98d241bf807a85ea706591dacee405b3e7d3fac4c4566f175ccb5e3ee12f\
0e869d2bb1ede63112975c8d147f8c072bd63960fe009849edd3f5f7c4ddfa54\
dd43b06a8a6ca9043c6a6498cf0d757902e69301f780a5d6190ac0da904420bb\
c2e8079f590d0ebca384512f1c61910b51336e401759734189de9bdb9d26d299\
c225e3ee290a7c96a448b83ed97f1e9ed34be1da354566da8a0202000000
Get the same block in JSON:
dash-cli -testnet getblock \
00000379fb0a60210eb58e736775784b4e0491ae23b65f7916988f9d780a9f93
Result:
{
"hash": "00000379fb0a60210eb58e736775784b4e0491ae23b65f7916988f9d780a9f93",
"confirmations": 107991,
"height": 917286,
"version": 536870912,
"versionHex": "20000000",
"merkleroot": "65d7fdfe47cde5907b706905fa3494a154e3614da2682bc78e82f8d5668cc9ca",
"time": 1700610621,
"mediantime": 1700609994,
"nonce": 363078,
"bits": "1e03f341",
"difficulty": 0.0009888562457268011,
"chainwork": "00000000000000000000000000000000000000000000000002d68d38fa5ef014",
"nTx": 1,
"previousblockhash": "000000220c69399e8cc3de9182735f15ab0902c4a5d0182993fe641cfac7d8fd",
"nextblockhash": "0000039bbed5dba71339bf917be5a797123919f02d1d9bda78cae3ab5d38985e",
"chainlock": true,
"size": 382,
"tx": [
"65d7fdfe47cde5907b706905fa3494a154e3614da2682bc78e82f8d5668cc9ca"
],
"cbTx": {
"version": 3,
"height": 917286,
"merkleRootMNList": "fad3e7b305e4ceda916570ea857a80bf41d2981c4e30eb33c9d847c5ba741458",
"merkleRootQuorums": "fe6039d62b078c7f148d5c971231e6edb12b9d860e2fe13e5ecb5c176f56c4c4",
"bestCLHeightDiff": 0,
"bestCLSignature": "9849edd3f5f7c4ddfa54dd43b06a8a6ca9043c6a6498cf0d757902e69301f780a5d6190ac0da904420bbc2e8079f590d0ebca384512f1c61910b51336e401759734189de9bdb9d26d299c225e3ee290a7c96a448b83ed97f1e9ed34be1da3545",
"creditPoolBalance": 86.32588902
}
}
Get the same block in JSON with transaction details:
dash-cli -testnet getblock \
00000379fb0a60210eb58e736775784b4e0491ae23b65f7916988f9d780a9f93 2
Result:
{
"hash": "00000379fb0a60210eb58e736775784b4e0491ae23b65f7916988f9d780a9f93",
"confirmations": 107993,
"height": 917286,
"version": 536870912,
"versionHex": "20000000",
"merkleroot": "65d7fdfe47cde5907b706905fa3494a154e3614da2682bc78e82f8d5668cc9ca",
"time": 1700610621,
"mediantime": 1700609994,
"nonce": 363078,
"bits": "1e03f341",
"difficulty": 0.0009888562457268011,
"chainwork": "00000000000000000000000000000000000000000000000002d68d38fa5ef014",
"nTx": 1,
"previousblockhash": "000000220c69399e8cc3de9182735f15ab0902c4a5d0182993fe641cfac7d8fd",
"nextblockhash": "0000039bbed5dba71339bf917be5a797123919f02d1d9bda78cae3ab5d38985e",
"chainlock": true,
"size": 382,
"tx": [
{
"txid": "65d7fdfe47cde5907b706905fa3494a154e3614da2682bc78e82f8d5668cc9ca",
"version": 3,
"type": 5,
"size": 301,
"locktime": 0,
"vin": [
{
"coinbase": "0326ff0d0101",
"sequence": 4294967295
}
],
"vout": [
{
"value": 0.74346627,
"valueSat": 74346627,
"n": 0,
"scriptPubKey": {
"asm": "OP_DUP OP_HASH160 c69a0bda7daaae481be8def95e5f347a1d00a4b4 OP_EQUALVERIFY OP_CHECKSIG",
"hex": "76a914c69a0bda7daaae481be8def95e5f347a1d00a4b488ac",
"reqSigs": 1,
"type": "pubkeyhash",
"addresses": [
"yeRZBWYfeNE4yVUHV4ZLs83Ppn9aMRH57A"
]
}
},
{
"value": 2.23039881,
"valueSat": 223039881,
"n": 1,
"scriptPubKey": {
"asm": "OP_DUP OP_HASH160 21eca01872dbfce4bf20886a004f6caaa69c1ff7 OP_EQUALVERIFY OP_CHECKSIG",
"hex": "76a91421eca01872dbfce4bf20886a004f6caaa69c1ff788ac",
"reqSigs": 1,
"type": "pubkeyhash",
"addresses": [
"yPQpcZ1EdtQXWHzNjZuvVCKXuESW5wZ5x1"
]
}
}
],
"extraPayloadSize": 175,
"extraPayload": "030026ff0d00581474bac547d8c933eb304e1c98d241bf807a85ea706591dacee405b3e7d3fac4c4566f175ccb5e3ee12f0e869d2bb1ede63112975c8d147f8c072bd63960fe009849edd3f5f7c4ddfa54dd43b06a8a6ca9043c6a6498cf0d757902e69301f780a5d6190ac0da904420bbc2e8079f590d0ebca384512f1c61910b51336e401759734189de9bdb9d26d299c225e3ee290a7c96a448b83ed97f1e9ed34be1da354566da8a0202000000",
"cbTx": {
"version": 3,
"height": 917286,
"merkleRootMNList": "fad3e7b305e4ceda916570ea857a80bf41d2981c4e30eb33c9d847c5ba741458",
"merkleRootQuorums": "fe6039d62b078c7f148d5c971231e6edb12b9d860e2fe13e5ecb5c176f56c4c4",
"bestCLHeightDiff": 0,
"bestCLSignature": "9849edd3f5f7c4ddfa54dd43b06a8a6ca9043c6a6498cf0d757902e69301f780a5d6190ac0da904420bbc2e8079f590d0ebca384512f1c61910b51336e401759734189de9bdb9d26d299c225e3ee290a7c96a448b83ed97f1e9ed34be1da3545",
"creditPoolBalance": 86.32588902
},
"hex": "03000500010000000000000000000000000000000000000000000000000000000000000000ffffffff060326ff0d0101ffffffff0283706e04000000001976a914c69a0bda7daaae481be8def95e5f347a1d00a4b488ac89514b0d000000001976a91421eca01872dbfce4bf20886a004f6caaa69c1ff788ac00000000af030026ff0d00581474bac547d8c933eb304e1c98d241bf807a85ea706591dacee405b3e7d3fac4c4566f175ccb5e3ee12f0e869d2bb1ede63112975c8d147f8c072bd63960fe009849edd3f5f7c4ddfa54dd43b06a8a6ca9043c6a6498cf0d757902e69301f780a5d6190ac0da904420bbc2e8079f590d0ebca384512f1c61910b51336e401759734189de9bdb9d26d299c225e3ee290a7c96a448b83ed97f1e9ed34be1da354566da8a0202000000",
"instantlock": true,
"instantlock_internal": false
}
],
"cbTx": {
"version": 3,
"height": 917286,
"merkleRootMNList": "fad3e7b305e4ceda916570ea857a80bf41d2981c4e30eb33c9d847c5ba741458",
"merkleRootQuorums": "fe6039d62b078c7f148d5c971231e6edb12b9d860e2fe13e5ecb5c176f56c4c4",
"bestCLHeightDiff": 0,
"bestCLSignature": "9849edd3f5f7c4ddfa54dd43b06a8a6ca9043c6a6498cf0d757902e69301f780a5d6190ac0da904420bbc2e8079f590d0ebca384512f1c61910b51336e401759734189de9bdb9d26d299c225e3ee290a7c96a448b83ed97f1e9ed34be1da3545",
"creditPoolBalance": 86.32588902
}
}
See also
GetBlockHash: returns the header hash of a block at the given height in the local best block chain.
GetBestBlockHash: returns the header hash of the most recent block on the best block chain.
GetBlockChainInfo#
The getblockchaininfo
RPC provides information about the current state of the block chain.
Parameters: none
Result—A JSON object providing information about the block chain
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object |
Required |
Information about the current state of the local block chain |
→ |
string |
Required |
The name of the block chain. Either |
→ |
number (int) |
Required |
The number of validated blocks in the local best block chain. For a new node with just the hardcoded genesis block, this will be 0 |
→ |
number (int) |
Required |
The number of validated headers in the local best headers chain. For a new node with just the hardcoded genesis block, this will be zero. This number may be higher than the number of blocks |
→ |
string (hex) |
Required |
The hash of the header of the highest validated block in the best block chain, encoded as hex in RPC byte order. This is identical to the string returned by the |
→ |
number (real) |
Required |
The difficulty of the highest-height block in the best block chain |
→ |
number (int) |
Required |
Added in Dash Core 20.1.0 |
→ |
number (int) |
Required |
Added in Bitcoin Core 0.12.0 |
→ |
number (real) |
Required |
Estimate of what percentage of the block chain transactions have been verified so far, starting at 0.0 and increasing to 1.0 for fully verified. May slightly exceed 1.0 when fully synced to account for transactions in the memory pool which have been verified before being included in a block |
→ |
boolean |
Required |
Added in Dash Core 0.16.0 |
→ |
string (hex) |
Required |
The estimated number of block header hashes checked from the genesis block to this block, encoded as big-endian hex |
→ |
number (int) |
Required |
Added in Dash Core 0.16.0 |
→ |
bool |
Required |
Added in Bitcoin Core 0.11.0 |
→ |
number (int) |
Optional |
Added in Bitcoin Core 0.11.0 |
→ |
bool |
Required |
Added in Dash Core 0.16.0 |
→ |
number (int) |
Optional |
Added in Dash Core 0.16.0 |
→ |
object |
Required |
Revised significantly in Dash Core 20.0.0 |
→ → |
object |
Required |
The name of a specific softfork |
→ → → |
string |
Required |
One of “buried”, “bip9” |
→ → → |
object |
Optional |
Status of bip9 softforks (only for “bip9” type) |
→ → → → |
string |
Required |
One of “defined”, “started”, “locked_in”, “active”, “failed” |
→ → → → |
numeric |
Optional |
The bit (0-28) in the block version field used to signal this softfork (only for “started” status) |
→ → → → |
numeric |
Required |
The minimum median time past of a block at which the bit gains its meaning |
→ → → → |
numeric |
Required |
The median time past of a block at which the deployment is considered failed if not yet locked in |
→ → → → |
numeric |
Required |
Height of the first block to which the status applies |
→ → → → |
numeric |
Optional |
Expected activation height for this softfork (only for “locked_in” |
→ → → → |
numeric |
Optional |
Minimum height of blocks for which the rules may be enforced |
→ → → → |
bool |
Required |
|
→ → → → |
numeric |
Optional |
The minimum height at which miner’s signals for the deployment matter. Below this height miner signaling cannot trigger hard fork lock-in. Not returned if |
→ → → → |
string : object |
Required |
Added in Dash Core 0.15.0 |
→ → → → → |
numeric |
Optional |
Added in Dash Core 0.15.0 |
→ → → → → |
numeric |
Optional |
Added in Dash Core 0.15.0 |
→ → → → → |
numeric |
Optional |
Added in Dash Core 0.15.0 |
→ → → → → |
numeric |
Optional |
Added in Dash Core 0.15.0 |
→ → → → → |
bool |
Optional |
Added in Bitcoin Core 0.11.0 |
→ → → |
numeric |
Optional |
Height of the first block at which the rules are or will be enforced (only for “buried” type, or “bip9” type with “active” status) |
→ → → |
boolean |
Required |
True if the rules are enforced for the mempool and the next block |
→ |
string |
Optional |
Added in Dash Core 0.16.0 |
Example from Dash Core 21.0.0
dash-cli -testnet getblockchaininfo
Result:
{
"chain": "test",
"blocks": 1025413,
"headers": 1025413,
"bestblockhash": "000000a7f4dbe0865dbbfacf24d8cdb2914fc0ba2d24131ed7ea0b181bec532f",
"difficulty": 0.002316476131335342,
"time": 1715629755,
"mediantime": 1715628900,
"verificationprogress": 0.9999996933131421,
"initialblockdownload": false,
"chainwork": "000000000000000000000000000000000000000000000000030928dd71247c3d",
"size_on_disk": 3508237778,
"pruned": false,
"softforks": {
"bip34": {
"type": "buried",
"active": true,
"height": 76
},
"bip66": {
"type": "buried",
"active": true,
"height": 2075
},
"bip65": {
"type": "buried",
"active": true,
"height": 2431
},
"bip147": {
"type": "buried",
"active": true,
"height": 4300
},
"csv": {
"type": "buried",
"active": true,
"height": 8064
},
"dip0001": {
"type": "buried",
"active": true,
"height": 5500
},
"dip0003": {
"type": "buried",
"active": true,
"height": 7000
},
"dip0008": {
"type": "buried",
"active": true,
"height": 78800
},
"dip0020": {
"type": "buried",
"active": true,
"height": 414100
},
"dip0024": {
"type": "buried",
"active": true,
"height": 769700
},
"realloc": {
"type": "buried",
"active": true,
"height": 387500
},
"v19": {
"type": "buried",
"active": true,
"height": 850100
},
"v20": {
"type": "bip9",
"bip9": {
"status": "active",
"start_time": 1693526400,
"timeout": 9223372036854775807,
"ehf": false,
"since": 905100,
"min_activation_height": 0
},
"height": 905100,
"active": true
},
"mn_rr": {
"type": "bip9",
"bip9": {
"status": "defined",
"start_time": 1693526400,
"timeout": 9223372036854775807,
"ehf": true,
"since": 0,
"min_activation_height": 0
},
"active": false
}
},
"warnings": "Make sure to encrypt your wallet and delete all non-encrypted backups after you have verified that the wallet works!"
}
See also
GetMiningInfo: returns various mining-related information.
GetNetworkInfo: returns information about the node’s connection to the network.
GetWalletInfo: provides information about the wallet.
GetBlockCount#
The getblockcount
RPC returns the number of blocks in the local best block chain.
Parameters: none
Result—the number of blocks in the local best block chain
Name |
Type |
Presence |
Description |
---|---|---|---|
|
number (int) |
Required |
The number of blocks in the local best block chain. For a new node with only the hardcoded genesis block, this number will be 0 |
Example from Dash Core 0.12.2
dash-cli -testnet getblockcount
Result:
4627
See also
GetBlockHash: returns the header hash of a block at the given height in the local best block chain.
GetBlock: gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.
GetBlockHash#
The getblockhash
RPC returns the header hash of a block at the given height in the local best block chain.
Parameter—a block height
Name |
Type |
Presence |
Description |
---|---|---|---|
Block Height |
number (int) |
Required |
The height of the block whose header hash should be returned. The height of the hardcoded genesis block is 0 |
Result—the block header hash
Name |
Type |
Presence |
Description |
---|---|---|---|
|
string (hex)/null |
Required |
The hash of the block at the requested height, encoded as hex in RPC byte order, or JSON |
Example from Dash Core 0.12.2
dash-cli -testnet getblockhash 4000
Result:
00000ce22113f3eb8636e225d6a1691e132fdd587aed993e1bc9b07a0235eea4
See also
GetBlock: gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.
GetBestBlockHash: returns the header hash of the most recent block on the best block chain.
GetBlockFilter#
Added in Dash Core 18.0.0
The getblockfilter
RPC retrieves a BIP157 content filter for a particular block.
Note
Requires the -blockfilterindex
Dash Core command-line/configuration-file parameter to be enabled.
Parameter #1—blockhash
Name |
Type |
Presence |
Description |
---|---|---|---|
Hash |
string |
Required |
The hash of the block |
Parameter #2—filtertype
Name |
Type |
Presence |
Description |
---|---|---|---|
Filter type |
string |
Optional |
The type name of the filter (default: basic). |
Result—A JSON object with the encoded filter data
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object |
Required |
The hex-encoded filter data. |
→ |
string (hex) |
Required |
The hex-encoded filter data |
→ |
string (hex) |
Required |
The hex-encoded filter header |
Example from Dash Core 18.0.0
dash-cli -testnet getblockfilter 0000004bb972bddf8d5b2bce517db07ff4c69a04e74e9c0bd2caa11ee23d0323 basic
Result:
{
"filter": "038c72a18c696aca7a",
"header": "f80b699589d1bfb1b269f948e9114034686c110273b01b6e4c0026ade1d6b968"
}
GetBlockHashes#
Note
Requires timestampindex
Dash Core command-line/configuration-file parameter to be enabled.
Added in Dash Core 0.12.1
The getblockhashes
RPC returns array of hashes of blocks within the timestamp range provided (requires timestampindex
to be enabled).
Parameter #1—high block timestamp
Name |
Type |
Presence |
Description |
---|---|---|---|
Block Timestamp |
number (int) |
Required |
The block timestamp for the newest block hash that should be returned. |
Parameter #2—low block timestamp
Name |
Type |
Presence |
Description |
---|---|---|---|
Block Timestamp |
number (int) |
Required |
The block timestamp for the oldest block hash that should be returned. |
Result—the block header hashes in the give time range
Name |
Type |
Presence |
Description |
---|---|---|---|
|
array |
Required |
The hashes of the blocks in the requested time range |
→ |
string (hex) |
Required |
The hash of a block in the chain, encoded as hex in RPC byte order |
Example from Dash Core 0.12.2
dash-cli -testnet getblockhashes 1507555793 1507554793
Result:
[
"0000000010a16c6fbc6bd5cdc238c2beabcda334e97fde1500d59be4e6fc4b89",
"000000009910885e811230c403e55aac6547d6df04ee671b2e8348524f73cab8",
"000000004bbb3828db1c4d4491760336cec215087819ab656336f30d4095e3d2",
"00000000ad2df2149aca2261a9a87c41e139dfe8f73d91db7ec0c1837fee21a0",
"0000000074068a9e3a271d165da3deb28bc3f8c751dde97f460d8078d92a9d06"
]
See also
GetBlock: gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.
GetBlockHash: returns the header hash of a block at the given height in the local best block chain.
GetBestBlockHash: returns the header hash of the most recent block on the best block chain.
GetBlockHeader#
Added in Bitcoin Core 0.12.0
The getblockheader
RPC gets a block header with a particular header hash from the local block database either as a JSON object or as a serialized block header.
Parameter #1—header hash
Name |
Type |
Presence |
Description |
---|---|---|---|
Header Hash |
string (hex) |
Required |
The hash of the block header to get, encoded as hex in RPC byte order |
Parameter #2—JSON or hex output
Name |
Type |
Presence |
Description |
---|---|---|---|
Format |
bool |
Optional |
Set to |
Result (if format was false
)—a serialized block header
Name |
Type |
Presence |
Description |
---|---|---|---|
|
string (hex)/null |
Required |
The requested block header as a serialized block, encoded as hex, or JSON |
Result (if format was true
or omitted)—a JSON block header
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object/null |
Required |
An object containing the requested block, or JSON |
→ |
string (hex) |
Required |
The hash of this block’s block header encoded as hex in RPC byte order. This is the same as the hash provided in parameter #1 |
→ |
number (int) |
Required |
The number of confirmations the transactions in this block have, starting at 1 when this block is at the tip of the best block chain. This score will be -1 if the the block is not part of the best block chain |
→ |
number (int) |
Required |
The height of this block on its block chain |
→ |
number (int) |
Required |
This block’s version number. See block version numbers |
→ |
string (hex) |
Required |
The merkle root for this block, encoded as hex in RPC byte order |
→ |
number (int) |
Required |
The time of the block |
→ |
number (int) |
Required |
The computed median time of the previous 11 blocks. Used for validating transaction locktime under BIP113 |
→ |
number (int) |
Required |
The nonce which was successful at turning this particular block into one that could be added to the best block chain |
→ |
string (hex) |
Required |
The value of the nBits field in the block header, indicating the target threshold this block’s header had to pass |
→ |
number (real) |
Required |
The estimated amount of work done to find this block relative to the estimated amount of work done to find block 0 |
→ |
string (hex) |
Required |
The estimated number of block header hashes miners had to check from the genesis block to this block, encoded as big-endian hex |
→ |
number (int) |
Required |
Added in Dash Core 0.16.0 |
→ |
string (hex) |
Optional |
The hash of the header of the previous block, encoded as hex in RPC byte order. Not returned for genesis block |
→ |
string (hex) |
Optional |
The hash of the next block on the best block chain, if known, encoded as hex in RPC byte order |
Changes from Bitcoin - Following items not present in Dash result
Name |
Type |
Presence |
Description |
---|---|---|---|
→ |
number (hex) |
Required |
This block’s hex version number. See block version numbers |
Example from Dash Core 0.16.0
Get a block header in raw hex:
dash-cli -testnet getblockheader \
00000000007b0fb99e36713cf08012482478ee496e6dcb4007ad2e806306e62b \
false
Result (wrapped):
00000020272e374a06c87a0ce0e6ee1a0754c98b9ec2493e7c0ac7ba41a0\
730000000000568b3c4156090db4d8db5447762e95dd1d4c921c96801a9\
086720ded85266325916cc05caa94001c5caf3595
Get the same block in JSON:
dash-cli -testnet getblockheader \
00000000007b0fb99e36713cf08012482478ee496e6dcb4007ad2e806306e62b
Result:
{
"hash": "00000000007b0fb99e36713cf08012482478ee496e6dcb4007ad2e806306e62b",
"confirmations": 212900,
"height": 86190,
"version": 536870912,
"versionHex": "20000000",
"merkleroot": "25632685ed0d7286901a80961c924c1ddd952e764754dbd8b40d0956413c8b56",
"time": 1556114577,
"mediantime": 1556113720,
"nonce": 2503323484,
"bits": "1c0094aa",
"difficulty": 440.8261075201009,
"chainwork": "0000000000000000000000000000000000000000000000000045ab6f9403a8e7",
"nTx": 1,
"previousblockhash": "000000000073a041bac70a7c3e49c29e8bc954071aeee6e00c7ac8064a372e27",
"nextblockhash": "00000000001c6c962639a1aad4cd069f315560a824d489418dc1f26b50a58aed",
"chainlock": true
}
See also
GetBlock: gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.
GetBlockHash: returns the header hash of a block at the given height in the local best block chain.
GetBlockHashes: returns array of hashes of blocks within the timestamp range provided (requires
timestampindex
to be enabled).GetBlockHeaders: returns an array of items with information about the requested number of blockheaders starting from the requested hash.
GetBestBlockHash: returns the header hash of the most recent block on the best block chain.
GetBlockHeaders#
Added in Dash Core 0.12.1
The getblockheaders
RPC returns an array of items with information about the requested number of blockheaders starting from the requested hash.
Parameter #1—header hash
Name |
Type |
Presence |
Description |
---|---|---|---|
Header Hash |
string (hex) |
Required |
The hash of the block header to get, encoded as hex in RPC byte order |
Parameter #2—number of headers to return
Name |
Type |
Presence |
Description |
---|---|---|---|
Count |
number |
Optional |
The number of block headers to get |
Parameter #3—JSON or hex output
Name |
Type |
Presence |
Description |
---|---|---|---|
Verbose |
bool |
Optional |
Set to |
Result (if format was false
)—a serialized block header
Name |
Type |
Presence |
Description |
---|---|---|---|
|
array |
Required |
The requested block header(s) as a serialized block |
→ |
string (hex) |
Required |
The block header encoded as hex in RPC byte order |
Result (if format was true
or omitted)—a JSON block header
Name |
Type |
Presence |
Description |
---|---|---|---|
|
array |
Required |
An array of objects each containing a block header, or JSON |
→ |
object/null |
Required |
An object containing a block header |
→ → |
string (hex) |
Required |
The hash of this block’s block header encoded as hex in RPC byte order. This is the same as the hash provided in parameter #1 |
→ → |
number (int) |
Required |
The number of confirmations the transactions in this block have, starting at 1 when this block is at the tip of the best block chain. This score will be -1 if the the block is not part of the best block chain |
→ → |
number (int) |
Required |
The height of this block on its block chain |
→ → |
number (int) |
Required |
This block’s version number. See block version numbers |
→ → |
string (hex) |
Required |
The merkle root for this block, encoded as hex in RPC byte order |
→ → |
number (int) |
Required |
The time of the block |
→ → |
number (int) |
Required |
The computed median time of the previous 11 blocks. Used for validating transaction locktime under BIP113 |
→ → |
number (int) |
Required |
The nonce which was successful at turning this particular block into one that could be added to the best block chain |
→ → |
string (hex) |
Required |
The value of the nBits field in the block header, indicating the target threshold this block’s header had to pass |
→ → |
number (real) |
Required |
The estimated amount of work done to find this block relative to the estimated amount of work done to find block 0 |
→ |
string (hex) |
Required |
The estimated number of block header hashes miners had to check from the genesis block to this block, encoded as big-endian hex |
→ |
number (int) |
Required |
Added in Dash Core 0.16.0 |
→ → |
string (hex) |
Optional |
The hash of the header of the previous block, encoded as hex in RPC byte order. Not returned for genesis block |
→ → |
string (hex) |
Optional |
The hash of the next block on the best block chain, if known, encoded as hex in RPC byte order |
Example from Dash Core 0.16.0
Get two block headers in raw hex:
dash-cli -testnet getblockheaders \
00000000007b0fb99e36713cf08012482478ee496e6dcb4007ad2e806306e62b \
2 false
Result (wrapped):
[
"00000020272e374a06c87a0ce0e6ee1a0754c98b9ec2493e7c0ac7ba41a0730000000\
000568b3c4156090db4d8db5447762e95dd1d4c921c96801a9086720ded8526632591\
6cc05caa94001c5caf3595",
"000000202be60663802ead0740cb6d6e49ee7824481280f03c71369eb90f7b00000000\
006abd277facc8cf02886d88662dbcc2adb6d8de7a491915e74bed4d835656a4f1f26d\
c05ced93001ccf81cabc"
]
Get the same two block headers in JSON:
dash-cli -testnet getblockheader \
00000000eb0af5aec7b673975a22593dc0cc763f71ba8de26292410273437078 \
2 true
Result:
[
{
"hash": "00000000007b0fb99e36713cf08012482478ee496e6dcb4007ad2e806306e62b",
"confirmations": 212910,
"height": 86190,
"version": 536870912,
"versionHex": "20000000",
"merkleroot": "25632685ed0d7286901a80961c924c1ddd952e764754dbd8b40d0956413c8b56",
"time": 1556114577,
"mediantime": 1556113720,
"nonce": 2503323484,
"bits": "1c0094aa",
"difficulty": 440.8261075201009,
"chainwork": "0000000000000000000000000000000000000000000000000045ab6f9403a8e7",
"nTx": 1,
"previousblockhash": "000000000073a041bac70a7c3e49c29e8bc954071aeee6e00c7ac8064a372e27",
"nextblockhash": "00000000001c6c962639a1aad4cd069f315560a824d489418dc1f26b50a58aed",
"chainlock": true
},
{
"hash": "00000000001c6c962639a1aad4cd069f315560a824d489418dc1f26b50a58aed",
"confirmations": 212909,
"height": 86191,
"version": 536870912,
"versionHex": "20000000",
"merkleroot": "f1a45656834ded4be71519497aded8b6adc2bc2d66886d8802cfc8ac7f27bd6a",
"time": 1556114930,
"mediantime": 1556113903,
"nonce": 3167388111,
"bits": "1c0093ed",
"difficulty": 443.0262219757585,
"chainwork": "0000000000000000000000000000000000000000000000000045ad2a9c752d18",
"nTx": 1,
"previousblockhash": "00000000007b0fb99e36713cf08012482478ee496e6dcb4007ad2e806306e62b",
"nextblockhash": "000000000076a17beb1bb56e6ec53579f8a604d2363c9a4f8ca3f63e6aca3423",
"chainlock": true
}
]
See also
GetBlock: gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.
GetBlockHash: returns the header hash of a block at the given height in the local best block chain.
GetBlockHashes: returns array of hashes of blocks within the timestamp range provided (requires
timestampindex
to be enabled).GetBlockHeader: gets a block header with a particular header hash from the local block database either as a JSON object or as a serialized block header.
GetBestBlockHash: returns the header hash of the most recent block on the best block chain.
GetBlockStats#
The getblockstats
RPC computes per block statistics for a given window.
This RPC won’t work for some heights if pruning is enabled. Since Dash Core 18.1, -txindex
is no longer required and it works for all non-pruned blocks.
Parameter #1—hash_or_height
Name |
Type |
Presence |
Description |
---|---|---|---|
hash_or_height |
string or numeric |
Required |
The block hash or height of the target block |
Parameter #2—stats
Name |
Type |
Presence |
Description |
---|---|---|---|
stats |
array |
optional |
Values to plot, by default all values (see result below) |
Result—a JSON object containing the requested statistics
Note
All amounts are in duffs.
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object/null |
Required |
An object containing stats for the requested block, or JSON |
→ |
numeric |
Required |
Average fee in the block |
→ |
numeric |
Required |
Average feerate (in duffs per byte) |
→ |
numeric |
Required |
Average transaction size |
→ |
string (hex) |
Required |
The block hash (to check for potential reorgs) |
→ |
array (num) |
Required |
Added in Dash Core 18.0.0 |
→ → |
numeric |
Required |
The 10th percentile feerate |
→ → |
numeric |
Required |
The 25th percentile feerate |
→ → |
numeric |
Required |
The 50th percentile feerate |
→ → |
numeric |
Required |
The 75th percentile feerate |
→ → |
numeric |
Required |
The 90th percentile feerate |
→ |
numeric |
Required |
The height of the block |
→ |
numeric |
Required |
The number of inputs (excluding coinbase) |
→ |
numeric |
Required |
Maximum fee in the block |
→ |
numeric |
Required |
Maximum feerate (in duffs per byte) |
→ |
numeric |
Required |
Maximum transaction size |
→ |
numeric |
Required |
Truncated median fee in the block |
→ |
~~numeric~~ |
~~Required (exactly 1)~~ |
Removed in Dash Core 18.0.0 |
→ |
numeric |
Required |
The block median time past |
→ |
numeric |
Required |
Truncated median transaction size |
→ |
numeric |
Required |
Minimum fee in the block |
→ |
numeric |
Required |
Minimum feerate (in duffs per byte) |
→ |
numeric |
Required |
Minimum transaction size |
→ |
numeric |
Required |
The number of outputs |
→ |
numeric |
Required |
The block subsidy |
→ |
number (real) |
Required |
The block time |
→ |
numeric |
Required |
Total amount in all outputs (excluding coinbase and thus reward [i.e. subsidy + totalfee]) |
→ |
numeric |
Required |
Total size of all non-coinbase transactions |
→ |
numeric |
Required |
The fee total |
→ |
numeric |
Required |
The number of transactions (including coinbase) |
→ |
numeric |
Required |
The increase/decrease in the number of unspent outputs |
→ |
numeric |
Required |
The increase/decrease in size for the utxo index (not discounting op_return and similar) |
Example from Dash Core 18.0.0
dash-cli getblockstats 1000 '["minfeerate","avgfeerate"]'
Result:
{
"avgfeerate": 0,
"minfeerate": 0
}
See also: none
GetChainTips#
The getchaintips
RPC returns information about the highest-height block (tip) of each local block chain.
Parameters: none
Result—an array of block chain tips
Name |
Type |
Presence |
Description |
---|---|---|---|
|
array |
Required |
An array of JSON objects, with each object describing a chain tip. At least one tip—the local best block chain—will always be present |
→ |
object |
Required |
An object describing a particular chain tip. The first object will always describe the active chain (the local best block chain) |
→ → |
number (int) |
Required |
The height of the highest block in the chain. A new node with only the genesis block will have a single tip with height of 0 |
→ → |
string (hex) |
Required |
The hash of the highest block in the chain, encoded as hex in RPC byte order |
→ |
number (real) |
Required |
The difficulty of the highest-height block in the best block chain (Added in Dash Core 0.12.1) |
→ |
string (hex) |
Required |
The estimated number of block header hashes checked from the genesis block to this block, encoded as big-endian hex (Added in Dash Core 0.12.1) |
→ → |
number (int) |
Required |
The number of blocks that are on this chain but not on the main chain. For the local best block chain, this will be |
→ → |
string (hex) |
Required |
Added in Dash Core 0.12.3 |
→ → |
string |
Required |
The status of this chain. Valid values are: |
Example from Dash Core 0.12.3
dash-cli -testnet getchaintips
[
{
"height": 110192,
"hash": "000000000c6007f40c3b68a77b0e1319a89c0504ae1b391d071cf49fa7591dee",
"difficulty": 18.38631407059958,
"chainwork": "000000000000000000000000000000000000000000000000002cbd2546718747",
"branchlen": 0,
"forkpoint": "000000000c6007f40c3b68a77b0e1319a89c0504ae1b391d071cf49fa7591dee",
"status": "active"
}
]
See also
GetBestBlockHash: returns the header hash of the most recent block on the best block chain.
GetBlock: gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block.
GetBlockChainInfo: provides information about the current state of the block chain.
GetChainTxStats#
The getchaintxstats
RPC compute statistics about the total number and rate of transactions in the chain.
Parameter #1—nblocks
Name |
Type |
Presence |
Description |
---|---|---|---|
nblocks |
number (int) |
Optional |
Size of the window in number of blocks (default: one month). |
Parameter #2—blockhash
Name |
Type |
Presence |
Description |
---|---|---|---|
blockhash |
string |
Optional |
The hash of the block that ends the window. |
Result–statistics about transactions
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object |
Required |
Object containing transaction statistics |
→ |
number (int) |
Required |
The timestamp for the statistics in UNIX format |
→ |
number (int) |
Required |
The total number of transactions in the chain up to that point |
→ |
string (hex) |
Required |
Added in Dash Core 0.17.0 |
→ |
number (int) |
Required |
Added in Dash Core 0.16.0 |
→ |
number (int) |
Required |
Added in Dash Core 18.0.0 |
→ |
number (int) |
Optional |
Added in Dash Core 0.16.0 |
→ |
number (int) |
Optional |
Added in Dash Core 0.16.0 |
→ |
number (int) |
Optional |
The average rate of transactions per second in the window. Only returned if |
Example from Dash Core 18.0.0
dash-cli -testnet getchaintxstats
Result:
{
"time": 1634200935,
"txcount": 5255650,
"window_final_block_hash": "0000013524141f0e54137d266088c3d042cca340eabc4393414d7d0560866239",
"window_final_block_height": 593815,
"window_block_count": 17280,
"window_tx_count": 33384,
"window_interval": 2417430,
"txrate": 0.0138097070028915
}
See also: none
GetDifficulty#
The getdifficulty
RPC returns the proof-of-work difficulty as a multiple of the minimum difficulty.
Parameters: none
Result—the current difficulty
Name |
Type |
Presence |
Description |
---|---|---|---|
|
number (real) |
Required |
The difficulty of creating a block with the same target threshold (nBits) as the highest-height block in the local best block chain. The number is a a multiple of the minimum difficulty |
Example from Dash Core 0.12.2
dash-cli -testnet getdifficulty
Result:
1.069156225528583
See also
GetNetworkHashPS: returns the estimated network hashes per second based on the last n blocks.
GetMiningInfo: returns various mining-related information.
GetMemPoolAncestors#
Added in Dash Core 0.12.3
The getmempoolancestors
RPC returns all in-mempool ancestors for a transaction in the mempool.
Parameter #1—a transaction identifier (TXID)
Name |
Type |
Presence |
Description |
---|---|---|---|
TXID |
string (hex) |
Required |
The TXID of a transaction in the memory pool, encoded as hex in RPC byte order |
Parameter #2—desired output format
Name |
Type |
Presence |
Description |
---|---|---|---|
Format |
bool |
Optional |
Set to |
Result—list of ancestor transactions
Name |
Type |
Presence |
Description |
---|---|---|---|
|
array |
Required |
An array of TXIDs belonging to transactions in the memory pool. The array may be empty if there are no transactions in the memory pool |
→ |
string |
Optional |
The TXID of a transaction in the memory pool, encoded as hex in RPC byte order |
Result (format: true
)—a JSON object describing each transaction
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object |
Required |
A object containing transactions currently in the memory pool. May be empty |
→ |
string : object |
Optional |
The TXID of a transaction in the memory pool, encoded as hex in RPC byte order |
→ → |
number (int) |
Required |
The size of the serialized transaction in bytes |
→ → |
number (bitcoins) |
Required |
Deprecated in Dash Core 0.17.0 |
→ → |
number (bitcoins) |
Required |
Deprecated in Dash Core 0.17.0 |
→ → |
number (int) |
Required |
The time the transaction entered the memory pool, Unix epoch time format |
→ → |
number (int) |
Required |
The block height when the transaction entered the memory pool |
→ → |
number (int) |
Required |
The number of in-mempool descendant transactions (including this one) |
→ → |
number (int) |
Required |
The size of in-mempool descendants (including this one) |
→ → |
number (int) |
Required |
Deprecated in Dash Core 0.17.0 |
→ → |
number (int) |
Required |
The number of in-mempool ancestor transactions (including this one) |
→ → |
number (int) |
Required |
The size of in-mempool ancestors (including this one) |
→ → |
number (int) |
Required |
Deprecated in Dash Core 0.17.0 |
→ → |
object |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→ → |
array |
Required |
An array holding TXIDs of unconfirmed transactions this transaction depends upon (parent transactions). Those transactions must be part of a block before this transaction can be added to a block, although all transactions may be included in the same block. The array may be empty |
→ → → |
string |
Optional (0 or more) |
The TXIDs of any unconfirmed transactions this transaction depends upon, encoded as hex in RPC byte order |
→ → |
array |
Required |
Added in Dash Core 20.0.0 |
→ → → |
string |
Optional (0 or more) |
The TXIDs of any unconfirmed transactions spending from this transaction |
→ → |
bool |
Required |
Added in Dash Core 20.0.0 |
→ → |
bool |
Required |
Set to |
Examples from Dash Core 20.0.0
The default (false
):
dash-cli getmempoolancestors c32b5d5d94a6d151b69bfd25d77e5b538dffba2445b957c81fcf9df1b90f4ba1
Result:
[
"d64eb30e5435e7a4564df9d06525a8ab48858fdaf111661d1e7874a72cebc132"
]
Verbose output (true
):
dash-cli getmempoolancestors c32b5d5d94a6d151b69bfd25d77e5b538dffba2445b957c81fcf9df1b90f4ba1 true
Result:
{
"177826190c3fd38a93a381a9b5ad7d955c3f2cf886f7c6f0d58647fb868cf9f5": {
"fees": {
"base": 0.00000226,
"modified": 0.00000226,
"ancestor": 0.00000226,
"descendant": 0.00003226
},
"vsize": 226,
"fee": 0.00000226,
"modifiedfee": 0.00000226,
"time": 1690318336,
"height": 1909978,
"descendantcount": 6,
"descendantsize": 1648,
"descendantfees": 3226,
"ancestorcount": 1,
"ancestorsize": 226,
"ancestorfees": 226,
"depends": [
],
"spentby": [
"127cfa4cd892ad78b9c1227bebfef2bb5a8a06636b659a734c0a5787004934ca"
],
"instantlock": "true",
"unbroadcast": false
}
}
See also
GetMemPoolDescendants: returns all in-mempool descendants for a transaction in the mempool.
GetRawMemPool: returns all transaction identifiers (TXIDs) in the memory pool as a JSON array, or detailed information about each transaction in the memory pool as a JSON object.
GetMemPoolDescendants#
Added in Dash Core 0.12.3
The getmempooldescendants
RPC returns all in-mempool descendants for a transaction in the mempool.
Parameter #1—a transaction identifier (TXID)
Name |
Type |
Presence |
Description |
---|---|---|---|
TXID |
string (hex) |
Required |
The TXID of a transaction in the memory pool, encoded as hex in RPC byte order |
Parameter #2—desired output format
Name |
Type |
Presence |
Description |
---|---|---|---|
Format |
bool |
Optional |
Set to |
Result—list of descendant transactions
Name |
Type |
Presence |
Description |
---|---|---|---|
|
array |
Required |
An array of TXIDs belonging to transactions in the memory pool. The array may be empty if there are no transactions in the memory pool |
→ |
string |
Optional |
The TXID of a transaction in the memory pool, encoded as hex in RPC byte order |
Result (format: true
)—a JSON object describing each transaction
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object |
Required |
A object containing transactions currently in the memory pool. May be empty |
→ |
string : object |
Optional |
The TXID of a transaction in the memory pool, encoded as hex in RPC byte order |
→ → |
number (int) |
Required |
The size of the serialized transaction in bytes |
→ → |
number (bitcoins) |
Required |
Deprecated in Dash Core 0.17.0 |
→ → |
number (bitcoins) |
Required |
Deprecated in Dash Core 0.17.0 |
→ → |
number (int) |
Required |
The time the transaction entered the memory pool, Unix epoch time format |
→ → |
number (int) |
Required |
The block height when the transaction entered the memory pool |
→ → |
number (int) |
Required |
The number of in-mempool descendant transactions (including this one) |
→ → |
number (int) |
Required |
The size of in-mempool descendants (including this one) |
→ → |
number (int) |
Required |
Deprecated in Dash Core 0.17.0 |
→ → |
number (int) |
Required |
The number of in-mempool ancestor transactions (including this one) |
→ → |
number (int) |
Required |
The size of in-mempool ancestors (including this one) |
→ → |
number (int) |
Required |
Deprecated in Dash Core 0.17.0 |
→ → |
object |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→ → |
array |
Required |
An array holding TXIDs of unconfirmed transactions this transaction depends upon (parent transactions). Those transactions must be part of a block before this transaction can be added to a block, although all transactions may be included in the same block. The array may be empty |
→ → → |
string |
Optional (0 or more) |
The TXIDs of any unconfirmed transactions this transaction depends upon, encoded as hex in RPC byte order |
→ → |
array |
Required |
Added in Dash Core 20.0.0 |
→ → → |
string |
Optional (0 or more) |
The TXIDs of any unconfirmed transactions spending from this transaction |
→ → |
bool |
Required |
Added in Dash Core 20.0.0 |
→ → |
bool |
Required |
Set to |
Examples from Dash Core 20.0.0
The default (false
):
dash-cli getmempooldescendants 414735b9b4da8232299b25510628e321ba7d2adfb042f7c6437ad3b0f7793b80
Result:
[
"94445715afd59a7ecc2fd6d62e42905194e91633e8f54b459f605fe0d780fe99"
]
Verbose output (true
):
dash-cli getmempooldescendants 414735b9b4da8232299b25510628e321ba7d2adfb042f7c6437ad3b0f7793b80 true
Result:
{
"94445715afd59a7ecc2fd6d62e42905194e91633e8f54b459f605fe0d780fe99": {
"fees": {
"base": 0.00000225,
"modified": 0.00000225,
"ancestor": 0.00000450,
"descendant": 0.00000225
},
"vsize": 225,
"fee": 0.00000225,
"modifiedfee": 0.00000225,
"time": 1690906537,
"height": 879144,
"descendantcount": 1,
"descendantsize": 225,
"descendantfees": 225,
"ancestorcount": 2,
"ancestorsize": 450,
"ancestorfees": 450,
"depends": [
"414735b9b4da8232299b25510628e321ba7d2adfb042f7c6437ad3b0f7793b80"
],
"spentby": [
],
"instantlock": "true",
"unbroadcast": false
}
}
See also
GetMemPoolAncestors: returns all in-mempool ancestors for a transaction in the mempool.
GetRawMemPool: returns all transaction identifiers (TXIDs) in the memory pool as a JSON array, or detailed information about each transaction in the memory pool as a JSON object.
GetMemPoolEntry#
Added in Dash Core 0.14.0
The getmempoolentry
RPC returns mempool data for given transaction (must be in mempool).
Parameter #1—a transaction identifier (TXID)
Name |
Type |
Presence |
Description |
---|---|---|---|
TXID |
string (hex) |
Required |
The TXID of a transaction in the memory pool, encoded as hex in RPC byte order |
Result —a JSON object describing the transaction
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object |
Required |
A object containing transactions currently in the memory pool. May be empty |
→ |
number (int) |
Required |
The virtual transaction size. This can be different from actual serialized size for high-sigop transactions. |
→ |
number (bitcoins) |
Required |
Deprecated in Dash Core 0.17.0 |
→ |
number (bitcoins) |
Required |
Deprecated in Dash Core 0.17.0 |
→ |
number (int) |
Required |
The time the transaction entered the memory pool, Unix epoch time format |
→ |
number (int) |
Required |
The block height when the transaction entered the memory pool |
→ |
number (int) |
Required |
The number of in-mempool descendant transactions (including this one) |
→ |
number (int) |
Required |
The size of in-mempool descendants (including this one) |
→ |
number (int) |
Required |
Deprecated in Dash Core 0.17.0 |
→ |
number (int) |
Required |
The number of in-mempool ancestor transactions (including this one) |
→ |
number (int) |
Required |
The size of in-mempool ancestors (including this one) |
→ |
number (int) |
Required |
Deprecated in Dash Core 0.17.0 |
→ → |
object |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→ |
array |
Required |
An array holding TXIDs of unconfirmed transactions this transaction depends upon (parent transactions). Those transactions must be part of a block before this transaction can be added to a block, although all transactions may be included in the same block. The array may be empty |
→ → |
string |
Optional (0 or more) |
The TXIDs of any unconfirmed transactions this transaction depends upon, encoded as hex in RPC byte order |
→ |
array |
Required |
Added in Dash Core 20.0.0 |
→ → |
string |
Optional (0 or more) |
The TXIDs of any unconfirmed transactions spending from this transaction |
→ |
bool |
Required |
Added in Dash Core 20.0.0 |
→ |
bool |
Required |
Set to |
Example from Dash Core 20.0.0
dash-cli getmempoolentry 33136ead40c8ad0019be7ab8d8e430c1e336fd6f7fcfe204096c0da28d9a6225
Result:
{
"fees": {
"base": 0.00009350,
"modified": 0.00009350,
"ancestor": 0.00009350,
"descendant": 0.00009350
},
"vsize": 374,
"fee": 0.00009350,
"modifiedfee": 0.00009350,
"time": 1690317662,
"height": 1909971,
"descendantcount": 1,
"descendantsize": 374,
"descendantfees": 9350,
"ancestorcount": 1,
"ancestorsize": 374,
"ancestorfees": 9350,
"depends": [
],
"spentby": [
],
"instantlock": "true",
"unbroadcast": false
}
See also
GetMemPoolAncestors: returns all in-mempool ancestors for a transaction in the mempool.
GetMemPoolDescendants: returns all in-mempool descendants for a transaction in the mempool.
GetRawMemPool: returns all transaction identifiers (TXIDs) in the memory pool as a JSON array, or detailed information about each transaction in the memory pool as a JSON object.
GetMemPoolInfo#
The getmempoolinfo
RPC returns information about the node’s current transaction memory pool.
Parameters: none
Result—information about the transaction memory pool
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object |
Required |
A object containing information about the memory pool |
→ |
boolean |
Required |
True if the mempool is fully loaded |
→ |
number (int) |
Required |
The number of transactions currently in the memory pool |
→ |
number (int) |
Required |
The total number of bytes in the transactions in the memory pool |
→ |
number (int) |
Required |
Added in Bitcoin Core 0.11.0 |
|
number (int) |
Required |
Added in Dash Core 20.1.0 |
→ |
number (int) |
Required |
Added in Bitcoin Core 0.12.0 |
→ |
number |
Required |
Added in Bitcoin Core 0.12.0 |
→ |
number |
Required |
Added in Dash Core 0.16.0 |
→ |
number (int) |
Required |
Added in Dash Core 20.0.0 |
→ |
number (int) |
Required |
Added in Dash Core 0.15.0 |
→ |
number (int) |
Required |
Added in Dash Core 20.0.0 |
Example from Dash Core 20.1.0
dash-cli -testnet getmempoolinfo
Result:
{
"loaded": true,
"size": 3,
"bytes": 1116,
"usage": 5072,
"total_fee": 0.00001116,
"maxmempool": 300000000,
"mempoolminfee": 0.00001000,
"minrelaytxfee": 0.00001000,
"instantsendlocks": 3,
"unbroadcastcount": 0
}
See also
GetBlockChainInfo: provides information about the current state of the block chain.
GetRawMemPool: returns all transaction identifiers (TXIDs) in the memory pool as a JSON array, or detailed information about each transaction in the memory pool as a JSON object.
GetTxOutSetInfo: returns statistics about the confirmed unspent transaction output (UTXO) set. Note that this call may take some time and that it only counts outputs from confirmed transactions—it does not count outputs from the memory pool.
GetRawMemPool#
The getrawmempool
RPC returns all transaction identifiers (TXIDs) in the memory pool as a JSON array, or detailed information about each transaction in the memory pool as a JSON object.
Parameter—desired output format
Name |
Type |
Presence |
Description |
---|---|---|---|
Format |
bool |
Optional |
Set to |
Result (format false
)—an array of TXIDs
Name |
Type |
Presence |
Description |
---|---|---|---|
|
array |
Required |
An array of TXIDs belonging to transactions in the memory pool. The array may be empty if there are no transactions in the memory pool |
→ |
string |
Optional |
The TXID of a transaction in the memory pool, encoded as hex in RPC byte order |
Result (format: true
)—a JSON object describing each transaction
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object |
Required |
A object containing transactions currently in the memory pool. May be empty |
→ |
string : object |
Optional |
The TXID of a transaction in the memory pool, encoded as hex in RPC byte order |
→ → |
number (int) |
Required |
The size of the serialized transaction in bytes |
→ → |
amount (Dash) |
Required |
Deprecated in Dash Core 0.17.0 |
→ → |
amount (Dash) |
Required |
Deprecated in Dash Core 0.17.0 |
→ → |
number (int) |
Required |
The time the transaction entered the memory pool, Unix epoch time format |
→ → |
number (int) |
Required |
The block height when the transaction entered the memory pool |
→ → |
number (int) |
Required |
Added in Bitcoin Core 0.12.0 |
→ → |
number (int) |
Required |
Added in Bitcoin Core 0.12.0 |
→ → |
number (int) |
Required |
Deprecated in Dash Core 0.17.0 |
→ → |
number (int) |
Required |
Added in Dash Core 0.12.3 / Bitcoin Core 0.13.0 |
→ → |
number (int) |
Required |
Added in Dash Core 0.12.3 / Bitcoin Core 0.13.0 |
→ → |
number (int) |
Required |
Deprecated in Dash Core 0.17.0 |
→ → |
object |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→→→ |
number |
Optional |
Added in Dash Core 0.17.0 |
→ → |
array |
Required |
An array holding TXIDs of unconfirmed transactions this transaction depends upon (parent transactions). Those transactions must be part of a block before this transaction can be added to a block, although all transactions may be included in the same block. The array may be empty |
→ → → |
string |
Optional (0 or more) |
The TXIDs of any unconfirmed transactions this transaction depends upon, encoded as hex in RPC byte order |
→ → |
array |
Required |
Added in Dash Core 0.17.0 |
→ → → |
string |
Optional (0 or more) |
The TXIDs of any unconfirmed transactions spending from this transaction |
→ → |
bool |
Required |
Added in Dash Core 20.0.0 |
→ → |
bool |
Required |
Added in Dash Core 0.12.3 |
Examples from Dash Core 20.0.0
The default (false
):
dash-cli getrawmempool
Result:
[
"16f9a964f1bafbf2a745c2add0da31330b2ee521c2d411416d59c25343b9fb92",
"664e9ca96802ec014469e0d2c34cc7c7e49c4a5a72613614ee97ebd193104376",
"bbbfff097dff060a44622d6569c6f11d13ec29d3c204318ec2c2b8bf5b888487",
"9e6cd0b8feb804b796a6a74e12c45d93c1ea39d3fd205b463e26c70f7f2063e9",
"d541e8776b42ab9dc9a722bf38f99f0b38be0325193ebaf1576119e3dbc00a49",
"4d1d77c26cf1184ff26d27cbbc78f95eada99965920c6bceeb508194bb7217e2",
"e1eafdf61c1062a8e82fd6c42baa0a95f24b8f75fb81db94c4b9e41afc0405d2",
"f4696ff8a75a0235fe7c9062a895a6e364fd7b3941b41a66efa513176bf3cb21",
"8614e7a3f4208f69823f09e02c66a22813cac8de7bc05828c3847e39c6d8e323",
"b8c9eea215addedd8f162e6c4881dd74a14dbd05c820d5149e29990ee5b869dd",
"0a8ccaf37b2652b6ac400922be8cd4ea91267d19ec8e11e20f848d8e62bdef77",
"bc0b7a1d1ee9976652949ef014637d107e8154d00484c62fc3a69cc004367244",
"5446f81969179087b5b490d20b156d13a9d63d7a6d9f618ccda903722b0dab34",
"50caf79821d946b46db0bb64d0e9d354680ce2b94257d5c7a28a1f65fefde226",
"76e018d092d1cd8c4e2074ef6225e38f1d7cc5264980b0d1b5e484f944affa06",
"b86f0408ae8c3126da6458df0c64b1bf19c2f512b40e5811b3130c9fecbc316d",
"52d8e1ea95fcb1b9156ec7ff2ab82ae3e3040cf8328f86b4d96974990527cd90",
"43619b452edc8647cbfe740b55a0c8f9716f6bd6bb258b3c7cb6e0be204a57d3",
"a77d001facacf7d00b2721d246b6790c12018e6e89d6cd543478a84e63bb498a",
"e4a409ee2fbb94925bdea0fa5a3040550fa85063c6343fba3c7b88122fba365f"
]
Verbose output (true
):
dash-cli getrawmempool true
Result:
"0994e854166beb6f15630e7b5aba0ef0e57b2a7235957bcbb8000c09449e9eba": {
"fees": {
"base": 0.00000225,
"modified": 0.00000225,
"ancestor": 0.00000225,
"descendant": 0.00000225
},
"vsize": 225,
"fee": 0.00000225,
"modifiedfee": 0.00000225,
"time": 1690318205,
"height": 1909975,
"descendantcount": 1,
"descendantsize": 225,
"descendantfees": 225,
"ancestorcount": 1,
"ancestorsize": 225,
"ancestorfees": 225,
"depends": [
],
"spentby": [
],
"instantlock": "false",
"unbroadcast": false
}
See also
GetMemPoolInfo: returns information about the node’s current transaction memory pool.
GetMemPoolEntry: returns mempool data for given transaction (must be in mempool).
GetTxOutSetInfo: returns statistics about the confirmed unspent transaction output (UTXO) set. Note that this call may take some time and that it only counts outputs from confirmed transactions—it does not count outputs from the memory pool.
GetMerkleBlocks#
Added in Dash Core 0.15.0
The getmerkleblocks
RPC returns an array of hex-encoded merkleblocks for
Parameter #1—filter
Name |
Type |
Presence |
Description |
---|---|---|---|
filter |
string |
Required |
The hex encoded bloom filter |
Parameter #2—hash
Name |
Type |
Presence |
Description |
---|---|---|---|
hash |
string |
Required |
The block hash |
Parameter #3—count
Name |
Type |
Presence |
Description |
---|---|---|---|
count |
number (int) |
Optional |
Result—the list of merkleblocks
Name |
Type |
Presence |
Description |
---|---|---|---|
|
array |
Required |
An array of merkleblocks |
→ |
string (hex) |
Optional |
A serialized, hex-encoded merkleblock |
Example from Dash Core 0.15.0
dash-cli getmerkleblocks \
"2303028005802040100040000008008400048141010000f8400420800080025004000004130000000000000001" \
"00000000007e1432d2af52e8463278bf556b55cf5049262f25634557e2e91202"
2000
Result (truncated):
[
"000000202c...aefc440107",
"0000002058...9a17830103"
]
See also: none
GetSpecialTxes#
Added in Dash Core 0.13.1
The getspecialtxes
RPC returns an array of special transactions found in the specified block
Parameter #1—Block hash
Name |
Type |
Presence |
Description |
---|---|---|---|
|
string |
Required |
The block hash. |
Parameter #2—Special transaction type
Name |
Type |
Presence |
Description |
---|---|---|---|
type |
int |
Optional |
Filter special txes by type, -1 means all types (default: -1) |
Parameter #3—Result limit
Name |
Type |
Presence |
Description |
---|---|---|---|
count |
int |
Optional |
The number of transactions to return (default: 10) |
Parameter #4—Results to skip
Name |
Type |
Presence |
Description |
---|---|---|---|
skip |
int |
Optional |
The number of transactions to skip (default: 0) |
Parameter #5—Verbosity
Name |
Type |
Presence |
Description |
---|---|---|---|
verbosity |
int |
Optional |
0 for hashes, 1 for hex-encoded data, and 2 for JSON object |
Result (if verbosity
was 0
)—An array of transaction IDs
Name |
Type |
Presence |
Description |
---|---|---|---|
|
string (hex): array |
Required |
Array of special transaction hashes |
Result (if verbosity
was 1
)—An array of serialized transactions
Name |
Type |
Presence |
Description |
---|---|---|---|
|
string (hex): array |
Required |
Array of serialized, hex-encoded data for the special transaction(s) |
Result (if verbosity
was 2
)—An array of JSON objects
Name |
Type |
Presence |
Description |
---|---|---|---|
|
string (hex): array of ojbects |
Required |
Array of special transaction objects in the format of the |
Example from Dash Core 0.13.1
List of Special Transactions hashes.
dash-cli -testnet getspecialtxes \
0000003db0006ecaccdf5ae2cfa9d94406ef40ff65b9ec34668b87fca3da9226
Result:
[
"1572a15f56307e413afe3cb7ea0017a1a3fd6d89c6c5f258cc17b2888a8e7fff",
"89a6dc42063e4a792ec225db64dd9426742a5d1738e8821625d2ab920a6187b2",
"fa3b3b0d3522becb02ddd15dd075f3d6ecc6a5a50b43c6c9f6d4703a9a8509d5"
]
List of Provider Registration Special Transactions (type: 1) in serialized, hex-encoded format.
dash-cli -testnet getspecialtxes \
0000003db0006ecaccdf5ae2cfa9d94406ef40ff65b9ec34668b87fca3da9226 1 10 0 1
Result:
[
"0300010001ea721d7420a9b58025894d08f9fecc73b7b87ed09277fa99dad5aa028ea357e1000000006b48304502210093c409672eed335f80630d7108c108d0b85ebe4d8be0758f8a3745f617c4b57302203175063605552c89f6de7f3dadc1773d5ef773b7cc0ccf98e6c5555ea75ba307012102b21d19fec95d9863c5b12fafeb60530e1cfc51d83f49ea9bca7192abb8b83e46feffffff01c4bb609a010000001976a9142efe9f9d3b36b133364d3cccbd27db75a0fbdcb788ac00000000fd120101000000000031567fbaf591ae9d2d0e9050bebce6a311cfd900616f851a3a630aa65e53f6940000000000000000000000000000ffffad3d1ee74a43c1ad3af209f75deaeb9216fc8339fd48d376f9b007ffa44583c9908f4aaca8dd97990c56043e475723f90940ef5fd7d493152540f25f58fb8c965ee5e1be4f850a661476c1ad3af209f75deaeb9216fc8339fd48d376f9b0e8031976a91454bbd7bd7c21553612d60ab16579e51efbcb135288acc281e8bf5a0dd22dfc9f1edeef9ef248f965a79210d997da37fb3e1dec76d1a4412096809bc005c860a0215cb008e3044b972688443b0b7a31ac5a04b728e63b1b5c5489e33dd666435f93c646523ad8a1d935a58957026749cbd0a9bf7e09a77388",
"03000100012354b77c0f261f3d5b8424cbe67c2f27130f01c531732a08b8ae3f28aaa1b1fb000000006a473044022058323d3d9114492a7a7d350d5e3127d2dc550563968319987079c98f19ed519202204160cfe81adf1f41301136a3cbe03697baa1b14c3103b66bd839ace503dbf2630121026f83a8dad6b4695b136c399405b31d4031fd6631c469673d71eda479157ef9dcfeffffff0106b8609a010000001976a9142a855dc127bfdd5cc0ab73b71ff126e49aa409c488ac00000000fd1201010000000000b60dcb8bab5aba47435942c36ca4ee74ea5b662f4d7c7b528ce341915b2d5aec0100000000000000000000000000ffffad3d1ee74a428d3433cb6b9a1a29fdf07613172bbfdab744889689e308c9d2d8a3cb35f9d7bb7220b1eca82c952b82111119670dacae18a509628c775287e4e796128cd6379b80dffd7d8d3433cb6b9a1a29fdf07613172bbfdab744889610271976a91454bbd7bd7c21553612d60ab16579e51efbcb135288ac512010a2b992d7d5c1e1f999852855cc55162800025cfdf3b56c74e4734a2d97411f858532607cbd8848452dab1f216650def1d11a5abf3fa464c9ffcc7fec894a012a4b70ee5d3b983b5fe640f04a7f3e4fe67fbb5b7cccb71afa37888ad6cca48e"
]
List of Coinbase Special Transactions (type: 5) in JSON format.
dash-cli -testnet getspecialtxes \
00000000007b0fb99e36713cf08012482478ee496e6dcb4007ad2e806306e62b 5 10 0 2
Result:
[
{
"txid": "25632685ed0d7286901a80961c924c1ddd952e764754dbd8b40d0956413c8b56",
"size": 229,
"version": 3,
"type": 5,
"locktime": 0,
"vin": [
{
"coinbase": "03ae50011a4d696e656420627920416e74506f6f6c2021000b01201da9196f0000000007000000",
"sequence": 4294967295
}
],
"vout": [
{
"value": 8.10000000,
"valueSat": 810000000,
"n": 0,
"scriptPubKey": {
"asm": "OP_DUP OP_HASH160 cbd7bfcc50351180132b2c0698cb90ad74c473c7 OP_EQUALVERIFY OP_CHECKSIG",
"hex": "76a914cbd7bfcc50351180132b2c0698cb90ad74c473c788ac",
"reqSigs": 1,
"type": "pubkeyhash",
"addresses": [
"yeuGUfPMrbEqAS2Pw1wonYgEPbM4LAA9LK"
]
}
},
{
"value": 8.10000000,
"valueSat": 810000000,
"n": 1,
"scriptPubKey": {
"asm": "OP_DUP OP_HASH160 88a060bc2dfe05780ae4dcb6c98b12436c35a939 OP_EQUALVERIFY OP_CHECKSIG",
"hex": "76a91488a060bc2dfe05780ae4dcb6c98b12436c35a93988ac",
"reqSigs": 1,
"type": "pubkeyhash",
"addresses": [
"yYmrsYP3XYMZr1cGtha3QzmuNB1C7CfyhV"
]
}
}
],
"extraPayloadSize": 70,
"extraPayload": "0200ae50010078e5c08b39960887bf95185c381bdb719e60b6925fa12af78a8824fade927387c757acb6bac63da84f9245e20cfd5d830382ac634d434725ca6349ab5db920a3",
"cbTx": {
"version": 2,
"height": 86190,
"merkleRootMNList": "877392defa24888af72aa15f92b6609e71db1b385c1895bf870896398bc0e578",
"merkleRootQuorums": "a320b95dab4963ca2547434d63ac8203835dfd0ce245924fa83dc6bab6ac57c7"
},
"instantlock": false,
"chainlock": false
}
]
See also:
GetRawTransaction: gets a hex-encoded serialized transaction or a JSON object describing the transaction. By default, Dash Core only stores complete transaction data for UTXOs and your own transactions, so the RPC may fail on historic transactions unless you use the non-default
txindex=1
in your Dash Core startup settings.
GetSpentInfo#
Note
Requires spentindex
Dash Core command-line/configuration-file parameter to be enabled.
Added in Dash Core 0.12.1
The getspentinfo
RPC returns the txid and index where an output is spent (requires spentindex
to be enabled).
Parameter #1—the TXID of the output
Name |
Type |
Presence |
Description |
---|---|---|---|
TXID |
string (hex) |
Required |
The TXID of the transaction containing the relevant output, encoded as hex in RPC byte order |
Parameter #2—the start block height
Name |
Type |
Presence |
Description |
---|---|---|---|
Index |
number (int) |
Required |
The block height to begin looking in |
Result—the TXID and spending input index
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object/null |
Required |
Information about the spent output. If output wasn’t found or if an error occurred, this will be JSON |
→ |
string |
Required |
The output txid |
→ |
number |
Required |
The spending input index |
Example from Dash Core 0.12.2
Get the txid and index where an output is spent:
dash-cli getspentinfo \
'''
{
"txid": "0456aaf51a8df21dd47c2a06ede046a5bf7403bcb95d14d1d71b178c189fb933", \
"index": 0
}
'''
Result:
{
"txid": "14e874421350840e9d43965967c5a989e7d41ad361ef37484ee67d01d433ecfa",
"index": 1,
"height": 7742
}
See also: none
GetTxOut#
The gettxout
RPC returns details about an unspent transaction output (UTXO).
Parameter #1—the TXID of the output to get
Name |
Type |
Presence |
Description |
---|---|---|---|
TXID |
string (hex) |
Required |
The TXID of the transaction containing the output to get, encoded as hex in RPC byte order |
Parameter #2—the output index number (vout) of the output to get
Name |
Type |
Presence |
Description |
---|---|---|---|
Vout |
number (int) |
Required |
The output index number (vout) of the output within the transaction; the first output in a transaction is vout 0 |
Parameter #3—whether to display unconfirmed outputs from the memory pool
Name |
Type |
Presence |
Description |
---|---|---|---|
Unconfirmed |
bool |
Optional |
Set to |
Result—a description of the output
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object/null |
Required |
Information about the output. If output wasn’t found, if it was spent, or if an error occurred, this will be JSON |
→ |
string (hex) |
Required |
The hash of the header of the block on the local best block chain which includes this transaction. The hash will encoded as hex in RPC byte order. If the transaction is not part of a block, the string will be empty |
→ |
number (int) |
Required |
The number of confirmations received for the transaction containing this output or |
→ |
number (Dash) |
Required |
The amount of Dash spent to this output. May be |
→ |
string : object |
Optional |
An object with information about the pubkey script. This may be |
→ → |
string |
Required |
The pubkey script in decoded form with non-data-pushing opcodes listed |
→ → |
string (hex) |
Required |
The pubkey script encoded as hex |
→ → |
number (int) |
Optional |
Deprecated in Dash Core 21.0.0 (returned only if config option -deprecatedrpc=addresses is passed) |
→ → |
string |
Optional |
The type of script. This will be one of the following: |
→ → |
string |
Optional |
Dash address (only if a well-defined address exists) |
→ → |
string : array |
Optional |
Deprecated in Dash Core 21.0.0 (returned only if config option -deprecatedrpc=addresses is passed) |
→ → → |
string |
Required |
A P2PKH or P2SH address |
→ |
bool |
Required |
Set to |
Example from Dash Core 0.15.0
Get the UTXO from the following transaction from the first output index (“0”), searching the memory pool if necessary.
dash-cli -testnet gettxout \
e0a06b47f0de6f3851a228d5ac377ac38b495adf04298c43e951e679c5b0aa8f \
0 true
Result:
{
"bestblock": "000000005651f6d7859793dee07d476a2f2a7338e66bbb41caf4b544c5b0318d",
"confirmations": 2,
"value": 25.00000000,
"scriptPubKey": {
"asm": "OP_DUP OP_HASH160 b66266c5017a759817f3bb99e8d9124bf5bb2e74 OP_EQUALVERIFY OP_CHECKSIG",
"hex": "76a914b66266c5017a759817f3bb99e8d9124bf5bb2e7488ac",
"type": "pubkeyhash",
"address": "ycwoiAibTjpwnoCZSX7S4kiB2H8wULw9qo"
},
"coinbase": false
}
See also
GetRawTransaction: gets a hex-encoded serialized transaction or a JSON object describing the transaction. By default, Dash Core only stores complete transaction data for UTXOs and your own transactions, so the RPC may fail on historic transactions unless you use the non-default
txindex=1
in your Dash Core startup settings.GetTransaction: gets detailed information about an in-wallet transaction.
GetTxOutProof#
The gettxoutproof
RPC returns a hex-encoded proof that one or more specified transactions were included in a block.
NOTE: By default this function only works when there is an
unspent output in the UTXO set 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 in manually (by block header hash).
Parameter #1—the transaction hashes to prove
Name |
Type |
Presence |
Description |
---|---|---|---|
TXIDs |
array |
Required |
A JSON array of txids to filter |
→ |
string |
Required |
TXIDs of the transactions to generate proof for. All transactions must be in the same block |
Parameter #2—the block to look for txids in
Name |
Type |
Presence |
Description |
---|---|---|---|
Header hash |
string |
Optional |
If specified, looks for txid in the block with this hash |
Result—serialized, hex-encoded data for the proof
Name |
Type |
Presence |
Description |
---|---|---|---|
|
string |
Required |
A string that is a serialized, hex-encoded data for the proof |
Example from Dash Core 0.12.2
Get the hex-encoded proof that “txid” was included in block 000000012d774f3c7668f32bc448efeb93b317f312dd863679de3a007d47817f:
dash-cli gettxoutproof \
'''
[
"e0a06b47f0de6f3851a228d5ac377ac38b495adf04298c43e951e679c5b0aa8f"
]
''' \
'000000012d774f3c7668f32bc448efeb93b317f312dd863679de3a007d47817f'
Result (wrapped):
01000020ed72cc6a7294782a7711d8fa7ef74716ef062dc50bb0820f7eec923801000000\
aa5d17c5128043803b67c7ab03e4d3ffbc9604b54f877f1c5cf9ed3adeaa19b2cd7ed659\
f838011d10a70a480200000002033c89c2baecba9fc983c85dcf365c2d9cc93aca1dee2e\
5ac18124464056542e8faab0c579e651e9438c2904df5a498bc37a37acd528a251386fde\
f0476ba0e00105
See also
VerifyTxOutProof: verifies that a proof points to one or more transactions in a block, returning the transactions the proof commits to and throwing an RPC error if the block is not in our best block chain.
merkleblock
message: A description of the format used for the proof.
GetTxOutSetInfo#
The gettxoutsetinfo
RPC returns statistics about the confirmed unspent transaction output (UTXO) set. Note that this call may take some time and that it only counts outputs from confirmed transactions—it does not count outputs from the memory pool.
Parameter #1—Selecting UTXO set hash
Name |
Type |
Presence |
Description |
---|---|---|---|
hash_type |
string |
Optional |
Which UTXO set hash should be calculated. Options: ‘hash_serialized_2’ (the legacy algorithm), ‘muhash’, ‘none’. |
Result—statistics about the UTXO set
Name |
Type |
Presence |
Description |
---|---|---|---|
|
object |
Required |
Information about the UTXO set |
→ |
number (int) |
Required |
The height of the local best block chain. A new node with only the hardcoded genesis block will have a height of 0 |
→ |
string (hex) |
Required |
The hash of the header of the highest block on the local best block chain, encoded as hex in RPC byte order |
→ |
number (int) |
Required |
The number of transactions with unspent outputs |
→ |
number (int) |
Required |
The number of unspent transaction outputs |
→ |
number (int) |
Required |
A meaningless metric for UTXO set size |
→ |
string (hex) |
Optional |
The serialized hash (only present if ‘hash_serialized_2’ hash_type is chosen) |
→ |
string (hex) |
Optional |
A SHA256(SHA256()) The serialized hash (only present if ‘muhash’ hash_type is chosen). |
→ |
number (int) |
Required |
The estimated size of the chainstate on disk |
→ |
number (Dash) |
Required |
The total amount of Dash in the UTXO set |
Example from Dash Core 0.15.0
dash-cli -testnet gettxoutsetinfo
Result:
{
"height": 159358,
"bestblock": "0000000000a705ef74a1fc134ea1eba49af8eead40b3df1fc4fb40f5940a0d60",
"transactions": 187542,
"txouts": 366996,
"bogosize": 28344374,
"hash_serialized_2": "d7326bdc2d9cb7d91580bfd47d6c2972ab1776c2c33c787873a5fd01986c9377",
"disk_size": 21513509,
"total_amount": 7517185.08574437
}
See also
GetBlockChainInfo: provides information about the current state of the block chain.
GetMemPoolInfo: returns information about the node’s current transaction memory pool.
PreciousBlock#
Added in Dash Core 0.12.3 / Bitcoin Core 0.14.0
The preciousblock
RPC 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.
Parameter #1—the block hash
Name |
Type |
Presence |
Description |
---|---|---|---|
Header Hash |
string (hex) |
Required |
The hash of the block to mark as precious |
Result—null
or error on failure
Name |
Type |
Presence |
Description |
---|---|---|---|
|
null |
Required |
JSON |
Example from Dash Core 0.12.3
dash-cli preciousblock 00000000034d77e287b63922a94f12e8c4ab9e\
1d8056060fd51f6153ea5dc757
Result (no output from dash-cli
because result is set to null
).
PruneBlockChain#
Added in Dash Core 0.12.3 / Bitcoin Core 0.14.0
The pruneblockchain
RPC prunes the blockchain up to a specified height or timestamp. The -prune
option needs to be enabled (disabled by default).
Parameter #1—the block height or timestamp
Name |
Type |
Presence |
Description |
---|---|---|---|
Height |
number (int) |
Required |
The block height to prune up to. May be set to a particular height, or a unix timestamp to prune blocks whose block time is at least 2 hours older than the provided timestamp |
Result—the height of the last block pruned
Name |
Type |
Presence |
Description |
---|---|---|---|
|
number (int) |
Required |
The height of the last block pruned |
Example from Dash Core 0.12.3
dash-cli pruneblockchain 413555
Result:
413555
See also
ImportPrunedFunds: imports funds without the need of a rescan. Meant for use with pruned wallets.
SaveMemPool#
The savemempool
RPC dumps the mempool to disk.
Parameters: none
Example from Dash Core 0.16.0
dash-cli savemempool
Result (no output from dash-cli).
See also: none
VerifyChain#
The verifychain
RPC verifies each entry in the local block chain database.
Parameter #1—how thoroughly to check each block
Name |
Type |
Presence |
Description |
---|---|---|---|
Check Level |
number (int) |
Optional |
How thoroughly to check each block, from 0 to 4. Default is the level set with the |
Parameter #2—the number of blocks to check
Name |
Type |
Presence |
Description |
---|---|---|---|
Number Of Blocks |
number (int) |
Optional |
The number of blocks to verify. Set to |
Result—verification results
Name |
Type |
Presence |
Description |
---|---|---|---|
|
bool |
Required |
Set to |
Example from Dash Core 0.12.2
Verify the most recent 400 blocks in the most through way:
dash-cli -testnet verifychain 4 400
Result (took < 1 second on a mobile workstation; it would’ve taken much longer on mainnet):
true
See also
GetBlockChainInfo: provides information about the current state of the block chain.
GetTxOutSetInfo: returns statistics about the confirmed unspent transaction output (UTXO) set. Note that this call may take some time and that it only counts outputs from confirmed transactions—it does not count outputs from the memory pool.
VerifyTxOutProof#
The verifytxoutproof
RPC verifies that a proof points to one or more transactions in a block, returning the transactions the proof commits to and throwing an RPC error if the block is not in our best block chain.
Parameter #1—The hex-encoded proof generated by gettxoutproof
Name |
Type |
Presence |
Description |
---|---|---|---|
|
string |
Required |
A hex-encoded proof |
Result—txid(s) which the proof commits to
Name |
Type |
Presence |
Description |
---|---|---|---|
|
string |
Required |
The txid(s) which the proof commits to, or empty array if the proof cannot be validated |
Example from Dash Core 0.12.2
Verify a proof:
dash-cli verifytxoutproof \
01000020ed72cc6a7294782a7711d8fa7ef74716ef062dc50bb0820f7eec923801000000\
aa5d17c5128043803b67c7ab03e4d3ffbc9604b54f877f1c5cf9ed3adeaa19b2cd7ed659\
f838011d10a70a480200000002033c89c2baecba9fc983c85dcf365c2d9cc93aca1dee2e\
5ac18124464056542e8faab0c579e651e9438c2904df5a498bc37a37acd528a251386fde\
f0476ba0e00105
Result:
[
"e0a06b47f0de6f3851a228d5ac377ac38b495adf04298c43e951e679c5b0aa8f"
]
See also
GetTxOutProof: returns a hex-encoded proof that one or more specified transactions were included in a block.
merkleblock
message: A description of the format used for the proof.