@metamask-previews/network-controller 36.0.0-preview-8bfa290fb → 37.0.0-preview-0a30e47

package/dist/create-network-client.cjs

@@ -1,439 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createNetworkClient = exports.classifyRetryReason = void 0;
-const connectivity_controller_1 = require("@metamask/connectivity-controller");
-const controller_utils_1 = require("@metamask/controller-utils");
-const eth_block_tracker_1 = require("@metamask/eth-block-tracker");
-const eth_json_rpc_infura_1 = require("@metamask/eth-json-rpc-infura");
-const eth_json_rpc_middleware_1 = require("@metamask/eth-json-rpc-middleware");
-const eth_json_rpc_provider_1 = require("@metamask/eth-json-rpc-provider");
-const eth_json_rpc_provider_2 = require("@metamask/eth-json-rpc-provider");
-const json_rpc_engine_1 = require("@metamask/json-rpc-engine");
-const v2_1 = require("@metamask/json-rpc-engine/v2");
-const utils_1 = require("@metamask/utils");
-const rpc_service_chain_js_1 = require("./rpc-service/rpc-service-chain.cjs");
-const rpc_service_js_1 = require("./rpc-service/rpc-service.cjs");
-const types_js_1 = require("./types.cjs");
-const SECOND = 1000;
-/**
- * Classifies the error that was being retried when retries were exhausted.
- *
- * @param error - The error from the last retry attempt.
- * @returns A classification string.
- */
-function classifyRetryReason(error) {
-    if (!(error instanceof Error)) {
-        return 'unknown';
-    }
-    if ((0, rpc_service_js_1.isConnectionError)(error)) {
-        return 'connection_failed';
-    }
-    if ((0, rpc_service_js_1.isJsonParseError)(error)) {
-        return 'response_not_json';
-    }
-    if ((0, rpc_service_js_1.isHttpServerError)(error)) {
-        return 'non_successful_http_status';
-    }
-    if ((0, rpc_service_js_1.isTimeoutError)(error)) {
-        return 'timed_out';
-    }
-    if ((0, rpc_service_js_1.isConnectionResetError)(error)) {
-        return 'connection_reset';
-    }
-    return 'unknown';
-}
-exports.classifyRetryReason = classifyRetryReason;
-/**
- * Create a JSON RPC network client for a specific network.
- *
- * @param args - The arguments.
- * @param args.id - The ID that will be assigned to the new network client in
- * the registry.
- * @param args.configuration - The network configuration.
- * @param args.getRpcServiceOptions - Factory for constructing RPC service
- * options. See {@link NetworkControllerOptions.getRpcServiceOptions}.
- * @param args.getBlockTrackerOptions - Factory for constructing block tracker
- * options. See {@link NetworkControllerOptions.getBlockTrackerOptions}.
- * @param args.messenger - The network controller messenger.
- * @param args.rpcFailoverMode - The RPC failover mode to apply: `disabled`
- * (failover off), `enabled` (divert to the configured failover URLs when the
- * primary endpoint is unavailable), or `forced` (Infura endpoints that have
- * failover URLs route all traffic to those URLs, bypassing Infura entirely).
- * @param args.logger - A `loglevel` logger.
- * @returns The network client.
- */
-function createNetworkClient({ id, configuration, getRpcServiceOptions, getBlockTrackerOptions, messenger, rpcFailoverMode, logger, }) {
-    const primaryEndpointUrl = configuration.type === types_js_1.NetworkClientType.Infura
-        ? `https://${configuration.network}.infura.io/v3/${configuration.infuraProjectId}`
-        : configuration.rpcUrl;
-    const rpcServiceChain = createRpcServiceChain({
-        id,
-        primaryEndpointUrl,
-        configuration,
-        getRpcServiceOptions,
-        messenger,
-        rpcFailoverMode,
-        logger,
-    });
-    let rpcApiMiddleware;
-    if (configuration.type === types_js_1.NetworkClientType.Infura) {
-        rpcApiMiddleware = (0, json_rpc_engine_1.asV2Middleware)((0, eth_json_rpc_infura_1.createInfuraMiddleware)({
-            rpcService: rpcServiceChain,
-            options: {
-                source: 'metamask',
-            },
-        }));
-    }
-    else {
-        rpcApiMiddleware = (0, eth_json_rpc_middleware_1.createFetchMiddleware)({ rpcService: rpcServiceChain });
-    }
-    const rpcProvider = (0, eth_json_rpc_provider_2.providerFromMiddlewareV2)(rpcApiMiddleware);
-    const blockTracker = createBlockTracker({
-        networkClientType: configuration.type,
-        endpointUrl: primaryEndpointUrl,
-        getOptions: getBlockTrackerOptions,
-        provider: rpcProvider,
-    });
-    const networkMiddleware = configuration.type === types_js_1.NetworkClientType.Infura
-        ? createInfuraNetworkMiddleware({
-            blockTracker,
-            chainId: configuration.chainId,
-            rpcProvider,
-            rpcApiMiddleware,
-        })
-        : createCustomNetworkMiddleware({
-            blockTracker,
-            chainId: configuration.chainId,
-            rpcApiMiddleware,
-        });
-    const provider = new eth_json_rpc_provider_1.InternalProvider({
-        engine: v2_1.JsonRpcEngineV2.create({
-            middleware: [networkMiddleware],
-        }),
-    });
-    const destroy = () => {
-        // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-        // eslint-disable-next-line @typescript-eslint/no-floating-promises
-        blockTracker.destroy();
-    };
-    return { configuration, provider, blockTracker, destroy };
-}
-exports.createNetworkClient = createNetworkClient;
-/**
- * Determines the ordered list of endpoints that make up the RPC service chain
- * for a network, honoring the RPC failover flags.
- *
- * @param args - The arguments.
- * @param args.primaryEndpointUrl - The primary endpoint URL for the network.
- * @param args.failoverRpcUrls - The configured failover URLs, if any.
- * @param args.rpcFailoverMode - The RPC failover mode to apply: `disabled`,
- * `enabled` (divert to the failover URLs when the primary is unavailable), or
- * `forced` (route all traffic for Infura endpoints with failover URLs to those
- * URLs, bypassing Infura).
- * @returns The endpoints to use, each flagged as primary or failover.
- */
-function getAvailableEndpoints({ primaryEndpointUrl, failoverRpcUrls, rpcFailoverMode, }) {
-    const failoverEndpoints = (failoverRpcUrls ?? []).map((url) => ({
-        url,
-        isFailover: true,
-    }));
-    // We explicitly check the URL since some networks have been added with invalid configuration types in the past.
-    const isInfura = new URL(primaryEndpointUrl).hostname.endsWith('.infura.io');
-    if (rpcFailoverMode === 'forced' &&
-        isInfura &&
-        failoverEndpoints.length > 0) {
-        // Forced mode for an Infura endpoint with failovers: bypass Infura entirely
-        // and route all traffic (including block polling) to failovers. The first
-        // failover becomes the positional primary of the chain, so
-        // availability/degraded events will report that failover URL as the primary
-        // endpoint (there is no Infura primary in this mode).
-        return failoverEndpoints;
-    }
-    if (rpcFailoverMode === 'enabled' && isInfura) {
-        return [
-            { url: primaryEndpointUrl, isFailover: false },
-            ...failoverEndpoints,
-        ];
-    }
-    return [{ url: primaryEndpointUrl, isFailover: false }];
-}
-/**
- * Creates an RPC service chain, which represents the primary endpoint URL for
- * the network as well as its failover URLs.
- *
- * @param args - The arguments.
- * @param args.id - The ID that will be assigned to the new network client in
- * the registry.
- * @param args.primaryEndpointUrl - The primary endpoint URL.
- * @param args.configuration - The network configuration.
- * @param args.getRpcServiceOptions - Factory for constructing RPC service
- * options. See {@link NetworkControllerOptions.getRpcServiceOptions}.
- * @param args.messenger - The network controller messenger.
- * @param args.rpcFailoverMode - The RPC failover mode to apply: `disabled`
- * (failover off), `enabled` (divert to the configured failover URLs when the
- * primary endpoint is unavailable), or `forced` (Infura endpoints that have
- * failover URLs route all traffic to those URLs, bypassing Infura entirely).
- * @param args.logger - A `loglevel` logger.
- * @returns The RPC service chain.
- */
-function createRpcServiceChain({ id, primaryEndpointUrl, configuration, getRpcServiceOptions, messenger, rpcFailoverMode, logger, }) {
-    const availableEndpoints = getAvailableEndpoints({
-        primaryEndpointUrl,
-        failoverRpcUrls: configuration.failoverRpcUrls,
-        rpcFailoverMode,
-    });
-    const isOffline = () => {
-        const connectivityState = messenger.call('ConnectivityController:getState');
-        return (connectivityState.connectivityStatus === connectivity_controller_1.CONNECTIVITY_STATUSES.Offline);
-    };
-    // Ensure that if the endpoint continually responds with errors, we
-    // break the circuit relatively fast (but not prematurely).
-    //
-    // Note that the circuit will break much faster if the errors are
-    // retriable (e.g. 503) than if not (e.g. 500), so we attempt to strike
-    // a balance here.
-    const maxConsecutiveFailures = controller_utils_1.DEFAULT_MAX_CONSECUTIVE_FAILURES;
-    // The number of rounds of retries that will break the circuit,
-    // triggering a "cooldown".
-    //
-    // When we fail over to QuickNode, we expect it to be down at first
-    // while it is being automatically activated, and we don't want to
-    // activate the "cooldown" accidentally.
-    const maxConsecutiveFailuresFailover = (controller_utils_1.DEFAULT_MAX_RETRIES + 1) * 10;
-    const rpcServiceConfigurations = availableEndpoints.map((endpoint) => {
-        const overriddenOptions = getRpcServiceOptions?.(endpoint.url) ?? {};
-        return {
-            fetch: globalThis.fetch.bind(globalThis),
-            btoa: globalThis.btoa.bind(globalThis),
-            isOffline,
-            policyOptions: {
-                maxRetries: controller_utils_1.DEFAULT_MAX_RETRIES,
-                circuitBreakDuration: (0, utils_1.inMilliseconds)(30, utils_1.Duration.Second),
-                maxConsecutiveFailures: endpoint.isFailover
-                    ? maxConsecutiveFailuresFailover
-                    : maxConsecutiveFailures,
-                ...(overriddenOptions.policyOptions ?? {}),
-            },
-            ...overriddenOptions,
-            endpointUrl: endpoint.url,
-            logger,
-        };
-    });
-    /**
-     * Extracts the error from Cockatiel's `FailureReason` type received in
-     * circuit breaker event handlers.
-     *
-     * The `FailureReason` object can have two possible shapes:
-     * - `{ error: Error }` - When the RPC service throws an error (the common
-     * case for RPC failures).
-     * - `{ value: T }` - When the RPC service returns a value that the retry
-     * filter policy considers a failure.
-     *
-     * @param value - The event data object from the circuit breaker event
-     * listener (after destructuring known properties like `endpointUrl`). This
-     * represents Cockatiel's `FailureReason` type.
-     * @returns The error or failure value, or `undefined` if neither property
-     * exists (which shouldn't happen in practice unless the circuit breaker is
-     * manually isolated).
-     */
-    const getError = (value) => {
-        if ('error' in value) {
-            return value.error;
-        }
-        else if ('value' in value) {
-            return value.value;
-        }
-        return undefined;
-    };
-    const rpcServiceChain = new rpc_service_chain_js_1.RpcServiceChain([
-        rpcServiceConfigurations[0],
-        ...rpcServiceConfigurations.slice(1),
-    ]);
-    rpcServiceChain.onBreak((data) => {
-        const error = getError(data);
-        if (error === undefined) {
-            // This error shouldn't happen in practice because we never call `.isolate`
-            // on the circuit breaker policy, but we need to appease TypeScript.
-            throw new Error('Could not make request to endpoint.');
-        }
-        messenger.publish('NetworkController:rpcEndpointChainUnavailable', {
-            chainId: configuration.chainId,
-            networkClientId: id,
-            error,
-        });
-    });
-    rpcServiceChain.onServiceBreak(({ endpointUrl, primaryEndpointUrl: primaryEndpointUrlFromEvent, ...rest }) => {
-        const error = getError(rest);
-        if (error === undefined) {
-            // This error shouldn't happen in practice because we never call `.isolate`
-            // on the circuit breaker policy, but we need to appease TypeScript.
-            throw new Error('Could not make request to endpoint.');
-        }
-        messenger.publish('NetworkController:rpcEndpointUnavailable', {
-            chainId: configuration.chainId,
-            networkClientId: id,
-            primaryEndpointUrl: primaryEndpointUrlFromEvent,
-            endpointUrl,
-            error,
-        });
-    });
-    rpcServiceChain.onDegraded(({ rpcMethodName, duration, traceId, ...rest }) => {
-        const error = getError(rest);
-        const type = error === undefined ? 'slow_success' : 'retries_exhausted';
-        messenger.publish('NetworkController:rpcEndpointChainDegraded', {
-            chainId: configuration.chainId,
-            networkClientId: id,
-            error,
-            rpcMethodName,
-            duration,
-            traceId,
-            type,
-            retryReason: error === undefined ? undefined : classifyRetryReason(error),
-        });
-    });
-    rpcServiceChain.onServiceDegraded(({ endpointUrl, primaryEndpointUrl: primaryEndpointUrlFromEvent, rpcMethodName, duration, traceId, ...rest }) => {
-        const error = getError(rest);
-        const type = error === undefined ? 'slow_success' : 'retries_exhausted';
-        messenger.publish('NetworkController:rpcEndpointDegraded', {
-            chainId: configuration.chainId,
-            networkClientId: id,
-            primaryEndpointUrl: primaryEndpointUrlFromEvent,
-            endpointUrl,
-            error,
-            rpcMethodName,
-            duration,
-            traceId,
-            type,
-            retryReason: error === undefined ? undefined : classifyRetryReason(error),
-        });
-    });
-    rpcServiceChain.onAvailable(() => {
-        messenger.publish('NetworkController:rpcEndpointChainAvailable', {
-            chainId: configuration.chainId,
-            networkClientId: id,
-        });
-    });
-    rpcServiceChain.onServiceRetry(({ attempt, endpointUrl, primaryEndpointUrl: primaryEndpointUrlFromEvent, }) => {
-        messenger.publish('NetworkController:rpcEndpointRetried', {
-            chainId: configuration.chainId,
-            networkClientId: id,
-            primaryEndpointUrl: primaryEndpointUrlFromEvent,
-            endpointUrl,
-            attempt,
-        });
-    });
-    return rpcServiceChain;
-}
-/**
- * Create the block tracker for the network.
- *
- * @param args - The arguments.
- * @param args.networkClientType - The type of the network client ("infura" or
- * "custom").
- * @param args.endpointUrl - The URL of the endpoint.
- * @param args.getOptions - Factory for the block tracker options.
- * @param args.provider - The EIP-1193 provider for the network's JSON-RPC
- * middleware stack.
- * @returns The created block tracker.
- */
-function createBlockTracker({ networkClientType, endpointUrl, getOptions, provider, }) {
-    const defaultOptions = {
-        pollingInterval: 
-        // Needed for testing.
-        // eslint-disable-next-line no-restricted-globals
-        process.env.IN_TEST && networkClientType === types_js_1.NetworkClientType.Custom
-            ? (0, utils_1.inMilliseconds)(1, utils_1.Duration.Second)
-            : (0, utils_1.inMilliseconds)(20, utils_1.Duration.Second),
-        retryTimeout: (0, utils_1.inMilliseconds)(20, utils_1.Duration.Second),
-    };
-    return new eth_block_tracker_1.PollingBlockTracker({
-        ...defaultOptions,
-        ...getOptions(endpointUrl),
-        provider,
-    });
-}
-/**
- * Create middleware for infura.
- *
- * @param args - The arguments.
- * @param args.blockTracker - The block tracker to use.
- * @param args.chainId - The chain id to use.
- * @param args.rpcProvider - The RPC provider to use.
- * @param args.rpcApiMiddleware - Additional middleware.
- * @returns The collection of middleware that makes up the Infura client.
- */
-function createInfuraNetworkMiddleware({ blockTracker, chainId, rpcProvider, rpcApiMiddleware, }) {
-    return v2_1.JsonRpcEngineV2.create({
-        middleware: [
-            createNetworkAndChainIdMiddleware({ chainId }),
-            (0, eth_json_rpc_middleware_1.createBlockCacheMiddleware)({ blockTracker }),
-            (0, eth_json_rpc_middleware_1.createInflightCacheMiddleware)(),
-            (0, eth_json_rpc_middleware_1.createBlockRefMiddleware)({ blockTracker, provider: rpcProvider }),
-            (0, eth_json_rpc_middleware_1.createRetryOnEmptyMiddleware)({ blockTracker, provider: rpcProvider }),
-            (0, eth_json_rpc_middleware_1.createBlockTrackerInspectorMiddleware)({ blockTracker }),
-            rpcApiMiddleware,
-        ],
-    }).asMiddleware();
-}
-/**
- * Creates static method middleware.
- *
- * @param args - The Arguments.
- * @param args.chainId - The chain id to use.
- * @returns The middleware that implements the eth_chainId method.
- */
-function createNetworkAndChainIdMiddleware({ chainId, }) {
-    return (0, v2_1.createScaffoldMiddleware)({
-        eth_chainId: chainId,
-    });
-}
-const createChainIdMiddleware = (chainId) => {
-    return ({ request, next }) => {
-        if (request.method === 'eth_chainId') {
-            return chainId;
-        }
-        return next();
-    };
-};
-/**
- * Creates custom middleware.
- *
- * @param args - The arguments.
- * @param args.blockTracker - The block tracker to use.
- * @param args.chainId - The chain id to use.
- * @param args.rpcApiMiddleware - Additional middleware.
- * @returns The collection of middleware that makes up the Infura client.
- */
-function createCustomNetworkMiddleware({ blockTracker, chainId, rpcApiMiddleware, }) {
-    // Needed for testing.
-    // eslint-disable-next-line no-restricted-globals
-    const testMiddlewares = process.env.IN_TEST
-        ? [createEstimateGasDelayTestMiddleware()]
-        : [];
-    return v2_1.JsonRpcEngineV2.create({
-        middleware: [
-            ...testMiddlewares,
-            createChainIdMiddleware(chainId),
-            (0, eth_json_rpc_middleware_1.createBlockRefRewriteMiddleware)({ blockTracker }),
-            (0, eth_json_rpc_middleware_1.createBlockCacheMiddleware)({ blockTracker }),
-            (0, eth_json_rpc_middleware_1.createInflightCacheMiddleware)(),
-            (0, eth_json_rpc_middleware_1.createBlockTrackerInspectorMiddleware)({ blockTracker }),
-            rpcApiMiddleware,
-        ],
-    }).asMiddleware();
-}
-/**
- * For use in tests only.
- * Adds a delay to `eth_estimateGas` calls.
- *
- * @returns The middleware for delaying gas estimation calls by 2 seconds when in test.
- */
-function createEstimateGasDelayTestMiddleware() {
-    return async ({ request, next }) => {
-        if (request.method === 'eth_estimateGas') {
-            await new Promise((resolve) => setTimeout(resolve, SECOND * 2));
-        }
-        return next();
-    };
-}
-//# sourceMappingURL=create-network-client.cjs.map

