@metamask-previews/eth-json-rpc-middleware 21.0.0-preview-468843ab

package/dist/providerAsMiddleware.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"providerAsMiddleware.cjs","sourceRoot":"","sources":["../src/providerAsMiddleware.ts"],"names":[],"mappings":";;;AACA,+DAGmC;AAGnC,SAAgB,oBAAoB,CAClC,QAAkC;IAElC,OAAO,IAAA,uCAAqB,EAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAC9C,GAAG,CAAC,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC;AAND,oDAMC","sourcesContent":["import type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';\nimport {\n  createAsyncMiddleware,\n  type JsonRpcMiddleware,\n} from '@metamask/json-rpc-engine';\nimport type { Json, JsonRpcParams } from '@metamask/utils';\n\nexport function providerAsMiddleware(\n  provider: SafeEventEmitterProvider,\n): JsonRpcMiddleware<JsonRpcParams, Json> {\n  return createAsyncMiddleware(async (req, res) => {\n    res.result = await provider.request(req);\n  });\n}\n"]}

package/dist/providerAsMiddleware.d.cts

@@ -0,0 +1,5 @@
+import type { SafeEventEmitterProvider } from "@metamask/eth-json-rpc-provider";
+import { type JsonRpcMiddleware } from "@metamask/json-rpc-engine";
+import type { Json, JsonRpcParams } from "@metamask/utils";
+export declare function providerAsMiddleware(provider: SafeEventEmitterProvider): JsonRpcMiddleware<JsonRpcParams, Json>;
+//# sourceMappingURL=providerAsMiddleware.d.cts.map

package/dist/providerAsMiddleware.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"providerAsMiddleware.d.cts","sourceRoot":"","sources":["../src/providerAsMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,wCAAwC;AAChF,OAAO,EAEL,KAAK,iBAAiB,EACvB,kCAAkC;AACnC,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAE3D,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,wBAAwB,GACjC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAIxC"}

package/dist/providerAsMiddleware.d.mts

@@ -0,0 +1,5 @@
+import type { SafeEventEmitterProvider } from "@metamask/eth-json-rpc-provider";
+import { type JsonRpcMiddleware } from "@metamask/json-rpc-engine";
+import type { Json, JsonRpcParams } from "@metamask/utils";
+export declare function providerAsMiddleware(provider: SafeEventEmitterProvider): JsonRpcMiddleware<JsonRpcParams, Json>;
+//# sourceMappingURL=providerAsMiddleware.d.mts.map

package/dist/providerAsMiddleware.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"providerAsMiddleware.d.mts","sourceRoot":"","sources":["../src/providerAsMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,wCAAwC;AAChF,OAAO,EAEL,KAAK,iBAAiB,EACvB,kCAAkC;AACnC,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAE3D,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,wBAAwB,GACjC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAIxC"}

package/dist/providerAsMiddleware.mjs

@@ -0,0 +1,7 @@
+import { createAsyncMiddleware } from "@metamask/json-rpc-engine";
+export function providerAsMiddleware(provider) {
+    return createAsyncMiddleware(async (req, res) => {
+        res.result = await provider.request(req);
+    });
+}
+//# sourceMappingURL=providerAsMiddleware.mjs.map

package/dist/providerAsMiddleware.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"providerAsMiddleware.mjs","sourceRoot":"","sources":["../src/providerAsMiddleware.ts"],"names":[],"mappings":"AACA,OAAO,EACL,qBAAqB,EAEtB,kCAAkC;AAGnC,MAAM,UAAU,oBAAoB,CAClC,QAAkC;IAElC,OAAO,qBAAqB,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAC9C,GAAG,CAAC,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';\nimport {\n  createAsyncMiddleware,\n  type JsonRpcMiddleware,\n} from '@metamask/json-rpc-engine';\nimport type { Json, JsonRpcParams } from '@metamask/utils';\n\nexport function providerAsMiddleware(\n  provider: SafeEventEmitterProvider,\n): JsonRpcMiddleware<JsonRpcParams, Json> {\n  return createAsyncMiddleware(async (req, res) => {\n    res.result = await provider.request(req);\n  });\n}\n"]}

package/dist/retryOnEmpty.cjs

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRetryOnEmptyMiddleware = void 0;
+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 error_1 = require("./utils/error.cjs");
+const timeout_1 = require("./utils/timeout.cjs");
+//
+// RetryOnEmptyMiddleware will retry any request with an empty response that has
+// a numbered block reference at or lower than the blockTracker's latest block.
+// Its useful for dealing with load-balanced ethereum JSON RPC
+// nodes that are not always in sync with each other.
+//
+const log = (0, logging_utils_1.createModuleLogger)(logging_utils_1.projectLogger, 'retry-on-empty');
+// empty values used to determine if a request should be retried
+// `<nil>` comes from https://github.com/ethereum/go-ethereum/issues/16925
+const emptyValues = [
+    undefined,
+    null,
+    '\u003cnil\u003e',
+];
+function createRetryOnEmptyMiddleware({ provider, blockTracker, } = {}) {
+    if (!provider) {
+        throw Error('RetryOnEmptyMiddleware - mandatory "provider" option is missing.');
+    }
+    if (!blockTracker) {
+        throw Error('RetryOnEmptyMiddleware - mandatory "blockTracker" option is missing.');
+    }
+    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();
+        }
+        // skip if not exact block references
+        let blockRef = Array.isArray(req.params) && req.params[blockRefIndex]
+            ? req.params[blockRefIndex]
+            : undefined;
+        // omitted blockRef implies "latest"
+        if (blockRef === undefined) {
+            blockRef = 'latest';
+        }
+        // skip if non-number block reference
+        if (['latest', 'pending'].includes(blockRef)) {
+            return next();
+        }
+        // skip if block refernce is not a valid number
+        const blockRefNumber = Number.parseInt(blockRef.slice(2), 16);
+        if (Number.isNaN(blockRefNumber)) {
+            return next();
+        }
+        // lookup latest block
+        const latestBlockNumberHex = await blockTracker.getLatestBlock();
+        const latestBlockNumber = Number.parseInt(latestBlockNumberHex.slice(2), 16);
+        // skip if request block number is higher than current
+        if (blockRefNumber > latestBlockNumber) {
+            log('Requested block number %o is higher than latest block number %o, falling through to original request', blockRefNumber, latestBlockNumber);
+            return next();
+        }
+        log('Requested block number %o is not higher than latest block number %o, trying request until non-empty response is received', blockRefNumber, latestBlockNumber);
+        // create child request with specific block-ref
+        const childRequest = (0, full_1.klona)(req);
+        // attempt child request until non-empty response is received
+        const childResult = await retry(10, async () => {
+            log('Performing request %o', childRequest);
+            const attemptResult = await provider.request(childRequest);
+            log('Result is %o', attemptResult);
+            // verify result
+            const allEmptyValues = emptyValues;
+            if (allEmptyValues.includes(attemptResult)) {
+                throw new Error(`RetryOnEmptyMiddleware - empty result "${JSON.stringify(attemptResult)}" for request "${JSON.stringify(childRequest)}"`);
+            }
+            return attemptResult;
+        });
+        log('Copying result %o', childResult);
+        // copy child result onto original response
+        res.result = childResult;
+        return undefined;
+    });
+}
+exports.createRetryOnEmptyMiddleware = createRetryOnEmptyMiddleware;
+async function retry(maxRetries, asyncFn) {
+    for (let index = 0; index < maxRetries; index++) {
+        try {
+            return await asyncFn();
+        }
+        catch (err) {
+            if ((0, error_1.isExecutionRevertedError)(err)) {
+                throw err;
+            }
+            log('(call %i) Request failed, waiting 1s to retry again...', index + 1);
+            await (0, timeout_1.timeout)(1000);
+        }
+    }
+    log('Retries exhausted');
+    throw new Error('RetryOnEmptyMiddleware - retries exhausted');
+}
+//# sourceMappingURL=retryOnEmpty.cjs.map

