@exodus/web3-ethereum-utils 3.37.0 → 3.38.0

package/lib/createSimulateTransactions.js

@@ -24,10 +24,19 @@ export const createSimulateTransactions = ({ apiEndpoint, headers }) => async ({
         simulationResult,
         headers,
     });
-    if (simulationTransactionInternalResult.kind === 'error' &&
-        simulationTransactionInternalResult.error ===
-            0 /* SimulationErrorMessages.SimulationNotSupported */) {
-        tryEstimatingChangesLocally({ asset, simulationResult, transaction });
+    if (simulationTransactionInternalResult.kind === 'error') {
+        const simulatedLocally = tryEstimatingChangesLocally({
+            asset,
+            simulationResult,
+            transaction,
+        });
+        if (!simulatedLocally) {
+            simulationResult.warnings.push({
+                kind: 'INTERNAL_ERROR',
+                severity: 'HIGH',
+                message: 'Balance changes cannot be estimated.',
+            });
+        }
         return simulationResult;
     }
     simulationResult.displayDetails = getDisplayDetails(simulationResult.balanceChanges.willApprove);

package/lib/simulation/simulateTransactions.d.ts

@@ -5,7 +5,8 @@ declare type SimulateTransactionParams = Required<Pick<CreateSimulateTransaction
     headers?: Record<string, string>;
 };
 export declare const enum SimulationErrorMessages {
-    'SimulationNotSupported' = 0
+    'SimulationNotSupported' = 0,
+    'APICallFailed' = 1
 }
 export declare const simulateTransactions: ({ transactions, apiEndpoint, origin, simulationResult, headers, asset, }: SimulateTransactionParams) => SimulateTransactionsInternalResult<undefined, SimulationErrorMessages>;
 export {};

package/lib/simulation/simulateTransactions.js

@@ -53,7 +53,11 @@ const handleExpectedBalanceChange = (expectedBalanceChange, simulationResult, {
     ]);
     // According to the Blowfish docs, `symbol` and `name` can be null as they are not required by the standard.
     // Using `NFT` as a fallback ensures a user sees a meaningful UI in that case.
-    const symbol = asset.symbol || asset.name || 'NFT';
+    let symbol = asset.symbol || asset.name || 'NFT';
+    // TODO: remove this once Blowfish completes their migration from Matic to POL.
+    if (network === 'polygon' && asset.symbol === 'MATIC') {
+        symbol = 'POL';
+    }
     if (isNftTransfer || isNftTransferApproval) {
         asset_.imageUrl = data?.metadata?.rawImageUrl;
     }
@@ -141,7 +145,10 @@ export const simulateTransactions = async ({ transactions, apiEndpoint, origin,
         headers,
     });
     if (!response) {
-        return successDefaultResult;
+        return {
+            kind: 'error',
+            error: 1 /* SimulationErrorMessages.APICallFailed */,
+        };
     }
     simulationResult.metadata.simulatedLocally = false;
     const { expectedStateChanges = {}, error } = response.simulationResults.aggregated;

package/lib/simulation/tryEstimatingChangesLocally.d.ts

@@ -4,4 +4,4 @@ export declare const tryEstimatingChangesLocally: ({ asset, simulationResult, tr
     asset: Asset;
     simulationResult: EthAggregatedTransactionSimulationResult;
     transaction: EthTransaction;
-}) => void;
+}) => boolean;

package/lib/simulation/tryEstimatingChangesLocally.js

@@ -3,6 +3,7 @@ import { getCreateCurrencyParams } from './common.js';
 import { estimateSimpleTransfer, NotSimpleTransferError, } from './estimateSimpleTransfer.js';
 /*
  Mutates the provided 'simulationResult' adding a 'willSend' entry if the transaction is a simple transfer.
+ The function also returns a boolean indicating whether the local simulation was possible (e.g., if any balance changes were made).
  */
 export const tryEstimatingChangesLocally = ({ asset, simulationResult, transaction, }) => {
     try {
@@ -13,11 +14,13 @@ export const tryEstimatingChangesLocally = ({ asset, simulationResult, transacti
         simulationResult.balanceChanges.willSend.push({
             balance: actualTransferValue,
         });
+        return true;
     }
     catch (err) {
         const expectedError = err instanceof NotSimpleTransferError;
         if (!expectedError) {
             // ToDo: accept a logger dep and log an error here
         }
+        return false;
     }
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/web3-ethereum-utils",
   "description": "Web3 Ethereum utils.",
-  "version": "3.37.0",
+  "version": "3.38.0",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -36,5 +36,5 @@
     "@exodus/web3-utils": "^1.48.2",
     "@metamask/eth-sig-util": "^4.0.1"
   },
-  "gitHead": "7f05caccbeec6ffb7785e6c404fe5a1141764706"
+  "gitHead": "212dd8249e074525316708335355fda305aa691f"
 }