viem 2.0.0-beta.2 → 2.0.0-beta.4

package/chains/celo/chainConfig.ts

@@ -0,0 +1,7 @@
+import { formatters } from './formatters.js'
+import { serializers } from './serializers.js'
+
+export const chainConfig = {
+  formatters,
+  serializers,
+} as const

package/chains/celo/formatters.ts

@@ -21,7 +21,7 @@ import type {
 } from './types.js'
 import { isCIP42, isCIP64 } from './utils.js'
 
-export const formattersCelo = {
+export const formatters = {
   block: /*#__PURE__*/ defineBlock({
     exclude: ['difficulty', 'gasLimit', 'mixHash', 'nonce', 'uncles'],
     format(

package/chains/celo/index.ts

@@ -0,0 +1,35 @@
+export { chainConfig } from './chainConfig.js'
+
+export { parseTransaction } from './parsers.js'
+
+export { serializeTransaction } from './serializers.js'
+
+export type {
+  CeloBlock,
+  CeloBlockOverrides,
+  CeloRpcBlock,
+  CeloRpcBlockOverrides,
+  CeloRpcTransaction,
+  CeloRpcTransactionReceipt,
+  CeloRpcTransactionReceiptOverrides,
+  CeloRpcTransactionRequest,
+  CeloTransaction,
+  CeloTransactionReceipt,
+  CeloTransactionReceiptOverrides,
+  CeloTransactionRequest,
+  CeloTransactionSerializable,
+  CeloTransactionSerialized,
+  CeloTransactionType,
+  RpcTransactionCIP42,
+  RpcTransactionCIP64,
+  RpcTransactionRequestCIP42,
+  RpcTransactionRequestCIP64,
+  TransactionCIP42,
+  TransactionCIP64,
+  TransactionRequestCIP42,
+  TransactionRequestCIP64,
+  TransactionSerializableCIP42,
+  TransactionSerializableCIP64,
+  TransactionSerializedCIP42,
+  TransactionSerializedCIP64,
+} from './types.js'

package/chains/celo/package.json

@@ -0,0 +1,6 @@
+{
+  "type": "module",
+  "types": "../../_types/chains/celo/index.d.ts",
+  "module": "../../_esm/chains/celo/index.js",
+  "main": "../../_cjs/chains/celo/index.js"
+}

package/chains/celo/parsers.ts

@@ -6,9 +6,9 @@ import { hexToBigInt, hexToNumber } from '../../utils/encoding/fromHex.js'
 import type { RecursiveArray } from '../../utils/encoding/toRlp.js'
 import type { GetSerializedTransactionType } from '../../utils/transaction/getSerializedTransactionType.js'
 import {
-  type ParseTransactionReturnType,
+  type ParseTransactionReturnType as ParseTransactionReturnType_,
   parseAccessList,
-  parseTransaction,
+  parseTransaction as parseTransaction_,
   toTransactionArray,
 } from '../../utils/transaction/parseTransaction.js'
 import {
@@ -24,33 +24,31 @@ import type {
   TransactionSerializedCIP64,
 } from './types.js'
 
-export type ParseTransactionCeloReturnType<
+export type ParseTransactionReturnType<
   TSerialized extends CeloTransactionSerialized = CeloTransactionSerialized,
   TType extends CeloTransactionType = GetSerializedTransactionType<TSerialized>,
 > = TSerialized extends TransactionSerializedCIP42
   ? TransactionSerializableCIP42
-  : ParseTransactionReturnType<TSerialized, TType>
+  : ParseTransactionReturnType_<TSerialized, TType>
 
-export function parseTransactionCelo<
+export function parseTransaction<
   TSerialized extends CeloTransactionSerialized,
->(
-  serializedTransaction: TSerialized,
-): ParseTransactionCeloReturnType<TSerialized> {
+>(serializedTransaction: TSerialized): ParseTransactionReturnType<TSerialized> {
   const serializedType = sliceHex(serializedTransaction, 0, 1)
 
   if (serializedType === '0x7c')
     return parseTransactionCIP42(
       serializedTransaction as TransactionSerializedCIP42,
-    ) as ParseTransactionCeloReturnType<TSerialized>
+    ) as ParseTransactionReturnType<TSerialized>
 
   if (serializedType === '0x7b')
     return parseTransactionCIP64(
       serializedTransaction as TransactionSerializedCIP64,
-    ) as ParseTransactionCeloReturnType<TSerialized>
+    ) as ParseTransactionReturnType<TSerialized>
 
-  return parseTransaction(
+  return parseTransaction_(
     serializedTransaction,
-  ) as ParseTransactionCeloReturnType<TSerialized>
+  ) as ParseTransactionReturnType<TSerialized>
 }
 
 function parseTransactionCIP42(

package/chains/celo/serializers.ts

@@ -13,7 +13,7 @@ import { toRlp } from '../../utils/encoding/toRlp.js'
 import { serializeAccessList } from '../../utils/transaction/serializeAccessList.js'
 import {
   type SerializeTransactionFn,
-  serializeTransaction,
+  serializeTransaction as serializeTransaction_,
 } from '../../utils/transaction/serializeTransaction.js'
 import type {
   CeloTransactionSerializable,
@@ -24,7 +24,7 @@ import type {
 } from './types.js'
 import { isCIP42, isCIP64, isEmpty, isPresent } from './utils.js'
 
-export const serializeTransactionCelo: SerializeTransactionFn<
+export const serializeTransaction: SerializeTransactionFn<
   CeloTransactionSerializable | TransactionSerializable
 > = (tx, signature) => {
   if (isCIP64(tx)) {
@@ -32,12 +32,12 @@ export const serializeTransactionCelo: SerializeTransactionFn<
   } else if (isCIP42(tx)) {
     return serializeTransactionCIP42(tx, signature)
   } else {
-    return serializeTransaction(tx as TransactionSerializable, signature)
+    return serializeTransaction_(tx as TransactionSerializable, signature)
   }
 }
 
-export const serializersCelo = {
-  transaction: serializeTransactionCelo,
+export const serializers = {
+  transaction: serializeTransaction,
 } as const satisfies ChainSerializers
 
 //////////////////////////////////////////////////////////////////////////////

package/chains/definitions/base.ts

@@ -1,7 +1,8 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formattersOptimism } from '../optimism/formatters.js'
+import { chainConfig } from '../opStack/chainConfig.js'
 
 export const base = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 8453,
   name: 'Base',
   nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
@@ -17,10 +18,10 @@ export const base = /*#__PURE__*/ defineChain({
     },
   },
   contracts: {
+    ...chainConfig.contracts,
     multicall3: {
       address: '0xca11bde05977b3631167028862be2a173976ca11',
       blockCreated: 5022,
     },
   },
-  formatters: formattersOptimism,
 })

package/chains/definitions/baseGoerli.ts

@@ -1,7 +1,8 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formattersOptimism } from '../optimism/formatters.js'
+import { chainConfig } from '../opStack/chainConfig.js'
 
 export const baseGoerli = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 84531,
   name: 'Base Goerli',
   nativeCurrency: { name: 'Goerli Ether', symbol: 'ETH', decimals: 18 },
@@ -15,6 +16,7 @@ export const baseGoerli = /*#__PURE__*/ defineChain({
     },
   },
   contracts: {
+    ...chainConfig.contracts,
     multicall3: {
       address: '0xca11bde05977b3631167028862be2a173976ca11',
       blockCreated: 1376988,
@@ -22,5 +24,4 @@ export const baseGoerli = /*#__PURE__*/ defineChain({
   },
   testnet: true,
   sourceId: 5, // goerli
-  formatters: formattersOptimism,
 })

package/chains/definitions/baseSepolia.ts

@@ -1,7 +1,8 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formattersOptimism } from '../optimism/formatters.js'
+import { chainConfig } from '../opStack/chainConfig.js'
 
 export const baseSepolia = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 84532,
   network: 'base-sepolia',
   name: 'Base Sepolia',
@@ -24,7 +25,7 @@ export const baseSepolia = /*#__PURE__*/ defineChain({
       url: 'https://base-sepolia.blockscout.com',
     },
   },
+  contracts: { ...chainConfig.contracts },
   testnet: true,
   sourceId: 11155111, // sepolia
-  formatters: formattersOptimism,
 })

package/chains/definitions/celo.ts

@@ -1,8 +1,8 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formattersCelo } from '../celo/formatters.js'
-import { serializersCelo } from '../celo/serializers.js'
+import { chainConfig } from '../celo/chainConfig.js'
 
 export const celo = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 42_220,
   name: 'Celo',
   nativeCurrency: {
@@ -26,6 +26,4 @@ export const celo = /*#__PURE__*/ defineChain({
     },
   },
   testnet: false,
-  formatters: formattersCelo,
-  serializers: serializersCelo,
 })

