viem 2.55.11 → 2.55.15

package/tempo/actions/earn.ts

@@ -67,6 +67,9 @@ import * as policyActions from './policy.js'
 import * as tokenActions from './token.js'
 import * as zoneActions from './zone.js'
 
+// biome-ignore lint/performance/noBarrelFile: namespace module
+export * from './earn/deployment.js'
+
 /** TIP-403 policy ID that allows every sender, recipient, and mint recipient. */
 export const alwaysAllowPolicyId = 1n
 
@@ -1048,6 +1051,7 @@ export namespace privateDeposit {
         memo: returnMemo,
         portalAddress: config.zonePortal,
         recipient,
+        sender: gateway,
         zoneId: config.zoneId,
       })
     const shareAmountMin = resolveMinimumShareAmount(parameters)
@@ -2426,6 +2430,7 @@ export namespace privateRedeem {
         memo: returnMemo,
         portalAddress: config.zonePortal,
         recipient,
+        sender: gateway,
         zoneId: config.zoneId,
       }),
       (async () => {

package/tempo/actions/zone.ts

@@ -28,7 +28,13 @@ import type { Transport } from '../../clients/transports/createTransport.js'
 import { zeroHash } from '../../constants/bytes.js'
 import type { BaseErrorType } from '../../errors/base.js'
 import type { Chain, GetChainParameter } from '../../types/chain.js'
-import type { Compute, UnionOmit } from '../../types/utils.js'
+import type {
+  Compute,
+  IsUndefined,
+  MaybeRequired,
+  UnionOmit,
+} from '../../types/utils.js'
+import { parseEventLogs } from '../../utils/abi/parseEventLogs.js'
 import type { RequestErrorType } from '../../utils/buildRequest.js'
 import { type ObserveErrorType, observe } from '../../utils/observe.js'
 import { type PollErrorType, poll } from '../../utils/poll.js'
@@ -80,6 +86,8 @@ export type PreparedEncryptedDeposit = {
   keyIndex: bigint
   /** Zone portal address on the parent chain. */
   portalAddress: Address
+  /** Address that will call the Zone portal. */
+  sender: Address
   /** Token address or ID to deposit. */
   token: TokenId.TokenIdOrAddress
   /** Zone ID (e.g. `7`). */
@@ -95,6 +103,8 @@ export type PreparedEncryptedDepositRecipient = {
   keyIndex: bigint
   /** Zone portal address on the parent chain. */
   portalAddress: Address
+  /** Address that will call the Zone portal. */
+  sender: Address
   /** Zone ID (e.g. `7`). */
   zoneId: number
 }
@@ -493,6 +503,7 @@ export async function encryptedDeposit<
     memo: parameters.memo,
     portalAddress: parameters.portalAddress,
     recipient,
+    sender: account_.address,
     token: parameters.token,
     zoneId: parameters.zoneId,
   })
@@ -572,6 +583,7 @@ export namespace encryptedDeposit {
    *   amount: 1_000_000n,
    *   bouncebackRecipient: '0x...',
    *   recipient: '0x...',
+   *   sender: '0x...',
    *   zoneId: 7,
    * })
    * ```
@@ -585,7 +597,7 @@ export namespace encryptedDeposit {
     account extends Account | undefined,
   >(
     client: Client<Transport, chain, account>,
-    parameters: prepare.Parameters,
+    parameters: prepare.Parameters<account>,
   ): Promise<prepare.ReturnValue> {
     const chainId = client.chain?.id
     if (!chainId) throw new Error('`chain` is required.')
@@ -596,10 +608,13 @@ export namespace encryptedDeposit {
       memo,
       portalAddress: portalAddress_,
       recipient,
+      sender: sender_ = client.account?.address,
       token,
       zoneId,
       ...rest
     } = parameters
+    if (!sender_) throw new Error('`sender` is required.')
+    const sender = sender_
     const portalAddress = portalAddress_ ?? getPortalAddress(chainId, zoneId)
 
     const { keyIndex, publicKey } = await getEncryptionKey(client, {
@@ -611,6 +626,7 @@ export namespace encryptedDeposit {
     const encrypted = await encryptDepositPayload(
       publicKey,
       recipient,
+      sender,
       portalAddress,
       keyIndex,
       memo,
@@ -623,13 +639,24 @@ export namespace encryptedDeposit {
       encrypted,
       keyIndex,
       portalAddress,
+      sender,
       token,
       zoneId,
     }
   }
 
   export namespace prepare {
-    export type Parameters = ReadParameters & Args
+    export type Parameters<
+      account extends Account | undefined = Account | undefined,
+    > = ReadParameters &
+      Omit<Args, 'sender'> &
+      MaybeRequired<
+        {
+          /** Address that will call the Zone portal. @default `client.account.address` */
+          sender?: Address | undefined
+        },
+        IsUndefined<account>
+      >
 
     export type Args = {
       /** Amount of tokens to deposit. */
@@ -642,6 +669,8 @@ export namespace encryptedDeposit {
       portalAddress?: Address | undefined
       /** Recipient address in the zone. */
       recipient: Address
+      /** Address that will call the Zone portal. */
+      sender: Address
       /** Token address or ID to deposit. */
       token: TokenId.TokenIdOrAddress
       /** Zone ID (e.g. `7`). */
@@ -673,6 +702,7 @@ export namespace encryptedDeposit {
    *
    * const recipient = await Actions.zone.encryptedDeposit.prepareRecipient(client, {
    *   recipient: '0x...',
+   *   sender: '0x...',
    *   zoneId: 7,
    * })
    * ```
