Struct sui_transaction_builder::TransactionBuilder

pub struct TransactionBuilder(/* private fields */);

Implementations

impl TransactionBuilder

pub fn new(data_reader: Arc<dyn DataReader + Sync + Send>) -> Self

pub async fn tx_data_for_dry_run( &self, sender: SuiAddress, kind: TransactionKind, gas_budget: u64, gas_price: u64, gas_payment: Option<Vec<ObjectID>>, gas_sponsor: Option<SuiAddress>, ) -> TransactionData

Construct the transaction data for a dry run

pub async fn tx_data( &self, sender: SuiAddress, kind: TransactionKind, gas_budget: u64, gas_price: u64, gas_payment: Vec<ObjectID>, gas_sponsor: Option<SuiAddress>, ) -> Result<TransactionData, Error>

Construct the transaction data from a transaction kind, and other parameters. If the gas_payment list is empty, it will pick the first gas coin that has at least the required gas budget that is not in the input coins.

pub async fn transfer_object_tx_kind( &self, object_id: ObjectID, recipient: SuiAddress, ) -> Result<TransactionKind, Error>

pub async fn transfer_object( &self, signer: SuiAddress, object_id: ObjectID, gas: Option<ObjectID>, gas_budget: u64, recipient: SuiAddress, ) -> Result<TransactionData>

pub fn transfer_sui_tx_kind( &self, recipient: SuiAddress, amount: Option<u64>, ) -> TransactionKind

pub async fn transfer_sui( &self, signer: SuiAddress, sui_object_id: ObjectID, gas_budget: u64, recipient: SuiAddress, amount: Option<u64>, ) -> Result<TransactionData>

pub async fn pay_tx_kind( &self, input_coins: Vec<ObjectID>, recipients: Vec<SuiAddress>, amounts: Vec<u64>, ) -> Result<TransactionKind, Error>

pub async fn pay( &self, signer: SuiAddress, input_coins: Vec<ObjectID>, recipients: Vec<SuiAddress>, amounts: Vec<u64>, gas: Option<ObjectID>, gas_budget: u64, ) -> Result<TransactionData>

pub async fn input_refs( &self, obj_ids: &[ObjectID], ) -> Result<Vec<ObjectRef>, Error>

Get the object references for a list of object IDs

pub fn pay_sui_tx_kind( &self, recipients: Vec<SuiAddress>, amounts: Vec<u64>, ) -> Result<TransactionKind, Error>

Construct a transaction kind for the PaySui transaction type

Use this function together with tx_data_for_dry_run or tx_data for maximum reusability

pub async fn pay_sui( &self, signer: SuiAddress, input_coins: Vec<ObjectID>, recipients: Vec<SuiAddress>, amounts: Vec<u64>, gas_budget: u64, ) -> Result<TransactionData>

pub fn pay_all_sui_tx_kind(&self, recipient: SuiAddress) -> TransactionKind

pub async fn pay_all_sui( &self, signer: SuiAddress, input_coins: Vec<ObjectID>, recipient: SuiAddress, gas_budget: u64, ) -> Result<TransactionData>

pub async fn move_call_tx_kind( &self, package_object_id: ObjectID, module: &str, function: &str, type_args: Vec<SuiTypeTag>, call_args: Vec<SuiJsonValue>, ) -> Result<TransactionKind, Error>

pub async fn move_call( &self, signer: SuiAddress, package_object_id: ObjectID, module: &str, function: &str, type_args: Vec<SuiTypeTag>, call_args: Vec<SuiJsonValue>, gas: Option<ObjectID>, gas_budget: u64, gas_price: Option<u64>, ) -> Result<TransactionData>

pub async fn single_move_call( &self, builder: &mut ProgrammableTransactionBuilder, package: ObjectID, module: &str, function: &str, type_args: Vec<SuiTypeTag>, call_args: Vec<SuiJsonValue>, ) -> Result<()>

pub async fn resolve_and_checks_json_args( &self, builder: &mut ProgrammableTransactionBuilder, package_id: ObjectID, module: &Identifier, function: &Identifier, type_args: &[TypeTag], json_args: Vec<SuiJsonValue>, ) -> Result<Vec<Argument>, Error>

pub async fn publish_tx_kind( &self, sender: SuiAddress, modules: Vec<Vec<u8>>, dep_ids: Vec<ObjectID>, ) -> Result<TransactionKind, Error>

pub async fn publish( &self, sender: SuiAddress, compiled_modules: Vec<Vec<u8>>, dep_ids: Vec<ObjectID>, gas: Option<ObjectID>, gas_budget: u64, ) -> Result<TransactionData>

pub async fn upgrade_tx_kind( &self, package_id: ObjectID, modules: Vec<Vec<u8>>, dep_ids: Vec<ObjectID>, upgrade_capability: ObjectID, upgrade_policy: u8, digest: Vec<u8>, ) -> Result<TransactionKind, Error>

pub async fn upgrade( &self, sender: SuiAddress, package_id: ObjectID, compiled_modules: Vec<Vec<u8>>, dep_ids: Vec<ObjectID>, upgrade_capability: ObjectID, upgrade_policy: u8, digest: Vec<u8>, gas: Option<ObjectID>, gas_budget: u64, ) -> Result<TransactionData>

pub async fn split_coin_tx_kind( &self, coin_object_id: ObjectID, split_amounts: Option<Vec<u64>>, split_count: Option<u64>, ) -> Result<TransactionKind, Error>

Construct a transaction kind for the SplitCoin transaction type It expects that only one of the two: split_amounts or split_count is provided If both are provided, it will use split_amounts.

pub async fn split_coin( &self, signer: SuiAddress, coin_object_id: ObjectID, split_amounts: Vec<u64>, gas: Option<ObjectID>, gas_budget: u64, ) -> Result<TransactionData>

pub async fn split_coin_equal( &self, signer: SuiAddress, coin_object_id: ObjectID, split_count: u64, gas: Option<ObjectID>, gas_budget: u64, ) -> Result<TransactionData>

pub async fn merge_coins_tx_kind( &self, primary_coin: ObjectID, coin_to_merge: ObjectID, ) -> Result<TransactionKind, Error>

pub async fn merge_coins( &self, signer: SuiAddress, primary_coin: ObjectID, coin_to_merge: ObjectID, gas: Option<ObjectID>, gas_budget: u64, ) -> Result<TransactionData>

pub async fn batch_transaction( &self, signer: SuiAddress, single_transaction_params: Vec<RPCTransactionRequestParams>, gas: Option<ObjectID>, gas_budget: u64, ) -> Result<TransactionData>

pub async fn request_add_stake( &self, signer: SuiAddress, coins: Vec<ObjectID>, amount: Option<u64>, validator: SuiAddress, gas: Option<ObjectID>, gas_budget: u64, ) -> Result<TransactionData>

pub async fn request_withdraw_stake( &self, signer: SuiAddress, staked_sui: ObjectID, gas: Option<ObjectID>, gas_budget: u64, ) -> Result<TransactionData>

pub async fn get_object_ref(&self, object_id: ObjectID) -> Result<ObjectRef>

Trait Implementations

impl Clone for TransactionBuilder

fn clone(&self) -> TransactionBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.