package/dist/create-network-client.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"create-network-client.cjs","sourceRoot":"","sources":["../src/create-network-client.ts"],"names":[],"mappings":";;;AAAA,+EAA0E;AAE1E,iEAGoC;AAEpC,mEAAkE;AAClE,uEAAuE;AACvE,+EAQ2C;AAC3C,2EAAmE;AACnE,2EAA2E;AAC3E,+DAA2D;AAC3D,qDAGsC;AAKtC,2CAA2D;AAQ3D,8EAAqE;AAErE,kEAMsC;AAOtC,0CAA+C;AAE/C,MAAM,MAAM,GAAG,IAAI,CAAC;AAkBpB;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,KAAc;IAChD,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,IAAA,kCAAiB,EAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IACD,IAAI,IAAA,iCAAgB,EAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IACD,IAAI,IAAA,kCAAiB,EAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,4BAA4B,CAAC;IACtC,CAAC;IACD,IAAI,IAAA,+BAAc,EAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,IAAI,IAAA,uCAAsB,EAAC,KAAK,CAAC,EAAE,CAAC;QAClC,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AApBD,kDAoBC;AAmBD;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,mBAAmB,CAAC,EAClC,EAAE,EACF,aAAa,EACb,oBAAoB,EACpB,sBAAsB,EACtB,SAAS,EACT,eAAe,EACf,MAAM,GAaP;IACC,MAAM,kBAAkB,GACtB,aAAa,CAAC,IAAI,KAAK,4BAAiB,CAAC,MAAM;QAC7C,CAAC,CAAC,WAAW,aAAa,CAAC,OAAO,iBAAiB,aAAa,CAAC,eAAe,EAAE;QAClF,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC;IAC3B,MAAM,eAAe,GAAG,qBAAqB,CAAC;QAC5C,EAAE;QACF,kBAAkB;QAClB,aAAa;QACb,oBAAoB;QACpB,SAAS;QACT,eAAe;QACf,MAAM;KACP,CAAC,CAAC;IAEH,IAAI,gBAAkC,CAAC;IACvC,IAAI,aAAa,CAAC,IAAI,KAAK,4BAAiB,CAAC,MAAM,EAAE,CAAC;QACpD,gBAAgB,GAAG,IAAA,gCAAc,EAC/B,IAAA,4CAAsB,EAAC;YACrB,UAAU,EAAE,eAAe;YAC3B,OAAO,EAAE;gBACP,MAAM,EAAE,UAAU;aACnB;SACF,CAAC,CACH,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,gBAAgB,GAAG,IAAA,+CAAqB,EAAC,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED,MAAM,WAAW,GAAG,IAAA,gDAAwB,EAAC,gBAAgB,CAAC,CAAC;IAE/D,MAAM,YAAY,GAAG,kBAAkB,CAAC;QACtC,iBAAiB,EAAE,aAAa,CAAC,IAAI;QACrC,WAAW,EAAE,kBAAkB;QAC/B,UAAU,EAAE,sBAAsB;QAClC,QAAQ,EAAE,WAAW;KACtB,CAAC,CAAC;IAEH,MAAM,iBAAiB,GACrB,aAAa,CAAC,IAAI,KAAK,4BAAiB,CAAC,MAAM;QAC7C,CAAC,CAAC,6BAA6B,CAAC;YAC5B,YAAY;YACZ,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,WAAW;YACX,gBAAgB;SACjB,CAAC;QACJ,CAAC,CAAC,6BAA6B,CAAC;YAC5B,YAAY;YACZ,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,gBAAgB;SACjB,CAAC,CAAC;IAET,MAAM,QAAQ,GAAa,IAAI,wCAAgB,CAAC;QAC9C,MAAM,EAAE,oBAAe,CAAC,MAAM,CAAC;YAC7B,UAAU,EAAE,CAAC,iBAAiB,CAAC;SAChC,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,GAAS,EAAE;QACzB,gFAAgF;QAChF,mEAAmE;QACnE,YAAY,CAAC,OAAO,EAAE,CAAC;IACzB,CAAC,CAAC;IAEF,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC;AAC5D,CAAC;AArFD,kDAqFC;AAED;;;;;;;;;;;;GAYG;AACH,SAAS,qBAAqB,CAAC,EAC7B,kBAAkB,EAClB,eAAe,EACf,eAAe,GAKhB;IACC,MAAM,iBAAiB,GAAG,CAAC,eAAe,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC9D,GAAG;QACH,UAAU,EAAE,IAAI;KACjB,CAAC,CAAC,CAAC;IACJ,gHAAgH;IAChH,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAE7E,IACE,eAAe,KAAK,QAAQ;QAC5B,QAAQ;QACR,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAC5B,CAAC;QACD,4EAA4E;QAC5E,0EAA0E;QAC1E,2DAA2D;QAC3D,4EAA4E;QAC5E,sDAAsD;QACtD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IACD,IAAI,eAAe,KAAK,SAAS,IAAI,QAAQ,EAAE,CAAC;QAC9C,OAAO;YACL,EAAE,GAAG,EAAE,kBAAkB,EAAE,UAAU,EAAE,KAAK,EAAE;YAC9C,GAAG,iBAAiB;SACrB,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,EAAE,GAAG,EAAE,kBAAkB,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAS,qBAAqB,CAAC,EAC7B,EAAE,EACF,kBAAkB,EAClB,aAAa,EACb,oBAAoB,EACpB,SAAS,EACT,eAAe,EACf,MAAM,GAWP;IACC,MAAM,kBAAkB,GAAG,qBAAqB,CAAC;QAC/C,kBAAkB;QAClB,eAAe,EAAE,aAAa,CAAC,eAAe;QAC9C,eAAe;KAChB,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,GAAY,EAAE;QAC9B,MAAM,iBAAiB,GAAG,SAAS,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;QAC5E,OAAO,CACL,iBAAiB,CAAC,kBAAkB,KAAK,+CAAqB,CAAC,OAAO,CACvE,CAAC;IACJ,CAAC,CAAC;IAEF,mEAAmE;IACnE,2DAA2D;IAC3D,EAAE;IACF,iEAAiE;IACjE,uEAAuE;IACvE,kBAAkB;IAClB,MAAM,sBAAsB,GAAG,mDAAgC,CAAC;IAEhE,+DAA+D;IAC/D,2BAA2B;IAC3B,EAAE;IACF,mEAAmE;IACnE,kEAAkE;IAClE,wCAAwC;IACxC,MAAM,8BAA8B,GAAG,CAAC,sCAAmB,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;IAEtE,MAAM,wBAAwB,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QACnE,MAAM,iBAAiB,GAAG,oBAAoB,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QACrE,OAAO;YACL,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;YACxC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;YACtC,SAAS;YACT,aAAa,EAAE;gBACb,UAAU,EAAE,sCAAmB;gBAC/B,oBAAoB,EAAE,IAAA,sBAAc,EAAC,EAAE,EAAE,gBAAQ,CAAC,MAAM,CAAC;gBACzD,sBAAsB,EAAE,QAAQ,CAAC,UAAU;oBACzC,CAAC,CAAC,8BAA8B;oBAChC,CAAC,CAAC,sBAAsB;gBAC1B,GAAG,CAAC,iBAAiB,CAAC,aAAa,IAAI,EAAE,CAAC;aAC3C;YACD,GAAG,iBAAiB;YACpB,WAAW,EAAE,QAAQ,CAAC,GAAG;YACzB,MAAM;SACP,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,QAAQ,GAAG,CACf,KAA6D,EAChC,EAAE;QAC/B,IAAI,OAAO,IAAI,KAAK,EAAE,CAAC;YACrB,OAAO,KAAK,CAAC,KAAK,CAAC;QACrB,CAAC;aAAM,IAAI,OAAO,IAAI,KAAK,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAC,KAAK,CAAC;QACrB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,IAAI,sCAAe,CAAC;QAC1C,wBAAwB,CAAC,CAAC,CAAC;QAC3B,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;KACrC,CAAC,CAAC;IAEH,eAAe,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC/B,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAE7B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,2EAA2E;YAC3E,oEAAoE;YACpE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QAED,SAAS,CAAC,OAAO,CAAC,+CAA+C,EAAE;YACjE,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,eAAe,EAAE,EAAE;YACnB,KAAK;SACN,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,eAAe,CAAC,cAAc,CAC5B,CAAC,EACC,WAAW,EACX,kBAAkB,EAAE,2BAA2B,EAC/C,GAAG,IAAI,EACR,EAAE,EAAE;QACH,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAE7B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,2EAA2E;YAC3E,oEAAoE;YACpE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QAED,SAAS,CAAC,OAAO,CAAC,0CAA0C,EAAE;YAC5D,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,eAAe,EAAE,EAAE;YACnB,kBAAkB,EAAE,2BAA2B;YAC/C,WAAW;YACX,KAAK;SACN,CAAC,CAAC;IACL,CAAC,CACF,CAAC;IAEF,eAAe,CAAC,UAAU,CACxB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE;QAChD,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,MAAM,IAAI,GACR,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,mBAAmB,CAAC;QAC7D,SAAS,CAAC,OAAO,CAAC,4CAA4C,EAAE;YAC9D,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,eAAe,EAAE,EAAE;YACnB,KAAK;YACL,aAAa;YACb,QAAQ;YACR,OAAO;YACP,IAAI;YACJ,WAAW,EACT,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC;SAC/D,CAAC,CAAC;IACL,CAAC,CACF,CAAC;IAEF,eAAe,CAAC,iBAAiB,CAC/B,CAAC,EACC,WAAW,EACX,kBAAkB,EAAE,2BAA2B,EAC/C,aAAa,EACb,QAAQ,EACR,OAAO,EACP,GAAG,IAAI,EACR,EAAE,EAAE;QACH,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,MAAM,IAAI,GACR,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,mBAAmB,CAAC;QAE7D,SAAS,CAAC,OAAO,CAAC,uCAAuC,EAAE;YACzD,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,eAAe,EAAE,EAAE;YACnB,kBAAkB,EAAE,2BAA2B;YAC/C,WAAW;YACX,KAAK;YACL,aAAa;YACb,QAAQ;YACR,OAAO;YACP,IAAI;YACJ,WAAW,EACT,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC;SAC/D,CAAC,CAAC;IACL,CAAC,CACF,CAAC;IAEF,eAAe,CAAC,WAAW,CAAC,GAAG,EAAE;QAC/B,SAAS,CAAC,OAAO,CAAC,6CAA6C,EAAE;YAC/D,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,eAAe,EAAE,EAAE;SACpB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,eAAe,CAAC,cAAc,CAC5B,CAAC,EACC,OAAO,EACP,WAAW,EACX,kBAAkB,EAAE,2BAA2B,GAChD,EAAE,EAAE;QACH,SAAS,CAAC,OAAO,CAAC,sCAAsC,EAAE;YACxD,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,eAAe,EAAE,EAAE;YACnB,kBAAkB,EAAE,2BAA2B;YAC/C,WAAW;YACX,OAAO;SACR,CAAC,CAAC;IACL,CAAC,CACF,CAAC;IAEF,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,kBAAkB,CAAC,EAC1B,iBAAiB,EACjB,WAAW,EACX,UAAU,EACV,QAAQ,GAQT;IACC,MAAM,cAAc,GAAG;QACrB,eAAe;QACb,sBAAsB;QACtB,iDAAiD;QACjD,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,iBAAiB,KAAK,4BAAiB,CAAC,MAAM;YACnE,CAAC,CAAC,IAAA,sBAAc,EAAC,CAAC,EAAE,gBAAQ,CAAC,MAAM,CAAC;YACpC,CAAC,CAAC,IAAA,sBAAc,EAAC,EAAE,EAAE,gBAAQ,CAAC,MAAM,CAAC;QACzC,YAAY,EAAE,IAAA,sBAAc,EAAC,EAAE,EAAE,gBAAQ,CAAC,MAAM,CAAC;KAClD,CAAC;IAEF,OAAO,IAAI,uCAAmB,CAAC;QAC7B,GAAG,cAAc;QACjB,GAAG,UAAU,CAAC,WAAW,CAAC;QAC1B,QAAQ;KACT,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,6BAA6B,CAAC,EACrC,YAAY,EACZ,OAAO,EACP,WAAW,EACX,gBAAgB,GAMjB;IAKC,OAAO,oBAAe,CAAC,MAAM,CAAC;QAC5B,UAAU,EAAE;YACV,iCAAiC,CAAC,EAAE,OAAO,EAAE,CAAC;YAC9C,IAAA,oDAA0B,EAAC,EAAE,YAAY,EAAE,CAAC;YAC5C,IAAA,uDAA6B,GAAE;YAC/B,IAAA,kDAAwB,EAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;YACjE,IAAA,sDAA4B,EAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;YACrE,IAAA,+DAAqC,EAAC,EAAE,YAAY,EAAE,CAAC;YACvD,gBAAgB;SACjB;KACF,CAAC,CAAC,YAAY,EAAE,CAAC;AACpB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,iCAAiC,CAAC,EACzC,OAAO,GAGR;IACC,OAAO,IAAA,6BAAwB,EAAC;QAC9B,WAAW,EAAE,OAAO;KACrB,CAAC,CAAC;AACL,CAAC;AAED,MAAM,uBAAuB,GAAG,CAC9B,OAAY,EAC6B,EAAE;IAC3C,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE;QAC3B,IAAI,OAAO,CAAC,MAAM,KAAK,aAAa,EAAE,CAAC;YACrC,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,SAAS,6BAA6B,CAAC,EACrC,YAAY,EACZ,OAAO,EACP,gBAAgB,GAKjB;IAKC,sBAAsB;IACtB,iDAAiD;IACjD,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO;QACzC,CAAC,CAAC,CAAC,oCAAoC,EAAE,CAAC;QAC1C,CAAC,CAAC,EAAE,CAAC;IAEP,OAAO,oBAAe,CAAC,MAAM,CAAC;QAC5B,UAAU,EAAE;YACV,GAAG,eAAe;YAClB,uBAAuB,CAAC,OAAO,CAAC;YAChC,IAAA,yDAA+B,EAAC,EAAE,YAAY,EAAE,CAAC;YACjD,IAAA,oDAA0B,EAAC,EAAE,YAAY,EAAE,CAAC;YAC5C,IAAA,uDAA6B,GAAE;YAC/B,IAAA,+DAAqC,EAAC,EAAE,YAAY,EAAE,CAAC;YACvD,gBAAgB;SACjB;KACF,CAAC,CAAC,YAAY,EAAE,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,SAAS,oCAAoC;IAI3C,OAAO,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE;QACjC,IAAI,OAAO,CAAC,MAAM,KAAK,iBAAiB,EAAE,CAAC;YACzC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QAClE,CAAC;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import { CONNECTIVITY_STATUSES } from '@metamask/connectivity-controller';\nimport type { CockatielFailureReason } from '@metamask/controller-utils';\nimport {\n  DEFAULT_MAX_CONSECUTIVE_FAILURES,\n  DEFAULT_MAX_RETRIES,\n} from '@metamask/controller-utils';\nimport type { PollingBlockTrackerOptions } from '@metamask/eth-block-tracker';\nimport { PollingBlockTracker } from '@metamask/eth-block-tracker';\nimport { createInfuraMiddleware } from '@metamask/eth-json-rpc-infura';\nimport {\n  createBlockCacheMiddleware,\n  createBlockRefMiddleware,\n  createBlockRefRewriteMiddleware,\n  createBlockTrackerInspectorMiddleware,\n  createInflightCacheMiddleware,\n  createFetchMiddleware,\n  createRetryOnEmptyMiddleware,\n} from '@metamask/eth-json-rpc-middleware';\nimport { InternalProvider } from '@metamask/eth-json-rpc-provider';\nimport { providerFromMiddlewareV2 } from '@metamask/eth-json-rpc-provider';\nimport { asV2Middleware } from '@metamask/json-rpc-engine';\nimport {\n  createScaffoldMiddleware,\n  JsonRpcEngineV2,\n} from '@metamask/json-rpc-engine/v2';\nimport type {\n  JsonRpcMiddleware,\n  MiddlewareContext,\n} from '@metamask/json-rpc-engine/v2';\nimport { inMilliseconds, Duration } from '@metamask/utils';\nimport type { Hex, Json, JsonRpcRequest } from '@metamask/utils';\nimport type { Logger } from 'loglevel';\n\nimport type {\n  NetworkClientId,\n  NetworkControllerMessenger,\n} from './NetworkController.js';\nimport { RpcServiceChain } from './rpc-service/rpc-service-chain.js';\nimport type { RpcServiceOptionsWithDefaults } from './rpc-service/rpc-service.js';\nimport {\n  isConnectionError,\n  isConnectionResetError,\n  isJsonParseError,\n  isHttpServerError,\n  isTimeoutError,\n} from './rpc-service/rpc-service.js';\nimport type { RpcFailoverMode } from './selectors.js';\nimport type {\n  BlockTracker,\n  NetworkClientConfiguration,\n  Provider,\n} from './types.js';\nimport { NetworkClientType } from './types.js';\n\nconst SECOND = 1000;\n\n/**\n * Why the degraded event was emitted.\n */\nexport type DegradedEventType = 'slow_success' | 'retries_exhausted';\n\n/**\n * The category of error that was retried until retries were exhausted.\n */\nexport type RetryReason =\n  | 'connection_failed'\n  | 'response_not_json'\n  | 'non_successful_http_status'\n  | 'timed_out'\n  | 'connection_reset'\n  | 'unknown';\n\n/**\n * Classifies the error that was being retried when retries were exhausted.\n *\n * @param error - The error from the last retry attempt.\n * @returns A classification string.\n */\nexport function classifyRetryReason(error: unknown): RetryReason {\n  if (!(error instanceof Error)) {\n    return 'unknown';\n  }\n  if (isConnectionError(error)) {\n    return 'connection_failed';\n  }\n  if (isJsonParseError(error)) {\n    return 'response_not_json';\n  }\n  if (isHttpServerError(error)) {\n    return 'non_successful_http_status';\n  }\n  if (isTimeoutError(error)) {\n    return 'timed_out';\n  }\n  if (isConnectionResetError(error)) {\n    return 'connection_reset';\n  }\n  return 'unknown';\n}\n\n/**\n * The pair of provider / block tracker that can be used to interface with the\n * network and respond to new activity.\n */\nexport type NetworkClient = {\n  configuration: NetworkClientConfiguration;\n  provider: Provider;\n  blockTracker: BlockTracker;\n  destroy: () => void;\n};\n\ntype RpcApiMiddleware = JsonRpcMiddleware<\n  JsonRpcRequest,\n  Json,\n  MiddlewareContext<{ origin: string }>\n>;\n\n/**\n * Create a JSON RPC network client for a specific network.\n *\n * @param args - The arguments.\n * @param args.id - The ID that will be assigned to the new network client in\n * the registry.\n * @param args.configuration - The network configuration.\n * @param args.getRpcServiceOptions - Factory for constructing RPC service\n * options. See {@link NetworkControllerOptions.getRpcServiceOptions}.\n * @param args.getBlockTrackerOptions - Factory for constructing block tracker\n * options. See {@link NetworkControllerOptions.getBlockTrackerOptions}.\n * @param args.messenger - The network controller messenger.\n * @param args.rpcFailoverMode - The RPC failover mode to apply: `disabled`\n * (failover off), `enabled` (divert to the configured failover URLs when the\n * primary endpoint is unavailable), or `forced` (Infura endpoints that have\n * failover URLs route all traffic to those URLs, bypassing Infura entirely).\n * @param args.logger - A `loglevel` logger.\n * @returns The network client.\n */\nexport function createNetworkClient({\n  id,\n  configuration,\n  getRpcServiceOptions,\n  getBlockTrackerOptions,\n  messenger,\n  rpcFailoverMode,\n  logger,\n}: {\n  id: NetworkClientId;\n  configuration: NetworkClientConfiguration;\n  getRpcServiceOptions?: (\n    rpcEndpointUrl: string,\n  ) => RpcServiceOptionsWithDefaults;\n  getBlockTrackerOptions: (\n    rpcEndpointUrl: string,\n  ) => Omit<PollingBlockTrackerOptions, 'provider'>;\n  messenger: NetworkControllerMessenger;\n  rpcFailoverMode: RpcFailoverMode;\n  logger?: Logger;\n}): NetworkClient {\n  const primaryEndpointUrl =\n    configuration.type === NetworkClientType.Infura\n      ? `https://${configuration.network}.infura.io/v3/${configuration.infuraProjectId}`\n      : configuration.rpcUrl;\n  const rpcServiceChain = createRpcServiceChain({\n    id,\n    primaryEndpointUrl,\n    configuration,\n    getRpcServiceOptions,\n    messenger,\n    rpcFailoverMode,\n    logger,\n  });\n\n  let rpcApiMiddleware: RpcApiMiddleware;\n  if (configuration.type === NetworkClientType.Infura) {\n    rpcApiMiddleware = asV2Middleware(\n      createInfuraMiddleware({\n        rpcService: rpcServiceChain,\n        options: {\n          source: 'metamask',\n        },\n      }),\n    );\n  } else {\n    rpcApiMiddleware = createFetchMiddleware({ rpcService: rpcServiceChain });\n  }\n\n  const rpcProvider = providerFromMiddlewareV2(rpcApiMiddleware);\n\n  const blockTracker = createBlockTracker({\n    networkClientType: configuration.type,\n    endpointUrl: primaryEndpointUrl,\n    getOptions: getBlockTrackerOptions,\n    provider: rpcProvider,\n  });\n\n  const networkMiddleware =\n    configuration.type === NetworkClientType.Infura\n      ? createInfuraNetworkMiddleware({\n          blockTracker,\n          chainId: configuration.chainId,\n          rpcProvider,\n          rpcApiMiddleware,\n        })\n      : createCustomNetworkMiddleware({\n          blockTracker,\n          chainId: configuration.chainId,\n          rpcApiMiddleware,\n        });\n\n  const provider: Provider = new InternalProvider({\n    engine: JsonRpcEngineV2.create({\n      middleware: [networkMiddleware],\n    }),\n  });\n\n  const destroy = (): void => {\n    // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n    // eslint-disable-next-line @typescript-eslint/no-floating-promises\n    blockTracker.destroy();\n  };\n\n  return { configuration, provider, blockTracker, destroy };\n}\n\n/**\n * Determines the ordered list of endpoints that make up the RPC service chain\n * for a network, honoring the RPC failover flags.\n *\n * @param args - The arguments.\n * @param args.primaryEndpointUrl - The primary endpoint URL for the network.\n * @param args.failoverRpcUrls - The configured failover URLs, if any.\n * @param args.rpcFailoverMode - The RPC failover mode to apply: `disabled`,\n * `enabled` (divert to the failover URLs when the primary is unavailable), or\n * `forced` (route all traffic for Infura endpoints with failover URLs to those\n * URLs, bypassing Infura).\n * @returns The endpoints to use, each flagged as primary or failover.\n */\nfunction getAvailableEndpoints({\n  primaryEndpointUrl,\n  failoverRpcUrls,\n  rpcFailoverMode,\n}: {\n  primaryEndpointUrl: string;\n  failoverRpcUrls: string[] | undefined;\n  rpcFailoverMode: RpcFailoverMode;\n}): { url: string; isFailover: boolean }[] {\n  const failoverEndpoints = (failoverRpcUrls ?? []).map((url) => ({\n    url,\n    isFailover: true,\n  }));\n  // We explicitly check the URL since some networks have been added with invalid configuration types in the past.\n  const isInfura = new URL(primaryEndpointUrl).hostname.endsWith('.infura.io');\n\n  if (\n    rpcFailoverMode === 'forced' &&\n    isInfura &&\n    failoverEndpoints.length > 0\n  ) {\n    // Forced mode for an Infura endpoint with failovers: bypass Infura entirely\n    // and route all traffic (including block polling) to failovers. The first\n    // failover becomes the positional primary of the chain, so\n    // availability/degraded events will report that failover URL as the primary\n    // endpoint (there is no Infura primary in this mode).\n    return failoverEndpoints;\n  }\n  if (rpcFailoverMode === 'enabled' && isInfura) {\n    return [\n      { url: primaryEndpointUrl, isFailover: false },\n      ...failoverEndpoints,\n    ];\n  }\n  return [{ url: primaryEndpointUrl, isFailover: false }];\n}\n\n/**\n * Creates an RPC service chain, which represents the primary endpoint URL for\n * the network as well as its failover URLs.\n *\n * @param args - The arguments.\n * @param args.id - The ID that will be assigned to the new network client in\n * the registry.\n * @param args.primaryEndpointUrl - The primary endpoint URL.\n * @param args.configuration - The network configuration.\n * @param args.getRpcServiceOptions - Factory for constructing RPC service\n * options. See {@link NetworkControllerOptions.getRpcServiceOptions}.\n * @param args.messenger - The network controller messenger.\n * @param args.rpcFailoverMode - The RPC failover mode to apply: `disabled`\n * (failover off), `enabled` (divert to the configured failover URLs when the\n * primary endpoint is unavailable), or `forced` (Infura endpoints that have\n * failover URLs route all traffic to those URLs, bypassing Infura entirely).\n * @param args.logger - A `loglevel` logger.\n * @returns The RPC service chain.\n */\nfunction createRpcServiceChain({\n  id,\n  primaryEndpointUrl,\n  configuration,\n  getRpcServiceOptions,\n  messenger,\n  rpcFailoverMode,\n  logger,\n}: {\n  id: NetworkClientId;\n  primaryEndpointUrl: string;\n  configuration: NetworkClientConfiguration;\n  getRpcServiceOptions?: (\n    rpcEndpointUrl: string,\n  ) => RpcServiceOptionsWithDefaults;\n  messenger: NetworkControllerMessenger;\n  rpcFailoverMode: RpcFailoverMode;\n  logger?: Logger;\n}): RpcServiceChain {\n  const availableEndpoints = getAvailableEndpoints({\n    primaryEndpointUrl,\n    failoverRpcUrls: configuration.failoverRpcUrls,\n    rpcFailoverMode,\n  });\n\n  const isOffline = (): boolean => {\n    const connectivityState = messenger.call('ConnectivityController:getState');\n    return (\n      connectivityState.connectivityStatus === CONNECTIVITY_STATUSES.Offline\n    );\n  };\n\n  // Ensure that if the endpoint continually responds with errors, we\n  // break the circuit relatively fast (but not prematurely).\n  //\n  // Note that the circuit will break much faster if the errors are\n  // retriable (e.g. 503) than if not (e.g. 500), so we attempt to strike\n  // a balance here.\n  const maxConsecutiveFailures = DEFAULT_MAX_CONSECUTIVE_FAILURES;\n\n  // The number of rounds of retries that will break the circuit,\n  // triggering a \"cooldown\".\n  //\n  // When we fail over to QuickNode, we expect it to be down at first\n  // while it is being automatically activated, and we don't want to\n  // activate the \"cooldown\" accidentally.\n  const maxConsecutiveFailuresFailover = (DEFAULT_MAX_RETRIES + 1) * 10;\n\n  const rpcServiceConfigurations = availableEndpoints.map((endpoint) => {\n    const overriddenOptions = getRpcServiceOptions?.(endpoint.url) ?? {};\n    return {\n      fetch: globalThis.fetch.bind(globalThis),\n      btoa: globalThis.btoa.bind(globalThis),\n      isOffline,\n      policyOptions: {\n        maxRetries: DEFAULT_MAX_RETRIES,\n        circuitBreakDuration: inMilliseconds(30, Duration.Second),\n        maxConsecutiveFailures: endpoint.isFailover\n          ? maxConsecutiveFailuresFailover\n          : maxConsecutiveFailures,\n        ...(overriddenOptions.policyOptions ?? {}),\n      },\n      ...overriddenOptions,\n      endpointUrl: endpoint.url,\n      logger,\n    };\n  });\n\n  /**\n   * Extracts the error from Cockatiel's `FailureReason` type received in\n   * circuit breaker event handlers.\n   *\n   * The `FailureReason` object can have two possible shapes:\n   * - `{ error: Error }` - When the RPC service throws an error (the common\n   * case for RPC failures).\n   * - `{ value: T }` - When the RPC service returns a value that the retry\n   * filter policy considers a failure.\n   *\n   * @param value - The event data object from the circuit breaker event\n   * listener (after destructuring known properties like `endpointUrl`). This\n   * represents Cockatiel's `FailureReason` type.\n   * @returns The error or failure value, or `undefined` if neither property\n   * exists (which shouldn't happen in practice unless the circuit breaker is\n   * manually isolated).\n   */\n  const getError = (\n    value: CockatielFailureReason<unknown> | Record<never, never>,\n  ): Error | unknown | undefined => {\n    if ('error' in value) {\n      return value.error;\n    } else if ('value' in value) {\n      return value.value;\n    }\n    return undefined;\n  };\n\n  const rpcServiceChain = new RpcServiceChain([\n    rpcServiceConfigurations[0],\n    ...rpcServiceConfigurations.slice(1),\n  ]);\n\n  rpcServiceChain.onBreak((data) => {\n    const error = getError(data);\n\n    if (error === undefined) {\n      // This error shouldn't happen in practice because we never call `.isolate`\n      // on the circuit breaker policy, but we need to appease TypeScript.\n      throw new Error('Could not make request to endpoint.');\n    }\n\n    messenger.publish('NetworkController:rpcEndpointChainUnavailable', {\n      chainId: configuration.chainId,\n      networkClientId: id,\n      error,\n    });\n  });\n\n  rpcServiceChain.onServiceBreak(\n    ({\n      endpointUrl,\n      primaryEndpointUrl: primaryEndpointUrlFromEvent,\n      ...rest\n    }) => {\n      const error = getError(rest);\n\n      if (error === undefined) {\n        // This error shouldn't happen in practice because we never call `.isolate`\n        // on the circuit breaker policy, but we need to appease TypeScript.\n        throw new Error('Could not make request to endpoint.');\n      }\n\n      messenger.publish('NetworkController:rpcEndpointUnavailable', {\n        chainId: configuration.chainId,\n        networkClientId: id,\n        primaryEndpointUrl: primaryEndpointUrlFromEvent,\n        endpointUrl,\n        error,\n      });\n    },\n  );\n\n  rpcServiceChain.onDegraded(\n    ({ rpcMethodName, duration, traceId, ...rest }) => {\n      const error = getError(rest);\n      const type: DegradedEventType =\n        error === undefined ? 'slow_success' : 'retries_exhausted';\n      messenger.publish('NetworkController:rpcEndpointChainDegraded', {\n        chainId: configuration.chainId,\n        networkClientId: id,\n        error,\n        rpcMethodName,\n        duration,\n        traceId,\n        type,\n        retryReason:\n          error === undefined ? undefined : classifyRetryReason(error),\n      });\n    },\n  );\n\n  rpcServiceChain.onServiceDegraded(\n    ({\n      endpointUrl,\n      primaryEndpointUrl: primaryEndpointUrlFromEvent,\n      rpcMethodName,\n      duration,\n      traceId,\n      ...rest\n    }) => {\n      const error = getError(rest);\n      const type: DegradedEventType =\n        error === undefined ? 'slow_success' : 'retries_exhausted';\n\n      messenger.publish('NetworkController:rpcEndpointDegraded', {\n        chainId: configuration.chainId,\n        networkClientId: id,\n        primaryEndpointUrl: primaryEndpointUrlFromEvent,\n        endpointUrl,\n        error,\n        rpcMethodName,\n        duration,\n        traceId,\n        type,\n        retryReason:\n          error === undefined ? undefined : classifyRetryReason(error),\n      });\n    },\n  );\n\n  rpcServiceChain.onAvailable(() => {\n    messenger.publish('NetworkController:rpcEndpointChainAvailable', {\n      chainId: configuration.chainId,\n      networkClientId: id,\n    });\n  });\n\n  rpcServiceChain.onServiceRetry(\n    ({\n      attempt,\n      endpointUrl,\n      primaryEndpointUrl: primaryEndpointUrlFromEvent,\n    }) => {\n      messenger.publish('NetworkController:rpcEndpointRetried', {\n        chainId: configuration.chainId,\n        networkClientId: id,\n        primaryEndpointUrl: primaryEndpointUrlFromEvent,\n        endpointUrl,\n        attempt,\n      });\n    },\n  );\n\n  return rpcServiceChain;\n}\n\n/**\n * Create the block tracker for the network.\n *\n * @param args - The arguments.\n * @param args.networkClientType - The type of the network client (\"infura\" or\n * \"custom\").\n * @param args.endpointUrl - The URL of the endpoint.\n * @param args.getOptions - Factory for the block tracker options.\n * @param args.provider - The EIP-1193 provider for the network's JSON-RPC\n * middleware stack.\n * @returns The created block tracker.\n */\nfunction createBlockTracker({\n  networkClientType,\n  endpointUrl,\n  getOptions,\n  provider,\n}: {\n  networkClientType: NetworkClientType;\n  endpointUrl: string;\n  getOptions: (\n    rpcEndpointUrl: string,\n  ) => Omit<PollingBlockTrackerOptions, 'provider'>;\n  provider: InternalProvider;\n}): PollingBlockTracker {\n  const defaultOptions = {\n    pollingInterval:\n      // Needed for testing.\n      // eslint-disable-next-line no-restricted-globals\n      process.env.IN_TEST && networkClientType === NetworkClientType.Custom\n        ? inMilliseconds(1, Duration.Second)\n        : inMilliseconds(20, Duration.Second),\n    retryTimeout: inMilliseconds(20, Duration.Second),\n  };\n\n  return new PollingBlockTracker({\n    ...defaultOptions,\n    ...getOptions(endpointUrl),\n    provider,\n  });\n}\n\n/**\n * Create middleware for infura.\n *\n * @param args - The arguments.\n * @param args.blockTracker - The block tracker to use.\n * @param args.chainId - The chain id to use.\n * @param args.rpcProvider - The RPC provider to use.\n * @param args.rpcApiMiddleware - Additional middleware.\n * @returns The collection of middleware that makes up the Infura client.\n */\nfunction createInfuraNetworkMiddleware({\n  blockTracker,\n  chainId,\n  rpcProvider,\n  rpcApiMiddleware,\n}: {\n  blockTracker: PollingBlockTracker;\n  chainId: string;\n  rpcProvider: InternalProvider;\n  rpcApiMiddleware: RpcApiMiddleware;\n}): JsonRpcMiddleware<\n  JsonRpcRequest,\n  Json,\n  MiddlewareContext<{ origin: string; skipCache: boolean }>\n> {\n  return JsonRpcEngineV2.create({\n    middleware: [\n      createNetworkAndChainIdMiddleware({ chainId }),\n      createBlockCacheMiddleware({ blockTracker }),\n      createInflightCacheMiddleware(),\n      createBlockRefMiddleware({ blockTracker, provider: rpcProvider }),\n      createRetryOnEmptyMiddleware({ blockTracker, provider: rpcProvider }),\n      createBlockTrackerInspectorMiddleware({ blockTracker }),\n      rpcApiMiddleware,\n    ],\n  }).asMiddleware();\n}\n\n/**\n * Creates static method middleware.\n *\n * @param args - The Arguments.\n * @param args.chainId - The chain id to use.\n * @returns The middleware that implements the eth_chainId method.\n */\nfunction createNetworkAndChainIdMiddleware({\n  chainId,\n}: {\n  chainId: string;\n}): JsonRpcMiddleware<JsonRpcRequest> {\n  return createScaffoldMiddleware({\n    eth_chainId: chainId,\n  });\n}\n\nconst createChainIdMiddleware = (\n  chainId: Hex,\n): JsonRpcMiddleware<JsonRpcRequest, Json> => {\n  return ({ request, next }) => {\n    if (request.method === 'eth_chainId') {\n      return chainId;\n    }\n    return next();\n  };\n};\n\n/**\n * Creates custom middleware.\n *\n * @param args - The arguments.\n * @param args.blockTracker - The block tracker to use.\n * @param args.chainId - The chain id to use.\n * @param args.rpcApiMiddleware - Additional middleware.\n * @returns The collection of middleware that makes up the Infura client.\n */\nfunction createCustomNetworkMiddleware({\n  blockTracker,\n  chainId,\n  rpcApiMiddleware,\n}: {\n  blockTracker: PollingBlockTracker;\n  chainId: Hex;\n  rpcApiMiddleware: RpcApiMiddleware;\n}): JsonRpcMiddleware<\n  JsonRpcRequest,\n  Json,\n  MiddlewareContext<{ origin: string; skipCache: boolean }>\n> {\n  // Needed for testing.\n  // eslint-disable-next-line no-restricted-globals\n  const testMiddlewares = process.env.IN_TEST\n    ? [createEstimateGasDelayTestMiddleware()]\n    : [];\n\n  return JsonRpcEngineV2.create({\n    middleware: [\n      ...testMiddlewares,\n      createChainIdMiddleware(chainId),\n      createBlockRefRewriteMiddleware({ blockTracker }),\n      createBlockCacheMiddleware({ blockTracker }),\n      createInflightCacheMiddleware(),\n      createBlockTrackerInspectorMiddleware({ blockTracker }),\n      rpcApiMiddleware,\n    ],\n  }).asMiddleware();\n}\n\n/**\n * For use in tests only.\n * Adds a delay to `eth_estimateGas` calls.\n *\n * @returns The middleware for delaying gas estimation calls by 2 seconds when in test.\n */\nfunction createEstimateGasDelayTestMiddleware(): JsonRpcMiddleware<\n  JsonRpcRequest,\n  Json\n> {\n  return async ({ request, next }) => {\n    if (request.method === 'eth_estimateGas') {\n      await new Promise((resolve) => setTimeout(resolve, SECOND * 2));\n    }\n    return next();\n  };\n}\n"]}

