@exodus/web3-ethereum 2.3.0 → 2.4.1

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,116 @@
+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 (account) => {
+            // Shouldn't we retrieve the nonce for a given account?
+            // We are relying on the assumption here that "account"
+            // is always equal to the activeWalletAccount.
+            const [baseAssetTxLog, blockchainNonce] = await Promise.all([
+                blockchainMetadata.getTxLog({
+                    assetName,
+                    walletAccount: await activeWalletAccountAtom.get(),
+                }),
+                apiGetNonce({ asset, address: account }),
+            ]);
+            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/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.d.ts

@@ -1,5 +1,6 @@
-import type { Asset, EthBalanceChanges } from './types.js';
+import type { EthBalanceChanges } from './types.js';
 import type { EthTransaction } from '@exodus/web3-ethereum-utils';
+import type { Asset, NumberUnit } from '@exodus/web3-types';
 export declare const simulateTransaction: (asset: Asset, transaction: EthTransaction) => Promise<{
     assetName: string;
     advancedDetails: never[];
@@ -7,7 +8,7 @@ export declare const simulateTransaction: (asset: Asset, transaction: EthTransac
     displayInfo: {
         title: string;
     };
-    txFee: unknown;
+    txFee: NumberUnit;
     txFeeDetails: {
         gasLimit: number;
         maxFeePerGas: number | undefined;

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/simulation/types.d.ts

@@ -1,5 +1,3 @@
-import type { Asset } from '@exodus/web3-types';
-export { Asset };
 export interface CurrencyParams {
     amount: string;
     symbol: string;

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>;
@@ -27,4 +38,3 @@ export declare type EVMDeps = {
 export declare type Dependencies = {
     evms: EVMDeps[];
 } & CommonDeps;
-export {};

package/lib/wallet-standard/wallet.d.ts

@@ -1,7 +1,7 @@
 import type { EthereumProvider } from '../provider/provider.js';
 import type { Wallet } from '@wallet-standard/base';
 export declare type EthereumProviderFeature = {
-    'ethereum:provider': {
+    'eip1193:provider': {
         provider: EthereumProvider;
     };
 };

package/lib/wallet-standard/wallet.js

@@ -18,7 +18,7 @@ export class ExodusEthereumWallet {
     }
     get features() {
         return {
-            'ethereum:provider': {
+            'eip1193:provider': {
                 provider: this.#provider,
             },
         };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/web3-ethereum",
   "description": "Apps connectivity library for EVM-compatible chains.",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -33,22 +33,23 @@
   "dependencies": {
     "@exodus/currency": "^2.1.2",
     "@exodus/ethereum-api": "^6.0.0",
-    "@exodus/web3-constants": "^1.17.0",
+    "@exodus/web3-constants": "^1.19.0",
     "@exodus/web3-ethereum-utils": "^1.8.0",
-    "@exodus/web3-provider": "^2.15.0",
-    "@exodus/web3-rpc-handlers": "^0.12.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.13.0",
-    "@exodus/web3-validation": "^1.32.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": "d9f5deb5407eeaaf0976c35fb597d337d6a02153"
+  "gitHead": "6516ee0735272140b1c48527bf98ed3b7bc54499"
 }