Struct UtxoManager 

pub struct UtxoManager { /* private fields */ }

A struct to manage UTXOs of internal accounts used to pay fee, match transactions, and users predicate based accounts.

Implementations

impl UtxoManager

pub fn new() -> Self

pub fn len_per_address(&self, asset_id: AssetId, address: Address) -> usize

pub fn new_from_coins<I>(coins: I) -> Self

where I: Iterator<Item = FuelTxCoin>,

pub fn load_from_coins<I>(&mut self, coins: I)

where I: Iterator<Item = FuelTxCoin>,

pub fn guaranteed_extract_coins( &mut self, owner: Address, asset_id: AssetId, amount: u128, max_coins: usize, ) -> Result<Vec<FuelTxCoin>>

Extracts coins covering amount, returning at most max_coins.

Prefers old, untouched UTXOs first (FIFO). If FIFO cannot reach the target within the cap, it falls back to the largest coins, which pack the most value into the fewest inputs. Errors only when neither strategy can cover amount within max_coins.

pub fn number_of_coins_with_amount_greater_or_equal( &self, owner: Address, asset_id: AssetId, amount: u128, ) -> (u128, usize)

pub fn balance_of(&self, owner: Address, asset_id: AssetId) -> u128

pub fn coins(&self) -> HashMap<UtxoId, FuelTxCoin>

Returns all tracked coins keyed by their UtxoId.

pub fn coin_count(&self) -> usize

Returns the number of coins tracked.

pub fn utxo_ids(&self) -> Vec<UtxoId>

Returns the UtxoIds of all tracked coins.

pub fn contains(&self, utxo_id: &UtxoId) -> bool

Checks if a specific coin is tracked.

pub fn total_balance(&self, asset_id: &AssetId) -> u128

Returns the total balance for a given asset across all owners.

pub fn remove_coin(&mut self, utxo_id: &UtxoId) -> bool

Removes a specific coin by UtxoId. Returns true if it was found and removed.

pub fn extract_largest_coins( &mut self, owner: Address, asset_id: AssetId, max_value: u128, ) -> Vec<FuelTxCoin>

Extracts the largest coins for the given owner/asset up to max_value total, in descending order of amount. Used by coin management (split/drain), independently of the FIFO fee-paying path, so it re-sorts by amount rather than relying on the set’s insertion order. Returns the extracted coins (removed from the manager).

Trait Implementations

impl Default for UtxoManager

fn default() -> Self

Returns the “default value” for a type.

impl UtxoProvider for UtxoManager

fn balance_of(&self, owner: Address, asset_id: AssetId) -> u128

fn len_per_address(&self, asset_id: AssetId, address: Address) -> usize

fn guaranteed_extract_coins( &mut self, owner: Address, asset_id: AssetId, amount: u128, max_coins: usize, ) -> Result<Vec<FuelTxCoin>>

fn load_from_coins_vec(&mut self, coins: Vec<FuelTxCoin>)

fn number_of_coins_with_amount_greater_or_equal( &self, owner: Address, asset_id: AssetId, amount: u128, ) -> (u128, usize)

fn extract_largest_coins( &mut self, owner: Address, asset_id: AssetId, max_value: u128, ) -> Vec<FuelTxCoin>

fn coin_count(&self) -> usize

fn utxo_ids(&self) -> Vec<UtxoId>

fn remove_coin(&mut self, utxo_id: &UtxoId) -> bool

fn total_balance(&self, asset_id: &AssetId) -> u128