@exodus/ethereum-lib 4.2.6 → 4.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-lib",
-  "version": "4.2.6",
+  "version": "4.3.0",
   "description": "Ethereum Library",
   "main": "src/index.js",
   "files": [
@@ -19,7 +19,7 @@
     "lint:fix": "yarn lint --fix"
   },
   "dependencies": {
-    "@exodus/asset-lib": "^3.7.1",
+    "@exodus/asset-lib": "^4.1.0",
     "@exodus/aurora-meta": "^1.0.3",
     "@exodus/avalanchec-meta": "^1.0.4",
     "@exodus/basemainnet-meta": "^1.0.6",
@@ -34,8 +34,8 @@
     "@exodus/ethereumgoerli-meta": "^1.0.3",
     "@exodus/ethereumholesky-meta": "^1.0.1",
     "@exodus/ethereumjs-common": "^2.4.0-exodus.6",
-    "@exodus/ethereumjs-tx": "^3.3.0-exodus.6",
-    "@exodus/ethereumjs-util": "^7.1.0-exodus.6",
+    "@exodus/ethereumjs-tx": "^3.3.0-exodus.7",
+    "@exodus/ethereumjs-util": "^7.1.0-exodus.7",
     "@exodus/fantommainnet-meta": "^1.0.5",
     "@exodus/flare-meta": "^1.0.4",
     "@exodus/harmonymainnet-meta": "^1.0.0",
@@ -53,8 +53,10 @@
     "reselect": "~3.0.1"
   },
   "devDependencies": {
-    "@exodus/assets": "9.1.0",
-    "@exodus/assets-base": "^8.1.14"
+    "@exodus/assets": "^9.1.1",
+    "@exodus/bitcoin-meta": "^1.0.2",
+    "@exodus/bnbmainnet-meta": "^1.0.0",
+    "@exodus/elliptic": "^6.5.4-precomputed"
   },
-  "gitHead": "b136d1a0684e11f282c31dbe89ebd52ab4dd6ec8"
+  "gitHead": "b4bf49e4180ceb6fb437a2c7dd155829b00aa212"
 }

package/src/abi/index.js

@@ -19,7 +19,7 @@ import ensRegistry from './ens-registry'
 import ensResolver from './ens-resolver'
 import optimismGasOracle from './optimism-gas-oracle'
 
