viem 2.9.29 → 2.9.30

package/experimental/eip3074/invokers/coders/batchInvokerCoder.ts

@@ -0,0 +1,46 @@
+import type { Address } from 'abitype'
+import { readContract } from '../../../../actions/public/readContract.js'
+import type { Hex } from '../../../../types/misc.js'
+import { encodeAbiParameters } from '../../../../utils/abi/encodeAbiParameters.js'
+import { encodePacked } from '../../../../utils/abi/encodePacked.js'
+import { concat } from '../../../../utils/data/concat.js'
+import { size } from '../../../../utils/data/size.js'
+import { invokerAbi } from '../../constants/abis.js'
+import { defineInvokerCoder } from './defineInvokerCoder.js'
+
+type Calls = readonly {
+  to: Address
+  data?: Hex | undefined
+  value?: bigint | undefined
+}[]
+
+export type BatchInvokerArgs = Calls
+
+export function batchInvokerCoder() {
+  return defineInvokerCoder({
+    async toExecData(
+      args: BatchInvokerArgs,
+      { authority, client, invokerAddress },
+    ) {
+      const nonce = await readContract(client, {
+        abi: invokerAbi,
+        address: invokerAddress,
+        functionName: 'nextNonce',
+        args: [authority],
+      })
+
+      const calls = concat(
+        args.map(({ data = '0x', to, value = 0n }) =>
+          encodePacked(
+            ['uint8', 'address', 'uint256', 'uint256', 'bytes'],
+            [2, to, value, BigInt(size(data)), data],
+          ),
+        ),
+      )
+      return encodeAbiParameters(
+        [{ type: 'uint256' }, { type: 'bytes' }],
+        [nonce, calls],
+      )
+    },
+  })
+}

package/experimental/eip3074/invokers/coders/defineInvokerCoder.ts

@@ -0,0 +1,20 @@
+import type { Address } from 'abitype'
+import type { Client } from '../../../../clients/createClient.js'
+import type { Hex } from '../../../../types/misc.js'
+
+export type InvokerCoder<args = unknown> = {
+  toExecData: (
+    args: args,
+    options: { authority: Address; client: Client; invokerAddress: Hex },
+  ) => Promise<Hex>
+}
+
+export type DefineInvokerCoderParameters<args = unknown> = InvokerCoder<args>
+
+export type DefineInvokerCoderReturnType<args = unknown> = InvokerCoder<args>
+
+export function defineInvokerCoder<args>(
+  parameters: DefineInvokerCoderParameters<args>,
+): DefineInvokerCoderReturnType<args> {
+  return parameters
+}

package/experimental/eip3074/invokers/getInvoker.ts

