@exodus/ethereum-api 8.21.2 → 8.22.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.22.0](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.21.3...@exodus/ethereum-api@8.22.0) (2024-12-02)
+
+
+### Features
+
+
+* feat: gasPriceMaximumRate in evm fee data (#4578)
+
+
+
+## [8.21.3](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.21.2...@exodus/ethereum-api@8.21.3) (2024-11-27)
+
+
+### Bug Fixes
+
+
+* fix: handling JSON RPC responses in Clarity V2 (#4587)
+
+* fix: improve nonce calculation for EVMs and fix drop txs in no history (#4583)
+
+
+
 ## [8.21.2](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.21.1...@exodus/ethereum-api@8.21.2) (2024-11-15)
 
 **Note:** Version bump only for package @exodus/ethereum-api

package/README.md

@@ -0,0 +1,3 @@
+# @exodus/ethereum-api
+
+Transaction monitors, fee monitors, RPC with the blockchain node, and other networking code for Ethereum and EVM-based blockchains. See [Asset Packages](../../docs/asset-packages.md) for more detail on this package's role.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/ethereum-api",
-  "version": "8.21.2",
-  "description": "Ethereum Api",
+  "version": "8.22.0",
+  "description": "Transaction monitors, fee monitors, RPC with the blockchain node, and other networking code for Ethereum and EVM-based blockchains",
   "type": "module",
   "main": "src/index.js",
   "files": [
@@ -64,5 +64,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "95e353cbf4ee280916760a1196b72e74889e475d"
+  "gitHead": "9888fd7b7356fd52f0bf92e505071565c8fa19ce"
 }

package/src/create-asset-plugin-factory.js

@@ -1,6 +1,4 @@
 import { createMetaDef } from '@exodus/asset'
-import { FeeData } from '@exodus/asset-lib'
-import { UnitType } from '@exodus/currency'
 import assert from 'minimalistic-assert'
 
 import { createAssetFactory } from './create-asset.js'
@@ -27,8 +25,6 @@ export const createAssetPluginFactory = (config) => {
     [ticker]: decimals || 18,
   }
 
-  const currency = UnitType.create(units)
-
   // adds lots of validation in config
   const tokenOverrides = (token) => ({
     ...token,
@@ -43,7 +39,7 @@ export const createAssetPluginFactory = (config) => {
   }
 
   const assetType = 'ETHEREUM_LIKE'
-  const { asset, assetsList } = createMetaDef({
+  const { assetsList } = createMetaDef({
     assetParams: {
       ...meta,
       name,
@@ -56,61 +52,17 @@ export const createAssetPluginFactory = (config) => {
     tokensParams: meta.tokens || [],
     tokenOverrides,
   })
-
-  const resolveFeeDataConfigDefaults = () => {
-    const shared = {
-      tipGasPrice: '0 Gwei',
-      fuelThreshold: '0 Gwei',
-      gasPriceEconomicalRate: 0.8,
-      gasPriceMinimumRate: 0.6,
-    }
-
-    if (config.eip1559Enabled === true) {
-      assert(config.baseFeePerGas, 'baseFeePerGas is required')
-      const baseFeePerGas = currency.parse(config.baseFeePerGas)
-      const gasPrice = config.gasPrice ? currency.parse(config.gasPrice) : baseFeePerGas.mul(1.5)
-      return {
-        gasPrice: gasPrice.toBaseString({ unit: true }),
-        baseFeePerGas: baseFeePerGas.toBaseString({ unit: true }),
-        max: gasPrice.mul(5).toBaseString({ unit: true }),
-        min: gasPrice.div(5).toBaseString({ unit: true }),
-        eip1559Enabled: config.eip1559Enabled,
-        ...shared,
-        ...config.feeData,
-      }
-    }
-
-    if (config.eip1559Enabled === false) {
-      assert(config.gasPrice, 'gasPrice is required')
-      const gasPrice = currency.parse(config.gasPrice)
-      return {
-        gasPrice: gasPrice.toBaseString({ unit: true }),
-        max: gasPrice.mul(5).toBaseString({ unit: true }),
-        min: gasPrice.div(5).toBaseString({ unit: true }),
-        eip1559Enabled: config.eip1559Enabled,
-        ...shared,
-        ...config.feeData,
-      }
-    }
-
-    return {
-      gasPrice: '0.02 Gwei',
-      baseFeePerGas: '0.02 Gwei',
-      eip1559Enabled: true,
-      ...shared,
+  const feeDataConfig = Object.fromEntries(
+    Object.entries({
+      gasPrice: config.gasPrice,
+      baseFeePerGas: config.baseFeePerGas,
+      eip1559Enabled: config.eip1559Enabled,
       ...config.feeData,
-    }
-  }
-
-  const feeData = new FeeData({
-    config: resolveFeeDataConfigDefaults(),
-    mainKey: 'gasPrice',
-    currency: asset.currency,
-  })
-
+    }).filter(([_, value]) => value !== undefined)
+  )
   const createAsset = createAssetFactory({
     assetsList,
-    feeData,
+    feeDataConfig,
     ...config.plugin,
   })
 

package/src/create-asset.js

@@ -23,6 +23,7 @@ import ms from 'ms'
 import { addressHasHistoryFactory } from './address-has-history.js'
 import { createTokenFactory } from './create-token-factory.js'
 import { createEvmServer } from './exodus-eth-server/index.js'
+import { createFeeData } from './fee-data-factory.js'
 import { createGetBalanceForAddress } from './get-balance-for-address.js'
 import { getBalancesFactory } from './get-balances.js'
 import { getEffectiveGasPrice, getFeeFactory } from './get-fee.js'
@@ -47,7 +48,8 @@ export const createAssetFactory = ({
   customCreateGetKeyIdentifier,
   customTokens: defaultCustomTokens = true,
   erc20FuelBuffer,
-  feeData,
+  feeData: providedFeeData,
+  feeDataConfig,
   feeMonitorInterval,
   fuelThreshold,
   isMaxFeeAsset = false,
@@ -62,11 +64,13 @@ export const createAssetFactory = ({
   forceGasLimitEstimation = false,
 }) => {
   assert(assetsList, 'assetsList is required')
-  assert(feeData, 'feeData is required')
+  assert(providedFeeData || feeDataConfig, 'feeData or feeDataConfig is required')
   assert(serverUrl, 'serverUrl is required')
   assert(confirmationsNumber, 'confirmationsNumber is required')
 
   const base = assetsList.find((asset) => asset.name === asset.baseAssetName)
+
+  const feeData = providedFeeData || createFeeData({ currency: base.currency, feeDataConfig })
   assert(base, 'base is required')
 
   const chainId = base.chainId

package/src/exodus-eth-server/clarity-v2.js

@@ -108,7 +108,9 @@ export default class ClarityServerV2 extends ClarityServer {
       fetchOptions.body = JSON.stringify(body)
     }
 
-    return fetchJson(url, fetchOptions)
+    const response = await fetchJson(url, fetchOptions)
+
+    return this.handleJsonRPCResponse(response)
   }
 
   async sendRawTransaction(...params) {

package/src/exodus-eth-server/clarity.js

@@ -86,6 +86,18 @@ export default class ClarityServer extends EventEmitter {
     }
   }
 
+  // See https://www.jsonrpc.org/specification#response_object for details.
+  handleJsonRPCResponse(response) {
+    const result = response?.result
+    const error = response?.error
+    if (error || result === undefined) {
+      const message = error?.message || error?.code || 'no result'
+      throw new Error(`Bad rpc response: ${message}`)
+    }
+
+    return result
+  }
+
   async getAllTransactions(params) {
     const transactions = { pending: [], confirmed: [] }
     const cursor = await this.getTransactions({
@@ -176,14 +188,8 @@ export default class ClarityServer extends EventEmitter {
 
   async sendRequest(request) {
     const response = await this.sendRpcRequest(request)
-    const result = response?.result
-    const error = response?.error
-    if (error || result === undefined) {
-      const message = error?.message || error?.code || 'no result'
-      throw new Error(`Bad rpc response: ${message}`)
-    }
 
-    return result
+    return this.handleJsonRPCResponse(response)
   }
 
   async isContract(address) {

package/src/fee-data-factory.js

@@ -0,0 +1,56 @@
+import { FeeData } from '@exodus/asset-lib'
+import assert from 'minimalistic-assert'
+
+const createFeeDataConfigDefaults = ({ currency, feeDataConfig }) => {
+  const shared = {
+    tipGasPrice: '0 Gwei',
+    fuelThreshold: '0 Gwei',
+    gasPriceEconomicalRate: 0.8,
+    gasPriceMinimumRate: 0.6,
+    gasPriceMaximumRate: 1.3,
+  }
+
+  if (feeDataConfig.eip1559Enabled === true) {
+    assert(feeDataConfig.baseFeePerGas, 'baseFeePerGas is required')
+    const baseFeePerGas = currency.parse(feeDataConfig.baseFeePerGas)
+    const gasPrice = feeDataConfig.gasPrice
+      ? currency.parse(feeDataConfig.gasPrice)
+      : baseFeePerGas.mul(1.5)
+    return {
+      gasPrice: gasPrice.toBaseString({ unit: true }),
+      baseFeePerGas: baseFeePerGas.toBaseString({ unit: true }),
+      eip1559Enabled: feeDataConfig.eip1559Enabled,
+      ...shared,
+      ...feeDataConfig,
+    }
+  }
+
+  if (feeDataConfig.eip1559Enabled === false) {
+    assert(feeDataConfig.gasPrice, 'gasPrice is required')
+    const gasPrice = currency.parse(feeDataConfig.gasPrice)
+    return {
+      gasPrice: gasPrice.toBaseString({ unit: true }),
+      max: gasPrice.mul(5).toBaseString({ unit: true }),
+      min: gasPrice.div(5).toBaseString({ unit: true }),
+      eip1559Enabled: feeDataConfig.eip1559Enabled,
+      ...shared,
+      ...feeDataConfig,
+    }
+  }
+
+  return {
+    gasPrice: '0.02 Gwei',
+    baseFeePerGas: '0.02 Gwei',
+    eip1559Enabled: true,
+    ...shared,
+    ...feeDataConfig,
+  }
+}
+
+export const createFeeData = ({ currency, feeDataConfig }) => {
+  return new FeeData({
+    config: createFeeDataConfigDefaults({ currency, feeDataConfig }),
+    mainKey: 'gasPrice',
+    currency,
+  })
+}

package/src/tx-log/ethereum-no-history-monitor.js

@@ -137,12 +137,13 @@ export class EthereumNoHistoryMonitor extends BaseMonitor {
 
     for (const { tx, assetName } of pendingTransactions) {
       const txFromNode = pendingTxsFromNode[tx.txId]
-      if (now - tx.date.getTime() > UNCONFIRMED_TX_LIMIT && txFromNode?.blockHash == null) {
+      const isConfirmed = Boolean(txFromNode?.blockHash)
+      if (now - tx.date.getTime() > UNCONFIRMED_TX_LIMIT && !isConfirmed) {
         txsToRemove.push({
           tx,
           assetSource: { asset: assetName, walletAccount },
         })
-      } else if (txFromNode?.blockHash !== null) {
+      } else if (isConfirmed) {
         txsToUpdate.push({
           tx: { ...tx, confirmations: 1 },
           assetSource: { asset: assetName, walletAccount },

package/src/tx-send/nonce-utils.js

@@ -0,0 +1,18 @@
+import { getNonce } from '../eth-like-util.js'
+
+export const resolveNonce = async ({ asset, fromAddress, providedNonce, txLog, triedNonce }) => {
+  const nonceFromNode = asset.baseAsset?.api?.features?.noHistory
+    ? await getNonce({ asset: asset.baseAsset, address: fromAddress, tag: 'latest' }) // maybe 'pending' to unconfirmed txs
+    : 0
+
+  const nonceFromLog = [...txLog]
+    .filter((tx) => tx.sent && !tx.dropped && tx.data.nonce != null)
+    .reduce((nonce, tx) => Math.max(tx.data.nonce + 1, nonce), 0)
+
+  return Math.max(
+    nonceFromNode,
+    nonceFromLog,
+    providedNonce ?? 0,
+    triedNonce === undefined ? 0 : triedNonce + 1
+  )
+}

package/src/tx-send/tx-send.js

@@ -4,9 +4,10 @@ import { calculateBumpedGasPrice, isEthereumLikeToken, normalizeTxId } from '@ex
 import assert from 'minimalistic-assert'
 
 import * as ErrorWrapper from '../error-wrapper.js'
-import { getNonce, transactionExists } from '../eth-like-util.js'
+import { transactionExists } from '../eth-like-util.js'
 import { getNftArguments } from '../nft-utils.js'
 import getFeeInfo from './get-fee-info.js'
+import { resolveNonce } from './nonce-utils.js'
 
 const txSendFactory = ({ assetClientInterface, createUnsignedTx }) => {
   assert(assetClientInterface, 'assetClientInterface is required')
@@ -21,7 +22,7 @@ const txSendFactory = ({ assetClientInterface, createUnsignedTx }) => {
     shouldLog = true,
     keepTxInput,
     txInput,
-    nonce: _nonce,
+    nonce: providedNonce,
     bumpTxId,
     customFee,
     isSendAll,
@@ -56,17 +57,18 @@ const txSendFactory = ({ assetClientInterface, createUnsignedTx }) => {
       amount = asset.baseAsset.currency.ZERO
     }
 
-    let nonceParam = _nonce
+    let bumpNonce
 
     let eip1559Enabled = feeData.eip1559Enabled
 
+    const baseAssetTxLog = await assetClientInterface.getTxLog({
+      assetName: baseAsset.name,
+      walletAccount,
+    })
+
     // `replacedTx` is always an ETH/ETC transaction (not a token)
     let replacedTx, replacedTokenTx
     if (bumpTxId) {
-      const baseAssetTxLog = await assetClientInterface.getTxLog({
-        assetName: baseAsset.name,
-        walletAccount,
-      })
       replacedTx = baseAssetTxLog.get(bumpTxId)
       if (!replacedTx || !replacedTx.pending) {
         throw new Error(`Cannot bump transaction ${bumpTxId}: not found or confirmed`)
@@ -98,21 +100,25 @@ const txSendFactory = ({ assetClientInterface, createUnsignedTx }) => {
       feeOpts.gasPrice = bumpedGasPrice
       feeOpts.tipGasPrice = bumpedTipGasPrice
       eip1559Enabled = feeData.eip1559Enabled && feeOpts.tipGasPrice
-      nonceParam = replacedTx.data.nonce
+      bumpNonce = replacedTx.data.nonce
       txInput = replacedTokenTx ? null : replacedTx.data.data || '0x'
       feeAmount = feeOpts.gasPrice.mul(feeOpts.gasLimit)
-      if (nonceParam === undefined) {
+      if (bumpNonce === undefined) {
         throw new Error(`Cannot bump transaction ${bumpTxId}: data object seems to be corrupted`)
       }
     }
 
+    const resolvedNonce =
+      bumpNonce ??
+      (await resolveNonce({ asset, fromAddress, providedNonce, txLog: baseAssetTxLog }))
+
     const createTxParams = {
       assetClientInterface,
       asset,
       walletAccount,
       toAddress: contractAddress || address,
       amount,
-      nonce: nonceParam,
+      nonce: resolvedNonce,
       fromAddress,
       eip1559Enabled,
       customFee,
@@ -157,8 +163,13 @@ const txSendFactory = ({ assetClientInterface, createUnsignedTx }) => {
       } else if (nonceTooLowErr) {
         console.info('trying to send again...') // inject logger factory from platform
         // let's try to fix the nonce issue
-
-        nonce = await getNonce({ asset: baseAsset, address: fromAddress })
+        nonce = await resolveNonce({
+          asset,
+          fromAddress,
+          providedNonce,
+          txLog: baseAssetTxLog,
+          triedNonce: nonce,
+        })
         ;({ txId, rawTx } = await createTx({ ...createTxParams, nonce }))
 
         try {
@@ -247,7 +258,7 @@ const txSendFactory = ({ assetClientInterface, createUnsignedTx }) => {
       })
     }
 
-    return { txId }
+    return { txId, nonce }
   }
 }
 
@@ -268,6 +279,10 @@ const createTx = async ({
   feeOpts,
   createUnsignedTx,
 }) => {
+  assert(
+    nonce !== undefined && typeof nonce === 'number',
+    'Nonce must be provided when creating a tx'
+  )
   const isToken = isEthereumLikeToken(asset)
 
   if (txInput && isToken && !keepTxInput)
@@ -309,21 +324,6 @@ const createTx = async ({
     // gasLimit = customGasLimit
   }
 
-  if (asset.baseAsset?.api?.hasFeature?.('noHistory')) {
-    nonce = await getNonce({ asset: asset.baseAsset, address: fromAddress })
-  }
-
-  if (nonce === undefined) {
-    // Calculate latest nonce from base asset's TX log
-    const baseAssetTxLog = await assetClientInterface.getTxLog({
-      assetName: asset.baseAsset.name,
-      walletAccount,
-    })
-    nonce = [...baseAssetTxLog]
-      .filter((tx) => tx.sent && !tx.dropped && tx.data.nonce != null)
-      .reduce((nonce, tx) => Math.max(tx.data.nonce + 1, nonce), 0)
-  }
-
   const unsignedTx = await createUnsignedTx({
     asset,
     walletAccount,