@exodus/ethereum-api 8.28.0 → 8.29.0

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.29.0](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.28.1...@exodus/ethereum-api@8.29.0) (2025-02-06)
+
+
+### Features
+
+
+* feat: improve (max)gasPrice resolution using baseFeePerGas (#4984)
+
+
+
+## [8.28.1](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.28.0...@exodus/ethereum-api@8.28.1) (2025-02-03)
+
+
+### Bug Fixes
+
+
+* fix: add ETH stakeable property (#4917)
+
+* fix: add optional chaining to tx references (#4948)
+
+* fix: ETH activity txs field (#4915)
+
+
+
 ## [8.28.0](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.27.0...@exodus/ethereum-api@8.28.0) (2025-01-23)
 
 

package/README.md

@@ -8,12 +8,12 @@ This section explains how fees currently work in Exodus and provides guidance on
 
 ### Gas Price
 
-Excluding custom fees, the result `gasPrice * gasPriceMultiplier` is used to resolve the transaction's gas price (legacy) and max gas price (EIP-1559).
+Excluding custom fees, `feeData.gasPrice` is used to resolve the transaction's gas price (legacy) and max gas price (EIP-1559).
 
 The `gasPrice` value is, in preference order, loaded from:
 
 1. Remote config
-2. The node via the fee data monitor
+2. The node via the fee data monitor and web socket. `gasPrice = baseFeePerGas * gasPriceMultipler + tipGasPrice`
 3. The default configuration.
 
 Using remote config is never recommended, as manually updating this value won't keep up with network activity.
@@ -26,7 +26,7 @@ To tune the fee resolution, we can:
 - Set a `min` value via remote config. Gas price will never be lower than this value.
 - Set a `max` value via remote config. Gas price will never be higher than this value.
 
-If the `gasPrice` returned by the node is not accurate or lower than the network's, the transaction may get stuck in pending status or may not be broadcast to the blockchain.
+If the resolved `gasPrice` is not accurate or lower than the network's, the transaction may get stuck in pending status or may not be broadcast to the blockchain.
 
 This is an undesirable situation:
 
@@ -42,9 +42,7 @@ The base gas price (or base fee) is the minimum amount of gas required to be pai
 
 It can be found in `feeData.baseFeePerGas`. The fee monitor keeps it up to date by monitoring the latest block's information. It could be tuned by remote config, but this is not recommended.
 
-The `feeData.baseFeePerGas` is only used when showing an "estimated fee" in the UI and not when sending a transaction.
-
-One possible improvement is to define the max gas price based on the base gas price rather than the network's current gas price.
+The `feeData.baseFeePerGas` is used when showing an "estimated fee" in the UI and to calculate the max gas price. `gasPrice = baseFeePerGas * gasPriceMultipler + tipGasPrice`
 
 ### Gas Limit
 
@@ -71,16 +69,18 @@ The L2 extra fee needs to be considered when showing the fee to the user, resolv
 
 Custom fees allow users to set a custom `gasPrice`. The wallet allows a range, as follows:
 
-- `recommended: gasPrice * gasPriceMultiplier`
-- `min: gasPrice * gasPriceMultiplier * gasPriceMinimumRate`
-- `max: gasPrice * gasPriceMultiplier * gasPriceMaximumRate`
+Note: `gasPrice = baseFeePerGas * gasPriceMultipler + tipGasPrice`
+
+- `recommended: gasPrice`
+- `min: gasPrice * gasPriceMinimumRate`
+- `max: gasPrice * gasPriceMaximumRate`
 
 If the user picks the recommended value, the custom fee is not set, leaving the default fee behavior.
 Custom fees can be disabled by setting `rbfEnabled: false` via remote config. Currently, only Ethereum allows custom fees. Other EVMs could be included in the future.
 
 The wallet allows acceleration when custom fees are allowed (and vice versa).
 
-If the user picks a different custom fee in that range, the fee is calculated as `customFee * gasLimit`. `gasPriceMultiplier` is not applied to the custom gas price.
+If the user picks a different custom fee in that range, the fee is calculated as `customFee * gasLimit`.
 
 A transaction created with a low custom fee may be stuck for a while, blocking future transactions, and it may create issues with the nonce, as explained above.
 
@@ -88,16 +88,18 @@ Min and max values can be tuned by changing `gasPriceMinimumRate` and `gasPriceM
 
 ### TX formulas
 
+Note: `gasPrice = baseFeePerGas * gasPriceMultipler + tipGasPrice`
+
 Table shows how the txs are create for both legacy and 1559 logic for major use case:
 
-|                    | Send some main                | Send all main                 | Send token/contract call      | Send main with custom fee | Send token/contract with custom fee | Accelerate                                                   |
-| ------------------ | ----------------------------- | ----------------------------- | ----------------------------- | ------------------------- | ----------------------------------- | ------------------------------------------------------------ |
-| Legacy Gas Price   | gasPrice \* gasPriceMultipler | gasPrice \* gasPriceMultipler | gasPrice \* gasPriceMultipler | customFee                 | customFee                           | max(current gasPrice,original tx gasPrice) \* BUMP_RATE 1.2  |
-| Legacy Gas Limit   | 21000                         | 21000                         | estimated + 20% extra         | 21000                     | estimated + 20% extra               | original tx gasLimit                                         |
-| -                  | -                             | -                             | -                             | -                         | -                                   | -                                                            |
-| 1559 Max gas Price | gasPrice \* gasPriceMultipler | gasPrice \* gasPriceMultipler | gasPrice \* gasPriceMultipler | customFee                 | customFee                           | max(current gasPrice, original tx gasPrice) \* BUMP_RATE 1.2 |
-| 1559 Tip gas Price | tipGasPrice                   | gasPrice \* gasPriceMultipler | tipGasPrice                   | customFee                 | tipGasPrice                         | orginal tx tipGasPrice \* BUMP_RATE 1.2                      |
-| 1559 Gas Limit     | 21000                         | 21000                         | estimated + 20% extra         | 21000                     | estimated + 20% extra               | original tx gasLimit                                         |
+|                    | Send some main | Send all main | Send token/contract call | Send main with custom fee | Send token/contract with custom fee | Accelerate                                                   |
+| ------------------ | -------------- | ------------- | ------------------------ | ------------------------- | ----------------------------------- | ------------------------------------------------------------ |
+| Legacy Gas Price   | gasPrice       | gasPrice      | gasPrice                 | customFee                 | customFee                           | max(current gasPrice,original tx gasPrice) \* BUMP_RATE 1.2  |
+| Legacy Gas Limit   | 21000          | 21000         | estimated + 20% extra    | 21000                     | estimated + 20% extra               | original tx gasLimit                                         |
+| -                  | -              | -             | -                        | -                         | -                                   | -                                                            |
+| 1559 Max gas Price | gasPrice       | gasPrice      | gasPrice                 | customFee                 | customFee                           | max(current gasPrice, original tx gasPrice) \* BUMP_RATE 1.2 |
+| 1559 Tip gas Price | tipGasPrice    | gasPrice      | tipGasPrice              | customFee                 | tipGasPrice                         | orginal tx tipGasPrice \* BUMP_RATE 1.2                      |
+| 1559 Gas Limit     | 21000          | 21000         | estimated + 20% extra    | 21000                     | estimated + 20% extra               | original tx gasLimit                                         |
 
 ### Fee Data Example
 
@@ -106,7 +108,8 @@ This is the default fee data configuration for Ethereum. Other EVMs have differe
 All these values can be tuned via remote config, although it may not be recommended as they are also tuned by the fee monitors:
 
 - **`baseFeePerGas`:** `50 Gwei` – Reference value for the base gas price. It is quickly updated by the fee monitor.
-- **`gasPrice`:** `75 Gwei` – Reference value for the network gas price. It is quickly updated by the fee monitor.
+- **`gasPrice`:** `77 Gwei` – `baseFeePerGas * gasPriceMultipler + tipGasPrice`
+- **`severGasPrice`:** `75 Gwei` – Reference value for the network gas price. It is quickly updated by the fee monitor.
 - **`tipGasPrice`:** `2 Gwei` – Controls the `maxPriorityFeePerGas` for all transactions when EIP-1559 is enabled.
 - **`eip1559Enabled`:** `true` – Enables or disables EIP-1559. A value of `false` means legacy fees and transactions.
 - **`rbfEnabled`:** `true` – Enables custom fees and acceleration. Currently, this is only available for Ethereum but can be expanded to other EVMs.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-api",
-  "version": "8.28.0",
+  "version": "8.29.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",
@@ -64,5 +64,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "1f116146a725da6f3c98abdf233261512a6333fc"
+  "gitHead": "45145f8d82dcee20192872aae962f9c1e1bfc487"
 }

package/src/create-asset.js

@@ -143,9 +143,9 @@ export const createAssetFactory = ({
       (isWebSocket ? null : DEFAULT_FEE_MONITOR_INTERVAL) // null means do not start the timer
 
     const createFeeMonitor = serverBasedFeeMonitorFactoryFactory({
-      assetName: base.name,
+      asset: base,
       interval: resolvedFeeMonitorInterval,
-      eip1559Enabled: feeData.eip1559Enabled, // this is not updated via remote config. Should it be?
+      aci: assetClientInterface,
       server,
     })
 

package/src/custom-fees.js

@@ -4,18 +4,18 @@ export const createCustomFeesApi = ({ baseAsset }) => {
   const Gwei = baseAsset.currency.units.Gwei
   return {
     getRecommendedMinMaxFeeUnitPrices: ({ feeData }) => {
-      const { gasPrice, gasPriceMultiplier, gasPriceMinimumRate, gasPriceMaximumRate } = feeData
+      const { gasPrice, gasPriceMinimumRate, gasPriceMaximumRate } = feeData
 
       const calculateFeeUnitPrice = (
         feeUnitPrice,
         multiplier = 1,
         toAdd = baseAsset.currency.ZERO
-      ) => feeUnitPrice.to('Gwei').mul(multiplier).add(toAdd).toNumber(Gwei)
+      ) => feeUnitPrice.mul(multiplier).add(toAdd).toNumber(Gwei)
 
       return {
-        recommended: calculateFeeUnitPrice(gasPrice, gasPriceMultiplier),
-        min: calculateFeeUnitPrice(gasPrice, gasPriceMinimumRate * gasPriceMultiplier),
-        max: calculateFeeUnitPrice(gasPrice, gasPriceMaximumRate * gasPriceMultiplier),
+        recommended: calculateFeeUnitPrice(gasPrice),
+        min: calculateFeeUnitPrice(gasPrice, gasPriceMinimumRate),
+        max: calculateFeeUnitPrice(gasPrice, gasPriceMaximumRate),
       }
     },
     unit: 'gwei/gas',

package/src/fee-monitor-utils.js

@@ -0,0 +1,38 @@
+import assert from 'minimalistic-assert'
+
+export const resolveGasPrices = ({
+  asset,
+  feeData,
+  gasPrice: gasPriceString,
+  baseFeePerGas: baseFeePerGasString,
+}) => {
+  assert(asset, 'asset is required')
+  assert(feeData, 'feeData is required')
+  assert(gasPriceString, 'gasPrice is required')
+
+  const zero = asset.currency.ZERO
+  const eip1559Enabled = feeData.eip1559Enabled
+  const gasPrice = asset.currency.parse(gasPriceString)
+
+  if (eip1559Enabled) {
+    assert(baseFeePerGasString, 'baseFeePerGasString is required')
+    const baseFeePerGas = asset.currency.parse(baseFeePerGasString)
+
+    const tipGasPrice = feeData.tipGasPrice ?? zero
+
+    const resolvedGasPrice = baseFeePerGas.mul(feeData.gasPriceMultiplier || 1).add(tipGasPrice)
+
+    return {
+      serverGasPrice: gasPriceString, // for reference
+      gasPrice: resolvedGasPrice.toBaseString({ unit: true }),
+      baseFeePerGas: baseFeePerGasString,
+      tipGasPrice: tipGasPrice.toBaseString({ unit: true }),
+    }
+  }
+
+  const resolvedGasPrice = gasPrice.mul(feeData.gasPriceMultiplier || 1)
+  return {
+    serverGasPrice: gasPriceString, // for reference
+    gasPrice: resolvedGasPrice.toBaseString({ unit: true }),
+  }
+}

package/src/get-balances.js

@@ -110,10 +110,13 @@ export const getBalancesFactory = ({ monitorType, config = Object.create(null) }
       total = spendable.add(staked).add(staking).add(unstaking).add(unstaked)
     }
 
+    const stakeable = spendable
+
     return {
       // new
       spendable,
       total,
+      stakeable,
       staked,
       staking,
       unstaking,

package/src/get-fee.js

@@ -34,9 +34,7 @@ export const getFeeFactory =
   }) => {
     const { gasPrice: feeDataGasPrice, eip1559Enabled, baseFeePerGas, tipGasPrice } = feeData
 
-    const gasPriceMultiplier = feeData.gasPriceMultiplier || 1
-
-    const gasPrice = customFee || feeDataGasPrice.mul(gasPriceMultiplier)
+    const gasPrice = customFee || feeDataGasPrice
 
     const gasLimit = providedGasLimit || asset.gasLimit || defaultGasLimit
 

package/src/server-based-fee-monitor.js

@@ -1,6 +1,7 @@
 import { FeeMonitor } from '@exodus/asset-lib'
 import assert from 'minimalistic-assert'
 
+import { resolveGasPrices } from './fee-monitor-utils.js'
 import { fromHexToString } from './number-utils.js'
 
 /**
@@ -12,39 +13,34 @@ import { fromHexToString } from './number-utils.js'
  *
  * const api = {
  *  ...
- *  createFeeMonitor: serverBasedFeeMonitorFactoryFactory({ interval: '50s', server, assetName: base.name }),
+ *  createFeeMonitor: serverBasedFeeMonitorFactoryFactory({ interval: '50s', server, asset, aci }),
  *  ...
  * }
  */
 
-export const serverBasedFeeMonitorFactoryFactory = ({
-  assetName,
-  interval,
-  eip1559Enabled,
-  server,
-}) => {
-  assert(assetName, 'assetName is required')
+export const serverBasedFeeMonitorFactoryFactory = ({ asset, interval, server, aci }) => {
+  assert(asset, 'asset is required')
   assert(server, 'server is required')
+  assert(aci, 'aci is required')
 
   const FeeMonitorClass = class ServerBaseEthereumFeeMonitor extends FeeMonitor {
     constructor({ updateFee }) {
       assert(updateFee, 'updateFee is required')
       super({
         updateFee,
-        assetName,
+        assetName: asset.name,
         interval,
       })
     }
 
     async fetchFee() {
-      const gasPrice = fromHexToString(await server.getGasPrice())
-
-      const baseFeePerGas = eip1559Enabled ? `${await server.getBaseFeePerGas()} wei` : undefined
-
-      return {
-        gasPrice: `${gasPrice} wei`,
-        baseFeePerGas,
-      }
+      const feeData = await aci.getFeeConfig({ assetName: asset.name })
+      const eip1559Enabled = feeData.eip1559Enabled
+      const [gasPrice, baseFeePerGas] = await Promise.all([
+        server.getGasPrice().then((wei) => `${fromHexToString(wei)} wei`),
+        eip1559Enabled ? server.getBaseFeePerGas().then((wei) => `${wei} wei`) : undefined,
+      ])
+      return resolveGasPrices({ asset, feeData, gasPrice, baseFeePerGas })
     }
   }
   return (...args) => new FeeMonitorClass(...args)

package/src/staking/matic/matic-staking-utils.js

@@ -15,10 +15,10 @@ export const isPolygonTx = ({ coinName }) => coinName === 'polygon'
 export const isPolygonDelegate = (tx) =>
   isPolygonTx(tx) && tx.to === STAKING_MANAGER_CONTRACT && tx.data?.methodId === DELEGATE
 export const isPolygonUndelegate = (tx) =>
-  isPolygonTx(tx) && tx.from[0] === STAKING_MANAGER_CONTRACT && tx.data?.methodId === UNDELEGATE
+  isPolygonTx(tx) && tx.from?.[0] === STAKING_MANAGER_CONTRACT && tx.data?.methodId === UNDELEGATE
 export const isPolygonReward = (tx) =>
-  isPolygonTx(tx) && tx.from[0] === STAKING_MANAGER_CONTRACT && tx.data?.methodId === CLAIM_REWARD
+  isPolygonTx(tx) && tx.from?.[0] === STAKING_MANAGER_CONTRACT && tx.data?.methodId === CLAIM_REWARD
 export const isPolygonClaimUndelegate = (tx) =>
   isPolygonTx(tx) &&
-  tx.from[0] === STAKING_MANAGER_CONTRACT &&
+  tx.from?.[0] === STAKING_MANAGER_CONTRACT &&
   tx.data?.methodId === CLAIM_UNDELEGATE_BALANCE

package/src/tx-log/clarity-monitor.js

@@ -2,6 +2,7 @@ import { BaseMonitor } from '@exodus/asset-lib'
 import { getAssetAddresses, isRpcBalanceAsset } from '@exodus/ethereum-lib'
 import lodash from 'lodash'
 
+import { resolveGasPrices } from '../fee-monitor-utils.js'
 import { fromHexToString } from '../number-utils.js'
 import { filterEffects, getLogItemsFromServerTx } from './clarity-utils/index.js'
 import {
@@ -264,14 +265,13 @@ export class ClarityMonitor extends BaseMonitor {
 
   async updateGasPrice({ gasPrice, baseFeePerGas }) {
     try {
-      const feeConfig = { gasPrice: `${fromHexToString(gasPrice).toString()} wei` }
-      if (baseFeePerGas) {
-        feeConfig.baseFeePerGas = `${fromHexToString(baseFeePerGas)} wei`
-      }
-
-      this.logger.debug(
-        `Update ${this.asset.name} gas price: ${feeConfig.gasPrice}, baseFeePerGas: ${feeConfig.baseFeePerGas}`
-      )
+      const feeData = await this.aci.getFeeConfig({ assetName: this.asset.name })
+      const feeConfig = resolveGasPrices({
+        asset: this.asset,
+        feeData,
+        gasPrice: `${fromHexToString(gasPrice)} wei`,
+        baseFeePerGas: baseFeePerGas ? `${fromHexToString(baseFeePerGas)} wei` : undefined,
+      })
       await this.aci.updateFeeConfig({ assetName: this.asset.name, feeConfig })
     } catch (e) {
       this.logger.warn('error updating gasPrice', e)

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

@@ -2,6 +2,7 @@ import { BaseMonitor } from '@exodus/asset-lib'
 import { getAssetAddresses, isRpcBalanceAsset } from '@exodus/ethereum-lib'
 import lodash from 'lodash'
 
+import { resolveGasPrices } from '../fee-monitor-utils.js'
 import { fromHexToString } from '../number-utils.js'
 import {
   checkPendingTransactions,
@@ -200,16 +201,13 @@ export class EthereumMonitor extends BaseMonitor {
 
   async updateGasPrice({ gasPrice, baseFeePerGas }) {
     try {
-      const feeConfig = {
-        gasPrice: `${parseInt(gasPrice, 16)} wei`,
-      }
-      if (baseFeePerGas) {
-        feeConfig.baseFeePerGas = `${parseInt(baseFeePerGas, 16)} wei`
-      }
-
-      this.logger.debug(
-        `Update ${this.asset.name} gas price: ${feeConfig.gasPrice}, baseFeePerGas: ${feeConfig.baseFeePerGas}`
-      )
+      const feeData = await this.aci.getFeeConfig({ assetName: this.asset.name })
+      const feeConfig = resolveGasPrices({
+        asset: this.asset,
+        feeData,
+        gasPrice: `${fromHexToString(gasPrice)} wei`,
+        baseFeePerGas: baseFeePerGas ? `${fromHexToString(baseFeePerGas)} wei` : undefined,
+      })
       await this.aci.updateFeeConfig({ assetName: this.asset.name, feeConfig })
     } catch (e) {
       this.logger.warn('error updating gasPrice', e)

package/src/tx-log-staking-processor/utils.js

@@ -21,16 +21,16 @@ export const decodePolygonStakingTxInputAmount = (tx) => {
 
 export const calculateRewardsFromStakeTx = ({ tx, currency }) => {
   const stakedAmount = currency.baseUnit(decodePolygonStakingTxInputAmount(tx))
-  const { reward } = tx.data
+  const { rewards } = tx.data
   // stake tx might have rewards in it,
   // i.e: https://etherscan.io/tx/0x0a81d266109034a3a70c6f1b9601c105d8caebbd0de652a0619344f9559ae4fa
   // thus reward = txInputAmount(amount to stake) - tx.coinAmount
   // tx.coinAmount is already computed from monitor; incoming - outgoing ERC20 token txs
   const stakeTxContainsReward = !stakedAmount.equals(tx.coinAmount.abs())
 
-  if (reward) {
+  if (rewards) {
     // cache rewards
-    return currency.baseUnit(reward)
+    return currency.baseUnit(rewards)
   }
 
   if (stakeTxContainsReward) {