@metamask/network-controller 22.2.1 → 23.0.0

package/dist/rpc-service/rpc-service-chain.d.mts

@@ -1,48 +1,24 @@
 import type { Json, JsonRpcParams, JsonRpcRequest, JsonRpcResponse } from "@metamask/utils";
-import type { AbstractRpcService } from "./abstract-rpc-service.mjs";
 import { RpcService } from "./rpc-service.mjs";
+import type { RpcServiceOptions } from "./rpc-service.mjs";
+import type { RpcServiceRequestable } from "./rpc-service-requestable.mjs";
 import type { FetchOptions } from "./shared.mjs";
-/**
- * The subset of options accepted by the RpcServiceChain constructor which
- * represent a single endpoint.
- */
-type RpcServiceConfiguration = {
-    /**
-     * The URL of the endpoint.
-     */
-    endpointUrl: URL | string;
-    /**
-     * The options to pass to `fetch` when making the request to the endpoint.
-     */
-    fetchOptions?: FetchOptions;
-};
 /**
  * This class constructs a chain of RpcService objects which represent a
- * particular network. The first object in the chain is intended to be the primary
- * way of reaching the network and the remaining objects are used as failovers.
+ * particular network. The first object in the chain is intended to be the
+ * primary way of reaching the network and the remaining objects are used as
+ * failovers.
  */
