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

ChainCallDTO.constructor

Properties

authorities

authorities?: string[]

Source

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

contractAddress

contractAddress?: string

Source

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

decimals

decimals?: number

Source

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

description

description: string

Source

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

image

image: string

Source

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

isNonFungible

isNonFungible?: boolean

Source

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

maxCapacity

maxCapacity?: BigNumber

Source

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

maxSupply

maxSupply?: BigNumber

Source

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

metadataAddress

metadataAddress?: string

Source

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

name

name: string

Source

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

network

network?: string

Source

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

prefix

prefix?: string

Inherited from

ChainCallDTO.prefix

Source

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

rarity

rarity?: string

Source

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

signature

signature?: string

Inherited from

ChainCallDTO.signature

Source

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

signerAddress

signerAddress?: string

Inherited from

ChainCallDTO.signerAddress

Source

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

signerPublicKey

signerPublicKey?: string

Inherited from

ChainCallDTO.signerPublicKey

Source

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

signing

signing?: SigningScheme

Inherited from

ChainCallDTO.signing

Source

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

symbol

symbol: string

Source

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

tokenClass

tokenClass: TokenClassKey

Source

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

totalBurned

totalBurned?: BigNumber

Source

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

totalMintAllowance

totalMintAllowance?: BigNumber

Source

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

totalSupply

totalSupply?: BigNumber

Source

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

trace

trace?: TraceContext

Inherited from

ChainCallDTO.trace

Source

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

uniqueKey

uniqueKey?: string

Inherited from

ChainCallDTO.uniqueKey

Source

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

DEFAULT_DECIMALS

static DEFAULT_DECIMALS: number = 0

Source

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

DEFAULT_MAX_CAPACITY

static DEFAULT_MAX_CAPACITY: BigNumber

Source

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

DEFAULT_MAX_SUPPLY

static DEFAULT_MAX_SUPPLY: BigNumber

Source

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

DEFAULT_NETWORK

static DEFAULT_NETWORK: string = "GC"

Source

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

ENCODING

static readonly ENCODING: "base64" = "base64"

Inherited from

ChainCallDTO.ENCODING

Source

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

INITIAL_MINT_ALLOWANCE

static INITIAL_MINT_ALLOWANCE: BigNumber

Source

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

INITIAL_TOTAL_BURNED

static INITIAL_TOTAL_BURNED: BigNumber

Source

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

INITIAL_TOTAL_SUPPLY

static INITIAL_TOTAL_SUPPLY: BigNumber

Source

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

Methods

isSignatureValid()

isSignatureValid(publicKey): boolean

Parameters

▪ publicKey: string

Inherited from

ChainCallDTO.isSignatureValid

Source

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

serialize()

serialize(): string

Returns

string

Inherited from

ChainCallDTO.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:208

sign()

sign(privateKey, useDer): void

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

ChainCallDTO.sign

Source

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

signed()

signed(privateKey, useDer): CreateTokenClassDto

Creates a signed copy of current object.

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

ChainCallDTO.signed

Source

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

validate()

validate(): Promise\<ValidationError[]>

Inherited from

ChainCallDTO.validate

Source

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

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

ChainCallDTO.validateOrReject

Source

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

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

ChainCallDTO.deserialize

Description

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

Source

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