xrpl
    Preparing search index...

    Interface MPTokenMetadata

    MPTokenMetadata object as per the XLS-89 standard. Use encodeMPTokenMetadata utility function to convert to a compact hex string for on-ledger storage. Use decodeMPTokenMetadata utility function to convert from a hex string to this format.

    interface MPTokenMetadata {
        additional_info?: string | Record<string, unknown>;
        asset_class: string;
        asset_subclass?: string;
        desc?: string;
        icon: string;
        issuer_name: string;
        name: string;
        ticker: string;
        uris?: MPTokenMetadataUri[];
    }
    Index

    Properties

    additional_info? asset_class asset_subclass? desc? icon issuer_name name ticker uris?

    Properties

    additional_info?: string | Record<string, unknown>

    Freeform field for key token details like interest rate, maturity date, term, or other relevant info. Can be any valid JSON object or UTF-8 string.

    { "interest_rate": "5.00%", "maturity_date": "2045-06-30" }
    asset_class: string

    Top-level classification of token purpose. Allowed values: "rwa", "memes", "wrapped", "gaming", "defi", "other"

    "rwa"
    asset_subclass?: string

    Optional subcategory of the asset class. Required if asset_class is "rwa". Allowed values: "stablecoin", "commodity", "real_estate", "private_credit", "equity", "treasury", "other"

    "treasury"
    desc?: string

    Short description of the token. Any UTF-8 string.

    "A yield-bearing stablecoin backed by short-term U.S. Treasuries"
    icon: string

    URI to the token icon. Can be a hostname/path (HTTPS assumed) or full URI for other protocols (e.g., ipfs://).

    "example.org/token-icon.png" or "ipfs://QmXxxx"
    issuer_name: string

    The name of the issuer account. Any UTF-8 string.

    "Example Yield Co."
    name: string

    Display name of the token. Any UTF-8 string.

    "T-Bill Yield Token"
    ticker: string

    Ticker symbol used to represent the token. Uppercase letters (A-Z) and digits (0-9) only. Max 6 characters recommended.

    "TBILL"
    uris?: MPTokenMetadataUri[]

    List of related URIs (site, dashboard, social media, documentation, etc.). Each URI object contains the link, its category, and a human-readable title.

    Settings

    Member Visibility

    On This Page

    Properties