@exodus/web3-ethereum 5.1.0 → 6.0.0

package/lib/index.d.ts

@@ -1,4 +1,3 @@
 export { EthereumProvider } from './provider/index.js';
-export { simulateTransaction } from './simulation/index.js';
 export { ExodusEthereumWallet } from './wallet-standard/index.js';
 export { registerRPCHandlers } from './rpc-handlers/index.js';

package/lib/index.js

@@ -1,4 +1,3 @@
 export { EthereumProvider } from './provider/index.js';
-export { simulateTransaction } from './simulation/index.js';
 export { ExodusEthereumWallet } from './wallet-standard/index.js';
 export { registerRPCHandlers } from './rpc-handlers/index.js';

package/lib/rpc-handlers/createEvmDeps.d.ts

@@ -1,3 +1,3 @@
 import type { CreateEvmDepsFactoryParams, EVMFactory } from '../types.js';
-declare const createEvmDepsFactory: ({ analytics, blockchainMetadata, }: CreateEvmDepsFactoryParams) => EVMFactory;
+declare const createEvmDepsFactory: ({ analytics, blockchainMetadata, simulateTransactionConfig, }: CreateEvmDepsFactoryParams) => EVMFactory;
 export default createEvmDepsFactory;

package/lib/rpc-handlers/createEvmDeps.js

@@ -1,6 +1,7 @@
 import { fetchGasLimit, getNonce as apiGetNonce, getServer, } from '@exodus/ethereum-api';
+import { createSimulateTransaction } from '@exodus/web3-ethereum-utils';
 import BN from 'bn.js';
