@exodus/web3-ethereum-utils 1.20.0 → 1.21.0

package/lib/createSimulateTransaction.d.ts

@@ -1,3 +1,3 @@
 import type { EthSimulateTransactionParams } from './types.js';
 import type { AggregatedTransactionSimulationResult, CreateSimulateTransactionParams } from '@exodus/web3-types';
-export declare const createSimulateTransaction: ({ serviceProvider, apiEndpoint, }: CreateSimulateTransactionParams) => ({ transaction, asset, shouldCallPreviewApi, }: EthSimulateTransactionParams) => Promise<AggregatedTransactionSimulationResult>;
+export declare const createSimulateTransaction: ({ serviceProvider, apiEndpoint, headers, }?: CreateSimulateTransactionParams) => ({ transaction, asset, shouldCallPreviewApi, origin, }: EthSimulateTransactionParams) => Promise<AggregatedTransactionSimulationResult>;

package/lib/createSimulateTransaction.js

@@ -1,10 +1,14 @@
 import { createEmptySimulationResult } from '@exodus/web3-utils';
 import { estimateFee } from './simulation/estimateFee.js';
+import { simulateTransaction } from './simulation/simulateTransaction.js';
 import { tryEstimatingChangesLocally } from './simulation/tryEstimatingChangesLocally.js';
 const SIMULATION_API_DEFAULT = 'https://simulation.a.exodus.io/simulate';
 const SERVICE_PROVIDER_DEFAULT = 'blowfish';
+const SIMULATION_HEADERS = {
+    'X-Api-Version': '2023-06-05',
+};
 /* eslint-disable @typescript-eslint/no-unused-vars */
-export const createSimulateTransaction = ({ serviceProvider = SERVICE_PROVIDER_DEFAULT, apiEndpoint = SIMULATION_API_DEFAULT, }) => async ({ transaction, asset, shouldCallPreviewApi = true, }) => {
+export const createSimulateTransaction = ({ serviceProvider = SERVICE_PROVIDER_DEFAULT, apiEndpoint = SIMULATION_API_DEFAULT, headers = SIMULATION_HEADERS, } = {}) => async ({ transaction, asset, shouldCallPreviewApi = true, origin, }) => {
     const simulationResult = createEmptySimulationResult({ asset });
     simulationResult.balanceChanges.willPayFee.push({
         balance: estimateFee({ asset, transaction }),
@@ -16,6 +20,12 @@ export const createSimulateTransaction = ({ serviceProvider = SERVICE_PROVIDER_D
         tryEstimatingChangesLocally({ asset, simulationResult, transaction });
         return simulationResult;
     }
-    // ToDo: finish with an actual simulation attempt
-    return createEmptySimulationResult({ asset });
+    await simulateTransaction({
+        transaction,
+        apiEndpoint,
+        origin,
+        simulationResult,
+        headers,
+    });
+    return simulationResult;
 };

package/lib/index.d.ts

@@ -2,3 +2,4 @@ export * from './addresses.js';
 export * from './signatures.js';
 export * from './transactions.js';
 export * from './types.js';
+export * from './createSimulateTransaction.js';

package/lib/index.js

@@ -2,3 +2,4 @@ export * from './addresses.js';
 export * from './signatures.js';
 export * from './transactions.js';
 export * from './types.js';
+export * from './createSimulateTransaction.js';

package/lib/simulation/simulateTransaction.d.ts

@@ -1,7 +1,8 @@
 import type { EthSimulateTransactionParams } from '../types.js';
 import type { AggregatedTransactionSimulationResult, CreateSimulateTransactionParams } from '@exodus/web3-types';
-declare type SimulateTransactionParams = Required<CreateSimulateTransactionParams> & Pick<EthSimulateTransactionParams, 'transaction' | 'origin'> & {
+declare type SimulateTransactionParams = Required<Pick<CreateSimulateTransactionParams, 'apiEndpoint'>> & Required<Pick<EthSimulateTransactionParams, 'transaction' | 'origin'>> & {
     simulationResult: AggregatedTransactionSimulationResult;
+    headers?: Record<string, string>;
 };
-export declare const simulateTransaction: ({ transaction, apiEndpoint, origin, simulationResult, }: SimulateTransactionParams) => Promise<void> | never;
+export declare const simulateTransaction: ({ transaction, apiEndpoint, origin, simulationResult, headers, }: SimulateTransactionParams) => Promise<void> | never;
 export {};

package/lib/simulation/simulateTransaction.js

@@ -4,12 +4,14 @@
  */
 import { createCurrency, makeSimulationAPICall } from '@exodus/web3-utils';
 const convertTransactionToApiPayload = (transaction, origin) => ({
-    txObject: {
-        from: transaction.from,
-        to: transaction.to,
-        data: transaction.data,
-        value: transaction.value,
-    },
+    txObjects: [
+        {
+            from: transaction.from,
+            to: transaction.to,
+            data: transaction.data,
+            value: transaction.value,
+        },
+    ],
     metadata: {
         origin,
     },
@@ -66,6 +68,8 @@ const handleExpectedBalanceChange = (expectedBalanceChange, simulationResult) =>
         };
     }
     if (balance.isNegative) {
+        // Convert to non-negative value.
+        balanceChange.balance = balanceChange.balance.negate();
         willReceive.push(balanceChange);
     }
     else {
@@ -82,13 +86,14 @@ const simulationResultHasAssets = (expectedStateChanges) => {
     }
     return true;
 };
-export const simulateTransaction = async ({ transaction, apiEndpoint, origin, simulationResult, }) => {
+export const simulateTransaction = async ({ transaction, apiEndpoint, origin, simulationResult, headers, }) => {
     const userAddress = transaction.from;
     const payload = convertTransactionToApiPayload(transaction, origin);
     const response = await makeSimulationAPICall({
         url: apiEndpoint,
         network: 'ethereum',
         payload,
+        headers,
     });
     const { expectedStateChanges = {}, error } = response.simulationResults.aggregated;
     if (error) {

package/lib/types.d.ts

@@ -47,5 +47,4 @@ export interface EthWalletWatchAsset {
 }
 export interface EthSimulateTransactionParams extends SimulateTransactionParams {
     transaction: EthTransaction;
-    shouldCallPreviewApi: boolean;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/web3-ethereum-utils",
   "description": "Web3 Ethereum utils.",
-  "version": "1.20.0",
+  "version": "1.21.0",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -26,13 +26,13 @@
     "build": "yarn clean && tsc"
   },
   "devDependencies": {
-    "@exodus/web3-types": "^1.25.0"
+    "@exodus/web3-types": "^1.26.0"
   },
   "dependencies": {
     "@exodus/ethereumjs-common": "^2.4.0-exodus.6",
     "@exodus/ethereumjs-tx": "^3.3.0-exodus.6",
-    "@exodus/web3-utils": "^1.16.0",
+    "@exodus/web3-utils": "^1.17.0",
     "@metamask/eth-sig-util": "^4.0.1"
   },
-  "gitHead": "8f42c066e1d289271e5db5b859e090d06626ef0f"
+  "gitHead": "e425fafca91cd79471b6fd4fbcd6b78a0a8d4a22"
 }