@metamask/network-controller 22.1.1 → 22.2.0

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

@@ -0,0 +1,134 @@
+import type { ServicePolicy } from "@metamask/controller-utils";
+import type { JsonRpcRequest } from "@metamask/utils";
+import { type Json, type JsonRpcParams, type JsonRpcResponse } from "@metamask/utils";
+import type { AbstractRpcService } from "./abstract-rpc-service.cjs";
+import type { AddToCockatielEventData, FetchOptions } from "./shared.cjs";
+/**
+ * The list of error messages that represent a failure to reach 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>
+ */
+export declare const NETWORK_UNREACHABLE_ERRORS: Set<string>;
+/**
+ * Determines whether the given error represents a failure to reach the network
+ * after request parameters have been validated.
+ *
+ * This is somewhat difficult to verify because JavaScript engines (and in
+ * some cases libraries) produce slightly different error messages for this
+ * 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.
+ */
+export default function isNetworkUnreachableError(error: unknown): boolean;
+/**
+ * This class is responsible for making a request to an endpoint that implements
+ * the JSON-RPC protocol. It is designed to gracefully handle network and server
+ * failures, retrying requests using exponential backoff. It also offers a hook
+ * which can used to respond to slow requests.
+ */
+export declare class RpcService implements AbstractRpcService {
+    #private;
+    /**
+     * 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.
+     */
+    constructor({ fetch: givenFetch, btoa: givenBtoa, endpointUrl, fetchOptions, failoverService, }: {
+        fetch: typeof fetch;
+        btoa: typeof btoa;
+        endpointUrl: URL | string;
+        fetchOptions?: FetchOptions;
+        failoverService?: AbstractRpcService;
+    });
+    /**
+     * 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;
+    }>): import("cockatiel").IDisposable;
+    /**
+     * 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;
+    }>): import("cockatiel").IDisposable;
+    /**
+     * 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;
+    }>): import("cockatiel").IDisposable;
+    /**
+     * Makes a request to the RPC endpoint. If the circuit is open because this
+     * request has failed too many times, the request is forwarded to a failover
+     * service (if provided).
+     *
+     * This overload is specifically designed for `eth_getBlockByNumber`, which
+     * can return a `result` of `null` despite an expected `Result` being
+     * provided.
+     *
+     * @param jsonRpcRequest - The JSON-RPC request to send to the endpoint.
+     * @param fetchOptions - An options bag for {@link fetch} which further
+     * specifies the request.
+     * @returns The decoded JSON-RPC response from the endpoint.
+     * @throws A "method not found" error if the response status is 405.
+     * @throws A rate limiting error if the response HTTP status is 429.
+     * @throws A timeout error if the response HTTP status is 503 or 504.
+     * @throws A generic error if the response HTTP status is not 2xx but also not
+     * 405, 429, 503, or 504.
+     */
+    request<Params extends JsonRpcParams, Result extends Json>(jsonRpcRequest: JsonRpcRequest<Params> & {
+        method: 'eth_getBlockByNumber';
+    }, fetchOptions?: FetchOptions): Promise<JsonRpcResponse<Result> | JsonRpcResponse<null>>;
+    /**
+     * Makes a request to the RPC endpoint. If the circuit is open because this
+     * request has failed too many times, the request is forwarded to a failover
+     * service (if provided).
+     *
+     * This overload is designed for all RPC methods except for
+     * `eth_getBlockByNumber`, which are expected to return a `result` of the
+     * expected `Result`.
+     *
+     * @param jsonRpcRequest - The JSON-RPC request to send to the endpoint.
+     * @param fetchOptions - An options bag for {@link fetch} which further
+     * specifies the request.
+     * @returns The decoded JSON-RPC response from the endpoint.
+     * @throws A "method not found" error if the response status is 405.
+     * @throws A rate limiting error if the response HTTP status is 429.
+     * @throws A timeout error if the response HTTP status is 503 or 504.
+     * @throws A generic error if the response HTTP status is not 2xx but also not
+     * 405, 429, 503, or 504.
+     */
+    request<Params extends JsonRpcParams, Result extends Json>(jsonRpcRequest: JsonRpcRequest<Params>, fetchOptions?: FetchOptions): Promise<JsonRpcResponse<Result>>;
+}
+//# sourceMappingURL=rpc-service.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-service.d.cts","sourceRoot":"","sources":["../../src/rpc-service/rpc-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,mCAAmC;AAOhE,OAAO,KAAK,EAAE,cAAc,EAAE,wBAAwB;AACtD,OAAO,EAEL,KAAK,IAAI,EACT,KAAK,aAAa,EAClB,KAAK,eAAe,EACrB,wBAAwB;AAGzB,OAAO,KAAK,EAAE,kBAAkB,EAAE,mCAA+B;AACjE,OAAO,KAAK,EAAE,uBAAuB,EAAE,YAAY,EAAE,qBAAiB;AAEtE;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,aASrC,CAAC;AAEH;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,KAAK,EAAE,OAAO,WAI/D;AAgBD;;;;;GAKG;AACH,qBAAa,UAAW,YAAW,kBAAkB;;IA2BnD;;;;;;;;;;;;;;;;;OAiBG;gBACS,EACV,KAAK,EAAE,UAAU,EACjB,IAAI,EAAE,SAAS,EACf,WAAW,EACX,YAAiB,EACjB,eAAe,GAChB,EAAE;QACD,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,IAAI,EAAE,OAAO,IAAI,CAAC;QAClB,WAAW,EAAE,GAAG,GAAG,MAAM,CAAC;QAC1B,YAAY,CAAC,EAAE,YAAY,CAAC;QAC5B,eAAe,CAAC,EAAE,kBAAkB,CAAC;KACtC;IA6BD;;;;;;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;IAOH;;;;;;;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;IAOH;;;;;;;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;IAOH;;;;;;;;;;;;;;;;;;OAkBG;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;;;;;;;;;;;;;;;;;;OAkBG;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;CA0KpC"}

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

