Trait polkadot_sdk_frame::traits::tokens::fungible::Inspect

pub trait Inspect<AccountId>: Sized {
    type Balance: Balance;

    // Required methods
    fn total_issuance() -> Self::Balance;
    fn minimum_balance() -> Self::Balance;
    fn total_balance(who: &AccountId) -> Self::Balance;
    fn balance(who: &AccountId) -> Self::Balance;
    fn reducible_balance(
        who: &AccountId,
        preservation: Preservation,
        force: Fortitude,
    ) -> Self::Balance;
    fn can_deposit(
        who: &AccountId,
        amount: Self::Balance,
        provenance: Provenance,
    ) -> DepositConsequence;
    fn can_withdraw(
        who: &AccountId,
        amount: Self::Balance,
    ) -> WithdrawConsequence<Self::Balance>;

    // Provided method
    fn active_issuance() -> Self::Balance { ... }
}

Expand description

Trait for providing balance-inspection access to a fungible asset.

Required Associated Types§

type Balance: Balance

Scalar type for representing balance of an account.

Required Methods§

fn total_issuance() -> Self::Balance

The total amount of issuance in the system.

fn minimum_balance() -> Self::Balance

The minimum balance any single account may have.

fn total_balance(who: &AccountId) -> Self::Balance

Get the total amount of funds whose ultimate beneficial ownership can be determined as who.

This may include funds which are wholly inaccessible to who, either temporarily or even indefinitely.

For the amount of the balance which is currently free to be removed from the account without error, use Inspect::reducible_balance.

For the amount of the balance which may eventually be free to be removed from the account, use balance().

fn balance(who: &AccountId) -> Self::Balance

Get the balance of who which does not include funds which are exclusively allocated to subsystems of the chain (“on hold” or “reserved”).

In general this isn’t especially useful outside of tests, and for practical purposes, you’ll want to use Inspect::reducible_balance.

fn reducible_balance( who: &AccountId, preservation: Preservation, force: Fortitude, ) -> Self::Balance

Get the maximum amount that who can withdraw/transfer successfully based on whether the account should be kept alive (preservation) or whether we are willing to force the reduction and potentially go below user-level restrictions on the minimum amount of the account.

Always less than or equal to Inspect::balance.

fn can_deposit( who: &AccountId, amount: Self::Balance, provenance: Provenance, ) -> DepositConsequence

Returns true if the balance of who may be increased by amount.

who: The account of which the balance should be increased by amount.
amount: How much should the balance be increased?
provenance: Will amount be minted to deposit it into account or is it already in the system?

fn can_withdraw( who: &AccountId, amount: Self::Balance, ) -> WithdrawConsequence<Self::Balance>

Returns Success if the balance of who may be decreased by amount, otherwise the consequence.

Provided Methods§

fn active_issuance() -> Self::Balance

The total amount of issuance in the system excluding those which are controlled by the system.

Object Safety§

This trait is not object safe.

Implementations on Foreign Types§

§

impl<AccountId> Inspect<AccountId> for ()

Dummy implementation of Inspect

§

fn reducible_balance( _: &AccountId, _: Preservation, _: Fortitude, ) -> <() as Inspect<AccountId>>::Balance

§

fn can_deposit( _: &AccountId, _: <() as Inspect<AccountId>>::Balance, _: Provenance, ) -> DepositConsequence

§

fn can_withdraw( _: &AccountId, _: <() as Inspect<AccountId>>::Balance, ) -> WithdrawConsequence<<() as Inspect<AccountId>>::Balance>

Implementors§

§

impl<F, A, AccountId> Inspect<AccountId> for ItemOf<F, A, AccountId>
where F: Inspect<AccountId>, A: Get<<F as Inspect<AccountId>>::AssetId>,

§

Trait polkadot_sdk_frame::traits::tokens::fungible::InspectCopy item path