@exodus/web3-ethereum 10.7.0 → 11.0.0

package/lib/rpc-handlers/createEvmDeps.js

@@ -1,7 +1,16 @@
 import { fetchGasLimit, getNonce as apiGetNonce, getServer, } from '@exodus/ethereum-api';
+import { InvalidInputError } from '@exodus/web3-errors';
+import { signMessage, signTypedData } from '@exodus/web3-ethereum-utils';
+import { SignTypedDataVersion } from '@metamask/eth-sig-util';
 import BN from 'bn.js';
+async function getDefaultPurposeForLedger(asset) {
+    const purposes = await asset.api.getSupportedPurposes({
+        compatibilityMode: 'ledger',
+    });
+    return purposes[0];
+}
 const createEvmDepsFactory = ({ analytics, blockchainMetadata, }) => {
-    return ({ assetName, origin, getAsset, getAddress: _getAddress, getPrivateKey: _getPrivateKey, getFeeData: getFeeConfig, getCustomFeeRate, getActiveWalletAccount, simulateEthereumTransactions, }) => {
+    return ({ assetName, origin, getAsset, getAddress: _getAddress, getPrivateKey: _getPrivateKey, getFeeData: getFeeConfig, getCustomFeeRate, getActiveWalletAccount, simulateEthereumTransactions, getActiveWalletAccountData, transactionSigner, getLedgerDevice, }) => {
         const asset = getAsset(assetName);
         const server = getServer(asset);
         const forwardRequest = async ({ method, params }) => {
@@ -107,6 +116,44 @@ const createEvmDepsFactory = ({ analytics, blockchainMetadata, }) => {
             });
             return true;
         };
+        const messageSigner = {
+            signMessage: async ({ baseAssetName, walletAccount, message, }) => {
+                const { rawMessage, EIP712Message } = message;
+                if (walletAccount.source === 'exodus') {
+                    const privateKey = await getPrivateKey();
+                    if (rawMessage) {
+                        return Buffer.from(signMessage(rawMessage.toString(), privateKey));
+                    }
+                    if (EIP712Message) {
+                        const typedDataVersion = Array.isArray(EIP712Message)
+                            ? SignTypedDataVersion.V1
+                            : SignTypedDataVersion.V4;
+                        return Buffer.from(signTypedData(EIP712Message, privateKey, typedDataVersion));
+                    }
+                }
+                else if (getLedgerDevice) {
+                    const device = await getLedgerDevice();
+                    const purpose = await getDefaultPurposeForLedger(asset);
+                    const { derivationPath } = await getAsset(assetName).baseAsset.api.getKeyIdentifier({
+                        compatibilityMode: 'ledger',
+                        purpose,
+                        accountIndex: 0,
+                        chainIndex: 0,
+                        addressIndex: 0,
+                    });
+                    const signedMessage = await device.signMessage({
+                        assetName: baseAssetName,
+                        derivationPath,
+                        message: {
+                            rawMessage,
+                            EIP712Message,
+                        },
+                    });
+                    return Buffer.from(signedMessage);
+                }
+                throw new InvalidInputError();
+            },
+        };
         return {
             chainId: 'undefined',
             forwardRequest,
@@ -119,6 +166,9 @@ const createEvmDepsFactory = ({ analytics, blockchainMetadata, }) => {
             getCustomFeeData,
             onEthWalletWatchAssetRequest: trackWalletWatchAssetUse,
             simulateEthereumTransactions,
+            transactionSigner,
+            messageSigner,
+            getActiveWalletAccountData,
         };
     };
 };

package/lib/rpc-handlers/exposeHandlers.js

@@ -1,5 +1,4 @@
 import { AssetNotSupportedError, InvalidInputError, UnauthorizedError, UserRejectedRequestError, } from '@exodus/web3-errors';
-import { getTransactionId, signMessage, signTransaction, signTypedData, } from '@exodus/web3-ethereum-utils';
 import { connect } from '@exodus/web3-rpc-handlers';
 import { hexToBN } from '@exodus/web3-utils';
 import { SignTypedDataVersion } from '@metamask/eth-sig-util';
@@ -62,7 +61,7 @@ const isValidGasLimitValue = (value) => {
     return proposedGasLimit.lte(maximumBlockGasLimit);
 };
 export function exposeHandlers(rpc, deps) {
-    const { chainId, isTrusted, isAutoApproved, ensureTrusted, approveConnection, approveMessage, approveTransactions, forwardRequest, getAddress, getPrivateKey, getEstimatedGas, getCustomFeeData, getFeeData, getNonce, sendRawTransaction, simulateEthereumTransactions, scanDomains, onTransactionsSigned = () => { }, onEthWalletWatchAssetRequest = () => { }, isUnlocked = () => true, ensureUnlocked = async () => true, getAsset, getOrigin, } = deps;
+    const { chainId, isTrusted, isAutoApproved, ensureTrusted, approveConnection, approveMessage, approveTransactions, forwardRequest, getAddress, getEstimatedGas, getCustomFeeData, getFeeData, getNonce, sendRawTransaction, simulateEthereumTransactions, scanDomains, onTransactionsSigned = () => { }, onEthWalletWatchAssetRequest = () => { }, isUnlocked = () => true, ensureUnlocked = async () => true, getAsset, getOrigin, getActiveWalletAccountData, transactionSigner, messageSigner, } = deps;
     const network = `evm:${chainId}`;
     async function assertTrusted() {
         const trusted = await isTrusted();
@@ -142,26 +141,48 @@ export function exposeHandlers(rpc, deps) {
         });
         await approve(approveTransactions, network, simulatedChanges);
         const modifiedTransaction = await applyCustomFeeRate(preparedTransaction);
-        const privateKey = await getPrivateKey();
-        const signedTransaction = signTransaction({ ...modifiedTransaction, chainId }, privateKey);
         const isEIP1559Enabled = !!modifiedTransaction.maxFeePerGas;
-        const transactionId = getTransactionId(signedTransaction, isEIP1559Enabled);
-        onTransactionsSigned(network, [transactionId]);
-        return `0x${signedTransaction.toString('hex')}`;
+        const walletAccount = await getActiveWalletAccountData();
+        const { rawTx: signedTransaction, txId } = await transactionSigner.signTransaction({
+            baseAssetName: asset.baseAssetName,
+            walletAccount,
+            unsignedTx: {
+                txData: { transaction: { ...modifiedTransaction, chainId } },
+                txMeta: { eip1559Enabled: isEIP1559Enabled },
+            },
+        });
+        onTransactionsSigned(network, [txId]);
+        return `0x${Buffer.from(signedTransaction).toString('hex')}`;
     }
     async function approveAndSignMessage(message) {
         await assertTrusted();
         await approve(approveMessage, network, message);
-        const privateKey = await getPrivateKey();
-        return signMessage(message, privateKey);
+        const walletAccount = await getActiveWalletAccountData();
+        const asset = await getAsset(network);
+        const signedMessageBuffer = await messageSigner.signMessage({
+            walletAccount,
+            baseAssetName: asset.baseAssetName,
+            message: {
+                rawMessage: Buffer.from(message),
+            },
+        });
+        return signedMessageBuffer.toString();
     }
     async function approveAndSignTypedData(typedData) {
         await assertTrusted();
         const parsedTypedData = parseAndValidateTypedData(typedData, { chainId });
         const message = typedDataToMessage(typedData, SignTypedDataVersion.V4);
         await approve(approveMessage, network, message);
-        const privateKey = await getPrivateKey();
-        return signTypedData(parsedTypedData, privateKey, SignTypedDataVersion.V4);
+        const walletAccount = await getActiveWalletAccountData();
+        const asset = await getAsset(network);
+        const signedMessageBuffer = await messageSigner.signMessage({
+            walletAccount,
+            baseAssetName: asset.baseAssetName,
+            message: {
+                EIP712Message: parsedTypedData,
+            },
+        });
+        return signedMessageBuffer.toString();
     }
     function exposeEvmFunction(name, 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -203,8 +224,16 @@ export function exposeHandlers(rpc, deps) {
         await assertTrusted();
         const message = typedDataToMessage(typedData, SignTypedDataVersion.V1);
         await approve(approveMessage, network, message);
-        const privateKey = await getPrivateKey();
-        return signTypedData(typedData, privateKey, SignTypedDataVersion.V1);
+        const walletAccount = await getActiveWalletAccountData();
+        const asset = await getAsset(network);
+        const signedMessageBuffer = await messageSigner.signMessage({
+            walletAccount,
+            baseAssetName: asset.baseAssetName,
+            message: {
+                EIP712Message: typedData,
+            },
+        });
+        return signedMessageBuffer.toString();
     });
     exposeEvmFunction('eth_signTypedData_v3', async (account, typedData) => approveAndSignTypedData(typedData));
     exposeEvmFunction('eth_signTypedData_v4', async (account, typedData) => approveAndSignTypedData(typedData));

package/lib/rpc-handlers/index.js

@@ -15,6 +15,9 @@ const validateEVMDeps = (evm) => {
         'getNonce',
         'sendRawTransaction',
         'simulateEthereumTransactions',
+        'getActiveWalletAccountData',
+        'transactionSigner',
+        'messageSigner',
     ];
     const optionalKeys = ['onEthWalletWatchAssetRequest'];
     validateDeps(evm, requiredKeys, optionalKeys);

package/lib/types.d.ts

@@ -1,9 +1,12 @@
 /// <reference types="node" resolution-mode="require"/>
 import type { EthereumProvider } from './provider/index.js';
 import type { EthAggregatedTransactionSimulationResult, EthSimulateTransactionParams, EthTransaction, EthTransactionHash, EthWalletWatchAsset } from '@exodus/web3-ethereum-utils';
+import type { EthTransactionParams } from '@exodus/web3-ethereum-utils';
 import type { WalletStandardCommonDeps } from '@exodus/web3-provider';
 import type { CommonDeps } from '@exodus/web3-rpc-handlers';
-import type { Asset, IAnalyticsModule, IBlockchainMetadataModule, EthereumFeeData, GetFeeDataParams, CreateSimulationServiceParams, NumberUnit } from '@exodus/web3-types';
+import type { Asset, CreateSimulationServiceParams, EthereumFeeData, GetActiveWalletAccountData, GetFeeDataParams, GetLedgerDevice, IAnalyticsModule, IBlockchainMetadataModule, IMessageSignerModule, ITransactionSignerModule, NumberUnit } from '@exodus/web3-types';
+import type { TypedDataV1 } from '@metamask/eth-sig-util';
+import type { MessageTypes, TypedMessage } from '@metamask/eth-sig-util/sign-typed-data';
 /**
  * EVM-compatible chains.
  */
@@ -34,8 +37,12 @@ export interface CreateEvmDepsParams {
         privateKey: Buffer;
     }>;
     simulateEthereumTransactions: SimulateTransactionsFn;
+    getActiveWalletAccountData: GetActiveWalletAccountData;
+    transactionSigner: EVMTransactionSignerModule;
+    getLedgerDevice?: GetLedgerDevice;
 }
 export declare type EVMFactory = (params: CreateEvmDepsParams) => EVMDeps;