package/dist/create-network-client.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"create-network-client.d.cts","sourceRoot":"","sources":["../src/create-network-client.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,0BAA0B,EAAE,oCAAoC;AAyB9E,OAAO,KAAK,EAAE,MAAM,EAAE,iBAAiB;AAEvC,OAAO,KAAK,EACV,eAAe,EACf,0BAA0B,EAC3B,gCAA+B;AAEhC,OAAO,KAAK,EAAE,6BAA6B,EAAE,sCAAqC;AAQlF,OAAO,KAAK,EAAE,eAAe,EAAE,wBAAuB;AACtD,OAAO,KAAK,EACV,YAAY,EACZ,0BAA0B,EAC1B,QAAQ,EACT,oBAAmB;AAKpB;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,cAAc,GAAG,mBAAmB,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,4BAA4B,GAC5B,WAAW,GACX,kBAAkB,GAClB,SAAS,CAAC;AAEd;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,WAAW,CAoB/D;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,aAAa,EAAE,0BAA0B,CAAC;IAC1C,QAAQ,EAAE,QAAQ,CAAC;IACnB,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAQF;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,EAAE,EACF,aAAa,EACb,oBAAoB,EACpB,sBAAsB,EACtB,SAAS,EACT,eAAe,EACf,MAAM,GACP,EAAE;IACD,EAAE,EAAE,eAAe,CAAC;IACpB,aAAa,EAAE,0BAA0B,CAAC;IAC1C,oBAAoB,CAAC,EAAE,CACrB,cAAc,EAAE,MAAM,KACnB,6BAA6B,CAAC;IACnC,sBAAsB,EAAE,CACtB,cAAc,EAAE,MAAM,KACnB,IAAI,CAAC,0BAA0B,EAAE,UAAU,CAAC,CAAC;IAClD,SAAS,EAAE,0BAA0B,CAAC;IACtC,eAAe,EAAE,eAAe,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,GAAG,aAAa,CAiEhB"}

