viem 2.9.1 → 2.9.3

package/celo/utils.ts

@@ -0,0 +1,81 @@
+import type { Address } from 'abitype'
+import { trim } from '../utils/data/trim.js'
+import type {
+  CeloTransactionRequest,
+  CeloTransactionSerializable,
+  TransactionSerializableCIP42,
+  TransactionSerializableCIP64,
+} from './types.js'
+
+export function isEmpty(
+  value: string | undefined | number | BigInt,
+): value is undefined {
+  return (
+    value === 0 ||
+    value === 0n ||
+    value === undefined ||
+    value === null ||
+    value === '0' ||
+    value === '' ||
+    (typeof value === 'string' &&
+      (trim(value as Address).toLowerCase() === '0x' ||
+        trim(value as Address).toLowerCase() === '0x00'))
+  )
+}
+
+export function isPresent(
+  value: string | undefined | number | BigInt,
+): value is string | number | BigInt {
+  return !isEmpty(value)
+}
+
+export function isEIP1559(
+  transaction: CeloTransactionSerializable | CeloTransactionRequest,
+): boolean {
+  return (
+    typeof transaction.maxFeePerGas !== 'undefined' &&
+    typeof transaction.maxPriorityFeePerGas !== 'undefined'
+  )
+}
+
+// process as CIP42 if any of these fields are present. realistically gatewayfee is not used but is part of spec
+export function isCIP42(
+  transaction: CeloTransactionSerializable | CeloTransactionRequest,
+): transaction is TransactionSerializableCIP42 {
+  // Enable end-user to force the tx to be considered as a cip42
+  if (transaction.type === 'cip42') {
+    return true
+  }
+
+  return (
+    isEIP1559(transaction) &&
+    (isPresent(transaction.feeCurrency) ||
+      isPresent(transaction.gatewayFeeRecipient) ||
+      isPresent(transaction.gatewayFee))
+  )
+}
+
+export function isCIP64(
+  transaction: CeloTransactionSerializable | CeloTransactionRequest,
+): transaction is TransactionSerializableCIP64 {
+  /*
+   * Enable end user to force the tx to be considered as a CIP-64.
+   *
+   * The preliminary type will be determined as "eip1559" by src/utils/transaction/getTransactionType.ts
+   * and so we need the logic below to check for the specific value instead of checking if just any
+   * transaction type is provided. If that's anything else than "cip64" then we need to reevaluate the
+   * type based on the transaction fields.
+   *
+   * Modify with caution and according to https://github.com/celo-org/celo-proposals/blob/master/CIPs/cip-0064.md
+   */
+  if (transaction.type === 'cip64') {
+    return true
+  }
+
+  return (
+    isEIP1559(transaction) &&
+    isPresent(transaction.feeCurrency) &&
+    isEmpty(transaction.gatewayFee) &&
+    isEmpty(transaction.gatewayFeeRecipient)
+  )
+}

package/chains/definitions/ancient8.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 1 // mainnet
 

package/chains/definitions/ancient8Sepolia.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 11_155_111 // sepolia
 

package/chains/definitions/areonNetwork.ts