package/chains/definitions/celoAlfajores.ts

@@ -1,8 +1,8 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formattersCelo } from '../celo/formatters.js'
-import { serializersCelo } from '../celo/serializers.js'
+import { chainConfig } from '../celo/chainConfig.js'
 
 export const celoAlfajores = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 44_787,
   name: 'Alfajores',
   nativeCurrency: {
@@ -28,6 +28,4 @@ export const celoAlfajores = /*#__PURE__*/ defineChain({
     },
   },
   testnet: true,
-  formatters: formattersCelo,
-  serializers: serializersCelo,
 })

package/chains/definitions/celoCannoli.ts

@@ -1,8 +1,8 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formattersCelo } from '../celo/formatters.js'
-import { serializersCelo } from '../celo/serializers.js'
+import { chainConfig } from '../celo/chainConfig.js'
 
 export const celoCannoli = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 17_323,
   name: 'Cannoli',
   nativeCurrency: {
@@ -28,6 +28,4 @@ export const celoCannoli = /*#__PURE__*/ defineChain({
     },
   },
   testnet: true,
-  formatters: formattersCelo,
-  serializers: serializersCelo,
 })

package/chains/definitions/optimism.ts

@@ -1,7 +1,8 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formattersOptimism } from '../optimism/formatters.js'
+import { chainConfig } from '../opStack/chainConfig.js'
 
 export const optimism = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 10,
   name: 'OP Mainnet',
   nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