@@ -0,0 +1,192 @@
+import type { Address } from 'abitype'
+import {
+  type GetTransactionCountErrorType,
+  getTransactionCount,
+} from '../../../actions/public/getTransactionCount.js'
+import {
+  type WriteContractErrorType,
+  writeContract,
+} from '../../../actions/wallet/writeContract.js'
+import type { Client } from '../../../clients/createClient.js'
+import type { Transport } from '../../../clients/transports/createTransport.js'
+import type { ErrorType } from '../../../errors/utils.js'
+import type { Account, LocalAccount } from '../../../types/account.js'
+import type { Chain, GetChainParameter } from '../../../types/chain.js'
+import type { Hex } from '../../../types/misc.js'
+import type { IsUndefined } from '../../../types/utils.js'
+import { parseAccount } from '../../../utils/accounts.js'
+import {
+  type IsAddressEqualErrorType,
+  isAddressEqual,
+} from '../../../utils/address/isAddressEqual.js'
+import { getAction } from '../../../utils/getAction.js'
+import {
+  type Keccak256ErrorType,
+  keccak256,
+} from '../../../utils/hash/keccak256.js'
+import {
+  type HexToSignatureErrorType,
+  hexToSignature,
+} from '../../../utils/signature/hexToSignature.js'
+import {
+  type SignAuthMessageErrorType,
+  signAuthMessage,
+} from '../actions/signAuthMessage.js'
+import { invokerAbi } from '../constants/abis.js'
+import type { InvokerCoder } from './coders/defineInvokerCoder.js'
+
+type GetExecutorParameter<
+  TAccount extends Account | undefined = Account | undefined,
+  TAccountOverride extends Account | Address | undefined = Account | Address,
+  TRequired extends boolean = true,
+> = IsUndefined<TAccount> extends true
+  ? TRequired extends true
+    ? { executor: TAccountOverride | Account | Address }
+    : { executor?: TAccountOverride | Account | Address | undefined }
+  : { executor?: TAccountOverride | Account | Address | undefined }
+
+export type InvokerExecuteParameters<
+  account extends Account | undefined = Account | undefined,
+  chain extends Chain | undefined = Chain | undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
+  args = unknown,
+> = {
+  args: args
+  authority: Account | Address
+  signature: Hex
+} & GetExecutorParameter<account> &
+  GetChainParameter<chain, chainOverride>
+
+export type InvokerExecuteErrorType =
+  | WriteContractErrorType
+  | HexToSignatureErrorType
+  | ErrorType
+
+export type InvokerSignParameters<
+  account extends Account | undefined = Account | undefined,
+  chain extends Chain | undefined = Chain | undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
+  args = unknown,
+> = {
+  args: args
+  authority: LocalAccount
+} & GetExecutorParameter<account, Account | Address, false> &
+  GetChainParameter<chain, chainOverride>
+
+export type InvokerSignErrorType =
+  | GetTransactionCountErrorType
+  | SignAuthMessageErrorType
+  | Keccak256ErrorType
+  | IsAddressEqualErrorType
+  | ErrorType
+
+export type Invoker<
+  account extends Account | undefined = Account | undefined,
+  chain extends Chain | undefined = Chain | undefined,
+  args = unknown,
+> = {
+  address: Address
+  execute<chainOverride extends Chain | undefined = undefined>(
+    parameters: InvokerExecuteParameters<account, chain, chainOverride, args>,
+  ): Promise<Hex>
+  sign<chainOverride extends Chain | undefined = undefined>(
+    parameters: InvokerSignParameters<account, chain, chainOverride, args>,
+  ): Promise<Hex>
+}
+
+export type GetInvokerParameters<
+  account extends Account | undefined = Account | undefined,
+  chain extends Chain | undefined = Chain | undefined,
+  args = unknown,
+> = {
+  address: Address
+  client: Client<Transport, chain, account>
+  coder: InvokerCoder<args>
+}
+
+export type GetInvokerErrorType = ErrorType
+
+export type InvokerArgs<invoker extends Invoker<any, any, any> = Invoker> =
+  invoker extends Invoker<any, any, infer args> ? args : unknown
+
+export function getInvoker<
+  account extends Account | undefined,
+  chain extends Chain | undefined,
+  args,
+>(
+  parameters: GetInvokerParameters<account, chain, args>,
+): Invoker<account, chain, args> {
+  const { address, client, coder } = parameters
+  return {
+    address,
+    async execute(parameters) {
+      const {
+        executor: executor_ = client.account,
+        authority: authority_,
+        args,
+        chain = client.chain,
+        signature,
+      } = parameters
+      const authority = parseAccount(authority_!)
+      const executor = parseAccount(executor_!)
+
+      const execData = await coder.toExecData(args, {
+        authority: authority.address,
+        client,
+        invokerAddress: address,
+      })
+
+      const { r, s, yParity } = hexToSignature(signature)
+      return getAction(
+        client,
+        writeContract,
+        'writeContract',
+      )({
+        abi: invokerAbi,
+        address,
+        account: executor,
+        chain,
+        functionName: 'execute',
+        args: [execData, { signer: authority.address, r, s, yParity }],
+      })
+    },
+    async sign(parameters) {
+      const {
+        args,
+        authority,
+        executor: executor_ = client.account,
+        chain = client.chain,
+      } = parameters
+      const executor = parseAccount(executor_!)
+      const [execData, nonce] = await Promise.all([
+        await coder.toExecData(args, {
+          authority: authority.address,
+          client,
+          invokerAddress: address,
+        }),
+        getAction(
+          client,
+          getTransactionCount,
+          'getTransactionCount',
+        )({
+          address: authority.address,
+          blockTag: 'pending',
+        }),
+      ])
+      const signature = await getAction(
+        client,
+        signAuthMessage,
+        'signAuthMessage',
+      )({
+        account: authority,
+        chain,
+        commit: keccak256(execData),
+        invokerAddress: address,
+        nonce: isAddressEqual(authority.address, executor.address)
+          ? nonce + 1
+          : nonce,
+      })
+      return signature
+    },
+  }
+}

package/experimental/index.ts

@@ -20,6 +20,27 @@ export {
   type WalletActionsEip3074,
   walletActionsEip3074,
 } from './eip3074/decorators/eip3074.js'
