Top Up Channel
channel.topUp
Adds deposit to a TIP-20 channel reserve channel.
Usage
import { } from './viem.config'
const = {
: '0x0000000000000000000000000000000000000000',
: '0x0000000000000000000000000000000000000000000000000000000000000000',
: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
: '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
: '0x0000000000000000000000000000000000000000000000000000000000000101',
: '0x20c0000000000000000000000000000000000001',
} as
const { , ... } = await ..({
: 25000000n,
,
})
.('Top up:', )
Top up: { channelId: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef', payer: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb', payee: '0x70997970C51812dc3A010C7d01b50e0d17dc79C8', additionalDeposit: 25000000n, newDeposit: 125000000n }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.topUp 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 ..({
: 25000000n,
,
})
const = await ..({ }).
const { } = ...(.)Recipes
Keep a Metered Channel Funded
Combine channel.getStates with a headroom check to refill before signed vouchers exhaust the deposit, so payments never stall mid-stream.
import { } from 'viem/tempo'
import { } from './viem.config'
const = .({
: '0x0000000000000000000000000000000000000000000000000000000000000000',
: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
: ..,
: '0x0000000000000000000000000000000000000000000000000000000000000101',
: '0x20c0000000000000000000000000000000000000',
})
// Highest cumulative amount you have signed so far.
const = 88_000000n
const = await ..({ })
if (. - < 20_000000n)
await ..({
: 100_000000n,
,
})import { , } from 'viem/tempo'
export const = .({
: .('0x...'),
})Cover an Invoice That Exceeds the Deposit
Size additionalDeposit to the exact shortfall before signing a voucher above the current deposit with channel.signVoucher.
import { } from 'viem/tempo'
import { } from './viem.config'
const = .({
: '0x0000000000000000000000000000000000000000000000000000000000000000',
: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
: ..,
: '0x0000000000000000000000000000000000000000000000000000000000000101',
: '0x20c0000000000000000000000000000000000000',
})
// Next voucher total, including the new invoice.
const = 150_000000n
const = await ..({ })
const = - .
if ( > 0n)
await ..({
: ,
,
})
const = await ..({
,
,
})import { , } from 'viem/tempo'
export const = .({
: .('0x...'),
})Return Value
type ReturnType = {
/** Channel ID. */
channelId: Hex
/** Channel payer. */
payer: Address
/** Channel payee. */
payee: Address
/** Additional deposit. */
additionalDeposit: bigint
/** New total deposit. */
newDeposit: bigint
/** Transaction receipt. */
receipt: TransactionReceipt
}The transaction receipt and decoded event data.
Parameters
additionalDeposit
- Type:
bigint
Additional deposit to lock in the channel.
channel
- Type:
Channel
TIP-20 channel.
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.