Struct pallet_restricted_tokens::pallet::Pallet

pub struct Pallet<T>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config> Pallet<T>

pub fn transfer( origin: OriginFor<T>, dest: <T::Lookup as StaticLookup>::Source, currency_id: T::CurrencyId, amount: T::Balance ) -> DispatchResultWithPostInfo

pub fn transfer_all( origin: OriginFor<T>, dest: <T::Lookup as StaticLookup>::Source, currency_id: T::CurrencyId, keep_alive: bool ) -> DispatchResultWithPostInfo

pub fn transfer_keep_alive( origin: OriginFor<T>, dest: <T::Lookup as StaticLookup>::Source, currency_id: T::CurrencyId, amount: T::Balance ) -> DispatchResultWithPostInfo

pub fn force_transfer( origin: OriginFor<T>, source: <T::Lookup as StaticLookup>::Source, dest: <T::Lookup as StaticLookup>::Source, currency_id: T::CurrencyId, amount: T::Balance ) -> DispatchResultWithPostInfo

pub fn set_balance( origin: OriginFor<T>, who: <T::Lookup as StaticLookup>::Source, currency_id: T::CurrencyId, new_free: T::Balance, new_reserved: T::Balance ) -> DispatchResultWithPostInfo

Trait Implementations

impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T: Config> Callable<T> for Pallet<T>

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Config> Currency<<T as Config>::AccountId> for Pallet<T>

type Balance = <T as Config>::Balance

The balance of an account.

type NegativeImbalance = <<T as Config>::NativeFungible as Currency<<T as Config>::AccountId>>::NegativeImbalance

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 PositiveImbalance = <<T as Config>::NativeFungible as Currency<<T as Config>::AccountId>>::PositiveImbalance

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 deposit_into_existing( who: &T::AccountId, value: Self::Balance ) -> Result<Self::PositiveImbalance, DispatchError>

Mints value to the free balance of who.

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

Adds up to value to the free balance of who. If who doesn’t exist, it is created.

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, balance: 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> Debug for Pallet<T>

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

Formats the value using the given formatter.

impl<T: Config> GetStorageVersion for Pallet<T>

type CurrentStorageVersion = NoStorageVersionSet

This will be filled out by the pallet macro.

fn current_storage_version() -> Self::CurrentStorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]).

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by FRAME.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main wasm runtime.

fn integrity_test()

Check the integrity of this pallet’s configuration.

impl<T: Config> Inspect<<T as Config>::AccountId> for Pallet<T>

type AssetId = <T as Config>::CurrencyId

Means of identifying one asset class from another.

type Balance = <T as Config>::Balance

Scalar type for representing balance of an account.

fn total_issuance(asset: Self::AssetId) -> Self::Balance

The total amount of issuance in the system.

fn minimum_balance(asset: Self::AssetId) -> Self::Balance

The minimum balance any single account may have.

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

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

