listdescriptors

Back to wallet

Changed params/results since v30.2 Wallet

Summary

List all descriptors present in a wallet.

Description

List all descriptors present in a wallet. On P2MR-only chains, public output omits P2MR descriptors that rely on BIP32 extended public keys; use exportpubkeydb for watch-only P2MR exports.

Change Buckets

  • Changed params/results since v30.2

Arguments

  • private (BOOL): Show private descriptors.

Results

  • value (OBJ): No description.
  • wallet_name (STR): Name of wallet this operation was performed on
  • descriptors (ARR): Array of descriptor objects (sorted by descriptor string representation)
    • value (OBJ): No description.
    • desc (STR): Descriptor string representation
    • timestamp (NUM): The creation time of the descriptor
    • active (BOOL): Whether this descriptor is currently used to generate new addresses
    • internal (BOOL, optional): True if this descriptor is used to generate change addresses. False if this descriptor is used to generate receiving addresses; defined only for active descriptors
    • range (ARR_FIXED, optional): Defined only for ranged descriptors
      • value (NUM): Range start inclusive
      • value (NUM): Range end inclusive
    • next (NUM, optional): Same as next_index field. Kept for compatibility reason.
    • next_index (NUM, optional): The next index to generate addresses from; defined only for ranged descriptors
  • warnings (ARR, optional): No description.
    • value (STR): No description.

Examples

qbit-cli listdescriptors

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "listdescriptors", "params": []}' -H 'content-type: application/json' http://127.0.0.1:8352/

qbit-cli listdescriptors true

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "listdescriptors", "params": [true]}' -H 'content-type: application/json' http://127.0.0.1:8352/