package/dist/retryOnEmpty.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"retryOnEmpty.cjs","sourceRoot":"","sources":["../src/retryOnEmpty.ts"],"names":[],"mappings":";;;AAGA,+DAAkE;AAElE,qCAAmC;AAEnC,uDAAoE;AAEpE,6CAAmD;AACnD,6CAAyD;AACzD,iDAA0C;AAE1C,EAAE;AACF,gFAAgF;AAChF,+EAA+E;AAC/E,8DAA8D;AAC9D,qDAAqD;AACrD,EAAE;AAEF,MAAM,GAAG,GAAG,IAAA,kCAAkB,EAAC,6BAAa,EAAE,gBAAgB,CAAC,CAAC;AAChE,gEAAgE;AAChE,0EAA0E;AAC1E,MAAM,WAAW,GAAkC;IACjD,SAAS;IACT,IAAI;IACJ,iBAAiB;CAClB,CAAC;AAOF,SAAgB,4BAA4B,CAAC,EAC3C,QAAQ,EACR,YAAY,MACqB,EAAE;IACnC,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,KAAK,CACT,kEAAkE,CACnE,CAAC;KACH;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,KAAK,CACT,sEAAsE,CACvE,CAAC;KACH;IAED,OAAO,IAAA,uCAAqB,EAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACpD,MAAM,aAAa,GAAuB,IAAA,0BAAkB,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACzE,2CAA2C;QAC3C,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,OAAO,IAAI,EAAE,CAAC;SACf;QACD,qCAAqC;QACrC,IAAI,QAAQ,GACV,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,SAAS,CAAC;QAChB,oCAAoC;QACpC,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,QAAQ,GAAG,QAAQ,CAAC;SACrB;QAED,qCAAqC;QACrC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YAC5C,OAAO,IAAI,EAAE,CAAC;SACf;QACD,+CAA+C;QAC/C,MAAM,cAAc,GAAW,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACtE,IAAI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE;YAChC,OAAO,IAAI,EAAE,CAAC;SACf;QACD,sBAAsB;QACtB,MAAM,oBAAoB,GAAW,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;QACzE,MAAM,iBAAiB,GAAW,MAAM,CAAC,QAAQ,CAC/C,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,EAC7B,EAAE,CACH,CAAC;QACF,sDAAsD;QACtD,IAAI,cAAc,GAAG,iBAAiB,EAAE;YACtC,GAAG,CACD,sGAAsG,EACtG,cAAc,EACd,iBAAiB,CAClB,CAAC;YACF,OAAO,IAAI,EAAE,CAAC;SACf;QAED,GAAG,CACD,0HAA0H,EAC1H,cAAc,EACd,iBAAiB,CAClB,CAAC;QAEF,+CAA+C;QAC/C,MAAM,YAAY,GAAG,IAAA,YAAK,EAAC,GAAG,CAAC,CAAC;QAChC,6DAA6D;QAC7D,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,EAAE,EAAE,KAAK,IAAI,EAAE;YAC7C,GAAG,CAAC,uBAAuB,EAAE,YAAY,CAAC,CAAC;YAC3C,MAAM,aAAa,GAAG,MAAM,QAAQ,CAAC,OAAO,CAC1C,YAAY,CACb,CAAC;YACF,GAAG,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;YACnC,gBAAgB;YAChB,MAAM,cAAc,GAAc,WAAW,CAAC;YAC9C,IAAI,cAAc,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;gBAC1C,MAAM,IAAI,KAAK,CACb,0CAA0C,IAAI,CAAC,SAAS,CACtD,aAAa,CACd,kBAAkB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CACnD,CAAC;aACH;YACD,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC;QACtC,2CAA2C;QAC3C,GAAG,CAAC,MAAM,GAAG,WAAW,CAAC;QACzB,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC,CAAC;AACL,CAAC;AAxFD,oEAwFC;AAED,KAAK,UAAU,KAAK,CAClB,UAAkB,EAClB,OAA8B;IAE9B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,UAAU,EAAE,KAAK,EAAE,EAAE;QAC/C,IAAI;YACF,OAAO,MAAM,OAAO,EAAE,CAAC;SACxB;QAAC,OAAO,GAAY,EAAE;YACrB,IAAI,IAAA,gCAAwB,EAAC,GAAG,CAAC,EAAE;gBACjC,MAAM,GAAc,CAAC;aACtB;YACD,GAAG,CAAC,wDAAwD,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;YACzE,MAAM,IAAA,iBAAO,EAAC,IAAI,CAAC,CAAC;SACrB;KACF;IACD,GAAG,CAAC,mBAAmB,CAAC,CAAC;IACzB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;AAChE,CAAC","sourcesContent":["import type { PollingBlockTracker } from '@metamask/eth-block-tracker';\nimport type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';\nimport type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport { createAsyncMiddleware } from '@metamask/json-rpc-engine';\nimport type { Json, JsonRpcParams } from '@metamask/utils';\nimport { klona } from 'klona/full';\n\nimport { projectLogger, createModuleLogger } from './logging-utils';\nimport type { Block } from './types';\nimport { blockTagParamIndex } from './utils/cache';\nimport { isExecutionRevertedError } from './utils/error';\nimport { timeout } from './utils/timeout';\n\n//\n// RetryOnEmptyMiddleware will retry any request with an empty response that has\n// a numbered block reference at or lower than the blockTracker's latest block.\n// Its useful for dealing with load-balanced ethereum JSON RPC\n// nodes that are not always in sync with each other.\n//\n\nconst log = createModuleLogger(projectLogger, 'retry-on-empty');\n// empty values used to determine if a request should be retried\n// `<nil>` comes from https://github.com/ethereum/go-ethereum/issues/16925\nconst emptyValues: (string | null | undefined)[] = [\n  undefined,\n  null,\n  '\\u003cnil\\u003e',\n];\n\ninterface RetryOnEmptyMiddlewareOptions {\n  provider?: SafeEventEmitterProvider;\n  blockTracker?: PollingBlockTracker;\n}\n\nexport function createRetryOnEmptyMiddleware({\n  provider,\n  blockTracker,\n}: RetryOnEmptyMiddlewareOptions = {}): JsonRpcMiddleware<JsonRpcParams, Json> {\n  if (!provider) {\n    throw Error(\n      'RetryOnEmptyMiddleware - mandatory \"provider\" option is missing.',\n    );\n  }\n\n  if (!blockTracker) {\n    throw Error(\n      'RetryOnEmptyMiddleware - mandatory \"blockTracker\" option is missing.',\n    );\n  }\n\n  return createAsyncMiddleware(async (req, res, next) => {\n    const blockRefIndex: number | undefined = blockTagParamIndex(req.method);\n    // skip if method does not include blockRef\n    if (blockRefIndex === undefined) {\n      return next();\n    }\n    // skip if not exact block references\n    let blockRef: string | undefined =\n      Array.isArray(req.params) && req.params[blockRefIndex]\n        ? (req.params[blockRefIndex] as string)\n        : undefined;\n    // omitted blockRef implies \"latest\"\n    if (blockRef === undefined) {\n      blockRef = 'latest';\n    }\n\n    // skip if non-number block reference\n    if (['latest', 'pending'].includes(blockRef)) {\n      return next();\n    }\n    // skip if block refernce is not a valid number\n    const blockRefNumber: number = Number.parseInt(blockRef.slice(2), 16);\n    if (Number.isNaN(blockRefNumber)) {\n      return next();\n    }\n    // lookup latest block\n    const latestBlockNumberHex: string = await blockTracker.getLatestBlock();\n    const latestBlockNumber: number = Number.parseInt(\n      latestBlockNumberHex.slice(2),\n      16,\n    );\n    // skip if request block number is higher than current\n    if (blockRefNumber > latestBlockNumber) {\n      log(\n        'Requested block number %o is higher than latest block number %o, falling through to original request',\n        blockRefNumber,\n        latestBlockNumber,\n      );\n      return next();\n    }\n\n    log(\n      'Requested block number %o is not higher than latest block number %o, trying request until non-empty response is received',\n      blockRefNumber,\n      latestBlockNumber,\n    );\n\n    // create child request with specific block-ref\n    const childRequest = klona(req);\n    // attempt child request until non-empty response is received\n    const childResult = await retry(10, async () => {\n      log('Performing request %o', childRequest);\n      const attemptResult = await provider.request<JsonRpcParams, Block>(\n        childRequest,\n      );\n      log('Result is %o', attemptResult);\n      // verify result\n      const allEmptyValues: unknown[] = emptyValues;\n      if (allEmptyValues.includes(attemptResult)) {\n        throw new Error(\n          `RetryOnEmptyMiddleware - empty result \"${JSON.stringify(\n            attemptResult,\n          )}\" for request \"${JSON.stringify(childRequest)}\"`,\n        );\n      }\n      return attemptResult;\n    });\n    log('Copying result %o', childResult);\n    // copy child result onto original response\n    res.result = childResult;\n    return undefined;\n  });\n}\n\nasync function retry<Result>(\n  maxRetries: number,\n  asyncFn: () => Promise<Result>,\n): Promise<Result> {\n  for (let index = 0; index < maxRetries; index++) {\n    try {\n      return await asyncFn();\n    } catch (err: unknown) {\n      if (isExecutionRevertedError(err)) {\n        throw err as unknown;\n      }\n      log('(call %i) Request failed, waiting 1s to retry again...', index + 1);\n      await timeout(1000);\n    }\n  }\n  log('Retries exhausted');\n  throw new Error('RetryOnEmptyMiddleware - retries exhausted');\n}\n"]}

