Skip to content
LogoLogo

channel.close

Closes a TIP-20 channel reserve channel from the payee or operator side, settles the signed voucher amount, and refunds the remaining deposit to the payer.

Usage

import { parseUnits } from 'viem'
import { client, channel } from './viem.config'
 
const { receipt, refundedToPayer, settledToPayee } =
  await client.channel.closeSync({
    captureAmount: parseUnits('40', 6),
    cumulativeAmount: parseUnits('40', 6),
    channel,
    signature: '0x...',
  })
 
console.log('Settled:', settledToPayee)
console.log('Refunded:', refundedToPayer)
console.log('Transaction hash:', receipt.transactionHash)

Voucher Signature

The signature should be produced by the payer, or the channel's authorizedSigner.

import { parseUnits } from 'viem'
import { client, channel } from './viem.config'
 
const signature = await client.channel.signVoucher({
  channel,
  cumulativeAmount: parseUnits('40', 6),
})

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

import { Actions } from 'viem/tempo'
import { client, channel } from './viem.config'
 
const hash = await client.channel.close({
  captureAmount: 40000000n,
  cumulativeAmount: 40000000n,
  channel,
  signature: '0x...',
})
const receipt = await client.waitForTransactionReceipt({ hash })
 
const { args } = Actions.channel.close.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

captureAmount

  • Type: bigint

Amount to capture for the payee during close.

cumulativeAmount

  • Type: bigint

Total voucher amount signed for the channel.

channel

  • Type: Channel.from.Value

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

signature

  • Type: Hex

Voucher signature for the cumulative amount.

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.

Suggest changes to this page