-const createEvmDepsFactory = ({ analytics, blockchainMetadata, }) => {
+const createEvmDepsFactory = ({ analytics, blockchainMetadata, simulateTransactionConfig = {}, }) => {
     return ({ assetName, origin, getAsset, getAddress: _getAddress, getPrivateKey: _getPrivateKey, getFeeData: getFeeConfig, getActiveWalletAccount, }) => {
         const asset = getAsset(assetName);
         const server = getServer(asset);
@@ -78,6 +79,7 @@ const createEvmDepsFactory = ({ analytics, blockchainMetadata, }) => {
             return true;
         };
         const getOrigin = () => origin;
+        const simulateTransaction = createSimulateTransaction(simulateTransactionConfig);
         return {
             chainId: 'undefined',
             forwardRequest,
@@ -89,6 +91,7 @@ const createEvmDepsFactory = ({ analytics, blockchainMetadata, }) => {
             getEstimatedGas,
             onEthWalletWatchAssetRequest: trackWalletWatchAssetUse,
             getOrigin,
+            simulateTransaction,
         };
     };
 };

package/lib/rpc-handlers/exposeHandlers.js

@@ -1,9 +1,8 @@
 import { AssetNotSupportedError, InvalidInputError, UnauthorizedError, UserRejectedRequestError, } from '@exodus/web3-errors';
 import { getTransactionId, signMessage, signTransaction, signTypedData, } from '@exodus/web3-ethereum-utils';
+import { hexToBN } from '@exodus/web3-utils';
 import { SignTypedDataVersion } from '@metamask/eth-sig-util';
 import { parseAndValidateTypedData } from './parseAndValidateTypedData.js';
-import { simulateTransaction } from '../simulation/index.js';
-import { hexToBN } from '../simulation/utils.js';
 // See: https://eips.ethereum.org/EIPS/eip-2255.
 const ETH_ACCOUNTS_PERMISSION = 'eth_accounts';
 const PROXIED_METHODS = [
@@ -62,7 +61,7 @@ const isValidGasLimitValue = (value) => {
     return proposedGasLimit.lte(maximumBlockGasLimit);
 };
 export function exposeHandlers(rpc, deps) {
-    const { chainId, isTrusted, isAutoApproved, ensureTrusted, approveConnection, approveMessage, approveTransactions, forwardRequest, getAddress, getPrivateKey, getEstimatedGas, getFeeData, getNonce, sendRawTransaction, onTransactionsSigned = () => { }, onEthWalletWatchAssetRequest = () => { }, isUnlocked = () => true, ensureUnlocked = () => true, getAsset, getOrigin, } = deps;
+    const { chainId, isTrusted, isAutoApproved, ensureTrusted, approveConnection, approveMessage, approveTransactions, forwardRequest, getAddress, getPrivateKey, getEstimatedGas, getFeeData, getNonce, sendRawTransaction, simulateTransaction, onTransactionsSigned = () => { }, onEthWalletWatchAssetRequest = () => { }, isUnlocked = () => true, ensureUnlocked = () => true, getAsset, getOrigin, } = deps;
     const network = `evm:${chainId}`;
     async function assertTrusted() {
         const trusted = await isTrusted();

package/lib/rpc-handlers/index.js

@@ -13,6 +13,7 @@ const validateEVMDeps = (evm) => {
         'getFeeData',
         'getNonce',
         'sendRawTransaction',
+        'simulateTransaction',
         'getOrigin',
     ];
     const optionalKeys = ['onEthWalletWatchAssetRequest'];

package/lib/types.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" resolution-mode="require"/>
-import type { EthTransaction, EthTransactionHash, EthWalletWatchAsset } from '@exodus/web3-ethereum-utils';
+import type { EthAggregatedTransactionSimulationResult, EthSimulateTransactionParams, EthTransaction, EthTransactionHash, EthWalletWatchAsset } from '@exodus/web3-ethereum-utils';
 import type { CommonDeps } from '@exodus/web3-rpc-handlers';
-import type { Asset, IAnalyticsModule, IBlockchainMetadataModule, EthereumFeeData, GetFeeDataParams } from '@exodus/web3-types';
+import type { Asset, IAnalyticsModule, IBlockchainMetadataModule, EthereumFeeData, GetFeeDataParams, CreateSimulateTransactionParams } from '@exodus/web3-types';
 /**
  * EVM-compatible chains.
  */
@@ -17,6 +17,7 @@ export interface FeeData {
 export interface CreateEvmDepsFactoryParams {
     analytics: IAnalyticsModule;
     blockchainMetadata: IBlockchainMetadataModule;
+    simulateTransactionConfig?: CreateSimulateTransactionParams;
 }
 export interface CreateEvmDepsParams {
     assetName: string;
@@ -35,6 +36,7 @@ export declare type EVMDeps = {
     getAddress: () => Promise<string>;
     getPrivateKey: () => Promise<Buffer>;
     sendRawTransaction: (rawTransaction: string) => Promise<EthTransactionHash>;
+    simulateTransaction: (params: EthSimulateTransactionParams) => Promise<EthAggregatedTransactionSimulationResult>;
     getEstimatedGas: (transaction: EthTransaction) => Promise<string>;
     getFeeData: () => Promise<FeeData>;
     getOrigin: () => string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/web3-ethereum",
   "description": "Apps connectivity library for EVM-compatible chains.",
-  "version": "5.1.0",
+  "version": "6.0.0",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -11,7 +11,6 @@
     "./package.json": "./package.json",
     "./provider": "./lib/provider/index.js",
     "./rpc": "./lib/rpc-handlers/index.js",
-    "./simulation": "./lib/simulation/index.js",
     "./wallet-standard": "./lib/wallet-standard/index.js"
   },
   "react-native": "./lib/index.js",
@@ -34,10 +33,10 @@
     "@exodus/currency": "^2.1.2",
     "@exodus/ethereum-api": "^6.0.0",
     "@exodus/web3-constants": "^1.29.0",
-    "@exodus/web3-ethereum-utils": "^1.23.0",
-    "@exodus/web3-provider": "^2.29.0",
-    "@exodus/web3-rpc-handlers": "^1.4.0",
-    "@exodus/web3-utils": "^1.18.0",
+    "@exodus/web3-ethereum-utils": "^1.25.0",
+    "@exodus/web3-provider": "^2.30.0",
+    "@exodus/web3-rpc-handlers": "^1.5.0",
+    "@exodus/web3-utils": "^1.20.0",
     "bn.js": "^5.2.0",
     "eth-rpc-errors": "^4.0.3"
   },
@@ -45,12 +44,12 @@
     "@exodus/assets": "^8.0.72",
     "@exodus/json-rpc": "^1.11.0",
     "@exodus/schemasafe": "^1.0.0",
-    "@exodus/web3-types": "^1.27.0",
+    "@exodus/web3-types": "^1.28.0",
     "@exodus/web3-validation": "^1.35.0",
     "@wallet-standard/base": "^1.0.1"
   },
   "peerDependencies": {
     "@exodus/assets": "^8.0.72"
   },
-  "gitHead": "94b6a34b8a0f7826a4d4652dc1c7ff2b3ea6c017"
+  "gitHead": "6ecf2163a1426779896da6b283d4d7547068a84f"
 }

package/lib/simulation/constant.d.ts

@@ -1 +0,0 @@
-export declare const SIMULATION_SUPPORTED_ASSET_NAMES: string[];

package/lib/simulation/constant.js

@@ -1 +0,0 @@
-export const SIMULATION_SUPPORTED_ASSET_NAMES = ['ethereum']; // just ethereum for now

package/lib/simulation/index.d.ts

@@ -1 +0,0 @@
-export { simulateTransaction } from './simulation.js';

package/lib/simulation/index.js

@@ -1 +0,0 @@
-export { simulateTransaction } from './simulation.js';

package/lib/simulation/simulation.d.ts

@@ -1,16 +0,0 @@
-import type { EthSimulateTransactionParams } from '@exodus/web3-ethereum-utils';
-import type { NumberUnit } from '@exodus/web3-types';
-export declare const simulateTransaction: ({ asset, transaction, origin, }: EthSimulateTransactionParams) => Promise<{
-    baseAssetName: string;
-    advancedDetails: never[];
-    balanceChanges: import("@exodus/web3-types").BalanceChanges;
-    displayInfo: {
-        title: string;
-    };
-    txFee: NumberUnit;
-    txFeeDetails: {
-        gasLimit: number;
-        maxFeePerGas: number | undefined;
-        gasPrice: number;
-    };
-}>;

package/lib/simulation/simulation.js

@@ -1,39 +0,0 @@
-import { createSimulateTransaction } from '@exodus/web3-ethereum-utils';
-import { SIMULATION_SUPPORTED_ASSET_NAMES } from './constant.js';
-import { getEthereumDisplayInfo, hexToBN } from './utils.js';
-const simulateTransactionV2 = createSimulateTransaction();
-const getTxFeeDetails = (asset, transaction) => {
-    const maxFeePerGasBn = transaction.maxFeePerGas
-        ? hexToBN(transaction.maxFeePerGas)
-        : undefined;
-    const gasPriceBn = hexToBN(transaction.gasPrice);
-    const gasBn = hexToBN(transaction.gas);
-    return {
-        txFee: asset.currency.baseUnit(gasBn.mul(maxFeePerGasBn || gasPriceBn).toString()),
-        txFeeDetails: {
-            gasLimit: gasBn.toNumber(),
-            maxFeePerGas: maxFeePerGasBn?.toNumber(),
-            gasPrice: gasPriceBn.toNumber(),
-        },
-    };
-};
-export const simulateTransaction = async ({ asset, transaction, origin, }) => {
-    const baseAssetName = asset.name;
-    const shouldSimulate = SIMULATION_SUPPORTED_ASSET_NAMES.includes(baseAssetName);
-    const { balanceChanges } = await simulateTransactionV2({
-        transaction,
-        asset,
-        origin,
-        shouldCallPreviewApi: shouldSimulate,
-    });
-    const { txFee, txFeeDetails } = getTxFeeDetails(asset, transaction);
-    const displayInfo = getEthereumDisplayInfo(balanceChanges);
-    return {
-        baseAssetName,
-        advancedDetails: [],
-        balanceChanges,
-        displayInfo,
-        txFee,
-        txFeeDetails,
-    };
-};

package/lib/simulation/types.d.ts

@@ -1,22 +0,0 @@
-export interface CurrencyParams {
-    amount: string;
-    symbol: string;
-    denominator: number;
-}
-export interface EthBalanceChanges {
-    willReceive: Array<EthBalanceChange>;
-    willSend: Array<EthBalanceChange>;
-    willApprove: Array<EthBalanceChange>;
-}
-export interface EthBalanceChange {
-    unitName?: string;
-    balance: EthNumberUnit;
-}
-export interface EthNumberUnit {
-    unitName: string;
-}
-export interface EthAccount {
-    balance: number;
-    symbol: string;
-    decimal: number;
-}

package/lib/simulation/types.js

@@ -1 +0,0 @@
-export {};

package/lib/simulation/utils.d.ts

@@ -1,17 +0,0 @@
-import BN from 'bn.js';
-import type { EthBalanceChange, EthBalanceChanges } from './types.js';
-import type { EthTransaction } from '@exodus/web3-ethereum-utils';
-export declare const hexToBN: (hexValue?: string) => BN;
-export declare const isEthTransferTx: (transaction: EthTransaction) => boolean;
-export declare function getEthereumDisplayInfo(balanceChanges: EthBalanceChanges): {
-    title: string;
-};
-export declare const formatAccounts: ({ willSend, willReceive, willApprove, }: {
-    willSend?: never[] | undefined;
-    willReceive?: never[] | undefined;
-    willApprove?: never[] | undefined;
-}) => {
-    willSend: EthBalanceChange[];
-    willReceive: EthBalanceChange[];
-    willApprove: never[];
-};

package/lib/simulation/utils.js

@@ -1,34 +0,0 @@
-import { createCurrency } from '@exodus/web3-utils';
-import BN from 'bn.js';
-export const hexToBN = (hexValue) => new BN((hexValue || '').slice(2), 'hex');
-export const isEthTransferTx = (transaction) => {
-    return (['0x', null, undefined].includes(transaction.data) &&
-        [undefined, '0x5208'].includes(transaction.gas));
-};
-export function getEthereumDisplayInfo(balanceChanges) {
-    let title = 'Approve Transaction?';
-    const isApproveTransaction = balanceChanges.willApprove.length;
-    if (isApproveTransaction) {
-        const tokenName = balanceChanges.willApprove[0].unitName;
-        // Don't change the title if 'tokenName' is undefined
-        title = tokenName ? `Approve ${tokenName} Transactions?` : title;
-    }
-    return { title };
-}
-const convertToNumberUnit = (account) => ({
-    ...account,
-    balance: createCurrency({
-        amount: new BN(account.balance).abs().toString(),
-        symbol: account.symbol,
-        denominator: account.decimal,
-    }),
-});
-export const formatAccounts = ({ willSend = [], willReceive = [], willApprove = [], }) => {
-    const newWillSend = willSend.map(convertToNumberUnit);
-    const newWillReceive = willReceive.map(convertToNumberUnit);
-    return {
-        willSend: newWillSend,
-        willReceive: newWillReceive,
-        willApprove,
-    };
-};