Struct orml_currencies::Currency

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

Trait Implementations

impl<T, GetCurrencyId> BasicCurrency<<T as Config>::AccountId> for Currency<T, GetCurrencyId> where
    T: Config,
    GetCurrencyId: Get<<<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::CurrencyId>, 

type Balance = <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance

The balance of an account.

fn minimum_balance() -> Self::Balance

Existential deposit.

fn total_issuance() -> Self::Balance

The total amount of issuance.

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

The combined balance of who.

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

The free balance of who.

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

A dry-run of withdraw. Returns Ok iff the account is able to make a withdrawal of the given amount.

fn transfer(
    from: &T::AccountId,
    to: &T::AccountId,
    amount: Self::Balance
) -> DispatchResult

Transfer some amount from one account to another.

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

Add amount to the balance of who and increase total issuance.

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

Remove amount from the balance of who and reduce total issuance.

fn can_slash(who: &T::AccountId, amount: 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 slash(who: &T::AccountId, amount: Self::Balance) -> Self::Balance

Deduct the balance of who by up to amount.

impl<T, GetCurrencyId> BasicCurrencyExtended<<T as Config>::AccountId> for Currency<T, GetCurrencyId> where
    T: Config,
    GetCurrencyId: Get<<<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::CurrencyId>, 

type Amount = <<T as Config>::MultiCurrency as MultiCurrencyExtended<<T as Config>::AccountId>>::Amount

The signed type for balance related operations, typically signed int.

fn update_balance(who: &T::AccountId, by_amount: Self::Amount) -> DispatchResult

Add or remove abs(by_amount) from the balance of who. If positive by_amount, do add, else do remove.

impl<T, GetCurrencyId> BasicLockableCurrency<<T as Config>::AccountId> for Currency<T, GetCurrencyId> where
    T: Config,
    GetCurrencyId: Get<<<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::CurrencyId>, 

type Moment = T::BlockNumber

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

fn set_lock(
    lock_id: LockIdentifier,
    who: &T::AccountId,
    amount: Self::Balance
) -> DispatchResult

Create a new balance lock on account who.

fn extend_lock(
    lock_id: LockIdentifier,
    who: &T::AccountId,
    amount: Self::Balance
) -> DispatchResult

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

fn remove_lock(lock_id: LockIdentifier, who: &T::AccountId) -> DispatchResult

Remove an existing lock.

impl<T, GetCurrencyId> BasicReservableCurrency<<T as Config>::AccountId> for Currency<T, GetCurrencyId> where
    T: Config,
    GetCurrencyId: Get<<<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::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::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: BalanceStatus
) -> 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.