@exodus/ethereum-api 8.13.2 → 8.14.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.14.0](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.13.3...@exodus/ethereum-api@8.14.0) (2024-08-26)
+
+
+### Features
+
+* allow custom gasPriceEconomicalRate ([#3236](https://github.com/ExodusMovement/assets/issues/3236)) ([acdf78e](https://github.com/ExodusMovement/assets/commit/acdf78e20c9f93da2cafa0045f24e5ad4f2e0a5d))
+* forceGasLimitEstimation asset plugin param ([#3237](https://github.com/ExodusMovement/assets/issues/3237)) ([7da77dd](https://github.com/ExodusMovement/assets/commit/7da77dd8f09bddc752dc113b5ef875bf1ff5263c))
+
+
+
+## [8.13.3](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.13.2...@exodus/ethereum-api@8.13.3) (2024-08-13)
+
+
+### Bug Fixes
+
+* **ethereum-api:** enhance gasLimit default value ([#3140](https://github.com/ExodusMovement/assets/issues/3140)) ([4522a65](https://github.com/ExodusMovement/assets/commit/4522a6518afb617acb5ab82df9f8c4836fe95236))
+
+
+
 ## [8.13.2](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.13.1...@exodus/ethereum-api@8.13.2) (2024-08-12)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-api",
-  "version": "8.13.2",
+  "version": "8.14.0",
   "description": "Ethereum Api",
   "main": "src/index.js",
   "files": [
@@ -21,8 +21,8 @@
   },
   "dependencies": {
     "@exodus/asset": "^1.2.0",
-    "@exodus/asset-lib": "^4.2.0",
-    "@exodus/assets": "^9.1.1",
+    "@exodus/asset-lib": "^4.2.2",
+    "@exodus/assets": "^11.0.0",
     "@exodus/basic-utils": "^2.1.0",
     "@exodus/bip44-constants": "^195.0.0",
     "@exodus/crypto": "^1.0.0-rc.0",
@@ -65,5 +65,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "fc7420fbe8a8acf647ee9319de3eb2d3832b87f6"
+  "gitHead": "12dda1cbba91cbfeaeb0811570baa671b8557c2c"
 }

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

@@ -158,6 +158,7 @@ export const fromAddEthereumChainParameterToFactoryParams = (params) => {
       confirmationsNumber: 5,
       monitorType: 'no-history',
       isTestnet: params.isTestnet,
+      ...params.plugin, // extra plugin configuration
     },
     baseFeePerGas: params.baseFeePerGas,
     gasPrice: params.gasPrice,

package/src/create-asset.js

@@ -57,6 +57,7 @@ export const createAssetFactory = ({
   serverUrl,
   stakingConfiguration = {},
   useEip1191ChainIdChecksum = false,
+  forceGasLimitEstimation = false,
 }) => {
   assert(assetsList, 'assetsList is required')
   assert(feeData, 'feeData is required')
@@ -160,17 +161,28 @@ export const createAssetFactory = ({
       let monitor
       switch (monitorType) {
         case 'clarity':
-          monitor = new ClarityMonitor({ interval: ms(monitorInterval || '5m'), server, ...args })
+          monitor = new ClarityMonitor({
+            assetClientInterface,
+            interval: ms(monitorInterval || '5m'),
+            server,
+            ...args,
+          })
           break
         case 'no-history':
           monitor = new EthereumNoHistoryMonitor({
+            assetClientInterface,
             interval: ms(monitorInterval || '15s'),
             server,
             ...args,
           })
           break
         case 'magnifier':
-          monitor = new EthereumMonitor({ interval: ms(monitorInterval || '15s'), server, ...args })
+          monitor = new EthereumMonitor({
+            assetClientInterface,
+            interval: ms(monitorInterval || '15s'),
+            server,
+            ...args,
+          })
           break
         default:
           throw new Error(`Monitor type ${monitorType} of evm asset ${asset.name} is unknown`)
@@ -258,6 +270,7 @@ export const createAssetFactory = ({
       chainId,
       monitorType,
       estimateL1DataFee,
+      forceGasLimitEstimation,
       server,
       ...(erc20FuelBuffer && { erc20FuelBuffer }),
       ...(fuelThreshold && { fuelThreshold: asset.currency.defaultUnit(fuelThreshold) }),

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

@@ -1,9 +1,9 @@
 import {
-  // eslint-disable-next-line import/no-deprecated
+  // eslint-disable-next-line @exodus/import/no-deprecated
   DEFAULT_SERVER_URLS,
-  // eslint-disable-next-line import/no-deprecated
+  // eslint-disable-next-line @exodus/import/no-deprecated
   ETHEREUM_LIKE_ASSETS,
-  // eslint-disable-next-line import/no-deprecated
+  // eslint-disable-next-line @exodus/import/no-deprecated
   ETHEREUM_LIKE_MONITOR_TYPES,
 } from '@exodus/ethereum-lib'
 import assert from 'minimalistic-assert'
@@ -30,11 +30,11 @@ export function createEvmServer({ assetName, serverUrl, monitorType }) {
 
 // @Deprecated
 const serverMap = Object.fromEntries(
-  // eslint-disable-next-line import/no-deprecated
+  // eslint-disable-next-line @exodus/import/no-deprecated
   ETHEREUM_LIKE_ASSETS.map((assetName) => {
-    // eslint-disable-next-line import/no-deprecated
+    // eslint-disable-next-line @exodus/import/no-deprecated
     const monitorType = ETHEREUM_LIKE_MONITOR_TYPES[assetName]
-    // eslint-disable-next-line import/no-deprecated
+    // eslint-disable-next-line @exodus/import/no-deprecated
     const serverUrl = DEFAULT_SERVER_URLS[assetName]
     return [assetName, createEvmServer({ assetName, serverUrl, monitorType })]
   })

package/src/gas-estimation.js

@@ -74,8 +74,9 @@ export async function fetchGasLimit({
     toAddress = asset.contract.address
   } else if (
     !isContract &&
-    // hacky, convert this to a fetchGasLimit forceGasLimitEstimation plugin flag!
+    !asset.forceGasLimitEstimation &&
     ![
+      // back compatiblity until all plugins are updated. Then remove this array
       'ethereumarbone',
       'ethereumarbonesepolia',
       'ethereumarbnova',

package/src/get-fee.js

@@ -7,16 +7,19 @@ const taxes = {
 
 const getGasPriceMultiplier = ({ asset, feeData, isExchange, isSendAll, isRbfAllowed }) => {
   // exchanges quotes expire, do not risk having a stuck tx
-  if (isExchange) return 1
+
+  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 1
+  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 1
+  if (!isRbfAllowed || !feeData.rbfEnabled) return gasPriceMultiplier
 
-  return feeData.gasPriceEconomicalRate
+  return feeData.gasPriceEconomicalRate || gasPriceMultiplier
 }
 
 const getExtraFeeData = ({ asset, amount }) => {
@@ -39,7 +42,7 @@ export const getFeeFactory =
     asset,
     feeData,
     customFee,
-    gasLimit = defaultGasLimit,
+    gasLimit: providedGasLimit,
     isExchange,
     isSendAll,
     amount,
@@ -55,6 +58,8 @@ export const getFeeFactory =
       isSendAll,
     })
 
+    const gasLimit = providedGasLimit || asset.gasLimit || defaultGasLimit
+
     const extraFeeData = getExtraFeeData({ asset, amount })
     if (calculateEffectiveFee && eip1559Enabled) {
       const maxFeePerGas = customFee || gasPrice
@@ -65,7 +70,7 @@ export const getFeeFactory =
       return { fee: effectiveGasPrice.mul(gasLimit), extraFeeData }
     }
 
-    const fee = (customFee || gasPrice.mul(gasPriceMultiplier)).mul(gasLimit || asset.gasLimit)
+    const fee = (customFee || gasPrice.mul(gasPriceMultiplier)).mul(gasLimit)
     return { fee, extraFeeData }
   }
 

package/src/staking/matic/api.js

@@ -96,7 +96,7 @@ export class MaticStakingApi {
   /**
    * UnbondNonce is a counter stored in the contract that tracks each time a delegator unstakes
    * @param address delegator address
-   * @return current unbonded nonce
+   * @returns current unbonded nonce
    */
   getCurrentUnbondNonce = async (address) => {
     const unbondNonce = await this.callReadFunctionContract(