Skip to main content

Interface: GalaChainTokenHold

GalaChain core SDK 1.0.0-rc.8

GalaChain core SDK 1.0.0-rc.8 / index / GalaChainTokenHold

Interface: GalaChainTokenHold

Defined in: packages/gala-core-sdk/dist/index.d.ts:2694

A hold on part of a balance (a lock, or the legacy in-use hold), as GalaChain stores it. quantity is whole tokens as a decimal string; times are epoch milliseconds.

Properties​

created​

readonly created: number

Defined in: packages/gala-core-sdk/dist/index.d.ts:2696

When the hold was placed.

createdBy​

readonly createdBy: string

Defined in: packages/gala-core-sdk/dist/index.d.ts:2698

Who placed it.

expires​

readonly expires: number

Defined in: packages/gala-core-sdk/dist/index.d.ts:2700

When it expires; 0 means never.

instanceId​

readonly instanceId: string

Defined in: packages/gala-core-sdk/dist/index.d.ts:2702

The token instance held ("0" for a fungible token).

lockAuthority​

readonly lockAuthority: string

Defined in: packages/gala-core-sdk/dist/index.d.ts:2704

Who may release it.

name?​

readonly optional name?: string

Defined in: packages/gala-core-sdk/dist/index.d.ts:2706

The hold's name, when it has one.

quantity​

readonly quantity: string

Defined in: packages/gala-core-sdk/dist/index.d.ts:2708

How much is held, in whole tokens.

vestingPeriodStart?​

readonly optional vestingPeriodStart?: number

Defined in: packages/gala-core-sdk/dist/index.d.ts:2710

Start of a vesting period, when the hold is a vesting hold.