Struct Balance 

pub struct Balance { /* private fields */ }

Available on crate feature intents only.

An intent requesting a Balance<T> of a specific type and amount.

When resolved via TransactionBuilder::build, the resolver prefers withdrawing directly from the sender’s address balance when possible, falling back to coin selection and conversion when necessary.

Examples

use sui_transaction_builder::intent::Balance;

// Request 1 SUI as a Balance<SUI>
let bal = Balance::sui(1_000_000_000);

// Request a custom type
use sui_sdk_types::StructTag;
let bal = Balance::new(
    "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC"
        .parse()
        .unwrap(),
    1_000_000,
);

Implementations

impl Balance

pub fn new(coin_type: StructTag, balance: u64) -> Self

Create a new Balance intent for the given coin type and amount (in base units).

use sui_sdk_types::StructTag;
use sui_transaction_builder::intent::Balance;

let bal = Balance::new(StructTag::sui(), 1_000_000_000);

pub fn sui(balance: u64) -> Self

Shorthand for requesting a SUI balance with the given amount.

By default the resolver will draw from the gas coin when falling back to the merge-and-split path. Call with_use_gas_coin(false) to opt out.

use sui_transaction_builder::intent::Balance;

let one_sui = Balance::sui(1_000_000_000);

pub fn with_use_gas_coin(self, use_gas_coin: bool) -> Self

Control whether the resolver should draw from the gas coin when the merge-and-split path is used.

This is only meaningful when the coin type is SUI. Pass false to force the resolver to select non-gas SUI coins instead.

use sui_transaction_builder::intent::Balance;

let bal = Balance::sui(1_000_000_000).with_use_gas_coin(false);