@@ -0,0 +1,20 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const areonNetwork = defineChain({
+  id: 463,
+  name: 'Areon Network',
+  nativeCurrency: { decimals: 18, name: 'AREA', symbol: 'AREA' },
+  rpcUrls: {
+    default: {
+      http: ['https://mainnet-rpc.areon.network'],
+      webSocket: ['wss://mainnet-ws.areon.network'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Areonscan',
+      url: 'https://areonscan.com',
+    },
+  },
+  testnet: false,
+})

package/chains/definitions/areonNetworkTestnet.ts

@@ -0,0 +1,20 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const areonNetworkTestnet = defineChain({
+  id: 462,
+  name: 'Areon Network Testnet',
+  nativeCurrency: { decimals: 18, name: 'TAREA', symbol: 'TAREA' },
+  rpcUrls: {
+    default: {
+      http: ['https://testnet-rpc.areon.network'],
+      webSocket: ['wss://testnet-ws.areon.network'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Areonscan',
+      url: 'https://areonscan.com',
+    },
+  },
+  testnet: true,
+})

package/chains/definitions/base.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 1 // mainnet
 

package/chains/definitions/baseGoerli.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 5 // goerli
 

package/chains/definitions/baseSepolia.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 11_155_111 // sepolia
 

package/chains/definitions/celo.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../celo/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../celo/chainConfig.js'
 
 export const celo = /*#__PURE__*/ defineChain({
   ...chainConfig,

package/chains/definitions/celoAlfajores.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../celo/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../celo/chainConfig.js'
 
 export const celoAlfajores = /*#__PURE__*/ defineChain({
   ...chainConfig,

package/chains/definitions/fraxtal.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 1 // mainnet
 

package/chains/definitions/fraxtalTestnet.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 17000 // holesky
 

package/chains/definitions/liskSepolia.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 11_155_111 // sepolia
 

package/chains/definitions/optimism.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 1 // mainnet
 

package/chains/definitions/optimismGoerli.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 5 // goerli
 

package/chains/definitions/optimismSepolia.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 11_155_111 // sepolia
 

package/chains/definitions/pgn.ts

@@ -1,5 +1,5 @@
+import { formatters } from '../../op-stack/formatters.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formatters } from '../opStack/formatters.js'
 
 const sourceId = 1 // mainnet
 

package/chains/definitions/pgnTestnet.ts

@@ -1,5 +1,5 @@
+import { formatters } from '../../op-stack/formatters.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { formatters } from '../opStack/formatters.js'
 
 const sourceId = 11_155_111 // sepolia
 

package/chains/definitions/polygonMumbai.ts

@@ -13,7 +13,7 @@ export const polygonMumbai = /*#__PURE__*/ defineChain({
     default: {
       name: 'PolygonScan',
       url: 'https://mumbai.polygonscan.com',
-      apiUrl: 'https://mumbai.polygonscan.com/api',
+      apiUrl: 'https://api-testnet.polygonscan.com/api',
     },
   },
   contracts: {

package/chains/definitions/rss3.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 1 // mainnet
 

package/chains/definitions/rss3Sepolia.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 11_155_111 // sepolia
 

package/chains/definitions/zkSync.ts

@@ -1,5 +1,5 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../zksync/chainConfig.js'
+import { chainConfig } from '../../zksync/chainConfig.js'
 
 export const zkSync = /*#__PURE__*/ defineChain({
   ...chainConfig,

package/chains/definitions/zkSyncSepoliaTestnet.ts

@@ -1,5 +1,5 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../zksync/chainConfig.js'
+import { chainConfig } from '../../zksync/chainConfig.js'
 
 export const zkSyncSepoliaTestnet = /*#__PURE__*/ defineChain({
   ...chainConfig,

package/chains/definitions/zkSyncTestnet.ts

@@ -1,5 +1,5 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../zksync/chainConfig.js'
+import { chainConfig } from '../../zksync/chainConfig.js'
 
 /** @deprecated Use `zkSyncSepoliaTestnet` */
 export const zkSyncTestnet = /*#__PURE__*/ defineChain({

package/chains/definitions/zora.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 1 // mainnet
 

package/chains/definitions/zoraSepolia.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 11_155_111 // sepolia
 

package/chains/definitions/zoraTestnet.ts

@@ -1,5 +1,5 @@
+import { chainConfig } from '../../op-stack/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
-import { chainConfig } from '../opStack/chainConfig.js'
 
 const sourceId = 5 // goerli
 

package/chains/index.ts

@@ -12,6 +12,8 @@ export { astar } from './definitions/astar.js'
 export { astarZkEVM } from './definitions/astarZkEVM.js'
 export { astarZkyoto } from './definitions/astarZkyoto.js'
 export { arbitrumSepolia } from './definitions/arbitrumSepolia.js'
+export { areonNetwork } from './definitions/areonNetwork.js'
+export { areonNetworkTestnet } from './definitions/areonNetworkTestnet.js'
 export { astarZkatana } from './definitions/astarZkatana.js'
 export { aurora } from './definitions/aurora.js'
 export { auroraTestnet } from './definitions/auroraTestnet.js'
@@ -271,13 +273,13 @@ export type {
   TransactionSerializableCIP64,
   TransactionSerializedCIP42,
   TransactionSerializedCIP64,
-} from './celo/types.js'
+} from '../celo/types.js'
 export type {
   OpStackBlock,
   OpStackBlockOverrides,
   OpStackRpcBlock,
   OpStackRpcBlockOverrides,
-} from './opStack/types/block.js'
+} from '../op-stack/types/block.js'
 export type {
   SerializeTransactionDepositReturnType,
   SerializeTransactionErrorType,
@@ -285,7 +287,7 @@ export type {
   serializeTransaction as serializeTransactionOpStack,
   assertTransactionDeposit as assertTransactionDepositOpStack,
   serializers as serializersOpStack,
-} from './opStack/serializers.js'
+} from '../op-stack/serializers.js'
 export type {
   OpStackDepositTransaction,
   OpStackRpcDepositTransaction,
@@ -300,22 +302,22 @@ export type {
   OpStackTransactionType,
   TransactionSerializableDeposit,
   TransactionSerializedDeposit,
-} from './opStack/types/transaction.js'
+} from '../op-stack/types/transaction.js'
 export type {
   ZkSyncBlock,
   ZkSyncBlockOverrides,
   ZkSyncRpcBlock,
   ZkSyncRpcBlockOverrides,
-} from './zksync/types/block.js'
-export type { ChainEIP712 } from './zksync/types/chain.js'
-export type { ZkSyncEip712Meta } from './zksync/types/eip712.js'
-export type { ZkSyncFeeValues } from './zksync/types/fee.js'
+} from '../zksync/types/block.js'
+export type { ChainEIP712 } from '../zksync/types/chain.js'
+export type { ZkSyncEip712Meta } from '../zksync/types/eip712.js'
+export type { ZkSyncFeeValues } from '../zksync/types/fee.js'
 export type {
   ZkSyncL2ToL1Log,
   ZkSyncLog,
   ZkSyncRpcL2ToL1Log,
   ZkSyncRpcLog,
-} from './zksync/types/log.js'
+} from '../zksync/types/log.js'
 export type {
   TransactionRequestEIP712,
   ZkSyncEIP712TransactionSignable,
@@ -336,4 +338,4 @@ export type {
   ZkSyncTransactionSerialized,
   ZkSyncTransactionSerializedEIP712,
   ZkSyncTransactionType,
-} from './zksync/types/transaction.js'
+} from '../zksync/types/transaction.js'

package/clients/createClient.ts

@@ -12,6 +12,10 @@ import type {
 } from '../types/eip1193.js'
 import type { ExactPartial, Prettify } from '../types/utils.js'
 import { parseAccount } from '../utils/accounts.js'
+import type {
+  CcipRequestParameters,
+  CcipRequestReturnType,
+} from '../utils/ccip.js'
 import { uid } from '../utils/uid.js'
 import type { PublicActions } from './decorators/public.js'
 import type { WalletActions } from './decorators/wallet.js'
@@ -39,6 +43,22 @@ export type ClientConfig<
    * @default 4_000
    */
   cacheTime?: number | undefined
+  /**
+   * [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration.
+   * If `false`, the client will not support offchain CCIP lookups.
+   */
+  ccipRead?:
+    | {
+        /**
+         * A function that will be called to make the offchain CCIP lookup request.
+         * @see https://eips.ethereum.org/EIPS/eip-3668#client-lookup-protocol
+         */
+        request?: (
+          parameters: CcipRequestParameters,
+        ) => Promise<CcipRequestReturnType>
+      }
+    | false
+    | undefined
   /** Chain for the client. */
   chain?: Chain | undefined | chain
   /** A key for the client. */
@@ -130,6 +150,8 @@ type Client_Base<
   batch?: ClientConfig['batch'] | undefined
   /** Time (in ms) that cached data will remain in memory. */
   cacheTime: number
+  /** [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. */
+  ccipRead?: ClientConfig['ccipRead'] | undefined
   /** Chain for the client. */
   chain: chain
   /** A key for the client. */
@@ -189,6 +211,7 @@ export function createClient(parameters: ClientConfig): Client {
   const {
     batch,
     cacheTime = parameters.pollingInterval ?? 4_000,
+    ccipRead,
     key = 'base',
     name = 'Base Client',
     pollingInterval = 4_000,
@@ -209,6 +232,7 @@ export function createClient(parameters: ClientConfig): Client {
     account,
     batch,
     cacheTime,
+    ccipRead,
     chain,
     key,
     name,

package/clients/createPublicClient.ts

@@ -19,6 +19,7 @@ export type PublicClientConfig<
     ClientConfig<transport, chain>,
     | 'batch'
     | 'cacheTime'
+    | 'ccipRead'
     | 'chain'
     | 'key'
     | 'name'

package/clients/createWalletClient.ts

@@ -27,6 +27,7 @@ export type WalletClientConfig<
     ClientConfig<transport, chain, accountOrAddress>,
     | 'account'
     | 'cacheTime'
+    | 'ccipRead'
     | 'chain'
     | 'key'
     | 'name'

package/errors/version.ts

@@ -1 +1 @@
-export const version = '2.9.1'
+export const version = '2.9.3'

package/index.ts

@@ -1335,8 +1335,11 @@ export {
   fromBytes,
 } from './utils/encoding/fromBytes.js'
 export {
-  type CcipFetchErrorType,
-  ccipFetch,
+  type CcipRequestParameters,
+  type CcipRequestErrorType,
+  ccipRequest,
+  /** @deprecated Use `ccipRequest`. */
+  ccipRequest as ccipFetch,
   type OffchainLookupErrorType,
   offchainLookup,
   offchainLookupAbiItem,

package/op-stack/actions/buildDepositTransaction.ts

@@ -0,0 +1,156 @@
+import type { Address } from 'abitype'
+import {
+  type ParseAccountErrorType,
+  parseAccount,
+} from '../../accounts/utils/parseAccount.js'
+import {
+  type PrepareTransactionRequestErrorType,
+  type PrepareTransactionRequestParameters,
+  prepareTransactionRequest,
+} from '../../actions/wallet/prepareTransactionRequest.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,
+  DeriveAccount,
+  GetAccountParameter,
+} from '../../types/account.js'
+import type {
+  Chain,
+  DeriveChain,
+  GetChainParameter,
+} from '../../types/chain.js'
+import type { Hex } from '../../types/misc.js'
+import type { Prettify, UnionOmit } from '../../types/utils.js'
+import type { DepositTransactionParameters } from './depositTransaction.js'
+
+export type BuildDepositTransactionParameters<
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
+  accountOverride extends Account | Address | undefined =
+    | Account
+    | Address
+    | undefined,
+  _derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
+> = GetAccountParameter<account, accountOverride, false> &
+  GetChainParameter<chain, chainOverride> & {
+    /** Gas limit for transaction execution on the L2. */
+    gas?: bigint | undefined
+    /** Value in wei to mint (deposit) on the L2. Debited from the caller's L1 balance. */
+    mint?: bigint | undefined
+    /** Value in wei sent with this transaction on the L2. Debited from the caller's L2 balance. */
+    value?: bigint | undefined
+  } & (
+    | {
+        /** Encoded contract method & arguments. */
+        data?: Hex | undefined
+        /** Whether or not this is a contract deployment transaction. */
+        isCreation?: false | undefined
+        /** L2 Transaction recipient. */
+        to?: Address | undefined
+      }
+    | {
+        /** Contract deployment bytecode. Required for contract deployment transactions. */
+        data: Hex
+        /** Whether or not this is a contract deployment transaction. */
+        isCreation: true
+        /** L2 Transaction recipient. Cannot exist for contract deployment transactions. */
+        to?: never | undefined
+      }
+  )
+
+export type BuildDepositTransactionReturnType<
+  account extends Account | undefined = Account | undefined,
+  accountOverride extends Account | Address | undefined =
+    | Account
+    | Address
+    | undefined,
+> = Prettify<
+  UnionOmit<DepositTransactionParameters<Chain, account, Chain>, 'account'> & {
+    account: DeriveAccount<account, accountOverride>
+  }
+>
+
+export type BuildDepositTransactionErrorType =
+  | ParseAccountErrorType
+  | PrepareTransactionRequestErrorType
+  | ErrorType
+
+/**
+ * Prepares parameters for a [deposit transaction](https://github.com/ethereum-optimism/optimism/blob/develop/specs/deposits.md) to be initiated on an L1.
+ *
+ * - Docs: https://viem.sh/op-stack/actions/buildDepositTransaction
+ *
+ * @param client - Client to use
+ * @param parameters - {@link BuildDepositTransactionParameters}
+ * @returns Parameters for `depositTransaction`. {@link DepositTransactionReturnType}
+ *
+ * @example
+ * import { createWalletClient, http, parseEther } from 'viem'
+ * import { base } from 'viem/chains'
+ * import { publicActionsL2 } from 'viem/op-stack'
+ * import { buildDepositTransaction } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   chain: base,
+ *   transport: http(),
+ * }).extend(publicActionsL2())
+ *
+ * const args = await buildDepositTransaction(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: parseEther('1'),
+ * })
+ */
+export async function buildDepositTransaction<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  chainOverride extends Chain | undefined = undefined,
+  accountOverride extends Account | Address | undefined = undefined,
+>(
+  client: Client<Transport, chain, account>,
+  args: BuildDepositTransactionParameters<
+    chain,
+    account,
+    chainOverride,
+    accountOverride
+  >,
+): Promise<BuildDepositTransactionReturnType<account, accountOverride>> {
+  const {
+    account: account_,
+    chain = client.chain,
+    gas,
+    data,
+    isCreation,
+    mint,
+    to,
+    value,
+  } = args
+
+  const account = account_ ? parseAccount(account_) : undefined
+
+  const request = await prepareTransactionRequest(client, {
+    account: mint ? undefined : account,
+    chain,
+    gas,
+    data,
+    parameters: ['gas'],
+    to,
+    value,
+  } as PrepareTransactionRequestParameters)
+
+  return {
+    account,
+    request: {
+      data: request.data,
+      gas: request.gas,
+      mint,
+      isCreation,
+      to: request.to,
+      value: request.value,
+    },
+    targetChain: chain,
+  } as unknown as BuildDepositTransactionReturnType<account, accountOverride>
+}