viem 2.18.8 → 2.19.0

package/accounts/utils/signAuthorization.ts

@@ -0,0 +1,63 @@
+import type { ErrorType } from '../../errors/utils.js'
+import type {
+  Authorization,
+  SignedAuthorization,
+} from '../../experimental/eip7702/types/authorization.js'
+import {
+  type HashAuthorizationErrorType,
+  hashAuthorization,
+} from '../../experimental/eip7702/utils/hashAuthorization.js'
+import type { Hex, Signature } from '../../types/misc.js'
+import type { Prettify } from '../../types/utils.js'
+import {
+  type SignErrorType,
+  type SignParameters,
+  type SignReturnType,
+  sign,
+} from './sign.js'
+
+type To = 'object' | 'bytes' | 'hex'
+
+export type SignAuthorizationParameters<to extends To = 'object'> =
+  Authorization & {
+    /** The private key to sign with. */
+    privateKey: Hex
+    to?: SignParameters<to>['to'] | undefined
+  }
+
+export type SignAuthorizationReturnType<to extends To = 'object'> = Prettify<
+  to extends 'object' ? SignedAuthorization : SignReturnType<to>
+>
+
+export type SignAuthorizationErrorType =
+  | SignErrorType
+  | HashAuthorizationErrorType
+  | ErrorType
+
+/**
+ * Signs an Authorization hash in [EIP-7702 format](https://eips.ethereum.org/EIPS/eip-7702): `keccak256('0x05' || rlp([chain_id, address, nonce]))`.
+ */
+export async function experimental_signAuthorization<to extends To = 'object'>(
+  parameters: SignAuthorizationParameters<to>,
+): Promise<SignAuthorizationReturnType<to>> {
+  const {
+    contractAddress,
+    chainId,
+    nonce,
+    privateKey,
+    to = 'object',
+  } = parameters
+  const signature = await sign({
+    hash: hashAuthorization({ contractAddress, chainId, nonce }),
+    privateKey,
+    to,
+  })
+  if (to === 'object')
+    return {
+      contractAddress,
+      chainId,
+      nonce,
+      ...(signature as Signature),
+    } as any
+  return signature as any
+}

package/actions/public/estimateGas.ts

@@ -6,7 +6,11 @@ import {
 } from '../../accounts/utils/parseAccount.js'
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
-import type { BaseError } from '../../errors/base.js'
+import { BaseError } from '../../errors/base.js'
+import {
+  type RecoverAuthorizationAddressErrorType,
+  recoverAuthorizationAddress,
+} from '../../experimental/eip7702/utils/recoverAuthorizationAddress.js'
 import type { BlockTag } from '../../types/block.js'
 import type { Chain } from '../../types/chain.js'
 import type { StateOverride } from '../../types/stateOverride.js'
@@ -36,6 +40,7 @@ import {
   type PrepareTransactionRequestParameters,
   prepareTransactionRequest,
 } from '../wallet/prepareTransactionRequest.js'
+import { getBalance } from './getBalance.js'
 
 export type EstimateGasParameters<
   chain extends Chain | undefined = Chain | undefined,
@@ -66,6 +71,7 @@ export type EstimateGasErrorType = GetEstimateGasErrorReturnType<
   | ParseAccountErrorType
   | NumberToHexErrorType
   | RequestErrorType
+  | RecoverAuthorizationAddressErrorType
   | AssertRequestErrorType
 >
 
