@exodus/web3-ethereum-utils 1.24.0 → 2.0.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, headers, }?: CreateSimulateTransactionParams) => ({ transaction, asset, shouldCallPreviewApi, origin, }: EthSimulateTransactionParams) => Promise<AggregatedTransactionSimulationResult>;
+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>;

package/lib/createSimulateTransaction.js

@@ -2,21 +2,25 @@ import { createEmptySimulationResult } 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 = {
     '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, } = {}) => async ({ transaction, asset, shouldCallPreviewApi = true, origin, }) => {
-    const simulationResult = createEmptySimulationResult({ asset });
+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) {
         return simulationResult;
     }
-    if (!shouldCallPreviewApi) {
+    if (!shouldSimulate) {
         tryEstimatingChangesLocally({ asset, simulationResult, transaction });
         return simulationResult;
     }
@@ -26,6 +30,8 @@ export const createSimulateTransaction = ({ serviceProvider = SERVICE_PROVIDER_D
         origin,
         simulationResult,
         headers,
+        assetName: asset.name,
     });
+    simulationResult.displayDetails = getDisplayDetails(simulationResult.balanceChanges.willApprove);
     return simulationResult;
 };

package/lib/simulation/simulateTransaction.d.ts

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

package/lib/simulation/simulateTransaction.js

@@ -3,6 +3,28 @@
  with the according balance changes.
  */
 import { createCurrency, makeSimulationAPICall } from '@exodus/web3-utils';
