receivePolicy.burn

Burns the funds backing a blocked receipt. Requires the caller to hold the token's BURN_BLOCKED_ROLE, and is only valid when the receipt's policy subject is currently unauthorized as a sender under the token's TIP-403 policy. Learn more about transfer policies

Usage

import { client } from './viem.config'
 
const { receipt } = await client.receivePolicy.burnSync({
  receipt: '0x...',
})
 
console.log('Transaction hash:', receipt.transactionHash)
Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef

import { Account, createClient } from 'viem/tempo'
 
export const client = createClient({
  account: Account.fromSecp256k1('0x...'),
})

Asynchronous Usage

The example above uses the burnSync variant, which waits for the transaction to be included before returning.

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

import { client } from './viem.config'
 
const hash = await client.receivePolicy.burn({
  receipt: '0x...',
})
const receipt = await client.waitForTransactionReceipt({ hash })

Return Type

burn

type ReturnType = Hash

Returns the transaction hash.

burnSync

type ReturnType = {
  /** Event data from the `ReceiptBurned` event. */
  // ...
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

Returns the ReceiptBurned event arguments along with the transaction receipt.

Parameters

receipt

• Type: Hex

The encoded claim receipt (the witness emitted by a TransferBlocked event).

throwOnReceiptRevert (optional, burnSync only)

• Type: boolean
• Default: true

Whether to throw if the transaction's receipt status is reverted.

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, or true if a Fee Payer Service 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), 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.