package/dist/retryOnEmpty.d.cts

@@ -0,0 +1,11 @@
+import type { PollingBlockTracker } from "@metamask/eth-block-tracker";
+import type { SafeEventEmitterProvider } from "@metamask/eth-json-rpc-provider";
+import type { JsonRpcMiddleware } from "@metamask/json-rpc-engine";
+import type { Json, JsonRpcParams } from "@metamask/utils";
+interface RetryOnEmptyMiddlewareOptions {
+    provider?: SafeEventEmitterProvider;
+    blockTracker?: PollingBlockTracker;
+}
+export declare function createRetryOnEmptyMiddleware({ provider, blockTracker, }?: RetryOnEmptyMiddlewareOptions): JsonRpcMiddleware<JsonRpcParams, Json>;
+export {};
+//# sourceMappingURL=retryOnEmpty.d.cts.map

package/dist/retryOnEmpty.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retryOnEmpty.d.cts","sourceRoot":"","sources":["../src/retryOnEmpty.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oCAAoC;AACvE,OAAO,KAAK,EAAE,wBAAwB,EAAE,wCAAwC;AAChF,OAAO,KAAK,EAAE,iBAAiB,EAAE,kCAAkC;AAEnE,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAyB3D,UAAU,6BAA6B;IACrC,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IACpC,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC;AAED,wBAAgB,4BAA4B,CAAC,EAC3C,QAAQ,EACR,YAAY,GACb,GAAE,6BAAkC,GAAG,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAqF7E"}

package/dist/retryOnEmpty.d.mts

@@ -0,0 +1,11 @@
+import type { PollingBlockTracker } from "@metamask/eth-block-tracker";
+import type { SafeEventEmitterProvider } from "@metamask/eth-json-rpc-provider";
+import type { JsonRpcMiddleware } from "@metamask/json-rpc-engine";
+import type { Json, JsonRpcParams } from "@metamask/utils";
+interface RetryOnEmptyMiddlewareOptions {
+    provider?: SafeEventEmitterProvider;
+    blockTracker?: PollingBlockTracker;
+}
+export declare function createRetryOnEmptyMiddleware({ provider, blockTracker, }?: RetryOnEmptyMiddlewareOptions): JsonRpcMiddleware<JsonRpcParams, Json>;
+export {};
+//# sourceMappingURL=retryOnEmpty.d.mts.map

package/dist/retryOnEmpty.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retryOnEmpty.d.mts","sourceRoot":"","sources":["../src/retryOnEmpty.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oCAAoC;AACvE,OAAO,KAAK,EAAE,wBAAwB,EAAE,wCAAwC;AAChF,OAAO,KAAK,EAAE,iBAAiB,EAAE,kCAAkC;AAEnE,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAyB3D,UAAU,6BAA6B;IACrC,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IACpC,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC;AAED,wBAAgB,4BAA4B,CAAC,EAC3C,QAAQ,EACR,YAAY,GACb,GAAE,6BAAkC,GAAG,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAqF7E"}

package/dist/retryOnEmpty.mjs

@@ -0,0 +1,96 @@
+import { createAsyncMiddleware } from "@metamask/json-rpc-engine";
+import { klona } from "klona/full";
+import { projectLogger, createModuleLogger } from "./logging-utils.mjs";
+import { blockTagParamIndex } from "./utils/cache.mjs";
+import { isExecutionRevertedError } from "./utils/error.mjs";
+import { timeout } from "./utils/timeout.mjs";
+//
+// RetryOnEmptyMiddleware will retry any request with an empty response that has
+// a numbered block reference at or lower than the blockTracker's latest block.
+// Its useful for dealing with load-balanced ethereum JSON RPC
+// nodes that are not always in sync with each other.
+//
+const log = createModuleLogger(projectLogger, 'retry-on-empty');
+// empty values used to determine if a request should be retried
+// `<nil>` comes from https://github.com/ethereum/go-ethereum/issues/16925
+const emptyValues = [
+    undefined,
+    null,
+    '\u003cnil\u003e',
+];
+export function createRetryOnEmptyMiddleware({ provider, blockTracker, } = {}) {
+    if (!provider) {
+        throw Error('RetryOnEmptyMiddleware - mandatory "provider" option is missing.');
+    }
+    if (!blockTracker) {
+        throw Error('RetryOnEmptyMiddleware - mandatory "blockTracker" option is missing.');
+    }
+    return createAsyncMiddleware(async (req, res, next) => {
+        const blockRefIndex = blockTagParamIndex(req.method);
+        // skip if method does not include blockRef
+        if (blockRefIndex === undefined) {
+            return next();
+        }
+        // skip if not exact block references
+        let blockRef = Array.isArray(req.params) && req.params[blockRefIndex]
+            ? req.params[blockRefIndex]
+            : undefined;
+        // omitted blockRef implies "latest"
+        if (blockRef === undefined) {
+            blockRef = 'latest';
+        }
+        // skip if non-number block reference
+        if (['latest', 'pending'].includes(blockRef)) {
+            return next();
+        }
+        // skip if block refernce is not a valid number
+        const blockRefNumber = Number.parseInt(blockRef.slice(2), 16);
+        if (Number.isNaN(blockRefNumber)) {
+            return next();
+        }
+        // lookup latest block
+        const latestBlockNumberHex = await blockTracker.getLatestBlock();
+        const latestBlockNumber = Number.parseInt(latestBlockNumberHex.slice(2), 16);
+        // skip if request block number is higher than current
+        if (blockRefNumber > latestBlockNumber) {
+            log('Requested block number %o is higher than latest block number %o, falling through to original request', blockRefNumber, latestBlockNumber);
+            return next();
+        }
+        log('Requested block number %o is not higher than latest block number %o, trying request until non-empty response is received', blockRefNumber, latestBlockNumber);
+        // create child request with specific block-ref
+        const childRequest = klona(req);
+        // attempt child request until non-empty response is received
+        const childResult = await retry(10, async () => {
+            log('Performing request %o', childRequest);
+            const attemptResult = await provider.request(childRequest);
+            log('Result is %o', attemptResult);
+            // verify result
+            const allEmptyValues = emptyValues;
+            if (allEmptyValues.includes(attemptResult)) {
+                throw new Error(`RetryOnEmptyMiddleware - empty result "${JSON.stringify(attemptResult)}" for request "${JSON.stringify(childRequest)}"`);
+            }
+            return attemptResult;
+        });
+        log('Copying result %o', childResult);
+        // copy child result onto original response
+        res.result = childResult;
+        return undefined;
+    });
+}
+async function retry(maxRetries, asyncFn) {
+    for (let index = 0; index < maxRetries; index++) {
+        try {
+            return await asyncFn();
+        }
+        catch (err) {
+            if (isExecutionRevertedError(err)) {
+                throw err;
+            }
+            log('(call %i) Request failed, waiting 1s to retry again...', index + 1);
+            await timeout(1000);
+        }
+    }
+    log('Retries exhausted');
+    throw new Error('RetryOnEmptyMiddleware - retries exhausted');
+}
+//# sourceMappingURL=retryOnEmpty.mjs.map

