@exodus/web3-ethereum-utils 1.11.0 → 1.13.0

package/lib/createSimulateTransaction.js

@@ -1,4 +1,6 @@
 import { createEmptySimulationResult } from '@exodus/web3-utils';
+import { estimateFee } from './simulation/estimateFee.js';
+import { tryEstimatingChangesLocally } from './simulation/tryEstimatingChangesLocally.js';
 const SIMULATION_API_DEFAULT = 'https://simulation.a.exodus.io/simulate';
 const SERVICE_PROVIDER_DEFAULT = 'blowfish';
 /* eslint-disable @typescript-eslint/no-unused-vars */
@@ -6,6 +8,14 @@ export const createSimulateTransaction = ({ serviceProvider = SERVICE_PROVIDER_D
     if (!transaction.to) {
         return createEmptySimulationResult({ asset });
     }
+    const simulationResult = createEmptySimulationResult({ asset });
+    simulationResult.balanceChanges.willPayFee.push({
+        balance: estimateFee({ asset, transaction }),
+    });
+    if (!shouldCallPreviewApi) {
+        tryEstimatingChangesLocally({ asset, simulationResult, transaction });
+        return simulationResult;
+    }
     // ToDo: finish with an actual simulation attempt
     return createEmptySimulationResult({ asset });
 };

package/lib/simulation/estimateFee.d.ts

@@ -0,0 +1,6 @@
+import type { EthTransaction } from '../types.js';
+import type { Asset, NumberUnit } from '@exodus/web3-types';
+export declare const estimateFee: ({ asset, transaction, }: {
+    asset: Asset;
+    transaction: EthTransaction;
+}) => NumberUnit;

package/lib/simulation/estimateFee.js

@@ -0,0 +1,19 @@
+/*
+ This utility determines a 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.
+ */
+import { hexToBN } from '@exodus/web3-utils';
+export const estimateFee = ({ asset, transaction, }) => {
+    const gas = hexToBN(transaction.gas);
+    if (transaction.maxFeePerGas) {
+        const maxFeePerGas = hexToBN(transaction.maxFeePerGas);
+        const maximumFee = gas.mul(maxFeePerGas);
+        return asset.currency.baseUnit(maximumFee);
+    }
+    const gasPrice = hexToBN(transaction.gasPrice);
+    return asset.currency.baseUnit(gas.mul(gasPrice));
+};

package/lib/simulation/estimateSimpleTransfer.d.ts

@@ -1,6 +1,9 @@
 import type { EthTransaction } from '../types.js';
 import type { NumberUnit } from '@exodus/web3-types';
 import type { Asset } from '@exodus/web3-types';
+export declare class NotSimpleTransferError extends Error {
+    constructor(msg: string);
+}
 export declare const estimateSimpleTransfer: ({ asset, transaction, }: {
     asset: Asset;
     transaction: EthTransaction;

package/lib/simulation/estimateSimpleTransfer.js

@@ -7,14 +7,19 @@
  with a gas limit exceeding 21000 units.
  */
 import { hexToBN } from '@exodus/web3-utils';
+export class NotSimpleTransferError extends Error {
+    constructor(msg) {
+        super(msg);
+    }
+}
 export const estimateSimpleTransfer = ({ asset, transaction, }) => {
     // Transaction shouldn't provide any parameters to a smart contract.
     if (!['0x', null, undefined].includes(transaction.data)) {
-        throw new Error('Non-empty transaction input.');
+        throw new NotSimpleTransferError('The transaction input should be empty ("0x").');
     }
     // Simple transfers should consume 21.000 (constant) units of gas.
     if (![undefined, '0x5208'].includes(transaction.gas)) {
-        throw new Error('Gas value is too high.');
+        throw new NotSimpleTransferError('The gas value must precisely be 21,000 units.');
     }
     const txValue = hexToBN(transaction.value || '0x0').toString();
     return asset.currency.baseUnit(txValue);

package/lib/simulation/simulateTransaction.d.ts

@@ -0,0 +1,7 @@
+import type { EthSimulateTransactionParams } from '../types.js';
+import type { AggregatedTransactionSimulationResult, CreateSimulateTransactionParams } from '@exodus/web3-types';
+declare type SimulateTransactionParams = Required<CreateSimulateTransactionParams> & Pick<EthSimulateTransactionParams, 'transaction' | 'origin'> & {
+    simulationResult: AggregatedTransactionSimulationResult;
+};
+export declare const simulateTransaction: ({ transaction, apiEndpoint, origin, }: SimulateTransactionParams) => Promise<void> | never;
+export {};

package/lib/simulation/simulateTransaction.js

@@ -0,0 +1,26 @@
+/*
+ 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';
+const convertTransactionToApiPayload = (transaction, origin) => ({
+    txObject: {
+        from: transaction.from,
+        to: transaction.to,
+        data: transaction.data,
+        value: transaction.value,
+    },
+    metadata: {
+        origin,
+    },
+    userAccount: transaction.from,
+});
+export const simulateTransaction = async ({ transaction, apiEndpoint, origin, }) => {
+    const payload = convertTransactionToApiPayload(transaction, origin);
+    await makeSimulationAPICall({
+        url: apiEndpoint,
+        network: 'ethereum',
+        payload,
+    });
+    // ToDo: parse the response and mutate the simulation result
+};

package/lib/simulation/tryEstimatingChangesLocally.d.ts

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

package/lib/simulation/tryEstimatingChangesLocally.js

@@ -0,0 +1,16 @@
+import { estimateSimpleTransfer, NotSimpleTransferError, } from './estimateSimpleTransfer.js';
+/*
+ Mutates the provided 'simulationResult' adding a 'willSend' entry if the transaction is a simple transfer.
+ */
+export const tryEstimatingChangesLocally = ({ asset, simulationResult, transaction, }) => {
+    try {
+        const transferValue = estimateSimpleTransfer({ asset, transaction });
+        simulationResult.balanceChanges.willSend.push({ balance: transferValue });
+    }
+    catch (err) {
+        const expectedError = err instanceof NotSimpleTransferError;
+        if (!expectedError) {
+            // ToDo: accept a logger dep and log an error here
+        }
+    }
+};

package/lib/types.d.ts

@@ -15,14 +15,14 @@ export interface EthTransactionParams {
     maxFeePerGas?: string;
 }
 export interface EthTransaction {
-    chainId?: string;
+    chainId: string;
     from: string;
     to?: string;
-    gas?: string;
-    gasPrice?: string;
-    value?: string;
+    gas: string;
+    gasPrice: string;
+    value: string;
     data: string;
-    nonce?: string;
+    nonce: string;
     maxPriorityFeePerGas?: string;
     maxFeePerGas?: string;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/web3-ethereum-utils",
   "description": "Web3 Ethereum utils.",
-  "version": "1.11.0",
+  "version": "1.13.0",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -26,13 +26,13 @@
     "build": "yarn clean && tsc"
   },
   "devDependencies": {
-    "@exodus/web3-types": "^1.17.0"
+    "@exodus/web3-types": "^1.19.0"
   },
   "dependencies": {
     "@exodus/ethereumjs-common": "^2.4.0-exodus.6",
     "@exodus/ethereumjs-tx": "^3.3.0-exodus.6",
-    "@exodus/web3-utils": "^1.6.0",
+    "@exodus/web3-utils": "^1.9.0",
     "@metamask/eth-sig-util": "^4.0.1"
   },
-  "gitHead": "a9cd4485d1f90608ba4e38dd0d9bd237768d6009"
+  "gitHead": "ee026a5dba0f36d61545cbb7fbecbbd143355ded"
 }