zone.requestWithdrawal

Requests a withdrawal from a zone to the parent Tempo chain.

Usage

import { createPublicClient, http, parseUnits } from 'viem'
import { tempoModerato } from 'viem/chains'
import { Abis, getPortalAddress } from 'viem/tempo/zones'
import { client } from './zones.config'
 
const { receipt, senderTag } = await client.zone.requestWithdrawalSync({
  amount: parseUnits('100', 6),
  token: '0x20c0000000000000000000000000000000000001',
})
 
console.log('Transaction hash:', receipt.transactionHash)
 
// After the sequencer processes the withdrawal on the parent chain,
// query its indexed WithdrawalProcessed event by senderTag.
const tempoClient = createPublicClient({
  chain: tempoModerato,
  transport: http(),
})
const [withdrawal] = await tempoClient.getContractEvents({
  address: getPortalAddress(tempoModerato.id, 7),
  abi: Abis.zonePortal,
  eventName: 'WithdrawalProcessed',
  args: { senderTag },
  fromBlock: 0n,
})
 
console.log('Tempo transaction hash:', withdrawal?.transactionHash)

import { privateKeyToAccount } from 'viem/accounts'
import { createClient } from 'viem/tempo'
import { http, zoneModerato } from 'viem/tempo/zones'
 
export const client = createClient({
  account: privateKeyToAccount('0x...'),
  chain: zoneModerato(7),
  transport: 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 zone.requestWithdrawal action and wait for inclusion manually:

import { parseUnits } from 'viem'
import { client } from './zones.config'
 
const hash = await client.zone.requestWithdrawal({
  amount: parseUnits('100', 6),
  token: '0x20c0000000000000000000000000000000000001',
})
const receipt = await client.waitForTransactionReceipt({ hash })

Prepare a Withdrawal

Use zone.requestWithdrawal.prepare to populate and inspect the Zone transaction request without broadcasting. The result includes the request, normalized withdrawal details, and a maxFee rounded up into fee-token base units using Tempo's fixed gas-price conversion.

Use zone.getWithdrawalFee separately to inspect the protocol withdrawal fee.

import { parseUnits } from 'viem'
import { client } from './zones.config'
 
const prepared = await client.zone.requestWithdrawal.prepare({
  amount: parseUnits('100', 6),
  callbackGas: 10_000_000n,
  token: '0x20c0000000000000000000000000000000000001',
})
 
console.log('Maximum fee:', prepared.maxFee)
console.log('Gas limit:', prepared.request.gas)
console.log('Calls:', prepared.request.calls)

The prepare helper returns:

type PreparedWithdrawal = {
  amount: bigint
  callbackGas: bigint
  data: Hex
  fallbackRecipient: Address
  maxFee: bigint
  memo: Hex
  request: PrepareTransactionRequestReturnType
  to: Address
  token: Address | bigint
}

Return Type

type ReturnType = {
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Sender tag identifying the indexed parent-chain WithdrawalProcessed event */
  senderTag: Hash
}

Parameters

amount

• Type: bigint

Amount of tokens to withdraw.

token

• Type: Address | bigint

Token address or ID to withdraw.

to (optional)

• Type: Address
• Default: account.address

Recipient address on the parent Tempo chain.

data (optional)

• Type: Hex
• Default: '0x'

Optional callback data for the recipient.

fallbackRecipient (optional)

• Type: Address
• Default: to

Fallback address if callback fails.

callbackGas (optional)

• Type: bigint
• Default: 0n

Gas limit reserved for the withdrawal callback on the parent chain.

gas (optional)

• Type: bigint
• Default: 10_000_000n

Transaction gas limit on the Zone chain.

memo (optional)

• Type: Hex
• Default: 0x00...00

Optional withdrawal memo.

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.