@metamask-previews/sample-controllers 0.0.0-preview-37b05a4 → 0.0.0-preview-2084c06c

package/dist/index.cjs

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

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAQA,mFAGwC;AAFtC,wJAAA,wCAAwC,OAAA;AACxC,yIAAA,yBAAyB,OAAA;AAU3B,+EAAwE;AAA/D,sIAAA,wBAAwB,OAAA;AACjC,mFAGqC;AAFnC,mIAAA,sBAAsB,OAAA","sourcesContent":["export type {\n  SampleGasPricesControllerActions,\n  SampleGasPricesControllerEvents,\n  SampleGasPricesControllerGetStateAction,\n  SampleGasPricesControllerMessenger,\n  SampleGasPricesControllerState,\n  SampleGasPricesControllerStateChangeEvent,\n} from './sample-gas-prices-controller';\nexport {\n  getDefaultSampleGasPricesControllerState,\n  SampleGasPricesController,\n} from './sample-gas-prices-controller';\nexport type {\n  SamplePetnamesControllerActions,\n  SamplePetnamesControllerEvents,\n  SamplePetnamesControllerGetStateAction,\n  SamplePetnamesControllerMessenger,\n  SamplePetnamesControllerState,\n  SamplePetnamesControllerStateChangeEvent,\n} from './sample-petnames-controller';\nexport { SamplePetnamesController } from './sample-petnames-controller';\nexport {\n  SampleGasPricesService,\n  type SampleAbstractGasPricesService,\n} from './sample-gas-prices-service';\n"]}

package/dist/index.d.cts

@@ -0,0 +1,6 @@
+export type { SampleGasPricesControllerActions, SampleGasPricesControllerEvents, SampleGasPricesControllerGetStateAction, SampleGasPricesControllerMessenger, SampleGasPricesControllerState, SampleGasPricesControllerStateChangeEvent, } from "./sample-gas-prices-controller.cjs";
+export { getDefaultSampleGasPricesControllerState, SampleGasPricesController, } from "./sample-gas-prices-controller.cjs";
+export type { SamplePetnamesControllerActions, SamplePetnamesControllerEvents, SamplePetnamesControllerGetStateAction, SamplePetnamesControllerMessenger, SamplePetnamesControllerState, SamplePetnamesControllerStateChangeEvent, } from "./sample-petnames-controller.cjs";
+export { SamplePetnamesController } from "./sample-petnames-controller.cjs";
+export { SampleGasPricesService, type SampleAbstractGasPricesService, } from "./sample-gas-prices-service/index.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,gCAAgC,EAChC,+BAA+B,EAC/B,uCAAuC,EACvC,kCAAkC,EAClC,8BAA8B,EAC9B,yCAAyC,GAC1C,2CAAuC;AACxC,OAAO,EACL,wCAAwC,EACxC,yBAAyB,GAC1B,2CAAuC;AACxC,YAAY,EACV,+BAA+B,EAC/B,8BAA8B,EAC9B,sCAAsC,EACtC,iCAAiC,EACjC,6BAA6B,EAC7B,wCAAwC,GACzC,yCAAqC;AACtC,OAAO,EAAE,wBAAwB,EAAE,yCAAqC;AACxE,OAAO,EACL,sBAAsB,EACtB,KAAK,8BAA8B,GACpC,8CAAoC"}

package/dist/index.d.mts

@@ -0,0 +1,6 @@
+export type { SampleGasPricesControllerActions, SampleGasPricesControllerEvents, SampleGasPricesControllerGetStateAction, SampleGasPricesControllerMessenger, SampleGasPricesControllerState, SampleGasPricesControllerStateChangeEvent, } from "./sample-gas-prices-controller.mjs";
+export { getDefaultSampleGasPricesControllerState, SampleGasPricesController, } from "./sample-gas-prices-controller.mjs";
+export type { SamplePetnamesControllerActions, SamplePetnamesControllerEvents, SamplePetnamesControllerGetStateAction, SamplePetnamesControllerMessenger, SamplePetnamesControllerState, SamplePetnamesControllerStateChangeEvent, } from "./sample-petnames-controller.mjs";
+export { SamplePetnamesController } from "./sample-petnames-controller.mjs";
+export { SampleGasPricesService, type SampleAbstractGasPricesService, } from "./sample-gas-prices-service/index.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,gCAAgC,EAChC,+BAA+B,EAC/B,uCAAuC,EACvC,kCAAkC,EAClC,8BAA8B,EAC9B,yCAAyC,GAC1C,2CAAuC;AACxC,OAAO,EACL,wCAAwC,EACxC,yBAAyB,GAC1B,2CAAuC;AACxC,YAAY,EACV,+BAA+B,EAC/B,8BAA8B,EAC9B,sCAAsC,EACtC,iCAAiC,EACjC,6BAA6B,EAC7B,wCAAwC,GACzC,yCAAqC;AACtC,OAAO,EAAE,wBAAwB,EAAE,yCAAqC;AACxE,OAAO,EACL,sBAAsB,EACtB,KAAK,8BAA8B,GACpC,8CAAoC"}

