Struct polkadot_sdk_frame::traits::tokens::fungible::ItemOf

pub struct ItemOf<F, A, AccountId>(/* private fields */)
where
    F: Inspect<AccountId>,
    A: Get<<F as Inspect<AccountId>>::AssetId>;

Convert a fungibles trait implementation into a fungible trait implementation by identifying a single item.

Trait Implementations

impl<F, A, AccountId> Balanced<AccountId> for ItemOf<F, A, AccountId>

where F: Inspect<AccountId> + Unbalanced<AccountId> + Balanced<AccountId>, A: Get<<F as Inspect<AccountId>>::AssetId>,

type OnDropDebt = ConvertImbalanceDropHandler<AccountId, <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, <F as Inspect<AccountId>>::AssetId, A, <F as Balanced<AccountId>>::OnDropDebt>

The type for managing what happens when an instance of Debt is dropped without being used.

type OnDropCredit = ConvertImbalanceDropHandler<AccountId, <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, <F as Inspect<AccountId>>::AssetId, A, <F as Balanced<AccountId>>::OnDropCredit>

The type for managing what happens when an instance of Credit is dropped without being used.

fn deposit( who: &AccountId, value: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, precision: Precision, ) -> Result<Imbalance<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropDebt, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropCredit>, DispatchError>

Mints value into the account of who, creating it as needed.

fn issue( amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, ) -> Imbalance<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropCredit, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropDebt>

Increase the total issuance by amount and return the according imbalance. The imbalance will typically be used to increase an account by the same amount with e.g. Balanced::resolve.

fn pair( amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, ) -> Result<(Imbalance<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropDebt, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropCredit>, Imbalance<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropCredit, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropDebt>), DispatchError>

Produce a pair of imbalances that cancel each other out exactly.

fn rescind( amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, ) -> Imbalance<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropDebt, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropCredit>

Reduce the total issuance by amount and return the according imbalance. The imbalance will typically be used to reduce an account by the same amount with e.g. Balanced::settle.

fn resolve( who: &AccountId, credit: Imbalance<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropCredit, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropDebt>, ) -> Result<(), Imbalance<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropCredit, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropDebt>>

The balance of who is increased in order to counter credit. If the whole of credit cannot be countered, then nothing is changed and the original credit is returned in an Err.

fn settle( who: &AccountId, debt: Imbalance<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropDebt, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropCredit>, preservation: Preservation, ) -> Result<Imbalance<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropCredit, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropDebt>, Imbalance<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropDebt, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropCredit>>

The balance of who is decreased in order to counter debt. If the whole of debt cannot be countered, then nothing is changed and the original debt is returned in an Err.

fn withdraw( who: &AccountId, value: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, precision: Precision, preservation: Preservation, force: Fortitude, ) -> Result<Imbalance<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropCredit, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropDebt>, DispatchError>

Removes value balance from who account if possible.

fn done_rescind(_amount: Self::Balance)

fn done_issue(_amount: Self::Balance)

fn done_deposit(_who: &AccountId, _amount: Self::Balance)

fn done_withdraw(_who: &AccountId, _amount: Self::Balance)

impl<F, A, AccountId> Balanced<AccountId> for ItemOf<F, A, AccountId>

where F: Balanced<AccountId>, A: Get<<F as Inspect<AccountId>>::AssetId>,

fn slash( reason: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Reason, who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, ) -> (Imbalance<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropCredit, <ItemOf<F, A, AccountId> as Balanced<AccountId>>::OnDropDebt>, <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance)

Reduce the balance of some funds on hold in an account.

impl<F, A, AccountId> DoneSlash<<F as Inspect<AccountId>>::Reason, AccountId, <F as Inspect<AccountId>>::Balance> for ItemOf<F, A, AccountId>

where F: Balanced<AccountId>, A: Get<<F as Inspect<AccountId>>::AssetId>,

fn done_slash( reason: &<F as Inspect<AccountId>>::Reason, who: &AccountId, amount: <F as Inspect<AccountId>>::Balance, )

impl<F, A, AccountId> Inspect<AccountId> for ItemOf<F, A, AccountId>

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

type Balance = <F as Inspect<AccountId>>::Balance

Scalar type for representing balance of an account.

fn total_issuance() -> <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance

The total amount of issuance in the system.

fn active_issuance() -> <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance

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

fn minimum_balance() -> <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance

The minimum balance any single account may have.

fn balance( who: &AccountId, ) -> <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance

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

fn total_balance( who: &AccountId, ) -> <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance

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

fn reducible_balance( who: &AccountId, preservation: Preservation, force: Fortitude, ) -> <ItemOf<F, A, AccountId> as Inspect<AccountId>>::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.

fn can_deposit( who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, provenance: Provenance, ) -> DepositConsequence

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

fn can_withdraw( who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, ) -> WithdrawConsequence<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance>

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

impl<F, A, AccountId> Inspect<AccountId> for ItemOf<F, A, AccountId>

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

type Id = <F as Inspect<AccountId>>::Id

