Struct TransactionHeaderBuilder

pub struct TransactionHeaderBuilder { /* private fields */ }

Builder for TransactionHeader.

Implementations

impl TransactionHeaderBuilder

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

The account that authorized the transaction.

Fees are deducted from this account.

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

Optional transaction fee in microALGO.

When None, the fee will be interpreted as 0 by the network.

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

First round for when the transaction is valid.

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

Last round for when the transaction is valid.

After this round, the transaction will be expired.

pub fn genesis_hash(&mut self, value: Byte32) -> &mut Self

Hash of the genesis block of the network.

Used to identify which network the transaction is for.

pub fn genesis_id(&mut self, value: String) -> &mut Self

Genesis ID of the network.

A human-readable string used alongside genesis hash to identify the network.

pub fn note(&mut self, value: Vec<u8>) -> &mut Self

Optional user-defined note field.

Can contain arbitrary data up to 1KB in size.

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

Optional authorized account for future transactions.

If set, only this account will be used for transaction authorization going forward. Reverting back control to the original address must be done by setting this field to the original address.

pub fn lease(&mut self, value: Byte32) -> &mut Self

Optional lease value to enforce mutual transaction exclusion.

When a transaction with a non-empty lease field is confirmed, the lease is acquired. A lease X is acquired by the sender, generating the (sender, X) lease. The lease is kept active until the last_valid round of the transaction has elapsed. No other transaction sent by the same sender can be confirmed until the lease expires.

pub fn group(&mut self, value: Byte32) -> &mut Self

Optional group ID for atomic transaction grouping.

Transactions with the same group ID must execute together or not at all.

pub fn build(&self) -> Result<TransactionHeader, TransactionHeaderBuilderError>

Builds a new TransactionHeader.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for TransactionHeaderBuilder

fn clone(&self) -> TransactionHeaderBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for TransactionHeaderBuilder

fn default() -> Self

Returns the “default value” for a type.