sendall

Back to wallet

Changed params/results since v30.2 Wallet

Summary

EXPERIMENTAL warning: this call may be changed in future releases.

Description

EXPERIMENTAL warning: this call may be changed in future releases.

Spend the value of all (or specific) confirmed UTXOs and unconfirmed change in the wallet to one or more recipients. Unconfirmed inbound UTXOs and locked UTXOs will not be spent. Sendall will respect the avoid_reuse wallet flag. If your wallet contains many small inputs, either because it received tiny payments or as a result of accumulating change, consider using send_max to exclude inputs that are worth less than the fees needed to spend them.

Change Buckets

  • Changed params/results since v30.2

Arguments

  • recipients (ARR, required): The sendall destinations. Each address may only appear once. Optionally some recipients can be specified with an amount to perform payments, but at least one address must appear without a specified amount.

  • address (STR, required): A qbit address which receives an equal share of the unspecified amount.

  • value (OBJ_USER_KEYS): No description.
    • address (AMOUNT, required): A key-value pair. The key (string) is the qbit address, the value (float or string) is the amount in QBT
  • conf_target (NUM): Confirmation target in blocks

  • estimate_mode (STR): The fee estimate mode, must be one of (case insensitive): unset, economical, conservative unset means no mode set (economical mode is used if the transaction is replaceable; otherwise, conservative mode is used). economical estimates use a shorter time horizon, making them more responsive to short-term drops in the prevailing fee market. This mode potentially returns a lower fee rate estimate. conservative estimates use a longer time horizon, making them less responsive to short-term drops in the prevailing fee market. This mode potentially returns a higher fee rate estimate.

  • fee_rate (AMOUNT): Specify a fee rate in sat/vB.

  • options (OBJ_NAMED_PARAMS): No description.
  • add_to_wallet (BOOL): When false, returns the serialized transaction without broadcasting or adding it to the wallet
  • fee_rate (AMOUNT): Specify a fee rate in sat/vB.
  • include_watching (BOOL): (DEPRECATED) No longer used
  • inputs (ARR): Use exactly the specified inputs to build the transaction. Specifying inputs is incompatible with the send_max, minconf, and maxconf options.
    • value (OBJ): No description.
    • txid (STR_HEX, required): The transaction id
    • vout (NUM, required): The output number
    • sequence (NUM): The sequence number
  • locktime (NUM): Raw locktime. Non-0 value also locktime-activates inputs
  • lock_unspents (BOOL): Lock selected unspent outputs
  • psbt (BOOL): Always return a PSBT, implies add_to_wallet=false.
  • send_max (BOOL): When true, only use UTXOs that can pay for their own fees to maximize the output amount. When 'false' (default), no UTXO is left behind. send_max is incompatible with providing specific inputs.
  • minconf (NUM): Require inputs with at least this many confirmations.
  • maxconf (NUM): Require inputs with at most this many confirmations.
  • version (NUM): Transaction version
  • conf_target (NUM): Confirmation target in blocks

  • estimate_mode (STR): The fee estimate mode, must be one of (case insensitive): unset, economical, conservative unset means no mode set (economical mode is used if the transaction is replaceable; otherwise, conservative mode is used). economical estimates use a shorter time horizon, making them more responsive to short-term drops in the prevailing fee market. This mode potentially returns a lower fee rate estimate. conservative estimates use a longer time horizon, making them less responsive to short-term drops in the prevailing fee market. This mode potentially returns a higher fee rate estimate.

  • replaceable (BOOL): Marks this transaction as BIP125-replaceable. Allows this transaction to be replaced by a transaction with higher fees

  • solving_data (OBJ): Keys and scripts needed for producing a final transaction with a dummy signature. Used for fee estimation during coin selection.
    • pubkeys (ARR): Public keys involved in this transaction.
    • pubkey (STR_HEX): A public key
    • scripts (ARR): Scripts involved in this transaction.
    • script (STR_HEX): A script
    • descriptors (ARR): Descriptors that provide solving data for this transaction.
    • descriptor (STR): A descriptor

Results

  • value (OBJ): No description.
  • complete (BOOL): If the transaction has a complete set of signatures
  • txid (STR_HEX, optional): The transaction id for the send. Only 1 transaction is created regardless of the number of addresses.
  • hex (STR_HEX, optional): If add_to_wallet is false, the hex-encoded raw transaction with signature(s)
  • psbt (STR, optional): If more signatures are needed, or if add_to_wallet is false, the base64-encoded (partially) signed transaction
  • pqc_key_states (ARR, optional): PQC usage state for local wallet keys that participated in this response.
    • value (OBJ): No description.
    • pubkey (STR_HEX): The hex-encoded PQC public key.
    • pqc_signature_count (NUM): The number of signatures used by this PQC key.
    • pqc_signature_limit (NUM): The hard signature limit for this PQC key.
    • pqc_signatures_remaining (NUM): The remaining signature budget for this PQC key.
    • pqc_limit_state (STR): The PQC usage state. One of normal, warning, critical, or exhausted.
  • pqc_overall_limit_state (STR, optional): The maximum PQC usage severity across pqc_key_states.
  • pqc_signature_count (NUM, optional): The number of signatures used by the single local PQC key associated with this response.
  • pqc_signature_limit (NUM, optional): The hard signature limit for the single local PQC key associated with this response.
  • pqc_signatures_remaining (NUM, optional): The remaining signature budget for the single local PQC key associated with this response.
  • pqc_limit_state (STR, optional): The PQC usage state for the single local PQC key associated with this response.
  • warnings (ARR, optional): Human-readable warning lines emitted when PQC threshold transitions or reminder buckets fire.
    • warning (STR): No description.

Examples

Spend all UTXOs from the wallet with a fee rate of 1 sat/vB using named arguments

qbit-cli -named sendall recipients='["qb1zqqqsyqcyq5rqwzqfpg9scrgwpugpzysnzs23v9ccrydpk8qarc0sjq57mw"]' fee_rate=1

Spend all UTXOs with a fee rate of 1.1 sat/vB using positional arguments

qbit-cli sendall '["qb1zqqqsyqcyq5rqwzqfpg9scrgwpugpzysnzs23v9ccrydpk8qarc0sjq57mw"]' null "unset" 1.1

Spend all UTXOs split into equal amounts to two addresses with a fee rate of 1.5 sat/vB using the options argument

qbit-cli sendall '["qb1zqqqsyqcyq5rqwzqfpg9scrgwpugpzysnzs23v9ccrydpk8qarc0sjq57mw", "qb1zyqsjygeyy5nzw2pf9g4jctfw9ucrzv3nxs6nvdec8yark0pa8clsj9cmtx"]' null "unset" null '{"fee_rate": 1.5}'

Leave dust UTXOs in wallet, spend only UTXOs with positive effective value with a fee rate of 10 sat/vB using the options argument

qbit-cli sendall '["qb1zqqqsyqcyq5rqwzqfpg9scrgwpugpzysnzs23v9ccrydpk8qarc0sjq57mw"]' null "unset" null '{"fee_rate": 10, "send_max": true}'

Spend all UTXOs with a fee rate of 1.3 sat/vB using named arguments and sending a 0.25 QBT to another recipient

qbit-cli -named sendall recipients='[{"qb1zyqsjygeyy5nzw2pf9g4jctfw9ucrzv3nxs6nvdec8yark0pa8clsj9cmtx": 0.25}, "qb1zqqqsyqcyq5rqwzqfpg9scrgwpugpzysnzs23v9ccrydpk8qarc0sjq57mw"]' fee_rate=1.3