package/dist/retryOnEmpty.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"retryOnEmpty.mjs","sourceRoot":"","sources":["../src/retryOnEmpty.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,qBAAqB,EAAE,kCAAkC;AAElE,OAAO,EAAE,KAAK,EAAE,mBAAmB;AAEnC,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,4BAAwB;AAEpE,OAAO,EAAE,kBAAkB,EAAE,0BAAsB;AACnD,OAAO,EAAE,wBAAwB,EAAE,0BAAsB;AACzD,OAAO,EAAE,OAAO,EAAE,4BAAwB;AAE1C,EAAE;AACF,gFAAgF;AAChF,+EAA+E;AAC/E,8DAA8D;AAC9D,qDAAqD;AACrD,EAAE;AAEF,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;AAChE,gEAAgE;AAChE,0EAA0E;AAC1E,MAAM,WAAW,GAAkC;IACjD,SAAS;IACT,IAAI;IACJ,iBAAiB;CAClB,CAAC;AAOF,MAAM,UAAU,4BAA4B,CAAC,EAC3C,QAAQ,EACR,YAAY,MACqB,EAAE;IACnC,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,KAAK,CACT,kEAAkE,CACnE,CAAC;KACH;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,KAAK,CACT,sEAAsE,CACvE,CAAC;KACH;IAED,OAAO,qBAAqB,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACpD,MAAM,aAAa,GAAuB,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACzE,2CAA2C;QAC3C,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,OAAO,IAAI,EAAE,CAAC;SACf;QACD,qCAAqC;QACrC,IAAI,QAAQ,GACV,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,SAAS,CAAC;QAChB,oCAAoC;QACpC,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,QAAQ,GAAG,QAAQ,CAAC;SACrB;QAED,qCAAqC;QACrC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YAC5C,OAAO,IAAI,EAAE,CAAC;SACf;QACD,+CAA+C;QAC/C,MAAM,cAAc,GAAW,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACtE,IAAI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE;YAChC,OAAO,IAAI,EAAE,CAAC;SACf;QACD,sBAAsB;QACtB,MAAM,oBAAoB,GAAW,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;QACzE,MAAM,iBAAiB,GAAW,MAAM,CAAC,QAAQ,CAC/C,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,EAC7B,EAAE,CACH,CAAC;QACF,sDAAsD;QACtD,IAAI,cAAc,GAAG,iBAAiB,EAAE;YACtC,GAAG,CACD,sGAAsG,EACtG,cAAc,EACd,iBAAiB,CAClB,CAAC;YACF,OAAO,IAAI,EAAE,CAAC;SACf;QAED,GAAG,CACD,0HAA0H,EAC1H,cAAc,EACd,iBAAiB,CAClB,CAAC;QAEF,+CAA+C;QAC/C,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QAChC,6DAA6D;QAC7D,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,EAAE,EAAE,KAAK,IAAI,EAAE;YAC7C,GAAG,CAAC,uBAAuB,EAAE,YAAY,CAAC,CAAC;YAC3C,MAAM,aAAa,GAAG,MAAM,QAAQ,CAAC,OAAO,CAC1C,YAAY,CACb,CAAC;YACF,GAAG,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;YACnC,gBAAgB;YAChB,MAAM,cAAc,GAAc,WAAW,CAAC;YAC9C,IAAI,cAAc,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;gBAC1C,MAAM,IAAI,KAAK,CACb,0CAA0C,IAAI,CAAC,SAAS,CACtD,aAAa,CACd,kBAAkB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CACnD,CAAC;aACH;YACD,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC;QACtC,2CAA2C;QAC3C,GAAG,CAAC,MAAM,GAAG,WAAW,CAAC;QACzB,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,KAAK,CAClB,UAAkB,EAClB,OAA8B;IAE9B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,UAAU,EAAE,KAAK,EAAE,EAAE;QAC/C,IAAI;YACF,OAAO,MAAM,OAAO,EAAE,CAAC;SACxB;QAAC,OAAO,GAAY,EAAE;YACrB,IAAI,wBAAwB,CAAC,GAAG,CAAC,EAAE;gBACjC,MAAM,GAAc,CAAC;aACtB;YACD,GAAG,CAAC,wDAAwD,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;YACzE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;SACrB;KACF;IACD,GAAG,CAAC,mBAAmB,CAAC,CAAC;IACzB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;AAChE,CAAC","sourcesContent":["import type { PollingBlockTracker } from '@metamask/eth-block-tracker';\nimport type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';\nimport type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport { createAsyncMiddleware } from '@metamask/json-rpc-engine';\nimport type { Json, JsonRpcParams } from '@metamask/utils';\nimport { klona } from 'klona/full';\n\nimport { projectLogger, createModuleLogger } from './logging-utils';\nimport type { Block } from './types';\nimport { blockTagParamIndex } from './utils/cache';\nimport { isExecutionRevertedError } from './utils/error';\nimport { timeout } from './utils/timeout';\n\n//\n// RetryOnEmptyMiddleware will retry any request with an empty response that has\n// a numbered block reference at or lower than the blockTracker's latest block.\n// Its useful for dealing with load-balanced ethereum JSON RPC\n// nodes that are not always in sync with each other.\n//\n\nconst log = createModuleLogger(projectLogger, 'retry-on-empty');\n// empty values used to determine if a request should be retried\n// `<nil>` comes from https://github.com/ethereum/go-ethereum/issues/16925\nconst emptyValues: (string | null | undefined)[] = [\n  undefined,\n  null,\n  '\\u003cnil\\u003e',\n];\n\ninterface RetryOnEmptyMiddlewareOptions {\n  provider?: SafeEventEmitterProvider;\n  blockTracker?: PollingBlockTracker;\n}\n\nexport function createRetryOnEmptyMiddleware({\n  provider,\n  blockTracker,\n}: RetryOnEmptyMiddlewareOptions = {}): JsonRpcMiddleware<JsonRpcParams, Json> {\n  if (!provider) {\n    throw Error(\n      'RetryOnEmptyMiddleware - mandatory \"provider\" option is missing.',\n    );\n  }\n\n  if (!blockTracker) {\n    throw Error(\n      'RetryOnEmptyMiddleware - mandatory \"blockTracker\" option is missing.',\n    );\n  }\n\n  return createAsyncMiddleware(async (req, res, next) => {\n    const blockRefIndex: number | undefined = blockTagParamIndex(req.method);\n    // skip if method does not include blockRef\n    if (blockRefIndex === undefined) {\n      return next();\n    }\n    // skip if not exact block references\n    let blockRef: string | undefined =\n      Array.isArray(req.params) && req.params[blockRefIndex]\n        ? (req.params[blockRefIndex] as string)\n        : undefined;\n    // omitted blockRef implies \"latest\"\n    if (blockRef === undefined) {\n      blockRef = 'latest';\n    }\n\n    // skip if non-number block reference\n    if (['latest', 'pending'].includes(blockRef)) {\n      return next();\n    }\n    // skip if block refernce is not a valid number\n    const blockRefNumber: number = Number.parseInt(blockRef.slice(2), 16);\n    if (Number.isNaN(blockRefNumber)) {\n      return next();\n    }\n    // lookup latest block\n    const latestBlockNumberHex: string = await blockTracker.getLatestBlock();\n    const latestBlockNumber: number = Number.parseInt(\n      latestBlockNumberHex.slice(2),\n      16,\n    );\n    // skip if request block number is higher than current\n    if (blockRefNumber > latestBlockNumber) {\n      log(\n        'Requested block number %o is higher than latest block number %o, falling through to original request',\n        blockRefNumber,\n        latestBlockNumber,\n      );\n      return next();\n    }\n\n    log(\n      'Requested block number %o is not higher than latest block number %o, trying request until non-empty response is received',\n      blockRefNumber,\n      latestBlockNumber,\n    );\n\n    // create child request with specific block-ref\n    const childRequest = klona(req);\n    // attempt child request until non-empty response is received\n    const childResult = await retry(10, async () => {\n      log('Performing request %o', childRequest);\n      const attemptResult = await provider.request<JsonRpcParams, Block>(\n        childRequest,\n      );\n      log('Result is %o', attemptResult);\n      // verify result\n      const allEmptyValues: unknown[] = emptyValues;\n      if (allEmptyValues.includes(attemptResult)) {\n        throw new Error(\n          `RetryOnEmptyMiddleware - empty result \"${JSON.stringify(\n            attemptResult,\n          )}\" for request \"${JSON.stringify(childRequest)}\"`,\n        );\n      }\n      return attemptResult;\n    });\n    log('Copying result %o', childResult);\n    // copy child result onto original response\n    res.result = childResult;\n    return undefined;\n  });\n}\n\nasync function retry<Result>(\n  maxRetries: number,\n  asyncFn: () => Promise<Result>,\n): Promise<Result> {\n  for (let index = 0; index < maxRetries; index++) {\n    try {\n      return await asyncFn();\n    } catch (err: unknown) {\n      if (isExecutionRevertedError(err)) {\n        throw err as unknown;\n      }\n      log('(call %i) Request failed, waiting 1s to retry again...', index + 1);\n      await timeout(1000);\n    }\n  }\n  log('Retries exhausted');\n  throw new Error('RetryOnEmptyMiddleware - retries exhausted');\n}\n"]}

