FT4 Library/lib.ft4.external.assets/burn

burn

@mount("ft4.burn") operation burn(asset_id: byte_array, amount: big_integer)(source)

Deletes tokens from an account's balance, decreasing the total supply by the amount being burned.

Must be signed by an auth descriptor with accounts.auth_flags.TRANSFER

Throws if the required assets cannot be burned. Common cases include:

  • the account balance is lower than amount

  • the amount to burn is not in the accepted range (0; 2^256) (exclusive)

  • some conditions added in development through burn extensions (before_burn or after_burn) aren't met

Parameters

asset_id

id of the asset to burn

amount

the amount of tokens to burn