@metamask-previews/eth-json-rpc-middleware 21.0.0-preview-c96ff8f → 21.0.0-preview-6b15e01

package/CHANGELOG.md

@@ -9,9 +9,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- **BREAKING:** Migrate to `JsonRpcEngineV2` ([#7065](https://github.com/MetaMask/core/pull/7065))
-  - Migrates all middleware from `JsonRpcEngine` to `JsonRpcEngineV2`.
-  - To continue using this package with the legacy `JsonRpcEngine`, use the `asLegacyMiddleware` backwards compatibility function.
 - **BREAKING:** Use `InternalProvider` instead of `SafeEventEmitterProvider` ([#6796](https://github.com/MetaMask/core/pull/6796))
   - Wherever a `SafeEventEmitterProvider` was expected, an `InternalProvider` is now expected instead.
 - **BREAKING:** Stop retrying `undefined` results for methods that include a block tag parameter ([#7001](https://github.com/MetaMask/core/pull/7001))

package/dist/block-cache.cjs

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createBlockCacheMiddleware = void 0;
+const json_rpc_engine_1 = require("@metamask/json-rpc-engine");
 const logging_utils_1 = require("./logging-utils.cjs");
 const cache_1 = require("./utils/cache.cjs");
 const log = (0, logging_utils_1.createModuleLogger)(logging_utils_1.projectLogger, 'block-cache');
@@ -86,9 +87,11 @@ class BlockCacheStrategy {
     }
 }
 function createBlockCacheMiddleware({ blockTracker, } = {}) {
+    // validate options
     if (!blockTracker) {
         throw new Error('createBlockCacheMiddleware - No PollingBlockTracker specified');
     }
+    // create caching strategies
     const blockCache = new BlockCacheStrategy();
     const strategies = {
         [cache_1.CacheStrategy.Permanent]: blockCache,
@@ -96,23 +99,28 @@ function createBlockCacheMiddleware({ blockTracker, } = {}) {
         [cache_1.CacheStrategy.Fork]: blockCache,
         [cache_1.CacheStrategy.Never]: undefined,
     };
-    return async ({ request, next, context }) => {
-        if (context.get('skipCache')) {
+    return (0, json_rpc_engine_1.createAsyncMiddleware)(async (req, res, next) => {
+        // allow cach to be skipped if so specified
+        if (req.skipCache) {
             return next();
         }
-        const type = (0, cache_1.cacheTypeForMethod)(request.method);
+        // check type and matching strategy
+        const type = (0, cache_1.cacheTypeForMethod)(req.method);
         const strategy = strategies[type];
+        // If there's no strategy in place, pass it down the chain.
         if (!strategy) {
             return next();
         }
-        if (!strategy.canCacheRequest(request)) {
+        // If the strategy can't cache this request, ignore it.
+        if (!strategy.canCacheRequest(req)) {
             return next();
         }
-        const requestBlockTag = (0, cache_1.blockTagForRequest)(request);
+        // get block reference (number or keyword)
+        const requestBlockTag = (0, cache_1.blockTagForRequest)(req);
         const blockTag = requestBlockTag && typeof requestBlockTag === 'string'
             ? requestBlockTag
             : 'latest';
-        log('blockTag = %o, req = %o', blockTag, request);
+        log('blockTag = %o, req = %o', blockTag, req);
         // get exact block number
         let requestedBlockNumber;
         if (blockTag === 'earliest') {
@@ -120,6 +128,7 @@ function createBlockCacheMiddleware({ blockTracker, } = {}) {
             requestedBlockNumber = '0x00';
         }
         else if (blockTag === 'latest') {
+            // fetch latest block number
             log('Fetching latest block number to determine cache key');
             const latestBlockNumber = await blockTracker.getLatestBlock();
             // clear all cache before latest block
@@ -128,26 +137,29 @@ function createBlockCacheMiddleware({ blockTracker, } = {}) {
             requestedBlockNumber = latestBlockNumber;
         }
         else {
-            // we have a hex number
+            // We have a hex number
             requestedBlockNumber = blockTag;
         }
         // end on a hit, continue on a miss
-        const cacheResult = await strategy.get(request, requestedBlockNumber);
+        const cacheResult = await strategy.get(req, 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();
+            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('Populating cache with', res);
+            await strategy.set(req, requestedBlockNumber, res.result);
         }
-        log('Cache hit, reusing cache result stored under block number %o', requestedBlockNumber);
-        return cacheResult;
-    };
+        else {
+            // fill in result from cache
+            log('Cache hit, reusing cache result stored under block number %o', requestedBlockNumber);
+            res.result = cacheResult;
+        }
+        return undefined;
+    });
 }
 exports.createBlockCacheMiddleware = createBlockCacheMiddleware;
 //# sourceMappingURL=block-cache.cjs.map

package/dist/block-cache.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"block-cache.cjs","sourceRoot":"","sources":["../src/block-cache.ts"],"names":[],"mappings":";;;AAOA,uDAAoE;AAOpE,6CAMuB;AAEvB,MAAM,GAAG,GAAG,IAAA,kCAAkB,EAAC,6BAAa,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;QACE,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;IAClB,CAAC;IAED,aAAa,CAAC,cAAsB;QAClC,MAAM,WAAW,GAAW,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QAChE,IAAI,UAAU,GAAe,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACrD,+BAA+B;QAC/B,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,QAAQ,GAAe,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;YACnC,UAAU,GAAG,QAAQ,CAAC;SACvB;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,iCAAyB,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;YACnB,OAAO;SACR;QAED,6BAA6B;QAC7B,MAAM,UAAU,GAAkB,IAAA,iCAAyB,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3E,IAAI,CAAC,UAAU,EAAE;YACf,OAAO;SACR;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,gBAAQ,EAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YAC7B,OAAO,KAAK,CAAC;SACd;QACD,iBAAiB;QACjB,MAAM,QAAQ,GAAG,IAAA,0BAAkB,EAAC,OAAO,CAAC,CAAC;QAE7C,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,OAAO,KAAK,CAAC;SACd;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;YAChC,OAAO,KAAK,CAAC;SACd;QAED,4DAA4D;QAC5D,IACE,OAAO,CAAC,MAAM;YACd,CAAC,0BAA0B,EAAE,2BAA2B,CAAC,CAAC,QAAQ,CAChE,OAAO,CAAC,MAAM,CACf,EACD;YACA,IACE,CAAC,MAAM,EAAE,SAAS;gBAClB,MAAM,CAAC,SAAS;oBACd,oEAAoE,EACtE;gBACA,OAAO,KAAK,CAAC;aACd;SACF;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,IAAI,CAAC,KAAK,CAAC;aACpB,GAAG,CAAC,MAAM,CAAC;aACX,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,cAAc,CAAC;aACrC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9C,CAAC;CACF;AAED,SAAgB,0BAA0B,CAAC,EACzC,YAAY,MACmB,EAAE;IAKjC,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;KACH;IAED,MAAM,UAAU,GAAuB,IAAI,kBAAkB,EAAE,CAAC;IAChE,MAAM,UAAU,GAA0D;QACxE,CAAC,qBAAa,CAAC,SAAS,CAAC,EAAE,UAAU;QACrC,CAAC,qBAAa,CAAC,KAAK,CAAC,EAAE,UAAU;QACjC,CAAC,qBAAa,CAAC,IAAI,CAAC,EAAE,UAAU;QAChC,CAAC,qBAAa,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;YAC5B,OAAO,IAAI,EAAE,CAAC;SACf;QAED,MAAM,IAAI,GAAG,IAAA,0BAAkB,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,IAAI,EAAE,CAAC;SACf;QAED,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE;YACtC,OAAO,IAAI,EAAE,CAAC;SACf;QAED,MAAM,eAAe,GAAG,IAAA,0BAAkB,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;YAC3B,8CAA8C;YAC9C,oBAAoB,GAAG,MAAM,CAAC;SAC/B;aAAM,IAAI,QAAQ,KAAK,QAAQ,EAAE;YAChC,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;SAC1C;aAAM;YACL,uBAAuB;YACvB,oBAAoB,GAAG,QAAQ,CAAC;SACjC;QAED,mCAAmC;QACnC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;QACtE,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,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;SACf;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';\nimport type {\n  Block,\n  BlockCache,\n  // eslint-disable-next-line @typescript-eslint/no-shadow\n  Cache,\n} from './types';\nimport {\n  cacheIdentifierForRequest,\n  blockTagForRequest,\n  cacheTypeForMethod,\n  canCache,\n  CacheStrategy,\n} from './utils/cache';\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  private 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((num) => num < oldBlockNumber)\n      .forEach((num) => delete this.cache[num]);\n  }\n}\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"]}
+{"version":3,"file":"block-cache.cjs","sourceRoot":"","sources":["../src/block-cache.ts"],"names":[],"mappings":";;;AACA,+DAAkE;AAGlE,uDAAoE;AASpE,6CAMuB;AAEvB,MAAM,GAAG,GAAG,IAAA,kCAAkB,EAAC,6BAAa,EAAE,aAAa,CAAC,CAAC;AAC7D,0EAA0E;AAC1E,MAAM,WAAW,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;AAMzD,EAAE;AACF,mBAAmB;AACnB,EAAE;AAEF,MAAM,kBAAkB;IAGtB;QACE,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;IAClB,CAAC;IAED,aAAa,CAAC,cAAsB;QAClC,MAAM,WAAW,GAAW,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QAChE,IAAI,UAAU,GAAe,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACrD,+BAA+B;QAC/B,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,QAAQ,GAAe,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;YACnC,UAAU,GAAG,QAAQ,CAAC;SACvB;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,iCAAyB,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;YACnB,OAAO;SACR;QAED,6BAA6B;QAC7B,MAAM,UAAU,GAAkB,IAAA,iCAAyB,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3E,IAAI,CAAC,UAAU,EAAE;YACf,OAAO;SACR;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,gBAAQ,EAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YAC7B,OAAO,KAAK,CAAC;SACd;QACD,iBAAiB;QACjB,MAAM,QAAQ,GAAG,IAAA,0BAAkB,EAAC,OAAO,CAAC,CAAC;QAE7C,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,OAAO,KAAK,CAAC;SACd;QACD,gBAAgB;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,OAAuB,EAAE,MAAa;QACnD,4CAA4C;QAC5C,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAa,CAAC,EAAE;YACvC,OAAO,KAAK,CAAC;SACd;QAED,4DAA4D;QAC5D,IACE,OAAO,CAAC,MAAM;YACd,CAAC,0BAA0B,EAAE,2BAA2B,CAAC,CAAC,QAAQ,CAChE,OAAO,CAAC,MAAM,CACf,EACD;YACA,IACE,CAAC,MAAM,EAAE,SAAS;gBAClB,MAAM,CAAC,SAAS;oBACd,oEAAoE,EACtE;gBACA,OAAO,KAAK,CAAC;aACd;SACF;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,IAAI,CAAC,KAAK,CAAC;aACpB,GAAG,CAAC,MAAM,CAAC;aACX,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,cAAc,CAAC;aACrC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9C,CAAC;CACF;AAED,SAAgB,0BAA0B,CAAC,EACzC,YAAY,MACmB,EAAE;IAIjC,mBAAmB;IACnB,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;KACH;IAED,4BAA4B;IAC5B,MAAM,UAAU,GAAuB,IAAI,kBAAkB,EAAE,CAAC;IAChE,MAAM,UAAU,GAA0D;QACxE,CAAC,qBAAa,CAAC,SAAS,CAAC,EAAE,UAAU;QACrC,CAAC,qBAAa,CAAC,KAAK,CAAC,EAAE,UAAU;QACjC,CAAC,qBAAa,CAAC,IAAI,CAAC,EAAE,UAAU;QAChC,CAAC,qBAAa,CAAC,KAAK,CAAC,EAAE,SAAS;KACjC,CAAC;IAEF,OAAO,IAAA,uCAAqB,EAC1B,KAAK,EAAE,GAAyC,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC7D,2CAA2C;QAC3C,IAAI,GAAG,CAAC,SAAS,EAAE;YACjB,OAAO,IAAI,EAAE,CAAC;SACf;QACD,mCAAmC;QACnC,MAAM,IAAI,GAAG,IAAA,0BAAkB,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QAClC,2DAA2D;QAC3D,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,IAAI,EAAE,CAAC;SACf;QAED,uDAAuD;QACvD,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE;YAClC,OAAO,IAAI,EAAE,CAAC;SACf;QAED,0CAA0C;QAC1C,MAAM,eAAe,GAAG,IAAA,0BAAkB,EAAC,GAAG,CAAC,CAAC;QAChD,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,GAAG,CAAC,CAAC;QAE9C,yBAAyB;QACzB,IAAI,oBAA4B,CAAC;QACjC,IAAI,QAAQ,KAAK,UAAU,EAAE;YAC3B,8CAA8C;YAC9C,oBAAoB,GAAG,MAAM,CAAC;SAC/B;aAAM,IAAI,QAAQ,KAAK,QAAQ,EAAE;YAChC,4BAA4B;YAC5B,GAAG,CAAC,qDAAqD,CAAC,CAAC;YAC3D,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;YAC9D,sCAAsC;YACtC,GAAG,CACD,sDAAsD,EACtD,iBAAiB,CAClB,CAAC;YACF,UAAU,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;YAC1C,oBAAoB,GAAG,iBAAiB,CAAC;SAC1C;aAAM;YACL,uBAAuB;YACvB,oBAAoB,GAAG,QAAQ,CAAC;SACjC;QACD,mCAAmC;QACnC,MAAM,WAAW,GAAsB,MAAM,QAAQ,CAAC,GAAG,CACvD,GAAG,EACH,oBAAoB,CACrB,CAAC;QACF,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,aAAa;YACb,8CAA8C;YAC9C,GAAG,CACD,iEAAiE,EACjE,oBAAoB,CACrB,CAAC;YACF,MAAM,IAAI,EAAE,CAAC;YAEb,sBAAsB;YACtB,oEAAoE;YACpE,wCAAwC;YACxC,GAAG,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;YAClC,MAAM,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,oBAAoB,EAAE,GAAG,CAAC,MAAe,CAAC,CAAC;SACpE;aAAM;YACL,4BAA4B;YAC5B,GAAG,CACD,8DAA8D,EAC9D,oBAAoB,CACrB,CAAC;YACF,GAAG,CAAC,MAAM,GAAG,WAAW,CAAC;SAC1B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CACF,CAAC;AACJ,CAAC;AApGD,gEAoGC","sourcesContent":["import type { PollingBlockTracker } from '@metamask/eth-block-tracker';\nimport { createAsyncMiddleware } from '@metamask/json-rpc-engine';\nimport type { Json, JsonRpcParams, JsonRpcRequest } from '@metamask/utils';\n\nimport { projectLogger, createModuleLogger } from './logging-utils';\nimport type {\n  Block,\n  BlockCache,\n  // eslint-disable-next-line @typescript-eslint/no-shadow\n  Cache,\n  JsonRpcCacheMiddleware,\n  JsonRpcRequestToCache,\n} from './types';\nimport {\n  cacheIdentifierForRequest,\n  blockTagForRequest,\n  cacheTypeForMethod,\n  canCache,\n  CacheStrategy,\n} from './utils/cache';\n\nconst log = createModuleLogger(projectLogger, 'block-cache');\n// `<nil>` comes from https://github.com/ethereum/go-ethereum/issues/16925\nconst emptyValues = [undefined, null, '\\u003cnil\\u003e'];\n\ntype BlockCacheMiddlewareOptions = {\n  blockTracker?: PollingBlockTracker;\n};\n\n//\n// Cache Strategies\n//\n\nclass BlockCacheStrategy {\n  private 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 as any)) {\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((num) => num < oldBlockNumber)\n      .forEach((num) => delete this.cache[num]);\n  }\n}\n\nexport function createBlockCacheMiddleware({\n  blockTracker,\n}: BlockCacheMiddlewareOptions = {}): JsonRpcCacheMiddleware<\n  JsonRpcParams,\n  Json\n> {\n  // validate options\n  if (!blockTracker) {\n    throw new Error(\n      'createBlockCacheMiddleware - No PollingBlockTracker specified',\n    );\n  }\n\n  // create caching strategies\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 createAsyncMiddleware(\n    async (req: JsonRpcRequestToCache<JsonRpcParams>, res, next) => {\n      // allow cach to be skipped if so specified\n      if (req.skipCache) {\n        return next();\n      }\n      // check type and matching strategy\n      const type = cacheTypeForMethod(req.method);\n      const strategy = strategies[type];\n      // If there's no strategy in place, pass it down the chain.\n      if (!strategy) {\n        return next();\n      }\n\n      // If the strategy can't cache this request, ignore it.\n      if (!strategy.canCacheRequest(req)) {\n        return next();\n      }\n\n      // get block reference (number or keyword)\n      const requestBlockTag = blockTagForRequest(req);\n      const blockTag =\n        requestBlockTag && typeof requestBlockTag === 'string'\n          ? requestBlockTag\n          : 'latest';\n\n      log('blockTag = %o, req = %o', blockTag, req);\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        // fetch latest block number\n        log('Fetching latest block number to determine cache key');\n        const latestBlockNumber = await blockTracker.getLatestBlock();\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      // end on a hit, continue on a miss\n      const cacheResult: Block | undefined = await strategy.get(\n        req,\n        requestedBlockNumber,\n      );\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        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', res);\n        await strategy.set(req, requestedBlockNumber, res.result as Block);\n      } else {\n        // fill in result from cache\n        log(\n          'Cache hit, reusing cache result stored under block number %o',\n          requestedBlockNumber,\n        );\n        res.result = cacheResult;\n      }\n      return undefined;\n    },\n  );\n}\n"]}

package/dist/block-cache.d.cts

@@ -1,11 +1,9 @@
 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 { Json, JsonRpcParams } from "@metamask/utils";
+import type { JsonRpcCacheMiddleware } from "./types.cjs";
 type BlockCacheMiddlewareOptions = {
     blockTracker?: PollingBlockTracker;
 };
-export declare function createBlockCacheMiddleware({ blockTracker, }?: BlockCacheMiddlewareOptions): JsonRpcMiddleware<JsonRpcRequest, Json, MiddlewareContext<{
-    skipCache?: boolean;
-}>>;
+export declare function createBlockCacheMiddleware({ blockTracker, }?: BlockCacheMiddlewareOptions): JsonRpcCacheMiddleware<JsonRpcParams, Json>;
 export {};
 //# sourceMappingURL=block-cache.d.cts.map

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

@@ -1 +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,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"}
+{"version":3,"file":"block-cache.d.cts","sourceRoot":"","sources":["../src/block-cache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oCAAoC;AAEvE,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAkB,wBAAwB;AAG3E,OAAO,KAAK,EAKV,sBAAsB,EAEvB,oBAAgB;AAajB,KAAK,2BAA2B,GAAG;IACjC,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC,CAAC;AA2GF,wBAAgB,0BAA0B,CAAC,EACzC,YAAY,GACb,GAAE,2BAAgC,GAAG,sBAAsB,CAC1D,aAAa,EACb,IAAI,CACL,CA+FA"}

package/dist/block-cache.d.mts

@@ -1,11 +1,9 @@
 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 { Json, JsonRpcParams } from "@metamask/utils";
+import type { JsonRpcCacheMiddleware } from "./types.mjs";
 type BlockCacheMiddlewareOptions = {
     blockTracker?: PollingBlockTracker;
 };
-export declare function createBlockCacheMiddleware({ blockTracker, }?: BlockCacheMiddlewareOptions): JsonRpcMiddleware<JsonRpcRequest, Json, MiddlewareContext<{
-    skipCache?: boolean;
-}>>;
+export declare function createBlockCacheMiddleware({ blockTracker, }?: BlockCacheMiddlewareOptions): JsonRpcCacheMiddleware<JsonRpcParams, Json>;
 export {};
 //# sourceMappingURL=block-cache.d.mts.map

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

@@ -1 +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,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"}
+{"version":3,"file":"block-cache.d.mts","sourceRoot":"","sources":["../src/block-cache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oCAAoC;AAEvE,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAkB,wBAAwB;AAG3E,OAAO,KAAK,EAKV,sBAAsB,EAEvB,oBAAgB;AAajB,KAAK,2BAA2B,GAAG;IACjC,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC,CAAC;AA2GF,wBAAgB,0BAA0B,CAAC,EACzC,YAAY,GACb,GAAE,2BAAgC,GAAG,sBAAsB,CAC1D,aAAa,EACb,IAAI,CACL,CA+FA"}

package/dist/block-cache.mjs

@@ -1,3 +1,4 @@
+import { createAsyncMiddleware } from "@metamask/json-rpc-engine";
 import { projectLogger, createModuleLogger } from "./logging-utils.mjs";
 import { cacheIdentifierForRequest, blockTagForRequest, cacheTypeForMethod, canCache, CacheStrategy } from "./utils/cache.mjs";
 const log = createModuleLogger(projectLogger, 'block-cache');
@@ -83,9 +84,11 @@ class BlockCacheStrategy {
     }
 }
 export function createBlockCacheMiddleware({ blockTracker, } = {}) {
+    // validate options
     if (!blockTracker) {
         throw new Error('createBlockCacheMiddleware - No PollingBlockTracker specified');
     }
+    // create caching strategies
     const blockCache = new BlockCacheStrategy();
     const strategies = {
         [CacheStrategy.Permanent]: blockCache,
@@ -93,23 +96,28 @@ export function createBlockCacheMiddleware({ blockTracker, } = {}) {
         [CacheStrategy.Fork]: blockCache,
         [CacheStrategy.Never]: undefined,
     };
-    return async ({ request, next, context }) => {
-        if (context.get('skipCache')) {
+    return createAsyncMiddleware(async (req, res, next) => {
+        // allow cach to be skipped if so specified
+        if (req.skipCache) {
             return next();
         }
-        const type = cacheTypeForMethod(request.method);
+        // check type and matching strategy
+        const type = cacheTypeForMethod(req.method);
         const strategy = strategies[type];
+        // If there's no strategy in place, pass it down the chain.
         if (!strategy) {
             return next();
         }
-        if (!strategy.canCacheRequest(request)) {
+        // If the strategy can't cache this request, ignore it.
+        if (!strategy.canCacheRequest(req)) {
             return next();
         }
-        const requestBlockTag = blockTagForRequest(request);
+        // get block reference (number or keyword)
+        const requestBlockTag = blockTagForRequest(req);
         const blockTag = requestBlockTag && typeof requestBlockTag === 'string'
             ? requestBlockTag
             : 'latest';
-        log('blockTag = %o, req = %o', blockTag, request);
+        log('blockTag = %o, req = %o', blockTag, req);
         // get exact block number
         let requestedBlockNumber;
         if (blockTag === 'earliest') {
@@ -117,6 +125,7 @@ export function createBlockCacheMiddleware({ blockTracker, } = {}) {
             requestedBlockNumber = '0x00';
         }
         else if (blockTag === 'latest') {
+            // fetch latest block number
             log('Fetching latest block number to determine cache key');
             const latestBlockNumber = await blockTracker.getLatestBlock();
             // clear all cache before latest block
@@ -125,25 +134,28 @@ export function createBlockCacheMiddleware({ blockTracker, } = {}) {
             requestedBlockNumber = latestBlockNumber;
         }
         else {
-            // we have a hex number
+            // We have a hex number
             requestedBlockNumber = blockTag;
         }
         // end on a hit, continue on a miss
-        const cacheResult = await strategy.get(request, requestedBlockNumber);
+        const cacheResult = await strategy.get(req, 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();
+            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('Populating cache with', res);
+            await strategy.set(req, requestedBlockNumber, res.result);
         }
-        log('Cache hit, reusing cache result stored under block number %o', requestedBlockNumber);
-        return cacheResult;
-    };
+        else {
+            // fill in result from cache
+            log('Cache hit, reusing cache result stored under block number %o', requestedBlockNumber);
+            res.result = cacheResult;
+        }
+        return undefined;
+    });
 }
 //# sourceMappingURL=block-cache.mjs.map

package/dist/block-cache.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"block-cache.mjs","sourceRoot":"","sources":["../src/block-cache.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,4BAAwB;AAOpE,OAAO,EACL,yBAAyB,EACzB,kBAAkB,EAClB,kBAAkB,EAClB,QAAQ,EACR,aAAa,EACd,0BAAsB;AAEvB,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;QACE,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;IAClB,CAAC;IAED,aAAa,CAAC,cAAsB;QAClC,MAAM,WAAW,GAAW,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QAChE,IAAI,UAAU,GAAe,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACrD,+BAA+B;QAC/B,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,QAAQ,GAAe,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;YACnC,UAAU,GAAG,QAAQ,CAAC;SACvB;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;YACnB,OAAO;SACR;QAED,6BAA6B;QAC7B,MAAM,UAAU,GAAkB,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3E,IAAI,CAAC,UAAU,EAAE;YACf,OAAO;SACR;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;YAC7B,OAAO,KAAK,CAAC;SACd;QACD,iBAAiB;QACjB,MAAM,QAAQ,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAE7C,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,OAAO,KAAK,CAAC;SACd;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;YAChC,OAAO,KAAK,CAAC;SACd;QAED,4DAA4D;QAC5D,IACE,OAAO,CAAC,MAAM;YACd,CAAC,0BAA0B,EAAE,2BAA2B,CAAC,CAAC,QAAQ,CAChE,OAAO,CAAC,MAAM,CACf,EACD;YACA,IACE,CAAC,MAAM,EAAE,SAAS;gBAClB,MAAM,CAAC,SAAS;oBACd,oEAAoE,EACtE;gBACA,OAAO,KAAK,CAAC;aACd;SACF;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,IAAI,CAAC,KAAK,CAAC;aACpB,GAAG,CAAC,MAAM,CAAC;aACX,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,cAAc,CAAC;aACrC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9C,CAAC;CACF;AAED,MAAM,UAAU,0BAA0B,CAAC,EACzC,YAAY,MACmB,EAAE;IAKjC,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;KACH;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;YAC5B,OAAO,IAAI,EAAE,CAAC;SACf;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;YACb,OAAO,IAAI,EAAE,CAAC;SACf;QAED,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE;YACtC,OAAO,IAAI,EAAE,CAAC;SACf;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;YAC3B,8CAA8C;YAC9C,oBAAoB,GAAG,MAAM,CAAC;SAC/B;aAAM,IAAI,QAAQ,KAAK,QAAQ,EAAE;YAChC,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;SAC1C;aAAM;YACL,uBAAuB;YACvB,oBAAoB,GAAG,QAAQ,CAAC;SACjC;QAED,mCAAmC;QACnC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;QACtE,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,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;SACf;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';\nimport type {\n  Block,\n  BlockCache,\n  // eslint-disable-next-line @typescript-eslint/no-shadow\n  Cache,\n} from './types';\nimport {\n  cacheIdentifierForRequest,\n  blockTagForRequest,\n  cacheTypeForMethod,\n  canCache,\n  CacheStrategy,\n} from './utils/cache';\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  private 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((num) => num < oldBlockNumber)\n      .forEach((num) => delete this.cache[num]);\n  }\n}\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"]}
+{"version":3,"file":"block-cache.mjs","sourceRoot":"","sources":["../src/block-cache.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAE,kCAAkC;AAGlE,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,4BAAwB;AASpE,OAAO,EACL,yBAAyB,EACzB,kBAAkB,EAClB,kBAAkB,EAClB,QAAQ,EACR,aAAa,EACd,0BAAsB;AAEvB,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;AAC7D,0EAA0E;AAC1E,MAAM,WAAW,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;AAMzD,EAAE;AACF,mBAAmB;AACnB,EAAE;AAEF,MAAM,kBAAkB;IAGtB;QACE,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;IAClB,CAAC;IAED,aAAa,CAAC,cAAsB;QAClC,MAAM,WAAW,GAAW,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QAChE,IAAI,UAAU,GAAe,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACrD,+BAA+B;QAC/B,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,QAAQ,GAAe,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;YACnC,UAAU,GAAG,QAAQ,CAAC;SACvB;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;YACnB,OAAO;SACR;QAED,6BAA6B;QAC7B,MAAM,UAAU,GAAkB,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3E,IAAI,CAAC,UAAU,EAAE;YACf,OAAO;SACR;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;YAC7B,OAAO,KAAK,CAAC;SACd;QACD,iBAAiB;QACjB,MAAM,QAAQ,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAE7C,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,OAAO,KAAK,CAAC;SACd;QACD,gBAAgB;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,OAAuB,EAAE,MAAa;QACnD,4CAA4C;QAC5C,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAa,CAAC,EAAE;YACvC,OAAO,KAAK,CAAC;SACd;QAED,4DAA4D;QAC5D,IACE,OAAO,CAAC,MAAM;YACd,CAAC,0BAA0B,EAAE,2BAA2B,CAAC,CAAC,QAAQ,CAChE,OAAO,CAAC,MAAM,CACf,EACD;YACA,IACE,CAAC,MAAM,EAAE,SAAS;gBAClB,MAAM,CAAC,SAAS;oBACd,oEAAoE,EACtE;gBACA,OAAO,KAAK,CAAC;aACd;SACF;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,IAAI,CAAC,KAAK,CAAC;aACpB,GAAG,CAAC,MAAM,CAAC;aACX,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,cAAc,CAAC;aACrC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9C,CAAC;CACF;AAED,MAAM,UAAU,0BAA0B,CAAC,EACzC,YAAY,MACmB,EAAE;IAIjC,mBAAmB;IACnB,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;KACH;IAED,4BAA4B;IAC5B,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,qBAAqB,CAC1B,KAAK,EAAE,GAAyC,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC7D,2CAA2C;QAC3C,IAAI,GAAG,CAAC,SAAS,EAAE;YACjB,OAAO,IAAI,EAAE,CAAC;SACf;QACD,mCAAmC;QACnC,MAAM,IAAI,GAAG,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QAClC,2DAA2D;QAC3D,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,IAAI,EAAE,CAAC;SACf;QAED,uDAAuD;QACvD,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE;YAClC,OAAO,IAAI,EAAE,CAAC;SACf;QAED,0CAA0C;QAC1C,MAAM,eAAe,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;QAChD,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,GAAG,CAAC,CAAC;QAE9C,yBAAyB;QACzB,IAAI,oBAA4B,CAAC;QACjC,IAAI,QAAQ,KAAK,UAAU,EAAE;YAC3B,8CAA8C;YAC9C,oBAAoB,GAAG,MAAM,CAAC;SAC/B;aAAM,IAAI,QAAQ,KAAK,QAAQ,EAAE;YAChC,4BAA4B;YAC5B,GAAG,CAAC,qDAAqD,CAAC,CAAC;YAC3D,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;YAC9D,sCAAsC;YACtC,GAAG,CACD,sDAAsD,EACtD,iBAAiB,CAClB,CAAC;YACF,UAAU,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;YAC1C,oBAAoB,GAAG,iBAAiB,CAAC;SAC1C;aAAM;YACL,uBAAuB;YACvB,oBAAoB,GAAG,QAAQ,CAAC;SACjC;QACD,mCAAmC;QACnC,MAAM,WAAW,GAAsB,MAAM,QAAQ,CAAC,GAAG,CACvD,GAAG,EACH,oBAAoB,CACrB,CAAC;QACF,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,aAAa;YACb,8CAA8C;YAC9C,GAAG,CACD,iEAAiE,EACjE,oBAAoB,CACrB,CAAC;YACF,MAAM,IAAI,EAAE,CAAC;YAEb,sBAAsB;YACtB,oEAAoE;YACpE,wCAAwC;YACxC,GAAG,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;YAClC,MAAM,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,oBAAoB,EAAE,GAAG,CAAC,MAAe,CAAC,CAAC;SACpE;aAAM;YACL,4BAA4B;YAC5B,GAAG,CACD,8DAA8D,EAC9D,oBAAoB,CACrB,CAAC;YACF,GAAG,CAAC,MAAM,GAAG,WAAW,CAAC;SAC1B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CACF,CAAC;AACJ,CAAC","sourcesContent":["import type { PollingBlockTracker } from '@metamask/eth-block-tracker';\nimport { createAsyncMiddleware } from '@metamask/json-rpc-engine';\nimport type { Json, JsonRpcParams, JsonRpcRequest } from '@metamask/utils';\n\nimport { projectLogger, createModuleLogger } from './logging-utils';\nimport type {\n  Block,\n  BlockCache,\n  // eslint-disable-next-line @typescript-eslint/no-shadow\n  Cache,\n  JsonRpcCacheMiddleware,\n  JsonRpcRequestToCache,\n} from './types';\nimport {\n  cacheIdentifierForRequest,\n  blockTagForRequest,\n  cacheTypeForMethod,\n  canCache,\n  CacheStrategy,\n} from './utils/cache';\n\nconst log = createModuleLogger(projectLogger, 'block-cache');\n// `<nil>` comes from https://github.com/ethereum/go-ethereum/issues/16925\nconst emptyValues = [undefined, null, '\\u003cnil\\u003e'];\n\ntype BlockCacheMiddlewareOptions = {\n  blockTracker?: PollingBlockTracker;\n};\n\n//\n// Cache Strategies\n//\n\nclass BlockCacheStrategy {\n  private 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 as any)) {\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((num) => num < oldBlockNumber)\n      .forEach((num) => delete this.cache[num]);\n  }\n}\n\nexport function createBlockCacheMiddleware({\n  blockTracker,\n}: BlockCacheMiddlewareOptions = {}): JsonRpcCacheMiddleware<\n  JsonRpcParams,\n  Json\n> {\n  // validate options\n  if (!blockTracker) {\n    throw new Error(\n      'createBlockCacheMiddleware - No PollingBlockTracker specified',\n    );\n  }\n\n  // create caching strategies\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 createAsyncMiddleware(\n    async (req: JsonRpcRequestToCache<JsonRpcParams>, res, next) => {\n      // allow cach to be skipped if so specified\n      if (req.skipCache) {\n        return next();\n      }\n      // check type and matching strategy\n      const type = cacheTypeForMethod(req.method);\n      const strategy = strategies[type];\n      // If there's no strategy in place, pass it down the chain.\n      if (!strategy) {\n        return next();\n      }\n\n      // If the strategy can't cache this request, ignore it.\n      if (!strategy.canCacheRequest(req)) {\n        return next();\n      }\n\n      // get block reference (number or keyword)\n      const requestBlockTag = blockTagForRequest(req);\n      const blockTag =\n        requestBlockTag && typeof requestBlockTag === 'string'\n          ? requestBlockTag\n          : 'latest';\n\n      log('blockTag = %o, req = %o', blockTag, req);\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        // fetch latest block number\n        log('Fetching latest block number to determine cache key');\n        const latestBlockNumber = await blockTracker.getLatestBlock();\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      // end on a hit, continue on a miss\n      const cacheResult: Block | undefined = await strategy.get(\n        req,\n        requestedBlockNumber,\n      );\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        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', res);\n        await strategy.set(req, requestedBlockNumber, res.result as Block);\n      } else {\n        // fill in result from cache\n        log(\n          'Cache hit, reusing cache result stored under block number %o',\n          requestedBlockNumber,\n        );\n        res.result = cacheResult;\n      }\n      return undefined;\n    },\n  );\n}\n"]}

package/dist/block-ref-rewrite.cjs

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createBlockRefRewriteMiddleware = void 0;
+const json_rpc_engine_1 = require("@metamask/json-rpc-engine");
 const cache_1 = require("./utils/cache.cjs");
 /**
  * Creates a middleware that rewrites "latest" block references to the known
@@ -14,13 +15,13 @@ function createBlockRefRewriteMiddleware({ blockTracker, } = {}) {
     if (!blockTracker) {
         throw Error('BlockRefRewriteMiddleware - mandatory "blockTracker" option is missing.');
     }
-    return async ({ request, next }) => {
-        const blockRefIndex = (0, cache_1.blockTagParamIndex)(request.method);
+    return (0, json_rpc_engine_1.createAsyncMiddleware)(async (req, _res, next) => {
+        const blockRefIndex = (0, cache_1.blockTagParamIndex)(req.method);
         if (blockRefIndex === undefined) {
             return next();
         }
-        const blockRef = Array.isArray(request.params) && request.params[blockRefIndex]
-            ? request.params[blockRefIndex]
+        const blockRef = Array.isArray(req.params) && req.params[blockRefIndex]
+            ? req.params[blockRefIndex]
             : // omitted blockRef implies "latest"
                 'latest';
         if (blockRef !== 'latest') {
@@ -28,16 +29,11 @@ function createBlockRefRewriteMiddleware({ blockTracker, } = {}) {
         }
         // 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,
-            });
+        if (Array.isArray(req.params)) {
+            req.params[blockRefIndex] = latestBlockNumber;
         }
         return next();
-    };
+    });
 }
 exports.createBlockRefRewriteMiddleware = createBlockRefRewriteMiddleware;
 //# sourceMappingURL=block-ref-rewrite.cjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"block-ref-rewrite.cjs","sourceRoot":"","sources":["../src/block-ref-rewrite.ts"],"names":[],"mappings":";;;AAIA,6CAAmD;AAMnD;;;;;;;GAOG;AACH,SAAgB,+BAA+B,CAAC,EAC9C,YAAY,MACwB,EAAE;IAItC,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,KAAK,CACT,yEAAyE,CAC1E,CAAC;KACH;IAED,OAAO,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE;QACjC,MAAM,aAAa,GAAuB,IAAA,0BAAkB,EAC1D,OAAO,CAAC,MAAM,CACf,CAAC;QACF,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,OAAO,IAAI,EAAE,CAAC;SACf;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;YACzB,OAAO,IAAI,EAAE,CAAC;SACf;QAED,mDAAmD;QACnD,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;QAC9D,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACjC,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;SACJ;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';\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"]}
+{"version":3,"file":"block-ref-rewrite.cjs","sourceRoot":"","sources":["../src/block-ref-rewrite.ts"],"names":[],"mappings":";;;AAEA,+DAAkE;AAGlE,6CAAmD;AAMnD;;;;;;;GAOG;AACH,SAAgB,+BAA+B,CAAC,EAC9C,YAAY,MACwB,EAAE;IAItC,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,KAAK,CACT,yEAAyE,CAC1E,CAAC;KACH;IAED,OAAO,IAAA,uCAAqB,EAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;QACrD,MAAM,aAAa,GAAuB,IAAA,0BAAkB,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACzE,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,OAAO,IAAI,EAAE,CAAC;SACf;QAED,MAAM,QAAQ,GACZ,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC;YACpD,CAAC,CAAE,GAAG,CAAC,MAAM,CAAC,aAAa,CAAY;YACvC,CAAC,CAAC,oCAAoC;gBACpC,QAAQ,CAAC;QAEf,IAAI,QAAQ,KAAK,QAAQ,EAAE;YACzB,OAAO,IAAI,EAAE,CAAC;SACf;QAED,mDAAmD;QACnD,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;QAC9D,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC7B,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,iBAAiB,CAAC;SAC/C;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC;AAnCD,0EAmCC","sourcesContent":["import type { PollingBlockTracker } from '@metamask/eth-block-tracker';\nimport type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport { createAsyncMiddleware } from '@metamask/json-rpc-engine';\nimport type { Json, JsonRpcParams } from '@metamask/utils';\n\nimport { blockTagParamIndex } from './utils/cache';\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  JsonRpcParams,\n  Json\n> {\n  if (!blockTracker) {\n    throw Error(\n      'BlockRefRewriteMiddleware - mandatory \"blockTracker\" option is missing.',\n    );\n  }\n\n  return createAsyncMiddleware(async (req, _res, next) => {\n    const blockRefIndex: number | undefined = blockTagParamIndex(req.method);\n    if (blockRefIndex === undefined) {\n      return next();\n    }\n\n    const blockRef: string | undefined =\n      Array.isArray(req.params) && req.params[blockRefIndex]\n        ? (req.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(req.params)) {\n      req.params[blockRefIndex] = latestBlockNumber;\n    }\n    return next();\n  });\n}\n"]}

package/dist/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 { JsonRpcMiddleware } from "@metamask/json-rpc-engine";
+import type { Json, JsonRpcParams } from "@metamask/utils";
 type BlockRefRewriteMiddlewareOptions = {
     blockTracker?: PollingBlockTracker;
 };
@@ -12,6 +12,6 @@ type BlockRefRewriteMiddlewareOptions = {
  * @param options.blockTracker - The block tracker to use.
  * @returns The middleware.
  */
-export declare function createBlockRefRewriteMiddleware({ blockTracker, }?: BlockRefRewriteMiddlewareOptions): JsonRpcMiddleware<JsonRpcRequest, Json>;
+export declare function createBlockRefRewriteMiddleware({ blockTracker, }?: BlockRefRewriteMiddlewareOptions): JsonRpcMiddleware<JsonRpcParams, Json>;
 export {};
 //# sourceMappingURL=block-ref-rewrite.d.cts.map

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

@@ -1 +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"}
+{"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,kCAAkC;AAEnE,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAI3D,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,aAAa,EACb,IAAI,CACL,CA8BA"}

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

@@ -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 { JsonRpcMiddleware } from "@metamask/json-rpc-engine";
+import type { Json, JsonRpcParams } from "@metamask/utils";
 type BlockRefRewriteMiddlewareOptions = {
     blockTracker?: PollingBlockTracker;
 };
@@ -12,6 +12,6 @@ type BlockRefRewriteMiddlewareOptions = {
  * @param options.blockTracker - The block tracker to use.
  * @returns The middleware.
  */
-export declare function createBlockRefRewriteMiddleware({ blockTracker, }?: BlockRefRewriteMiddlewareOptions): JsonRpcMiddleware<JsonRpcRequest, Json>;
+export declare function createBlockRefRewriteMiddleware({ blockTracker, }?: BlockRefRewriteMiddlewareOptions): JsonRpcMiddleware<JsonRpcParams, Json>;
 export {};
 //# sourceMappingURL=block-ref-rewrite.d.mts.map

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

@@ -1 +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"}
+{"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,kCAAkC;AAEnE,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAI3D,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,aAAa,EACb,IAAI,CACL,CA8BA"}

package/dist/block-ref-rewrite.mjs

@@ -1,3 +1,4 @@
+import { createAsyncMiddleware } from "@metamask/json-rpc-engine";
 import { blockTagParamIndex } from "./utils/cache.mjs";
 /**
  * Creates a middleware that rewrites "latest" block references to the known
@@ -11,13 +12,13 @@ export function createBlockRefRewriteMiddleware({ blockTracker, } = {}) {
     if (!blockTracker) {
         throw Error('BlockRefRewriteMiddleware - mandatory "blockTracker" option is missing.');
     }
-    return async ({ request, next }) => {
-        const blockRefIndex = blockTagParamIndex(request.method);
+    return createAsyncMiddleware(async (req, _res, next) => {
+        const blockRefIndex = blockTagParamIndex(req.method);
         if (blockRefIndex === undefined) {
             return next();
         }
-        const blockRef = Array.isArray(request.params) && request.params[blockRefIndex]
-            ? request.params[blockRefIndex]
+        const blockRef = Array.isArray(req.params) && req.params[blockRefIndex]
+            ? req.params[blockRefIndex]
             : // omitted blockRef implies "latest"
                 'latest';
         if (blockRef !== 'latest') {
@@ -25,15 +26,10 @@ export function createBlockRefRewriteMiddleware({ blockTracker, } = {}) {
         }
         // 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,
-            });
+        if (Array.isArray(req.params)) {
+            req.params[blockRefIndex] = latestBlockNumber;
         }
         return next();
-    };
+    });
 }
 //# sourceMappingURL=block-ref-rewrite.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"block-ref-rewrite.mjs","sourceRoot":"","sources":["../src/block-ref-rewrite.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,kBAAkB,EAAE,0BAAsB;AAMnD;;;;;;;GAOG;AACH,MAAM,UAAU,+BAA+B,CAAC,EAC9C,YAAY,MACwB,EAAE;IAItC,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,KAAK,CACT,yEAAyE,CAC1E,CAAC;KACH;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;YAC/B,OAAO,IAAI,EAAE,CAAC;SACf;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;YACzB,OAAO,IAAI,EAAE,CAAC;SACf;QAED,mDAAmD;QACnD,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;QAC9D,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACjC,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;SACJ;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';\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"]}
+{"version":3,"file":"block-ref-rewrite.mjs","sourceRoot":"","sources":["../src/block-ref-rewrite.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,kCAAkC;AAGlE,OAAO,EAAE,kBAAkB,EAAE,0BAAsB;AAMnD;;;;;;;GAOG;AACH,MAAM,UAAU,+BAA+B,CAAC,EAC9C,YAAY,MACwB,EAAE;IAItC,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,KAAK,CACT,yEAAyE,CAC1E,CAAC;KACH;IAED,OAAO,qBAAqB,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;QACrD,MAAM,aAAa,GAAuB,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACzE,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,OAAO,IAAI,EAAE,CAAC;SACf;QAED,MAAM,QAAQ,GACZ,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC;YACpD,CAAC,CAAE,GAAG,CAAC,MAAM,CAAC,aAAa,CAAY;YACvC,CAAC,CAAC,oCAAoC;gBACpC,QAAQ,CAAC;QAEf,IAAI,QAAQ,KAAK,QAAQ,EAAE;YACzB,OAAO,IAAI,EAAE,CAAC;SACf;QAED,mDAAmD;QACnD,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;QAC9D,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC7B,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,iBAAiB,CAAC;SAC/C;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type { PollingBlockTracker } from '@metamask/eth-block-tracker';\nimport type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport { createAsyncMiddleware } from '@metamask/json-rpc-engine';\nimport type { Json, JsonRpcParams } from '@metamask/utils';\n\nimport { blockTagParamIndex } from './utils/cache';\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  JsonRpcParams,\n  Json\n> {\n  if (!blockTracker) {\n    throw Error(\n      'BlockRefRewriteMiddleware - mandatory \"blockTracker\" option is missing.',\n    );\n  }\n\n  return createAsyncMiddleware(async (req, _res, next) => {\n    const blockRefIndex: number | undefined = blockTagParamIndex(req.method);\n    if (blockRefIndex === undefined) {\n      return next();\n    }\n\n    const blockRef: string | undefined =\n      Array.isArray(req.params) && req.params[blockRefIndex]\n        ? (req.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(req.params)) {\n      req.params[blockRefIndex] = latestBlockNumber;\n    }\n    return next();\n  });\n}\n"]}

package/dist/block-ref.cjs

@@ -1,19 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createBlockRefMiddleware = void 0;
-const klona_1 = require("klona");
+const json_rpc_engine_1 = require("@metamask/json-rpc-engine");
+const full_1 = require("klona/full");
 const logging_utils_1 = require("./logging-utils.cjs");
 const cache_1 = require("./utils/cache.cjs");
 const log = (0, logging_utils_1.createModuleLogger)(logging_utils_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.');
@@ -21,14 +13,14 @@ function createBlockRefMiddleware({ provider, blockTracker, } = {}) {
     if (!blockTracker) {
         throw Error('BlockRefMiddleware - mandatory "blockTracker" option is missing.');
     }
-    return async ({ request, next }) => {
-        const blockRefIndex = (0, cache_1.blockTagParamIndex)(request.method);
+    return (0, json_rpc_engine_1.createAsyncMiddleware)(async (req, res, next) => {
+        const blockRefIndex = (0, cache_1.blockTagParamIndex)(req.method);
         // skip if method does not include blockRef
         if (blockRefIndex === undefined) {
             return next();
         }
-        const blockRef = Array.isArray(request.params)
-            ? (request.params[blockRefIndex] ?? 'latest')
+        const blockRef = Array.isArray(req.params)
+            ? (req.params[blockRefIndex] ?? 'latest')
             : 'latest';
         // skip if not "latest"
         if (blockRef !== 'latest') {
@@ -39,15 +31,16 @@ function createBlockRefMiddleware({ provider, blockTracker, } = {}) {
         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);
+        const childRequest = (0, full_1.klona)(req);
         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);
-    };
+        res.result = await provider.request(childRequest);
+        return undefined;
+    });
 }
 exports.createBlockRefMiddleware = createBlockRefMiddleware;
 //# sourceMappingURL=block-ref.cjs.map