Struct gekko::common::AccountId

pub struct AccountId(_);

An opaque 32-byte identifier of an on-chain account.

Usually contains the public key (or its hash in case of ECDSA). This is a simpler implementation of Substrates AccountId32 with some convenience methods (which can be used instead, if desired). It also implements the necessary encode/decode functionality to make it suitable to be used in transactions without having to wrap it in MultiAddress.

Note: This type should only be used to encode transactions, not decode those. Officially, Kusama and Polkadot support multiple account identifiers and MultiAddress should therefore be used for decoding.

use gekko::common::{*, sp_core::crypto::AccountId32};

let account_id =
    AccountId::from_ss58_address("D12RroVkrWavttGJ1g3iHNmDa68kyMsSeXvoZ1xPm8828kk")
        .unwrap();

// Convert this type into Substrates `AccountId32`
let sub: AccountId32 = account_id.into();

// Convert it back into the native type.
let account_id: AccountId = sub.into();

Implementations

impl AccountId

pub fn new(bytes: [u8; 32]) -> Self

Creates a new account identifier from a byte array.

pub fn from_ss58_address(addr: &str) -> Result<Self, ()>

Creates a new account identifier from a SS58 encoded string.

Example

use gekko::common::*;

let account_id =
    AccountId::from_ss58_address("D12RroVkrWavttGJ1g3iHNmDa68kyMsSeXvoZ1xPm8828kk")
        .unwrap();

pub fn from_ss58_address_with_version(
    addr: &str
) -> Result<(Self, Ss58AddressFormat), ()>

Creates a new account identifier from a SS58 encoded string and returns the identified SS58 Address format.

Example

use gekko::common::*;
use gekko::common::sp_core::crypto::Ss58AddressFormat;

let (account_id, version) =
    AccountId::from_ss58_address_with_version("D12RroVkrWavttGJ1g3iHNmDa68kyMsSeXvoZ1xPm8828kk")
        .unwrap();

assert_eq!(version, Ss58AddressFormat::KusamaAccount);

pub fn to_ss58_address(&self, format: Ss58AddressFormat) -> String

Returns the SS58 encoded representation of the account identifiers, based on the specified format.

pub fn to_bytes(&self) -> [u8; 32]

Returns the underlying byte array of the account identifier. Usually the public key of the account.

Trait Implementations

impl AsMut<[u8]> for AccountId

fn as_mut(&mut self) -> &mut [u8]

Performs the conversion.

impl AsRef<[u8]> for AccountId

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Clone for AccountId

fn clone(&self) -> AccountId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccountId

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

Formats the value using the given formatter.

impl Decode for AccountId

fn decode<I: Input>(input: &mut I) -> Result<Self, Error>

Attempt to deserialise the value from input.

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 AccountId

fn default() -> AccountId

Returns the “default value” for a type.

impl Encode for AccountId

fn using_encoded<R, F: FnOnce(&[u8]) -> R>(&self, f: F) -> R

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

fn size_hint(&self) -> usize

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

fn encode_to<T>(&self, dest: &mut T) where
    T: Output + ?Sized, 

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

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

Convert self to an owned vector.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl From<AccountId> for AccountId32

fn from(val: AccountId) -> Self

Performs the conversion.

impl From<AccountId32> for AccountId

fn from(val: AccountId32) -> Self

Performs the conversion.

impl From<MultiKeyPair> for AccountId

fn from(val: MultiKeyPair) -> Self

Performs the conversion.

impl From<Public> for AccountId

fn from(val: Public) -> Self

Performs the conversion.

impl From<Public> for AccountId

fn from(val: Public) -> Self

Performs the conversion.

impl PartialEq<AccountId> for AccountId

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

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

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

This method tests for !=.

impl Ss58Codec for AccountId

fn format_is_allowed(f: Ss58AddressFormat) -> bool

A format filterer, can be used to ensure that from_ss58check family only decode for allowed identifiers. By default just refuses the two reserved identifiers.

fn from_ss58check(s: &str) -> Result<Self, PublicError>

Some if the string is a properly encoded SS58Check address.

fn from_ss58check_with_version(
    s: &str
) -> Result<(Self, Ss58AddressFormat), PublicError>

Some if the string is a properly encoded SS58Check address.

fn from_string(s: &str) -> Result<Self, PublicError>

Some if the string is a properly encoded SS58Check address, optionally with a derivation path following.

fn to_ss58check_with_version(&self, version: Ss58AddressFormat) -> String

Return the ss58-check string for this key.

fn to_ss58check(&self) -> String

Return the ss58-check string for this key.

fn from_string_with_version(
    s: &str
) -> Result<(Self, Ss58AddressFormat), PublicError>

Some if the string is a properly encoded SS58Check address, optionally with a derivation path following.

impl Copy for AccountId

impl Eq for AccountId

impl StructuralEq for AccountId

impl StructuralPartialEq for AccountId