@@ -17,10 +18,10 @@ export const optimism = /*#__PURE__*/ defineChain({
     },
   },
   contracts: {
+    ...chainConfig.contracts,
     multicall3: {
       address: '0xca11bde05977b3631167028862be2a173976ca11',
       blockCreated: 4286263,
     },
   },
-  formatters: formattersOptimism,
 })

package/chains/definitions/optimismGoerli.ts

@@ -1,7 +1,8 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formattersOptimism } from '../optimism/formatters.js'
+import { chainConfig } from '../opStack/chainConfig.js'
 
 export const optimismGoerli = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 420,
   name: 'Optimism Goerli',
   nativeCurrency: { name: 'Goerli Ether', symbol: 'ETH', decimals: 18 },
@@ -17,11 +18,11 @@ export const optimismGoerli = /*#__PURE__*/ defineChain({
     },
   },
   contracts: {
+    ...chainConfig.contracts,
     multicall3: {
       address: '0xca11bde05977b3631167028862be2a173976ca11',
       blockCreated: 49461,
     },
   },
   testnet: true,
-  formatters: formattersOptimism,
 })

package/chains/definitions/optimismSepolia.ts

@@ -1,7 +1,8 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formattersOptimism } from '../optimism/formatters.js'
+import { chainConfig } from '../opStack/chainConfig.js'
 
 export const optimismSepolia = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 11155420,
   name: 'Optimism Sepolia',
   nativeCurrency: { name: 'Sepolia Ether', symbol: 'ETH', decimals: 18 },
@@ -17,11 +18,11 @@ export const optimismSepolia = /*#__PURE__*/ defineChain({
     },
   },
   contracts: {
+    ...chainConfig.contracts,
     multicall3: {
       address: '0xca11bde05977b3631167028862be2a173976ca11',
       blockCreated: 1620204,
     },
   },
   testnet: true,
-  formatters: formattersOptimism,
 })

package/chains/definitions/zkSync.ts

