@exodus/web3-ethereum-utils 3.38.0 → 4.0.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2024 Exodus Movement, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/lib/createSimulateMessage.d.ts

@@ -5,4 +5,4 @@ export declare const createSimulateMessage: ({ apiEndpoint, headers, }?: {
     headers?: {
         'X-Api-Version': string;
     } | undefined;
-}) => ({ message, origin, asset, address, }: EthSimulateMessageParams) => Promise<MessageSimulationResult>;
+}) => ({ message, url, asset, address, }: EthSimulateMessageParams) => Promise<MessageSimulationResult>;

package/lib/createSimulateMessage.js

@@ -1,9 +1,11 @@
+import assert from 'minimalistic-assert';
 import { getMessageType } from './simulation/getMessageType.js';
 import { simulateMessage } from './simulation/simulateMessage.js';
 import { tryParsingSIWE } from './simulation/tryParsingSIWE.js';
 export const createSimulateMessage = ({ apiEndpoint = 'https://simulation.a.exodus.io/simulateMessage', headers = {
     'X-Api-Version': '2023-06-05',
-}, } = {}) => async ({ message, origin, asset, address, }) => {
+}, } = {}) => async ({ message, url, asset, address, }) => {
+    assert(url instanceof URL, "'url' should be an instance of the URL object.");
     const simulationResult = {
         baseAssetName: asset.baseAssetName,
         action: 'NONE',
@@ -15,7 +17,7 @@ export const createSimulateMessage = ({ apiEndpoint = 'https://simulation.a.exod
     tryParsingSIWE({
         message,
         messageType,
-        origin,
+        url,
         simulationResult,
     });
     await simulateMessage({
@@ -24,7 +26,7 @@ export const createSimulateMessage = ({ apiEndpoint = 'https://simulation.a.exod
             message,
             messageType,
         },
-        origin,
+        url,
         apiEndpoint,
         headers,
         simulationResult,

package/lib/createSimulateTransactions.js

@@ -1,6 +1,6 @@
 import { createEmptySimulationResult } from '@exodus/web3-utils';
 import { estimateFee } from './simulation/estimateFee.js';
-import { simulateTransactions, } from './simulation/simulateTransactions.js';
+import { simulateTransactions } from './simulation/simulateTransactions.js';
 import { tryEstimatingChangesLocally } from './simulation/tryEstimatingChangesLocally.js';
 import { getDisplayDetails, getTxFeeDetails } from './transactions.js';
 export const createSimulateTransactions = ({ apiEndpoint, headers }) => async ({ transactions, asset, origin, overrideApiEndpoint, }) => {
@@ -37,6 +37,9 @@ export const createSimulateTransactions = ({ apiEndpoint, headers }) => async ({
                 message: 'Balance changes cannot be estimated.',
             });
         }
+        if (simulationTransactionInternalResult.errorMessage) {
+            simulationResult.metadata.humanReadableError = simulationTransactionInternalResult.errorMessage;
+        }
         return simulationResult;
     }
     simulationResult.displayDetails = getDisplayDetails(simulationResult.balanceChanges.willApprove);

package/lib/signatures.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import { SignTypedDataVersion } from '@metamask/eth-sig-util';
 import type { EthTransactionParams } from './types.js';
 import type { MessageTypes, TypedDataV1, TypedMessage } from '@metamask/eth-sig-util';

package/lib/signatures.js

@@ -1,6 +1,7 @@
-import Common, { Hardfork } from '@exodus/ethereumjs-common';
-import { FeeMarketEIP1559Transaction, Transaction as LegacyTransaction, } from '@exodus/ethereumjs-tx';
+import { Common, Hardfork } from '@exodus/ethereumjs/common';
+import { FeeMarketEIP1559Transaction, Transaction as LegacyTransaction, } from '@exodus/ethereumjs/tx';
 import { SignTypedDataVersion, personalSign, signTypedData as ethSigUtilSignTypedData, } from '@metamask/eth-sig-util';
+const custom = Common.default?.custom || Common.custom;
 export function signMessage(message, privateKey) {
     return personalSign({ privateKey, data: message });
 }
@@ -12,10 +13,10 @@ export function signTransaction(transactionParams, privateKey) {
     const isEIP1559Enabled = !!transactionParams.maxFeePerGas;
     const transaction = isEIP1559Enabled
         ? FeeMarketEIP1559Transaction.fromTxData(transactionData, {
-            common: Common.custom({ chainId }, { hardfork: Hardfork.London }),
+            common: custom({ chainId }, { hardfork: Hardfork.London }),
         })
         : LegacyTransaction.fromTxData(transactionData, {
-            common: Common.custom({ chainId }),
+            common: custom({ chainId }),
         });
     const signedTransaction = transaction.sign(privateKey);
     return signedTransaction.serialize();

package/lib/simulation/simulateMessage.d.ts

@@ -4,4 +4,4 @@ export declare const handleActionResponse: ({ simulationResult, response, }: {
     simulationResult: MessageSimulationResult;
     response: ScanMessageEvm200Response;
 }) => void;
-export declare const simulateMessage: ({ address, apiEndpoint, message, origin, headers, simulationResult, }: SimulateMessageParams) => Promise<void>;
+export declare const simulateMessage: ({ address, apiEndpoint, message, url, headers, simulationResult, }: SimulateMessageParams) => Promise<void>;

package/lib/simulation/simulateMessage.js

@@ -1,8 +1,8 @@
 import { makeSimulationAPICall } from '@exodus/web3-utils';
 import { BLOWFISH_EVM_CHAINS } from './common.js';
-const convertToAPIPayload = ({ origin, address, message, }) => {
+const convertToAPIPayload = ({ address, message, url, }) => {
     const restParameters = {
-        metadata: { origin },
+        metadata: { origin: url.href },
         userAccount: address,
     };
     if (message.messageType === 1 /* MessageTypeEnum.TypedData */) {
@@ -29,9 +29,9 @@ export const handleActionResponse = ({ simulationResult, response, }) => {
         simulationResult.action = response.action;
     }
 };
-export const simulateMessage = async ({ address, apiEndpoint, message, origin, headers, simulationResult, }) => {
+export const simulateMessage = async ({ address, apiEndpoint, message, url, headers, simulationResult, }) => {
     const { network, chain } = BLOWFISH_EVM_CHAINS[simulationResult.baseAssetName];
-    const payload = convertToAPIPayload({ address, origin, message });
+    const payload = convertToAPIPayload({ address, message, url });
     const response = await makeSimulationAPICall({
         url: apiEndpoint,
         chain,

package/lib/simulation/simulateTransactions.d.ts

@@ -1,12 +1,13 @@
 import type { EthAggregatedTransactionSimulationResult, EthSimulateTransactionParams } from '../types.js';
 import type { CreateSimulateTransactionsParams, SimulateTransactionsInternalResult } from '@exodus/web3-types';
-declare type SimulateTransactionParams = Required<Pick<CreateSimulateTransactionsParams, 'apiEndpoint'>> & Required<Pick<EthSimulateTransactionParams, 'asset' | 'transactions' | 'origin'>> & {
+type SimulateTransactionParams = Required<Pick<CreateSimulateTransactionsParams, 'apiEndpoint'>> & Required<Pick<EthSimulateTransactionParams, 'asset' | 'transactions' | 'origin'>> & {
     simulationResult: EthAggregatedTransactionSimulationResult;
     headers?: Record<string, string>;
 };
 export declare const enum SimulationErrorMessages {
-    'SimulationNotSupported' = 0,
-    'APICallFailed' = 1
+    'APICallFailed' = 0,
+    'SimulationFailed' = 1,
+    'SimulationNotSupported' = 2
 }
 export declare const simulateTransactions: ({ transactions, apiEndpoint, origin, simulationResult, headers, asset, }: SimulateTransactionParams) => SimulateTransactionsInternalResult<undefined, SimulationErrorMessages>;
 export {};

package/lib/simulation/simulateTransactions.js

@@ -127,7 +127,7 @@ export const simulateTransactions = async ({ transactions, apiEndpoint, origin,
     if (!BLOWFISH_EVM_CHAINS[asset.name]) {
         return {
             kind: 'error',
-            error: 0 /* SimulationErrorMessages.SimulationNotSupported */,
+            error: 2 /* SimulationErrorMessages.SimulationNotSupported */,
         };
     }
     const userAddress = transactions[0].from;
@@ -147,15 +147,20 @@ export const simulateTransactions = async ({ transactions, apiEndpoint, origin,
     if (!response) {
         return {
             kind: 'error',
-            error: 1 /* SimulationErrorMessages.APICallFailed */,
+            error: 0 /* SimulationErrorMessages.APICallFailed */,
         };
     }
     simulationResult.metadata.simulatedLocally = false;
     const { expectedStateChanges = {}, error } = response.simulationResults.aggregated;
     if (error) {
+        const { humanReadableError } = response.simulationResults.aggregated;
         // ToDo: accept a logger dep and log the error
         // ToDo: consider pushing an error to the "warnings" list
-        return successDefaultResult;
+        return {
+            kind: 'error',
+            error: 1 /* SimulationErrorMessages.SimulationFailed */,
+            errorMessage: humanReadableError
+        };
     }
     const noExpectedStateChangesDetected = Object.keys(expectedStateChanges).length === 0;
     // This is a self-send transaction, adding a zero "transfer" so that the UI can display it.

package/lib/simulation/tryParsingSIWE.d.ts

@@ -1,8 +1,8 @@
 import { MessageTypeEnum } from './getMessageType.js';
 import type { MessageSimulationResult } from '@exodus/web3-types';
-export declare const tryParsingSIWE: ({ message, messageType, origin: _origin, simulationResult, }: {
+export declare const tryParsingSIWE: ({ message, messageType, url, simulationResult, }: {
     message: string;
     messageType: MessageTypeEnum;
-    origin: string;
+    url: URL;
     simulationResult: MessageSimulationResult;
 }) => void;

package/lib/simulation/tryParsingSIWE.js

@@ -1,31 +1,11 @@
-const createURL = (origin) => {
-    try {
-        return new URL(origin);
-    }
-    catch (err) {
-        try {
-            // During this attempt we're checking if a scheme was missing in the origin as
-            // Platforms may or may nor include it.
-            return new URL(`https://${origin}`);
-        }
-        catch (err) {
-            // ToDo: accept a logger dep and log an error here
-            return null;
-        }
-    }
-};
-export const tryParsingSIWE = ({ message, messageType, origin: _origin, simulationResult, }) => {
+export const tryParsingSIWE = ({ message, messageType, url, simulationResult, }) => {
     if (messageType === 1 /* MessageTypeEnum.TypedData */) {
         return;
     }
-    const origin = createURL(_origin);
-    if (!origin) {
-        return;
-    }
     /*
       Some dApps don't comply with EIP-4361 and use their custom Sign-In messages. This code block detects such known custom SIWE messages.
      */
-    if (origin.hostname === 'rarible.com' &&
+    if (url.hostname === 'rarible.com' &&
         message.includes('I want to login on Rarible')) {
         simulationResult.kind = {
             kind: 'SIWE',

package/lib/transactions.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" resolution-mode="require"/>
+/// <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;

package/lib/transactions.js

@@ -1,4 +1,4 @@
-import { FeeMarketEIP1559Transaction, Transaction as LegacyTransaction, } from '@exodus/ethereumjs-tx';
+import { FeeMarketEIP1559Transaction, Transaction as LegacyTransaction, } from '@exodus/ethereumjs/tx';
 export function getTransactionId(serializedTransaction, isEIP1559Transaction = false) {
     const Transaction = isEIP1559Transaction
         ? FeeMarketEIP1559Transaction

package/lib/types.d.ts

@@ -25,15 +25,15 @@ export interface EthTransaction {
     maxPriorityFeePerGas?: string;
     maxFeePerGas?: string;
 }
-export declare type EthTransactionHash = string;
-export declare type EthParentCapability = 'eth_accounts';
+export type EthTransactionHash = string;
+export type EthParentCapability = 'eth_accounts';
 export interface EthWalletPermission {
     parentCapability: EthParentCapability;
 }
 export interface EthWalletSwitchEthereumChain {
     chainId: string;
 }
-export declare type EthWalletWatchAssetOptions = {
+export type EthWalletWatchAssetOptions = {
     address: string;
     symbol?: string;
     decimals?: number;
@@ -52,11 +52,11 @@ export interface EthFeeDetails {
     maxFeePerGas: BN;
     gasPrice: BN;
 }
-export declare type EthAggregatedTransactionSimulationResult = AggregatedTransactionSimulationResult<EthFeeDetails>;
+export type EthAggregatedTransactionSimulationResult = AggregatedTransactionSimulationResult<EthFeeDetails>;
 export interface EthSimulateMessageParams {
     asset: Asset;
     message: string;
-    origin: string;
+    url: URL;
     address: string;
 }
 export interface SimulateMessageParams {
@@ -65,7 +65,7 @@ export interface SimulateMessageParams {
         message: string;
         messageType: MessageTypeEnum.RawMessage | MessageTypeEnum.TypedData;
     };
-    origin: EthSimulateMessageParams['origin'];
+    url: EthSimulateMessageParams['url'];
     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.38.0",
+  "version": "4.0.0",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -18,23 +18,35 @@
     "lib/**/*.js"
   ],
   "publishConfig": {
-    "access": "restricted"
+    "access": "public"
   },
-  "repository": "https://github.com/ExodusMovement/exodus-web3/tree/master/libs/ethereum-utils",
-  "license": "UNLICENSED",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ExodusMovement/assets.git"
+  },
+  "license": "MIT",
   "scripts": {
     "clean": "run -T rimraf lib",
-    "build": "yarn clean &&  run -T tsc"
+    "build": "yarn clean &&  run -T tsc",
+    "lint": "run -T eslintc .",
+    "lint:fix": "yarn lint --fix",
+    "prepublishOnly": "yarn run -T build --scope @exodus/web3-ethereum-utils",
+    "test": "run -T exodus-test --jest --esbuild"
   },
   "devDependencies": {
-    "@exodus/web3-types": "1.52.0"
+    "@exodus/web3-types": "1.53.0"
   },
   "dependencies": {
     "@exodus/basic-utils": "^3.0.1",
-    "@exodus/ethereumjs-common": "^2.4.0-exodus.6",
-    "@exodus/ethereumjs-tx": "^3.3.0-exodus.6",
-    "@exodus/web3-utils": "^1.48.2",
-    "@metamask/eth-sig-util": "^4.0.1"
+    "@exodus/ethereumjs": "^1.0.0",
+    "@exodus/web3-utils": "^1.48.3",
+    "@metamask/eth-sig-util": "^4.0.1",
+    "minimalistic-assert": "^1.0.1"
+  },
+  "author": "Exodus Movement, Inc.",
+  "bugs": {
+    "url": "https://github.com/ExodusMovement/assets/issues?q=is%3Aissue+is%3Aopen+label%3Aweb3-ethereum-utils"
   },
-  "gitHead": "212dd8249e074525316708335355fda305aa691f"
+  "homepage": "https://github.com/ExodusMovement/assets/tree/master/web3/web3-ethereum-utils",
+  "gitHead": "9cc59fb6f6de9bdee27a48a9695763d46d3bc07b"
 }