Skip to content

@gala-chain/api ∙ API

API > TokenHold

Class: TokenHold

Contents

Constructors

new TokenHold(params)

new TokenHold(params?): TokenHold

Parameters

▪ params?: object

▪ params.created?: number

▪ params.createdBy?: UserAlias

▪ params.expires?: number

▪ params.instanceId?: BigNumber

▪ params.lockAuthority?: UserAlias

▪ params.name?: string

▪ params.quantity?: BigNumber

Source

chain-api/src/types/TokenBalance.ts:547

Properties

created

readonly created: number

Source

chain-api/src/types/TokenBalance.ts:527

createdBy

readonly createdBy: UserAlias

Source

chain-api/src/types/TokenBalance.ts:514

expires

readonly expires: number

Source

chain-api/src/types/TokenBalance.ts:531

instanceId

readonly instanceId: BigNumber

Source

chain-api/src/types/TokenBalance.ts:519

lockAuthority

lockAuthority?: UserAlias

Source

chain-api/src/types/TokenBalance.ts:545

name

readonly name?: string

Source

chain-api/src/types/TokenBalance.ts:535

quantity

readonly quantity: BigNumber

Source

chain-api/src/types/TokenBalance.ts:523

DEFAULT_EXPIRES

static readonly DEFAULT_EXPIRES: 0 = 0

Source

chain-api/src/types/TokenBalance.ts:511

Methods

isExpired()

isExpired(currentTime): boolean

Parameters

▪ currentTime: number

Source

chain-api/src/types/TokenBalance.ts:594

matches()

matches(instanceId, name): boolean

Parameters

▪ instanceId: BigNumber

▪ name: undefined | string

Source

chain-api/src/types/TokenBalance.ts:590

createValid()

static createValid(params): Promise\<TokenHold>

Parameters

▪ params: object

▪ params.created: number

▪ params.createdBy: UserAlias

▪ params.expires: undefined | number

▪ params.instanceId: BigNumber

▪ params.lockAuthority: undefined | UserAlias

▪ params.name: undefined | string

▪ params.quantity: BigNumber

Source

chain-api/src/types/TokenBalance.ts:571

sortByAscendingExpiration()

static sortByAscendingExpiration(a, b): 0 | 1 | -1

Parameters

▪ a: TokenHold

▪ b: TokenHold

Source

chain-api/src/types/TokenBalance.ts:599