@exodus/web3-ethereum 2.4.0 → 2.5.0

package/CHANGELOG.md

@@ -0,0 +1,153 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [2.5.0] - 2023-06-07
+
+### Changed
+
+- Use a simplified `getNonce` dependency (doesn't require arguments)
+
+## [2.4.1] - 2023-06-05
+
+### Added
+
+- chore(ethereum): build ethereum dependencies based on hydra modules (#502)
+
+### Fixed
+
+- fix(ethereum): harden typed data validation (#508)
+- fix(ethereum): untangle balance weirdness (#506)
+
+## [2.4.0] - 2023-05-29
+
+### Fixed
+
+- fix(ethereum): TS compilation errors (#498)
+- fix: rename ethereum:provider to eip1193:provider (#499)
+
+## [2.3.0] - 2023-05-18
+
+### Fixed
+
+- fix(web3): resolve error on approving token for swap (#485)
+- fix: rename ethereum:provider to eip1193:provider (#499)
+
+## [2.1.1] - 2023-05-11
+
+### Fixed
+
+- Validation for signing typed data.
+
+### Changed
+
+- Ensure mainnet (`0x1`) is always a first supported chain ID
+
+## [2.0.0] - 2023-05-11
+
+### Changed
+
+- Breaking: accept `getAsset` dependency instead of `asset`.
+- Breaking: make RPC validate parsed requests.
+
+## [1.5.1] - 2023-04-06
+
+### Fixed
+
+- Convert methods in the provider to properties with arrow functions.
+- Convert chain ID from `getDefaultChainId` to lower case
+
+## [1.5.0] - 2023-04-05
+
+### Changed
+
+- Supply simulated changes to the approval function
+
+## [1.4.6] - 2023-03-27
+
+### Fixed
+
+- `eth_getLogs` method validation (allow null in an array)
+
+## [1.4.4] - 2023-03-26
+
+### Fixed
+
+- Don't change the Approve Transaction title if no token symbol found
+- `eth_getLogs` method validation
+
+## [1.4.2] - 2023-03-22
+
+### Fixed
+
+- Returning a possibly mutated object in `validateRequestWithPrefix`
+
+## [1.4.1] - 2023-03-15
+
+### Changed
+
+- Properly check if `getDefaultChainId` is undefined in provider constructor
+
+## [1.4.0] - 2023-03-01
+
+### Changed
+
+- Unpin `ethereum-api` package version
+
+## [1.3.0] - 2023-02-28
+
+### Changed
+
+- Use arrow functions for compatibility with React bundler
+
+## [1.2.0] - 2023-02-27
+
+### Added
+
+- Implement RPC functions
+
+## [1.1.0] - 2023-02-22
+
+### Changed
+
+- Rework simulate transaction api
+- Package structure
+
+## [1.0.0] - 2023-02-20
+
+Initial release.
+
+[unreleased]:
+  https://github.com/ExodusMovement/exodus-web3/compare/db3e8cfd7d2f3cb908bb675cff1ca7981bbd1b09...master
+[1.0.0]:
+  (https://github.com/ExodusMovement/exodus-web3/commit/c220026347ce27cfc25bacc083d61b1aae5c876b)
+[1.1.0]:
+  (https://github.com/ExodusMovement/exodus-web3/commit/75254d697e3ffd2d95759e30425c30c7fb7fa654)
+[1.2.0]:
+  (https://github.com/ExodusMovement/exodus-web3/commit/39137384d78bfa3e008b92e47e106a7be1df071e)
+[1.3.0]:
+  (https://github.com/ExodusMovement/exodus-web3/commit/91de31ee30652f2f8acc66f6e1d909fd27174a36)
+[1.4.0]:
+  (https://github.com/ExodusMovement/exodus-web3/commit/bbba5c8aa7d663deec5f649250421777c855341a)
+[1.4.1]:
+  (https://github.com/ExodusMovement/exodus-web3/commit/cd3382acdb92fd0dafbb2f2f49b0cc9a648d6e2c)
+[1.4.2]:
+  (https://github.com/ExodusMovement/exodus-web3/commit/c414d2c359ecbd25fe1b4d244f6fb51f633a4284)
+[1.4.4]:
+  (https://github.com/ExodusMovement/exodus-web3/commit/e48f74f32e040de9e86ef77ea48058d5c0b36c86)
+[1.4.6]:
+  (https://github.com/ExodusMovement/exodus-web3/commit/4d9d6eed59fbe201c1e6f2abb4b50f1f336bc690)
+[1.5.0]:
+  (https://github.com/ExodusMovement/exodus-web3/commit/4a0c077d0175fe3c6a35e2f9a459f8cad214e8f6)
+[1.5.1]:
+  (https://github.com/ExodusMovement/exodus-web3/commit/0576160a36d260f5f63789ddd28c18c9d8885e7b)
+[2.0.0]:
+  (https://github.com/ExodusMovement/exodus-web3/commit/54f84cf089d1dffd5dafd443fc2aacb8dd0fc962)
+[2.1.1]:
+  (https://github.com/ExodusMovement/exodus-web3/commit/db3e8cfd7d2f3cb908bb675cff1ca7981bbd1b09)

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

@@ -0,0 +1,3 @@
+import type { createEvmDepsFactoryParams, EVMFactory } from '../types.js';
+declare const createEvmDepsFactory: ({ analytics, activeWalletAccountAtom, assetsModule, blockchainMetadata, feeMonitors, wallet, walletAccounts, }: createEvmDepsFactoryParams) => EVMFactory;
+export default createEvmDepsFactory;

package/lib/rpc-handlers/createEvmDeps.js

@@ -0,0 +1,113 @@
+import { fetchGasLimit, getNonce as apiGetNonce, getServer, } from '@exodus/ethereum-api';
+import BN from 'bn.js';
+const createEvmDepsFactory = ({ analytics, activeWalletAccountAtom, assetsModule, blockchainMetadata, feeMonitors, wallet, walletAccounts, }) => {
+    return (assetName, origin) => {
+        const asset = assetsModule.getAsset(assetName);
+        const server = getServer(asset);
+        const forwardRequest = async ({ method, params }) => {
+            if (server.proxyToCoinNode) {
+                return server.proxyToCoinNode({ method, params });
+            }
+            const request = server.buildRequest({ method, params });
+            return server.sendRequest(request);
+        };
+        const sendRawTransaction = async (rawTransaction) => {
+            return server.sendRawTransaction(rawTransaction);
+        };
+        const _getAccountIndexForActiveWalletAccount = async () => {
+            const walletAccount = await activeWalletAccountAtom.get();
+            const walletAccountData = walletAccounts.get(walletAccount);
+            if (!walletAccountData ||
+                walletAccountData.isHardware ||
+                walletAccountData.is2FA) {
+                throw new Error('Invalid walletAccount');
+            }
+            const accountIndex = walletAccountData.index;
+            return accountIndex;
+        };
+        const getAddress = async () => {
+            const accountIndex = await _getAccountIndexForActiveWalletAccount();
+            const { publicKey } = await wallet.getPublicKey({
+                baseAssetName: assetName,
+                accountIndex,
+            });
+            return '0x' + publicKey.toString('hex');
+        };
+        const getPrivateKey = async () => {
+            const accountIndex = await _getAccountIndexForActiveWalletAccount();
+            const { privateKey } = await wallet.getPrivateKey({
+                baseAssetName: assetName,
+                accountIndex,
+            });
+            return privateKey;
+        };
+        const getNonce = async () => {
+            const [baseAssetTxLog, blockchainNonce] = await Promise.all([
+                blockchainMetadata.getTxLog({
+                    assetName,
+                    walletAccount: await activeWalletAccountAtom.get(),
+                }),
+                apiGetNonce({ asset, address: await getAddress() }),
+            ]);
+            const walletNonce = Array.from(baseAssetTxLog)
+                .filter((tx) => tx.sent && !tx.dropped && tx.data.nonce != null)
+                .reduce((nonce, tx) => Math.max(tx.data.nonce + 1, nonce), 0);
+            return `0x${Math.max(walletNonce, blockchainNonce).toString(16)}`;
+        };
+        const getEstimatedGas = async (transaction) => {
+            const EXTRA_PERCENTAGE_GAS_LIMIT = 20;
+            const { data: txInput, from: fromAddress, to: toAddress, value: amount, } = transaction;
+            const gasLimit = await fetchGasLimit({
+                asset,
+                amount: amount
+                    ? asset.currency.baseUnit(new BN(amount.slice(2), 'hex'))
+                    : asset.currency.ZERO,
+                fromAddress,
+                toAddress,
+                txInput,
+                extraPercentage: EXTRA_PERCENTAGE_GAS_LIMIT,
+            });
+            return `0x${gasLimit.toString(16)}`;
+        };
+        const getFeeData = async () => {
+            const { eip1559Enabled, tipGasPrice, gasPrice: _gasPrice, } = await feeMonitors.getFeeData({
+                assetName,
+            });
+            const gasPrice = `0x${_gasPrice.toBaseNumber().toString(16)}`;
+            const feeData = {
+                gasPrice,
+            };
+            if (eip1559Enabled) {
+                feeData.maxPriorityFeePerGas = `0x${tipGasPrice
+                    .toBaseNumber()
+                    .toString(16)}`;
+                feeData.maxFeePerGas = gasPrice;
+            }
+            return feeData;
+        };
+        const trackWalletWatchAssetUse = async (assetDetails) => {
+            // TODO: do we still need this? If yes, this ...assetDetails expansion is no bueno
+            // why is this not always returning true in browser?
+            analytics.track({
+                event: 'DappWalletWatchAsset',
+                properties: {
+                    ...assetDetails,
+                    dappDomain: origin,
+                },
+            });
+            return true;
+        };
+        return {
+            chainId: 'undefined',
+            forwardRequest,
+            sendRawTransaction,
+            getAddress,
+            getPrivateKey,
+            getNonce,
+            getFeeData,
+            getEstimatedGas,
+            onEthWalletWatchAssetRequest: trackWalletWatchAssetUse,
+        };
+    };
+};
+export default createEvmDepsFactory;

package/lib/rpc-handlers/exposeHandlers.js

@@ -59,7 +59,7 @@ export function exposeHandlers(rpc, deps) {
     async function prepareTransaction(transaction) {
         const { gasPrice, maxFeePerGas, maxPriorityFeePerGas } = await getFeeData();
         const preparedTransaction = { ...transaction };
-        preparedTransaction.nonce = await getNonce(transaction.from);
+        preparedTransaction.nonce = await getNonce();
         if (!transaction.value) {
             preparedTransaction.value = '0x0';
         }

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

@@ -1,3 +1,4 @@
+export { default as createEvmDepsFactory } from './createEvmDeps.js';
 import type { EthRequestArguments } from '../types.js';
 import type { Dependencies } from '../types.js';
 import type RPC from '@exodus/json-rpc';
@@ -11,4 +12,3 @@ export declare const registerRPCHandlers: ({ deps, RPC, transport, }: {
     RPC: RpcConstructor;
     transport: Transport;
 }) => any;
-export {};

package/lib/rpc-handlers/index.js

@@ -2,6 +2,7 @@ import { RPC_REQUEST_TIMEOUT } from '@exodus/web3-constants';
 import { validate as validateDeps, validateCommonDeps, } from '@exodus/web3-rpc-handlers';
 import { exposeHandlers } from './exposeHandlers.js';
 import { validateRequest } from './validator.js';
+export { default as createEvmDepsFactory } from './createEvmDeps.js';
 const validateEVMDeps = (evm) => {
     const requiredKeys = [
         'chainId',

package/lib/rpc-handlers/parseAndValidateTypedData.js

@@ -20,6 +20,17 @@ export function parseAndValidateTypedData(typedData, { chainId: activeChainId })
     catch (e) {
         throw new InvalidInputError();
     }
+    // Security: checking if the 'message' property includes fields that don't belong to the primary type.
+    if (!Object.hasOwnProperty.call(parsedTypedData.types, parsedTypedData.primaryType)) {
+        throw new InvalidInputError();
+    }
+    const allowedFieldsSet = new Set(parsedTypedData.types[parsedTypedData.primaryType].map(({ name }) => name));
+    for (const field in parsedTypedData.message) {
+        if (!allowedFieldsSet.has(field)) {
+            throw new InvalidInputError(`field '${field}' is not defined in the primary type definition`);
+        }
+    }
+    // Security: checking if the requested chain matches the active chain ID.
     if (parsedTypedData?.domain?.chainId) {
         const suppliedChainIdHex = convertChainIdToHex(`${parsedTypedData.domain.chainId}`);
         if (activeChainId.toLowerCase() !== suppliedChainIdHex) {

package/lib/rpc-handlers/validator.js

@@ -611,7 +611,7 @@ export function validateRequest(value) {
       }
       return true
     }
-    const format5 = new RegExp('^(?!_)[\\s\\w!?.,/()[\\]]+$', '')
+    const format5 = new RegExp('^(?![\\s_])[\\s\\w!?.,/()[\\]]+$', '')
     const ref9 = function validate(data) {
       validate.errors = null
       if (!Array.isArray(data)) {
@@ -2348,7 +2348,7 @@ export function parseAndValidateTypedData(value) {
       /[\uD800-\uDFFF]/.test(string) ? [...string].length : string.length
     const pointerPart = (s) =>
       /~\//.test(s) ? `${s}`.replace(/~/g, '~0').replace(/\//g, '~1') : s
-    const format0 = new RegExp('^(?!_)[\\s\\w!?.,/()[\\]]+$', '')
+    const format0 = new RegExp('^(?![\\s_])[\\s\\w!?.,/()[\\]]+$', '')
     const ref2 = function validate(data) {
       validate.errors = null
       if (!(typeof data === 'object' && data && !Array.isArray(data))) {

package/lib/simulation/simulation.js

@@ -1,6 +1,6 @@
 import { retrieveSideEffects } from '@exodus/ethereum-api';
 import { SIMULATION_SUPPORTED_ASSET_NAMES } from './constant.js';
-import { createCurrency, formatAccounts, getEthereumDisplayInfo, hexToBN, isEthTransferTx, } from './utils.js';
+import { formatAccounts, getEthereumDisplayInfo, hexToBN, isEthTransferTx, } from './utils.js';
 const computeBalanceChanges = async (asset, shouldSimulate, transaction) => {
     let balanceChanges = {
         willReceive: [],
@@ -10,11 +10,7 @@ const computeBalanceChanges = async (asset, shouldSimulate, transaction) => {
     if (isEthTransferTx(transaction)) {
         const txValue = hexToBN(transaction.value).toString();
         balanceChanges.willSend.push({
-            balance: createCurrency({
-                amount: txValue,
-                denominator: asset.currency.defaultUnit.power,
-                symbol: asset.displayTicker,
-            }),
+            balance: asset.currency.baseUnit(txValue),
         });
     }
     else {

package/lib/types.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" resolution-mode="require"/>
 import type { EthTransaction, EthTransactionHash, EthWalletWatchAsset } from '@exodus/web3-ethereum-utils';
 import type { CommonDeps } from '@exodus/web3-rpc-handlers';
+import type { IAnalyticsModule, IActiveWalletAccountAtom, IAssetsModule, IBlockchainMetadataModule, IFeeDataModule, IWalletModule, IWalletAccountsModule } from '@exodus/web3-types';
 /**
  * EVM-compatible chains.
  */
@@ -8,11 +9,21 @@ export interface EthRequestArguments {
     method: string;
     params?: unknown[] | Record<string, unknown>;
 }
-interface FeeData {
+export interface FeeData {
     gasPrice: string;
     maxFeePerGas?: string;
     maxPriorityFeePerGas?: string;
 }
+export interface createEvmDepsFactoryParams {
+    activeWalletAccountAtom: IActiveWalletAccountAtom;
+    analytics: IAnalyticsModule;
+    assetsModule: IAssetsModule;
+    blockchainMetadata: IBlockchainMetadataModule;
+    feeMonitors: IFeeDataModule;
+    wallet: IWalletModule;
+    walletAccounts: IWalletAccountsModule;
+}
+export declare type EVMFactory = (assetName: string, origin: string) => EVMDeps;
 export declare type EVMDeps = {
     chainId: string;
     getAddress: () => Promise<string>;
@@ -20,11 +31,10 @@ export declare type EVMDeps = {
     sendRawTransaction: (rawTransaction: string) => Promise<EthTransactionHash>;
     getEstimatedGas: (transaction: EthTransaction) => Promise<string>;
     getFeeData: () => Promise<FeeData>;
-    getNonce: (account: string) => Promise<string>;
+    getNonce: () => Promise<string>;
     forwardRequest: (args: EthRequestArguments) => Promise<unknown>;
     onEthWalletWatchAssetRequest?: (assetDetails: EthWalletWatchAsset) => Promise<boolean>;
 };
 export declare type Dependencies = {
     evms: EVMDeps[];
 } & CommonDeps;
-export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/web3-ethereum",
   "description": "Apps connectivity library for EVM-compatible chains.",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -33,22 +33,22 @@
   "dependencies": {
     "@exodus/currency": "^2.1.2",
     "@exodus/ethereum-api": "^6.0.0",
-    "@exodus/web3-constants": "^1.18.0",
+    "@exodus/web3-constants": "^1.19.0",
     "@exodus/web3-ethereum-utils": "^1.8.0",
-    "@exodus/web3-provider": "^2.16.0",
-    "@exodus/web3-rpc-handlers": "^0.13.0",
+    "@exodus/web3-provider": "^2.17.0",
+    "@exodus/web3-rpc-handlers": "^0.14.0",
+    "bn.js": "^5.2.0",
     "eth-rpc-errors": "^4.0.3"
   },
   "devDependencies": {
     "@exodus/assets": "^8.0.72",
     "@exodus/json-rpc": "^1.11.0",
     "@exodus/schemasafe": "^1.0.0",
-    "@exodus/web3-types": "^1.14.0",
+    "@exodus/web3-types": "^1.15.0",
     "@exodus/web3-validation": "^1.33.0",
     "@wallet-standard/base": "^1.0.1"
   },
   "peerDependencies": {
     "@exodus/assets": "^8.0.72"
-  },
-  "gitHead": "3bfe3ffd37584b844b60cef81a2d951cb867438e"
+  }
 }