fn balance(asset: Self::AssetId, 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 reducible_balance( asset: Self::AssetId, who: &T::AccountId, preservation: Preservation, force: 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 transfer and potentially go below user-level restrictions on the minimum amount of the account.

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

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

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

Returns Failed if the asset balance of who may not be decreased by amount, otherwise the consequence.

fn asset_exists(asset: Self::AssetId) -> bool

Returns true if an asset exists.

fn active_issuance(asset: Self::AssetId) -> Self::Balance

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

impl<T: Config> Inspect<<T as Config>::AccountId> for Pallet<T>

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 total_balance(who: &T::AccountId) -> Self::Balance

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

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 reducible_balance( who: &T::AccountId, preservation: Preservation, force: 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: Config> Inspect<<T as Config>::AccountId> for Pallet<T>

type Reason = <T as Config>::RuntimeHoldReason

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 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 balance_on_hold(reason: &Self::Reason, who: &T::AccountId) -> Self::Balance

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

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: Self::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: Config> Inspect<<T as Config>::AccountId> for Pallet<T>

type 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 total_balance_on_hold( asset: Self::AssetId, who: &T::AccountId ) -> Self::Balance

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

fn reducible_total_balance_on_hold( asset: Self::AssetId, 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 balance_on_hold( asset: Self::AssetId, _reason: &Self::Reason, who: &T::AccountId ) -> Self::Balance

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

fn hold_available( asset: Self::AssetId, _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( asset: Self::AssetId, _reason: &Self::Reason, who: &T::AccountId, amount: Self::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( asset: Self::AssetId, 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: Config> IntegrityTest for Pallet<T>

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> LockableCurrency<<T as Config>::AccountId> for Pallet<T>

type MaxLocks = <<T as Config>::NativeFungible as LockableCurrency<<T as Config>::AccountId>>::MaxLocks

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

type Moment = <<T as Config>::NativeFungible as LockableCurrency<<T as Config>::AccountId>>::Moment

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

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: Config> Mutate<<T as Config>::AccountId> for Pallet<T>

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

fn transfer( source: &T::AccountId, dest: &T::AccountId, amount: Self::Balance, preservation: Preservation ) -> Result<Self::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: Config> Mutate<<T as Config>::AccountId> for Pallet<T>

fn mint_into( asset: Self::AssetId, 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( asset: Self::AssetId, who: &T::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.

fn transfer( asset: Self::AssetId, source: &T::AccountId, dest: &T::AccountId, amount: Self::Balance, preservation: Preservation ) -> Result<Self::Balance, DispatchError>

Transfer funds from one account into another.

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

Attempt to decrease the asset balance of who by amount.

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

Attempt to increase the asset balance of who by amount.

fn set_balance( asset: Self::AssetId, 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( _asset: Self::AssetId, _who: &AccountId, _amount: Self::Balance )

fn done_burn_from( _asset: Self::AssetId, _who: &AccountId, _amount: Self::Balance )

fn done_shelve(_asset: Self::AssetId, _who: &AccountId, _amount: Self::Balance)

fn done_restore(_asset: Self::AssetId, _who: &AccountId, _amount: Self::Balance)

fn done_transfer( _asset: Self::AssetId, _source: &AccountId, _dest: &AccountId, _amount: Self::Balance )

impl<T: Config> Mutate<<T as Config>::AccountId> for Pallet<T>

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

Release up to amount held funds in an account.

fn transfer_on_hold( reason: &Self::Reason, source: &T::AccountId, dest: &T::AccountId, amount: Self::Balance, precision: Precision, mode: Restriction, force: 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: Config> Mutate<<T as Config>::AccountId> for Pallet<T>

fn hold( asset: Self::AssetId, _reason: &Self::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( asset: Self::AssetId, _reason: &Self::Reason, who: &T::AccountId, amount: Self::Balance, precision: Precision ) -> Result<Self::Balance, DispatchError>

Release up to amount held funds in an account.

fn transfer_on_hold( asset: Self::AssetId, _reason: &Self::Reason, source: &T::AccountId, dest: &T::AccountId, amount: Self::Balance, precision: Precision, mode: Restriction, force: Fortitude ) -> Result<Self::Balance, DispatchError>

Transfer held funds into a destination account.

fn burn_held( asset: Self::AssetId, reason: &Self::Reason, who: &AccountId, amount: Self::Balance, precision: Precision, force: Fortitude ) -> Result<Self::Balance, DispatchError>

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

fn burn_all_held( asset: Self::AssetId, reason: &Self::Reason, who: &AccountId, precision: Precision, force: Fortitude ) -> Result<Self::Balance, DispatchError>

Attempt to decrease the asset balance of who which is held for the given reason to zero.

fn transfer_and_hold( asset: Self::AssetId, 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. for reason.

fn done_hold( _asset: Self::AssetId, _reason: &Self::Reason, _who: &AccountId, _amount: Self::Balance )

fn done_release( _asset: Self::AssetId, _reason: &Self::Reason, _who: &AccountId, _amount: Self::Balance )

fn done_burn_held( _asset: Self::AssetId, _reason: &Self::Reason, _who: &AccountId, _amount: Self::Balance )

fn done_transfer_on_hold( _asset: Self::AssetId, _reason: &Self::Reason, _source: &AccountId, _dest: &AccountId, _amount: Self::Balance )

fn done_transfer_and_hold( _asset: Self::AssetId, _reason: &Self::Reason, _source: &AccountId, _dest: &AccountId, _transferred: Self::Balance )

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn name_hash() -> [u8; 16]

Two128 hash of name.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq for Pallet<T>

fn eq(&self, other: &Self) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config> ReservableCurrency<<T as Config>::AccountId> for Pallet<T>

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

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> Unbalanced<<T as Config>::AccountId> for Pallet<T>

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

Forcefully set the balance of who to amount.

fn set_total_issuance(asset: Self::AssetId, amount: Self::Balance)

Set the total issuance to amount.

fn handle_raw_dust(asset: Self::AssetId, amount: Self::Balance)

Create some dust and handle it with Self::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 Self::minimum_balance() - 1.

fn decrease_balance( asset: Self::AssetId, 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( asset: Self::AssetId, who: &AccountId, amount: Self::Balance, precision: Precision ) -> Result<Self::Balance, DispatchError>

Increase the balance of who by amount.

fn deactivate(_asset: Self::AssetId, _: Self::Balance)

Reduce the active issuance by some amount.

fn reactivate(_asset: Self::AssetId, _: Self::Balance)

Increase the active issuance by some amount, up to the outstanding amount reduced.

impl<T: Config> Unbalanced<<T as Config>::AccountId> for Pallet<T>

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: Config> Unbalanced<<T as Config>::AccountId> for Pallet<T>

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.

impl<T: Config> Unbalanced<<T as Config>::AccountId> for Pallet<T>

fn set_balance_on_hold( asset: Self::AssetId, _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( asset: Self::AssetId, 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( asset: Self::AssetId, reason: &Self::Reason, who: &AccountId, amount: Self::Balance, precision: Precision ) -> Result<Self::Balance, DispatchError>

Increase the balance on hold of who by amount.

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>