+export declare type EVMTransactionSignerModule = ITransactionSignerModule<EVMUnsignedTransaction>;
 export declare type EVMDeps = {
     chainId: string;
     getAddress: () => Promise<string>;
@@ -47,7 +54,10 @@ export declare type EVMDeps = {
     getCustomFeeData: () => Promise<FeeData | undefined>;
     getNonce: () => Promise<string>;
     forwardRequest: (args: EthRequestArguments) => Promise<unknown>;
+    transactionSigner: EVMTransactionSignerModule;
+    messageSigner: EVMMessageSigner;
     onEthWalletWatchAssetRequest?: (assetDetails: EthWalletWatchAsset) => Promise<boolean>;
+    getActiveWalletAccountData: GetActiveWalletAccountData;
 };
 export declare type Dependencies = {
     evms: EVMDeps[];
@@ -55,4 +65,17 @@ export declare type Dependencies = {
 export interface WalletStandardDeps extends WalletStandardCommonDeps {
     provider: EthereumProvider;
 }
+export interface EVMUnsignedTransaction {
+    txData: {
+        transaction: EthTransactionParams;
+    };
+    txMeta: {
+        eip1559Enabled: boolean;
+    };
+}
+export interface EVMMesage {
+    rawMessage?: Buffer;
+    EIP712Message?: TypedDataV1 | TypedMessage<MessageTypes>;
+}
+export declare type EVMMessageSigner = IMessageSignerModule<EVMMesage>;
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/web3-ethereum",
   "description": "Apps connectivity library for EVM-compatible chains.",
-  "version": "10.7.0",
+  "version": "11.0.0",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -33,10 +33,10 @@
     "@exodus/currency": "^2.1.2",
     "@exodus/ethereum-api": "^6.3.33",
     "@exodus/web3-constants": "^1.29.0",
-    "@exodus/web3-ethereum-utils": "^3.16.0",
-    "@exodus/web3-provider": "^3.7.0",
-    "@exodus/web3-rpc-handlers": "^2.13.0",
-    "@exodus/web3-utils": "^1.37.0",
+    "@exodus/web3-ethereum-utils": "^3.17.0",
+    "@exodus/web3-provider": "^3.8.0",
+    "@exodus/web3-rpc-handlers": "^2.14.0",
+    "@exodus/web3-utils": "^1.38.0",
     "bn.js": "^5.2.0",
     "eth-rpc-errors": "^4.0.3"
   },
@@ -44,12 +44,12 @@
     "@exodus/assets": "^8.0.95",
     "@exodus/json-rpc": "^1.11.0",
     "@exodus/schemasafe": "^1.0.0",
-    "@exodus/web3-types": "^1.43.0",
+    "@exodus/web3-types": "^1.44.0",
     "@exodus/web3-validation": "^1.37.0",
     "@wallet-standard/base": "^1.0.1"
   },
   "peerDependencies": {
     "@exodus/assets": "^8.0.95"
   },
-  "gitHead": "07e0d01d5ba64f77d04412d71195bf4eaf1c09cb"
+  "gitHead": "273234a09070d3d7ce08d77cace39695fc27b2c8"
 }