@metamask-previews/sample-controllers 1.0.0-preview-f3f2e8c8 → 1.0.0-preview-1f079244

package/dist/sample-gas-prices-controller.d.cts

@@ -1,8 +1,9 @@
 import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
 import { BaseController } from "@metamask/base-controller";
+import type { NetworkControllerGetNetworkClientByIdAction, NetworkControllerStateChangeEvent } from "@metamask/network-controller";
 import type { Hex } from "@metamask/utils";
-import type { NetworkControllerGetStateAction } from "./network-controller-types.cjs";
-import type { SampleAbstractGasPricesService } from "./sample-gas-prices-service/index.cjs";
+import type { SampleGasPricesControllerMethodActions } from "./sample-gas-prices-controller-method-action-types.cjs";
+import type { SampleGasPricesServiceFetchGasPricesAction } from "./sample-gas-prices-service/sample-gas-prices-service-method-action-types.cjs";
 /**
  * The name of the {@link SampleGasPricesController}, used to namespace the
  * controller's actions and events and to namespace the controller's state data
@@ -35,61 +36,51 @@ type GasPrices = {
  */
 export type SampleGasPricesControllerState = {
     /**
-     * The registry of pet names, categorized by chain ID first and address
-     * second.
+     * Fetched gas prices categorized by chain ID.
      */
     gasPricesByChainId: {
         [chainId: Hex]: GasPrices;
     };
 };
 /**
- * The action which can be used to retrieve the state of the
- * {@link SampleGasPricesController}.
+ * Constructs the default {@link SampleGasPricesController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link SampleGasPricesController} state.
  */
-export type SampleGasPricesControllerGetStateAction = ControllerGetStateAction<typeof controllerName, SampleGasPricesControllerState>;
+export declare function getDefaultSampleGasPricesControllerState(): SampleGasPricesControllerState;
 /**
- * The action which can be used to update gas prices.
+ * Retrieves the state of the {@link SampleGasPricesController}.
  */
-export type SampleGasPricesControllerUpdateGasPricesAction = {
-    type: `${typeof controllerName}:updateGasPrices`;
-    handler: SampleGasPricesController['updateGasPrices'];
-};
+export type SampleGasPricesControllerGetStateAction = ControllerGetStateAction<typeof controllerName, SampleGasPricesControllerState>;
 /**
- * All actions that {@link SampleGasPricesController} registers, to be called
- * externally.
+ * Actions that {@link SampleGasPricesMessenger} exposes to other consumers.
  */
-export type SampleGasPricesControllerActions = SampleGasPricesControllerGetStateAction | SampleGasPricesControllerUpdateGasPricesAction;
+export type SampleGasPricesControllerActions = SampleGasPricesControllerGetStateAction | SampleGasPricesControllerMethodActions;
 /**
- * All actions that {@link SampleGasPricesController} calls internally.
+ * Actions from other messengers that {@link SampleGasPricesMessenger} calls.
  */
-type AllowedActions = NetworkControllerGetStateAction;
+type AllowedActions = NetworkControllerGetNetworkClientByIdAction | SampleGasPricesServiceFetchGasPricesAction;
 /**
- * The event that {@link SampleGasPricesController} publishes when updating state.
+ * Published when the state of {@link SampleGasPricesController} changes.
  */
 export type SampleGasPricesControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, SampleGasPricesControllerState>;
 /**
- * All events that {@link SampleGasPricesController} publishes, to be subscribed to
- * externally.
+ * Events that {@link SampleGasPricesMessenger} exposes to other consumers.
  */
 export type SampleGasPricesControllerEvents = SampleGasPricesControllerStateChangeEvent;
 /**
- * All events that {@link SampleGasPricesController} subscribes to internally.
+ * Events from other messengers that {@link SampleGasPricesMessenger} subscribes
+ * to.
  */
-type AllowedEvents = never;
+type AllowedEvents = NetworkControllerStateChangeEvent;
 /**
- * The messenger which is restricted to actions and events accessed by
+ * The messenger restricted to actions and events accessed by
  * {@link SampleGasPricesController}.
  */
 export type SampleGasPricesControllerMessenger = RestrictedMessenger<typeof controllerName, SampleGasPricesControllerActions | AllowedActions, SampleGasPricesControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
