Enum cfg_types::tokens::CurrencyId

pub enum CurrencyId {
    Native,
    Tranche(PoolId, TrancheId),
    AUSD,
    ForeignAsset(ForeignAssetId),
    Staking(StakingCurrency),
    LocalAsset(LocalAssetId),
}

The type for all Currency ids that our chains handles. Foreign assets gather all the tokens that are native to other chains, such as DOT, AUSD, UDST, etc.

NOTE: We MUST NEVER change the #[codec(index =_)] below as doing so results in corrupted storage keys; if changing the index value of a variant is mandatory, a storage migration must take place to ensure that the values under an old codec-encoded key are moved to the new key.

Variants

Native

Tranche(PoolId, TrancheId)

A Tranche token

AUSD

DEPRECATED - Will be removed in the next Altair RU 1034 when the orml_tokens’ balances are migrated to the new CurrencyId for AUSD.

ForeignAsset(ForeignAssetId)

A foreign asset

Staking(StakingCurrency)

A staking currency

LocalAsset(LocalAssetId)

A local asset

Trait Implementations

impl Clone for CurrencyId

fn clone(&self) -> CurrencyId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CurrencyInspect for CurrencyId

type CurrencyId = CurrencyId

fn is_tranche_token(currency: Self::CurrencyId) -> bool

Checks whether the provided currency is a tranche token.

impl Debug for CurrencyId

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

Formats the value using the given formatter.

impl Decode for CurrencyId

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Default for CurrencyId

fn default() -> CurrencyId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CurrencyId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for CurrencyId

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl From<(u64, [u8; 16])> for CurrencyId

fn from((pool_id, tranche_id): (PoolId, TrancheId)) -> Self

Converts to this type from the input type.

impl From<CurrencyId> for FilterCurrency

fn from(value: CurrencyId) -> Self

Converts to this type from the input type.

impl From<LocalAssetId> for CurrencyId

fn from(value: LocalAssetId) -> Self

Converts to this type from the input type.

impl From<StakingCurrency> for CurrencyId

fn from(inner: StakingCurrency) -> Self

Converts to this type from the input type.

impl From<u32> for CurrencyId

fn from(value: u32) -> Self

Converts to this type from the input type.

impl<AssetInspect> HasLocalAssetRepresentation<AssetInspect> for CurrencyId

where AssetInspect: Inspect<AssetId = CurrencyId, Balance = Balance, CustomMetadata = CustomMetadata>,

fn is_local_representation_of( &self, variant_currency: &Self ) -> Result<bool, DispatchError>

impl MaxEncodedLen for CurrencyId

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl Ord for CurrencyId

fn cmp(&self, other: &CurrencyId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for CurrencyId

fn eq(&self, other: &CurrencyId) -> 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 PartialOrd for CurrencyId

fn partial_cmp(&self, other: &CurrencyId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for CurrencyId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Index, Prefix> TryFrom<CurrencyId> for GeneralCurrencyIndex<Index, Prefix>

where Index: From<u128>, Prefix: Get<[u8; 12]>,

type Error = DispatchError

The type returned in the event of a conversion error.

fn try_from( value: CurrencyId ) -> Result<GeneralCurrencyIndex<Index, Prefix>, Self::Error>

Performs the conversion.

impl TryFrom<CurrencyId> for LocalAssetId

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: CurrencyId) -> Result<Self, Self::Error>

Performs the conversion.

impl<Index, Prefix> TryFrom<GeneralCurrencyIndex<Index, Prefix>> for CurrencyId

where Index: Into<u128>, Prefix: Get<[u8; 12]>,

type Error = DispatchError

The type returned in the event of a conversion error.

fn try_from( value: GeneralCurrencyIndex<Index, Prefix> ) -> Result<Self, Self::Error>

Performs the conversion.

impl TypeInfo for CurrencyId

type Identity = CurrencyId

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Copy for CurrencyId

impl EncodeLike for CurrencyId

impl Eq for CurrencyId

impl StructuralPartialEq for CurrencyId