burn_token
Burn factory-token atoms from this wallet, removing them from circulation and reducing the factory's supply ledger. It waits for settlement and returns status plus transaction hash.
Instructions
Burn an amount of a factory token this wallet holds: the coins leave circulation and the factory's supply ledger drops. Built, proven and signed here, a sponsor pays; the factory has to be on the sponsor's contract list and burn on its circuit list. Names the token by its name and issuer: without issuerKey the token is one this wallet minted. The tool waits until the job settled (about 1 minute) and returns { status, txHash, transactionHash, result }. failed: next says what to do. If the call was cut off or came back pending, run it again with the same arguments: it picks up the job it started and submits nothing new (the answer says deduplicated). A second, separate call with the same arguments needs a new idempotencyKey.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Token name, at most 32 UTF-8 bytes | |
| amount | Yes | Atoms to burn; a decimal string is exact | |
| issuerKey | No | The issuer of the token (64 hex, from mint_token); default this wallet's own issuer | |
| idempotencyKey | No | Dedupes retries | |
| contractAddress | Yes | The token-factory deployment the token was minted on |