@exodus/ethereum-lib 5.10.1 → 5.11.0

package/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.11.0](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-lib@5.10.2...@exodus/ethereum-lib@5.11.0) (2025-05-29)
+
+
+### Features
+
+
+* feat: import eth-sig-util sign-typed-data, with fixes (#5716)
+
+* feat: unify ethereum signMessage with signMessageWithSigner (#5709)
+
+
+
+## [5.10.2](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-lib@5.10.1...@exodus/ethereum-lib@5.10.2) (2025-04-29)
+
+**Note:** Version bump only for package @exodus/ethereum-lib
+
+
+
+
+
 ## [5.10.1](https://github.com/ExodusMovement/assets/compare/@exodus/ethereum-lib@5.10.0...@exodus/ethereum-lib@5.10.1) (2025-04-15)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-lib",
-  "version": "5.10.1",
+  "version": "5.11.0",
   "description": "Ethereum utils, such as for cryptography, address encoding/decoding, transaction building, etc.",
   "type": "module",
   "main": "src/index.js",
@@ -22,12 +22,12 @@
   },
   "dependencies": {
     "@exodus/basic-utils": "^3.0.1",
+    "@exodus/crypto": "^1.0.0-rc.18",
     "@exodus/currency": "^6.0.1",
-    "@exodus/ethereumjs": "^1.2.0",
+    "@exodus/ethereumjs": "^1.5.0",
     "@exodus/key-utils": "^3.7.0",
     "@exodus/models": "^12.0.1",
     "@exodus/solidity-contract": "^1.1.3",
-    "@metamask/eth-sig-util": "^4.0.1",
     "base-x": "^3.0.2",
     "lodash": "^4.17.15",
     "minimalistic-assert": "^1.0.1",
@@ -38,7 +38,6 @@
     "@exodus/assets": "^11.0.0",
     "@exodus/bitcoin-meta": "^2.0.0",
     "@exodus/bsc-meta": "^2.0.0",
-    "@exodus/crypto": "^1.0.0-rc.13",
     "@exodus/ethereum-meta": "^2.5.0",
     "@exodus/ethereumclassic-meta": "^2.0.0",
     "@exodus/fantommainnet-meta": "^2.0.0",
@@ -51,5 +50,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "ecb4bcc6088186f382a07550df989646486b1ca6"
+  "gitHead": "45be970be70f9211b8a6489566c352f4caeb82dc"
 }

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

@@ -11,5 +11,6 @@ export const ethStakeAccountState = ({ currency }) => {
     pendingDepositedBalance: currency.ZERO,
     totalRewardsReceived: currency.ZERO,
     lastStakingTxProcessed: '',
+    activeStakedBalance: currency.ZERO,
   }
 }

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

@@ -1,3 +1,4 @@
+import assert from 'minimalistic-assert'
 import ms from 'ms'
 import { createSelector } from 'reselect'
 
