Transfer

Transfer

Send XHV to a number of recipients.

Alias: None.

Inputs:

  • destinations - array of destinations to receive XHV:

    • amount - unsigned int; Amount to send to each destination, in @atomic-units.

    • address - string; Destination public address.

  • account_index - unsigned int; (Optional) Transfer from this account index. (Defaults to 0)

  • subaddr_indices - array of unsigned int; (Optional) Transfer from this set of subaddresses. (Defaults to empty - all indices)

  • priority - unsigned int; Set a priority for the transaction. Accepted Values are: 0-3 for: default, unimportant, normal, elevated, priority.

  • mixin - unsigned int; Number of outputs from the blockchain to mix with (0 means no mixing).

  • ring_size - unsigned int; Number of outputs to mix in the transaction (this output + N decoys from the blockchain).

  • unlock_time - unsigned int; Number of blocks before the haven can be spent (0 to not add a lock).

  • get_tx_key - boolean; (Optional) Return the transaction key after sending.

  • do_not_relay - boolean; (Optional) If true, the newly created transaction will not be relayed to the haven network. (Defaults to false)

  • get_tx_hex - boolean; Return the transaction as hex string after sending (Defaults to false)

  • get_tx_metadata - boolean; Return the metadata needed to relay the transaction. (Defaults to false)

Outputs:

  • amount - Amount transferred for the transaction.

  • amount_usd - Amount transferred for the transaction.

  • fee - Integer value of the fee charged for the txn.

  • multisig_txset - Set of multisig transactions in the process of being signed (empty for non-multisig).

  • tx_blob - Raw transaction represented as hex string, if get_tx_hex is true.

  • tx_hash - String for the publically searchable transaction hash.

  • tx_key - String for the transaction key if get_tx_key is true, otherwise, blank string.

  • tx_metadata - Set of transaction metadata needed to relay this transfer later, if get_tx_metadata is true.

  • unsigned_txset - String. Set of unsigned tx for cold-signing purposes.

Example

Last updated

Was this helpful?