qbit RPC Reference
Generated from the current manifest, the committed v30.2 baseline, and the semantic overlay.
Summary
| Metric | Count |
|---|---|
| Total methods | 159 |
| New since v30.2 | 10 |
| Changed params/results since v30.2 | 14 |
| Changed behavior since v30.2 | 3 |
| Unchanged | 134 |
Change counts are not mutually exclusive. A method may appear in more than one change bucket.
Changed since v30.2
- All changed methods
- New endpoints since v30.2: 10
- Changed params/results since v30.2: 14
- Changed behavior since v30.2: 3
Categories
- Blockchain: 39 total, 2 new, 0 params/results changed, 0 behavior changed, 37 unchanged
- Control: 6 total, 0 new, 0 params/results changed, 0 behavior changed, 6 unchanged
- Mining: 9 total, 2 new, 2 params/results changed, 3 behavior changed, 4 unchanged
- Network: 15 total, 1 new, 0 params/results changed, 0 behavior changed, 14 unchanged
- Rawtransactions: 20 total, 1 new, 3 params/results changed, 0 behavior changed, 16 unchanged
- Signer: 1 total, 0 new, 0 params/results changed, 0 behavior changed, 1 unchanged
- Util: 8 total, 0 new, 0 params/results changed, 0 behavior changed, 8 unchanged
- Wallet: 60 total, 4 new, 9 params/results changed, 0 behavior changed, 47 unchanged
- Zmq: 1 total, 0 new, 0 params/results changed, 0 behavior changed, 1 unchanged
All Methods
dumptxoutset
Write the serialized UTXO set to a file. This can be used in loadtxoutset afterwards if this snapshot height is supported in the chainparams as well.
getbestblockhash
Returns the hash of the best (tip) block in the most-work fully-validated chain.
getblock
If verbosity is 0, returns a string that is serialized, hex-encoded data for block 'hash'.
getblockchaininfo
Returns an object containing various state info regarding blockchain processing.
getblockcount
Returns the height of the most-work fully-validated chain.
getblockfilter
Retrieve a BIP 157 content filter for a particular block.
getblockfrompeer
Attempt to fetch block from a given peer.
getblockhash
Returns hash of block in best-block-chain at height provided.
getblockheader
If verbose is false, returns a string that is serialized, hex-encoded data for blockheader 'hash'.
getblockstats
Compute per block statistics for a given window. All amounts are in satoshis.
getchainstates
Return information about chainstates.
getchaintips
Return information about all known tips in the block tree, including the main chain as well as orphaned branches.
getchaintxstats
Compute statistics about the total number and rate of transactions in the chain.
getconfirmationtarget
Calculate the recommended number of confirmations for a transaction.
New since v30.2
Adds the qbit confirmation-target estimator RPC.
getdeploymentinfo
Returns an object containing various state info regarding deployments of consensus changes.
getdescriptoractivity
Get spend and receive activity associated with a set of descriptors for a set of blocks. This command pairs well with the `relevant_blocks` output of `scanblocks()`.
getdifficulty
Returns the proof-of-work difficulty as a multiple of the minimum difficulty.
getmempoolancestors
If txid is in the mempool, returns all in-mempool ancestors.
getmempooldescendants
If txid is in the mempool, returns all in-mempool descendants.
getmempoolentry
Returns mempool data for given transaction
getmempoolinfo
Returns details on the active state of the TX memory pool.
getorphanmetrics
Return stale block metrics over a rolling event window.
New since v30.2
getrawmempool
Returns all transaction ids in memory pool as a json array of string transaction ids.
gettxout
Returns details about an unspent transaction output.
gettxoutproof
Returns a hex-encoded proof that "txid" was included in a block.
gettxoutsetinfo
Returns statistics about the unspent transaction output set.
gettxspendingprevout
Scans the mempool to find transactions spending any of the given outputs
importmempool
Import a mempool.dat file and attempt to add its contents to the mempool.
loadtxoutset
Load the serialized UTXO set from a file.
preciousblock
Treats a block as if it were received before others with the same work.
pruneblockchain
Attempts to delete block and undo data up to a specified height or timestamp, if eligible for pruning.
savemempool
Dumps the mempool to disk. It will fail until the previous dump is fully loaded.
scanblocks
Return relevant blockhashes for given descriptors (requires blockfilterindex).
scantxoutset
Scans the unspent transaction output set for entries that match certain output descriptors.
verifychain
Verifies blockchain database.
verifytxoutproof
Verifies that a proof points to a transaction in a block, returning the transaction it commits to
waitforblock
Waits for a specific new block and returns useful info about it.
waitforblockheight
Waits for (at least) block height and returns the height and hash
waitfornewblock
Waits for any new block and returns useful info about it.
getmemoryinfo
Returns an object containing information about memory usage.
getrpcinfo
Returns details of the RPC server.
help
List all commands, or get help for a specified command.
logging
Gets and sets the logging configuration.
stop
Request a graceful shutdown of qbit.
uptime
Returns the total uptime of the server.
createauxblock
Create a merged-mining candidate block paying the coinbase reward to the given P2MR address.
New since v30.2
getblocktemplate
If the request parameters include a 'mode' key, that is used to explicitly select between the default 'template' request or a 'proposal'.
Changed params/results since v30.2 Changed behavior since v30.2
Cadence, AuxPoW, and qbit version-rolling semantics diverge from upstream behavior.
getmininginfo
Returns a json object containing mining-related information.
Changed behavior since v30.2
networkhashps is the default total qbit chainwork hashrate estimate, and next is the permissionless/native candidate.
getnetworkhashps
Returns the estimated network hashes per second (H/s) based on accepted block proof work.
Changed params/results since v30.2 Changed behavior since v30.2
Adds lane-aware qbit hashrate estimates for all, permissionless, and AuxPoW work.
getprioritisedtransactions
Returns a map of all user-created (see prioritisetransaction) fee deltas by txid, and whether the tx is present in mempool.
prioritisetransaction
Accepts the transaction into mined blocks at a higher (or lower) priority
submitauxblock
Submit an AuxPoW payload for a cached merged-mining candidate block.
New since v30.2
submitblock
Attempts to submit new block to network.
submitheader
Decode the given hexdata as a header and submit it as a candidate chain tip if valid.
addnode
Attempts to add or remove a node from the addnode list.
clearbanned
Clear all banned IPs.
disconnectnode
Immediately disconnects from the specified peer node.
getaddednodeinfo
Returns information about the given added node, or all added nodes
getaddrmaninfo
Provides information about the node's address manager by returning the number of addresses in the `new` and `tried` tables and their sum for all networks.
getarchivepeers
Returns archive-relevant peer state for bootstrap, fallback debugging, and monitoring.
New since v30.2
getconnectioncount
Returns the number of connections to other nodes.
getnettotals
Returns information about network traffic, including bytes in, bytes out,
getnetworkinfo
Returns an object containing various state info regarding P2P networking.
getnodeaddresses
Return known addresses, after filtering for quality and recency.
getpeerinfo
Returns data about each connected network peer as a json array of objects.
listbanned
List all manually banned IPs/Subnets.
ping
Requests that a ping be sent to all other nodes, to measure ping time.
setban
Attempts to add or remove an IP/Subnet from the banned list.
setnetworkactive
Disable/enable all p2p network activity.
analyzepsbt
Analyzes and provides information about the current status of a PSBT and its inputs
Changed params/results since v30.2
combinepsbt
Combine multiple PSBTs into one transaction.
combinerawtransaction
Combine multiple partially signed transactions into one transaction.
converttopsbt
Converts a network serialized transaction to a PSBT. This should be used only with createrawtransaction and fundrawtransaction
createpsbt
Creates a transaction in the Partially Signed Transaction format.
createrawtransaction
Create a transaction spending the given inputs and creating new outputs.
decodepsbt
Return a JSON object representing the serialized, base64-encoded PSBT.
Changed params/results since v30.2
decoderawtransaction
Return a JSON object representing the serialized, hex-encoded transaction.
decodescript
Decode a hex-encoded script.
descriptorprocesspsbt
Update all segwit inputs in a PSBT with information from output descriptors, the UTXO set or the mempool.
finalizepsbt
Finalize the inputs of a PSBT. If the transaction is fully signed, it will produce a
fundrawtransaction
If the transaction has no inputs, they will be automatically selected to meet its out value.
Wallet
getdefaultctvhash
Compute the BIP119-style default OP_CHECKTEMPLATEVERIFY hash for a serialized transaction input.
New since v30.2
getrawtransaction
By default, this call only returns a transaction if it is in the mempool. If -txindex is enabled
joinpsbts
Joins multiple distinct PSBTs with different inputs and outputs into one PSBT with inputs and outputs from all of the PSBTs
sendrawtransaction
Submit a raw transaction (serialized, hex-encoded) to local node and network.
signrawtransactionwithkey
Sign inputs for raw transaction (serialized, hex-encoded).
Changed params/results since v30.2
submitpackage
Submit a package of raw transactions (serialized, hex-encoded) to local node.
testmempoolaccept
Returns result of mempool acceptance tests indicating if raw transaction(s) (serialized, hex-encoded) would be accepted by mempool.
utxoupdatepsbt
Updates all segwit inputs and outputs in a PSBT with data from output descriptors, the UTXO set, txindex, or the mempool.
enumeratesigners
Returns a list of external signers from -signer.
Signer
createmultisig
Creates a multi-signature address with n signatures of m keys required.
deriveaddresses
Derives one or more addresses corresponding to an output descriptor.
estimatesmartfee
Estimates the approximate fee per kilobyte needed for a transaction to begin
getdescriptorinfo
Analyses a descriptor.
getindexinfo
Returns the status of one or all available indices currently running in the node.
signmessagewithprivkey
Sign a message with the private key of an address
validateaddress
Return information about the given qbit address.
verifymessage
Verify a signed message.
abandontransaction
Mark in-wallet transaction <txid> as abandoned
Wallet
abortrescan
Stops current wallet rescan triggered by an RPC call, e.g. by a rescanblockchain call.
Wallet
backupwallet
Safely copies the current wallet file to the specified destination, which can either be a directory or a path with a filename.
Wallet
bumpfee
Bumps the fee of a transaction T, replacing it with a new transaction B.
Wallet
createwallet
Creates and loads a new wallet.
Wallet
createwalletdescriptor
Creates the wallet's descriptor for the given address type. The address type must be one that the wallet does not already have a descriptor for. On P2MR-only chains, public P2MR descriptors are omitted from the result; use exportpubkeydb for watch-only P2MR exports.
Changed params/results since v30.2 Wallet
encryptwallet
Encrypts the wallet with 'passphrase'. This is for first time encryption.
Wallet
exportpubkeydb
Exports wallet P2MR pubkeys as an explicit-pubkey JSON database that can be imported into a watch-only wallet.
New since v30.2 Wallet
getaddressesbylabel
Returns the list of addresses assigned the specified label.
Wallet
getaddressinfo
Return information about the given qbit address.
Changed params/results since v30.2 Wallet
getbalance
Returns the total available balance.
Wallet
getbalances
Returns an object with all balances in QBT.
Wallet
gethdkeys
List all BIP 32 HD keys in the wallet and which descriptors use them.
Wallet
getnewaddress
Returns a new qbit address for receiving payments.
Wallet
getnextpubkeydbaddress
Returns the next allocatable imported P2MR pubkey-pool address for a watch-only wallet.
New since v30.2 Wallet
getrawchangeaddress
Returns a new qbit address, for receiving change.
Wallet
getreceivedbyaddress
Returns the total amount received by the given address in transactions with at least minconf confirmations.
Wallet
getreceivedbylabel
Returns the total amount received by addresses with <label> in transactions with at least [minconf] confirmations.
Wallet
gettransaction
Get detailed information about in-wallet transaction <txid>
Wallet
getwalletinfo
Returns an object containing various wallet state info.
Wallet
importdescriptors
Import descriptors. This will trigger a rescan of the blockchain based on the earliest timestamp of all descriptors being imported. Requires a new wallet backup.
Wallet
importprunedfunds
Imports funds without rescan. Corresponding address or script must previously be included in wallet. Aimed towards pruned wallets. The end-user is responsible to import additional transactions that subsequently spend the imported outputs or rescan after the point in the blockchain the transaction is included.
Wallet
importpubkeydb
Imports a JSON pubkey database into a watch-only wallet as P2MR descriptors.
New since v30.2 Wallet
keypoolrefill
Refills each descriptor keypool in the wallet up to the specified number of new keys.
Wallet
listaddressgroupings
Lists groups of addresses which have had their common ownership
Wallet
listdescriptors
List all descriptors present in a wallet.
Changed params/results since v30.2 Wallet
listlabels
Returns the list of all labels, or labels that are assigned to addresses with a specific purpose.
Wallet
listlockunspent
Returns list of temporarily unspendable outputs.
Wallet
listpubkeydbstatus
Reports imported P2MR pubkey-pool allocation status by account and chain.
New since v30.2 Wallet
listreceivedbyaddress
List balances by receiving address.
Wallet
listreceivedbylabel
List received transactions by label.
Wallet
listsinceblock
Get all transactions in blocks since block [blockhash], or all transactions if omitted.
Wallet
listtransactions
If a label name is provided, this will return only incoming transactions paying to addresses with the specified label.
Wallet
listunspent
Returns array of unspent transaction outputs
Wallet
listwalletdir
Returns a list of wallets in the wallet directory.
Wallet
listwallets
Returns a list of currently loaded wallets.
Wallet
loadwallet
Loads a wallet from a wallet file or directory.
Wallet
lockunspent
Updates list of temporarily unspendable outputs.
Wallet
migratewallet
Migrate the wallet to a descriptor wallet.
Wallet
psbtbumpfee
Bumps the fee of a transaction T, replacing it with a new transaction B.
Wallet
removeprunedfunds
Deletes the specified transaction from the wallet. Meant for use with pruned wallets and as a companion to importprunedfunds. This will affect wallet balances.
Wallet
rescanblockchain
Rescan the local blockchain for wallet related transactions.
Wallet
restorewallet
Restores and loads a wallet from backup.
Wallet
send
EXPERIMENTAL warning: this call may be changed in future releases.
Changed params/results since v30.2 Wallet
sendall
EXPERIMENTAL warning: this call may be changed in future releases.
Changed params/results since v30.2 Wallet
sendmany
Send multiple times. Amounts are double-precision floating point numbers.
Changed params/results since v30.2 Wallet
sendtoaddress
Send an amount to a given address.
Changed params/results since v30.2 Wallet
setlabel
Sets the label associated with the given address.
Wallet
settxfee
(DEPRECATED) Set the transaction fee rate in QBT/kvB for this wallet. Overrides the global -paytxfee command line parameter.
Wallet
setwalletflag
Change the state of the given wallet flag for a wallet.
Wallet
signmessage
Sign a message with the private key of an address
Wallet
signrawtransactionwithwallet
Sign inputs for raw transaction (serialized, hex-encoded).
Changed params/results since v30.2 Wallet
simulaterawtransaction
Calculate the balance change resulting in the signing and broadcasting of the given transaction(s).
Wallet
unloadwallet
Unloads the wallet referenced by the request endpoint or the wallet_name argument.
Wallet
walletcreatefundedpsbt
Creates and funds a transaction in the Partially Signed Transaction format.
Wallet
walletdisplayaddress
Display address on an external signer for verification.
Wallet Signer
walletlock
Removes the wallet encryption key from memory, locking the wallet.
Wallet
walletpassphrase
Stores the wallet decryption key in memory for 'timeout' seconds.
Wallet
walletpassphrasechange
Changes the wallet passphrase from 'oldpassphrase' to 'newpassphrase'.
Wallet
walletprocesspsbt
Update a PSBT with input information from our wallet and then sign inputs
Changed params/results since v30.2 Wallet
getzmqnotifications
Returns information about the active ZeroMQ notifications.
ZMQ