# `token.burnBlocked`

Burns TIP-20 tokens from a blocked address. Requires the `BURN_BLOCKED` role. [Learn more about token roles](https://docs.tempo.xyz/protocol/tip403/spec)

## Usage

:::code-group

```ts twoslash [example.ts]
import { client } from './viem.config'

const { receipt } = await client.token.burnBlockedSync({
  amount: { formatted: '10.5' },
  from: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: 'pathusd',
})

console.log('Transaction hash:', receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts twoslash [viem.config.ts] filename="viem.config.ts"
// [!include ~/snippets/tempo/viem.config.ts:setup]
```

:::

### By Token Address

When passing a token address, include `amount.decimals` so the formatted amount can be parsed.

:::code-group

```ts twoslash [example.ts]
import { client } from './viem.config'

const { receipt } = await client.token.burnBlockedSync({
  amount: { decimals: 6, formatted: '10.5' },
  from: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})
```

```ts twoslash [viem.config.ts] filename="viem.config.ts"
// [!include ~/snippets/tempo/viem.config.ts:setup]
```

:::

### Base Amounts

Pass a `bigint` to use the token's base unit amount directly.

:::code-group

```ts twoslash [example.ts]
import { client } from './viem.config'

const { receipt } = await client.token.burnBlockedSync({
  amount: 10500000n,
  from: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: 'pathusd',
})
```

```ts twoslash [viem.config.ts] filename="viem.config.ts"
// [!include ~/snippets/tempo/viem.config.ts:setup]
```

:::

### Asynchronous Usage

The examples above use 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.burnBlocked` action and wait for inclusion manually:

```ts twoslash
import { Actions } from 'viem/tempo'
import { client } from './viem.config'

const hash = await client.token.burnBlocked({
  amount: { formatted: '10.5' },
  from: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: 'pathusd',
})
const receipt = await client.waitForTransactionReceipt({ hash })

const { args } 
  = Actions.token.burnBlocked.extractEvent(receipt.logs)
```

## Return Type

```ts
type ReturnType = {
  /** Amount of tokens burned */
  amount: bigint
  /** Address tokens were burned from */
  from: Address
  /** Transaction receipt */
  receipt: TransactionReceipt
}
```

## Parameters

### amount

* **Type:** `bigint | { decimals?: number, formatted: string }`

Amount to burn in base units. Use `{ formatted: '10.5' }` to parse a human-readable
decimal string for a chain-declared token, or include `amount.decimals` when using a
token address.

### from

* **Type:** `Address`

Address to burn tokens from.

### token

* **Type:** `string | bigint`

Token to operate on: a [chain-declared](/tokens/tokens#token-lookup) token name (resolving
its `address` and `decimals`), a TIP-20 token id, or a token address.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be an unpaused USD-denominated TIP-20 token address or ID. Use `client.fee.validateToken({ token })` to validate a token before submitting a transaction or setting it as a fee preference.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction. Use `'expiring'` to use [expiring nonces (TIP-1009)](https://docs.tempo.xyz/protocol/tips/tip-1009), which enables concurrent transaction submission without nonce ordering.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.