@exodus/ethereum-lib 2.7.4 → 2.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-lib",
-  "version": "2.7.4",
+  "version": "2.8.0",
   "description": "Ethereum Library",
   "main": "src/index.js",
   "author": "Exodus Movement, Inc.",
@@ -10,12 +10,13 @@
     "access": "restricted"
   },
   "dependencies": {
+    "@ethereumjs/common": "^2.3.1",
+    "@ethereumjs/tx": "^3.2.1",
     "@exodus/asset-lib": "^3.4.0",
     "@exodus/models": "^8.5.12",
     "@exodus/solidity-contract": "^0.1.3",
     "base-x": "^3.0.2",
-    "ethereumjs-tx": "^1.3.7",
-    "ethereumjs-util": "^5.2.0",
+    "ethereumjs-util": "^7.0.10",
     "lodash": "^4.17.15",
     "ms": "^2.1.1",
     "reselect": "~3.0.1"
@@ -23,5 +24,5 @@
   "peerDependencies": {
     "@exodus/assets": "8.0.x"
   },
-  "gitHead": "14b8266879ea622f272c94f98e71c1a16dd274f1"
+  "gitHead": "a9971be6cc00557bc1581c6801c90ae8702b4712"
 }

package/src/constants.js

@@ -1,9 +1,10 @@
-export const CHAIN_IDS = { ethereum: 1, ethereumclassic: 61, quorum: 10, bsc: 56 }
+export const CHAIN_IDS = { ethereum: 1, ethereumclassic: 61, bsc: 56 }
 export const MIN_GASPRICE = 1e9 // 1 gwei
 export const DEFAULT_FEE_MONITOR_INTERVAL = '1m'
 export const CONFIRMATIONS_NUMBER = {
   ethereum: 30,
   ethereumclassic: 5000,
-  quorum: 4,
   bsc: 15,
 }
+export const ETHEREUM_LIKE_ASSETS = ['bsc', 'ethereum', 'ethereumclassic']
+export const ETHEREUM_LIKE_TOKEN_TYPES = ['ETHEREUM_ERC20', 'BSC_BEP20']

package/src/encode.js

