@gala-chain/api ∙ API

---

API > TokenHold

Class: TokenHold

Contents

• Constructors
• new TokenHold(params)
• Properties
• created
• createdBy
• expires
• instanceId
• lockAuthority
• name
• quantity
• vestingPeriodStart
• DEFAULT_EXPIRES
• Methods
• getLockedVestingQuantity()
• isExpired()
• isVestingHold()
• isVestingStarted()
• matches()
• timeSinceStart()
• totalTimeOfVestingPeriod()
• createValid()
• sortByAscendingExpiration()

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

▪ params.vestingPeriodStart?: number

Source

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

Properties

created

readonly created: number

Source

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

---

createdBy

readonly createdBy: UserAlias

Source

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

---

expires

readonly expires: number

Source

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

---

instanceId

readonly instanceId: BigNumber

Source

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

---

lockAuthority

lockAuthority?: UserAlias

Source

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

---

name

readonly name?: string

Source

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

---

quantity

readonly quantity: BigNumber

Source

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

---

vestingPeriodStart

readonly vestingPeriodStart?: number

Source

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

---

DEFAULT_EXPIRES

static readonly DEFAULT_EXPIRES: 0 = 0

Source

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

Methods

getLockedVestingQuantity()

getLockedVestingQuantity(currentTime): BigNumber

Parameters

▪ currentTime: number

Source

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

---

isExpired()

isExpired(currentTime): boolean

Parameters

▪ currentTime: number

Source

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

---

isVestingHold()

isVestingHold(): boolean

Source

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

---

isVestingStarted()

isVestingStarted(currentTime): boolean

Parameters

▪ currentTime: number

Source

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

---

matches()

matches(instanceId, name): boolean

Parameters

▪ instanceId: BigNumber

▪ name: undefined | string

Source

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

---

timeSinceStart()

timeSinceStart(currentTime): number

Parameters

▪ currentTime: number

Source

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

---

totalTimeOfVestingPeriod()

totalTimeOfVestingPeriod(): number

Source

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

---

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

▪ params.vestingPeriodStart: undefined | number

Source

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

---

sortByAscendingExpiration()

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

Parameters

▪ a: TokenHold

▪ b: TokenHold

Source

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