@@ -0,0 +1,134 @@
+import type { ServicePolicy } from "@metamask/controller-utils";
+import type { JsonRpcRequest } from "@metamask/utils";
+import { type Json, type JsonRpcParams, type JsonRpcResponse } from "@metamask/utils";
+import type { AbstractRpcService } from "./abstract-rpc-service.mjs";
+import type { AddToCockatielEventData, FetchOptions } from "./shared.mjs";
+/**
+ * The list of error messages that represent a failure to reach 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>
+ */
+export declare const NETWORK_UNREACHABLE_ERRORS: Set<string>;
+/**
+ * Determines whether the given error represents a failure to reach the network
+ * after request parameters have been validated.
+ *
+ * This is somewhat difficult to verify because JavaScript engines (and in
+ * some cases libraries) produce slightly different error messages for this
+ * 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.
+ */
+export default function isNetworkUnreachableError(error: unknown): boolean;
+/**
+ * This class is responsible for making a request to an endpoint that implements
+ * the JSON-RPC protocol. It is designed to gracefully handle network and server
+ * failures, retrying requests using exponential backoff. It also offers a hook
+ * which can used to respond to slow requests.
+ */
+export declare class RpcService implements AbstractRpcService {
+    #private;
+    /**
+     * 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.
+     */
+    constructor({ fetch: givenFetch, btoa: givenBtoa, endpointUrl, fetchOptions, failoverService, }: {
+        fetch: typeof fetch;
+        btoa: typeof btoa;
+        endpointUrl: URL | string;
+        fetchOptions?: FetchOptions;
+        failoverService?: AbstractRpcService;
+    });
+    /**
+     * 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;
+    }>): import("cockatiel").IDisposable;
+    /**
+     * 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;
+    }>): import("cockatiel").IDisposable;
+    /**
+     * 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;
+    }>): import("cockatiel").IDisposable;
+    /**
+     * Makes a request to the RPC endpoint. If the circuit is open because this
+     * request has failed too many times, the request is forwarded to a failover
+     * service (if provided).
+     *
+     * This overload is specifically designed for `eth_getBlockByNumber`, which
+     * can return a `result` of `null` despite an expected `Result` being
+     * provided.
+     *
+     * @param jsonRpcRequest - The JSON-RPC request to send to the endpoint.
+     * @param fetchOptions - An options bag for {@link fetch} which further
+     * specifies the request.
+     * @returns The decoded JSON-RPC response from the endpoint.
+     * @throws A "method not found" error if the response status is 405.
+     * @throws A rate limiting error if the response HTTP status is 429.
+     * @throws A timeout error if the response HTTP status is 503 or 504.
+     * @throws A generic error if the response HTTP status is not 2xx but also not
+     * 405, 429, 503, or 504.
+     */
+    request<Params extends JsonRpcParams, Result extends Json>(jsonRpcRequest: JsonRpcRequest<Params> & {
+        method: 'eth_getBlockByNumber';
+    }, fetchOptions?: FetchOptions): Promise<JsonRpcResponse<Result> | JsonRpcResponse<null>>;
+    /**
+     * Makes a request to the RPC endpoint. If the circuit is open because this
+     * request has failed too many times, the request is forwarded to a failover
+     * service (if provided).
+     *
+     * This overload is designed for all RPC methods except for
+     * `eth_getBlockByNumber`, which are expected to return a `result` of the
+     * expected `Result`.
+     *
+     * @param jsonRpcRequest - The JSON-RPC request to send to the endpoint.
+     * @param fetchOptions - An options bag for {@link fetch} which further
+     * specifies the request.
+     * @returns The decoded JSON-RPC response from the endpoint.
+     * @throws A "method not found" error if the response status is 405.
+     * @throws A rate limiting error if the response HTTP status is 429.
+     * @throws A timeout error if the response HTTP status is 503 or 504.
+     * @throws A generic error if the response HTTP status is not 2xx but also not
+     * 405, 429, 503, or 504.
+     */
+    request<Params extends JsonRpcParams, Result extends Json>(jsonRpcRequest: JsonRpcRequest<Params>, fetchOptions?: FetchOptions): Promise<JsonRpcResponse<Result>>;
+}
+//# sourceMappingURL=rpc-service.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-service.d.mts","sourceRoot":"","sources":["../../src/rpc-service/rpc-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,mCAAmC;AAOhE,OAAO,KAAK,EAAE,cAAc,EAAE,wBAAwB;AACtD,OAAO,EAEL,KAAK,IAAI,EACT,KAAK,aAAa,EAClB,KAAK,eAAe,EACrB,wBAAwB;AAGzB,OAAO,KAAK,EAAE,kBAAkB,EAAE,mCAA+B;AACjE,OAAO,KAAK,EAAE,uBAAuB,EAAE,YAAY,EAAE,qBAAiB;AAEtE;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,aASrC,CAAC;AAEH;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,KAAK,EAAE,OAAO,WAI/D;AAgBD;;;;;GAKG;AACH,qBAAa,UAAW,YAAW,kBAAkB;;IA2BnD;;;;;;;;;;;;;;;;;OAiBG;gBACS,EACV,KAAK,EAAE,UAAU,EACjB,IAAI,EAAE,SAAS,EACf,WAAW,EACX,YAAiB,EACjB,eAAe,GAChB,EAAE;QACD,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,IAAI,EAAE,OAAO,IAAI,CAAC;QAClB,WAAW,EAAE,GAAG,GAAG,MAAM,CAAC;QAC1B,YAAY,CAAC,EAAE,YAAY,CAAC;QAC5B,eAAe,CAAC,EAAE,kBAAkB,CAAC;KACtC;IA6BD;;;;;;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;IAOH;;;;;;;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;IAOH;;;;;;;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;IAOH;;;;;;;;;;;;;;;;;;OAkBG;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;;;;;;;;;;;;;;;;;;OAkBG;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;CA0KpC"}

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

