Struct pallet_asset_registry::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>,
    name: Vec<u8>,
    asset_type: AssetType<T::AssetId>,
    existential_deposit: T::Balance,
    asset_id: Option<T::AssetId>,
    metadata: Option<Metadata>,
    location: Option<T::AssetNativeLocation>
) -> DispatchResult

Register a new asset.

Asset is identified by name and the name must not be used to register another asset.

New asset is given NextAssetId - sequential asset id

Adds mapping between name and assigned asset_id so asset id can be retrieved by name too (Note: this approach is used in AMM implementation (xyk))

Emits ’Registered` event when successful.

pub fn update(
    origin: OriginFor<T>,
    asset_id: T::AssetId,
    name: Vec<u8>,
    asset_type: AssetType<T::AssetId>,
    existential_deposit: Option<T::Balance>
) -> DispatchResult

Update registered asset.

Updates also mapping between name and asset id if provided name is different than currently registered.

Emits Updated event when successful.

pub fn set_metadata(
    origin: OriginFor<T>,
    asset_id: T::AssetId,
    symbol: Vec<u8>,
    decimals: u8
) -> DispatchResult

Set metadata for an asset.

• asset_id: Asset identifier.
• symbol: The exchange symbol for this asset. Limited in length by StringLimit.
• decimals: The number of decimals this asset uses to represent one unit.

Emits MetadataSet event when successful.

pub fn set_location(
    origin: OriginFor<T>,
    asset_id: T::AssetId,
    location: T::AssetNativeLocation
) -> DispatchResult

Set asset native location.

Adds mapping between native location and local asset id and vice versa.

Mainly used in XCM.

Emits LocationSet event when successful.

impl<T: Config> Pallet<T>

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

Details of an asset.

impl<T: Config> Pallet<T>

pub fn asset_ids<KArg>(k: KArg) -> Option<T::AssetId>where
    KArg: EncodeLike<BoundedVec<u8, T::StringLimit>>,

Mapping between asset name and asset id.

impl<T: Config> Pallet<T>

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

Native location of an asset.

impl<T: Config> Pallet<T>

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

Local asset for native location.

impl<T: Config> Pallet<T>

pub fn asset_metadata<KArg>(
    k: KArg
) -> Option<AssetMetadata<BoundedVec<u8, T::StringLimit>>>where
    KArg: EncodeLike<T::AssetId>,

Metadata of an asset.

impl<T: Config> Pallet<T>

pub fn next_asset_id() -> Option<T::AssetId>

pub fn to_bounded_name(
    name: Vec<u8>
) -> Result<BoundedVec<u8, T::StringLimit>, Error<T>>

Convert Vec to BoundedVec so it respects the max set limit, otherwise return TooLong error

pub fn register_asset(
    name: BoundedVec<u8, T::StringLimit>,
    asset_type: AssetType<T::AssetId>,
    existential_deposit: T::Balance,
    selected_asset_id: Option<T::AssetId>
) -> Result<T::AssetId, DispatchError>

Register new asset.

Does not perform any check whether an asset for given name already exists. This has to be prior to calling this function.

pub fn get_or_create_asset(
    name: Vec<u8>,
    asset_type: AssetType<T::AssetId>,
    existential_deposit: T::Balance,
    asset_id: Option<T::AssetId>
) -> Result<T::AssetId, DispatchError>

Create asset for given name or return existing AssetId if such asset already exists.

pub fn asset_to_location(asset_id: T::AssetId) -> Option<T::AssetNativeLocation>

Return location for given asset.

pub fn location_to_asset(location: T::AssetNativeLocation) -> Option<T::AssetId>

Return asset for given loation.

Trait Implementations

impl<T> Benchmarking for Pallet<T>where
    T: Config + Config,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark(
    extrinsic: &[u8],
    c: &[(BenchmarkParameter, u32)],
    whitelist: &[TrackedStorageKey],
    verify: bool,
    internal_repeats: u32
) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

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

type Call = 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> GetByKey<<T as Config>::AssetId, <T as Config>::Balance> for Pallet<T>

fn get(k: &T::AssetId) -> T::Balance

Return the value.

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 try_state(_n: BlockNumber) -> Result<(), &'static str>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime 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.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a 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 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> Registry<<T as Config>::AssetId, Vec<u8, Global>, <T as Config>::Balance, DispatchError> for Pallet<T>

fn exists(asset_id: T::AssetId) -> bool

fn retrieve_asset(name: &Vec<u8>) -> Result<T::AssetId, DispatchError>

fn create_asset(
    name: &Vec<u8>,
    existential_deposit: T::Balance
) -> Result<T::AssetId, DispatchError>

fn get_or_create_asset(
    name: AssetName,
    existential_deposit: Balance
) -> Result<AssetId, Error>

impl<T: Config> ShareTokenRegistry<<T as Config>::AssetId, Vec<u8, Global>, <T as Config>::Balance, DispatchError> for Pallet<T>

fn retrieve_shared_asset(
    name: &Vec<u8>,
    _assets: &[T::AssetId]
) -> Result<T::AssetId, DispatchError>

fn create_shared_asset(
    name: &Vec<u8>,
    assets: &[T::AssetId],
    existential_deposit: T::Balance
) -> Result<T::AssetId, DispatchError>

fn get_or_create_shared_asset(
    name: AssetName,
    assets: Vec<AssetId, Global>,
    existential_deposit: Balance
) -> Result<AssetId, Error>

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

fn storage_info() -> Vec<StorageInfo>

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

fn try_state(
    n: <T as Config>::BlockNumber,
    _s: TryStateSelect
) -> Result<(), &'static str>

Execute the state checks.

impl<T> Eq for Pallet<T>