Struct pallet_balances::Module

pub struct Module<T: Trait<I>, I: Instance = DefaultInstance>(_);

Implementations

impl<T: Trait<I> + 'static, I: Instance> Module<T, I>

pub fn total_issuance() -> T::Balance

The total units issued in the system.

pub fn locks<K: EncodeLike<T::AccountId>>(
    key: K
) -> Vec<BalanceLock<T::Balance>>

Any liquidity locks on some account balances. NOTE: Should only be accessed when setting, changing and freeing a lock.

impl<T: Trait<I>, I: Instance> Module<T, I>

Can also be called using Call.

pub fn transfer(
    origin: T::Origin,
    dest: <T::Lookup as StaticLookup>::Source,
    value: T::Balance
) -> DispatchResult

Transfer some liquid free balance to another account.

transfer will set the FreeBalance of the sender and receiver. It will decrease the total issuance of the system by the TransferFee. If the sender’s account is below the existential deposit as a result of the transfer, the account will be reaped.

The dispatch origin for this call must be Signed by the transactor.

• Dependent on arguments but not critical, given proper implementations for input config types. See related functions below.
• It contains a limited number of reads and writes internally and no complex computation.

Related functions:

• ensure_can_withdraw is always called internally but has a bounded complexity.
• Transferring balances to accounts that did not exist before will cause T::OnNewAccount::on_new_account to be called.
• Removing enough funds from an account will trigger T::DustRemoval::on_unbalanced.
• transfer_keep_alive works the same way as transfer, but has an additional check that the transfer will not kill the origin account.

---

• Base Weight: 73.64 µs, worst case scenario (account created, account removed)
• DB Weight: 1 Read and 1 Write to destination account
• Origin account is already in memory, so no DB operations for them.

NOTE: Calling this function will bypass origin filters.

pub fn force_transfer(
    origin: T::Origin,
    source: <T::Lookup as StaticLookup>::Source,
    dest: <T::Lookup as StaticLookup>::Source,
    value: T::Balance
) -> DispatchResult

Exactly as transfer, except the origin must be root and the source account may be specified.

• Same as transfer, but additional read and write because the source account is not assumed to be in the overlay.

NOTE: Calling this function will bypass origin filters.

pub fn transfer_keep_alive(
    origin: T::Origin,
    dest: <T::Lookup as StaticLookup>::Source,
    value: T::Balance
) -> DispatchResult

Same as the transfer call, but with a check that the transfer will not kill the origin account.

99% of the time you want transfer instead.

• Cheaper than transfer because account cannot be killed.
• Base Weight: 51.4 µs
• DB Weight: 1 Read and 1 Write to dest (sender is in overlay already) #

NOTE: Calling this function will bypass origin filters.

impl<T: Trait<I>, I: Instance> Module<T, I>

pub fn free_balance(who: impl Borrow<T::AccountId>) -> T::Balance

Get the free balance of an account.

pub fn usable_balance(who: impl Borrow<T::AccountId>) -> T::Balance

Get the balance of an account that can be used for transfers, reservations, or any other non-locking, non-transaction-fee activity. Will be at most free_balance.

pub fn usable_balance_for_fees(who: impl Borrow<T::AccountId>) -> T::Balance

Get the balance of an account that can be used for paying transaction fees (not tipping, or any other kind of fees, though). Will be at most free_balance.

pub fn reserved_balance(who: impl Borrow<T::AccountId>) -> T::Balance

Get the reserved balance of an account.

pub fn mutate_account<R>(
    who: &T::AccountId,
    f: impl FnOnce(&mut AccountData<T::Balance>) -> R
) -> R

Mutate an account to some new value, or delete it entirely with None. Will enforce ExistentialDeposit law, annulling the account as needed.

NOTE: Doesn’t do any preparatory work for creating a new account, so should only be used when it is known that the account already exists.

NOTE: LOW-LEVEL: This will not attempt to maintain total issuance. It is expected that the caller will do this.

Trait Implementations

impl<T: Trait<I>, I: Instance> Callable<T> for Module<T, I>

type Call = Call<T, I>

impl<T: Clone + Trait<I>, I: Clone + Instance> Clone for Module<T, I>

fn clone(&self) -> Module<T, I>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Copy + Trait<I>, I: Copy + Instance> Copy for Module<T, I>

impl<T: Trait<I>, I: Instance> Currency<<T as Trait>::AccountId> for Module<T, I> where
    T::Balance: MaybeSerializeDeserialize + Debug, 

type Balance = T::Balance

The balance of an account.