@@ -0,0 +1,278 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _RpcService_instances, _RpcService_fetch, _RpcService_endpointUrl, _RpcService_fetchOptions, _RpcService_failoverService, _RpcService_policy, _RpcService_getDefaultFetchOptions, _RpcService_getCompleteFetchOptions, _RpcService_executePolicy;
+function $importDefault(module) {
+    if (module?.__esModule) {
+        return module.default;
+    }
+    return module;
+}
+import { CircuitState, createServicePolicy, handleWhen } from "@metamask/controller-utils";
+import { rpcErrors } from "@metamask/rpc-errors";
+import { hasProperty } from "@metamask/utils";
+import $deepmerge from "deepmerge";
+const deepmerge = $importDefault($deepmerge);
+/**
+ * The list of error messages that represent a failure to reach 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>
+ */
+export const 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)
+]);
+/**
+ * Determines whether the given error represents a failure to reach the network
+ * after request parameters have been validated.
+ *
+ * This is somewhat difficult to verify because JavaScript engines (and in
+ * some cases libraries) produce slightly different error messages for this
+ * 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.
+ */
+export default function isNetworkUnreachableError(error) {
+    return (error instanceof TypeError && NETWORK_UNREACHABLE_ERRORS.has(error.message));
+}
+/**
+ * Guarantees a URL, even given a string. This is useful for checking components
+ * of that URL.
+ *
+ * @param endpointUrlOrUrlString - Either a URL object or a string that
+ * represents the URL of an endpoint.
+ * @returns A URL object.
+ */
+function getNormalizedEndpointUrl(endpointUrlOrUrlString) {
+    return endpointUrlOrUrlString instanceof URL
+        ? endpointUrlOrUrlString
+        : new URL(endpointUrlOrUrlString);
+}
+/**
+ * This class is responsible for making a request to an endpoint that implements
+ * the JSON-RPC protocol. It is designed to gracefully handle network and server
+ * failures, retrying requests using exponential backoff. It also offers a hook
+ * which can used to respond to slow requests.
+ */
+export 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.
+     */
+    constructor({ fetch: givenFetch, btoa: givenBtoa, endpointUrl, fetchOptions = {}, failoverService, }) {
+        _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.
+         */
+        _RpcService_fetchOptions.set(this, void 0);
+        /**
+         * An RPC service that represents a failover endpoint which will be invoked
+         * while the circuit for _this_ service is open.
+         */
+        _RpcService_failoverService.set(this, void 0);
+        /**
+         * The policy that wraps the request.
+         */
+        _RpcService_policy.set(this, void 0);
+        __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");
+        __classPrivateFieldSet(this, _RpcService_failoverService, failoverService, "f");
+        const policy = createServicePolicy({
+            maxRetries: 4,
+            maxConsecutiveFailures: 15,
+            retryFilterPolicy: handleWhen((error) => {
+                return (
+                // Ignore errors where the request failed to establish
+                isNetworkUnreachableError(error) ||
+                    // Ignore server sent HTML error pages or truncated JSON responses
+                    error.message.includes('not valid JSON') ||
+                    // Ignore server overload errors
+                    error.message.includes('Gateway timeout') ||
+                    (hasProperty(error, 'code') &&
+                        (error.code === 'ETIMEDOUT' || error.code === 'ECONNRESET')));
+            }),
+        });
+        __classPrivateFieldSet(this, _RpcService_policy, policy, "f");
+    }
+    /**
+     * 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) {
+        return __classPrivateFieldGet(this, _RpcService_policy, "f").onRetry((data) => {
+            listener({ ...data, endpointUrl: __classPrivateFieldGet(this, _RpcService_endpointUrl, "f").toString() });
+        });
+    }
+    /**
+     * 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) {
+        return __classPrivateFieldGet(this, _RpcService_policy, "f").onBreak((data) => {
+            listener({ ...data, endpointUrl: __classPrivateFieldGet(this, _RpcService_endpointUrl, "f").toString() });
+        });
+    }
+    /**
+     * 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) {
+        return __classPrivateFieldGet(this, _RpcService_policy, "f").onDegraded(() => {
+            listener({ endpointUrl: __classPrivateFieldGet(this, _RpcService_endpointUrl, "f").toString() });
+        });
+    }
+    async request(jsonRpcRequest, fetchOptions = {}) {
+        const completeFetchOptions = __classPrivateFieldGet(this, _RpcService_instances, "m", _RpcService_getCompleteFetchOptions).call(this, jsonRpcRequest, fetchOptions);
+        try {
+            return await __classPrivateFieldGet(this, _RpcService_instances, "m", _RpcService_executePolicy).call(this, jsonRpcRequest, completeFetchOptions);
+        }
+        catch (error) {
+            if (__classPrivateFieldGet(this, _RpcService_policy, "f").circuitBreakerPolicy.state === CircuitState.Open &&
+                __classPrivateFieldGet(this, _RpcService_failoverService, "f") !== undefined) {
+                return await __classPrivateFieldGet(this, _RpcService_failoverService, "f").request(jsonRpcRequest, completeFetchOptions);
+            }
+            throw error;
+        }
+    }
+}
+_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) {
+    if (endpointUrl.username && endpointUrl.password) {
+        const authString = `${endpointUrl.username}:${endpointUrl.password}`;
+        const encodedCredentials = givenBtoa(authString);
+        return deepmerge(fetchOptions, {
+            headers: { Authorization: `Basic ${encodedCredentials}` },
+        });
+    }
+    return fetchOptions;
+}, _RpcService_getCompleteFetchOptions = function _RpcService_getCompleteFetchOptions(jsonRpcRequest, fetchOptions) {
+    const defaultOptions = {
+        method: 'POST',
+        headers: {
+            Accept: 'application/json',
+            'Content-Type': 'application/json',
+        },
+    };
+    const mergedOptions = deepmerge(defaultOptions, deepmerge(__classPrivateFieldGet(this, _RpcService_fetchOptions, "f"), fetchOptions));
+    const { id, jsonrpc, method, params } = jsonRpcRequest;
+    const body = JSON.stringify({
+        id,
+        jsonrpc,
+        method,
+        params,
+    });
+    return { ...mergedOptions, body };
+}, _RpcService_executePolicy = 
+/**
+ * Makes the request using the Cockatiel policy that this service creates.
+ *
+ * @param jsonRpcRequest - The JSON-RPC request to send to the endpoint.
+ * @param fetchOptions - The options for `fetch`; will be combined with the
+ * fetch options passed to the constructor
+ * @returns The decoded JSON-RPC response from the endpoint.
+ * @throws A "method not found" error if the response status is 405.
+ * @throws A rate limiting error if the response HTTP status is 429.
+ * @throws A timeout error if the response HTTP status is 503 or 504.
+ * @throws A generic error if the response HTTP status is not 2xx but also not
+ * 405, 429, 503, or 504.
+ */
+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);
+        if (response.status === 405) {
+            throw rpcErrors.methodNotFound();
+        }
+        if (response.status === 429) {
+            throw rpcErrors.internal({ message: 'Request is being rate limited.' });
+        }
+        if (response.status === 503 || response.status === 504) {
+            throw rpcErrors.internal({
+                message: 'Gateway timeout. The request took too long to process. This can happen when querying logs over too wide a block range.',
+            });
+        }
+        const text = await response.text();
+        if (jsonRpcRequest.method === 'eth_getBlockByNumber' &&
+            text === 'Not Found') {
+            return {
+                id: jsonRpcRequest.id,
+                jsonrpc: jsonRpcRequest.jsonrpc,
+                result: null,
+            };
+        }
+        // Type annotation: We assume that if this response is valid JSON, it's a
+        // valid JSON-RPC response.
+        let json;
+        try {
+            json = JSON.parse(text);
+        }
+        catch (error) {
+            if (error instanceof SyntaxError) {
+                throw rpcErrors.internal({
+                    message: 'Could not parse response as it is not valid JSON',
+                    data: text,
+                });
+            }
+            else {
+                throw error;
+            }
+        }
+        if (!response.ok) {
+            throw rpcErrors.internal({
+                message: `Non-200 status code: '${response.status}'`,
+                data: json,
+            });
+        }
+        return json;
+    });
+};
+//# sourceMappingURL=rpc-service.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-service.mjs","sourceRoot":"","sources":["../../src/rpc-service/rpc-service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AACA,OAAO,EACL,YAAY,EACZ,mBAAmB,EACnB,UAAU,EACX,mCAAmC;AACpC,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAEjD,OAAO,EACL,WAAW,EAIZ,wBAAwB;AACzB,OAAO,UAAS,kBAAkB;;AAKlC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,IAAI,GAAG,CAAC;IAChD,eAAe;IACf,iBAAiB;IACjB,iDAAiD;IACjD,gDAAgD;IAChD,aAAa;IACb,wBAAwB;IACxB,cAAc;IACd,YAAY,EAAE,mBAAmB;CAClC,CAAC,CAAC;AAEH;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,KAAc;IAC9D,OAAO,CACL,KAAK,YAAY,SAAS,IAAI,0BAA0B,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAC5E,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,wBAAwB,CAAC,sBAAoC;IACpE,OAAO,sBAAsB,YAAY,GAAG;QAC1C,CAAC,CAAC,sBAAsB;QACxB,CAAC,CAAC,IAAI,GAAG,CAAC,sBAAsB,CAAC,CAAC;AACtC,CAAC;AAED;;;;;GAKG;AACH,MAAM,OAAO,UAAU;IA2BrB;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,EACV,KAAK,EAAE,UAAU,EACjB,IAAI,EAAE,SAAS,EACf,WAAW,EACX,YAAY,GAAG,EAAE,EACjB,eAAe,GAOhB;;QAxDD;;WAEG;QACM,oCAAqB;QAE9B;;WAEG;QACM,0CAAkB;QAE3B;;WAEG;QACM,2CAA4B;QAErC;;;WAGG;QACM,8CAAiD;QAE1D;;WAEG;QACM,qCAAuB;QAiC9B,uBAAA,IAAI,qBAAU,UAAU,MAAA,CAAC;QACzB,uBAAA,IAAI,2BAAgB,wBAAwB,CAAC,WAAW,CAAC,MAAA,CAAC;QAC1D,uBAAA,IAAI,4BAAiB,uBAAA,IAAI,iEAAwB,MAA5B,IAAI,EACvB,uBAAA,IAAI,+BAAa,EACjB,YAAY,EACZ,SAAS,CACV,MAAA,CAAC;QACF,uBAAA,IAAI,+BAAoB,eAAe,MAAA,CAAC;QAExC,MAAM,MAAM,GAAG,mBAAmB,CAAC;YACjC,UAAU,EAAE,CAAC;YACb,sBAAsB,EAAE,EAAE;YAC1B,iBAAiB,EAAE,UAAU,CAAC,CAAC,KAAK,EAAE,EAAE;gBACtC,OAAO;gBACL,sDAAsD;gBACtD,yBAAyB,CAAC,KAAK,CAAC;oBAChC,kEAAkE;oBAClE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC;oBACxC,gCAAgC;oBAChC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC;oBACzC,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC;wBACzB,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAC/D,CAAC;YACJ,CAAC,CAAC;SACH,CAAC,CAAC;QACH,uBAAA,IAAI,sBAAW,MAAM,MAAA,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CACL,QAGC;QAED,OAAO,uBAAA,IAAI,0BAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACnC,QAAQ,CAAC,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,uBAAA,IAAI,+BAAa,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CACL,QAGC;QAED,OAAO,uBAAA,IAAI,0BAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACnC,QAAQ,CAAC,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,uBAAA,IAAI,+BAAa,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CACR,QAGC;QAED,OAAO,uBAAA,IAAI,0BAAQ,CAAC,UAAU,CAAC,GAAG,EAAE;YAClC,QAAQ,CAAC,EAAE,WAAW,EAAE,uBAAA,IAAI,+BAAa,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC;IAkDD,KAAK,CAAC,OAAO,CACX,cAAsC,EACtC,eAA6B,EAAE;QAE/B,MAAM,oBAAoB,GAAG,uBAAA,IAAI,kEAAyB,MAA7B,IAAI,EAC/B,cAAc,EACd,YAAY,CACb,CAAC;QAEF,IAAI;YACF,OAAO,MAAM,uBAAA,IAAI,wDAAe,MAAnB,IAAI,EACf,cAAc,EACd,oBAAoB,CACrB,CAAC;SACH;QAAC,OAAO,KAAK,EAAE;YACd,IACE,uBAAA,IAAI,0BAAQ,CAAC,oBAAoB,CAAC,KAAK,KAAK,YAAY,CAAC,IAAI;gBAC7D,uBAAA,IAAI,mCAAiB,KAAK,SAAS,EACnC;gBACA,OAAO,MAAM,uBAAA,IAAI,mCAAiB,CAAC,OAAO,CACxC,cAAc,EACd,oBAAoB,CACrB,CAAC;aACH;YACD,MAAM,KAAK,CAAC;SACb;IACH,CAAC;CA8IF;+TAhIG,WAAgB,EAChB,YAA0B,EAC1B,SAA6C;IAE7C,IAAI,WAAW,CAAC,QAAQ,IAAI,WAAW,CAAC,QAAQ,EAAE;QAChD,MAAM,UAAU,GAAG,GAAG,WAAW,CAAC,QAAQ,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC;QACrE,MAAM,kBAAkB,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;QACjD,OAAO,SAAS,CAAC,YAAY,EAAE;YAC7B,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,kBAAkB,EAAE,EAAE;SAC1D,CAAC,CAAC;KACJ;IAED,OAAO,YAAY,CAAC;AACtB,CAAC,qFAWC,cAAsC,EACtC,YAA0B;IAE1B,MAAM,cAAc,GAAG;QACrB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;SACnC;KACF,CAAC;IACF,MAAM,aAAa,GAAG,SAAS,CAC7B,cAAc,EACd,SAAS,CAAC,uBAAA,IAAI,gCAAc,EAAE,YAAY,CAAC,CAC5C,CAAC;IAEF,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC;IACvD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;QAC1B,EAAE;QACF,OAAO;QACP,MAAM;QACN,MAAM;KACP,CAAC,CAAC;IAEH,OAAO,EAAE,GAAG,aAAa,EAAE,IAAI,EAAE,CAAC;AACpC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,KAAK,oCAKH,cAAuB,EACvB,YAA0B;IAE1B,OAAO,MAAM,uBAAA,IAAI,0BAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;QAC3C,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,yBAAO,MAAX,IAAI,EAAQ,uBAAA,IAAI,+BAAa,EAAE,YAAY,CAAC,CAAC;QAEpE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC3B,MAAM,SAAS,CAAC,cAAc,EAAE,CAAC;SAClC;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC3B,MAAM,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,gCAAgC,EAAE,CAAC,CAAC;SACzE;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YACtD,MAAM,SAAS,CAAC,QAAQ,CAAC;gBACvB,OAAO,EACL,wHAAwH;aAC3H,CAAC,CAAC;SACJ;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEnC,IACE,cAAc,CAAC,MAAM,KAAK,sBAAsB;YAChD,IAAI,KAAK,WAAW,EACpB;YACA,OAAO;gBACL,EAAE,EAAE,cAAc,CAAC,EAAE;gBACrB,OAAO,EAAE,cAAc,CAAC,OAAO;gBAC/B,MAAM,EAAE,IAAI;aACb,CAAC;SACH;QAED,yEAAyE;QACzE,2BAA2B;QAC3B,IAAI,IAA6B,CAAC;QAClC,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SACzB;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,KAAK,YAAY,WAAW,EAAE;gBAChC,MAAM,SAAS,CAAC,QAAQ,CAAC;oBACvB,OAAO,EAAE,kDAAkD;oBAC3D,IAAI,EAAE,IAAI;iBACX,CAAC,CAAC;aACJ;iBAAM;gBACL,MAAM,KAAK,CAAC;aACb;SACF;QAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,SAAS,CAAC,QAAQ,CAAC;gBACvB,OAAO,EAAE,yBAAyB,QAAQ,CAAC,MAAM,GAAG;gBACpD,IAAI,EAAE,IAAI;aACX,CAAC,CAAC;SACJ;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type { ServicePolicy } from '@metamask/controller-utils';\nimport {\n  CircuitState,\n  createServicePolicy,\n  handleWhen,\n} from '@metamask/controller-utils';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { JsonRpcRequest } from '@metamask/utils';\nimport {\n  hasProperty,\n  type Json,\n  type JsonRpcParams,\n  type JsonRpcResponse,\n} from '@metamask/utils';\nimport deepmerge from 'deepmerge';\n\nimport type { AbstractRpcService } from './abstract-rpc-service';\nimport type { AddToCockatielEventData, FetchOptions } from './shared';\n\n/**\n * The list of error messages that represent a failure to reach the network.\n *\n * This list was derived from Sindre Sorhus's `is-network-error` package:\n * <https://github.com/sindresorhus/is-network-error/blob/7bbfa8be9482ce1427a21fbff60e3ee1650dd091/index.js>\n */\nexport const NETWORK_UNREACHABLE_ERRORS = new Set([\n  'network error', // Chrome\n  'Failed to fetch', // Chrome\n  'NetworkError when attempting to fetch resource.', // Firefox\n  'The Internet connection appears to be offline.', // Safari 16\n  'Load failed', // Safari 17+\n  'Network request failed', // `cross-fetch`\n  'fetch failed', // Undici (Node.js)\n  'terminated', // Undici (Node.js)\n]);\n\n/**\n * Determines whether the given error represents a failure to reach the network\n * after request parameters have been validated.\n *\n * This is somewhat difficult to verify because JavaScript engines (and in\n * some cases libraries) produce slightly different error messages for this\n * particular scenario, and we need to account for this.\n *\n * @param error - The error.\n * @returns True if the error indicates that the network is unreachable, and\n * false otherwise.\n */\nexport default function isNetworkUnreachableError(error: unknown) {\n  return (\n    error instanceof TypeError && NETWORK_UNREACHABLE_ERRORS.has(error.message)\n  );\n}\n\n/**\n * Guarantees a URL, even given a string. This is useful for checking components\n * of that URL.\n *\n * @param endpointUrlOrUrlString - Either a URL object or a string that\n * represents the URL of an endpoint.\n * @returns A URL object.\n */\nfunction getNormalizedEndpointUrl(endpointUrlOrUrlString: URL | string): URL {\n  return endpointUrlOrUrlString instanceof URL\n    ? endpointUrlOrUrlString\n    : new URL(endpointUrlOrUrlString);\n}\n\n/**\n * This class is responsible for making a request to an endpoint that implements\n * the JSON-RPC protocol. It is designed to gracefully handle network and server\n * failures, retrying requests using exponential backoff. It also offers a hook\n * which can used to respond to slow requests.\n */\nexport class RpcService implements AbstractRpcService {\n  /**\n   * The function used to make an HTTP request.\n   */\n  readonly #fetch: typeof fetch;\n\n  /**\n   * The URL of the RPC endpoint.\n   */\n  readonly #endpointUrl: URL;\n\n  /**\n   * A common set of options that the request options will extend.\n   */\n  readonly #fetchOptions: FetchOptions;\n\n  /**\n   * An RPC service that represents a failover endpoint which will be invoked\n   * while the circuit for _this_ service is open.\n   */\n  readonly #failoverService: AbstractRpcService | undefined;\n\n  /**\n   * The policy that wraps the request.\n   */\n  readonly #policy: ServicePolicy;\n\n  /**\n   * Constructs a new RpcService 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.endpointUrl - The URL of the RPC endpoint.\n   * @param args.fetchOptions - A common set of options that will be used to\n   * make every request. Can be overridden on the request level (e.g. to add\n   * headers).\n   * @param args.failoverService - An RPC service that represents a failover\n   * endpoint which will be invoked while the circuit for _this_ service is\n   * open.\n   */\n  constructor({\n    fetch: givenFetch,\n    btoa: givenBtoa,\n    endpointUrl,\n    fetchOptions = {},\n    failoverService,\n  }: {\n    fetch: typeof fetch;\n    btoa: typeof btoa;\n    endpointUrl: URL | string;\n    fetchOptions?: FetchOptions;\n    failoverService?: AbstractRpcService;\n  }) {\n    this.#fetch = givenFetch;\n    this.#endpointUrl = getNormalizedEndpointUrl(endpointUrl);\n    this.#fetchOptions = this.#getDefaultFetchOptions(\n      this.#endpointUrl,\n      fetchOptions,\n      givenBtoa,\n    );\n    this.#failoverService = failoverService;\n\n    const policy = createServicePolicy({\n      maxRetries: 4,\n      maxConsecutiveFailures: 15,\n      retryFilterPolicy: handleWhen((error) => {\n        return (\n          // Ignore errors where the request failed to establish\n          isNetworkUnreachableError(error) ||\n          // Ignore server sent HTML error pages or truncated JSON responses\n          error.message.includes('not valid JSON') ||\n          // Ignore server overload errors\n          error.message.includes('Gateway timeout') ||\n          (hasProperty(error, 'code') &&\n            (error.code === 'ETIMEDOUT' || error.code === 'ECONNRESET'))\n        );\n      }),\n    });\n    this.#policy = policy;\n  }\n\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  ) {\n    return this.#policy.onRetry((data) => {\n      listener({ ...data, endpointUrl: this.#endpointUrl.toString() });\n    });\n  }\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  ) {\n    return this.#policy.onBreak((data) => {\n      listener({ ...data, endpointUrl: this.#endpointUrl.toString() });\n    });\n  }\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  ) {\n    return this.#policy.onDegraded(() => {\n      listener({ endpointUrl: this.#endpointUrl.toString() });\n    });\n  }\n\n  /**\n   * Makes a request to the RPC endpoint. If the circuit is open because this\n   * request has failed too many times, the request is forwarded to a failover\n   * service (if provided).\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 RPC endpoint. If the circuit is open because this\n   * request has failed too many times, the request is forwarded to a failover\n   * service (if provided).\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    const completeFetchOptions = this.#getCompleteFetchOptions(\n      jsonRpcRequest,\n      fetchOptions,\n    );\n\n    try {\n      return await this.#executePolicy<Params, Result>(\n        jsonRpcRequest,\n        completeFetchOptions,\n      );\n    } catch (error) {\n      if (\n        this.#policy.circuitBreakerPolicy.state === CircuitState.Open &&\n        this.#failoverService !== undefined\n      ) {\n        return await this.#failoverService.request(\n          jsonRpcRequest,\n          completeFetchOptions,\n        );\n      }\n      throw error;\n    }\n  }\n\n  /**\n   * Constructs a default set of options to `fetch`.\n   *\n   * If a username and password are present in the URL, they are extracted to an\n   * Authorization header.\n   *\n   * @param endpointUrl - The endpoint URL.\n   * @param fetchOptions - The options to `fetch`.\n   * @param givenBtoa - An implementation of `btoa`.\n   * @returns The default fetch options.\n   */\n  #getDefaultFetchOptions(\n    endpointUrl: URL,\n    fetchOptions: FetchOptions,\n    givenBtoa: (stringToEncode: string) => string,\n  ): FetchOptions {\n    if (endpointUrl.username && endpointUrl.password) {\n      const authString = `${endpointUrl.username}:${endpointUrl.password}`;\n      const encodedCredentials = givenBtoa(authString);\n      return deepmerge(fetchOptions, {\n        headers: { Authorization: `Basic ${encodedCredentials}` },\n      });\n    }\n\n    return fetchOptions;\n  }\n\n  /**\n   * Constructs a final set of options to pass to `fetch`. Note that the method\n   * defaults to `post`, and the JSON-RPC request is automatically JSON-encoded.\n   *\n   * @param jsonRpcRequest - The JSON-RPC request.\n   * @param fetchOptions - Custom `fetch` options.\n   * @returns The complete set of `fetch` options.\n   */\n  #getCompleteFetchOptions<Params extends JsonRpcParams>(\n    jsonRpcRequest: JsonRpcRequest<Params>,\n    fetchOptions: FetchOptions,\n  ): FetchOptions {\n    const defaultOptions = {\n      method: 'POST',\n      headers: {\n        Accept: 'application/json',\n        'Content-Type': 'application/json',\n      },\n    };\n    const mergedOptions = deepmerge(\n      defaultOptions,\n      deepmerge(this.#fetchOptions, fetchOptions),\n    );\n\n    const { id, jsonrpc, method, params } = jsonRpcRequest;\n    const body = JSON.stringify({\n      id,\n      jsonrpc,\n      method,\n      params,\n    });\n\n    return { ...mergedOptions, body };\n  }\n\n  /**\n   * Makes the request using the Cockatiel policy that this service creates.\n   *\n   * @param jsonRpcRequest - The JSON-RPC request to send to the endpoint.\n   * @param fetchOptions - The options for `fetch`; will be combined with the\n   * fetch options passed to the constructor\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 #executePolicy<\n    Params extends JsonRpcParams,\n    Result extends Json,\n    Request extends JsonRpcRequest = JsonRpcRequest<Params>,\n  >(\n    jsonRpcRequest: Request,\n    fetchOptions: FetchOptions,\n  ): Promise<JsonRpcResponse<Result> | JsonRpcResponse<null>> {\n    return await this.#policy.execute(async () => {\n      const response = await this.#fetch(this.#endpointUrl, fetchOptions);\n\n      if (response.status === 405) {\n        throw rpcErrors.methodNotFound();\n      }\n\n      if (response.status === 429) {\n        throw rpcErrors.internal({ message: 'Request is being rate limited.' });\n      }\n\n      if (response.status === 503 || response.status === 504) {\n        throw rpcErrors.internal({\n          message:\n            'Gateway timeout. The request took too long to process. This can happen when querying logs over too wide a block range.',\n        });\n      }\n\n      const text = await response.text();\n\n      if (\n        jsonRpcRequest.method === 'eth_getBlockByNumber' &&\n        text === 'Not Found'\n      ) {\n        return {\n          id: jsonRpcRequest.id,\n          jsonrpc: jsonRpcRequest.jsonrpc,\n          result: null,\n        };\n      }\n\n      // Type annotation: We assume that if this response is valid JSON, it's a\n      // valid JSON-RPC response.\n      let json: JsonRpcResponse<Result>;\n      try {\n        json = JSON.parse(text);\n      } catch (error) {\n        if (error instanceof SyntaxError) {\n          throw rpcErrors.internal({\n            message: 'Could not parse response as it is not valid JSON',\n            data: text,\n          });\n        } else {\n          throw error;\n        }\n      }\n\n      if (!response.ok) {\n        throw rpcErrors.internal({\n          message: `Non-200 status code: '${response.status}'`,\n          data: json,\n        });\n      }\n\n      return json;\n    });\n  }\n}\n"]}

