pub trait Mutate<AccountId>: Inspect<AccountId> + Unbalanced<AccountId> {
// Provided methods
fn mint_into(
who: &AccountId,
amount: Self::Balance
) -> Result<Self::Balance, DispatchError> { ... }
fn burn_from(
who: &AccountId,
amount: Self::Balance,
precision: Precision,
force: Fortitude
) -> Result<Self::Balance, DispatchError> { ... }
fn shelve(
who: &AccountId,
amount: Self::Balance
) -> Result<Self::Balance, DispatchError> { ... }
fn restore(
who: &AccountId,
amount: Self::Balance
) -> Result<Self::Balance, DispatchError> { ... }
fn transfer(
source: &AccountId,
dest: &AccountId,
amount: Self::Balance,
preservation: Preservation
) -> Result<Self::Balance, DispatchError> { ... }
fn set_balance(who: &AccountId, amount: Self::Balance) -> Self::Balance { ... }
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
) { ... }
}
Expand description
Trait for providing a basic fungible asset.
Provided Methods§
sourcefn mint_into(
who: &AccountId,
amount: Self::Balance
) -> Result<Self::Balance, DispatchError>
fn mint_into( who: &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.
sourcefn burn_from(
who: &AccountId,
amount: Self::Balance,
precision: Precision,
force: Fortitude
) -> Result<Self::Balance, DispatchError>
fn burn_from( who: &AccountId, amount: Self::Balance, precision: Precision, force: Fortitude ) -> 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.
sourcefn shelve(
who: &AccountId,
amount: Self::Balance
) -> Result<Self::Balance, DispatchError>
fn shelve( who: &AccountId, amount: Self::Balance ) -> Result<Self::Balance, DispatchError>
Attempt to decrease the asset
balance of who
by amount
.
Equivalent to burn_from
, except with an expectation that within the bounds of some
universal issuance, the total assets suspend
ed and resume
d will be equivalent. The
implementation may be configured such that the total assets suspended may never be less than
the total assets resumed (which is the invariant for an issuing system), or the reverse
(which the invariant in a non-issuing system).
Because of this expectation, any metadata associated with the asset is expected to survive the suspect-resume cycle.
sourcefn restore(
who: &AccountId,
amount: Self::Balance
) -> Result<Self::Balance, DispatchError>
fn restore( who: &AccountId, amount: Self::Balance ) -> Result<Self::Balance, DispatchError>
Attempt to increase the asset
balance of who
by amount
.
Equivalent to mint_into
, except with an expectation that within the bounds of some
universal issuance, the total assets suspend
ed and resume
d will be equivalent. The
implementation may be configured such that the total assets suspended may never be less than
the total assets resumed (which is the invariant for an issuing system), or the reverse
(which the invariant in a non-issuing system).
Because of this expectation, any metadata associated with the asset is expected to survive the suspect-resume cycle.
sourcefn transfer(
source: &AccountId,
dest: &AccountId,
amount: Self::Balance,
preservation: Preservation
) -> Result<Self::Balance, DispatchError>
fn transfer( source: &AccountId, dest: &AccountId, amount: Self::Balance, preservation: Preservation ) -> Result<Self::Balance, DispatchError>
Transfer funds from one account into another.
sourcefn set_balance(who: &AccountId, amount: Self::Balance) -> Self::Balance
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.
Returns the new balance.