zone.encryptedDeposit

Deposits tokens into a zone on the parent Tempo chain with an encrypted recipient and memo. The recipient and memo are encrypted client-side using ECIES (AES-256-GCM) with the sequencer's public encryption key so that only the zone sequencer can decrypt the deposit details.

Usage

import { parseUnits } from 'viem'
import { client } from './viem.config'
 
const { receipt } = await client.zone.encryptedDepositSync({
  amount: parseUnits('100', 6),
  token: '0x20c0000000000000000000000000000000000001',
  zoneId: 7,
})
 
console.log('Transaction hash:', receipt.transactionHash)

import { Account, createClient } from 'viem/tempo'
 
export const client = createClient({
  account: Account.fromSecp256k1('0x...'),
})

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

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

Prepared Usage

Use zone.encryptedDeposit.prepare when one party should choose the private zone recipient, but another party will submit the parent-chain deposit transaction.

import { parseUnits } from 'viem'
import { broadcaster, client } from './viem.config'
 
const prepared = await client.zone.encryptedDeposit.prepare({
  amount: parseUnits('100', 6),
  recipient: '0x0000000000000000000000000000000000000001',
  token: '0x20c0000000000000000000000000000000000001',
  zoneId: 7,
})
 
const hash = await broadcaster.zone.encryptedDeposit(prepared)

import { Account, createClient } from 'viem/tempo'
 
export const client = createClient({
  account: Account.fromSecp256k1('0x...'),
})
 
 
export const broadcaster = client

Return Type

type ReturnType = {
  /** Transaction receipt */
  receipt: TransactionReceipt
}

Parameters

amount

• Type: bigint

Amount of tokens to deposit.

token

• Type: Address | bigint

Token address or ID to deposit.

zoneId

• Type: number

Zone ID to deposit into (e.g. 7).

memo (optional)

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

Optional deposit memo. Encrypted along with the recipient.

recipient (optional)

• Type: Address
• Default: account.address

Recipient address in the zone. Encrypted in the on-chain payload.

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.