Struct AssetTransferTransactionBuilder

pub struct AssetTransferTransactionBuilder { /* private fields */ }

Builder for AssetTransferTransactionFields.

Implementations

impl AssetTransferTransactionBuilder

pub fn header(&mut self, value: TransactionHeader) -> &mut Self

Common transaction header fields.

pub fn asset_id(&mut self, value: u64) -> &mut Self

The ID of the asset being transferred.

pub fn amount(&mut self, value: u64) -> &mut Self

The amount of the asset to transfer.

An integer value representing the number of units (to their smallest denomination) of the asset that are being transferred. In other words, the asset decimals don’t play a role in this value. It should be up to the caller (or a higher abstraction) to handle the conversion based on the asset decimals.

pub fn receiver(&mut self, value: Address) -> &mut Self

The address of the account that will receive the asset.

The receiver must have opted-in to the asset before they can receive it.

pub fn asset_sender(&mut self, value: Address) -> &mut Self

Optional address of the account that actually holds the asset being transferred.

If provided, this indicates that the transaction is a clawback operation, where the sender is the asset clawback address and is forcibly moving assets from this account to the receiver.

pub fn close_remainder_to(&mut self, value: Address) -> &mut Self

Optional address to send all remaining asset units to after the transfer.

If specified, this indicates that the sender is closing out their position in the asset, and all remaining units of this asset owned by the sender will be transferred to this address. This effectively removes the asset from the sender’s account.

pub fn build_fields( &self, ) -> Result<AssetTransferTransactionFields, AssetTransferTransactionBuilderError>

Builds a new AssetTransferTransactionFields.

Errors

If a required field has not been initialized.

impl AssetTransferTransactionBuilder

pub fn build(&self) -> Result<Transaction, AssetTransferTransactionBuilderError>

Trait Implementations

impl Clone for AssetTransferTransactionBuilder

fn clone(&self) -> AssetTransferTransactionBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for AssetTransferTransactionBuilder

fn default() -> Self

Returns the “default value” for a type.