Struct iota_transaction_builder :: TransactionBuilder Copy item path

impl TransactionBuilder

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

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

Construct the transaction data for a dry run

pub async fn tx_data( &self, sender: IotaAddress, kind: TransactionKind, gas_budget: u64, gas_price: u64, gas_payment: Vec<ObjectID>, gas_sponsor: impl Into<Option<IotaAddress>>, ) -> 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: IotaAddress, ) -> Result<TransactionKind, Error>

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

Transfer an object to the specified recipient address.

pub fn transfer_iota_tx_kind( &self, recipient: IotaAddress, amount: impl Into<Option<u64>>, ) -> TransactionKind

pub async fn transfer_iota( &self, signer: IotaAddress, iota_object_id: ObjectID, gas_budget: u64, recipient: IotaAddress, amount: impl Into<Option<u64>>, ) -> Result<TransactionData>

Transfer IOTA from the provided coin object to the recipient address. The provided coin object is also used for the gas payment.

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

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

Take multiple coins and send to multiple addresses following the specified amount list. The length of the vectors must be the same. Take any type of coin, including IOTA. A separate IOTA object will be used for gas payment.

If the recipient and sender are the same, it’s effectively a generalized version of split_coin and merge_coin.

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_iota_tx_kind( &self, recipients: Vec<IotaAddress>, amounts: Vec<u64>, ) -> Result<TransactionKind, Error>

Construct a transaction kind for the PayIota transaction type.

Use this function together with tx_data_for_dry_run or tx_data for maximum reusability. The length of the vectors must be the same.

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

Take multiple IOTA coins and send to multiple addresses following the specified amount list. The length of the vectors must be the same. Only takes IOTA coins and does not require a gas coin object.

The first IOTA coin object input will be used for gas payment, so the balance of this IOTA coin has to be equal to or greater than the gas budget. The total IOTA coin balance input must be sufficient to cover both the gas budget and the amounts to be transferred.

pub fn pay_all_iota_tx_kind(&self, recipient: IotaAddress) -> TransactionKind

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

Take multiple IOTA coins and send them to one recipient, after gas payment deduction. After the transaction, strictly zero of the IOTA coins input will be left under the sender’s address.

The first IOTA coin object input will be used for gas payment, so the balance of this IOTA coin has to be equal or greater than the gas budget. A sender can transfer all their IOTA coins to another address with strictly zero IOTA left in one transaction via this transaction type.

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

pub async fn move_call( &self, signer: IotaAddress, package_object_id: ObjectID, module: &str, function: &str, type_args: Vec<IotaTypeTag>, call_args: Vec<IotaJsonValue>, gas: impl Into<Option<ObjectID>>, gas_budget: u64, gas_price: impl Into<Option<u64>>, ) -> Result<TransactionData>

Call a move function from a published package.

pub async fn single_move_call( &self, builder: &mut ProgrammableTransactionBuilder, package: ObjectID, module: &str, function: &str, type_args: Vec<IotaTypeTag>, call_args: Vec<IotaJsonValue>, ) -> 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<IotaJsonValue>, ) -> Result<Vec<Argument>, Error>

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

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

Publish a new move package.

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: IotaAddress, package_id: ObjectID, compiled_modules: Vec<Vec<u8>>, dep_ids: Vec<ObjectID>, upgrade_capability: ObjectID, upgrade_policy: u8, gas: impl Into<Option<ObjectID>>, gas_budget: u64, ) -> Result<TransactionData>

Upgrade an existing move package.

pub async fn split_coin_tx_kind( &self, coin_object_id: ObjectID, split_amounts: impl Into<Option<Vec<u64>>>, split_count: impl Into<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: IotaAddress, coin_object_id: ObjectID, split_amounts: Vec<u64>, gas: impl Into<Option<ObjectID>>, gas_budget: u64, ) -> Result<TransactionData>

pub async fn split_coin_equal( &self, signer: IotaAddress, coin_object_id: ObjectID, split_count: u64, gas: impl Into<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: IotaAddress, primary_coin: ObjectID, coin_to_merge: ObjectID, gas: impl Into<Option<ObjectID>>, gas_budget: u64, ) -> Result<TransactionData>

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

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

Add stake to a validator’s staking pool using multiple IOTA coins.

pub async fn request_withdraw_stake( &self, signer: IotaAddress, staked_iota: ObjectID, gas: impl Into<Option<ObjectID>>, gas_budget: u64, ) -> Result<TransactionData>

Withdraw stake from a validator’s staking pool.

pub async fn request_add_timelocked_stake( &self, signer: IotaAddress, locked_balance: ObjectID, validator: IotaAddress, gas: ObjectID, gas_budget: u64, ) -> Result<TransactionData>

Add stake to a validator’s staking pool using a timelocked IOTA coin.

pub async fn request_withdraw_timelocked_stake( &self, signer: IotaAddress, timelocked_staked_iota: ObjectID, gas: ObjectID, gas_budget: u64, ) -> Result<TransactionData>

Withdraw timelocked stake from a validator’s staking pool.

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. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

impl !UnwindSafe for TransactionBuilder

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl As for U

fn as_<T>(self) -> T
where T: CastFrom,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_:: can be used in the same way as T as U for numeric conversions. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> ConvertTo<T> for T
where T: Send,

fn convert(self) -> Result<T, Error>

fn convert_unchecked(self) -> T

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a Request

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more