@exodus/web3-ethereum-utils 4.5.0 → 4.6.0

package/lib/createSimulateTransactions.js

@@ -4,19 +4,39 @@ import { simulateTransactions } from './simulation/simulateTransactions.js';
 import { tryEstimatingChangesLocally } from './simulation/tryEstimatingChangesLocally.js';
 import { decodeRecipientAddresses, getDisplayDetails, getTxFeeDetails } from './transactions.js';
 export const createSimulateTransactions = ({ apiEndpoint, headers }) => async ({ transactions, asset, origin, overrideApiEndpoint, }) => {
-    // Ethereum transactions from web3 providers are always one item in an array.
-    const transaction = transactions[0];
     const simulationResult = createEmptySimulationResult({
         asset,
     });
-    simulationResult.balanceChanges.willPayFee.push({
-        balance: estimateFee({ asset, transaction }),
-        feeDetails: getTxFeeDetails(transaction),
-    });
-    if (!transaction.to) {
+    if (transactions.length === 0) {
+        const message = 'No transactions provided. Cannot simulate transaction batch.';
+        simulationResult.warnings.push({ kind: 'INTERNAL_ERROR', severity: 'HIGH', message });
+        simulationResult.metadata.humanReadableError = message;
+        return simulationResult;
+    }
+    // Ensure all transactions share the same "from" address
+    // Added this because simulateTransactions makes this assumption and would give us invalid results if it's not the case
+    // If we need this (which is unlikely) we can remove this check and update simulateTransactions to handle multiple from addresses
+    const firstFrom = transactions[0].from.toLowerCase();
+    const hasMismatchedFrom = transactions.some((tx) => tx.from.toLowerCase() !== firstFrom);
+    if (hasMismatchedFrom) {
+        const message = 'All transactions in a batch must have the same "from" address. Cannot simulate transaction batch.';
+        simulationResult.warnings.push({ kind: 'INTERNAL_ERROR', severity: 'HIGH', message });
+        // add human readable error
+        simulationResult.metadata.humanReadableError = message;
+        return simulationResult;
+    }
+    // Check if ALL transactions have a 'to' address - if any are missing, return early
+    // Transactions are linked, so if one is invalid, the entire batch is invalid
+    const hasInvalidTransaction = transactions.some(tx => !tx.to);
+    if (hasInvalidTransaction) {
+        const message = 'One or more transactions are missing required "to" address. Cannot simulate transaction batch.';
+        simulationResult.warnings.push({ kind: 'INTERNAL_ERROR', severity: 'HIGH', message });
+        simulationResult.metadata.humanReadableError = message;
         return simulationResult;
     }
+    // Fees are added only after a successful simulation (remote or local)
     simulationResult.recipientAddresses = transactions.map((tx) => decodeRecipientAddresses(tx));
+    // Mutates the simulationResult, simulationTransactionInternalResult is only for checking the kind of response
     const simulationTransactionInternalResult = await simulateTransactions({
         asset,
         transactions,
@@ -25,24 +45,48 @@ export const createSimulateTransactions = ({ apiEndpoint, headers }) => async ({
         simulationResult,
         headers,
     });
+    // Blowfish simulation failed, try local simulation
     if (simulationTransactionInternalResult.kind === 'error') {
+        if (transactions.length > 1) {
+            // For batched transactions, don't attempt local simulation
+            const message = 'Cannot locally simulate batched transactions.';
+            simulationResult.warnings.push({ kind: 'INTERNAL_ERROR', severity: 'HIGH', message });
+            simulationResult.metadata.humanReadableError = message;
+            return simulationResult;
+        }
+        // Local simulation also mutates the simulationResult, so we need to check if it was successful
         const simulatedLocally = tryEstimatingChangesLocally({
             asset,
             simulationResult,
-            transaction,
+            transaction: transactions[0],
         });
-        if (!simulatedLocally) {
-            simulationResult.warnings.push({
-                kind: 'INTERNAL_ERROR',
-                severity: 'HIGH',
-                message: 'Balance changes cannot be estimated.',
+        // If local simulation succeeded, add fee for the (single) transaction now
+        if (simulatedLocally) {
+            simulationResult.metadata.simulatedLocally = true;
+            const transaction = transactions[0];
+            simulationResult.balanceChanges.willPayFee.push({
+                balance: estimateFee({ asset, transaction }),
+                feeDetails: getTxFeeDetails(transaction),
             });
         }
+        else {
+            // Local Simulation also failed.
+            const message = 'Balance changes cannot be estimated.';
+            simulationResult.warnings.push({ kind: 'INTERNAL_ERROR', severity: 'HIGH', message });
+            simulationResult.metadata.humanReadableError = message;
+        }
         if (simulationTransactionInternalResult.errorMessage) {
             simulationResult.metadata.humanReadableError = simulationTransactionInternalResult.errorMessage;
         }
         return simulationResult;
     }
+    // Remote simulation succeeded; add fees for all transactions now
+    for (const transaction of transactions) {
+        simulationResult.balanceChanges.willPayFee.push({
+            balance: estimateFee({ asset, transaction }),
+            feeDetails: getTxFeeDetails(transaction),
+        });
+    }
     simulationResult.displayDetails = getDisplayDetails(simulationResult.balanceChanges.willApprove);
     return simulationResult;
 };

package/lib/signatures.js

@@ -1,7 +1,6 @@
-import { Common, Hardfork } from '@exodus/ethereumjs/common';
+import { getEthereumJsTxByTransactionProps } from '@exodus/ethereum-lib';
 import { SignTypedDataVersion, personalSign, signTypedData as ethSigUtilSignTypedData, } from '@exodus/ethereumjs/eth-sig-util';
-import { FeeMarketEIP1559Transaction, Transaction as LegacyTransaction, } from '@exodus/ethereumjs/tx';
-const custom = Common.default?.custom || Common.custom;
+import assert from 'minimalistic-assert';
 export function signMessage(message, privateKey) {
     return personalSign({ privateKey, data: message });
 }
@@ -9,15 +8,13 @@ export function signTypedData(typedData, privateKey, version = SignTypedDataVers
     return ethSigUtilSignTypedData({ privateKey, data: typedData, version });
 }
 export function signTransaction(transactionParams, privateKey) {
-    const { chainId, ...transactionData } = transactionParams;
-    const isEIP1559Enabled = !!transactionParams.maxFeePerGas;
-    const transaction = isEIP1559Enabled
-        ? FeeMarketEIP1559Transaction.fromTxData(transactionData, {
-            common: custom({ chainId }, { hardfork: Hardfork.London }),
-        })
-        : LegacyTransaction.fromTxData(transactionData, {
-            common: custom({ chainId }),
-        });
+    const { chainId, ...transactionProps } = transactionParams;
+    assert(typeof chainId === 'number', 'signTransaction must be explicitly passed a chainId');
+    const transaction = getEthereumJsTxByTransactionProps({
+        chainId,
+        eip1559Enabled: Boolean(transactionProps.maxFeePerGas),
+        transactionProps,
+    });
     const signedTransaction = transaction.sign(privateKey);
     return signedTransaction.serialize();
 }

package/lib/simulation/simulateTransactions.js

@@ -45,7 +45,7 @@ const handleExpectedBalanceChange = (expectedBalanceChange, simulationResult, {
     const isNftTransferApproval = kind === 'ERC721_APPROVAL' ||
         (kind === 'ERC721_APPROVAL_FOR_ALL' && !asset.decimals) ||
         (kind === 'ERC1155_APPROVAL_FOR_ALL' && !asset.decimals);
-    const decimals = isNftTransfer || isNftTransferApproval ? 0 : asset.decimals;
+    const decimals = isNftTransfer || isNftTransferApproval || !Number.isFinite(asset.decimals) ? 0 : asset.decimals;
     const asset_ = pick(asset, [
         'address',
         'imageUrl',
@@ -130,8 +130,11 @@ export const simulateTransactions = async ({ transactions, apiEndpoint, origin,
         return {
             kind: 'error',
             error: 2 /* SimulationErrorMessages.SimulationNotSupported */,
+            errorMessage: 'Simulation is not supported for this asset.',
         };
     }
+    //Only one user address is supported
+    //Sending multiple transactions with different from addresses would lead to invalid results
     const userAddress = transactions[0].from;
     const payload = convertTransactionToApiPayload(transactions, origin);
     if (!Object.hasOwnProperty.call(BLOWFISH_EVM_CHAINS, asset.name)) {
@@ -150,6 +153,7 @@ export const simulateTransactions = async ({ transactions, apiEndpoint, origin,
         return {
             kind: 'error',
             error: 0 /* SimulationErrorMessages.APICallFailed */,
+            errorMessage: 'Simulation API call failed.',
         };
     }
     simulationResult.metadata.simulatedLocally = false;

package/lib/transactions.d.ts

@@ -1,6 +1,10 @@
 import type { EthTransaction } from './types.js';
 import type { ApprovalBalanceChange } from '@exodus/web3-types';
-export declare function getTransactionId(serializedTransaction: Buffer, isEIP1559Transaction?: boolean): string;
+export declare function getTransactionId({ chainId, serializedTransaction, }: {
+    chainId: number;
+    serializedTransaction: Buffer;
+    eip1559Enabled?: boolean;
+}): string;
 export declare function getDisplayDetails(willApprove: ApprovalBalanceChange[]): {
     title: string;
 };

package/lib/transactions.js

@@ -1,10 +1,10 @@
-import { FeeMarketEIP1559Transaction, Transaction as LegacyTransaction, } from '@exodus/ethereumjs/tx';
+import { getEthereumJsTxByTransactionBuffer } from '@exodus/ethereum-lib';
 import SolidityContract from '@exodus/solidity-contract';
-export function getTransactionId(serializedTransaction, isEIP1559Transaction = false) {
-    const Transaction = isEIP1559Transaction
-        ? FeeMarketEIP1559Transaction
-        : LegacyTransaction;
-    const transaction = Transaction.fromSerializedTx(serializedTransaction);
+export function getTransactionId({ chainId, serializedTransaction, }) {
+    const transaction = getEthereumJsTxByTransactionBuffer({
+        chainId,
+        transactionBuffer: serializedTransaction,
+    });
     return `0x${transaction.hash().toString('hex')}`;
 }
 export function getDisplayDetails(willApprove) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/web3-ethereum-utils",
   "description": "Web3 Ethereum utils.",
-  "version": "4.5.0",
+  "version": "4.6.0",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -18,7 +18,8 @@
     "lib/**/*.js"
   ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": false
   },
   "repository": {
     "type": "git",
@@ -34,10 +35,11 @@
     "test": "run -T exodus-test --jest --esbuild"
   },
   "devDependencies": {
-    "@exodus/web3-types": "1.57.2"
+    "@exodus/web3-types": "1.59.0"
   },
   "dependencies": {
     "@exodus/basic-utils": "^3.0.1",
+    "@exodus/ethereum-lib": "^5.20.0",
     "@exodus/ethereumjs": "^1.5.0",
     "@exodus/solidity-contract": "^1.2.1",
     "@exodus/web3-utils": "^1.50.1",
@@ -48,5 +50,5 @@
     "url": "https://github.com/ExodusMovement/assets/issues?q=is%3Aissue+is%3Aopen+label%3Aweb3-ethereum-utils"
   },
   "homepage": "https://github.com/ExodusMovement/assets/tree/master/web3/web3-ethereum-utils",
-  "gitHead": "a703c06af7e51ff5810dc4feb397ef61639059fa"
+  "gitHead": "a15d8239871e44fd99d48a2b1a66606e2d428735"
 }