viem 2.20.1 → 2.21.1

package/actions/wallet/prepareTransactionRequest.ts

@@ -55,6 +55,7 @@ import { commitmentsToVersionedHashes } from '../../utils/blob/commitmentsToVers
 import { toBlobSidecars } from '../../utils/blob/toBlobSidecars.js'
 import type { FormattedTransactionRequest } from '../../utils/formatters/transactionRequest.js'
 import { getAction } from '../../utils/getAction.js'
+import type { NonceManager } from '../../utils/nonceManager.js'
 import {
   type AssertRequestErrorType,
   type AssertRequestParameters,
@@ -96,6 +97,15 @@ export type PrepareTransactionRequestRequest<
   _derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
 > = UnionOmit<FormattedTransactionRequest<_derivedChain>, 'from'> &
   GetTransactionRequestKzgParameter & {
+    /**
+     * Nonce manager to use for the transaction request.
+     */
+    nonceManager?: NonceManager | undefined
+    /**
+     * Parameters to prepare for the transaction request.
+     *
+     * @default ['blobVersionedHashes', 'chainId', 'fees', 'gas', 'nonce', 'type']
+     */
     parameters?: readonly PrepareTransactionRequestParameterType[] | undefined
   }
 
@@ -248,6 +258,7 @@ export async function prepareTransactionRequest<
     gas,
     kzg,
     nonce,
+    nonceManager,
     parameters = defaultParameters,
     type,
   } = args