-/**
- * Constructs the default {@link SampleGasPricesController} state. This allows
- * consumers to provide a partial state object when initializing the controller
- * and also helps in constructing complete state objects for this controller in
- * tests.
- *
- * @returns The default {@link SampleGasPricesController} state.
- */
-export declare function getDefaultSampleGasPricesControllerState(): SampleGasPricesControllerState;
 /**
  * `SampleGasPricesController` fetches and persists gas prices for various chains.
  *
@@ -97,36 +88,60 @@ export declare function getDefaultSampleGasPricesControllerState(): SampleGasPri
  *
  * ``` ts
  * import { Messenger } from '@metamask/base-controller';
- * import {
- *   SampleGasPricesController,
- *   SampleGasPricesService
- * } from '@metamask/example-controllers';
+ * import type {
+ *   NetworkControllerActions,
+ *   NetworkControllerEvents,
+ * } from '@metamask/network-controller';
  * import type {
  *   SampleGasPricesControllerActions,
- *   SampleGasPricesControllerEvents
- * } from '@metamask/example-controllers';
- * import type { NetworkControllerGetStateAction } from '@metamask/network-controller';
+ *   SampleGasPricesControllerEvents,
+ *   SampleGasPricesServiceActions,
+ *   SampleGasPricesServiceEvents,
+ * } from '@metamask/sample-controllers';
+ * import {
+ *   SampleGasPricesController,
+ *   SampleGasPricesService,
+ *   selectGasPrices,
+ * } from '@metamask/sample-controllers';
  *
- * // Assuming that you're using this in the browser
- * const gasPricesService = new SampleGasPricesService({ fetch });
- * const rootMessenger = new Messenger<
- *  SampleGasPricesControllerActions | NetworkControllerGetStateAction,
- *  SampleGasPricesControllerEvents
+ * const globalMessenger = new Messenger<
+ *  SampleGasPricesServiceActions
+ *  | SampleGasPricesControllerActions
+ *  | NetworkControllerActions,
+ *  SampleGasPricesServiceEvents
+ *  | SampleGasPricesControllerEvents
+ *  | NetworkControllerEvents
  * >();
- * const gasPricesMessenger = rootMessenger.getRestricted({
- *   name: 'SampleGasPricesController',
- *   allowedActions: ['NetworkController:getState'],
+ * const gasPricesServiceMessenger = globalMessenger.getRestricted({
+ *   name: 'SampleGasPricesService',
+ *   allowedActions: [],
  *   allowedEvents: [],
  * });
- * const gasPricesController = new SampleGasPricesController({
- *   messenger: gasPricesMessenger,
- *   gasPricesService,
+ * // Instantiate the service to register its actions on the messenger
+ * new SampleGasPricesService({
+ *   messenger: gasPricesServiceMessenger,
+ *   // We assume you're using this in the browser.
+ *   fetch,
+ * });
+ * const gasPricesControllerMessenger = globalMessenger.getRestricted({
+ *   name: 'SampleGasPricesController',
+ *   allowedActions: ['NetworkController:getNetworkClientById'],
+ *   allowedEvents: ['NetworkController:stateChange'],
+ * });
+ * // Instantiate the controller to register its actions on the messenger
+ * new SampleGasPricesController({
+ *   messenger: gasPricesControllerMessenger,
  * });
  *
- * // Assuming that `NetworkController:getState` returns an object with a
- * // `chainId` of `0x42`...
- * await gasPricesController.updateGasPrices();
- * gasPricesController.state.gasPricesByChainId
+ * // Later...
+ * await globalMessenger.call(
+ *   'SampleGasPricesController:updateGasPrices',
+ *   { chainId: '0x42' },
+ * );
+ * const gasPricesControllerState = await globalMessenger.call(
+ *   'SampleGasPricesController:getState',
+ * );
+ * gasPricesControllerState.gasPricesByChainId
  * // => { '0x42': { low: 5, average: 10, high: 15, fetchedDate: '2024-01-02T00:00:00.000Z' } }
  * ```
  */
@@ -135,23 +150,25 @@ export declare class SampleGasPricesController extends BaseController<typeof con
     /**
      * Constructs a new {@link SampleGasPricesController}.
      *
-     * @param args - The arguments to the controller.
+     * @param args - The constructor arguments.
      * @param args.messenger - The messenger suited for this controller.
      * @param args.state - The desired state with which to initialize this
      * controller. Missing properties will be filled in with defaults.
-     * @param args.gasPricesService - The service object that will be used to
-     * obtain gas prices.
      */