package/dist/create-network-client.d.mts

@@ -1,60 +0,0 @@
-import type { PollingBlockTrackerOptions } from "@metamask/eth-block-tracker";
-import type { Logger } from "loglevel";
-import type { NetworkClientId, NetworkControllerMessenger } from "./NetworkController.mjs";
-import type { RpcServiceOptionsWithDefaults } from "./rpc-service/rpc-service.mjs";
-import type { RpcFailoverMode } from "./selectors.mjs";
-import type { BlockTracker, NetworkClientConfiguration, Provider } from "./types.mjs";
-/**
- * Why the degraded event was emitted.
- */
-export type DegradedEventType = 'slow_success' | 'retries_exhausted';
-/**
- * The category of error that was retried until retries were exhausted.
- */
-export type RetryReason = 'connection_failed' | 'response_not_json' | 'non_successful_http_status' | 'timed_out' | 'connection_reset' | 'unknown';
-/**
- * Classifies the error that was being retried when retries were exhausted.
- *
- * @param error - The error from the last retry attempt.
- * @returns A classification string.
- */
-export declare function classifyRetryReason(error: unknown): RetryReason;
-/**
- * The pair of provider / block tracker that can be used to interface with the
- * network and respond to new activity.
- */
-export type NetworkClient = {
-    configuration: NetworkClientConfiguration;
-    provider: Provider;
-    blockTracker: BlockTracker;
-    destroy: () => void;
-};
-/**
- * Create a JSON RPC network client for a specific network.
- *
- * @param args - The arguments.
- * @param args.id - The ID that will be assigned to the new network client in
- * the registry.
- * @param args.configuration - The network configuration.
- * @param args.getRpcServiceOptions - Factory for constructing RPC service
- * options. See {@link NetworkControllerOptions.getRpcServiceOptions}.
- * @param args.getBlockTrackerOptions - Factory for constructing block tracker
- * options. See {@link NetworkControllerOptions.getBlockTrackerOptions}.
- * @param args.messenger - The network controller messenger.
- * @param args.rpcFailoverMode - The RPC failover mode to apply: `disabled`
- * (failover off), `enabled` (divert to the configured failover URLs when the
- * primary endpoint is unavailable), or `forced` (Infura endpoints that have
- * failover URLs route all traffic to those URLs, bypassing Infura entirely).
- * @param args.logger - A `loglevel` logger.
- * @returns The network client.
- */
-export declare function createNetworkClient({ id, configuration, getRpcServiceOptions, getBlockTrackerOptions, messenger, rpcFailoverMode, logger, }: {
-    id: NetworkClientId;
-    configuration: NetworkClientConfiguration;
-    getRpcServiceOptions?: (rpcEndpointUrl: string) => RpcServiceOptionsWithDefaults;
-    getBlockTrackerOptions: (rpcEndpointUrl: string) => Omit<PollingBlockTrackerOptions, 'provider'>;
-    messenger: NetworkControllerMessenger;
-    rpcFailoverMode: RpcFailoverMode;
-    logger?: Logger;
-}): NetworkClient;
-//# sourceMappingURL=create-network-client.d.mts.map