@@ -1,4 +1,4 @@
-import etherUtil from 'ethereumjs-util'
+import * as etherUtil from 'ethereumjs-util'
 
 export function validate(address) {
   if (typeof address !== 'string') return false
@@ -21,7 +21,7 @@ export function encodePrivate(privKey) {
 
 export function encodePublic(compressedPubKey) {
   const hash160bits = etherUtil.publicToAddress(compressedPubKey, true)
-  return etherUtil.toChecksumAddress(hash160bits.toString('hex'))
+  return etherUtil.toChecksumAddress('0x' + hash160bits.toString('hex'))
 }
 
 export function isValidPrivate(privateKey) {

package/src/fee-data/ethereum.js

@@ -10,6 +10,9 @@ export default new FeeData(
     gasPriceEconomicalRate: 0.7,
     gasPriceMinimumRate: 0.5,
     enableFeeDelegation: false,
+    tipGasPrice: '2 Gwei',
+    baseFeeMultiplier: 1.8,
+    eip1559Enabled: false,
   },
   'gasPrice',
   'ethereum'

package/src/fee-data/index.js

@@ -1,4 +1,3 @@
 export { default as ethereum } from './ethereum'
 export { default as ethereumclassic } from './ethereumclassic'
-export { default as quorum } from './quorum'
 export { default as bsc } from './bsc'

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

@@ -7,11 +7,15 @@ export default class EthereumLikeFeeMonitor extends FeeMonitor {
     interval = DEFAULT_FEE_MONITOR_INTERVAL,
     assetName,
     getGasPrice,
+    getBaseFee,
+    eip1559Enabled = false,
     minGasPrice = 0,
   }) {
     super({ updateFee, interval, assetName })
     this.getGasPrice = getGasPrice
     this.minGasPrice = minGasPrice
+    this.getBaseFee = getBaseFee
+    this.eip1559Enabled = eip1559Enabled
   }
 
   async fetchFee() {
@@ -25,8 +29,15 @@ export default class EthereumLikeFeeMonitor extends FeeMonitor {
       gasPrice = this.minGasPrice
     }
 
-    return {
-      gasPrice: `${gasPrice} wei`,
+    if (this.asset.name === 'ethereum' && this.eip1559Enabled) {
+      const baseFee = parseInt(await this.getBaseFee(), 16)
+      return {
+        gasPrice: `${gasPrice} wei`,
+        baseFee: `${baseFee} wei`,
+        eip1559Enabled: this.eip1559Enabled,
+      }
     }
+
+    return { gasPrice: `${gasPrice} wei` }
   }
 }

package/src/index.js

@@ -1,7 +1,9 @@
 import createContract from './create-contract'
 import ABI from './abi'
+import * as feeData from './fee-data'
+
+export { createContract, ABI, feeData }
 
-export { createContract, ABI }
 export * from './encode'
 export * from './unsigned-tx'
 export * from './utils'

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

@@ -1,5 +1,6 @@
 import { createSelector } from 'reselect'
 import ms from 'ms'
+import { isEthereumLike } from '../utils'
 
 const MINUTE = ms('1m')
 const BumpType = {
@@ -122,7 +123,7 @@ export default (
       const baseAssetName = assets[assetName].baseAsset.name
       if (!getIsRbfEnabled(assetName))
         return wrapResponseToObject({ errorMessage: 'rbf is disabled' })
-      if (!['ethereum', 'bsc'].includes(baseAssetName))
+      if (!isEthereumLike(assets[assetName]))
         return wrapResponseToObject({ errorMessage: `not an ETH/ERC20/BSC/BEP20 asset supplied` })
       if (!tx.pending || !tx.sent)
         return wrapResponseToObject({ errorMessage: 'can not bump a confirmed or received TX' })

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

@@ -1,4 +1,6 @@
-import ethUtil from 'ethereumjs-util'
+import { bufferToHex, privateToAddress, toBuffer } from 'ethereumjs-util'
+import { intToBuffer } from 'ethjs-util'
+
 import { isToken, currency2buffer } from '../utils'
 import { CHAIN_IDS } from '../constants'
 
@@ -11,13 +13,15 @@ export default function createUnsignedTx({
   nonce,
   txInput,
   gasLimit,
-  gasPrice,
+  gasPrice, // eip 1559: `maxFeePerGas`
+  tipGasPrice, // eip 1559: `maxPriorityPerGas`
   privateKey,
   fromAddress,
   chainId,
+  eip1559Enabled,
 }): UnsignedTransaction {
   if (txInput) {
-    txInput = ethUtil.toBuffer(txInput) // If txInput is already a Buffer, then it is passed through
+    txInput = toBuffer(txInput) // If txInput is already a Buffer, then it is passed through
   } else {
     txInput = Buffer.alloc(0)
   }
@@ -34,14 +38,15 @@ export default function createUnsignedTx({
   if (value.equals(Buffer.from([0]))) value = Buffer.alloc(0)
 
   if (!fromAddress) {
-    if (privateKey) fromAddress = ethUtil.bufferToHex(ethUtil.privateToAddress(privateKey))
+    if (privateKey) fromAddress = bufferToHex(privateToAddress(privateKey))
     else throw new Error('createTx: Must pass fromAddress or privateKey in options')
   }
 
   const txData = {
-    nonce: nonce === 0 ? Buffer.alloc(0) : ethUtil.intToBuffer(nonce), // mobile: { nonce: ethUtil.intToBuffer(nonce) }
-    gasPrice: currency2buffer(gasPrice.toBase()), // mobile: { gasPrice: currency2buffer(gasPrice) }
-    gasLimit: ethUtil.intToBuffer(gasLimit),
+    nonce: nonce === 0 ? Buffer.alloc(0) : intToBuffer(nonce),
+    gasPrice: currency2buffer(gasPrice.toBase()),
+    tipGasPrice: tipGasPrice ? currency2buffer(tipGasPrice.toBase()) : undefined,
+    gasLimit: intToBuffer(gasLimit),
     to,
     value,
     data: txInput,
@@ -53,6 +58,7 @@ export default function createUnsignedTx({
     // TODO: We should move away from putting the PK into txMeta, it is a bad practice. It is a potential PK exposure risk if the wrong PK gets included here.
     privateKey, // Used for importing private key
     fee: baseAsset.currency.baseUnit(gasPrice.toBase().toNumber() * gasLimit),
+    eip1559Enabled: !!eip1559Enabled,
   }
 
   return {

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

@@ -1,5 +1,6 @@
 /* @flow */
-import EthereumTx from 'ethereumjs-tx'
+import { Transaction, FeeMarketEIP1559Transaction } from '@ethereumjs/tx'
+import Common from '@ethereumjs/common'
 
 import type { UnsignedTransaction, SignedTransaction } from '@exodus/models/lib/types'
 
@@ -7,13 +8,38 @@ export default function signUnsignedTx(
   unsignedTx: UnsignedTransaction,
   privateKey: Buffer
 ): SignedTransaction {
-  const { txData } = unsignedTx
+  const {
+    txData: { gasPrice, tipGasPrice: maxPriorityFeePerGas, chainId: chain, ...txData },
+    txMeta: { eip1559Enabled },
+  } = unsignedTx
 
-  const tx = new EthereumTx(txData)
-  tx.sign(privateKey)
+  let tx
+  /*
+    To assemble an EIP 1559 tx,
+    both `tipGasPrice` and `eip` must have been set in the input object used to build `unsignedTx`.
+    Whether bsc will support EIP 1559 is unknown.
+    So we must prevent building accidentally an EIP1559 tx on bsc if tipGasPrice is set
+    `eip` will be set with s corresponding feature flag in the wallet
+  */
+  if (maxPriorityFeePerGas && eip1559Enabled) {
+    tx = FeeMarketEIP1559Transaction.fromTxData(
+      {
+        maxFeePerGas: gasPrice,
+        maxPriorityFeePerGas,
+        type: '0x02', // https://github.com/ethereumjs/ethereumjs-monorepo/tree/master/packages/tx#gas-fee-market-transactions-eip-1559,
+        ...txData,
+      },
+      { common: new Common({ chain, hardfork: 'london' }) }
+    )
+  } else {
+    // Legacy tx
+    tx = Transaction.fromTxData({ gasPrice, ...txData }, { common: new Common({ chain }) })
+  }
+
+  const signedTx = tx.sign(privateKey)
 
   // serialize and get txId
-  const rawTx = tx.serialize()
-  const txId = tx.hash().toString('hex')
+  const rawTx = signedTx.serialize()
+  const txId = signedTx.hash().toString('hex')
   return { rawTx, txId }
 }

package/src/utils/index.js

@@ -1,6 +1,7 @@
 import baseX from 'base-x'
 import * as ethUtil from 'ethereumjs-util'
 import assets from '@exodus/assets'
+import { ETHEREUM_LIKE_ASSETS, ETHEREUM_LIKE_TOKEN_TYPES } from '../constants'
 
 export { default as calculateExtraEth } from './calculate-extra-eth'
 
@@ -9,9 +10,13 @@ const base16 = baseX('0123456789abcdef')
 
 export const isEthereumToken = (asset) => asset.assetType === 'ETHEREUM_ERC20'
 export const isBscToken = (asset) => asset.assetType === 'BSC_BEP20'
-export const isQuorumToken = (asset) => asset.assetType === 'QUORUM_ERC20'
-export const isToken = (asset) =>
-  isEthereumToken(asset) || isBscToken(asset) || isQuorumToken(asset)
+// All ethereum-like tokens
+export const isEthereumLikeToken = (asset) => ETHEREUM_LIKE_TOKEN_TYPES.includes(asset.assetType)
+export const isToken = isEthereumLikeToken
+// All ethereum-like assets (native coins)
+export const isEthereumLikeAsset = (asset) => ETHEREUM_LIKE_ASSETS.includes(asset.name)
+// All ethereum-like assets and tokens
+export const isEthereumLike = (asset) => ETHEREUM_LIKE_ASSETS.includes(asset.baseAsset.name)
 
 export function buffer2currency({ asset, value }) {
   return asset.currency.baseUnit(base10.encode(value)).toDefault()
@@ -41,5 +46,5 @@ export function normalizeTxId(txId: string): string {
 
 export function getBaseAsset(asset) {
   console.log(`calling deprecated function getBaseAsset(${asset.name})`) // Apr. 9th 2021
-  return isEthereumToken(asset) ? assets.ethereum : isQuorumToken(asset) ? assets.quorum : asset
+  return isEthereumToken(asset) ? assets.ethereum : asset
 }

package/src/fee-data/quorum.js

@@ -1,11 +0,0 @@
-import { FeeData } from '@exodus/asset-lib'
-
-export default new FeeData(
-  {
-    gasPrice: '0 Gwei',
-    max: '0 Gwei',
-    min: '0 Gwei',
-  },
-  'gasPrice',
-  'quorum'
-)