Struct SponsoredTransactionBuilder

Source

pub struct SponsoredTransactionBuilder { /* private fields */ }

Expand description

A builder for constructing sponsored (fee payer) transactions.

This provides a fluent API for creating transactions where a fee payer account pays the gas fees on behalf of the sender.

§Example

use aptos_sdk::transaction::{SponsoredTransactionBuilder, EntryFunction};

// Build the fee payer transaction structure
let fee_payer_txn = SponsoredTransactionBuilder::new()
    .sender(user_account.address())
    .sequence_number(0)
    .fee_payer(sponsor_account.address())
    .payload(payload)
    .chain_id(ChainId::testnet())
    .build()?;

// Then sign it
let signed = sign_sponsored_transaction(
    &fee_payer_txn,
    &user_account,
    &[],  // no secondary signers
    &sponsor_account,
)?;

Implementations§

Source §

impl SponsoredTransactionBuilder

Source

pub fn new() -> Self

Creates a new sponsored transaction builder with default values.

Source

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

Sets the sender address.

Source

pub fn sequence_number(self, sequence_number: u64) -> Self

Sets the sender’s sequence number.

Source

pub fn secondary_signer(self, address: AccountAddress) -> Self

Adds a secondary signer address to the transaction.

Secondary signers are additional accounts that must sign the transaction. This is useful for multi-party transactions.

Source

pub fn secondary_signers(self, addresses: &[AccountAddress]) -> Self

Adds multiple secondary signer addresses to the transaction.

Source

pub fn fee_payer(self, address: AccountAddress) -> Self

Sets the fee payer address.

Source

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

Sets the transaction payload.

Source

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

Sets the maximum gas amount.

Source

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

Sets the gas unit price in octas.

Source

pub fn expiration_timestamp_secs(self, expiration_timestamp_secs: u64) -> Self

Sets the expiration timestamp in seconds since Unix epoch.

Source

pub fn expiration_from_now(self, seconds: u64) -> Self

Sets the expiration time relative to now.

Source

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

Sets the chain ID.

Source

pub fn build(self) -> AptosResult<FeePayerRawTransaction>

Builds the raw fee payer transaction (unsigned).

This returns a FeePayerRawTransaction that can be signed later by the sender, secondary signers, and fee payer.

§Errors

Returns an error if sender, sequence_number, payload, chain_id, or fee_payer is not set.

Source

pub fn build_and_sign<S, F>( self, sender: &S, secondary_signers: &[&dyn Account], fee_payer: &F, ) -> AptosResult<SignedTransaction>
where S: Account, F: Account,

Builds and signs the transaction with all provided accounts.

This is a convenience method that builds the transaction and signs it in one step.

§Example

let signed = SponsoredTransactionBuilder::new()
    .sender(user.address())
    .sequence_number(0)
    .fee_payer(sponsor.address())
    .payload(payload)
    .chain_id(ChainId::testnet())
    .build_and_sign(&user, &[], &sponsor)?;