@@ -107,6 +113,7 @@ export async function estimateGas<
   try {
     const {
       accessList,
+      authorizationList,
       blobs,
       blobVersionedHashes,
       blockNumber,
@@ -118,7 +125,6 @@ export async function estimateGas<
       maxFeePerGas,
       maxPriorityFeePerGas,
       nonce,
-      to,
       value,
       stateOverride,
       ...rest
@@ -135,6 +141,25 @@ export async function estimateGas<
 
     const rpcStateOverride = serializeStateOverride(stateOverride)
 
+    const to = await (async () => {
+      // If `to` exists on the parameters, use that.
+      if (rest.to) return rest.to
+
+      // If no `to` exists, and we are sending a EIP-7702 transaction, use the
+      // address of the first authorization in the list.
+      if (authorizationList && authorizationList.length > 0)
+        return await recoverAuthorizationAddress({
+          authorization: authorizationList[0],
+        }).catch(() => {
+          throw new BaseError(
+            '`to` is required. Could not infer from `authorizationList`',
+          )
+        })
+
+      // Otherwise, we are sending a deployment transaction.
+      return undefined
+    })()
+
     assertRequest(args as AssertRequestParameters)
 
     const chainFormat = client.chain?.formatters?.transactionRequest?.format
@@ -145,6 +170,7 @@ export async function estimateGas<
       ...extract(rest, { format: chainFormat }),
       from: account?.address,
       accessList,
+      authorizationList,
       blobs,
       blobVersionedHashes,
       data,
@@ -158,15 +184,52 @@ export async function estimateGas<
       value,
     } as TransactionRequest)
 