type PositiveImbalance = PositiveImbalance<T, I>

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, I>

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: T::Balance,
    reasons: WithdrawReasons,
    new_balance: T::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(
    transactor: &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)

Slash a target account who, returning the negative imbalance created and any left over amount that could not be slashed.

Is a no-op if value to be slashed is zero.

NOTE: slash() prefers free balance, but assumes that reserve balance can be drawn from in extreme circumstances. can_slash() should be used prior to slash() to avoid having to draw from reserved funds, however we err on the side of punishment if things are inconsistent or can_slash wasn’t used appropriately.

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.

Is a no-op if the value to be deposited is zero.

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.

This function is a no-op if:

• the value to be deposited is zero; or
• if the value to be deposited is less than the ED and the account does not yet exist; or
• value is so large it would cause the balance of who to overflow.

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

Withdraw some free balance from an account, respecting existence requirements.

Is a no-op if value to be withdrawn is zero.

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

Force the new free balance of a target account who to some new value balance.

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

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

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

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

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

pub 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: Trait<I>, I: Instance> Debug for Module<T, I> where
    T: Debug,
    I: Debug, 

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Eq + Trait<I>, I: Eq + Instance> Eq for Module<T, I>

impl<T: Trait<I>, I: Instance> IntegrityTest for Module<T, I>

pub fn integrity_test()

Run integrity test.

impl<T: Trait<I>, I: Instance> IsDeadAccount<<T as Trait>::AccountId> for Module<T, I> where
    T::Balance: MaybeSerializeDeserialize + Debug, 

fn is_dead_account(who: &T::AccountId) -> bool

Is the given account dead?

impl<T: Trait<I>, I: Instance> LockableCurrency<<T as Trait>::AccountId> for Module<T, I> where
    T::Balance: MaybeSerializeDeserialize + Debug, 

type Moment = T::BlockNumber

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

type MaxLocks = T::MaxLocks

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

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

Create a new balance lock on account who.

fn extend_lock(
    id: LockIdentifier,
    who: &T::AccountId,
    amount: T::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: Trait<I>, I: Instance> ModuleErrorMetadata for Module<T, I>

fn metadata() -> &'static [ErrorMetadata]

impl<T: Trait + Trait<I>, I: Instance> OffchainWorker<<T as Trait>::BlockNumber> for Module<T, I>

pub fn offchain_worker(_n: BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Trait + Trait<I>, I: Instance> OnFinalize<<T as Trait>::BlockNumber> for Module<T, I>

pub fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Trait + Trait<I>, I: Instance> OnInitialize<<T as Trait>::BlockNumber> for Module<T, I>

pub fn on_initialize(_n: BlockNumber) -> u64

The block is being initialized. Implement to have something happen.

impl<T: Trait<I>, I: Instance> OnKilledAccount<<T as Trait>::AccountId> for Module<T, I>

Implement OnKilledAccount to remove the local account, if using local account storage.

NOTE: You probably won’t need to use this! This only needs to be “wired in” to System module if you’re using the local balance storage. If you’re using the composite system account storage (which is the default in most examples and tests) then there’s no need.

fn on_killed_account(who: &T::AccountId)

The account with the given id was reaped.

impl<T: Trait<I>, I: Instance> OnRuntimeUpgrade for Module<T, I>

pub fn on_runtime_upgrade() -> u64

Perform a module upgrade.

impl<T: PartialEq + Trait<I>, I: PartialEq + Instance> PartialEq<Module<T, I>> for Module<T, I>

fn eq(&self, other: &Module<T, I>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Module<T, I>) -> bool

This method tests for !=.

impl<T: Trait<I>, I: Instance> ReservableCurrency<<T as Trait>::AccountId> for Module<T, I> where
    T::Balance: MaybeSerializeDeserialize + Debug, 

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

Check if who can reserve value from their free balance.

Always true if value to be reserved is zero.

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

Move value from the free balance from who to their reserved balance.

Is a no-op if value to be reserved is zero.

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

Unreserve some funds, returning any amount that was unable to be unreserved.

Is a no-op if the value to be unreserved is zero.

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

Slash from reserved balance, returning the negative imbalance created, and any amount that was unable to be slashed.

Is a no-op if the value to be slashed is zero.

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

Move the reserved balance of one account into the balance of another, according to status.

Is a no-op if:

• the value to be moved is zero; or
• the slashed id equal to beneficiary and the status is Reserved.

impl<T: Trait<I>, I: Instance> StructuralEq for Module<T, I>

impl<T: Trait<I>, I: Instance> StructuralPartialEq for Module<T, I>