@exodus/web3-ethereum 9.0.0 → 9.2.0

package/lib/rpc-handlers/createEvmDeps.js

@@ -1,7 +1,7 @@
 import { fetchGasLimit, getNonce as apiGetNonce, getServer, } from '@exodus/ethereum-api';
 import BN from 'bn.js';
 const createEvmDepsFactory = ({ analytics, blockchainMetadata, }) => {
-    return ({ assetName, origin, getAsset, getAddress: _getAddress, getPrivateKey: _getPrivateKey, getFeeData: getFeeConfig, getActiveWalletAccount, simulateEthereumTransactions, }) => {
+    return ({ assetName, origin, getAsset, getAddress: _getAddress, getPrivateKey: _getPrivateKey, getFeeData: getFeeConfig, getCustomFeeRate, getActiveWalletAccount, simulateEthereumTransactions, }) => {
         const asset = getAsset(assetName);
         const server = getServer(asset);
         const forwardRequest = async ({ method, params }) => {
@@ -53,6 +53,7 @@ const createEvmDepsFactory = ({ analytics, blockchainMetadata, }) => {
             const { eip1559Enabled, tipGasPrice, gasPrice: _gasPrice, } = await getFeeConfig({
                 assetName,
             });
+            // gasPrice is actually maxFeePerGas if eip1559 is true
             const gasPrice = `0x${_gasPrice.toBaseNumber().toString(16)}`;
             const feeData = {
                 gasPrice,
@@ -65,6 +66,35 @@ const createEvmDepsFactory = ({ analytics, blockchainMetadata, }) => {
             }
             return feeData;
         };
+        const getCustomFeeData = async () => {
+            const _maxFeePerGas = await getCustomFeeRate?.();
+            if (!_maxFeePerGas) {
+                // The user did not select a custom fee rate or
+                // we didn't supply the function, eitherway nothing should happen.
+                return undefined;
+            }
+            const { eip1559Enabled, baseFeePerGas } = await getFeeConfig({
+                assetName,
+            });
+            const maxFeePerGas = `0x${_maxFeePerGas.toBaseNumber().toString(16)}`;
+            const feeData = {
+                // If no eip1559 support, so set it to the max
+                // Otherwise ignored
+                gasPrice: maxFeePerGas,
+            };
+            if (eip1559Enabled) {
+                feeData.maxFeePerGas = maxFeePerGas;
+                // If our custom fee rate is higher than the base fee rate
+                // then compute the priority / tip fee.
+                if (baseFeePerGas && _maxFeePerGas.gt(baseFeePerGas)) {
+                    const maxPriorityFeePerGas = _maxFeePerGas.sub(baseFeePerGas);
+                    feeData.maxPriorityFeePerGas = `0x${maxPriorityFeePerGas
+                        .toBaseNumber()
+                        .toString(16)}`;
+                }
+            }
+            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?
@@ -86,6 +116,7 @@ const createEvmDepsFactory = ({ analytics, blockchainMetadata, }) => {
             getNonce,
             getFeeData,
             getEstimatedGas,
+            getCustomFeeData,
             onEthWalletWatchAssetRequest: trackWalletWatchAssetUse,
             simulateEthereumTransactions,
         };

package/lib/rpc-handlers/exposeHandlers.js

@@ -62,7 +62,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, 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, getPrivateKey, getEstimatedGas, getCustomFeeData, getFeeData, getNonce, sendRawTransaction, simulateEthereumTransactions, scanDomains, onTransactionsSigned = () => { }, onEthWalletWatchAssetRequest = () => { }, isUnlocked = () => true, ensureUnlocked = async () => true, getAsset, getOrigin, } = deps;
     const network = `evm:${chainId}`;
     async function assertTrusted() {
         const trusted = await isTrusted();
@@ -72,18 +72,19 @@ export function exposeHandlers(rpc, deps) {
     }
     async function prepareTransaction(transaction) {
         const { gasPrice, maxFeePerGas, maxPriorityFeePerGas } = await getFeeData();
+        const eip1559Enabled = maxFeePerGas !== undefined && maxPriorityFeePerGas !== undefined;
         const preparedTransaction = { ...transaction };
         preparedTransaction.nonce = await getNonce();
         if (!transaction.value) {
             preparedTransaction.value = '0x0';
         }
-        if (!transaction.gasPrice) {
+        if (!transaction.gasPrice && !eip1559Enabled) {
             preparedTransaction.gasPrice = gasPrice;
         }
-        if (!transaction.maxFeePerGas && maxFeePerGas) {
+        if (!transaction.maxFeePerGas && eip1559Enabled) {
             preparedTransaction.maxFeePerGas = maxFeePerGas;
         }
-        if (!transaction.maxPriorityFeePerGas && maxPriorityFeePerGas) {
+        if (!transaction.maxPriorityFeePerGas && eip1559Enabled) {
             preparedTransaction.maxPriorityFeePerGas = maxPriorityFeePerGas;
         }
         if (!transaction.data) {
@@ -95,6 +96,16 @@ export function exposeHandlers(rpc, deps) {
         }
         return preparedTransaction;
     }
+    async function applyCustomFeeRate(transaction) {
+        const feeData = await getCustomFeeData();
+        if (feeData) {
+            const { gasPrice, maxFeePerGas, maxPriorityFeePerGas } = feeData;
+            return { ...transaction, gasPrice, maxFeePerGas, maxPriorityFeePerGas };
+        }
+        else {
+            return transaction;
+        }
+    }
     function validateTransaction(transaction) {
         const gasKeys = [
             'gas',
@@ -130,9 +141,10 @@ export function exposeHandlers(rpc, deps) {
             origin,
         });
         await approve(approveTransactions, network, simulatedChanges);
+        const modifiedTransaction = await applyCustomFeeRate(preparedTransaction);
         const privateKey = await getPrivateKey();
-        const signedTransaction = signTransaction({ ...preparedTransaction, chainId }, privateKey);
-        const isEIP1559Enabled = !!preparedTransaction.maxFeePerGas;
+        const signedTransaction = signTransaction({ ...modifiedTransaction, chainId }, privateKey);
+        const isEIP1559Enabled = !!modifiedTransaction.maxFeePerGas;
         const transactionId = getTransactionId(signedTransaction, isEIP1559Enabled);
         onTransactionsSigned(network, [transactionId]);
         return `0x${signedTransaction.toString('hex')}`;

package/lib/rpc-handlers/index.js

@@ -11,6 +11,7 @@ const validateEVMDeps = (evm) => {
         'getPrivateKey',
         'getEstimatedGas',
         'getFeeData',
+        'getCustomFeeData',
         'getNonce',
         'sendRawTransaction',
         'simulateEthereumTransactions',

package/lib/types.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" resolution-mode="require"/>
 import type { EthAggregatedTransactionSimulationResult, EthSimulateTransactionParams, EthTransaction, EthTransactionHash, EthWalletWatchAsset } from '@exodus/web3-ethereum-utils';
 import type { CommonDeps } from '@exodus/web3-rpc-handlers';
-import type { Asset, IAnalyticsModule, IBlockchainMetadataModule, EthereumFeeData, GetFeeDataParams, CreateSimulationServiceParams } from '@exodus/web3-types';
+import type { Asset, IAnalyticsModule, IBlockchainMetadataModule, EthereumFeeData, GetFeeDataParams, CreateSimulationServiceParams, NumberUnit } from '@exodus/web3-types';
 /**
  * EVM-compatible chains.
  */
@@ -27,6 +27,7 @@ export interface CreateEvmDepsParams {
     getActiveWalletAccount: () => Promise<string>;
     getAsset: (assetName: string) => Asset;
     getFeeData: ({ assetName }: GetFeeDataParams) => Promise<EthereumFeeData>;
+    getCustomFeeRate?: () => Promise<NumberUnit>;
     getPrivateKey: (assetName: string) => Promise<{
         privateKey: Buffer;
     }>;
@@ -41,6 +42,7 @@ export declare type EVMDeps = {
     simulateEthereumTransactions: SimulateTransactionsFn;
     getEstimatedGas: (transaction: EthTransaction) => Promise<string>;
     getFeeData: () => Promise<FeeData>;
+    getCustomFeeData: () => Promise<FeeData | undefined>;
     getNonce: () => Promise<string>;
     forwardRequest: (args: EthRequestArguments) => Promise<unknown>;
     onEthWalletWatchAssetRequest?: (assetDetails: EthWalletWatchAsset) => Promise<boolean>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/web3-ethereum",
   "description": "Apps connectivity library for EVM-compatible chains.",
-  "version": "9.0.0",
+  "version": "9.2.0",
   "type": "module",
   "sideEffects": false,
   "module": "lib/index.js",
@@ -33,10 +33,10 @@
     "@exodus/currency": "^2.1.2",
     "@exodus/ethereum-api": "^6.0.0",
     "@exodus/web3-constants": "^1.29.0",
-    "@exodus/web3-ethereum-utils": "^3.5.0",
-    "@exodus/web3-provider": "^2.37.0",
-    "@exodus/web3-rpc-handlers": "^2.4.0",
-    "@exodus/web3-utils": "^1.27.0",
+    "@exodus/web3-ethereum-utils": "^3.7.0",
+    "@exodus/web3-provider": "^2.38.0",
+    "@exodus/web3-rpc-handlers": "^2.5.0",
+    "@exodus/web3-utils": "^1.28.0",
     "bn.js": "^5.2.0",
     "eth-rpc-errors": "^4.0.3"
   },
@@ -44,12 +44,12 @@
     "@exodus/assets": "^8.0.72",
     "@exodus/json-rpc": "^1.11.0",
     "@exodus/schemasafe": "^1.0.0",
-    "@exodus/web3-types": "^1.35.0",
+    "@exodus/web3-types": "^1.36.0",
     "@exodus/web3-validation": "^1.37.0",
     "@wallet-standard/base": "^1.0.1"
   },
   "peerDependencies": {
     "@exodus/assets": "^8.0.72"
   },
-  "gitHead": "8a63b2eaf2e1b184b0d8556ac2010d1c95e37742"
+  "gitHead": "ad7cf0bf015329652410c87a33327515fed9fe42"
 }