package/dist/rpc-service/shared.cjs

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"shared.cjs","sourceRoot":"","sources":["../../src/rpc-service/shared.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Equivalent to the built-in `FetchOptions` type, but renamed for clarity.\n */\nexport type FetchOptions = RequestInit;\n\n/**\n * Extends an event listener that Cockatiel uses so that when it is called, more\n * data can be supplied in the event object.\n */\nexport type AddToCockatielEventData<EventListener, AdditionalData> =\n  EventListener extends (data: infer Data) => void\n    ? // Prevent Data from being split if it's a type union\n      [Data] extends [void]\n      ? (data: AdditionalData) => void\n      : (data: Data & AdditionalData) => void\n    : never;\n"]}

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

@@ -0,0 +1,12 @@
+/**
+ * Equivalent to the built-in `FetchOptions` type, but renamed for clarity.
+ */
+export type FetchOptions = RequestInit;
+/**
+ * Extends an event listener that Cockatiel uses so that when it is called, more
+ * data can be supplied in the event object.
+ */
+export type AddToCockatielEventData<EventListener, AdditionalData> = EventListener extends (data: infer Data) => void ? [
+    Data
+] extends [void] ? (data: AdditionalData) => void : (data: Data & AdditionalData) => void : never;
+//# sourceMappingURL=shared.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.cts","sourceRoot":"","sources":["../../src/rpc-service/shared.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,CAAC;AAEvC;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CAAC,aAAa,EAAE,cAAc,IAC/D,aAAa,SAAS,CAAC,IAAI,EAAE,MAAM,IAAI,KAAK,IAAI,GAE5C;IAAC,IAAI;CAAC,SAAS,CAAC,IAAI,CAAC,GACnB,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GAC9B,CAAC,IAAI,EAAE,IAAI,GAAG,cAAc,KAAK,IAAI,GACvC,KAAK,CAAC"}

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

@@ -0,0 +1,12 @@
+/**
+ * Equivalent to the built-in `FetchOptions` type, but renamed for clarity.
+ */
+export type FetchOptions = RequestInit;
+/**
+ * Extends an event listener that Cockatiel uses so that when it is called, more
+ * data can be supplied in the event object.
+ */
+export type AddToCockatielEventData<EventListener, AdditionalData> = EventListener extends (data: infer Data) => void ? [
+    Data
+] extends [void] ? (data: AdditionalData) => void : (data: Data & AdditionalData) => void : never;
+//# sourceMappingURL=shared.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.mts","sourceRoot":"","sources":["../../src/rpc-service/shared.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,CAAC;AAEvC;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CAAC,aAAa,EAAE,cAAc,IAC/D,aAAa,SAAS,CAAC,IAAI,EAAE,MAAM,IAAI,KAAK,IAAI,GAE5C;IAAC,IAAI;CAAC,SAAS,CAAC,IAAI,CAAC,GACnB,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GAC9B,CAAC,IAAI,EAAE,IAAI,GAAG,cAAc,KAAK,IAAI,GACvC,KAAK,CAAC"}

package/dist/rpc-service/shared.mjs

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