@exodus/ethereum-api 8.13.3 → 8.15.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.15.0](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.14.0...@exodus/ethereum-api@8.15.0) (2024-08-27)
+
+
+### Features
+
+* introduce Clarity V2 server  ([#2982](https://github.com/ExodusMovement/assets/issues/2982)) ([90ebbf0](https://github.com/ExodusMovement/assets/commit/90ebbf0b48c118c1aa50f1b8adb4c941c3344f1b))
+
+
+
+## [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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-api",
-  "version": "8.13.3",
+  "version": "8.15.0",
   "description": "Ethereum Api",
   "main": "src/index.js",
   "files": [
@@ -22,7 +22,7 @@
   "dependencies": {
     "@exodus/asset": "^1.2.0",
     "@exodus/asset-lib": "^4.2.2",
-    "@exodus/assets": "^9.1.1",
+    "@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": "71031eb3482dd28419a5b53df1ba83c45011095f"
+  "gitHead": "0ab4b1325214507e17398f71cfeb7e37c19c6c15"
 }

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

@@ -1,6 +1,6 @@
 import { connectAssetsList } from '@exodus/assets'
 import { pick } from '@exodus/basic-utils'
-import bip44Constants from '@exodus/bip44-constants/by-ticker'
+import bip44Constants from '@exodus/bip44-constants/by-ticker.js'
 import {
   createEthereumLikeAccountState,
   createGetKeyIdentifier as defaultCreateGetKeyIdentifier,
@@ -57,6 +57,7 @@ export const createAssetFactory = ({
   serverUrl,
   stakingConfiguration = {},
   useEip1191ChainIdChecksum = false,
+  forceGasLimitEstimation = false,
 }) => {
   assert(assetsList, 'assetsList is required')
   assert(feeData, 'feeData is required')
@@ -160,6 +161,7 @@ export const createAssetFactory = ({
       let monitor
       switch (monitorType) {
         case 'clarity':
+        case 'clarity-v2':
           monitor = new ClarityMonitor({
             assetClientInterface,
             interval: ms(monitorInterval || '5m'),
@@ -269,6 +271,7 @@ export const createAssetFactory = ({
       chainId,
       monitorType,
       estimateL1DataFee,
+      forceGasLimitEstimation,
       server,
       ...(erc20FuelBuffer && { erc20FuelBuffer }),
       ...(fuelThreshold && { fuelThreshold: asset.currency.defaultUnit(fuelThreshold) }),

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

@@ -0,0 +1,90 @@
+import { fetch } from '@exodus/fetch'
+import { retry } from '@exodus/simple-retry'
+
+import ClarityServer from './clarity'
+
+const getTextFromResponse = async (response) => {
+  try {
+    const responseBody = await response.text()
+    return responseBody.slice(0, 100)
+  } catch {
+    return ''
+  }
+}
+
+const fetchJson = async (url, fetchOptions) => {
+  const response = await fetch(url, fetchOptions)
+
+  if (!response.ok)
+    throw new Error(
+      `${url} returned ${response.status}: ${
+        response.statusText || 'Unknown Status Text'
+      }. Body: ${await getTextFromResponse(response)}`
+    )
+  return response.json()
+}
+
+async function fetchJsonRetry(url, fetchOptions) {
+  const waitTimes = ['3s']
+  const fetchWithRetry = retry(fetchJson, { delayTimesMs: waitTimes })
+  return fetchWithRetry(url, fetchOptions)
+}
+
+export default class ClarityServerV2 extends ClarityServer {
+  constructor({ baseAssetName, uri }) {
+    super({ baseAssetName, uri })
+    this.baseApiPath = this.uri + `/api/v2/${this.baseAssetName}`
+  }
+
+  async getAllTransactions({ address, cursor }) {
+    let { blockNumber } = this.#decodeCursor(cursor)
+    blockNumber = blockNumber.toString()
+
+    const transactions = []
+
+    while (true) {
+      const url = new URL(`${this.baseApiPath}/addresses/${address}/transactions`)
+      url.searchParams.set('cursor', blockNumber)
+      url.searchParams.set('withInput', 'true')
+
+      const { transactions: txs, cursor: nextBlockNumber } = await fetchJsonRetry(url)
+
+      if (txs.length === 0) {
+        // fetch until no more new transactions
+        blockNumber = nextBlockNumber
+        break
+      }
+
+      if (nextBlockNumber <= blockNumber) {
+        console.warn('Invalid cursor: next block number is not greater than current block number')
+      }
+
+      transactions.push(...txs)
+      blockNumber = nextBlockNumber
+    }
+
+    const newCursor = Buffer.alloc(8)
+    newCursor.writeBigUInt64LE(BigInt(blockNumber), 0)
+
+    return {
+      transactions: {
+        confirmed: transactions,
+        pending: [],
+      },
+      cursor: newCursor,
+    }
+  }
+
+  #decodeCursor(cursor) {
+    if (Buffer.isBuffer(cursor)) {
+      // New format: buffer containing only the block number
+      if (cursor.length === 8) return { blockNumber: cursor.readBigUInt64LE(0) }
+
+      // Old format: buffer with length 26
+      if (cursor.length === 26) return { blockNumber: cursor.readBigInt64LE(10) }
+    }
+
+    // Doesn't match any known format, return default
+    return { blockNumber: BigInt(0) }
+  }
+}

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'
@@ -11,6 +11,7 @@ import assert from 'minimalistic-assert'
 import { create } from './api'
 import ApiCoinNodesServer from './api-coin-nodes'
 import ClarityServer from './clarity'
+import ClarityServerV2 from './clarity-v2'
 
 export function createEvmServer({ assetName, serverUrl, monitorType }) {
   assert(assetName, 'assetName is required')
@@ -21,6 +22,8 @@ export function createEvmServer({ assetName, serverUrl, monitorType }) {
       return new ApiCoinNodesServer({ uri: serverUrl })
     case 'clarity':
       return new ClarityServer({ baseAssetName: assetName, uri: serverUrl })
+    case 'clarity-v2':
+      return new ClarityServerV2({ baseAssetName: assetName, uri: serverUrl })
     case 'magnifier':
       return create(serverUrl, assetName)
     default:
@@ -30,11 +33,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 }) => {

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(

package/src/websocket/index.js

@@ -1,21 +1,2 @@
-/**
- * This is a "light" version of @exodus/core resolution to select the native WebSocket on BE
- * It's a workaround until https://github.com/ExodusMovement/assets/pull/72 is merged.
- *
- * Based on https://github.com/ExodusMovement/fetch/blob/master/core.js , note that chooses native on Desktop
- */
-if (typeof process !== 'undefined' && (process.type === 'renderer' || process.type === 'worker')) {
-  // THIS IS FOR DESKTOP
-  if (process.env.EXODUS_DISABLE_WS) {
-    module.exports = globalThis.WebSocket
-  } else {
-    module.exports = require('ws')
-  }
-  // eslint-disable-next-line no-undef
-} else if (typeof WebSocket === 'undefined') {
-  // THIS IS FOR UNIT TESTING.
-  module.exports = require('ws')
-} else {
-  // THIS IS FOR BE
-  module.exports = globalThis.WebSocket
-}
+// Uses cjs to optimize out requiring / bundling ws
+export { default } from './websocket.cjs'

package/src/websocket/websocket.cjs

@@ -0,0 +1,21 @@
+/**
+ * This is a "light" version of @exodus/core resolution to select the native WebSocket on BE
+ * It's a workaround until https://github.com/ExodusMovement/assets/pull/72 is merged.
+ *
+ * Based on https://github.com/ExodusMovement/fetch/blob/master/core.js , note that chooses native on Desktop
+ */
+if (typeof process !== 'undefined' && (process.type === 'renderer' || process.type === 'worker')) {
+  // THIS IS FOR DESKTOP
+  if (process.env.EXODUS_DISABLE_WS) {
+    module.exports = globalThis.WebSocket
+  } else {
+    module.exports = require('ws')
+  }
+  // eslint-disable-next-line no-undef
+} else if (typeof WebSocket === 'undefined') {
+  // THIS IS FOR UNIT TESTING.
+  module.exports = require('ws')
+} else {
+  // THIS IS FOR BE
+  module.exports = globalThis.WebSocket
+}