@toruslabs/ethereum-controllers 4.11.0 → 5.0.0

package/dist/types/Account/AccountTrackerController.d.ts

@@ -26,6 +26,9 @@ declare class AccountTrackerController extends BaseController<AccountTrackerConf
     private getIdentities;
     private getCurrentChainId;
     constructor({ config, state, provider, blockTracker, getIdentities, onPreferencesStateChange, getCurrentChainId, }: AccountTrackerControllerOptions);
+    blockTrackerListener(block: EthereumBlock): void;
+    startPolling(): void;
+    stopPolling(): void;
     syncAccounts(): boolean;
     refresh(): Promise<void>;
     private _updateAccounts;

package/dist/types/Preferences/PreferencesController.d.ts

@@ -1,6 +1,5 @@
-import { BasePreferencesController, CustomNft, CustomToken, IPreferencesController, PreferencesConfig, PreferencesState, UserInfo } from "@toruslabs/base-controllers";
+import { BasePreferencesController, CustomNft, CustomToken, InitPreferencesParams, IPreferencesController, PreferencesConfig, PreferencesState } from "@toruslabs/base-controllers";
 import { SafeEventEmitterProvider } from "@toruslabs/openlogin-jrpc";
-import PollingBlockTracker from "../Block/PollingBlockTracker";
 import KeyringController from "../Keyring/KeyringController";
 import NetworkController from "../Network/NetworkController";
 import type { AddChainMessageParams, CustomNetworkPayload, CustomNftInfo, CustomTokenInfo, ExtendedAddressPreferences, TransactionPayload } from "../utils/interfaces";
@@ -8,7 +7,6 @@ interface IPreferencesControllerOptions {
     config?: Partial<PreferencesConfig> & Pick<PreferencesConfig, "api" | "commonApiHost" | "signInPrefix">;
     state?: Partial<PreferencesState<ExtendedAddressPreferences>>;
     provider: SafeEventEmitterProvider;
-    blockTracker?: PollingBlockTracker;
     signAuthMessage?: KeyringController["signAuthMessage"];
     getProviderConfig?: NetworkController["getProviderConfig"];
     setProviderConfig?: NetworkController["setProviderConfig"];
@@ -19,29 +17,17 @@ export default class PreferencesController extends BasePreferencesController<Ext
     private getProviderConfig;
     private setProviderConfig;
     private provider;
-    private blockTracker;
-    constructor({ config, state, provider, blockTracker, signAuthMessage, getProviderConfig, setProviderConfig }: IPreferencesControllerOptions);
+    constructor({ config, state, provider, signAuthMessage, getProviderConfig, setProviderConfig }: IPreferencesControllerOptions);
     poll(interval?: number): Promise<void>;
-    initPreferences(params: {
-        address: string;
-        jwtToken?: string;
-        calledFromEmbed?: boolean;
-        userInfo?: UserInfo;
-        rehydrate?: boolean;
-        locale?: string;
-        type?: string;
-        signatures?: string[];
-        network?: string;
-        web3AuthClientId?: string;
-    }): Promise<void>;
+    initPreferences(params: InitPreferencesParams): Promise<void>;
     getSelectedAddress(): string;
     sync(address: string): Promise<boolean>;
     patchNewTx(tx: TransactionPayload, address: string): Promise<void>;
     recalculatePastTx(address?: string): void;
-    refetchEtherscanTx(address?: string): Promise<void>;
+    refetchEtherscanTx(address?: string): Promise<unknown[]>;
     fetchEtherscanTx<T>(parameters: {
         selectedAddress: string;
-        selectedNetwork: string;
+        chainId: string;
     }): Promise<T[]>;
     getEtherScanTokens(address: string, chainId: string): Promise<CustomTokenInfo[]>;
     getSimpleHashNfts(address: string, chainId: string): Promise<CustomNftInfo[]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toruslabs/ethereum-controllers",
-  "version": "4.11.0",
+  "version": "5.0.0",
   "homepage": "https://github.com/torusresearch/controllers#readme",
   "license": "ISC",
   "main": "dist/ethereumControllers.cjs.js",
@@ -24,7 +24,7 @@
     "@ethereumjs/util": "^9.0.1",
     "@metamask/eth-sig-util": "^7.0.1",
     "@metamask/rpc-errors": "^6.1.0",
-    "@toruslabs/base-controllers": "^4.11.0",
+    "@toruslabs/base-controllers": "^5.0.0",
     "@toruslabs/http-helpers": "^6.0.0",
     "@toruslabs/openlogin-jrpc": "^6.1.0",
     "async-mutex": "^0.4.0",
@@ -64,7 +64,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ece0fb5e61005a05f63eb85dd6a76a0c6e108089",
+  "gitHead": "f63427503cff9c9a08240da584ebee008f1d7527",
   "devDependencies": {
     "@nomicfoundation/hardhat-toolbox": "^4.0.0",
     "hardhat": "^2.19.3"

package/src/Account/AccountTrackerController.ts

@@ -65,12 +65,6 @@ class AccountTrackerController
     this.blockTracker = blockTracker;
     this.ethersProvider = new BrowserProvider(this.provider, "any");
 
-    // Initiate block tracker internal tracking.
-    this.blockTracker.on("latest", (block: EthereumBlock) => {
-      this.configure({ _currentBlock: block });
-      this.refresh();
-    });
-
     this.getIdentities = getIdentities;
     this.getCurrentChainId = getCurrentChainId;
 
@@ -79,6 +73,25 @@ class AccountTrackerController
       const refreshNeeded = this.syncAccounts();
       if (refreshNeeded) this.refresh();
     });
