Skip to content

@gala-chain/api ∙ API

API > CreateTokenSaleDto

Class: CreateTokenSaleDto

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 CreateTokenSaleDto()

new CreateTokenSaleDto(): CreateTokenSaleDto

Inherited from

SubmitCallDTO.constructor

Properties

cost

cost: TokenSaleQuantity[]

Source

chain-api/src/types/sale.ts:317

end

end?: number

Source

chain-api/src/types/sale.ts:335

owner

owner?: UserRef

Source

chain-api/src/types/sale.ts:299

prefix

prefix?: string

Inherited from

SubmitCallDTO.prefix

Source

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

quantity

quantity: BigNumber

Source

chain-api/src/types/sale.ts:325

selling

selling: TokenSaleQuantity[]

Source

chain-api/src/types/sale.ts:308

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

start

start?: number

Source

chain-api/src/types/sale.ts:342

uniqueKey

uniqueKey: string

Inherited from

SubmitCallDTO.uniqueKey

Source

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

DEFAULT_END

static DEFAULT_END: number = 0

Source

chain-api/src/types/sale.ts:289

DEFAULT_START

static DEFAULT_START: number = 0

Source

chain-api/src/types/sale.ts:290

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): CreateTokenSaleDto

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