@exodus/ethereum-api 8.22.4 → 8.23.0

package/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.23.0](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.22.5...@exodus/ethereum-api@8.23.0) (2024-12-09)
+
+
+### Features
+
+
+* feat: customFees api (#4653)
+
+
+
+## [8.22.5](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.22.4...@exodus/ethereum-api@8.22.5) (2024-12-09)
+
+
+### Bug Fixes
+
+
+* fix: remove gasPriceEconomicalRate (#4659)
+
+
+
 ## [8.22.4](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.22.3...@exodus/ethereum-api@8.22.4) (2024-12-09)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-api",
-  "version": "8.22.4",
+  "version": "8.23.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",
@@ -28,7 +28,7 @@
     "@exodus/bip44-constants": "^195.0.0",
     "@exodus/crypto": "^1.0.0-rc.13",
     "@exodus/currency": "^6.0.1",
-    "@exodus/ethereum-lib": "^5.4.0",
+    "@exodus/ethereum-lib": "^5.8.1",
     "@exodus/ethereum-meta": "^2.1.5",
     "@exodus/ethereumholesky-meta": "^2.0.0",
     "@exodus/ethereumjs": "^1.0.0",
@@ -64,5 +64,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "9271a07964a668a9903bd4268b893c83ca1118f9"
+  "gitHead": "4d505ee7d024c0ae961e2d95e6408b0b251a7d89"
 }

package/src/create-asset.js

@@ -22,6 +22,7 @@ import ms from 'ms'
 
 import { addressHasHistoryFactory } from './address-has-history.js'
 import { createTokenFactory } from './create-token-factory.js'
+import { createCustomFeesApi } from './custom-fees.js'
 import { createEvmServer } from './exodus-eth-server/index.js'
 import { createFeeData } from './fee-data-factory.js'
 import { createGetBalanceForAddress } from './get-balance-for-address.js'
@@ -62,6 +63,7 @@ export const createAssetFactory = ({
   stakingConfiguration = {},
   useEip1191ChainIdChecksum = false,
   forceGasLimitEstimation = false,
+  supportsCustomFees: defaultSupportsCustomFees = false,
 }) => {
   assert(assetsList, 'assetsList is required')
   assert(providedFeeData || feeDataConfig, 'feeData or feeDataConfig is required')
@@ -81,6 +83,7 @@ export const createAssetFactory = ({
   const defaultConfig = {
     allowMetaMaskCompat: false,
     supportsStaking: false,
+    supportsCustomFees: defaultSupportsCustomFees,
     nfts: defaultNfts,
     customTokens: defaultCustomTokens,
   }
@@ -93,7 +96,7 @@ export const createAssetFactory = ({
   ) => {
     const assets = connectAssetsList(assetsList)
 
-    const { allowMetaMaskCompat, supportsStaking, nfts, customTokens } = {
+    const { allowMetaMaskCompat, supportsStaking, nfts, customTokens, supportsCustomFees } = {
       ...defaultConfig,
       ...config,
     }
@@ -156,6 +159,7 @@ export const createAssetFactory = ({
       noHistory: monitorType === 'no-history',
       signWithSigner: true,
       signMessageWithSigner: true,
+      supportsCustomFees,
       ...(supportsStaking && { staking: {} }),
     }
 
@@ -246,6 +250,7 @@ export const createAssetFactory = ({
       createHistoryMonitor,
       createToken,
       createUnsignedTx,
+      customFees: createCustomFeesApi({ baseAsset: asset }),
       defaultAddressPath,
       features,
       getBalances,
@@ -263,7 +268,7 @@ export const createAssetFactory = ({
       getSupportedPurposes: () => [44],
       getTokens,
       hasFeature: (feature) => !!features[feature], // @deprecated use api.features instead
-      privateKeyEncodingDefinition: { encoding: 'hex', prefix: '0x' },
+      privateKeyEncodingDefinition: { encoding: 'hex' },
       sendTx,
       signTx: ({ unsignedTx, privateKey, signer }) =>
         signer

package/src/custom-fees.js

@@ -0,0 +1,26 @@
+import NumberUnit from '@exodus/currency'
+
+export const createCustomFeesApi = ({ baseAsset }) => {
+  const Gwei = baseAsset.currency.units.Gwei
+  return {
+    getRecommendedMinMaxFeeUnitPrices: ({ feeData }) => {
+      const { gasPrice, gasPriceMinimumRate, gasPriceMaximumRate } = feeData
+
+      const calculateFeeUnitPrice = (
+        feeUnitPrice,
+        multiplier = 1,
+        toAdd = baseAsset.currency.ZERO
+      ) => feeUnitPrice.to('Gwei').mul(multiplier).add(toAdd).toNumber(Gwei)
+
+      return {
+        recommended: calculateFeeUnitPrice(gasPrice),
+        min: calculateFeeUnitPrice(gasPrice, gasPriceMinimumRate),
+        max: calculateFeeUnitPrice(gasPrice, gasPriceMaximumRate),
+      }
+    },
+    unit: 'gwei/gas',
+    feeUnitPriceToNumber: (feeNumberUnit) => feeNumberUnit.toNumber(Gwei),
+    numberToFeeUnitPrice: (value) => new NumberUnit(value, Gwei),
+    isEnabled: ({ feeData }) => Boolean(feeData.rbfEnabled),
+  }
+}

package/src/fee-data-factory.js

@@ -5,7 +5,6 @@ const createFeeDataConfigDefaults = ({ currency, feeDataConfig }) => {
   const shared = {
     tipGasPrice: '0 Gwei',
     fuelThreshold: '0 Gwei',
-    gasPriceEconomicalRate: 0.8,
     gasPriceMinimumRate: 0.6,
     gasPriceMaximumRate: 1.3,
   }

package/src/get-fee.js

@@ -1,27 +1,10 @@
-import { calculateBumpedGasPrice, calculateExtraEth, isEthereumLike } from '@exodus/ethereum-lib'
+import { calculateBumpedGasPrice, calculateExtraEth } from '@exodus/ethereum-lib'
 
 // Move to meta?
 const taxes = {
   paxgold: 0.0002,
 }
 
-const getGasPriceMultiplier = ({ asset, feeData, isExchange, isSendAll, isRbfAllowed }) => {
-  // exchanges quotes expire, do not risk having a stuck tx
-
-  const gasPriceMultiplier = feeData.gasPriceMultiplier || 1
-
-  if (isExchange) return gasPriceMultiplier
-
-  // if eip1559 enabled, do not risk not leaving enough ETH to cover base fee (applies only for native asset)
-  // (gasPrice difference will be reimbursed anyway: users do not overpay)
-  if (isSendAll && isEthereumLike(asset) && feeData.eip1559Enabled) return gasPriceMultiplier
-
-  // do not risk having a stuck tx if we're not able to accelerate it
-  if (!isRbfAllowed || !feeData.rbfEnabled) return gasPriceMultiplier
-
-  return feeData.gasPriceEconomicalRate || gasPriceMultiplier
-}
-
 const getExtraFeeData = ({ asset, amount }) => {
   const tax = taxes[asset.name]
   if (!amount || !tax || amount.isZero) {
@@ -51,13 +34,7 @@ export const getFeeFactory =
   }) => {
     const { gasPrice: feeDataGasPrice, eip1559Enabled, baseFeePerGas, tipGasPrice } = feeData
 
-    const gasPriceMultiplier = getGasPriceMultiplier({
-      asset,
-      isRbfAllowed,
-      feeData,
-      isExchange,
-      isSendAll,
-    })
+    const gasPriceMultiplier = feeData.gasPriceMultiplier || 1
 
     const gasPrice = customFee || feeDataGasPrice.mul(gasPriceMultiplier)
 

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

@@ -14,7 +14,7 @@ const txSendFactory = ({ assetClientInterface, createUnsignedTx }) => {
   assert(createUnsignedTx, 'createUnsignedTx is required')
   return async ({ asset, walletAccount, address, amount, options = {} }) => {
     const { nft, bumpTxId, nonce: providedNonce, customFee, keepTxInput, isSendAll } = options
-    let { txInput, feeAmount } = options // avoid let!
+    let { txInput } = options // avoid let!
 
     const feeOpts = {
       gasPrice: options.gasPrice,
@@ -27,12 +27,6 @@ const txSendFactory = ({ assetClientInterface, createUnsignedTx }) => {
 
     const assets = await assetClientInterface.getAssetsForNetwork({ baseAssetName: baseAsset.name })
 
-    // Using a default zero value to not break code relying on the `tx.feeAmount` property.
-    // For example, some exchange providers don't supply this.
-    if (!feeAmount) {
-      feeAmount = asset.baseAsset.currency.ZERO
-    }
-
     const fromAddress = await assetClientInterface.getReceiveAddress({
       assetName: baseAsset.name,
       walletAccount,
@@ -95,7 +89,6 @@ const txSendFactory = ({ assetClientInterface, createUnsignedTx }) => {
       eip1559Enabled = feeData.eip1559Enabled && feeOpts.tipGasPrice
       bumpNonce = replacedTx.data.nonce
       txInput = replacedTokenTx ? null : replacedTx.data.data || '0x'
-      feeAmount = feeOpts.gasPrice.mul(feeOpts.gasLimit)
       if (bumpNonce === undefined) {
         throw new Error(`Cannot bump transaction ${bumpTxId}: data object seems to be corrupted`)
       }
@@ -121,7 +114,9 @@ const txSendFactory = ({ assetClientInterface, createUnsignedTx }) => {
       isSendAll,
       createUnsignedTx,
     }
-    let { txId, rawTx, nonce, gasLimit, tipGasPrice } = await createTx(createTxParams)
+    let { txId, rawTx, nonce, gasLimit, tipGasPrice, gasPrice } = await createTx(createTxParams)
+
+    const feeAmount = gasPrice.mul(gasLimit)
 
     try {
       await baseAsset.api.broadcastTx(rawTx.toString('hex'))