+    this.blockTrackerListener = this.blockTrackerListener.bind(this);
+  }
+
+  blockTrackerListener(block: EthereumBlock) {
+    this.configure({ _currentBlock: block });
+    this.refresh();
+  }
+
+  startPolling(): void {
+    this.stopPolling();
+    // Initiate block tracker internal tracking.
+    if (Object.keys(this.state.accounts).length > 0) {
+      // Adding this listener on block tracker triggers it to start polling.
+      this.blockTracker.on("latest", this.blockTrackerListener);
+    }
+  }
+
+  stopPolling(): void {
+    this.blockTracker.removeListener("latest", this.blockTrackerListener);
   }
 
   syncAccounts(): boolean {

package/src/Preferences/PreferencesController.ts

@@ -1,23 +1,23 @@
 import { stripHexPrefix } from "@ethereumjs/util";
 import {
+  ACCOUNT_TYPE,
   BasePreferencesController,
   CustomNft,
   CustomToken,
+  InitPreferencesParams,
   IPreferencesController,
   PreferencesConfig,
   PreferencesState,
   TransactionStatus,
-  UserInfo,
 } from "@toruslabs/base-controllers";
 import { get, patch, post, remove } from "@toruslabs/http-helpers";
 import { SafeEventEmitterProvider } from "@toruslabs/openlogin-jrpc";
 import { Mutex } from "async-mutex";
 import log from "loglevel";
 
-import PollingBlockTracker from "../Block/PollingBlockTracker";
 import KeyringController from "../Keyring/KeyringController";
 import NetworkController from "../Network/NetworkController";
-import { SUPPORTED_NETWORKS } from "../utils/constants";
+import { ETHERSCAN_SUPPORTED_CHAINS, SUPPORTED_NETWORKS } from "../utils/constants";
 import { formatDate, formatPastTx, formatTime, getEthTxStatus } from "../utils/helpers";
 import type {
   AddChainMessageParams,
@@ -37,8 +37,6 @@ interface IPreferencesControllerOptions {
   config?: Partial<PreferencesConfig> & Pick<PreferencesConfig, "api" | "commonApiHost" | "signInPrefix">;
   state?: Partial<PreferencesState<ExtendedAddressPreferences>>;
   provider: SafeEventEmitterProvider;
-  // TODO: Require later
-  blockTracker?: PollingBlockTracker;
   signAuthMessage?: KeyringController["signAuthMessage"];
   getProviderConfig?: NetworkController["getProviderConfig"];
   setProviderConfig?: NetworkController["setProviderConfig"];
@@ -58,15 +56,11 @@ export default class PreferencesController
 
   private provider: SafeEventEmitterProvider;
 
-  private blockTracker: PollingBlockTracker;
-
-  constructor({ config, state, provider, blockTracker, signAuthMessage, getProviderConfig, setProviderConfig }: IPreferencesControllerOptions) {
+  constructor({ config, state, provider, signAuthMessage, getProviderConfig, setProviderConfig }: IPreferencesControllerOptions) {
     super({ config, state, defaultPreferences: { formattedPastTransactions: [], fetchedPastTx: [], paymentTx: [] }, signAuthMessage });
     this.provider = provider;
     this.getProviderConfig = getProviderConfig;
     this.setProviderConfig = setProviderConfig;
-    this.blockTracker = blockTracker;
-    log.info(this.blockTracker);
   }
 
   public async poll(interval?: number): Promise<void> {
@@ -85,20 +79,9 @@ export default class PreferencesController
     }, this.config.pollInterval);
   }
 
-  public async initPreferences(params: {
-    address: string;
-    jwtToken?: string;
-    calledFromEmbed?: boolean;
-    userInfo?: UserInfo;
-    rehydrate?: boolean;
-    locale?: string;
-    type?: string;
-    signatures?: string[];
-    network?: string;
-    web3AuthClientId?: string;
-  }): Promise<void> {
-    const { address, jwtToken, calledFromEmbed, userInfo, rehydrate, locale = "en-US", type, signatures, network, web3AuthClientId } = params;
-    await super.init(address, userInfo, jwtToken, { type, email: userInfo.email, signatures, network });
+  public async initPreferences(params: InitPreferencesParams): Promise<void> {
+    const { address, jwtToken, calledFromEmbed, userInfo, rehydrate, locale = "en-US", type, signatures, web3AuthClientId, web3AuthNetwork } = params;
+    await super.init({ address, userInfo, idToken: jwtToken, type, metadata: { email: userInfo.email, signatures } });
     const { aggregateVerifier, verifier, verifierId } = userInfo || {};
     const userExists = await this.sync(address);
     if (!userExists) {
@@ -110,16 +93,18 @@ export default class PreferencesController
         verifierId,
         locale,
         address,
+        type,
+        web3AuthNetwork,
       });
     }
-    if (!rehydrate)
-      await this.storeUserLogin({
-        verifier: aggregateVerifier || verifier,
-        verifierId,
-        options: { calledFromEmbed, rehydrate },
-        address,
-        web3AuthClientId,
-      });
+    await this.storeUserLogin({
+      verifier: aggregateVerifier || verifier,
+      verifierId,
+      options: { calledFromEmbed, rehydrate },
+      address,
+      web3AuthClientId,
+      web3AuthNetwork,
+    });
   }
 
   public getSelectedAddress(): string {
@@ -140,6 +125,7 @@ export default class PreferencesController
           customNetworks,
           customTokens,
           customNfts,
+          account_type: accountType,
         } = user || {};
 
         // update latest data in state.
@@ -153,6 +139,7 @@ export default class PreferencesController
             customTokens,
             customNfts,
             customNetworks,
+            accountType: accountType as ACCOUNT_TYPE,
           },
           address
         );
