Struct ProgrammableTransactionBuilder 

pub struct ProgrammableTransactionBuilder { /* private fields */ }

Builder for a ProgrammableTransaction.

Implementations

impl ProgrammableTransactionBuilder

Base API.

pub fn new() -> Self

pub fn finish(self) -> ProgrammableTransaction

pub fn pure<T: Serialize + ?Sized>(&mut self, value: &T) -> Result<Argument>

Potentially adds a pure argument to the PTB.

May not create a new PTB input if a previous one already has the same contents.

pub fn force_separate_pure<T: Serialize>( &mut self, value: T, ) -> Result<Argument>

Like Self::pure but forces a separate input entry

pub fn pure_bytes(&mut self, bytes: Vec<u8>, force_separate: bool) -> Argument

Adds a pure argument to the PTB.

Arguments

• bytes: the BCS-serialized contents of the argument
• force_separate: whether to force a separate input argument to the PTB, else the builder re-uses a previously declared input argument if it has the same contents.

pub fn obj<O: Into<Input>>(&mut self, obj_arg: O) -> Result<Argument>

Adds an object input to the PTB, returning the corresponding argument which can be used in the body.

May fail if overriding a previously declared input.

pub fn command(&mut self, command: impl Into<Command>) -> Argument

Add a command to the PTB.

This will come after any commands that were previously declared.

impl ProgrammableTransactionBuilder

Address-balance helpers.

pub fn funds_withdrawal(&mut self, withdrawal: FundsWithdrawal) -> Argument

Adds a FundsWithdrawal input to the PTB.

pub fn balance_from_sender( &mut self, amount: u64, coin_type: TypeTag, ) -> Argument

Adds a FundsWithdrawal input withdrawing amount of coin_type from the sender’s balance.

pub fn balance_from_sponsor( &mut self, amount: u64, coin_type: TypeTag, ) -> Argument

Adds a FundsWithdrawal input withdrawing amount of coin_type from the sponsor’s balance.

pub fn finish_address_balance( self, sender: Address, sponsor: Address, chain_identifier: Digest, nonce: u32, gas_price: u64, gas_budget: u64, current_epoch: u64, ) -> Transaction

Consumes the builder and wraps the resulting ProgrammableTransaction in a Transaction that pays gas from an address balance rather than from explicit gas coin objects.

sponsor is the address whose balance covers gas; pass the same value as sender for the common self-sponsored case.

The resulting transaction has:

• An empty gas_payment.objects list (balance-based payment)
• gas_payment.owner set to sponsor
• A TransactionExpiration::ValidDuring window of [current_epoch, current_epoch + 1] anchored to chain_identifier with the given nonce

impl ProgrammableTransactionBuilder

Extensions to the base API.

pub fn split_coins_into_vec( &mut self, coin: Argument, amounts: Vec<Argument>, ) -> Vec<Argument>

Like .command(Command::SplitCoins(coin_arg, balances)), but also takes care of unpacking each entry in the returned vector as its own Argument.

Panics

Panics if the balances input vector has a length that exceeds u16::MAX.

Trait Implementations

impl Clone for ProgrammableTransactionBuilder

fn clone(&self) -> ProgrammableTransactionBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgrammableTransactionBuilder

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

Formats the value using the given formatter.

impl Default for ProgrammableTransactionBuilder

fn default() -> ProgrammableTransactionBuilder

Returns the “default value” for a type.

impl From<ProgrammableTransactionBuilder> for ProgrammableTransaction

fn from(value: ProgrammableTransactionBuilder) -> Self

Converts to this type from the input type.

impl TryFrom<ProgrammableTransaction> for ProgrammableTransactionBuilder

type Error = Error

The type returned in the event of a conversion error.

fn try_from(_: ProgrammableTransaction) -> Result<Self>

Performs the conversion.