@@ -1,8 +1,8 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formattersZkSync } from '../zksync/formatters.js'
-import { serializersZkSync } from '../zksync/serializers.js'
+import { chainConfig } from '../zksync/chainConfig.js'
 
 export const zkSync = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 324,
   name: 'zkSync Era',
   network: 'zksync-era',
@@ -28,6 +28,4 @@ export const zkSync = /*#__PURE__*/ defineChain({
       address: '0xF9cda624FBC7e059355ce98a31693d299FACd963',
     },
   },
-  serializers: serializersZkSync,
-  formatters: formattersZkSync,
 })

package/chains/definitions/zkSyncTestnet.ts

@@ -1,8 +1,8 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formattersZkSync } from '../zksync/formatters.js'
-import { serializersZkSync } from '../zksync/serializers.js'
+import { chainConfig } from '../zksync/chainConfig.js'
 
 export const zkSyncTestnet = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 280,
   name: 'zkSync Era Testnet',
   network: 'zksync-era-testnet',
@@ -25,6 +25,4 @@ export const zkSyncTestnet = /*#__PURE__*/ defineChain({
     },
   },
   testnet: true,
-  serializers: serializersZkSync,
-  formatters: formattersZkSync,
 })

package/chains/definitions/zora.ts

@@ -1,7 +1,8 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formattersOptimism } from '../optimism/formatters.js'
+import { chainConfig } from '../opStack/chainConfig.js'
 
 export const zora = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 7777777,
   name: 'Zora',
   nativeCurrency: {
@@ -19,10 +20,10 @@ export const zora = /*#__PURE__*/ defineChain({
     default: { name: 'Explorer', url: 'https://explorer.zora.energy' },
   },
   contracts: {
+    ...chainConfig.contracts,
     multicall3: {
       address: '0xcA11bde05977b3631167028862bE2a173976CA11',
       blockCreated: 5882,
     },
   },
-  formatters: formattersOptimism,
 })

package/chains/definitions/zoraSepolia.ts

@@ -1,7 +1,8 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formattersOptimism } from '../optimism/formatters.js'
+import { chainConfig } from '../opStack/chainConfig.js'
 
 export const zoraSepolia = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 999999999,
   name: 'Zora Sepolia',
   network: 'zora-sepolia',
@@ -27,11 +28,11 @@ export const zoraSepolia = /*#__PURE__*/ defineChain({
     },
   },
   contracts: {
+    ...chainConfig.contracts,
     multicall3: {
       address: '0xcA11bde05977b3631167028862bE2a173976CA11',
       blockCreated: 83160,
     },
   },
   testnet: true,
-  formatters: formattersOptimism,
 })

package/chains/definitions/zoraTestnet.ts

@@ -1,7 +1,8 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formattersOptimism } from '../optimism/formatters.js'
+import { chainConfig } from '../opStack/chainConfig.js'
 
 export const zoraTestnet = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 999,
   name: 'Zora Goerli Testnet',
   nativeCurrency: {
@@ -22,11 +23,11 @@ export const zoraTestnet = /*#__PURE__*/ defineChain({
     },
   },
   contracts: {
+    ...chainConfig.contracts,
     multicall3: {
       address: '0xcA11bde05977b3631167028862bE2a173976CA11',
       blockCreated: 189123,
     },
   },
   testnet: true,
-  formatters: formattersOptimism,
 })

package/chains/opStack/abis.ts

