@exodus/web3-ethereum-utils 2.0.2 → 3.0.0

package/lib/createSimulateTransaction.d.ts

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

package/lib/createSimulateTransaction.js

@@ -1,37 +1,40 @@
-import { createEmptySimulationResult } from '@exodus/web3-utils';
+import { createEmptySimulationResult, createScanDomains, } from '@exodus/web3-utils';
 import { estimateFee } from './simulation/estimateFee.js';
 import { simulateTransaction } from './simulation/simulateTransaction.js';
 import { tryEstimatingChangesLocally } from './simulation/tryEstimatingChangesLocally.js';
 import { getDisplayDetails, getTxFeeDetails } from './transactions.js';
 const SIMULATION_API_DEFAULT = 'https://simulation.a.exodus.io/simulate';
 const SERVICE_PROVIDER_DEFAULT = 'blowfish';
-const SIMULATION_HEADERS = {
+const SIMULATION_HEADERS_DEFAULT = {
     'X-Api-Version': '2023-06-05',
 };
 /* eslint-disable @typescript-eslint/no-unused-vars */
-export const createSimulateTransaction = ({ serviceProvider = SERVICE_PROVIDER_DEFAULT, apiEndpoint = SIMULATION_API_DEFAULT, headers = SIMULATION_HEADERS, shouldSimulate = true, }) => async ({ transaction, asset, origin, }) => {
-    const simulationResult = createEmptySimulationResult({
-        asset,
-    });
-    simulationResult.balanceChanges.willPayFee.push({
-        balance: estimateFee({ asset, transaction }),
-        feeDetails: getTxFeeDetails(transaction),
-    });
-    if (!transaction.to) {
+export const createSimulationService = ({ apiEndpoint = SIMULATION_API_DEFAULT, headers = SIMULATION_HEADERS_DEFAULT, serviceProvider = SERVICE_PROVIDER_DEFAULT, shouldSimulate = true, }) => ({
+    simulateTransaction: async ({ transaction, asset, origin, }) => {
+        const simulationResult = createEmptySimulationResult({
+            asset,
+        });
+        simulationResult.balanceChanges.willPayFee.push({
+            balance: estimateFee({ asset, transaction }),
+            feeDetails: getTxFeeDetails(transaction),
+        });
+        if (!transaction.to) {
+            return simulationResult;
+        }
+        if (!shouldSimulate) {
+            tryEstimatingChangesLocally({ asset, simulationResult, transaction });
+            return simulationResult;
+        }
+        await simulateTransaction({
+            transaction,
+            apiEndpoint,
+            origin,
+            simulationResult,
+            headers,
+            assetName: asset.name,
+        });
+        simulationResult.displayDetails = getDisplayDetails(simulationResult.balanceChanges.willApprove);
         return simulationResult;
-    }
-    if (!shouldSimulate) {
-        tryEstimatingChangesLocally({ asset, simulationResult, transaction });
-        return simulationResult;
-    }
-    await simulateTransaction({
-        transaction,
-        apiEndpoint,
-        origin,
-        simulationResult,
-        headers,
-        assetName: asset.name,
-    });
-    simulationResult.displayDetails = getDisplayDetails(simulationResult.balanceChanges.willApprove);
-    return simulationResult;
-};
+    },
+    scanDomains: createScanDomains({ url: apiEndpoint, headers }),
+});

package/lib/simulation/simulateTransaction.d.ts

@@ -1,5 +1,5 @@
 import type { EthAggregatedTransactionSimulationResult, EthSimulateTransactionParams } from '../types.js';
-import type { CreateSimulateTransactionParams } from '@exodus/web3-types';
+import type { CreateSimulationServiceParams } from '@exodus/web3-types';
 interface BlowfishEvmChain {
     [key: string]: {
         network: string;
@@ -7,7 +7,7 @@ interface BlowfishEvmChain {
     };
 }
 export declare const BLOWFISH_EVM_CHAINS: BlowfishEvmChain;
-declare type SimulateTransactionParams = Required<Pick<CreateSimulateTransactionParams, 'apiEndpoint'>> & Required<Pick<EthSimulateTransactionParams, 'transaction' | 'origin'>> & {
+declare type SimulateTransactionParams = Required<Pick<CreateSimulationServiceParams, 'apiEndpoint'>> & Required<Pick<EthSimulateTransactionParams, 'transaction' | 'origin'>> & {
     simulationResult: EthAggregatedTransactionSimulationResult;
     headers?: Record<string, string>;
     assetName: string;

package/lib/types.d.ts

@@ -1,4 +1,4 @@
-import type { AggregatedTransactionSimulationResult, BN, SimulateTransactionParams } from '@exodus/web3-types';
+import type { AggregatedTransactionSimulationResult, CreateSimulationServiceParams, BN, ScanDomainsFn, SimulateTransactionParams } from '@exodus/web3-types';
 export interface EthTransactionParams {
     chainId: string;
     from: string;
@@ -47,3 +47,7 @@ export interface EthFeeDetails {
     gasPrice: BN;
 }
 export declare type EthAggregatedTransactionSimulationResult = AggregatedTransactionSimulationResult<EthFeeDetails>;
+export declare type CreateEthSimulationServiceFn = (simulationServiceParams: CreateSimulationServiceParams) => {
+    simulateTransaction: (params: EthSimulateTransactionParams) => Promise<EthAggregatedTransactionSimulationResult>;
+    scanDomains: ScanDomainsFn;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/web3-ethereum-utils",
   "description": "Web3 Ethereum utils.",
-  "version": "2.0.2",
+  "version": "3.0.0",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -26,13 +26,13 @@
     "build": "yarn clean && tsc"
   },
   "devDependencies": {
-    "@exodus/web3-types": "^1.29.0"
+    "@exodus/web3-types": "^1.30.0"
   },
   "dependencies": {
     "@exodus/ethereumjs-common": "^2.4.0-exodus.6",
     "@exodus/ethereumjs-tx": "^3.3.0-exodus.6",
-    "@exodus/web3-utils": "^1.21.0",
+    "@exodus/web3-utils": "^1.22.0",
     "@metamask/eth-sig-util": "^4.0.1"
   },
-  "gitHead": "97e2a3393ee466aaddbb6317267269ae93e5d6ac"
+  "gitHead": "5130517c87424b7118b272f053d10fb42750fa3f"
 }