Burn Blocked Funds

Burns the funds backing a blocked receipt.

Usage

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

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

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 receivePolicy.burn action and wait for inclusion manually:

import { Actions } from 'viem/tempo'
import { client } from './viem.config'
 
const hash = await client.receivePolicy.burn({
  receipt: '0x1234',
})
const receipt = await client.transaction.waitForReceipt({ hash }).receipt
 
const { args } = Actions.receivePolicy.burn.extractEvent(receipt.logs)

Recipes

Destroy Payments from Sanctioned Senders

Decode the receipt with ReceivePolicyReceipt.decode to screen the originator, then burn funds that must not be released and claim the rest with receivePolicy.claimSync.

import { ReceivePolicyReceipt } from 'viem/tempo'
import { client } from './viem.config'
 
const sanctioned = new Set(['0x000000000000000000000000000000000000dead'])
 
// Receipt captured from a `TransferBlocked` event.
const blockedReceipt = '0x1234'
 
const { originator } = ReceivePolicyReceipt.decode(blockedReceipt)
if (sanctioned.has(originator.toLowerCase()))
  await client.receivePolicy.burnSync({ receipt: blockedReceipt })
else
  await client.receivePolicy.claimSync({
    receipt: blockedReceipt,
    to: client.account.address,
  })

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

Burn Airdrop Dust Automatically

Combine receivePolicy.watchBlocked with a dust threshold to destroy unwanted airdrops your token policy blocks, instead of accumulating unclaimed receipts.

import { client } from './viem.config'
 
const watcher = client.receivePolicy.watchBlocked({
  args: { receiver: client.account.address },
})
 
watcher.onLogs(async (logs) => {
  for (const log of logs) {
    if (log.args.amount >= 1_000_000n) continue
    await client.receivePolicy.burnSync({ receipt: log.args.receipt })
  }
})

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

Return Value

type ReturnType = {
  token: Address
  receiver: Address
  blockedNonce: bigint
  blockedAt: bigint
  receiptVersion: number
  originator: Address
  recipient: Address
  recoveryAuthority: Address
  caller: Address
  amount: bigint
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

The burned receipt event arguments and the transaction receipt.

Parameters

receipt

• Type: Hex

The encoded claim receipt.

account (optional)

• Type: Account | Address

Account that will be used to send the transaction.

feePayer (optional)

• Type: Account | boolean

Fee payer for the transaction (TIP-1 gas sponsorship).

Pass true to defer the fee token to an external fee payer (e.g. a relay), or a local Account to co-sign the transaction as the fee payer.

feeToken (optional)

• Type: Address | bigint

Fee token for the transaction.

Can be an unpaused USD-denominated TIP-20 token address or ID.

gas (optional)

• Type: bigint

Gas limit for the transaction.

keyAuthorization (optional)

• Type: KeyAuthorization

Signed key authorization to include with the transaction, authorizing an access key to act for the sending account.

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' | 'random' | bigint

Nonce key for the transaction (TIP-1009 2D nonces).

Use 'expiring' to select an expiring nonce, which enables concurrent transaction submission without nonce ordering. Use 'random' to select a random key.

throwOnReceiptRevert (optional)

• Type: boolean
• Default: true

Whether a Sync action throws when the receipt reports a revert.

validAfter (optional)

• Type: number

Unix timestamp after which the transaction can be included.

validBefore (optional)

• Type: number

Unix timestamp before which the transaction must be included.