zone.encryptedDeposit

Deposits tokens into a zone with an encrypted recipient and memo.

Use the *Sync variant when you want the receipt before continuing. The non-sync zone.encryptedDeposit action returns the transaction hash immediately.

Requires viem >=2.48.0

Zone actions and hooks require viem >=2.48.0.

Usage

example.ts

import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { config } from './config'

const result = await Actions.zone.encryptedDepositSync(config, {
  amount: parseUnits('10', 6),
  token: '0x20c0000000000000000000000000000000000001',
  zoneId: 7,
})

console.log('Transaction hash:', result.receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef

config.ts

import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

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 { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.zone.encryptedDeposit(config, {
  amount: parseUnits('10', 6),
  token: '0x20c0000000000000000000000000000000000001',
  zoneId: 7,
})
const receipt = await waitForTransactionReceipt(config, { hash })

console.log(receipt.status)

Return Type

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

Returns the transaction receipt from zone.encryptedDepositSync.

Parameters

amount

• Type: bigint

Amount of tokens to deposit.

token

• Type: Address | bigint

Address or ID of the TIP-20 token to deposit.

zoneId

• Type: number

Zone ID to deposit into.

memo (optional)

• Type: Hex

Optional memo that will be encrypted together with the recipient.

recipient (optional)

• Type: Address

Recipient address in the destination zone. Defaults to the connected account address before encryption.

account (optional)

• Type: Account | Address

Account that will be used to send the transaction. Defaults to connected Wagmi account.

feeToken (optional)

• Type: Address | bigint

Fee token for the transaction.

Can be a TIP-20 token address or ID.

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.

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.

Viem

• zone.encryptedDeposit