An identifier for a freeze.

fn balance_frozen( id: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Id, who: &AccountId, ) -> <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance

Amount of funds frozen in reserve by who for the given id.

fn balance_freezable( who: &AccountId, ) -> <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance

The amount of the balance which can become frozen. Defaults to total_balance().

fn can_freeze( id: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Id, who: &AccountId, ) -> bool

Returns true if it’s possible to introduce a freeze for the given id onto the account of who. This will be true as long as the implementor supports as many concurrent freezes as there are possible values of id.

impl<F, A, AccountId> Inspect<AccountId> for ItemOf<F, A, AccountId>

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

type Reason = <F as Inspect<AccountId>>::Reason

An identifier for a hold. Used for disambiguating different holds so that they can be individually replaced or removed and funds from one hold don’t accidentally become unreserved or slashed for another.

fn reducible_total_balance_on_hold( who: &AccountId, force: Fortitude, ) -> <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance

Get the maximum amount that the total_balance_on_hold of who can be reduced successfully based on whether we are willing to force the reduction and potentially go below user-level restrictions on the minimum amount of the account. Note: This cannot bring the account into an inconsistent state with regards any required existential deposit.

fn hold_available( reason: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Reason, who: &AccountId, ) -> bool

Returns true if it’s possible to place (additional) funds under a hold of a given reason. This may fail if the account has exhausted a limited number of concurrent holds or if it cannot be made to exist (e.g. there is no provider reference).

fn total_balance_on_hold( who: &AccountId, ) -> <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance

Amount of funds on hold (for all hold reasons) of who.

fn balance_on_hold( reason: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Reason, who: &AccountId, ) -> <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance

Amount of funds on hold (for the given reason) of who.

fn can_hold( reason: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Reason, who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, ) -> bool

Check to see if some amount of funds of who may be placed on hold for the given reason. Reasons why this may not be true:

fn ensure_can_hold( reason: &Self::Reason, who: &AccountId, amount: Self::Balance, ) -> Result<(), DispatchError>

Check to see if some amount of funds of who may be placed on hold with the given reason. Reasons why this may not be true:

impl<F, A, AccountId> Mutate<AccountId> for ItemOf<F, A, AccountId>

where F: Mutate<AccountId>, A: Get<<F as Inspect<AccountId>>::AssetId>, AccountId: Eq,

fn mint_into( who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, ) -> Result<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, DispatchError>

Increase the balance of who by exactly amount, minting new tokens. If that isn’t possible then an Err is returned and nothing is changed.

fn burn_from( who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, preservation: Preservation, precision: Precision, force: Fortitude, ) -> Result<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, DispatchError>

Attempt to decrease the balance of who, burning the tokens. The actual amount burned is derived from the amount, preservation, precision and force, and might end up being more, less or equal to the amount specified.

fn shelve( who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, ) -> Result<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, DispatchError>

Attempt to decrease the asset balance of who by amount.

fn restore( who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, ) -> Result<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, DispatchError>

Attempt to increase the asset balance of who by amount.

fn transfer( source: &AccountId, dest: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, preservation: Preservation, ) -> Result<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, DispatchError>

Transfer funds from one account into another.

fn set_balance( who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, ) -> <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance

Simple infallible function to force an account to have a particular balance, good for use in tests and benchmarks but not recommended for production code owing to the lack of error reporting.

fn done_mint_into(_who: &AccountId, _amount: Self::Balance)

fn done_burn_from(_who: &AccountId, _amount: Self::Balance)

fn done_shelve(_who: &AccountId, _amount: Self::Balance)

fn done_restore(_who: &AccountId, _amount: Self::Balance)

fn done_transfer(_source: &AccountId, _dest: &AccountId, _amount: Self::Balance)

impl<F, A, AccountId> Mutate<AccountId> for ItemOf<F, A, AccountId>

where F: Mutate<AccountId>, A: Get<<F as Inspect<AccountId>>::AssetId>,

fn set_freeze( id: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Id, who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, ) -> Result<(), DispatchError>

Prevent actions which would reduce the balance of the account of who below the given amount and identify this restriction though the given id. Unlike extend_freeze, any outstanding freeze in place for who under the id are dropped.

fn extend_freeze( id: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Id, who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, ) -> Result<(), DispatchError>

Prevent the balance of the account of who from being reduced below the given amount and identify this restriction though the given id. Unlike set_freeze, this does not counteract any pre-existing freezes in place for who under the id. Also unlike set_freeze, in the case that amount is zero, this is no-op and never fails.

fn thaw( id: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Id, who: &AccountId, ) -> Result<(), DispatchError>

Remove an existing freeze.

fn set_frozen( id: &Self::Id, who: &AccountId, amount: Self::Balance, fortitude: Fortitude, ) -> Result<(), DispatchError>

Attempt to alter the amount frozen under the given id to amount.

fn ensure_frozen( id: &Self::Id, who: &AccountId, amount: Self::Balance, fortitude: Fortitude, ) -> Result<(), DispatchError>

Attempt to set the amount frozen under the given id to amount, iff this would increase the amount frozen under id. Do nothing otherwise.