package/dist/index.mjs

@@ -0,0 +1,4 @@
+export { getDefaultSampleGasPricesControllerState, SampleGasPricesController } from "./sample-gas-prices-controller.mjs";
+export { SamplePetnamesController } from "./sample-petnames-controller.mjs";
+export { SampleGasPricesService } from "./sample-gas-prices-service/index.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,wCAAwC,EACxC,yBAAyB,EAC1B,2CAAuC;AASxC,OAAO,EAAE,wBAAwB,EAAE,yCAAqC;AACxE,OAAO,EACL,sBAAsB,EAEvB,8CAAoC","sourcesContent":["export type {\n  SampleGasPricesControllerActions,\n  SampleGasPricesControllerEvents,\n  SampleGasPricesControllerGetStateAction,\n  SampleGasPricesControllerMessenger,\n  SampleGasPricesControllerState,\n  SampleGasPricesControllerStateChangeEvent,\n} from './sample-gas-prices-controller';\nexport {\n  getDefaultSampleGasPricesControllerState,\n  SampleGasPricesController,\n} from './sample-gas-prices-controller';\nexport type {\n  SamplePetnamesControllerActions,\n  SamplePetnamesControllerEvents,\n  SamplePetnamesControllerGetStateAction,\n  SamplePetnamesControllerMessenger,\n  SamplePetnamesControllerState,\n  SamplePetnamesControllerStateChangeEvent,\n} from './sample-petnames-controller';\nexport { SamplePetnamesController } from './sample-petnames-controller';\nexport {\n  SampleGasPricesService,\n  type SampleAbstractGasPricesService,\n} from './sample-gas-prices-service';\n"]}

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

