Skip to main content

Type Alias: CoinMetadata

type CoinMetadata = {
  address: ObjectIdLike;
  decimals?: number;
  description?: string;
  iconUrl?: string;
  name?: string;
  supply?: bigint;
  symbol?: string;
  version: bigint;
};

The coin metadata associated with the given coin type.

Properties​

address​

address: ObjectIdLike;

The CoinMetadata object ID.

decimals?​

optional decimals?: number;

The number of decimal places used to represent the token.

description?​

optional description?: string;

Optional description of the token, provided by the creator of the token.

iconUrl?​

optional iconUrl?: string;

Icon URL of the coin.

name?​

optional name?: string;

Full, official name of the token.

supply?​

optional supply?: bigint;

The overall quantity of tokens that will be issued.

symbol?​

optional symbol?: string;

The token's identifying abbreviation.

version​

version: bigint;

Version of the token.