-    const balance = await client.request({
-      method: 'eth_estimateGas',
-      params: rpcStateOverride
-        ? [request, block ?? 'latest', rpcStateOverride]
-        : block
-          ? [request, block]
-          : [request],
-    })
-    return BigInt(balance)
+    function estimateGas_rpc(parameters: {
+      block: any
+      request: any
+      rpcStateOverride: any
+    }) {
+      const { block, request, rpcStateOverride } = parameters
+      return client.request({
+        method: 'eth_estimateGas',
+        params: rpcStateOverride
+          ? [request, block ?? 'latest', rpcStateOverride]
+          : block
+            ? [request, block]
+            : [request],
+      })
+    }
+
+    let estimate = BigInt(
+      await estimateGas_rpc({ block, request, rpcStateOverride }),
+    )
+
+    // TODO(7702): Remove this once https://github.com/ethereum/execution-apis/issues/561 is resolved.
+    //       Authorization list schema is not implemented on JSON-RPC spec yet, so we need to
+    //       manually estimate the gas.
+    if (authorizationList) {
+      const value = await getBalance(client, { address: request.from })
+      const estimates = await Promise.all(
+        authorizationList.map(async (authorization) => {
+          const { contractAddress } = authorization
+          const estimate = await estimateGas_rpc({
+            block,
+            request: {
+              authorizationList: undefined,
+              data,
+              from: account?.address,
+              to: contractAddress,
+              value: numberToHex(value),
+            },
+            rpcStateOverride,
+          }).catch(() => 100_000n)
+          return 2n * BigInt(estimate)
+        }),
+      )
+      estimate += estimates.reduce((acc, curr) => acc + curr, 0n)
+    }
+
+    return estimate
   } catch (err) {
     throw getEstimateGasError(err as BaseError, {
       ...args,

package/actions/public/simulateContract.ts

@@ -1,4 +1,4 @@
-import type { Abi, Address } from 'abitype'
+import type { Abi, AbiFunction, AbiStateMutability, Address } from 'abitype'
 
 import {
   type ParseAccountErrorType,
@@ -16,10 +16,15 @@ import type {
   ContractFunctionParameters,
   ContractFunctionReturnType,
   ExtractAbiFunctionForArgs,
-  GetValue,
 } from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
-import type { Prettify, UnionEvaluate, UnionOmit } from '../../types/utils.js'
+import type {
+  IsNarrowable,
+  NoInfer,
+  Prettify,
+  UnionEvaluate,
+  UnionOmit,
+} from '../../types/utils.js'
 import {
   type DecodeFunctionResultErrorType,
   decodeFunctionResult,
@@ -34,9 +39,35 @@ import {
 } from '../../utils/errors/getContractError.js'
 import type { WriteContractParameters } from '../wallet/writeContract.js'
 
+import type { TransactionRequest } from '../../types/transaction.js'
 import { getAction } from '../../utils/getAction.js'
 import { type CallErrorType, type CallParameters, call } from './call.js'
 
+export type GetMutabilityAwareValue<
+  abi extends Abi | readonly unknown[],
+  mutability extends AbiStateMutability = AbiStateMutability,
+  functionName extends ContractFunctionName<
+    abi,
+    mutability
+  > = ContractFunctionName<abi, mutability>,
+  valueType = TransactionRequest['value'],
+  args extends ContractFunctionArgs<
+    abi,
+    mutability,
+    functionName
+  > = ContractFunctionArgs<abi, mutability, functionName>,
+  abiFunction extends AbiFunction = abi extends Abi
+    ? ExtractAbiFunctionForArgs<abi, mutability, functionName, args>
+    : AbiFunction,
+  _Narrowable extends boolean = IsNarrowable<abi, Abi>,
+> = _Narrowable extends true
+  ? abiFunction['stateMutability'] extends 'payable'
+    ? { value?: NoInfer<valueType> | undefined }
+    : abiFunction['payable'] extends true
+      ? { value?: NoInfer<valueType> | undefined }
+      : { value?: undefined }
+  : { value?: NoInfer<valueType> | undefined }
+
 export type SimulateContractParameters<
   abi extends Abi | readonly unknown[] = Abi,
   functionName extends ContractFunctionName<
@@ -75,34 +106,37 @@ export type SimulateContractParameters<
     | 'factoryData'
     | 'value'
   > &
-  GetValue<
+  GetMutabilityAwareValue<
     abi,
+    'nonpayable' | 'payable',
     functionName,
     CallParameters<derivedChain> extends CallParameters
       ? CallParameters<derivedChain>['value']
-      : CallParameters['value']
+      : CallParameters['value'],
+    args
   >
 
 export type SimulateContractReturnType<
-  abi extends Abi | readonly unknown[] = Abi,
-  functionName extends ContractFunctionName<
+  out abi extends Abi | readonly unknown[] = Abi,
+  in out functionName extends ContractFunctionName<
     abi,
     'nonpayable' | 'payable'
   > = ContractFunctionName<abi, 'nonpayable' | 'payable'>,
-  args extends ContractFunctionArgs<
+  in out args extends ContractFunctionArgs<
     abi,
     'nonpayable' | 'payable',
     functionName
   > = ContractFunctionArgs<abi, 'nonpayable' | 'payable', functionName>,
-  chain extends Chain | undefined = Chain | undefined,
-  account extends Account | undefined = Account | undefined,
-  chainOverride extends Chain | undefined = Chain | undefined,
-  accountOverride extends Account | Address | undefined =
+  /** @ts-expect-error cast variance */
+  out chain extends Chain | undefined = Chain | undefined,
+  out account extends Account | undefined = Account | undefined,
+  out chainOverride extends Chain | undefined = Chain | undefined,
+  out accountOverride extends Account | Address | undefined =
     | Account
     | Address
     | undefined,
   ///
-  minimizedAbi extends Abi = readonly [
+  in out minimizedAbi extends Abi = readonly [
     ExtractAbiFunctionForArgs<
       abi extends Abi ? abi : Abi,
       'nonpayable' | 'payable',
@@ -110,7 +144,7 @@ export type SimulateContractReturnType<
       args
     >,
   ],
-  resolvedAccount extends Account | undefined = accountOverride extends
+  out resolvedAccount extends Account | undefined = accountOverride extends
     | Account
     | Address
     ? ParseAccount<accountOverride>

package/actions/wallet/prepareTransactionRequest.ts

@@ -38,6 +38,7 @@ import type {
   TransactionRequestEIP1559,
   TransactionRequestEIP2930,
   TransactionRequestEIP4844,
+  TransactionRequestEIP7702,
   TransactionRequestLegacy,
   TransactionSerializable,
 } from '../../types/transaction.js'
@@ -142,7 +143,8 @@ export type PrepareTransactionRequestReturnType<
     | (_transactionType extends 'legacy' ? TransactionRequestLegacy : never)
     | (_transactionType extends 'eip1559' ? TransactionRequestEIP1559 : never)
     | (_transactionType extends 'eip2930' ? TransactionRequestEIP2930 : never)
-    | (_transactionType extends 'eip4844' ? TransactionRequestEIP4844 : never),
+    | (_transactionType extends 'eip4844' ? TransactionRequestEIP4844 : never)
+    | (_transactionType extends 'eip7702' ? TransactionRequestEIP7702 : never),
 > = Prettify<
   UnionRequiredBy<
     Extract<

package/actions/wallet/sendTransaction.ts

@@ -12,8 +12,12 @@ import {
   AccountTypeNotSupportedError,
   type AccountTypeNotSupportedErrorType,
 } from '../../errors/account.js'
-import type { BaseError } from '../../errors/base.js'
+import { BaseError } from '../../errors/base.js'
 import type { ErrorType } from '../../errors/utils.js'
+import {
+  type RecoverAuthorizationAddressErrorType,
+  recoverAuthorizationAddress,
+} from '../../experimental/eip7702/utils/recoverAuthorizationAddress.js'
 import type { GetAccountParameter } from '../../types/account.js'
 import type { Chain, DeriveChain } from '../../types/chain.js'
 import type { GetChainParameter } from '../../types/chain.js'
@@ -85,6 +89,7 @@ export type SendTransactionErrorType =
       | GetChainIdErrorType
       | PrepareTransactionRequestErrorType
       | SendRawTransactionErrorType
+      | RecoverAuthorizationAddressErrorType
       | SignTransactionErrorType
       | RequestErrorType
     >
@@ -148,6 +153,7 @@ export async function sendTransaction<
     account: account_ = client.account,
     chain = client.chain,
     accessList,
+    authorizationList,
     blobs,
     data,
     gas,
@@ -156,7 +162,6 @@ export async function sendTransaction<
     maxFeePerGas,
     maxPriorityFeePerGas,
     nonce,
-    to,
     value,
     ...rest
   } = parameters
@@ -179,6 +184,25 @@ export async function sendTransaction<
       })
     }
 
+    const to = await (async () => {
+      // If `to` exists on the parameters, use that.
+      if (parameters.to) return parameters.to
+
+      // If no `to` exists, and we are sending a EIP-7702 transaction, use the
+      // address of the first authorization in the list.
+      if (authorizationList && authorizationList.length > 0)
+        return await recoverAuthorizationAddress({
+          authorization: authorizationList[0],
+        }).catch(() => {
+          throw new BaseError(
+            '`to` is required. Could not infer from `authorizationList`.',
+          )
+        })
+
+      // Otherwise, we are sending a deployment transaction.
+      return undefined
+    })()
+
     if (account.type === 'json-rpc') {
       const chainFormat = client.chain?.formatters?.transactionRequest?.format
       const format = chainFormat || formatTransactionRequest
@@ -187,6 +211,7 @@ export async function sendTransaction<
         // Pick out extra data that might exist on the chain's transaction request type.
         ...extract(rest, { format: chainFormat }),
         accessList,
+        authorizationList,
         blobs,
         chainId,
         data,
@@ -218,6 +243,7 @@ export async function sendTransaction<
       )({
         account,
         accessList,
+        authorizationList,
         blobs,
         chain,
         chainId,
@@ -229,9 +255,9 @@ export async function sendTransaction<
         maxPriorityFeePerGas,
         nonce,
         parameters: [...defaultParameters, 'sidecars'],
-        to,
         value,
         ...rest,
+        to,
       } as any)
 
       const serializer = chain?.serializers?.transaction
@@ -256,7 +282,10 @@ export async function sendTransaction<
         type: 'smart',
       })
 
