Struct TokenSymbol 

pub struct TokenSymbol(/* private fields */);

Represents a token symbol (e.g. “POL”, “ETH”).

Token Symbols can consist of up to 12 capital Latin characters, e.g. “C”, “ETH”, “MIDEN”.

The symbol is stored as a String and can be converted to a Felt encoding via as_element().

Implementations

impl TokenSymbol

pub const MAX_SYMBOL_LENGTH: usize = 12

Maximum allowed length of the token string.

pub const ALPHABET_LENGTH: u64 = 26

The length of the set of characters that can be used in a token’s name.

pub const MIN_ENCODED_VALUE: u64 = 1

The minimum integer value of an encoded TokenSymbol.

This value encodes the “A” token symbol.

pub const MAX_ENCODED_VALUE: u64 = 2481152873203736562

The maximum integer value of an encoded TokenSymbol.

This value encodes the “ZZZZZZZZZZZZ” token symbol.

pub fn new_unchecked(symbol: &str) -> Self

Constructs a new TokenSymbol from a string, panicking on invalid input.

Panics

Panics if:

• The length of the provided string is less than 1 or greater than 12.
• The provided token string contains characters that are not uppercase ASCII.

pub fn new(symbol: &str) -> Result<Self, TokenSymbolError>

Creates a new TokenSymbol instance from the provided token name string.

Errors

Returns an error if:

• The length of the provided string is less than 1 or greater than 12.
• The provided token string contains characters that are not uppercase ASCII.

pub fn as_element(&self) -> Felt

Returns the Felt encoding of this token symbol.

The alphabet used in the encoding process consists of the Latin capital letters as defined in the ASCII table, having the length of 26 characters.

The encoding is performed by multiplying the intermediate encoded value by the length of the used alphabet and adding the relative index of the character to it. At the end of the encoding process the length of the initial token string is added to the encoded value.

Relative character index is computed by subtracting the index of the character “A” (65) from the index of the currently processing character, e.g., A = 65 - 65 = 0, B = 66 - 65 = 1, ... , Z = 90 - 65 = 25.

Trait Implementations

impl Clone for TokenSymbol

fn clone(&self) -> TokenSymbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenSymbol

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

Formats the value using the given formatter.

impl Display for TokenSymbol

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

Formats the value using the given formatter.

impl From<&TokenSymbol> for Felt

fn from(symbol: &TokenSymbol) -> Self

Converts to this type from the input type.

impl From<TokenSymbol> for Felt

fn from(symbol: TokenSymbol) -> Self

Converts to this type from the input type.

impl PartialEq for TokenSymbol

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&str> for TokenSymbol

type Error = TokenSymbolError

The type returned in the event of a conversion error.

fn try_from(symbol: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Felt> for TokenSymbol

Decodes a Felt representation of the token symbol into a TokenSymbol.

The alphabet used in the decoding process consists of the Latin capital letters as defined in the ASCII table, having the length of 26 characters.

The decoding is performed by getting the modulus of the intermediate encoded value by the length of the used alphabet and then dividing the intermediate value by the length of the alphabet to shift to the next character. At the beginning of the decoding process the length of the initial token string is obtained from the encoded value. After that the value obtained after taking the modulus represents the relative character index, which then gets converted to the ASCII index.

Final ASCII character index is computed by adding the index of the character “A” (65) to the index of the currently processing character, e.g., A = 0 + 65 = 65, B = 1 + 65 = 66, ... , Z = 25 + 65 = 90.

type Error = TokenSymbolError

The type returned in the event of a conversion error.

fn try_from(felt: Felt) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for TokenSymbol

impl StructuralPartialEq for TokenSymbol