@metamask-previews/eth-json-rpc-middleware 24.0.1-preview-4f4c98e → 24.0.1-preview-eb263b0ee

package/CHANGELOG.md

@@ -11,7 +11,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- **BREAKING:** Bump minimum Node.js version to 22 ([#9168](https://github.com/MetaMask/core/pull/9168))
 - Bump `@metamask/superstruct` from `^3.1.0` to `^3.4.1` ([#9754](https://github.com/MetaMask/core/pull/9754))
 
 ### Fixed

package/dist/block-cache.cjs

@@ -0,0 +1,174 @@
+"use strict";
+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);
+};
+var _BlockCacheStrategy_cache;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createBlockCacheMiddleware = void 0;
+const logging_utils_js_1 = require("./logging-utils.cjs");
+const cache_js_1 = require("./utils/cache.cjs");
+const log = (0, logging_utils_js_1.createModuleLogger)(logging_utils_js_1.projectLogger, 'block-cache');
+// `<nil>` comes from https://github.com/ethereum/go-ethereum/issues/16925
+const emptyValues = [undefined, null, '\u003cnil\u003e'];
+//
+// Cache Strategies
+//
+class BlockCacheStrategy {
+    constructor() {
+        _BlockCacheStrategy_cache.set(this, void 0);
+        __classPrivateFieldSet(this, _BlockCacheStrategy_cache, {}, "f");
+    }
+    getBlockCache(blockNumberHex) {
+        const blockNumber = Number.parseInt(blockNumberHex, 16);
+        let blockCache = __classPrivateFieldGet(this, _BlockCacheStrategy_cache, "f")[blockNumber];
+        // create new cache if necesary
+        if (!blockCache) {
+            const newCache = {};
+            __classPrivateFieldGet(this, _BlockCacheStrategy_cache, "f")[blockNumber] = newCache;
+            blockCache = newCache;
+        }
+        return blockCache;
+    }
+    async get(request, requestedBlockNumber) {
+        // lookup block cache
+        const blockCache = this.getBlockCache(requestedBlockNumber);
+        // lookup payload in block cache
+        const identifier = (0, cache_js_1.cacheIdentifierForRequest)(request, true);
+        return identifier ? blockCache[identifier] : undefined;
+    }
+    async set(request, requestedBlockNumber, result) {
+        // check if we can cached this result
+        const canCacheResult = this.canCacheResult(request, result);
+        if (!canCacheResult) {
+            return;
+        }
+        // set the value in the cache
+        const identifier = (0, cache_js_1.cacheIdentifierForRequest)(request, true);
+        if (!identifier) {
+            return;
+        }
+        const blockCache = this.getBlockCache(requestedBlockNumber);
+        blockCache[identifier] = result;
+    }
+    canCacheRequest(request) {
+        // check request method
+        if (!(0, cache_js_1.canCache)(request.method)) {
+            return false;
+        }
+        // check blockTag
+        const blockTag = (0, cache_js_1.blockTagForRequest)(request);
+        if (blockTag === 'pending') {
+            return false;
+        }
+        // can be cached
+        return true;
+    }
+    canCacheResult(request, result) {
+        // never cache empty values (e.g. undefined)
+        if (emptyValues.includes(result)) {
+            return false;
+        }
+        // check if transactions have block reference before caching
+        if (request.method &&
+            ['eth_getTransactionByHash', 'eth_getTransactionReceipt'].includes(request.method)) {
+            if (!result?.blockHash ||
+                result.blockHash ===
+                    '0x0000000000000000000000000000000000000000000000000000000000000000') {
+                return false;
+            }
+        }
+        // otherwise true
+        return true;
+    }
+    // removes all block caches with block number lower than `oldBlockHex`
+    clearBefore(oldBlockHex) {
+        const oldBlockNumber = Number.parseInt(oldBlockHex, 16);
+        // clear old caches
+        Object.keys(__classPrivateFieldGet(this, _BlockCacheStrategy_cache, "f"))
+            .map(Number)
+            .filter((value) => value < oldBlockNumber)
+            .forEach((value) => delete __classPrivateFieldGet(this, _BlockCacheStrategy_cache, "f")[value]);
+    }
+}
+_BlockCacheStrategy_cache = new WeakMap();
+/**
+ * Creates a middleware that caches block-related requests.
+ *
+ * @param options - The options for the middleware.
+ * @param options.blockTracker - The block tracker to use.
+ * @returns The block cache middleware.
+ */
+function createBlockCacheMiddleware({ blockTracker, } = {}) {
+    if (!blockTracker) {
+        throw new Error('createBlockCacheMiddleware - No PollingBlockTracker specified');
+    }
+    const blockCache = new BlockCacheStrategy();
+    const strategies = {
+        [cache_js_1.CacheStrategy.Permanent]: blockCache,
+        [cache_js_1.CacheStrategy.Block]: blockCache,
+        [cache_js_1.CacheStrategy.Fork]: blockCache,
+        [cache_js_1.CacheStrategy.Never]: undefined,
+    };
+    return async ({ request, next, context }) => {
+        if (context.get('skipCache')) {
+            return next();
+        }
+        const type = (0, cache_js_1.cacheTypeForMethod)(request.method);
+        const strategy = strategies[type];
+        if (!strategy) {
+            return next();
+        }
+        if (!strategy.canCacheRequest(request)) {
+            return next();
+        }
+        const requestBlockTag = (0, cache_js_1.blockTagForRequest)(request);
+        const blockTag = requestBlockTag && typeof requestBlockTag === 'string'
+            ? requestBlockTag
+            : 'latest';
+        log('blockTag = %o, req = %o', blockTag, request);
+        // get exact block number
+        let requestedBlockNumber;
+        if (blockTag === 'earliest') {
+            // this just exists for symmetry with "latest"
+            requestedBlockNumber = '0x00';
+        }
+        else if (blockTag === 'latest') {
+            log('Fetching latest block number to determine cache key');
+            const latestBlockNumber = await blockTracker.getLatestBlock();
+            // clear all cache before latest block
+            log('Clearing values stored under block numbers before %o', latestBlockNumber);
+            blockCache.clearBefore(latestBlockNumber);
+            requestedBlockNumber = latestBlockNumber;
+        }
+        else {
+            // we have a hex number
+            requestedBlockNumber = blockTag;
+        }
+        // end on a hit, continue on a miss
+        const cacheResult = await strategy.get(request, requestedBlockNumber);
+        if (cacheResult === undefined) {
+            // cache miss
+            // wait for other middleware to handle request
+            log('No cache stored under block number %o, carrying request forward', requestedBlockNumber);
+            const result = await next();
+            // add result to cache
+            // it's safe to cast res.result as Block, due to runtime type checks
+            // performed when strategy.set is called
+            log('Populating cache with', result);
+            await strategy.set(request, requestedBlockNumber, result);
+            return result;
+        }
+        log('Cache hit, reusing cache result stored under block number %o', requestedBlockNumber);
+        return cacheResult;
+    };
+}
+exports.createBlockCacheMiddleware = createBlockCacheMiddleware;
+//# sourceMappingURL=block-cache.cjs.map

package/dist/block-cache.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-cache.cjs","sourceRoot":"","sources":["../src/block-cache.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAOA,0DAAuE;AAOvE,gDAM0B;AAE1B,MAAM,GAAG,GAAG,IAAA,qCAAkB,EAAC,gCAAa,EAAE,aAAa,CAAC,CAAC;AAC7D,0EAA0E;AAC1E,MAAM,WAAW,GAAc,CAAC,SAAS,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;AAMpE,EAAE;AACF,mBAAmB;AACnB,EAAE;AAEF,MAAM,kBAAkB;IAGtB;QAFA,4CAAc;QAGZ,uBAAA,IAAI,6BAAU,EAAE,MAAA,CAAC;IACnB,CAAC;IAED,aAAa,CAAC,cAAsB;QAClC,MAAM,WAAW,GAAW,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QAChE,IAAI,UAAU,GAAe,uBAAA,IAAI,iCAAO,CAAC,WAAW,CAAC,CAAC;QACtD,+BAA+B;QAC/B,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,QAAQ,GAAe,EAAE,CAAC;YAChC,uBAAA,IAAI,iCAAO,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;YACpC,UAAU,GAAG,QAAQ,CAAC;QACxB,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,GAAG,CACP,OAAuB,EACvB,oBAA4B;QAE5B,qBAAqB;QACrB,MAAM,UAAU,GAAe,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;QACxE,gCAAgC;QAChC,MAAM,UAAU,GAAkB,IAAA,oCAAyB,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3E,OAAO,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,GAAG,CACP,OAAuB,EACvB,oBAA4B,EAC5B,MAAa;QAEb,qCAAqC;QACrC,MAAM,cAAc,GAAY,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACrE,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QAED,6BAA6B;QAC7B,MAAM,UAAU,GAAkB,IAAA,oCAAyB,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3E,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,MAAM,UAAU,GAAe,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;QACxE,UAAU,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC;IAClC,CAAC;IAED,eAAe,CAAC,OAAuB;QACrC,uBAAuB;QACvB,IAAI,CAAC,IAAA,mBAAQ,EAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,iBAAiB;QACjB,MAAM,QAAQ,GAAG,IAAA,6BAAkB,EAAC,OAAO,CAAC,CAAC;QAE7C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,gBAAgB;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,OAAuB,EAAE,MAAa;QACnD,4CAA4C;QAC5C,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACjC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,4DAA4D;QAC5D,IACE,OAAO,CAAC,MAAM;YACd,CAAC,0BAA0B,EAAE,2BAA2B,CAAC,CAAC,QAAQ,CAChE,OAAO,CAAC,MAAM,CACf,EACD,CAAC;YACD,IACE,CAAC,MAAM,EAAE,SAAS;gBAClB,MAAM,CAAC,SAAS;oBACd,oEAAoE,EACtE,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QACD,iBAAiB;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,sEAAsE;IACtE,WAAW,CAAC,WAAmB;QAC7B,MAAM,cAAc,GAAW,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAChE,mBAAmB;QACnB,MAAM,CAAC,IAAI,CAAC,uBAAA,IAAI,iCAAO,CAAC;aACrB,GAAG,CAAC,MAAM,CAAC;aACX,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,cAAc,CAAC;aACzC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,uBAAA,IAAI,iCAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IACnD,CAAC;CACF;;AAED;;;;;;GAMG;AACH,SAAgB,0BAA0B,CAAC,EACzC,YAAY,MACmB,EAAE;IAKjC,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GAAuB,IAAI,kBAAkB,EAAE,CAAC;IAChE,MAAM,UAAU,GAA0D;QACxE,CAAC,wBAAa,CAAC,SAAS,CAAC,EAAE,UAAU;QACrC,CAAC,wBAAa,CAAC,KAAK,CAAC,EAAE,UAAU;QACjC,CAAC,wBAAa,CAAC,IAAI,CAAC,EAAE,UAAU;QAChC,CAAC,wBAAa,CAAC,KAAK,CAAC,EAAE,SAAS;KACjC,CAAC;IAEF,OAAO,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;QAC1C,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,MAAM,IAAI,GAAG,IAAA,6BAAkB,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,MAAM,eAAe,GAAG,IAAA,6BAAkB,EAAC,OAAO,CAAC,CAAC;QACpD,MAAM,QAAQ,GACZ,eAAe,IAAI,OAAO,eAAe,KAAK,QAAQ;YACpD,CAAC,CAAC,eAAe;YACjB,CAAC,CAAC,QAAQ,CAAC;QAEf,GAAG,CAAC,yBAAyB,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAElD,yBAAyB;QACzB,IAAI,oBAA4B,CAAC;QACjC,IAAI,QAAQ,KAAK,UAAU,EAAE,CAAC;YAC5B,8CAA8C;YAC9C,oBAAoB,GAAG,MAAM,CAAC;QAChC,CAAC;aAAM,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,GAAG,CAAC,qDAAqD,CAAC,CAAC;YAC3D,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;YAE9D,sCAAsC;YACtC,GAAG,CACD,sDAAsD,EACtD,iBAAiB,CAClB,CAAC;YACF,UAAU,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;YAC1C,oBAAoB,GAAG,iBAAiB,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,uBAAuB;YACvB,oBAAoB,GAAG,QAAQ,CAAC;QAClC,CAAC;QAED,mCAAmC;QACnC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;QACtE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,aAAa;YACb,8CAA8C;YAC9C,GAAG,CACD,iEAAiE,EACjE,oBAAoB,CACrB,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;YAE5B,sBAAsB;YACtB,oEAAoE;YACpE,wCAAwC;YACxC,GAAG,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;YACrC,MAAM,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,oBAAoB,EAAE,MAAe,CAAC,CAAC;YACnE,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,GAAG,CACD,8DAA8D,EAC9D,oBAAoB,CACrB,CAAC;QACF,OAAO,WAAW,CAAC;IACrB,CAAC,CAAC;AACJ,CAAC;AAzFD,gEAyFC","sourcesContent":["import type { PollingBlockTracker } from '@metamask/eth-block-tracker';\nimport type {\n  JsonRpcMiddleware,\n  MiddlewareContext,\n} from '@metamask/json-rpc-engine/v2';\nimport type { Json, JsonRpcRequest } from '@metamask/utils';\n\nimport { projectLogger, createModuleLogger } from './logging-utils.js';\nimport type {\n  Block,\n  BlockCache,\n  // eslint-disable-next-line @typescript-eslint/no-shadow\n  Cache,\n} from './types.js';\nimport {\n  cacheIdentifierForRequest,\n  blockTagForRequest,\n  cacheTypeForMethod,\n  canCache,\n  CacheStrategy,\n} from './utils/cache.js';\n\nconst log = createModuleLogger(projectLogger, 'block-cache');\n// `<nil>` comes from https://github.com/ethereum/go-ethereum/issues/16925\nconst emptyValues: unknown[] = [undefined, null, '\\u003cnil\\u003e'];\n\ntype BlockCacheMiddlewareOptions = {\n  blockTracker?: PollingBlockTracker;\n};\n\n//\n// Cache Strategies\n//\n\nclass BlockCacheStrategy {\n  #cache: Cache;\n\n  constructor() {\n    this.#cache = {};\n  }\n\n  getBlockCache(blockNumberHex: string): BlockCache {\n    const blockNumber: number = Number.parseInt(blockNumberHex, 16);\n    let blockCache: BlockCache = this.#cache[blockNumber];\n    // create new cache if necesary\n    if (!blockCache) {\n      const newCache: BlockCache = {};\n      this.#cache[blockNumber] = newCache;\n      blockCache = newCache;\n    }\n    return blockCache;\n  }\n\n  async get(\n    request: JsonRpcRequest,\n    requestedBlockNumber: string,\n  ): Promise<Block | undefined> {\n    // lookup block cache\n    const blockCache: BlockCache = this.getBlockCache(requestedBlockNumber);\n    // lookup payload in block cache\n    const identifier: string | null = cacheIdentifierForRequest(request, true);\n    return identifier ? blockCache[identifier] : undefined;\n  }\n\n  async set(\n    request: JsonRpcRequest,\n    requestedBlockNumber: string,\n    result: Block,\n  ): Promise<void> {\n    // check if we can cached this result\n    const canCacheResult: boolean = this.canCacheResult(request, result);\n    if (!canCacheResult) {\n      return;\n    }\n\n    // set the value in the cache\n    const identifier: string | null = cacheIdentifierForRequest(request, true);\n    if (!identifier) {\n      return;\n    }\n    const blockCache: BlockCache = this.getBlockCache(requestedBlockNumber);\n    blockCache[identifier] = result;\n  }\n\n  canCacheRequest(request: JsonRpcRequest): boolean {\n    // check request method\n    if (!canCache(request.method)) {\n      return false;\n    }\n    // check blockTag\n    const blockTag = blockTagForRequest(request);\n\n    if (blockTag === 'pending') {\n      return false;\n    }\n    // can be cached\n    return true;\n  }\n\n  canCacheResult(request: JsonRpcRequest, result: Block): boolean {\n    // never cache empty values (e.g. undefined)\n    if (emptyValues.includes(result)) {\n      return false;\n    }\n\n    // check if transactions have block reference before caching\n    if (\n      request.method &&\n      ['eth_getTransactionByHash', 'eth_getTransactionReceipt'].includes(\n        request.method,\n      )\n    ) {\n      if (\n        !result?.blockHash ||\n        result.blockHash ===\n          '0x0000000000000000000000000000000000000000000000000000000000000000'\n      ) {\n        return false;\n      }\n    }\n    // otherwise true\n    return true;\n  }\n\n  // removes all block caches with block number lower than `oldBlockHex`\n  clearBefore(oldBlockHex: string): void {\n    const oldBlockNumber: number = Number.parseInt(oldBlockHex, 16);\n    // clear old caches\n    Object.keys(this.#cache)\n      .map(Number)\n      .filter((value) => value < oldBlockNumber)\n      .forEach((value) => delete this.#cache[value]);\n  }\n}\n\n/**\n * Creates a middleware that caches block-related requests.\n *\n * @param options - The options for the middleware.\n * @param options.blockTracker - The block tracker to use.\n * @returns The block cache middleware.\n */\nexport function createBlockCacheMiddleware({\n  blockTracker,\n}: BlockCacheMiddlewareOptions = {}): JsonRpcMiddleware<\n  JsonRpcRequest,\n  Json,\n  MiddlewareContext<{ skipCache?: boolean }>\n> {\n  if (!blockTracker) {\n    throw new Error(\n      'createBlockCacheMiddleware - No PollingBlockTracker specified',\n    );\n  }\n\n  const blockCache: BlockCacheStrategy = new BlockCacheStrategy();\n  const strategies: Record<CacheStrategy, BlockCacheStrategy | undefined> = {\n    [CacheStrategy.Permanent]: blockCache,\n    [CacheStrategy.Block]: blockCache,\n    [CacheStrategy.Fork]: blockCache,\n    [CacheStrategy.Never]: undefined,\n  };\n\n  return async ({ request, next, context }) => {\n    if (context.get('skipCache')) {\n      return next();\n    }\n\n    const type = cacheTypeForMethod(request.method);\n    const strategy = strategies[type];\n    if (!strategy) {\n      return next();\n    }\n\n    if (!strategy.canCacheRequest(request)) {\n      return next();\n    }\n\n    const requestBlockTag = blockTagForRequest(request);\n    const blockTag =\n      requestBlockTag && typeof requestBlockTag === 'string'\n        ? requestBlockTag\n        : 'latest';\n\n    log('blockTag = %o, req = %o', blockTag, request);\n\n    // get exact block number\n    let requestedBlockNumber: string;\n    if (blockTag === 'earliest') {\n      // this just exists for symmetry with \"latest\"\n      requestedBlockNumber = '0x00';\n    } else if (blockTag === 'latest') {\n      log('Fetching latest block number to determine cache key');\n      const latestBlockNumber = await blockTracker.getLatestBlock();\n\n      // clear all cache before latest block\n      log(\n        'Clearing values stored under block numbers before %o',\n        latestBlockNumber,\n      );\n      blockCache.clearBefore(latestBlockNumber);\n      requestedBlockNumber = latestBlockNumber;\n    } else {\n      // we have a hex number\n      requestedBlockNumber = blockTag;\n    }\n\n    // end on a hit, continue on a miss\n    const cacheResult = await strategy.get(request, requestedBlockNumber);\n    if (cacheResult === undefined) {\n      // cache miss\n      // wait for other middleware to handle request\n      log(\n        'No cache stored under block number %o, carrying request forward',\n        requestedBlockNumber,\n      );\n      const result = await next();\n\n      // add result to cache\n      // it's safe to cast res.result as Block, due to runtime type checks\n      // performed when strategy.set is called\n      log('Populating cache with', result);\n      await strategy.set(request, requestedBlockNumber, result as Block);\n      return result;\n    }\n    log(\n      'Cache hit, reusing cache result stored under block number %o',\n      requestedBlockNumber,\n    );\n    return cacheResult;\n  };\n}\n"]}

package/dist/{block-cache.d.ts → block-cache.d.cts}

@@ -1,6 +1,6 @@
-import type { PollingBlockTracker } from '@metamask/eth-block-tracker';
-import type { JsonRpcMiddleware, MiddlewareContext } from '@metamask/json-rpc-engine/v2';
-import type { Json, JsonRpcRequest } from '@metamask/utils';
+import type { PollingBlockTracker } from "@metamask/eth-block-tracker";
+import type { JsonRpcMiddleware, MiddlewareContext } from "@metamask/json-rpc-engine/v2";
+import type { Json, JsonRpcRequest } from "@metamask/utils";
 type BlockCacheMiddlewareOptions = {
     blockTracker?: PollingBlockTracker;
 };
@@ -15,4 +15,4 @@ export declare function createBlockCacheMiddleware({ blockTracker, }?: BlockCach
     skipCache?: boolean;
 }>>;
 export {};
-//# sourceMappingURL=block-cache.d.ts.map
+//# sourceMappingURL=block-cache.d.cts.map

package/dist/block-cache.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-cache.d.cts","sourceRoot":"","sources":["../src/block-cache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oCAAoC;AACvE,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EAClB,qCAAqC;AACtC,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,wBAAwB;AAqB5D,KAAK,2BAA2B,GAAG;IACjC,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC,CAAC;AA2GF;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,EACzC,YAAY,GACb,GAAE,2BAAgC,GAAG,iBAAiB,CACrD,cAAc,EACd,IAAI,EACJ,iBAAiB,CAAC;IAAE,SAAS,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAC3C,CAmFA"}

package/dist/block-cache.d.mts

@@ -0,0 +1,18 @@
+import type { PollingBlockTracker } from "@metamask/eth-block-tracker";
+import type { JsonRpcMiddleware, MiddlewareContext } from "@metamask/json-rpc-engine/v2";
+import type { Json, JsonRpcRequest } from "@metamask/utils";
+type BlockCacheMiddlewareOptions = {
+    blockTracker?: PollingBlockTracker;
+};
+/**
+ * Creates a middleware that caches block-related requests.
+ *
+ * @param options - The options for the middleware.
+ * @param options.blockTracker - The block tracker to use.
+ * @returns The block cache middleware.
+ */
+export declare function createBlockCacheMiddleware({ blockTracker, }?: BlockCacheMiddlewareOptions): JsonRpcMiddleware<JsonRpcRequest, Json, MiddlewareContext<{
+    skipCache?: boolean;
+}>>;
+export {};
+//# sourceMappingURL=block-cache.d.mts.map

package/dist/block-cache.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-cache.d.mts","sourceRoot":"","sources":["../src/block-cache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oCAAoC;AACvE,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EAClB,qCAAqC;AACtC,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,wBAAwB;AAqB5D,KAAK,2BAA2B,GAAG;IACjC,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC,CAAC;AA2GF;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,EACzC,YAAY,GACb,GAAE,2BAAgC,GAAG,iBAAiB,CACrD,cAAc,EACd,IAAI,EACJ,iBAAiB,CAAC;IAAE,SAAS,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAC3C,CAmFA"}

package/dist/{block-cache.js → block-cache.mjs}

@@ -10,8 +10,8 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _BlockCacheStrategy_cache;
-import { projectLogger, createModuleLogger } from './logging-utils.js';
-import { cacheIdentifierForRequest, blockTagForRequest, cacheTypeForMethod, canCache, CacheStrategy, } from './utils/cache.js';
+import { projectLogger, createModuleLogger } from "./logging-utils.mjs";
+import { cacheIdentifierForRequest, blockTagForRequest, cacheTypeForMethod, canCache, CacheStrategy } from "./utils/cache.mjs";
 const log = createModuleLogger(projectLogger, 'block-cache');
 // `<nil>` comes from https://github.com/ethereum/go-ethereum/issues/16925
 const emptyValues = [undefined, null, '\u003cnil\u003e'];
@@ -167,4 +167,4 @@ export function createBlockCacheMiddleware({ blockTracker, } = {}) {
         return cacheResult;
     };
 }
-//# sourceMappingURL=block-cache.js.map
+//# sourceMappingURL=block-cache.mjs.map

package/dist/block-cache.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-cache.mjs","sourceRoot":"","sources":["../src/block-cache.ts"],"names":[],"mappings":";;;;;;;;;;;;AAOA,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,4BAA2B;AAOvE,OAAO,EACL,yBAAyB,EACzB,kBAAkB,EAClB,kBAAkB,EAClB,QAAQ,EACR,aAAa,EACd,0BAAyB;AAE1B,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;AAC7D,0EAA0E;AAC1E,MAAM,WAAW,GAAc,CAAC,SAAS,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;AAMpE,EAAE;AACF,mBAAmB;AACnB,EAAE;AAEF,MAAM,kBAAkB;IAGtB;QAFA,4CAAc;QAGZ,uBAAA,IAAI,6BAAU,EAAE,MAAA,CAAC;IACnB,CAAC;IAED,aAAa,CAAC,cAAsB;QAClC,MAAM,WAAW,GAAW,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QAChE,IAAI,UAAU,GAAe,uBAAA,IAAI,iCAAO,CAAC,WAAW,CAAC,CAAC;QACtD,+BAA+B;QAC/B,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,QAAQ,GAAe,EAAE,CAAC;YAChC,uBAAA,IAAI,iCAAO,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;YACpC,UAAU,GAAG,QAAQ,CAAC;QACxB,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,GAAG,CACP,OAAuB,EACvB,oBAA4B;QAE5B,qBAAqB;QACrB,MAAM,UAAU,GAAe,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;QACxE,gCAAgC;QAChC,MAAM,UAAU,GAAkB,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3E,OAAO,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,GAAG,CACP,OAAuB,EACvB,oBAA4B,EAC5B,MAAa;QAEb,qCAAqC;QACrC,MAAM,cAAc,GAAY,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACrE,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QAED,6BAA6B;QAC7B,MAAM,UAAU,GAAkB,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3E,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,MAAM,UAAU,GAAe,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;QACxE,UAAU,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC;IAClC,CAAC;IAED,eAAe,CAAC,OAAuB;QACrC,uBAAuB;QACvB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,iBAAiB;QACjB,MAAM,QAAQ,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAE7C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,gBAAgB;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,OAAuB,EAAE,MAAa;QACnD,4CAA4C;QAC5C,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACjC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,4DAA4D;QAC5D,IACE,OAAO,CAAC,MAAM;YACd,CAAC,0BAA0B,EAAE,2BAA2B,CAAC,CAAC,QAAQ,CAChE,OAAO,CAAC,MAAM,CACf,EACD,CAAC;YACD,IACE,CAAC,MAAM,EAAE,SAAS;gBAClB,MAAM,CAAC,SAAS;oBACd,oEAAoE,EACtE,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QACD,iBAAiB;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,sEAAsE;IACtE,WAAW,CAAC,WAAmB;QAC7B,MAAM,cAAc,GAAW,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAChE,mBAAmB;QACnB,MAAM,CAAC,IAAI,CAAC,uBAAA,IAAI,iCAAO,CAAC;aACrB,GAAG,CAAC,MAAM,CAAC;aACX,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,cAAc,CAAC;aACzC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,uBAAA,IAAI,iCAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IACnD,CAAC;CACF;;AAED;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CAAC,EACzC,YAAY,MACmB,EAAE;IAKjC,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GAAuB,IAAI,kBAAkB,EAAE,CAAC;IAChE,MAAM,UAAU,GAA0D;QACxE,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,UAAU;QACrC,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,UAAU;QACjC,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,UAAU;QAChC,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,SAAS;KACjC,CAAC;IAEF,OAAO,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;QAC1C,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,MAAM,IAAI,GAAG,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,MAAM,eAAe,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACpD,MAAM,QAAQ,GACZ,eAAe,IAAI,OAAO,eAAe,KAAK,QAAQ;YACpD,CAAC,CAAC,eAAe;YACjB,CAAC,CAAC,QAAQ,CAAC;QAEf,GAAG,CAAC,yBAAyB,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAElD,yBAAyB;QACzB,IAAI,oBAA4B,CAAC;QACjC,IAAI,QAAQ,KAAK,UAAU,EAAE,CAAC;YAC5B,8CAA8C;YAC9C,oBAAoB,GAAG,MAAM,CAAC;QAChC,CAAC;aAAM,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,GAAG,CAAC,qDAAqD,CAAC,CAAC;YAC3D,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;YAE9D,sCAAsC;YACtC,GAAG,CACD,sDAAsD,EACtD,iBAAiB,CAClB,CAAC;YACF,UAAU,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;YAC1C,oBAAoB,GAAG,iBAAiB,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,uBAAuB;YACvB,oBAAoB,GAAG,QAAQ,CAAC;QAClC,CAAC;QAED,mCAAmC;QACnC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;QACtE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,aAAa;YACb,8CAA8C;YAC9C,GAAG,CACD,iEAAiE,EACjE,oBAAoB,CACrB,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;YAE5B,sBAAsB;YACtB,oEAAoE;YACpE,wCAAwC;YACxC,GAAG,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;YACrC,MAAM,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,oBAAoB,EAAE,MAAe,CAAC,CAAC;YACnE,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,GAAG,CACD,8DAA8D,EAC9D,oBAAoB,CACrB,CAAC;QACF,OAAO,WAAW,CAAC;IACrB,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import type { PollingBlockTracker } from '@metamask/eth-block-tracker';\nimport type {\n  JsonRpcMiddleware,\n  MiddlewareContext,\n} from '@metamask/json-rpc-engine/v2';\nimport type { Json, JsonRpcRequest } from '@metamask/utils';\n\nimport { projectLogger, createModuleLogger } from './logging-utils.js';\nimport type {\n  Block,\n  BlockCache,\n  // eslint-disable-next-line @typescript-eslint/no-shadow\n  Cache,\n} from './types.js';\nimport {\n  cacheIdentifierForRequest,\n  blockTagForRequest,\n  cacheTypeForMethod,\n  canCache,\n  CacheStrategy,\n} from './utils/cache.js';\n\nconst log = createModuleLogger(projectLogger, 'block-cache');\n// `<nil>` comes from https://github.com/ethereum/go-ethereum/issues/16925\nconst emptyValues: unknown[] = [undefined, null, '\\u003cnil\\u003e'];\n\ntype BlockCacheMiddlewareOptions = {\n  blockTracker?: PollingBlockTracker;\n};\n\n//\n// Cache Strategies\n//\n\nclass BlockCacheStrategy {\n  #cache: Cache;\n\n  constructor() {\n    this.#cache = {};\n  }\n\n  getBlockCache(blockNumberHex: string): BlockCache {\n    const blockNumber: number = Number.parseInt(blockNumberHex, 16);\n    let blockCache: BlockCache = this.#cache[blockNumber];\n    // create new cache if necesary\n    if (!blockCache) {\n      const newCache: BlockCache = {};\n      this.#cache[blockNumber] = newCache;\n      blockCache = newCache;\n    }\n    return blockCache;\n  }\n\n  async get(\n    request: JsonRpcRequest,\n    requestedBlockNumber: string,\n  ): Promise<Block | undefined> {\n    // lookup block cache\n    const blockCache: BlockCache = this.getBlockCache(requestedBlockNumber);\n    // lookup payload in block cache\n    const identifier: string | null = cacheIdentifierForRequest(request, true);\n    return identifier ? blockCache[identifier] : undefined;\n  }\n\n  async set(\n    request: JsonRpcRequest,\n    requestedBlockNumber: string,\n    result: Block,\n  ): Promise<void> {\n    // check if we can cached this result\n    const canCacheResult: boolean = this.canCacheResult(request, result);\n    if (!canCacheResult) {\n      return;\n    }\n\n    // set the value in the cache\n    const identifier: string | null = cacheIdentifierForRequest(request, true);\n    if (!identifier) {\n      return;\n    }\n    const blockCache: BlockCache = this.getBlockCache(requestedBlockNumber);\n    blockCache[identifier] = result;\n  }\n\n  canCacheRequest(request: JsonRpcRequest): boolean {\n    // check request method\n    if (!canCache(request.method)) {\n      return false;\n    }\n    // check blockTag\n    const blockTag = blockTagForRequest(request);\n\n    if (blockTag === 'pending') {\n      return false;\n    }\n    // can be cached\n    return true;\n  }\n\n  canCacheResult(request: JsonRpcRequest, result: Block): boolean {\n    // never cache empty values (e.g. undefined)\n    if (emptyValues.includes(result)) {\n      return false;\n    }\n\n    // check if transactions have block reference before caching\n    if (\n      request.method &&\n      ['eth_getTransactionByHash', 'eth_getTransactionReceipt'].includes(\n        request.method,\n      )\n    ) {\n      if (\n        !result?.blockHash ||\n        result.blockHash ===\n          '0x0000000000000000000000000000000000000000000000000000000000000000'\n      ) {\n        return false;\n      }\n    }\n    // otherwise true\n    return true;\n  }\n\n  // removes all block caches with block number lower than `oldBlockHex`\n  clearBefore(oldBlockHex: string): void {\n    const oldBlockNumber: number = Number.parseInt(oldBlockHex, 16);\n    // clear old caches\n    Object.keys(this.#cache)\n      .map(Number)\n      .filter((value) => value < oldBlockNumber)\n      .forEach((value) => delete this.#cache[value]);\n  }\n}\n\n/**\n * Creates a middleware that caches block-related requests.\n *\n * @param options - The options for the middleware.\n * @param options.blockTracker - The block tracker to use.\n * @returns The block cache middleware.\n */\nexport function createBlockCacheMiddleware({\n  blockTracker,\n}: BlockCacheMiddlewareOptions = {}): JsonRpcMiddleware<\n  JsonRpcRequest,\n  Json,\n  MiddlewareContext<{ skipCache?: boolean }>\n> {\n  if (!blockTracker) {\n    throw new Error(\n      'createBlockCacheMiddleware - No PollingBlockTracker specified',\n    );\n  }\n\n  const blockCache: BlockCacheStrategy = new BlockCacheStrategy();\n  const strategies: Record<CacheStrategy, BlockCacheStrategy | undefined> = {\n    [CacheStrategy.Permanent]: blockCache,\n    [CacheStrategy.Block]: blockCache,\n    [CacheStrategy.Fork]: blockCache,\n    [CacheStrategy.Never]: undefined,\n  };\n\n  return async ({ request, next, context }) => {\n    if (context.get('skipCache')) {\n      return next();\n    }\n\n    const type = cacheTypeForMethod(request.method);\n    const strategy = strategies[type];\n    if (!strategy) {\n      return next();\n    }\n\n    if (!strategy.canCacheRequest(request)) {\n      return next();\n    }\n\n    const requestBlockTag = blockTagForRequest(request);\n    const blockTag =\n      requestBlockTag && typeof requestBlockTag === 'string'\n        ? requestBlockTag\n        : 'latest';\n\n    log('blockTag = %o, req = %o', blockTag, request);\n\n    // get exact block number\n    let requestedBlockNumber: string;\n    if (blockTag === 'earliest') {\n      // this just exists for symmetry with \"latest\"\n      requestedBlockNumber = '0x00';\n    } else if (blockTag === 'latest') {\n      log('Fetching latest block number to determine cache key');\n      const latestBlockNumber = await blockTracker.getLatestBlock();\n\n      // clear all cache before latest block\n      log(\n        'Clearing values stored under block numbers before %o',\n        latestBlockNumber,\n      );\n      blockCache.clearBefore(latestBlockNumber);\n      requestedBlockNumber = latestBlockNumber;\n    } else {\n      // we have a hex number\n      requestedBlockNumber = blockTag;\n    }\n\n    // end on a hit, continue on a miss\n    const cacheResult = await strategy.get(request, requestedBlockNumber);\n    if (cacheResult === undefined) {\n      // cache miss\n      // wait for other middleware to handle request\n      log(\n        'No cache stored under block number %o, carrying request forward',\n        requestedBlockNumber,\n      );\n      const result = await next();\n\n      // add result to cache\n      // it's safe to cast res.result as Block, due to runtime type checks\n      // performed when strategy.set is called\n      log('Populating cache with', result);\n      await strategy.set(request, requestedBlockNumber, result as Block);\n      return result;\n    }\n    log(\n      'Cache hit, reusing cache result stored under block number %o',\n      requestedBlockNumber,\n    );\n    return cacheResult;\n  };\n}\n"]}

package/dist/block-ref-rewrite.cjs

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createBlockRefRewriteMiddleware = void 0;
+const cache_js_1 = require("./utils/cache.cjs");
+/**
+ * Creates a middleware that rewrites "latest" block references to the known
+ * latest block number from a block tracker.
+ *
+ * @param options - The options for the middleware.
+ * @param options.blockTracker - The block tracker to use.
+ * @returns The middleware.
+ */
+function createBlockRefRewriteMiddleware({ blockTracker, } = {}) {
+    if (!blockTracker) {
+        throw Error('BlockRefRewriteMiddleware - mandatory "blockTracker" option is missing.');
+    }
+    return async ({ request, next }) => {
+        const blockRefIndex = (0, cache_js_1.blockTagParamIndex)(request.method);
+        if (blockRefIndex === undefined) {
+            return next();
+        }
+        const blockRef = Array.isArray(request.params) && request.params[blockRefIndex]
+            ? request.params[blockRefIndex]
+            : // omitted blockRef implies "latest"
+                'latest';
+        if (blockRef !== 'latest') {
+            return next();
+        }
+        // rewrite blockRef to block-tracker's block number
+        const latestBlockNumber = await blockTracker.getLatestBlock();
+        if (Array.isArray(request.params)) {
+            const params = request.params.slice();
+            params[blockRefIndex] = latestBlockNumber;
+            return next({
+                ...request,
+                params,
+            });
+        }
+        return next();
+    };
+}
+exports.createBlockRefRewriteMiddleware = createBlockRefRewriteMiddleware;
+//# sourceMappingURL=block-ref-rewrite.cjs.map

package/dist/block-ref-rewrite.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-ref-rewrite.cjs","sourceRoot":"","sources":["../src/block-ref-rewrite.ts"],"names":[],"mappings":";;;AAIA,gDAAsD;AAMtD;;;;;;;GAOG;AACH,SAAgB,+BAA+B,CAAC,EAC9C,YAAY,MACwB,EAAE;IAItC,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,MAAM,KAAK,CACT,yEAAyE,CAC1E,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE;QACjC,MAAM,aAAa,GAAuB,IAAA,6BAAkB,EAC1D,OAAO,CAAC,MAAM,CACf,CAAC;QACF,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,MAAM,QAAQ,GACZ,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC;YAC5D,CAAC,CAAE,OAAO,CAAC,MAAM,CAAC,aAAa,CAAY;YAC3C,CAAC,CAAC,oCAAoC;gBACpC,QAAQ,CAAC;QAEf,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC1B,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,mDAAmD;QACnD,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;QAC9D,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACtC,MAAM,CAAC,aAAa,CAAC,GAAG,iBAAiB,CAAC;YAC1C,OAAO,IAAI,CAAC;gBACV,GAAG,OAAO;gBACV,MAAM;aACP,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AA1CD,0EA0CC","sourcesContent":["import type { PollingBlockTracker } from '@metamask/eth-block-tracker';\nimport type { JsonRpcMiddleware } from '@metamask/json-rpc-engine/v2';\nimport type { Json, JsonRpcRequest } from '@metamask/utils';\n\nimport { blockTagParamIndex } from './utils/cache.js';\n\ntype BlockRefRewriteMiddlewareOptions = {\n  blockTracker?: PollingBlockTracker;\n};\n\n/**\n * Creates a middleware that rewrites \"latest\" block references to the known\n * latest block number from a block tracker.\n *\n * @param options - The options for the middleware.\n * @param options.blockTracker - The block tracker to use.\n * @returns The middleware.\n */\nexport function createBlockRefRewriteMiddleware({\n  blockTracker,\n}: BlockRefRewriteMiddlewareOptions = {}): JsonRpcMiddleware<\n  JsonRpcRequest,\n  Json\n> {\n  if (!blockTracker) {\n    throw Error(\n      'BlockRefRewriteMiddleware - mandatory \"blockTracker\" option is missing.',\n    );\n  }\n\n  return async ({ request, next }) => {\n    const blockRefIndex: number | undefined = blockTagParamIndex(\n      request.method,\n    );\n    if (blockRefIndex === undefined) {\n      return next();\n    }\n\n    const blockRef: string | undefined =\n      Array.isArray(request.params) && request.params[blockRefIndex]\n        ? (request.params[blockRefIndex] as string)\n        : // omitted blockRef implies \"latest\"\n          'latest';\n\n    if (blockRef !== 'latest') {\n      return next();\n    }\n\n    // rewrite blockRef to block-tracker's block number\n    const latestBlockNumber = await blockTracker.getLatestBlock();\n    if (Array.isArray(request.params)) {\n      const params = request.params.slice();\n      params[blockRefIndex] = latestBlockNumber;\n      return next({\n        ...request,\n        params,\n      });\n    }\n    return next();\n  };\n}\n"]}

package/dist/{block-ref-rewrite.d.ts → block-ref-rewrite.d.cts}

@@ -1,6 +1,6 @@
-import type { PollingBlockTracker } from '@metamask/eth-block-tracker';
-import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine/v2';
-import type { Json, JsonRpcRequest } from '@metamask/utils';
+import type { PollingBlockTracker } from "@metamask/eth-block-tracker";
+import type { JsonRpcMiddleware } from "@metamask/json-rpc-engine/v2";
+import type { Json, JsonRpcRequest } from "@metamask/utils";
 type BlockRefRewriteMiddlewareOptions = {
     blockTracker?: PollingBlockTracker;
 };
@@ -14,4 +14,4 @@ type BlockRefRewriteMiddlewareOptions = {
  */
 export declare function createBlockRefRewriteMiddleware({ blockTracker, }?: BlockRefRewriteMiddlewareOptions): JsonRpcMiddleware<JsonRpcRequest, Json>;
 export {};
-//# sourceMappingURL=block-ref-rewrite.d.ts.map
+//# sourceMappingURL=block-ref-rewrite.d.cts.map

package/dist/block-ref-rewrite.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-ref-rewrite.d.cts","sourceRoot":"","sources":["../src/block-ref-rewrite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oCAAoC;AACvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,qCAAqC;AACtE,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,wBAAwB;AAI5D,KAAK,gCAAgC,GAAG;IACtC,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,+BAA+B,CAAC,EAC9C,YAAY,GACb,GAAE,gCAAqC,GAAG,iBAAiB,CAC1D,cAAc,EACd,IAAI,CACL,CAqCA"}

package/dist/block-ref-rewrite.d.mts

@@ -0,0 +1,17 @@
+import type { PollingBlockTracker } from "@metamask/eth-block-tracker";
+import type { JsonRpcMiddleware } from "@metamask/json-rpc-engine/v2";
+import type { Json, JsonRpcRequest } from "@metamask/utils";
+type BlockRefRewriteMiddlewareOptions = {
+    blockTracker?: PollingBlockTracker;
+};
+/**
+ * Creates a middleware that rewrites "latest" block references to the known
+ * latest block number from a block tracker.
+ *
+ * @param options - The options for the middleware.
+ * @param options.blockTracker - The block tracker to use.
+ * @returns The middleware.
+ */
+export declare function createBlockRefRewriteMiddleware({ blockTracker, }?: BlockRefRewriteMiddlewareOptions): JsonRpcMiddleware<JsonRpcRequest, Json>;
+export {};
+//# sourceMappingURL=block-ref-rewrite.d.mts.map

package/dist/block-ref-rewrite.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-ref-rewrite.d.mts","sourceRoot":"","sources":["../src/block-ref-rewrite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oCAAoC;AACvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,qCAAqC;AACtE,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,wBAAwB;AAI5D,KAAK,gCAAgC,GAAG;IACtC,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,+BAA+B,CAAC,EAC9C,YAAY,GACb,GAAE,gCAAqC,GAAG,iBAAiB,CAC1D,cAAc,EACd,IAAI,CACL,CAqCA"}

package/dist/{block-ref-rewrite.js → block-ref-rewrite.mjs}

@@ -1,4 +1,4 @@
-import { blockTagParamIndex } from './utils/cache.js';
+import { blockTagParamIndex } from "./utils/cache.mjs";
 /**
  * Creates a middleware that rewrites "latest" block references to the known
  * latest block number from a block tracker.
@@ -36,4 +36,4 @@ export function createBlockRefRewriteMiddleware({ blockTracker, } = {}) {
         return next();
     };
 }
-//# sourceMappingURL=block-ref-rewrite.js.map
+//# sourceMappingURL=block-ref-rewrite.mjs.map

package/dist/block-ref-rewrite.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-ref-rewrite.mjs","sourceRoot":"","sources":["../src/block-ref-rewrite.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,kBAAkB,EAAE,0BAAyB;AAMtD;;;;;;;GAOG;AACH,MAAM,UAAU,+BAA+B,CAAC,EAC9C,YAAY,MACwB,EAAE;IAItC,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,MAAM,KAAK,CACT,yEAAyE,CAC1E,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE;QACjC,MAAM,aAAa,GAAuB,kBAAkB,CAC1D,OAAO,CAAC,MAAM,CACf,CAAC;QACF,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,MAAM,QAAQ,GACZ,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC;YAC5D,CAAC,CAAE,OAAO,CAAC,MAAM,CAAC,aAAa,CAAY;YAC3C,CAAC,CAAC,oCAAoC;gBACpC,QAAQ,CAAC;QAEf,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC1B,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,mDAAmD;QACnD,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;QAC9D,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACtC,MAAM,CAAC,aAAa,CAAC,GAAG,iBAAiB,CAAC;YAC1C,OAAO,IAAI,CAAC;gBACV,GAAG,OAAO;gBACV,MAAM;aACP,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import type { PollingBlockTracker } from '@metamask/eth-block-tracker';\nimport type { JsonRpcMiddleware } from '@metamask/json-rpc-engine/v2';\nimport type { Json, JsonRpcRequest } from '@metamask/utils';\n\nimport { blockTagParamIndex } from './utils/cache.js';\n\ntype BlockRefRewriteMiddlewareOptions = {\n  blockTracker?: PollingBlockTracker;\n};\n\n/**\n * Creates a middleware that rewrites \"latest\" block references to the known\n * latest block number from a block tracker.\n *\n * @param options - The options for the middleware.\n * @param options.blockTracker - The block tracker to use.\n * @returns The middleware.\n */\nexport function createBlockRefRewriteMiddleware({\n  blockTracker,\n}: BlockRefRewriteMiddlewareOptions = {}): JsonRpcMiddleware<\n  JsonRpcRequest,\n  Json\n> {\n  if (!blockTracker) {\n    throw Error(\n      'BlockRefRewriteMiddleware - mandatory \"blockTracker\" option is missing.',\n    );\n  }\n\n  return async ({ request, next }) => {\n    const blockRefIndex: number | undefined = blockTagParamIndex(\n      request.method,\n    );\n    if (blockRefIndex === undefined) {\n      return next();\n    }\n\n    const blockRef: string | undefined =\n      Array.isArray(request.params) && request.params[blockRefIndex]\n        ? (request.params[blockRefIndex] as string)\n        : // omitted blockRef implies \"latest\"\n          'latest';\n\n    if (blockRef !== 'latest') {\n      return next();\n    }\n\n    // rewrite blockRef to block-tracker's block number\n    const latestBlockNumber = await blockTracker.getLatestBlock();\n    if (Array.isArray(request.params)) {\n      const params = request.params.slice();\n      params[blockRefIndex] = latestBlockNumber;\n      return next({\n        ...request,\n        params,\n      });\n    }\n    return next();\n  };\n}\n"]}

package/dist/block-ref.cjs

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createBlockRefMiddleware = void 0;
+const klona_1 = require("klona");
+const logging_utils_js_1 = require("./logging-utils.cjs");
+const cache_js_1 = require("./utils/cache.cjs");
+const log = (0, logging_utils_js_1.createModuleLogger)(logging_utils_js_1.projectLogger, 'block-ref');
+/**
+ * Creates a middleware that rewrites "latest" block references to the known
+ * latest block number from a block tracker.
+ *
+ * @param options - The options for the middleware.
+ * @param options.provider - The provider to use.
+ * @param options.blockTracker - The block tracker to use.
+ * @returns The middleware.
+ */
+function createBlockRefMiddleware({ provider, blockTracker, } = {}) {
+    if (!provider) {
+        throw Error('BlockRefMiddleware - mandatory "provider" option is missing.');
+    }
+    if (!blockTracker) {
+        throw Error('BlockRefMiddleware - mandatory "blockTracker" option is missing.');
+    }
+    return async ({ request, next }) => {
+        const blockRefIndex = (0, cache_js_1.blockTagParamIndex)(request.method);
+        // skip if method does not include blockRef
+        if (blockRefIndex === undefined) {
+            return next();
+        }
+        const blockRef = Array.isArray(request.params)
+            ? (request.params[blockRefIndex] ?? 'latest')
+            : 'latest';
+        // skip if not "latest"
+        if (blockRef !== 'latest') {
+            log('blockRef is not "latest", carrying request forward');
+            return next();
+        }
+        // lookup latest block
+        const latestBlockNumber = await blockTracker.getLatestBlock();
+        log(`blockRef is "latest", setting param ${blockRefIndex} to latest block ${latestBlockNumber}`);
+        // create child request with specific block-ref
+        const childRequest = (0, klona_1.klona)(request);
+        if (Array.isArray(childRequest.params)) {
+            childRequest.params[blockRefIndex] = latestBlockNumber;
+        }
+        // perform child request
+        log('Performing another request %o', childRequest);
+        // copy child result onto original response
+        return await provider.request(childRequest);
+    };
+}
+exports.createBlockRefMiddleware = createBlockRefMiddleware;
+//# sourceMappingURL=block-ref.cjs.map

package/dist/block-ref.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-ref.cjs","sourceRoot":"","sources":["../src/block-ref.ts"],"names":[],"mappings":";;;AAIA,iCAA8B;AAE9B,0DAAuE;AAEvE,gDAAsD;AAOtD,MAAM,GAAG,GAAG,IAAA,qCAAkB,EAAC,gCAAa,EAAE,WAAW,CAAC,CAAC;AAE3D;;;;;;;;GAQG;AACH,SAAgB,wBAAwB,CAAC,EACvC,QAAQ,EACR,YAAY,MACiB,EAAE;IAC/B,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,KAAK,CAAC,8DAA8D,CAAC,CAAC;IAC9E,CAAC;IAED,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,MAAM,KAAK,CACT,kEAAkE,CACnE,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE;QACjC,MAAM,aAAa,GAAG,IAAA,6BAAkB,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEzD,2CAA2C;QAC3C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;YAC5C,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,QAAQ,CAAC;YAC7C,CAAC,CAAC,QAAQ,CAAC;QAEb,uBAAuB;QACvB,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC1B,GAAG,CAAC,oDAAoD,CAAC,CAAC;YAC1D,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,sBAAsB;QACtB,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;QAC9D,GAAG,CACD,uCAAuC,aAAa,oBAAoB,iBAAiB,EAAE,CAC5F,CAAC;QAEF,+CAA+C;QAC/C,MAAM,YAAY,GAAG,IAAA,aAAK,EAAC,OAAO,CAAC,CAAC;QAEpC,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;YACvC,YAAY,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,iBAAiB,CAAC;QACzD,CAAC;QAED,wBAAwB;QACxB,GAAG,CAAC,+BAA+B,EAAE,YAAY,CAAC,CAAC;QACnD,2CAA2C;QAC3C,OAAO,MAAM,QAAQ,CAAC,OAAO,CAAuB,YAAY,CAAC,CAAC;IACpE,CAAC,CAAC;AACJ,CAAC;AAlDD,4DAkDC","sourcesContent":["import type { PollingBlockTracker } from '@metamask/eth-block-tracker';\nimport type { InternalProvider } from '@metamask/eth-json-rpc-provider';\nimport type { JsonRpcMiddleware } from '@metamask/json-rpc-engine/v2';\nimport type { Json, JsonRpcParams, JsonRpcRequest } from '@metamask/utils';\nimport { klona } from 'klona';\n\nimport { projectLogger, createModuleLogger } from './logging-utils.js';\nimport type { Block } from './types.js';\nimport { blockTagParamIndex } from './utils/cache.js';\n\ntype BlockRefMiddlewareOptions = {\n  blockTracker?: PollingBlockTracker;\n  provider?: InternalProvider;\n};\n\nconst log = createModuleLogger(projectLogger, 'block-ref');\n\n/**\n * Creates a middleware that rewrites \"latest\" block references to the known\n * latest block number from a block tracker.\n *\n * @param options - The options for the middleware.\n * @param options.provider - The provider to use.\n * @param options.blockTracker - The block tracker to use.\n * @returns The middleware.\n */\nexport function createBlockRefMiddleware({\n  provider,\n  blockTracker,\n}: BlockRefMiddlewareOptions = {}): JsonRpcMiddleware<JsonRpcRequest, Json> {\n  if (!provider) {\n    throw Error('BlockRefMiddleware - mandatory \"provider\" option is missing.');\n  }\n\n  if (!blockTracker) {\n    throw Error(\n      'BlockRefMiddleware - mandatory \"blockTracker\" option is missing.',\n    );\n  }\n\n  return async ({ request, next }) => {\n    const blockRefIndex = blockTagParamIndex(request.method);\n\n    // skip if method does not include blockRef\n    if (blockRefIndex === undefined) {\n      return next();\n    }\n\n    const blockRef = Array.isArray(request.params)\n      ? (request.params[blockRefIndex] ?? 'latest')\n      : 'latest';\n\n    // skip if not \"latest\"\n    if (blockRef !== 'latest') {\n      log('blockRef is not \"latest\", carrying request forward');\n      return next();\n    }\n\n    // lookup latest block\n    const latestBlockNumber = await blockTracker.getLatestBlock();\n    log(\n      `blockRef is \"latest\", setting param ${blockRefIndex} to latest block ${latestBlockNumber}`,\n    );\n\n    // create child request with specific block-ref\n    const childRequest = klona(request);\n\n    if (Array.isArray(childRequest.params)) {\n      childRequest.params[blockRefIndex] = latestBlockNumber;\n    }\n\n    // perform child request\n    log('Performing another request %o', childRequest);\n    // copy child result onto original response\n    return await provider.request<JsonRpcParams, Block>(childRequest);\n  };\n}\n"]}

package/dist/{block-ref.d.ts → block-ref.d.cts}

@@ -1,7 +1,7 @@
-import type { PollingBlockTracker } from '@metamask/eth-block-tracker';
-import type { InternalProvider } from '@metamask/eth-json-rpc-provider';
-import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine/v2';
-import type { Json, JsonRpcRequest } from '@metamask/utils';
+import type { PollingBlockTracker } from "@metamask/eth-block-tracker";
+import type { InternalProvider } from "@metamask/eth-json-rpc-provider";
+import type { JsonRpcMiddleware } from "@metamask/json-rpc-engine/v2";
+import type { Json, JsonRpcRequest } from "@metamask/utils";
 type BlockRefMiddlewareOptions = {
     blockTracker?: PollingBlockTracker;
     provider?: InternalProvider;
@@ -17,4 +17,4 @@ type BlockRefMiddlewareOptions = {
  */
 export declare function createBlockRefMiddleware({ provider, blockTracker, }?: BlockRefMiddlewareOptions): JsonRpcMiddleware<JsonRpcRequest, Json>;
 export {};
-//# sourceMappingURL=block-ref.d.ts.map
+//# sourceMappingURL=block-ref.d.cts.map

package/dist/block-ref.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-ref.d.cts","sourceRoot":"","sources":["../src/block-ref.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oCAAoC;AACvE,OAAO,KAAK,EAAE,gBAAgB,EAAE,wCAAwC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,qCAAqC;AACtE,OAAO,KAAK,EAAE,IAAI,EAAiB,cAAc,EAAE,wBAAwB;AAO3E,KAAK,yBAAyB,GAAG;IAC/B,YAAY,CAAC,EAAE,mBAAmB,CAAC;IACnC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B,CAAC;AAIF;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CAAC,EACvC,QAAQ,EACR,YAAY,GACb,GAAE,yBAA8B,GAAG,iBAAiB,CAAC,cAAc,EAAE,IAAI,CAAC,CA+C1E"}

package/dist/block-ref.d.mts

@@ -0,0 +1,20 @@
+import type { PollingBlockTracker } from "@metamask/eth-block-tracker";
+import type { InternalProvider } from "@metamask/eth-json-rpc-provider";
+import type { JsonRpcMiddleware } from "@metamask/json-rpc-engine/v2";
+import type { Json, JsonRpcRequest } from "@metamask/utils";
+type BlockRefMiddlewareOptions = {
+    blockTracker?: PollingBlockTracker;
+    provider?: InternalProvider;
+};
+/**
+ * Creates a middleware that rewrites "latest" block references to the known
+ * latest block number from a block tracker.
+ *
+ * @param options - The options for the middleware.
+ * @param options.provider - The provider to use.
+ * @param options.blockTracker - The block tracker to use.
+ * @returns The middleware.
+ */
+export declare function createBlockRefMiddleware({ provider, blockTracker, }?: BlockRefMiddlewareOptions): JsonRpcMiddleware<JsonRpcRequest, Json>;
+export {};
+//# sourceMappingURL=block-ref.d.mts.map

package/dist/block-ref.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-ref.d.mts","sourceRoot":"","sources":["../src/block-ref.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oCAAoC;AACvE,OAAO,KAAK,EAAE,gBAAgB,EAAE,wCAAwC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,qCAAqC;AACtE,OAAO,KAAK,EAAE,IAAI,EAAiB,cAAc,EAAE,wBAAwB;AAO3E,KAAK,yBAAyB,GAAG;IAC/B,YAAY,CAAC,EAAE,mBAAmB,CAAC;IACnC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B,CAAC;AAIF;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CAAC,EACvC,QAAQ,EACR,YAAY,GACb,GAAE,yBAA8B,GAAG,iBAAiB,CAAC,cAAc,EAAE,IAAI,CAAC,CA+C1E"}

package/dist/{block-ref.js → block-ref.mjs}

@@ -1,6 +1,6 @@
-import { klona } from 'klona';
-import { projectLogger, createModuleLogger } from './logging-utils.js';
-import { blockTagParamIndex } from './utils/cache.js';
+import { klona } from "klona";
+import { projectLogger, createModuleLogger } from "./logging-utils.mjs";
+import { blockTagParamIndex } from "./utils/cache.mjs";
 const log = createModuleLogger(projectLogger, 'block-ref');
 /**
  * Creates a middleware that rewrites "latest" block references to the known
@@ -46,4 +46,4 @@ export function createBlockRefMiddleware({ provider, blockTracker, } = {}) {
         return await provider.request(childRequest);
     };
 }
-//# sourceMappingURL=block-ref.js.map
+//# sourceMappingURL=block-ref.mjs.map

package/dist/block-ref.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"block-ref.mjs","sourceRoot":"","sources":["../src/block-ref.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,EAAE,cAAc;AAE9B,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,4BAA2B;AAEvE,OAAO,EAAE,kBAAkB,EAAE,0BAAyB;AAOtD,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;AAE3D;;;;;;;;GAQG;AACH,MAAM,UAAU,wBAAwB,CAAC,EACvC,QAAQ,EACR,YAAY,MACiB,EAAE;IAC/B,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,KAAK,CAAC,8DAA8D,CAAC,CAAC;IAC9E,CAAC;IAED,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,MAAM,KAAK,CACT,kEAAkE,CACnE,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE;QACjC,MAAM,aAAa,GAAG,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEzD,2CAA2C;QAC3C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;YAC5C,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,QAAQ,CAAC;YAC7C,CAAC,CAAC,QAAQ,CAAC;QAEb,uBAAuB;QACvB,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC1B,GAAG,CAAC,oDAAoD,CAAC,CAAC;YAC1D,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,sBAAsB;QACtB,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;QAC9D,GAAG,CACD,uCAAuC,aAAa,oBAAoB,iBAAiB,EAAE,CAC5F,CAAC;QAEF,+CAA+C;QAC/C,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QAEpC,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;YACvC,YAAY,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,iBAAiB,CAAC;QACzD,CAAC;QAED,wBAAwB;QACxB,GAAG,CAAC,+BAA+B,EAAE,YAAY,CAAC,CAAC;QACnD,2CAA2C;QAC3C,OAAO,MAAM,QAAQ,CAAC,OAAO,CAAuB,YAAY,CAAC,CAAC;IACpE,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import type { PollingBlockTracker } from '@metamask/eth-block-tracker';\nimport type { InternalProvider } from '@metamask/eth-json-rpc-provider';\nimport type { JsonRpcMiddleware } from '@metamask/json-rpc-engine/v2';\nimport type { Json, JsonRpcParams, JsonRpcRequest } from '@metamask/utils';\nimport { klona } from 'klona';\n\nimport { projectLogger, createModuleLogger } from './logging-utils.js';\nimport type { Block } from './types.js';\nimport { blockTagParamIndex } from './utils/cache.js';\n\ntype BlockRefMiddlewareOptions = {\n  blockTracker?: PollingBlockTracker;\n  provider?: InternalProvider;\n};\n\nconst log = createModuleLogger(projectLogger, 'block-ref');\n\n/**\n * Creates a middleware that rewrites \"latest\" block references to the known\n * latest block number from a block tracker.\n *\n * @param options - The options for the middleware.\n * @param options.provider - The provider to use.\n * @param options.blockTracker - The block tracker to use.\n * @returns The middleware.\n */\nexport function createBlockRefMiddleware({\n  provider,\n  blockTracker,\n}: BlockRefMiddlewareOptions = {}): JsonRpcMiddleware<JsonRpcRequest, Json> {\n  if (!provider) {\n    throw Error('BlockRefMiddleware - mandatory \"provider\" option is missing.');\n  }\n\n  if (!blockTracker) {\n    throw Error(\n      'BlockRefMiddleware - mandatory \"blockTracker\" option is missing.',\n    );\n  }\n\n  return async ({ request, next }) => {\n    const blockRefIndex = blockTagParamIndex(request.method);\n\n    // skip if method does not include blockRef\n    if (blockRefIndex === undefined) {\n      return next();\n    }\n\n    const blockRef = Array.isArray(request.params)\n      ? (request.params[blockRefIndex] ?? 'latest')\n      : 'latest';\n\n    // skip if not \"latest\"\n    if (blockRef !== 'latest') {\n      log('blockRef is not \"latest\", carrying request forward');\n      return next();\n    }\n\n    // lookup latest block\n    const latestBlockNumber = await blockTracker.getLatestBlock();\n    log(\n      `blockRef is \"latest\", setting param ${blockRefIndex} to latest block ${latestBlockNumber}`,\n    );\n\n    // create child request with specific block-ref\n    const childRequest = klona(request);\n\n    if (Array.isArray(childRequest.params)) {\n      childRequest.params[blockRefIndex] = latestBlockNumber;\n    }\n\n    // perform child request\n    log('Performing another request %o', childRequest);\n    // copy child result onto original response\n    return await provider.request<JsonRpcParams, Block>(childRequest);\n  };\n}\n"]}

package/dist/block-tracker-inspector.cjs

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createBlockTrackerInspectorMiddleware = void 0;
+const utils_1 = require("@metamask/utils");
+const logging_utils_js_1 = require("./logging-utils.cjs");
+const log = (0, logging_utils_js_1.createModuleLogger)(logging_utils_js_1.projectLogger, 'block-tracker-inspector');
+const futureBlockRefRequests = [
+    'eth_getTransactionByHash',
+    'eth_getTransactionReceipt',
+];
+/**
+ * Creates a middleware that checks whether response block references are higher than the current block.
+ * If the block reference is higher, the middleware will make the block tracker check for a new block.
+ *
+ * @param options - The options for the middleware.
+ * @param options.blockTracker - The block tracker to use.
+ * @returns The middleware.
+ */
+function createBlockTrackerInspectorMiddleware({ blockTracker, }) {
+    return async ({ request, next }) => {
+        if (!futureBlockRefRequests.includes(request.method)) {
+            return next();
+        }
+        const result = await next();
+        const responseBlockNumber = getResultBlockNumber(result);
+        if (responseBlockNumber) {
+            log('res.result.blockNumber exists, proceeding. res = %o', result);
+            // If number is higher, suggest block-tracker check for a new block
+            const blockNumber = Number.parseInt(responseBlockNumber, 16);
+            const currentBlockNumber = Number.parseInt(
+            // Typecast: If getCurrentBlock returns null, currentBlockNumber will be NaN, which is fine.
+            blockTracker.getCurrentBlock(), 16);
+            if (blockNumber > currentBlockNumber) {
+                log('blockNumber from response is greater than current block number, refreshing current block number');
+                await blockTracker.checkForLatestBlock();
+            }
+        }
+        return result;
+    };
+}
+exports.createBlockTrackerInspectorMiddleware = createBlockTrackerInspectorMiddleware;
+/**
+ * Extracts the block number from the result.
+ *
+ * @param result - The result to extract the block number from.
+ * @returns The block number, or undefined if the result is not an object with a
+ * `blockNumber` property.
+ */
+function getResultBlockNumber(result) {
+    if (!result ||
+        typeof result !== 'object' ||
+        !(0, utils_1.hasProperty)(result, 'blockNumber')) {
+        return undefined;
+    }
+    return typeof result.blockNumber === 'string'
+        ? result.blockNumber
+        : undefined;
+}
+//# sourceMappingURL=block-tracker-inspector.cjs.map