Build Transaction

Build a transaction to confirm its contents before submitting it to the network.

Required Param
Purpose
Requirements

account_id

The account on which to perform this action

Account must exist in the wallet

Optional Param
Purpose
Requirements

addresses_and_amounts

An array of public addresses and Amountsarrow-up-right as a tuple

addresses are b58-encoded public addresses

recipient_public_address

The recipient for this transaction

b58-encoded public address bytes

amount

The Amountarrow-up-right to send in this transaction

input_txo_ids

Specific TXOs to use as inputs to this transaction

TXO IDs (obtain from get_txos_for_account)

fee_value

The fee value to submit with this transaction

If not provided, uses MINIMUM_FEE of the first outputs token_id, if available, or defaults to MOB

fee_token_id

The fee token_id to submit with this transaction

If not provided, uses token_id of first output, if available, or defaults to MOB

tombstone_block

The block after which this transaction expires

If not provided, uses cur_height + 10

block_version

string(u64)

The block version to build this transaction for. Defaults to the network block version

sender_memo_credential_subaddress_index

string(u64)

The subaddress to generate the SenderMemoCredentials from. Defaults to the default subaddress for the account.

payment_request_id

string(u64)

The payment request id to set in the RTH Memo.

max_spendable_value

The maximum amount for an input TXO selected for this transaction

spend_subaddress

string

If specified, the subaddress from which to spend funds. If sufficient funds are not availble that have been received only at this subaddress, an InsufficientFunds error is thrown.

Example

circle-info

Since the tx_proposalJSON object is quite large, you may wish to write the result to a file for use in the submit_transaction call, such as:

Last updated

Was this helpful?