@exodus/web3-ethereum-utils 3.26.1 → 3.27.0

package/lib/createSimulateMessage.d.ts

@@ -0,0 +1,8 @@
+import type { EthSimulateMessageParams } from './types.js';
+import type { MessageSimulationResult } from '@exodus/web3-types';
+export declare const createSimulateMessage: ({ apiEndpoint, headers, }?: {
+    apiEndpoint?: string | undefined;
+    headers?: {
+        'X-Api-Version': string;
+    } | undefined;
+}) => ({ message, origin, asset, address, }: EthSimulateMessageParams) => Promise<MessageSimulationResult>;

package/lib/createSimulateMessage.js

@@ -0,0 +1,26 @@
+import { getMessageType } from './simulation/getMessageType.js';
+import { simulateMessage } from './simulation/simulateMessage.js';
+export const createSimulateMessage = ({ apiEndpoint = 'https://simulation.a.exodus.io/simulateMessage', headers = {
+    'X-Api-Version': '2023-06-05',
+}, } = {}) => async ({ message, origin, asset, address, }) => {
+    const simulationResult = {
+        baseAssetName: asset.baseAssetName,
+        action: 'NONE',
+    };
+    const messageType = getMessageType(message);
+    if (messageType === 2 /* MessageTypeEnum.Unknown */) {
+        return simulationResult;
+    }
+    await simulateMessage({
+        address,
+        message: {
+            message,
+            messageType,
+        },
+        origin,
+        apiEndpoint,
+        headers,
+        simulationResult,
+    });
+    return simulationResult;
+};

package/lib/simulation/common.d.ts

@@ -0,0 +1,8 @@
+interface BlowfishEvmChain {
+    [key: string]: {
+        network: string;
+        chain: string;
+    };
+}
+export declare const BLOWFISH_EVM_CHAINS: BlowfishEvmChain;
+export {};

package/lib/simulation/common.js

@@ -0,0 +1,26 @@
+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',
+    },
+    basemainnet: {
+        network: 'base',
+        chain: 'mainnet',
+    },
+};

package/lib/simulation/getMessageType.d.ts

@@ -0,0 +1,6 @@
+export declare const enum MessageTypeEnum {
+    'RawMessage' = 0,
+    'TypedData' = 1,
+    'Unknown' = 2
+}
+export declare const getMessageType: (message: string) => MessageTypeEnum;

package/lib/simulation/getMessageType.js

@@ -0,0 +1,21 @@
+/*
+  This utility figures out if the supplied message is plaint text to be signed or a structured typed data.
+  See for differences:
+  - https://docs.metamask.io/wallet/reference/personal_sign/
+  - https://docs.metamask.io/wallet/reference/eth_signtypeddata_v4/
+
+  The utility does not make any security checks (e.g. schema validation), it's supposed to be used only for choosing
+  a proper payload type for the simulation API.
+ */
+export const getMessageType = (message) => {
+    if (typeof message !== 'string') {
+        return 2 /* MessageTypeEnum.Unknown */;
+    }
+    try {
+        JSON.parse(message);
+        return 1 /* MessageTypeEnum.TypedData */;
+    }
+    catch (err) {
+        return 0 /* MessageTypeEnum.RawMessage */;
+    }
+};

package/lib/simulation/simulateMessage.d.ts

@@ -0,0 +1,7 @@
+import type { SimulateMessageParams } from '../types.js';
+import type { MessageSimulationResult, ScanMessageEvm200Response } from '@exodus/web3-types';
+export declare const handleActionResponse: ({ simulationResult, response, }: {
+    simulationResult: MessageSimulationResult;
+    response: ScanMessageEvm200Response;
+}) => void;
+export declare const simulateMessage: ({ address, apiEndpoint, message, origin, headers, simulationResult, }: SimulateMessageParams) => Promise<void>;

package/lib/simulation/simulateMessage.js

