Trait polkadot_sdk_frame::traits::AccountIdConversion

pub trait AccountIdConversion<AccountId>: Sized {
    // Required methods
    fn into_sub_account_truncating<S>(&self, sub: S) -> AccountId
       where S: Encode;
    fn try_into_sub_account<S>(&self, sub: S) -> Option<AccountId>
       where S: Encode;
    fn try_from_sub_account<S>(x: &AccountId) -> Option<(Self, S)>
       where S: Decode;

    // Provided methods
    fn into_account_truncating(&self) -> AccountId { ... }
    fn try_into_account(&self) -> Option<AccountId> { ... }
    fn try_from_account(a: &AccountId) -> Option<Self> { ... }
}

Expand description

This type can be converted into and possibly from an AccountId (which itself is generic).

Required Methods§

fn into_sub_account_truncating<S>(&self, sub: S) -> AccountId
where S: Encode,

Convert this value amalgamated with the a secondary “sub” value into an account ID, truncating any unused bytes. This is infallible.

NOTE: The account IDs from this and from into_account are not guaranteed to be distinct for any given value of self, nor are different invocations to this with different types T. For example, the following will all encode to the same account ID value:

self.into_sub_account(0u32)
self.into_sub_account(vec![0u8; 0])
self.into_account()

Also, if the seed provided to this function is greater than the number of bytes which fit into this AccountId type, then it will lead to truncation of the seed, and potentially non-unique accounts.

fn try_into_sub_account<S>(&self, sub: S) -> Option<AccountId>
where S: Encode,

Same as into_sub_account_truncating, but ensuring that all bytes of the account’s seed are used when generating an account. This can help guarantee that different accounts are unique, besides types which encode the same as noted above.

fn try_from_sub_account<S>(x: &AccountId) -> Option<(Self, S)>
where S: Decode,

Try to convert an account ID into this type. Might not succeed.

Provided Methods§

fn into_account_truncating(&self) -> AccountId

Convert into an account ID. This is infallible, and may truncate bytes to provide a result. This may lead to duplicate accounts if the size of AccountId is less than the seed.

fn try_into_account(&self) -> Option<AccountId>

Convert into an account ID, checking that all bytes of the seed are being used in the final AccountId generated. If any bytes are dropped, this returns None.

fn try_from_account(a: &AccountId) -> Option<Self>

Try to convert an account ID into this type. Might not succeed.

Object Safety§

This trait is not object safe.

Implementors§

§

impl<T, Id> AccountIdConversion<T> for Id
where T: Encode + Decode, Id: Encode + Decode + TypeId,

Format is TYPE_ID ++ encode(sub-seed) ++ 00…. where 00… is indefinite trailing zeroes to fill AccountId.

Trait polkadot_sdk_frame::traits::AccountIdConversionCopy item path