-export declare class RpcServiceChain implements AbstractRpcService {
+export declare class RpcServiceChain implements RpcServiceRequestable {
     #private;
     /**
      * Constructs a new RpcServiceChain object.
      *
-     * @param args - The arguments.
-     * @param args.fetch - A function that can be used to make an HTTP request.
-     * If your JavaScript environment supports `fetch` natively, you'll probably
-     * want to pass that; otherwise you can pass an equivalent (such as `fetch`
-     * via `node-fetch`).
-     * @param args.btoa - A function that can be used to convert a binary string
-     * into base-64. Used to encode authorization credentials.
-     * @param args.serviceConfigurations - The options for the RPC services that
-     * you want to construct. This class takes a set of configuration objects and
-     * not literal `RpcService`s to account for the possibility that we may want
-     * to send request headers to official Infura endpoints and not failovers.
+     * @param rpcServiceConfigurations - The options for the RPC services
+     * that you want to construct. Each object in this array is the same as
+     * {@link RpcServiceOptions}.
      */
-    constructor({ fetch: givenFetch, btoa: givenBtoa, serviceConfigurations, }: {
-        fetch: typeof fetch;
-        btoa: typeof btoa;
-        serviceConfigurations: RpcServiceConfiguration[];
-    });
+    constructor(rpcServiceConfigurations: Omit<RpcServiceOptions, 'failoverService'>[]);
     /**
      * Listens for when any of the RPC services retry a request.
      *
@@ -112,5 +88,4 @@ export declare class RpcServiceChain implements AbstractRpcService {
      */
     request<Params extends JsonRpcParams, Result extends Json>(jsonRpcRequest: JsonRpcRequest<Params>, fetchOptions?: FetchOptions): Promise<JsonRpcResponse<Result>>;
 }
-export {};
 //# sourceMappingURL=rpc-service-chain.d.mts.map

package/dist/rpc-service/rpc-service-chain.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"rpc-service-chain.d.mts","sourceRoot":"","sources":["../../src/rpc-service/rpc-service-chain.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,IAAI,EACJ,aAAa,EACb,cAAc,EACd,eAAe,EAChB,wBAAwB;AAEzB,OAAO,KAAK,EAAE,kBAAkB,EAAE,mCAA+B;AACjE,OAAO,EAAE,UAAU,EAAE,0BAAsB;AAC3C,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAiB;AAE7C;;;GAGG;AACH,KAAK,uBAAuB,GAAG;IAC7B;;OAEG;IACH,WAAW,EAAE,GAAG,GAAG,MAAM,CAAC;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAEF;;;;GAIG;AACH,qBAAa,eAAgB,YAAW,kBAAkB;;IAGxD;;;;;;;;;;;;;;OAcG;gBACS,EACV,KAAK,EAAE,UAAU,EACjB,IAAI,EAAE,SAAS,EACf,qBAAqB,GACtB,EAAE;QACD,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,IAAI,EAAE,OAAO,IAAI,CAAC;QAClB,qBAAqB,EAAE,uBAAuB,EAAE,CAAC;KAClD;IAQD;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;;;IAYtD;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;;;IAYtD;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;;;IAY5D;;;;;;;;;;;;;;;;;OAiBG;IACG,OAAO,CAAC,MAAM,SAAS,aAAa,EAAE,MAAM,SAAS,IAAI,EAC7D,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG;QAAE,MAAM,EAAE,sBAAsB,CAAA;KAAE,EAC3E,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAE3D;;;;;;;;;;;;;;;;;OAiBG;IACG,OAAO,CAAC,MAAM,SAAS,aAAa,EAAE,MAAM,SAAS,IAAI,EAC7D,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,EACtC,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;CA4CpC"}
+{"version":3,"file":"rpc-service-chain.d.mts","sourceRoot":"","sources":["../../src/rpc-service/rpc-service-chain.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,IAAI,EACJ,aAAa,EACb,cAAc,EACd,eAAe,EAChB,wBAAwB;AAEzB,OAAO,EAAE,UAAU,EAAE,0BAAsB;AAC3C,OAAO,KAAK,EAAE,iBAAiB,EAAE,0BAAsB;AACvD,OAAO,KAAK,EAAE,qBAAqB,EAAE,sCAAkC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAiB;AAE7C;;;;;GAKG;AACH,qBAAa,eAAgB,YAAW,qBAAqB;;IAG3D;;;;;;OAMG;gBAED,wBAAwB,EAAE,IAAI,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,EAAE;IAKxE;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;;;IAYtD;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;;;IAYtD;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;;;IAY5D;;;;;;;;;;;;;;;;;OAiBG;IACG,OAAO,CAAC,MAAM,SAAS,aAAa,EAAE,MAAM,SAAS,IAAI,EAC7D,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG;QAAE,MAAM,EAAE,sBAAsB,CAAA;KAAE,EAC3E,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAE3D;;;;;;;;;;;;;;;;;OAiBG;IACG,OAAO,CAAC,MAAM,SAAS,aAAa,EAAE,MAAM,SAAS,IAAI,EAC7D,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,EACtC,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;CAiCpC"}

package/dist/rpc-service/rpc-service-chain.mjs

@@ -13,33 +13,22 @@ var _RpcServiceChain_instances, _RpcServiceChain_services, _RpcServiceChain_buil
 import { RpcService } from "./rpc-service.mjs";
 /**
  * This class constructs a chain of RpcService objects which represent a
- * particular network. The first object in the chain is intended to be the primary
- * way of reaching the network and the remaining objects are used as failovers.
+ * particular network. The first object in the chain is intended to be the
+ * primary way of reaching the network and the remaining objects are used as
+ * failovers.
  */
 export class RpcServiceChain {
     /**
      * Constructs a new RpcServiceChain object.
      *
-     * @param args - The arguments.
-     * @param args.fetch - A function that can be used to make an HTTP request.
-     * If your JavaScript environment supports `fetch` natively, you'll probably
-     * want to pass that; otherwise you can pass an equivalent (such as `fetch`
-     * via `node-fetch`).
-     * @param args.btoa - A function that can be used to convert a binary string
-     * into base-64. Used to encode authorization credentials.
-     * @param args.serviceConfigurations - The options for the RPC services that
-     * you want to construct. This class takes a set of configuration objects and
-     * not literal `RpcService`s to account for the possibility that we may want
-     * to send request headers to official Infura endpoints and not failovers.
+     * @param rpcServiceConfigurations - The options for the RPC services
+     * that you want to construct. Each object in this array is the same as
+     * {@link RpcServiceOptions}.
      */
-    constructor({ fetch: givenFetch, btoa: givenBtoa, serviceConfigurations, }) {
+    constructor(rpcServiceConfigurations) {
         _RpcServiceChain_instances.add(this);
         _RpcServiceChain_services.set(this, void 0);
-        __classPrivateFieldSet(this, _RpcServiceChain_services, __classPrivateFieldGet(this, _RpcServiceChain_instances, "m", _RpcServiceChain_buildRpcServiceChain).call(this, {
-            serviceConfigurations,
-            fetch: givenFetch,
-            btoa: givenBtoa,
-        }), "f");
+        __classPrivateFieldSet(this, _RpcServiceChain_services, __classPrivateFieldGet(this, _RpcServiceChain_instances, "m", _RpcServiceChain_buildRpcServiceChain).call(this, rpcServiceConfigurations), "f");
     }
     /**
      * Listens for when any of the RPC services retry a request.
@@ -88,14 +77,12 @@ export class RpcServiceChain {
         return __classPrivateFieldGet(this, _RpcServiceChain_services, "f")[0].request(jsonRpcRequest, fetchOptions);
     }
 }
-_RpcServiceChain_services = new WeakMap(), _RpcServiceChain_instances = new WeakSet(), _RpcServiceChain_buildRpcServiceChain = function _RpcServiceChain_buildRpcServiceChain({ serviceConfigurations, fetch: givenFetch, btoa: givenBtoa, }) {
-    return [...serviceConfigurations]
+_RpcServiceChain_services = new WeakMap(), _RpcServiceChain_instances = new WeakSet(), _RpcServiceChain_buildRpcServiceChain = function _RpcServiceChain_buildRpcServiceChain(rpcServiceConfigurations) {
+    return [...rpcServiceConfigurations]
         .reverse()
         .reduce((workingServices, serviceConfiguration, index) => {
         const failoverService = index > 0 ? workingServices[0] : undefined;
         const service = new RpcService({
-            fetch: givenFetch,
-            btoa: givenBtoa,
             ...serviceConfiguration,
             failoverService,
         });

package/dist/rpc-service/rpc-service-chain.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"rpc-service-chain.mjs","sourceRoot":"","sources":["../../src/rpc-service/rpc-service-chain.ts"],"names":[],"mappings":";;;;;;;;;;;;AAQA,OAAO,EAAE,UAAU,EAAE,0BAAsB;AAkB3C;;;;GAIG;AACH,MAAM,OAAO,eAAe;IAG1B;;;;;;;;;;;;;;OAcG;IACH,YAAY,EACV,KAAK,EAAE,UAAU,EACjB,IAAI,EAAE,SAAS,EACf,qBAAqB,GAKtB;;QAzBQ,4CAAwB;QA0B/B,uBAAA,IAAI,6BAAa,uBAAA,IAAI,yEAAsB,MAA1B,IAAI,EAAuB;YAC1C,qBAAqB;YACrB,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,SAAS;SAChB,CAAC,MAAA,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,QAA8C;QACpD,MAAM,WAAW,GAAG,uBAAA,IAAI,iCAAU,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACjD,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAC1B,CAAC;QAEF,OAAO;YACL,OAAO;gBACL,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAC5D,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,QAA8C;QACpD,MAAM,WAAW,GAAG,uBAAA,IAAI,iCAAU,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACjD,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAC1B,CAAC;QAEF,OAAO;YACL,OAAO;gBACL,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAC5D,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,QAAiD;QAC1D,MAAM,WAAW,GAAG,uBAAA,IAAI,iCAAU,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACjD,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAC7B,CAAC;QAEF,OAAO;YACL,OAAO;gBACL,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAC5D,CAAC;SACF,CAAC;IACJ,CAAC;IAgDD,KAAK,CAAC,OAAO,CACX,cAAsC,EACtC,eAA6B,EAAE;QAE/B,OAAO,uBAAA,IAAI,iCAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;IACjE,CAAC;CAqCF;8KAtBuB,EACpB,qBAAqB,EACrB,KAAK,EAAE,UAAU,EACjB,IAAI,EAAE,SAAS,GAKhB;IACC,OAAO,CAAC,GAAG,qBAAqB,CAAC;SAC9B,OAAO,EAAE;SACT,MAAM,CAAC,CAAC,eAA6B,EAAE,oBAAoB,EAAE,KAAK,EAAE,EAAE;QACrE,MAAM,eAAe,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACnE,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC;YAC7B,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,SAAS;YACf,GAAG,oBAAoB;YACvB,eAAe;SAChB,CAAC,CAAC;QACH,OAAO,CAAC,OAAO,EAAE,GAAG,eAAe,CAAC,CAAC;IACvC,CAAC,EAAE,EAAE,CAAC,CAAC;AACX,CAAC","sourcesContent":["import type {\n  Json,\n  JsonRpcParams,\n  JsonRpcRequest,\n  JsonRpcResponse,\n} from '@metamask/utils';\n\nimport type { AbstractRpcService } from './abstract-rpc-service';\nimport { RpcService } from './rpc-service';\nimport type { FetchOptions } from './shared';\n\n/**\n * The subset of options accepted by the RpcServiceChain constructor which\n * represent a single endpoint.\n */\ntype RpcServiceConfiguration = {\n  /**\n   * The URL of the endpoint.\n   */\n  endpointUrl: URL | string;\n  /**\n   * The options to pass to `fetch` when making the request to the endpoint.\n   */\n  fetchOptions?: FetchOptions;\n};\n\n/**\n * This class constructs a chain of RpcService objects which represent a\n * particular network. The first object in the chain is intended to be the primary\n * way of reaching the network and the remaining objects are used as failovers.\n */\nexport class RpcServiceChain implements AbstractRpcService {\n  readonly #services: RpcService[];\n\n  /**\n   * Constructs a new RpcServiceChain object.\n   *\n   * @param args - The arguments.\n   * @param args.fetch - A function that can be used to make an HTTP request.\n   * If your JavaScript environment supports `fetch` natively, you'll probably\n   * want to pass that; otherwise you can pass an equivalent (such as `fetch`\n   * via `node-fetch`).\n   * @param args.btoa - A function that can be used to convert a binary string\n   * into base-64. Used to encode authorization credentials.\n   * @param args.serviceConfigurations - The options for the RPC services that\n   * you want to construct. This class takes a set of configuration objects and\n   * not literal `RpcService`s to account for the possibility that we may want\n   * to send request headers to official Infura endpoints and not failovers.\n   */\n  constructor({\n    fetch: givenFetch,\n    btoa: givenBtoa,\n    serviceConfigurations,\n  }: {\n    fetch: typeof fetch;\n    btoa: typeof btoa;\n    serviceConfigurations: RpcServiceConfiguration[];\n  }) {\n    this.#services = this.#buildRpcServiceChain({\n      serviceConfigurations,\n      fetch: givenFetch,\n      btoa: givenBtoa,\n    });\n  }\n\n  /**\n   * Listens for when any of the RPC services retry a request.\n   *\n   * @param listener - The callback to be called when the retry occurs.\n   * @returns What {@link RpcService.onRetry} returns.\n   */\n  onRetry(listener: Parameters<RpcService['onRetry']>[0]) {\n    const disposables = this.#services.map((service) =>\n      service.onRetry(listener),\n    );\n\n    return {\n      dispose() {\n        disposables.forEach((disposable) => disposable.dispose());\n      },\n    };\n  }\n\n  /**\n   * Listens for when any of the RPC services retry the request too many times\n   * in a row.\n   *\n   * @param listener - The callback to be called when the retry occurs.\n   * @returns What {@link RpcService.onBreak} returns.\n   */\n  onBreak(listener: Parameters<RpcService['onBreak']>[0]) {\n    const disposables = this.#services.map((service) =>\n      service.onBreak(listener),\n    );\n\n    return {\n      dispose() {\n        disposables.forEach((disposable) => disposable.dispose());\n      },\n    };\n  }\n\n  /**\n   * Listens for when any of the RPC services send a slow request.\n   *\n   * @param listener - The callback to be called when the retry occurs.\n   * @returns What {@link RpcService.onRetry} returns.\n   */\n  onDegraded(listener: Parameters<RpcService['onDegraded']>[0]) {\n    const disposables = this.#services.map((service) =>\n      service.onDegraded(listener),\n    );\n\n    return {\n      dispose() {\n        disposables.forEach((disposable) => disposable.dispose());\n      },\n    };\n  }\n\n  /**\n   * Makes a request to the first RPC service in the chain. If this service is\n   * down, then the request is forwarded to the next service in the chain, etc.\n   *\n   * This overload is specifically designed for `eth_getBlockByNumber`, which\n   * can return a `result` of `null` despite an expected `Result` being\n   * provided.\n   *\n   * @param jsonRpcRequest - The JSON-RPC request to send to the endpoint.\n   * @param fetchOptions - An options bag for {@link fetch} which further\n   * specifies the request.\n   * @returns The decoded JSON-RPC response from the endpoint.\n   * @throws A \"method not found\" error if the response status is 405.\n   * @throws A rate limiting error if the response HTTP status is 429.\n   * @throws A timeout error if the response HTTP status is 503 or 504.\n   * @throws A generic error if the response HTTP status is not 2xx but also not\n   * 405, 429, 503, or 504.\n   */\n  async request<Params extends JsonRpcParams, Result extends Json>(\n    jsonRpcRequest: JsonRpcRequest<Params> & { method: 'eth_getBlockByNumber' },\n    fetchOptions?: FetchOptions,\n  ): Promise<JsonRpcResponse<Result> | JsonRpcResponse<null>>;\n\n  /**\n   * Makes a request to the first RPC service in the chain. If this service is\n   * down, then the request is forwarded to the next service in the chain, etc.\n   *\n   * This overload is designed for all RPC methods except for\n   * `eth_getBlockByNumber`, which are expected to return a `result` of the\n   * expected `Result`.\n   *\n   * @param jsonRpcRequest - The JSON-RPC request to send to the endpoint.\n   * @param fetchOptions - An options bag for {@link fetch} which further\n   * specifies the request.\n   * @returns The decoded JSON-RPC response from the endpoint.\n   * @throws A \"method not found\" error if the response status is 405.\n   * @throws A rate limiting error if the response HTTP status is 429.\n   * @throws A timeout error if the response HTTP status is 503 or 504.\n   * @throws A generic error if the response HTTP status is not 2xx but also not\n   * 405, 429, 503, or 504.\n   */\n  async request<Params extends JsonRpcParams, Result extends Json>(\n    jsonRpcRequest: JsonRpcRequest<Params>,\n    fetchOptions?: FetchOptions,\n  ): Promise<JsonRpcResponse<Result>>;\n\n  async request<Params extends JsonRpcParams, Result extends Json>(\n    jsonRpcRequest: JsonRpcRequest<Params>,\n    fetchOptions: FetchOptions = {},\n  ): Promise<JsonRpcResponse<Result | null>> {\n    return this.#services[0].request(jsonRpcRequest, fetchOptions);\n  }\n\n  /**\n   * Constructs the chain of RPC services. The second RPC service is\n   * configured as the failover for the first, the third service is\n   * configured as the failover for the second, etc.\n   *\n   * @param args - The arguments.\n   * @param args.serviceConfigurations - The options for the RPC services that\n   * you want to construct.\n   * @param args.fetch - A function that can be used to make an HTTP request.\n   * @param args.btoa - A function that can be used to convert a binary string\n   * into base-64. Used to encode authorization credentials.\n   * @returns The constructed chain of RPC services.\n   */\n  #buildRpcServiceChain({\n    serviceConfigurations,\n    fetch: givenFetch,\n    btoa: givenBtoa,\n  }: {\n    serviceConfigurations: RpcServiceConfiguration[];\n    fetch: typeof fetch;\n    btoa: typeof btoa;\n  }): RpcService[] {\n    return [...serviceConfigurations]\n      .reverse()\n      .reduce((workingServices: RpcService[], serviceConfiguration, index) => {\n        const failoverService = index > 0 ? workingServices[0] : undefined;\n        const service = new RpcService({\n          fetch: givenFetch,\n          btoa: givenBtoa,\n          ...serviceConfiguration,\n          failoverService,\n        });\n        return [service, ...workingServices];\n      }, []);\n  }\n}\n"]}
+{"version":3,"file":"rpc-service-chain.mjs","sourceRoot":"","sources":["../../src/rpc-service/rpc-service-chain.ts"],"names":[],"mappings":";;;;;;;;;;;;AAOA,OAAO,EAAE,UAAU,EAAE,0BAAsB;AAK3C;;;;;GAKG;AACH,MAAM,OAAO,eAAe;IAG1B;;;;;;OAMG;IACH,YACE,wBAAsE;;QAV/D,4CAAwB;QAY/B,uBAAA,IAAI,6BAAa,uBAAA,IAAI,yEAAsB,MAA1B,IAAI,EAAuB,wBAAwB,CAAC,MAAA,CAAC;IACxE,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,QAA8C;QACpD,MAAM,WAAW,GAAG,uBAAA,IAAI,iCAAU,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACjD,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAC1B,CAAC;QAEF,OAAO;YACL,OAAO;gBACL,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAC5D,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,QAA8C;QACpD,MAAM,WAAW,GAAG,uBAAA,IAAI,iCAAU,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACjD,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAC1B,CAAC;QAEF,OAAO;YACL,OAAO;gBACL,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAC5D,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,QAAiD;QAC1D,MAAM,WAAW,GAAG,uBAAA,IAAI,iCAAU,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACjD,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAC7B,CAAC;QAEF,OAAO;YACL,OAAO;gBACL,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAC5D,CAAC;SACF,CAAC;IACJ,CAAC;IAgDD,KAAK,CAAC,OAAO,CACX,cAAsC,EACtC,eAA6B,EAAE;QAE/B,OAAO,uBAAA,IAAI,iCAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;IACjE,CAAC;CA0BF;8KAbG,wBAAsE;IAEtE,OAAO,CAAC,GAAG,wBAAwB,CAAC;SACjC,OAAO,EAAE;SACT,MAAM,CAAC,CAAC,eAA6B,EAAE,oBAAoB,EAAE,KAAK,EAAE,EAAE;QACrE,MAAM,eAAe,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACnE,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC;YAC7B,GAAG,oBAAoB;YACvB,eAAe;SAChB,CAAC,CAAC;QACH,OAAO,CAAC,OAAO,EAAE,GAAG,eAAe,CAAC,CAAC;IACvC,CAAC,EAAE,EAAE,CAAC,CAAC;AACX,CAAC","sourcesContent":["import type {\n  Json,\n  JsonRpcParams,\n  JsonRpcRequest,\n  JsonRpcResponse,\n} from '@metamask/utils';\n\nimport { RpcService } from './rpc-service';\nimport type { RpcServiceOptions } from './rpc-service';\nimport type { RpcServiceRequestable } from './rpc-service-requestable';\nimport type { FetchOptions } from './shared';\n\n/**\n * This class constructs a chain of RpcService objects which represent a\n * particular network. The first object in the chain is intended to be the\n * primary way of reaching the network and the remaining objects are used as\n * failovers.\n */\nexport class RpcServiceChain implements RpcServiceRequestable {\n  readonly #services: RpcService[];\n\n  /**\n   * Constructs a new RpcServiceChain object.\n   *\n   * @param rpcServiceConfigurations - The options for the RPC services\n   * that you want to construct. Each object in this array is the same as\n   * {@link RpcServiceOptions}.\n   */\n  constructor(\n    rpcServiceConfigurations: Omit<RpcServiceOptions, 'failoverService'>[],\n  ) {\n    this.#services = this.#buildRpcServiceChain(rpcServiceConfigurations);\n  }\n\n  /**\n   * Listens for when any of the RPC services retry a request.\n   *\n   * @param listener - The callback to be called when the retry occurs.\n   * @returns What {@link RpcService.onRetry} returns.\n   */\n  onRetry(listener: Parameters<RpcService['onRetry']>[0]) {\n    const disposables = this.#services.map((service) =>\n      service.onRetry(listener),\n    );\n\n    return {\n      dispose() {\n        disposables.forEach((disposable) => disposable.dispose());\n      },\n    };\n  }\n\n  /**\n   * Listens for when any of the RPC services retry the request too many times\n   * in a row.\n   *\n   * @param listener - The callback to be called when the retry occurs.\n   * @returns What {@link RpcService.onBreak} returns.\n   */\n  onBreak(listener: Parameters<RpcService['onBreak']>[0]) {\n    const disposables = this.#services.map((service) =>\n      service.onBreak(listener),\n    );\n\n    return {\n      dispose() {\n        disposables.forEach((disposable) => disposable.dispose());\n      },\n    };\n  }\n\n  /**\n   * Listens for when any of the RPC services send a slow request.\n   *\n   * @param listener - The callback to be called when the retry occurs.\n   * @returns What {@link RpcService.onRetry} returns.\n   */\n  onDegraded(listener: Parameters<RpcService['onDegraded']>[0]) {\n    const disposables = this.#services.map((service) =>\n      service.onDegraded(listener),\n    );\n\n    return {\n      dispose() {\n        disposables.forEach((disposable) => disposable.dispose());\n      },\n    };\n  }\n\n  /**\n   * Makes a request to the first RPC service in the chain. If this service is\n   * down, then the request is forwarded to the next service in the chain, etc.\n   *\n   * This overload is specifically designed for `eth_getBlockByNumber`, which\n   * can return a `result` of `null` despite an expected `Result` being\n   * provided.\n   *\n   * @param jsonRpcRequest - The JSON-RPC request to send to the endpoint.\n   * @param fetchOptions - An options bag for {@link fetch} which further\n   * specifies the request.\n   * @returns The decoded JSON-RPC response from the endpoint.\n   * @throws A \"method not found\" error if the response status is 405.\n   * @throws A rate limiting error if the response HTTP status is 429.\n   * @throws A timeout error if the response HTTP status is 503 or 504.\n   * @throws A generic error if the response HTTP status is not 2xx but also not\n   * 405, 429, 503, or 504.\n   */\n  async request<Params extends JsonRpcParams, Result extends Json>(\n    jsonRpcRequest: JsonRpcRequest<Params> & { method: 'eth_getBlockByNumber' },\n    fetchOptions?: FetchOptions,\n  ): Promise<JsonRpcResponse<Result> | JsonRpcResponse<null>>;\n\n  /**\n   * Makes a request to the first RPC service in the chain. If this service is\n   * down, then the request is forwarded to the next service in the chain, etc.\n   *\n   * This overload is designed for all RPC methods except for\n   * `eth_getBlockByNumber`, which are expected to return a `result` of the\n   * expected `Result`.\n   *\n   * @param jsonRpcRequest - The JSON-RPC request to send to the endpoint.\n   * @param fetchOptions - An options bag for {@link fetch} which further\n   * specifies the request.\n   * @returns The decoded JSON-RPC response from the endpoint.\n   * @throws A \"method not found\" error if the response status is 405.\n   * @throws A rate limiting error if the response HTTP status is 429.\n   * @throws A timeout error if the response HTTP status is 503 or 504.\n   * @throws A generic error if the response HTTP status is not 2xx but also not\n   * 405, 429, 503, or 504.\n   */\n  async request<Params extends JsonRpcParams, Result extends Json>(\n    jsonRpcRequest: JsonRpcRequest<Params>,\n    fetchOptions?: FetchOptions,\n  ): Promise<JsonRpcResponse<Result>>;\n\n  async request<Params extends JsonRpcParams, Result extends Json>(\n    jsonRpcRequest: JsonRpcRequest<Params>,\n    fetchOptions: FetchOptions = {},\n  ): Promise<JsonRpcResponse<Result | null>> {\n    return this.#services[0].request(jsonRpcRequest, fetchOptions);\n  }\n\n  /**\n   * Constructs the chain of RPC services. The second RPC service is\n   * configured as the failover for the first, the third service is\n   * configured as the failover for the second, etc.\n   *\n   * @param rpcServiceConfigurations - The options for the RPC services that\n   * you want to construct. Each object in this array is the same as\n   * {@link RpcServiceOptions}.\n   * @returns The constructed chain of RPC services.\n   */\n  #buildRpcServiceChain(\n    rpcServiceConfigurations: Omit<RpcServiceOptions, 'failoverService'>[],\n  ): RpcService[] {\n    return [...rpcServiceConfigurations]\n      .reverse()\n      .reduce((workingServices: RpcService[], serviceConfiguration, index) => {\n        const failoverService = index > 0 ? workingServices[0] : undefined;\n        const service = new RpcService({\n          ...serviceConfiguration,\n          failoverService,\n        });\n        return [service, ...workingServices];\n      }, []);\n  }\n}\n"]}

package/dist/rpc-service/rpc-service-requestable.cjs

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

package/dist/rpc-service/rpc-service-requestable.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-service-requestable.cjs","sourceRoot":"","sources":["../../src/rpc-service/rpc-service-requestable.ts"],"names":[],"mappings":"","sourcesContent":["import type { ServicePolicy } from '@metamask/controller-utils';\nimport type {\n  Json,\n  JsonRpcParams,\n  JsonRpcRequest,\n  JsonRpcResponse,\n} from '@metamask/utils';\n\nimport type { AddToCockatielEventData, FetchOptions } from './shared';\n\n/**\n * The interface for a service class responsible for making a request to a\n * target, whether that is a single RPC endpoint or an RPC endpoint in an RPC\n * service chain.\n */\nexport type RpcServiceRequestable = {\n  /**\n   * Listens for when the RPC service retries the request.\n   *\n   * @param listener - The callback to be called when the retry occurs.\n   * @returns What {@link ServicePolicy.onRetry} returns.\n   * @see {@link createServicePolicy}\n   */\n  onRetry(\n    listener: AddToCockatielEventData<\n      Parameters<ServicePolicy['onRetry']>[0],\n      { endpointUrl: string }\n    >,\n  ): ReturnType<ServicePolicy['onRetry']>;\n\n  /**\n   * Listens for when the RPC service retries the request too many times in a\n   * row.\n   *\n   * @param listener - The callback to be called when the circuit is broken.\n   * @returns What {@link ServicePolicy.onBreak} returns.\n   * @see {@link createServicePolicy}\n   */\n  onBreak(\n    listener: AddToCockatielEventData<\n      Parameters<ServicePolicy['onBreak']>[0],\n      { endpointUrl: string }\n    >,\n  ): ReturnType<ServicePolicy['onBreak']>;\n\n  /**\n   * Listens for when the policy underlying this RPC service detects a slow\n   * request.\n   *\n   * @param listener - The callback to be called when the request is slow.\n   * @returns What {@link ServicePolicy.onDegraded} returns.\n   * @see {@link createServicePolicy}\n   */\n  onDegraded(\n    listener: AddToCockatielEventData<\n      Parameters<ServicePolicy['onDegraded']>[0],\n      { endpointUrl: string }\n    >,\n  ): ReturnType<ServicePolicy['onDegraded']>;\n\n  /**\n   * Makes a request to the target.\n   */\n  request<Params extends JsonRpcParams, Result extends Json>(\n    jsonRpcRequest: JsonRpcRequest<Params>,\n    fetchOptions?: FetchOptions,\n  ): Promise<JsonRpcResponse<Result | null>>;\n};\n"]}

package/dist/rpc-service/rpc-service-requestable.d.cts

@@ -0,0 +1,47 @@
+import type { ServicePolicy } from "@metamask/controller-utils";
+import type { Json, JsonRpcParams, JsonRpcRequest, JsonRpcResponse } from "@metamask/utils";
+import type { AddToCockatielEventData, FetchOptions } from "./shared.cjs";
+/**
+ * The interface for a service class responsible for making a request to a
+ * target, whether that is a single RPC endpoint or an RPC endpoint in an RPC
+ * service chain.
+ */
+export type RpcServiceRequestable = {
+    /**
+     * Listens for when the RPC service retries the request.
+     *
+     * @param listener - The callback to be called when the retry occurs.
+     * @returns What {@link ServicePolicy.onRetry} returns.
+     * @see {@link createServicePolicy}
+     */
+    onRetry(listener: AddToCockatielEventData<Parameters<ServicePolicy['onRetry']>[0], {
+        endpointUrl: string;
+    }>): ReturnType<ServicePolicy['onRetry']>;
+    /**
+     * Listens for when the RPC service retries the request too many times in a
+     * row.
+     *
+     * @param listener - The callback to be called when the circuit is broken.
+     * @returns What {@link ServicePolicy.onBreak} returns.
+     * @see {@link createServicePolicy}
+     */
+    onBreak(listener: AddToCockatielEventData<Parameters<ServicePolicy['onBreak']>[0], {
+        endpointUrl: string;
+    }>): ReturnType<ServicePolicy['onBreak']>;
+    /**
+     * Listens for when the policy underlying this RPC service detects a slow
+     * request.
+     *
+     * @param listener - The callback to be called when the request is slow.
+     * @returns What {@link ServicePolicy.onDegraded} returns.
+     * @see {@link createServicePolicy}
+     */
+    onDegraded(listener: AddToCockatielEventData<Parameters<ServicePolicy['onDegraded']>[0], {
+        endpointUrl: string;
+    }>): ReturnType<ServicePolicy['onDegraded']>;
+    /**
+     * Makes a request to the target.
+     */
+    request<Params extends JsonRpcParams, Result extends Json>(jsonRpcRequest: JsonRpcRequest<Params>, fetchOptions?: FetchOptions): Promise<JsonRpcResponse<Result | null>>;
+};
+//# sourceMappingURL=rpc-service-requestable.d.cts.map

package/dist/rpc-service/rpc-service-requestable.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-service-requestable.d.cts","sourceRoot":"","sources":["../../src/rpc-service/rpc-service-requestable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,mCAAmC;AAChE,OAAO,KAAK,EACV,IAAI,EACJ,aAAa,EACb,cAAc,EACd,eAAe,EAChB,wBAAwB;AAEzB,OAAO,KAAK,EAAE,uBAAuB,EAAE,YAAY,EAAE,qBAAiB;AAEtE;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;OAMG;IACH,OAAO,CACL,QAAQ,EAAE,uBAAuB,CAC/B,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EACvC;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CACxB,GACA,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,OAAO,CACL,QAAQ,EAAE,uBAAuB,CAC/B,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EACvC;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CACxB,GACA,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,UAAU,CACR,QAAQ,EAAE,uBAAuB,CAC/B,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,EAC1C;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CACxB,GACA,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC;IAE3C;;OAEG;IACH,OAAO,CAAC,MAAM,SAAS,aAAa,EAAE,MAAM,SAAS,IAAI,EACvD,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,EACtC,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC;CAC5C,CAAC"}

package/dist/rpc-service/rpc-service-requestable.d.mts

@@ -0,0 +1,47 @@
+import type { ServicePolicy } from "@metamask/controller-utils";
+import type { Json, JsonRpcParams, JsonRpcRequest, JsonRpcResponse } from "@metamask/utils";
+import type { AddToCockatielEventData, FetchOptions } from "./shared.mjs";
+/**
+ * The interface for a service class responsible for making a request to a
+ * target, whether that is a single RPC endpoint or an RPC endpoint in an RPC
+ * service chain.
+ */
+export type RpcServiceRequestable = {
+    /**
+     * Listens for when the RPC service retries the request.
+     *
+     * @param listener - The callback to be called when the retry occurs.
+     * @returns What {@link ServicePolicy.onRetry} returns.
+     * @see {@link createServicePolicy}
+     */
+    onRetry(listener: AddToCockatielEventData<Parameters<ServicePolicy['onRetry']>[0], {
+        endpointUrl: string;
+    }>): ReturnType<ServicePolicy['onRetry']>;
+    /**
+     * Listens for when the RPC service retries the request too many times in a
+     * row.
+     *
+     * @param listener - The callback to be called when the circuit is broken.
+     * @returns What {@link ServicePolicy.onBreak} returns.
+     * @see {@link createServicePolicy}
+     */
+    onBreak(listener: AddToCockatielEventData<Parameters<ServicePolicy['onBreak']>[0], {
+        endpointUrl: string;
+    }>): ReturnType<ServicePolicy['onBreak']>;
+    /**
+     * Listens for when the policy underlying this RPC service detects a slow
+     * request.
+     *
+     * @param listener - The callback to be called when the request is slow.
+     * @returns What {@link ServicePolicy.onDegraded} returns.
+     * @see {@link createServicePolicy}
+     */
+    onDegraded(listener: AddToCockatielEventData<Parameters<ServicePolicy['onDegraded']>[0], {
+        endpointUrl: string;
+    }>): ReturnType<ServicePolicy['onDegraded']>;
+    /**
+     * Makes a request to the target.
+     */
+    request<Params extends JsonRpcParams, Result extends Json>(jsonRpcRequest: JsonRpcRequest<Params>, fetchOptions?: FetchOptions): Promise<JsonRpcResponse<Result | null>>;
+};
+//# sourceMappingURL=rpc-service-requestable.d.mts.map

package/dist/rpc-service/rpc-service-requestable.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-service-requestable.d.mts","sourceRoot":"","sources":["../../src/rpc-service/rpc-service-requestable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,mCAAmC;AAChE,OAAO,KAAK,EACV,IAAI,EACJ,aAAa,EACb,cAAc,EACd,eAAe,EAChB,wBAAwB;AAEzB,OAAO,KAAK,EAAE,uBAAuB,EAAE,YAAY,EAAE,qBAAiB;AAEtE;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;OAMG;IACH,OAAO,CACL,QAAQ,EAAE,uBAAuB,CAC/B,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EACvC;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CACxB,GACA,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,OAAO,CACL,QAAQ,EAAE,uBAAuB,CAC/B,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EACvC;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CACxB,GACA,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,UAAU,CACR,QAAQ,EAAE,uBAAuB,CAC/B,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,EAC1C;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CACxB,GACA,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC;IAE3C;;OAEG;IACH,OAAO,CAAC,MAAM,SAAS,aAAa,EAAE,MAAM,SAAS,IAAI,EACvD,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,EACtC,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC;CAC5C,CAAC"}

package/dist/rpc-service/rpc-service-requestable.mjs

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

package/dist/rpc-service/rpc-service-requestable.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-service-requestable.mjs","sourceRoot":"","sources":["../../src/rpc-service/rpc-service-requestable.ts"],"names":[],"mappings":"","sourcesContent":["import type { ServicePolicy } from '@metamask/controller-utils';\nimport type {\n  Json,\n  JsonRpcParams,\n  JsonRpcRequest,\n  JsonRpcResponse,\n} from '@metamask/utils';\n\nimport type { AddToCockatielEventData, FetchOptions } from './shared';\n\n/**\n * The interface for a service class responsible for making a request to a\n * target, whether that is a single RPC endpoint or an RPC endpoint in an RPC\n * service chain.\n */\nexport type RpcServiceRequestable = {\n  /**\n   * Listens for when the RPC service retries the request.\n   *\n   * @param listener - The callback to be called when the retry occurs.\n   * @returns What {@link ServicePolicy.onRetry} returns.\n   * @see {@link createServicePolicy}\n   */\n  onRetry(\n    listener: AddToCockatielEventData<\n      Parameters<ServicePolicy['onRetry']>[0],\n      { endpointUrl: string }\n    >,\n  ): ReturnType<ServicePolicy['onRetry']>;\n\n  /**\n   * Listens for when the RPC service retries the request too many times in a\n   * row.\n   *\n   * @param listener - The callback to be called when the circuit is broken.\n   * @returns What {@link ServicePolicy.onBreak} returns.\n   * @see {@link createServicePolicy}\n   */\n  onBreak(\n    listener: AddToCockatielEventData<\n      Parameters<ServicePolicy['onBreak']>[0],\n      { endpointUrl: string }\n    >,\n  ): ReturnType<ServicePolicy['onBreak']>;\n\n  /**\n   * Listens for when the policy underlying this RPC service detects a slow\n   * request.\n   *\n   * @param listener - The callback to be called when the request is slow.\n   * @returns What {@link ServicePolicy.onDegraded} returns.\n   * @see {@link createServicePolicy}\n   */\n  onDegraded(\n    listener: AddToCockatielEventData<\n      Parameters<ServicePolicy['onDegraded']>[0],\n      { endpointUrl: string }\n    >,\n  ): ReturnType<ServicePolicy['onDegraded']>;\n\n  /**\n   * Makes a request to the target.\n   */\n  request<Params extends JsonRpcParams, Result extends Json>(\n    jsonRpcRequest: JsonRpcRequest<Params>,\n    fetchOptions?: FetchOptions,\n  ): Promise<JsonRpcResponse<Result | null>>;\n};\n"]}

package/dist/rpc-service/rpc-service.cjs

@@ -13,29 +13,78 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _RpcService_instances, _RpcService_fetch, _RpcService_endpointUrl, _RpcService_fetchOptions, _RpcService_failoverService, _RpcService_policy, _RpcService_getDefaultFetchOptions, _RpcService_getCompleteFetchOptions, _RpcService_executePolicy;
+var _RpcService_instances, _RpcService_fetch, _RpcService_fetchOptions, _RpcService_failoverService, _RpcService_policy, _RpcService_getDefaultFetchOptions, _RpcService_getCompleteFetchOptions, _RpcService_executePolicy;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RpcService = exports.NETWORK_UNREACHABLE_ERRORS = void 0;
+exports.RpcService = exports.isConnectionError = exports.CONNECTION_ERRORS = exports.DEFAULT_MAX_CONSECUTIVE_FAILURES = exports.DEFAULT_MAX_RETRIES = void 0;
 const controller_utils_1 = require("@metamask/controller-utils");
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const utils_1 = require("@metamask/utils");
 const deepmerge_1 = __importDefault(require("deepmerge"));
 /**
- * The list of error messages that represent a failure to reach the network.
+ * The maximum number of times that a failing service should be re-run before
+ * giving up.
+ */
+exports.DEFAULT_MAX_RETRIES = 4;
+/**
+ * The maximum number of times that the service is allowed to fail before
+ * pausing further retries. This is set to a value such that if given a
+ * service that continually fails, the policy needs to be executed 3 times
+ * before further retries are paused.
+ */
+exports.DEFAULT_MAX_CONSECUTIVE_FAILURES = (1 + exports.DEFAULT_MAX_RETRIES) * 3;
+/**
+ * The list of error messages that represent a failure to connect to the network.
  *
  * This list was derived from Sindre Sorhus's `is-network-error` package:
  * <https://github.com/sindresorhus/is-network-error/blob/7bbfa8be9482ce1427a21fbff60e3ee1650dd091/index.js>
  */
-exports.NETWORK_UNREACHABLE_ERRORS = new Set([
-    'network error',
-    'Failed to fetch',
-    'NetworkError when attempting to fetch resource.',
-    'The Internet connection appears to be offline.',
-    'Load failed',
-    'Network request failed',
-    'fetch failed',
-    'terminated', // Undici (Node.js)
-]);
+exports.CONNECTION_ERRORS = [
+    // Chrome
+    {
+        constructorName: 'TypeError',
+        pattern: /network error/u,
+    },
+    // Chrome
+    {
+        constructorName: 'TypeError',
+        pattern: /Failed to fetch/u,
+    },
+    // Firefox
+    {
+        constructorName: 'TypeError',
+        pattern: /NetworkError when attempting to fetch resource\./u,
+    },
+    // Safari 16
+    {
+        constructorName: 'TypeError',
+        pattern: /The Internet connection appears to be offline\./u,
+    },
+    // Safari 17+
+    {
+        constructorName: 'TypeError',
+        pattern: /Load failed/u,
+    },
+    // `cross-fetch`
+    {
+        constructorName: 'TypeError',
+        pattern: /Network request failed/u,
+    },
+    // `node-fetch`
+    {
+        constructorName: 'FetchError',
+        pattern: /request to (.+) failed/u,
+    },
+    // Undici (Node.js)
+    {
+        constructorName: 'TypeError',
+        pattern: /fetch failed/u,
+    },
+    // Undici (Node.js)
+    {
+        constructorName: 'TypeError',
+        pattern: /terminated/u,
+    },
+];
 /**
  * Determines whether the given error represents a failure to reach the network
  * after request parameters have been validated.
@@ -45,13 +94,34 @@ exports.NETWORK_UNREACHABLE_ERRORS = new Set([
  * particular scenario, and we need to account for this.
  *
  * @param error - The error.
- * @returns True if the error indicates that the network is unreachable, and
- * false otherwise.
+ * @returns True if the error indicates that the network cannot be connected to,
+ * and false otherwise.
  */
-function isNetworkUnreachableError(error) {
-    return (error instanceof TypeError && exports.NETWORK_UNREACHABLE_ERRORS.has(error.message));
+function isConnectionError(error) {
+    if (!(typeof error === 'object' && error !== null && 'message' in error)) {
+        return false;
+    }
+    const { message } = error;
+    return (typeof message === 'string' &&
+        !isNockError(message) &&
+        exports.CONNECTION_ERRORS.some(({ constructorName, pattern }) => {
+            return (error.constructor.name === constructorName && pattern.test(message));
+        }));
+}
+exports.isConnectionError = isConnectionError;
+/**
+ * Determines whether the given error message refers to a Nock error.
+ *
+ * It's important that if we failed to mock a request in a test, the resulting
+ * error does not cause the request to be retried so that we can see it right
+ * away.
+ *
+ * @param message - The error message to test.
+ * @returns True if the message indicates a missing Nock mock, false otherwise.
+ */
+function isNockError(message) {
+    return message.includes('Nock:');
 }
-exports.default = isNetworkUnreachableError;
 /**
  * Guarantees a URL, even given a string. This is useful for checking components
  * of that URL.
@@ -75,31 +145,14 @@ class RpcService {
     /**
      * Constructs a new RpcService object.
      *
-     * @param args - The arguments.
-     * @param args.fetch - A function that can be used to make an HTTP request.
-     * If your JavaScript environment supports `fetch` natively, you'll probably
-     * want to pass that; otherwise you can pass an equivalent (such as `fetch`
-     * via `node-fetch`).
-     * @param args.btoa - A function that can be used to convert a binary string
-     * into base-64. Used to encode authorization credentials.
-     * @param args.endpointUrl - The URL of the RPC endpoint.
-     * @param args.fetchOptions - A common set of options that will be used to
-     * make every request. Can be overridden on the request level (e.g. to add
-     * headers).
-     * @param args.failoverService - An RPC service that represents a failover
-     * endpoint which will be invoked while the circuit for _this_ service is
-     * open.
+     * @param options - The options. See {@link RpcServiceOptions}.
      */
-    constructor({ fetch: givenFetch, btoa: givenBtoa, endpointUrl, fetchOptions = {}, failoverService, }) {
+    constructor(options) {
         _RpcService_instances.add(this);
         /**
          * The function used to make an HTTP request.
          */
         _RpcService_fetch.set(this, void 0);
-        /**
-         * The URL of the RPC endpoint.
-         */
-        _RpcService_endpointUrl.set(this, void 0);
         /**
          * A common set of options that the request options will extend.
          */
@@ -113,17 +166,19 @@ class RpcService {
          * The policy that wraps the request.
          */
         _RpcService_policy.set(this, void 0);
+        const { btoa: givenBtoa, endpointUrl, failoverService, fetch: givenFetch, fetchOptions = {}, policyOptions = {}, } = options;
         __classPrivateFieldSet(this, _RpcService_fetch, givenFetch, "f");
-        __classPrivateFieldSet(this, _RpcService_endpointUrl, getNormalizedEndpointUrl(endpointUrl), "f");
-        __classPrivateFieldSet(this, _RpcService_fetchOptions, __classPrivateFieldGet(this, _RpcService_instances, "m", _RpcService_getDefaultFetchOptions).call(this, __classPrivateFieldGet(this, _RpcService_endpointUrl, "f"), fetchOptions, givenBtoa), "f");
+        this.endpointUrl = getNormalizedEndpointUrl(endpointUrl);
+        __classPrivateFieldSet(this, _RpcService_fetchOptions, __classPrivateFieldGet(this, _RpcService_instances, "m", _RpcService_getDefaultFetchOptions).call(this, this.endpointUrl, fetchOptions, givenBtoa), "f");
         __classPrivateFieldSet(this, _RpcService_failoverService, failoverService, "f");
         const policy = (0, controller_utils_1.createServicePolicy)({
-            maxRetries: 4,
-            maxConsecutiveFailures: 15,
+            maxRetries: exports.DEFAULT_MAX_RETRIES,
+            maxConsecutiveFailures: exports.DEFAULT_MAX_CONSECUTIVE_FAILURES,
+            ...policyOptions,
             retryFilterPolicy: (0, controller_utils_1.handleWhen)((error) => {
                 return (
                 // Ignore errors where the request failed to establish
-                isNetworkUnreachableError(error) ||
+                isConnectionError(error) ||
                     // Ignore server sent HTML error pages or truncated JSON responses
                     error.message.includes('not valid JSON') ||
                     // Ignore server overload errors
@@ -143,7 +198,7 @@ class RpcService {
      */
     onRetry(listener) {
         return __classPrivateFieldGet(this, _RpcService_policy, "f").onRetry((data) => {
-            listener({ ...data, endpointUrl: __classPrivateFieldGet(this, _RpcService_endpointUrl, "f").toString() });
+            listener({ ...data, endpointUrl: this.endpointUrl.toString() });
         });
     }
     /**
@@ -156,7 +211,13 @@ class RpcService {
      */
     onBreak(listener) {
         return __classPrivateFieldGet(this, _RpcService_policy, "f").onBreak((data) => {
-            listener({ ...data, endpointUrl: __classPrivateFieldGet(this, _RpcService_endpointUrl, "f").toString() });
+            listener({
+                ...data,
+                endpointUrl: this.endpointUrl.toString(),
+                failoverEndpointUrl: __classPrivateFieldGet(this, _RpcService_failoverService, "f")
+                    ? __classPrivateFieldGet(this, _RpcService_failoverService, "f").endpointUrl.toString()
+                    : undefined,
+            });
         });
     }
     /**
@@ -169,7 +230,7 @@ class RpcService {
      */
     onDegraded(listener) {
         return __classPrivateFieldGet(this, _RpcService_policy, "f").onDegraded(() => {
-            listener({ endpointUrl: __classPrivateFieldGet(this, _RpcService_endpointUrl, "f").toString() });
+            listener({ endpointUrl: this.endpointUrl.toString() });
         });
     }
     async request(jsonRpcRequest, fetchOptions = {}) {
@@ -187,7 +248,7 @@ class RpcService {
     }
 }
 exports.RpcService = RpcService;
-_RpcService_fetch = new WeakMap(), _RpcService_endpointUrl = new WeakMap(), _RpcService_fetchOptions = new WeakMap(), _RpcService_failoverService = new WeakMap(), _RpcService_policy = new WeakMap(), _RpcService_instances = new WeakSet(), _RpcService_getDefaultFetchOptions = function _RpcService_getDefaultFetchOptions(endpointUrl, fetchOptions, givenBtoa) {
+_RpcService_fetch = new WeakMap(), _RpcService_fetchOptions = new WeakMap(), _RpcService_failoverService = new WeakMap(), _RpcService_policy = new WeakMap(), _RpcService_instances = new WeakSet(), _RpcService_getDefaultFetchOptions = function _RpcService_getDefaultFetchOptions(endpointUrl, fetchOptions, givenBtoa) {
     if (endpointUrl.username && endpointUrl.password) {
         const authString = `${endpointUrl.username}:${endpointUrl.password}`;
         const encodedCredentials = givenBtoa(authString);
@@ -229,7 +290,7 @@ _RpcService_fetch = new WeakMap(), _RpcService_endpointUrl = new WeakMap(), _Rpc
  */
 async function _RpcService_executePolicy(jsonRpcRequest, fetchOptions) {
     return await __classPrivateFieldGet(this, _RpcService_policy, "f").execute(async () => {
-        const response = await __classPrivateFieldGet(this, _RpcService_fetch, "f").call(this, __classPrivateFieldGet(this, _RpcService_endpointUrl, "f"), fetchOptions);
+        const response = await __classPrivateFieldGet(this, _RpcService_fetch, "f").call(this, this.endpointUrl, fetchOptions);
         if (response.status === 405) {
             throw rpc_errors_1.rpcErrors.methodNotFound();
         }