@metamask/network-controller 22.2.1 → 23.0.0

package/dist/create-auto-managed-network-client.cjs

@@ -26,11 +26,15 @@ const UNINITIALIZED_TARGET = { __UNINITIALIZED__: true };
  * part of the network client is serving as the receiver. The network client is
  * then cached for subsequent usages.
  *
- * @param networkClientConfiguration - The configuration object that will be
+ * @param args - The arguments.
+ * @param args.networkClientConfiguration - The configuration object that will be
  * used to instantiate the network client when it is needed.
+ * @param args.getRpcServiceOptions - Factory for constructing RPC service
+ * options. See {@link NetworkControllerOptions.getRpcServiceOptions}.
+ * @param args.messenger - The network controller messenger.
  * @returns The auto-managed network client.
  */
-function createAutoManagedNetworkClient(networkClientConfiguration) {
+function createAutoManagedNetworkClient({ networkClientConfiguration, getRpcServiceOptions, messenger, }) {
     let networkClient;
     const providerProxy = new Proxy(UNINITIALIZED_TARGET, {
         // TODO: Replace `any` with type
@@ -39,7 +43,11 @@ function createAutoManagedNetworkClient(networkClientConfiguration) {
             if (propertyName === REFLECTIVE_PROPERTY_NAME) {
                 return networkClient?.provider;
             }
-            networkClient ?? (networkClient = (0, create_network_client_1.createNetworkClient)(networkClientConfiguration));
+            networkClient ?? (networkClient = (0, create_network_client_1.createNetworkClient)({
+                configuration: networkClientConfiguration,
+                getRpcServiceOptions,
+                messenger,
+            }));
             if (networkClient === undefined) {
                 throw new Error("It looks like `createNetworkClient` didn't return anything. Perhaps it's being mocked?");
             }
@@ -71,7 +79,11 @@ function createAutoManagedNetworkClient(networkClientConfiguration) {
             if (propertyName === REFLECTIVE_PROPERTY_NAME) {
                 return true;
             }
-            networkClient ?? (networkClient = (0, create_network_client_1.createNetworkClient)(networkClientConfiguration));
+            networkClient ?? (networkClient = (0, create_network_client_1.createNetworkClient)({
+                configuration: networkClientConfiguration,
+                getRpcServiceOptions,
+                messenger,
+            }));
             const { provider } = networkClient;
             return propertyName in provider;
         },
@@ -83,7 +95,11 @@ function createAutoManagedNetworkClient(networkClientConfiguration) {
             if (propertyName === REFLECTIVE_PROPERTY_NAME) {
                 return networkClient?.blockTracker;
             }
-            networkClient ?? (networkClient = (0, create_network_client_1.createNetworkClient)(networkClientConfiguration));
+            networkClient ?? (networkClient = (0, create_network_client_1.createNetworkClient)({
+                configuration: networkClientConfiguration,
+                getRpcServiceOptions,
+                messenger,
+            }));
             if (networkClient === undefined) {
                 throw new Error("It looks like createNetworkClient returned undefined. Perhaps it's mocked?");
             }
@@ -115,7 +131,11 @@ function createAutoManagedNetworkClient(networkClientConfiguration) {
             if (propertyName === REFLECTIVE_PROPERTY_NAME) {
                 return true;
             }
-            networkClient ?? (networkClient = (0, create_network_client_1.createNetworkClient)(networkClientConfiguration));
+            networkClient ?? (networkClient = (0, create_network_client_1.createNetworkClient)({
+                configuration: networkClientConfiguration,
+                getRpcServiceOptions,
+                messenger,
+            }));
             const { blockTracker } = networkClient;
             return propertyName in blockTracker;
         },

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

@@ -1 +1 @@
-{"version":3,"file":"create-auto-managed-network-client.cjs","sourceRoot":"","sources":["../src/create-auto-managed-network-client.ts"],"names":[],"mappings":";;;AACA,uEAA8D;AAO9D;;;;GAIG;AACH,MAAM,wBAAwB,GAAG,YAAY,CAAC;AA6B9C;;;;GAIG;AACH,gFAAgF;AAChF,gEAAgE;AAChE,MAAM,oBAAoB,GAAG,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;AAEzD;;;;;;;;;;;;;GAaG;AACH,SAAgB,8BAA8B,CAG5C,0BAAyC;IAEzC,IAAI,aAAwC,CAAC;IAE7C,MAAM,aAAa,GAAG,IAAI,KAAK,CAAC,oBAAoB,EAAE;QACpD,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB,EAAE,QAAiB;YAC5D,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,aAAa,EAAE,QAAQ,CAAC;aAChC;YAED,aAAa,KAAb,aAAa,GAAK,IAAA,2CAAmB,EAAC,0BAA0B,CAAC,EAAC;YAClE,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC/B,MAAM,IAAI,KAAK,CACb,wFAAwF,CACzF,CAAC;aACH;YACD,MAAM,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;YAEnC,IAAI,YAAY,IAAI,QAAQ,EAAE;gBAC5B,+DAA+D;gBAC/D,cAAc;gBACd,MAAM,KAAK,GAAG,QAAQ,CAAC,YAAqC,CAAC,CAAC;gBAC9D,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;oBAC/B,kEAAkE;oBAClE,2DAA2D;oBAC3D,gDAAgD;oBAChD,gCAAgC;oBAChC,8DAA8D;oBAC9D,OAAO,UAAyB,GAAG,IAAW;wBAC5C,mEAAmE;wBACnE,gEAAgE;wBAChE,sBAAsB;wBACtB,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;oBAChE,CAAC,CAAC;iBACH;gBACD,OAAO,KAAK,CAAC;aACd;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB;YACzC,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,IAAI,CAAC;aACb;YACD,aAAa,KAAb,aAAa,GAAK,IAAA,2CAAmB,EAAC,0BAA0B,CAAC,EAAC;YAClE,MAAM,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;YACnC,OAAO,YAAY,IAAI,QAAQ,CAAC;QAClC,CAAC;KACF,CAAC,CAAC;IAEH,MAAM,iBAAiB,GAA4C,IAAI,KAAK,CAC1E,oBAAoB,EACpB;QACE,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB,EAAE,QAAiB;YAC5D,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,aAAa,EAAE,YAAY,CAAC;aACpC;YAED,aAAa,KAAb,aAAa,GAAK,IAAA,2CAAmB,EAAC,0BAA0B,CAAC,EAAC;YAClE,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC/B,MAAM,IAAI,KAAK,CACb,4EAA4E,CAC7E,CAAC;aACH;YACD,MAAM,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC;YAEvC,IAAI,YAAY,IAAI,YAAY,EAAE;gBAChC,+DAA+D;gBAC/D,cAAc;gBACd,MAAM,KAAK,GAAG,YAAY,CAAC,YAAyC,CAAC,CAAC;gBACtE,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;oBAC/B,kEAAkE;oBAClE,2DAA2D;oBAC3D,gDAAgD;oBAChD,gCAAgC;oBAChC,8DAA8D;oBAC9D,OAAO,UAAyB,GAAG,IAAW;wBAC5C,wDAAwD;wBACxD,+DAA+D;wBAC/D,kCAAkC;wBAClC,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;oBACpE,CAAC,CAAC;iBACH;gBACD,OAAO,KAAK,CAAC;aACd;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB;YACzC,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,IAAI,CAAC;aACb;YACD,aAAa,KAAb,aAAa,GAAK,IAAA,2CAAmB,EAAC,0BAA0B,CAAC,EAAC;YAClE,MAAM,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC;YACvC,OAAO,YAAY,IAAI,YAAY,CAAC;QACtC,CAAC;KACF,CACF,CAAC;IAEF,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,aAAa,EAAE,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC;IAEF,OAAO;QACL,aAAa,EAAE,0BAA0B;QACzC,QAAQ,EAAE,aAAa;QACvB,YAAY,EAAE,iBAAiB;QAC/B,OAAO;KACR,CAAC;AACJ,CAAC;AA1HD,wEA0HC","sourcesContent":["import type { NetworkClient } from './create-network-client';\nimport { createNetworkClient } from './create-network-client';\nimport type {\n  BlockTracker,\n  NetworkClientConfiguration,\n  Provider,\n} from './types';\n\n/**\n * The name of the method on both the provider and block tracker proxy which can\n * be used to get the underlying provider or block tracker from the network\n * client, when it is initialized.\n */\nconst REFLECTIVE_PROPERTY_NAME = '__target__';\n\n/**\n * Represents a proxy object which wraps a target object. As a proxy, it allows\n * for accessing and setting all of the properties that the target object\n * supports, but also supports an extra propertyName (`__target__`) to access\n * the target itself.\n *\n * @template Type - The type of the target object. It is assumed that this type\n * will be constant even when the target is swapped.\n */\nexport type ProxyWithAccessibleTarget<TargetType> = TargetType & {\n  [REFLECTIVE_PROPERTY_NAME]: TargetType;\n};\n\n/**\n * An object that provides the same interface as a network client but where the\n * network client is not initialized until either the provider or block tracker\n * is first accessed.\n */\nexport type AutoManagedNetworkClient<\n  Configuration extends NetworkClientConfiguration,\n> = {\n  configuration: Configuration;\n  provider: ProxyWithAccessibleTarget<Provider>;\n  blockTracker: ProxyWithAccessibleTarget<BlockTracker>;\n  destroy: () => void;\n};\n\n/**\n * By default, the provider and block provider proxies will point to nothing.\n * This is impossible when using the Proxy API, as the target object has to be\n * something, so this object represents that \"something\".\n */\n// TODO: Either fix this lint violation or explain why it's necessary to ignore.\n// eslint-disable-next-line @typescript-eslint/naming-convention\nconst UNINITIALIZED_TARGET = { __UNINITIALIZED__: true };\n\n/**\n * This function creates two proxies, one that wraps a provider and another that\n * wraps a block tracker. These proxies are unique in that both will be \"empty\"\n * at first; that is, neither will point to a functional provider or block\n * tracker. Instead, as soon as a method or event is accessed on either object\n * that requires a network request to function, a network client is created on\n * the fly and the method or event in question is then forwarded to whichever\n * part of the network client is serving as the receiver. The network client is\n * then cached for subsequent usages.\n *\n * @param networkClientConfiguration - The configuration object that will be\n * used to instantiate the network client when it is needed.\n * @returns The auto-managed network client.\n */\nexport function createAutoManagedNetworkClient<\n  Configuration extends NetworkClientConfiguration,\n>(\n  networkClientConfiguration: Configuration,\n): AutoManagedNetworkClient<Configuration> {\n  let networkClient: NetworkClient | undefined;\n\n  const providerProxy = new Proxy(UNINITIALIZED_TARGET, {\n    // TODO: Replace `any` with type\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    get(_target: any, propertyName: PropertyKey, receiver: unknown) {\n      if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n        return networkClient?.provider;\n      }\n\n      networkClient ??= createNetworkClient(networkClientConfiguration);\n      if (networkClient === undefined) {\n        throw new Error(\n          \"It looks like `createNetworkClient` didn't return anything. Perhaps it's being mocked?\",\n        );\n      }\n      const { provider } = networkClient;\n\n      if (propertyName in provider) {\n        // Typecast: We know that `[propertyName]` is a propertyName on\n        // `provider`.\n        const value = provider[propertyName as keyof typeof provider];\n        if (typeof value === 'function') {\n          // Ensure that the method on the provider is called with `this` as\n          // the target, *not* the proxy (which happens by default) —\n          // this allows private properties to be accessed\n          // TODO: Replace `any` with type\n          // eslint-disable-next-line @typescript-eslint/no-explicit-any\n          return function (this: unknown, ...args: any[]) {\n            // @ts-expect-error We don't care that `this` may not be compatible\n            // with the signature of the method being called, as technically\n            // it can be anything.\n            return value.apply(this === receiver ? provider : this, args);\n          };\n        }\n        return value;\n      }\n\n      return undefined;\n    },\n\n    // TODO: Replace `any` with type\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    has(_target: any, propertyName: PropertyKey) {\n      if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n        return true;\n      }\n      networkClient ??= createNetworkClient(networkClientConfiguration);\n      const { provider } = networkClient;\n      return propertyName in provider;\n    },\n  });\n\n  const blockTrackerProxy: ProxyWithAccessibleTarget<BlockTracker> = new Proxy(\n    UNINITIALIZED_TARGET,\n    {\n      // TODO: Replace `any` with type\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      get(_target: any, propertyName: PropertyKey, receiver: unknown) {\n        if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n          return networkClient?.blockTracker;\n        }\n\n        networkClient ??= createNetworkClient(networkClientConfiguration);\n        if (networkClient === undefined) {\n          throw new Error(\n            \"It looks like createNetworkClient returned undefined. Perhaps it's mocked?\",\n          );\n        }\n        const { blockTracker } = networkClient;\n\n        if (propertyName in blockTracker) {\n          // Typecast: We know that `[propertyName]` is a propertyName on\n          // `provider`.\n          const value = blockTracker[propertyName as keyof typeof blockTracker];\n          if (typeof value === 'function') {\n            // Ensure that the method on the provider is called with `this` as\n            // the target, *not* the proxy (which happens by default) —\n            // this allows private properties to be accessed\n            // TODO: Replace `any` with type\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            return function (this: unknown, ...args: any[]) {\n              // @ts-expect-error We don't care that `this` may not be\n              // compatible with the signature of the method being called, as\n              // technically it can be anything.\n              return value.apply(this === receiver ? blockTracker : this, args);\n            };\n          }\n          return value;\n        }\n\n        return undefined;\n      },\n\n      // TODO: Replace `any` with type\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      has(_target: any, propertyName: PropertyKey) {\n        if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n          return true;\n        }\n        networkClient ??= createNetworkClient(networkClientConfiguration);\n        const { blockTracker } = networkClient;\n        return propertyName in blockTracker;\n      },\n    },\n  );\n\n  const destroy = () => {\n    networkClient?.destroy();\n  };\n\n  return {\n    configuration: networkClientConfiguration,\n    provider: providerProxy,\n    blockTracker: blockTrackerProxy,\n    destroy,\n  };\n}\n"]}
+{"version":3,"file":"create-auto-managed-network-client.cjs","sourceRoot":"","sources":["../src/create-auto-managed-network-client.ts"],"names":[],"mappings":";;;AACA,uEAA8D;AAS9D;;;;GAIG;AACH,MAAM,wBAAwB,GAAG,YAAY,CAAC;AA6B9C;;;;GAIG;AACH,gFAAgF;AAChF,gEAAgE;AAChE,MAAM,oBAAoB,GAAG,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;AAEzD;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,8BAA8B,CAE5C,EACA,0BAA0B,EAC1B,oBAAoB,EACpB,SAAS,GAOV;IACC,IAAI,aAAwC,CAAC;IAE7C,MAAM,aAAa,GAAG,IAAI,KAAK,CAAC,oBAAoB,EAAE;QACpD,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB,EAAE,QAAiB;YAC5D,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,aAAa,EAAE,QAAQ,CAAC;aAChC;YAED,aAAa,KAAb,aAAa,GAAK,IAAA,2CAAmB,EAAC;gBACpC,aAAa,EAAE,0BAA0B;gBACzC,oBAAoB;gBACpB,SAAS;aACV,CAAC,EAAC;YACH,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC/B,MAAM,IAAI,KAAK,CACb,wFAAwF,CACzF,CAAC;aACH;YACD,MAAM,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;YAEnC,IAAI,YAAY,IAAI,QAAQ,EAAE;gBAC5B,+DAA+D;gBAC/D,cAAc;gBACd,MAAM,KAAK,GAAG,QAAQ,CAAC,YAAqC,CAAC,CAAC;gBAC9D,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;oBAC/B,kEAAkE;oBAClE,2DAA2D;oBAC3D,gDAAgD;oBAChD,gCAAgC;oBAChC,8DAA8D;oBAC9D,OAAO,UAAyB,GAAG,IAAW;wBAC5C,mEAAmE;wBACnE,gEAAgE;wBAChE,sBAAsB;wBACtB,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;oBAChE,CAAC,CAAC;iBACH;gBACD,OAAO,KAAK,CAAC;aACd;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB;YACzC,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,IAAI,CAAC;aACb;YACD,aAAa,KAAb,aAAa,GAAK,IAAA,2CAAmB,EAAC;gBACpC,aAAa,EAAE,0BAA0B;gBACzC,oBAAoB;gBACpB,SAAS;aACV,CAAC,EAAC;YACH,MAAM,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;YACnC,OAAO,YAAY,IAAI,QAAQ,CAAC;QAClC,CAAC;KACF,CAAC,CAAC;IAEH,MAAM,iBAAiB,GAA4C,IAAI,KAAK,CAC1E,oBAAoB,EACpB;QACE,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB,EAAE,QAAiB;YAC5D,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,aAAa,EAAE,YAAY,CAAC;aACpC;YAED,aAAa,KAAb,aAAa,GAAK,IAAA,2CAAmB,EAAC;gBACpC,aAAa,EAAE,0BAA0B;gBACzC,oBAAoB;gBACpB,SAAS;aACV,CAAC,EAAC;YACH,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC/B,MAAM,IAAI,KAAK,CACb,4EAA4E,CAC7E,CAAC;aACH;YACD,MAAM,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC;YAEvC,IAAI,YAAY,IAAI,YAAY,EAAE;gBAChC,+DAA+D;gBAC/D,cAAc;gBACd,MAAM,KAAK,GAAG,YAAY,CAAC,YAAyC,CAAC,CAAC;gBACtE,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;oBAC/B,kEAAkE;oBAClE,2DAA2D;oBAC3D,gDAAgD;oBAChD,gCAAgC;oBAChC,8DAA8D;oBAC9D,OAAO,UAAyB,GAAG,IAAW;wBAC5C,wDAAwD;wBACxD,+DAA+D;wBAC/D,kCAAkC;wBAClC,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;oBACpE,CAAC,CAAC;iBACH;gBACD,OAAO,KAAK,CAAC;aACd;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB;YACzC,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,IAAI,CAAC;aACb;YACD,aAAa,KAAb,aAAa,GAAK,IAAA,2CAAmB,EAAC;gBACpC,aAAa,EAAE,0BAA0B;gBACzC,oBAAoB;gBACpB,SAAS;aACV,CAAC,EAAC;YACH,MAAM,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC;YACvC,OAAO,YAAY,IAAI,YAAY,CAAC;QACtC,CAAC;KACF,CACF,CAAC;IAEF,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,aAAa,EAAE,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC;IAEF,OAAO;QACL,aAAa,EAAE,0BAA0B;QACzC,QAAQ,EAAE,aAAa;QACvB,YAAY,EAAE,iBAAiB;QAC/B,OAAO;KACR,CAAC;AACJ,CAAC;AAlJD,wEAkJC","sourcesContent":["import type { NetworkClient } from './create-network-client';\nimport { createNetworkClient } from './create-network-client';\nimport type { NetworkControllerMessenger } from './NetworkController';\nimport type { RpcServiceOptions } from './rpc-service/rpc-service';\nimport type {\n  BlockTracker,\n  NetworkClientConfiguration,\n  Provider,\n} from './types';\n\n/**\n * The name of the method on both the provider and block tracker proxy which can\n * be used to get the underlying provider or block tracker from the network\n * client, when it is initialized.\n */\nconst REFLECTIVE_PROPERTY_NAME = '__target__';\n\n/**\n * Represents a proxy object which wraps a target object. As a proxy, it allows\n * for accessing and setting all of the properties that the target object\n * supports, but also supports an extra propertyName (`__target__`) to access\n * the target itself.\n *\n * @template Type - The type of the target object. It is assumed that this type\n * will be constant even when the target is swapped.\n */\nexport type ProxyWithAccessibleTarget<TargetType> = TargetType & {\n  [REFLECTIVE_PROPERTY_NAME]: TargetType;\n};\n\n/**\n * An object that provides the same interface as a network client but where the\n * network client is not initialized until either the provider or block tracker\n * is first accessed.\n */\nexport type AutoManagedNetworkClient<\n  Configuration extends NetworkClientConfiguration,\n> = {\n  configuration: Configuration;\n  provider: ProxyWithAccessibleTarget<Provider>;\n  blockTracker: ProxyWithAccessibleTarget<BlockTracker>;\n  destroy: () => void;\n};\n\n/**\n * By default, the provider and block provider proxies will point to nothing.\n * This is impossible when using the Proxy API, as the target object has to be\n * something, so this object represents that \"something\".\n */\n// TODO: Either fix this lint violation or explain why it's necessary to ignore.\n// eslint-disable-next-line @typescript-eslint/naming-convention\nconst UNINITIALIZED_TARGET = { __UNINITIALIZED__: true };\n\n/**\n * This function creates two proxies, one that wraps a provider and another that\n * wraps a block tracker. These proxies are unique in that both will be \"empty\"\n * at first; that is, neither will point to a functional provider or block\n * tracker. Instead, as soon as a method or event is accessed on either object\n * that requires a network request to function, a network client is created on\n * the fly and the method or event in question is then forwarded to whichever\n * part of the network client is serving as the receiver. The network client is\n * then cached for subsequent usages.\n *\n * @param args - The arguments.\n * @param args.networkClientConfiguration - The configuration object that will be\n * used to instantiate the network client when it is needed.\n * @param args.getRpcServiceOptions - Factory for constructing RPC service\n * options. See {@link NetworkControllerOptions.getRpcServiceOptions}.\n * @param args.messenger - The network controller messenger.\n * @returns The auto-managed network client.\n */\nexport function createAutoManagedNetworkClient<\n  Configuration extends NetworkClientConfiguration,\n>({\n  networkClientConfiguration,\n  getRpcServiceOptions,\n  messenger,\n}: {\n  networkClientConfiguration: Configuration;\n  getRpcServiceOptions: (\n    rpcEndpointUrl: string,\n  ) => Omit<RpcServiceOptions, 'failoverService' | 'endpointUrl'>;\n  messenger: NetworkControllerMessenger;\n}): AutoManagedNetworkClient<Configuration> {\n  let networkClient: NetworkClient | undefined;\n\n  const providerProxy = new Proxy(UNINITIALIZED_TARGET, {\n    // TODO: Replace `any` with type\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    get(_target: any, propertyName: PropertyKey, receiver: unknown) {\n      if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n        return networkClient?.provider;\n      }\n\n      networkClient ??= createNetworkClient({\n        configuration: networkClientConfiguration,\n        getRpcServiceOptions,\n        messenger,\n      });\n      if (networkClient === undefined) {\n        throw new Error(\n          \"It looks like `createNetworkClient` didn't return anything. Perhaps it's being mocked?\",\n        );\n      }\n      const { provider } = networkClient;\n\n      if (propertyName in provider) {\n        // Typecast: We know that `[propertyName]` is a propertyName on\n        // `provider`.\n        const value = provider[propertyName as keyof typeof provider];\n        if (typeof value === 'function') {\n          // Ensure that the method on the provider is called with `this` as\n          // the target, *not* the proxy (which happens by default) —\n          // this allows private properties to be accessed\n          // TODO: Replace `any` with type\n          // eslint-disable-next-line @typescript-eslint/no-explicit-any\n          return function (this: unknown, ...args: any[]) {\n            // @ts-expect-error We don't care that `this` may not be compatible\n            // with the signature of the method being called, as technically\n            // it can be anything.\n            return value.apply(this === receiver ? provider : this, args);\n          };\n        }\n        return value;\n      }\n\n      return undefined;\n    },\n\n    // TODO: Replace `any` with type\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    has(_target: any, propertyName: PropertyKey) {\n      if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n        return true;\n      }\n      networkClient ??= createNetworkClient({\n        configuration: networkClientConfiguration,\n        getRpcServiceOptions,\n        messenger,\n      });\n      const { provider } = networkClient;\n      return propertyName in provider;\n    },\n  });\n\n  const blockTrackerProxy: ProxyWithAccessibleTarget<BlockTracker> = new Proxy(\n    UNINITIALIZED_TARGET,\n    {\n      // TODO: Replace `any` with type\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      get(_target: any, propertyName: PropertyKey, receiver: unknown) {\n        if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n          return networkClient?.blockTracker;\n        }\n\n        networkClient ??= createNetworkClient({\n          configuration: networkClientConfiguration,\n          getRpcServiceOptions,\n          messenger,\n        });\n        if (networkClient === undefined) {\n          throw new Error(\n            \"It looks like createNetworkClient returned undefined. Perhaps it's mocked?\",\n          );\n        }\n        const { blockTracker } = networkClient;\n\n        if (propertyName in blockTracker) {\n          // Typecast: We know that `[propertyName]` is a propertyName on\n          // `provider`.\n          const value = blockTracker[propertyName as keyof typeof blockTracker];\n          if (typeof value === 'function') {\n            // Ensure that the method on the provider is called with `this` as\n            // the target, *not* the proxy (which happens by default) —\n            // this allows private properties to be accessed\n            // TODO: Replace `any` with type\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            return function (this: unknown, ...args: any[]) {\n              // @ts-expect-error We don't care that `this` may not be\n              // compatible with the signature of the method being called, as\n              // technically it can be anything.\n              return value.apply(this === receiver ? blockTracker : this, args);\n            };\n          }\n          return value;\n        }\n\n        return undefined;\n      },\n\n      // TODO: Replace `any` with type\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      has(_target: any, propertyName: PropertyKey) {\n        if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n          return true;\n        }\n        networkClient ??= createNetworkClient({\n          configuration: networkClientConfiguration,\n          getRpcServiceOptions,\n          messenger,\n        });\n        const { blockTracker } = networkClient;\n        return propertyName in blockTracker;\n      },\n    },\n  );\n\n  const destroy = () => {\n    networkClient?.destroy();\n  };\n\n  return {\n    configuration: networkClientConfiguration,\n    provider: providerProxy,\n    blockTracker: blockTrackerProxy,\n    destroy,\n  };\n}\n"]}

package/dist/create-auto-managed-network-client.d.cts

@@ -1,3 +1,5 @@
+import type { NetworkControllerMessenger } from "./NetworkController.cjs";
+import type { RpcServiceOptions } from "./rpc-service/rpc-service.cjs";
 import type { BlockTracker, NetworkClientConfiguration, Provider } from "./types.cjs";
 /**
  * The name of the method on both the provider and block tracker proxy which can
@@ -38,10 +40,18 @@ export type AutoManagedNetworkClient<Configuration extends NetworkClientConfigur
  * part of the network client is serving as the receiver. The network client is
  * then cached for subsequent usages.
  *
- * @param networkClientConfiguration - The configuration object that will be
+ * @param args - The arguments.
+ * @param args.networkClientConfiguration - The configuration object that will be
  * used to instantiate the network client when it is needed.
+ * @param args.getRpcServiceOptions - Factory for constructing RPC service
+ * options. See {@link NetworkControllerOptions.getRpcServiceOptions}.
+ * @param args.messenger - The network controller messenger.
  * @returns The auto-managed network client.
  */
-export declare function createAutoManagedNetworkClient<Configuration extends NetworkClientConfiguration>(networkClientConfiguration: Configuration): AutoManagedNetworkClient<Configuration>;
+export declare function createAutoManagedNetworkClient<Configuration extends NetworkClientConfiguration>({ networkClientConfiguration, getRpcServiceOptions, messenger, }: {
+    networkClientConfiguration: Configuration;
+    getRpcServiceOptions: (rpcEndpointUrl: string) => Omit<RpcServiceOptions, 'failoverService' | 'endpointUrl'>;
+    messenger: NetworkControllerMessenger;
+}): AutoManagedNetworkClient<Configuration>;
 export {};
 //# sourceMappingURL=create-auto-managed-network-client.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"create-auto-managed-network-client.d.cts","sourceRoot":"","sources":["../src/create-auto-managed-network-client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,YAAY,EACZ,0BAA0B,EAC1B,QAAQ,EACT,oBAAgB;AAEjB;;;;GAIG;AACH,QAAA,MAAM,wBAAwB,eAAe,CAAC;AAE9C;;;;;;;;GAQG;AACH,MAAM,MAAM,yBAAyB,CAAC,UAAU,IAAI,UAAU,GAAG;IAC/D,CAAC,wBAAwB,CAAC,EAAE,UAAU,CAAC;CACxC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,CAClC,aAAa,SAAS,0BAA0B,IAC9C;IACF,aAAa,EAAE,aAAa,CAAC;IAC7B,QAAQ,EAAE,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IAC9C,YAAY,EAAE,yBAAyB,CAAC,YAAY,CAAC,CAAC;IACtD,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAWF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,8BAA8B,CAC5C,aAAa,SAAS,0BAA0B,EAEhD,0BAA0B,EAAE,aAAa,GACxC,wBAAwB,CAAC,aAAa,CAAC,CAsHzC"}
+{"version":3,"file":"create-auto-managed-network-client.d.cts","sourceRoot":"","sources":["../src/create-auto-managed-network-client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,0BAA0B,EAAE,gCAA4B;AACtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,sCAAkC;AACnE,OAAO,KAAK,EACV,YAAY,EACZ,0BAA0B,EAC1B,QAAQ,EACT,oBAAgB;AAEjB;;;;GAIG;AACH,QAAA,MAAM,wBAAwB,eAAe,CAAC;AAE9C;;;;;;;;GAQG;AACH,MAAM,MAAM,yBAAyB,CAAC,UAAU,IAAI,UAAU,GAAG;IAC/D,CAAC,wBAAwB,CAAC,EAAE,UAAU,CAAC;CACxC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,CAClC,aAAa,SAAS,0BAA0B,IAC9C;IACF,aAAa,EAAE,aAAa,CAAC;IAC7B,QAAQ,EAAE,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IAC9C,YAAY,EAAE,yBAAyB,CAAC,YAAY,CAAC,CAAC;IACtD,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAWF;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,8BAA8B,CAC5C,aAAa,SAAS,0BAA0B,EAChD,EACA,0BAA0B,EAC1B,oBAAoB,EACpB,SAAS,GACV,EAAE;IACD,0BAA0B,EAAE,aAAa,CAAC;IAC1C,oBAAoB,EAAE,CACpB,cAAc,EAAE,MAAM,KACnB,IAAI,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,aAAa,CAAC,CAAC;IAChE,SAAS,EAAE,0BAA0B,CAAC;CACvC,GAAG,wBAAwB,CAAC,aAAa,CAAC,CAsI1C"}

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

@@ -1,3 +1,5 @@
+import type { NetworkControllerMessenger } from "./NetworkController.mjs";
+import type { RpcServiceOptions } from "./rpc-service/rpc-service.mjs";
 import type { BlockTracker, NetworkClientConfiguration, Provider } from "./types.mjs";
 /**
  * The name of the method on both the provider and block tracker proxy which can
@@ -38,10 +40,18 @@ export type AutoManagedNetworkClient<Configuration extends NetworkClientConfigur
  * part of the network client is serving as the receiver. The network client is
  * then cached for subsequent usages.
  *
- * @param networkClientConfiguration - The configuration object that will be
+ * @param args - The arguments.
+ * @param args.networkClientConfiguration - The configuration object that will be
  * used to instantiate the network client when it is needed.
+ * @param args.getRpcServiceOptions - Factory for constructing RPC service
+ * options. See {@link NetworkControllerOptions.getRpcServiceOptions}.
+ * @param args.messenger - The network controller messenger.
  * @returns The auto-managed network client.
  */
-export declare function createAutoManagedNetworkClient<Configuration extends NetworkClientConfiguration>(networkClientConfiguration: Configuration): AutoManagedNetworkClient<Configuration>;
+export declare function createAutoManagedNetworkClient<Configuration extends NetworkClientConfiguration>({ networkClientConfiguration, getRpcServiceOptions, messenger, }: {
+    networkClientConfiguration: Configuration;
+    getRpcServiceOptions: (rpcEndpointUrl: string) => Omit<RpcServiceOptions, 'failoverService' | 'endpointUrl'>;
+    messenger: NetworkControllerMessenger;
+}): AutoManagedNetworkClient<Configuration>;
 export {};
 //# sourceMappingURL=create-auto-managed-network-client.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"create-auto-managed-network-client.d.mts","sourceRoot":"","sources":["../src/create-auto-managed-network-client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,YAAY,EACZ,0BAA0B,EAC1B,QAAQ,EACT,oBAAgB;AAEjB;;;;GAIG;AACH,QAAA,MAAM,wBAAwB,eAAe,CAAC;AAE9C;;;;;;;;GAQG;AACH,MAAM,MAAM,yBAAyB,CAAC,UAAU,IAAI,UAAU,GAAG;IAC/D,CAAC,wBAAwB,CAAC,EAAE,UAAU,CAAC;CACxC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,CAClC,aAAa,SAAS,0BAA0B,IAC9C;IACF,aAAa,EAAE,aAAa,CAAC;IAC7B,QAAQ,EAAE,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IAC9C,YAAY,EAAE,yBAAyB,CAAC,YAAY,CAAC,CAAC;IACtD,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAWF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,8BAA8B,CAC5C,aAAa,SAAS,0BAA0B,EAEhD,0BAA0B,EAAE,aAAa,GACxC,wBAAwB,CAAC,aAAa,CAAC,CAsHzC"}
+{"version":3,"file":"create-auto-managed-network-client.d.mts","sourceRoot":"","sources":["../src/create-auto-managed-network-client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,0BAA0B,EAAE,gCAA4B;AACtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,sCAAkC;AACnE,OAAO,KAAK,EACV,YAAY,EACZ,0BAA0B,EAC1B,QAAQ,EACT,oBAAgB;AAEjB;;;;GAIG;AACH,QAAA,MAAM,wBAAwB,eAAe,CAAC;AAE9C;;;;;;;;GAQG;AACH,MAAM,MAAM,yBAAyB,CAAC,UAAU,IAAI,UAAU,GAAG;IAC/D,CAAC,wBAAwB,CAAC,EAAE,UAAU,CAAC;CACxC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,CAClC,aAAa,SAAS,0BAA0B,IAC9C;IACF,aAAa,EAAE,aAAa,CAAC;IAC7B,QAAQ,EAAE,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IAC9C,YAAY,EAAE,yBAAyB,CAAC,YAAY,CAAC,CAAC;IACtD,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAWF;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,8BAA8B,CAC5C,aAAa,SAAS,0BAA0B,EAChD,EACA,0BAA0B,EAC1B,oBAAoB,EACpB,SAAS,GACV,EAAE;IACD,0BAA0B,EAAE,aAAa,CAAC;IAC1C,oBAAoB,EAAE,CACpB,cAAc,EAAE,MAAM,KACnB,IAAI,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,aAAa,CAAC,CAAC;IAChE,SAAS,EAAE,0BAA0B,CAAC;CACvC,GAAG,wBAAwB,CAAC,aAAa,CAAC,CAsI1C"}

package/dist/create-auto-managed-network-client.mjs

@@ -23,11 +23,15 @@ const UNINITIALIZED_TARGET = { __UNINITIALIZED__: true };
  * part of the network client is serving as the receiver. The network client is
  * then cached for subsequent usages.
  *
- * @param networkClientConfiguration - The configuration object that will be
+ * @param args - The arguments.
+ * @param args.networkClientConfiguration - The configuration object that will be
  * used to instantiate the network client when it is needed.
+ * @param args.getRpcServiceOptions - Factory for constructing RPC service
+ * options. See {@link NetworkControllerOptions.getRpcServiceOptions}.
+ * @param args.messenger - The network controller messenger.
  * @returns The auto-managed network client.
  */
-export function createAutoManagedNetworkClient(networkClientConfiguration) {
+export function createAutoManagedNetworkClient({ networkClientConfiguration, getRpcServiceOptions, messenger, }) {
     let networkClient;
     const providerProxy = new Proxy(UNINITIALIZED_TARGET, {
         // TODO: Replace `any` with type
@@ -36,7 +40,11 @@ export function createAutoManagedNetworkClient(networkClientConfiguration) {
             if (propertyName === REFLECTIVE_PROPERTY_NAME) {
                 return networkClient?.provider;
             }
-            networkClient ?? (networkClient = createNetworkClient(networkClientConfiguration));
+            networkClient ?? (networkClient = createNetworkClient({
+                configuration: networkClientConfiguration,
+                getRpcServiceOptions,
+                messenger,
+            }));
             if (networkClient === undefined) {
                 throw new Error("It looks like `createNetworkClient` didn't return anything. Perhaps it's being mocked?");
             }
@@ -68,7 +76,11 @@ export function createAutoManagedNetworkClient(networkClientConfiguration) {
             if (propertyName === REFLECTIVE_PROPERTY_NAME) {
                 return true;
             }
-            networkClient ?? (networkClient = createNetworkClient(networkClientConfiguration));
+            networkClient ?? (networkClient = createNetworkClient({
+                configuration: networkClientConfiguration,
+                getRpcServiceOptions,
+                messenger,
+            }));
             const { provider } = networkClient;
             return propertyName in provider;
         },
@@ -80,7 +92,11 @@ export function createAutoManagedNetworkClient(networkClientConfiguration) {
             if (propertyName === REFLECTIVE_PROPERTY_NAME) {
                 return networkClient?.blockTracker;
             }
-            networkClient ?? (networkClient = createNetworkClient(networkClientConfiguration));
+            networkClient ?? (networkClient = createNetworkClient({
+                configuration: networkClientConfiguration,
+                getRpcServiceOptions,
+                messenger,
+            }));
             if (networkClient === undefined) {
                 throw new Error("It looks like createNetworkClient returned undefined. Perhaps it's mocked?");
             }
@@ -112,7 +128,11 @@ export function createAutoManagedNetworkClient(networkClientConfiguration) {
             if (propertyName === REFLECTIVE_PROPERTY_NAME) {
                 return true;
             }
-            networkClient ?? (networkClient = createNetworkClient(networkClientConfiguration));
+            networkClient ?? (networkClient = createNetworkClient({
+                configuration: networkClientConfiguration,
+                getRpcServiceOptions,
+                messenger,
+            }));
             const { blockTracker } = networkClient;
             return propertyName in blockTracker;
         },

package/dist/create-auto-managed-network-client.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"create-auto-managed-network-client.mjs","sourceRoot":"","sources":["../src/create-auto-managed-network-client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,oCAAgC;AAO9D;;;;GAIG;AACH,MAAM,wBAAwB,GAAG,YAAY,CAAC;AA6B9C;;;;GAIG;AACH,gFAAgF;AAChF,gEAAgE;AAChE,MAAM,oBAAoB,GAAG,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;AAEzD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,8BAA8B,CAG5C,0BAAyC;IAEzC,IAAI,aAAwC,CAAC;IAE7C,MAAM,aAAa,GAAG,IAAI,KAAK,CAAC,oBAAoB,EAAE;QACpD,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB,EAAE,QAAiB;YAC5D,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,aAAa,EAAE,QAAQ,CAAC;aAChC;YAED,aAAa,KAAb,aAAa,GAAK,mBAAmB,CAAC,0BAA0B,CAAC,EAAC;YAClE,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC/B,MAAM,IAAI,KAAK,CACb,wFAAwF,CACzF,CAAC;aACH;YACD,MAAM,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;YAEnC,IAAI,YAAY,IAAI,QAAQ,EAAE;gBAC5B,+DAA+D;gBAC/D,cAAc;gBACd,MAAM,KAAK,GAAG,QAAQ,CAAC,YAAqC,CAAC,CAAC;gBAC9D,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;oBAC/B,kEAAkE;oBAClE,2DAA2D;oBAC3D,gDAAgD;oBAChD,gCAAgC;oBAChC,8DAA8D;oBAC9D,OAAO,UAAyB,GAAG,IAAW;wBAC5C,mEAAmE;wBACnE,gEAAgE;wBAChE,sBAAsB;wBACtB,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;oBAChE,CAAC,CAAC;iBACH;gBACD,OAAO,KAAK,CAAC;aACd;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB;YACzC,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,IAAI,CAAC;aACb;YACD,aAAa,KAAb,aAAa,GAAK,mBAAmB,CAAC,0BAA0B,CAAC,EAAC;YAClE,MAAM,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;YACnC,OAAO,YAAY,IAAI,QAAQ,CAAC;QAClC,CAAC;KACF,CAAC,CAAC;IAEH,MAAM,iBAAiB,GAA4C,IAAI,KAAK,CAC1E,oBAAoB,EACpB;QACE,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB,EAAE,QAAiB;YAC5D,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,aAAa,EAAE,YAAY,CAAC;aACpC;YAED,aAAa,KAAb,aAAa,GAAK,mBAAmB,CAAC,0BAA0B,CAAC,EAAC;YAClE,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC/B,MAAM,IAAI,KAAK,CACb,4EAA4E,CAC7E,CAAC;aACH;YACD,MAAM,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC;YAEvC,IAAI,YAAY,IAAI,YAAY,EAAE;gBAChC,+DAA+D;gBAC/D,cAAc;gBACd,MAAM,KAAK,GAAG,YAAY,CAAC,YAAyC,CAAC,CAAC;gBACtE,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;oBAC/B,kEAAkE;oBAClE,2DAA2D;oBAC3D,gDAAgD;oBAChD,gCAAgC;oBAChC,8DAA8D;oBAC9D,OAAO,UAAyB,GAAG,IAAW;wBAC5C,wDAAwD;wBACxD,+DAA+D;wBAC/D,kCAAkC;wBAClC,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;oBACpE,CAAC,CAAC;iBACH;gBACD,OAAO,KAAK,CAAC;aACd;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB;YACzC,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,IAAI,CAAC;aACb;YACD,aAAa,KAAb,aAAa,GAAK,mBAAmB,CAAC,0BAA0B,CAAC,EAAC;YAClE,MAAM,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC;YACvC,OAAO,YAAY,IAAI,YAAY,CAAC;QACtC,CAAC;KACF,CACF,CAAC;IAEF,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,aAAa,EAAE,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC;IAEF,OAAO;QACL,aAAa,EAAE,0BAA0B;QACzC,QAAQ,EAAE,aAAa;QACvB,YAAY,EAAE,iBAAiB;QAC/B,OAAO;KACR,CAAC;AACJ,CAAC","sourcesContent":["import type { NetworkClient } from './create-network-client';\nimport { createNetworkClient } from './create-network-client';\nimport type {\n  BlockTracker,\n  NetworkClientConfiguration,\n  Provider,\n} from './types';\n\n/**\n * The name of the method on both the provider and block tracker proxy which can\n * be used to get the underlying provider or block tracker from the network\n * client, when it is initialized.\n */\nconst REFLECTIVE_PROPERTY_NAME = '__target__';\n\n/**\n * Represents a proxy object which wraps a target object. As a proxy, it allows\n * for accessing and setting all of the properties that the target object\n * supports, but also supports an extra propertyName (`__target__`) to access\n * the target itself.\n *\n * @template Type - The type of the target object. It is assumed that this type\n * will be constant even when the target is swapped.\n */\nexport type ProxyWithAccessibleTarget<TargetType> = TargetType & {\n  [REFLECTIVE_PROPERTY_NAME]: TargetType;\n};\n\n/**\n * An object that provides the same interface as a network client but where the\n * network client is not initialized until either the provider or block tracker\n * is first accessed.\n */\nexport type AutoManagedNetworkClient<\n  Configuration extends NetworkClientConfiguration,\n> = {\n  configuration: Configuration;\n  provider: ProxyWithAccessibleTarget<Provider>;\n  blockTracker: ProxyWithAccessibleTarget<BlockTracker>;\n  destroy: () => void;\n};\n\n/**\n * By default, the provider and block provider proxies will point to nothing.\n * This is impossible when using the Proxy API, as the target object has to be\n * something, so this object represents that \"something\".\n */\n// TODO: Either fix this lint violation or explain why it's necessary to ignore.\n// eslint-disable-next-line @typescript-eslint/naming-convention\nconst UNINITIALIZED_TARGET = { __UNINITIALIZED__: true };\n\n/**\n * This function creates two proxies, one that wraps a provider and another that\n * wraps a block tracker. These proxies are unique in that both will be \"empty\"\n * at first; that is, neither will point to a functional provider or block\n * tracker. Instead, as soon as a method or event is accessed on either object\n * that requires a network request to function, a network client is created on\n * the fly and the method or event in question is then forwarded to whichever\n * part of the network client is serving as the receiver. The network client is\n * then cached for subsequent usages.\n *\n * @param networkClientConfiguration - The configuration object that will be\n * used to instantiate the network client when it is needed.\n * @returns The auto-managed network client.\n */\nexport function createAutoManagedNetworkClient<\n  Configuration extends NetworkClientConfiguration,\n>(\n  networkClientConfiguration: Configuration,\n): AutoManagedNetworkClient<Configuration> {\n  let networkClient: NetworkClient | undefined;\n\n  const providerProxy = new Proxy(UNINITIALIZED_TARGET, {\n    // TODO: Replace `any` with type\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    get(_target: any, propertyName: PropertyKey, receiver: unknown) {\n      if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n        return networkClient?.provider;\n      }\n\n      networkClient ??= createNetworkClient(networkClientConfiguration);\n      if (networkClient === undefined) {\n        throw new Error(\n          \"It looks like `createNetworkClient` didn't return anything. Perhaps it's being mocked?\",\n        );\n      }\n      const { provider } = networkClient;\n\n      if (propertyName in provider) {\n        // Typecast: We know that `[propertyName]` is a propertyName on\n        // `provider`.\n        const value = provider[propertyName as keyof typeof provider];\n        if (typeof value === 'function') {\n          // Ensure that the method on the provider is called with `this` as\n          // the target, *not* the proxy (which happens by default) —\n          // this allows private properties to be accessed\n          // TODO: Replace `any` with type\n          // eslint-disable-next-line @typescript-eslint/no-explicit-any\n          return function (this: unknown, ...args: any[]) {\n            // @ts-expect-error We don't care that `this` may not be compatible\n            // with the signature of the method being called, as technically\n            // it can be anything.\n            return value.apply(this === receiver ? provider : this, args);\n          };\n        }\n        return value;\n      }\n\n      return undefined;\n    },\n\n    // TODO: Replace `any` with type\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    has(_target: any, propertyName: PropertyKey) {\n      if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n        return true;\n      }\n      networkClient ??= createNetworkClient(networkClientConfiguration);\n      const { provider } = networkClient;\n      return propertyName in provider;\n    },\n  });\n\n  const blockTrackerProxy: ProxyWithAccessibleTarget<BlockTracker> = new Proxy(\n    UNINITIALIZED_TARGET,\n    {\n      // TODO: Replace `any` with type\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      get(_target: any, propertyName: PropertyKey, receiver: unknown) {\n        if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n          return networkClient?.blockTracker;\n        }\n\n        networkClient ??= createNetworkClient(networkClientConfiguration);\n        if (networkClient === undefined) {\n          throw new Error(\n            \"It looks like createNetworkClient returned undefined. Perhaps it's mocked?\",\n          );\n        }\n        const { blockTracker } = networkClient;\n\n        if (propertyName in blockTracker) {\n          // Typecast: We know that `[propertyName]` is a propertyName on\n          // `provider`.\n          const value = blockTracker[propertyName as keyof typeof blockTracker];\n          if (typeof value === 'function') {\n            // Ensure that the method on the provider is called with `this` as\n            // the target, *not* the proxy (which happens by default) —\n            // this allows private properties to be accessed\n            // TODO: Replace `any` with type\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            return function (this: unknown, ...args: any[]) {\n              // @ts-expect-error We don't care that `this` may not be\n              // compatible with the signature of the method being called, as\n              // technically it can be anything.\n              return value.apply(this === receiver ? blockTracker : this, args);\n            };\n          }\n          return value;\n        }\n\n        return undefined;\n      },\n\n      // TODO: Replace `any` with type\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      has(_target: any, propertyName: PropertyKey) {\n        if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n          return true;\n        }\n        networkClient ??= createNetworkClient(networkClientConfiguration);\n        const { blockTracker } = networkClient;\n        return propertyName in blockTracker;\n      },\n    },\n  );\n\n  const destroy = () => {\n    networkClient?.destroy();\n  };\n\n  return {\n    configuration: networkClientConfiguration,\n    provider: providerProxy,\n    blockTracker: blockTrackerProxy,\n    destroy,\n  };\n}\n"]}
+{"version":3,"file":"create-auto-managed-network-client.mjs","sourceRoot":"","sources":["../src/create-auto-managed-network-client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,oCAAgC;AAS9D;;;;GAIG;AACH,MAAM,wBAAwB,GAAG,YAAY,CAAC;AA6B9C;;;;GAIG;AACH,gFAAgF;AAChF,gEAAgE;AAChE,MAAM,oBAAoB,GAAG,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;AAEzD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,8BAA8B,CAE5C,EACA,0BAA0B,EAC1B,oBAAoB,EACpB,SAAS,GAOV;IACC,IAAI,aAAwC,CAAC;IAE7C,MAAM,aAAa,GAAG,IAAI,KAAK,CAAC,oBAAoB,EAAE;QACpD,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB,EAAE,QAAiB;YAC5D,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,aAAa,EAAE,QAAQ,CAAC;aAChC;YAED,aAAa,KAAb,aAAa,GAAK,mBAAmB,CAAC;gBACpC,aAAa,EAAE,0BAA0B;gBACzC,oBAAoB;gBACpB,SAAS;aACV,CAAC,EAAC;YACH,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC/B,MAAM,IAAI,KAAK,CACb,wFAAwF,CACzF,CAAC;aACH;YACD,MAAM,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;YAEnC,IAAI,YAAY,IAAI,QAAQ,EAAE;gBAC5B,+DAA+D;gBAC/D,cAAc;gBACd,MAAM,KAAK,GAAG,QAAQ,CAAC,YAAqC,CAAC,CAAC;gBAC9D,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;oBAC/B,kEAAkE;oBAClE,2DAA2D;oBAC3D,gDAAgD;oBAChD,gCAAgC;oBAChC,8DAA8D;oBAC9D,OAAO,UAAyB,GAAG,IAAW;wBAC5C,mEAAmE;wBACnE,gEAAgE;wBAChE,sBAAsB;wBACtB,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;oBAChE,CAAC,CAAC;iBACH;gBACD,OAAO,KAAK,CAAC;aACd;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB;YACzC,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,IAAI,CAAC;aACb;YACD,aAAa,KAAb,aAAa,GAAK,mBAAmB,CAAC;gBACpC,aAAa,EAAE,0BAA0B;gBACzC,oBAAoB;gBACpB,SAAS;aACV,CAAC,EAAC;YACH,MAAM,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC;YACnC,OAAO,YAAY,IAAI,QAAQ,CAAC;QAClC,CAAC;KACF,CAAC,CAAC;IAEH,MAAM,iBAAiB,GAA4C,IAAI,KAAK,CAC1E,oBAAoB,EACpB;QACE,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB,EAAE,QAAiB;YAC5D,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,aAAa,EAAE,YAAY,CAAC;aACpC;YAED,aAAa,KAAb,aAAa,GAAK,mBAAmB,CAAC;gBACpC,aAAa,EAAE,0BAA0B;gBACzC,oBAAoB;gBACpB,SAAS;aACV,CAAC,EAAC;YACH,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC/B,MAAM,IAAI,KAAK,CACb,4EAA4E,CAC7E,CAAC;aACH;YACD,MAAM,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC;YAEvC,IAAI,YAAY,IAAI,YAAY,EAAE;gBAChC,+DAA+D;gBAC/D,cAAc;gBACd,MAAM,KAAK,GAAG,YAAY,CAAC,YAAyC,CAAC,CAAC;gBACtE,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;oBAC/B,kEAAkE;oBAClE,2DAA2D;oBAC3D,gDAAgD;oBAChD,gCAAgC;oBAChC,8DAA8D;oBAC9D,OAAO,UAAyB,GAAG,IAAW;wBAC5C,wDAAwD;wBACxD,+DAA+D;wBAC/D,kCAAkC;wBAClC,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;oBACpE,CAAC,CAAC;iBACH;gBACD,OAAO,KAAK,CAAC;aACd;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,gCAAgC;QAChC,8DAA8D;QAC9D,GAAG,CAAC,OAAY,EAAE,YAAyB;YACzC,IAAI,YAAY,KAAK,wBAAwB,EAAE;gBAC7C,OAAO,IAAI,CAAC;aACb;YACD,aAAa,KAAb,aAAa,GAAK,mBAAmB,CAAC;gBACpC,aAAa,EAAE,0BAA0B;gBACzC,oBAAoB;gBACpB,SAAS;aACV,CAAC,EAAC;YACH,MAAM,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC;YACvC,OAAO,YAAY,IAAI,YAAY,CAAC;QACtC,CAAC;KACF,CACF,CAAC;IAEF,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,aAAa,EAAE,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC;IAEF,OAAO;QACL,aAAa,EAAE,0BAA0B;QACzC,QAAQ,EAAE,aAAa;QACvB,YAAY,EAAE,iBAAiB;QAC/B,OAAO;KACR,CAAC;AACJ,CAAC","sourcesContent":["import type { NetworkClient } from './create-network-client';\nimport { createNetworkClient } from './create-network-client';\nimport type { NetworkControllerMessenger } from './NetworkController';\nimport type { RpcServiceOptions } from './rpc-service/rpc-service';\nimport type {\n  BlockTracker,\n  NetworkClientConfiguration,\n  Provider,\n} from './types';\n\n/**\n * The name of the method on both the provider and block tracker proxy which can\n * be used to get the underlying provider or block tracker from the network\n * client, when it is initialized.\n */\nconst REFLECTIVE_PROPERTY_NAME = '__target__';\n\n/**\n * Represents a proxy object which wraps a target object. As a proxy, it allows\n * for accessing and setting all of the properties that the target object\n * supports, but also supports an extra propertyName (`__target__`) to access\n * the target itself.\n *\n * @template Type - The type of the target object. It is assumed that this type\n * will be constant even when the target is swapped.\n */\nexport type ProxyWithAccessibleTarget<TargetType> = TargetType & {\n  [REFLECTIVE_PROPERTY_NAME]: TargetType;\n};\n\n/**\n * An object that provides the same interface as a network client but where the\n * network client is not initialized until either the provider or block tracker\n * is first accessed.\n */\nexport type AutoManagedNetworkClient<\n  Configuration extends NetworkClientConfiguration,\n> = {\n  configuration: Configuration;\n  provider: ProxyWithAccessibleTarget<Provider>;\n  blockTracker: ProxyWithAccessibleTarget<BlockTracker>;\n  destroy: () => void;\n};\n\n/**\n * By default, the provider and block provider proxies will point to nothing.\n * This is impossible when using the Proxy API, as the target object has to be\n * something, so this object represents that \"something\".\n */\n// TODO: Either fix this lint violation or explain why it's necessary to ignore.\n// eslint-disable-next-line @typescript-eslint/naming-convention\nconst UNINITIALIZED_TARGET = { __UNINITIALIZED__: true };\n\n/**\n * This function creates two proxies, one that wraps a provider and another that\n * wraps a block tracker. These proxies are unique in that both will be \"empty\"\n * at first; that is, neither will point to a functional provider or block\n * tracker. Instead, as soon as a method or event is accessed on either object\n * that requires a network request to function, a network client is created on\n * the fly and the method or event in question is then forwarded to whichever\n * part of the network client is serving as the receiver. The network client is\n * then cached for subsequent usages.\n *\n * @param args - The arguments.\n * @param args.networkClientConfiguration - The configuration object that will be\n * used to instantiate the network client when it is needed.\n * @param args.getRpcServiceOptions - Factory for constructing RPC service\n * options. See {@link NetworkControllerOptions.getRpcServiceOptions}.\n * @param args.messenger - The network controller messenger.\n * @returns The auto-managed network client.\n */\nexport function createAutoManagedNetworkClient<\n  Configuration extends NetworkClientConfiguration,\n>({\n  networkClientConfiguration,\n  getRpcServiceOptions,\n  messenger,\n}: {\n  networkClientConfiguration: Configuration;\n  getRpcServiceOptions: (\n    rpcEndpointUrl: string,\n  ) => Omit<RpcServiceOptions, 'failoverService' | 'endpointUrl'>;\n  messenger: NetworkControllerMessenger;\n}): AutoManagedNetworkClient<Configuration> {\n  let networkClient: NetworkClient | undefined;\n\n  const providerProxy = new Proxy(UNINITIALIZED_TARGET, {\n    // TODO: Replace `any` with type\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    get(_target: any, propertyName: PropertyKey, receiver: unknown) {\n      if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n        return networkClient?.provider;\n      }\n\n      networkClient ??= createNetworkClient({\n        configuration: networkClientConfiguration,\n        getRpcServiceOptions,\n        messenger,\n      });\n      if (networkClient === undefined) {\n        throw new Error(\n          \"It looks like `createNetworkClient` didn't return anything. Perhaps it's being mocked?\",\n        );\n      }\n      const { provider } = networkClient;\n\n      if (propertyName in provider) {\n        // Typecast: We know that `[propertyName]` is a propertyName on\n        // `provider`.\n        const value = provider[propertyName as keyof typeof provider];\n        if (typeof value === 'function') {\n          // Ensure that the method on the provider is called with `this` as\n          // the target, *not* the proxy (which happens by default) —\n          // this allows private properties to be accessed\n          // TODO: Replace `any` with type\n          // eslint-disable-next-line @typescript-eslint/no-explicit-any\n          return function (this: unknown, ...args: any[]) {\n            // @ts-expect-error We don't care that `this` may not be compatible\n            // with the signature of the method being called, as technically\n            // it can be anything.\n            return value.apply(this === receiver ? provider : this, args);\n          };\n        }\n        return value;\n      }\n\n      return undefined;\n    },\n\n    // TODO: Replace `any` with type\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    has(_target: any, propertyName: PropertyKey) {\n      if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n        return true;\n      }\n      networkClient ??= createNetworkClient({\n        configuration: networkClientConfiguration,\n        getRpcServiceOptions,\n        messenger,\n      });\n      const { provider } = networkClient;\n      return propertyName in provider;\n    },\n  });\n\n  const blockTrackerProxy: ProxyWithAccessibleTarget<BlockTracker> = new Proxy(\n    UNINITIALIZED_TARGET,\n    {\n      // TODO: Replace `any` with type\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      get(_target: any, propertyName: PropertyKey, receiver: unknown) {\n        if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n          return networkClient?.blockTracker;\n        }\n\n        networkClient ??= createNetworkClient({\n          configuration: networkClientConfiguration,\n          getRpcServiceOptions,\n          messenger,\n        });\n        if (networkClient === undefined) {\n          throw new Error(\n            \"It looks like createNetworkClient returned undefined. Perhaps it's mocked?\",\n          );\n        }\n        const { blockTracker } = networkClient;\n\n        if (propertyName in blockTracker) {\n          // Typecast: We know that `[propertyName]` is a propertyName on\n          // `provider`.\n          const value = blockTracker[propertyName as keyof typeof blockTracker];\n          if (typeof value === 'function') {\n            // Ensure that the method on the provider is called with `this` as\n            // the target, *not* the proxy (which happens by default) —\n            // this allows private properties to be accessed\n            // TODO: Replace `any` with type\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            return function (this: unknown, ...args: any[]) {\n              // @ts-expect-error We don't care that `this` may not be\n              // compatible with the signature of the method being called, as\n              // technically it can be anything.\n              return value.apply(this === receiver ? blockTracker : this, args);\n            };\n          }\n          return value;\n        }\n\n        return undefined;\n      },\n\n      // TODO: Replace `any` with type\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      has(_target: any, propertyName: PropertyKey) {\n        if (propertyName === REFLECTIVE_PROPERTY_NAME) {\n          return true;\n        }\n        networkClient ??= createNetworkClient({\n          configuration: networkClientConfiguration,\n          getRpcServiceOptions,\n          messenger,\n        });\n        const { blockTracker } = networkClient;\n        return propertyName in blockTracker;\n      },\n    },\n  );\n\n  const destroy = () => {\n    networkClient?.destroy();\n  };\n\n  return {\n    configuration: networkClientConfiguration,\n    provider: providerProxy,\n    blockTracker: blockTrackerProxy,\n    destroy,\n  };\n}\n"]}

package/dist/create-network-client.cjs

@@ -7,45 +7,84 @@ 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 json_rpc_engine_1 = require("@metamask/json-rpc-engine");
+const rpc_service_chain_1 = require("./rpc-service/rpc-service-chain.cjs");
 const types_1 = require("./types.cjs");
 const SECOND = 1000;
 /**
  * Create a JSON RPC network client for a specific network.
  *
- * @param networkConfig - The network configuration.
+ * @param args - The arguments.
+ * @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.
+ * See {@link NetworkControllerOptions.getRpcServiceOptions}.
  * @returns The network client.
  */
-function createNetworkClient(networkConfig) {
-    const rpcApiMiddleware = networkConfig.type === types_1.NetworkClientType.Infura
+function createNetworkClient({ configuration, getRpcServiceOptions, messenger, }) {
+    const primaryEndpointUrl = configuration.type === types_1.NetworkClientType.Infura
+        ? `https://${configuration.network}.infura.io/v3/${configuration.infuraProjectId}`
+        : configuration.rpcUrl;
+    const availableEndpointUrls = [
+        primaryEndpointUrl,
+        ...configuration.failoverRpcUrls,
+    ];
+    const rpcService = new rpc_service_chain_1.RpcServiceChain(availableEndpointUrls.map((endpointUrl) => ({
+        ...getRpcServiceOptions(endpointUrl),
+        endpointUrl,
+    })));
+    rpcService.onBreak(({ endpointUrl, failoverEndpointUrl, ...rest }) => {
+        let error;
+        if ('error' in rest) {
+            error = rest.error;
+        }
+        else if ('value' in rest) {
+            error = rest.value;
+        }
+        messenger.publish('NetworkController:rpcEndpointUnavailable', {
+            chainId: configuration.chainId,
+            endpointUrl,
+            failoverEndpointUrl,
+            error,
+        });
+    });
+    rpcService.onDegraded(({ endpointUrl }) => {
+        messenger.publish('NetworkController:rpcEndpointDegraded', {
+            endpointUrl,
+        });
+    });
+    rpcService.onRetry(({ endpointUrl, attempt }) => {
+        messenger.publish('NetworkController:rpcEndpointRequestRetried', {
+            endpointUrl,
+            attempt,
+        });
+    });
+    const rpcApiMiddleware = configuration.type === types_1.NetworkClientType.Infura
         ? (0, eth_json_rpc_infura_1.createInfuraMiddleware)({
-            network: networkConfig.network,
-            projectId: networkConfig.infuraProjectId,
-            maxAttempts: 5,
-            source: 'metamask',
+            rpcService,
+            options: {
+                source: 'metamask',
+            },
         })
-        : (0, eth_json_rpc_middleware_1.createFetchMiddleware)({
-            btoa: global.btoa,
-            fetch: global.fetch,
-            rpcUrl: networkConfig.rpcUrl,
-        });
+        : (0, eth_json_rpc_middleware_1.createFetchMiddleware)({ rpcService });
     const rpcProvider = (0, eth_json_rpc_provider_1.providerFromMiddleware)(rpcApiMiddleware);
-    const blockTrackerOpts = process.env.IN_TEST && networkConfig.type === 'custom'
+    const blockTrackerOpts = process.env.IN_TEST && configuration.type === types_1.NetworkClientType.Custom
         ? { pollingInterval: SECOND }
         : {};
     const blockTracker = new eth_block_tracker_1.PollingBlockTracker({
         ...blockTrackerOpts,
         provider: rpcProvider,
     });
-    const networkMiddleware = networkConfig.type === types_1.NetworkClientType.Infura
+    const networkMiddleware = configuration.type === types_1.NetworkClientType.Infura
         ? createInfuraNetworkMiddleware({
             blockTracker,
-            network: networkConfig.network,
+            network: configuration.network,
             rpcProvider,
             rpcApiMiddleware,
         })
         : createCustomNetworkMiddleware({
             blockTracker,
-            chainId: networkConfig.chainId,
+            chainId: configuration.chainId,
             rpcApiMiddleware,
         });
     const engine = new json_rpc_engine_1.JsonRpcEngine();
@@ -56,7 +95,7 @@ function createNetworkClient(networkConfig) {
         // eslint-disable-next-line @typescript-eslint/no-floating-promises
         blockTracker.destroy();
     };
-    return { configuration: networkConfig, provider, blockTracker, destroy };
+    return { configuration, provider, blockTracker, destroy };
 }
 exports.createNetworkClient = createNetworkClient;
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"create-network-client.cjs","sourceRoot":"","sources":["../src/create-network-client.ts"],"names":[],"mappings":";;;AACA,iEAAqD;AACrD,mEAAkE;AAClE,uEAAuE;AACvE,+EAQ2C;AAE3C,2EAGyC;AACzC,+DAKmC;AASnC,uCAA4C;AAE5C,MAAM,MAAM,GAAG,IAAI,CAAC;AAapB;;;;;GAKG;AACH,SAAgB,mBAAmB,CACjC,aAAyC;IAEzC,MAAM,gBAAgB,GACpB,aAAa,CAAC,IAAI,KAAK,yBAAiB,CAAC,MAAM;QAC7C,CAAC,CAAC,IAAA,4CAAsB,EAAC;YACrB,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,SAAS,EAAE,aAAa,CAAC,eAAe;YACxC,WAAW,EAAE,CAAC;YACd,MAAM,EAAE,UAAU;SACnB,CAAC;QACJ,CAAC,CAAC,IAAA,+CAAqB,EAAC;YACpB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,MAAM,EAAE,aAAa,CAAC,MAAM;SAC7B,CAAC,CAAC;IAET,MAAM,WAAW,GAAG,IAAA,8CAAsB,EAAC,gBAAgB,CAAC,CAAC;IAE7D,MAAM,gBAAgB,GACpB,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,aAAa,CAAC,IAAI,KAAK,QAAQ;QACpD,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE;QAC7B,CAAC,CAAC,EAAE,CAAC;IACT,MAAM,YAAY,GAAG,IAAI,uCAAmB,CAAC;QAC3C,GAAG,gBAAgB;QACnB,QAAQ,EAAE,WAAW;KACtB,CAAC,CAAC;IAEH,MAAM,iBAAiB,GACrB,aAAa,CAAC,IAAI,KAAK,yBAAiB,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,MAAM,GAAG,IAAI,+BAAa,EAAE,CAAC;IAEnC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAE/B,MAAM,QAAQ,GAAG,IAAA,0CAAkB,EAAC,MAAM,CAAC,CAAC;IAE5C,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,gFAAgF;QAChF,mEAAmE;QACnE,YAAY,CAAC,OAAO,EAAE,CAAC;IACzB,CAAC,CAAC;IAEF,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC;AAC3E,CAAC;AAvDD,kDAuDC;AAED;;;;;;;;;GASG;AACH,SAAS,6BAA6B,CAAC,EACrC,YAAY,EACZ,OAAO,EACP,WAAW,EACX,gBAAgB,GAMjB;IACC,OAAO,IAAA,iCAAe,EAAC;QACrB,iCAAiC,CAAC,EAAE,OAAO,EAAE,CAAC;QAC9C,IAAA,oDAA0B,EAAC,EAAE,YAAY,EAAE,CAAC;QAC5C,IAAA,uDAA6B,GAAE;QAC/B,IAAA,kDAAwB,EAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;QACjE,IAAA,sDAA4B,EAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;QACrE,IAAA,+DAAqC,EAAC,EAAE,YAAY,EAAE,CAAC;QACvD,gBAAgB;KACjB,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,iCAAiC,CAAC,EACzC,OAAO,GAGR;IACC,OAAO,IAAA,0CAAwB,EAAC;QAC9B,gFAAgF;QAChF,gEAAgE;QAChE,WAAW,EAAE,0BAAO,CAAC,OAAO,CAAC;KAC9B,CAAC,CAAC;AACL,CAAC;AAED,MAAM,uBAAuB,GAAG,CAC9B,OAAY,EAC4B,EAAE;IAC1C,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAC7B,IAAI,GAAG,CAAC,MAAM,KAAK,aAAa,EAAE;YAChC,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC;YACrB,OAAO,GAAG,EAAE,CAAC;SACd;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,SAAS,6BAA6B,CAAC,EACrC,YAAY,EACZ,OAAO,EACP,gBAAgB,GAKjB;IACC,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO;QACzC,CAAC,CAAC,CAAC,oCAAoC,EAAE,CAAC;QAC1C,CAAC,CAAC,EAAE,CAAC;IAEP,OAAO,IAAA,iCAAe,EAAC;QACrB,GAAG,eAAe;QAClB,uBAAuB,CAAC,OAAO,CAAC;QAChC,IAAA,yDAA+B,EAAC,EAAE,YAAY,EAAE,CAAC;QACjD,IAAA,oDAA0B,EAAC,EAAE,YAAY,EAAE,CAAC;QAC5C,IAAA,uDAA6B,GAAE;QAC/B,IAAA,+DAAqC,EAAC,EAAE,YAAY,EAAE,CAAC;QACvD,gBAAgB;KACjB,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAS,oCAAoC;IAC3C,OAAO,IAAA,uCAAqB,EAAC,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE;QAClD,IAAI,GAAG,CAAC,MAAM,KAAK,iBAAiB,EAAE;YACpC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;SACjE;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type { InfuraNetworkType } from '@metamask/controller-utils';\nimport { ChainId } from '@metamask/controller-utils';\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 type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';\nimport {\n  providerFromEngine,\n  providerFromMiddleware,\n} from '@metamask/eth-json-rpc-provider';\nimport {\n  createAsyncMiddleware,\n  createScaffoldMiddleware,\n  JsonRpcEngine,\n  mergeMiddleware,\n} from '@metamask/json-rpc-engine';\nimport type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport type { Hex, Json, JsonRpcParams } from '@metamask/utils';\n\nimport type {\n  BlockTracker,\n  NetworkClientConfiguration,\n  Provider,\n} from './types';\nimport { NetworkClientType } from './types';\n\nconst SECOND = 1000;\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\n/**\n * Create a JSON RPC network client for a specific network.\n *\n * @param networkConfig - The network configuration.\n * @returns The network client.\n */\nexport function createNetworkClient(\n  networkConfig: NetworkClientConfiguration,\n): NetworkClient {\n  const rpcApiMiddleware =\n    networkConfig.type === NetworkClientType.Infura\n      ? createInfuraMiddleware({\n          network: networkConfig.network,\n          projectId: networkConfig.infuraProjectId,\n          maxAttempts: 5,\n          source: 'metamask',\n        })\n      : createFetchMiddleware({\n          btoa: global.btoa,\n          fetch: global.fetch,\n          rpcUrl: networkConfig.rpcUrl,\n        });\n\n  const rpcProvider = providerFromMiddleware(rpcApiMiddleware);\n\n  const blockTrackerOpts =\n    process.env.IN_TEST && networkConfig.type === 'custom'\n      ? { pollingInterval: SECOND }\n      : {};\n  const blockTracker = new PollingBlockTracker({\n    ...blockTrackerOpts,\n    provider: rpcProvider,\n  });\n\n  const networkMiddleware =\n    networkConfig.type === NetworkClientType.Infura\n      ? createInfuraNetworkMiddleware({\n          blockTracker,\n          network: networkConfig.network,\n          rpcProvider,\n          rpcApiMiddleware,\n        })\n      : createCustomNetworkMiddleware({\n          blockTracker,\n          chainId: networkConfig.chainId,\n          rpcApiMiddleware,\n        });\n\n  const engine = new JsonRpcEngine();\n\n  engine.push(networkMiddleware);\n\n  const provider = providerFromEngine(engine);\n\n  const destroy = () => {\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: networkConfig, provider, blockTracker, destroy };\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.network - The Infura network 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  network,\n  rpcProvider,\n  rpcApiMiddleware,\n}: {\n  blockTracker: PollingBlockTracker;\n  network: InfuraNetworkType;\n  rpcProvider: SafeEventEmitterProvider;\n  rpcApiMiddleware: JsonRpcMiddleware<JsonRpcParams, Json>;\n}) {\n  return mergeMiddleware([\n    createNetworkAndChainIdMiddleware({ network }),\n    createBlockCacheMiddleware({ blockTracker }),\n    createInflightCacheMiddleware(),\n    createBlockRefMiddleware({ blockTracker, provider: rpcProvider }),\n    createRetryOnEmptyMiddleware({ blockTracker, provider: rpcProvider }),\n    createBlockTrackerInspectorMiddleware({ blockTracker }),\n    rpcApiMiddleware,\n  ]);\n}\n\n/**\n * Creates static method middleware.\n *\n * @param args - The Arguments.\n * @param args.network - The Infura network to use.\n * @returns The middleware that implements the eth_chainId method.\n */\nfunction createNetworkAndChainIdMiddleware({\n  network,\n}: {\n  network: InfuraNetworkType;\n}) {\n  return createScaffoldMiddleware({\n    // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n    // eslint-disable-next-line @typescript-eslint/naming-convention\n    eth_chainId: ChainId[network],\n  });\n}\n\nconst createChainIdMiddleware = (\n  chainId: Hex,\n): JsonRpcMiddleware<JsonRpcParams, Json> => {\n  return (req, res, next, end) => {\n    if (req.method === 'eth_chainId') {\n      res.result = chainId;\n      return end();\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: JsonRpcMiddleware<JsonRpcParams, Json>;\n}): JsonRpcMiddleware<JsonRpcParams, Json> {\n  const testMiddlewares = process.env.IN_TEST\n    ? [createEstimateGasDelayTestMiddleware()]\n    : [];\n\n  return mergeMiddleware([\n    ...testMiddlewares,\n    createChainIdMiddleware(chainId),\n    createBlockRefRewriteMiddleware({ blockTracker }),\n    createBlockCacheMiddleware({ blockTracker }),\n    createInflightCacheMiddleware(),\n    createBlockTrackerInspectorMiddleware({ blockTracker }),\n    rpcApiMiddleware,\n  ]);\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() {\n  return createAsyncMiddleware(async (req, _, next) => {\n    if (req.method === 'eth_estimateGas') {\n      await new Promise((resolve) => setTimeout(resolve, SECOND * 2));\n    }\n    return next();\n  });\n}\n"]}
+{"version":3,"file":"create-network-client.cjs","sourceRoot":"","sources":["../src/create-network-client.ts"],"names":[],"mappings":";;;AACA,iEAAqD;AACrD,mEAAkE;AAClE,uEAAuE;AACvE,+EAQ2C;AAE3C,2EAGyC;AACzC,+DAKmC;AAMnC,2EAAkE;AAMlE,uCAA4C;AAE5C,MAAM,MAAM,GAAG,IAAI,CAAC;AAapB;;;;;;;;;;GAUG;AACH,SAAgB,mBAAmB,CAAC,EAClC,aAAa,EACb,oBAAoB,EACpB,SAAS,GAOV;IACC,MAAM,kBAAkB,GACtB,aAAa,CAAC,IAAI,KAAK,yBAAiB,CAAC,MAAM;QAC7C,CAAC,CAAC,WAAW,aAAa,CAAC,OAAO,iBAAiB,aAAa,CAAC,eAAe,EAAE;QAClF,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC;IAC3B,MAAM,qBAAqB,GAAG;QAC5B,kBAAkB;QAClB,GAAG,aAAa,CAAC,eAAe;KACjC,CAAC;IACF,MAAM,UAAU,GAAG,IAAI,mCAAe,CACpC,qBAAqB,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC1C,GAAG,oBAAoB,CAAC,WAAW,CAAC;QACpC,WAAW;KACZ,CAAC,CAAC,CACJ,CAAC;IACF,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,WAAW,EAAE,mBAAmB,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE;QACnE,IAAI,KAAc,CAAC;QACnB,IAAI,OAAO,IAAI,IAAI,EAAE;YACnB,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;SACpB;aAAM,IAAI,OAAO,IAAI,IAAI,EAAE;YAC1B,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;SACpB;QAED,SAAS,CAAC,OAAO,CAAC,0CAA0C,EAAE;YAC5D,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,WAAW;YACX,mBAAmB;YACnB,KAAK;SACN,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE;QACxC,SAAS,CAAC,OAAO,CAAC,uCAAuC,EAAE;YACzD,WAAW;SACZ,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,EAAE;QAC9C,SAAS,CAAC,OAAO,CAAC,6CAA6C,EAAE;YAC/D,WAAW;YACX,OAAO;SACR,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,gBAAgB,GACpB,aAAa,CAAC,IAAI,KAAK,yBAAiB,CAAC,MAAM;QAC7C,CAAC,CAAC,IAAA,4CAAsB,EAAC;YACrB,UAAU;YACV,OAAO,EAAE;gBACP,MAAM,EAAE,UAAU;aACnB;SACF,CAAC;QACJ,CAAC,CAAC,IAAA,+CAAqB,EAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IAE5C,MAAM,WAAW,GAAG,IAAA,8CAAsB,EAAC,gBAAgB,CAAC,CAAC;IAE7D,MAAM,gBAAgB,GACpB,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,aAAa,CAAC,IAAI,KAAK,yBAAiB,CAAC,MAAM;QACpE,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE;QAC7B,CAAC,CAAC,EAAE,CAAC;IACT,MAAM,YAAY,GAAG,IAAI,uCAAmB,CAAC;QAC3C,GAAG,gBAAgB;QACnB,QAAQ,EAAE,WAAW;KACtB,CAAC,CAAC;IAEH,MAAM,iBAAiB,GACrB,aAAa,CAAC,IAAI,KAAK,yBAAiB,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,MAAM,GAAG,IAAI,+BAAa,EAAE,CAAC;IAEnC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAE/B,MAAM,QAAQ,GAAG,IAAA,0CAAkB,EAAC,MAAM,CAAC,CAAC;IAE5C,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,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;AApGD,kDAoGC;AAED;;;;;;;;;GASG;AACH,SAAS,6BAA6B,CAAC,EACrC,YAAY,EACZ,OAAO,EACP,WAAW,EACX,gBAAgB,GAMjB;IACC,OAAO,IAAA,iCAAe,EAAC;QACrB,iCAAiC,CAAC,EAAE,OAAO,EAAE,CAAC;QAC9C,IAAA,oDAA0B,EAAC,EAAE,YAAY,EAAE,CAAC;QAC5C,IAAA,uDAA6B,GAAE;QAC/B,IAAA,kDAAwB,EAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;QACjE,IAAA,sDAA4B,EAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;QACrE,IAAA,+DAAqC,EAAC,EAAE,YAAY,EAAE,CAAC;QACvD,gBAAgB;KACjB,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,iCAAiC,CAAC,EACzC,OAAO,GAGR;IACC,OAAO,IAAA,0CAAwB,EAAC;QAC9B,gFAAgF;QAChF,gEAAgE;QAChE,WAAW,EAAE,0BAAO,CAAC,OAAO,CAAC;KAC9B,CAAC,CAAC;AACL,CAAC;AAED,MAAM,uBAAuB,GAAG,CAC9B,OAAY,EAC4B,EAAE;IAC1C,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAC7B,IAAI,GAAG,CAAC,MAAM,KAAK,aAAa,EAAE;YAChC,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC;YACrB,OAAO,GAAG,EAAE,CAAC;SACd;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,SAAS,6BAA6B,CAAC,EACrC,YAAY,EACZ,OAAO,EACP,gBAAgB,GAKjB;IACC,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO;QACzC,CAAC,CAAC,CAAC,oCAAoC,EAAE,CAAC;QAC1C,CAAC,CAAC,EAAE,CAAC;IAEP,OAAO,IAAA,iCAAe,EAAC;QACrB,GAAG,eAAe;QAClB,uBAAuB,CAAC,OAAO,CAAC;QAChC,IAAA,yDAA+B,EAAC,EAAE,YAAY,EAAE,CAAC;QACjD,IAAA,oDAA0B,EAAC,EAAE,YAAY,EAAE,CAAC;QAC5C,IAAA,uDAA6B,GAAE;QAC/B,IAAA,+DAAqC,EAAC,EAAE,YAAY,EAAE,CAAC;QACvD,gBAAgB;KACjB,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAS,oCAAoC;IAC3C,OAAO,IAAA,uCAAqB,EAAC,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE;QAClD,IAAI,GAAG,CAAC,MAAM,KAAK,iBAAiB,EAAE;YACpC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;SACjE;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type { InfuraNetworkType } from '@metamask/controller-utils';\nimport { ChainId } from '@metamask/controller-utils';\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 type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';\nimport {\n  providerFromEngine,\n  providerFromMiddleware,\n} from '@metamask/eth-json-rpc-provider';\nimport {\n  createAsyncMiddleware,\n  createScaffoldMiddleware,\n  JsonRpcEngine,\n  mergeMiddleware,\n} from '@metamask/json-rpc-engine';\nimport type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport type { Hex, Json, JsonRpcParams } from '@metamask/utils';\n\nimport type { NetworkControllerMessenger } from './NetworkController';\nimport type { RpcServiceOptions } from './rpc-service/rpc-service';\nimport { RpcServiceChain } from './rpc-service/rpc-service-chain';\nimport type {\n  BlockTracker,\n  NetworkClientConfiguration,\n  Provider,\n} from './types';\nimport { NetworkClientType } from './types';\n\nconst SECOND = 1000;\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\n/**\n * Create a JSON RPC network client for a specific network.\n *\n * @param args - The arguments.\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 * See {@link NetworkControllerOptions.getRpcServiceOptions}.\n * @returns The network client.\n */\nexport function createNetworkClient({\n  configuration,\n  getRpcServiceOptions,\n  messenger,\n}: {\n  configuration: NetworkClientConfiguration;\n  getRpcServiceOptions: (\n    rpcEndpointUrl: string,\n  ) => Omit<RpcServiceOptions, 'failoverService' | 'endpointUrl'>;\n  messenger: NetworkControllerMessenger;\n}): NetworkClient {\n  const primaryEndpointUrl =\n    configuration.type === NetworkClientType.Infura\n      ? `https://${configuration.network}.infura.io/v3/${configuration.infuraProjectId}`\n      : configuration.rpcUrl;\n  const availableEndpointUrls = [\n    primaryEndpointUrl,\n    ...configuration.failoverRpcUrls,\n  ];\n  const rpcService = new RpcServiceChain(\n    availableEndpointUrls.map((endpointUrl) => ({\n      ...getRpcServiceOptions(endpointUrl),\n      endpointUrl,\n    })),\n  );\n  rpcService.onBreak(({ endpointUrl, failoverEndpointUrl, ...rest }) => {\n    let error: unknown;\n    if ('error' in rest) {\n      error = rest.error;\n    } else if ('value' in rest) {\n      error = rest.value;\n    }\n\n    messenger.publish('NetworkController:rpcEndpointUnavailable', {\n      chainId: configuration.chainId,\n      endpointUrl,\n      failoverEndpointUrl,\n      error,\n    });\n  });\n  rpcService.onDegraded(({ endpointUrl }) => {\n    messenger.publish('NetworkController:rpcEndpointDegraded', {\n      endpointUrl,\n    });\n  });\n  rpcService.onRetry(({ endpointUrl, attempt }) => {\n    messenger.publish('NetworkController:rpcEndpointRequestRetried', {\n      endpointUrl,\n      attempt,\n    });\n  });\n\n  const rpcApiMiddleware =\n    configuration.type === NetworkClientType.Infura\n      ? createInfuraMiddleware({\n          rpcService,\n          options: {\n            source: 'metamask',\n          },\n        })\n      : createFetchMiddleware({ rpcService });\n\n  const rpcProvider = providerFromMiddleware(rpcApiMiddleware);\n\n  const blockTrackerOpts =\n    process.env.IN_TEST && configuration.type === NetworkClientType.Custom\n      ? { pollingInterval: SECOND }\n      : {};\n  const blockTracker = new PollingBlockTracker({\n    ...blockTrackerOpts,\n    provider: rpcProvider,\n  });\n\n  const networkMiddleware =\n    configuration.type === NetworkClientType.Infura\n      ? createInfuraNetworkMiddleware({\n          blockTracker,\n          network: configuration.network,\n          rpcProvider,\n          rpcApiMiddleware,\n        })\n      : createCustomNetworkMiddleware({\n          blockTracker,\n          chainId: configuration.chainId,\n          rpcApiMiddleware,\n        });\n\n  const engine = new JsonRpcEngine();\n\n  engine.push(networkMiddleware);\n\n  const provider = providerFromEngine(engine);\n\n  const destroy = () => {\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 * Create middleware for infura.\n *\n * @param args - The arguments.\n * @param args.blockTracker - The block tracker to use.\n * @param args.network - The Infura network 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  network,\n  rpcProvider,\n  rpcApiMiddleware,\n}: {\n  blockTracker: PollingBlockTracker;\n  network: InfuraNetworkType;\n  rpcProvider: SafeEventEmitterProvider;\n  rpcApiMiddleware: JsonRpcMiddleware<JsonRpcParams, Json>;\n}) {\n  return mergeMiddleware([\n    createNetworkAndChainIdMiddleware({ network }),\n    createBlockCacheMiddleware({ blockTracker }),\n    createInflightCacheMiddleware(),\n    createBlockRefMiddleware({ blockTracker, provider: rpcProvider }),\n    createRetryOnEmptyMiddleware({ blockTracker, provider: rpcProvider }),\n    createBlockTrackerInspectorMiddleware({ blockTracker }),\n    rpcApiMiddleware,\n  ]);\n}\n\n/**\n * Creates static method middleware.\n *\n * @param args - The Arguments.\n * @param args.network - The Infura network to use.\n * @returns The middleware that implements the eth_chainId method.\n */\nfunction createNetworkAndChainIdMiddleware({\n  network,\n}: {\n  network: InfuraNetworkType;\n}) {\n  return createScaffoldMiddleware({\n    // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n    // eslint-disable-next-line @typescript-eslint/naming-convention\n    eth_chainId: ChainId[network],\n  });\n}\n\nconst createChainIdMiddleware = (\n  chainId: Hex,\n): JsonRpcMiddleware<JsonRpcParams, Json> => {\n  return (req, res, next, end) => {\n    if (req.method === 'eth_chainId') {\n      res.result = chainId;\n      return end();\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: JsonRpcMiddleware<JsonRpcParams, Json>;\n}): JsonRpcMiddleware<JsonRpcParams, Json> {\n  const testMiddlewares = process.env.IN_TEST\n    ? [createEstimateGasDelayTestMiddleware()]\n    : [];\n\n  return mergeMiddleware([\n    ...testMiddlewares,\n    createChainIdMiddleware(chainId),\n    createBlockRefRewriteMiddleware({ blockTracker }),\n    createBlockCacheMiddleware({ blockTracker }),\n    createInflightCacheMiddleware(),\n    createBlockTrackerInspectorMiddleware({ blockTracker }),\n    rpcApiMiddleware,\n  ]);\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() {\n  return createAsyncMiddleware(async (req, _, next) => {\n    if (req.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

@@ -1,3 +1,5 @@
+import type { NetworkControllerMessenger } from "./NetworkController.cjs";
+import type { RpcServiceOptions } from "./rpc-service/rpc-service.cjs";
 import type { BlockTracker, NetworkClientConfiguration, Provider } from "./types.cjs";
 /**
  * The pair of provider / block tracker that can be used to interface with the
@@ -12,8 +14,17 @@ export type NetworkClient = {
 /**
  * Create a JSON RPC network client for a specific network.
  *
- * @param networkConfig - The network configuration.
+ * @param args - The arguments.
+ * @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.
+ * See {@link NetworkControllerOptions.getRpcServiceOptions}.
  * @returns The network client.
  */
-export declare function createNetworkClient(networkConfig: NetworkClientConfiguration): NetworkClient;
+export declare function createNetworkClient({ configuration, getRpcServiceOptions, messenger, }: {
+    configuration: NetworkClientConfiguration;
+    getRpcServiceOptions: (rpcEndpointUrl: string) => Omit<RpcServiceOptions, 'failoverService' | 'endpointUrl'>;
+    messenger: NetworkControllerMessenger;
+}): NetworkClient;
 //# sourceMappingURL=create-network-client.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"create-network-client.d.cts","sourceRoot":"","sources":["../src/create-network-client.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EACV,YAAY,EACZ,0BAA0B,EAC1B,QAAQ,EACT,oBAAgB;AAKjB;;;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;AAEF;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,0BAA0B,GACxC,aAAa,CAqDf"}
+{"version":3,"file":"create-network-client.d.cts","sourceRoot":"","sources":["../src/create-network-client.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EAAE,0BAA0B,EAAE,gCAA4B;AACtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,sCAAkC;AAEnE,OAAO,KAAK,EACV,YAAY,EACZ,0BAA0B,EAC1B,QAAQ,EACT,oBAAgB;AAKjB;;;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;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,aAAa,EACb,oBAAoB,EACpB,SAAS,GACV,EAAE;IACD,aAAa,EAAE,0BAA0B,CAAC;IAC1C,oBAAoB,EAAE,CACpB,cAAc,EAAE,MAAM,KACnB,IAAI,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,aAAa,CAAC,CAAC;IAChE,SAAS,EAAE,0BAA0B,CAAC;CACvC,GAAG,aAAa,CA0FhB"}

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

@@ -1,3 +1,5 @@
+import type { NetworkControllerMessenger } from "./NetworkController.mjs";
+import type { RpcServiceOptions } from "./rpc-service/rpc-service.mjs";
 import type { BlockTracker, NetworkClientConfiguration, Provider } from "./types.mjs";
 /**
  * The pair of provider / block tracker that can be used to interface with the
@@ -12,8 +14,17 @@ export type NetworkClient = {
 /**
  * Create a JSON RPC network client for a specific network.
  *
- * @param networkConfig - The network configuration.
+ * @param args - The arguments.
+ * @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.
+ * See {@link NetworkControllerOptions.getRpcServiceOptions}.
  * @returns The network client.
  */
-export declare function createNetworkClient(networkConfig: NetworkClientConfiguration): NetworkClient;
+export declare function createNetworkClient({ configuration, getRpcServiceOptions, messenger, }: {
+    configuration: NetworkClientConfiguration;
+    getRpcServiceOptions: (rpcEndpointUrl: string) => Omit<RpcServiceOptions, 'failoverService' | 'endpointUrl'>;
+    messenger: NetworkControllerMessenger;
+}): NetworkClient;
 //# sourceMappingURL=create-network-client.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"create-network-client.d.mts","sourceRoot":"","sources":["../src/create-network-client.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EACV,YAAY,EACZ,0BAA0B,EAC1B,QAAQ,EACT,oBAAgB;AAKjB;;;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;AAEF;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,0BAA0B,GACxC,aAAa,CAqDf"}
+{"version":3,"file":"create-network-client.d.mts","sourceRoot":"","sources":["../src/create-network-client.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EAAE,0BAA0B,EAAE,gCAA4B;AACtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,sCAAkC;AAEnE,OAAO,KAAK,EACV,YAAY,EACZ,0BAA0B,EAC1B,QAAQ,EACT,oBAAgB;AAKjB;;;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;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,aAAa,EACb,oBAAoB,EACpB,SAAS,GACV,EAAE;IACD,aAAa,EAAE,0BAA0B,CAAC;IAC1C,oBAAoB,EAAE,CACpB,cAAc,EAAE,MAAM,KACnB,IAAI,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,aAAa,CAAC,CAAC;IAChE,SAAS,EAAE,0BAA0B,CAAC;CACvC,GAAG,aAAa,CA0FhB"}