@@ -0,0 +1,46 @@
+import { makeSimulationAPICall } from '@exodus/web3-utils';
+import { BLOWFISH_EVM_CHAINS } from './common.js';
+const convertToAPIPayload = ({ origin, address, message, }) => {
+    const restParameters = {
+        metadata: { origin },
+        userAccount: address,
+    };
+    if (message.messageType === 1 /* MessageTypeEnum.TypedData */) {
+        const kind = 'SIGN_TYPED_DATA';
+        return {
+            message: {
+                kind,
+                data: JSON.parse(message.message),
+            },
+            ...restParameters,
+        };
+    }
+    const kind = 'SIGN_MESSAGE';
+    return {
+        message: {
+            kind,
+            rawMessage: message.message,
+        },
+        ...restParameters,
+    };
+};
+export const handleActionResponse = ({ simulationResult, response, }) => {
+    if (['BLOCK', 'WARN'].includes(response.action)) {
+        simulationResult.action = response.action;
+    }
+};
+export const simulateMessage = async ({ address, apiEndpoint, message, origin, headers, simulationResult, }) => {
+    const { network, chain } = BLOWFISH_EVM_CHAINS[simulationResult.baseAssetName];
+    const payload = convertToAPIPayload({ address, origin, message });
+    const response = await makeSimulationAPICall({
+        url: apiEndpoint,
+        chain,
+        network,
+        payload,
+        headers,
+    });
+    if (!response) {
+        return;
+    }
+    handleActionResponse({ simulationResult, response });
+};

package/lib/simulation/simulateTransactions.d.ts

@@ -1,12 +1,5 @@
 import type { EthAggregatedTransactionSimulationResult, EthSimulateTransactionParams } from '../types.js';
 import type { CreateSimulateTransactionsParams } from '@exodus/web3-types';
-interface BlowfishEvmChain {
-    [key: string]: {
-        network: string;
-        chain: string;
-    };
-}
-export declare const BLOWFISH_EVM_CHAINS: BlowfishEvmChain;
 declare type SimulateTransactionParams = Required<Pick<CreateSimulateTransactionsParams, 'apiEndpoint'>> & Required<Pick<EthSimulateTransactionParams, 'transactions' | 'origin'>> & {
     simulationResult: EthAggregatedTransactionSimulationResult;
     headers?: Record<string, string>;

package/lib/simulation/simulateTransactions.js

@@ -4,32 +4,7 @@
  */
 import { pick } from '@exodus/basic-utils';
 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',
-    },
-    basemainnet: {
-        network: 'base',
-        chain: 'mainnet',
-    },
-};
+import { BLOWFISH_EVM_CHAINS } from './common.js';
 const convertTransactionToApiPayload = (transactions, origin) => ({
     txObjects: transactions.map((transaction) => ({
         from: transaction.from,

package/lib/types.d.ts

@@ -1,4 +1,5 @@
-import type { AggregatedTransactionSimulationResult, BN, SimulateTransactionParams } from '@exodus/web3-types';
+import type { MessageTypeEnum } from './simulation/getMessageType.js';
+import type { AggregatedTransactionSimulationResult, Asset, BN, MessageSimulationResult, SimulateTransactionParams } from '@exodus/web3-types';
 export interface EthTransactionParams {
     chainId: number;
     from: string;
@@ -50,3 +51,20 @@ export interface EthFeeDetails {
     gasPrice: BN;
 }
 export declare type EthAggregatedTransactionSimulationResult = AggregatedTransactionSimulationResult<EthFeeDetails>;
+export interface EthSimulateMessageParams {
+    asset: Asset;
+    message: string;
+    origin: string;
+    address: string;
+}
+export interface SimulateMessageParams {
+    address: EthSimulateMessageParams['address'];
+    message: {
+        message: string;
+        messageType: MessageTypeEnum.RawMessage | MessageTypeEnum.TypedData;
+    };
+    origin: EthSimulateMessageParams['origin'];
+    apiEndpoint: string;
+    headers: Record<string, string>;
+    simulationResult: MessageSimulationResult;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/web3-ethereum-utils",
   "description": "Web3 Ethereum utils.",
-  "version": "3.26.1",
+  "version": "3.27.0",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -32,8 +32,8 @@
     "@exodus/basic-utils": "^2.5.1",
     "@exodus/ethereumjs-common": "^2.4.0-exodus.6",
     "@exodus/ethereumjs-tx": "^3.3.0-exodus.6",
-    "@exodus/web3-utils": "^1.43.1",
+    "@exodus/web3-utils": "^1.44.0",
     "@metamask/eth-sig-util": "^4.0.1"
   },
-  "gitHead": "46dd9ea6b783c3c2421afaee9aa280f01474a353"
+  "gitHead": "c9a274287bfba81c264dd9d48dac15d9be56bd47"
 }