@metamask-previews/sample-controllers 1.0.0-preview-aa8c4291 → 1.0.0-preview-e821953

package/dist/sample-petnames-controller.d.cts

@@ -1,6 +1,7 @@
 import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
 import { BaseController } from "@metamask/base-controller";
 import type { Hex } from "@metamask/utils";
+import type { SamplePetnamesControllerMethodActions } from "./sample-petnames-controller-method-action-types.cjs";
 /**
  * The name of the {@link SamplePetnamesController}, used to namespace the
  * controller's actions and events and to namespace the controller's state data
@@ -22,40 +23,47 @@ export type SamplePetnamesControllerState = {
     };
 };
 /**
- * The action which can be used to retrieve the state of the
- * {@link SamplePetnamesController}.
+ * Constructs the default {@link SamplePetnamesController} 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 SamplePetnamesController} state.
+ */
+export declare function getDefaultPetnamesControllerState(): SamplePetnamesControllerState;
+/**
+ * Retrieves the state of the {@link SamplePetnamesController}.
  */
 export type SamplePetnamesControllerGetStateAction = ControllerGetStateAction<typeof controllerName, SamplePetnamesControllerState>;
 /**
- * All actions that {@link SamplePetnamesController} registers, to be called
- * externally.
+ * Actions that {@link SampleGasPricesMessenger} exposes to other consumers.
  */
-export type SamplePetnamesControllerActions = SamplePetnamesControllerGetStateAction;
+export type SamplePetnamesControllerActions = SamplePetnamesControllerGetStateAction | SamplePetnamesControllerMethodActions;
 /**
- * All actions that {@link SamplePetnamesController} calls internally.
+ * Actions from other messengers that {@link SampleGasPricesMessenger} calls.
  */
 type AllowedActions = never;
 /**
- * The event that {@link SamplePetnamesController} publishes when updating state.
+ * Published when the state of {@link SamplePetnamesController} changes.
  */
 export type SamplePetnamesControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, SamplePetnamesControllerState>;
 /**
- * All events that {@link SamplePetnamesController} publishes, to be subscribed to
- * externally.
+ * Events that {@link SampleGasPricesMessenger} exposes to other consumers.
  */
 export type SamplePetnamesControllerEvents = SamplePetnamesControllerStateChangeEvent;
 /**
- * All events that {@link SamplePetnamesController} subscribes to internally.
+ * Events from other messengers that {@link SampleGasPricesMessenger} subscribes
+ * to.
  */
 type AllowedEvents = never;
 /**
- * The messenger which is restricted to actions and events accessed by
+ * The messenger restricted to actions and events accessed by
  * {@link SamplePetnamesController}.
  */
 export type SamplePetnamesControllerMessenger = RestrictedMessenger<typeof controllerName, SamplePetnamesControllerActions | AllowedActions, SamplePetnamesControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
 /**
- * `SamplePetnamesController` records user-provided nicknames for various addresses on
- * various chains.
+ * `SamplePetnamesController` records user-provided nicknames for various
+ * addresses on various chains.
  *
  * @example
  *
@@ -64,27 +72,34 @@ export type SamplePetnamesControllerMessenger = RestrictedMessenger<typeof contr
  * import type {
  *   SamplePetnamesControllerActions,
  *   SamplePetnamesControllerEvents
- * } from '@metamask/example-controllers';
+ * } from '@metamask/sample-controllers';
  *
- * const rootMessenger = new Messenger<
+ * const globalMessenger = new Messenger<
  *  SamplePetnamesControllerActions,
  *  SamplePetnamesControllerEvents
  * >();
- * const samplePetnamesMessenger = rootMessenger.getRestricted({
+ * const samplePetnamesMessenger = globalMessenger.getRestricted({
  *   name: 'SamplePetnamesController',
  *   allowedActions: [],
  *   allowedEvents: [],
  * });
- * const samplePetnamesController = new SamplePetnamesController({
+ * // Instantiate the controller to register its actions on the messenger
+ * new SamplePetnamesController({
  *   messenger: samplePetnamesMessenger,
  * });
  *
- * samplePetnamesController.assignPetname(
- *   '0x1',
- *   '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99',
- *   'Primary Account'
+ * globalMessenger.call(
+ *   'SamplePetnamesController:assignPetname',
+ *   [
+ *     '0x1',
+ *     '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99',
+ *     'Primary Account',
+ *   ],
+ * );
+ * const samplePetnamesControllerState = await globalMessenger.call(
+ *   'SamplePetnamesController:getState',
  * );
- * samplePetnamesController.state.namesByChainIdAndAddress
+ * samplePetnamesControllerState.namesByChainIdAndAddress
  * // => { '0x1': { '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99': 'Primary Account' } }
  * ```
  */
