Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PeristentTokenMetadata

Hierarchy

  • PeristentTokenMetadata

Index

Constructors

Methods

Constructors

constructor

  • Parameters

    • prefix: string

      A prefix to use for every key of this map

    Returns PeristentTokenMetadata

Methods

add

  • Add metadata of a token

    Basic usage example:

    Assume we need add the metadata object TM1 to the token with token id = jenny911038,

    const persistent_tokens_metadata = new PeristentTokenMetadata('ptm')
    const metadata = persistent_tokens_metadata.add('jenny911038' , TM1 );
    

    Parameters

    • tokenId: TokenId

      Id of the token that need to save metadata

    • tokenMetadata: TokenMetadata

      Metadata object to be saved

    Returns TokenMetadata

    Saved token metadata object

get

  • Get token metadata for a given token ID

    Basic usage example:

    Assume we need to get the metadata of the token with token id = jenny911038,

    const persistent_tokens_metadata = new PeristentTokenMetadata('ptm')
    const metadata = persistent_tokens_metadata.get("jenny911038");
    

    Parameters

    • tokenId: TokenId

      ID of token to retrieve metadata

    Returns TokenMetadata

    Token Metadata object

keys

  • keys(start: i32, end: i32): TokenId[]
  • Get the IDs of tokens saved in the provided range

    Basic usage example:

    Assume we need the IDs of first 5 tokens,

    const persistent_tokens_metadata = new PeristentTokenMetadata('ptm')
    const token_ids = persistent_tokens_metadata.keys(0, 5);
    

    Parameters

    • start: i32

      Start index

    • end: i32

      End index

    Returns TokenId[]

    An array of tokenIds

Generated using TypeDoc