@toruslabs/ethereum-controllers 8.4.4 → 8.4.6

package/dist/lib.esm/Block/PollingBlockTracker.js

@@ -1,4 +1,5 @@
-import { BaseBlockTracker, idleTimeTracker, timeout } from '@toruslabs/base-controllers';
+import _defineProperty from '@babel/runtime/helpers/defineProperty';
+import { BaseBlockTracker, PollingManager, timeout } from '@toruslabs/base-controllers';
 import log from 'loglevel';
 
 const DEFAULT_POLLING_INTERVAL = 20;
@@ -7,15 +8,20 @@ const SEC = 1000;
 class PollingBlockTracker extends BaseBlockTracker {
   constructor({
     config,
-    state = {}
+    state = {},
+    idleTimeTracker
   }) {
     if (!config.provider) {
       throw new Error("PollingBlockTracker - no provider specified.");
     }
+    if (!idleTimeTracker) {
+      throw new Error("PollingBlockTracker - no idleTimeTracker specified.");
+    }
     super({
       config,
       state
     });
+    _defineProperty(this, "pollingManager", void 0);
     const pollingInterval = config.pollingInterval || DEFAULT_POLLING_INTERVAL;
     const retryTimeout = config.retryTimeout || DEFAULT_RETRY_TIMEOUT;
 
@@ -27,6 +33,7 @@ class PollingBlockTracker extends BaseBlockTracker {
       setSkipCacheFlag: config.setSkipCacheFlag || false
     };
     this.initialize();
+    this.pollingManager = new PollingManager(idleTimeTracker, pollingInterval);
   }
   async checkForLatestBlock() {
     await this._updateLatestBlock();
@@ -35,23 +42,26 @@ class PollingBlockTracker extends BaseBlockTracker {
 
   // overrides the BaseBlockTracker._start method.
   _start() {
-    this._synchronize().catch(err => this.emit("error", err));
+    this.pollingManager.start(async () => {
+      await this._synchronize().catch(err => {
+        this.emit("error", err);
+      });
+    });
+  }
+  _end() {
+    this.pollingManager.stop();
   }
   async _synchronize() {
-    while (this.state._isRunning) {
-      if (idleTimeTracker.checkIfIdle()) return;
+    try {
+      await this._updateLatestBlock();
+    } catch (err) {
+      const newErr = new Error(`PollingBlockTracker - encountered an error while attempting to update latest block:\n${err.stack}`);
       try {
-        await this._updateLatestBlock();
-        await timeout(this.config.pollingInterval);
-      } catch (err) {
-        const newErr = new Error(`PollingBlockTracker - encountered an error while attempting to update latest block:\n${err.stack}`);
-        try {
-          this.emit("error", newErr);
-        } catch {
-          log.error(newErr);
-        }
-        await timeout(this.config.retryTimeout);
+        this.emit("error", newErr);
+      } catch {
+        log.error(newErr);
       }
+      await timeout(this.config.retryTimeout);
     }
   }
   async _updateLatestBlock() {

package/dist/lib.esm/Currency/CurrencyController.js

@@ -1,6 +1,6 @@
 import _objectSpread from '@babel/runtime/helpers/objectSpread2';
 import _defineProperty from '@babel/runtime/helpers/defineProperty';
-import { BaseCurrencyController, idleTimeTracker } from '@toruslabs/base-controllers';
+import { BaseCurrencyController, PollingManager } from '@toruslabs/base-controllers';
 import { get } from '@toruslabs/http-helpers';
 import log from 'loglevel';
 
@@ -8,13 +8,14 @@ class CurrencyController extends BaseCurrencyController {
   constructor({
     config,
     state,
+    idleTimeTracker,
     onNetworkChanged
   }) {
     super({
       config,
       state
     });
-    _defineProperty(this, "conversionInterval", void 0);
+    _defineProperty(this, "pollingManager", void 0);
     this.defaultState = _objectSpread(_objectSpread({}, this.defaultState), {}, {
       commonDenomination: "USD",
       commonDenominatorPrice: 0
@@ -27,6 +28,7 @@ class CurrencyController extends BaseCurrencyController {
         this.updateConversionRate();
       }
     });
+    this.pollingManager = new PollingManager(idleTimeTracker, this.config.pollInterval);
   }
   setCommonDenomination(commonDenomination) {
     this.update({
@@ -50,15 +52,8 @@ class CurrencyController extends BaseCurrencyController {
    * stored at the controller's conversionInterval property. If it is called and such an id already exists, the
    * previous interval is clear and a new one is created.
    */
-  scheduleConversionInterval() {
-    if (this.conversionInterval) {
-      window.clearInterval(this.conversionInterval);
-    }
-    this.conversionInterval = window.setInterval(() => {
-      if (!idleTimeTracker.checkIfIdle()) {
-        this.updateConversionRate();
-      }
-    }, this.config.pollInterval);
+  async scheduleConversionInterval() {
+    this.pollingManager.start(this.updateConversionRate.bind(this));
   }
 
   /**

package/dist/lib.esm/Gas/GasFeeController.js

@@ -1,6 +1,6 @@
 import _defineProperty from '@babel/runtime/helpers/defineProperty';
 import { isHexString, addHexPrefix } from '@ethereumjs/util';
-import { BaseController, cloneDeep, idleTimeTracker } from '@toruslabs/base-controllers';
+import { BaseController, PollingManager, cloneDeep } from '@toruslabs/base-controllers';
 import log from 'loglevel';
 import { GAS_ESTIMATE_TYPES } from '../utils/constants.js';
 import { fetchGasEstimates, fetchEthGasPriceEstimate, fetchLegacyGasPriceEstimates, fetchGasEstimatesViaEthFeeHistory, calculateTimeEstimate } from './gasUtil.js';
@@ -14,6 +14,7 @@ class GasFeeController extends BaseController {
   constructor({
     config,
     state,
+    idleTimeTracker,
     getNetworkIdentifier,
     getProvider,
     fetchGasEstimates: fetchGasEstimates$1 = fetchGasEstimates,
@@ -32,7 +33,6 @@ class GasFeeController extends BaseController {
     _defineProperty(this, "name", "GasFeeController");
     // https://0x.org/docs/introduction/0x-cheat-sheet#swap-api-endpoints
     _defineProperty(this, "API_SUPPORTED_CHAINIDS", new Set(["0x1", "0x5", "0xa4b1", "0xa86a", "0x2105", "0x38", "0xfa", "0xa", "0x89"]));
-    _defineProperty(this, "intervalId", void 0);
     _defineProperty(this, "provider", void 0);
     _defineProperty(this, "currentChainId", void 0);
     _defineProperty(this, "getNetworkIdentifier", void 0);
@@ -44,6 +44,7 @@ class GasFeeController extends BaseController {
     _defineProperty(this, "getCurrentNetworkEIP1559Compatibility", void 0);
     _defineProperty(this, "getCurrentAccountEIP1559Compatibility", void 0);
     _defineProperty(this, "getCurrentNetworkLegacyGasAPICompatibility", void 0);
+    _defineProperty(this, "pollingManager", void 0);
     this.getNetworkIdentifier = getNetworkIdentifier;
     this.getProvider = getProvider;
     this.fetchGasEstimates = fetchGasEstimates$1;
@@ -70,6 +71,7 @@ class GasFeeController extends BaseController {
     onNetworkStateChange(() => {
       this.onNetworkStateChange();
     });
+    this.pollingManager = new PollingManager(idleTimeTracker, this.config.interval);
   }
   async onNetworkStateChange() {
     this.provider = this.getProvider();
@@ -103,9 +105,6 @@ class GasFeeController extends BaseController {
     this.stopPolling();
   }
   stopPolling() {
-    if (this.intervalId) {
-      clearInterval(this.intervalId);
-    }
     this.resetState();
   }
 
@@ -179,17 +178,9 @@ class GasFeeController extends BaseController {
     return newState;
   }
   async _startPolling() {
-    this._poll();
-  }
-  async _poll() {
-    if (this.intervalId) {
-      window.clearInterval(this.intervalId);
-    }
-    this.intervalId = window.setInterval(async () => {
-      if (!idleTimeTracker.checkIfIdle()) {
-        await this._fetchGasFeeEstimateData();
-      }
-    }, this.config.interval);
+    this.pollingManager.start(async () => {
+      await this._fetchGasFeeEstimateData();
+    });
   }
   resetState() {
     this.update(cloneDeep(this.defaultState));

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

@@ -13,7 +13,8 @@ const _excluded = ["chainId", "rpcTarget"];
 class NetworkController extends BaseController {
   constructor({
     config,
-    state
+    state,
+    idleTimeTracker
   }) {
     super({
       config,
@@ -26,6 +27,7 @@ class NetworkController extends BaseController {
     _defineProperty(this, "provider", null);
     _defineProperty(this, "blockTracker", null);
     _defineProperty(this, "baseProviderHandlers", void 0);
+    _defineProperty(this, "idleTimeTracker", void 0);
     this.defaultState = {
       chainId: "loading",
       properties: {
@@ -39,6 +41,7 @@ class NetworkController extends BaseController {
     // then when connection succeeds,
     // we update the network
     this.initialize();
+    this.idleTimeTracker = idleTimeTracker;
   }
   getNetworkIdentifier() {
     return this.state.chainId;
@@ -182,7 +185,7 @@ class NetworkController extends BaseController {
     this.blockTracker = blockTracker;
   }
   configureStandardProvider(providerConfig) {
-    const networkClient = createJsonRpcClient(providerConfig, this.config);
+    const networkClient = createJsonRpcClient(providerConfig, this.config, this.idleTimeTracker);
     log.info("networkClient", networkClient);
     this.setNetworkClient(networkClient);
   }

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

@@ -27,7 +27,7 @@ function createProviderConfigMiddleware(providerConfig) {
     return next();
   };
 }
-function createJsonRpcClient(providerConfig, networkConfig) {
+function createJsonRpcClient(providerConfig, networkConfig, idleTimeTracker) {
   const {
     chainId,
     rpcTarget
@@ -40,7 +40,8 @@ function createJsonRpcClient(providerConfig, networkConfig) {
     config: _objectSpread(_objectSpread({}, networkConfig), {}, {
       provider: blockProvider
     }),
-    state: {}
+    state: {},
+    idleTimeTracker
   });
   const networkMiddleware = mergeMiddleware([createChainIdMiddleware(chainId), createProviderConfigMiddleware(providerConfig),
   // No need for the following middlewares for web because all browser sessions are quite short lived and each session is limited to scope of a window/tab

package/dist/lib.esm/Nfts/NftsController.js

@@ -1,6 +1,6 @@
 import _objectSpread from '@babel/runtime/helpers/objectSpread2';
 import _defineProperty from '@babel/runtime/helpers/defineProperty';
-import { BaseController, idleTimeTracker } from '@toruslabs/base-controllers';
+import { BaseController, PollingManager } from '@toruslabs/base-controllers';
 import deepmerge from 'deepmerge';
 import { BrowserProvider } from 'ethers';
 import log from 'loglevel';
@@ -16,7 +16,8 @@ class NftsController extends BaseController {
     getCustomNfts,
     getSimpleHashNfts,
     onPreferencesStateChange,
-    onNetworkStateChange
+    onNetworkStateChange,
+    idleTimeTracker
   }) {
     super({
       config,
@@ -25,9 +26,9 @@ class NftsController extends BaseController {
     _defineProperty(this, "name", "NftsController");
     _defineProperty(this, "provider", void 0);
     _defineProperty(this, "ethersProvider", void 0);
-    _defineProperty(this, "_timer", void 0);
     _defineProperty(this, "getCustomNfts", void 0);
     _defineProperty(this, "getSimpleHashNfts", void 0);
+    _defineProperty(this, "pollingManager", void 0);
     this.provider = provider;
     this.ethersProvider = new BrowserProvider(this.provider, "any");
     this.getCustomNfts = getCustomNfts;
@@ -60,6 +61,7 @@ class NftsController extends BaseController {
         this.restartNftDetection();
       }
     });
+    this.pollingManager = new PollingManager(idleTimeTracker, this.config.interval);
   }
   get userSelectedAddress() {
     return this.config.selectedAddress;
@@ -69,21 +71,6 @@ class NftsController extends BaseController {
     if (!this.userSelectedAddress) return [];
     return (_this$state$nfts$this = this.state.nfts[this.userSelectedAddress]) !== null && _this$state$nfts$this !== void 0 ? _this$state$nfts$this : [];
   }
-  get interval() {
-    return this.config.interval;
-  }
-  set interval(interval) {
-    if (this._timer) window.clearInterval(this._timer);
-    if (!interval) {
-      return;
-    }
-    this._timer = window.setInterval(() => {
-      if (!idleTimeTracker.checkIfIdle()) {
-        this.detectNewNfts();
-        this.refreshNftBalances();
-      }
-    }, interval);
-  }
   startNftDetection(selectedAddress) {
     this.configure({
       selectedAddress
@@ -100,9 +87,10 @@ class NftsController extends BaseController {
     if (!this.userSelectedAddress) {
       return;
     }
-    this.detectNewNfts();
-    this.refreshNftBalances();
-    this.config.interval = DEFAULT_INTERVAL;
+    this.pollingManager.start(() => {
+      this.detectNewNfts();
+      this.refreshNftBalances();
+    });
   }
   detectNewNfts() {
     const userAddress = this.userSelectedAddress;

package/dist/lib.esm/Tokens/TokenRatesController.js

@@ -1,6 +1,6 @@
 import _objectSpread from '@babel/runtime/helpers/objectSpread2';
 import _defineProperty from '@babel/runtime/helpers/defineProperty';
-import { BaseController, idleTimeTracker } from '@toruslabs/base-controllers';
+import { BaseController, PollingManager } from '@toruslabs/base-controllers';
 import { get } from '@toruslabs/http-helpers';
 import log from 'loglevel';
 import { COINGECKO_PLATFORMS_CHAIN_CODE_MAP, COINGECKO_SUPPORTED_CURRENCIES } from '../utils/constants.js';
@@ -13,6 +13,7 @@ class TokenRatesController extends BaseController {
   constructor({
     config,
     state,
+    idleTimeTracker,
     onPreferencesStateChange,
     onNetworkStateChange,
     onTokensStateChange
@@ -21,7 +22,7 @@ class TokenRatesController extends BaseController {
       config,
       state
     });
-    _defineProperty(this, "conversionInterval", void 0);
+    _defineProperty(this, "pollingManager", void 0);
     this.defaultState = _objectSpread(_objectSpread({}, this.defaultState), {}, {
       contractExchangeRates: {}
     });
@@ -56,6 +57,7 @@ class TokenRatesController extends BaseController {
         this.updateExchangeRates();
       }
     });
+    this.pollingManager = new PollingManager(idleTimeTracker, this.config.pollInterval);
   }
 
   /**
@@ -63,15 +65,8 @@ class TokenRatesController extends BaseController {
    * stored at the controller's conversionInterval property. If it is called and such an id already exists, the
    * previous interval is clear and a new one is created.
    */
-  scheduleConversionInterval() {
-    if (this.conversionInterval) {
-      window.clearInterval(this.conversionInterval);
-    }
-    this.conversionInterval = window.setInterval(() => {
-      if (!idleTimeTracker.checkIfIdle()) {
-        this.updateExchangeRates();
-      }
-    }, this.config.pollInterval);
+  async scheduleConversionInterval() {
+    this.pollingManager.start(this.updateExchangeRates.bind(this));
   }
   async updateExchangeRates() {
     const chainCodes = COINGECKO_PLATFORMS_CHAIN_CODE_MAP[this.config.chainId];

package/dist/lib.esm/Tokens/TokensController.js

@@ -1,6 +1,6 @@
 import _objectSpread from '@babel/runtime/helpers/objectSpread2';
 import _defineProperty from '@babel/runtime/helpers/defineProperty';
-import { BaseController, idleTimeTracker } from '@toruslabs/base-controllers';
+import { BaseController, PollingManager } from '@toruslabs/base-controllers';
 import { BrowserProvider, Contract, toQuantity } from 'ethers';
 import log from 'loglevel';
 import { singleBalanceCheckerAbi } from '../utils/abis.js';
@@ -14,6 +14,7 @@ class TokensController extends BaseController {
     config,
     state,
     provider,
+    idleTimeTracker,
     getCustomTokens,
     getEtherScanTokens,
     getProviderConfig,
@@ -27,7 +28,7 @@ class TokensController extends BaseController {
     _defineProperty(this, "name", "TokensController");
     _defineProperty(this, "provider", void 0);
     _defineProperty(this, "ethersProvider", void 0);
-    _defineProperty(this, "_timer", void 0);
+    _defineProperty(this, "pollingManager", void 0);
     _defineProperty(this, "getProviderConfig", void 0);
     _defineProperty(this, "getCustomTokens", void 0);
     _defineProperty(this, "getEtherScanTokens", void 0);
@@ -64,6 +65,7 @@ class TokensController extends BaseController {
         this.restartTokenDetection();
       }
     });
+    this.pollingManager = new PollingManager(idleTimeTracker, this.config.interval);
   }
   get userSelectedAddress() {
     return this.config.selectedAddress;
@@ -73,21 +75,6 @@ class TokensController extends BaseController {
     if (!this.userSelectedAddress) return [];
     return (_this$state$tokens$th = this.state.tokens[this.userSelectedAddress]) !== null && _this$state$tokens$th !== void 0 ? _this$state$tokens$th : [];
   }
-  get interval() {
-    return this.config.interval;
-  }
-  set interval(interval) {
-    if (this._timer) window.clearInterval(this._timer);
-    if (!interval) {
-      return;
-    }
-    this._timer = window.setInterval(() => {
-      if (!idleTimeTracker.checkIfIdle()) {
-        this.detectNewTokens();
-        this.refreshTokenBalances();
-      }
-    }, interval);
-  }
   startTokenDetection(selectedAddress) {
     this.configure({
       selectedAddress
@@ -104,9 +91,10 @@ class TokensController extends BaseController {
     if (!this.userSelectedAddress) {
       return;
     }
-    this.detectNewTokens();
-    this.refreshTokenBalances();
-    this.config.interval = DEFAULT_INTERVAL;
+    this.pollingManager.start(async () => {
+      this.detectNewTokens();
+      await this.refreshTokenBalances();
+    });
   }
   detectNewTokens() {
     const userAddress = this.userSelectedAddress;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toruslabs/ethereum-controllers",
-  "version": "8.4.4",
+  "version": "8.4.6",
   "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.4",
+    "@toruslabs/base-controllers": "^8.4.6",
     "@toruslabs/http-helpers": "^8.1.1",
     "@web3auth/auth": "^10.4.1",
     "async-mutex": "^0.5.0",
@@ -63,7 +63,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7040c38814fe30e35f1dcd9713de118ded2e3d4a",
+  "gitHead": "9b83f0f321a2a91489825b2d440c172656bb91d7",
   "devDependencies": {
     "@typechain/ethers-v6": "^0.5.1",
     "typechain": "^8.3.2"