Struct assets::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn register( origin: OriginFor<T>, symbol: AssetSymbol, name: AssetName, initial_supply: Balance, is_mintable: bool, is_indivisible: bool, opt_content_src: Option<ContentSource>, opt_desc: Option<Description> ) -> DispatchResultWithPostInfo

Performs an asset registration.

Registers new AssetId for the given origin. AssetSymbol should represent string with only uppercase latin chars with max length of 7. AssetName should represent string with only uppercase or lowercase latin chars or numbers or spaces, with max length of 33.

pub fn transfer( origin: OriginFor<T>, asset_id: T::AssetId, to: T::AccountId, amount: Balance ) -> DispatchResultWithPostInfo

Performs a checked Asset transfer.

• origin: caller Account, from which Asset amount is withdrawn,
• asset_id: Id of transferred Asset,
• to: Id of Account, to which Asset amount is deposited,
• amount: transferred Asset amount.

pub fn mint( origin: OriginFor<T>, asset_id: T::AssetId, to: T::AccountId, amount: Balance ) -> DispatchResultWithPostInfo

Performs a checked Asset mint, can only be done by corresponding asset owner account.

• origin: caller Account, which issues Asset minting,
• asset_id: Id of minted Asset,
• to: Id of Account, to which Asset amount is minted,
• amount: minted Asset amount.

pub fn force_mint( origin: OriginFor<T>, asset_id: T::AssetId, to: T::AccountId, amount: Balance ) -> DispatchResultWithPostInfo

Performs an unchecked Asset mint, can only be done by root account.

Should be used as extrinsic call only. Currencies::updated_balance() should be deprecated. Using force_mint allows us to perform extra actions for minting, such as buy-back, extra-minting and etc.

• origin: caller Account, which issues Asset minting,
• asset_id: Id of minted Asset,
• to: Id of Account, to which Asset amount is minted,
• amount: minted Asset amount.

pub fn burn( origin: OriginFor<T>, asset_id: T::AssetId, amount: Balance ) -> DispatchResultWithPostInfo

Performs a checked Asset burn, can only be done by corresponding asset owner with own account.

• origin: caller Account, from which Asset amount is burned,
• asset_id: Id of burned Asset,
• amount: burned Asset amount.

pub fn update_balance( origin: OriginFor<T>, who: T::AccountId, currency_id: <<T as Config>::Currency as MultiCurrency<<T as Config>::AccountId>>::CurrencyId, amount: <<T as Config>::Currency as MultiCurrencyExtended<<T as Config>::AccountId>>::Amount ) -> DispatchResult

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

Basically a wrapper of MultiCurrencyExtended::update_balance for testing purposes.

TODO: move into tests extrinsic collection pallet

pub fn set_non_mintable( origin: OriginFor<T>, asset_id: T::AssetId ) -> DispatchResultWithPostInfo

Set given asset to be non-mintable, i.e. it can no longer be minted, only burned. Operation can not be undone.

• origin: caller Account, should correspond to Asset owner
• asset_id: Id of burned Asset,

pub fn update_info( origin: OriginFor<T>, asset_id: T::AssetId, new_symbol: Option<AssetSymbol>, new_name: Option<AssetName> ) -> DispatchResultWithPostInfo

Change information about asset. Can only be done by root

• origin: caller Account, should be root
• asset_id: Id of asset to change,
• new_symbol: New asset symbol. If None asset symbol will not change
• new_name: New asset name. If None asset name will not change

impl<T: Config> Pallet<T>

pub fn asset_owner<KArg>(k: KArg) -> Option<T::AccountId>where KArg: EncodeLike<T::AssetId>,

Asset Id -> Owner Account Id

impl<T: Config> Pallet<T>

pub fn asset_infos<KArg>( k: KArg ) -> (AssetSymbol, AssetName, BalancePrecision, bool, Option<ContentSource>, Option<Description>)where KArg: EncodeLike<T::AssetId>,

Asset Id -> (Symbol, Name, Precision, Is Mintable, Content Source, Description)

impl<T: Config> Pallet<T>

pub fn tuple_from_asset_id<KArg>(k: KArg) -> Option<AssetRecord<T>>where KArg: EncodeLike<T::AssetId>,

Asset Id -> AssetRecord

impl<T: Config> Pallet<T>

