@metamask/polling-controller 2.0.0 → 4.0.0

package/CHANGELOG.md

@@ -6,6 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [4.0.0]
+### Changed
+- **BREAKING:** Bump `@metamask/network-controller` dependency and peer dependency from `^17.0.0` to `^17.1.1` ([#3695](https://github.com/MetaMask/core/pull/3695))
+- Bump `@metamask/base-controller` to `^4.0.1` ([#3695](https://github.com/MetaMask/core/pull/3695))
+- Bump `@metamask/controller-utils` to `^8.0.1` ([#3695](https://github.com/MetaMask/core/pull/3695), [#3678](https://github.com/MetaMask/core/pull/3678))
+
+## [3.0.0]
+### Added
+- `BlockTrackerPollingController`, `BlockTrackerPollingControllerV1` and `BlockTrackerPollingControllerOnly` have been added and can be used by subclasses to poll with a blockTracker using the same API as the `StaticIntervalPollingController` versions - the only exception is the requirement to implement the abstract method `_getNetworkClientById` on subclasses.
+
+### Changed
+- **BREAKING:** `PollingController`, `PollingControllerV1` and `PollingControllerOnly` are all removed and replaced by `StaticIntervalPollingController`, `StaticIntervalPollingControllerV1` and `StaticIntervalPollingControllerOnly` ([#3636](https://github.com/MetaMask/core/pull/3636))
+
 ## [2.0.0]
 ### Changed
 - **BREAKING:** Bump `@metamask/base-controller` to ^4.0.0 ([#2063](https://github.com/MetaMask/core/pull/2063))
@@ -46,7 +59,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/polling-controller@2.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/polling-controller@4.0.0...HEAD
+[4.0.0]: https://github.com/MetaMask/core/compare/@metamask/polling-controller@3.0.0...@metamask/polling-controller@4.0.0
+[3.0.0]: https://github.com/MetaMask/core/compare/@metamask/polling-controller@2.0.0...@metamask/polling-controller@3.0.0
 [2.0.0]: https://github.com/MetaMask/core/compare/@metamask/polling-controller@1.0.2...@metamask/polling-controller@2.0.0
 [1.0.2]: https://github.com/MetaMask/core/compare/@metamask/polling-controller@1.0.1...@metamask/polling-controller@1.0.2
 [1.0.1]: https://github.com/MetaMask/core/compare/@metamask/polling-controller@1.0.0...@metamask/polling-controller@1.0.1

package/dist/AbstractPollingController.d.ts

@@ -0,0 +1,33 @@
+import type { NetworkClientId } from '@metamask/network-controller';
+import type { Json } from '@metamask/utils';
+export declare type IPollingController = {
+    startPollingByNetworkClientId(networkClientId: NetworkClientId, options: Json): string;
+    stopAllPolling(): void;
+    stopPollingByPollingToken(pollingToken: string): void;
+    onPollingCompleteByNetworkClientId(networkClientId: NetworkClientId, callback: (networkClientId: NetworkClientId) => void, options: Json): void;
+    _executePoll(networkClientId: NetworkClientId, options: Json): Promise<void>;
+    _startPollingByNetworkClientId(networkClientId: NetworkClientId, options: Json): void;
+    _stopPollingByPollingTokenSetId(key: PollingTokenSetId): void;
+};
+export declare const getKey: (networkClientId: NetworkClientId, options: Json) => PollingTokenSetId;
+export declare type PollingTokenSetId = `${NetworkClientId}:${string}`;
+declare type Constructor = new (...args: any[]) => object;
+/**
+ * AbstractPollingControllerBaseMixin
+ *
+ * @param Base - The base class to mix onto.
+ * @returns The composed class.
+ */
+export declare function AbstractPollingControllerBaseMixin<TBase extends Constructor>(Base: TBase): (abstract new (...args: any[]) => {
+    readonly "__#93085@#pollingTokenSets": Map<PollingTokenSetId, Set<string>>;
+    "__#93085@#callbacks": Map<`${string}:${string}`, Set<(PollingTokenSetId: `${string}:${string}`) => void>>;
+    _executePoll(networkClientId: NetworkClientId, options: Json): Promise<void>;
+    _startPollingByNetworkClientId(networkClientId: NetworkClientId, options: Json): void;
+    _stopPollingByPollingTokenSetId(key: PollingTokenSetId): void;
+    startPollingByNetworkClientId(networkClientId: NetworkClientId, options?: Json): string;
+    stopAllPolling(): void;
+    stopPollingByPollingToken(pollingToken: string): void;
+    onPollingCompleteByNetworkClientId(networkClientId: NetworkClientId, callback: (networkClientId: NetworkClientId) => void, options?: Json): void;
+}) & TBase;
+export {};
+//# sourceMappingURL=AbstractPollingController.d.ts.map

package/dist/AbstractPollingController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractPollingController.d.ts","sourceRoot":"","sources":["../src/AbstractPollingController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAI5C,oBAAY,kBAAkB,GAAG;IAC/B,6BAA6B,CAC3B,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,IAAI,GACZ,MAAM,CAAC;IAEV,cAAc,IAAI,IAAI,CAAC;IAEvB,yBAAyB,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtD,kCAAkC,CAChC,eAAe,EAAE,eAAe,EAChC,QAAQ,EAAE,CAAC,eAAe,EAAE,eAAe,KAAK,IAAI,EACpD,OAAO,EAAE,IAAI,GACZ,IAAI,CAAC;IAER,YAAY,CAAC,eAAe,EAAE,eAAe,EAAE,OAAO,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7E,8BAA8B,CAC5B,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,IAAI,GACZ,IAAI,CAAC;IACR,+BAA+B,CAAC,GAAG,EAAE,iBAAiB,GAAG,IAAI,CAAC;CAC/D,CAAC;AAEF,eAAO,MAAM,MAAM,oBACA,eAAe,WACvB,IAAI,KACZ,iBAA+D,CAAC;AAEnE,oBAAY,iBAAiB,GAAG,GAAG,eAAe,IAAI,MAAM,EAAE,CAAC;AAI/D,aAAK,WAAW,GAAG,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAAC;AAElD;;;;;GAKG;AACH,wBAAgB,kCAAkC,CAAC,KAAK,SAAS,WAAW,EAC1E,IAAI,EAAE,KAAK;2CAMmB,IAAI,iBAAiB,EAAE,IAAI,MAAM,CAAC,CAAC;wGAIf,IAAI;kCAIjC,eAAe,WACvB,IAAI,GACZ,QAAQ,IAAI,CAAC;oDAGG,eAAe,WACvB,IAAI,GACZ,IAAI;yCAEuC,iBAAiB,GAAG,IAAI;mDAGnD,eAAe,YACvB,IAAI,GACZ,MAAM;;4CAuB+B,MAAM;wDA8B3B,eAAe,8BACJ,eAAe,KAAK,IAAI,YAC3C,IAAI;WASlB"}

package/dist/AbstractPollingController.js

@@ -0,0 +1,87 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractPollingControllerBaseMixin = exports.getKey = void 0;
+const fast_json_stable_stringify_1 = __importDefault(require("fast-json-stable-stringify"));
+const uuid_1 = require("uuid");
+const getKey = (networkClientId, options) => `${networkClientId}:${(0, fast_json_stable_stringify_1.default)(options)}`;
+exports.getKey = getKey;
+/**
+ * AbstractPollingControllerBaseMixin
+ *
+ * @param Base - The base class to mix onto.
+ * @returns The composed class.
+ */
+function AbstractPollingControllerBaseMixin(Base) {
+    var _AbstractPollingControllerBase_pollingTokenSets, _AbstractPollingControllerBase_callbacks;
+    class AbstractPollingControllerBase extends Base {
+        constructor() {
+            super(...arguments);
+            _AbstractPollingControllerBase_pollingTokenSets.set(this, new Map());
+            _AbstractPollingControllerBase_callbacks.set(this, new Map());
+        }
+        startPollingByNetworkClientId(networkClientId, options = {}) {
+            var _a;
+            const pollToken = (0, uuid_1.v4)();
+            const key = (0, exports.getKey)(networkClientId, options);
+            const pollingTokenSet = (_a = __classPrivateFieldGet(this, _AbstractPollingControllerBase_pollingTokenSets, "f").get(key)) !== null && _a !== void 0 ? _a : new Set();
+            pollingTokenSet.add(pollToken);
+            __classPrivateFieldGet(this, _AbstractPollingControllerBase_pollingTokenSets, "f").set(key, pollingTokenSet);
+            if (pollingTokenSet.size === 1) {
+                this._startPollingByNetworkClientId(networkClientId, options);
+            }
+            return pollToken;
+        }
+        stopAllPolling() {
+            __classPrivateFieldGet(this, _AbstractPollingControllerBase_pollingTokenSets, "f").forEach((tokenSet, _key) => {
+                tokenSet.forEach((token) => {
+                    this.stopPollingByPollingToken(token);
+                });
+            });
+        }
+        stopPollingByPollingToken(pollingToken) {
+            if (!pollingToken) {
+                throw new Error('pollingToken required');
+            }
+            let keyToDelete = null;
+            for (const [key, tokenSet] of __classPrivateFieldGet(this, _AbstractPollingControllerBase_pollingTokenSets, "f")) {
+                if (tokenSet.delete(pollingToken)) {
+                    if (tokenSet.size === 0) {
+                        keyToDelete = key;
+                    }
+                    break;
+                }
+            }
+            if (keyToDelete) {
+                this._stopPollingByPollingTokenSetId(keyToDelete);
+                __classPrivateFieldGet(this, _AbstractPollingControllerBase_pollingTokenSets, "f").delete(keyToDelete);
+                const callbacks = __classPrivateFieldGet(this, _AbstractPollingControllerBase_callbacks, "f").get(keyToDelete);
+                if (callbacks) {
+                    for (const callback of callbacks) {
+                        // eslint-disable-next-line n/callback-return
+                        callback(keyToDelete);
+                    }
+                    callbacks.clear();
+                }
+            }
+        }
+        onPollingCompleteByNetworkClientId(networkClientId, callback, options = {}) {
+            var _a;
+            const key = (0, exports.getKey)(networkClientId, options);
+            const callbacks = (_a = __classPrivateFieldGet(this, _AbstractPollingControllerBase_callbacks, "f").get(key)) !== null && _a !== void 0 ? _a : new Set();
+            callbacks.add(callback);
+            __classPrivateFieldGet(this, _AbstractPollingControllerBase_callbacks, "f").set(key, callbacks);
+        }
+    }
+    _AbstractPollingControllerBase_pollingTokenSets = new WeakMap(), _AbstractPollingControllerBase_callbacks = new WeakMap();
+    return AbstractPollingControllerBase;
+}
+exports.AbstractPollingControllerBaseMixin = AbstractPollingControllerBaseMixin;
+//# sourceMappingURL=AbstractPollingController.js.map

package/dist/AbstractPollingController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractPollingController.js","sourceRoot":"","sources":["../src/AbstractPollingController.ts"],"names":[],"mappings":";;;;;;;;;;;AAEA,4FAAmD;AACnD,+BAAoC;AA0B7B,MAAM,MAAM,GAAG,CACpB,eAAgC,EAChC,OAAa,EACM,EAAE,CAAC,GAAG,eAAe,IAAI,IAAA,oCAAS,EAAC,OAAO,CAAC,EAAE,CAAC;AAHtD,QAAA,MAAM,UAGgD;AAQnE;;;;;GAKG;AACH,SAAgB,kCAAkC,CAChD,IAAW;;IAEX,MAAe,6BACb,SAAQ,IAAI;QADd;;YAIE,0DAAkE,IAAI,GAAG,EAAE,EAAC;YAE5E,mDAGI,IAAI,GAAG,EAAE,EAAC;QA+EhB,CAAC;QAjEC,6BAA6B,CAC3B,eAAgC,EAChC,UAAgB,EAAE;;YAElB,MAAM,SAAS,GAAG,IAAA,SAAM,GAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,IAAA,cAAM,EAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YAC7C,MAAM,eAAe,GACnB,MAAA,uBAAA,IAAI,uDAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,IAAI,GAAG,EAAU,CAAC;YACvD,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAC/B,uBAAA,IAAI,uDAAkB,CAAC,GAAG,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;YAEjD,IAAI,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE;gBAC9B,IAAI,CAAC,8BAA8B,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;aAC/D;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,cAAc;YACZ,uBAAA,IAAI,uDAAkB,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE;gBAChD,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;oBACzB,IAAI,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;gBACxC,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QAED,yBAAyB,CAAC,YAAoB;YAC5C,IAAI,CAAC,YAAY,EAAE;gBACjB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;aAC1C;YAED,IAAI,WAAW,GAA6B,IAAI,CAAC;YACjD,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,uBAAA,IAAI,uDAAkB,EAAE;gBACpD,IAAI,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;oBACjC,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE;wBACvB,WAAW,GAAG,GAAG,CAAC;qBACnB;oBACD,MAAM;iBACP;aACF;YAED,IAAI,WAAW,EAAE;gBACf,IAAI,CAAC,+BAA+B,CAAC,WAAW,CAAC,CAAC;gBAClD,uBAAA,IAAI,uDAAkB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;gBAC3C,MAAM,SAAS,GAAG,uBAAA,IAAI,gDAAW,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;gBACnD,IAAI,SAAS,EAAE;oBACb,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;wBAChC,6CAA6C;wBAC7C,QAAQ,CAAC,WAAW,CAAC,CAAC;qBACvB;oBACD,SAAS,CAAC,KAAK,EAAE,CAAC;iBACnB;aACF;QACH,CAAC;QAED,kCAAkC,CAChC,eAAgC,EAChC,QAAoD,EACpD,UAAgB,EAAE;;YAElB,MAAM,GAAG,GAAG,IAAA,cAAM,EAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YAC7C,MAAM,SAAS,GAAG,MAAA,uBAAA,IAAI,gDAAW,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,IAAI,GAAG,EAAmB,CAAC;YACzE,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACxB,uBAAA,IAAI,gDAAW,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACtC,CAAC;KACF;;IACD,OAAO,6BAA6B,CAAC;AACvC,CAAC;AA7FD,gFA6FC","sourcesContent":["import type { NetworkClientId } from '@metamask/network-controller';\nimport type { Json } from '@metamask/utils';\nimport stringify from 'fast-json-stable-stringify';\nimport { v4 as random } from 'uuid';\n\nexport type IPollingController = {\n  startPollingByNetworkClientId(\n    networkClientId: NetworkClientId,\n    options: Json,\n  ): string;\n\n  stopAllPolling(): void;\n\n  stopPollingByPollingToken(pollingToken: string): void;\n\n  onPollingCompleteByNetworkClientId(\n    networkClientId: NetworkClientId,\n    callback: (networkClientId: NetworkClientId) => void,\n    options: Json,\n  ): void;\n\n  _executePoll(networkClientId: NetworkClientId, options: Json): Promise<void>;\n  _startPollingByNetworkClientId(\n    networkClientId: NetworkClientId,\n    options: Json,\n  ): void;\n  _stopPollingByPollingTokenSetId(key: PollingTokenSetId): void;\n};\n\nexport const getKey = (\n  networkClientId: NetworkClientId,\n  options: Json,\n): PollingTokenSetId => `${networkClientId}:${stringify(options)}`;\n\nexport type PollingTokenSetId = `${NetworkClientId}:${string}`;\n\n// TODO: Replace `any` with type\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype Constructor = new (...args: any[]) => object;\n\n/**\n * AbstractPollingControllerBaseMixin\n *\n * @param Base - The base class to mix onto.\n * @returns The composed class.\n */\nexport function AbstractPollingControllerBaseMixin<TBase extends Constructor>(\n  Base: TBase,\n) {\n  abstract class AbstractPollingControllerBase\n    extends Base\n    implements IPollingController\n  {\n    readonly #pollingTokenSets: Map<PollingTokenSetId, Set<string>> = new Map();\n\n    #callbacks: Map<\n      PollingTokenSetId,\n      Set<(PollingTokenSetId: PollingTokenSetId) => void>\n    > = new Map();\n\n    abstract _executePoll(\n      networkClientId: NetworkClientId,\n      options: Json,\n    ): Promise<void>;\n\n    abstract _startPollingByNetworkClientId(\n      networkClientId: NetworkClientId,\n      options: Json,\n    ): void;\n\n    abstract _stopPollingByPollingTokenSetId(key: PollingTokenSetId): void;\n\n    startPollingByNetworkClientId(\n      networkClientId: NetworkClientId,\n      options: Json = {},\n    ): string {\n      const pollToken = random();\n      const key = getKey(networkClientId, options);\n      const pollingTokenSet =\n        this.#pollingTokenSets.get(key) ?? new Set<string>();\n      pollingTokenSet.add(pollToken);\n      this.#pollingTokenSets.set(key, pollingTokenSet);\n\n      if (pollingTokenSet.size === 1) {\n        this._startPollingByNetworkClientId(networkClientId, options);\n      }\n\n      return pollToken;\n    }\n\n    stopAllPolling() {\n      this.#pollingTokenSets.forEach((tokenSet, _key) => {\n        tokenSet.forEach((token) => {\n          this.stopPollingByPollingToken(token);\n        });\n      });\n    }\n\n    stopPollingByPollingToken(pollingToken: string) {\n      if (!pollingToken) {\n        throw new Error('pollingToken required');\n      }\n\n      let keyToDelete: PollingTokenSetId | null = null;\n      for (const [key, tokenSet] of this.#pollingTokenSets) {\n        if (tokenSet.delete(pollingToken)) {\n          if (tokenSet.size === 0) {\n            keyToDelete = key;\n          }\n          break;\n        }\n      }\n\n      if (keyToDelete) {\n        this._stopPollingByPollingTokenSetId(keyToDelete);\n        this.#pollingTokenSets.delete(keyToDelete);\n        const callbacks = this.#callbacks.get(keyToDelete);\n        if (callbacks) {\n          for (const callback of callbacks) {\n            // eslint-disable-next-line n/callback-return\n            callback(keyToDelete);\n          }\n          callbacks.clear();\n        }\n      }\n    }\n\n    onPollingCompleteByNetworkClientId(\n      networkClientId: NetworkClientId,\n      callback: (networkClientId: NetworkClientId) => void,\n      options: Json = {},\n    ) {\n      const key = getKey(networkClientId, options);\n      const callbacks = this.#callbacks.get(key) ?? new Set<typeof callback>();\n      callbacks.add(callback);\n      this.#callbacks.set(key, callbacks);\n    }\n  }\n  return AbstractPollingControllerBase;\n}\n"]}

package/dist/BlockTrackerPollingController.d.ts

@@ -0,0 +1,47 @@
+import { BaseController, BaseControllerV1 } from '@metamask/base-controller';
+import type { NetworkClientId, NetworkClient } from '@metamask/network-controller';
+import type { Json } from '@metamask/utils';
+import type { PollingTokenSetId } from './AbstractPollingController';
+declare class Empty {
+}
+export declare const BlockTrackerPollingControllerOnly: (abstract new (...args: any[]) => {
+    "__#93086@#activeListeners": Record<string, (options: Json) => Promise<void>>;
+    _getNetworkClientById(networkClientId: NetworkClientId): NetworkClient | undefined;
+    _startPollingByNetworkClientId(networkClientId: NetworkClientId, options: Json): void;
+    _stopPollingByPollingTokenSetId(key: PollingTokenSetId): void;
+    readonly "__#93085@#pollingTokenSets": Map<`${string}:${string}`, Set<string>>;
+    "__#93085@#callbacks": Map<`${string}:${string}`, Set<(PollingTokenSetId: `${string}:${string}`) => void>>;
+    _executePoll(networkClientId: string, options: Json): Promise<void>;
+    startPollingByNetworkClientId(networkClientId: string, options?: Json): string;
+    stopAllPolling(): void;
+    stopPollingByPollingToken(pollingToken: string): void;
+    onPollingCompleteByNetworkClientId(networkClientId: string, callback: (networkClientId: string) => void, options?: Json): void;
+}) & typeof Empty;
+export declare const BlockTrackerPollingController: (abstract new (...args: any[]) => {
+    "__#93086@#activeListeners": Record<string, (options: Json) => Promise<void>>;
+    _getNetworkClientById(networkClientId: NetworkClientId): NetworkClient | undefined;
+    _startPollingByNetworkClientId(networkClientId: NetworkClientId, options: Json): void;
+    _stopPollingByPollingTokenSetId(key: PollingTokenSetId): void;
+    readonly "__#93085@#pollingTokenSets": Map<`${string}:${string}`, Set<string>>;
+    "__#93085@#callbacks": Map<`${string}:${string}`, Set<(PollingTokenSetId: `${string}:${string}`) => void>>;
+    _executePoll(networkClientId: string, options: Json): Promise<void>;
+    startPollingByNetworkClientId(networkClientId: string, options?: Json): string;
+    stopAllPolling(): void;
+    stopPollingByPollingToken(pollingToken: string): void;
+    onPollingCompleteByNetworkClientId(networkClientId: string, callback: (networkClientId: string) => void, options?: Json): void;
+}) & typeof BaseController;
+export declare const BlockTrackerPollingControllerV1: (abstract new (...args: any[]) => {
+    "__#93086@#activeListeners": Record<string, (options: Json) => Promise<void>>;
+    _getNetworkClientById(networkClientId: NetworkClientId): NetworkClient | undefined;
+    _startPollingByNetworkClientId(networkClientId: NetworkClientId, options: Json): void;
+    _stopPollingByPollingTokenSetId(key: PollingTokenSetId): void;
+    readonly "__#93085@#pollingTokenSets": Map<`${string}:${string}`, Set<string>>;
+    "__#93085@#callbacks": Map<`${string}:${string}`, Set<(PollingTokenSetId: `${string}:${string}`) => void>>;
+    _executePoll(networkClientId: string, options: Json): Promise<void>;
+    startPollingByNetworkClientId(networkClientId: string, options?: Json): string;
+    stopAllPolling(): void;
+    stopPollingByPollingToken(pollingToken: string): void;
+    onPollingCompleteByNetworkClientId(networkClientId: string, callback: (networkClientId: string) => void, options?: Json): void;
+}) & typeof BaseControllerV1;
+export {};
+//# sourceMappingURL=BlockTrackerPollingController.d.ts.map

package/dist/BlockTrackerPollingController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlockTrackerPollingController.d.ts","sourceRoot":"","sources":["../src/BlockTrackerPollingController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,KAAK,EACV,eAAe,EACf,aAAa,EACd,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAM5C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAsErE,cAAM,KAAK;CAAG;AAEd,eAAO,MAAM,iCAAiC;0DArDC,IAAI,KAAK,QAAQ,IAAI,CAAC;2CAG9C,eAAe,GAC/B,aAAa,GAAG,SAAS;oDAGT,eAAe,WACvB,IAAI;yCAwBsB,iBAAiB;;;;;;;;iBAsBf,CAAC;AAC5C,eAAO,MAAM,6BAA6B;0DAvDK,IAAI,KAAK,QAAQ,IAAI,CAAC;2CAG9C,eAAe,GAC/B,aAAa,GAAG,SAAS;oDAGT,eAAe,WACvB,IAAI;yCAwBsB,iBAAiB;;;;;;;;0BAwBN,CAAC;AACrD,eAAO,MAAM,+BAA+B;0DAzDG,IAAI,KAAK,QAAQ,IAAI,CAAC;2CAG9C,eAAe,GAC/B,aAAa,GAAG,SAAS;oDAGT,eAAe,WACvB,IAAI;yCAwBsB,iBAAiB;;;;;;;;4BA0BJ,CAAC"}

package/dist/BlockTrackerPollingController.js

@@ -0,0 +1,60 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlockTrackerPollingControllerV1 = exports.BlockTrackerPollingController = exports.BlockTrackerPollingControllerOnly = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const AbstractPollingController_1 = require("./AbstractPollingController");
+/**
+ * BlockTrackerPollingControllerMixin
+ * A polling controller that polls using a block tracker.
+ *
+ * @param Base - The base class to mix onto.
+ * @returns The composed class.
+ */
+function BlockTrackerPollingControllerMixin(Base) {
+    var _BlockTrackerPollingController_activeListeners;
+    class BlockTrackerPollingController extends (0, AbstractPollingController_1.AbstractPollingControllerBaseMixin)(Base) {
+        constructor() {
+            super(...arguments);
+            _BlockTrackerPollingController_activeListeners.set(this, {});
+        }
+        _startPollingByNetworkClientId(networkClientId, options) {
+            const key = (0, AbstractPollingController_1.getKey)(networkClientId, options);
+            if (__classPrivateFieldGet(this, _BlockTrackerPollingController_activeListeners, "f")[key]) {
+                return;
+            }
+            const networkClient = this._getNetworkClientById(networkClientId);
+            if (networkClient) {
+                const updateOnNewBlock = this._executePoll.bind(this, networkClientId, options);
+                networkClient.blockTracker.addListener('latest', updateOnNewBlock);
+                __classPrivateFieldGet(this, _BlockTrackerPollingController_activeListeners, "f")[key] = updateOnNewBlock;
+            }
+            else {
+                throw new Error(`Unable to retrieve blockTracker for networkClientId ${networkClientId}`);
+            }
+        }
+        _stopPollingByPollingTokenSetId(key) {
+            const [networkClientId] = key.split(':');
+            const networkClient = this._getNetworkClientById(networkClientId);
+            if (networkClient && __classPrivateFieldGet(this, _BlockTrackerPollingController_activeListeners, "f")[key]) {
+                const listener = __classPrivateFieldGet(this, _BlockTrackerPollingController_activeListeners, "f")[key];
+                if (listener) {
+                    networkClient.blockTracker.removeListener('latest', listener);
+                    delete __classPrivateFieldGet(this, _BlockTrackerPollingController_activeListeners, "f")[key];
+                }
+            }
+        }
+    }
+    _BlockTrackerPollingController_activeListeners = new WeakMap();
+    return BlockTrackerPollingController;
+}
+class Empty {
+}
+exports.BlockTrackerPollingControllerOnly = BlockTrackerPollingControllerMixin(Empty);
+exports.BlockTrackerPollingController = BlockTrackerPollingControllerMixin(base_controller_1.BaseController);
+exports.BlockTrackerPollingControllerV1 = BlockTrackerPollingControllerMixin(base_controller_1.BaseControllerV1);
+//# sourceMappingURL=BlockTrackerPollingController.js.map

package/dist/BlockTrackerPollingController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlockTrackerPollingController.js","sourceRoot":"","sources":["../src/BlockTrackerPollingController.ts"],"names":[],"mappings":";;;;;;;;AAAA,+DAA6E;AAO7E,2EAGqC;AAOrC;;;;;;GAMG;AACH,SAAS,kCAAkC,CACzC,IAAW;;IAEX,MAAe,6BAA8B,SAAQ,IAAA,8DAAkC,EACrF,IAAI,CACL;QAFD;;YAGE,yDAAqE,EAAE,EAAC;QA8C1E,CAAC;QAxCC,8BAA8B,CAC5B,eAAgC,EAChC,OAAa;YAEb,MAAM,GAAG,GAAG,IAAA,kCAAM,EAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YAE7C,IAAI,uBAAA,IAAI,sDAAiB,CAAC,GAAG,CAAC,EAAE;gBAC9B,OAAO;aACR;YAED,MAAM,aAAa,GAAG,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC;YAClE,IAAI,aAAa,EAAE;gBACjB,MAAM,gBAAgB,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAC7C,IAAI,EACJ,eAAe,EACf,OAAO,CACR,CAAC;gBACF,aAAa,CAAC,YAAY,CAAC,WAAW,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;gBACnE,uBAAA,IAAI,sDAAiB,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC;aAC/C;iBAAM;gBACL,MAAM,IAAI,KAAK,CACb,uDAAuD,eAAe,EAAE,CACzE,CAAC;aACH;QACH,CAAC;QAED,+BAA+B,CAAC,GAAsB;YACpD,MAAM,CAAC,eAAe,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACzC,MAAM,aAAa,GAAG,IAAI,CAAC,qBAAqB,CAC9C,eAAkC,CACnC,CAAC;YAEF,IAAI,aAAa,IAAI,uBAAA,IAAI,sDAAiB,CAAC,GAAG,CAAC,EAAE;gBAC/C,MAAM,QAAQ,GAAG,uBAAA,IAAI,sDAAiB,CAAC,GAAG,CAAC,CAAC;gBAC5C,IAAI,QAAQ,EAAE;oBACZ,aAAa,CAAC,YAAY,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;oBAC9D,OAAO,uBAAA,IAAI,sDAAiB,CAAC,GAAG,CAAC,CAAC;iBACnC;aACF;QACH,CAAC;KACF;;IAED,OAAO,6BAA6B,CAAC;AACvC,CAAC;AAED,MAAM,KAAK;CAAG;AAED,QAAA,iCAAiC,GAC5C,kCAAkC,CAAC,KAAK,CAAC,CAAC;AAC/B,QAAA,6BAA6B,GACxC,kCAAkC,CAAC,gCAAc,CAAC,CAAC;AACxC,QAAA,+BAA+B,GAC1C,kCAAkC,CAAC,kCAAgB,CAAC,CAAC","sourcesContent":["import { BaseController, BaseControllerV1 } from '@metamask/base-controller';\nimport type {\n  NetworkClientId,\n  NetworkClient,\n} from '@metamask/network-controller';\nimport type { Json } from '@metamask/utils';\n\nimport {\n  AbstractPollingControllerBaseMixin,\n  getKey,\n} from './AbstractPollingController';\nimport type { PollingTokenSetId } from './AbstractPollingController';\n\n// TODO: Replace `any` with type\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype Constructor = new (...args: any[]) => object;\n\n/**\n * BlockTrackerPollingControllerMixin\n * A polling controller that polls using a block tracker.\n *\n * @param Base - The base class to mix onto.\n * @returns The composed class.\n */\nfunction BlockTrackerPollingControllerMixin<TBase extends Constructor>(\n  Base: TBase,\n) {\n  abstract class BlockTrackerPollingController extends AbstractPollingControllerBaseMixin(\n    Base,\n  ) {\n    #activeListeners: Record<string, (options: Json) => Promise<void>> = {};\n\n    abstract _getNetworkClientById(\n      networkClientId: NetworkClientId,\n    ): NetworkClient | undefined;\n\n    _startPollingByNetworkClientId(\n      networkClientId: NetworkClientId,\n      options: Json,\n    ) {\n      const key = getKey(networkClientId, options);\n\n      if (this.#activeListeners[key]) {\n        return;\n      }\n\n      const networkClient = this._getNetworkClientById(networkClientId);\n      if (networkClient) {\n        const updateOnNewBlock = this._executePoll.bind(\n          this,\n          networkClientId,\n          options,\n        );\n        networkClient.blockTracker.addListener('latest', updateOnNewBlock);\n        this.#activeListeners[key] = updateOnNewBlock;\n      } else {\n        throw new Error(\n          `Unable to retrieve blockTracker for networkClientId ${networkClientId}`,\n        );\n      }\n    }\n\n    _stopPollingByPollingTokenSetId(key: PollingTokenSetId) {\n      const [networkClientId] = key.split(':');\n      const networkClient = this._getNetworkClientById(\n        networkClientId as NetworkClientId,\n      );\n\n      if (networkClient && this.#activeListeners[key]) {\n        const listener = this.#activeListeners[key];\n        if (listener) {\n          networkClient.blockTracker.removeListener('latest', listener);\n          delete this.#activeListeners[key];\n        }\n      }\n    }\n  }\n\n  return BlockTrackerPollingController;\n}\n\nclass Empty {}\n\nexport const BlockTrackerPollingControllerOnly =\n  BlockTrackerPollingControllerMixin(Empty);\nexport const BlockTrackerPollingController =\n  BlockTrackerPollingControllerMixin(BaseController);\nexport const BlockTrackerPollingControllerV1 =\n  BlockTrackerPollingControllerMixin(BaseControllerV1);\n"]}

package/dist/StaticIntervalPollingController.d.ts

@@ -0,0 +1,58 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { BaseController, BaseControllerV1 } from '@metamask/base-controller';
+import type { NetworkClientId } from '@metamask/network-controller';
+import type { Json } from '@metamask/utils';
+import type { PollingTokenSetId } from './AbstractPollingController';
+declare class Empty {
+}
+export declare const StaticIntervalPollingControllerOnly: (abstract new (...args: any[]) => {
+    readonly "__#93087@#intervalIds": Record<PollingTokenSetId, NodeJS.Timeout>;
+    "__#93087@#intervalLength": number | undefined;
+    setIntervalLength(intervalLength: number): void;
+    getIntervalLength(): number | undefined;
+    _startPollingByNetworkClientId(networkClientId: NetworkClientId, options: Json): void;
+    _stopPollingByPollingTokenSetId(key: PollingTokenSetId): void;
+    readonly "__#93085@#pollingTokenSets": Map<`${string}:${string}`, Set<string>>;
+    "__#93085@#callbacks": Map<`${string}:${string}`, Set<(PollingTokenSetId: `${string}:${string}`) => void>>;
+    _executePoll(networkClientId: string, options: Json): Promise<void>;
+    startPollingByNetworkClientId(networkClientId: string, options?: Json): string;
+    stopAllPolling(): void;
+    stopPollingByPollingToken(pollingToken: string): void;
+    onPollingCompleteByNetworkClientId(networkClientId: string, callback: (networkClientId: string) => void, options?: Json): void;
+}) & typeof Empty;
+export declare const StaticIntervalPollingController: (abstract new (...args: any[]) => {
+    readonly "__#93087@#intervalIds": Record<PollingTokenSetId, NodeJS.Timeout>;
+    "__#93087@#intervalLength": number | undefined;
+    setIntervalLength(intervalLength: number): void;
+    getIntervalLength(): number | undefined;
+    _startPollingByNetworkClientId(networkClientId: NetworkClientId, options: Json): void;
+    _stopPollingByPollingTokenSetId(key: PollingTokenSetId): void;
+    readonly "__#93085@#pollingTokenSets": Map<`${string}:${string}`, Set<string>>;
+    "__#93085@#callbacks": Map<`${string}:${string}`, Set<(PollingTokenSetId: `${string}:${string}`) => void>>;
+    _executePoll(networkClientId: string, options: Json): Promise<void>;
+    startPollingByNetworkClientId(networkClientId: string, options?: Json): string;
+    stopAllPolling(): void;
+    stopPollingByPollingToken(pollingToken: string): void;
+    onPollingCompleteByNetworkClientId(networkClientId: string, callback: (networkClientId: string) => void, options?: Json): void;
+}) & typeof BaseController;
+export declare const StaticIntervalPollingControllerV1: (abstract new (...args: any[]) => {
+    readonly "__#93087@#intervalIds": Record<PollingTokenSetId, NodeJS.Timeout>;
+    "__#93087@#intervalLength": number | undefined;
+    setIntervalLength(intervalLength: number): void;
+    getIntervalLength(): number | undefined;
+    _startPollingByNetworkClientId(networkClientId: NetworkClientId, options: Json): void;
+    _stopPollingByPollingTokenSetId(key: PollingTokenSetId): void;
+    readonly "__#93085@#pollingTokenSets": Map<`${string}:${string}`, Set<string>>;
+    "__#93085@#callbacks": Map<`${string}:${string}`, Set<(PollingTokenSetId: `${string}:${string}`) => void>>;
+    _executePoll(networkClientId: string, options: Json): Promise<void>;
+    startPollingByNetworkClientId(networkClientId: string, options?: Json): string;
+    stopAllPolling(): void;
+    stopPollingByPollingToken(pollingToken: string): void;
+    onPollingCompleteByNetworkClientId(networkClientId: string, callback: (networkClientId: string) => void, options?: Json): void;
+}) & typeof BaseControllerV1;
+export {};
+//# sourceMappingURL=StaticIntervalPollingController.d.ts.map

package/dist/StaticIntervalPollingController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StaticIntervalPollingController.d.ts","sourceRoot":"","sources":["../src/StaticIntervalPollingController.ts"],"names":[],"mappings":";;;;;AAAA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAM5C,OAAO,KAAK,EAEV,iBAAiB,EAClB,MAAM,6BAA6B,CAAC;AAqErC,cAAM,KAAK;CAAG;AAEd,eAAO,MAAM,mCAAmC;sCAnDrB,OAAO,iBAAiB,EAAE,OAAO,OAAO,CAAC;gCAE/C,MAAM,GAAG,SAAS;sCAED,MAAM;;oDASrB,eAAe,WACvB,IAAI;yCAuBsB,iBAAiB;;;;;;;;iBAeb,CAAC;AAC9C,eAAO,MAAM,+BAA+B;sCArDjB,OAAO,iBAAiB,EAAE,OAAO,OAAO,CAAC;gCAE/C,MAAM,GAAG,SAAS;sCAED,MAAM;;oDASrB,eAAe,WACvB,IAAI;yCAuBsB,iBAAiB;;;;;;;;0BAiBJ,CAAC;AACvD,eAAO,MAAM,iCAAiC;sCAvDnB,OAAO,iBAAiB,EAAE,OAAO,OAAO,CAAC;gCAE/C,MAAM,GAAG,SAAS;sCAED,MAAM;;oDASrB,eAAe,WACvB,IAAI;yCAuBsB,iBAAiB;;;;;;;;4BAmBF,CAAC"}

package/dist/StaticIntervalPollingController.js

@@ -0,0 +1,80 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StaticIntervalPollingControllerV1 = exports.StaticIntervalPollingController = exports.StaticIntervalPollingControllerOnly = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const AbstractPollingController_1 = require("./AbstractPollingController");
+/**
+ * StaticIntervalPollingControllerMixin
+ * A polling controller that polls on a static interval.
+ *
+ * @param Base - The base class to mix onto.
+ * @returns The composed class.
+ */
+function StaticIntervalPollingControllerMixin(Base) {
+    var _StaticIntervalPollingController_intervalIds, _StaticIntervalPollingController_intervalLength;
+    class StaticIntervalPollingController extends (0, AbstractPollingController_1.AbstractPollingControllerBaseMixin)(Base) {
+        constructor() {
+            super(...arguments);
+            _StaticIntervalPollingController_intervalIds.set(this, {});
+            _StaticIntervalPollingController_intervalLength.set(this, 1000);
+        }
+        setIntervalLength(intervalLength) {
+            __classPrivateFieldSet(this, _StaticIntervalPollingController_intervalLength, intervalLength, "f");
+        }
+        getIntervalLength() {
+            return __classPrivateFieldGet(this, _StaticIntervalPollingController_intervalLength, "f");
+        }
+        _startPollingByNetworkClientId(networkClientId, options) {
+            if (!__classPrivateFieldGet(this, _StaticIntervalPollingController_intervalLength, "f")) {
+                throw new Error('intervalLength must be defined and greater than 0');
+            }
+            const key = (0, AbstractPollingController_1.getKey)(networkClientId, options);
+            const existingInterval = __classPrivateFieldGet(this, _StaticIntervalPollingController_intervalIds, "f")[key];
+            this._stopPollingByPollingTokenSetId(key);
+            __classPrivateFieldGet(this, _StaticIntervalPollingController_intervalIds, "f")[key] = setTimeout(() => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    yield this._executePoll(networkClientId, options);
+                }
+                catch (error) {
+                    console.error(error);
+                }
+                this._startPollingByNetworkClientId(networkClientId, options);
+            }), existingInterval ? __classPrivateFieldGet(this, _StaticIntervalPollingController_intervalLength, "f") : 0);
+        }
+        _stopPollingByPollingTokenSetId(key) {
+            const intervalId = __classPrivateFieldGet(this, _StaticIntervalPollingController_intervalIds, "f")[key];
+            if (intervalId) {
+                clearTimeout(intervalId);
+                delete __classPrivateFieldGet(this, _StaticIntervalPollingController_intervalIds, "f")[key];
+            }
+        }
+    }
+    _StaticIntervalPollingController_intervalIds = new WeakMap(), _StaticIntervalPollingController_intervalLength = new WeakMap();
+    return StaticIntervalPollingController;
+}
+class Empty {
+}
+exports.StaticIntervalPollingControllerOnly = StaticIntervalPollingControllerMixin(Empty);
+exports.StaticIntervalPollingController = StaticIntervalPollingControllerMixin(base_controller_1.BaseController);
+exports.StaticIntervalPollingControllerV1 = StaticIntervalPollingControllerMixin(base_controller_1.BaseControllerV1);
+//# sourceMappingURL=StaticIntervalPollingController.js.map

package/dist/StaticIntervalPollingController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StaticIntervalPollingController.js","sourceRoot":"","sources":["../src/StaticIntervalPollingController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA,+DAA6E;AAI7E,2EAGqC;AAUrC;;;;;;GAMG;AACH,SAAS,oCAAoC,CAC3C,IAAW;;IAEX,MAAe,+BACb,SAAQ,IAAA,8DAAkC,EAAC,IAAI,CAAC;QADlD;;YAIE,uDAAmE,EAAE,EAAC;YAEtE,0DAAsC,IAAI,EAAC;QA0C7C,CAAC;QAxCC,iBAAiB,CAAC,cAAsB;YACtC,uBAAA,IAAI,mDAAmB,cAAc,MAAA,CAAC;QACxC,CAAC;QAED,iBAAiB;YACf,OAAO,uBAAA,IAAI,uDAAgB,CAAC;QAC9B,CAAC;QAED,8BAA8B,CAC5B,eAAgC,EAChC,OAAa;YAEb,IAAI,CAAC,uBAAA,IAAI,uDAAgB,EAAE;gBACzB,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;aACtE;YAED,MAAM,GAAG,GAAG,IAAA,kCAAM,EAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YAC7C,MAAM,gBAAgB,GAAG,uBAAA,IAAI,oDAAa,CAAC,GAAG,CAAC,CAAC;YAChD,IAAI,CAAC,+BAA+B,CAAC,GAAG,CAAC,CAAC;YAE1C,uBAAA,IAAI,oDAAa,CAAC,GAAG,CAAC,GAAG,UAAU,CACjC,GAAS,EAAE;gBACT,IAAI;oBACF,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;iBACnD;gBAAC,OAAO,KAAK,EAAE;oBACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;iBACtB;gBACD,IAAI,CAAC,8BAA8B,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YAChE,CAAC,CAAA,EACD,gBAAgB,CAAC,CAAC,CAAC,uBAAA,IAAI,uDAAgB,CAAC,CAAC,CAAC,CAAC,CAC5C,CAAC;QACJ,CAAC;QAED,+BAA+B,CAAC,GAAsB;YACpD,MAAM,UAAU,GAAG,uBAAA,IAAI,oDAAa,CAAC,GAAG,CAAC,CAAC;YAC1C,IAAI,UAAU,EAAE;gBACd,YAAY,CAAC,UAAU,CAAC,CAAC;gBACzB,OAAO,uBAAA,IAAI,oDAAa,CAAC,GAAG,CAAC,CAAC;aAC/B;QACH,CAAC;KACF;;IAED,OAAO,+BAA+B,CAAC;AACzC,CAAC;AAED,MAAM,KAAK;CAAG;AAED,QAAA,mCAAmC,GAC9C,oCAAoC,CAAC,KAAK,CAAC,CAAC;AACjC,QAAA,+BAA+B,GAC1C,oCAAoC,CAAC,gCAAc,CAAC,CAAC;AAC1C,QAAA,iCAAiC,GAC5C,oCAAoC,CAAC,kCAAgB,CAAC,CAAC","sourcesContent":["import { BaseController, BaseControllerV1 } from '@metamask/base-controller';\nimport type { NetworkClientId } from '@metamask/network-controller';\nimport type { Json } from '@metamask/utils';\n\nimport {\n  AbstractPollingControllerBaseMixin,\n  getKey,\n} from './AbstractPollingController';\nimport type {\n  IPollingController,\n  PollingTokenSetId,\n} from './AbstractPollingController';\n\n// TODO: Replace `any` with type\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype Constructor = new (...args: any[]) => object;\n\n/**\n * StaticIntervalPollingControllerMixin\n * A polling controller that polls on a static interval.\n *\n * @param Base - The base class to mix onto.\n * @returns The composed class.\n */\nfunction StaticIntervalPollingControllerMixin<TBase extends Constructor>(\n  Base: TBase,\n) {\n  abstract class StaticIntervalPollingController\n    extends AbstractPollingControllerBaseMixin(Base)\n    implements IPollingController\n  {\n    readonly #intervalIds: Record<PollingTokenSetId, NodeJS.Timeout> = {};\n\n    #intervalLength: number | undefined = 1000;\n\n    setIntervalLength(intervalLength: number) {\n      this.#intervalLength = intervalLength;\n    }\n\n    getIntervalLength() {\n      return this.#intervalLength;\n    }\n\n    _startPollingByNetworkClientId(\n      networkClientId: NetworkClientId,\n      options: Json,\n    ) {\n      if (!this.#intervalLength) {\n        throw new Error('intervalLength must be defined and greater than 0');\n      }\n\n      const key = getKey(networkClientId, options);\n      const existingInterval = this.#intervalIds[key];\n      this._stopPollingByPollingTokenSetId(key);\n\n      this.#intervalIds[key] = setTimeout(\n        async () => {\n          try {\n            await this._executePoll(networkClientId, options);\n          } catch (error) {\n            console.error(error);\n          }\n          this._startPollingByNetworkClientId(networkClientId, options);\n        },\n        existingInterval ? this.#intervalLength : 0,\n      );\n    }\n\n    _stopPollingByPollingTokenSetId(key: PollingTokenSetId) {\n      const intervalId = this.#intervalIds[key];\n      if (intervalId) {\n        clearTimeout(intervalId);\n        delete this.#intervalIds[key];\n      }\n    }\n  }\n\n  return StaticIntervalPollingController;\n}\n\nclass Empty {}\n\nexport const StaticIntervalPollingControllerOnly =\n  StaticIntervalPollingControllerMixin(Empty);\nexport const StaticIntervalPollingController =\n  StaticIntervalPollingControllerMixin(BaseController);\nexport const StaticIntervalPollingControllerV1 =\n  StaticIntervalPollingControllerMixin(BaseControllerV1);\n"]}

package/dist/index.d.ts

@@ -1,2 +1,4 @@
-export { PollingController, PollingControllerV1, PollingControllerOnly, } from './PollingController';
+export { BlockTrackerPollingControllerOnly, BlockTrackerPollingController, BlockTrackerPollingControllerV1, } from './BlockTrackerPollingController';
+export { StaticIntervalPollingControllerOnly, StaticIntervalPollingController, StaticIntervalPollingControllerV1, } from './StaticIntervalPollingController';
+export type { IPollingController } from './AbstractPollingController';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iCAAiC,EACjC,6BAA6B,EAC7B,+BAA+B,GAChC,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EACL,mCAAmC,EACnC,+BAA+B,EAC/B,iCAAiC,GAClC,MAAM,mCAAmC,CAAC;AAE3C,YAAY,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC"}

package/dist/index.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PollingControllerOnly = exports.PollingControllerV1 = exports.PollingController = void 0;
-var PollingController_1 = require("./PollingController");
-Object.defineProperty(exports, "PollingController", { enumerable: true, get: function () { return PollingController_1.PollingController; } });
-Object.defineProperty(exports, "PollingControllerV1", { enumerable: true, get: function () { return PollingController_1.PollingControllerV1; } });
-Object.defineProperty(exports, "PollingControllerOnly", { enumerable: true, get: function () { return PollingController_1.PollingControllerOnly; } });
+exports.StaticIntervalPollingControllerV1 = exports.StaticIntervalPollingController = exports.StaticIntervalPollingControllerOnly = exports.BlockTrackerPollingControllerV1 = exports.BlockTrackerPollingController = exports.BlockTrackerPollingControllerOnly = void 0;
+var BlockTrackerPollingController_1 = require("./BlockTrackerPollingController");
+Object.defineProperty(exports, "BlockTrackerPollingControllerOnly", { enumerable: true, get: function () { return BlockTrackerPollingController_1.BlockTrackerPollingControllerOnly; } });
+Object.defineProperty(exports, "BlockTrackerPollingController", { enumerable: true, get: function () { return BlockTrackerPollingController_1.BlockTrackerPollingController; } });
+Object.defineProperty(exports, "BlockTrackerPollingControllerV1", { enumerable: true, get: function () { return BlockTrackerPollingController_1.BlockTrackerPollingControllerV1; } });
+var StaticIntervalPollingController_1 = require("./StaticIntervalPollingController");
+Object.defineProperty(exports, "StaticIntervalPollingControllerOnly", { enumerable: true, get: function () { return StaticIntervalPollingController_1.StaticIntervalPollingControllerOnly; } });
+Object.defineProperty(exports, "StaticIntervalPollingController", { enumerable: true, get: function () { return StaticIntervalPollingController_1.StaticIntervalPollingController; } });
+Object.defineProperty(exports, "StaticIntervalPollingControllerV1", { enumerable: true, get: function () { return StaticIntervalPollingController_1.StaticIntervalPollingControllerV1; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,yDAI6B;AAH3B,sHAAA,iBAAiB,OAAA;AACjB,wHAAA,mBAAmB,OAAA;AACnB,0HAAA,qBAAqB,OAAA","sourcesContent":["export {\n  PollingController,\n  PollingControllerV1,\n  PollingControllerOnly,\n} from './PollingController';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iFAIyC;AAHvC,kJAAA,iCAAiC,OAAA;AACjC,8IAAA,6BAA6B,OAAA;AAC7B,gJAAA,+BAA+B,OAAA;AAGjC,qFAI2C;AAHzC,sJAAA,mCAAmC,OAAA;AACnC,kJAAA,+BAA+B,OAAA;AAC/B,oJAAA,iCAAiC,OAAA","sourcesContent":["export {\n  BlockTrackerPollingControllerOnly,\n  BlockTrackerPollingController,\n  BlockTrackerPollingControllerV1,\n} from './BlockTrackerPollingController';\n\nexport {\n  StaticIntervalPollingControllerOnly,\n  StaticIntervalPollingController,\n  StaticIntervalPollingControllerV1,\n} from './StaticIntervalPollingController';\n\nexport type { IPollingController } from './AbstractPollingController';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/polling-controller",
-  "version": "2.0.0",
+  "version": "4.0.0",
   "description": "Polling Controller is the base for controllers that polling by networkClientId",
   "keywords": [
     "MetaMask",
@@ -22,6 +22,7 @@
   ],
   "scripts": {
     "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/polling-controller",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/polling-controller",
     "publish:preview": "yarn npm publish --tag preview",
     "test": "jest --reporters=jest-silent-reporter",
@@ -30,16 +31,16 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^4.0.0",
-    "@metamask/controller-utils": "^6.0.0",
-    "@metamask/network-controller": "^17.0.0",
+    "@metamask/base-controller": "^4.0.1",
+    "@metamask/controller-utils": "^8.0.1",
+    "@metamask/network-controller": "^17.1.0",
     "@metamask/utils": "^8.2.0",
     "@types/uuid": "^8.3.0",
     "fast-json-stable-stringify": "^2.1.0",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@metamask/auto-changelog": "^3.4.3",
+    "@metamask/auto-changelog": "^3.4.4",
     "@types/jest": "^27.4.1",
     "deepmerge": "^4.2.2",
     "jest": "^27.5.1",
@@ -50,7 +51,7 @@
     "typescript": "~4.8.4"
   },
   "peerDependencies": {
-    "@metamask/network-controller": "^17.0.0"
+    "@metamask/network-controller": "^17.1.0"
   },
   "engines": {
     "node": ">=16.0.0"

package/dist/PollingController.d.ts

@@ -1,161 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-import { BaseController, BaseControllerV1 } from '@metamask/base-controller';
-import type { NetworkClientId } from '@metamask/network-controller';
-import type { Json } from '@metamask/utils';
-/**
- * Returns a unique key for a networkClientId and options. This is used to group networkClientId polls with the same options
- * @param networkClientId - The networkClientId to get a key for
- * @param options - The options used to group the polling events
- * @returns The unique key
- */
-export declare const getKey: (networkClientId: NetworkClientId, options: Json) => PollingTokenSetId;
-declare type PollingTokenSetId = `${NetworkClientId}:${string}`;
-declare class Empty {
-}
-export declare const PollingControllerOnly: (abstract new (...args: any[]) => {
-    readonly "__#91333@#pollingTokenSets": Map<PollingTokenSetId, Set<string>>;
-    readonly "__#91333@#intervalIds": Record<PollingTokenSetId, NodeJS.Timeout>;
-    "__#91333@#callbacks": Map<string, Set<(networkClientId: NetworkClientId) => void>>;
-    "__#91333@#intervalLength": number;
-    getIntervalLength(): number;
-    /**
-     * Sets the length of the polling interval
-     *
-     * @param length - The length of the polling interval in milliseconds
-     */
-    setIntervalLength(length: number): void;
-    /**
-     * Starts polling for a networkClientId
-     *
-     * @param networkClientId - The networkClientId to start polling for
-     * @param options - The options used to group the polling events
-     * @returns void
-     */
-    startPollingByNetworkClientId(networkClientId: NetworkClientId, options?: Json): string;
-    /**
-     * Stops polling for all networkClientIds
-     */
-    stopAllPolling(): void;
-    /**
-     * Stops polling for a networkClientId
-     *
-     * @param pollingToken - The polling token to stop polling for
-     */
-    stopPollingByPollingToken(pollingToken: string): void;
-    /**
-     * Executes the poll for a networkClientId
-     *
-     * @param networkClientId - The networkClientId to execute the poll for
-     * @param options - The options passed to startPollingByNetworkClientId
-     */
-    _executePoll(networkClientId: NetworkClientId, options: Json): Promise<void>;
-    "__#91333@#poll"(networkClientId: NetworkClientId, options: Json): void;
-    /**
-     * Adds a callback to execute when polling is complete
-     *
-     * @param networkClientId - The networkClientId to listen for polling complete events
-     * @param callback - The callback to execute when polling is complete
-     * @param options - The options used to group the polling events
-     */
-    onPollingCompleteByNetworkClientId(networkClientId: NetworkClientId, callback: (networkClientId: NetworkClientId) => void, options?: Json): void;
-}) & typeof Empty;
-export declare const PollingController: (abstract new (...args: any[]) => {
-    readonly "__#91333@#pollingTokenSets": Map<PollingTokenSetId, Set<string>>;
-    readonly "__#91333@#intervalIds": Record<PollingTokenSetId, NodeJS.Timeout>;
-    "__#91333@#callbacks": Map<string, Set<(networkClientId: NetworkClientId) => void>>;
-    "__#91333@#intervalLength": number;
-    getIntervalLength(): number;
-    /**
-     * Sets the length of the polling interval
-     *
-     * @param length - The length of the polling interval in milliseconds
-     */
-    setIntervalLength(length: number): void;
-    /**
-     * Starts polling for a networkClientId
-     *
-     * @param networkClientId - The networkClientId to start polling for
-     * @param options - The options used to group the polling events
-     * @returns void
-     */
-    startPollingByNetworkClientId(networkClientId: NetworkClientId, options?: Json): string;
-    /**
-     * Stops polling for all networkClientIds
-     */
-    stopAllPolling(): void;
-    /**
-     * Stops polling for a networkClientId
-     *
-     * @param pollingToken - The polling token to stop polling for
-     */
-    stopPollingByPollingToken(pollingToken: string): void;
-    /**
-     * Executes the poll for a networkClientId
-     *
-     * @param networkClientId - The networkClientId to execute the poll for
-     * @param options - The options passed to startPollingByNetworkClientId
-     */
-    _executePoll(networkClientId: NetworkClientId, options: Json): Promise<void>;
-    "__#91333@#poll"(networkClientId: NetworkClientId, options: Json): void;
-    /**
-     * Adds a callback to execute when polling is complete
-     *
-     * @param networkClientId - The networkClientId to listen for polling complete events
-     * @param callback - The callback to execute when polling is complete
-     * @param options - The options used to group the polling events
-     */
-    onPollingCompleteByNetworkClientId(networkClientId: NetworkClientId, callback: (networkClientId: NetworkClientId) => void, options?: Json): void;
-}) & typeof BaseController;
-export declare const PollingControllerV1: (abstract new (...args: any[]) => {
-    readonly "__#91333@#pollingTokenSets": Map<PollingTokenSetId, Set<string>>;
-    readonly "__#91333@#intervalIds": Record<PollingTokenSetId, NodeJS.Timeout>;
-    "__#91333@#callbacks": Map<string, Set<(networkClientId: NetworkClientId) => void>>;
-    "__#91333@#intervalLength": number;
-    getIntervalLength(): number;
-    /**
-     * Sets the length of the polling interval
-     *
-     * @param length - The length of the polling interval in milliseconds
-     */
-    setIntervalLength(length: number): void;
-    /**
-     * Starts polling for a networkClientId
-     *
-     * @param networkClientId - The networkClientId to start polling for
-     * @param options - The options used to group the polling events
-     * @returns void
-     */
-    startPollingByNetworkClientId(networkClientId: NetworkClientId, options?: Json): string;
-    /**
-     * Stops polling for all networkClientIds
-     */
-    stopAllPolling(): void;
-    /**
-     * Stops polling for a networkClientId
-     *
-     * @param pollingToken - The polling token to stop polling for
-     */
-    stopPollingByPollingToken(pollingToken: string): void;
-    /**
-     * Executes the poll for a networkClientId
-     *
-     * @param networkClientId - The networkClientId to execute the poll for
-     * @param options - The options passed to startPollingByNetworkClientId
-     */
-    _executePoll(networkClientId: NetworkClientId, options: Json): Promise<void>;
-    "__#91333@#poll"(networkClientId: NetworkClientId, options: Json): void;
-    /**
-     * Adds a callback to execute when polling is complete
-     *
-     * @param networkClientId - The networkClientId to listen for polling complete events
-     * @param callback - The callback to execute when polling is complete
-     * @param options - The options used to group the polling events
-     */
-    onPollingCompleteByNetworkClientId(networkClientId: NetworkClientId, callback: (networkClientId: NetworkClientId) => void, options?: Json): void;
-}) & typeof BaseControllerV1;
-export {};
-//# sourceMappingURL=PollingController.d.ts.map

package/dist/PollingController.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PollingController.d.ts","sourceRoot":"","sources":["../src/PollingController.ts"],"names":[],"mappings":";;;;;AAAA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAQ5C;;;;;GAKG;AACH,eAAO,MAAM,MAAM,oBACA,eAAe,WACvB,IAAI,KACZ,iBAA+D,CAAC;AAEnE,aAAK,iBAAiB,GAAG,GAAG,eAAe,IAAI,MAAM,EAAE,CAAC;AAwKxD,cAAM,KAAK;CAAG;AAEd,eAAO,MAAM,qBAAqB,0BAvLD,GAAG,EAAE;2CA4BN,IAAI,iBAAiB,EAAE,IAAI,MAAM,CAAC,CAAC;sCAExC,OAAO,iBAAiB,EAAE,OAAO,OAAO,CAAC;6DAIxC,eAAe,KAAK,IAAI;;;IAShD;;;;OAIG;8BACuB,MAAM;IAIhC;;;;;;OAMG;mDAEgB,eAAe,YACvB,IAAI;IAkBf;;OAEG;;IASH;;;;OAIG;4CACqC,MAAM;IAyB9C;;;;;OAKG;kCAEgB,eAAe,WACvB,IAAI,GACZ,QAAQ,IAAI,CAAC;sCAEO,eAAe,WAAW,IAAI;IAuBrD;;;;;;OAMG;wDAEgB,eAAe,8BACJ,eAAe,KAAK,IAAI,YAC3C,IAAI;iBAmB+C,CAAC;AACnE,eAAO,MAAM,iBAAiB,0BAxLG,GAAG,EAAE;2CA4BN,IAAI,iBAAiB,EAAE,IAAI,MAAM,CAAC,CAAC;sCAExC,OAAO,iBAAiB,EAAE,OAAO,OAAO,CAAC;6DAIxC,eAAe,KAAK,IAAI;;;IAShD;;;;OAIG;8BACuB,MAAM;IAIhC;;;;;;OAMG;mDAEgB,eAAe,YACvB,IAAI;IAkBf;;OAEG;;IASH;;;;OAIG;4CACqC,MAAM;IAyB9C;;;;;OAKG;kCAEgB,eAAe,WACvB,IAAI,GACZ,QAAQ,IAAI,CAAC;sCAEO,eAAe,WAAW,IAAI;IAuBrD;;;;;;OAMG;wDAEgB,eAAe,8BACJ,eAAe,KAAK,IAAI,YAC3C,IAAI;0BAoBoD,CAAC;AACxE,eAAO,MAAM,mBAAmB,0BAzLC,GAAG,EAAE;2CA4BN,IAAI,iBAAiB,EAAE,IAAI,MAAM,CAAC,CAAC;sCAExC,OAAO,iBAAiB,EAAE,OAAO,OAAO,CAAC;6DAIxC,eAAe,KAAK,IAAI;;;IAShD;;;;OAIG;8BACuB,MAAM;IAIhC;;;;;;OAMG;mDAEgB,eAAe,YACvB,IAAI;IAkBf;;OAEG;;IASH;;;;OAIG;4CACqC,MAAM;IAyB9C;;;;;OAKG;kCAEgB,eAAe,WACvB,IAAI,GACZ,QAAQ,IAAI,CAAC;sCAEO,eAAe,WAAW,IAAI;IAuBrD;;;;;;OAMG;wDAEgB,eAAe,8BACJ,eAAe,KAAK,IAAI,YAC3C,IAAI;4BAqBwD,CAAC"}

package/dist/PollingController.js

@@ -1,181 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PollingControllerV1 = exports.PollingController = exports.PollingControllerOnly = exports.getKey = void 0;
-const base_controller_1 = require("@metamask/base-controller");
-const fast_json_stable_stringify_1 = __importDefault(require("fast-json-stable-stringify"));
-const uuid_1 = require("uuid");
-/**
- * Returns a unique key for a networkClientId and options. This is used to group networkClientId polls with the same options
- * @param networkClientId - The networkClientId to get a key for
- * @param options - The options used to group the polling events
- * @returns The unique key
- */
-const getKey = (networkClientId, options) => `${networkClientId}:${(0, fast_json_stable_stringify_1.default)(options)}`;
-exports.getKey = getKey;
-/**
- * PollingControllerMixin
- *
- * @param Base - The base class to mix onto.
- * @returns The composed class.
- */
-function PollingControllerMixin(Base) {
-    var _PollingControllerBase_instances, _PollingControllerBase_pollingTokenSets, _PollingControllerBase_intervalIds, _PollingControllerBase_callbacks, _PollingControllerBase_intervalLength, _PollingControllerBase_poll;
-    /**
-     * PollingController is an abstract class that implements the polling
-     * functionality for a controller. It is meant to be extended by a controller
-     * that needs to poll for data by networkClientId.
-     *
-     */
-    class PollingControllerBase extends Base {
-        constructor() {
-            super(...arguments);
-            _PollingControllerBase_instances.add(this);
-            _PollingControllerBase_pollingTokenSets.set(this, new Map());
-            _PollingControllerBase_intervalIds.set(this, {});
-            _PollingControllerBase_callbacks.set(this, new Map());
-            _PollingControllerBase_intervalLength.set(this, 1000);
-        }
-        getIntervalLength() {
-            return __classPrivateFieldGet(this, _PollingControllerBase_intervalLength, "f");
-        }
-        /**
-         * Sets the length of the polling interval
-         *
-         * @param length - The length of the polling interval in milliseconds
-         */
-        setIntervalLength(length) {
-            __classPrivateFieldSet(this, _PollingControllerBase_intervalLength, length, "f");
-        }
-        /**
-         * Starts polling for a networkClientId
-         *
-         * @param networkClientId - The networkClientId to start polling for
-         * @param options - The options used to group the polling events
-         * @returns void
-         */
-        startPollingByNetworkClientId(networkClientId, options = {}) {
-            const pollToken = (0, uuid_1.v4)();
-            const key = (0, exports.getKey)(networkClientId, options);
-            const pollingTokenSet = __classPrivateFieldGet(this, _PollingControllerBase_pollingTokenSets, "f").get(key);
-            if (pollingTokenSet) {
-                pollingTokenSet.add(pollToken);
-            }
-            else {
-                const set = new Set();
-                set.add(pollToken);
-                __classPrivateFieldGet(this, _PollingControllerBase_pollingTokenSets, "f").set(key, set);
-            }
-            __classPrivateFieldGet(this, _PollingControllerBase_instances, "m", _PollingControllerBase_poll).call(this, networkClientId, options);
-            return pollToken;
-        }
-        /**
-         * Stops polling for all networkClientIds
-         */
-        stopAllPolling() {
-            __classPrivateFieldGet(this, _PollingControllerBase_pollingTokenSets, "f").forEach((tokenSet, _networkClientId) => {
-                tokenSet.forEach((token) => {
-                    this.stopPollingByPollingToken(token);
-                });
-            });
-        }
-        /**
-         * Stops polling for a networkClientId
-         *
-         * @param pollingToken - The polling token to stop polling for
-         */
-        stopPollingByPollingToken(pollingToken) {
-            if (!pollingToken) {
-                throw new Error('pollingToken required');
-            }
-            let found = false;
-            __classPrivateFieldGet(this, _PollingControllerBase_pollingTokenSets, "f").forEach((tokenSet, key) => {
-                var _a, _b;
-                if (tokenSet.has(pollingToken)) {
-                    found = true;
-                    tokenSet.delete(pollingToken);
-                    if (tokenSet.size === 0) {
-                        clearTimeout(__classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[key]);
-                        delete __classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[key];
-                        __classPrivateFieldGet(this, _PollingControllerBase_pollingTokenSets, "f").delete(key);
-                        (_a = __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").get(key)) === null || _a === void 0 ? void 0 : _a.forEach((callback) => {
-                            callback(key);
-                        });
-                        (_b = __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").get(key)) === null || _b === void 0 ? void 0 : _b.clear();
-                    }
-                }
-            });
-            if (!found) {
-                throw new Error('pollingToken not found');
-            }
-        }
-        /**
-         * Adds a callback to execute when polling is complete
-         *
-         * @param networkClientId - The networkClientId to listen for polling complete events
-         * @param callback - The callback to execute when polling is complete
-         * @param options - The options used to group the polling events
-         */
-        onPollingCompleteByNetworkClientId(networkClientId, callback, options = {}) {
-            const key = (0, exports.getKey)(networkClientId, options);
-            const callbacks = __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").get(key);
-            if (callbacks === undefined) {
-                const set = new Set();
-                set.add(callback);
-                __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").set(key, set);
-            }
-            else {
-                callbacks.add(callback);
-            }
-        }
-    }
-    _PollingControllerBase_pollingTokenSets = new WeakMap(), _PollingControllerBase_intervalIds = new WeakMap(), _PollingControllerBase_callbacks = new WeakMap(), _PollingControllerBase_intervalLength = new WeakMap(), _PollingControllerBase_instances = new WeakSet(), _PollingControllerBase_poll = function _PollingControllerBase_poll(networkClientId, options) {
-        const key = (0, exports.getKey)(networkClientId, options);
-        const interval = __classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[key];
-        if (interval) {
-            clearTimeout(interval);
-            delete __classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[key];
-        }
-        // setTimeout is not `await`ing this async function, which is expected
-        // We're just using async here for improved stack traces
-        // eslint-disable-next-line @typescript-eslint/no-misused-promises
-        __classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[key] = setTimeout(() => __awaiter(this, void 0, void 0, function* () {
-            try {
-                yield this._executePoll(networkClientId, options);
-            }
-            catch (error) {
-                console.error(error);
-            }
-            __classPrivateFieldGet(this, _PollingControllerBase_instances, "m", _PollingControllerBase_poll).call(this, networkClientId, options);
-        }), interval ? __classPrivateFieldGet(this, _PollingControllerBase_intervalLength, "f") : 0);
-    };
-    return PollingControllerBase;
-}
-class Empty {
-}
-exports.PollingControllerOnly = PollingControllerMixin(Empty);
-exports.PollingController = PollingControllerMixin(base_controller_1.BaseController);
-exports.PollingControllerV1 = PollingControllerMixin(base_controller_1.BaseControllerV1);
-//# sourceMappingURL=PollingController.js.map

package/dist/PollingController.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PollingController.js","sourceRoot":"","sources":["../src/PollingController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+DAA6E;AAG7E,4FAAmD;AACnD,+BAAoC;AAMpC;;;;;GAKG;AACI,MAAM,MAAM,GAAG,CACpB,eAAgC,EAChC,OAAa,EACM,EAAE,CAAC,GAAG,eAAe,IAAI,IAAA,oCAAS,EAAC,OAAO,CAAC,EAAE,CAAC;AAHtD,QAAA,MAAM,UAGgD;AAGnE;;;;;GAKG;AACH,SAAS,sBAAsB,CAA4B,IAAW;;IACpE;;;;;OAKG;IACH,MAAe,qBAAsB,SAAQ,IAAI;QAAjD;;;YACE,kDAAkE,IAAI,GAAG,EAAE,EAAC;YAE5E,6CAAmE,EAAE,EAAC;YAEtE,2CAGI,IAAI,GAAG,EAAE,EAAC;YAEd,gDAAkB,IAAI,EAAC;QA4IzB,CAAC;QA1IC,iBAAiB;YACf,OAAO,uBAAA,IAAI,6CAAgB,CAAC;QAC9B,CAAC;QAED;;;;WAIG;QACH,iBAAiB,CAAC,MAAc;YAC9B,uBAAA,IAAI,yCAAmB,MAAM,MAAA,CAAC;QAChC,CAAC;QAED;;;;;;WAMG;QACH,6BAA6B,CAC3B,eAAgC,EAChC,UAAgB,EAAE;YAElB,MAAM,SAAS,GAAG,IAAA,SAAM,GAAE,CAAC;YAE3B,MAAM,GAAG,GAAG,IAAA,cAAM,EAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YAE7C,MAAM,eAAe,GAAG,uBAAA,IAAI,+CAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACxD,IAAI,eAAe,EAAE;gBACnB,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;aAChC;iBAAM;gBACL,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;gBAC9B,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACnB,uBAAA,IAAI,+CAAkB,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;aACtC;YACD,uBAAA,IAAI,qEAAM,MAAV,IAAI,EAAO,eAAe,EAAE,OAAO,CAAC,CAAC;YACrC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED;;WAEG;QACH,cAAc;YACZ,uBAAA,IAAI,+CAAkB,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,gBAAgB,EAAE,EAAE;gBAC5D,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;oBACzB,IAAI,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;gBACxC,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QAED;;;;WAIG;QACH,yBAAyB,CAAC,YAAoB;YAC5C,IAAI,CAAC,YAAY,EAAE;gBACjB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;aAC1C;YACD,IAAI,KAAK,GAAG,KAAK,CAAC;YAClB,uBAAA,IAAI,+CAAkB,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE;;gBAC/C,IAAI,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE;oBAC9B,KAAK,GAAG,IAAI,CAAC;oBACb,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;oBAC9B,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE;wBACvB,YAAY,CAAC,uBAAA,IAAI,0CAAa,CAAC,GAAG,CAAC,CAAC,CAAC;wBACrC,OAAO,uBAAA,IAAI,0CAAa,CAAC,GAAG,CAAC,CAAC;wBAC9B,uBAAA,IAAI,+CAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;wBACnC,MAAA,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,GAAG,CAAC,0CAAE,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;4BAC7C,QAAQ,CAAC,GAAG,CAAC,CAAC;wBAChB,CAAC,CAAC,CAAC;wBACH,MAAA,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,GAAG,CAAC,0CAAE,KAAK,EAAE,CAAC;qBACnC;iBACF;YACH,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,KAAK,EAAE;gBACV,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;aAC3C;QACH,CAAC;QAoCD;;;;;;WAMG;QACH,kCAAkC,CAChC,eAAgC,EAChC,QAAoD,EACpD,UAAgB,EAAE;YAElB,MAAM,GAAG,GAAG,IAAA,cAAM,EAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YAC7C,MAAM,SAAS,GAAG,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAE3C,IAAI,SAAS,KAAK,SAAS,EAAE;gBAC3B,MAAM,GAAG,GAAG,IAAI,GAAG,EAAmB,CAAC;gBACvC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAClB,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;aAC/B;iBAAM;gBACL,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;aACzB;QACH,CAAC;KACF;+UA9CO,eAAgC,EAAE,OAAa;QACnD,MAAM,GAAG,GAAG,IAAA,cAAM,EAAC,eAAe,EAAE,OAAO,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,uBAAA,IAAI,0CAAa,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,QAAQ,EAAE;YACZ,YAAY,CAAC,QAAQ,CAAC,CAAC;YACvB,OAAO,uBAAA,IAAI,0CAAa,CAAC,GAAG,CAAC,CAAC;SAC/B;QACD,sEAAsE;QACtE,wDAAwD;QACxD,kEAAkE;QAClE,uBAAA,IAAI,0CAAa,CAAC,GAAG,CAAC,GAAG,UAAU,CACjC,GAAS,EAAE;YACT,IAAI;gBACF,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;aACnD;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aACtB;YACD,uBAAA,IAAI,qEAAM,MAAV,IAAI,EAAO,eAAe,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC,CAAA,EACD,QAAQ,CAAC,CAAC,CAAC,uBAAA,IAAI,6CAAgB,CAAC,CAAC,CAAC,CAAC,CACpC,CAAC;IACJ,CAAC;IA0BH,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAED,MAAM,KAAK;CAAG;AAED,QAAA,qBAAqB,GAAG,sBAAsB,CAAC,KAAK,CAAC,CAAC;AACtD,QAAA,iBAAiB,GAAG,sBAAsB,CAAC,gCAAc,CAAC,CAAC;AAC3D,QAAA,mBAAmB,GAAG,sBAAsB,CAAC,kCAAgB,CAAC,CAAC","sourcesContent":["import { BaseController, BaseControllerV1 } from '@metamask/base-controller';\nimport type { NetworkClientId } from '@metamask/network-controller';\nimport type { Json } from '@metamask/utils';\nimport stringify from 'fast-json-stable-stringify';\nimport { v4 as random } from 'uuid';\n\n// Mixin classes require a constructor with an `...any[]` parameter\n// See TS2545\ntype Constructor = new (...args: any[]) => object;\n\n/**\n * Returns a unique key for a networkClientId and options. This is used to group networkClientId polls with the same options\n * @param networkClientId - The networkClientId to get a key for\n * @param options - The options used to group the polling events\n * @returns The unique key\n */\nexport const getKey = (\n  networkClientId: NetworkClientId,\n  options: Json,\n): PollingTokenSetId => `${networkClientId}:${stringify(options)}`;\n\ntype PollingTokenSetId = `${NetworkClientId}:${string}`;\n/**\n * PollingControllerMixin\n *\n * @param Base - The base class to mix onto.\n * @returns The composed class.\n */\nfunction PollingControllerMixin<TBase extends Constructor>(Base: TBase) {\n  /**\n   * PollingController is an abstract class that implements the polling\n   * functionality for a controller. It is meant to be extended by a controller\n   * that needs to poll for data by networkClientId.\n   *\n   */\n  abstract class PollingControllerBase extends Base {\n    readonly #pollingTokenSets: Map<PollingTokenSetId, Set<string>> = new Map();\n\n    readonly #intervalIds: Record<PollingTokenSetId, NodeJS.Timeout> = {};\n\n    #callbacks: Map<\n      NetworkClientId,\n      Set<(networkClientId: NetworkClientId) => void>\n    > = new Map();\n\n    #intervalLength = 1000;\n\n    getIntervalLength() {\n      return this.#intervalLength;\n    }\n\n    /**\n     * Sets the length of the polling interval\n     *\n     * @param length - The length of the polling interval in milliseconds\n     */\n    setIntervalLength(length: number) {\n      this.#intervalLength = length;\n    }\n\n    /**\n     * Starts polling for a networkClientId\n     *\n     * @param networkClientId - The networkClientId to start polling for\n     * @param options - The options used to group the polling events\n     * @returns void\n     */\n    startPollingByNetworkClientId(\n      networkClientId: NetworkClientId,\n      options: Json = {},\n    ) {\n      const pollToken = random();\n\n      const key = getKey(networkClientId, options);\n\n      const pollingTokenSet = this.#pollingTokenSets.get(key);\n      if (pollingTokenSet) {\n        pollingTokenSet.add(pollToken);\n      } else {\n        const set = new Set<string>();\n        set.add(pollToken);\n        this.#pollingTokenSets.set(key, set);\n      }\n      this.#poll(networkClientId, options);\n      return pollToken;\n    }\n\n    /**\n     * Stops polling for all networkClientIds\n     */\n    stopAllPolling() {\n      this.#pollingTokenSets.forEach((tokenSet, _networkClientId) => {\n        tokenSet.forEach((token) => {\n          this.stopPollingByPollingToken(token);\n        });\n      });\n    }\n\n    /**\n     * Stops polling for a networkClientId\n     *\n     * @param pollingToken - The polling token to stop polling for\n     */\n    stopPollingByPollingToken(pollingToken: string) {\n      if (!pollingToken) {\n        throw new Error('pollingToken required');\n      }\n      let found = false;\n      this.#pollingTokenSets.forEach((tokenSet, key) => {\n        if (tokenSet.has(pollingToken)) {\n          found = true;\n          tokenSet.delete(pollingToken);\n          if (tokenSet.size === 0) {\n            clearTimeout(this.#intervalIds[key]);\n            delete this.#intervalIds[key];\n            this.#pollingTokenSets.delete(key);\n            this.#callbacks.get(key)?.forEach((callback) => {\n              callback(key);\n            });\n            this.#callbacks.get(key)?.clear();\n          }\n        }\n      });\n      if (!found) {\n        throw new Error('pollingToken not found');\n      }\n    }\n\n    /**\n     * Executes the poll for a networkClientId\n     *\n     * @param networkClientId - The networkClientId to execute the poll for\n     * @param options - The options passed to startPollingByNetworkClientId\n     */\n    abstract _executePoll(\n      networkClientId: NetworkClientId,\n      options: Json,\n    ): Promise<void>;\n\n    #poll(networkClientId: NetworkClientId, options: Json) {\n      const key = getKey(networkClientId, options);\n      const interval = this.#intervalIds[key];\n      if (interval) {\n        clearTimeout(interval);\n        delete this.#intervalIds[key];\n      }\n      // setTimeout is not `await`ing this async function, which is expected\n      // We're just using async here for improved stack traces\n      // eslint-disable-next-line @typescript-eslint/no-misused-promises\n      this.#intervalIds[key] = setTimeout(\n        async () => {\n          try {\n            await this._executePoll(networkClientId, options);\n          } catch (error) {\n            console.error(error);\n          }\n          this.#poll(networkClientId, options);\n        },\n        interval ? this.#intervalLength : 0,\n      );\n    }\n\n    /**\n     * Adds a callback to execute when polling is complete\n     *\n     * @param networkClientId - The networkClientId to listen for polling complete events\n     * @param callback - The callback to execute when polling is complete\n     * @param options - The options used to group the polling events\n     */\n    onPollingCompleteByNetworkClientId(\n      networkClientId: NetworkClientId,\n      callback: (networkClientId: NetworkClientId) => void,\n      options: Json = {},\n    ) {\n      const key = getKey(networkClientId, options);\n      const callbacks = this.#callbacks.get(key);\n\n      if (callbacks === undefined) {\n        const set = new Set<typeof callback>();\n        set.add(callback);\n        this.#callbacks.set(key, set);\n      } else {\n        callbacks.add(callback);\n      }\n    }\n  }\n  return PollingControllerBase;\n}\n\nclass Empty {}\n\nexport const PollingControllerOnly = PollingControllerMixin(Empty);\nexport const PollingController = PollingControllerMixin(BaseController);\nexport const PollingControllerV1 = PollingControllerMixin(BaseControllerV1);\n"]}