@exodus/web3-ethereum-utils 1.18.0 → 1.20.0

package/lib/createSimulateTransaction.js

@@ -5,13 +5,13 @@ const SIMULATION_API_DEFAULT = 'https://simulation.a.exodus.io/simulate';
 const SERVICE_PROVIDER_DEFAULT = 'blowfish';
 /* eslint-disable @typescript-eslint/no-unused-vars */
 export const createSimulateTransaction = ({ serviceProvider = SERVICE_PROVIDER_DEFAULT, apiEndpoint = SIMULATION_API_DEFAULT, }) => async ({ transaction, asset, shouldCallPreviewApi = true, }) => {
-    if (!transaction.to) {
-        return createEmptySimulationResult({ asset });
-    }
     const simulationResult = createEmptySimulationResult({ asset });
     simulationResult.balanceChanges.willPayFee.push({
         balance: estimateFee({ asset, transaction }),
     });
+    if (!transaction.to) {
+        return simulationResult;
+    }
     if (!shouldCallPreviewApi) {
         tryEstimatingChangesLocally({ asset, simulationResult, transaction });
         return simulationResult;

package/lib/simulation/estimateFee.js

@@ -1,10 +1,12 @@
 /*
- This utility determines a fee a transaction is going to pay based on
+ This utility determines a preliminary fee a transaction is going to pay based on
  its "gas", "gasPrice" and "maxFeePerGas" properties.
 
- Note: if EIP-1559 is enabled a transaction will have the "maxFeePerGas" field. In that case
- a final fee will be calculated on-chain (the utility returns a maximum possible value).
- If a transaction has just "gasPrice" it can be considered as a total fee.
+ Note: if EIP-1559 is enabled, a transaction will have the "maxFeePerGas" field. In that case,
+ a final gas price will be determined on-chain (the utility uses a maximum possible gas price value).
+ If a transaction has only "gasPrice", it can be considered as a final gas price.
+ However, a final fee for non-simple transfers is always calculated on-chain once the EVM executes a transaction
+ and has the number of gas consumed.
  */
 import { hexToBN } from '@exodus/web3-utils';
 export const estimateFee = ({ asset, transaction, }) => {

package/lib/simulation/simulateTransaction.d.ts

@@ -3,5 +3,5 @@ import type { AggregatedTransactionSimulationResult, CreateSimulateTransactionPa
 declare type SimulateTransactionParams = Required<CreateSimulateTransactionParams> & Pick<EthSimulateTransactionParams, 'transaction' | 'origin'> & {
     simulationResult: AggregatedTransactionSimulationResult;
 };
-export declare const simulateTransaction: ({ transaction, apiEndpoint, origin, }: SimulateTransactionParams) => Promise<void> | never;
+export declare const simulateTransaction: ({ transaction, apiEndpoint, origin, simulationResult, }: SimulateTransactionParams) => Promise<void> | never;
 export {};

package/lib/simulation/simulateTransaction.js

@@ -2,7 +2,7 @@
  This utility makes an API call to a simulation service, parses the response and mutates the supplied "simulationResult" object
  with the according balance changes.
  */
-import { makeSimulationAPICall } from '@exodus/web3-utils';
+import { createCurrency, makeSimulationAPICall } from '@exodus/web3-utils';
 const convertTransactionToApiPayload = (transaction, origin) => ({
     txObject: {
         from: transaction.from,
@@ -15,12 +15,102 @@ const convertTransactionToApiPayload = (transaction, origin) => ({
     },
     userAccount: transaction.from,
 });
-export const simulateTransaction = async ({ transaction, apiEndpoint, origin, }) => {
+const createBalanceAmount = (amount, { decimals, symbol }) => {
+    const beforeAmount = createCurrency({
+        amount: amount.before,
+        symbol: symbol,
+        denominator: decimals,
+    });
+    const afterAmount = createCurrency({
+        amount: amount.after,
+        symbol: symbol,
+        denominator: decimals,
+    });
+    return beforeAmount.sub(afterAmount);
+};
+const handleExpectedBalanceChange = (expectedBalanceChange, simulationResult) => {
+    const { willApprove, willSend, willReceive } = simulationResult.balanceChanges;
+    const { data, kind } = expectedBalanceChange.rawInfo;
+    const { asset } = data;
+    // ERC1155 is a multi-token standard (https://eips.ethereum.org/EIPS/eip-1155) and can be used for NFTs as well.
+    const isNftTransfer = kind === 'ERC721_TRANSFER' ||
+        (kind === 'ERC1155_TRANSFER' && !asset.decimals);
+    const symbol = asset.symbol;
+    const decimals = isNftTransfer ? 1 : asset.decimals;
+    if (kind === 'ERC20_APPROVAL' ||
+        kind === 'ERC721_APPROVAL_FOR_ALL' ||
+        kind === 'ERC1155_APPROVAL_FOR_ALL' ||
+        kind === 'ERC721_APPROVAL') {
+        willApprove.push({
+            spender: data.spender.address,
+            unitName: symbol,
+            balance: createCurrency({
+                amount: data.amount.after,
+                symbol: symbol,
+                denominator: decimals,
+            }),
+        });
+        return;
+    }
+    const { amount } = data;
+    const balance = createBalanceAmount(amount, { decimals, symbol });
+    if (balance.isZero) {
+        return;
+    }
+    const balanceChange = {
+        balance,
+    };
+    if (isNftTransfer) {
+        balanceChange.nft = {
+            title: asset.name,
+        };
+    }
+    if (balance.isNegative) {
+        willReceive.push(balanceChange);
+    }
+    else {
+        willSend.push(balanceChange);
+    }
+};
+const simulationResultHasAssets = (expectedStateChanges) => {
+    for (const expectedChange of expectedStateChanges) {
+        const { asset } = expectedChange.rawInfo
+            .data;
+        if (!asset) {
+            return false;
+        }
+    }
+    return true;
+};
+export const simulateTransaction = async ({ transaction, apiEndpoint, origin, simulationResult, }) => {
+    const userAddress = transaction.from;
     const payload = convertTransactionToApiPayload(transaction, origin);
-    await makeSimulationAPICall({
+    const response = await makeSimulationAPICall({
         url: apiEndpoint,
         network: 'ethereum',
         payload,
     });
-    // ToDo: parse the response and mutate the simulation result
+    const { expectedStateChanges = {}, error } = response.simulationResults.aggregated;
+    if (error) {
+        // ToDo: accept a logger dep and log the error
+        // ToDo: consider pushing an error to the "warnings" list
+        return;
+    }
+    const userExpectedChanges = Object.keys(expectedStateChanges).reduce((prev, address) => {
+        if (userAddress !== address) {
+            return prev;
+        }
+        const result = (Object.prototype.hasOwnProperty.call(expectedStateChanges, address) &&
+            expectedStateChanges[address]) ||
+            [];
+        return [...prev, ...result];
+    }, []);
+    // Return and log if asset is not present in the expectedStateChanges
+    if (!simulationResultHasAssets(userExpectedChanges)) {
+        // ToDo: accept a logger dep and log the error
+        return;
+    }
+    userExpectedChanges.forEach((expectedChange) => {
+        handleExpectedBalanceChange(expectedChange, simulationResult);
+    });
 };

package/package.json

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