Struct CurrencyAdapter 

pub struct CurrencyAdapter<T, GetCurrencyId>(/* private fields */);

Trait Implementations

impl<T, GetCurrencyId> Currency<<T as Config>::AccountId> for CurrencyAdapter<T, GetCurrencyId>

where T: Config, GetCurrencyId: Get<T::CurrencyId>,

fn deposit_into_existing( who: &T::AccountId, value: Self::Balance, ) -> Result<Self::PositiveImbalance, DispatchError>

Deposit some value into the free balance of an existing target account who.

fn deposit_creating( who: &T::AccountId, value: Self::Balance, ) -> Self::PositiveImbalance

Deposit some value into the free balance of who, possibly creating a new account.

type Balance = <T as Config>::Balance

The balance of an account.

type PositiveImbalance = PositiveImbalance<T, GetCurrencyId>

The opaque token type for an imbalance. This is returned by unbalanced operations and must be dealt with. It may be dropped but cannot be cloned.

type NegativeImbalance = NegativeImbalance<T, GetCurrencyId>

The opaque token type for an imbalance. This is returned by unbalanced operations and must be dealt with. It may be dropped but cannot be cloned.

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

The combined balance of who.

fn can_slash(who: &T::AccountId, value: Self::Balance) -> bool

Same result as slash(who, value) (but without the side-effects) assuming there are no balance changes in the meantime and only the reserved balance is not taken into account.

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. This is equivalent to the Balances module’s ExistentialDeposit.

fn burn(amount: Self::Balance) -> Self::PositiveImbalance

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. settle.

fn issue(amount: Self::Balance) -> Self::NegativeImbalance

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. resolve_into_existing or resolve_creating.

fn free_balance(who: &T::AccountId) -> Self::Balance

The ‘free’ balance of a given account.

fn ensure_can_withdraw( who: &T::AccountId, amount: Self::Balance, _reasons: WithdrawReasons, _new_balance: Self::Balance, ) -> DispatchResult

Returns Ok iff the account is able to make a withdrawal of the given amount for the given reason. Basically, it’s just a dry-run of withdraw.

fn transfer( source: &T::AccountId, dest: &T::AccountId, value: Self::Balance, existence_requirement: ExistenceRequirement, ) -> DispatchResult

Transfer some liquid free balance to another staker.

fn slash( who: &T::AccountId, value: Self::Balance, ) -> (Self::NegativeImbalance, Self::Balance)

Deducts up to value from the combined balance of who, preferring to deduct from the free balance. This function cannot fail.

fn withdraw( who: &T::AccountId, value: Self::Balance, _reasons: WithdrawReasons, liveness: ExistenceRequirement, ) -> Result<Self::NegativeImbalance, DispatchError>

Removes some free balance from who account for reason if possible. If liveness is KeepAlive, then no less than ExistentialDeposit must be left remaining.

fn make_free_balance_be( who: &T::AccountId, value: Self::Balance, ) -> SignedImbalance<Self::Balance, Self::PositiveImbalance>

Ensure an account’s free balance equals some value; this will create the account if needed.

fn active_issuance() -> Self::Balance

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

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.

fn pair( amount: Self::Balance, ) -> (Self::PositiveImbalance, Self::NegativeImbalance)

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

fn resolve_into_existing( who: &AccountId, value: Self::NegativeImbalance, ) -> Result<(), Self::NegativeImbalance>

Similar to deposit_creating, only accepts a NegativeImbalance and returns nothing on success.

fn resolve_creating(who: &AccountId, value: Self::NegativeImbalance)

Similar to deposit_creating, only accepts a NegativeImbalance and returns nothing on success.

fn settle( who: &AccountId, value: Self::PositiveImbalance, reasons: WithdrawReasons, liveness: ExistenceRequirement, ) -> Result<(), Self::PositiveImbalance>

Similar to withdraw, only accepts a PositiveImbalance and returns nothing on success.

impl<T, GetCurrencyId> Inspect<<T as Config>::AccountId> for CurrencyAdapter<T, GetCurrencyId>

where T: Config, GetCurrencyId: Get<T::CurrencyId>,

type Balance = <T as Config>::Balance

Scalar type for representing balance of an account.

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 balance(who: &T::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”).

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

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