-    constructor({ messenger, state, gasPricesService, }: {
+    constructor({ messenger, state, }: {
         messenger: SampleGasPricesControllerMessenger;
         state?: Partial<SampleGasPricesControllerState>;
-        gasPricesService: SampleAbstractGasPricesService;
     });
     /**
-     * Fetches the latest gas prices for the current chain, persisting them to
+     * Fetches the latest gas prices for the given chain and persists them to
      * state.
+     *
+     * @param args - The arguments to the function.
+     * @param args.chainId - The chain ID for which to fetch gas prices.
      */
-    updateGasPrices(): Promise<void>;
+    updateGasPrices({ chainId }: {
+        chainId: Hex;
+    }): Promise<void>;
 }
 export {};
 //# sourceMappingURL=sample-gas-prices-controller.d.cts.map

package/dist/sample-gas-prices-controller.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"sample-gas-prices-controller.d.cts","sourceRoot":"","sources":["../src/sample-gas-prices-controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EAEpB,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,OAAO,KAAK,EAAE,+BAA+B,EAAE,uCAAmC;AAClF,OAAO,KAAK,EAAE,8BAA8B,EAAE,8CAAoC;AAIlF;;;;GAIG;AACH,eAAO,MAAM,cAAc,8BAA8B,CAAC;AAI1D;;GAEG;AACH,KAAK,SAAS,GAAG;IACf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;;OAGG;IACH,kBAAkB,EAAE;QAClB,CAAC,OAAO,EAAE,GAAG,GAAG,SAAS,CAAC;KAC3B,CAAC;CACH,CAAC;AAcF;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GAAG,wBAAwB,CAC5E,OAAO,cAAc,EACrB,8BAA8B,CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,GAAG,OAAO,cAAc,kBAAkB,CAAC;IACjD,OAAO,EAAE,yBAAyB,CAAC,iBAAiB,CAAC,CAAC;CACvD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GACxC,uCAAuC,GACvC,8CAA8C,CAAC;AAEnD;;GAEG;AACH,KAAK,cAAc,GAAG,+BAA+B,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,yCAAyC,GACnD,0BAA0B,CACxB,OAAO,cAAc,EACrB,8BAA8B,CAC/B,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GACzC,yCAAyC,CAAC;AAE5C;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAAG,mBAAmB,CAClE,OAAO,cAAc,EACrB,gCAAgC,GAAG,cAAc,EACjD,+BAA+B,GAAG,aAAa,EAC/C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,wCAAwC,IAAI,8BAA8B,CAIzF;AAID;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,yBAA0B,SAAQ,cAAc,CAC3D,OAAO,cAAc,EACrB,8BAA8B,EAC9B,kCAAkC,CACnC;;IAMC;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,KAAK,EACL,gBAAgB,GACjB,EAAE;QACD,SAAS,EAAE,kCAAkC,CAAC;QAC9C,KAAK,CAAC,EAAE,OAAO,CAAC,8BAA8B,CAAC,CAAC;QAChD,gBAAgB,EAAE,8BAA8B,CAAC;KAClD;IAmBD;;;OAGG;IACG,eAAe;CAWtB"}
+{"version":3,"file":"sample-gas-prices-controller.d.cts","sourceRoot":"","sources":["../src/sample-gas-prices-controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EAEpB,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAEV,2CAA2C,EAC3C,iCAAiC,EAClC,qCAAqC;AACtC,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,OAAO,KAAK,EAAE,sCAAsC,EAAE,+DAA2D;AACjH,OAAO,KAAK,EAAE,0CAA0C,EAAE,sFAAkF;AAI5I;;;;GAIG;AACH,eAAO,MAAM,cAAc,8BAA8B,CAAC;AAI1D;;GAEG;AACH,KAAK,SAAS,GAAG;IACf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,kBAAkB,EAAE;QAClB,CAAC,OAAO,EAAE,GAAG,GAAG,SAAS,CAAC;KAC3B,CAAC;CACH,CAAC;AAcF;;;;;;;GAOG;AACH,wBAAgB,wCAAwC,IAAI,8BAA8B,CAIzF;AAMD;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAAG,wBAAwB,CAC5E,OAAO,cAAc,EACrB,8BAA8B,CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GACxC,uCAAuC,GACvC,sCAAsC,CAAC;AAE3C;;GAEG;AACH,KAAK,cAAc,GACf,2CAA2C,GAC3C,0CAA0C,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,yCAAyC,GACnD,0BAA0B,CACxB,OAAO,cAAc,EACrB,8BAA8B,CAC/B,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACzC,yCAAyC,CAAC;AAE5C;;;GAGG;AACH,KAAK,aAAa,GAAG,iCAAiC,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAAG,mBAAmB,CAClE,OAAO,cAAc,EACrB,gCAAgC,GAAG,cAAc,EACjD,+BAA+B,GAAG,aAAa,EAC/C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAIF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,qBAAa,yBAA0B,SAAQ,cAAc,CAC3D,OAAO,cAAc,EACrB,8BAA8B,EAC9B,kCAAkC,CACnC;;IAMC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,kCAAkC,CAAC;QAC9C,KAAK,CAAC,EAAE,OAAO,CAAC,8BAA8B,CAAC,CAAC;KACjD;IAwBD;;;;;;OAMG;IACG,eAAe,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,GAAG,CAAA;KAAE;CAmCpD"}

package/dist/sample-gas-prices-controller.d.mts

@@ -1,8 +1,9 @@
 import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
 import { BaseController } from "@metamask/base-controller";
+import type { NetworkControllerGetNetworkClientByIdAction, NetworkControllerStateChangeEvent } from "@metamask/network-controller";
 import type { Hex } from "@metamask/utils";
-import type { NetworkControllerGetStateAction } from "./network-controller-types.mjs";
-import type { SampleAbstractGasPricesService } from "./sample-gas-prices-service/index.mjs";
+import type { SampleGasPricesControllerMethodActions } from "./sample-gas-prices-controller-method-action-types.mjs";
+import type { SampleGasPricesServiceFetchGasPricesAction } from "./sample-gas-prices-service/sample-gas-prices-service-method-action-types.mjs";
 /**
  * The name of the {@link SampleGasPricesController}, used to namespace the
  * controller's actions and events and to namespace the controller's state data
@@ -35,61 +36,51 @@ type GasPrices = {
  */
 export type SampleGasPricesControllerState = {
     /**
-     * The registry of pet names, categorized by chain ID first and address
-     * second.
+     * Fetched gas prices categorized by chain ID.
      */
     gasPricesByChainId: {
         [chainId: Hex]: GasPrices;
     };
 };
 /**
- * The action which can be used to retrieve the state of the
- * {@link SampleGasPricesController}.
+ * Constructs the default {@link SampleGasPricesController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link SampleGasPricesController} state.
  */
-export type SampleGasPricesControllerGetStateAction = ControllerGetStateAction<typeof controllerName, SampleGasPricesControllerState>;
+export declare function getDefaultSampleGasPricesControllerState(): SampleGasPricesControllerState;
 /**
- * The action which can be used to update gas prices.
+ * Retrieves the state of the {@link SampleGasPricesController}.
  */
-export type SampleGasPricesControllerUpdateGasPricesAction = {
-    type: `${typeof controllerName}:updateGasPrices`;
-    handler: SampleGasPricesController['updateGasPrices'];
-};
+export type SampleGasPricesControllerGetStateAction = ControllerGetStateAction<typeof controllerName, SampleGasPricesControllerState>;
 /**
- * All actions that {@link SampleGasPricesController} registers, to be called
- * externally.
+ * Actions that {@link SampleGasPricesMessenger} exposes to other consumers.
  */
-export type SampleGasPricesControllerActions = SampleGasPricesControllerGetStateAction | SampleGasPricesControllerUpdateGasPricesAction;
+export type SampleGasPricesControllerActions = SampleGasPricesControllerGetStateAction | SampleGasPricesControllerMethodActions;
 /**
- * All actions that {@link SampleGasPricesController} calls internally.
+ * Actions from other messengers that {@link SampleGasPricesMessenger} calls.
  */
-type AllowedActions = NetworkControllerGetStateAction;
+type AllowedActions = NetworkControllerGetNetworkClientByIdAction | SampleGasPricesServiceFetchGasPricesAction;
 /**
- * The event that {@link SampleGasPricesController} publishes when updating state.
+ * Published when the state of {@link SampleGasPricesController} changes.
  */
 export type SampleGasPricesControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, SampleGasPricesControllerState>;
 /**
- * All events that {@link SampleGasPricesController} publishes, to be subscribed to
- * externally.
+ * Events that {@link SampleGasPricesMessenger} exposes to other consumers.
  */
 export type SampleGasPricesControllerEvents = SampleGasPricesControllerStateChangeEvent;
 /**
- * All events that {@link SampleGasPricesController} subscribes to internally.
+ * Events from other messengers that {@link SampleGasPricesMessenger} subscribes
+ * to.
  */
-type AllowedEvents = never;
+type AllowedEvents = NetworkControllerStateChangeEvent;
 /**
- * The messenger which is restricted to actions and events accessed by
+ * The messenger restricted to actions and events accessed by
  * {@link SampleGasPricesController}.
  */
 export type SampleGasPricesControllerMessenger = RestrictedMessenger<typeof controllerName, SampleGasPricesControllerActions | AllowedActions, SampleGasPricesControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
-/**
- * Constructs the default {@link SampleGasPricesController} state. This allows
- * consumers to provide a partial state object when initializing the controller
- * and also helps in constructing complete state objects for this controller in
- * tests.
- *
- * @returns The default {@link SampleGasPricesController} state.
- */
-export declare function getDefaultSampleGasPricesControllerState(): SampleGasPricesControllerState;
 /**
  * `SampleGasPricesController` fetches and persists gas prices for various chains.
  *
@@ -97,36 +88,60 @@ export declare function getDefaultSampleGasPricesControllerState(): SampleGasPri
  *
  * ``` ts
  * import { Messenger } from '@metamask/base-controller';
- * import {
- *   SampleGasPricesController,
- *   SampleGasPricesService
- * } from '@metamask/example-controllers';
+ * import type {
+ *   NetworkControllerActions,
+ *   NetworkControllerEvents,
+ * } from '@metamask/network-controller';
  * import type {
  *   SampleGasPricesControllerActions,
- *   SampleGasPricesControllerEvents
- * } from '@metamask/example-controllers';
- * import type { NetworkControllerGetStateAction } from '@metamask/network-controller';
+ *   SampleGasPricesControllerEvents,
+ *   SampleGasPricesServiceActions,
+ *   SampleGasPricesServiceEvents,
+ * } from '@metamask/sample-controllers';
+ * import {
+ *   SampleGasPricesController,
+ *   SampleGasPricesService,
+ *   selectGasPrices,
+ * } from '@metamask/sample-controllers';
  *
- * // Assuming that you're using this in the browser
- * const gasPricesService = new SampleGasPricesService({ fetch });
- * const rootMessenger = new Messenger<
- *  SampleGasPricesControllerActions | NetworkControllerGetStateAction,
- *  SampleGasPricesControllerEvents
+ * const globalMessenger = new Messenger<
+ *  SampleGasPricesServiceActions
+ *  | SampleGasPricesControllerActions
+ *  | NetworkControllerActions,
+ *  SampleGasPricesServiceEvents
+ *  | SampleGasPricesControllerEvents
+ *  | NetworkControllerEvents
  * >();
- * const gasPricesMessenger = rootMessenger.getRestricted({
- *   name: 'SampleGasPricesController',
- *   allowedActions: ['NetworkController:getState'],
+ * const gasPricesServiceMessenger = globalMessenger.getRestricted({
+ *   name: 'SampleGasPricesService',
+ *   allowedActions: [],
  *   allowedEvents: [],
  * });
- * const gasPricesController = new SampleGasPricesController({
- *   messenger: gasPricesMessenger,
- *   gasPricesService,
+ * // Instantiate the service to register its actions on the messenger
+ * new SampleGasPricesService({
+ *   messenger: gasPricesServiceMessenger,
+ *   // We assume you're using this in the browser.
+ *   fetch,
+ * });
+ * const gasPricesControllerMessenger = globalMessenger.getRestricted({
+ *   name: 'SampleGasPricesController',
+ *   allowedActions: ['NetworkController:getNetworkClientById'],
+ *   allowedEvents: ['NetworkController:stateChange'],
+ * });
+ * // Instantiate the controller to register its actions on the messenger
+ * new SampleGasPricesController({
+ *   messenger: gasPricesControllerMessenger,
  * });
  *
- * // Assuming that `NetworkController:getState` returns an object with a
- * // `chainId` of `0x42`...
- * await gasPricesController.updateGasPrices();
- * gasPricesController.state.gasPricesByChainId
+ * // Later...
+ * await globalMessenger.call(
+ *   'SampleGasPricesController:updateGasPrices',
+ *   { chainId: '0x42' },
+ * );
+ * const gasPricesControllerState = await globalMessenger.call(
+ *   'SampleGasPricesController:getState',
+ * );
+ * gasPricesControllerState.gasPricesByChainId
  * // => { '0x42': { low: 5, average: 10, high: 15, fetchedDate: '2024-01-02T00:00:00.000Z' } }
  * ```
  */
@@ -135,23 +150,25 @@ export declare class SampleGasPricesController extends BaseController<typeof con
     /**
      * Constructs a new {@link SampleGasPricesController}.
      *
-     * @param args - The arguments to the controller.
+     * @param args - The constructor arguments.
      * @param args.messenger - The messenger suited for this controller.
      * @param args.state - The desired state with which to initialize this
      * controller. Missing properties will be filled in with defaults.
-     * @param args.gasPricesService - The service object that will be used to
-     * obtain gas prices.
      */
-    constructor({ messenger, state, gasPricesService, }: {
+    constructor({ messenger, state, }: {
         messenger: SampleGasPricesControllerMessenger;
         state?: Partial<SampleGasPricesControllerState>;
-        gasPricesService: SampleAbstractGasPricesService;
     });
     /**
-     * Fetches the latest gas prices for the current chain, persisting them to
+     * Fetches the latest gas prices for the given chain and persists them to
      * state.
+     *
+     * @param args - The arguments to the function.
+     * @param args.chainId - The chain ID for which to fetch gas prices.
      */
-    updateGasPrices(): Promise<void>;
+    updateGasPrices({ chainId }: {
+        chainId: Hex;
+    }): Promise<void>;
 }
 export {};
 //# sourceMappingURL=sample-gas-prices-controller.d.mts.map

package/dist/sample-gas-prices-controller.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"sample-gas-prices-controller.d.mts","sourceRoot":"","sources":["../src/sample-gas-prices-controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EAEpB,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,OAAO,KAAK,EAAE,+BAA+B,EAAE,uCAAmC;AAClF,OAAO,KAAK,EAAE,8BAA8B,EAAE,8CAAoC;AAIlF;;;;GAIG;AACH,eAAO,MAAM,cAAc,8BAA8B,CAAC;AAI1D;;GAEG;AACH,KAAK,SAAS,GAAG;IACf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;;OAGG;IACH,kBAAkB,EAAE;QAClB,CAAC,OAAO,EAAE,GAAG,GAAG,SAAS,CAAC;KAC3B,CAAC;CACH,CAAC;AAcF;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GAAG,wBAAwB,CAC5E,OAAO,cAAc,EACrB,8BAA8B,CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,GAAG,OAAO,cAAc,kBAAkB,CAAC;IACjD,OAAO,EAAE,yBAAyB,CAAC,iBAAiB,CAAC,CAAC;CACvD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GACxC,uCAAuC,GACvC,8CAA8C,CAAC;AAEnD;;GAEG;AACH,KAAK,cAAc,GAAG,+BAA+B,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,yCAAyC,GACnD,0BAA0B,CACxB,OAAO,cAAc,EACrB,8BAA8B,CAC/B,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GACzC,yCAAyC,CAAC;AAE5C;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAAG,mBAAmB,CAClE,OAAO,cAAc,EACrB,gCAAgC,GAAG,cAAc,EACjD,+BAA+B,GAAG,aAAa,EAC/C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,wCAAwC,IAAI,8BAA8B,CAIzF;AAID;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,yBAA0B,SAAQ,cAAc,CAC3D,OAAO,cAAc,EACrB,8BAA8B,EAC9B,kCAAkC,CACnC;;IAMC;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,KAAK,EACL,gBAAgB,GACjB,EAAE;QACD,SAAS,EAAE,kCAAkC,CAAC;QAC9C,KAAK,CAAC,EAAE,OAAO,CAAC,8BAA8B,CAAC,CAAC;QAChD,gBAAgB,EAAE,8BAA8B,CAAC;KAClD;IAmBD;;;OAGG;IACG,eAAe;CAWtB"}
+{"version":3,"file":"sample-gas-prices-controller.d.mts","sourceRoot":"","sources":["../src/sample-gas-prices-controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EAEpB,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAEV,2CAA2C,EAC3C,iCAAiC,EAClC,qCAAqC;AACtC,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,OAAO,KAAK,EAAE,sCAAsC,EAAE,+DAA2D;AACjH,OAAO,KAAK,EAAE,0CAA0C,EAAE,sFAAkF;AAI5I;;;;GAIG;AACH,eAAO,MAAM,cAAc,8BAA8B,CAAC;AAI1D;;GAEG;AACH,KAAK,SAAS,GAAG;IACf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,kBAAkB,EAAE;QAClB,CAAC,OAAO,EAAE,GAAG,GAAG,SAAS,CAAC;KAC3B,CAAC;CACH,CAAC;AAcF;;;;;;;GAOG;AACH,wBAAgB,wCAAwC,IAAI,8BAA8B,CAIzF;AAMD;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAAG,wBAAwB,CAC5E,OAAO,cAAc,EACrB,8BAA8B,CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GACxC,uCAAuC,GACvC,sCAAsC,CAAC;AAE3C;;GAEG;AACH,KAAK,cAAc,GACf,2CAA2C,GAC3C,0CAA0C,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,yCAAyC,GACnD,0BAA0B,CACxB,OAAO,cAAc,EACrB,8BAA8B,CAC/B,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACzC,yCAAyC,CAAC;AAE5C;;;GAGG;AACH,KAAK,aAAa,GAAG,iCAAiC,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAAG,mBAAmB,CAClE,OAAO,cAAc,EACrB,gCAAgC,GAAG,cAAc,EACjD,+BAA+B,GAAG,aAAa,EAC/C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAIF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,qBAAa,yBAA0B,SAAQ,cAAc,CAC3D,OAAO,cAAc,EACrB,8BAA8B,EAC9B,kCAAkC,CACnC;;IAMC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,kCAAkC,CAAC;QAC9C,KAAK,CAAC,EAAE,OAAO,CAAC,8BAA8B,CAAC,CAAC;KACjD;IAwBD;;;;;;OAMG;IACG,eAAe,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,GAAG,CAAA;KAAE;CAmCpD"}

package/dist/sample-gas-prices-controller.mjs

@@ -1,15 +1,15 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
 var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
     if (kind === "m") throw new TypeError("Private method is not writable");
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _SampleGasPricesController_gasPricesService;
+var _SampleGasPricesController_instances, _SampleGasPricesController_selectedChainId, _SampleGasPricesController_onSelectedNetworkClientIdChange;
 import { BaseController } from "@metamask/base-controller";
 // === GENERAL ===
 /**
@@ -23,8 +23,10 @@ export const controllerName = 'SampleGasPricesController';
  */
 const gasPricesControllerMetadata = {
     gasPricesByChainId: {
+        includeInStateLogs: true,
         persist: true,
         anonymous: false,
+        usedInUi: true,
     },
 };
 /**
@@ -40,6 +42,8 @@ export function getDefaultSampleGasPricesControllerState() {
         gasPricesByChainId: {},
     };
 }
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = ['updateGasPrices'];
 // === CONTROLLER DEFINITION ===
 /**
  * `SampleGasPricesController` fetches and persists gas prices for various chains.
@@ -48,36 +52,60 @@ export function getDefaultSampleGasPricesControllerState() {
  *
  * ``` ts
  * import { Messenger } from '@metamask/base-controller';
- * import {
- *   SampleGasPricesController,
- *   SampleGasPricesService
- * } from '@metamask/example-controllers';
+ * import type {
+ *   NetworkControllerActions,
+ *   NetworkControllerEvents,
+ * } from '@metamask/network-controller';
  * import type {
  *   SampleGasPricesControllerActions,
- *   SampleGasPricesControllerEvents
- * } from '@metamask/example-controllers';
- * import type { NetworkControllerGetStateAction } from '@metamask/network-controller';
+ *   SampleGasPricesControllerEvents,
+ *   SampleGasPricesServiceActions,
+ *   SampleGasPricesServiceEvents,
+ * } from '@metamask/sample-controllers';
+ * import {
+ *   SampleGasPricesController,
+ *   SampleGasPricesService,
+ *   selectGasPrices,
+ * } from '@metamask/sample-controllers';
  *
- * // Assuming that you're using this in the browser
- * const gasPricesService = new SampleGasPricesService({ fetch });
- * const rootMessenger = new Messenger<
- *  SampleGasPricesControllerActions | NetworkControllerGetStateAction,
- *  SampleGasPricesControllerEvents
+ * const globalMessenger = new Messenger<
+ *  SampleGasPricesServiceActions
+ *  | SampleGasPricesControllerActions
+ *  | NetworkControllerActions,
+ *  SampleGasPricesServiceEvents
+ *  | SampleGasPricesControllerEvents
+ *  | NetworkControllerEvents
  * >();
- * const gasPricesMessenger = rootMessenger.getRestricted({
- *   name: 'SampleGasPricesController',
- *   allowedActions: ['NetworkController:getState'],
+ * const gasPricesServiceMessenger = globalMessenger.getRestricted({
+ *   name: 'SampleGasPricesService',
+ *   allowedActions: [],
  *   allowedEvents: [],
  * });
- * const gasPricesController = new SampleGasPricesController({
- *   messenger: gasPricesMessenger,
- *   gasPricesService,
+ * // Instantiate the service to register its actions on the messenger
+ * new SampleGasPricesService({
+ *   messenger: gasPricesServiceMessenger,
+ *   // We assume you're using this in the browser.
+ *   fetch,
+ * });
+ * const gasPricesControllerMessenger = globalMessenger.getRestricted({
+ *   name: 'SampleGasPricesController',
+ *   allowedActions: ['NetworkController:getNetworkClientById'],
+ *   allowedEvents: ['NetworkController:stateChange'],
+ * });
+ * // Instantiate the controller to register its actions on the messenger
+ * new SampleGasPricesController({
+ *   messenger: gasPricesControllerMessenger,
  * });
  *
- * // Assuming that `NetworkController:getState` returns an object with a
- * // `chainId` of `0x42`...
- * await gasPricesController.updateGasPrices();
- * gasPricesController.state.gasPricesByChainId
+ * // Later...
+ * await globalMessenger.call(
+ *   'SampleGasPricesController:updateGasPrices',
+ *   { chainId: '0x42' },
+ * );
+ * const gasPricesControllerState = await globalMessenger.call(
+ *   'SampleGasPricesController:getState',
+ * );
+ * gasPricesControllerState.gasPricesByChainId
  * // => { '0x42': { low: 5, average: 10, high: 15, fetchedDate: '2024-01-02T00:00:00.000Z' } }
  * ```
  */
@@ -85,14 +113,12 @@ export class SampleGasPricesController extends BaseController {
     /**
      * Constructs a new {@link SampleGasPricesController}.
      *
-     * @param args - The arguments to the controller.
+     * @param args - The constructor arguments.
      * @param args.messenger - The messenger suited for this controller.
      * @param args.state - The desired state with which to initialize this
      * controller. Missing properties will be filled in with defaults.
-     * @param args.gasPricesService - The service object that will be used to
-     * obtain gas prices.
      */
-    constructor({ messenger, state, gasPricesService, }) {
+    constructor({ messenger, state, }) {
         super({
             messenger,
             metadata: gasPricesControllerMetadata,
@@ -102,20 +128,23 @@ export class SampleGasPricesController extends BaseController {
                 ...state,
             },
         });
+        _SampleGasPricesController_instances.add(this);
         /**
-         * The service object that is used to obtain gas prices.
+         * The globally selected chain ID.
          */
-        _SampleGasPricesController_gasPricesService.set(this, void 0);
-        __classPrivateFieldSet(this, _SampleGasPricesController_gasPricesService, gasPricesService, "f");
-        this.messagingSystem.registerActionHandler(`${controllerName}:updateGasPrices`, this.updateGasPrices.bind(this));
+        _SampleGasPricesController_selectedChainId.set(this, void 0);
+        this.messagingSystem.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+        this.messagingSystem.subscribe('NetworkController:stateChange', __classPrivateFieldGet(this, _SampleGasPricesController_instances, "m", _SampleGasPricesController_onSelectedNetworkClientIdChange).bind(this), (networkControllerState) => networkControllerState.selectedNetworkClientId);
     }
     /**
-     * Fetches the latest gas prices for the current chain, persisting them to
+     * Fetches the latest gas prices for the given chain and persists them to
      * state.
+     *
+     * @param args - The arguments to the function.
+     * @param args.chainId - The chain ID for which to fetch gas prices.
      */
-    async updateGasPrices() {
-        const { chainId } = this.messagingSystem.call('NetworkController:getState');
-        const gasPricesResponse = await __classPrivateFieldGet(this, _SampleGasPricesController_gasPricesService, "f").fetchGasPrices(chainId);
+    async updateGasPrices({ chainId }) {
+        const gasPricesResponse = await this.messagingSystem.call('SampleGasPricesService:fetchGasPrices', chainId);
         this.update((state) => {
             state.gasPricesByChainId[chainId] = {
                 ...gasPricesResponse,
@@ -124,5 +153,18 @@ export class SampleGasPricesController extends BaseController {
         });
     }
 }
-_SampleGasPricesController_gasPricesService = new WeakMap();
+_SampleGasPricesController_selectedChainId = new WeakMap(), _SampleGasPricesController_instances = new WeakSet(), _SampleGasPricesController_onSelectedNetworkClientIdChange = 
+/**
+ * Callback to call when the globally selected network client ID changes,
+ * ensuring that gas prices get updated.
+ *
+ * @param selectedNetworkClientId - The globally selected network client ID.
+ */
+async function _SampleGasPricesController_onSelectedNetworkClientIdChange(selectedNetworkClientId) {
+    const { configuration: { chainId }, } = this.messagingSystem.call('NetworkController:getNetworkClientById', selectedNetworkClientId);
+    if (chainId !== __classPrivateFieldGet(this, _SampleGasPricesController_selectedChainId, "f")) {
+        __classPrivateFieldSet(this, _SampleGasPricesController_selectedChainId, chainId, "f");
+        await this.updateGasPrices({ chainId });
+    }
+};
 //# sourceMappingURL=sample-gas-prices-controller.mjs.map