@exodus/ethereum-api 8.0.0 → 8.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-api",
-  "version": "8.0.0",
+  "version": "8.2.0",
   "description": "Ethereum Api",
   "main": "src/index.js",
   "files": [
@@ -34,6 +34,7 @@
     "@exodus/models": "^11.0.0",
     "@exodus/simple-retry": "^0.0.6",
     "@exodus/solidity-contract": "^1.1.3",
+    "@exodus/web3-ethereum-utils": "^3.27.1",
     "bn.js": "^5.2.1",
     "events": "^1.1.1",
     "idna-uts46-hx": "^2.3.1",
@@ -57,5 +58,5 @@
     "cross-fetch": "^3.1.5",
     "delay": "4.0.1"
   },
-  "gitHead": "a5992c8a158d486d6e95c03b17136b67ee06459c"
+  "gitHead": "3d6deb1f1d8ba08510be92ed52dfe39ce69e6fb9"
 }

package/src/allowance/index.js

@@ -30,15 +30,13 @@ export async function isSpendingApprovalRequired({
 export const createApprove =
   ({ sendTx }) =>
   async ({
-    walletAccount,
-    fromAddress,
     spenderAddress,
     asset,
     feeData,
-    feeAmount,
     approveAmount,
     gasLimit,
     txInput: preTxInput,
+    ...rest
   }) => {
     const baseAsset = asset.baseAsset
     const txInput =
@@ -48,7 +46,6 @@ export const createApprove =
     const gasLimitOptions = {
       asset: baseAsset,
       amount: baseAsset.currency.ZERO,
-      fromAddress,
       toAddress,
       txInput,
       feeData,
@@ -59,7 +56,6 @@ export const createApprove =
 
     const txData = await sendTx({
       asset: baseAsset.name,
-      walletAccount,
       receiver: {
         address: toAddress,
         amount: baseAsset.currency.ZERO,
@@ -67,8 +63,8 @@ export const createApprove =
       txInput,
       gasPrice: feeData.gasPrice,
       gasLimit,
-      feeAmount,
       silent: true,
+      ...rest,
     })
 
     if (!txData || !txData.txId) {

package/src/create-asset.js

@@ -37,6 +37,8 @@ import { serverBasedFeeMonitorFactoryFactory } from './server-based-fee-monitor'
 import { createGetBalanceForAddress } from './get-balance-for-address'
 import { estimateL1DataFeeFactory, getL1GetFeeFactory } from './optimism-gas'
 import { mapValues } from 'lodash'
+import { createWeb3API } from './web3'
+import getFeeAsyncFactory from './get-fee-async'
 
 export const createAssetFactory = ({
   assetsList,
@@ -217,6 +219,7 @@ export const createAssetFactory = ({
       getBalanceForAddress: createGetBalanceForAddress({ asset, server }),
       getConfirmationsNumber: () => confirmationNumber,
       getDefaultAddressPath: () => defaultAddressPath,
+      getFeeAsync: getFeeAsyncFactory({ assetClientInterface, gasLimit, createUnsignedTx }),
       getFee,
       getFeeData: () => feeData,
       getKeyIdentifier: createGetKeyIdentifier({
@@ -239,6 +242,7 @@ export const createAssetFactory = ({
         signer ? signMessageWithSigner({ message, signer }) : signMessage({ privateKey, message }),
       ...(supportsStaking && { staking: createStakingApi({ network: asset.name }) }),
       validateAssetId: address.validate,
+      web3: createWeb3API({ asset }),
     }
 
     const fullAsset = {

package/src/eth-like-util.js

@@ -13,6 +13,12 @@ export async function isContractAddress({ asset, address }) {
   return getServer(asset).isContract(address)
 }
 
+export const isContractAddressCached = memoizeLruCache(
+  isContractAddress,
+  ({ asset, address }) => `${asset.name}:${address}`,
+  { max: 1000 }
+)
+
 export async function isForwarderContract({ asset, address }) {
   const contractCode = await getServer(asset).getCode(address)
   return (
@@ -21,6 +27,12 @@ export async function isForwarderContract({ asset, address }) {
   )
 }
 
+export const isForwarderContractCached = memoizeLruCache(
+  isForwarderContract,
+  ({ asset, address }) => `${asset.name}:${address}`,
+  { max: 1000 }
+)
+
 export async function getNonce({ asset, address, tag = 'latest' }) {
   const server = getServer(asset)
   const nonce = await server.getTransactionCount(address, tag)

package/src/gas-estimation.js

@@ -1,7 +1,7 @@
 import BN from 'bn.js'
 import * as ethUtil from '@exodus/ethereumjs-util'
 import { currency2buffer, isToken } from '@exodus/ethereum-lib'
-import { estimateGas, isContractAddress } from './eth-like-util'
+import { estimateGas, isContractAddressCached } from './eth-like-util'
 
 const EXTRA_PERCENTAGE = 20
 
@@ -44,9 +44,7 @@ export async function fetchGasLimit({
   toAddress,
   txInput = '0x',
   amount,
-  feeData = {},
   bip70,
-  isContract,
   throwOnError = true,
   extraPercentage,
 }) {
@@ -54,13 +52,14 @@ export async function fetchGasLimit({
     return asset.name === 'ethereum' ? 65_000 : 130_000 // from on chain stats https://dune.xyz/queries/189123
 
   if (!amount) amount = asset.currency.ZERO
-  // eslint-disable-next-line @exodus/mutable/no-param-reassign-prop-only
-  if (!feeData.gasPrice) feeData.gasPrice = asset.baseAsset.currency.ZERO
 
   const defaultGasLimit = () =>
     asset.gasLimit + GAS_PER_NON_ZERO_BYTE * ethUtil.toBuffer(txInput).length
 
   const _isToken = isToken(asset)
+
+  const isContract = await isContractAddressCached({ asset, address: toAddress })
+
   if (_isToken) {
     // only create tx-input only if not pass tx-input to a token asset
     if (txInput === '0x') {
@@ -72,12 +71,13 @@ export async function fetchGasLimit({
     amount = asset.baseAsset.currency.ZERO
     toAddress = asset.contract.address
   } else if (!isContract && !['ethereumarbone', 'ethereumarbnova'].includes(asset.name)) {
-    if (isContract === undefined)
-      isContract = await isContractAddress({ asset, address: toAddress })
-    if (!isContract) return defaultGasLimit()
+    return defaultGasLimit()
   }
 
-  const gasPrice = ethUtil.bufferToHex(currency2buffer(feeData.gasPrice))
+  // calling forwarder contracts with a bumped gas limit causes 'Out Of Gas' error on chain
+  // Since geth v1.9.14 estimateGas will throw if user does not have enough ETH.
+  // If gasPrice is set to zero, estimateGas will make the expected estimation.
+  const gasPrice = ethUtil.bufferToHex(currency2buffer(asset.baseAsset.currency.ZERO))
 
   try {
     return await estimateGasLimit(

package/src/get-fee-async.js

@@ -0,0 +1,97 @@
+import assert from 'minimalistic-assert'
+import { fetchGasLimit } from './gas-estimation'
+import { isForwarderContractCached } from './eth-like-util'
+import { getFeeFactory } from './get-fee'
+
+const FIXED_TRANSFER_GAS_LIMIT_ASSETS = new Set([
+  'amp',
+  'tetherusd',
+  'usdcoin',
+  'snx',
+  'geminidollar',
+])
+
+async function resolveExtraPercentage({ asset, toAddress }) {
+  const isToken = asset.name !== asset.baseAsset.name
+  // calling forwarder contracts with a bumped gas limit causes 'Out Of Gas' error on chain
+  const hasForwarderContract =
+    !isToken && toAddress ? await isForwarderContractCached({ asset, address: toAddress }) : false
+
+  return asset.baseAsset.estimateL1DataFee
+    ? 100
+    : (isToken && FIXED_TRANSFER_GAS_LIMIT_ASSETS.has(asset.name)) || hasForwarderContract
+      ? 0
+      : undefined
+}
+
+const getFeeAsyncFactory = ({
+  assetClientInterface,
+  gasLimit: defaultGasLimit,
+  createUnsignedTx,
+}) => {
+  assert(assetClientInterface, 'assetClientInterface is required')
+  assert(createUnsignedTx, 'createUnsignedTx is required')
+  const getFee = getFeeFactory({ gasLimit: defaultGasLimit })
+  return async ({
+    asset,
+    fromAddress = '0xffffffffffffffffffffffffffffffffffffffff', // sending from a random address
+    toAddress = '0xffffffffffffffffffffffffffffffffffffffff', // sending to a random address,
+    amount,
+    bip70,
+    txInput,
+    isExchange,
+    customFee,
+    calculateEffectiveFee,
+    isSendAll,
+    isRbfAllowed = true, // Destkop, isRbfAllowed=true when advanced panel is on
+    throwOnError = false,
+  }) => {
+    const extraPercentage = await resolveExtraPercentage({ asset, toAddress })
+
+    const gasLimit = await fetchGasLimit({
+      asset,
+      fromAddress,
+      toAddress,
+      txInput: txInput ?? '0x', // default value is '0x'
+      amount,
+      bip70,
+      throwOnError,
+      extraPercentage,
+    })
+    const feeData = await assetClientInterface.getFeeConfig({ assetName: asset.baseAsset.name })
+
+    const optimismL1DataFee = asset.baseAsset.estimateL1DataFee
+      ? await asset.baseAsset.estimateL1DataFee({
+          unsignedTx: createUnsignedTx({
+            asset,
+            address: toAddress,
+            fromAddress,
+            amount,
+            nonce: 0,
+            txInput,
+            gasPrice: feeData.gasPrice,
+            gasLimit,
+          }),
+        })
+      : undefined
+
+    const { fee, ...rest } = getFee({
+      asset,
+      feeData,
+      gasLimit,
+      isExchange,
+      isSendAll,
+      amount,
+      isRbfAllowed,
+      calculateEffectiveFee, // BE
+      customFee, // BE
+    })
+
+    const l1DataFee = optimismL1DataFee
+      ? asset.baseAsset.currency.baseUnit(optimismL1DataFee)
+      : asset.baseAsset.currency.ZERO
+    return { fee: fee.add(l1DataFee), gasLimit, ...rest }
+  }
+}
+
+export default getFeeAsyncFactory

package/src/get-fee.js

@@ -44,8 +44,7 @@ export const getFeeFactory =
     isSendAll,
     amount,
     isRbfAllowed = true, // Destkop, isRbfAllowed=true when advanced panel is on
-    calculateEffectiveFee, // BE
-    customFee: customGasPrice, // BE
+    calculateEffectiveFee,
   }) => {
     const { gasPrice, eip1559Enabled, baseFeePerGas, tipGasPrice } = feeData
     const gasPriceMultiplier = getGasPriceMultiplier({
@@ -58,7 +57,7 @@ export const getFeeFactory =
 
     const extraFeeData = getExtraFeeData({ asset, amount })
     if (calculateEffectiveFee && eip1559Enabled) {
-      const maxFeePerGas = customGasPrice || gasPrice
+      const maxFeePerGas = customFee || gasPrice
       // effective_gas_price = min(base_fee_per_gas + tip_gas_price, max_fee_per_gas)
       const feePerGas = baseFeePerGas.add(tipGasPrice)
       const effectiveGasPrice = feePerGas.lt(maxFeePerGas) ? feePerGas : maxFeePerGas

package/src/web3/createSimulateMessage.js

@@ -0,0 +1,12 @@
+import { createSimulateMessage as createSimulateEVMMessage } from '@exodus/web3-ethereum-utils'
+import assert from 'minimalistic-assert'
+
+export const createSimulateMessage = ({ asset }) => {
+  assert('asset', '"asset" should be passed.')
+
+  const simulateEVMMessage = createSimulateEVMMessage()
+
+  return function simulateMessage({ message, ...restParameters }) {
+    return simulateEVMMessage({ asset, message, ...restParameters })
+  }
+}

package/src/web3/index.js

@@ -0,0 +1,7 @@
+import { createSimulateMessage } from './createSimulateMessage'
+
+export const createWeb3API = (deps) => {
+  return {
+    simulateMessage: createSimulateMessage(deps),
+  }
+}