Struct TransactionBuilder 

pub struct TransactionBuilder { /* private fields */ }

A builder for creating transactions. Use resolve to finalize the transaction data.

Implementations

impl TransactionBuilder

pub fn new() -> Self

Create a new transaction builder and initialize its elements to default.

pub fn gas(&mut self) -> Argument

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

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

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

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

pub fn object(&mut self, object: ObjectInput) -> Argument

pub fn add_gas_objects<O, I>(&mut self, gas: I)

where O: Into<ObjectInput>, I: IntoIterator<Item = O>,

Add one or more gas objects to use to pay for the transaction.

pub fn set_gas_budget(&mut self, budget: u64)

Set the gas budget for the transaction.

pub fn set_gas_price(&mut self, price: u64)

Set the gas price for the transaction.

pub fn set_sender(&mut self, sender: Address)

Set the sender of the transaction.

pub fn set_sponsor(&mut self, sponsor: Address)

Set the sponsor of the transaction.

pub fn set_expiration(&mut self, expiration: TransactionExpiration)

Set the expiration of the transaction.

pub fn move_call( &mut self, function: Function, arguments: Vec<Argument>, ) -> Argument

Call a Move function with the given arguments.

• function is a structured representation of a package::module::function argument, optionally with type arguments.

pub fn transfer_objects(&mut self, objects: Vec<Argument>, address: Argument)

Transfer a list of objects to the given address, without producing any result.

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

Split a coin by the provided amounts, returning multiple results (as many as there are amounts). The returned vector of Arguments is guaranteed to be the same length as the provided amounts vector.

pub fn merge_coins(&mut self, coin: Argument, coins_to_merge: Vec<Argument>)

Merge a list of coins into a single coin, without producing any result.

pub fn make_move_vec( &mut self, type_: Option<TypeTag>, elements: Vec<Argument>, ) -> Argument

Make a move vector from a list of elements. If the elements are not objects, or the vector is empty, a type must be supplied. It returns the Move vector as an argument, that can be used in subsequent commands.

pub fn publish( &mut self, modules: Vec<Vec<u8>>, dependencies: Vec<Address>, ) -> Argument

Publish a list of modules with the given dependencies. The result is the 0x2::package::UpgradeCap Move type. Note that the upgrade capability needs to be handled after this call:

• transfer it to the transaction sender or another address
• burn it
• wrap it for access control
• discard the it to make a package immutable

The arguments required for this command are:

• modules: is the modules’ bytecode to be published
• dependencies: is the list of IDs of the transitive dependencies of the package

pub fn upgrade( &mut self, modules: Vec<Vec<u8>>, dependencies: Vec<Address>, package: Address, ticket: Argument, ) -> Argument

Upgrade a Move package.

• modules: is the modules’ bytecode for the modules to be published
• dependencies: is the list of IDs of the transitive dependencies of the package to be upgraded
• package: is the ID of the current package being upgraded
• ticket: is the upgrade ticket

To get the ticket, you have to call the 0x2::package::authorize_upgrade function, and pass the package ID, the upgrade policy, and package digest.

pub fn intent<I: Intent>(&mut self, intent: I) -> Argument

Available on crate feature intents only.

pub fn try_build(self) -> Result<Transaction, Error>

Assuming everything is resolved, convert this transaction into the resolved form. Returns a [Transaction] if successful, or an Error if not.

pub async fn build(self, client: &mut Client) -> Result<Transaction, Error>

Available on crate feature intents only.

Trait Implementations

impl Default for TransactionBuilder

fn default() -> TransactionBuilder

Returns the “default value” for a type.