@gala-chain/api ∙ API

---

API > TokenClass

Class: TokenClass

Contents

• Extends
• Constructors
• new TokenClass()
• Properties
• additionalKey
• authorities
• category
• collection
• contractAddress
• decimals
• description
• image
• isNonFungible
• knownMintAllowanceSupply
• knownMintSupply
• maxCapacity
• maxSupply
• metadataAddress
• name
• network
• rarity
• symbol
• totalBurned
• totalMintAllowance
• totalSupply
• type
• COMPOSITEKEY_NS
• ID_SPLIT_CHAR
• ID_SUB_SPLIT_CHAR
• INDEX_KEY
• MIN_UNICODE_RUNE_VALUE
• Methods
• getCompositeKey()
• getKey()
• serialize()
• toPlainObject()
• updatedWith()
• validate()
• validateOrReject()
• buildClassKeyList()
• buildClassKeyObject()
• buildTokenClassCompositeKey()
• deserialize()
• getCompositeKeyFromParts()
• getStringKeyFromParts()

Extends

• ChainObject

Constructors

new TokenClass()

new TokenClass(): TokenClass

Inherited from

ChainObject.constructor

Properties

additionalKey

additionalKey: string

Source

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

---

authorities

authorities: string[]

Source

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

---

category

category: string

Source

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

---

collection

collection: string

Source

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

---

contractAddress

contractAddress?: string

Source

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

---

decimals

decimals: number

Source

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

---

description

description: string

Source

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

---

image

image: string

Source

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

---

isNonFungible

isNonFungible: boolean

Source

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

---

knownMintAllowanceSupply

knownMintAllowanceSupply?: BigNumber

Source

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

---

knownMintSupply

knownMintSupply?: BigNumber

Source

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

---

maxCapacity

maxCapacity: BigNumber

Source

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

---

maxSupply

maxSupply: BigNumber

Source

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

---

metadataAddress

metadataAddress?: string

Source

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

---

name

name: string

Source

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

---

network

network: string

Source

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

---

rarity

rarity?: string

Source

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

---

symbol

symbol: string

Source

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

---

totalBurned

totalBurned: BigNumber

Source

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

---

totalMintAllowance

totalMintAllowance: BigNumber

Source

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

---

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:187

---

type

type: string

Source

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

---

COMPOSITEKEY_NS

static COMPOSITEKEY_NS: string = "\x00"

Inherited from

ChainObject.COMPOSITEKEY_NS

Source

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

---

ID_SPLIT_CHAR

static ID_SPLIT_CHAR: string = "$"

Inherited from

ChainObject.ID_SPLIT_CHAR

Source

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

---

ID_SUB_SPLIT_CHAR

static ID_SUB_SPLIT_CHAR: string = "|"

Inherited from

ChainObject.ID_SUB_SPLIT_CHAR

Source

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

---

INDEX_KEY

static INDEX_KEY: string = "GCTI"

Source

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

---

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:41

Methods

getCompositeKey()

getCompositeKey(): string

Inherited from

ChainObject.getCompositeKey

Source

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

---

getKey()

getKey(): Promise\<TokenClassKey>

Source

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

---

serialize()

serialize(): string

Inherited from

ChainObject.serialize

Source

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

---

toPlainObject()

toPlainObject(): Record\<string, unknown>

Inherited from

ChainObject.toPlainObject

Source

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

---

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:236

---

validate()

validate(): Promise\<ValidationError[]>

Inherited from

ChainObject.validate

Source

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

---

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

ChainObject.validateOrReject

Source

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

---

buildClassKeyList()

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

Parameters

▪ tokenClassKey: TokenClassKeyProperties

Source

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

---

buildClassKeyObject()

static buildClassKeyObject(token): Promise\<TokenClassKey>

Parameters

▪ token: TokenClassKeyProperties

Source

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

---

buildTokenClassCompositeKey()

static buildTokenClassCompositeKey(tokenClassKey): string

Parameters

▪ tokenClassKey: TokenClassKeyProperties

Source

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

---

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:70

---

getCompositeKeyFromParts()

static getCompositeKeyFromParts(indexKey, parts): string

Parameters

▪ indexKey: string

▪ parts: unknown[]

Inherited from

ChainObject.getCompositeKeyFromParts

Source

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

---

getStringKeyFromParts()

static getStringKeyFromParts(parts): string

Parameters

▪ parts: string[]

Inherited from

ChainObject.getStringKeyFromParts

Source

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