@exodus/web3-ethereum-utils 3.29.1 → 3.31.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, shouldSimulate, }: EthSimulateTransactionParams) => Promise<EthAggregatedTransactionSimulationResult>;
+export declare const createSimulateTransactions: ({ apiEndpoint, headers }: Required<CreateSimulateTransactionsParams>) => ({ transactions, asset, origin, overrideApiEndpoint, }: EthSimulateTransactionParams) => Promise<EthAggregatedTransactionSimulationResult>;

package/lib/createSimulateTransactions.js

@@ -1,9 +1,9 @@
 import { createEmptySimulationResult } from '@exodus/web3-utils';
 import { estimateFee } from './simulation/estimateFee.js';
-import { simulateTransactions } from './simulation/simulateTransactions.js';
+import { simulateTransactions, } from './simulation/simulateTransactions.js';
 import { tryEstimatingChangesLocally } from './simulation/tryEstimatingChangesLocally.js';
 import { getDisplayDetails, getTxFeeDetails } from './transactions.js';
-export const createSimulateTransactions = ({ apiEndpoint, headers }) => async ({ transactions, asset, origin, overrideApiEndpoint, shouldSimulate = true, }) => {
+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({
@@ -16,18 +16,20 @@ export const createSimulateTransactions = ({ apiEndpoint, headers }) => async ({
     if (!transaction.to) {
         return simulationResult;
     }
-    if (!shouldSimulate) {
-        tryEstimatingChangesLocally({ asset, simulationResult, transaction });
-        return simulationResult;
-    }
-    await simulateTransactions({
+    const simulationTransactionInternalResult = await simulateTransactions({
+        asset,
         transactions,
         apiEndpoint: overrideApiEndpoint || apiEndpoint,
         origin,
         simulationResult,
         headers,
-        assetName: asset.name,
     });
+    if (simulationTransactionInternalResult.kind === 'error' &&
+        simulationTransactionInternalResult.error ===
+            0 /* SimulationErrorMessages.SimulationNotSupported */) {
+        tryEstimatingChangesLocally({ asset, simulationResult, transaction });
+        return simulationResult;
+    }
     simulationResult.displayDetails = getDisplayDetails(simulationResult.balanceChanges.willApprove);
     return simulationResult;
 };

package/lib/simulation/estimateSimpleTransfer.js

@@ -17,10 +17,6 @@ export const estimateSimpleTransfer = ({ asset, transaction, }) => {
     if (!['0x', null, undefined].includes(transaction.data)) {
         throw new NotSimpleTransferError('The transaction input should be empty ("0x").');
     }
-    // Simple transfers should consume 21.000 (constant) units of gas.
-    if (![undefined, '0x5208'].includes(transaction.gas)) {
-        throw new NotSimpleTransferError('The gas value must precisely be 21,000 units.');
-    }
     const txValue = hexToBN(transaction.value || '0x0').toString();
     return asset.currency.baseUnit(txValue);
 };

package/lib/simulation/simulateTransactions.d.ts

@@ -1,9 +1,11 @@
 import type { EthAggregatedTransactionSimulationResult, EthSimulateTransactionParams } from '../types.js';
-import type { CreateSimulateTransactionsParams } from '@exodus/web3-types';
-declare type SimulateTransactionParams = Required<Pick<CreateSimulateTransactionsParams, 'apiEndpoint'>> & Required<Pick<EthSimulateTransactionParams, 'transactions' | 'origin'>> & {
+import type { CreateSimulateTransactionsParams, SimulateTransactionsInternalResult } from '@exodus/web3-types';
+declare type SimulateTransactionParams = Required<Pick<CreateSimulateTransactionsParams, 'apiEndpoint'>> & Required<Pick<EthSimulateTransactionParams, 'asset' | 'transactions' | 'origin'>> & {
     simulationResult: EthAggregatedTransactionSimulationResult;
     headers?: Record<string, string>;
-    assetName: string;
 };
-export declare const simulateTransactions: ({ transactions, apiEndpoint, origin, simulationResult, headers, assetName, }: SimulateTransactionParams) => Promise<void>;
+export declare const enum SimulationErrorMessages {
+    'SimulationNotSupported' = 0
+}
+export declare const simulateTransactions: ({ transactions, apiEndpoint, origin, simulationResult, headers, asset, }: SimulateTransactionParams) => SimulateTransactionsInternalResult<undefined, SimulationErrorMessages>;
 export {};

package/lib/simulation/simulateTransactions.js

@@ -105,14 +105,24 @@ const simulationResultHasAssets = (expectedStateChanges) => {
     }
     return true;
 };
-export const simulateTransactions = async ({ transactions, apiEndpoint, origin, simulationResult, headers, assetName, }) => {
+export const simulateTransactions = async ({ transactions, apiEndpoint, origin, simulationResult, headers, asset, }) => {
+    const successDefaultResult = {
+        kind: 'success',
+        value: undefined,
+    };
+    if (!BLOWFISH_EVM_CHAINS[asset.name]) {
+        return {
+            kind: 'error',
+            error: 0 /* SimulationErrorMessages.SimulationNotSupported */,
+        };
+    }
     const userAddress = transactions[0].from;
     const payload = convertTransactionToApiPayload(transactions, origin);
-    if (!Object.hasOwnProperty.call(BLOWFISH_EVM_CHAINS, assetName)) {
+    if (!Object.hasOwnProperty.call(BLOWFISH_EVM_CHAINS, asset.name)) {
         // ToDo: accept a logger dep and log the error
-        return;
+        return successDefaultResult;
     }
-    const { network, chain } = BLOWFISH_EVM_CHAINS[assetName];
+    const { network, chain } = BLOWFISH_EVM_CHAINS[asset.name];
     const response = await makeSimulationAPICall({
         url: apiEndpoint,
         chain,
@@ -121,13 +131,25 @@ export const simulateTransactions = async ({ transactions, apiEndpoint, origin,
         headers,
     });
     if (!response) {
-        return;
+        return successDefaultResult;
     }
     const { expectedStateChanges = {}, error } = response.simulationResults.aggregated;
     if (error) {
         // ToDo: accept a logger dep and log the error
         // ToDo: consider pushing an error to the "warnings" list
-        return;
+        return successDefaultResult;
+    }
+    const noExpectedStateChangesDetected = Object.keys(expectedStateChanges).length === 0;
+    // This is a self-send transaction, adding a zero "transfer" so that the UI can display it.
+    if (noExpectedStateChangesDetected) {
+        simulationResult.balanceChanges.willSend.push({
+            balance: createCurrency({
+                amount: 0,
+                symbol: asset.displayTicker,
+                denominator: asset.currency.defaultUnit.power,
+            }),
+        });
+        return successDefaultResult;
     }
     const userExpectedChanges = Object.keys(expectedStateChanges).reduce((prev, address) => {
         if (userAddress.toLowerCase() !== address.toLowerCase()) {
@@ -141,9 +163,10 @@ export const simulateTransactions = async ({ transactions, apiEndpoint, origin,
     // Return and log if asset is not present in the expectedStateChanges
     if (!simulationResultHasAssets(userExpectedChanges)) {
         // ToDo: accept a logger dep and log the error
-        return;
+        return successDefaultResult;
     }
     userExpectedChanges.forEach((expectedChange) => {
         handleExpectedBalanceChange(expectedChange, simulationResult, { network });
     });
+    return successDefaultResult;
 };

package/lib/types.d.ts

@@ -46,7 +46,6 @@ export interface EthWalletWatchAsset {
 }
 export interface EthSimulateTransactionParams extends SimulateTransactionParams {
     transactions: EthTransaction[];
-    shouldSimulate?: boolean;
 }
 export interface EthFeeDetails {
     gasLimit: BN;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/web3-ethereum-utils",
   "description": "Web3 Ethereum utils.",
-  "version": "3.29.1",
+  "version": "3.31.0",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -36,5 +36,5 @@
     "@exodus/web3-utils": "^1.45.0",
     "@metamask/eth-sig-util": "^4.0.1"
   },
-  "gitHead": "c3ca91ffe762b459c3b42d9577eef90010cce56d"
+  "gitHead": "312f25a38096f8a1dcb9bfb7124d59e89d8be873"
 }