@exodus/ethereum-api 8.22.5 → 8.23.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-api",
-  "version": "8.22.5",
+  "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",
@@ -64,5 +64,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "2a5e9f37cb3694f7fc17f8760c69cbccda13e462"
+  "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),
+  }
+}