@@ -306,9 +317,9 @@ export async function prepareTransactionRequest<
   if (parameters.includes('chainId')) request.chainId = await getChainId()
 
   if (parameters.includes('nonce') && typeof nonce === 'undefined' && account) {
-    if (account.nonceManager) {
+    if (nonceManager) {
       const chainId = await getChainId()
-      request.nonce = await account.nonceManager.consume({
+      request.nonce = await nonceManager.consume({
         address: account.address,
         chainId,
         client,

package/actions/wallet/sendTransaction.ts

@@ -253,6 +253,7 @@ export async function sendTransaction<
         maxFeePerGas,
         maxPriorityFeePerGas,
         nonce,
+        nonceManager: account.nonceManager,
         parameters: [...defaultParameters, 'sidecars'],
         value,
         ...rest,

package/chains/definitions/fluence.ts

@@ -0,0 +1,20 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const fluence = /*#__PURE__*/ defineChain({
+  id: 9_999_999,
+  name: 'Fluence',
+  nativeCurrency: { name: 'FLT', symbol: 'FLT', decimals: 18 },
+  rpcUrls: {
+    default: {
+      http: ['https://rpc.mainnet.fluence.dev'],
+      webSocket: ['wss://ws.mainnet.fluence.dev'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Blockscout',
+      url: 'https://blockscout.mainnet.fluence.dev',
+      apiUrl: 'https://blockscout.mainnet.fluence.dev/api',
+    },
+  },
+})

package/chains/definitions/fluenceStage.ts

@@ -0,0 +1,21 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const fluenceStage = /*#__PURE__*/ defineChain({
+  id: 123_420_000_220,
+  name: 'Fluence Stage',
+  nativeCurrency: { name: 'tFLT', symbol: 'tFLT', decimals: 18 },
+  rpcUrls: {
+    default: {
+      http: ['https://rpc.stage.fluence.dev'],
+      webSocket: ['wss://ws.stage.fluence.dev'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Blockscout',
+      url: 'https://blockscout.stage.fluence.dev',
+      apiUrl: 'https://blockscout.stage.fluence.dev/api',
+    },
+  },
+  testnet: true,
+})

package/chains/definitions/fluenceTestnet.ts

@@ -0,0 +1,21 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const fluenceTestnet = /*#__PURE__*/ defineChain({
+  id: 52_164_803,
+  name: 'Fluence Testnet',
+  nativeCurrency: { name: 'tFLT', symbol: 'tFLT', decimals: 18 },
+  rpcUrls: {
+    default: {
+      http: ['https://rpc.testnet.fluence.dev'],
+      webSocket: ['wss://ws.testnet.fluence.dev'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Blockscout',
+      url: 'https://blockscout.testnet.fluence.dev',
+      apiUrl: 'https://blockscout.testnet.fluence.dev/api',
+    },
+  },
+  testnet: true,
+})

package/chains/definitions/linea.ts

@@ -1,6 +1,8 @@
+import { chainConfig } from '../../linea/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const linea = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 59_144,
   name: 'Linea Mainnet',
   nativeCurrency: { name: 'Linea Ether', symbol: 'ETH', decimals: 18 },

package/chains/definitions/lineaSepolia.ts

@@ -1,6 +1,8 @@
+import { chainConfig } from '../../linea/chainConfig.js'
 import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const lineaSepolia = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 59_141,
   name: 'Linea Sepolia Testnet',
   nativeCurrency: { name: 'Linea Ether', symbol: 'ETH', decimals: 18 },

package/chains/definitions/soneiumMinato.ts

@@ -0,0 +1,26 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const soneiumMinato = defineChain({
+  id: 1946,
+  name: 'Soneium Minato',
+  nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
+  rpcUrls: {
+    default: {
+      http: ['https://rpc.minato.soneium.org'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Minato Explorer',
+      url: 'https://explorer-testnet.soneium.org',
+      apiUrl: 'https://explorer-testnet.soneium.org/api/',
+    },
+  },
+  contracts: {
+    multicall3: {
+      address: '0xcA11bde05977b3631167028862bE2a173976CA11',
+      blockCreated: 1,
+    },
+  },
+  testnet: true,
+})

package/chains/definitions/sophonTestnet.ts

@@ -1,12 +1,14 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
+import { chainConfig } from '../../zksync/chainConfig.js'
 
 export const sophonTestnet = /*#__PURE__*/ defineChain({
+  ...chainConfig,
   id: 531_050_104,
   name: 'Sophon Testnet',
   nativeCurrency: {
     decimals: 18,
     name: 'Sophon',
-    symbol: 'ETH',
+    symbol: 'SOPH',
   },
   rpcUrls: {
     default: {

package/chains/definitions/storyTestnet.ts

@@ -0,0 +1,21 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const storyTestnet = /*#__PURE__*/ defineChain({
+  id: 1513,
+  name: 'Story Testnet',
+  nativeCurrency: {
+    decimals: 18,
+    name: 'IP',
+    symbol: 'IP',
+  },
+  rpcUrls: {
+    default: { http: ['https://testnet.storyrpc.io'] },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Story Testnet Explorer',
+      url: 'https://testnet.storyscan.xyz',
+    },
+  },
+  testnet: true,
+})

package/chains/definitions/tron.ts

@@ -0,0 +1,19 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const tron = /*#__PURE__*/ defineChain({
+  id: 728126428,
+  name: 'Tron',
+  nativeCurrency: { name: 'TRON', symbol: 'TRX', decimals: 6 },
+  rpcUrls: {
+    default: {
+      http: ['https://api.trongrid.io/jsonrpc'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Tronscan',
+      url: 'https://tronscan.org',
+      apiUrl: 'https://apilist.tronscanapi.com/api',
+    },
+  },
+})

package/chains/index.ts

@@ -111,6 +111,9 @@ export { flareTestnet } from './definitions/flareTestnet.js'
 export { flowPreviewnet } from './definitions/flowPreviewnet.js'
 export { flowMainnet } from './definitions/flowMainnet.js'
 export { flowTestnet } from './definitions/flowTestnet.js'
+export { fluence } from './definitions/fluence.js'
+export { fluenceStage } from './definitions/fluenceStage.js'
+export { fluenceTestnet } from './definitions/fluenceTestnet.js'
 export { forma } from './definitions/forma.js'
 /** @deprecated Use `anvil` instead. */
 export { foundry } from './definitions/foundry.js'
@@ -277,6 +280,7 @@ export { skaleRazor } from './definitions/skale/razor.js'
 export { skaleTitan } from './definitions/skale/titan.js'
 export { skaleTitanTestnet } from './definitions/skale/titanTestnet.js'
 export { sketchpad } from './definitions/sketchpad.js'
+export { soneiumMinato } from './definitions/soneiumMinato.js'
 export { songbird } from './definitions/songbird.js'
 export { songbirdTestnet } from './definitions/songbirdTestnet.js'
 export { sophonTestnet } from './definitions/sophonTestnet.js'
@@ -284,6 +288,7 @@ export { spicy } from './definitions/spicy.js'
 export { shardeumSphinx } from './definitions/shardeumSphinx.js'
 export { shibarium } from './definitions/shibarium.js'
 export { shibariumTestnet } from './definitions/shibariumTestnet.js'
+export { storyTestnet } from './definitions/storyTestnet.js'
 export { stratis } from './definitions/stratis.js'
 export { syscoin } from './definitions/syscoin.js'
 export { syscoinTestnet } from './definitions/syscoinTestnet.js'
@@ -300,6 +305,7 @@ export { telosTestnet } from './definitions/telosTestnet.js'
 export { tenet } from './definitions/tenet.js'
 export { thaiChain } from './definitions/thaiChain.js'
 export { thunderTestnet } from './definitions/thunderTestnet.js'
+export { tron } from './definitions/tron.js'
 export { unreal } from './definitions/unreal.js'
 export { vechain } from './definitions/vechain.js'
 export { wanchain } from './definitions/wanchain.js'

package/errors/node.ts

@@ -150,7 +150,8 @@ export type InsufficientFundsErrorType = InsufficientFundsError & {
   name: 'InsufficientFundsError'
 }
 export class InsufficientFundsError extends BaseError {
-  static nodeMessage = /insufficient funds/
+  static nodeMessage =
+    /insufficient funds|exceeds transaction sender account balance/
   constructor({ cause }: { cause?: BaseError | undefined } = {}) {
     super(
       [

package/errors/version.ts

@@ -1 +1 @@
-export const version = '2.20.1'
+export const version = '2.21.1'

package/index.ts

@@ -467,11 +467,14 @@ export type {
 } from './actions/wallet/writeContract.js'
 export type {
   Chain,
+  ChainConfig,
   ChainContract,
+  ChainEstimateFeesPerGasFn,
   ChainFees,
   ChainFeesFnParameters,
   ChainFormatter,
   ChainEstimateFeesPerGasFnParameters,
+  ChainMaxPriorityFeePerGasFn,
   DeriveChain,
   GetChainParameter,
   ChainFormatters,

package/linea/actions/estimateGas.ts

@@ -0,0 +1,137 @@
+import type { Account } from '../../accounts/types.js'
+import { parseAccount } from '../../accounts/utils/parseAccount.js'
+import type { EstimateGasParameters as EstimateGasParameters_base } from '../../actions/public/estimateGas.js'
+import {
+  type PrepareTransactionRequestParameters,
+  prepareTransactionRequest,
+} from '../../actions/wallet/prepareTransactionRequest.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import { AccountNotFoundError } from '../../errors/account.js'
+import type { BaseError } from '../../errors/base.js'
+import type { GetAccountParameter } from '../../types/account.js'
+import type { Chain } from '../../types/chain.js'
+import type { TransactionRequest } from '../../types/transaction.js'
+import type { Filter } from '../../types/utils.js'
+import { numberToHex } from '../../utils/encoding/toHex.js'
+import { getCallError } from '../../utils/errors/getCallError.js'
+import { extract } from '../../utils/formatters/extract.js'
+import { formatTransactionRequest } from '../../utils/formatters/transactionRequest.js'
+import {
+  type AssertRequestParameters,
+  assertRequest,
+} from '../../utils/transaction/assertRequest.js'
+import type { LineaRpcSchema } from '../types/rpc.js'
+
+export type EstimateGasParameters<
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+> = EstimateGasParameters_base<chain> & GetAccountParameter<account>
+
+export type EstimateGasReturnType = {
+  gasLimit: bigint
+  baseFeePerGas: bigint
+  priorityFeePerGas: bigint
+}
+
+/**
+ * Estimates the gas and fees per gas necessary to complete a transaction without submitting it to the network.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link EstimateGasParameters}
+ * @returns A gas estimate and fees per gas (in wei). {@link EstimateGasReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseEther } from 'viem'
+ * import { linea } from 'viem/chains'
+ * import { estimateGas } from 'viem/linea'
+ *
+ * const client = createPublicClient({
+ *   chain: linea,
+ *   transport: http(),
+ * })
+ * const gasEstimate = await estimateGas(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: 0n,
+ * })
+ */
+export async function estimateGas<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+>(
+  client: Client<Transport, chain, account>,
+  args: EstimateGasParameters<chain>,
+): Promise<EstimateGasReturnType> {
+  const { account: account_ = client.account } = args
+
+  if (!account_) throw new AccountNotFoundError()
+  const account = parseAccount(account_)
+
+  try {
+    const {
+      accessList,
+      blockNumber,
+      blockTag,
+      data,
+      gas,
+      gasPrice,
+      maxFeePerGas,
+      maxPriorityFeePerGas,
+      nonce,
+      to,
+      value,
+      ...rest
+    } =
+      account?.type === 'local'
+        ? ((await prepareTransactionRequest(
+            client,
+            args as PrepareTransactionRequestParameters,
+          )) as EstimateGasParameters)
+        : args
+
+    const blockNumberHex = blockNumber ? numberToHex(blockNumber) : undefined
+    const block = blockNumberHex || blockTag
+
+    assertRequest(args as AssertRequestParameters)
+
+    const chainFormat = client.chain?.formatters?.transactionRequest?.format
+    const format = chainFormat || formatTransactionRequest
+
+    const request = format({
+      // Pick out extra data that might exist on the chain's transaction request type.
+      ...extract(rest, { format: chainFormat }),
+      from: account?.address,
+      accessList,
+      data,
+      gas,
+      gasPrice,
+      maxFeePerGas,
+      maxPriorityFeePerGas,
+      nonce,
+      to,
+      value,
+    } as TransactionRequest)
+
+    type LineaEstimateGasSchema = Filter<
+      LineaRpcSchema,
+      { Method: 'linea_estimateGas' }
+    >[0]
+    const { baseFeePerGas, gasLimit, priorityFeePerGas } =
+      await client.request<LineaEstimateGasSchema>({
+        method: 'linea_estimateGas',
+        params: block ? [request, block] : [request],
+      })
+    return {
+      baseFeePerGas: BigInt(baseFeePerGas),
+      gasLimit: BigInt(gasLimit),
+      priorityFeePerGas: BigInt(priorityFeePerGas),
+    }
+  } catch (err) {
+    throw getCallError(err as BaseError, {
+      ...args,
+      account,
+      chain: client.chain,
+    })
+  }
+}

package/linea/chainConfig.ts

@@ -0,0 +1,53 @@
+import type { ChainConfig, ChainEstimateFeesPerGasFn } from '../types/chain.js'
+import { estimateGas } from './actions/estimateGas.js'
+
+export const chainConfig = {
+  fees: {
+    estimateFeesPerGas,
+    async maxPriorityFeePerGas({ block, client, request }) {
+      const response = await estimateFeesPerGas({
+        block,
+        client,
+        multiply: (x) => x,
+        request,
+        type: 'eip1559',
+      })
+      // Returning `null` will trigger the base `estimateMaxPriorityFeePerGas` to perform
+      // fallback mechanisms to estimate priority fee.
+      if (!response?.maxPriorityFeePerGas) return null
+      return response.maxPriorityFeePerGas
+    },
+  },
+} as const satisfies ChainConfig
+
+///////////////////////////////////////////////////////////////////////////
+// Internal
+///////////////////////////////////////////////////////////////////////////
+
+async function estimateFeesPerGas({
+  client,
+  multiply,
+  request,
+  type,
+}: Parameters<ChainEstimateFeesPerGasFn>[0]): ReturnType<ChainEstimateFeesPerGasFn> {
+  try {
+    const response = await estimateGas(client, {
+      ...request,
+      account: request?.account!,
+    })
+    const { priorityFeePerGas: maxPriorityFeePerGas } = response
+
+    const baseFeePerGas = multiply(BigInt(response.baseFeePerGas))
+    const maxFeePerGas = baseFeePerGas + maxPriorityFeePerGas
+
+    if (type === 'legacy') return { gasPrice: maxFeePerGas }
+    return {
+      maxFeePerGas,
+      maxPriorityFeePerGas,
+    }
+  } catch {
+    // Returning `null` will trigger the base `estimateFeesPerGas` to perform
+    // fallback mechanisms to estimate fees.
+    return null
+  }
+}

package/linea/chains.ts

@@ -0,0 +1,3 @@
+// biome-ignore lint/performance/noBarrelFile: entrypoint module
+export { linea } from '../chains/definitions/linea.js'
+export { lineaSepolia } from '../chains/definitions/lineaSepolia.js'

package/linea/index.ts

@@ -0,0 +1,8 @@
+// biome-ignore lint/performance/noBarrelFile: entrypoint module
+export {
+  estimateGas,
+  type EstimateGasParameters,
+  type EstimateGasReturnType,
+} from './actions/estimateGas.js'
+
+export { linea, lineaSepolia } from './chains.js'

package/linea/package.json

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

package/linea/types/rpc.ts

@@ -0,0 +1,28 @@
+import type { BlockNumber, BlockTag } from '../../types/block.js'
+import type { Hex } from '../../types/misc.js'
+import type {
+  RpcStateOverride,
+  RpcTransactionRequest,
+} from '../../types/rpc.js'
+
+export type LineaRpcSchema = [
+  {
+    Method: 'linea_estimateGas'
+    Parameters?:
+      | [transaction: RpcTransactionRequest]
+      | [
+          transaction: RpcTransactionRequest,
+          block: Hex | BlockNumber | BlockTag,
+        ]
+      | [
+          transaction: RpcTransactionRequest,
+          block: BlockNumber | BlockTag,
+          stateOverride: RpcStateOverride,
+        ]
+    ReturnType: {
+      gasLimit: Hex
+      baseFeePerGas: Hex
+      priorityFeePerGas: Hex
+    }
+  },
+]

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.20.1",
+  "version": "2.21.1",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -69,6 +69,11 @@
       "import": "./_esm/experimental/erc7739/index.js",
       "default": "./_cjs/experimental/erc7739/index.js"
     },
+    "./linea": {
+      "types": "./_types/linea/index.d.ts",
+      "import": "./_esm/linea/index.js",
+      "default": "./_cjs/linea/index.js"
+    },
     "./node": {
       "types": "./_types/node/index.d.ts",
       "import": "./_esm/node/index.js",