Struct TokenId 

pub struct TokenId<M: ManagedTypeApi> { /* private fields */ }

Specialized type for handling token identifiers (e.g. ABCDEF-123456).

Implementations

impl<M: ManagedTypeApi> TokenId<M>

pub fn new(data: ManagedBuffer<M>) -> Self

Creates a new TokenId from a ManagedBuffer.

Automatically handles backwards compatibility by converting:

• Empty buffers to the native token (EGLD-000000)
• Legacy “EGLD” representation to the native token (EGLD-000000)
• All other values are stored as-is

pub fn new_backwards_compatible(data: ManagedBuffer<M>) -> Self

Creates a new TokenId with backwards compatibility for legacy EGLD representations.

This method handles the conversion of legacy EGLD representations to the current standard:

• Empty buffers are converted to the native token (EGLD-000000)
• The legacy “EGLD” representation is converted to “EGLD-000000”
• All other token identifiers are stored without modification

This ensures consistency across the codebase when dealing with the native token.

pub unsafe fn new_unchecked(data: ManagedBuffer<M>) -> Self

Creates a TokenId without any conversion or validation.

Safety

It does not convert the legacy EGLD representation (“EGLD” -> “EGLD-000000”). Only use if you are certain you are not in this scenario.

pub fn native() -> Self

Creates a TokenId representing the native token on the chain.

Returns a TokenId with the value “EGLD-000000”, which is the current standard representation for the native EGLD token.

Future developments might make this configurable for custom chains.

pub fn into_managed_buffer(self) -> ManagedBuffer<M>

pub fn as_managed_buffer(&self) -> &ManagedBuffer<M>

pub fn into_legacy(self) -> EgldOrEsdtTokenIdentifier<M>

pub fn as_legacy(&self) -> &EgldOrEsdtTokenIdentifier<M>

pub unsafe fn as_esdt_unchecked(&self) -> &EsdtTokenIdentifier<M>

Converts to a specialized ESDT token identifier.

Safety

Leads to inconsistencies if the token is EGLD.

pub unsafe fn into_esdt_unchecked(self) -> EsdtTokenIdentifier<M>

Converts to a specialized ESDT token identifier.

Safety

Leads to inconsistencies if the token is EGLD.

pub fn to_boxed_bytes(&self) -> BoxedBytes

pub fn is_native(&self) -> bool

Checks if a token is the native one on the chain. Currently only returns true for EGLD-000000.

pub fn is_valid(&self) -> bool

Checks the ESDT token identifier for validity.

Will fail if it encodes an invalid ESDT token identifier.

pub fn is_valid_esdt_identifier(&self) -> bool

Old method name. Kept for easier transition. Use is_valid instead.

pub fn ticker(&self) -> ManagedBuffer<M>

Extracts the ticker from the token identifier.

E.g. for “ABCDEF-123456” it will return “ABCDEF”.

Trait Implementations

impl<M: ManagedTypeApi> AsRef<TokenId<M>> for EgldOrEsdtTokenIdentifier<M>

fn as_ref(&self) -> &TokenId<M>

Converts this type into a shared reference of the (usually inferred) input type.

impl<M: ManagedTypeApi> AsRef<TokenId<M>> for TokenId<M>

fn as_ref(&self) -> &TokenId<M>

Converts this type into a shared reference of the (usually inferred) input type.

impl<M: Clone + ManagedTypeApi> Clone for TokenId<M>

fn clone(&self) -> TokenId<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: ManagedTypeApi> Debug for TokenId<M>

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

Formats the value using the given formatter.

impl<M: ManagedTypeApi> Display for TokenId<M>

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

Formats the value using the given formatter.

impl<M: ManagedTypeApi> From<&[u8]> for TokenId<M>

fn from(bytes: &[u8]) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi, const N: usize> From<&[u8; N]> for TokenId<M>

fn from(bytes: &[u8; N]) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<&String> for TokenId<M>

fn from(s: &String) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<&str> for TokenId<M>

fn from(s: &str) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<EgldOrEsdtTokenIdentifier<M>> for TokenId<M>

fn from(token_id: EgldOrEsdtTokenIdentifier<M>) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<ManagedBuffer<M>> for TokenId<M>

fn from(buffer: ManagedBuffer<M>) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<TokenId<M>> for EgldOrEsdtTokenIdentifier<M>

fn from(token_id: TokenId<M>) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<TokenId<M>> for EsdtTokenIdentifier<M>

fn from(token_id: TokenId<M>) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> ManagedType<M> for TokenId<M>

type OwnHandle = <M as HandleTypeInfo>::ManagedBufferHandle

fn get_handle(&self) -> M::ManagedBufferHandle

unsafe fn forget_into_handle(self) -> Self::OwnHandle

Forgets current object (does not run destructor), but extracts the handle.

fn transmute_from_handle_ref(handle_ref: &M::ManagedBufferHandle) -> &Self

Implement carefully, since the underlying transmutation is an unsafe operation. For types that wrap a handle to some VM-managed data, make sure the type only contains the handle (plus ZSTs if necessary). For types that just wrap another managed type it is easier, call for the wrapped object.

fn transmute_from_handle_ref_mut( handle_ref: &mut M::ManagedBufferHandle, ) -> &mut Self

