channel.withdraw

Withdraws payer funds after the close grace period elapses.

Usage

import { client, channel } from './viem.config'
 
const { receipt, refundedToPayer, settledToPayee } =
  await client.channel.withdrawSync({
    channel,
  })
 
console.log('Settled:', settledToPayee)
console.log('Refunded:', refundedToPayer)
console.log('Transaction hash:', receipt.transactionHash)

import { Account, createClient } from 'viem/tempo'
 
export const client = createClient({
  account: Account.fromSecp256k1('0x...'),
})
 
import { Channel } from 'viem/tempo'
 
export const channel = Channel.from({
  expiringNonceHash:
    '0x0000000000000000000000000000000000000000000000000000000000000000',
  payee: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  payer: client.account.address,
  salt: '0x0000000000000000000000000000000000000000000000000000000000000000',
  token: '0x20c0000000000000000000000000000000000001',
})

Call channel.requestClose first, then wait for the close grace period before calling channel.withdraw.

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

import { Actions } from 'viem/tempo'
import { client, channel } from './viem.config'
 
const hash = await client.channel.withdraw({
  channel,
})
const receipt = await client.waitForTransactionReceipt({ hash })
 
const { args } = Actions.channel.withdraw.extractEvent(receipt.logs)

Return Type

type ReturnType = {
  /** Channel ID */
  channelId: Hex
  /** Account that receives settled voucher payments */
  payee: Address
  /** Account that funded the channel and receives refunds */
  payer: Address
  /** Amount refunded to the payer */
  refundedToPayer: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Amount settled to the payee */
  settledToPayee: bigint
}

Parameters

channel

• Type: Channel.from.Value

Channel containing the payer, payee, operator, token, salt, authorized signer, and expiring nonce hash.

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.