Skip to main content

Interface: LockTokensInput

GalaChain core SDK 1.0.0-rc.8

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

Interface: LockTokensInput

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

lockTokens: 1 to 100 tokens of the writer's, held under one lock.

Extends​

Properties​

expires?​

optional expires?: number

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

When the hold expires, in epoch milliseconds; 0 (or omitted) means it never expires.

lockAuthority?​

optional lockAuthority?: string

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

Who may unlock (see TransferGalaInput.to for the forms); default the writer itself.

name?​

optional name?: string

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

A name for the hold, so it can be unlocked by name.

tokens​

tokens: readonly TokenQuantityInput[]

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

uniqueKey?​

optional uniqueKey?: string

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

The write's idempotency key: 1 to 128 characters of A-Za-z0-9._:-. Reuse a key only to retry the SAME write. Omitted: a fresh <uniqueKeyPrefix><uuid v4> is minted (CSPRNG).

Inherited from​

WriteKeyInput.uniqueKey