fn get_raw_handle(&self) -> RawHandle

fn get_raw_handle_unchecked(&self) -> RawHandle

fn as_ref(&self) -> ManagedRef<'_, M, Self>

impl<M: ManagedTypeApi> ManagedVecItem for TokenId<M>

const SKIPS_RESERIALIZATION: bool = false

If true, then the encoding of the item is identical to the payload, and no further conversion is necessary (the underlying buffer can be used as-is during serialization). False for all managed types, but true for basic types (like u32).

type PAYLOAD = ManagedVecItemPayloadBuffer<UInt<UInt<UInt<UTerm, B1>, B0>, B0>>

Type managing the underlying binary representation in a ManagedVec..

type Ref<'a> = ManagedRef<'a, M, TokenId<M>>

Reference representation of the ManagedVec item.

fn read_from_payload(payload: &Self::PAYLOAD) -> Self

Parses given bytes as a an owned object.

unsafe fn borrow_from_payload<'a>(payload: &Self::PAYLOAD) -> Self::Ref<'a>

Parses given bytes as a representation of the object, either owned, or a reference.

fn save_to_payload(self, payload: &mut Self::PAYLOAD)

Converts the object into bytes.

fn payload_size() -> usize

impl<M: ManagedTypeApi> NestedDecode for TokenId<M>

fn dep_decode_or_handle_err<I, H>( input: &mut I, h: H, ) -> Result<Self, H::HandledErr>

where I: NestedDecodeInput, H: DecodeErrorHandler,

Version of dep_decode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn dep_decode<I>(input: &mut I) -> Result<Self, DecodeError>

where I: NestedDecodeInput,

Attempt to deserialise the value from input, using the format of an object nested inside another structure. In case of success returns the deserialized value and the number of bytes consumed during the operation.

impl<M: ManagedTypeApi> NestedEncode for TokenId<M>

fn dep_encode_or_handle_err<O, H>( &self, dest: &mut O, h: H, ) -> Result<(), H::HandledErr>

where O: NestedEncodeOutput, H: EncodeErrorHandler,

Version of dep_encode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn dep_encode<O>(&self, dest: &mut O) -> Result<(), EncodeError>

where O: NestedEncodeOutput,

NestedEncode to output, using the format of an object nested inside another structure. Does not provide compact version.

impl<M: ManagedTypeApi> PartialEq for TokenId<M>

fn eq(&self, other: &Self) -> 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<M: ManagedTypeApi> SCDisplay for TokenId<M>

fn fmt<F: FormatByteReceiver>(&self, f: &mut F)

impl<M: ManagedTypeApi> SCLowerHex for TokenId<M>

fn fmt<F: FormatByteReceiver>(&self, f: &mut F)

impl<M: ManagedTypeApi> TopDecode for TokenId<M>

fn top_decode_or_handle_err<I, H>(input: I, h: H) -> Result<Self, H::HandledErr>

where I: TopDecodeInput, H: DecodeErrorHandler,

Version of top_decode that can handle errors as soon as they occur. For instance it can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn top_decode<I>(input: I) -> Result<Self, DecodeError>

where I: TopDecodeInput,

Attempt to deserialize the value from input.

impl<M: ManagedTypeApi> TopEncode for TokenId<M>

fn top_encode_or_handle_err<O, H>( &self, output: O, h: H, ) -> Result<(), H::HandledErr>

where O: TopEncodeOutput, H: EncodeErrorHandler,

Version of top_encode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn top_encode<O>(&self, output: O) -> Result<(), EncodeError>

where O: TopEncodeOutput,

Attempt to serialize the value to output.

impl<M: ManagedTypeApi> TypeAbi for TokenId<M>

type Unmanaged = TokenId<M>

fn type_name() -> TypeName

fn type_name_rust() -> TypeName

fn type_names() -> TypeNames

fn provide_type_descriptions<TDC: TypeDescriptionContainer>( accumulator: &mut TDC, )

A type can provide more than its own name. For instance, a struct can also provide the descriptions of the type of its fields. TypeAbi doesn’t care for the exact accumulator type, which is abstracted by the TypeDescriptionContainer trait.

impl<M: ManagedTypeApi> Eq for TokenId<M>

impl<M> TypeAbiFrom<&[u8]> for TokenId<M>

where M: ManagedTypeApi,

impl<M> TypeAbiFrom<&EsdtTokenIdentifier<M>> for TokenId<M>

where M: ManagedTypeApi,

impl<M> TypeAbiFrom<&TestTokenIdentifier<'_>> for TokenId<M>

where M: ManagedTypeApi,

impl<M: ManagedTypeApi> TypeAbiFrom<&TokenId<M>> for TokenId<M>

impl<M> TypeAbiFrom<&str> for TokenId<M>

where M: ManagedTypeApi,

impl<M> TypeAbiFrom<EsdtTokenIdentifier<M>> for TokenId<M>

where M: ManagedTypeApi,

impl<M> TypeAbiFrom<TestTokenIdentifier<'_>> for TokenId<M>

where M: ManagedTypeApi,

impl<M: ManagedTypeApi> TypeAbiFrom<TokenId<M>> for TokenId<M>