package/dist/create-network-client.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"create-network-client.d.mts","sourceRoot":"","sources":["../src/create-network-client.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,0BAA0B,EAAE,oCAAoC;AAyB9E,OAAO,KAAK,EAAE,MAAM,EAAE,iBAAiB;AAEvC,OAAO,KAAK,EACV,eAAe,EACf,0BAA0B,EAC3B,gCAA+B;AAEhC,OAAO,KAAK,EAAE,6BAA6B,EAAE,sCAAqC;AAQlF,OAAO,KAAK,EAAE,eAAe,EAAE,wBAAuB;AACtD,OAAO,KAAK,EACV,YAAY,EACZ,0BAA0B,EAC1B,QAAQ,EACT,oBAAmB;AAKpB;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,cAAc,GAAG,mBAAmB,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,4BAA4B,GAC5B,WAAW,GACX,kBAAkB,GAClB,SAAS,CAAC;AAEd;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,WAAW,CAoB/D;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,aAAa,EAAE,0BAA0B,CAAC;IAC1C,QAAQ,EAAE,QAAQ,CAAC;IACnB,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAQF;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,EAAE,EACF,aAAa,EACb,oBAAoB,EACpB,sBAAsB,EACtB,SAAS,EACT,eAAe,EACf,MAAM,GACP,EAAE;IACD,EAAE,EAAE,eAAe,CAAC;IACpB,aAAa,EAAE,0BAA0B,CAAC;IAC1C,oBAAoB,CAAC,EAAE,CACrB,cAAc,EAAE,MAAM,KACnB,6BAA6B,CAAC;IACnC,sBAAsB,EAAE,CACtB,cAAc,EAAE,MAAM,KACnB,IAAI,CAAC,0BAA0B,EAAE,UAAU,CAAC,CAAC;IAClD,SAAS,EAAE,0BAA0B,CAAC;IACtC,eAAe,EAAE,eAAe,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,GAAG,aAAa,CAiEhB"}