pub fn register_asset_id_from_tuple(tuple: &AssetRecord<T>) -> T::AssetId

Generates an AssetId for the given AssetRecord<T>, and insert record to storage map.

pub fn gen_asset_id_from_any(value: &impl Encode) -> T::AssetId

Generates an AssetId from an Encode value.

pub fn gen_asset_id(account_id: &T::AccountId) -> T::AssetId

Generates an AssetId for the given AccountId.

pub fn register_asset_id( account_id: T::AccountId, asset_id: T::AssetId, symbol: AssetSymbol, name: AssetName, precision: BalancePrecision, initial_supply: Balance, is_mintable: bool, opt_content_src: Option<ContentSource>, opt_desc: Option<Description> ) -> DispatchResult

Register the given AssetId.

pub fn register_from( account_id: &T::AccountId, symbol: AssetSymbol, name: AssetName, precision: BalancePrecision, initial_supply: Balance, is_mintable: bool, opt_content_src: Option<ContentSource>, opt_desc: Option<Description> ) -> Result<T::AssetId, DispatchError>

Generates new AssetId and registers it from the account_id.

pub fn ensure_asset_is_mintable(asset_id: &T::AssetId) -> DispatchResult

pub fn transfer_from( asset_id: &T::AssetId, from: &T::AccountId, to: &T::AccountId, amount: Balance ) -> DispatchResult

pub fn mint_to( asset_id: &T::AssetId, issuer: &T::AccountId, to: &T::AccountId, amount: Balance ) -> DispatchResult

pub fn mint_unchecked( asset_id: &T::AssetId, to: &T::AccountId, amount: Balance ) -> DispatchResult

pub fn burn_from( asset_id: &T::AssetId, issuer: &T::AccountId, from: &T::AccountId, amount: Balance ) -> DispatchResult

pub fn update_own_balance( asset_id: &T::AssetId, who: &T::AccountId, by_amount: Amount ) -> DispatchResult

pub fn can_reserve( asset_id: T::AssetId, who: &T::AccountId, amount: Balance ) -> bool

pub fn reserve( asset_id: &T::AssetId, who: &T::AccountId, amount: Balance ) -> DispatchResult

pub fn unreserve( asset_id: &T::AssetId, who: &T::AccountId, amount: Balance ) -> Result<Balance, DispatchError>

pub fn set_non_mintable_from( asset_id: &T::AssetId, who: &T::AccountId ) -> DispatchResult

pub fn list_registered_asset_ids() -> Vec<T::AssetId>

pub fn list_registered_asset_infos( ) -> Vec<(T::AssetId, AssetSymbol, AssetName, BalancePrecision, bool, Option<ContentSource>, Option<Description>)>

Trait Implementations

impl<T: Config> AssetInfoProvider<<T as Config>::AssetId, <T as Config>::AccountId, AssetSymbol, AssetName, u8, ContentSource, Description> for Pallet<T>

fn asset_exists(asset_id: &T::AssetId) -> bool

fn ensure_asset_exists(asset_id: &T::AssetId) -> DispatchResult

fn is_asset_owner(asset_id: &T::AssetId, account_id: &T::AccountId) -> bool

fn get_asset_info( asset_id: &T::AssetId ) -> (AssetSymbol, AssetName, BalancePrecision, bool, Option<ContentSource>, Option<Description>)

fn is_non_divisible(asset_id: &T::AssetId) -> bool

fn get_asset_content_src(asset_id: &T::AssetId) -> Option<ContentSource>

fn get_asset_description(asset_id: &T::AssetId) -> Option<Description>

fn total_issuance(asset_id: &T::AssetId) -> Result<Balance, DispatchError>

fn total_balance( asset_id: &T::AssetId, who: &T::AccountId ) -> Result<Balance, DispatchError>

fn free_balance( asset_id: &T::AssetId, who: &T::AccountId ) -> Result<Balance, DispatchError>

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

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

fn current_storage_version() -> StorageVersion

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>::BlockNumber> for Pallet<T>

fn on_finalize(_n: BlockNumber)

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

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

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_initialize(_n: BlockNumber) -> Weight

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

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

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

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

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

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

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

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

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

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

fn on_runtime_upgrade() -> Weight

Perform a module 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 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<Pallet<T>> 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> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

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>