+export const BLOWFISH_EVM_CHAINS = {
+    ethereum: {
+        network: 'ethereum',
+        chain: 'mainnet',
+    },
+    matic: {
+        network: 'polygon',
+        chain: 'mainnet',
+    },
+    bsc: {
+        network: 'bnb',
+        chain: 'mainnet',
+    },
+    ethereumarbone: {
+        network: 'arbitrum',
+        chain: 'one',
+    },
+    optimism: {
+        network: 'optimism',
+        chain: 'goerli',
+    },
+};
 const convertTransactionToApiPayload = (transaction, origin) => ({
     txObjects: [
         {
@@ -86,12 +108,18 @@ const simulationResultHasAssets = (expectedStateChanges) => {
     }
     return true;
 };
-export const simulateTransaction = async ({ transaction, apiEndpoint, origin, simulationResult, headers, }) => {
+export const simulateTransaction = async ({ transaction, apiEndpoint, origin, simulationResult, headers, assetName, }) => {
     const userAddress = transaction.from;
     const payload = convertTransactionToApiPayload(transaction, origin);
+    if (!Object.hasOwnProperty.call(BLOWFISH_EVM_CHAINS, assetName)) {
+        // ToDo: accept a logger dep and log the error
+        return;
+    }
+    const { network, chain } = BLOWFISH_EVM_CHAINS[assetName];
     const response = await makeSimulationAPICall({
         url: apiEndpoint,
-        network: 'ethereum',
+        chain,
+        network,
         payload,
         headers,
     });

package/lib/simulation/tryEstimatingChangesLocally.d.ts

@@ -1,7 +1,7 @@
-import type { EthTransaction } from '../types.js';
-import type { AggregatedTransactionSimulationResult, Asset } from '@exodus/web3-types';
+import type { EthAggregatedTransactionSimulationResult, EthTransaction } from '../types.js';
+import type { Asset } from '@exodus/web3-types';
 export declare const tryEstimatingChangesLocally: ({ asset, simulationResult, transaction, }: {
     asset: Asset;
-    simulationResult: AggregatedTransactionSimulationResult;
+    simulationResult: EthAggregatedTransactionSimulationResult;
     transaction: EthTransaction;
 }) => void;

package/lib/transactions.d.ts

@@ -1,2 +1,12 @@
 /// <reference types="node" resolution-mode="require"/>
+import type { EthTransaction } from './types.js';
+import type { ApprovalBalanceChange } from '@exodus/web3-types';
 export declare function getTransactionId(serializedTransaction: Buffer, isEIP1559Transaction?: boolean): string;
+export declare function getDisplayDetails(willApprove: ApprovalBalanceChange[]): {
+    title: string;
+};
+export declare const getTxFeeDetails: (transaction: EthTransaction) => {
+    gasLimit: import("bn.js");
+    maxFeePerGas: import("bn.js");
+    gasPrice: import("bn.js");
+};

package/lib/transactions.js

@@ -1,4 +1,5 @@
 import { FeeMarketEIP1559Transaction, Transaction as LegacyTransaction, } from '@exodus/ethereumjs-tx';
+import { hexToBN } from '@exodus/web3-utils';
 export function getTransactionId(serializedTransaction, isEIP1559Transaction = false) {
     const Transaction = isEIP1559Transaction
         ? FeeMarketEIP1559Transaction
@@ -6,3 +7,23 @@ export function getTransactionId(serializedTransaction, isEIP1559Transaction = f
     const transaction = Transaction.fromSerializedTx(serializedTransaction);
     return `0x${transaction.hash().toString('hex')}`;
 }
+export function getDisplayDetails(willApprove) {
+    let title = 'Approve Transaction?';
+    const isApproveTransaction = willApprove.length;
+    if (isApproveTransaction) {
+        const tokenName = willApprove[0].unitName;
+        // Don't change the title if 'tokenName' is undefined
+        title = tokenName ? `Approve ${tokenName} Transactions?` : title;
+    }
+    return { title };
+}
+export const getTxFeeDetails = (transaction) => {
+    const maxFeePerGas = hexToBN(transaction.maxFeePerGas);
+    const gasPrice = hexToBN(transaction.gasPrice);
+    const gasLimit = hexToBN(transaction.gas);
+    return {
+        gasLimit,
+        maxFeePerGas,
+        gasPrice,
+    };
+};

package/lib/types.d.ts

@@ -1,7 +1,4 @@
-import type { SimulateTransactionParams } from '@exodus/web3-types';
-export interface EthChainParam {
-    chainId: string;
-}
+import type { AggregatedTransactionSimulationResult, BN, SimulateTransactionParams } from '@exodus/web3-types';
 export interface EthTransactionParams {
     chainId: string;
     from: string;
@@ -24,7 +21,7 @@ export interface EthTransaction {
     data: string;
     nonce: string;
     maxPriorityFeePerGas?: string;
-    maxFeePerGas?: string;
+    maxFeePerGas: string;
 }
 export declare type EthTransactionHash = string;
 export declare type EthParentCapability = 'eth_accounts';
@@ -44,3 +41,9 @@ export interface EthWalletWatchAsset {
 export interface EthSimulateTransactionParams extends SimulateTransactionParams {
     transaction: EthTransaction;
 }
+export interface EthFeeDetails {
+    gasLimit: BN;
+    maxFeePerGas: BN;
+    gasPrice: BN;
+}
+export declare type EthAggregatedTransactionSimulationResult = AggregatedTransactionSimulationResult<EthFeeDetails>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/web3-ethereum-utils",
   "description": "Web3 Ethereum utils.",
-  "version": "1.24.0",
+  "version": "2.0.0",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -26,13 +26,13 @@
     "build": "yarn clean && tsc"
   },
   "devDependencies": {
-    "@exodus/web3-types": "^1.27.0"
+    "@exodus/web3-types": "^1.29.0"
   },
   "dependencies": {
     "@exodus/ethereumjs-common": "^2.4.0-exodus.6",
     "@exodus/ethereumjs-tx": "^3.3.0-exodus.6",
-    "@exodus/web3-utils": "^1.19.0",
+    "@exodus/web3-utils": "^1.21.0",
     "@metamask/eth-sig-util": "^4.0.1"
   },
-  "gitHead": "92836d8ceabd596075b6ad6bec087db36e0ff3f2"
+  "gitHead": "8ac7c36af33c692d577d3a53a4edad0187fee33b"
 }