@exodus/web3-ethereum-utils 3.0.0 → 3.1.0

package/lib/createSimulateTransactions.d.ts

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

package/lib/createSimulateTransactions.js

@@ -0,0 +1,33 @@
+import { createEmptySimulationResult } from '@exodus/web3-utils';
+import { estimateFee } from './simulation/estimateFee.js';
+import { simulateTransactions } from './simulation/simulateTransactions.js';
+import { tryEstimatingChangesLocally } from './simulation/tryEstimatingChangesLocally.js';
+import { getDisplayDetails, getTxFeeDetails } from './transactions.js';
+export const createSimulateTransactions = ({ apiEndpoint, headers, shouldSimulate, }) => async ({ transactions, asset, origin, }) => {
+    // Ethereum transactions from web3 providers are always one item in an array.
+    const transaction = transactions[0];
+    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 simulateTransactions({
+        transactions,
+        apiEndpoint,
+        origin,
+        simulationResult,
+        headers,
+        assetName: asset.name,
+    });
+    simulationResult.displayDetails = getDisplayDetails(simulationResult.balanceChanges.willApprove);
+    return simulationResult;
+};

package/lib/index.d.ts

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

package/lib/index.js

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

package/lib/simulation/{simulateTransaction.d.ts → simulateTransactions.d.ts}

@@ -7,10 +7,10 @@ interface BlowfishEvmChain {
     };
 }
 export declare const BLOWFISH_EVM_CHAINS: BlowfishEvmChain;
-declare type SimulateTransactionParams = Required<Pick<CreateSimulationServiceParams, 'apiEndpoint'>> & Required<Pick<EthSimulateTransactionParams, 'transaction' | 'origin'>> & {
+declare type SimulateTransactionParams = Required<Pick<CreateSimulationServiceParams, 'apiEndpoint'>> & Required<Pick<EthSimulateTransactionParams, 'transactions' | 'origin'>> & {
     simulationResult: EthAggregatedTransactionSimulationResult;
     headers?: Record<string, string>;
     assetName: string;
 };
-export declare const simulateTransaction: ({ transaction, apiEndpoint, origin, simulationResult, headers, assetName, }: SimulateTransactionParams) => Promise<void> | never;
+export declare const simulateTransactions: ({ transactions, apiEndpoint, origin, simulationResult, headers, assetName, }: SimulateTransactionParams) => Promise<void> | never;
 export {};

package/lib/simulation/{simulateTransaction.js → simulateTransactions.js}

@@ -25,19 +25,17 @@ export const BLOWFISH_EVM_CHAINS = {
         chain: 'goerli',
     },
 };
-const convertTransactionToApiPayload = (transaction, origin) => ({
-    txObjects: [
-        {
-            from: transaction.from,
-            to: transaction.to,
-            data: transaction.data,
-            value: transaction.value,
-        },
-    ],
+const convertTransactionToApiPayload = (transactions, origin) => ({
+    txObjects: transactions.map((transaction) => ({
+        from: transaction.from,
+        to: transaction.to,
+        data: transaction.data,
+        value: transaction.value,
+    })),
     metadata: {
         origin,
     },
-    userAccount: transaction.from,
+    userAccount: transactions[0].from,
 });
 const createBalanceAmount = (amount, { decimals, symbol }) => {
     const beforeAmount = createCurrency({
@@ -108,9 +106,9 @@ const simulationResultHasAssets = (expectedStateChanges) => {
     }
     return true;
 };
-export const simulateTransaction = async ({ transaction, apiEndpoint, origin, simulationResult, headers, assetName, }) => {
-    const userAddress = transaction.from;
-    const payload = convertTransactionToApiPayload(transaction, origin);
+export const simulateTransactions = async ({ transactions, apiEndpoint, origin, simulationResult, headers, assetName, }) => {
+    const userAddress = transactions[0].from;
+    const payload = convertTransactionToApiPayload(transactions, origin);
     if (!Object.hasOwnProperty.call(BLOWFISH_EVM_CHAINS, assetName)) {
         // ToDo: accept a logger dep and log the error
         return;

package/lib/types.d.ts

@@ -1,4 +1,4 @@
-import type { AggregatedTransactionSimulationResult, CreateSimulationServiceParams, BN, ScanDomainsFn, SimulateTransactionParams } from '@exodus/web3-types';
+import type { AggregatedTransactionSimulationResult, BN, SimulateTransactionParams } from '@exodus/web3-types';
 export interface EthTransactionParams {
     chainId: string;
     from: string;
@@ -39,7 +39,7 @@ export interface EthWalletWatchAsset {
     options: EthWalletWatchAssetOptions;
 }
 export interface EthSimulateTransactionParams extends SimulateTransactionParams {
-    transaction: EthTransaction;
+    transactions: EthTransaction[];
 }
 export interface EthFeeDetails {
     gasLimit: BN;
@@ -47,7 +47,3 @@ 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": "3.0.0",
+  "version": "3.1.0",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -26,13 +26,13 @@
     "build": "yarn clean && tsc"
   },
   "devDependencies": {
-    "@exodus/web3-types": "^1.30.0"
+    "@exodus/web3-types": "^1.31.0"
   },
   "dependencies": {
     "@exodus/ethereumjs-common": "^2.4.0-exodus.6",
     "@exodus/ethereumjs-tx": "^3.3.0-exodus.6",
-    "@exodus/web3-utils": "^1.22.0",
+    "@exodus/web3-utils": "^1.23.0",
     "@metamask/eth-sig-util": "^4.0.1"
   },
-  "gitHead": "5130517c87424b7118b272f053d10fb42750fa3f"
+  "gitHead": "809f56d8040d221eb52373bc9ce3c797c1bbb7a5"
 }

package/lib/createSimulateTransaction.d.ts

@@ -1,2 +0,0 @@
-import type { CreateEthSimulationServiceFn } from './types.js';
-export declare const createSimulationService: CreateEthSimulationServiceFn;

package/lib/createSimulateTransaction.js

@@ -1,40 +0,0 @@
-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_DEFAULT = {
-    'X-Api-Version': '2023-06-05',
-};
-/* eslint-disable @typescript-eslint/no-unused-vars */
-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;
-    },
-    scanDomains: createScanDomains({ url: apiEndpoint, headers }),
-});