Skip to main content

index/interfaces/BurnTokensData.md

Data required for burning tokens on GalaChain

IRREVERSIBLE: Burned tokens are permanently destroyed and cannot be recovered. Use with caution. This operation reduces total supply.

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

Batch Limits: Maximum MAX_BURN_BATCH_SIZE tokens per operation (default: 50). This conservative limit exists due to the irreversible nature of burn operations.

Properties​

PropertyTypeDescription
privateKey?stringOptional private key override for this operation (format: '0x' + 64 hex characters)
tokensBurnTokenEntry[]Array of tokens to burn - supports multiple token types in single transaction
uniqueKey?stringOptional unique key for idempotency - auto-generated if not provided