@@ -92,7 +107,7 @@ export declare class SamplePetnamesController extends BaseController<typeof cont
     /**
      * Constructs a new {@link SamplePetnamesController}.
      *
-     * @param args - The arguments to the controller.
+     * @param args - The arguments to this controller.
      * @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.

package/dist/sample-petnames-controller.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"sample-petnames-controller.d.cts","sourceRoot":"","sources":["../src/sample-petnames-controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EAEpB,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAI3C;;;;GAIG;AACH,eAAO,MAAM,cAAc,6BAA6B,CAAC;AAIzD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;OAGG;IACH,wBAAwB,EAAE;QACxB,CAAC,OAAO,EAAE,GAAG,GAAG;YACd,CAAC,OAAO,EAAE,GAAG,GAAG,MAAM,CAAC;SACxB,CAAC;KACH,CAAC;CACH,CAAC;AAcF;;;GAGG;AACH,MAAM,MAAM,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GACzC,sCAAsC,CAAC;AAEzC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAClD,0BAA0B,CACxB,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GACxC,wCAAwC,CAAC;AAE3C;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,mBAAmB,CACjE,OAAO,cAAc,EACrB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,EAC9C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAkBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,wBAAyB,SAAQ,cAAc,CAC1D,OAAO,cAAc,EACrB,6BAA6B,EAC7B,iCAAiC,CAClC;IACC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,iCAAiC,CAAC;QAC7C,KAAK,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC;KAChD;IAYD;;;;;;;OAOG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM;CAYvD"}
+{"version":3,"file":"sample-petnames-controller.d.cts","sourceRoot":"","sources":["../src/sample-petnames-controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EAEpB,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,OAAO,KAAK,EAAE,qCAAqC,EAAE,6DAAyD;AAI9G;;;;GAIG;AACH,eAAO,MAAM,cAAc,6BAA6B,CAAC;AAIzD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;OAGG;IACH,wBAAwB,EAAE;QACxB,CAAC,OAAO,EAAE,GAAG,GAAG;YACd,CAAC,OAAO,EAAE,GAAG,GAAG,MAAM,CAAC;SACxB,CAAC;KACH,CAAC;CACH,CAAC;AAYF;;;;;;;GAOG;AACH,wBAAgB,iCAAiC,IAAI,6BAA6B,CAIjF;AAMD;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,sCAAsC,GACtC,qCAAqC,CAAC;AAE1C;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAClD,0BAA0B,CACxB,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,wCAAwC,CAAC;AAE3C;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,mBAAmB,CACjE,OAAO,cAAc,EACrB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,EAC9C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAIF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,qBAAa,wBAAyB,SAAQ,cAAc,CAC1D,OAAO,cAAc,EACrB,6BAA6B,EAC7B,iCAAiC,CAClC;IACC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,iCAAiC,CAAC;QAC7C,KAAK,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC;KAChD;IAiBD;;;;;;;OAOG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM;CAYvD"}

package/dist/sample-petnames-controller.d.mts

@@ -1,6 +1,7 @@
 import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
 import { BaseController } from "@metamask/base-controller";
 import type { Hex } from "@metamask/utils";
+import type { SamplePetnamesControllerMethodActions } from "./sample-petnames-controller-method-action-types.mjs";
 /**
  * The name of the {@link SamplePetnamesController}, used to namespace the
  * controller's actions and events and to namespace the controller's state data
@@ -22,40 +23,47 @@ export type SamplePetnamesControllerState = {
     };
 };
 /**
- * The action which can be used to retrieve the state of the
- * {@link SamplePetnamesController}.
+ * Constructs the default {@link SamplePetnamesController} 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 SamplePetnamesController} state.
+ */
+export declare function getDefaultPetnamesControllerState(): SamplePetnamesControllerState;
+/**
+ * Retrieves the state of the {@link SamplePetnamesController}.
  */
 export type SamplePetnamesControllerGetStateAction = ControllerGetStateAction<typeof controllerName, SamplePetnamesControllerState>;
 /**
- * All actions that {@link SamplePetnamesController} registers, to be called
- * externally.
+ * Actions that {@link SampleGasPricesMessenger} exposes to other consumers.
  */
-export type SamplePetnamesControllerActions = SamplePetnamesControllerGetStateAction;
+export type SamplePetnamesControllerActions = SamplePetnamesControllerGetStateAction | SamplePetnamesControllerMethodActions;
 /**
- * All actions that {@link SamplePetnamesController} calls internally.
+ * Actions from other messengers that {@link SampleGasPricesMessenger} calls.
  */
 type AllowedActions = never;
 /**
- * The event that {@link SamplePetnamesController} publishes when updating state.
+ * Published when the state of {@link SamplePetnamesController} changes.
  */
 export type SamplePetnamesControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, SamplePetnamesControllerState>;
 /**
- * All events that {@link SamplePetnamesController} publishes, to be subscribed to
- * externally.
+ * Events that {@link SampleGasPricesMessenger} exposes to other consumers.
  */
 export type SamplePetnamesControllerEvents = SamplePetnamesControllerStateChangeEvent;
 /**
- * All events that {@link SamplePetnamesController} subscribes to internally.
+ * Events from other messengers that {@link SampleGasPricesMessenger} subscribes
+ * to.
  */
 type AllowedEvents = never;
 /**
- * The messenger which is restricted to actions and events accessed by
+ * The messenger restricted to actions and events accessed by
  * {@link SamplePetnamesController}.
  */
 export type SamplePetnamesControllerMessenger = RestrictedMessenger<typeof controllerName, SamplePetnamesControllerActions | AllowedActions, SamplePetnamesControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
 /**
- * `SamplePetnamesController` records user-provided nicknames for various addresses on
- * various chains.
+ * `SamplePetnamesController` records user-provided nicknames for various
+ * addresses on various chains.
  *
  * @example
  *
@@ -64,27 +72,34 @@ export type SamplePetnamesControllerMessenger = RestrictedMessenger<typeof contr
  * import type {
  *   SamplePetnamesControllerActions,
  *   SamplePetnamesControllerEvents
- * } from '@metamask/example-controllers';
+ * } from '@metamask/sample-controllers';
  *
- * const rootMessenger = new Messenger<
+ * const globalMessenger = new Messenger<
  *  SamplePetnamesControllerActions,
  *  SamplePetnamesControllerEvents
  * >();
- * const samplePetnamesMessenger = rootMessenger.getRestricted({
+ * const samplePetnamesMessenger = globalMessenger.getRestricted({
  *   name: 'SamplePetnamesController',
  *   allowedActions: [],
  *   allowedEvents: [],
  * });
- * const samplePetnamesController = new SamplePetnamesController({
+ * // Instantiate the controller to register its actions on the messenger
+ * new SamplePetnamesController({
  *   messenger: samplePetnamesMessenger,
  * });
  *
- * samplePetnamesController.assignPetname(
- *   '0x1',
- *   '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99',
- *   'Primary Account'
+ * globalMessenger.call(
+ *   'SamplePetnamesController:assignPetname',
+ *   [
+ *     '0x1',
+ *     '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99',
+ *     'Primary Account',
+ *   ],
+ * );
+ * const samplePetnamesControllerState = await globalMessenger.call(
+ *   'SamplePetnamesController:getState',
  * );
- * samplePetnamesController.state.namesByChainIdAndAddress
+ * samplePetnamesControllerState.namesByChainIdAndAddress
  * // => { '0x1': { '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99': 'Primary Account' } }
  * ```
  */
