@exodus/web3-ethereum-utils 4.5.1 → 4.7.0

package/lib/createSimulateTransactions.d.ts

@@ -1,3 +1,3 @@
 import type { EthAggregatedTransactionSimulationResult, EthSimulateTransactionParams } from './types.js';
 import type { CreateSimulateTransactionsParams } from '@exodus/web3-types';
-export declare const createSimulateTransactions: ({ apiEndpoint, headers }: Required<CreateSimulateTransactionsParams>) => ({ transactions, asset, origin, overrideApiEndpoint, }: EthSimulateTransactionParams) => Promise<EthAggregatedTransactionSimulationResult>;
+export declare const createSimulateTransactions: ({ apiEndpoint, headers: headersFromDeps }: Required<CreateSimulateTransactionsParams>) => ({ transactions, asset, origin, headers: headersFromParams, overrideApiEndpoint, }: EthSimulateTransactionParams) => Promise<EthAggregatedTransactionSimulationResult>;

package/lib/createSimulateTransactions.js

@@ -3,20 +3,41 @@ import { estimateFee } from './simulation/estimateFee.js';
 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];
+export const createSimulateTransactions = ({ apiEndpoint, headers: headersFromDeps }) => async ({ transactions, asset, origin, headers: headersFromParams, overrideApiEndpoint, }) => {
+    const headers = { ...headersFromDeps, ...headersFromParams };
     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 +46,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/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/types.d.ts

@@ -46,6 +46,7 @@ export interface EthWalletWatchAsset {
 }
 export interface EthSimulateTransactionParams extends SimulateTransactionParams {
     transactions: EthTransaction[];
+    headers?: Record<string, string>;
 }
 export interface EthFeeDetails {
     gasLimit: BN;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/web3-ethereum-utils",
   "description": "Web3 Ethereum utils.",
-  "version": "4.5.1",
+  "version": "4.7.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",
@@ -38,7 +39,7 @@
   },
   "dependencies": {
     "@exodus/basic-utils": "^3.0.1",
-    "@exodus/ethereum-lib": "^5.18.1",
+    "@exodus/ethereum-lib": "^5.20.0",
     "@exodus/ethereumjs": "^1.5.0",
     "@exodus/solidity-contract": "^1.2.1",
     "@exodus/web3-utils": "^1.50.1",
@@ -49,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": "f6ea2714c95f2e7ec71ffecdc589726b7974511e"
+  "gitHead": "600b3f3f510e30333080011e85958f71835e020c"
 }