package/dist/types.cjs

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

package/dist/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport type {\n  Json,\n  JsonRpcParams,\n  JsonRpcRequest,\n  JsonRpcResponse,\n} from '@metamask/utils';\n\nexport interface JsonRpcRequestToCache<Params extends JsonRpcParams>\n  extends JsonRpcRequest<Params> {\n  skipCache?: boolean;\n}\n\nexport type JsonRpcCacheMiddleware<\n  Params extends JsonRpcParams,\n  Result extends Json,\n> =\n  JsonRpcMiddleware<Params, Result> extends (\n    req: JsonRpcRequest<Params>,\n    ...args: infer X\n  ) => infer Y\n    ? (req: JsonRpcRequestToCache<Params>, ...args: X) => Y\n    : never;\n\nexport type BlockData = string | string[];\n\nexport type Block = Record<string, BlockData>;\n\nexport type BlockCache = Record<string, Block>;\n\nexport type Cache = Record<number, BlockCache>;\n\n/**\n * A copy of the `AbstractRpcService` type in metamask/network-controller`, but\n * keeping only the `request` method.\n *\n * We cannot get `AbstractRpcService` directly from\n * `@metamask/network-controller` because relying on this package would create a\n * circular dependency.\n *\n * This type should be accurate as of `@metamask/network-controller` 24.x and\n * `@metamask/utils` 11.x.\n */\nexport type AbstractRpcServiceLike = {\n  request: <Params extends JsonRpcParams, Result extends Json>(\n    jsonRpcRequest: JsonRpcRequest<Params>,\n    fetchOptions?: RequestInit,\n  ) => Promise<JsonRpcResponse<Result | null>>;\n};\n"]}

package/dist/types.d.cts

@@ -0,0 +1,25 @@
+import type { JsonRpcMiddleware } from "@metamask/json-rpc-engine";
+import type { Json, JsonRpcParams, JsonRpcRequest, JsonRpcResponse } from "@metamask/utils";
+export interface JsonRpcRequestToCache<Params extends JsonRpcParams> extends JsonRpcRequest<Params> {
+    skipCache?: boolean;
+}
+export type JsonRpcCacheMiddleware<Params extends JsonRpcParams, Result extends Json> = JsonRpcMiddleware<Params, Result> extends (req: JsonRpcRequest<Params>, ...args: infer X) => infer Y ? (req: JsonRpcRequestToCache<Params>, ...args: X) => Y : never;
+export type BlockData = string | string[];
+export type Block = Record<string, BlockData>;
+export type BlockCache = Record<string, Block>;
+export type Cache = Record<number, BlockCache>;
+/**
+ * A copy of the `AbstractRpcService` type in metamask/network-controller`, but
+ * keeping only the `request` method.
+ *
+ * We cannot get `AbstractRpcService` directly from
+ * `@metamask/network-controller` because relying on this package would create a
+ * circular dependency.
+ *
+ * This type should be accurate as of `@metamask/network-controller` 24.x and
+ * `@metamask/utils` 11.x.
+ */
+export type AbstractRpcServiceLike = {
+    request: <Params extends JsonRpcParams, Result extends Json>(jsonRpcRequest: JsonRpcRequest<Params>, fetchOptions?: RequestInit) => Promise<JsonRpcResponse<Result | null>>;
+};
+//# sourceMappingURL=types.d.cts.map