@@ -686,7 +716,7 @@ export namespace encryptedDeposit {
     account extends Account | undefined,
   >(
     client: Client<Transport, chain, account>,
-    parameters: prepareRecipient.Parameters,
+    parameters: prepareRecipient.Parameters<account>,
   ): Promise<prepareRecipient.ReturnValue> {
     const chainId = client.chain?.id
     if (!chainId) throw new Error('`chain` is required.')
@@ -695,9 +725,12 @@ export namespace encryptedDeposit {
       memo,
       portalAddress: portalAddress_,
       recipient,
+      sender: sender_ = client.account?.address,
       zoneId,
       ...rest
     } = parameters
+    if (!sender_) throw new Error('`sender` is required.')
+    const sender = sender_
     const portalAddress = portalAddress_ ?? getPortalAddress(chainId, zoneId)
     const { keyIndex, publicKey } = await getEncryptionKey(client, {
       ...rest,
@@ -707,6 +740,7 @@ export namespace encryptedDeposit {
     const encrypted = await encryptDepositPayload(
       publicKey,
       recipient,
+      sender,
       portalAddress,
       keyIndex,
       memo,
@@ -717,12 +751,23 @@ export namespace encryptedDeposit {
       encrypted,
       keyIndex,
       portalAddress,
+      sender,
       zoneId,
     }
   }
 
   export namespace prepareRecipient {
-    export type Parameters = ReadParameters & Args
+    export type Parameters<
+      account extends Account | undefined = Account | undefined,
+    > = ReadParameters &
+      Omit<Args, 'sender'> &
+      MaybeRequired<
+        {
+          /** Address that will call the Zone portal. @default `client.account.address` */
+          sender?: Address | undefined
+        },
+        IsUndefined<account>
+      >
 
     export type Args = {
       /** Optional deposit memo. @default `0x00...00` */
@@ -731,6 +776,8 @@ export namespace encryptedDeposit {
       portalAddress?: Address | undefined
       /** Recipient address in the zone. */
       recipient: Address
+      /** Address that will call the Zone portal. */
+      sender: Address
       /** Zone ID (e.g. `7`). */
       zoneId: number
     }
@@ -863,6 +910,7 @@ export async function encryptedDepositSync<
     memo: parameters.memo,
     portalAddress: parameters.portalAddress,
     recipient,
+    sender: account_.address,
     token: parameters.token,
     zoneId: parameters.zoneId,
   })
@@ -1547,8 +1595,16 @@ export async function requestWithdrawalSync<
     gas: parameters.gas ?? defaultWithdrawalGas,
     throwOnReceiptRevert,
   } as never)
+  const [event] = parseEventLogs({
+    abi: ZoneAbis.zoneOutbox,
+    logs: receipt.logs,
+    eventName: 'WithdrawalRequested',
+    strict: true,
+  })
+  if (!event) throw new Error('`WithdrawalRequested` event not found.')
   const senderTag = WithdrawalSenderTag.from({
-    sender: account_.address,
+    fallbackNonce: event.args.fallbackNonce,
+    sender: event.args.sender,
     transactionHash: receipt.transactionHash,
   })
   return { receipt, senderTag }
@@ -1874,6 +1930,7 @@ export namespace signAuthorizationToken {
 async function encryptDepositPayload(
   publicKey: { prefix: 2 | 3; x: Hex.Hex },
   recipient: Address,
+  sender: Address,
   portalAddress: Address,
   keyIndex: bigint,
   memo: Hex.Hex = zeroHash,
@@ -1909,6 +1966,7 @@ async function encryptDepositPayload(
         portalAddress,
         keyIndex,
         Hex.fromNumber(compressedEphemeral.x, { size: 32 }),
+        sender,
       ) as BufferSource,
     },
     hkdfKey,
@@ -1952,11 +2010,13 @@ function buildDepositHkdfInfo(
   portalAddress: Address,
   keyIndex: bigint,
   ephemeralPubkeyX: Hex.Hex,
+  sender: Address,
 ): Bytes.Bytes {
   return Bytes.concat(
     Bytes.from(portalAddress),
     Bytes.fromNumber(keyIndex, { size: 32 }),
     Bytes.from(ephemeralPubkeyX),
+    Bytes.from(sender),
   )
 }
 

package/tempo/chainConfig.ts

@@ -116,6 +116,36 @@ export const chainConfig = {
         if (request.account?.source !== 'multisig') delete request.account
       }
 
+      // Register concurrency before account preparation performs storage or
+      // network I/O so overlapping requests cannot miss each other.
+      const useExpiringNonce = await (async () => {
+        if (request.nonceKey === 'expiring' || request.nonceKey === maxUint256)
+          return true
+        if (multisig) return false
+        if (request.feePayer && typeof request.nonceKey === 'undefined')
+          return true
+        const account = request.account as
+          | Account
+          | MultisigAccount
+          | Address
+          | undefined
+        const address = typeof account === 'string' ? account : account?.address
+        if (address && typeof request.nonceKey === 'undefined')
+          return await Concurrent.detect(address.toLowerCase())
+        return false
+      })()
+
+      if (useExpiringNonce) {
+        request.nonceKey = maxUint256
+        request.nonce = 0
+        if (typeof request.validAfter === 'undefined')
+          request.validAfter = randomValidAfter()
+        if (typeof request.validBefore === 'undefined')
+          request.validBefore = Math.floor(Date.now() / 1000) + maxExpirySecs
+      } else if (typeof request.nonceKey !== 'undefined') {
+        request.nonce = typeof request.nonce === 'number' ? request.nonce : 0
+      }
+
       if (
         !request.keyAuthorization &&
         request.account?.source === 'accessKey'
@@ -156,33 +186,6 @@ export const chainConfig = {
         }
       }
 
-      // Use expiring nonces for concurrent transactions (TIP-1009).
-      // When nonceKey is 'expiring', feePayer is specified, or concurrent requests
-      // are detected, we use expiring nonces (nonceKey = uint256.max) with a
-      // validBefore timestamp.
-      const useExpiringNonce = await (async () => {
-        if (request.nonceKey === 'expiring') return true
-        if (multisig) return false
-        if (request.feePayer && typeof request.nonceKey === 'undefined')
-          return true
-        const address = request.account?.address
-        if (address && typeof request.nonceKey === 'undefined')
-          return await Concurrent.detect(address)
-        return false
-      })()
-
-      if (useExpiringNonce) {
-        request.nonceKey = maxUint256
-        request.nonce = 0
-        if (typeof request.validAfter === 'undefined')
-          request.validAfter = randomValidAfter()
-        if (typeof request.validBefore === 'undefined')
-          request.validBefore = Math.floor(Date.now() / 1000) + maxExpirySecs
-      } else if (typeof request.nonceKey !== 'undefined') {
-        // Explicit nonceKey provided (2D nonce mode)
-        request.nonce = typeof request.nonce === 'number' ? request.nonce : 0
-      }
-
       if (!request.feeToken && request.chain?.feeToken)
         request.feeToken = request.chain.feeToken
 

package/tempo/internal/WithdrawalSenderTag.ts

@@ -1,19 +1,20 @@
 import type { Address } from 'abitype'
 import { AbiParameters, Hash, type Hex } from 'ox'
 
-/** Derives a withdrawal sender tag from its sender and transaction hash. @internal */
+/** Derives a user withdrawal sender tag. @internal */
 export function from(options: from.Options): Hex.Hex {
-  const { sender, transactionHash } = options
+  const { fallbackNonce, sender, transactionHash } = options
   return Hash.keccak256(
     AbiParameters.encodePacked(
-      ['address', 'bytes32'],
-      [sender, transactionHash],
+      ['address', 'bytes32', 'uint64'],
+      [sender, transactionHash, fallbackNonce],
     ),
   )
 }
 
 export declare namespace from {
   type Options = {
+    fallbackNonce: bigint
     sender: Address
     transactionHash: Hex.Hex
   }

package/tempo/zones/Abis.ts

@@ -168,6 +168,23 @@ export const zonePortal = [
 ] as const
 
 export const zoneOutbox = [
+  {
+    name: 'WithdrawalRequested',
+    type: 'event',
+    inputs: [
+      { name: 'withdrawalIndex', type: 'uint64', indexed: true },
+      { name: 'sender', type: 'address', indexed: true },
+      { name: 'token', type: 'address', indexed: false },
+      { name: 'to', type: 'address', indexed: false },
+      { name: 'amount', type: 'uint128', indexed: false },
+      { name: 'fee', type: 'uint128', indexed: false },
+      { name: 'memo', type: 'bytes32', indexed: false },
+      { name: 'gasLimit', type: 'uint64', indexed: false },
+      { name: 'fallbackNonce', type: 'uint64', indexed: false },
+      { name: 'data', type: 'bytes', indexed: false },
+      { name: 'revealTo', type: 'bytes', indexed: false },
+    ],
+  },
   {
     name: 'requestWithdrawal',
     type: 'function',