@exodus/ethereum-api 8.8.0 → 8.9.1

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.9.1](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.9.0...@exodus/ethereum-api@8.9.1) (2024-07-03)
+
+**Note:** Version bump only for package @exodus/ethereum-api
+
+
+
+
+
+## [8.9.0](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.8.0...@exodus/ethereum-api@8.9.0) (2024-07-03)
+
+
+### Features
+
+* dynamic evm factory ([#2659](https://github.com/ExodusMovement/assets/issues/2659)) ([0baae82](https://github.com/ExodusMovement/assets/commit/0baae82a7f53c8808c9cd2621cf04e9960568cc6))
+
+
+### Bug Fixes
+
+* **ethereum:** false dropped tx check ([#2707](https://github.com/ExodusMovement/assets/issues/2707)) ([d05a8c8](https://github.com/ExodusMovement/assets/commit/d05a8c895563fb13120956c0081db7ebe86195d6))
+
+
+
 ## [8.8.0](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-api@8.7.1...@exodus/ethereum-api@8.8.0) (2024-07-02)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-api",
-  "version": "8.8.0",
+  "version": "8.9.1",
   "description": "Ethereum Api",
   "main": "src/index.js",
   "files": [
@@ -20,6 +20,7 @@
     "lint:fix": "yarn lint --fix"
   },
   "dependencies": {
+    "@exodus/asset": "^1.2.0",
     "@exodus/asset-lib": "^4.2.0",
     "@exodus/assets": "^9.1.1",
     "@exodus/basic-utils": "^2.1.0",
@@ -48,7 +49,6 @@
     "ws": "^6.1.0"
   },
   "devDependencies": {
-    "@exodus/assets": "^9.1.1",
     "@exodus/assets-testing": "^1.0.0",
     "@exodus/bsc-meta": "^1.2.2",
     "@exodus/ethereumarbone-meta": "^1.2.0",
@@ -66,5 +66,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "2429beb0c513a4e0da8de7e4c070f0774e5f62c4"
+  "gitHead": "d52d315260d32e7a2fce15e32e7393813a02bc90"
 }

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

@@ -0,0 +1,162 @@
+import { createMetaDef } from '@exodus/asset'
+import { FeeData } from '@exodus/asset-lib'
+import { createAssetFactory } from './create-asset'
+import assert from 'minimalistic-assert'
+import { UnitType } from '@exodus/currency'
+
+// Move to ethereum-api for config base evm
+export const createAssetPluginFactory = (config) => {
+  assert(config, 'config is required')
+  assert(config.chainId, 'chainId is required')
+  assert(config.meta, 'config.meta is required')
+  assert(config.meta.explorerUrl, 'meta.explorerUrl is required')
+
+  const chainId = config.chainId
+  const { explorerUrl, ...meta } = config.meta
+  const name = `evm_${chainId}`
+  const ticker = `EVM${chainId}`
+  const tokenType = `EVM_${chainId}_TOKEN`
+
+  const units = {
+    wei: 0,
+    Kwei: 3,
+    Mwei: 6,
+    Gwei: 9,
+    [ticker]: config.decimals || 18,
+  }
+
+  const currency = UnitType.create(units)
+
+  // adds lots of validation in config
+  const tokenOverrides = (token) => ({
+    ...token,
+    assetType: tokenType,
+    contract: token.addresses,
+    gasLimit: meta.gasLimit || 120e3,
+  })
+
+  const blockExplorer = {
+    addressUrl: (address) => `${explorerUrl}/address/${encodeURIComponent(address)}`,
+    txUrl: (txId) => `${explorerUrl}/tx/${encodeURIComponent(txId)}`,
+  }
+
+  const assetType = 'ETHEREUM_LIKE'
+  const { asset, assetsList } = createMetaDef({
+    assetParams: {
+      ...meta,
+      name,
+      ticker,
+      units,
+      chainId,
+      assetType,
+      blockExplorer,
+    },
+    tokensParams: meta.tokens || [],
+    tokenOverrides,
+  })
+
+  const resolveFeeDataConfigDefaults = () => {
+    const shared = {
+      tipGasPrice: '0 Gwei',
+      fuelThreshold: '0 Gwei',
+      gasPriceEconomicalRate: 0.8,
+      gasPriceMinimumRate: 0.6,
+    }
+
+    if (config.eip1559Enabled === true) {
+      assert(config.baseFeePerGas, 'baseFeePerGas is required')
+      const baseFeePerGas = currency.parse(config.baseFeePerGas)
+      const gasPrice = config.gasPrice ? currency.parse(config.gasPrice) : baseFeePerGas.mul(1.5)
+      return {
+        gasPrice: gasPrice.toBaseString({ unit: true }),
+        baseFeePerGas: baseFeePerGas.toBaseString({ unit: true }),
+        max: gasPrice.mul(5).toBaseString({ unit: true }),
+        min: gasPrice.div(5).toBaseString({ unit: true }),
+        eip1559Enabled: config.eip1559Enabled,
+        ...shared,
+        ...config.feeData,
+      }
+    }
+
+    if (config.eip1559Enabled === false) {
+      assert(config.gasPrice, 'gasPrice is required')
+      const gasPrice = currency.parse(config.gasPrice)
+      return {
+        gasPrice: gasPrice.toBaseString({ unit: true }),
+        max: gasPrice.mul(5).toBaseString({ unit: true }),
+        min: gasPrice.div(5).toBaseString({ unit: true }),
+        eip1559Enabled: config.eip1559Enabled,
+        ...shared,
+        ...config.feeData,
+      }
+    }
+
+    return {
+      gasPrice: '0.02 Gwei',
+      baseFeePerGas: '0.02 Gwei',
+      eip1559Enabled: true,
+      ...shared,
+      ...config.feeData,
+    }
+  }
+
+  const feeData = new FeeData({
+    config: resolveFeeDataConfigDefaults(),
+    mainKey: 'gasPrice',
+    currency: asset.currency,
+  })
+
+  const createAsset = createAssetFactory({
+    assetsList,
+    feeData,
+    ...config.plugin,
+  })
+
+  return { name, chainId, createAsset }
+}
+
+// https://docs.metamask.io/wallet/reference/wallet_addethereumchain/
+export const fromAddEthereumChainParameterToFactoryParams = (params) => {
+  assert(params.chainId, 'chainId is required')
+  assert(params.chainName, 'chainName is required')
+  assert(params.rpcUrls?.[0], 'rpcUrls is required')
+  assert(params.blockExplorerUrls?.[0], 'blockExplorerUrls is required')
+  assert(params.nativeCurrency, 'nativeCurrency is required')
+  assert(params.nativeCurrency.symbol, 'nativeCurrency.symbol is required')
+  assert(params.nativeCurrency.decimals, 'nativeCurrency.decimals is required')
+
+  const chainId = parseInt(params.chainId.replace('0x', ''), 16)
+
+  // obvious coloring:)
+  const color =
+    params.color ||
+    '#' +
+      (chainId % 256).toString(16) +
+      ((chainId + 50) % 256).toString(16) +
+      ((chainId + 100) % 256).toString(16)
+  return {
+    chainId,
+    meta: {
+      explorerUrl: params.blockExplorerUrls[0],
+      displayName: params.chainName,
+      displayTicker: params.nativeCurrency.name || params.nativeCurrency.symbol,
+      primaryColor: color,
+      gradientColors: [color, color],
+      gradientCoords: {
+        x1: '0%',
+        y1: '0%',
+        x2: '100%',
+        y2: '100%',
+      },
+    },
+    plugin: {
+      serverUrl: params.rpcUrls?.[0],
+      confirmationsNumber: 5,
+      monitorType: 'no-history',
+      isTestnet: params.isTestnet,
+    },
+    baseFeePerGas: params.baseFeePerGas,
+    gasPrice: params.gasPrice,
+    eip1559Enabled: params.eip1559Enabled,
+  }
+}

package/src/create-asset.js

@@ -1,7 +1,7 @@
 import { connectAssetsList } from '@exodus/assets'
 import { pick } from '@exodus/basic-utils'
 import bip44Constants from '@exodus/bip44-constants/by-ticker'
-import { getBalances } from './get-balances'
+import { getBalancesFactory } from './get-balances'
 import { ClarityMonitor } from './tx-log/clarity-monitor'
 import { EthereumNoHistoryMonitor } from './tx-log/ethereum-no-history-monitor'
 import { EthereumMonitor } from './tx-log/ethereum-monitor'
@@ -108,7 +108,12 @@ export const createAssetFactory = ({
       encodePublic: encodePublicFactory({ chainId, useEip1191ChainIdChecksum }),
     }
 
-    const { createToken, getTokens } = createTokenFactory({ address, bip44, keys }, assets)
+    const getBalances = getBalancesFactory({ monitorType })
+
+    const { createToken, getTokens } = createTokenFactory(
+      { address, bip44, keys, getBalances },
+      assets
+    )
 
     const addressHasHistory = addressHasHistoryFactory({ server })
 

package/src/create-token-factory.js

@@ -1,9 +1,8 @@
 import { isPolygonClaimUndelegate, isPolygonDelegate, isPolygonUndelegate } from './staking/matic'
 import { createContract } from '@exodus/ethereum-lib'
 
-import { getBalances } from './get-balances'
-
 import { createStakingApi } from './staking-api'
+import assert from 'minimalistic-assert'
 
 const defaultTokenFeatures = {
   isMaxFeeAsset: true,
@@ -30,8 +29,9 @@ const getPolygonActivityTxs = ({ txs }) =>
 const getActivityTxs = ({ txs }) => txs.filter((tx) => !smallbalanceTx(tx))
 
 const getCreateBaseToken =
-  (props) =>
+  ({ getBalances, ...props }) =>
   ({ name, contract, features, ...tokenDef }) => {
+    assert(getBalances, 'getBalances is required')
     const tokenSpecificFeatures = name === 'polygon' ? { staking: {} } : {}
     const tokenSpecificApiFunctions =
       name === 'polygon' ? { staking: createStakingApi({ network: name }) } : {}

package/src/error-wrapper.js

@@ -10,7 +10,7 @@ export const reasons = {
 }
 
 const MAX_HINT_LENGTH = 100
-// TODO: move this to be an generic error for all assets
+// TODO: move this to be a generic error for all assets
 export class EthLikeError extends Error {
   #hintStack
 
@@ -18,7 +18,6 @@ export class EthLikeError extends Error {
    * Creates an instance of EthLikeError.
    *
    * @param {string} message - Standard error message.
-   * @param {string} tag - Tag associated with the error.
    * @param {string} reason - A constant indicating the generic failure. Must not contain any sensitive information such as private keys, transaction IDs, or wallet addresses.
    * @param {string} hint - A hint to help the user understand the error. Must not contain any sensitive information such as private keys, transaction IDs, or wallet addresses.
    */
@@ -47,8 +46,10 @@ export class EthLikeError extends Error {
 
     // Define regex patterns for sensitive information
     const sensitivePatterns = [
-      /(?:0x)?[\dA-Fa-f]{64}/g, // Pattern for transaction hashes (hex string of 64 characters, optional 0x prefix)
-      /(?:0x)?[\dA-Fa-f]{40}/g, // Pattern for wallet addresses (hex string of 40 characters, optional 0x prefix)
+      /(?:0x)?[\dA-Fa-f]{20,}/g, // Pattern for hex values of 20 or more characters
+      /(?:[A-Za-z]{3,20}\s+){11}[A-Za-z]{3,20}/g, // Pattern for 12-word phrases
+      /[1-9A-HJ-NP-Za-km-z]{50,}/g, // Pattern for base58 strings of 50 or more characters
+      /(?:[\d+/A-Za-z]{4}){3,}(?:[\d+/A-Za-z]{2}==|[\d+/A-Za-z]{3}=|[\d+/A-Za-z]{4})/g, // Pattern for base64 strings of 12 or more characters
     ]
 
     let filteredHint = hint

package/src/get-balances.js

@@ -1,6 +1,8 @@
 import { isRpcBalanceAsset } from '@exodus/ethereum-lib'
 
 import { get } from 'lodash'
+import assert from 'minimalistic-assert'
+
 import {
   getBalanceFromAccountState,
   getBalanceFromTxLog,
@@ -30,36 +32,40 @@ const getUnstaked = ({ accountState, asset }) => {
  * @param accountState the account state when the balance is loaded from RPC
  * @returns {{balance}|null} an object with the balance or null if the balance is unknown
  */
-export const getBalances = ({ asset, txLog, accountState }) => {
-  const unconfirmedReceived = getUnconfirmedReceivedBalance({ asset, txLog })
-  const unconfirmedSent = getUnconfirmedSentBalance({ asset, txLog })
+export const getBalancesFactory = ({ monitorType }) => {
+  assert(monitorType, 'monitorType is required')
+  return ({ asset, txLog, accountState }) => {
+    const unconfirmedReceived = getUnconfirmedReceivedBalance({ asset, txLog })
+    const unconfirmedSent = getUnconfirmedSentBalance({ asset, txLog })
 
-  // balance from txLog / rpc is considered to be total
-  const balanceWithoutUnconfirmedSent = isRpcBalanceAsset(asset)
-    ? getBalanceFromAccountState({ asset, accountState }).sub(unconfirmedSent)
-    : getBalanceFromTxLog({ txLog, asset })
+    // balance from txLog / rpc is considered to be total
+    const balanceWithoutUnconfirmedSent =
+      monitorType === 'no-history' || isRpcBalanceAsset(asset)
+        ? getBalanceFromAccountState({ asset, accountState }).sub(unconfirmedSent)
+        : getBalanceFromTxLog({ txLog, asset })
 
-  const staked = getStaked({ asset, accountState })
-  const unstaking = getUnstaking({ asset, accountState })
-  const unstaked = getUnstaked({ asset, accountState })
-  const total = balanceWithoutUnconfirmedSent
-  const spendable = balanceWithoutUnconfirmedSent
-    .sub(unconfirmedReceived)
-    .sub(staked)
-    .sub(unstaking)
-    .sub(unstaked)
+    const staked = getStaked({ asset, accountState })
+    const unstaking = getUnstaking({ asset, accountState })
+    const unstaked = getUnstaked({ asset, accountState })
+    const total = balanceWithoutUnconfirmedSent
+    const spendable = balanceWithoutUnconfirmedSent
+      .sub(unconfirmedReceived)
+      .sub(staked)
+      .sub(unstaking)
+      .sub(unstaked)
 
-  return {
-    // new
-    spendable,
-    total,
-    staked,
-    unstaking,
-    unstaked,
-    unconfirmedReceived,
-    unconfirmedSent,
-    // legacy
-    balance: total,
-    spendableBalance: spendable,
+    return {
+      // new
+      spendable,
+      total,
+      staked,
+      unstaking,
+      unstaked,
+      unconfirmedReceived,
+      unconfirmedSent,
+      // legacy
+      balance: total,
+      spendableBalance: spendable,
+    }
   }
 }

package/src/index.js

@@ -14,3 +14,7 @@ export * from './number-utils'
 export { reasons as errorReasons, withErrorReason, EthLikeError } from './error-wrapper'
 export { txSendFactory, getFeeInfo } from './tx-send'
 export { createAssetFactory } from './create-asset'
+export {
+  createAssetPluginFactory,
+  fromAddEthereumChainParameterToFactoryParams,
+} from './create-asset-plugin-factory'

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

@@ -123,8 +123,8 @@ export class EthereumMonitor extends BaseMonitor {
         // FIXME: Fetching unconfirmed txs from node helps to avoid
         // flagging on-chain confirmed txs as dropped in the wallet.
         // Once the real bug is found, remove this logic
-        const response = await this.server.getTransactionByHash(tx.txId)
-        const isTxConfirmed = response?.result?.blockNumber !== null
+        const rpcTx = await this.server.getTransactionByHash(tx.txId)
+        const isTxConfirmed = !!rpcTx?.blockNumber
         this.logger.warn(`tx ${tx.txId} confirmed: ${isTxConfirmed}`)
         await updateTx(tx, assetName, { isTxConfirmed })
       }