-    throw new Error('incompatible account type.')
+    throw new AccountTypeNotSupportedError({
+      docsPath: '/docs/actions/wallet/sendTransaction',
+      type: (account as { type: string }).type,
+    })
   } catch (err) {
     if (err instanceof AccountTypeNotSupportedError) throw err
     throw getTransactionError(err as BaseError, {

package/actions/wallet/writeContract.ts

@@ -14,7 +14,6 @@ import type {
   ContractFunctionArgs,
   ContractFunctionName,
   ContractFunctionParameters,
-  GetValue,
 } from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
 import type { Prettify, UnionEvaluate, UnionOmit } from '../../types/utils.js'
@@ -25,6 +24,7 @@ import {
 } from '../../utils/abi/encodeFunctionData.js'
 import type { FormattedTransactionRequest } from '../../utils/formatters/transactionRequest.js'
 import { getAction } from '../../utils/getAction.js'
+import type { GetMutabilityAwareValue } from '../public/simulateContract.js'
 import {
   type SendTransactionErrorType,
   type SendTransactionReturnType,
@@ -59,10 +59,12 @@ export type WriteContractParameters<
   GetChainParameter<chain, chainOverride> &
   Prettify<
     GetAccountParameter<account> &
-      GetValue<
+      GetMutabilityAwareValue<
         abi,
+        'nonpayable' | 'payable',
         functionName,
-        FormattedTransactionRequest<derivedChain>['value']
+        FormattedTransactionRequest<derivedChain>['value'],
+        args
       > & {
         /** Data to append to the end of the calldata. Useful for adding a ["domain" tag](https://opensea.notion.site/opensea/Seaport-Order-Attributions-ec2d69bf455041a5baa490941aad307f). */
         dataSuffix?: Hex | undefined

package/chains/definitions/abstractTestnet.ts

@@ -1,6 +1,8 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
+import { chainConfig } from '../../zksync/chainConfig.js'
 
 export const abstractTestnet = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 11_124,
   name: 'Abstract Testnet',
   nativeCurrency: {

package/chains/definitions/{zkSync.ts → zksync.ts}

@@ -1,10 +1,10 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
 import { chainConfig } from '../../zksync/chainConfig.js'
 
-export const zkSync = /*#__PURE__*/ defineChain({
+export const zksync = /*#__PURE__*/ defineChain({
   ...chainConfig,
   id: 324,
-  name: 'zkSync Era',
+  name: 'ZKsync Era',
   network: 'zksync-era',
   nativeCurrency: {
     decimals: 18,
@@ -24,8 +24,9 @@ export const zkSync = /*#__PURE__*/ defineChain({
       apiUrl: 'https://api-era.zksync.network/api',
     },
     native: {
-      name: 'zkSync Explorer',
+      name: 'ZKsync Explorer',
       url: 'https://explorer.zksync.io/',
+      apiUrl: 'https://block-explorer-api.mainnet.zksync.io/api',
     },
   },
   contracts: {

package/chains/definitions/{zkSyncInMemoryNode.ts → zksyncInMemoryNode.ts}

@@ -1,10 +1,10 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
 import { chainConfig } from '../../zksync/chainConfig.js'
 
-export const zkSyncInMemoryNode = /*#__PURE__*/ defineChain({
+export const zksyncInMemoryNode = /*#__PURE__*/ defineChain({
   ...chainConfig,
   id: 260,
-  name: 'zkSync InMemory Node',
+  name: 'ZKsync InMemory Node',
   network: 'zksync-in-memory-node',
   nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
   rpcUrls: {

package/chains/definitions/{zkSyncLocalNode.ts → zksyncLocalNode.ts}

@@ -1,10 +1,10 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
 import { chainConfig } from '../../zksync/chainConfig.js'
 
-export const zkSyncLocalNode = /*#__PURE__*/ defineChain({
+export const zksyncLocalNode = /*#__PURE__*/ defineChain({
   ...chainConfig,
   id: 270,
-  name: 'zkSync CLI Local Node',
+  name: 'ZKsync CLI Local Node',
   network: 'zksync-cli-local-node',
   nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
   rpcUrls: {

package/chains/definitions/{zkSyncSepoliaTestnet.ts → zksyncSepoliaTestnet.ts}

@@ -1,10 +1,10 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
 import { chainConfig } from '../../zksync/chainConfig.js'
 
-export const zkSyncSepoliaTestnet = /*#__PURE__*/ defineChain({
+export const zksyncSepoliaTestnet = /*#__PURE__*/ defineChain({
   ...chainConfig,
   id: 300,
-  name: 'zkSync Sepolia Testnet',
+  name: 'ZKsync Sepolia Testnet',
   network: 'zksync-sepolia-testnet',
   nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
   rpcUrls: {
@@ -17,10 +17,12 @@ export const zkSyncSepoliaTestnet = /*#__PURE__*/ defineChain({
     default: {
       name: 'Etherscan',
       url: 'https://sepolia-era.zksync.network/',
+      apiUrl: 'https://api-sepolia-era.zksync.network/api',
     },
     native: {
-      name: 'zkSync Explorer',
+      name: 'ZKsync Explorer',
       url: 'https://sepolia.explorer.zksync.io/',
+      blockExplorerApi: 'https://block-explorer-api.sepolia.zksync.dev/api',
     },
   },
   contracts: {