fn reducible_balance( who: &T::AccountId, preservation: Preservation, fortitude: 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.

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

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

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

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

fn active_issuance() -> Self::Balance

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

impl<T, GetCurrencyId> Inspect<<T as Config>::AccountId> for CurrencyAdapter<T, GetCurrencyId>

where T: Config, GetCurrencyId: Get<T::CurrencyId>,

type Reason = <Pallet<T> as Inspect<<T as Config>::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 balance_on_hold(reason: &Self::Reason, who: &T::AccountId) -> T::Balance

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

fn total_balance_on_hold(who: &T::AccountId) -> Self::Balance

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

fn reducible_total_balance_on_hold( who: &T::AccountId, force: Fortitude, ) -> Self::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: &Self::Reason, who: &T::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 can_hold( reason: &Self::Reason, who: &T::AccountId, amount: T::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<T, GetCurrencyId> LockableCurrency<<T as Config>::AccountId> for CurrencyAdapter<T, GetCurrencyId>

where T: Config, GetCurrencyId: Get<T::CurrencyId>,

type Moment = <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

The quantity used to denote time; usually just a BlockNumber.

type MaxLocks = ()

The maximum number of locks a user should have on their account.

fn set_lock( id: LockIdentifier, who: &T::AccountId, amount: Self::Balance, _reasons: WithdrawReasons, )

Create a new balance lock on account who.

fn extend_lock( id: LockIdentifier, who: &T::AccountId, amount: Self::Balance, _reasons: WithdrawReasons, )

Changes a balance lock (selected by id) so that it becomes less liquid in all parameters or creates a new one if it does not exist.

fn remove_lock(id: LockIdentifier, who: &T::AccountId)

Remove an existing lock.

impl<T, GetCurrencyId> Mutate<<T as Config>::AccountId> for CurrencyAdapter<T, GetCurrencyId>

where T: Config, GetCurrencyId: Get<T::CurrencyId>,

fn mint_into( who: &T::AccountId, amount: Self::Balance, ) -> Result<Self::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: &T::AccountId, amount: Self::Balance, preservation: Preservation, precision: Precision, fortitude: Fortitude, ) -> Result<Self::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 transfer( source: &T::AccountId, dest: &T::AccountId, amount: T::Balance, preservation: Preservation, ) -> Result<T::Balance, DispatchError>

Transfer funds from one account into another.

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

Attempt to decrease the asset balance of who by amount.

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

Attempt to increase the asset balance of who by amount.

fn set_balance(who: &AccountId, amount: Self::Balance) -> Self::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<T, GetCurrencyId> Mutate<<T as Config>::AccountId> for CurrencyAdapter<T, GetCurrencyId>

where T: Config, GetCurrencyId: Get<T::CurrencyId>,

fn hold( reason: &<Self as InspectHold<<T as Config>::AccountId>>::Reason, who: &T::AccountId, amount: Self::Balance, ) -> DispatchResult

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

fn release( reason: &<Self as InspectHold<<T as Config>::AccountId>>::Reason, who: &T::AccountId, amount: Self::Balance, precision: Precision, ) -> Result<T::Balance, DispatchError>

Release up to amount held funds in an account.

fn transfer_on_hold( reason: &<Self as InspectHold<<T as Config>::AccountId>>::Reason, source: &T::AccountId, dest: &T::AccountId, amount: Self::Balance, precision: Precision, restriction: Restriction, fortitude: Fortitude, ) -> Result<Self::Balance, DispatchError>

Transfer held funds into a destination account.

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_held( reason: &Self::Reason, who: &AccountId, amount: Self::Balance, precision: Precision, force: Fortitude, ) -> Result<Self::Balance, DispatchError>

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

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 transfer_and_hold( reason: &Self::Reason, source: &AccountId, dest: &AccountId, amount: Self::Balance, precision: Precision, expendability: Preservation, force: Fortitude, ) -> Result<Self::Balance, DispatchError>

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

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<T, GetCurrencyId> NamedReservableCurrency<<T as Config>::AccountId> for CurrencyAdapter<T, GetCurrencyId>

where T: Config, GetCurrencyId: Get<T::CurrencyId>,

type ReserveIdentifier = <T as Config>::ReserveIdentifier

An identifier for a reserve. Used for disambiguating different reserves so that they can be individually replaced or removed.

fn reserved_balance_named( id: &Self::ReserveIdentifier, who: &T::AccountId, ) -> Self::Balance

The amount of the balance of a given account that is externally reserved; this can still get slashed, but gets slashed last of all.

fn reserve_named( id: &Self::ReserveIdentifier, who: &T::AccountId, value: Self::Balance, ) -> DispatchResult

Moves value from balance to reserved balance.

fn unreserve_named( id: &Self::ReserveIdentifier, who: &T::AccountId, value: Self::Balance, ) -> Self::Balance

Moves up to value from reserved balance to free balance. This function cannot fail.

fn slash_reserved_named( id: &Self::ReserveIdentifier, who: &T::AccountId, value: Self::Balance, ) -> (Self::NegativeImbalance, Self::Balance)

Deducts up to value from reserved balance of who. This function cannot fail.

fn repatriate_reserved_named( id: &Self::ReserveIdentifier, slashed: &T::AccountId, beneficiary: &T::AccountId, value: Self::Balance, status: Status, ) -> Result<Self::Balance, DispatchError>

Moves up to value from reserved balance of account slashed to balance of account beneficiary. beneficiary must exist for this to succeed. If it does not, Err will be returned. Funds will be placed in either the free balance or the reserved balance, depending on the status.

fn ensure_reserved_named( id: &Self::ReserveIdentifier, who: &AccountId, value: Self::Balance, ) -> Result<(), DispatchError>

Ensure the reserved balance is equal to value.

fn unreserve_all_named( id: &Self::ReserveIdentifier, who: &AccountId, ) -> Self::Balance

Unreserve all the named reserved balances, returning unreserved amount.

fn slash_all_reserved_named( id: &Self::ReserveIdentifier, who: &AccountId, ) -> Self::NegativeImbalance

Slash all the reserved balance, returning the negative imbalance created.

fn repatriate_all_reserved_named( id: &Self::ReserveIdentifier, slashed: &AccountId, beneficiary: &AccountId, status: BalanceStatus, ) -> Result<(), DispatchError>

Move all the named reserved balance of one account into the balance of another, according to status. If status is Reserved, the balance will be reserved with given id.

impl<T, GetCurrencyId> ReservableCurrency<<T as Config>::AccountId> for CurrencyAdapter<T, GetCurrencyId>

where T: Config, GetCurrencyId: Get<T::CurrencyId>,

fn can_reserve(who: &T::AccountId, value: Self::Balance) -> bool

Same result as reserve(who, value) (but without the side-effects) assuming there are no balance changes in the meantime.

fn slash_reserved( who: &T::AccountId, value: Self::Balance, ) -> (Self::NegativeImbalance, Self::Balance)

Deducts up to value from reserved balance of who. This function cannot fail.

fn reserved_balance(who: &T::AccountId) -> Self::Balance

The amount of the balance of a given account that is externally reserved; this can still get slashed, but gets slashed last of all.

fn reserve(who: &T::AccountId, value: Self::Balance) -> DispatchResult

Moves value from balance to reserved balance.

fn unreserve(who: &T::AccountId, value: Self::Balance) -> Self::Balance

Moves up to value from reserved balance to free balance. This function cannot fail.

fn repatriate_reserved( slashed: &T::AccountId, beneficiary: &T::AccountId, value: Self::Balance, status: Status, ) -> Result<Self::Balance, DispatchError>

Moves up to value from reserved balance of account slashed to balance of account beneficiary. beneficiary must exist for this to succeed. If it does not, Err will be returned. Funds will be placed in either the free balance or the reserved balance, depending on the status.

impl<T, GetCurrencyId> Unbalanced<<T as Config>::AccountId> for CurrencyAdapter<T, GetCurrencyId>

where T: Config, GetCurrencyId: Get<T::CurrencyId>,

fn handle_dust(_dust: Dust<T::AccountId, Self>)

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: &T::AccountId, amount: Self::Balance, ) -> Result<Option<Self::Balance>, DispatchError>

Forcefully set the balance of who to amount.

fn set_total_issuance(amount: Self::Balance)

Set the total issuance to 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 decrease_balance( who: &AccountId, amount: Self::Balance, precision: Precision, preservation: Preservation, force: Fortitude, ) -> Result<Self::Balance, DispatchError>

Reduce the balance of who by amount.

fn increase_balance( who: &AccountId, amount: Self::Balance, precision: Precision, ) -> Result<Self::Balance, DispatchError>

Increase the balance of who by amount.

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<T, GetCurrencyId> Unbalanced<<T as Config>::AccountId> for CurrencyAdapter<T, GetCurrencyId>

where T: Config, GetCurrencyId: Get<T::CurrencyId>,

fn set_balance_on_hold( reason: &Self::Reason, who: &T::AccountId, amount: Self::Balance, ) -> DispatchResult

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: &Self::Reason, who: &AccountId, amount: Self::Balance, precision: Precision, ) -> Result<Self::Balance, DispatchError>

Reduce the balance on hold of who by amount.

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

Increase the balance on hold of who by amount.