Skip to content

@gala-chain/chaincodeAPI


API > burnTokens

Function: burnTokens()

burnTokens(ctx, param1): Promise\<TokenBurn[]>

Parameters

ctx: GalaChainContext

param1: BurnsTokensParams

Returns

Description

Burn a quantity of tokens described by one or more TokenInstanceKeys belonging to a single owner.

Remarks

The optional preValidated? boolean is intended for use internally by other chaincode contract methods that have already validated identities, allowances, and authorization to burn.

For example, a burning bridge may need to burn tokens while executing bridgeTokenOut actions.

Source

chaincode/src/burns/burnTokens.ts:72