@@ -0,0 +1 @@
+{"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.map

@@ -0,0 +1 @@
+{"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.map

@@ -0,0 +1 @@
+{"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.map

@@ -0,0 +1 @@
+{"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/{types/gas-prices-controller.cjs → sample-gas-prices-controller.cjs}

@@ -10,19 +10,19 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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 _GasPricesController_gasPricesService;
+var _SampleGasPricesController_gasPricesService;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GasPricesController = exports.getDefaultGasPricesControllerState = exports.controllerName = void 0;
+exports.SampleGasPricesController = exports.getDefaultSampleGasPricesControllerState = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
 // === GENERAL ===
 /**
- * The name of the {@link GasPricesController}, used to namespace the
+ * The name of the {@link SampleGasPricesController}, used to namespace the
  * controller's actions and events and to namespace the controller's state data
  * when composed with other controllers.
  */
-exports.controllerName = 'GasPricesController';
+exports.controllerName = 'SampleGasPricesController';
 /**
- * The metadata for each property in {@link GasPricesControllerState}.
+ * The metadata for each property in {@link SampleGasPricesControllerState}.
  */
 const gasPricesControllerMetadata = {
     gasPricesByChainId: {
@@ -31,49 +31,49 @@ const gasPricesControllerMetadata = {
     },
 };
 /**
- * Constructs the default {@link GasPricesController} state. This allows
+ * 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 GasPricesController} state.
+ * @returns The default {@link SampleGasPricesController} state.
  */
-function getDefaultGasPricesControllerState() {
+function getDefaultSampleGasPricesControllerState() {
     return {
         gasPricesByChainId: {},
     };
 }
-exports.getDefaultGasPricesControllerState = getDefaultGasPricesControllerState;
+exports.getDefaultSampleGasPricesControllerState = getDefaultSampleGasPricesControllerState;
 // === CONTROLLER DEFINITION ===
 /**
- * `GasPricesController` fetches and persists gas prices for various chains.
+ * `SampleGasPricesController` fetches and persists gas prices for various chains.
  *
  * @example
  *
  * ``` ts
  * import { Messenger } from '@metamask/base-controller';
  * import {
- *   GasPricesController,
- *   GasPricesService
+ *   SampleGasPricesController,
+ *   SampleGasPricesService
  * } from '@metamask/example-controllers';
  * import type {
- *   GasPricesControllerActions,
- *   GasPricesControllerEvents
+ *   SampleGasPricesControllerActions,
+ *   SampleGasPricesControllerEvents
  * } from '@metamask/example-controllers';
  * import type { NetworkControllerGetStateAction } from '@metamask/network-controller';
  *
  * // Assuming that you're using this in the browser
- * const gasPricesService = new GasPricesService({ fetch });
+ * const gasPricesService = new SampleGasPricesService({ fetch });
  * const rootMessenger = new Messenger<
- *  GasPricesControllerActions | NetworkControllerGetStateAction,
- *  GasPricesControllerEvents
+ *  SampleGasPricesControllerActions | NetworkControllerGetStateAction,
+ *  SampleGasPricesControllerEvents
  * >();
  * const gasPricesMessenger = rootMessenger.getRestricted({
- *   name: 'GasPricesController',
+ *   name: 'SampleGasPricesController',
  *   allowedActions: ['NetworkController:getState'],
  *   allowedEvents: [],
  * });
- * const gasPricesController = new GasPricesController({
+ * const gasPricesController = new SampleGasPricesController({
  *   messenger: gasPricesMessenger,
  *   gasPricesService,
  * });
@@ -85,9 +85,9 @@ exports.getDefaultGasPricesControllerState = getDefaultGasPricesControllerState;
  * // => { '0x42': { low: 5, average: 10, high: 15, fetchedDate: '2024-01-02T00:00:00.000Z' } }
  * ```
  */
-class GasPricesController extends base_controller_1.BaseController {
+class SampleGasPricesController extends base_controller_1.BaseController {
     /**
-     * Constructs a new {@link GasPricesController}.
+     * Constructs a new {@link SampleGasPricesController}.
      *
      * @param args - The arguments to the controller.
      * @param args.messenger - The messenger suited for this controller.
@@ -102,15 +102,15 @@ class GasPricesController extends base_controller_1.BaseController {
             metadata: gasPricesControllerMetadata,
             name: exports.controllerName,
             state: {
-                ...getDefaultGasPricesControllerState(),
+                ...getDefaultSampleGasPricesControllerState(),
                 ...state,
             },
         });
         /**
          * The service object that is used to obtain gas prices.
          */
-        _GasPricesController_gasPricesService.set(this, void 0);
-        __classPrivateFieldSet(this, _GasPricesController_gasPricesService, gasPricesService, "f");
+        _SampleGasPricesController_gasPricesService.set(this, void 0);
+        __classPrivateFieldSet(this, _SampleGasPricesController_gasPricesService, gasPricesService, "f");
         this.messagingSystem.registerActionHandler(`${exports.controllerName}:updateGasPrices`, this.updateGasPrices.bind(this));
     }
     /**
@@ -119,7 +119,7 @@ class GasPricesController extends base_controller_1.BaseController {
      */
     async updateGasPrices() {
         const { chainId } = this.messagingSystem.call('NetworkController:getState');
-        const gasPricesResponse = await __classPrivateFieldGet(this, _GasPricesController_gasPricesService, "f").fetchGasPrices(chainId);
+        const gasPricesResponse = await __classPrivateFieldGet(this, _SampleGasPricesController_gasPricesService, "f").fetchGasPrices(chainId);
         this.update((state) => {
             state.gasPricesByChainId[chainId] = {
                 ...gasPricesResponse,
@@ -128,6 +128,6 @@ class GasPricesController extends base_controller_1.BaseController {
         });
     }
 }
-exports.GasPricesController = GasPricesController;
-_GasPricesController_gasPricesService = new WeakMap();
-//# sourceMappingURL=gas-prices-controller.cjs.map
+exports.SampleGasPricesController = SampleGasPricesController;
+_SampleGasPricesController_gasPricesService = new WeakMap();
+//# sourceMappingURL=sample-gas-prices-controller.cjs.map

package/dist/sample-gas-prices-controller.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sample-gas-prices-controller.cjs","sourceRoot":"","sources":["../src/sample-gas-prices-controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAMA,+DAA2D;AAM3D,kBAAkB;AAElB;;;;GAIG;AACU,QAAA,cAAc,GAAG,2BAA2B,CAAC;AAuC1D;;GAEG;AACH,MAAM,2BAA2B,GAAG;IAClC,kBAAkB,EAAE;QAClB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;CACsD,CAAC;AAmE1D;;;;;;;GAOG;AACH,SAAgB,wCAAwC;IACtD,OAAO;QACL,kBAAkB,EAAE,EAAE;KACvB,CAAC;AACJ,CAAC;AAJD,4FAIC;AAED,gCAAgC;AAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAa,yBAA0B,SAAQ,gCAI9C;IAMC;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,gBAAgB,GAKjB;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,2BAA2B;YACrC,IAAI,EAAE,sBAAc;YACpB,KAAK,EAAE;gBACL,GAAG,wCAAwC,EAAE;gBAC7C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;QAhCL;;WAEG;QACM,8DAAkD;QA+BzD,uBAAA,IAAI,+CAAqB,gBAAgB,MAAA,CAAC;QAE1C,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,sBAAc,kBAAkB,EACnC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAChC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe;QACnB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAC5E,MAAM,iBAAiB,GACrB,MAAM,uBAAA,IAAI,mDAAkB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,GAAG;gBAClC,GAAG,iBAAiB;gBACpB,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;aACtC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA9DD,8DA8DC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Hex } from '@metamask/utils';\n\nimport type { NetworkControllerGetStateAction } from './network-controller-types';\nimport type { SampleAbstractGasPricesService } from './sample-gas-prices-service';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link SampleGasPricesController}, 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 = 'SampleGasPricesController';\n\n// === STATE ===\n\n/**\n * The collection of gas price data fetched periodically.\n */\ntype GasPrices = {\n  /**\n   * The total estimated gas in the \"low\" bucket.\n   */\n  low: number;\n  /**\n   * The total estimated gas in the \"average\" bucket.\n   */\n  average: number;\n  /**\n   * The total estimated gas in the \"high\" bucket.\n   */\n  high: number;\n  /**\n   * The date/time (in ISO-8601 format) when prices were fetched.\n   */\n  fetchedDate: string;\n};\n\n/**\n * Describes the shape of the state object for {@link SampleGasPricesController}.\n */\nexport type SampleGasPricesControllerState = {\n  /**\n   * The registry of pet names, categorized by chain ID first and address\n   * second.\n   */\n  gasPricesByChainId: {\n    [chainId: Hex]: GasPrices;\n  };\n};\n\n/**\n * The metadata for each property in {@link SampleGasPricesControllerState}.\n */\nconst gasPricesControllerMetadata = {\n  gasPricesByChainId: {\n    persist: true,\n    anonymous: false,\n  },\n} satisfies StateMetadata<SampleGasPricesControllerState>;\n\n// === MESSENGER ===\n\n/**\n * The action which can be used to retrieve the state of the\n * {@link SampleGasPricesController}.\n */\nexport type SampleGasPricesControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  SampleGasPricesControllerState\n>;\n\n/**\n * The action which can be used to update gas prices.\n */\nexport type SampleGasPricesControllerUpdateGasPricesAction = {\n  type: `${typeof controllerName}:updateGasPrices`;\n  handler: SampleGasPricesController['updateGasPrices'];\n};\n\n/**\n * All actions that {@link SampleGasPricesController} registers, to be called\n * externally.\n */\nexport type SampleGasPricesControllerActions =\n  | SampleGasPricesControllerGetStateAction\n  | SampleGasPricesControllerUpdateGasPricesAction;\n\n/**\n * All actions that {@link SampleGasPricesController} calls internally.\n */\ntype AllowedActions = NetworkControllerGetStateAction;\n\n/**\n * The event that {@link SampleGasPricesController} publishes when updating state.\n */\nexport type SampleGasPricesControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    SampleGasPricesControllerState\n  >;\n\n/**\n * All events that {@link SampleGasPricesController} publishes, to be subscribed to\n * externally.\n */\nexport type SampleGasPricesControllerEvents =\n  SampleGasPricesControllerStateChangeEvent;\n\n/**\n * All events that {@link SampleGasPricesController} subscribes to internally.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link SampleGasPricesController}.\n */\nexport type SampleGasPricesControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  SampleGasPricesControllerActions | AllowedActions,\n  SampleGasPricesControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Constructs the default {@link SampleGasPricesController} 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 SampleGasPricesController} state.\n */\nexport function getDefaultSampleGasPricesControllerState(): SampleGasPricesControllerState {\n  return {\n    gasPricesByChainId: {},\n  };\n}\n\n// === CONTROLLER DEFINITION ===\n\n/**\n * `SampleGasPricesController` fetches and persists gas prices for various chains.\n *\n * @example\n *\n * ``` ts\n * import { Messenger } from '@metamask/base-controller';\n * import {\n *   SampleGasPricesController,\n *   SampleGasPricesService\n * } from '@metamask/example-controllers';\n * import type {\n *   SampleGasPricesControllerActions,\n *   SampleGasPricesControllerEvents\n * } from '@metamask/example-controllers';\n * import type { NetworkControllerGetStateAction } from '@metamask/network-controller';\n *\n * // Assuming that you're using this in the browser\n * const gasPricesService = new SampleGasPricesService({ fetch });\n * const rootMessenger = new Messenger<\n *  SampleGasPricesControllerActions | NetworkControllerGetStateAction,\n *  SampleGasPricesControllerEvents\n * >();\n * const gasPricesMessenger = rootMessenger.getRestricted({\n *   name: 'SampleGasPricesController',\n *   allowedActions: ['NetworkController:getState'],\n *   allowedEvents: [],\n * });\n * const gasPricesController = new SampleGasPricesController({\n *   messenger: gasPricesMessenger,\n *   gasPricesService,\n * });\n *\n * // Assuming that `NetworkController:getState` returns an object with a\n * // `chainId` of `0x42`...\n * await gasPricesController.updateGasPrices();\n * gasPricesController.state.gasPricesByChainId\n * // => { '0x42': { low: 5, average: 10, high: 15, fetchedDate: '2024-01-02T00:00:00.000Z' } }\n * ```\n */\nexport class SampleGasPricesController extends BaseController<\n  typeof controllerName,\n  SampleGasPricesControllerState,\n  SampleGasPricesControllerMessenger\n> {\n  /**\n   * The service object that is used to obtain gas prices.\n   */\n  readonly #gasPricesService: SampleAbstractGasPricesService;\n\n  /**\n   * Constructs a new {@link SampleGasPricesController}.\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   * @param args.gasPricesService - The service object that will be used to\n   * obtain gas prices.\n   */\n  constructor({\n    messenger,\n    state,\n    gasPricesService,\n  }: {\n    messenger: SampleGasPricesControllerMessenger;\n    state?: Partial<SampleGasPricesControllerState>;\n    gasPricesService: SampleAbstractGasPricesService;\n  }) {\n    super({\n      messenger,\n      metadata: gasPricesControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultSampleGasPricesControllerState(),\n        ...state,\n      },\n    });\n\n    this.#gasPricesService = gasPricesService;\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:updateGasPrices`,\n      this.updateGasPrices.bind(this),\n    );\n  }\n\n  /**\n   * Fetches the latest gas prices for the current chain, persisting them to\n   * state.\n   */\n  async updateGasPrices() {\n    const { chainId } = this.messagingSystem.call('NetworkController:getState');\n    const gasPricesResponse =\n      await this.#gasPricesService.fetchGasPrices(chainId);\n    this.update((state) => {\n      state.gasPricesByChainId[chainId] = {\n        ...gasPricesResponse,\n        fetchedDate: new Date().toISOString(),\n      };\n    });\n  }\n}\n"]}

package/dist/{types/gas-prices-controller.d.cts → sample-gas-prices-controller.d.cts}

@@ -1,14 +1,14 @@
 import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
 import { BaseController } from "@metamask/base-controller";
 import type { Hex } from "@metamask/utils";
-import type { AbstractGasPricesService } from "./gas-prices-service/abstract-gas-prices-service.cjs";
 import type { NetworkControllerGetStateAction } from "./network-controller-types.cjs";
+import type { SampleAbstractGasPricesService } from "./sample-gas-prices-service/index.cjs";
 /**
- * The name of the {@link GasPricesController}, used to namespace the
+ * The name of the {@link SampleGasPricesController}, used to namespace the
  * controller's actions and events and to namespace the controller's state data
  * when composed with other controllers.
  */
-export declare const controllerName = "GasPricesController";
+export declare const controllerName = "SampleGasPricesController";
 /**
  * The collection of gas price data fetched periodically.
  */
@@ -31,9 +31,9 @@ type GasPrices = {
     fetchedDate: string;
 };
 /**
- * Describes the shape of the state object for {@link GasPricesController}.
+ * Describes the shape of the state object for {@link SampleGasPricesController}.
  */
-export type GasPricesControllerState = {
+export type SampleGasPricesControllerState = {
     /**
      * The registry of pet names, categorized by chain ID first and address
      * second.
@@ -44,81 +44,81 @@ export type GasPricesControllerState = {
 };
 /**
  * The action which can be used to retrieve the state of the
- * {@link GasPricesController}.
+ * {@link SampleGasPricesController}.
  */
-export type GasPricesControllerGetStateAction = ControllerGetStateAction<typeof controllerName, GasPricesControllerState>;
+export type SampleGasPricesControllerGetStateAction = ControllerGetStateAction<typeof controllerName, SampleGasPricesControllerState>;
 /**
  * The action which can be used to update gas prices.
  */
-export type GasPricesControllerUpdateGasPricesAction = {
+export type SampleGasPricesControllerUpdateGasPricesAction = {
     type: `${typeof controllerName}:updateGasPrices`;
-    handler: GasPricesController['updateGasPrices'];
+    handler: SampleGasPricesController['updateGasPrices'];
 };
 /**
- * All actions that {@link GasPricesController} registers, to be called
+ * All actions that {@link SampleGasPricesController} registers, to be called
  * externally.
  */
-export type GasPricesControllerActions = GasPricesControllerGetStateAction | GasPricesControllerUpdateGasPricesAction;
+export type SampleGasPricesControllerActions = SampleGasPricesControllerGetStateAction | SampleGasPricesControllerUpdateGasPricesAction;
 /**
- * All actions that {@link GasPricesController} calls internally.
+ * All actions that {@link SampleGasPricesController} calls internally.
  */
 type AllowedActions = NetworkControllerGetStateAction;
 /**
- * The event that {@link GasPricesController} publishes when updating state.
+ * The event that {@link SampleGasPricesController} publishes when updating state.
  */
-export type GasPricesControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, GasPricesControllerState>;
+export type SampleGasPricesControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, SampleGasPricesControllerState>;
 /**
- * All events that {@link GasPricesController} publishes, to be subscribed to
+ * All events that {@link SampleGasPricesController} publishes, to be subscribed to
  * externally.
  */
-export type GasPricesControllerEvents = GasPricesControllerStateChangeEvent;
+export type SampleGasPricesControllerEvents = SampleGasPricesControllerStateChangeEvent;
 /**
- * All events that {@link GasPricesController} subscribes to internally.
+ * All events that {@link SampleGasPricesController} subscribes to internally.
  */
 type AllowedEvents = never;
 /**
  * The messenger which is restricted to actions and events accessed by
- * {@link GasPricesController}.
+ * {@link SampleGasPricesController}.
  */
-export type GasPricesControllerMessenger = RestrictedMessenger<typeof controllerName, GasPricesControllerActions | AllowedActions, GasPricesControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+export type SampleGasPricesControllerMessenger = RestrictedMessenger<typeof controllerName, SampleGasPricesControllerActions | AllowedActions, SampleGasPricesControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
 /**
- * Constructs the default {@link GasPricesController} state. This allows
+ * 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 GasPricesController} state.
+ * @returns The default {@link SampleGasPricesController} state.
  */
-export declare function getDefaultGasPricesControllerState(): GasPricesControllerState;
+export declare function getDefaultSampleGasPricesControllerState(): SampleGasPricesControllerState;
 /**
- * `GasPricesController` fetches and persists gas prices for various chains.
+ * `SampleGasPricesController` fetches and persists gas prices for various chains.
  *
  * @example
  *
  * ``` ts
  * import { Messenger } from '@metamask/base-controller';
  * import {
- *   GasPricesController,
- *   GasPricesService
+ *   SampleGasPricesController,
+ *   SampleGasPricesService
  * } from '@metamask/example-controllers';
  * import type {
- *   GasPricesControllerActions,
- *   GasPricesControllerEvents
+ *   SampleGasPricesControllerActions,
+ *   SampleGasPricesControllerEvents
  * } from '@metamask/example-controllers';
  * import type { NetworkControllerGetStateAction } from '@metamask/network-controller';
  *
  * // Assuming that you're using this in the browser
- * const gasPricesService = new GasPricesService({ fetch });
+ * const gasPricesService = new SampleGasPricesService({ fetch });
  * const rootMessenger = new Messenger<
- *  GasPricesControllerActions | NetworkControllerGetStateAction,
- *  GasPricesControllerEvents
+ *  SampleGasPricesControllerActions | NetworkControllerGetStateAction,
+ *  SampleGasPricesControllerEvents
  * >();
  * const gasPricesMessenger = rootMessenger.getRestricted({
- *   name: 'GasPricesController',
+ *   name: 'SampleGasPricesController',
  *   allowedActions: ['NetworkController:getState'],
  *   allowedEvents: [],
  * });
- * const gasPricesController = new GasPricesController({
+ * const gasPricesController = new SampleGasPricesController({
  *   messenger: gasPricesMessenger,
  *   gasPricesService,
  * });
@@ -130,10 +130,10 @@ export declare function getDefaultGasPricesControllerState(): GasPricesControlle
  * // => { '0x42': { low: 5, average: 10, high: 15, fetchedDate: '2024-01-02T00:00:00.000Z' } }
  * ```
  */
-export declare class GasPricesController extends BaseController<typeof controllerName, GasPricesControllerState, GasPricesControllerMessenger> {
+export declare class SampleGasPricesController extends BaseController<typeof controllerName, SampleGasPricesControllerState, SampleGasPricesControllerMessenger> {
     #private;
     /**
-     * Constructs a new {@link GasPricesController}.
+     * Constructs a new {@link SampleGasPricesController}.
      *
      * @param args - The arguments to the controller.
      * @param args.messenger - The messenger suited for this controller.
@@ -143,9 +143,9 @@ export declare class GasPricesController extends BaseController<typeof controlle
      * obtain gas prices.
      */
     constructor({ messenger, state, gasPricesService, }: {
-        messenger: GasPricesControllerMessenger;
-        state?: Partial<GasPricesControllerState>;
-        gasPricesService: AbstractGasPricesService;
+        messenger: SampleGasPricesControllerMessenger;
+        state?: Partial<SampleGasPricesControllerState>;
+        gasPricesService: SampleAbstractGasPricesService;
     });
     /**
      * Fetches the latest gas prices for the current chain, persisting them to
@@ -154,4 +154,4 @@ export declare class GasPricesController extends BaseController<typeof controlle
     updateGasPrices(): Promise<void>;
 }
 export {};
-//# sourceMappingURL=gas-prices-controller.d.cts.map
+//# sourceMappingURL=sample-gas-prices-controller.d.cts.map

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

@@ -0,0 +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"}

package/dist/{types/gas-prices-controller.d.mts → sample-gas-prices-controller.d.mts}

@@ -1,14 +1,14 @@
 import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
 import { BaseController } from "@metamask/base-controller";
 import type { Hex } from "@metamask/utils";
-import type { AbstractGasPricesService } from "./gas-prices-service/abstract-gas-prices-service.mjs";
 import type { NetworkControllerGetStateAction } from "./network-controller-types.mjs";
+import type { SampleAbstractGasPricesService } from "./sample-gas-prices-service/index.mjs";
 /**
- * The name of the {@link GasPricesController}, used to namespace the
+ * The name of the {@link SampleGasPricesController}, used to namespace the
  * controller's actions and events and to namespace the controller's state data
  * when composed with other controllers.
  */
-export declare const controllerName = "GasPricesController";
+export declare const controllerName = "SampleGasPricesController";
 /**
  * The collection of gas price data fetched periodically.
  */
@@ -31,9 +31,9 @@ type GasPrices = {
     fetchedDate: string;
 };
 /**
- * Describes the shape of the state object for {@link GasPricesController}.
+ * Describes the shape of the state object for {@link SampleGasPricesController}.
  */
-export type GasPricesControllerState = {
+export type SampleGasPricesControllerState = {
     /**
      * The registry of pet names, categorized by chain ID first and address
      * second.
@@ -44,81 +44,81 @@ export type GasPricesControllerState = {
 };
 /**
  * The action which can be used to retrieve the state of the
- * {@link GasPricesController}.
+ * {@link SampleGasPricesController}.
  */
-export type GasPricesControllerGetStateAction = ControllerGetStateAction<typeof controllerName, GasPricesControllerState>;
+export type SampleGasPricesControllerGetStateAction = ControllerGetStateAction<typeof controllerName, SampleGasPricesControllerState>;
 /**
  * The action which can be used to update gas prices.
  */
-export type GasPricesControllerUpdateGasPricesAction = {
+export type SampleGasPricesControllerUpdateGasPricesAction = {
     type: `${typeof controllerName}:updateGasPrices`;
-    handler: GasPricesController['updateGasPrices'];
+    handler: SampleGasPricesController['updateGasPrices'];
 };
 /**
- * All actions that {@link GasPricesController} registers, to be called
+ * All actions that {@link SampleGasPricesController} registers, to be called
  * externally.
  */
-export type GasPricesControllerActions = GasPricesControllerGetStateAction | GasPricesControllerUpdateGasPricesAction;
+export type SampleGasPricesControllerActions = SampleGasPricesControllerGetStateAction | SampleGasPricesControllerUpdateGasPricesAction;
 /**
- * All actions that {@link GasPricesController} calls internally.
+ * All actions that {@link SampleGasPricesController} calls internally.
  */
 type AllowedActions = NetworkControllerGetStateAction;
 /**
- * The event that {@link GasPricesController} publishes when updating state.
+ * The event that {@link SampleGasPricesController} publishes when updating state.
  */
-export type GasPricesControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, GasPricesControllerState>;
+export type SampleGasPricesControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, SampleGasPricesControllerState>;
 /**
- * All events that {@link GasPricesController} publishes, to be subscribed to
+ * All events that {@link SampleGasPricesController} publishes, to be subscribed to
  * externally.
  */
-export type GasPricesControllerEvents = GasPricesControllerStateChangeEvent;
+export type SampleGasPricesControllerEvents = SampleGasPricesControllerStateChangeEvent;
 /**
- * All events that {@link GasPricesController} subscribes to internally.
+ * All events that {@link SampleGasPricesController} subscribes to internally.
  */
 type AllowedEvents = never;
 /**
  * The messenger which is restricted to actions and events accessed by
- * {@link GasPricesController}.
+ * {@link SampleGasPricesController}.
  */
-export type GasPricesControllerMessenger = RestrictedMessenger<typeof controllerName, GasPricesControllerActions | AllowedActions, GasPricesControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+export type SampleGasPricesControllerMessenger = RestrictedMessenger<typeof controllerName, SampleGasPricesControllerActions | AllowedActions, SampleGasPricesControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
 /**
- * Constructs the default {@link GasPricesController} state. This allows
+ * 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 GasPricesController} state.
+ * @returns The default {@link SampleGasPricesController} state.
  */
-export declare function getDefaultGasPricesControllerState(): GasPricesControllerState;
+export declare function getDefaultSampleGasPricesControllerState(): SampleGasPricesControllerState;
 /**
- * `GasPricesController` fetches and persists gas prices for various chains.
+ * `SampleGasPricesController` fetches and persists gas prices for various chains.
  *
  * @example
  *
  * ``` ts
  * import { Messenger } from '@metamask/base-controller';
  * import {
- *   GasPricesController,
- *   GasPricesService
+ *   SampleGasPricesController,
+ *   SampleGasPricesService
  * } from '@metamask/example-controllers';
  * import type {
- *   GasPricesControllerActions,
- *   GasPricesControllerEvents
+ *   SampleGasPricesControllerActions,
+ *   SampleGasPricesControllerEvents
  * } from '@metamask/example-controllers';
  * import type { NetworkControllerGetStateAction } from '@metamask/network-controller';
  *
  * // Assuming that you're using this in the browser
- * const gasPricesService = new GasPricesService({ fetch });
+ * const gasPricesService = new SampleGasPricesService({ fetch });
  * const rootMessenger = new Messenger<
- *  GasPricesControllerActions | NetworkControllerGetStateAction,
- *  GasPricesControllerEvents
+ *  SampleGasPricesControllerActions | NetworkControllerGetStateAction,
+ *  SampleGasPricesControllerEvents
  * >();
  * const gasPricesMessenger = rootMessenger.getRestricted({
- *   name: 'GasPricesController',
+ *   name: 'SampleGasPricesController',
  *   allowedActions: ['NetworkController:getState'],
  *   allowedEvents: [],
  * });
- * const gasPricesController = new GasPricesController({
+ * const gasPricesController = new SampleGasPricesController({
  *   messenger: gasPricesMessenger,
  *   gasPricesService,
  * });
@@ -130,10 +130,10 @@ export declare function getDefaultGasPricesControllerState(): GasPricesControlle
  * // => { '0x42': { low: 5, average: 10, high: 15, fetchedDate: '2024-01-02T00:00:00.000Z' } }
  * ```
  */
-export declare class GasPricesController extends BaseController<typeof controllerName, GasPricesControllerState, GasPricesControllerMessenger> {
+export declare class SampleGasPricesController extends BaseController<typeof controllerName, SampleGasPricesControllerState, SampleGasPricesControllerMessenger> {
     #private;
     /**
-     * Constructs a new {@link GasPricesController}.
+     * Constructs a new {@link SampleGasPricesController}.
      *
      * @param args - The arguments to the controller.
      * @param args.messenger - The messenger suited for this controller.
@@ -143,9 +143,9 @@ export declare class GasPricesController extends BaseController<typeof controlle
      * obtain gas prices.
      */
     constructor({ messenger, state, gasPricesService, }: {
-        messenger: GasPricesControllerMessenger;
-        state?: Partial<GasPricesControllerState>;
-        gasPricesService: AbstractGasPricesService;
+        messenger: SampleGasPricesControllerMessenger;
+        state?: Partial<SampleGasPricesControllerState>;
+        gasPricesService: SampleAbstractGasPricesService;
     });
     /**
      * Fetches the latest gas prices for the current chain, persisting them to
@@ -154,4 +154,4 @@ export declare class GasPricesController extends BaseController<typeof controlle
     updateGasPrices(): Promise<void>;
 }
 export {};
-//# sourceMappingURL=gas-prices-controller.d.mts.map
+//# sourceMappingURL=sample-gas-prices-controller.d.mts.map

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

@@ -0,0 +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"}