Skip to content

@gala-chain/api ∙ API

API > TokenClass

Class: TokenClass

Contents

Extends

Constructors

new TokenClass()

new TokenClass(): TokenClass

Inherited from

ChainObject.constructor

Properties

additionalKey

additionalKey: string

Source

chain-api/src/types/TokenClass.ts:123

authorities

authorities: string[]

Source

chain-api/src/types/TokenClass.ts:153

category

category: string

Source

chain-api/src/types/TokenClass.ts:115

collection

collection: string

Source

chain-api/src/types/TokenClass.ts:111

contractAddress

contractAddress?: string

Source

chain-api/src/types/TokenClass.ts:171

decimals

decimals: number

Source

chain-api/src/types/TokenClass.ts:136

description

description: string

Source

chain-api/src/types/TokenClass.ts:166

image

image: string

Source

chain-api/src/types/TokenClass.ts:181

isNonFungible

isNonFungible: boolean

Source

chain-api/src/types/TokenClass.ts:144

knownMintAllowanceSupply

knownMintAllowanceSupply?: BigNumber

Source

chain-api/src/types/TokenClass.ts:197

knownMintSupply

knownMintSupply?: BigNumber

Source

chain-api/src/types/TokenClass.ts:209

maxCapacity

maxCapacity: BigNumber

Source

chain-api/src/types/TokenClass.ts:149

maxSupply

maxSupply: BigNumber

Source

chain-api/src/types/TokenClass.ts:141

metadataAddress

metadataAddress?: string

Source

chain-api/src/types/TokenClass.ts:176

name

name: string

Source

chain-api/src/types/TokenClass.ts:158

network

network: string

Source

chain-api/src/types/TokenClass.ts:127

rarity

rarity?: string

Source

chain-api/src/types/TokenClass.ts:186

symbol

symbol: string

Source

chain-api/src/types/TokenClass.ts:162

totalBurned

totalBurned: BigNumber

Source

chain-api/src/types/TokenClass.ts:190

totalMintAllowance

totalMintAllowance: BigNumber

Source

chain-api/src/types/TokenClass.ts:193

totalSupply

totalSupply: BigNumber

Total supply of tokens minted for class.

Deprecated

2023-05-30, replaced with knownMintSupply for high-throughput implementation.

Source

chain-api/src/types/TokenClass.ts:205

type

type: string

Source

chain-api/src/types/TokenClass.ts:119

COMPOSITEKEY_NS

static COMPOSITEKEY_NS: string = "\x00"

Inherited from

ChainObject.COMPOSITEKEY_NS

Source

chain-api/src/types/ChainObject.ts:46

ID_SPLIT_CHAR

static ID_SPLIT_CHAR: string = "$"

Inherited from

ChainObject.ID_SPLIT_CHAR

Source

chain-api/src/types/ChainObject.ts:49

ID_SUB_SPLIT_CHAR

static ID_SUB_SPLIT_CHAR: string = "|"

Inherited from

ChainObject.ID_SUB_SPLIT_CHAR

Source

chain-api/src/types/ChainObject.ts:51

INDEX_KEY

static INDEX_KEY: string = "GCTI"

Source

chain-api/src/types/TokenClass.ts:104

MIN_UNICODE_RUNE_VALUE

static MIN_UNICODE_RUNE_VALUE: string = "\u0000"

Inherited from

ChainObject.MIN_UNICODE_RUNE_VALUE

Source

chain-api/src/types/ChainObject.ts:44

Methods

getCompositeKey()

getCompositeKey(): string

Inherited from

ChainObject.getCompositeKey

Source

chain-api/src/types/ChainObject.ts:80

getKey()

getKey(): Promise\<TokenClassKey>

Source

chain-api/src/types/TokenClass.ts:212

serialize()

serialize(): string

Inherited from

ChainObject.serialize

Source

chain-api/src/types/ChainObject.ts:53

toPlainObject()

toPlainObject(): Record\<string, unknown>

Inherited from

ChainObject.toPlainObject

Source

chain-api/src/types/ChainObject.ts:69

updatedWith()

updatedWith(toUpdate): TokenClass

Returns new token class object updated with properties that are allowed to be updated

Parameters

▪ toUpdate: ToUpdate

Source

chain-api/src/types/TokenClass.ts:254

validate()

validate(): Promise\<ValidationError[]>

Inherited from

ChainObject.validate

Source

chain-api/src/types/ChainObject.ts:57

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

ChainObject.validateOrReject

Source

chain-api/src/types/ChainObject.ts:61

buildClassKeyList()

static buildClassKeyList(tokenClassKey): [string, string, string, string]

Parameters

▪ tokenClassKey: TokenClassKeyProperties

Source

chain-api/src/types/TokenClass.ts:216

buildClassKeyObject()

static buildClassKeyObject(token): Promise\<TokenClassKey>

Parameters

▪ token: TokenClassKeyProperties

Source

chain-api/src/types/TokenClass.ts:234

buildTokenClassCompositeKey()

static buildTokenClassCompositeKey(tokenClassKey): string

Parameters

▪ tokenClassKey: TokenClassKeyProperties

Source

chain-api/src/types/TokenClass.ts:224

decodeFromBase58()

static decodeFromBase58(base58String): string

Parameters

▪ base58String: string

Inherited from

ChainObject.decodeFromBase58

Source

chain-api/src/types/ChainObject.ts:142

deserialize()

static deserialize\<T>(constructor, object): T

Type parameters

▪ T

Parameters

▪ constructor: ClassConstructor\<Inferred\<T, ChainObject>>

▪ object: string | Record\<string, unknown> | Record\<string, unknown>[]

Inherited from

ChainObject.deserialize

Source

chain-api/src/types/ChainObject.ts:73

encodeToBase58()

static encodeToBase58(stringKey): string

Parameters

▪ stringKey: string

Inherited from

ChainObject.encodeToBase58

Source

chain-api/src/types/ChainObject.ts:137

getCompositeKeyFromParts()

static getCompositeKeyFromParts(indexKey, parts): string

Parameters

▪ indexKey: string

▪ parts: unknown[]

Inherited from

ChainObject.getCompositeKeyFromParts

Source

chain-api/src/types/ChainObject.ts:105

getEncodableStringKeyFromParts()

static getEncodableStringKeyFromParts(parts): string

Parameters

▪ parts: string[]

Inherited from

ChainObject.getEncodableStringKeyFromParts

Source

chain-api/src/types/ChainObject.ts:129

getPartsFromEncodableStringKey()

static getPartsFromEncodableStringKey(stringKey): string[]

Parameters

▪ stringKey: string

Inherited from

ChainObject.getPartsFromEncodableStringKey

Source

chain-api/src/types/ChainObject.ts:133

getStringKeyFromParts()

static getStringKeyFromParts(parts): string

Parameters

▪ parts: string[]

Inherited from

ChainObject.getStringKeyFromParts

Source

chain-api/src/types/ChainObject.ts:125