-export default {
+const index = {
   ant,
   cdai,
   dai,
@@ -41,3 +41,5 @@ export default {
   ensResolver,
   optimismGasOracle,
 }
+
+export default index

package/src/account-state/parse-legacy-balances.js

@@ -6,18 +6,21 @@ function parseBalance({ asset, balance }) {
   if (isNumberUnit(balance)) {
     if (balance.unitType.equals(currency)) {
       return balance
-    } else {
-      throw new Error(
-        `Balance '${balance.toDefaultString()}' is not of currency ${currency.toString()}`
-      )
     }
+
+    throw new Error(
+      `Balance '${balance.toDefaultString()}' is not of currency ${currency.toString()}`
+    )
   }
+
   if (isString(balance)) {
     return currency.parse(balance)
   }
+
   if (isNumber(balance)) {
     return currency.defaultUnit(balance)
   }
+
   throw new Error(`Cannot parse balance '${balance}' of currency ${currency}`)
 }
 

package/src/account-state/staking-data.js

@@ -6,6 +6,8 @@ const ethStakeAccountState = ({ currency }) => ({
   delegatedBalance: currency.ZERO,
   rewardsBalance: currency.ZERO,
   unclaimedUndelegatedBalance: currency.ZERO,
+  totalRewardsReceived: currency.ZERO,
+  lastStakingTxProcessed: '',
 })
 
 const assetStakingData = {

package/src/balances/ethereum-balance.js

@@ -12,9 +12,17 @@ export const getEthereumBalances = ({ asset, liquidBalance, accountState }) => {
     ['staking', asset.name, 'unclaimedUndelegatedBalance'],
     asset.currency.ZERO
   )
-  const totalBalance = liquidBalance.add(delegatedBalance).add(undelegatedBalance)
+  const rewardsReceived = get(
+    accountState,
+    ['staking', asset.name, 'totalRewardsReceived'],
+    asset.currency.ZERO
+  )
+  const totalBalance = liquidBalance
+    .add(delegatedBalance)
+    .add(undelegatedBalance)
+    .add(rewardsReceived)
   return {
     balance: totalBalance,
-    liquidBalance,
+    liquidBalance: liquidBalance.add(rewardsReceived),
   }
 }

package/src/constants.js

@@ -20,7 +20,7 @@ const CHAIN_DATA = {
     tokenType: 'ETHEREUM_GOERLI_ERC20',
   },
   ethereumholesky: {
-    chainId: 17000,
+    chainId: 17_000,
     serverUrl: 'https://geth-holesky-testnet-d.a.exodus.io/wallet/v1/',
     confirmationsNumber: 30,
     tokenType: 'ETHEREUM_HOLESKY_ERC20',
@@ -39,7 +39,7 @@ const CHAIN_DATA = {
     tokenType: 'MATIC_ERC20',
   },
   avalanchec: {
-    chainId: 43114,
+    chainId: 43_114,
     serverUrl: 'https://avax-c.a.exodus.io/wallet/v1/',
     confirmationsNumber: 30,
     tokenType: 'AVAX_ERC20',
@@ -51,20 +51,20 @@ const CHAIN_DATA = {
     tokenType: 'FTM_ERC20',
   },
   harmonymainnet: {
-    chainId: 1666600000,
+    chainId: 1_666_600_000,
     serverUrl: 'https://harmony.a.exodus.io/wallet/v1/',
     confirmationsNumber: 6,
     // tokenType: // we do not support tokens yet
   },
   ethereumarbnova: {
-    chainId: 42170,
+    chainId: 42_170,
     serverUrl: 'https://arbitrum-nova-clarity.a.exodus.io',
     confirmationsNumber: 3,
     monitorType: 'clarity',
     tokenType: 'ETHEREUM_ARBONE_ERC20',
   },
   ethereumarbone: {
-    chainId: 42161,
+    chainId: 42_161,
     serverUrl: 'https://arbitrum-one-clarity.a.exodus.io',
     confirmationsNumber: 3,
     monitorType: 'clarity',
@@ -93,7 +93,7 @@ const CHAIN_DATA = {
     tokenType: 'FLR_ERC20',
   },
   aurora: {
-    chainId: 1313161554,
+    chainId: 1_313_161_554,
     serverUrl: 'https://aurora.a.exodus.io',
     confirmationsNumber: 3,
     monitorType: 'no-history',

package/src/encode.js

@@ -18,8 +18,7 @@ export function validate(address, { baseAssetName } = {}) {
 }
 
 export function hasChecksum(address) {
-  if (/^0x[0-9A-F]{40}$/.test(address) || /^0x[0-9a-f]{40}$/.test(address)) return false
-  return true
+  return !(/^0x[\dA-F]{40}$/.test(address) || /^0x[\da-f]{40}$/.test(address))
 }
 
 export function encodePrivate(privKey) {
@@ -40,10 +39,7 @@ export function encodePublic(compressedPubKey, { baseAssetName } = {}) {
 }
 
 export function isValidPrivate(privateKey) {
-  if (privateKey.length !== 32 || !etherUtil.isValidPrivate(privateKey)) {
-    return false
-  }
-  return true
+  return !(privateKey.length !== 32 || !etherUtil.isValidPrivate(privateKey))
 }
 
 export function encodePublicFromPrivate(privateKey, { baseAssetName } = {}) {

package/src/fee-monitor/ethereum-like.js

@@ -18,7 +18,7 @@ export default class EthereumLikeFeeMonitor extends FeeMonitor {
     let gasPrice = parseInt(await this.getGasPrice(), 16)
 
     if (!Number.isFinite(gasPrice)) {
-      throw new Error(`Invalid gas price: ${gasPrice}`)
+      throw new TypeError(`Invalid gas price: ${gasPrice}`)
     }
 
     if (gasPrice < this.minGasPrice) {

package/src/index.js

@@ -1,9 +1,3 @@
-import createContract from './create-contract'
-import ABI from './abi'
-import * as feeData from './fee-data'
-
-export { createContract, ABI, feeData }
-
 export * from './balances'
 export * from './encode'
 export * from './unsigned-tx'
@@ -13,3 +7,7 @@ export * from './fee-monitor'
 export * from './selectors'
 export { default as createGetKeyIdentifier } from './key-identifier'
 export { default as createEthereumLikeAccountState } from './account-state'
+
+export { default as createContract } from './create-contract'
+export * as feeData from './fee-data'
+export { default as ABI } from './abi'

package/src/key-identifier.js

@@ -3,44 +3,41 @@ import { createGetKeyIdentifier, unhardenDerivationIndex } from '@exodus/key-uti
 
 const HARDWARE_WALLETS = new Set(['ledger', 'trezor'])
 
-const createEthereumGetKeyIdentifier = ({
-  bip44,
-  assetName,
-  keyType = 'secp256k1',
-  allowMetaMaskCompat = false,
-} = {}) => (partialParams = {}) => {
-  const params = {
-    purpose: 44,
-    chainIndex: 0,
-    accountIndex: 0,
-    addressIndex: 0,
-    ...partialParams,
-  }
+const createEthereumGetKeyIdentifier =
+  ({ bip44, assetName, keyType = 'secp256k1', allowMetaMaskCompat = false } = {}) =>
+  (partialParams = {}) => {
+    const params = {
+      purpose: 44,
+      chainIndex: 0,
+      accountIndex: 0,
+      addressIndex: 0,
+      ...partialParams,
+    }
+
+    const { accountIndex, addressIndex, compatibilityMode } = params
+    const isHardwareWallet = HARDWARE_WALLETS.has(compatibilityMode)
+    const unhardenedBip44 = unhardenDerivationIndex(bip44)
+    const isMetaMask = allowMetaMaskCompat && compatibilityMode === 'metamask'
 
-  const { accountIndex, addressIndex, compatibilityMode } = params
-  const isHardwareWallet = HARDWARE_WALLETS.has(compatibilityMode)
-  const unhardenedBip44 = unhardenDerivationIndex(bip44)
-  const isMetaMask = allowMetaMaskCompat && compatibilityMode === 'metamask'
+    if (isMetaMask) {
+      assert(addressIndex === 0, 'MetaMask compatibility does not support setting an addressIndex')
+      return {
+        assetName,
+        derivationAlgorithm: 'BIP32',
+        derivationPath: `m/44'/${unhardenedBip44}'/0'/0/${accountIndex}`,
+        keyType,
+      }
+    }
 
-  if (isMetaMask) {
-    assert(addressIndex === 0, 'MetaMask compatibility does not support setting an addressIndex')
-    return {
+    return createGetKeyIdentifier({
+      bip44,
       assetName,
-      derivationAlgorithm: 'BIP32',
-      derivationPath: `m/44'/${unhardenedBip44}'/0'/0/${accountIndex}`,
       keyType,
-    }
+      validationRules: {
+        allowMultipleAddresses: true,
+        allowXPUB: isHardwareWallet,
+      },
+    })(params)
   }
 
-  return createGetKeyIdentifier({
-    bip44,
-    assetName,
-    keyType,
-    validationRules: {
-      allowMultipleAddresses: true,
-      allowXPUB: isHardwareWallet,
-    },
-  })(params)
-}
-
 export default createEthereumGetKeyIdentifier

package/src/selectors/get-can-accelerate-tx-factory.js

@@ -51,6 +51,7 @@ function isQueuedPendingTx(tx, baseAssetName, activeWalletAccount, getTxLog) {
   if (isQueuedPendingTx.minIndex >= 0 && txAtMinIndex && txAtMinIndex.pending) {
     return tx.data && tx.data.nonce > txAtMinIndex.data.nonce
   }
+
   let minPendingNonce = Number.MAX_SAFE_INTEGER
   for (let index = 0; index < txLog.size; index++) {
     const _tx = txLog.getAt(index)
@@ -128,9 +129,11 @@ export const canAccelerateTx = ({
   if (isQueuedPendingTx(tx, baseAssetName, activeWalletAccount, getTxLog))
     return wrapResponseToObject({ errorMessage: 'there is a stuck TX with lower nonce' })
 
-  const { gasPrice: currentGasPrice, gasPriceEconomicalRate, eip1559Enabled } = getFeeData(
-    assetName
-  )
+  const {
+    gasPrice: currentGasPrice,
+    gasPriceEconomicalRate,
+    eip1559Enabled,
+  } = getFeeData(assetName)
 
   if (calculateTxGasPrice(tx).gte(currentGasPrice.mul(gasPriceEconomicalRate)))
     return wrapResponseToObject({ errorMessage: 'the used gas price is still high enough' })
@@ -149,7 +152,7 @@ export const canAccelerateTx = ({
   return wrapResponseToObject({ bumpType: BumpType.RBF })
 }
 
-export default (
+const getCanAccelerateTxFactory = (
   getFeeDataSelector,
   getFeeSelector,
   activeWalletAccountSelector,
@@ -180,17 +183,20 @@ export default (
       getTxLog,
       getIsExchangeTx,
       assets
-    ) => (tx) =>
-      canAccelerateTx({
-        tx,
-        assets,
-        getFeeData,
-        getFee,
-        activeWalletAccount,
-        getPersonalNoteByTxId,
-        getIsRbfEnabled,
-        getIsEnoughBalanceToAccelerate,
-        getTxLog,
-        getIsExchangeTx,
-      })
+    ) =>
+      (tx) =>
+        canAccelerateTx({
+          tx,
+          assets,
+          getFeeData,
+          getFee,
+          activeWalletAccount,
+          getPersonalNoteByTxId,
+          getIsRbfEnabled,
+          getIsEnoughBalanceToAccelerate,
+          getTxLog,
+          getIsExchangeTx,
+        })
   )
+
+export default getCanAccelerateTxFactory

package/src/selectors/get-is-enough-balance-to-accelerate-factory.js

@@ -4,21 +4,23 @@ export const isEnoughBalanceToAccelerate = (totalBalance, unconfirmedBalance, ex
   return totalBalance.sub(unconfirmedBalance).gte(extraEthNeeded)
 }
 
-export default (getWalletAccountBalancesSelector, getUnconfirmedEthereumBalanceSelector) =>
+const getIsEnoughBalanceToAccelerateFactory = (
+  getWalletAccountBalancesSelector,
+  getUnconfirmedEthereumBalanceSelector
+) =>
   createSelector(
     getWalletAccountBalancesSelector,
     getUnconfirmedEthereumBalanceSelector,
-    (getWalletAccountBalances, getUnconfirmedEthereumBalance) => (
-      walletAccount,
-      assetName,
-      extraEthNeeded
-    ) => {
-      const totalBalance = getWalletAccountBalances(walletAccount)[assetName]
-      const unconfirmedBalance = getUnconfirmedEthereumBalance({
-        asset: assetName,
-        walletAccount,
-      })
+    (getWalletAccountBalances, getUnconfirmedEthereumBalance) =>
+      (walletAccount, assetName, extraEthNeeded) => {
+        const totalBalance = getWalletAccountBalances(walletAccount)[assetName]
+        const unconfirmedBalance = getUnconfirmedEthereumBalance({
+          asset: assetName,
+          walletAccount,
+        })
 
-      return isEnoughBalanceToAccelerate(totalBalance, unconfirmedBalance, extraEthNeeded)
-    }
+        return isEnoughBalanceToAccelerate(totalBalance, unconfirmedBalance, extraEthNeeded)
+      }
   )
+
+export default getIsEnoughBalanceToAccelerateFactory

package/src/unsigned-tx/create-ethereumjs-tx.js

@@ -31,8 +31,8 @@ export default function createEthereumJsTx(unsignedTx) {
         ),
       }
     )
-  } else {
-    // Legacy tx
-    return Transaction.fromTxData(txData, { common: Common.custom({ chainId }) })
   }
+
+  // Legacy tx
+  return Transaction.fromTxData(txData, { common: Common.custom({ chainId }) })
 }

package/src/unsigned-tx/index.js

@@ -1,6 +1,6 @@
 export { default as createUnsignedTx } from './create-unsigned-tx'
 export { default as parseUnsignedTx } from './parse-unsigned-tx'
-export { default as signUnsignedTx } from './sign-unsigned-tx'
+export { default as signUnsignedTx, signUnsignedTxWithSigner } from './sign-unsigned-tx'
 export { default as createAndSignTx } from './create-and-sign-tx'
 export { default as createEthereumJsTx } from './create-ethereumjs-tx'
 export { signHardwareFactory } from './sign-hardware'

package/src/unsigned-tx/sign-hardware.js

@@ -1,25 +1,23 @@
 import assert from 'minimalistic-assert'
 import createEthereumJsTx from './create-ethereumjs-tx'
 
-export const signHardwareFactory = ({ baseAssetName }) => async ({
-  unsignedTx,
-  hardwareDevice,
-  accountIndex,
-}) => {
-  const tx = createEthereumJsTx(unsignedTx)
+export const signHardwareFactory =
+  ({ baseAssetName }) =>
+  async ({ unsignedTx, hardwareDevice, accountIndex }) => {
+    const tx = createEthereumJsTx(unsignedTx)
 
-  const signedTx = await signWithHardwareWallet({
-    baseAssetName,
-    tx,
-    hardwareDevice,
-    accountIndex,
-  })
+    const signedTx = await signWithHardwareWallet({
+      baseAssetName,
+      tx,
+      hardwareDevice,
+      accountIndex,
+    })
 
-  // serialize and get txId
-  const rawTx = signedTx.serialize()
-  const txId = signedTx.hash().toString('hex')
-  return { rawTx, txId }
-}
+    // serialize and get txId
+    const rawTx = signedTx.serialize()
+    const txId = signedTx.hash().toString('hex')
+    return { rawTx, txId }
+  }
 
 async function signWithHardwareWallet({ baseAssetName, tx, hardwareDevice, accountIndex }) {
   const rlpEncodedTx = tx.serialize()
@@ -41,13 +39,10 @@ async function signWithHardwareWallet({ baseAssetName, tx, hardwareDevice, accou
   } else if (tx.common.chainId !== undefined) {
     // _processSignature for legacy transactions expects 27 or 28.
     // hardware wallets on the other hand already precomputed the final v (chainId * 2 + 35 + parity).
-    const diff = tx.common
-      .chainIdBN()
-      .muln(2)
-      .addn(8)
-      .toNumber()
+    const diff = tx.common.chainIdBN().muln(2).addn(8).toNumber()
     v -= diff
   }
+
   assert([27, 28].includes(v), `unexpected v-value, expected 27 or 28 but got ${v} `)
   const r = signature.slice(V_SIZE, V_SIZE + 32)
   const s = signature.slice(V_SIZE + 32, V_SIZE + 32 + 32)

package/src/unsigned-tx/sign-unsigned-tx.js

@@ -1,12 +1,32 @@
 import createEthereumJsTx from './create-ethereumjs-tx'
 
+function prepareRawTx(signedTx) {
+  // serialize and get txId
+  const rawTx = signedTx.serialize()
+  const txId = signedTx.hash().toString('hex')
+  return { rawTx, txId }
+}
+
+export async function signUnsignedTxWithSigner(unsignedTx, signer) {
+  const tx = createEthereumJsTx(unsignedTx)
+
+  const ethSigner = async (data) => {
+    const sig = await signer({ data, ecOptions: { canonical: true }, enc: 'raw' })
+    const signature = new Uint8Array(64)
+    signature.set(sig.r.toArrayLike(Uint8Array, 'be', 32), 0)
+    signature.set(sig.s.toArrayLike(Uint8Array, 'be', 32), 32)
+    return { signature, recid: sig.recoveryParam }
+  }
+
+  const signedTx = await tx.signWithSigner(ethSigner)
+
+  return prepareRawTx(signedTx)
+}
+
 export default function signUnsignedTx(unsignedTx, privateKey) {
   const tx = createEthereumJsTx(unsignedTx)
 
   const signedTx = tx.sign(privateKey)
 
-  // serialize and get txId
-  const rawTx = signedTx.serialize()
-  const txId = signedTx.hash().toString('hex')
-  return { rawTx, txId }
+  return prepareRawTx(signedTx)
 }

package/src/utils/calculate-extra-eth.js

@@ -2,14 +2,9 @@ const defaultMultiplier = 1.1
 
 // if a wallet has 0 ETH the deposit needed should be more than the fee needed by <multiplier>
 // if a wallet has <N> ETH, the deposit needed should be the fee * <multiplier> - <N>
-export default function({ fee, balance, multiplier = defaultMultiplier }) {
+export default function ({ fee, balance, multiplier = defaultMultiplier }) {
   if (typeof multiplier !== 'number' || multiplier < 1) multiplier = defaultMultiplier
   if (balance.gt(fee)) return balance.unitType.ZERO
 
-  return fee
-    .mul(multiplier)
-    .toDefault()
-    .sub(balance)
-    .toFixed(4, 'ceil')
-    .toString()
+  return fee.mul(multiplier).sub(balance).toDefault().toFixed(4, 'ceil').toString()
 }

package/src/utils/index.js

@@ -35,6 +35,7 @@ export const isEthereumLikeToken = (asset) => ETHEREUM_LIKE_TOKEN_TYPES.includes
 export const isEthereumLikeTokenByName = (assetName) => {
   throw new Error('Please use isEthereumLikeToken() instead')
 }
+
 export const isToken = isEthereumLikeToken
 
 // All ethereum-like assets (native coins)
@@ -55,7 +56,7 @@ export function buffer2currency({ asset, value }) {
 export function currency2buffer(value) {
   const b10Value = value.toBaseString()
 
-  // Desktop: const hexValue = value.toBase()._number.toString(16)
+  // Desktop: const hexValue = new BN(value.toBaseString()).toString(16)
   const hexValue = base16.encode(base10.decode(b10Value))
 
   if (hexValue.includes('.')) {
@@ -68,7 +69,7 @@ export function currency2buffer(value) {
 
 export function normalizeTxId(txId) {
   if (txId.startsWith('0x')) return txId
-  else return '0x' + txId
+  return '0x' + txId
 }
 
 // @deprecated