@@ -92,7 +107,7 @@ export declare class SamplePetnamesController extends BaseController<typeof cont
     /**
      * Constructs a new {@link SamplePetnamesController}.
      *
-     * @param args - The arguments to the controller.
+     * @param args - The arguments to this controller.
      * @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.

package/dist/sample-petnames-controller.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"sample-petnames-controller.d.mts","sourceRoot":"","sources":["../src/sample-petnames-controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EAEpB,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAI3C;;;;GAIG;AACH,eAAO,MAAM,cAAc,6BAA6B,CAAC;AAIzD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;OAGG;IACH,wBAAwB,EAAE;QACxB,CAAC,OAAO,EAAE,GAAG,GAAG;YACd,CAAC,OAAO,EAAE,GAAG,GAAG,MAAM,CAAC;SACxB,CAAC;KACH,CAAC;CACH,CAAC;AAcF;;;GAGG;AACH,MAAM,MAAM,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GACzC,sCAAsC,CAAC;AAEzC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAClD,0BAA0B,CACxB,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GACxC,wCAAwC,CAAC;AAE3C;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,mBAAmB,CACjE,OAAO,cAAc,EACrB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,EAC9C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAkBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,wBAAyB,SAAQ,cAAc,CAC1D,OAAO,cAAc,EACrB,6BAA6B,EAC7B,iCAAiC,CAClC;IACC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,iCAAiC,CAAC;QAC7C,KAAK,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC;KAChD;IAYD;;;;;;;OAOG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM;CAYvD"}
+{"version":3,"file":"sample-petnames-controller.d.mts","sourceRoot":"","sources":["../src/sample-petnames-controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EAEpB,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,OAAO,KAAK,EAAE,qCAAqC,EAAE,6DAAyD;AAI9G;;;;GAIG;AACH,eAAO,MAAM,cAAc,6BAA6B,CAAC;AAIzD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;OAGG;IACH,wBAAwB,EAAE;QACxB,CAAC,OAAO,EAAE,GAAG,GAAG;YACd,CAAC,OAAO,EAAE,GAAG,GAAG,MAAM,CAAC;SACxB,CAAC;KACH,CAAC;CACH,CAAC;AAYF;;;;;;;GAOG;AACH,wBAAgB,iCAAiC,IAAI,6BAA6B,CAIjF;AAMD;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,sCAAsC,GACtC,qCAAqC,CAAC;AAE1C;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAClD,0BAA0B,CACxB,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,wCAAwC,CAAC;AAE3C;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,mBAAmB,CACjE,OAAO,cAAc,EACrB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,EAC9C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAIF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,qBAAa,wBAAyB,SAAQ,cAAc,CAC1D,OAAO,cAAc,EACrB,6BAA6B,EAC7B,iCAAiC,CAClC;IACC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,iCAAiC,CAAC;QAC7C,KAAK,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC;KAChD;IAiBD;;;;;;;OAOG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM;CAYvD"}

package/dist/sample-petnames-controller.mjs

@@ -24,15 +24,17 @@ const samplePetnamesControllerMetadata = {
  *
  * @returns The default {@link SamplePetnamesController} state.
  */
