@toruslabs/ethereum-controllers 8.4.7 → 8.5.0

package/dist/lib.cjs/Network/NetworkController.js

@@ -16,7 +16,8 @@ class NetworkController extends baseControllers.BaseController {
   constructor({
     config,
     state,
-    idleTimeTracker
+    idleTimeTracker,
+    analytics
   }) {
     super({
       config,
@@ -30,6 +31,7 @@ class NetworkController extends baseControllers.BaseController {
     _defineProperty(this, "blockTracker", null);
     _defineProperty(this, "baseProviderHandlers", void 0);
     _defineProperty(this, "idleTimeTracker", void 0);
+    _defineProperty(this, "analytics", void 0);
     this.defaultState = {
       chainId: "loading",
       properties: {
@@ -37,6 +39,7 @@ class NetworkController extends baseControllers.BaseController {
       },
       providerConfig: constants.SUPPORTED_NETWORKS[constants.MAINNET_CHAIN_ID]
     };
+    this.analytics = analytics;
     // when a new network is set,
     // we set to loading first and
     // then when connection succeeds,
@@ -147,8 +150,12 @@ class NetworkController extends baseControllers.BaseController {
     networkMiddleware,
     blockTracker
   }) {
-    const ethereumMiddleware = createEthereumMiddleware.createEthereumMiddleware(this.baseProviderHandlers);
+    const ethereumMiddleware = createEthereumMiddleware.createEthereumMiddleware(this.baseProviderHandlers, this.analytics);
     const engine = new auth.JRPCEngine();
+    engine.push(baseControllers.createAnalyticsMiddleware({
+      analytics: this.analytics,
+      providerConfig: this.getProviderConfig()
+    }));
     engine.push(ethereumMiddleware);
     engine.push(networkMiddleware);
     const provider = auth.providerFromEngine(engine);
@@ -183,7 +190,7 @@ class NetworkController extends baseControllers.BaseController {
     this.blockTracker = blockTracker;
   }
   configureStandardProvider(providerConfig) {
-    const networkClient = createJsonRpcClient.createJsonRpcClient(providerConfig, this.config, this.idleTimeTracker);
+    const networkClient = createJsonRpcClient.createJsonRpcClient(providerConfig, this.config, this.idleTimeTracker, this.analytics);
     log.info("networkClient", networkClient);
     this.setNetworkClient(networkClient);
   }

package/dist/lib.cjs/Network/createEthereumMiddleware.js

@@ -48,7 +48,7 @@ function createProcessEstimateUserOperationGasMiddleware({
     const {
       method
     } = request;
-    if (method !== constants.METHOD_TYPES.ETH_ESTIMATE_USER_OPERATION_GAS) return next();
+    if (method !== constants.METHOD_TYPES.ETH_ESTIMATE_AA_TRANSACTION_GAS) return next();
     if (!processEstimateUserOperationGas) throw new Error("WalletMiddleware - opts.processEstimateUserOperationGas not provided");
     response.result = await processEstimateUserOperationGas(request.params, request);
   });
@@ -295,15 +295,33 @@ function createRequestAccountsMiddleware({
  */
 function createAAMiddleware({
   bundlerUrl,
-  paymasterUrl
+  paymasterUrl,
+  analytics
 }) {
   // forward request to bundler/paymaster
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const middlewares = [];
+  // NOTE: bundler/paymaster rpc only accept number as request id, we need to handle that here if client doesn't handle request id themselves
+  const idNumberRemapMiddleware = (req, res, next, _end) => {
+    // skip if not bundler/paymaster methods
+    if (!constants.BUNDLER_METHOD_TYPES.includes(req.method) && !constants.PAYMASTER_METHOD_TYPES.includes(req.method)) {
+      return next();
+    }
+    const originalId = req.id;
+    const newId = Math.floor(Math.random() * 1000000);
+    req.id = newId;
+    res.id = newId;
+    next(done => {
+      req.id = originalId;
+      res.id = originalId;
+      done();
+    });
+  };
   const bundlerFetchMiddleware = baseControllers.createFetchMiddleware({
-    rpcTarget: bundlerUrl
+    rpcTarget: bundlerUrl,
+    analytics
   });
-  // NOTE: bundler/paymaster rpc only accept number as request id, we might need to handle that here if client doesn't handle request id themselves
+  middlewares.push(idNumberRemapMiddleware);
   middlewares.push((request, response, next, end) => {
     if (!constants.BUNDLER_METHOD_TYPES.includes(request.method)) {
       return next();
@@ -312,7 +330,8 @@ function createAAMiddleware({
   });
   if (paymasterUrl) {
     const paymasterFetchMiddleware = baseControllers.createFetchMiddleware({
-      rpcTarget: paymasterUrl
+      rpcTarget: paymasterUrl,
+      analytics
     });
     middlewares.push((request, response, next, end) => {
       if (!constants.PAYMASTER_METHOD_TYPES.includes(request.method)) {
@@ -323,7 +342,7 @@ function createAAMiddleware({
   }
   return auth.mergeMiddleware(middlewares);
 }
-function createEthereumMiddleware(providerHandlers) {
+function createEthereumMiddleware(providerHandlers, analytics) {
   const {
     requestAccounts,
     getAccounts,
@@ -377,7 +396,8 @@ function createEthereumMiddleware(providerHandlers) {
   if (aaConfig) {
     middlewares.push(createAAMiddleware({
       bundlerUrl: aaConfig.bundlerUrl,
-      paymasterUrl: aaConfig.paymasterUrl
+      paymasterUrl: aaConfig.paymasterUrl,
+      analytics
     }));
   }
   return auth.mergeMiddleware(middlewares);

package/dist/lib.cjs/Network/createJsonRpcClient.js

@@ -29,13 +29,14 @@ function createProviderConfigMiddleware(providerConfig) {
     return next();
   };
 }
-function createJsonRpcClient(providerConfig, networkConfig, idleTimeTracker) {
+function createJsonRpcClient(providerConfig, networkConfig, idleTimeTracker, analytics) {
   const {
     chainId,
     rpcTarget
   } = providerConfig;
   const fetchMiddleware = baseControllers.createFetchMiddleware({
-    rpcTarget
+    rpcTarget,
+    analytics
   });
   const blockProvider = auth.providerFromMiddleware(fetchMiddleware);
   const blockTracker = new PollingBlockTracker.PollingBlockTracker({

package/dist/lib.cjs/types/Network/NetworkController.d.ts

@@ -1,4 +1,4 @@
-import { BaseController, IdleTimeTracker, INetworkController } from "@toruslabs/base-controllers";
+import { type Analytics, BaseController, IdleTimeTracker, INetworkController } from "@toruslabs/base-controllers";
 import { SafeEventEmitterProvider } from "@web3auth/auth";
 import { PollingBlockTracker } from "../Block/PollingBlockTracker";
 import { EthereumNetworkConfig, EthereumNetworkState, EthereumProviderConfig, NetworkControllerEvents } from "../utils/interfaces";
@@ -12,10 +12,12 @@ export declare class NetworkController extends BaseController<EthereumNetworkCon
     private blockTracker?;
     private baseProviderHandlers;
     private idleTimeTracker;
-    constructor({ config, state, idleTimeTracker, }: {
+    private analytics?;
+    constructor({ config, state, idleTimeTracker, analytics, }: {
         config?: Partial<EthereumNetworkConfig>;
         state?: Partial<EthereumNetworkState>;
         idleTimeTracker: IdleTimeTracker;
+        analytics: Analytics;
     });
     getNetworkIdentifier(): string;
     getNetworkRPCUrl(): string;

package/dist/lib.cjs/types/Network/createEthereumMiddleware.d.ts

@@ -1,4 +1,4 @@
-import { InPageWalletProviderState, MessageParams, SwitchChainMessageParams, UserRequestApprovalParams } from "@toruslabs/base-controllers";
+import { type Analytics, InPageWalletProviderState, MessageParams, SwitchChainMessageParams, UserRequestApprovalParams } from "@toruslabs/base-controllers";
 import { JRPCEngineEndCallback, JRPCEngineNextCallback, JRPCMiddleware, JRPCRequest, JRPCResponse } from "@web3auth/auth";
 import { AddChainMessageParams, BlockParams, EthereumTransactionMeta, TransactionParams, TransactionRPCMeta, TypedMessageParams, UserOperationGas } from "../utils/interfaces";
 export interface IProviderHandlers {
@@ -76,8 +76,9 @@ export declare function createRequestAccountsMiddleware({ requestAccounts, }: {
 /**
  * Middleware to handle bundler/paymaster rpc method
  */
-export declare function createAAMiddleware({ bundlerUrl, paymasterUrl }: {
+export declare function createAAMiddleware({ bundlerUrl, paymasterUrl, analytics, }: {
     bundlerUrl: string;
     paymasterUrl?: string;
+    analytics?: Analytics;
 }): JRPCMiddleware<unknown, unknown>;
-export declare function createEthereumMiddleware(providerHandlers: IProviderHandlers): JRPCMiddleware<unknown, unknown>;
+export declare function createEthereumMiddleware(providerHandlers: IProviderHandlers, analytics?: Analytics): JRPCMiddleware<unknown, unknown>;

package/dist/lib.cjs/types/Network/createJsonRpcClient.d.ts

@@ -1,10 +1,10 @@
-import { IdleTimeTracker, ProviderConfig } from "@toruslabs/base-controllers";
+import { type Analytics, IdleTimeTracker, ProviderConfig } from "@toruslabs/base-controllers";
 import { JRPCMiddleware } from "@web3auth/auth";
 import { PollingBlockTracker } from "../Block/PollingBlockTracker";
 import { EthereumNetworkConfig } from "../utils/interfaces";
 export declare function createChainIdMiddleware(chainId: string): JRPCMiddleware<unknown, string>;
 export declare function createProviderConfigMiddleware(providerConfig: ProviderConfig): JRPCMiddleware<unknown, ProviderConfig>;
-export declare function createJsonRpcClient(providerConfig: ProviderConfig, networkConfig: EthereumNetworkConfig, idleTimeTracker?: IdleTimeTracker): {
+export declare function createJsonRpcClient(providerConfig: ProviderConfig, networkConfig: EthereumNetworkConfig, idleTimeTracker?: IdleTimeTracker, analytics?: Analytics): {
     networkMiddleware: JRPCMiddleware<unknown, unknown>;
     blockTracker: PollingBlockTracker;
 };

package/dist/lib.cjs/types/utils/constants.d.ts

@@ -31,6 +31,7 @@ export declare const METHOD_TYPES: {
     readonly GET_ACCOUNTS: "eth_accounts";
     readonly ETH_TRANSACTION: "eth_sendTransaction";
     readonly ETH_SIGN_TRANSACTION: "eth_signTransaction";
+    readonly ETH_ESTIMATE_AA_TRANSACTION_GAS: "eth_estimateAATransactionGas";
     readonly ETH_ESTIMATE_USER_OPERATION_GAS: "eth_estimateUserOperationGas";
     readonly ETH_GET_SUPPORTED_ENTRY_POINTS: "eth_supportedEntryPoints";
     readonly ETH_GET_USER_OPERATION: "eth_getUserOperationByHash";

package/dist/lib.cjs/utils/constants.js

@@ -231,6 +231,8 @@ const METHOD_TYPES = {
   GET_ACCOUNTS: "eth_accounts",
   ETH_TRANSACTION: "eth_sendTransaction",
   ETH_SIGN_TRANSACTION: "eth_signTransaction",
+  // In TransferToken UI of WS, we call this method via JRPC provider to get gas estimation for a user op. Renamed to avoid conflict with bundler's gas estimation method
+  ETH_ESTIMATE_AA_TRANSACTION_GAS: "eth_estimateAATransactionGas",
   // start bundler methods
   ETH_ESTIMATE_USER_OPERATION_GAS: "eth_estimateUserOperationGas",
   ETH_GET_SUPPORTED_ENTRY_POINTS: "eth_supportedEntryPoints",

package/dist/lib.esm/Network/NetworkController.js

@@ -1,7 +1,7 @@
 import _objectWithoutProperties from '@babel/runtime/helpers/objectWithoutProperties';
 import _objectSpread from '@babel/runtime/helpers/objectSpread2';
 import _defineProperty from '@babel/runtime/helpers/defineProperty';
-import { BaseController, createSwappableProxy, createEventEmitterProxy } from '@toruslabs/base-controllers';
+import { BaseController, createAnalyticsMiddleware, createSwappableProxy, createEventEmitterProxy } from '@toruslabs/base-controllers';
 import { JRPCEngine, providerFromEngine } from '@web3auth/auth';
 import { Mutex } from 'async-mutex';
 import log from 'loglevel';
@@ -14,7 +14,8 @@ class NetworkController extends BaseController {
   constructor({
     config,
     state,
-    idleTimeTracker
+    idleTimeTracker,
+    analytics
   }) {
     super({
       config,
@@ -28,6 +29,7 @@ class NetworkController extends BaseController {
     _defineProperty(this, "blockTracker", null);
     _defineProperty(this, "baseProviderHandlers", void 0);
     _defineProperty(this, "idleTimeTracker", void 0);
+    _defineProperty(this, "analytics", void 0);
     this.defaultState = {
       chainId: "loading",
       properties: {
@@ -35,6 +37,7 @@ class NetworkController extends BaseController {
       },
       providerConfig: SUPPORTED_NETWORKS[MAINNET_CHAIN_ID]
     };
+    this.analytics = analytics;
 
     // when a new network is set,
     // we set to loading first and
@@ -148,8 +151,12 @@ class NetworkController extends BaseController {
     networkMiddleware,
     blockTracker
   }) {
-    const ethereumMiddleware = createEthereumMiddleware(this.baseProviderHandlers);
+    const ethereumMiddleware = createEthereumMiddleware(this.baseProviderHandlers, this.analytics);
     const engine = new JRPCEngine();
+    engine.push(createAnalyticsMiddleware({
+      analytics: this.analytics,
+      providerConfig: this.getProviderConfig()
+    }));
     engine.push(ethereumMiddleware);
     engine.push(networkMiddleware);
     const provider = providerFromEngine(engine);
@@ -185,7 +192,7 @@ class NetworkController extends BaseController {
     this.blockTracker = blockTracker;
   }
   configureStandardProvider(providerConfig) {
-    const networkClient = createJsonRpcClient(providerConfig, this.config, this.idleTimeTracker);
+    const networkClient = createJsonRpcClient(providerConfig, this.config, this.idleTimeTracker, this.analytics);
     log.info("networkClient", networkClient);
     this.setNetworkClient(networkClient);
   }

package/dist/lib.esm/Network/createEthereumMiddleware.js

@@ -46,7 +46,7 @@ function createProcessEstimateUserOperationGasMiddleware({
     const {
       method
     } = request;
-    if (method !== METHOD_TYPES.ETH_ESTIMATE_USER_OPERATION_GAS) return next();
+    if (method !== METHOD_TYPES.ETH_ESTIMATE_AA_TRANSACTION_GAS) return next();
     if (!processEstimateUserOperationGas) throw new Error("WalletMiddleware - opts.processEstimateUserOperationGas not provided");
     response.result = await processEstimateUserOperationGas(request.params, request);
   });
@@ -294,15 +294,34 @@ function createRequestAccountsMiddleware({
  */
 function createAAMiddleware({
   bundlerUrl,
-  paymasterUrl
+  paymasterUrl,
+  analytics
 }) {
   // forward request to bundler/paymaster
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const middlewares = [];
+
+  // NOTE: bundler/paymaster rpc only accept number as request id, we need to handle that here if client doesn't handle request id themselves
+  const idNumberRemapMiddleware = (req, res, next, _end) => {
+    // skip if not bundler/paymaster methods
+    if (!BUNDLER_METHOD_TYPES.includes(req.method) && !PAYMASTER_METHOD_TYPES.includes(req.method)) {
+      return next();
+    }
+    const originalId = req.id;
+    const newId = Math.floor(Math.random() * 1000000);
+    req.id = newId;
+    res.id = newId;
+    next(done => {
+      req.id = originalId;
+      res.id = originalId;
+      done();
+    });
+  };
   const bundlerFetchMiddleware = createFetchMiddleware({
-    rpcTarget: bundlerUrl
+    rpcTarget: bundlerUrl,
+    analytics
   });
-  // NOTE: bundler/paymaster rpc only accept number as request id, we might need to handle that here if client doesn't handle request id themselves
+  middlewares.push(idNumberRemapMiddleware);
   middlewares.push((request, response, next, end) => {
     if (!BUNDLER_METHOD_TYPES.includes(request.method)) {
       return next();
@@ -311,7 +330,8 @@ function createAAMiddleware({
   });
   if (paymasterUrl) {
     const paymasterFetchMiddleware = createFetchMiddleware({
-      rpcTarget: paymasterUrl
+      rpcTarget: paymasterUrl,
+      analytics
     });
     middlewares.push((request, response, next, end) => {
       if (!PAYMASTER_METHOD_TYPES.includes(request.method)) {
@@ -322,7 +342,7 @@ function createAAMiddleware({
   }
   return mergeMiddleware(middlewares);
 }
-function createEthereumMiddleware(providerHandlers) {
+function createEthereumMiddleware(providerHandlers, analytics) {
   const {
     requestAccounts,
     getAccounts,
@@ -376,7 +396,8 @@ function createEthereumMiddleware(providerHandlers) {
   if (aaConfig) {
     middlewares.push(createAAMiddleware({
       bundlerUrl: aaConfig.bundlerUrl,
-      paymasterUrl: aaConfig.paymasterUrl
+      paymasterUrl: aaConfig.paymasterUrl,
+      analytics
     }));
   }
   return mergeMiddleware(middlewares);

package/dist/lib.esm/Network/createJsonRpcClient.js

@@ -27,13 +27,14 @@ function createProviderConfigMiddleware(providerConfig) {
     return next();
   };
 }
-function createJsonRpcClient(providerConfig, networkConfig, idleTimeTracker) {
+function createJsonRpcClient(providerConfig, networkConfig, idleTimeTracker, analytics) {
   const {
     chainId,
     rpcTarget
   } = providerConfig;
   const fetchMiddleware = createFetchMiddleware({
-    rpcTarget
+    rpcTarget,
+    analytics
   });
   const blockProvider = providerFromMiddleware(fetchMiddleware);
   const blockTracker = new PollingBlockTracker({

package/dist/lib.esm/utils/constants.js

@@ -229,6 +229,8 @@ const METHOD_TYPES = {
   GET_ACCOUNTS: "eth_accounts",
   ETH_TRANSACTION: "eth_sendTransaction",
   ETH_SIGN_TRANSACTION: "eth_signTransaction",
+  // In TransferToken UI of WS, we call this method via JRPC provider to get gas estimation for a user op. Renamed to avoid conflict with bundler's gas estimation method
+  ETH_ESTIMATE_AA_TRANSACTION_GAS: "eth_estimateAATransactionGas",
   // start bundler methods
   ETH_ESTIMATE_USER_OPERATION_GAS: "eth_estimateUserOperationGas",
   ETH_GET_SUPPORTED_ENTRY_POINTS: "eth_supportedEntryPoints",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toruslabs/ethereum-controllers",
-  "version": "8.4.7",
+  "version": "8.5.0",
   "homepage": "https://github.com/torusresearch/controllers#readme",
   "license": "ISC",
   "sideEffects": false,
@@ -21,7 +21,7 @@
   "dependencies": {
     "@ethereumjs/util": "^9.1.0",
     "@metamask/delegation-toolkit": "^0.11.0",
-    "@toruslabs/base-controllers": "^8.4.6",
+    "@toruslabs/base-controllers": "^8.5.0",
     "@toruslabs/http-helpers": "^8.1.1",
     "@web3auth/auth": "^10.4.1",
     "async-mutex": "^0.5.0",
@@ -63,7 +63,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8356258913e258284e86d13db0994d50e3ee0322",
+  "gitHead": "8337c32aaff845838d7ca69da92b94ca991e4df9",
   "devDependencies": {
     "@typechain/ethers-v6": "^0.5.1",
     "typechain": "^8.3.2"