Skip to main content

index/interfaces/UnlockTokensData.md

Data required for unlocking previously locked tokens on GalaChain (batch operation)

Supports unlocking multiple token types in a single transaction. Must be signed by the lock authority (the address that locked the tokens or was designated as lock authority during the lock operation).

Batch Behavior: Each token in the batch is processed as part of a single GalaChain transaction. The transaction either succeeds completely (all tokens unlocked) or fails completely (no tokens unlocked). However, network errors after submission may require checking transaction status to confirm the outcome.

Batch Limits: Maximum MAX_UNLOCK_BATCH_SIZE tokens per operation (default: 100).

Properties​

PropertyTypeDescription
privateKey?stringOptional private key override for this operation (format: '0x' + 64 hex characters)
tokensUnlockTokenEntry[]Array of tokens to unlock (each with tokenId or tokenName, amount, and optional name)
uniqueKey?stringOptional unique key for idempotency - auto-generated if not provided