-function getDefaultPetnamesControllerState() {
+export function getDefaultPetnamesControllerState() {
     return {
         namesByChainIdAndAddress: {},
     };
 }
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = ['assignPetname'];
 // === CONTROLLER DEFINITION ===
 /**
- * `SamplePetnamesController` records user-provided nicknames for various addresses on
- * various chains.
+ * `SamplePetnamesController` records user-provided nicknames for various
+ * addresses on various chains.
  *
  * @example
  *
@@ -41,27 +43,34 @@ function getDefaultPetnamesControllerState() {
  * import type {
  *   SamplePetnamesControllerActions,
  *   SamplePetnamesControllerEvents
- * } from '@metamask/example-controllers';
+ * } from '@metamask/sample-controllers';
  *
- * const rootMessenger = new Messenger<
+ * const globalMessenger = new Messenger<
  *  SamplePetnamesControllerActions,
  *  SamplePetnamesControllerEvents
  * >();
- * const samplePetnamesMessenger = rootMessenger.getRestricted({
+ * const samplePetnamesMessenger = globalMessenger.getRestricted({
  *   name: 'SamplePetnamesController',
  *   allowedActions: [],
  *   allowedEvents: [],
  * });
- * const samplePetnamesController = new SamplePetnamesController({
+ * // Instantiate the controller to register its actions on the messenger
+ * new SamplePetnamesController({
  *   messenger: samplePetnamesMessenger,
  * });
  *
- * samplePetnamesController.assignPetname(
- *   '0x1',
- *   '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99',
- *   'Primary Account'
+ * globalMessenger.call(
+ *   'SamplePetnamesController:assignPetname',
+ *   [
+ *     '0x1',
+ *     '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99',
+ *     'Primary Account',
+ *   ],
  * );
- * samplePetnamesController.state.namesByChainIdAndAddress
+ * const samplePetnamesControllerState = await globalMessenger.call(
+ *   'SamplePetnamesController:getState',
+ * );
+ * samplePetnamesControllerState.namesByChainIdAndAddress
  * // => { '0x1': { '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99': 'Primary Account' } }
  * ```
  */
@@ -69,7 +78,7 @@ export class SamplePetnamesController extends BaseController {
     /**
      * Constructs a new {@link SamplePetnamesController}.
      *
-     * @param args - The arguments to the controller.
+     * @param args - The arguments to this controller.
      * @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.
@@ -84,6 +93,7 @@ export class SamplePetnamesController extends BaseController {
                 ...state,
             },
         });
+        this.messagingSystem.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
     }
     /**
      * Registers the given name with the given address (relative to the given

package/dist/sample-petnames-controller.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"sample-petnames-controller.mjs","sourceRoot":"","sources":["../src/sample-petnames-controller.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,mCAAmC;AAG9D,kBAAkB;AAElB;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAmBzD;;GAEG;AACH,MAAM,gCAAgC,GAAG;IACvC,wBAAwB,EAAE;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;CACqD,CAAC;AA0DzD;;;;;;;GAOG;AACH,SAAS,iCAAiC;IACxC,OAAO;QACL,wBAAwB,EAAE,EAAE;KAC7B,CAAC;AACJ,CAAC;AAED,gCAAgC;AAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,OAAO,wBAAyB,SAAQ,cAI7C;IACC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,gCAAgC;YAC1C,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE;gBACL,GAAG,iCAAiC,EAAE;gBACtC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CAAC,OAAY,EAAE,OAAY,EAAE,IAAY;QACpD,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;SACrC;QAED,MAAM,iBAAiB,GAAG,OAAO,CAAC,WAAW,EAAS,CAAC;QAEvD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;;YACpB,MAAA,KAAK,CAAC,wBAAwB,EAAC,OAAO,SAAP,OAAO,IAAM,EAAE,EAAC;YAC/C,KAAK,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;QACpE,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport { isSafeDynamicKey } from '@metamask/controller-utils';\nimport type { Hex } from '@metamask/utils';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link SamplePetnamesController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'SamplePetnamesController';\n\n// === STATE ===\n\n/**\n * Describes the shape of the state object for {@link SamplePetnamesController}.\n */\nexport type SamplePetnamesControllerState = {\n  /**\n   * The registry of pet names, categorized by chain ID first and address\n   * second.\n   */\n  namesByChainIdAndAddress: {\n    [chainId: Hex]: {\n      [address: Hex]: string;\n    };\n  };\n};\n\n/**\n * The metadata for each property in {@link SamplePetnamesControllerState}.\n */\nconst samplePetnamesControllerMetadata = {\n  namesByChainIdAndAddress: {\n    persist: true,\n    anonymous: false,\n  },\n} satisfies StateMetadata<SamplePetnamesControllerState>;\n\n// === MESSENGER ===\n\n/**\n * The action which can be used to retrieve the state of the\n * {@link SamplePetnamesController}.\n */\nexport type SamplePetnamesControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  SamplePetnamesControllerState\n>;\n\n/**\n * All actions that {@link SamplePetnamesController} registers, to be called\n * externally.\n */\nexport type SamplePetnamesControllerActions =\n  SamplePetnamesControllerGetStateAction;\n\n/**\n * All actions that {@link SamplePetnamesController} calls internally.\n */\ntype AllowedActions = never;\n\n/**\n * The event that {@link SamplePetnamesController} publishes when updating state.\n */\nexport type SamplePetnamesControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    SamplePetnamesControllerState\n  >;\n\n/**\n * All events that {@link SamplePetnamesController} publishes, to be subscribed to\n * externally.\n */\nexport type SamplePetnamesControllerEvents =\n  SamplePetnamesControllerStateChangeEvent;\n\n/**\n * All events that {@link SamplePetnamesController} subscribes to internally.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link SamplePetnamesController}.\n */\nexport type SamplePetnamesControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  SamplePetnamesControllerActions | AllowedActions,\n  SamplePetnamesControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Constructs the default {@link SamplePetnamesController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link SamplePetnamesController} state.\n */\nfunction getDefaultPetnamesControllerState(): SamplePetnamesControllerState {\n  return {\n    namesByChainIdAndAddress: {},\n  };\n}\n\n// === CONTROLLER DEFINITION ===\n\n/**\n * `SamplePetnamesController` records user-provided nicknames for various addresses on\n * various chains.\n *\n * @example\n *\n * ``` ts\n * import { Messenger } from '@metamask/base-controller';\n * import type {\n *   SamplePetnamesControllerActions,\n *   SamplePetnamesControllerEvents\n * } from '@metamask/example-controllers';\n *\n * const rootMessenger = new Messenger<\n *  SamplePetnamesControllerActions,\n *  SamplePetnamesControllerEvents\n * >();\n * const samplePetnamesMessenger = rootMessenger.getRestricted({\n *   name: 'SamplePetnamesController',\n *   allowedActions: [],\n *   allowedEvents: [],\n * });\n * const samplePetnamesController = new SamplePetnamesController({\n *   messenger: samplePetnamesMessenger,\n * });\n *\n * samplePetnamesController.assignPetname(\n *   '0x1',\n *   '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99',\n *   'Primary Account'\n * );\n * samplePetnamesController.state.namesByChainIdAndAddress\n * // => { '0x1': { '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99': 'Primary Account' } }\n * ```\n */\nexport class SamplePetnamesController extends BaseController<\n  typeof controllerName,\n  SamplePetnamesControllerState,\n  SamplePetnamesControllerMessenger\n> {\n  /**\n   * Constructs a new {@link SamplePetnamesController}.\n   *\n   * @param args - The arguments to the controller.\n   * @param args.messenger - The messenger suited for this controller.\n   * @param args.state - The desired state with which to initialize this\n   * controller. Missing properties will be filled in with defaults.\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: SamplePetnamesControllerMessenger;\n    state?: Partial<SamplePetnamesControllerState>;\n  }) {\n    super({\n      messenger,\n      metadata: samplePetnamesControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultPetnamesControllerState(),\n        ...state,\n      },\n    });\n  }\n\n  /**\n   * Registers the given name with the given address (relative to the given\n   * chain).\n   *\n   * @param chainId - The chain ID that the address belongs to.\n   * @param address - The account address to name.\n   * @param name - The name to assign to the address.\n   */\n  assignPetname(chainId: Hex, address: Hex, name: string) {\n    if (!isSafeDynamicKey(chainId)) {\n      throw new Error('Invalid chain ID');\n    }\n\n    const normalizedAddress = address.toLowerCase() as Hex;\n\n    this.update((state) => {\n      state.namesByChainIdAndAddress[chainId] ??= {};\n      state.namesByChainIdAndAddress[chainId][normalizedAddress] = name;\n    });\n  }\n}\n"]}
+{"version":3,"file":"sample-petnames-controller.mjs","sourceRoot":"","sources":["../src/sample-petnames-controller.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,mCAAmC;AAK9D,kBAAkB;AAElB;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAmBzD;;GAEG;AACH,MAAM,gCAAgC,GAAG;IACvC,wBAAwB,EAAE;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;CACqD,CAAC;AAEzD;;;;;;;GAOG;AACH,MAAM,UAAU,iCAAiC;IAC/C,OAAO;QACL,wBAAwB,EAAE,EAAE;KAC7B,CAAC;AACJ,CAAC;AAED,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,eAAe,CAAU,CAAC;AAuD7D,gCAAgC;AAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,OAAO,wBAAyB,SAAQ,cAI7C;IACC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,gCAAgC;YAC1C,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE;gBACL,GAAG,iCAAiC,EAAE;gBACtC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,CAAC,4BAA4B,CAC/C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CAAC,OAAY,EAAE,OAAY,EAAE,IAAY;QACpD,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;SACrC;QAED,MAAM,iBAAiB,GAAG,OAAO,CAAC,WAAW,EAAS,CAAC;QAEvD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;;YACpB,MAAA,KAAK,CAAC,wBAAwB,EAAC,OAAO,SAAP,OAAO,IAAM,EAAE,EAAC;YAC/C,KAAK,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;QACpE,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport { isSafeDynamicKey } from '@metamask/controller-utils';\nimport type { Hex } from '@metamask/utils';\n\nimport type { SamplePetnamesControllerMethodActions } from './sample-petnames-controller-method-action-types';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link SamplePetnamesController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'SamplePetnamesController';\n\n// === STATE ===\n\n/**\n * Describes the shape of the state object for {@link SamplePetnamesController}.\n */\nexport type SamplePetnamesControllerState = {\n  /**\n   * The registry of pet names, categorized by chain ID first and address\n   * second.\n   */\n  namesByChainIdAndAddress: {\n    [chainId: Hex]: {\n      [address: Hex]: string;\n    };\n  };\n};\n\n/**\n * The metadata for each property in {@link SamplePetnamesControllerState}.\n */\nconst samplePetnamesControllerMetadata = {\n  namesByChainIdAndAddress: {\n    persist: true,\n    anonymous: false,\n  },\n} satisfies StateMetadata<SamplePetnamesControllerState>;\n\n/**\n * Constructs the default {@link SamplePetnamesController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link SamplePetnamesController} state.\n */\nexport function getDefaultPetnamesControllerState(): SamplePetnamesControllerState {\n  return {\n    namesByChainIdAndAddress: {},\n  };\n}\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = ['assignPetname'] as const;\n\n/**\n * Retrieves the state of the {@link SamplePetnamesController}.\n */\nexport type SamplePetnamesControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  SamplePetnamesControllerState\n>;\n\n/**\n * Actions that {@link SampleGasPricesMessenger} exposes to other consumers.\n */\nexport type SamplePetnamesControllerActions =\n  | SamplePetnamesControllerGetStateAction\n  | SamplePetnamesControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link SampleGasPricesMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Published when the state of {@link SamplePetnamesController} changes.\n */\nexport type SamplePetnamesControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    SamplePetnamesControllerState\n  >;\n\n/**\n * Events that {@link SampleGasPricesMessenger} exposes to other consumers.\n */\nexport type SamplePetnamesControllerEvents =\n  SamplePetnamesControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link SampleGasPricesMessenger} subscribes\n * to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link SamplePetnamesController}.\n */\nexport type SamplePetnamesControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  SamplePetnamesControllerActions | AllowedActions,\n  SamplePetnamesControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n// === CONTROLLER DEFINITION ===\n\n/**\n * `SamplePetnamesController` records user-provided nicknames for various\n * addresses on various chains.\n *\n * @example\n *\n * ``` ts\n * import { Messenger } from '@metamask/base-controller';\n * import type {\n *   SamplePetnamesControllerActions,\n *   SamplePetnamesControllerEvents\n * } from '@metamask/sample-controllers';\n *\n * const globalMessenger = new Messenger<\n *  SamplePetnamesControllerActions,\n *  SamplePetnamesControllerEvents\n * >();\n * const samplePetnamesMessenger = globalMessenger.getRestricted({\n *   name: 'SamplePetnamesController',\n *   allowedActions: [],\n *   allowedEvents: [],\n * });\n * // Instantiate the controller to register its actions on the messenger\n * new SamplePetnamesController({\n *   messenger: samplePetnamesMessenger,\n * });\n *\n * globalMessenger.call(\n *   'SamplePetnamesController:assignPetname',\n *   [\n *     '0x1',\n *     '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99',\n *     'Primary Account',\n *   ],\n * );\n * const samplePetnamesControllerState = await globalMessenger.call(\n *   'SamplePetnamesController:getState',\n * );\n * samplePetnamesControllerState.namesByChainIdAndAddress\n * // => { '0x1': { '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99': 'Primary Account' } }\n * ```\n */\nexport class SamplePetnamesController extends BaseController<\n  typeof controllerName,\n  SamplePetnamesControllerState,\n  SamplePetnamesControllerMessenger\n> {\n  /**\n   * Constructs a new {@link SamplePetnamesController}.\n   *\n   * @param args - The arguments to this controller.\n   * @param args.messenger - The messenger suited for this controller.\n   * @param args.state - The desired state with which to initialize this\n   * controller. Missing properties will be filled in with defaults.\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: SamplePetnamesControllerMessenger;\n    state?: Partial<SamplePetnamesControllerState>;\n  }) {\n    super({\n      messenger,\n      metadata: samplePetnamesControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultPetnamesControllerState(),\n        ...state,\n      },\n    });\n\n    this.messagingSystem.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Registers the given name with the given address (relative to the given\n   * chain).\n   *\n   * @param chainId - The chain ID that the address belongs to.\n   * @param address - The account address to name.\n   * @param name - The name to assign to the address.\n   */\n  assignPetname(chainId: Hex, address: Hex, name: string) {\n    if (!isSafeDynamicKey(chainId)) {\n      throw new Error('Invalid chain ID');\n    }\n\n    const normalizedAddress = address.toLowerCase() as Hex;\n\n    this.update((state) => {\n      state.namesByChainIdAndAddress[chainId] ??= {};\n      state.namesByChainIdAndAddress[chainId][normalizedAddress] = name;\n    });\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/sample-controllers",
-  "version": "1.0.0-preview-aa8c4291",
+  "version": "1.0.0-preview-e821953",
   "description": "Sample package to illustrate best practices for controllers",
   "keywords": [
     "MetaMask",
@@ -58,6 +58,7 @@
     "deepmerge": "^4.2.2",
     "jest": "^27.5.1",
     "nock": "^13.3.1",
+    "sinon": "^9.2.4",
     "ts-jest": "^27.1.4",
     "typedoc": "^0.24.8",
     "typedoc-plugin-missing-exports": "^2.0.0",

package/dist/network-controller-types.cjs

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultNetworkControllerState = void 0;
-/**
- * Constructs a default representation of a theoretical NetworkController's
- * state.
- *
- * Note that this package does not supply a NetworkController; this type is only
- * here so it is possible to write a complete example.
- *
- * @returns The default network controller state.
- */
-function getDefaultNetworkControllerState() {
-    return {
-        networkName: 'Some Network',
-        chainId: '0x1',
-    };
-}
-exports.getDefaultNetworkControllerState = getDefaultNetworkControllerState;
-//# sourceMappingURL=network-controller-types.cjs.map

package/dist/network-controller-types.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"network-controller-types.cjs","sourceRoot":"","sources":["../src/network-controller-types.ts"],"names":[],"mappings":";;;AAaA;;;;;;;;GAQG;AACH,SAAgB,gCAAgC;IAC9C,OAAO;QACL,WAAW,EAAE,cAAc;QAC3B,OAAO,EAAE,KAAK;KACf,CAAC;AACJ,CAAC;AALD,4EAKC","sourcesContent":["import type { Hex } from '@metamask/utils';\n\n/**\n * Describes the shape of the state object for a theoretical NetworkController.\n *\n * Note that this package does not supply a NetworkController; this type is only\n * here so it is possible to write a complete example.\n */\ntype NetworkControllerState = {\n  networkName: string;\n  chainId: Hex;\n};\n\n/**\n * Constructs a default representation of a theoretical NetworkController's\n * state.\n *\n * Note that this package does not supply a NetworkController; this type is only\n * here so it is possible to write a complete example.\n *\n * @returns The default network controller state.\n */\nexport function getDefaultNetworkControllerState(): NetworkControllerState {\n  return {\n    networkName: 'Some Network',\n    chainId: '0x1',\n  };\n}\n\n/**\n * The action which can be used to obtain the state for a theoretical\n * NetworkController.\n *\n * Note that this package does not supply a NetworkController; this type is only\n * here so it is possible to write a complete example.\n */\nexport type NetworkControllerGetStateAction = {\n  type: 'NetworkController:getState';\n  handler: () => NetworkControllerState;\n};\n"]}

package/dist/network-controller-types.d.cts

@@ -1,34 +0,0 @@
-import type { Hex } from "@metamask/utils";
-/**
- * Describes the shape of the state object for a theoretical NetworkController.
- *
- * Note that this package does not supply a NetworkController; this type is only
- * here so it is possible to write a complete example.
- */
-type NetworkControllerState = {
-    networkName: string;
-    chainId: Hex;
-};
-/**
- * Constructs a default representation of a theoretical NetworkController's
- * state.
- *
- * Note that this package does not supply a NetworkController; this type is only
- * here so it is possible to write a complete example.
- *
- * @returns The default network controller state.
- */
-export declare function getDefaultNetworkControllerState(): NetworkControllerState;
-/**
- * The action which can be used to obtain the state for a theoretical
- * NetworkController.
- *
- * Note that this package does not supply a NetworkController; this type is only
- * here so it is possible to write a complete example.
- */
-export type NetworkControllerGetStateAction = {
-    type: 'NetworkController:getState';
-    handler: () => NetworkControllerState;
-};
-export {};
-//# sourceMappingURL=network-controller-types.d.cts.map

package/dist/network-controller-types.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"network-controller-types.d.cts","sourceRoot":"","sources":["../src/network-controller-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;;;;GAKG;AACH,KAAK,sBAAsB,GAAG;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,gCAAgC,IAAI,sBAAsB,CAKzE;AAED;;;;;;GAMG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,MAAM,sBAAsB,CAAC;CACvC,CAAC"}

package/dist/network-controller-types.d.mts

@@ -1,34 +0,0 @@
-import type { Hex } from "@metamask/utils";
-/**
- * Describes the shape of the state object for a theoretical NetworkController.
- *
- * Note that this package does not supply a NetworkController; this type is only
- * here so it is possible to write a complete example.
- */
-type NetworkControllerState = {
-    networkName: string;
-    chainId: Hex;
-};
-/**
- * Constructs a default representation of a theoretical NetworkController's
- * state.
- *
- * Note that this package does not supply a NetworkController; this type is only
- * here so it is possible to write a complete example.
- *
- * @returns The default network controller state.
- */
-export declare function getDefaultNetworkControllerState(): NetworkControllerState;
-/**
- * The action which can be used to obtain the state for a theoretical
- * NetworkController.
- *
- * Note that this package does not supply a NetworkController; this type is only
- * here so it is possible to write a complete example.
- */
-export type NetworkControllerGetStateAction = {
-    type: 'NetworkController:getState';
-    handler: () => NetworkControllerState;
-};
-export {};
-//# sourceMappingURL=network-controller-types.d.mts.map

package/dist/network-controller-types.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"network-controller-types.d.mts","sourceRoot":"","sources":["../src/network-controller-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;;;;GAKG;AACH,KAAK,sBAAsB,GAAG;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,gCAAgC,IAAI,sBAAsB,CAKzE;AAED;;;;;;GAMG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,MAAM,sBAAsB,CAAC;CACvC,CAAC"}

package/dist/network-controller-types.mjs

@@ -1,16 +0,0 @@
-/**
- * Constructs a default representation of a theoretical NetworkController's
- * state.
- *
- * Note that this package does not supply a NetworkController; this type is only
- * here so it is possible to write a complete example.
- *
- * @returns The default network controller state.
- */
-export function getDefaultNetworkControllerState() {
-    return {
-        networkName: 'Some Network',
-        chainId: '0x1',
-    };
-}
-//# sourceMappingURL=network-controller-types.mjs.map

package/dist/network-controller-types.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"network-controller-types.mjs","sourceRoot":"","sources":["../src/network-controller-types.ts"],"names":[],"mappings":"AAaA;;;;;;;;GAQG;AACH,MAAM,UAAU,gCAAgC;IAC9C,OAAO;QACL,WAAW,EAAE,cAAc;QAC3B,OAAO,EAAE,KAAK;KACf,CAAC;AACJ,CAAC","sourcesContent":["import type { Hex } from '@metamask/utils';\n\n/**\n * Describes the shape of the state object for a theoretical NetworkController.\n *\n * Note that this package does not supply a NetworkController; this type is only\n * here so it is possible to write a complete example.\n */\ntype NetworkControllerState = {\n  networkName: string;\n  chainId: Hex;\n};\n\n/**\n * Constructs a default representation of a theoretical NetworkController's\n * state.\n *\n * Note that this package does not supply a NetworkController; this type is only\n * here so it is possible to write a complete example.\n *\n * @returns The default network controller state.\n */\nexport function getDefaultNetworkControllerState(): NetworkControllerState {\n  return {\n    networkName: 'Some Network',\n    chainId: '0x1',\n  };\n}\n\n/**\n * The action which can be used to obtain the state for a theoretical\n * NetworkController.\n *\n * Note that this package does not supply a NetworkController; this type is only\n * here so it is possible to write a complete example.\n */\nexport type NetworkControllerGetStateAction = {\n  type: 'NetworkController:getState';\n  handler: () => NetworkControllerState;\n};\n"]}

package/dist/sample-gas-prices-service/index.cjs

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SampleGasPricesService = void 0;
-var sample_gas_prices_service_1 = require("./sample-gas-prices-service.cjs");
-Object.defineProperty(exports, "SampleGasPricesService", { enumerable: true, get: function () { return sample_gas_prices_service_1.SampleGasPricesService; } });
-//# sourceMappingURL=index.cjs.map

package/dist/sample-gas-prices-service/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/sample-gas-prices-service/index.ts"],"names":[],"mappings":";;;AACA,6EAAqE;AAA5D,mIAAA,sBAAsB,OAAA","sourcesContent":["export { type SampleAbstractGasPricesService } from './sample-abstract-gas-prices-service';\nexport { SampleGasPricesService } from './sample-gas-prices-service';\n"]}

package/dist/sample-gas-prices-service/index.d.cts

@@ -1,3 +0,0 @@
-export { type SampleAbstractGasPricesService } from "./sample-abstract-gas-prices-service.cjs";
-export { SampleGasPricesService } from "./sample-gas-prices-service.cjs";
-//# sourceMappingURL=index.d.cts.map

package/dist/sample-gas-prices-service/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/sample-gas-prices-service/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,8BAA8B,EAAE,iDAA6C;AAC3F,OAAO,EAAE,sBAAsB,EAAE,wCAAoC"}

package/dist/sample-gas-prices-service/index.d.mts

@@ -1,3 +0,0 @@
-export { type SampleAbstractGasPricesService } from "./sample-abstract-gas-prices-service.mjs";
-export { SampleGasPricesService } from "./sample-gas-prices-service.mjs";
-//# sourceMappingURL=index.d.mts.map

package/dist/sample-gas-prices-service/index.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/sample-gas-prices-service/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,8BAA8B,EAAE,iDAA6C;AAC3F,OAAO,EAAE,sBAAsB,EAAE,wCAAoC"}

package/dist/sample-gas-prices-service/index.mjs

@@ -1,2 +0,0 @@
-export { SampleGasPricesService } from "./sample-gas-prices-service.mjs";
-//# sourceMappingURL=index.mjs.map

package/dist/sample-gas-prices-service/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/sample-gas-prices-service/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,wCAAoC","sourcesContent":["export { type SampleAbstractGasPricesService } from './sample-abstract-gas-prices-service';\nexport { SampleGasPricesService } from './sample-gas-prices-service';\n"]}

package/dist/sample-gas-prices-service/sample-abstract-gas-prices-service.cjs

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

package/dist/sample-gas-prices-service/sample-abstract-gas-prices-service.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"sample-abstract-gas-prices-service.cjs","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-abstract-gas-prices-service.ts"],"names":[],"mappings":"","sourcesContent":["import type { PublicInterface } from '@metamask/utils';\n\nimport type { SampleGasPricesService } from './sample-gas-prices-service';\n\n/**\n * A service object which is responsible for fetching gas prices.\n */\nexport type SampleAbstractGasPricesService =\n  PublicInterface<SampleGasPricesService>;\n"]}

package/dist/sample-gas-prices-service/sample-abstract-gas-prices-service.d.cts

@@ -1,7 +0,0 @@
-import type { PublicInterface } from "@metamask/utils";
-import type { SampleGasPricesService } from "./sample-gas-prices-service.cjs";
-/**
- * A service object which is responsible for fetching gas prices.
- */
-export type SampleAbstractGasPricesService = PublicInterface<SampleGasPricesService>;
-//# sourceMappingURL=sample-abstract-gas-prices-service.d.cts.map

package/dist/sample-gas-prices-service/sample-abstract-gas-prices-service.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sample-abstract-gas-prices-service.d.cts","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-abstract-gas-prices-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,wBAAwB;AAEvD,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAoC;AAE1E;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,eAAe,CAAC,sBAAsB,CAAC,CAAC"}

package/dist/sample-gas-prices-service/sample-abstract-gas-prices-service.d.mts

@@ -1,7 +0,0 @@
-import type { PublicInterface } from "@metamask/utils";
-import type { SampleGasPricesService } from "./sample-gas-prices-service.mjs";
-/**
- * A service object which is responsible for fetching gas prices.
- */
-export type SampleAbstractGasPricesService = PublicInterface<SampleGasPricesService>;
-//# sourceMappingURL=sample-abstract-gas-prices-service.d.mts.map

package/dist/sample-gas-prices-service/sample-abstract-gas-prices-service.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sample-abstract-gas-prices-service.d.mts","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-abstract-gas-prices-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,wBAAwB;AAEvD,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAoC;AAE1E;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,eAAe,CAAC,sBAAsB,CAAC,CAAC"}

package/dist/sample-gas-prices-service/sample-abstract-gas-prices-service.mjs

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=sample-abstract-gas-prices-service.mjs.map

package/dist/sample-gas-prices-service/sample-abstract-gas-prices-service.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"sample-abstract-gas-prices-service.mjs","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-abstract-gas-prices-service.ts"],"names":[],"mappings":"","sourcesContent":["import type { PublicInterface } from '@metamask/utils';\n\nimport type { SampleGasPricesService } from './sample-gas-prices-service';\n\n/**\n * A service object which is responsible for fetching gas prices.\n */\nexport type SampleAbstractGasPricesService =\n  PublicInterface<SampleGasPricesService>;\n"]}