package/dist/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,kCAAkC;AACnE,OAAO,KAAK,EACV,IAAI,EACJ,aAAa,EACb,cAAc,EACd,eAAe,EAChB,wBAAwB;AAEzB,MAAM,WAAW,qBAAqB,CAAC,MAAM,SAAS,aAAa,CACjE,SAAQ,cAAc,CAAC,MAAM,CAAC;IAC9B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,MAAM,sBAAsB,CAChC,MAAM,SAAS,aAAa,EAC5B,MAAM,SAAS,IAAI,IAEnB,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,SAAS,CACxC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,EAC3B,GAAG,IAAI,EAAE,MAAM,CAAC,KACb,MAAM,CAAC,GACR,CAAC,GAAG,EAAE,qBAAqB,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,GACrD,KAAK,CAAC;AAEZ,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAE1C,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAE9C,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAE/C,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAE/C;;;;;;;;;;GAUG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,CAAC,MAAM,SAAS,aAAa,EAAE,MAAM,SAAS,IAAI,EACzD,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,EACtC,YAAY,CAAC,EAAE,WAAW,KACvB,OAAO,CAAC,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC;CAC9C,CAAC"}

package/dist/types.d.mts

@@ -0,0 +1,25 @@
+import type { JsonRpcMiddleware } from "@metamask/json-rpc-engine";
+import type { Json, JsonRpcParams, JsonRpcRequest, JsonRpcResponse } from "@metamask/utils";
+export interface JsonRpcRequestToCache<Params extends JsonRpcParams> extends JsonRpcRequest<Params> {
+    skipCache?: boolean;
+}
+export type JsonRpcCacheMiddleware<Params extends JsonRpcParams, Result extends Json> = JsonRpcMiddleware<Params, Result> extends (req: JsonRpcRequest<Params>, ...args: infer X) => infer Y ? (req: JsonRpcRequestToCache<Params>, ...args: X) => Y : never;
+export type BlockData = string | string[];
+export type Block = Record<string, BlockData>;
+export type BlockCache = Record<string, Block>;
+export type Cache = Record<number, BlockCache>;
+/**
+ * A copy of the `AbstractRpcService` type in metamask/network-controller`, but
+ * keeping only the `request` method.
+ *
+ * We cannot get `AbstractRpcService` directly from
+ * `@metamask/network-controller` because relying on this package would create a
+ * circular dependency.
+ *
+ * This type should be accurate as of `@metamask/network-controller` 24.x and
+ * `@metamask/utils` 11.x.
+ */
+export type AbstractRpcServiceLike = {
+    request: <Params extends JsonRpcParams, Result extends Json>(jsonRpcRequest: JsonRpcRequest<Params>, fetchOptions?: RequestInit) => Promise<JsonRpcResponse<Result | null>>;
+};
+//# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,kCAAkC;AACnE,OAAO,KAAK,EACV,IAAI,EACJ,aAAa,EACb,cAAc,EACd,eAAe,EAChB,wBAAwB;AAEzB,MAAM,WAAW,qBAAqB,CAAC,MAAM,SAAS,aAAa,CACjE,SAAQ,cAAc,CAAC,MAAM,CAAC;IAC9B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,MAAM,sBAAsB,CAChC,MAAM,SAAS,aAAa,EAC5B,MAAM,SAAS,IAAI,IAEnB,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,SAAS,CACxC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,EAC3B,GAAG,IAAI,EAAE,MAAM,CAAC,KACb,MAAM,CAAC,GACR,CAAC,GAAG,EAAE,qBAAqB,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,GACrD,KAAK,CAAC;AAEZ,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAE1C,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAE9C,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAE/C,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAE/C;;;;;;;;;;GAUG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,CAAC,MAAM,SAAS,aAAa,EAAE,MAAM,SAAS,IAAI,EACzD,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,EACtC,YAAY,CAAC,EAAE,WAAW,KACvB,OAAO,CAAC,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC;CAC9C,CAAC"}

package/dist/types.mjs

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

package/dist/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport type {\n  Json,\n  JsonRpcParams,\n  JsonRpcRequest,\n  JsonRpcResponse,\n} from '@metamask/utils';\n\nexport interface JsonRpcRequestToCache<Params extends JsonRpcParams>\n  extends JsonRpcRequest<Params> {\n  skipCache?: boolean;\n}\n\nexport type JsonRpcCacheMiddleware<\n  Params extends JsonRpcParams,\n  Result extends Json,\n> =\n  JsonRpcMiddleware<Params, Result> extends (\n    req: JsonRpcRequest<Params>,\n    ...args: infer X\n  ) => infer Y\n    ? (req: JsonRpcRequestToCache<Params>, ...args: X) => Y\n    : never;\n\nexport type BlockData = string | string[];\n\nexport type Block = Record<string, BlockData>;\n\nexport type BlockCache = Record<string, Block>;\n\nexport type Cache = Record<number, BlockCache>;\n\n/**\n * A copy of the `AbstractRpcService` type in metamask/network-controller`, but\n * keeping only the `request` method.\n *\n * We cannot get `AbstractRpcService` directly from\n * `@metamask/network-controller` because relying on this package would create a\n * circular dependency.\n *\n * This type should be accurate as of `@metamask/network-controller` 24.x and\n * `@metamask/utils` 11.x.\n */\nexport type AbstractRpcServiceLike = {\n  request: <Params extends JsonRpcParams, Result extends Json>(\n    jsonRpcRequest: JsonRpcRequest<Params>,\n    fetchOptions?: RequestInit,\n  ) => Promise<JsonRpcResponse<Result | null>>;\n};\n"]}

package/dist/utils/cache.cjs

