Skip to content

@gala-chain/api ∙ API

API > CreateTokenClassDto

Class: CreateTokenClassDto

Contents

Description

The base DTO (Data Transfer Object) class. Provides common properties and methods for signing, uniqueness, validation, and serialization. All other DTOs in the SDK extend from this base class. To implement custom a custom DTO, create a new class that extends ChainCallDTO, and use the class-validator npm package to decorate the properties of the new class.

Remarks

Additional details for specific properties of this class are generated via the class-validator-jsonschema npm module and can either be viewed in the source code or in the OpenAPI documentation served alongside GalaChain's API endpoints.

Extends

Constructors

new CreateTokenClassDto()

new CreateTokenClassDto(): CreateTokenClassDto

Inherited from

SubmitCallDTO.constructor

Properties

authorities

authorities?: string[]

Source

chain-api/src/types/token.ts:264

contractAddress

contractAddress?: string

Source

chain-api/src/types/token.ts:232

decimals

decimals?: number

Source

chain-api/src/types/token.ts:160

description

description: string

Source

chain-api/src/types/token.ts:195

image

image: string

Source

chain-api/src/types/token.ts:246

isNonFungible

isNonFungible?: boolean

Source

chain-api/src/types/token.ts:253

maxCapacity

maxCapacity?: BigNumber

Source

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

maxSupply

maxSupply?: BigNumber

Source

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

metadataAddress

metadataAddress?: string

Source

chain-api/src/types/token.ts:236

name

name: string

Source

chain-api/src/types/token.ts:187

network

network?: string

Source

chain-api/src/types/token.ts:152

prefix

prefix?: string

Inherited from

SubmitCallDTO.prefix

Source

chain-api/src/types/dtos.ts:159

rarity

rarity?: string

Source

chain-api/src/types/token.ts:243

signature

signature?: string

Inherited from

SubmitCallDTO.signature

Source

chain-api/src/types/dtos.ts:150

signerAddress

signerAddress?: string

Inherited from

SubmitCallDTO.signerAddress

Source

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

signerPublicKey

signerPublicKey?: string

Inherited from

SubmitCallDTO.signerPublicKey

Source

chain-api/src/types/dtos.ts:173

signing

signing?: SigningScheme

Inherited from

SubmitCallDTO.signing

Source

chain-api/src/types/dtos.ts:183

symbol

symbol: string

Source

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

tokenClass

tokenClass: TokenClassKey

Source

chain-api/src/types/token.ts:184

totalBurned

totalBurned?: BigNumber

Source

chain-api/src/types/token.ts:228

totalMintAllowance

totalMintAllowance?: BigNumber

Source

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

totalSupply

totalSupply?: BigNumber

Source

chain-api/src/types/token.ts:217

uniqueKey

uniqueKey: string

Inherited from

SubmitCallDTO.uniqueKey

Source

chain-api/src/types/dtos.ts:271

DEFAULT_DECIMALS

static DEFAULT_DECIMALS: number = 0

Source

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

DEFAULT_MAX_CAPACITY

static DEFAULT_MAX_CAPACITY: BigNumber

Source

chain-api/src/types/token.ts:138

DEFAULT_MAX_SUPPLY

static DEFAULT_MAX_SUPPLY: BigNumber

Source

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

DEFAULT_NETWORK

static DEFAULT_NETWORK: string = "GC"

Source

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

INITIAL_MINT_ALLOWANCE

static INITIAL_MINT_ALLOWANCE: BigNumber

Source

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

INITIAL_TOTAL_BURNED

static INITIAL_TOTAL_BURNED: BigNumber

Source

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

INITIAL_TOTAL_SUPPLY

static INITIAL_TOTAL_SUPPLY: BigNumber

Source

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

Methods

isSignatureValid()

isSignatureValid(publicKey): boolean

Parameters

▪ publicKey: string

Inherited from

SubmitCallDTO.isSignatureValid

Source

chain-api/src/types/dtos.ts:257

serialize()

serialize(): string

Returns

string

Inherited from

SubmitCallDTO.serialize

Description

Serialze this object to string in a determinsitic fashion. See Hyperledger Fabric's documentation on JSON Determinism for more details.

Source

chain-api/src/types/dtos.ts:207

sign()

sign(privateKey, useDer): void

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

SubmitCallDTO.sign

Source

chain-api/src/types/dtos.ts:235

signed()

signed(privateKey, useDer): CreateTokenClassDto

Creates a signed copy of current object.

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

SubmitCallDTO.signed

Source

chain-api/src/types/dtos.ts:251

validate()

validate(): Promise\<ValidationError[]>

Inherited from

SubmitCallDTO.validate

Source

chain-api/src/types/dtos.ts:185

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

SubmitCallDTO.validateOrReject

Source

chain-api/src/types/dtos.ts:189

deserialize()

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

Type parameters

▪ T

Parameters

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

ClassConstructor that extends ChainCallDTO

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

serialized string or plain object to be instantiated via the provided ClassConstructor

Returns

An instantiated class created with the provided ClassConstructor

Inherited from

SubmitCallDTO.deserialize

Description

Instantiate a class instance from a serialized object using the provided ClassConstructor.

Source

chain-api/src/types/dtos.ts:228