Struct orml_tokens::CurrencyAdapter

pub struct CurrencyAdapter<T, GetCurrencyId>(_);

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

fn reducible_balance(who: &T::AccountId, keep_alive: bool) -> Self::Balance

Get the maximum amount that who can withdraw/transfer successfully.

fn can_deposit(
    who: &T::AccountId,
    amount: Self::Balance,
    mint: bool
) -> 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 Failed if the balance of who may not be decreased by amount, otherwise the consequence.

impl<T, GetCurrencyId> InspectHold<<T as Config>::AccountId> for CurrencyAdapter<T, GetCurrencyId>where
    T: Config,
    GetCurrencyId: Get<T::CurrencyId>,

fn balance_on_hold(who: &T::AccountId) -> T::Balance

Amount of funds held in reserve by who.

fn can_hold(who: &T::AccountId, amount: T::Balance) -> bool

Check to see if some amount of funds of who may be placed on hold.

impl<T, GetCurrencyId> LockableCurrency<<T as Config>::AccountId> for CurrencyAdapter<T, GetCurrencyId>where
    T: Config,
    GetCurrencyId: Get<T::CurrencyId>,

type Moment = <T as Config>::BlockNumber

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) -> DispatchResult

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
) -> Result<Self::Balance, DispatchError>

Decrease the balance of who by at least amount, possibly slightly more in the case of minimum_balance requirements, burning the tokens. If that isn’t possible then an Err is returned and nothing is changed. If successful, the amount of tokens reduced is returned.

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

Attempt to reduce the balance of who by as much as possible up to amount, and possibly slightly more due to minimum_balance requirements. If no decrease is possible then an Err is returned and nothing is changed. If successful, the amount of tokens reduced is returned.

fn teleport(
    source: &AccountId,
    dest: &AccountId,
    amount: Self::Balance
) -> Result<Self::Balance, DispatchError>

Transfer funds from one account into another. The default implementation uses mint_into and burn_from and may generate unwanted events.

impl<T, GetCurrencyId> MutateHold<<T as Config>::AccountId> for CurrencyAdapter<T, GetCurrencyId>where
    T: Config,
    GetCurrencyId: Get<T::CurrencyId>,

fn hold(who: &T::AccountId, amount: Self::Balance) -> DispatchResult

Hold some funds in an account.

fn release(
    who: &T::AccountId,
    amount: Self::Balance,
    best_effort: bool
) -> Result<T::Balance, DispatchError>

Release up to amount held funds in an account.

fn transfer_held(
    source: &T::AccountId,
    dest: &T::AccountId,
    amount: Self::Balance,
    best_effort: bool,
    on_hold: bool
) -> Result<Self::Balance, DispatchError>

Transfer held funds into a destination account.

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> Transfer<<T as Config>::AccountId> for CurrencyAdapter<T, GetCurrencyId>where
    T: Config,
    GetCurrencyId: Get<T::CurrencyId>,

fn transfer(
    source: &T::AccountId,
    dest: &T::AccountId,
    amount: T::Balance,
    keep_alive: bool
) -> Result<T::Balance, DispatchError>

Transfer funds from one account into another.

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

fn set_balance(who: &T::AccountId, amount: Self::Balance) -> DispatchResult

Set the balance of who to amount. If this cannot be done for some reason (e.g. because the account cannot be created or an overflow) then an Err is returned.

fn set_total_issuance(amount: Self::Balance)

Set the total issuance to amount.

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

Reduce the balance of who by amount. If it cannot be reduced by that amount for some reason, return Err and don’t reduce it at all. If Ok, return the imbalance.

fn decrease_balance_at_most(
    who: &AccountId,
    amount: Self::Balance
) -> Self::Balance

Reduce the balance of who by the most that is possible, up to amount.

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

Increase the balance of who by amount. If it cannot be increased by that amount for some reason, return Err and don’t increase it at all. If Ok, return the imbalance.

fn increase_balance_at_most(
    who: &AccountId,
    amount: Self::Balance
) -> Self::Balance

Increase the balance of who by the most that is possible, up to amount.