fn decrease_frozen( id: &Self::Id, who: &AccountId, amount: Self::Balance, ) -> Result<(), DispatchError>

Decrease the amount which is being frozen for a particular freeze, failing in the case of underflow.

fn increase_frozen( id: &Self::Id, who: &AccountId, amount: Self::Balance, ) -> Result<(), DispatchError>

Increase the amount which is being frozen for a particular freeze, failing in the case that too little balance is available for being frozen.

impl<F, A, AccountId> Mutate<AccountId> for ItemOf<F, A, AccountId>

where F: Mutate<AccountId>, A: Get<<F as Inspect<AccountId>>::AssetId>,

fn hold( reason: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Reason, who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, ) -> Result<(), DispatchError>

Hold some funds in an account. If a hold for reason is already in place, then this will increase it.

fn release( reason: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Reason, who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, precision: Precision, ) -> Result<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, DispatchError>

Release up to amount held funds in an account.

fn burn_held( reason: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Reason, who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, precision: Precision, force: Fortitude, ) -> Result<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, DispatchError>

Attempt to decrease the balance of who which is held for the given reason by amount.

fn transfer_on_hold( reason: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Reason, source: &AccountId, dest: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, precision: Precision, mode: Restriction, force: Fortitude, ) -> Result<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, DispatchError>

Transfer held funds into a destination account.

fn transfer_and_hold( reason: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Reason, source: &AccountId, dest: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, precision: Precision, preservation: Preservation, force: Fortitude, ) -> Result<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, DispatchError>

Transfer some amount of free balance from source to become owned by dest but on hold for reason.

fn set_on_hold( reason: &Self::Reason, who: &AccountId, amount: Self::Balance, ) -> Result<(), DispatchError>

Hold or release funds in the account of who to bring the balance on hold for reason to exactly amount.

fn release_all( reason: &Self::Reason, who: &AccountId, precision: Precision, ) -> Result<Self::Balance, DispatchError>

Release all funds in the account of who on hold for reason.

fn burn_all_held( reason: &Self::Reason, who: &AccountId, precision: Precision, force: Fortitude, ) -> Result<Self::Balance, DispatchError>

Attempt to decrease the balance of who which is held for the given reason to zero.

fn done_hold(_reason: &Self::Reason, _who: &AccountId, _amount: Self::Balance)

fn done_release( _reason: &Self::Reason, _who: &AccountId, _amount: Self::Balance, )

fn done_burn_held( _reason: &Self::Reason, _who: &AccountId, _amount: Self::Balance, )

fn done_transfer_on_hold( _reason: &Self::Reason, _source: &AccountId, _dest: &AccountId, _amount: Self::Balance, )

fn done_transfer_and_hold( _reason: &Self::Reason, _source: &AccountId, _dest: &AccountId, _transferred: Self::Balance, )

impl<F, A, AccountId> Unbalanced<AccountId> for ItemOf<F, A, AccountId>

where F: Unbalanced<AccountId>, A: Get<<F as Inspect<AccountId>>::AssetId>,

fn handle_dust(dust: Dust<AccountId, ItemOf<F, A, AccountId>>)

where ItemOf<F, A, AccountId>: Sized,

Do something with the dust which has been destroyed from the system. Dust can be converted into a Credit with the Balanced trait impl.

fn write_balance( who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, ) -> Result<Option<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance>, DispatchError>

Forcefully set the balance of who to amount.

fn set_total_issuance( amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, )

Set the total issuance to amount.

fn decrease_balance( who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, precision: Precision, preservation: Preservation, force: Fortitude, ) -> Result<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, DispatchError>

Reduce the balance of who by amount.

fn increase_balance( who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, precision: Precision, ) -> Result<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, DispatchError>

Increase the balance of who by amount.

fn handle_raw_dust(amount: Self::Balance)

Create some dust and handle it with Unbalanced::handle_dust. This is an unbalanced operation and it must only be used when an account is modified in a raw fashion, outside of the entire fungibles API. The amount is capped at Inspect::minimum_balance() - 1`.

fn deactivate(_: Self::Balance)

Reduce the active issuance by some amount.

fn reactivate(_: Self::Balance)

Increase the active issuance by some amount, up to the outstanding amount reduced.

impl<F, A, AccountId> Unbalanced<AccountId> for ItemOf<F, A, AccountId>

where F: Unbalanced<AccountId>, A: Get<<F as Inspect<AccountId>>::AssetId>,

fn set_balance_on_hold( reason: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Reason, who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, ) -> Result<(), DispatchError>

Forcefully set the balance on hold of who to amount. This is independent of any other balances on hold or the main (“free”) balance.

fn decrease_balance_on_hold( reason: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Reason, who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, precision: Precision, ) -> Result<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, DispatchError>

Reduce the balance on hold of who by amount.

fn increase_balance_on_hold( reason: &<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Reason, who: &AccountId, amount: <ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, precision: Precision, ) -> Result<<ItemOf<F, A, AccountId> as Inspect<AccountId>>::Balance, DispatchError>

Increase the balance on hold of who by amount.