@gala-chain/api ∙ API

---

API > TokenMintConfiguration

Class: TokenMintConfiguration

Contents

• Description
• Extends
• Constructors
• new TokenMintConfiguration()
• Properties
• additionalKey
• category
• collection
• postMintBurn
• postMintLock
• preMintBurn
• type
• COMPOSITEKEY_NS
• ID_SPLIT_CHAR
• ID_SUB_SPLIT_CHAR
• INDEX_KEY
• MIN_UNICODE_RUNE_VALUE
• Methods
• getCompositeKey()
• serialize()
• toPlainObject()
• validate()
• validateOrReject()
• validatePostProcessingTotals()
• deserialize()
• getCompositeKeyFromParts()
• getStringKeyFromParts()

Description

Configure mint configurations for specific token classes. The chain key properties are expected to match a token class.

On mint actions, the @GalaTransaction decorator's before and/or after property can potentially be configured with custom functions that will look for these configuration options.

If present, they can execute myriad additional actions atomically with the mint, such as post-mint fees, nft crafting (e.g. burn three common parts to assemble one rare) etc.

Extends

• ChainObject

Constructors

new TokenMintConfiguration()

new TokenMintConfiguration(): TokenMintConfiguration

Inherited from

ChainObject.constructor

Properties

additionalKey

additionalKey: string

Source

chain-api/src/types/TokenMintConfiguration.ts:155

---

category

category: string

Source

chain-api/src/types/TokenMintConfiguration.ts:147

---

collection

collection: string

Source

chain-api/src/types/TokenMintConfiguration.ts:143

---

postMintBurn

postMintBurn?: BurnToMintConfiguration

Description

(optional) specify a BurnToMintConfiguration to configure a specific token class to potentially burn some amount of minted quantity post-mint.

Source

chain-api/src/types/TokenMintConfiguration.ts:182

---

postMintLock

postMintLock?: PostMintLockConfiguration

Description

(optional) set a quantity to configure a specific token class to lock some amount of minted quantity post-mint.

Remarks

Use in conjucntion with FeeCodeDefintion chain objects and Fee Exit Gates to set specific amounts and/or percentages to be burned.

Source

chain-api/src/types/TokenMintConfiguration.ts:201

---

preMintBurn

preMintBurn?: BurnToMintConfiguration

Description

(optional) specify a BurnToMintConfiguration to configure a specific token class to potentially burn some amount of the quantity to-be-minted prior to executing the mint.

Source

chain-api/src/types/TokenMintConfiguration.ts:169

---

type

type: string

Source

chain-api/src/types/TokenMintConfiguration.ts:151

---

COMPOSITEKEY_NS

static COMPOSITEKEY_NS: string = "\x00"

Inherited from

ChainObject.COMPOSITEKEY_NS

Source

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

---

ID_SPLIT_CHAR

static ID_SPLIT_CHAR: string = "$"

Inherited from

ChainObject.ID_SPLIT_CHAR

Source

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

---

ID_SUB_SPLIT_CHAR

static ID_SUB_SPLIT_CHAR: string = "|"

Inherited from

ChainObject.ID_SUB_SPLIT_CHAR

Source

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

---

INDEX_KEY

static INDEX_KEY: string = "GCTMC"

Source

chain-api/src/types/TokenMintConfiguration.ts:139

---

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

Methods

getCompositeKey()

getCompositeKey(): string

Inherited from

ChainObject.getCompositeKey

Source

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

---

serialize()

serialize(): string

Inherited from

ChainObject.serialize

Source

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

---

toPlainObject()

toPlainObject(): Record\<string, unknown>

Inherited from

ChainObject.toPlainObject

Source

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

---

validate()

validate(): Promise\<ValidationError[]>

Inherited from

ChainObject.validate

Source

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

---

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

ChainObject.validateOrReject

Source

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

---

validatePostProcessingTotals()

validatePostProcessingTotals(): void

Source

chain-api/src/types/TokenMintConfiguration.ts:204

---

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

---

getCompositeKeyFromParts()

static getCompositeKeyFromParts(indexKey, parts): string

Parameters

▪ indexKey: string

▪ parts: unknown[]

Inherited from

ChainObject.getCompositeKeyFromParts

Source

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

---

getStringKeyFromParts()

static getStringKeyFromParts(parts): string

Parameters

▪ parts: string[]

Inherited from

ChainObject.getStringKeyFromParts

Source

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