@@ -0,0 +1,186 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cacheTypeForMethod = exports.blockTagParamIndex = exports.blockTagForRequest = exports.canCache = exports.cacheIdentifierForRequest = exports.CacheStrategy = void 0;
+const safe_stable_stringify_1 = require("safe-stable-stringify");
+const stringify = (0, safe_stable_stringify_1.configure)({ bigint: false, circularValue: Error });
+/**
+ * The cache strategy to use for a given method.
+ */
+var CacheStrategy;
+(function (CacheStrategy) {
+    /**
+     * Cache per-block.
+     */
+    CacheStrategy["Block"] = "block";
+    /**
+     * Cache until a chain reorganization occurs.
+     */
+    CacheStrategy["Fork"] = "fork";
+    /**
+     * Never cache.
+     */
+    CacheStrategy["Never"] = "never";
+    /**
+     * Permanently cache.
+     */
+    CacheStrategy["Permanent"] = "perma";
+})(CacheStrategy || (exports.CacheStrategy = CacheStrategy = {}));
+/**
+ * Return a cache identifier for the given request.
+ *
+ * This identifier should include any request details that might impact the
+ * response, with the exception of the block parameter if the `skipBlockRef`
+ * option is set,
+ *
+ * If the request cannot be cached, this will return `null`.
+ *
+ * @param request - The JSON-RPC request.
+ * @param skipBlockRef - Skip the block parameter when generating the cache
+ * identifier.
+ * @returns The cache identifier for this request, or `null` if it can't be
+ * cached.
+ */
+function cacheIdentifierForRequest(request, skipBlockRef) {
+    const simpleParams = skipBlockRef
+        ? paramsWithoutBlockTag(request)
+        : (request.params ?? []);
+    if (canCache(request.method)) {
+        return `${request.method}:${stringify(simpleParams)}`;
+    }
+    return null;
+}
+exports.cacheIdentifierForRequest = cacheIdentifierForRequest;
+/**
+ * Return whether a method can be cached or not.
+ *
+ * @param method - The method to check.
+ * @returns Whether the method can be cached.
+ */
+function canCache(method) {
+    return cacheTypeForMethod(method) !== CacheStrategy.Never;
+}
+exports.canCache = canCache;
+/**
+ * Return the block parameter for the given request, if it has one.
+ *
+ * @param request - The JSON-RPC request.
+ * @returns The block parameter in the given request, or `undefined` if none was found.
+ */
+function blockTagForRequest(request) {
+    if (!request.params) {
+        return undefined;
+    }
+    const index = blockTagParamIndex(request.method);
+    // Block tag param not passed.
+    if (index === undefined ||
+        !Array.isArray(request.params) ||
+        index >= request.params.length) {
+        return undefined;
+    }
+    return request.params[index];
+}
+exports.blockTagForRequest = blockTagForRequest;
+/**
+ * Return the request parameters without the block parameter.
+ *
+ * @param request - The JSON-RPC request.
+ * @returns The request parameters with the block parameter removed, if one was found.
+ */
+function paramsWithoutBlockTag(request) {
+    if (!request.params) {
+        return [];
+    }
+    const index = blockTagParamIndex(request.method);
+    // Block tag param not passed.
+    if (index === undefined ||
+        !Array.isArray(request.params) ||
+        index >= request.params.length) {
+        return request.params;
+    }
+    // eth_getBlockByNumber has the block tag first, then the optional includeTx? param
+    if (request.method === 'eth_getBlockByNumber') {
+        return request.params.slice(1);
+    }
+    return request.params.slice(0, index);
+}
+/**
+ * Returns the index of the block parameter for the given method.
+ *
+ * @param method - A JSON-RPC method.
+ * @returns The index of the block parameter for that method, or `undefined` if
+ * there is no known block parameter.
+ */
+function blockTagParamIndex(method) {
+    switch (method) {
+        // blockTag is at index 2
+        case 'eth_getStorageAt':
+            return 2;
+        // blockTag is at index 1
+        case 'eth_getBalance':
+        case 'eth_getCode':
+        case 'eth_getTransactionCount':
+        case 'eth_call':
+            return 1;
+        // blockTag is at index 0
+        case 'eth_getBlockByNumber':
+            return 0;
+        // there is no blockTag
+        default:
+            return undefined;
+    }
+}
+exports.blockTagParamIndex = blockTagParamIndex;
+/**
+ * Return the cache type used for the given method.
+ *
+ * @param method - A JSON-RPC method.
+ * @returns The cache type to use for that method.
+ */
+function cacheTypeForMethod(method) {
+    switch (method) {
+        // cache permanently
+        case 'web3_clientVersion':
+        case 'web3_sha3':
+        case 'eth_protocolVersion':
+        case 'eth_getBlockTransactionCountByHash':
+        case 'eth_getUncleCountByBlockHash':
+        case 'eth_getCode':
+        case 'eth_getBlockByHash':
+        case 'eth_getTransactionByHash':
+        case 'eth_getTransactionByBlockHashAndIndex':
+        case 'eth_getTransactionReceipt':
+        case 'eth_getUncleByBlockHashAndIndex':
+        case 'eth_getCompilers':
+        case 'eth_compileLLL':
+        case 'eth_compileSolidity':
+        case 'eth_compileSerpent':
+        case 'shh_version':
+        case 'test_permaCache':
+            return CacheStrategy.Permanent;
+        // cache until fork
+        case 'eth_getBlockByNumber':
+        case 'eth_getBlockTransactionCountByNumber':
+        case 'eth_getUncleCountByBlockNumber':
+        case 'eth_getTransactionByBlockNumberAndIndex':
+        case 'eth_getUncleByBlockNumberAndIndex':
+        case 'test_forkCache':
+            return CacheStrategy.Fork;
+        // cache for block
+        case 'eth_gasPrice':
+        case 'eth_blockNumber':
+        case 'eth_getBalance':
+        case 'eth_getStorageAt':
+        case 'eth_getTransactionCount':
+        case 'eth_call':
+        case 'eth_estimateGas':
+        case 'eth_getFilterLogs':
+        case 'eth_getLogs':
+        case 'test_blockCache':
+            return CacheStrategy.Block;
+        // never cache
+        default:
+            return CacheStrategy.Never;
+    }
+}
+exports.cacheTypeForMethod = cacheTypeForMethod;
+//# sourceMappingURL=cache.cjs.map

