Close Channel

channel.close

Closes a TIP-20 channel reserve channel from the payee or operator side.

Usage

import {  } from './viem.config'
 
const  = {
  : '0x0000000000000000000000000000000000000000',
  : '0x0000000000000000000000000000000000000000000000000000000000000000',
  : '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
  : '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
  : '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  : '0x0000000000000000000000000000000000000000000000000000000000000101',
  : '0x20c0000000000000000000000000000000000001',
} as 
 
const { , ... } = await ..({
  : 40000000n,
  : 40000000n,
  ,
  : '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1b',
})
 
.('Closed:', )
Closed: { channelId: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef', payer: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb', payee: '0x70997970C51812dc3A010C7d01b50e0d17dc79C8', settledToPayee: 40000000n, refundedToPayer: 60000000n }

import { ,  } from 'viem/tempo'
 
export const  = .({
  : .('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 channel.close action and wait for inclusion manually:

import {  } from 'viem/tempo'
import {  } from './viem.config'
 
const  = {
  : '0x0000000000000000000000000000000000000000',
  : '0x0000000000000000000000000000000000000000000000000000000000000000',
  : '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
  : '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
  : '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  : '0x0000000000000000000000000000000000000000000000000000000000000101',
  : '0x20c0000000000000000000000000000000000001',
} as 
 
const  = await ..({
  : 40000000n,
  : 40000000n,
  ,
  : '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1b',
})
const  = await ..({  }).
 
const {  } = ...(.)

Recipes

Capture Only the Unsettled Remainder

Combine channel.getStates with captureAmount to take what earlier settlements have not yet paid out when closing on the final voucher.

import {  } from 'viem/tempo'
import {  } from './viem.config'
 
const  = .({
  : '0x0000000000000000000000000000000000000000000000000000000000000000',
  : ..,
  : '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  : '0x0000000000000000000000000000000000000000000000000000000000000101',
  : '0x20c0000000000000000000000000000000000000',
})
 
// Final voucher received from the payer.
const  = 75_000000n
 
const  = await ..({  })
 
await ..({
  :  - .,
  ,
  ,
  : '0x...',
})

import { ,  } from 'viem/tempo'
 
export const  = .({
  : .('0x...'),
})

Refund Part of a Tab at Close

Pass a captureAmount below the voucher's cumulativeAmount to return the difference to the payer, resolving a dispute or refund without a separate transfer.

import {  } from 'viem/tempo'
import {  } from './viem.config'
 
// Channel opened with a 100 pathUSD deposit.
const  = .({
  : '0x0000000000000000000000000000000000000000000000000000000000000000',
  : ..,
  : '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  : '0x0000000000000000000000000000000000000000000000000000000000000101',
  : '0x20c0000000000000000000000000000000000000',
})
 
const { ,  } = await ..({
  : 65_000000n,
  : 80_000000n,
  ,
  : '0x...',
})
 
.({ ,  })
{ settledToPayee: 65000000n, refundedToPayer: 35000000n }

import { ,  } from 'viem/tempo'
 
export const  = .({
  : .('0x...'),
})

Return Value

type ReturnType = {
  /** Channel ID. */
  channelId: Hex
  /** Channel payer. */
  payer: Address
  /** Channel payee. */
  payee: Address
  /** Amount settled to the payee. */
  settledToPayee: bigint
  /** Amount refunded to the payer. */
  refundedToPayer: bigint
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

The transaction receipt and decoded event data.

Parameters

captureAmount

Type: bigint

Amount to capture for the payee during close.

channel

Type: Channel

TIP-20 channel.

cumulativeAmount

Type: bigint

Total voucher amount signed for the channel.

signature

Type: Hex

Voucher signature.

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.

Suggest changes to this page