@exodus/ethereum-api 7.3.2 → 7.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-api",
-  "version": "7.3.2",
+  "version": "7.5.0",
   "description": "Ethereum Api",
   "main": "src/index.js",
   "files": [
@@ -57,5 +57,5 @@
     "cross-fetch": "^3.1.5",
     "delay": "4.0.1"
   },
-  "gitHead": "06a32175d0e18e2fca6c74e55313b68ce0c2b402"
+  "gitHead": "8066c2fd98a9065156d93108e42aa01f40aecf57"
 }

package/src/create-asset.js

@@ -21,6 +21,7 @@ import {
   signUnsignedTxWithSigner,
   validate,
   signMessage,
+  signMessageWithSigner,
   signHardwareFactory,
   DEFAULT_FEE_MONITOR_INTERVAL,
 } from '@exodus/ethereum-lib'
@@ -34,8 +35,9 @@ import { getEffectiveGasPrice, getFeeFactory } from './get-fee'
 import { createEthereumHooks } from './hooks'
 import { createStakingApi } from './staking-api'
 import { txSendFactory } from './tx-send'
-import { signMessageWithSigner } from '@exodus/ethereum-lib/src/sign-message'
 import { serverBasedFeeMonitorFactoryFactory } from './fee-monitor'
+import { createGetBalanceForAddress } from './get-balance-for-address'
+import { estimateL1DataFeeFactory, getL1GetFeeFactory } from './optimism-gas'
 
 export const createAssetFactory = ({
   assetsList,
@@ -43,7 +45,6 @@ export const createAssetFactory = ({
   AccountState: CustomAccountState,
   monitorInterval,
   nfts = false,
-  getFee: customGetFee,
   useEip1191ChainIdChecksum = false,
   customTokens = true,
   isTestnet = false,
@@ -53,6 +54,7 @@ export const createAssetFactory = ({
   customBip44,
   customCreateGetKeyIdentifier,
   feeMonitorInterval,
+  l1GasOracleAddress, // l1 extra fee for base and opto
 }) => {
   assert(assetsList, 'assetsList is required')
   assert(feeData, 'feeData is required')
@@ -114,6 +116,7 @@ export const createAssetFactory = ({
     const createFeeMonitor = serverBasedFeeMonitorFactoryFactory({
       assetName: base.name,
       interval: config.feeMonitorInterval || feeMonitorInterval || DEFAULT_FEE_MONITOR_INTERVAL,
+      eip1559Enabled: feeData.eip1559Enabled, // this is not updated via remote config. Should it be?
     })
 
     const features = {
@@ -126,6 +129,7 @@ export const createAssetFactory = ({
       nfts,
       noHistory: monitorType === 'no-history',
       signWithSigner: true,
+      signMessageWithSigner: true,
       ...(supportsStaking && { staking: {} }),
     }
 
@@ -165,6 +169,17 @@ export const createAssetFactory = ({
     const defaultAddressPath = 'm/0/0'
 
     const sendTx = txSendFactory({ assetClientInterface })
+
+    const estimateL1DataFee = l1GasOracleAddress
+      ? estimateL1DataFeeFactory({ l1GasOracleAddress, server })
+      : undefined
+
+    const originalGetFee = getFeeFactory({ gasLimit })
+
+    const getFee = l1GasOracleAddress
+      ? getL1GetFeeFactory({ asset, originalGetFee })
+      : originalGetFee
+
     const api = {
       addressHasHistory,
       broadcastTx: (...args) => server.sendRawTransaction(...args),
@@ -176,9 +191,10 @@ export const createAssetFactory = ({
       defaultAddressPath,
       features,
       getBalances,
+      getBalanceForAddress: createGetBalanceForAddress({ asset, server }),
       getConfirmationsNumber: () => confirmationNumber,
       getDefaultAddressPath: () => defaultAddressPath,
-      getFee: customGetFee || getFeeFactory({ gasLimit }),
+      getFee,
       getFeeData: () => feeData,
       getKeyIdentifier: createGetKeyIdentifier({ bip44, allowMetaMaskCompat }),
       getSupportedPurposes: () => [44],
@@ -207,6 +223,8 @@ export const createAssetFactory = ({
       keys,
       address,
       api,
+      estimateL1DataFee,
+      server,
       ...(erc20FuelBuffer && { erc20FuelBuffer }),
       ...(fuelThreshold && { fuelThreshold: asset.currency.defaultUnit(fuelThreshold) }),
       getEffectiveGasPrice,

package/src/exodus-eth-server/api-coin-nodes.js

@@ -160,6 +160,21 @@ export default class ApiCoinNodesServer extends EventEmitter {
   // for fee monitor
   getGasPrice = this.gasPrice
 
+  async getLatestBlock() {
+    const request = this.buildRequest({
+      method: 'eth_getBlockByNumber',
+      params: ['latest', false],
+    })
+    return this.sendRequest(request)
+  }
+
+  async getBaseFeePerGas() {
+    const response = await this.getLatestBlock()
+    if (response.baseFeePerGas) {
+      return fromHexToString(response.baseFeePerGas)
+    }
+  }
+
   async estimateGas(...params) {
     const request = this.estimateGasRequest(...params)
     return this.sendRequest(request)

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

@@ -126,6 +126,17 @@ export function create(defaultURL, ensAssetName) {
       return requestWithRetry('proxy', { method: 'eth_gasPrice' })
     },
 
+    async getLatestBlock() {
+      return this.getBlockByNumber('latest')
+    },
+
+    async getBaseFeePerGas() {
+      const response = await this.getLatestBlock()
+      if (response.baseFeePerGas) {
+        return fromHexToString(response.baseFeePerGas)
+      }
+    },
+
     async getTransactionCount(address, tag = 'latest') {
       return requestWithRetry('proxy', { method: 'eth_getTransactionCount', address, tag })
     },

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

@@ -366,6 +366,17 @@ export default class ClarityServer extends EventEmitter {
     return this.sendRequest(request)
   }
 
+  async getLatestBlock() {
+    return this.getBlockByNumber('latest')
+  }
+
+  async getBaseFeePerGas() {
+    const response = await this.getLatestBlock()
+    if (response.baseFeePerGas) {
+      return fromHexToString(response.baseFeePerGas)
+    }
+  }
+
   async getBlockByHash(...params) {
     const request = this.getBlockByHashRequest(...params)
     return this.sendRequest(request)

package/src/fee-monitor/server-based-fee-monitor.js

@@ -1,6 +1,8 @@
-import { EthereumLikeFeeMonitor } from '@exodus/ethereum-lib'
+import { FeeMonitor } from '@exodus/asset-lib'
 import assert from 'minimalistic-assert'
 import { getServerByName } from '../exodus-eth-server'
+import { DEFAULT_FEE_MONITOR_INTERVAL } from '@exodus/ethereum-lib'
+import { fromHexToString } from '../number-utils'
 
 /**
  * Generic eth server based fee monitor.
@@ -16,24 +18,37 @@ import { getServerByName } from '../exodus-eth-server'
  * }
  */
 
-export const serverBasedFeeMonitorFactoryFactory = ({ assetName, interval }) => {
+export const serverBasedFeeMonitorFactoryFactory = ({
+  assetName,
+  interval = DEFAULT_FEE_MONITOR_INTERVAL,
+  eip1559Enabled,
+}) => {
   assert(assetName, 'assetName is required')
-
   // NOTE: Using getServerByName for simplicity now but
   // remove getServerByName and convert server to a param instead.
   // This is to avoid global references, static creation, remove the chain specific map and allow IOC
   const server = getServerByName(assetName)
-  const getGasPrice = (...args) => server.getGasPrice(...args)
-  const FeeMonitorClass = class ServerBaseEthereumFeeMonitor extends EthereumLikeFeeMonitor {
+
+  const FeeMonitorClass = class ServerBaseEthereumFeeMonitor extends FeeMonitor {
     constructor({ updateFee }) {
       assert(updateFee, 'updateFee is required')
       super({
         updateFee,
         assetName,
-        getGasPrice,
         interval,
       })
     }
+
+    async fetchFee() {
+      const gasPrice = fromHexToString(await server.getGasPrice())
+
+      const baseFeePerGas = eip1559Enabled ? `${await server.getBaseFeePerGas()} wei` : undefined
+
+      return {
+        gasPrice: `${gasPrice} wei`,
+        baseFeePerGas,
+      }
+    }
   }
   return (...args) => new FeeMonitorClass(...args)
 }

package/src/get-balance-for-address.js

@@ -0,0 +1,10 @@
+import assert from 'minimalistic-assert'
+
+export const createGetBalanceForAddress = ({ asset, server }) => {
+  assert(asset, 'asset is required')
+  assert(server, 'server is required')
+  return async (address) => {
+    const balances = await server.getBalance(address)
+    return asset.currency.baseUnit(balances.confirmed.value)
+  }
+}

package/src/get-balances.js

@@ -2,21 +2,6 @@ import { isRpcBalanceAsset } from '@exodus/ethereum-lib'
 
 import { get } from 'lodash'
 
-const fixBalance = ({ txLog, balance }) => {
-  for (const tx of txLog) {
-    // TODO: pending can only be less than a few minutes old, we can only search the latest txs to improve performance
-    if (tx.sent && tx.pending && !tx.error) {
-      // coinAmount is negative for sent tx
-      balance = balance.sub(tx.coinAmount.abs())
-      if (tx.coinAmount.unitType.equals(tx.feeAmount.unitType)) {
-        balance = balance.sub(tx.feeAmount)
-      }
-    }
-  }
-
-  return balance
-}
-
 const getBalanceFromAccountState = ({ asset, accountState }) => {
   const isBase = asset.name === asset.baseAsset.name
   return get(
@@ -44,14 +29,33 @@ const getUnstaked = ({ accountState, asset }) => {
   )
 }
 
-function getBasicSpendable({ asset, accountState, txLog }) {
-  const balance = isRpcBalanceAsset(asset)
-    ? getBalanceFromAccountState({ asset, accountState })
-    : getBalanceFromTxLog({ txLog, asset })
+const getUnconfirmedSentBalanceFromTxLog = ({ asset, txLog }) => {
+  let result = asset.currency.ZERO
+
+  for (const tx of txLog) {
+    const isUnconfirmed = !tx.failed && tx.pending
+
+    if (isUnconfirmed && tx.sent) {
+      result = result.add(tx.coinAmount.abs())
+      if (tx.feeAmount && tx.coinAmount.unitType.equals(tx.feeAmount.unitType)) {
+        result = result.add(tx.feeAmount.abs())
+      }
+    }
+  }
 
-  const shouldFixBalance = isRpcBalanceAsset(asset)
+  return result
+}
 
-  return shouldFixBalance ? fixBalance({ txLog, balance }) : balance
+const getUnconfirmedReceivedBalanceFromTxLog = ({ asset, txLog }) => {
+  let result = asset.currency.ZERO
+  for (const tx of txLog) {
+    const isUnconfirmed = !tx.failed && tx.pending
+    if (isUnconfirmed && !tx.sent) {
+      result = result.add(tx.coinAmount.abs())
+    }
+  }
+
+  return result
 }
 
 /**
@@ -63,13 +67,18 @@ function getBasicSpendable({ asset, accountState, txLog }) {
  * @returns {{balance}|null} an object with the balance or null if the balance is unknown
  */
 export const getBalances = ({ asset, txLog, accountState }) => {
-  const spendable = getBasicSpendable({ asset, accountState, txLog })
+  const unconfirmedReceived = getUnconfirmedReceivedBalanceFromTxLog({ asset, txLog })
+  const unconfirmedSent = getUnconfirmedSentBalanceFromTxLog({ asset, txLog })
 
+  const balanceWithoutUnconfirmedSent = isRpcBalanceAsset(asset)
+    ? getBalanceFromAccountState({ asset, accountState }).sub(unconfirmedSent)
+    : getBalanceFromTxLog({ txLog, asset })
+
+  const spendable = balanceWithoutUnconfirmedSent.sub(unconfirmedReceived)
   const staked = getStaked({ asset, accountState })
   const unstaking = getUnstaking({ asset, accountState })
   const unstaked = getUnstaked({ asset, accountState })
-
-  const total = spendable.add(staked).add(unstaking).add(unstaked)
+  const total = balanceWithoutUnconfirmedSent.add(staked).add(unstaking).add(unstaked)
 
   return {
     // new
@@ -78,6 +87,8 @@ export const getBalances = ({ asset, txLog, accountState }) => {
     staked,
     unstaking,
     unstaked,
+    unconfirmedReceived,
+    unconfirmedSent,
     // legacy
     balance: total,
     spendableBalance: spendable,

package/src/optimism-gas/index.js

@@ -3,19 +3,48 @@ import { createEthereumJsTx, createContract } from '@exodus/ethereum-lib'
 import { getServerByName } from '../exodus-eth-server'
 import { GAS_ORACLE_ADDRESS } from './addresses'
 import { fromHexToBigInt } from '../number-utils'
+import assert from 'minimalistic-assert'
 
-const gasContract = createContract(GAS_ORACLE_ADDRESS, 'optimismGasOracle')
+export const estimateL1DataFeeFactory = ({ l1GasOracleAddress, server }) => {
+  assert(l1GasOracleAddress, 'l1GasOracleAddress is required')
+  assert(server, 'server is required')
+  const gasContract = createContract(l1GasOracleAddress, 'optimismGasOracle')
+  return async ({ unsignedTx }) => {
+    const ethjsTx = createEthereumJsTx(unsignedTx)
+    const serialized = ethjsTx.serialize()
+    const callData = gasContract.getL1Fee.build(serialized)
+    const buffer = Buffer.from(callData)
+    const data = ethUtil.bufferToHex(buffer)
+    const hex = await server.ethCall({ to: l1GasOracleAddress, data }, 'latest')
+    const l1DataFee = fromHexToBigInt(hex)
+    const padFee = l1DataFee / BigInt(4)
+    const maxL1DataFee = l1DataFee + padFee
+    return maxL1DataFee.toString()
+  }
+}
+
+export const getL1GetFeeFactory = ({ asset, originalGetFee }) => {
+  return ({ feeOpts, ...args }) => {
+    const { fee, ...rest } = originalGetFee(args)
+    if (!feeOpts?.optimismL1DataFee) {
+      // hardcoded optimism name is for back compatiblity, it could be base!
+      // better to rename
+      return { fee, ...rest }
+    }
 
-export async function estimateOptimismL1DataFee({ unsignedTx }) {
-  const ethjsTx = createEthereumJsTx(unsignedTx)
-  const serialized = ethjsTx.serialize()
-  const callData = gasContract.getL1Fee.build(serialized)
-  const buffer = Buffer.from(callData)
-  const data = ethUtil.bufferToHex(buffer)
-  const server = getServerByName('optimism')
-  const hex = await server.ethCall({ to: GAS_ORACLE_ADDRESS, data }, 'latest')
-  const l1DataFee = fromHexToBigInt(hex)
-  const padFee = l1DataFee / BigInt(4)
-  const maxL1DataFee = l1DataFee + padFee
-  return maxL1DataFee.toString()
+    const l1DataFee = asset.currency.baseUnit(feeOpts.optimismL1DataFee)
+    return { fee: fee.add(l1DataFee), ...rest }
+  }
 }
+
+/**
+ * Back-compatibility
+ *
+ * @deprecated use eth-asset.estimateL1DataFee
+ * @param unsignedTx
+ * @returns {Promise<string>}
+ */
+export const estimateOptimismL1DataFee = estimateL1DataFeeFactory({
+  server: getServerByName('optimism'),
+  l1GasOracleAddress: GAS_ORACLE_ADDRESS,
+})

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

@@ -34,6 +34,12 @@ const txSendFactory = ({ assetClientInterface }) => {
     const assets = await assetClientInterface.getAssetsForNetwork({ baseAssetName: baseAsset.name })
     let eip1559Enabled = baseAsset.name === 'ethereum' // TODO: temp override, clean up use of eip1559Enabled flag and default to always true
 
+    // 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,