+export {
+  type GetInvokerErrorType,
+  type GetInvokerParameters,
+  type Invoker,
+  type InvokerArgs,
+  type InvokerExecuteErrorType,
+  type InvokerExecuteParameters,
+  type InvokerSignErrorType,
+  type InvokerSignParameters,
+  getInvoker,
+} from './eip3074/invokers/getInvoker.js'
+export {
+  type BatchInvokerArgs,
+  batchInvokerCoder,
+} from './eip3074/invokers/coders/batchInvokerCoder.js'
+export {
+  type DefineInvokerCoderParameters,
+  type DefineInvokerCoderReturnType,
+  type InvokerCoder,
+  defineInvokerCoder,
+} from './eip3074/invokers/coders/defineInvokerCoder.js'
 
 export {
   type GetCapabilitiesErrorType,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.9.29",
+  "version": "2.9.30",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",

package/zksync/constants/abis.ts

@@ -422,3 +422,42 @@ export const contractDeployerAbi = [
     type: 'function',
   },
 ]
+
+export const paymasterAbi = [
+  {
+    inputs: [
+      {
+        internalType: 'address',
+        name: '_token',
+        type: 'address',
+      },
+      {
+        internalType: 'uint256',
+        name: '_minAllowance',
+        type: 'uint256',
+      },
+      {
+        internalType: 'bytes',
+        name: '_innerInput',
+        type: 'bytes',
+      },
+    ],
+    name: 'approvalBased',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'bytes',
+        name: 'input',
+        type: 'bytes',
+      },
+    ],
+    name: 'general',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+]

package/zksync/index.ts

@@ -84,3 +84,14 @@ export type {
   ZkSyncTransactionSerializedEIP712,
   ZkSyncTransactionType,
 } from './types/transaction.js'
+
+export {
+  type GetApprovalBasedPaymasterInputParameters,
+  type GetApprovalBasedPaymasterInputReturnType,
+  getApprovalBasedPaymasterInput,
+} from './utils/paymaster/getApprovalBasedPaymasterInput.js'
+export {
+  type GetGeneralPaymasterInputParameters,
+  type GetGeneralPaymasterInputReturnType,
+  getGeneralPaymasterInput,
+} from './utils/paymaster/getGeneralPaymasterInput.js'

package/zksync/utils/paymaster/getApprovalBasedPaymasterInput.ts

@@ -0,0 +1,29 @@
+import { type Address } from 'abitype'
+import type { ByteArray, Hex } from '../../../types/misc.js'
+import type { EncodeFunctionDataReturnType } from '../../../utils/abi/encodeFunctionData.js'
+import { bytesToHex, encodeFunctionData } from '../../../utils/index.js'
+import { paymasterAbi } from '../../constants/abis.js'
+
+export type GetApprovalBasedPaymasterInputParameters = {
+  innerInput: Hex | ByteArray
+  minAllowance: bigint
+  token: Address
+}
+
+export type GetApprovalBasedPaymasterInputReturnType =
+  EncodeFunctionDataReturnType
+
+export function getApprovalBasedPaymasterInput(
+  parameters: GetApprovalBasedPaymasterInputParameters,
+): GetApprovalBasedPaymasterInputReturnType {
+  const { innerInput, minAllowance, token } = parameters
+
+  const innerInputHex =
+    typeof innerInput === 'string' ? innerInput : bytesToHex(innerInput)
+
+  return encodeFunctionData({
+    abi: paymasterAbi,
+    functionName: 'approvalBased',
+    args: [token, minAllowance, innerInputHex],
+  })
+}

package/zksync/utils/paymaster/getGeneralPaymasterInput.ts

@@ -0,0 +1,25 @@
+import type { ByteArray, Hex } from '../../../types/misc.js'
+import type { EncodeFunctionDataReturnType } from '../../../utils/abi/encodeFunctionData.js'
+import { bytesToHex, encodeFunctionData } from '../../../utils/index.js'
+import { paymasterAbi } from '../../constants/abis.js'
+
+export type GetGeneralPaymasterInputParameters = {
+  innerInput: Hex | ByteArray
+}
+
+export type GetGeneralPaymasterInputReturnType = EncodeFunctionDataReturnType
+
+export function getGeneralPaymasterInput(
+  parameters: GetGeneralPaymasterInputParameters,
+): GetGeneralPaymasterInputReturnType {
+  const { innerInput } = parameters
+
+  const innerInputHex =
+    typeof innerInput === 'string' ? innerInput : bytesToHex(innerInput)
+
+  return encodeFunctionData({
+    abi: paymasterAbi,
+    functionName: 'general',
+    args: [innerInputHex],
+  })
+}