viem 2.55.18 → 2.56.0

package/tempo/actions/zone.ts

@@ -6,12 +6,19 @@ import * as Secp256k1 from 'ox/Secp256k1'
 import { TokenId, ZoneId, ZoneRpcAuthentication } from 'ox/tempo'
 import type { Account } from '../../accounts/types.js'
 import { parseAccount } from '../../accounts/utils/parseAccount.js'
+import {
+  type GetContractReturnType,
+  getContract,
+} from '../../actions/getContract.js'
 import {
   type MulticallErrorType,
   type MulticallParameters,
   multicall,
 } from '../../actions/public/multicall.js'
-import { readContract } from '../../actions/public/readContract.js'
+import {
+  type ReadContractErrorType,
+  readContract,
+} from '../../actions/public/readContract.js'
 import {
   type PrepareTransactionRequestErrorType,
   type PrepareTransactionRequestRequest,
@@ -24,6 +31,7 @@ import {
 } from '../../actions/wallet/sendTransaction.js'
 import { sendTransactionSync } from '../../actions/wallet/sendTransactionSync.js'
 import type { Client } from '../../clients/createClient.js'
+import type { PublicClient } from '../../clients/createPublicClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import { zeroHash } from '../../constants/bytes.js'
 import type { BaseErrorType } from '../../errors/base.js'
@@ -60,11 +68,24 @@ import {
 import * as WithdrawalSenderTag from '../internal/WithdrawalSenderTag.js'
 import * as Storage from '../Storage.js'
 import type { TransactionReceipt } from '../Transaction.js'
-import * as ZoneAbis from '../zones/Abis.js'
-import { getPortalAddress } from '../zones/zone.js'
 
 const defaultWithdrawalGas = 10_000_000n
 
+// TODO: Remove this compatibility ABI when T10 support is retired.
+// Later Zone deployments append the derived address to these two values.
+const sequencerEncryptionKeyAbi = [
+  {
+    name: 'sequencerEncryptionKey',
+    type: 'function',
+    stateMutability: 'view',
+    inputs: [],
+    outputs: [
+      { type: 'bytes32', name: 'x' },
+      { type: 'uint8', name: 'yParity' },
+    ],
+  },
+] as const
+
 export type EncryptedPayload = {
   ciphertext: Hex.Hex
   ephemeralPubkeyX: Hex.Hex
@@ -144,9 +165,6 @@ export async function deposit<
   client: Client<Transport, chain, account>,
   parameters: deposit.Parameters<chain, account>,
 ): Promise<deposit.ReturnValue> {
-  const chainId = client.chain?.id
-  if (!chainId) throw new Error('`chain` is required.')
-
   const { account = client.account, ...rest } = parameters
 
   const account_ = account ? parseAccount(account) : undefined
@@ -157,7 +175,6 @@ export async function deposit<
     parameters.tempoRefundRecipient ?? account_.address
   const args = {
     ...parameters,
-    chainId,
     recipient,
     tempoRefundRecipient,
   }
@@ -173,7 +190,7 @@ export namespace deposit {
     chain extends Chain | undefined = Chain | undefined,
     account extends Account | undefined = Account | undefined,
   > = WriteParameters<chain, account> &
-    Omit<Args, 'chainId' | 'recipient' | 'tempoRefundRecipient'> & {
+    Omit<Args, 'recipient' | 'tempoRefundRecipient'> & {
       /** Recipient address in the zone. @default `account.address` */
       recipient?: Address | undefined
       /** Refund recipient on the parent chain. @default `account.address` */
@@ -183,11 +200,9 @@ export namespace deposit {
   export type Args = {
     /** Amount of tokens to deposit. */
     amount: bigint
-    /** Parent chain ID (e.g. `42431` for moderato). */
-    chainId: number
     /** Optional deposit memo. @default `0x00...00` */
     memo?: Hex.Hex | undefined
-    /** Zone portal address. @default resolved via the portal registry. */
+    /** Zone portal address. @default derived from `zoneId`. */
     portalAddress?: Address | undefined
     /** Recipient address in the zone. */
     recipient: Address
@@ -213,15 +228,13 @@ export namespace deposit {
   export function calls(args: Args) {
     const {
       amount,
-      chainId,
       memo = zeroHash,
       recipient,
       tempoRefundRecipient,
       token,
       zoneId,
     } = args
-    const portalAddress =
-      args.portalAddress ?? getPortalAddress(chainId, zoneId)
+    const portalAddress = args.portalAddress ?? Addresses.zonePortal(zoneId)
     const tokenAddress = TokenId.toAddress(token)
     const approveCall = defineCall({
       address: tokenAddress,
@@ -231,7 +244,7 @@ export namespace deposit {
     })
     const depositCall = defineCall({
       address: portalAddress,
-      abi: ZoneAbis.zonePortal,
+      abi: Abis.zonePortal,
       functionName: 'deposit',
       args: [tokenAddress, recipient, amount, memo, tempoRefundRecipient],
     })
@@ -274,9 +287,6 @@ export async function depositSync<
   client: Client<Transport, chain, account>,
   parameters: depositSync.Parameters<chain, account>,
 ): Promise<depositSync.ReturnValue> {
-  const chainId = client.chain?.id
-  if (!chainId) throw new Error('`chain` is required.')
-
   const {
     account = client.account,
     throwOnReceiptRevert = true,
@@ -291,7 +301,6 @@ export async function depositSync<
     parameters.tempoRefundRecipient ?? account_.address
   const args = {
     ...parameters,
-    chainId,
     recipient,
     tempoRefundRecipient,
   }
@@ -348,11 +357,8 @@ export async function getEncryptionKey<chain extends Chain | undefined>(
   client: Client<Transport, chain>,
   parameters: getEncryptionKey.Parameters,
 ): Promise<getEncryptionKey.ReturnValue> {
-  const chainId = client.chain?.id
-  if (!chainId) throw new Error('`chain` is required.')
-
   const { account, portalAddress: portalAddress_, zoneId, ...rest } = parameters
-  const portalAddress = portalAddress_ ?? getPortalAddress(chainId, zoneId)
+  const portalAddress = portalAddress_ ?? Addresses.zonePortal(zoneId)
   const [keyCountResult, publicKeyResult] = await multicall(client, {
     ...rest,
     account: account ? parseAccount(account).address : undefined,
@@ -392,7 +398,7 @@ export namespace getEncryptionKey {
     }
 
   export type Args = {
-    /** Zone portal address. @default resolved via the portal registry. */
+    /** Zone portal address. @default derived from `zoneId`. */
     portalAddress?: Address | undefined
     /** Zone ID (e.g. `7`). */
     zoneId: number
@@ -424,18 +430,140 @@ export namespace getEncryptionKey {
     return [
       defineCall({
         address: args.portalAddress,
-        abi: ZoneAbis.zonePortal,
+        abi: Abis.zonePortal,
         functionName: 'encryptionKeyCount',
       }),
       defineCall({
         address: args.portalAddress,
-        abi: ZoneAbis.zonePortal,
+        abi: sequencerEncryptionKeyAbi,
         functionName: 'sequencerEncryptionKey',
       }),
     ] as const
   }
 }
 
+/**
+ * Gets metadata and configuration for a zone portal.
+ *
+ * @example
+ * ```ts
+ * import { createClient, http } from 'viem'
+ * import { tempoModerato } from 'viem/chains'
+ * import { Actions } from 'viem/tempo'
+ *
+ * const client = createClient({
+ *   chain: tempoModerato,
+ *   transport: http(),
+ * })
+ *
+ * const info = await Actions.zone.getPortalInfo(client, {
+ *   zoneId: 7,
+ * })
+ * ```
+ *
+ * @param client - Public client connected to the parent Tempo chain.
+ * @param parameters - Zone portal parameters.
+ * @returns The portal metadata and configuration.
+ */
+export async function getPortalInfo<chain extends Chain | undefined>(
+  client: Client<Transport, chain>,
+  parameters: getPortalInfo.Parameters,
+): Promise<getPortalInfo.ReturnValue> {
+  const { portalAddress: portalAddress_, zoneId, ...rest } = parameters
+  const portal = getContract({
+    abi: Abis.zonePortal,
+    address: portalAddress_ ?? Addresses.zonePortal(zoneId),
+    client,
+  }) as unknown as GetContractReturnType<
+    typeof Abis.zonePortal,
+    PublicClient<Transport, Chain>
+  >
+  const [
+    admin,
+    enabledTokenCount,
+    messenger,
+    pauseExpiry,
+    paused,
+    pendingAdmin,
+    sequencerCount,
+    sequencerSetVersion,
+    sequencerThreshold,
+    verifier,
+  ] = await Promise.all([
+    portal.read.admin(rest),
+    portal.read.enabledTokenCount(rest),
+    portal.read.messenger(rest),
+    portal.read.pauseExpiry(rest),
+    portal.read.paused(rest),
+    portal.read.pendingAdmin(rest),
+    portal.read.sequencerCount(rest),
+    portal.read.sequencerSetVersion(rest),
+    portal.read.sequencerThreshold(rest),
+    portal.read.verifier(rest),
+  ])
+  const [sequencers, enabledTokens] = await Promise.all([
+    Promise.all(
+      Array.from({ length: Number(sequencerCount) }, (_, index) =>
+        portal.read.sequencerAt([BigInt(index)], rest),
+      ),
+    ),
+    Promise.all(
+      Array.from({ length: Number(enabledTokenCount) }, (_, index) =>
+        portal.read.enabledTokenAt([BigInt(index)], rest),
+      ),
+    ),
+  ])
+
+  return {
+    admin,
+    enabledTokens,
+    messenger,
+    pauseExpiry,
+    paused,
+    pendingAdmin,
+    sequencers,
+    sequencerSetVersion,
+    sequencerThreshold,
+    verifier,
+  }
+}
+
+export namespace getPortalInfo {
+  export type Parameters = ReadParameters & Args
+
+  export type Args = {
+    /** Zone portal address. @default derived from `zoneId`. */
+    portalAddress?: Address | undefined
+    /** Zone ID (e.g. `7`). */
+    zoneId: number
+  }
+
+  export type ReturnValue = Compute<{
+    /** Portal governance admin. */
+    admin: Address
+    /** Tokens enabled for deposits into the zone. */
+    enabledTokens: readonly Address[]
+    /** Zone messenger assigned to the portal. */
+    messenger: Address
+    /** Timestamp when the current emergency pause expires. */
+    pauseExpiry: bigint
+    /** Whether the portal is paused. */
+    paused: boolean
+    /** Pending governance admin. */
+    pendingAdmin: Address
+    /** Active sequencer addresses. */
+    sequencers: readonly Address[]
+    /** Version of the active sequencer set. */
+    sequencerSetVersion: bigint
+    /** Number of sequencers required to attest to a settlement. */
+    sequencerThreshold: number
+    /** Settlement verifier assigned to the portal. */
+    verifier: Address
+  }>
+
+  export type ErrorType = ReadContractErrorType | BaseErrorType
+}
+
 /**
  * Deposits tokens into a zone on the parent Tempo chain with encrypted
  * recipient and memo. Batches approve and depositEncrypted into a single
@@ -550,7 +678,7 @@ export namespace encryptedDeposit {
     keyIndex: bigint
     /** Optional deposit memo. @default `0x00...00` */
     memo?: Hex.Hex | undefined
-    /** Zone portal address. @default resolved via the portal registry. */
+    /** Zone portal address. @default derived from `zoneId`. */
     portalAddress?: Address | undefined
     /** Recipient address in the zone. */
     recipient: Address
@@ -618,7 +746,7 @@ export namespace encryptedDeposit {
     } = parameters
     if (!sender_) throw new Error('`sender` is required.')
     const sender = sender_
-    const portalAddress = portalAddress_ ?? getPortalAddress(chainId, zoneId)
+    const portalAddress = portalAddress_ ?? Addresses.zonePortal(zoneId)
 
     const { keyIndex, publicKey } = await getEncryptionKey(client, {
       ...rest,
@@ -666,7 +794,7 @@ export namespace encryptedDeposit {
       amount: bigint
       /** Optional deposit memo. @default `0x00...00` */
       memo?: Hex.Hex | undefined
-      /** Zone portal address. @default resolved via the portal registry. */
+      /** Zone portal address. @default derived from `zoneId`. */
       portalAddress?: Address | undefined
       /** Recipient address in the zone. */
       recipient: Address
@@ -734,7 +862,7 @@ export namespace encryptedDeposit {
     } = parameters
     if (!sender_) throw new Error('`sender` is required.')
     const sender = sender_
-    const portalAddress = portalAddress_ ?? getPortalAddress(chainId, zoneId)
+    const portalAddress = portalAddress_ ?? Addresses.zonePortal(zoneId)
     const { keyIndex, publicKey } = await getEncryptionKey(client, {
       ...rest,
       portalAddress,
@@ -775,7 +903,7 @@ export namespace encryptedDeposit {
     export type Args = {
       /** Optional deposit memo. @default `0x00...00` */
       memo?: Hex.Hex | undefined
-      /** Zone portal address. @default resolved via the portal registry. */
+      /** Zone portal address. @default derived from `zoneId`. */
       portalAddress?: Address | undefined
       /** Recipient address in the zone. */
       recipient: Address
@@ -797,17 +925,9 @@ export namespace encryptedDeposit {
    * @returns The calls.
    */
   export function calls(args: Args | PreparedEncryptedDeposit) {
-    const {
-      amount,
-      chainId,
-      encrypted,
-      keyIndex,
-      tempoRefundRecipient,
-      token,
-      zoneId,
-    } = args
-    const portalAddress =
-      args.portalAddress ?? getPortalAddress(chainId, zoneId)
+    const { amount, encrypted, keyIndex, tempoRefundRecipient, token, zoneId } =
+      args
+    const portalAddress = args.portalAddress ?? Addresses.zonePortal(zoneId)
     const tokenAddress = TokenId.toAddress(token)
     const encryptedPayload = {
       ephemeralPubkeyX: encrypted.ephemeralPubkeyX,
@@ -824,7 +944,7 @@ export namespace encryptedDeposit {
     })
     const depositCall = defineCall({
       address: portalAddress,
-      abi: ZoneAbis.zonePortal,
+      abi: Abis.zonePortal,
       functionName: 'depositEncrypted',
       args: [
         tokenAddress,
@@ -951,11 +1071,10 @@ export namespace encryptedDepositSync {
  * @example
  * ```ts
  * import { createClient } from 'viem'
- * import { http, zoneModerato } from 'viem/tempo/zones'
- * import { Actions } from 'viem/tempo'
+ * import { Actions, http, Zone } from 'viem/tempo'
  *
  * const client = createClient({
- *   chain: zoneModerato(7),
+ *   chain: Zone.a,
  *   transport: http(),
  * })
  *
@@ -1009,11 +1128,10 @@ export namespace getAuthorizationTokenInfo {
  * @example
  * ```ts
  * import { createClient } from 'viem'
- * import { http, zoneModerato } from 'viem/tempo/zones'
- * import { Actions } from 'viem/tempo'
+ * import { Actions, http, Zone } from 'viem/tempo'
  *
  * const client = createClient({
- *   chain: zoneModerato(7),
+ *   chain: Zone.a,
  *   transport: http(),
  * })
  *
@@ -1035,7 +1153,7 @@ export async function getWithdrawalFee<
   return readContract(client, {
     ...rest,
     address: Addresses.zoneOutbox,
-    abi: ZoneAbis.zoneOutbox,
+    abi: Abis.zoneOutbox,
     functionName: 'calculateWithdrawalFee',
     args: [callbackGas],
   })
@@ -1058,11 +1176,10 @@ export namespace getWithdrawalFee {
  * @example
  * ```ts
  * import { createClient } from 'viem'
- * import { http, zoneModerato } from 'viem/tempo/zones'
- * import { Actions } from 'viem/tempo'
+ * import { Actions, http, Zone } from 'viem/tempo'
  *
  * const client = createClient({
- *   chain: zoneModerato(7),
+ *   chain: Zone.a,
  *   transport: http(),
  * })
  *
@@ -1149,11 +1266,10 @@ export namespace getZoneInfo {
  * @example
  * ```ts
  * import { createClient } from 'viem'
- * import { Actions } from 'viem/tempo'
- * import { http, zoneModerato } from 'viem/tempo/zones'
+ * import { Actions, http, Zone } from 'viem/tempo'
  *
  * const client = createClient({
- *   chain: zoneModerato(7),
+ *   chain: Zone.a,
  *   transport: http(),
  * })
  *
@@ -1253,12 +1369,11 @@ export namespace waitForTempoBlock {
  * ```ts
  * import { createClient } from 'viem'
  * import { privateKeyToAccount } from 'viem/accounts'
- * import { http, zoneModerato } from 'viem/tempo/zones'
- * import { Actions } from 'viem/tempo'
+ * import { Actions, http, Zone } from 'viem/tempo'
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: zoneModerato(7),
+ *   chain: Zone.a,
  *   transport: http(),
  * })
  *
@@ -1352,7 +1467,7 @@ export namespace requestWithdrawal {
       }),
       defineCall({
         address: Addresses.zoneOutbox,
-        abi: ZoneAbis.zoneOutbox,
+        abi: Abis.zoneOutbox,
         functionName: 'requestWithdrawal',
         args: [
           TokenId.toAddress(token),
@@ -1377,11 +1492,10 @@ export namespace requestWithdrawal {
    * @example
    * ```ts
    * import { createClient } from 'viem'
-   * import { http, zoneModerato } from 'viem/tempo/zones'
-   * import { Actions } from 'viem/tempo'
+   * import { Actions, http, Zone } from 'viem/tempo'
    *
    * const client = createClient({
-   *   chain: zoneModerato(7),
+   *   chain: Zone.a,
    *   transport: http(),
    * })
    *
@@ -1537,17 +1651,11 @@ type WithdrawalCalls = ReturnType<typeof requestWithdrawal.calls>
  * import { createClient, createPublicClient, http } from 'viem'
  * import { privateKeyToAccount } from 'viem/accounts'
  * import { tempoModerato } from 'viem/chains'
- * import { Actions } from 'viem/tempo'
- * import {
- *   Abis,
- *   getPortalAddress,
- *   http as zoneHttp,
- *   zoneModerato,
- * } from 'viem/tempo/zones'
+ * import { Abis, Actions, Addresses, http as zoneHttp, Zone } from 'viem/tempo'
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: zoneModerato(7),
+ *   chain: Zone.a,
  *   transport: zoneHttp(),
  * })
  *
@@ -1564,7 +1672,7 @@ type WithdrawalCalls = ReturnType<typeof requestWithdrawal.calls>
  *   transport: http(),
  * })
  * const [withdrawal] = await tempoClient.getContractEvents({
- *   address: getPortalAddress(tempoModerato.id, 7),
+ *   address: Addresses.zonePortal(Zone.a.id),
  *   abi: Abis.zonePortal,
  *   eventName: 'WithdrawalProcessed',
  *   args: { senderTag },
@@ -1600,7 +1708,7 @@ export async function requestWithdrawalSync<
     throwOnReceiptRevert,
   } as never)
   const [event] = parseEventLogs({
-    abi: ZoneAbis.zoneOutbox,
+    abi: Abis.zoneOutbox,
     logs: receipt.logs,
     eventName: 'WithdrawalRequested',
     strict: true,
@@ -1645,12 +1753,11 @@ export namespace requestWithdrawalSync {
  * ```ts
  * import { createClient } from 'viem'
  * import { privateKeyToAccount } from 'viem/accounts'
- * import { http, zoneModerato } from 'viem/tempo/zones'
- * import { Actions } from 'viem/tempo'
+ * import { Actions, http, Zone } from 'viem/tempo'
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: zoneModerato(7),
+ *   chain: Zone.a,
  *   transport: http(),
  * })
  *
@@ -1734,7 +1841,7 @@ export namespace requestVerifiableWithdrawal {
       }),
       defineCall({
         address: Addresses.zoneOutbox,
-        abi: ZoneAbis.zoneOutbox,
+        abi: Abis.zoneOutbox,
         functionName: 'requestWithdrawal',
         args: [
           TokenId.toAddress(token),
@@ -1759,12 +1866,11 @@ export namespace requestVerifiableWithdrawal {
  * ```ts
  * import { createClient } from 'viem'
  * import { privateKeyToAccount } from 'viem/accounts'
- * import { http, zoneModerato } from 'viem/tempo/zones'
- * import { Actions } from 'viem/tempo'
+ * import { Actions, http, Zone } from 'viem/tempo'
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: zoneModerato(7),
+ *   chain: Zone.a,
  *   transport: http(),
  * })
  *
@@ -1826,19 +1932,17 @@ export namespace requestVerifiableWithdrawalSync {
 /**
  * Signs a zone authorization token and stores it for the zone HTTP transport.
  *
- * Zone chains should define `contracts.zonePortal` with the portal address.
  * The `zoneId` is derived from `ZoneId.fromChainId(chain.id)` and can be overridden.
  *
  * @example
  * ```ts
  * import { createClient } from 'viem'
  * import { privateKeyToAccount } from 'viem/accounts'
- * import { http, zoneModerato } from 'viem/tempo/zones'
- * import { Actions } from 'viem/tempo'
+ * import { Actions, http, Zone } from 'viem/tempo'
  *
  * const client = createClient({
  *   account: privateKeyToAccount('0x...'),
- *   chain: zoneModerato(7),
+ *   chain: Zone.a,
  *   transport: http(),
  * })
  *