package/dist/utils/cache.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.cjs","sourceRoot":"","sources":["../../src/utils/cache.ts"],"names":[],"mappings":";;;AACA,iEAAkD;AAElD,MAAM,SAAS,GAAG,IAAA,iCAAS,EAAC,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC;AAErE;;GAEG;AACH,IAAY,aAiBX;AAjBD,WAAY,aAAa;IACvB;;OAEG;IACH,gCAAe,CAAA;IACf;;OAEG;IACH,8BAAa,CAAA;IACb;;OAEG;IACH,gCAAe,CAAA;IACf;;OAEG;IACH,oCAAmB,CAAA;AACrB,CAAC,EAjBW,aAAa,6BAAb,aAAa,QAiBxB;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,yBAAyB,CACvC,OAAuB,EACvB,YAAsB;IAEtB,MAAM,YAAY,GAAG,YAAY;QAC/B,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC;QAChC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;IAC3B,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QAC5B,OAAO,GAAG,OAAO,CAAC,MAAM,IAAI,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC;KACvD;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAXD,8DAWC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,MAAc;IACrC,OAAO,kBAAkB,CAAC,MAAM,CAAC,KAAK,aAAa,CAAC,KAAK,CAAC;AAC5D,CAAC;AAFD,4BAEC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,OAAuB;IACxD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;QACnB,OAAO,SAAS,CAAC;KAClB;IACD,MAAM,KAAK,GAAuB,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAErE,8BAA8B;IAC9B,IACE,KAAK,KAAK,SAAS;QACnB,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;QAC9B,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAC9B;QACA,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAhBD,gDAgBC;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,OAAuB;IACpD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;QACnB,OAAO,EAAE,CAAC;KACX;IACD,MAAM,KAAK,GAAuB,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAErE,8BAA8B;IAC9B,IACE,KAAK,KAAK,SAAS;QACnB,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;QAC9B,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAC9B;QACA,OAAO,OAAO,CAAC,MAAM,CAAC;KACvB;IAED,mFAAmF;IACnF,IAAI,OAAO,CAAC,MAAM,KAAK,sBAAsB,EAAE;QAC7C,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KAChC;IACD,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAAC,MAAc;IAC/C,QAAQ,MAAM,EAAE;QACd,yBAAyB;QACzB,KAAK,kBAAkB;YACrB,OAAO,CAAC,CAAC;QACX,yBAAyB;QACzB,KAAK,gBAAgB,CAAC;QACtB,KAAK,aAAa,CAAC;QACnB,KAAK,yBAAyB,CAAC;QAC/B,KAAK,UAAU;YACb,OAAO,CAAC,CAAC;QACX,yBAAyB;QACzB,KAAK,sBAAsB;YACzB,OAAO,CAAC,CAAC;QACX,uBAAuB;QACvB;YACE,OAAO,SAAS,CAAC;KACpB;AACH,CAAC;AAlBD,gDAkBC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,MAAc;IAC/C,QAAQ,MAAM,EAAE;QACd,oBAAoB;QACpB,KAAK,oBAAoB,CAAC;QAC1B,KAAK,WAAW,CAAC;QACjB,KAAK,qBAAqB,CAAC;QAC3B,KAAK,oCAAoC,CAAC;QAC1C,KAAK,8BAA8B,CAAC;QACpC,KAAK,aAAa,CAAC;QACnB,KAAK,oBAAoB,CAAC;QAC1B,KAAK,0BAA0B,CAAC;QAChC,KAAK,uCAAuC,CAAC;QAC7C,KAAK,2BAA2B,CAAC;QACjC,KAAK,iCAAiC,CAAC;QACvC,KAAK,kBAAkB,CAAC;QACxB,KAAK,gBAAgB,CAAC;QACtB,KAAK,qBAAqB,CAAC;QAC3B,KAAK,oBAAoB,CAAC;QAC1B,KAAK,aAAa,CAAC;QACnB,KAAK,iBAAiB;YACpB,OAAO,aAAa,CAAC,SAAS,CAAC;QAEjC,mBAAmB;QACnB,KAAK,sBAAsB,CAAC;QAC5B,KAAK,sCAAsC,CAAC;QAC5C,KAAK,gCAAgC,CAAC;QACtC,KAAK,yCAAyC,CAAC;QAC/C,KAAK,mCAAmC,CAAC;QACzC,KAAK,gBAAgB;YACnB,OAAO,aAAa,CAAC,IAAI,CAAC;QAE5B,kBAAkB;QAClB,KAAK,cAAc,CAAC;QACpB,KAAK,iBAAiB,CAAC;QACvB,KAAK,gBAAgB,CAAC;QACtB,KAAK,kBAAkB,CAAC;QACxB,KAAK,yBAAyB,CAAC;QAC/B,KAAK,UAAU,CAAC;QAChB,KAAK,iBAAiB,CAAC;QACvB,KAAK,mBAAmB,CAAC;QACzB,KAAK,aAAa,CAAC;QACnB,KAAK,iBAAiB;YACpB,OAAO,aAAa,CAAC,KAAK,CAAC;QAE7B,cAAc;QACd;YACE,OAAO,aAAa,CAAC,KAAK,CAAC;KAC9B;AACH,CAAC;AAhDD,gDAgDC","sourcesContent":["import type { Json, JsonRpcRequest } from '@metamask/utils';\nimport { configure } from 'safe-stable-stringify';\n\nconst stringify = configure({ bigint: false, circularValue: Error });\n\n/**\n * The cache strategy to use for a given method.\n */\nexport enum CacheStrategy {\n  /**\n   * Cache per-block.\n   */\n  Block = 'block',\n  /**\n   * Cache until a chain reorganization occurs.\n   */\n  Fork = 'fork',\n  /**\n   * Never cache.\n   */\n  Never = 'never',\n  /**\n   * Permanently cache.\n   */\n  Permanent = 'perma',\n}\n\n/**\n * Return a cache identifier for the given request.\n *\n * This identifier should include any request details that might impact the\n * response, with the exception of the block parameter if the `skipBlockRef`\n * option is set,\n *\n * If the request cannot be cached, this will return `null`.\n *\n * @param request - The JSON-RPC request.\n * @param skipBlockRef - Skip the block parameter when generating the cache\n * identifier.\n * @returns The cache identifier for this request, or `null` if it can't be\n * cached.\n */\nexport function cacheIdentifierForRequest(\n  request: JsonRpcRequest,\n  skipBlockRef?: boolean,\n): string | null {\n  const simpleParams = skipBlockRef\n    ? paramsWithoutBlockTag(request)\n    : (request.params ?? []);\n  if (canCache(request.method)) {\n    return `${request.method}:${stringify(simpleParams)}`;\n  }\n  return null;\n}\n\n/**\n * Return whether a method can be cached or not.\n *\n * @param method - The method to check.\n * @returns Whether the method can be cached.\n */\nexport function canCache(method: string): boolean {\n  return cacheTypeForMethod(method) !== CacheStrategy.Never;\n}\n\n/**\n * Return the block parameter for the given request, if it has one.\n *\n * @param request - The JSON-RPC request.\n * @returns The block parameter in the given request, or `undefined` if none was found.\n */\nexport function blockTagForRequest(request: JsonRpcRequest): Json | undefined {\n  if (!request.params) {\n    return undefined;\n  }\n  const index: number | undefined = blockTagParamIndex(request.method);\n\n  // Block tag param not passed.\n  if (\n    index === undefined ||\n    !Array.isArray(request.params) ||\n    index >= request.params.length\n  ) {\n    return undefined;\n  }\n\n  return request.params[index];\n}\n\n/**\n * Return the request parameters without the block parameter.\n *\n * @param request - The JSON-RPC request.\n * @returns The request parameters with the block parameter removed, if one was found.\n */\nfunction paramsWithoutBlockTag(request: JsonRpcRequest): Json {\n  if (!request.params) {\n    return [];\n  }\n  const index: number | undefined = blockTagParamIndex(request.method);\n\n  // Block tag param not passed.\n  if (\n    index === undefined ||\n    !Array.isArray(request.params) ||\n    index >= request.params.length\n  ) {\n    return request.params;\n  }\n\n  // eth_getBlockByNumber has the block tag first, then the optional includeTx? param\n  if (request.method === 'eth_getBlockByNumber') {\n    return request.params.slice(1);\n  }\n  return request.params.slice(0, index);\n}\n\n/**\n * Returns the index of the block parameter for the given method.\n *\n * @param method - A JSON-RPC method.\n * @returns The index of the block parameter for that method, or `undefined` if\n * there is no known block parameter.\n */\nexport function blockTagParamIndex(method: string): number | undefined {\n  switch (method) {\n    // blockTag is at index 2\n    case 'eth_getStorageAt':\n      return 2;\n    // blockTag is at index 1\n    case 'eth_getBalance':\n    case 'eth_getCode':\n    case 'eth_getTransactionCount':\n    case 'eth_call':\n      return 1;\n    // blockTag is at index 0\n    case 'eth_getBlockByNumber':\n      return 0;\n    // there is no blockTag\n    default:\n      return undefined;\n  }\n}\n\n/**\n * Return the cache type used for the given method.\n *\n * @param method - A JSON-RPC method.\n * @returns The cache type to use for that method.\n */\nexport function cacheTypeForMethod(method: string): CacheStrategy {\n  switch (method) {\n    // cache permanently\n    case 'web3_clientVersion':\n    case 'web3_sha3':\n    case 'eth_protocolVersion':\n    case 'eth_getBlockTransactionCountByHash':\n    case 'eth_getUncleCountByBlockHash':\n    case 'eth_getCode':\n    case 'eth_getBlockByHash':\n    case 'eth_getTransactionByHash':\n    case 'eth_getTransactionByBlockHashAndIndex':\n    case 'eth_getTransactionReceipt':\n    case 'eth_getUncleByBlockHashAndIndex':\n    case 'eth_getCompilers':\n    case 'eth_compileLLL':\n    case 'eth_compileSolidity':\n    case 'eth_compileSerpent':\n    case 'shh_version':\n    case 'test_permaCache':\n      return CacheStrategy.Permanent;\n\n    // cache until fork\n    case 'eth_getBlockByNumber':\n    case 'eth_getBlockTransactionCountByNumber':\n    case 'eth_getUncleCountByBlockNumber':\n    case 'eth_getTransactionByBlockNumberAndIndex':\n    case 'eth_getUncleByBlockNumberAndIndex':\n    case 'test_forkCache':\n      return CacheStrategy.Fork;\n\n    // cache for block\n    case 'eth_gasPrice':\n    case 'eth_blockNumber':\n    case 'eth_getBalance':\n    case 'eth_getStorageAt':\n    case 'eth_getTransactionCount':\n    case 'eth_call':\n    case 'eth_estimateGas':\n    case 'eth_getFilterLogs':\n    case 'eth_getLogs':\n    case 'test_blockCache':\n      return CacheStrategy.Block;\n\n    // never cache\n    default:\n      return CacheStrategy.Never;\n  }\n}\n"]}