token.useBurn

Burns TIP-20 tokens from the caller's balance.

Usage

example.ts

import {  } from 'wagmi/tempo'
import {  } from 'viem'

const  = ..()

// Call `mutate` in response to user action (e.g. button click, form submission)
.({
  : ('10.5', 6),
  : '0x20c0000000000000000000000000000000000000',
})

.('Burned amount:', .?.)
.('From:', .?.)
Burned amount: 10500000n
From: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb

config.ts

import { createConfig, http } from 'wagmi'
import { tempoTestnet } from 'wagmi/chains'
import { KeyManager, webAuthn } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [
    webAuthn({
      keyManager: KeyManager.localStorage(),
    }),
  ],
  chains: [tempoTestnet],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempoTestnet.id]: http(),
  },
})

Asynchronous Usage

The example above uses a *Sync variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync token.burn action and wait for inclusion manually:

import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { parseUnits } from 'viem'
import { useWaitForTransactionReceipt } from 'wagmi'

const burn = Hooks.token.useBurn()
const { data: receipt } = useWaitForTransactionReceipt({ hash: burn.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
burn.mutate({
  amount: parseUnits('10.5', 6),
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const { args: { amount, from } } 
    = Actions.token.burn.extractEvent(receipt.logs)

Return Type

See TanStack Query mutation docs for more info hook return types.

data

See Wagmi Action token.burn Return Type

mutate/mutateAsync

See Wagmi Action token.burn Parameters

Parameters

config

Config | undefined

Config to use instead of retrieving from the nearest WagmiProvider.

mutation

See the TanStack Query mutation docs for more info hook parameters.

Action

• token.burn