@@ -215,18 +202,16 @@ export default class PreferencesController
   public async refetchEtherscanTx(address?: string) {
     const selectedAddress = address || this.state.selectedAddress;
     if (this.getAddressState(selectedAddress)?.jwtToken) {
-      // const selectedNetwork = this.getProviderConfig().rpcTarget;
-      // if (ETHERSCAN_SUPPORTED_NETWORKS.has(selectedNetwork)) {
-      //   const data = await this.fetchEtherscanTx({ selectedAddress, selectedNetwork });
-      //   if (data.length) {
-      //     this.emit("addEtherscanTransactions", data, selectedNetwork);
-      //   }
-      // }
+      const { chainId } = this.getProviderConfig();
+      if (ETHERSCAN_SUPPORTED_CHAINS.includes(chainId)) {
+        return this.fetchEtherscanTx({ selectedAddress, chainId: this.getProviderConfig().chainId });
+      }
     }
   }
 
-  async fetchEtherscanTx<T>(parameters: { selectedAddress: string; selectedNetwork: string }): Promise<T[]> {
+  async fetchEtherscanTx<T>(parameters: { selectedAddress: string; chainId: string }): Promise<T[]> {
     try {
+      // TODO: rewrite this api to use chainId
       const url = new URL(`${this.config.api}/etherscan`);
       Object.keys(parameters).forEach((key) => url.searchParams.append(key, parameters[key as keyof typeof parameters]));
       const response = await get<{ success: boolean; data: T[] }>(url.href, this.headers(parameters.selectedAddress));