Skip to content

@gala-chain/connect ∙ API

API > TokenHold

Class: TokenHold

Contents

Constructors

new TokenHold(params)

new TokenHold(params?): TokenHold

Parameters

▪ params?: object

▪ params.created?: number

▪ params.createdBy?: string

▪ params.expires?: number

▪ params.instanceId?: BigNumber

▪ params.lockAuthority?: string

▪ params.name?: string

▪ params.quantity?: BigNumber

▪ params.vestingPeriodStart?: number

Source

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

Properties

created

readonly created: number

Source

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

createdBy

readonly createdBy: string

Source

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

expires

readonly expires: number

Source

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

instanceId

readonly instanceId: BigNumber

Source

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

lockAuthority

lockAuthority?: string

Source

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

name

readonly name?: string

Source

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

quantity

readonly quantity: BigNumber

Source

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

vestingPeriodStart

readonly vestingPeriodStart?: number

Source

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

DEFAULT_EXPIRES

static readonly DEFAULT_EXPIRES: 0 = 0

Source

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

Methods

getLockedVestingQuantity()

getLockedVestingQuantity(currentTime): BigNumber

Parameters

▪ currentTime: number

Source

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

isExpired()

isExpired(currentTime): boolean

Parameters

▪ currentTime: number

Source

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

isVestingHold()

isVestingHold(): boolean

Source

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

isVestingStarted()

isVestingStarted(currentTime): boolean

Parameters

▪ currentTime: number

Source

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

matches()

matches(instanceId, name): boolean

Parameters

▪ instanceId: BigNumber

▪ name: undefined | string

Source

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

timeSinceStart()

timeSinceStart(currentTime): number

Parameters

▪ currentTime: number

Source

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

totalTimeOfVestingPeriod()

totalTimeOfVestingPeriod(): number

Source

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

createValid()

static createValid(params): Promise\<TokenHold>

Parameters

▪ params: object

▪ params.created: number

▪ params.createdBy: string

▪ params.expires: undefined | number

▪ params.instanceId: BigNumber

▪ params.lockAuthority: undefined | string

▪ params.name: undefined | string

▪ params.quantity: BigNumber

▪ params.vestingPeriodStart?: number

Source

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

sortByAscendingExpiration()

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

Parameters

▪ a: TokenHold

▪ b: TokenHold

Source

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