@@ -0,0 +1,73 @@
+export const gasPriceOracleAbi = [
+  { inputs: [], stateMutability: 'nonpayable', type: 'constructor' },
+  {
+    inputs: [],
+    name: 'DECIMALS',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'baseFee',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'decimals',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'pure',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'gasPrice',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'bytes', name: '_data', type: 'bytes' }],
+    name: 'getL1Fee',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'bytes', name: '_data', type: 'bytes' }],
+    name: 'getL1GasUsed',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'l1BaseFee',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'overhead',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'scalar',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'version',
+    outputs: [{ internalType: 'string', name: '', type: 'string' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+] as const

package/chains/opStack/actions/estimateContractL1Fee.ts

@@ -0,0 +1,142 @@
+import type { Abi } from 'abitype'
+
+import type { Account } from '../../../accounts/types.js'
+import {
+  type ParseAccountErrorType,
+  parseAccount,
+} 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 type { Chain } from '../../../types/chain.js'
+import type {
+  ContractFunctionArgs,
+  ContractFunctionName,
+  ContractFunctionParameters,
+  GetValue,
+} from '../../../types/contract.js'
+import type { UnionOmit } from '../../../types/utils.js'
+import {
+  type EncodeFunctionDataErrorType,
+  type EncodeFunctionDataParameters,
+  encodeFunctionData,
+} from '../../../utils/abi/encodeFunctionData.js'
+import {
+  type GetContractErrorReturnType,
+  getContractError,
+} from '../../../utils/errors/getContractError.js'
+import {
+  type EstimateL1FeeErrorType,
+  type EstimateL1FeeParameters,
+  estimateL1Fee,
+} from './estimateL1Fee.js'
+
+export type EstimateContractL1FeeParameters<
+  abi extends Abi | readonly unknown[] = Abi,
+  functionName extends ContractFunctionName<
+    abi,
+    'nonpayable' | 'payable'
+  > = ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<
+    abi,
+    'nonpayable' | 'payable',
+    functionName
+  > = ContractFunctionArgs<abi, 'nonpayable' | 'payable', functionName>,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
+> = ContractFunctionParameters<
+  abi,
+  'nonpayable' | 'payable',
+  functionName,
+  args
+> &
+  UnionOmit<
+    EstimateL1FeeParameters<chain, account, chainOverride>,
+    'data' | 'to' | 'value'
+  > &
+  GetValue<
+    abi,
+    functionName,
+    EstimateL1FeeParameters<
+      chain,
+      account,
+      chainOverride
+    > extends EstimateL1FeeParameters
+      ? EstimateL1FeeParameters<chain, account, chainOverride>['value']
+      : EstimateL1FeeParameters['value']
+  >
+
+export type EstimateContractL1FeeReturnType = bigint
+
+export type EstimateContractL1FeeErrorType = GetContractErrorReturnType<
+  EncodeFunctionDataErrorType | EstimateL1FeeErrorType | ParseAccountErrorType
+>
+
+/**
+ * Estimates the L1 data fee required to execute an L2 contract write.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link EstimateContractL1FeeParameters}
+ * @returns The gas estimate (in wei). {@link EstimateContractL1FeeReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseAbi } from 'viem'
+ * import { optimism } from 'viem/chains'
+ * import { estimateContractL1Fee } from 'viem/op-stack'
+ *
+ * const client = createPublicClient({
+ *   chain: optimism,
+ *   transport: http(),
+ * })
+ * const l1Fee = await estimateContractL1Fee(client, {
+ *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+ *   abi: parseAbi(['function mint() public']),
+ *   functionName: 'mint',
+ *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+ * })
+ */
+export async function estimateContractL1Fee<
+  const abi extends Abi | readonly unknown[],
+  functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
+  chain extends Chain | undefined,
+  account extends Account | undefined = undefined,
+  chainOverride extends Chain | undefined = undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: EstimateContractL1FeeParameters<
+    abi,
+    functionName,
+    args,
+    chain,
+    account,
+    chainOverride
+  >,
+): Promise<EstimateContractL1FeeReturnType> {
+  const { abi, address, args, functionName, ...request } =
+    parameters as EstimateContractL1FeeParameters
+  const data = encodeFunctionData({
+    abi,
+    args,
+    functionName,
+  } as EncodeFunctionDataParameters)
+  try {
+    const fee = await estimateL1Fee(client, {
+      data,
+      to: address,
+      ...request,
+    } as unknown as EstimateL1FeeParameters)
+    return fee
+  } catch (error) {
+    const account = request.account ? parseAccount(request.account) : undefined
+    throw getContractError(error as BaseError, {
+      abi,
+      address,
+      args,
+      docsPath: '/docs/chains/op-stack/estimateContractL1Fee',
+      functionName,
+      sender: account?.address,
+    })
+  }
+}