feat: linea (#2665)

* chore: update snapshots

* feat: Add support for linea_estimateGas

* fix: fix returns

* fix: lineaEstimateGas refactoring

* chore: tweaks

* chore: lint

---------

Co-authored-by: wantedsystem <amine.harty@consensys.net>

.changeset/slimy-melons-bathe.md

@@ -0,0 +1,5 @@
+---
+"viem": minor
+---
+
+Added built-in support for Linea gas & fee estimations.

.changeset/wise-planets-press.md

@@ -0,0 +1,5 @@
+---
+"viem": minor
+---
+
+Deprecated `chain.fees.defaultPriorityFee`, use `chain.fees.maxPriorityFeePerGas` instead.

src/actions/public/estimateFeesPerGas.ts

@@ -7,6 +7,7 @@ import {
   type Eip1559FeesNotSupportedErrorType,
 } from '../../errors/fee.js'
 import type { ErrorType } from '../../errors/utils.js'
+import type { Account } from '../../types/account.js'
 import type { Block } from '../../types/block.js'
 import type {
   Chain,
@@ -99,7 +100,7 @@ export async function internal_estimateFeesPerGas<
   client: Client<Transport, chain>,
   args: EstimateFeesPerGasParameters<chain, chainOverride, type> & {
     block?: Block | undefined
-    request?: PrepareTransactionRequestParameters | undefined
+    request?: PrepareTransactionRequestParameters<Chain, Account> | undefined
   },
 ): Promise<EstimateFeesPerGasReturnType<type>> {
   const {

src/actions/public/estimateMaxPriorityFeePerGas.test.ts

@@ -31,7 +31,7 @@ test('fallback', async () => {
   expect(await estimateMaxPriorityFeePerGas(client_1)).toBeDefined()
 })
 
-test('args: chain `defaultPriorityFee` override', async () => {
+test('args: chain `priorityFee` override', async () => {
   // value
   const client_1 = createPublicClient({
     transport: http(anvilMainnet.rpcUrl.http),
@@ -41,7 +41,7 @@ test('args: chain `defaultPriorityFee` override', async () => {
       chain: {
         ...anvilMainnet.chain,
         fees: {
-          defaultPriorityFee: 69420n,
+          maxPriorityFeePerGas: 69420n,
         },
       },
     }),
@@ -56,7 +56,7 @@ test('args: chain `defaultPriorityFee` override', async () => {
       chain: {
         ...anvilMainnet.chain,
         fees: {
-          defaultPriorityFee: () => 69420n,
+          maxPriorityFeePerGas: () => 69420n,
         },
       },
     }),
@@ -71,7 +71,7 @@ test('args: chain `defaultPriorityFee` override', async () => {
       chain: {
         ...anvilMainnet.chain,
         fees: {
-          defaultPriorityFee: async () => 69420n,
+          maxPriorityFeePerGas: async () => 69420n,
         },
       },
     }),
@@ -86,7 +86,7 @@ test('args: chain `defaultPriorityFee` override', async () => {
       chain: {
         ...anvilMainnet.chain,
         fees: {
-          defaultPriorityFee: 0n,
+          maxPriorityFeePerGas: 0n,
         },
       },
     }),
@@ -101,20 +101,50 @@ test('args: chain `defaultPriorityFee` override', async () => {
       chain: {
         ...anvilMainnet.chain,
         fees: {
-          defaultPriorityFee: async () => 0n,
+          maxPriorityFeePerGas: async () => 0n,
         },
       },
     }),
   ).toBe(0n)
+
+  // fallback
+  const client_6 = createPublicClient({
+    transport: http(anvilMainnet.rpcUrl.http),
+  })
+  expect(
+    await estimateMaxPriorityFeePerGas(client_6, {
+      chain: {
+        ...anvilMainnet.chain,
+        fees: {
+          maxPriorityFeePerGas: async () => null,
+        },
+      },
+    }),
+  ).toBeDefined()
+
+  // deprecated `defaultPriorityFee`
+  const client_7 = createPublicClient({
+    transport: http(anvilMainnet.rpcUrl.http),
+  })
+  expect(
+    await estimateMaxPriorityFeePerGas(client_7, {
+      chain: {
+        ...anvilMainnet.chain,
+        fees: {
+          defaultPriorityFee: async () => 69420n,
+        },
+      },
+    }),
+  ).toBe(69420n)
 })
 
-test('client: chain `defaultPriorityFee` override', async () => {
+test('client: chain `priorityFee` override', async () => {
   // value
   const client_1 = createPublicClient({
     chain: {
       ...anvilMainnet.chain,
       fees: {
-        defaultPriorityFee: 69420n,
+        maxPriorityFeePerGas: 69420n,
       },
     },
     transport: http(),
@@ -126,7 +156,7 @@ test('client: chain `defaultPriorityFee` override', async () => {
     chain: {
       ...anvilMainnet.chain,
       fees: {
-        defaultPriorityFee: () => 69420n,
+        maxPriorityFeePerGas: () => 69420n,
       },
     },
     transport: http(),
@@ -138,7 +168,7 @@ test('client: chain `defaultPriorityFee` override', async () => {
     chain: {
       ...anvilMainnet.chain,
       fees: {
-        defaultPriorityFee: async () => 69420n,
+        maxPriorityFeePerGas: async () => 69420n,
       },
     },
     transport: http(),
@@ -150,7 +180,7 @@ test('client: chain `defaultPriorityFee` override', async () => {
     chain: {
       ...anvilMainnet.chain,
       fees: {
-        defaultPriorityFee: 0n,
+        maxPriorityFeePerGas: 0n,
       },
     },
     transport: http(),
@@ -162,7 +192,7 @@ test('client: chain `defaultPriorityFee` override', async () => {
     chain: {
       ...anvilMainnet.chain,
       fees: {
-        defaultPriorityFee: async () => 0n,
+        maxPriorityFeePerGas: async () => 0n,
       },
     },
     transport: http(),

src/actions/public/estimateMaxPriorityFeePerGas.ts

@@ -86,19 +86,25 @@ export async function internal_estimateMaxPriorityFeePerGas<
   },
 ): Promise<EstimateMaxPriorityFeePerGasReturnType> {
   const { block: block_, chain = client.chain, request } = args || {}
-  if (typeof chain?.fees?.defaultPriorityFee === 'function') {
-    const block = block_ || (await getAction(client, getBlock, 'getBlock')({}))
-    return chain.fees.defaultPriorityFee({
-      block,
-      client,
-      request,
-    } as ChainFeesFnParameters)
-  }
-
-  if (typeof chain?.fees?.defaultPriorityFee !== 'undefined')
-    return chain?.fees?.defaultPriorityFee
 
   try {
+    const maxPriorityFeePerGas =
+      chain?.fees?.maxPriorityFeePerGas ?? chain?.fees?.defaultPriorityFee
+
+    if (typeof maxPriorityFeePerGas === 'function') {
+      const block =
+        block_ || (await getAction(client, getBlock, 'getBlock')({}))
+      const maxPriorityFeePerGas_ = await maxPriorityFeePerGas({
+        block,
+        client,
+        request,
+      } as ChainFeesFnParameters)
+      if (maxPriorityFeePerGas_ === null) throw new Error()
+      return maxPriorityFeePerGas_
+    }
+
+    if (typeof maxPriorityFeePerGas !== 'undefined') return maxPriorityFeePerGas
+
     const maxPriorityFeePerGasHex = await client.request({
       method: 'eth_maxPriorityFeePerGas',
     })

src/actions/public/getTransactionReceipt.test.ts

@@ -364,7 +364,7 @@ test('chain w/ custom block type', async () => {
           "transactionLogIndex": 10,
         },
       ],
-      "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
+      "logsBloom": "0x10880004000400000000000000000000000040000000020000000000000400120000000000100000000080000001000000000000000000000000000000804000004000101002040000000008000000200000000000000000001000000000080000840000020000000000100000000800000000020100000000000010000000000000000400000000000004000040000000000000280000000000002000000000000000004000120000000200000000000000000000000000000000200000800000001002008008000000000000000000000000200000800000000000000020001800000000000000000000001000000000000000000000000000000000000000",
       "root": "0xc621ee95e2d4ab65ecf499805dba770b20297c64029816b18c618fc49fe3d748",
       "status": "success",
       "to": "0x54de43b6ba21a5553697a2b78338e046dd7e0278",

src/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 },

src/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 },

src/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(
       [

src/linea/actions/estimateGas.test.ts

@@ -0,0 +1,56 @@
+import { expect, test } from 'vitest'
+
+import { accounts } from '../../../test/src/constants.js'
+import { createClient } from '../../clients/createClient.js'
+import { http } from '../../clients/transports/http.js'
+import { parseEther } from '../../utils/unit/parseEther.js'
+import { lineaSepolia } from '../chains.js'
+import { estimateGas } from './estimateGas.js'
+
+const client = createClient({
+  chain: lineaSepolia,
+  transport: http(),
+})
+
+test('default', async () => {
+  const { baseFeePerGas, gasLimit, priorityFeePerGas } = await estimateGas(
+    client,
+    {
+      account: '0x0000000000000000000000000000000000000000',
+      to: '0x0000000000000000000000000000000000000000',
+      value: parseEther('0.0001'),
+    },
+  )
+  expect(baseFeePerGas).toBeGreaterThan(0n)
+  expect(gasLimit).toBe(21000n)
+  expect(priorityFeePerGas).toBeGreaterThan(0n)
+})
+
+test('error: insufficient balance', async () => {
+  await expect(() =>
+    estimateGas(client, {
+      account: accounts[0].address,
+      to: '0x0000000000000000000000000000000000000000',
+      value: parseEther('0.0001'),
+    }),
+  ).rejects.toThrowErrorMatchingInlineSnapshot(`
+    [CallExecutionError: The total cost (gas * gas fee + value) of executing this transaction exceeds the balance of the account.
+
+    This error could arise when the account does not have enough funds to:
+     - pay for the total gas fee,
+     - pay for the value to send.
+     
+    The cost of the transaction is calculated as \`gas * gas fee + value\`, where:
+     - \`gas\` is the amount of gas needed for transaction to execute,
+     - \`gas fee\` is the gas fee,
+     - \`value\` is the amount of ether to send to the recipient.
+     
+    Raw Call Arguments:
+      from:   0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
+      to:     0x0000000000000000000000000000000000000000
+      value:  0.0001 ETH
+
+    Details: transaction up-front cost 0x5af31cfe9880 exceeds transaction sender account balance 0x0
+    Version: viem@x.y.z]
+  `)
+})