@@ -85,20 +86,136 @@ const wrapResponseToObject = ({ bumpType = BumpType.NONE, errorMessage = null }
 
 const calculateTxGasPrice = (tx) => tx.feeAmount.div(tx.data.gasLimit)
 
-export const calculateBumpedGasPrice = ({ baseAsset, tx, currentGasPrice, eip1559Enabled }) => {
-  const usedGasPrice = calculateTxGasPrice(tx)
-  const gasPrice = currentGasPrice.gt(usedGasPrice) ? currentGasPrice : usedGasPrice
-  const bumpedGasPrice = gasPrice.mul(BUMP_RATE)
-
-  return eip1559Enabled && tx.data?.tipGasPrice
-    ? {
-        bumpedTipGasPrice: baseAsset.currency
-          .baseUnit(tx.data.tipGasPrice)
-          .to('Gwei')
-          .mul(BUMP_RATE),
-        bumpedGasPrice,
-      }
-    : { bumpedGasPrice }
+const calculateBumpedGasPriceNonEip1559 = ({ currentGasPrice, prevMaxFeePerGas }) => {
+  assert(currentGasPrice, 'currentGasPrice is required')
+  assert(prevMaxFeePerGas, 'prevMaxFeePerGas is required')
+
+  // Pick the largest between the network's `currentGasPrice`
+  // and the maximum `gasPrice` the previous transaction was
+  // willing to send at.
+  const nextGasPrice = currentGasPrice.gt(prevMaxFeePerGas) ? currentGasPrice : prevMaxFeePerGas
+
+  // Suggest using an amplified `gasPrice`.
+  return {
+    bumpedGasPrice: nextGasPrice.mul(BUMP_RATE),
+  }
+}
+
+const getLinearIncentiveBumpForEip1559Transaction = ({
+  currentBaseFeePerGas,
+  prevMaxFeePerGas,
+  prevMaxPriorityFeePerGas,
+}) => {
+  assert(currentBaseFeePerGas, 'currentBaseFeePerGas is required')
+  assert(prevMaxFeePerGas, 'prevMaxFeePerGas is required')
+  assert(prevMaxPriorityFeePerGas, 'prevMaxPriorityFeePerGas is required')
+
+  // First, let's determine if there's a bump required just to bring
+  // the transaction up to the `baseFeePerGas`. If the current base
+  // fee is larger, we'll need to see how much to adjust the overall
+  // transaction by.
+  const increaseToBaseFeePerGasTipGasPrice = currentBaseFeePerGas.gt(prevMaxFeePerGas)
+    ? currentBaseFeePerGas.sub(prevMaxFeePerGas)
+    : currentBaseFeePerGas.sub(currentBaseFeePerGas) // TODO: What is a nice way to get ZERO without an `asset`? Is it `currentBaseFeePerGas.ZERO`?
+
+  // The new `bumpedTipGasPrice`.
+  const bumpedTipGasPrice = prevMaxPriorityFeePerGas
+    .mul(BUMP_RATE)
+    .add(increaseToBaseFeePerGasTipGasPrice)
+
+  // We'll make attempt a linear increase of the transaction pricing. By
+  // increasing the `tipGasPrice` and the `gasPrice` by the same amount,
+  // we ensuret he any additional amount we spend (over the basefee) goes
+  // directly to the miner, thereby increasing transaction incentive.
+  return {
+    bumpedGasPrice: prevMaxFeePerGas
+      .sub(prevMaxPriorityFeePerGas) // Removes the previous `tipGasPrice` before adding the next one (`bumpedTipGasPrice` is inclusive).
+      .add(bumpedTipGasPrice),
+    bumpedTipGasPrice,
+  }
+}
+
+const calculateBumpedGasPriceEip1559 = ({
+  currentBaseFeePerGas,
+  prevMaxFeePerGas,
+  prevMaxPriorityFeePerGas,
+}) => {
+  assert(currentBaseFeePerGas, 'currentBaseFeePerGas is required')
+  assert(prevMaxFeePerGas, 'prevMaxFeePerGas is required')
+
+  // If the previous transaction didn't define a `tipGasPrice`, we
+  // can use this value directly.
+  if (!prevMaxPriorityFeePerGas || prevMaxPriorityFeePerGas.isZero) {
+    // We can determine the intended transaction bump using
+    // pre EIP-1559 logic, where we compare the `currentBaseFeePerGas`
+    // (i.e. the network gas price without a miner incentive) versus
+    // the `currentMaxFeePerGas` (which we can the previous `gasPrice`
+    // for the transaction). In this regard, the logic of finding the
+    // `bumpedGasPrice` to increase to is identical.
+    const { bumpedGasPrice } = calculateBumpedGasPriceNonEip1559({
+      currentGasPrice: currentBaseFeePerGas,
+      prevMaxFeePerGas,
+    })
+
+    assert(bumpedGasPrice >= currentBaseFeePerGas, 'bumpedGasPrice must be >= currentBaseFeePerGas')
+
+    // Since `calculateBumpedGasPriceNonEip1559` will guarantee that
+    // the returned `bumpedGasPrice` will be greater than the
+    // `currentBaseFeePerGas` (and the `currentMaxFeePerGas`), we can
+    // use their difference to deterime the equivalent `bumpTipGasPrice`.
+    const bumpedTipGasPrice = bumpedGasPrice.sub(currentBaseFeePerGas)
+
+    return {
+      bumpedGasPrice: currentBaseFeePerGas.add(bumpedTipGasPrice),
+      bumpedTipGasPrice,
+    }
+  }
+
+  // Else, let's make a linear increase to the transaction tip. This
+  // increase should ensure that:
+  // 1. The `prevMaxPriorityFeePerGas` is multiplied by the `BUMP_RATE`.
+  // 2. The returned `bumpedGasPrice` is sufficient for the
+  //    `currentBaseFeePerGas`.
+  return getLinearIncentiveBumpForEip1559Transaction({
+    currentBaseFeePerGas,
+    prevMaxFeePerGas,
+    prevMaxPriorityFeePerGas,
+  })
+}
+
+export const calculateBumpedGasPrice = ({
+  baseAsset,
+  tx,
+  currentBaseFee,
+  currentGasPrice,
+  eip1559Enabled,
+}) => {
+  // Determine the transaction we intend to override's
+  // `maxFeePerGas` (for pre-EIP-1559 networks, this is the
+  // `gasPrice` of the previous transaction).
+  const prevMaxFeePerGas = calculateTxGasPrice(tx)
+
+  if (!eip1559Enabled)
+    return calculateBumpedGasPriceNonEip1559({
+      currentGasPrice,
+      prevMaxFeePerGas,
+    })
+
+  if (!currentBaseFee) {
+    // NOTE: This can result in differences between predicted and realized fees.
+    currentBaseFee = currentGasPrice
+  }
+
+  const prevMaxPriorityFeePerGas = tx.data?.tipGasPrice
+    ? baseAsset.currency.baseUnit(tx.data.tipGasPrice)
+    : null
+
+  return calculateBumpedGasPriceEip1559({
+    baseAsset,
+    currentBaseFeePerGas: currentBaseFee,
+    prevMaxPriorityFeePerGas,
+    prevMaxFeePerGas,
+  })
 }
 
 export const canAccelerateTx = ({
@@ -130,19 +247,23 @@ export const canAccelerateTx = ({
   if (isQueuedPendingTx(tx, baseAssetName, activeWalletAccount, getTxLog))
     return wrapResponseToObject({ errorMessage: 'there is a stuck TX with lower nonce' })
 
-  const { gasPrice: currentGasPrice, eip1559Enabled } = getFeeData(assetName)
-
-  if (calculateTxGasPrice(tx).gte(currentGasPrice))
-    return wrapResponseToObject({ errorMessage: 'the used gas price is still high enough' })
+  const {
+    gasPrice: currentGasPrice,
+    eip1559Enabled,
+    baseFeePerGas: currentBaseFee,
+  } = getFeeData(assetName)
 
   const { bumpedGasPrice: gasPriceToUse } = calculateBumpedGasPrice({
     baseAsset,
     tx,
     currentGasPrice,
+    currentBaseFee,
     eip1559Enabled,
   })
   const replacementFee = gasPriceToUse.mul(tx.data.gasLimit)
+
   const extraEthNeeded = replacementFee.sub(tx.feeAmount)
+
   if (!getIsEnoughBalanceToAccelerate(activeWalletAccount, baseAssetName, extraEthNeeded))
     return wrapResponseToObject({ errorMessage: 'insufficient funds' })
 

package/src/sign-message.js

@@ -1,11 +1,10 @@
-import { hashPersonalMessage } from '@exodus/ethereumjs/util'
+import { ecdsaSignHash } from '@exodus/crypto/secp256k1'
 import {
-  personalSign,
-  signTypedData,
   SignTypedDataVersion,
   TypedDataUtils,
   typedSignatureHash,
-} from '@metamask/eth-sig-util'
+} from '@exodus/ethereumjs/eth-sig-util'
+import { hashPersonalMessage } from '@exodus/ethereumjs/util'
 import assert from 'minimalistic-assert'
 
 import { normalizeRecoveryParam } from './utils/ecdsa.js'
@@ -19,41 +18,19 @@ function hex0xStringToBuffer(hex) {
   return Buffer.from(hexWithLeadingZeros, 'hex')
 }
 
-/**
- * Converts a buffer to the 0xhex encoded value
- * @param {Buffer} buf the buffer to convert to 0xHEXSTRING
- * @returns the hex-encoded value prepended with 0x
- */
-function bufferToHex0xString(buf) {
-  if (!Buffer.isBuffer(buf)) {
-    throw new TypeError('expected a buffer')
-  }
-
-  const hex = buf.toString('hex')
-
-  if (typeof hex !== 'string') {
-    throw new TypeError('expected hex string')
-  }
-
-  return '0x' + hex
-}
-
-export const signMessage = async ({ privateKey, message }) => {
-  const { rawMessage, EIP712Message } = message
-
-  // Exclusive OR (XOR)
-  assert(!!rawMessage !== !!EIP712Message, 'Need either rawMessage or EIP712Message')
-
-  if (rawMessage) {
-    return hex0xStringToBuffer(personalSign({ privateKey, data: bufferToHex0xString(rawMessage) }))
-  }
-
-  if (EIP712Message) {
-    const version = Array.isArray(EIP712Message) ? SignTypedDataVersion.V1 : SignTypedDataVersion.V4
-
-    return hex0xStringToBuffer(signTypedData({ privateKey, data: EIP712Message, version }))
-  }
-}
+export const signMessage = async ({ privateKey, message }) =>
+  signMessageWithSigner({
+    message,
+    signer: {
+      sign: async ({ data }) =>
+        ecdsaSignHash({
+          hash: data,
+          privateKey,
+          recovery: true,
+          extraEntropy: null, // TODO: can we flip this to true?
+        }),
+    },
+  })
 
 /**
  * @param {object} params