@metamask-previews/eth-block-tracker 14.0.0-preview-468843ab

package/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [14.0.0]
+
+### Changed
+
+- **BREAKING:** Update minimum Node.js version from `^18.16.0` to `^18.18.0` ([#6865](https://github.com/MetaMask/core/pull/6865))
+- This package was migrated from `MetaMask/eth-block-tracker` to the
+  `MetaMask/core` monorepo ([#6865](https://github.com/MetaMask/core/pull/6865))
+  - See [`MetaMask/eth-block-tracker`](https://github.com/MetaMask/eth-block-tracker/blob/main/CHANGELOG.md)
+    for the original changelog.
+
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/eth-block-tracker@14.0.0...HEAD
+[14.0.0]: https://github.com/MetaMask/core/releases/tag/@metamask/eth-block-tracker@14.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2018 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,91 @@
+# `@metamask/eth-block-tracker`
+
+This module walks the Ethereum blockchain, keeping track of the latest block. It uses a web3 provider as a data source and will continuously poll for the next block.
+
+## Installation
+
+`yarn add @metamask/eth-block-tracker`
+
+or
+
+`npm install @metamask/eth-block-tracker`
+
+## Usage
+
+```js
+const createInfuraProvider = require('@metamask/eth-json-rpc-infura');
+const { PollingBlockTracker } = require('@metamask/eth-block-tracker');
+
+const provider = createInfuraProvider({
+  network: 'mainnet',
+  projectId: process.env.INFURA_PROJECT_ID,
+});
+const blockTracker = new PollingBlockTracker({ provider });
+
+blockTracker.on('sync', ({ newBlock, oldBlock }) => {
+  if (oldBlock) {
+    console.log(`sync #${Number(oldBlock)} -> #${Number(newBlock)}`);
+  } else {
+    console.log(`first sync #${Number(newBlock)}`);
+  }
+});
+```
+
+## API
+
+### Methods
+
+#### new PollingBlockTracker({ provider, pollingInterval, retryTimeout, keepEventLoopActive, usePastBlocks })
+
+- Creates a new block tracker with `provider` as a data source and `pollingInterval` (ms) timeout between polling for the latest block.
+- If an error is encountered when fetching blocks, it will wait `retryTimeout` (ms) before attempting again.
+- If `keepEventLoopActive` is `false`, in Node.js it will [unref the polling timeout](https://nodejs.org/api/timers.html#timers_timeout_unref), allowing the process to exit during the polling interval. Defaults to `true`, meaning the process will be kept alive.
+- If `usePastBlocks` is `true`, block numbers less than the current block number can used and emitted. Defaults to `false`, meaning that only block numbers greater than the current block number will be used and emitted.
+
+#### getCurrentBlock()
+
+Synchronously returns the current block. May be `null`.
+
+```js
+console.log(blockTracker.getCurrentBlock());
+```
+
+#### async getLatestBlock()
+
+Asynchronously returns the latest block. if not immediately available, it will fetch one.
+
+#### async checkForLatestBlock()
+
+Tells the block tracker to ask for a new block immediately, in addition to its normal polling interval. Useful if you received a hint of a new block (e.g. via `tx.blockNumber` from `getTransactionByHash`). Will resolve to the new latest block when done polling.
+
+### Events
+
+#### latest
+
+The `latest` event is emitted for whenever a new latest block is detected. This may mean skipping blocks if there were two created since the last polling period.
+
+```js
+blockTracker.on('latest', (newBlock) => console.log(newBlock));
+```
+
+#### sync
+
+The `sync` event is emitted the same as "latest" but includes the previous block.
+
+```js
+blockTracker.on('sync', ({ newBlock, oldBlock }) =>
+  console.log(newBlock, oldBlock),
+);
+```
+
+#### error
+
+The `error` event means an error occurred while polling for the latest block.
+
+```js
+blockTracker.on('error', (err) => console.error(err));
+```
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/BlockTracker.cjs

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=BlockTracker.cjs.map

package/dist/BlockTracker.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlockTracker.cjs","sourceRoot":"","sources":["../src/BlockTracker.ts"],"names":[],"mappings":"","sourcesContent":["import type SafeEventEmitter from '@metamask/safe-event-emitter';\n\nexport type BlockTracker = SafeEventEmitter & {\n  destroy(): Promise<void>;\n\n  isRunning(): boolean;\n\n  getCurrentBlock(): string | null;\n\n  getLatestBlock(): Promise<string>;\n\n  checkForLatestBlock(): Promise<string>;\n};\n"]}

package/dist/BlockTracker.d.cts

@@ -0,0 +1,9 @@
+import type SafeEventEmitter from "@metamask/safe-event-emitter";
+export type BlockTracker = SafeEventEmitter & {
+    destroy(): Promise<void>;
+    isRunning(): boolean;
+    getCurrentBlock(): string | null;
+    getLatestBlock(): Promise<string>;
+    checkForLatestBlock(): Promise<string>;
+};
+//# sourceMappingURL=BlockTracker.d.cts.map

package/dist/BlockTracker.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlockTracker.d.cts","sourceRoot":"","sources":["../src/BlockTracker.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,gBAAgB,qCAAqC;AAEjE,MAAM,MAAM,YAAY,GAAG,gBAAgB,GAAG;IAC5C,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB,SAAS,IAAI,OAAO,CAAC;IAErB,eAAe,IAAI,MAAM,GAAG,IAAI,CAAC;IAEjC,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAElC,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CACxC,CAAC"}

package/dist/BlockTracker.d.mts

@@ -0,0 +1,9 @@
+import type SafeEventEmitter from "@metamask/safe-event-emitter";
+export type BlockTracker = SafeEventEmitter & {
+    destroy(): Promise<void>;
+    isRunning(): boolean;
+    getCurrentBlock(): string | null;
+    getLatestBlock(): Promise<string>;
+    checkForLatestBlock(): Promise<string>;
+};
+//# sourceMappingURL=BlockTracker.d.mts.map

package/dist/BlockTracker.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlockTracker.d.mts","sourceRoot":"","sources":["../src/BlockTracker.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,gBAAgB,qCAAqC;AAEjE,MAAM,MAAM,YAAY,GAAG,gBAAgB,GAAG;IAC5C,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB,SAAS,IAAI,OAAO,CAAC;IAErB,eAAe,IAAI,MAAM,GAAG,IAAI,CAAC;IAEjC,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAElC,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CACxC,CAAC"}

package/dist/BlockTracker.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=BlockTracker.mjs.map

package/dist/BlockTracker.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlockTracker.mjs","sourceRoot":"","sources":["../src/BlockTracker.ts"],"names":[],"mappings":"","sourcesContent":["import type SafeEventEmitter from '@metamask/safe-event-emitter';\n\nexport type BlockTracker = SafeEventEmitter & {\n  destroy(): Promise<void>;\n\n  isRunning(): boolean;\n\n  getCurrentBlock(): string | null;\n\n  getLatestBlock(): Promise<string>;\n\n  checkForLatestBlock(): Promise<string>;\n};\n"]}

package/dist/PollingBlockTracker.cjs

@@ -0,0 +1,352 @@
+"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 __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 };
+};
+var _PollingBlockTracker_instances, _PollingBlockTracker_internalEventListeners, _PollingBlockTracker_pendingLatestBlock, _PollingBlockTracker_pendingFetch, _PollingBlockTracker_addInternalListener, _PollingBlockTracker_removeInternalListener, _PollingBlockTracker_rejectPendingLatestBlock;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PollingBlockTracker = void 0;
+const safe_event_emitter_1 = __importDefault(require("@metamask/safe-event-emitter"));
+const utils_1 = require("@metamask/utils");
+const json_rpc_random_id_1 = __importDefault(require("json-rpc-random-id"));
+const logging_utils_1 = require("./logging-utils.cjs");
+const log = (0, logging_utils_1.createModuleLogger)(logging_utils_1.projectLogger, 'polling-block-tracker');
+const createRandomId = (0, json_rpc_random_id_1.default)();
+const sec = 1000;
+const blockTrackerEvents = ['sync', 'latest'];
+class PollingBlockTracker extends safe_event_emitter_1.default {
+    constructor(opts = {}) {
+        // parse + validate args
+        if (!opts.provider) {
+            throw new Error('PollingBlockTracker - no provider specified.');
+        }
+        super();
+        _PollingBlockTracker_instances.add(this);
+        _PollingBlockTracker_internalEventListeners.set(this, []);
+        _PollingBlockTracker_pendingLatestBlock.set(this, void 0);
+        _PollingBlockTracker_pendingFetch.set(this, void 0);
+        // config
+        this._blockResetDuration = opts.blockResetDuration || 20 * sec;
+        this._usePastBlocks = opts.usePastBlocks || false;
+        // state
+        this._currentBlock = null;
+        this._isRunning = false;
+        // bind functions for internal use
+        this._onNewListener = this._onNewListener.bind(this);
+        this._onRemoveListener = this._onRemoveListener.bind(this);
+        this._resetCurrentBlock = this._resetCurrentBlock.bind(this);
+        // listen for handler changes
+        this._setupInternalEvents();
+        // config
+        this._provider = opts.provider;
+        this._pollingInterval = opts.pollingInterval || 20 * sec;
+        this._retryTimeout = opts.retryTimeout || this._pollingInterval / 10;
+        this._keepEventLoopActive =
+            opts.keepEventLoopActive === undefined ? true : opts.keepEventLoopActive;
+        this._setSkipCacheFlag = opts.setSkipCacheFlag || false;
+    }
+    async destroy() {
+        this._cancelBlockResetTimeout();
+        super.removeAllListeners();
+        this._maybeEnd();
+    }
+    isRunning() {
+        return this._isRunning;
+    }
+    getCurrentBlock() {
+        return this._currentBlock;
+    }
+    async getLatestBlock({ useCache = true, } = {}) {
+        // return if available
+        if (this._currentBlock && useCache) {
+            return this._currentBlock;
+        }
+        if (__classPrivateFieldGet(this, _PollingBlockTracker_pendingLatestBlock, "f")) {
+            return await __classPrivateFieldGet(this, _PollingBlockTracker_pendingLatestBlock, "f").promise;
+        }
+        const { promise, resolve, reject } = (0, utils_1.createDeferredPromise)({
+            suppressUnhandledRejection: true,
+        });
+        __classPrivateFieldSet(this, _PollingBlockTracker_pendingLatestBlock, { reject, promise }, "f");
+        if (this._isRunning) {
+            try {
+                // If tracker is running, wait for next block with timeout
+                const onLatestBlock = (value) => {
+                    __classPrivateFieldGet(this, _PollingBlockTracker_instances, "m", _PollingBlockTracker_removeInternalListener).call(this, onLatestBlock);
+                    this.removeListener('latest', onLatestBlock);
+                    resolve(value);
+                };
+                __classPrivateFieldGet(this, _PollingBlockTracker_instances, "m", _PollingBlockTracker_addInternalListener).call(this, onLatestBlock);
+                this.once('latest', onLatestBlock);
+                return await promise;
+            }
+            catch (error) {
+                reject(error);
+                throw error;
+            }
+            finally {
+                __classPrivateFieldSet(this, _PollingBlockTracker_pendingLatestBlock, undefined, "f");
+            }
+        }
+        else {
+            // If tracker isn't running, just fetch directly
+            try {
+                const latestBlock = await this._updateLatestBlock();
+                resolve(latestBlock);
+                return latestBlock;
+            }
+            catch (error) {
+                reject(error);
+                throw error;
+            }
+            finally {
+                // We want to rate limit calls to this method if we made a direct fetch
+                // for the block number because the BlockTracker was not running. We
+                // achieve this by delaying the unsetting of the #pendingLatestBlock promise.
+                setTimeout(() => {
+                    __classPrivateFieldSet(this, _PollingBlockTracker_pendingLatestBlock, undefined, "f");
+                }, this._pollingInterval);
+            }
+        }
+    }
+    // dont allow module consumer to remove our internal event listeners
+    removeAllListeners(eventName) {
+        // perform default behavior, preserve fn arity
+        if (eventName) {
+            super.removeAllListeners(eventName);
+        }
+        else {
+            super.removeAllListeners();
+        }
+        // re-add internal events
+        this._setupInternalEvents();
+        // trigger stop check just in case
+        this._onRemoveListener();
+        return this;
+    }
+    _setupInternalEvents() {
+        // first remove listeners for idempotence
+        this.removeListener('newListener', this._onNewListener);
+        this.removeListener('removeListener', this._onRemoveListener);
+        // then add them
+        this.on('newListener', this._onNewListener);
+        this.on('removeListener', this._onRemoveListener);
+    }
+    _onNewListener(eventName) {
+        // `newListener` is called *before* the listener is added
+        if (blockTrackerEvents.includes(eventName)) {
+            // TODO: Handle dangling promise
+            this._maybeStart();
+        }
+    }
+    _onRemoveListener() {
+        // `removeListener` is called *after* the listener is removed
+        if (this._getBlockTrackerEventCount() > 0) {
+            return;
+        }
+        this._maybeEnd();
+    }
+    _maybeStart() {
+        if (this._isRunning) {
+            return;
+        }
+        this._isRunning = true;
+        // cancel setting latest block to stale
+        this._cancelBlockResetTimeout();
+        this._start();
+        this.emit('_started');
+    }
+    _maybeEnd() {
+        if (!this._isRunning) {
+            return;
+        }
+        this._isRunning = false;
+        this._setupBlockResetTimeout();
+        this._end();
+        __classPrivateFieldGet(this, _PollingBlockTracker_instances, "m", _PollingBlockTracker_rejectPendingLatestBlock).call(this, new Error('Block tracker destroyed'));
+        this.emit('_ended');
+    }
+    _getBlockTrackerEventCount() {
+        return (blockTrackerEvents
+            .map((eventName) => this.listeners(eventName))
+            .flat()
+            // internal listeners are not included in the count
+            .filter((listener) => __classPrivateFieldGet(this, _PollingBlockTracker_internalEventListeners, "f").every((internalListener) => !Object.is(internalListener, listener))).length);
+    }
+    _shouldUseNewBlock(newBlock) {
+        const currentBlock = this._currentBlock;
+        if (!currentBlock) {
+            return true;
+        }
+        const newBlockInt = hexToInt(newBlock);
+        const currentBlockInt = hexToInt(currentBlock);
+        return ((this._usePastBlocks && newBlockInt < currentBlockInt) ||
+            newBlockInt > currentBlockInt);
+    }
+    _newPotentialLatest(newBlock) {
+        if (!this._shouldUseNewBlock(newBlock)) {
+            return;
+        }
+        this._setCurrentBlock(newBlock);
+    }
+    _setCurrentBlock(newBlock) {
+        const oldBlock = this._currentBlock;
+        this._currentBlock = newBlock;
+        this.emit('latest', newBlock);
+        this.emit('sync', { oldBlock, newBlock });
+    }
+    _setupBlockResetTimeout() {
+        // clear any existing timeout
+        this._cancelBlockResetTimeout();
+        // clear latest block when stale
+        this._blockResetTimeout = setTimeout(this._resetCurrentBlock, this._blockResetDuration);
+        // nodejs - dont hold process open
+        if (this._blockResetTimeout.unref) {
+            this._blockResetTimeout.unref();
+        }
+    }
+    _cancelBlockResetTimeout() {
+        if (this._blockResetTimeout) {
+            clearTimeout(this._blockResetTimeout);
+        }
+    }
+    _resetCurrentBlock() {
+        this._currentBlock = null;
+    }
+    /**
+     * Checks for the latest block, updates the internal state,  and returns the
+     * value immediately rather than waiting for the next polling interval.
+     *
+     * @deprecated Use {@link getLatestBlock} instead.
+     * @returns A promise that resolves to the latest block number.
+     */
+    async checkForLatestBlock() {
+        await this._updateLatestBlock();
+        return await this.getLatestBlock();
+    }
+    _start() {
+        // Intentionally not awaited as this starts the polling via a timeout chain.
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        this._updateAndQueue();
+    }
+    _end() {
+        this._clearPollingTimeout();
+    }
+    async _updateLatestBlock() {
+        // fetch + set latest block
+        const latestBlock = await this._fetchLatestBlock();
+        this._newPotentialLatest(latestBlock);
+        if (!this._isRunning) {
+            // Ensure the one-time update is eventually reset once it's stale
+            this._setupBlockResetTimeout();
+        }
+        // _newPotentialLatest() ensures that this._currentBlock is not null
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        return this._currentBlock;
+    }
+    async _fetchLatestBlock() {
+        // If there's already a pending fetch, reuse it
+        if (__classPrivateFieldGet(this, _PollingBlockTracker_pendingFetch, "f")) {
+            return await __classPrivateFieldGet(this, _PollingBlockTracker_pendingFetch, "f").promise;
+        }
+        // Create a new deferred promise for this request
+        const { promise, resolve, reject } = (0, utils_1.createDeferredPromise)({
+            suppressUnhandledRejection: true,
+        });
+        __classPrivateFieldSet(this, _PollingBlockTracker_pendingFetch, { reject, promise }, "f");
+        try {
+            const req = {
+                jsonrpc: '2.0',
+                id: createRandomId(),
+                method: 'eth_blockNumber',
+                params: [],
+            };
+            if (this._setSkipCacheFlag) {
+                req.skipCache = true;
+            }
+            log('Making request', req);
+            const result = await this._provider.request(req);
+            log('Got result', result);
+            resolve(result);
+            return result;
+        }
+        catch (error) {
+            log('Encountered error fetching block', (0, utils_1.getErrorMessage)(error));
+            reject(error);
+            __classPrivateFieldGet(this, _PollingBlockTracker_instances, "m", _PollingBlockTracker_rejectPendingLatestBlock).call(this, error);
+            throw error;
+        }
+        finally {
+            __classPrivateFieldSet(this, _PollingBlockTracker_pendingFetch, undefined, "f");
+        }
+    }
+    /**
+     * The core polling function that runs after each interval.
+     * Updates the latest block and then queues the next update.
+     */
+    async _updateAndQueue() {
+        let interval = this._pollingInterval;
+        try {
+            await this._updateLatestBlock();
+        }
+        catch (error) {
+            try {
+                this.emit('error', error);
+            }
+            catch {
+                console.error(`Error updating latest block: ${(0, utils_1.getErrorMessage)(error)}`);
+            }
+            interval = this._retryTimeout;
+        }
+        if (!this._isRunning) {
+            return;
+        }
+        this._clearPollingTimeout();
+        const timeoutRef = setTimeout(() => {
+            // Intentionally not awaited as this just continues the polling loop.
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
+            this._updateAndQueue();
+        }, interval);
+        if (timeoutRef.unref && !this._keepEventLoopActive) {
+            timeoutRef.unref();
+        }
+        this._pollingTimeout = timeoutRef;
+        this.emit('_waitingForNextIteration');
+    }
+    _clearPollingTimeout() {
+        if (this._pollingTimeout) {
+            clearTimeout(this._pollingTimeout);
+            this._pollingTimeout = undefined;
+        }
+    }
+}
+exports.PollingBlockTracker = PollingBlockTracker;
+_PollingBlockTracker_internalEventListeners = new WeakMap(), _PollingBlockTracker_pendingLatestBlock = new WeakMap(), _PollingBlockTracker_pendingFetch = new WeakMap(), _PollingBlockTracker_instances = new WeakSet(), _PollingBlockTracker_addInternalListener = function _PollingBlockTracker_addInternalListener(listener) {
+    __classPrivateFieldGet(this, _PollingBlockTracker_internalEventListeners, "f").push(listener);
+}, _PollingBlockTracker_removeInternalListener = function _PollingBlockTracker_removeInternalListener(listener) {
+    __classPrivateFieldGet(this, _PollingBlockTracker_internalEventListeners, "f").splice(__classPrivateFieldGet(this, _PollingBlockTracker_internalEventListeners, "f").indexOf(listener), 1);
+}, _PollingBlockTracker_rejectPendingLatestBlock = function _PollingBlockTracker_rejectPendingLatestBlock(error) {
+    __classPrivateFieldGet(this, _PollingBlockTracker_pendingLatestBlock, "f")?.reject(error);
+    __classPrivateFieldSet(this, _PollingBlockTracker_pendingLatestBlock, undefined, "f");
+};
+/**
+ * Converts a number represented as a string in hexadecimal format into a native
+ * number.
+ *
+ * @param hexInt - The hex string.
+ * @returns The number.
+ */
+function hexToInt(hexInt) {
+    return Number.parseInt(hexInt, 16);
+}
+//# sourceMappingURL=PollingBlockTracker.cjs.map

package/dist/PollingBlockTracker.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"PollingBlockTracker.cjs","sourceRoot":"","sources":["../src/PollingBlockTracker.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AACA,sFAA4D;AAC5D,2CAKyB;AACzB,4EAAmD;AAGnD,uDAAoE;AAEpE,MAAM,GAAG,GAAG,IAAA,kCAAkB,EAAC,6BAAa,EAAE,uBAAuB,CAAC,CAAC;AACvE,MAAM,cAAc,GAAG,IAAA,4BAAiB,GAAE,CAAC;AAC3C,MAAM,GAAG,GAAG,IAAI,CAAC;AAEjB,MAAM,kBAAkB,GAAwB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAkBnE,MAAa,mBACX,SAAQ,4BAAgB;IA+BxB,YAAY,OAAmC,EAAE;QAC/C,wBAAwB;QACxB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;SACjE;QAED,KAAK,EAAE,CAAC;;QAZD,sDAA8C,EAAE,EAAC;QAE1D,0DAA+D;QAE/D,oDAAyD;QAUvD,SAAS;QACT,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,kBAAkB,IAAI,EAAE,GAAG,GAAG,CAAC;QAC/D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,aAAa,IAAI,KAAK,CAAC;QAClD,QAAQ;QACR,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QAExB,kCAAkC;QAClC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3D,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE7D,6BAA6B;QAC7B,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAE5B,SAAS;QACT,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,eAAe,IAAI,EAAE,GAAG,GAAG,CAAC;QACzD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QACrE,IAAI,CAAC,oBAAoB;YACvB,IAAI,CAAC,mBAAmB,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC;QAC3E,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,IAAI,KAAK,CAAC;IAC1D,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAChC,KAAK,CAAC,kBAAkB,EAAE,CAAC;QAC3B,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,eAAe;QACb,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,EACnB,QAAQ,GAAG,IAAI,MACW,EAAE;QAC5B,sBAAsB;QACtB,IAAI,IAAI,CAAC,aAAa,IAAI,QAAQ,EAAE;YAClC,OAAO,IAAI,CAAC,aAAa,CAAC;SAC3B;QAED,IAAI,uBAAA,IAAI,+CAAoB,EAAE;YAC5B,OAAO,MAAM,uBAAA,IAAI,+CAAoB,CAAC,OAAO,CAAC;SAC/C;QAED,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAA,6BAAqB,EAAS;YACjE,0BAA0B,EAAE,IAAI;SACjC,CAAC,CAAC;QACH,uBAAA,IAAI,2CAAuB,EAAE,MAAM,EAAE,OAAO,EAAE,MAAA,CAAC;QAE/C,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,IAAI;gBACF,0DAA0D;gBAC1D,MAAM,aAAa,GAAG,CAAC,KAAa,EAAE,EAAE;oBACtC,uBAAA,IAAI,mFAAwB,MAA5B,IAAI,EAAyB,aAAa,CAAC,CAAC;oBAC5C,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;oBAC7C,OAAO,CAAC,KAAK,CAAC,CAAC;gBACjB,CAAC,CAAC;gBAEF,uBAAA,IAAI,gFAAqB,MAAzB,IAAI,EAAsB,aAAa,CAAC,CAAC;gBACzC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;gBAEnC,OAAO,MAAM,OAAO,CAAC;aACtB;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,CAAC,KAAK,CAAC,CAAC;gBACd,MAAM,KAAK,CAAC;aACb;oBAAS;gBACR,uBAAA,IAAI,2CAAuB,SAAS,MAAA,CAAC;aACtC;SACF;aAAM;YACL,gDAAgD;YAChD,IAAI;gBACF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACpD,OAAO,CAAC,WAAW,CAAC,CAAC;gBACrB,OAAO,WAAW,CAAC;aACpB;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,CAAC,KAAK,CAAC,CAAC;gBACd,MAAM,KAAK,CAAC;aACb;oBAAS;gBACR,uEAAuE;gBACvE,oEAAoE;gBACpE,6EAA6E;gBAC7E,UAAU,CAAC,GAAG,EAAE;oBACd,uBAAA,IAAI,2CAAuB,SAAS,MAAA,CAAC;gBACvC,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAC3B;SACF;IACH,CAAC;IAED,oEAAoE;IACpE,kBAAkB,CAAC,SAA2B;QAC5C,8CAA8C;QAC9C,IAAI,SAAS,EAAE;YACb,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;SACrC;aAAM;YACL,KAAK,CAAC,kBAAkB,EAAE,CAAC;SAC5B;QAED,yBAAyB;QACzB,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,kCAAkC;QAClC,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAEzB,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,oBAAoB;QAC1B,yCAAyC;QACzC,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QACxD,IAAI,CAAC,cAAc,CAAC,gBAAgB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC9D,gBAAgB;QAChB,IAAI,CAAC,EAAE,CAAC,aAAa,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC5C,IAAI,CAAC,EAAE,CAAC,gBAAgB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACpD,CAAC;IAEO,cAAc,CAAC,SAA0B;QAC/C,yDAAyD;QACzD,IAAI,kBAAkB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;YAC1C,gCAAgC;YAChC,IAAI,CAAC,WAAW,EAAE,CAAC;SACpB;IACH,CAAC;IAEO,iBAAiB;QACvB,6DAA6D;QAC7D,IAAI,IAAI,CAAC,0BAA0B,EAAE,GAAG,CAAC,EAAE;YACzC,OAAO;SACR;QACD,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAEO,WAAW;QACjB,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,OAAO;SACR;QAED,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,uCAAuC;QACvC,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAChC,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACxB,CAAC;IAEO,SAAS;QACf,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,OAAO;SACR;QAED,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAC/B,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,uBAAA,IAAI,qFAA0B,MAA9B,IAAI,EAA2B,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC,CAAC;QACrE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtB,CAAC;IAEO,0BAA0B;QAChC,OAAO,CACL,kBAAkB;aACf,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;aAC7C,IAAI,EAAE;YACP,mDAAmD;aAClD,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CACnB,uBAAA,IAAI,mDAAwB,CAAC,KAAK,CAChC,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAC7D,CACF,CAAC,MAAM,CACX,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,QAAgB;QACzC,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,CAAC,YAAY,EAAE;YACjB,OAAO,IAAI,CAAC;SACb;QACD,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,eAAe,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC;QAE/C,OAAO,CACL,CAAC,IAAI,CAAC,cAAc,IAAI,WAAW,GAAG,eAAe,CAAC;YACtD,WAAW,GAAG,eAAe,CAC9B,CAAC;IACJ,CAAC;IAEO,mBAAmB,CAAC,QAAgB;QAC1C,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE;YACtC,OAAO;SACR;QACD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAEO,gBAAgB,CAAC,QAAgB;QACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC;QACpC,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC5C,CAAC;IAEO,uBAAuB;QAC7B,6BAA6B;QAC7B,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAChC,gCAAgC;QAChC,IAAI,CAAC,kBAAkB,GAAG,UAAU,CAClC,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,mBAAmB,CACzB,CAAC;QAEF,kCAAkC;QAClC,IAAI,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE;YACjC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;SACjC;IACH,CAAC;IAEO,wBAAwB;QAC9B,IAAI,IAAI,CAAC,kBAAkB,EAAE;YAC3B,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;SACvC;IACH,CAAC;IAEO,kBAAkB;QACxB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,mBAAmB;QACvB,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAChC,OAAO,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;IACrC,CAAC;IAEO,MAAM;QACZ,4EAA4E;QAC5E,mEAAmE;QACnE,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAEO,IAAI;QACV,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAEO,KAAK,CAAC,kBAAkB;QAC9B,2BAA2B;QAC3B,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACnD,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAEtC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,iEAAiE;YACjE,IAAI,CAAC,uBAAuB,EAAE,CAAC;SAChC;QAED,oEAAoE;QACpE,oEAAoE;QACpE,OAAO,IAAI,CAAC,aAAc,CAAC;IAC7B,CAAC;IAEO,KAAK,CAAC,iBAAiB;QAC7B,+CAA+C;QAC/C,IAAI,uBAAA,IAAI,yCAAc,EAAE;YACtB,OAAO,MAAM,uBAAA,IAAI,yCAAc,CAAC,OAAO,CAAC;SACzC;QAED,iDAAiD;QACjD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAA,6BAAqB,EAAS;YACjE,0BAA0B,EAAE,IAAI;SACjC,CAAC,CAAC;QACH,uBAAA,IAAI,qCAAiB,EAAE,MAAM,EAAE,OAAO,EAAE,MAAA,CAAC;QAEzC,IAAI;YACF,MAAM,GAAG,GAA2B;gBAClC,OAAO,EAAE,KAAK;gBACd,EAAE,EAAE,cAAc,EAAE;gBACpB,MAAM,EAAE,iBAAiB;gBACzB,MAAM,EAAE,EAAQ;aACjB,CAAC;YACF,IAAI,IAAI,CAAC,iBAAiB,EAAE;gBAC1B,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC;aACtB;YAED,GAAG,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;YAC3B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAa,GAAG,CAAC,CAAC;YAC7D,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;YAC1B,OAAO,CAAC,MAAM,CAAC,CAAC;YAChB,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,KAAK,EAAE;YACd,GAAG,CAAC,kCAAkC,EAAE,IAAA,uBAAe,EAAC,KAAK,CAAC,CAAC,CAAC;YAChE,MAAM,CAAC,KAAK,CAAC,CAAC;YACd,uBAAA,IAAI,qFAA0B,MAA9B,IAAI,EAA2B,KAAK,CAAC,CAAC;YACtC,MAAM,KAAK,CAAC;SACb;gBAAS;YACR,uBAAA,IAAI,qCAAiB,SAAS,MAAA,CAAC;SAChC;IACH,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,eAAe;QAC3B,IAAI,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAErC,IAAI;YACF,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;SACjC;QAAC,OAAO,KAAc,EAAE;YACvB,IAAI;gBACF,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;aAC3B;YAAC,MAAM;gBACN,OAAO,CAAC,KAAK,CAAC,gCAAgC,IAAA,uBAAe,EAAC,KAAK,CAAC,EAAE,CAAC,CAAC;aACzE;YAED,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC;SAC/B;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,OAAO;SACR;QAED,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAE5B,MAAM,UAAU,GAAG,UAAU,CAAC,GAAG,EAAE;YACjC,qEAAqE;YACrE,mEAAmE;YACnE,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,CAAC,EAAE,QAAQ,CAAC,CAAC;QAEb,IAAI,UAAU,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE;YAClD,UAAU,CAAC,KAAK,EAAE,CAAC;SACpB;QAED,IAAI,CAAC,eAAe,GAAG,UAAU,CAAC;QAElC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;IACxC,CAAC;IAED,oBAAoB;QAClB,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YACnC,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;SAClC;IACH,CAAC;CAiBF;AApZD,kDAoZC;sTAfsB,QAA0B;IAC7C,uBAAA,IAAI,mDAAwB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC9C,CAAC,qGAEuB,QAA0B;IAChD,uBAAA,IAAI,mDAAwB,CAAC,MAAM,CACjC,uBAAA,IAAI,mDAAwB,CAAC,OAAO,CAAC,QAAQ,CAAC,EAC9C,CAAC,CACF,CAAC;AACJ,CAAC,yGAEyB,KAAc;IACtC,uBAAA,IAAI,+CAAoB,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;IACxC,uBAAA,IAAI,2CAAuB,SAAS,MAAA,CAAC;AACvC,CAAC;AAGH;;;;;;GAMG;AACH,SAAS,QAAQ,CAAC,MAAc;IAC9B,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACrC,CAAC","sourcesContent":["import type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';\nimport SafeEventEmitter from '@metamask/safe-event-emitter';\nimport {\n  createDeferredPromise,\n  type DeferredPromise,\n  getErrorMessage,\n  type JsonRpcRequest,\n} from '@metamask/utils';\nimport getCreateRandomId from 'json-rpc-random-id';\n\nimport type { BlockTracker } from './BlockTracker';\nimport { projectLogger, createModuleLogger } from './logging-utils';\n\nconst log = createModuleLogger(projectLogger, 'polling-block-tracker');\nconst createRandomId = getCreateRandomId();\nconst sec = 1000;\n\nconst blockTrackerEvents: (string | symbol)[] = ['sync', 'latest'];\n\nexport type PollingBlockTrackerOptions = {\n  provider?: SafeEventEmitterProvider;\n  pollingInterval?: number;\n  retryTimeout?: number;\n  keepEventLoopActive?: boolean;\n  setSkipCacheFlag?: boolean;\n  blockResetDuration?: number;\n  usePastBlocks?: boolean;\n};\n\ntype ExtendedJsonRpcRequest = {\n  skipCache?: boolean;\n} & JsonRpcRequest<[]>;\n\ntype InternalListener = (value: string) => void;\n\nexport class PollingBlockTracker\n  extends SafeEventEmitter\n  implements BlockTracker\n{\n  private _isRunning: boolean;\n\n  private readonly _blockResetDuration: number;\n\n  private readonly _usePastBlocks: boolean;\n\n  private _currentBlock: string | null;\n\n  private _blockResetTimeout?: ReturnType<typeof setTimeout>;\n\n  private _pollingTimeout?: ReturnType<typeof setTimeout>;\n\n  private readonly _provider: SafeEventEmitterProvider;\n\n  private readonly _pollingInterval: number;\n\n  private readonly _retryTimeout: number;\n\n  private readonly _keepEventLoopActive: boolean;\n\n  private readonly _setSkipCacheFlag: boolean;\n\n  readonly #internalEventListeners: InternalListener[] = [];\n\n  #pendingLatestBlock?: Omit<DeferredPromise<string>, 'resolve'>;\n\n  #pendingFetch?: Omit<DeferredPromise<string>, 'resolve'>;\n\n  constructor(opts: PollingBlockTrackerOptions = {}) {\n    // parse + validate args\n    if (!opts.provider) {\n      throw new Error('PollingBlockTracker - no provider specified.');\n    }\n\n    super();\n\n    // config\n    this._blockResetDuration = opts.blockResetDuration || 20 * sec;\n    this._usePastBlocks = opts.usePastBlocks || false;\n    // state\n    this._currentBlock = null;\n    this._isRunning = false;\n\n    // bind functions for internal use\n    this._onNewListener = this._onNewListener.bind(this);\n    this._onRemoveListener = this._onRemoveListener.bind(this);\n    this._resetCurrentBlock = this._resetCurrentBlock.bind(this);\n\n    // listen for handler changes\n    this._setupInternalEvents();\n\n    // config\n    this._provider = opts.provider;\n    this._pollingInterval = opts.pollingInterval || 20 * sec;\n    this._retryTimeout = opts.retryTimeout || this._pollingInterval / 10;\n    this._keepEventLoopActive =\n      opts.keepEventLoopActive === undefined ? true : opts.keepEventLoopActive;\n    this._setSkipCacheFlag = opts.setSkipCacheFlag || false;\n  }\n\n  async destroy() {\n    this._cancelBlockResetTimeout();\n    super.removeAllListeners();\n    this._maybeEnd();\n  }\n\n  isRunning(): boolean {\n    return this._isRunning;\n  }\n\n  getCurrentBlock(): string | null {\n    return this._currentBlock;\n  }\n\n  async getLatestBlock({\n    useCache = true,\n  }: { useCache?: boolean } = {}): Promise<string> {\n    // return if available\n    if (this._currentBlock && useCache) {\n      return this._currentBlock;\n    }\n\n    if (this.#pendingLatestBlock) {\n      return await this.#pendingLatestBlock.promise;\n    }\n\n    const { promise, resolve, reject } = createDeferredPromise<string>({\n      suppressUnhandledRejection: true,\n    });\n    this.#pendingLatestBlock = { reject, promise };\n\n    if (this._isRunning) {\n      try {\n        // If tracker is running, wait for next block with timeout\n        const onLatestBlock = (value: string) => {\n          this.#removeInternalListener(onLatestBlock);\n          this.removeListener('latest', onLatestBlock);\n          resolve(value);\n        };\n\n        this.#addInternalListener(onLatestBlock);\n        this.once('latest', onLatestBlock);\n\n        return await promise;\n      } catch (error) {\n        reject(error);\n        throw error;\n      } finally {\n        this.#pendingLatestBlock = undefined;\n      }\n    } else {\n      // If tracker isn't running, just fetch directly\n      try {\n        const latestBlock = await this._updateLatestBlock();\n        resolve(latestBlock);\n        return latestBlock;\n      } catch (error) {\n        reject(error);\n        throw error;\n      } finally {\n        // We want to rate limit calls to this method if we made a direct fetch\n        // for the block number because the BlockTracker was not running. We\n        // achieve this by delaying the unsetting of the #pendingLatestBlock promise.\n        setTimeout(() => {\n          this.#pendingLatestBlock = undefined;\n        }, this._pollingInterval);\n      }\n    }\n  }\n\n  // dont allow module consumer to remove our internal event listeners\n  removeAllListeners(eventName?: string | symbol) {\n    // perform default behavior, preserve fn arity\n    if (eventName) {\n      super.removeAllListeners(eventName);\n    } else {\n      super.removeAllListeners();\n    }\n\n    // re-add internal events\n    this._setupInternalEvents();\n    // trigger stop check just in case\n    this._onRemoveListener();\n\n    return this;\n  }\n\n  private _setupInternalEvents(): void {\n    // first remove listeners for idempotence\n    this.removeListener('newListener', this._onNewListener);\n    this.removeListener('removeListener', this._onRemoveListener);\n    // then add them\n    this.on('newListener', this._onNewListener);\n    this.on('removeListener', this._onRemoveListener);\n  }\n\n  private _onNewListener(eventName: string | symbol): void {\n    // `newListener` is called *before* the listener is added\n    if (blockTrackerEvents.includes(eventName)) {\n      // TODO: Handle dangling promise\n      this._maybeStart();\n    }\n  }\n\n  private _onRemoveListener(): void {\n    // `removeListener` is called *after* the listener is removed\n    if (this._getBlockTrackerEventCount() > 0) {\n      return;\n    }\n    this._maybeEnd();\n  }\n\n  private _maybeStart() {\n    if (this._isRunning) {\n      return;\n    }\n\n    this._isRunning = true;\n    // cancel setting latest block to stale\n    this._cancelBlockResetTimeout();\n    this._start();\n    this.emit('_started');\n  }\n\n  private _maybeEnd() {\n    if (!this._isRunning) {\n      return;\n    }\n\n    this._isRunning = false;\n    this._setupBlockResetTimeout();\n    this._end();\n    this.#rejectPendingLatestBlock(new Error('Block tracker destroyed'));\n    this.emit('_ended');\n  }\n\n  private _getBlockTrackerEventCount(): number {\n    return (\n      blockTrackerEvents\n        .map((eventName) => this.listeners(eventName))\n        .flat()\n        // internal listeners are not included in the count\n        .filter((listener) =>\n          this.#internalEventListeners.every(\n            (internalListener) => !Object.is(internalListener, listener),\n          ),\n        ).length\n    );\n  }\n\n  private _shouldUseNewBlock(newBlock: string) {\n    const currentBlock = this._currentBlock;\n    if (!currentBlock) {\n      return true;\n    }\n    const newBlockInt = hexToInt(newBlock);\n    const currentBlockInt = hexToInt(currentBlock);\n\n    return (\n      (this._usePastBlocks && newBlockInt < currentBlockInt) ||\n      newBlockInt > currentBlockInt\n    );\n  }\n\n  private _newPotentialLatest(newBlock: string): void {\n    if (!this._shouldUseNewBlock(newBlock)) {\n      return;\n    }\n    this._setCurrentBlock(newBlock);\n  }\n\n  private _setCurrentBlock(newBlock: string): void {\n    const oldBlock = this._currentBlock;\n    this._currentBlock = newBlock;\n    this.emit('latest', newBlock);\n    this.emit('sync', { oldBlock, newBlock });\n  }\n\n  private _setupBlockResetTimeout(): void {\n    // clear any existing timeout\n    this._cancelBlockResetTimeout();\n    // clear latest block when stale\n    this._blockResetTimeout = setTimeout(\n      this._resetCurrentBlock,\n      this._blockResetDuration,\n    );\n\n    // nodejs - dont hold process open\n    if (this._blockResetTimeout.unref) {\n      this._blockResetTimeout.unref();\n    }\n  }\n\n  private _cancelBlockResetTimeout(): void {\n    if (this._blockResetTimeout) {\n      clearTimeout(this._blockResetTimeout);\n    }\n  }\n\n  private _resetCurrentBlock(): void {\n    this._currentBlock = null;\n  }\n\n  /**\n   * Checks for the latest block, updates the internal state,  and returns the\n   * value immediately rather than waiting for the next polling interval.\n   *\n   * @deprecated Use {@link getLatestBlock} instead.\n   * @returns A promise that resolves to the latest block number.\n   */\n  async checkForLatestBlock() {\n    await this._updateLatestBlock();\n    return await this.getLatestBlock();\n  }\n\n  private _start() {\n    // Intentionally not awaited as this starts the polling via a timeout chain.\n    // eslint-disable-next-line @typescript-eslint/no-floating-promises\n    this._updateAndQueue();\n  }\n\n  private _end() {\n    this._clearPollingTimeout();\n  }\n\n  private async _updateLatestBlock(): Promise<string> {\n    // fetch + set latest block\n    const latestBlock = await this._fetchLatestBlock();\n    this._newPotentialLatest(latestBlock);\n\n    if (!this._isRunning) {\n      // Ensure the one-time update is eventually reset once it's stale\n      this._setupBlockResetTimeout();\n    }\n\n    // _newPotentialLatest() ensures that this._currentBlock is not null\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    return this._currentBlock!;\n  }\n\n  private async _fetchLatestBlock(): Promise<string> {\n    // If there's already a pending fetch, reuse it\n    if (this.#pendingFetch) {\n      return await this.#pendingFetch.promise;\n    }\n\n    // Create a new deferred promise for this request\n    const { promise, resolve, reject } = createDeferredPromise<string>({\n      suppressUnhandledRejection: true,\n    });\n    this.#pendingFetch = { reject, promise };\n\n    try {\n      const req: ExtendedJsonRpcRequest = {\n        jsonrpc: '2.0',\n        id: createRandomId(),\n        method: 'eth_blockNumber',\n        params: [] as [],\n      };\n      if (this._setSkipCacheFlag) {\n        req.skipCache = true;\n      }\n\n      log('Making request', req);\n      const result = await this._provider.request<[], string>(req);\n      log('Got result', result);\n      resolve(result);\n      return result;\n    } catch (error) {\n      log('Encountered error fetching block', getErrorMessage(error));\n      reject(error);\n      this.#rejectPendingLatestBlock(error);\n      throw error;\n    } finally {\n      this.#pendingFetch = undefined;\n    }\n  }\n\n  /**\n   * The core polling function that runs after each interval.\n   * Updates the latest block and then queues the next update.\n   */\n  private async _updateAndQueue() {\n    let interval = this._pollingInterval;\n\n    try {\n      await this._updateLatestBlock();\n    } catch (error: unknown) {\n      try {\n        this.emit('error', error);\n      } catch {\n        console.error(`Error updating latest block: ${getErrorMessage(error)}`);\n      }\n\n      interval = this._retryTimeout;\n    }\n\n    if (!this._isRunning) {\n      return;\n    }\n\n    this._clearPollingTimeout();\n\n    const timeoutRef = setTimeout(() => {\n      // Intentionally not awaited as this just continues the polling loop.\n      // eslint-disable-next-line @typescript-eslint/no-floating-promises\n      this._updateAndQueue();\n    }, interval);\n\n    if (timeoutRef.unref && !this._keepEventLoopActive) {\n      timeoutRef.unref();\n    }\n\n    this._pollingTimeout = timeoutRef;\n\n    this.emit('_waitingForNextIteration');\n  }\n\n  _clearPollingTimeout() {\n    if (this._pollingTimeout) {\n      clearTimeout(this._pollingTimeout);\n      this._pollingTimeout = undefined;\n    }\n  }\n\n  #addInternalListener(listener: InternalListener) {\n    this.#internalEventListeners.push(listener);\n  }\n\n  #removeInternalListener(listener: InternalListener) {\n    this.#internalEventListeners.splice(\n      this.#internalEventListeners.indexOf(listener),\n      1,\n    );\n  }\n\n  #rejectPendingLatestBlock(error: unknown) {\n    this.#pendingLatestBlock?.reject(error);\n    this.#pendingLatestBlock = undefined;\n  }\n}\n\n/**\n * Converts a number represented as a string in hexadecimal format into a native\n * number.\n *\n * @param hexInt - The hex string.\n * @returns The number.\n */\nfunction hexToInt(hexInt: string): number {\n  return Number.parseInt(hexInt, 16);\n}\n"]}

package/dist/PollingBlockTracker.d.cts

@@ -0,0 +1,65 @@
+import type { SafeEventEmitterProvider } from "@metamask/eth-json-rpc-provider";
+import SafeEventEmitter from "@metamask/safe-event-emitter";
+import type { BlockTracker } from "./BlockTracker.cjs";
+export type PollingBlockTrackerOptions = {
+    provider?: SafeEventEmitterProvider;
+    pollingInterval?: number;
+    retryTimeout?: number;
+    keepEventLoopActive?: boolean;
+    setSkipCacheFlag?: boolean;
+    blockResetDuration?: number;
+    usePastBlocks?: boolean;
+};
+export declare class PollingBlockTracker extends SafeEventEmitter implements BlockTracker {
+    #private;
+    private _isRunning;
+    private readonly _blockResetDuration;
+    private readonly _usePastBlocks;
+    private _currentBlock;
+    private _blockResetTimeout?;
+    private _pollingTimeout?;
+    private readonly _provider;
+    private readonly _pollingInterval;
+    private readonly _retryTimeout;
+    private readonly _keepEventLoopActive;
+    private readonly _setSkipCacheFlag;
+    constructor(opts?: PollingBlockTrackerOptions);
+    destroy(): Promise<void>;
+    isRunning(): boolean;
+    getCurrentBlock(): string | null;
+    getLatestBlock({ useCache, }?: {
+        useCache?: boolean;
+    }): Promise<string>;
+    removeAllListeners(eventName?: string | symbol): this;
+    private _setupInternalEvents;
+    private _onNewListener;
+    private _onRemoveListener;
+    private _maybeStart;
+    private _maybeEnd;
+    private _getBlockTrackerEventCount;
+    private _shouldUseNewBlock;
+    private _newPotentialLatest;
+    private _setCurrentBlock;
+    private _setupBlockResetTimeout;
+    private _cancelBlockResetTimeout;
+    private _resetCurrentBlock;
+    /**
+     * Checks for the latest block, updates the internal state,  and returns the
+     * value immediately rather than waiting for the next polling interval.
+     *
+     * @deprecated Use {@link getLatestBlock} instead.
+     * @returns A promise that resolves to the latest block number.
+     */
+    checkForLatestBlock(): Promise<string>;
+    private _start;
+    private _end;
+    private _updateLatestBlock;
+    private _fetchLatestBlock;
+    /**
+     * The core polling function that runs after each interval.
+     * Updates the latest block and then queues the next update.
+     */
+    private _updateAndQueue;
+    _clearPollingTimeout(): void;
+}
+//# sourceMappingURL=PollingBlockTracker.d.cts.map

package/dist/PollingBlockTracker.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PollingBlockTracker.d.cts","sourceRoot":"","sources":["../src/PollingBlockTracker.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,wCAAwC;AAChF,OAAO,gBAAgB,qCAAqC;AAS5D,OAAO,KAAK,EAAE,YAAY,EAAE,2BAAuB;AASnD,MAAM,MAAM,0BAA0B,GAAG;IACvC,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IACpC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAQF,qBAAa,mBACX,SAAQ,gBACR,YAAW,YAAY;;IAEvB,OAAO,CAAC,UAAU,CAAU;IAE5B,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAS;IAE7C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAU;IAEzC,OAAO,CAAC,aAAa,CAAgB;IAErC,OAAO,CAAC,kBAAkB,CAAC,CAAgC;IAE3D,OAAO,CAAC,eAAe,CAAC,CAAgC;IAExD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA2B;IAErD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAE1C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IAEvC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAU;IAE/C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAU;gBAQhC,IAAI,GAAE,0BAA+B;IAgC3C,OAAO;IAMb,SAAS,IAAI,OAAO;IAIpB,eAAe,IAAI,MAAM,GAAG,IAAI;IAI1B,cAAc,CAAC,EACnB,QAAe,GAChB,GAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAuDhD,kBAAkB,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM;IAgB9C,OAAO,CAAC,oBAAoB;IAS5B,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,iBAAiB;IAQzB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,SAAS;IAYjB,OAAO,CAAC,0BAA0B;IAclC,OAAO,CAAC,kBAAkB;IAc1B,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,gBAAgB;IAOxB,OAAO,CAAC,uBAAuB;IAe/B,OAAO,CAAC,wBAAwB;IAMhC,OAAO,CAAC,kBAAkB;IAI1B;;;;;;OAMG;IACG,mBAAmB;IAKzB,OAAO,CAAC,MAAM;IAMd,OAAO,CAAC,IAAI;YAIE,kBAAkB;YAelB,iBAAiB;IAsC/B;;;OAGG;YACW,eAAe;IAoC7B,oBAAoB;CAsBrB"}