Struct TransactionBatchBuilder 

pub struct TransactionBatchBuilder { /* private fields */ }

Builder for creating a batch of transactions.

This builder handles:

• Automatic sequence number management (incrementing from a starting value)
• Transaction signing

Gas parameters use fixed defaults (a gas_unit_price of 100 octas and a max_gas_amount of 2,000,000) unless overridden via gas_unit_price / max_gas_amount. This builder does not query the network for a recommended gas price; live gas-price estimation happens one level up in BatchOperations::build, which fetches the estimate and passes it to this builder.

Example

let batch = TransactionBatchBuilder::new()
    .sender(account.address())
    .starting_sequence_number(10)
    .chain_id(ChainId::testnet())
    .gas_unit_price(100)
    .add_payload(payload1)
    .add_payload(payload2)
    .build_and_sign(&account)?;

Implementations

impl TransactionBatchBuilder

pub fn new() -> Self

Creates a new batch builder.

pub fn sender(self, sender: AccountAddress) -> Self

Sets the sender address.

pub fn starting_sequence_number(self, seq: u64) -> Self

Sets the starting sequence number.

Each transaction in the batch will use an incrementing sequence number starting from this value.

pub fn chain_id(self, chain_id: ChainId) -> Self

Sets the chain ID.

pub fn gas_unit_price(self, price: u64) -> Self

Sets the gas unit price for all transactions.

pub fn max_gas_amount(self, amount: u64) -> Self

Sets the maximum gas amount for all transactions.

pub fn expiration_secs(self, secs: u64) -> Self

Sets the expiration time in seconds from now.

pub fn add_payload(self, payload: TransactionPayload) -> Self

Adds a transaction payload to the batch.

pub fn add_payloads( self, payloads: impl IntoIterator<Item = TransactionPayload>, ) -> Self

Adds multiple transaction payloads to the batch.

pub fn len(&self) -> usize

Returns the number of transactions in the batch.

pub fn is_empty(&self) -> bool

Returns true if the batch is empty.

pub fn build(self) -> AptosResult<Vec<RawTransaction>>

Builds raw transactions without signing.

Errors

Returns an error if sender, starting_sequence_number, or chain_id is not set, or if building any transaction fails.

pub fn build_and_sign<A: Account>( self, account: &A, ) -> AptosResult<SignedTransactionBatch>

Builds and signs all transactions in the batch.

Errors

Returns an error if building the transactions fails or if signing any transaction fails.

Trait Implementations

impl Clone for TransactionBatchBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionBatchBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TransactionBatchBuilder

fn default() -> Self

Returns the “default value” for a type.