@metamask-previews/sample-controllers 5.0.6-preview-b13d916 → 5.0.6-preview-4f4c98e

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

@@ -1,179 +0,0 @@
-"use strict";
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var _SampleGasPricesController_instances, _SampleGasPricesController_selectedChainId, _SampleGasPricesController_onSelectedNetworkClientIdChange;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SampleGasPricesController = exports.getDefaultSampleGasPricesControllerState = void 0;
-const base_controller_1 = require("@metamask/base-controller");
-// === GENERAL ===
-/**
- * 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.
- */
-const CONTROLLER_NAME = 'SampleGasPricesController';
-/**
- * The metadata for each property in {@link SampleGasPricesControllerState}.
- */
-const gasPricesControllerMetadata = {
-    gasPricesByChainId: {
-        includeInDebugSnapshot: false,
-        includeInStateLogs: true,
-        persist: true,
-        usedInUi: true,
-    },
-};
-/**
- * Constructs the default {@link SampleGasPricesController} state. This allows
- * consumers to provide a partial state object when initializing the controller
- * and also helps in constructing complete state objects for this controller in
- * tests.
- *
- * @returns The default {@link SampleGasPricesController} state.
- */
-function getDefaultSampleGasPricesControllerState() {
-    return {
-        gasPricesByChainId: {},
-    };
-}
-exports.getDefaultSampleGasPricesControllerState = getDefaultSampleGasPricesControllerState;
-// === MESSENGER ===
-const MESSENGER_EXPOSED_METHODS = ['updateGasPrices'];
-// === CONTROLLER DEFINITION ===
-/**
- * `SampleGasPricesController` fetches and persists gas prices for various chains.
- *
- * @example
- *
- * ``` ts
- * import { Messenger } from '@metamask/messenger';
- * import type {
- *   NetworkControllerActions,
- *   NetworkControllerEvents,
- * } from '@metamask/network-controller';
- * import type {
- *   SampleGasPricesControllerActions,
- *   SampleGasPricesControllerEvents,
- *   SampleGasPricesServiceActions,
- *   SampleGasPricesServiceEvents,
- * } from '@metamask/sample-controllers';
- * import {
- *   SampleGasPricesController,
- *   SampleGasPricesService,
- *   selectGasPrices,
- * } from '@metamask/sample-controllers';
- *
- * const rootMessenger = new Messenger<
- *  'Root',
- *  SampleGasPricesServiceActions
- *  | SampleGasPricesControllerActions
- *  | NetworkControllerActions,
- *  SampleGasPricesServiceEvents
- *  | SampleGasPricesControllerEvents
- *  | NetworkControllerEvents
- * >({ namespace: 'Root' });
- * const gasPricesServiceMessenger = new Messenger<
- *   'SampleGasPricesService',
- *   SampleGasPricesServiceActions,
- *   SampleGasPricesServiceEvents,
- *   typeof rootMessenger,
- * >({
- *   namespace: 'SampleGasPricesService',
- *   parent: rootMessenger,
- * });
- * // Instantiate the service to register its actions on the messenger
- * new SampleGasPricesService({
- *   messenger: gasPricesServiceMessenger,
- *   // We assume you're using this in the browser.
- *   fetch,
- * });
- * const gasPricesControllerMessenger = new Messenger<
- *   'SampleGasPricesController',
- *   SampleGasPricesControllerActions | NetworkControllerGetNetworkClientByIdAction,
- *   SampleGasPricesControllerEvents | NetworkControllerStateChangeEvent,
- *   typeof rootMessenger,
- * >({
- *   namespace: 'SampleGasPricesController',
- *   parent: rootMessenger,
- * });
- * // Instantiate the controller to register its actions on the messenger
- * new SampleGasPricesController({
- *   messenger: gasPricesControllerMessenger,
- * });
- *
- * // Later...
- * await rootMessenger.call(
- *   'SampleGasPricesController:updateGasPrices',
- *   { chainId: '0x42' },
- * );
- * const gasPricesControllerState = await rootMessenger.call(
- *   'SampleGasPricesController:getState',
- * );
- * gasPricesControllerState.gasPricesByChainId
- * // => { '0x42': { low: 5, average: 10, high: 15, fetchedDate: '2024-01-02T00:00:00.000Z' } }
- * ```
- */
-class SampleGasPricesController extends base_controller_1.BaseController {
-    /**
-     * Constructs a new {@link SampleGasPricesController}.
-     *
-     * @param args - The constructor arguments.
-     * @param args.messenger - The messenger suited for this controller.
-     * @param args.state - The desired state with which to initialize this
-     * controller. Missing properties will be filled in with defaults.
-     */
-    constructor({ messenger, state, }) {
-        super({
-            messenger,
-            metadata: gasPricesControllerMetadata,
-            name: CONTROLLER_NAME,
-            state: {
-                ...getDefaultSampleGasPricesControllerState(),
-                ...state,
-            },
-        });
-        _SampleGasPricesController_instances.add(this);
-        /**
-         * The globally selected chain ID.
-         */
-        _SampleGasPricesController_selectedChainId.set(this, void 0);
-        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
-        this.messenger.subscribe('NetworkController:stateChange', __classPrivateFieldGet(this, _SampleGasPricesController_instances, "m", _SampleGasPricesController_onSelectedNetworkClientIdChange).bind(this), (networkControllerState) => networkControllerState.selectedNetworkClientId);
-    }
-    /**
-     * Fetches the latest gas prices for the given chain and persists them to
-     * state.
-     *
-     * @param args - The arguments to the function.
-     * @param args.chainId - The chain ID for which to fetch gas prices.
-     */
-    async updateGasPrices({ chainId }) {
-        const gasPricesResponse = await this.messenger.call('SampleGasPricesService:fetchGasPrices', chainId);
-        this.update((state) => {
-            state.gasPricesByChainId[chainId] = {
-                ...gasPricesResponse,
-                fetchedDate: new Date().toISOString(),
-            };
-        });
-    }
-}
-exports.SampleGasPricesController = SampleGasPricesController;
-_SampleGasPricesController_selectedChainId = new WeakMap(), _SampleGasPricesController_instances = new WeakSet(), _SampleGasPricesController_onSelectedNetworkClientIdChange = function _SampleGasPricesController_onSelectedNetworkClientIdChange(selectedNetworkClientId) {
-    const { configuration: { chainId }, } = this.messenger.call('NetworkController:getNetworkClientById', selectedNetworkClientId);
-    if (chainId !== __classPrivateFieldGet(this, _SampleGasPricesController_selectedChainId, "f")) {
-        __classPrivateFieldSet(this, _SampleGasPricesController_selectedChainId, chainId, "f");
-        this.updateGasPrices({ chainId }).catch((error) => {
-            this.messenger.captureException?.(error);
-        });
-    }
-};
-//# sourceMappingURL=sample-gas-prices-controller.cjs.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"sample-gas-prices-controller.cjs","sourceRoot":"","sources":["../src/sample-gas-prices-controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAKA,+DAA2D;AAY3D,kBAAkB;AAElB;;;;GAIG;AACH,MAAM,eAAe,GAAG,2BAA2B,CAAC;AAsCpD;;GAEG;AACH,MAAM,2BAA2B,GAAG;IAClC,kBAAkB,EAAE;QAClB,sBAAsB,EAAE,KAAK;QAC7B,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,IAAI;KACf;CACsD,CAAC;AAE1D;;;;;;;GAOG;AACH,SAAgB,wCAAwC;IACtD,OAAO;QACL,kBAAkB,EAAE,EAAE;KACvB,CAAC;AACJ,CAAC;AAJD,4FAIC;AAED,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,iBAAiB,CAAU,CAAC;AAuD/D,gCAAgC;AAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwEG;AACH,MAAa,yBAA0B,SAAQ,gCAI9C;IAMC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,2BAA2B;YACrC,IAAI,EAAE,eAAe;YACrB,KAAK,EAAE;gBACL,GAAG,wCAAwC,EAAE;gBAC7C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QA5BL;;WAEG;QACH,6DAAkC;QA2BhC,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,+BAA+B,EAC/B,uBAAA,IAAI,wGAAiC,CAAC,IAAI,CAAC,IAAI,CAAC,EAChD,CAAC,sBAAsB,EAAE,EAAE,CACzB,sBAAsB,CAAC,uBAAuB,CACjD,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CAAC,EAAE,OAAO,EAAoB;QACjD,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACjD,uCAAuC,EACvC,OAAO,CACR,CAAC;QAEF,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;CAyBF;AA5FD,8DA4FC;mPAhBG,uBAAwC;IAExC,MAAM,EACJ,aAAa,EAAE,EAAE,OAAO,EAAE,GAC3B,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACrB,wCAAwC,EACxC,uBAAuB,CACxB,CAAC;IAEF,IAAI,OAAO,KAAK,uBAAA,IAAI,kDAAiB,EAAE,CAAC;QACtC,uBAAA,IAAI,8CAAoB,OAAO,MAAA,CAAC;QAChC,IAAI,CAAC,eAAe,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAChD,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport type {\n  NetworkClientId,\n  NetworkControllerGetNetworkClientByIdAction,\n  NetworkControllerStateChangeEvent,\n} from '@metamask/network-controller';\nimport type { Hex } from '@metamask/utils';\n\nimport type { SampleGasPricesControllerMethodActions } from './sample-gas-prices-controller-method-action-types.js';\nimport type { SampleGasPricesServiceFetchGasPricesAction } from './sample-gas-prices-service/sample-gas-prices-service-method-action-types.js';\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 */\nconst CONTROLLER_NAME = '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   * Fetched gas prices categorized by chain ID.\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    includeInDebugSnapshot: false,\n    includeInStateLogs: true,\n    persist: true,\n    usedInUi: true,\n  },\n} satisfies StateMetadata<SampleGasPricesControllerState>;\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// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = ['updateGasPrices'] as const;\n\n/**\n * Retrieves the state of the {@link SampleGasPricesController}.\n */\nexport type SampleGasPricesControllerGetStateAction = ControllerGetStateAction<\n  typeof CONTROLLER_NAME,\n  SampleGasPricesControllerState\n>;\n\n/**\n * Actions that {@link SampleGasPricesMessenger} exposes to other consumers.\n */\nexport type SampleGasPricesControllerActions =\n  | SampleGasPricesControllerGetStateAction\n  | SampleGasPricesControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link SampleGasPricesMessenger} calls.\n */\ntype AllowedActions =\n  | NetworkControllerGetNetworkClientByIdAction\n  | SampleGasPricesServiceFetchGasPricesAction;\n\n/**\n * Published when the state of {@link SampleGasPricesController} changes.\n */\nexport type SampleGasPricesControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof CONTROLLER_NAME,\n    SampleGasPricesControllerState\n  >;\n\n/**\n * Events that {@link SampleGasPricesMessenger} exposes to other consumers.\n */\nexport type SampleGasPricesControllerEvents =\n  SampleGasPricesControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link SampleGasPricesMessenger} subscribes\n * to.\n */\ntype AllowedEvents = NetworkControllerStateChangeEvent;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link SampleGasPricesController}.\n */\nexport type SampleGasPricesControllerMessenger = Messenger<\n  typeof CONTROLLER_NAME,\n  SampleGasPricesControllerActions | AllowedActions,\n  SampleGasPricesControllerEvents | AllowedEvents\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/messenger';\n * import type {\n *   NetworkControllerActions,\n *   NetworkControllerEvents,\n * } from '@metamask/network-controller';\n * import type {\n *   SampleGasPricesControllerActions,\n *   SampleGasPricesControllerEvents,\n *   SampleGasPricesServiceActions,\n *   SampleGasPricesServiceEvents,\n * } from '@metamask/sample-controllers';\n * import {\n *   SampleGasPricesController,\n *   SampleGasPricesService,\n *   selectGasPrices,\n * } from '@metamask/sample-controllers';\n *\n * const rootMessenger = new Messenger<\n *  'Root',\n *  SampleGasPricesServiceActions\n *  | SampleGasPricesControllerActions\n *  | NetworkControllerActions,\n *  SampleGasPricesServiceEvents\n *  | SampleGasPricesControllerEvents\n *  | NetworkControllerEvents\n * >({ namespace: 'Root' });\n * const gasPricesServiceMessenger = new Messenger<\n *   'SampleGasPricesService',\n *   SampleGasPricesServiceActions,\n *   SampleGasPricesServiceEvents,\n *   typeof rootMessenger,\n * >({\n *   namespace: 'SampleGasPricesService',\n *   parent: rootMessenger,\n * });\n * // Instantiate the service to register its actions on the messenger\n * new SampleGasPricesService({\n *   messenger: gasPricesServiceMessenger,\n *   // We assume you're using this in the browser.\n *   fetch,\n * });\n * const gasPricesControllerMessenger = new Messenger<\n *   'SampleGasPricesController',\n *   SampleGasPricesControllerActions | NetworkControllerGetNetworkClientByIdAction,\n *   SampleGasPricesControllerEvents | NetworkControllerStateChangeEvent,\n *   typeof rootMessenger,\n * >({\n *   namespace: 'SampleGasPricesController',\n *   parent: rootMessenger,\n * });\n * // Instantiate the controller to register its actions on the messenger\n * new SampleGasPricesController({\n *   messenger: gasPricesControllerMessenger,\n * });\n *\n * // Later...\n * await rootMessenger.call(\n *   'SampleGasPricesController:updateGasPrices',\n *   { chainId: '0x42' },\n * );\n * const gasPricesControllerState = await rootMessenger.call(\n *   'SampleGasPricesController:getState',\n * );\n * gasPricesControllerState.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 CONTROLLER_NAME,\n  SampleGasPricesControllerState,\n  SampleGasPricesControllerMessenger\n> {\n  /**\n   * The globally selected chain ID.\n   */\n  #selectedChainId: Hex | undefined;\n\n  /**\n   * Constructs a new {@link SampleGasPricesController}.\n   *\n   * @param args - The constructor arguments.\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: SampleGasPricesControllerMessenger;\n    state?: Partial<SampleGasPricesControllerState>;\n  }) {\n    super({\n      messenger,\n      metadata: gasPricesControllerMetadata,\n      name: CONTROLLER_NAME,\n      state: {\n        ...getDefaultSampleGasPricesControllerState(),\n        ...state,\n      },\n    });\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    this.messenger.subscribe(\n      'NetworkController:stateChange',\n      this.#onSelectedNetworkClientIdChange.bind(this),\n      (networkControllerState) =>\n        networkControllerState.selectedNetworkClientId,\n    );\n  }\n\n  /**\n   * Fetches the latest gas prices for the given chain and persists them to\n   * state.\n   *\n   * @param args - The arguments to the function.\n   * @param args.chainId - The chain ID for which to fetch gas prices.\n   */\n  async updateGasPrices({ chainId }: { chainId: Hex }): Promise<void> {\n    const gasPricesResponse = await this.messenger.call(\n      'SampleGasPricesService:fetchGasPrices',\n      chainId,\n    );\n\n    this.update((state) => {\n      state.gasPricesByChainId[chainId] = {\n        ...gasPricesResponse,\n        fetchedDate: new Date().toISOString(),\n      };\n    });\n  }\n\n  /**\n   * Callback to call when the globally selected network client ID changes,\n   * ensuring that gas prices get updated.\n   *\n   * @param selectedNetworkClientId - The globally selected network client ID.\n   */\n  #onSelectedNetworkClientIdChange(\n    selectedNetworkClientId: NetworkClientId,\n  ): void {\n    const {\n      configuration: { chainId },\n    } = this.messenger.call(\n      'NetworkController:getNetworkClientById',\n      selectedNetworkClientId,\n    );\n\n    if (chainId !== this.#selectedChainId) {\n      this.#selectedChainId = chainId;\n      this.updateGasPrices({ chainId }).catch((error) => {\n        this.messenger.captureException?.(error);\n      });\n    }\n  }\n}\n"]}

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

@@ -1 +0,0 @@
-{"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,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAEV,2CAA2C,EAC3C,iCAAiC,EAClC,qCAAqC;AACtC,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,OAAO,KAAK,EAAE,sCAAsC,EAAE,+DAA8D;AACpH,OAAO,KAAK,EAAE,0CAA0C,EAAE,sFAAqF;AAI/I;;;;GAIG;AACH,QAAA,MAAM,eAAe,8BAA8B,CAAC;AAIpD;;GAEG;AACH,KAAK,SAAS,GAAG;IACf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,kBAAkB,EAAE;QAClB,CAAC,OAAO,EAAE,GAAG,GAAG,SAAS,CAAC;KAC3B,CAAC;CACH,CAAC;AAcF;;;;;;;GAOG;AACH,wBAAgB,wCAAwC,IAAI,8BAA8B,CAIzF;AAMD;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAAG,wBAAwB,CAC5E,OAAO,eAAe,EACtB,8BAA8B,CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GACxC,uCAAuC,GACvC,sCAAsC,CAAC;AAE3C;;GAEG;AACH,KAAK,cAAc,GACf,2CAA2C,GAC3C,0CAA0C,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,yCAAyC,GACnD,0BAA0B,CACxB,OAAO,eAAe,EACtB,8BAA8B,CAC/B,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACzC,yCAAyC,CAAC;AAE5C;;;GAGG;AACH,KAAK,aAAa,GAAG,iCAAiC,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAAG,SAAS,CACxD,OAAO,eAAe,EACtB,gCAAgC,GAAG,cAAc,EACjD,+BAA+B,GAAG,aAAa,CAChD,CAAC;AAIF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwEG;AACH,qBAAa,yBAA0B,SAAQ,cAAc,CAC3D,OAAO,eAAe,EACtB,8BAA8B,EAC9B,kCAAkC,CACnC;;IAMC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,kCAAkC,CAAC;QAC9C,KAAK,CAAC,EAAE,OAAO,CAAC,8BAA8B,CAAC,CAAC;KACjD;IAwBD;;;;;;OAMG;IACG,eAAe,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,GAAG,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAqCpE"}

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

@@ -1,184 +0,0 @@
-import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
-import { BaseController } from "@metamask/base-controller";
-import type { Messenger } from "@metamask/messenger";
-import type { NetworkControllerGetNetworkClientByIdAction, NetworkControllerStateChangeEvent } from "@metamask/network-controller";
-import type { Hex } from "@metamask/utils";
-import type { SampleGasPricesControllerMethodActions } from "./sample-gas-prices-controller-method-action-types.mjs";
-import type { SampleGasPricesServiceFetchGasPricesAction } from "./sample-gas-prices-service/sample-gas-prices-service-method-action-types.mjs";
-/**
- * The name of the {@link SampleGasPricesController}, used to namespace the
- * controller's actions and events and to namespace the controller's state data
- * when composed with other controllers.
- */
-declare const CONTROLLER_NAME = "SampleGasPricesController";
-/**
- * The collection of gas price data fetched periodically.
- */
-type GasPrices = {
-    /**
-     * The total estimated gas in the "low" bucket.
-     */
-    low: number;
-    /**
-     * The total estimated gas in the "average" bucket.
-     */
-    average: number;
-    /**
-     * The total estimated gas in the "high" bucket.
-     */
-    high: number;
-    /**
-     * The date/time (in ISO-8601 format) when prices were fetched.
-     */
-    fetchedDate: string;
-};
-/**
- * Describes the shape of the state object for {@link SampleGasPricesController}.
- */
-export type SampleGasPricesControllerState = {
-    /**
-     * Fetched gas prices categorized by chain ID.
-     */
-    gasPricesByChainId: {
-        [chainId: Hex]: GasPrices;
-    };
-};
-/**
- * Constructs the default {@link SampleGasPricesController} state. This allows
- * consumers to provide a partial state object when initializing the controller
- * and also helps in constructing complete state objects for this controller in
- * tests.
- *
- * @returns The default {@link SampleGasPricesController} state.
- */
-export declare function getDefaultSampleGasPricesControllerState(): SampleGasPricesControllerState;
-/**
- * Retrieves the state of the {@link SampleGasPricesController}.
- */
-export type SampleGasPricesControllerGetStateAction = ControllerGetStateAction<typeof CONTROLLER_NAME, SampleGasPricesControllerState>;
-/**
- * Actions that {@link SampleGasPricesMessenger} exposes to other consumers.
- */
-export type SampleGasPricesControllerActions = SampleGasPricesControllerGetStateAction | SampleGasPricesControllerMethodActions;
-/**
- * Actions from other messengers that {@link SampleGasPricesMessenger} calls.
- */
-type AllowedActions = NetworkControllerGetNetworkClientByIdAction | SampleGasPricesServiceFetchGasPricesAction;
-/**
- * Published when the state of {@link SampleGasPricesController} changes.
- */
-export type SampleGasPricesControllerStateChangeEvent = ControllerStateChangeEvent<typeof CONTROLLER_NAME, SampleGasPricesControllerState>;
-/**
- * Events that {@link SampleGasPricesMessenger} exposes to other consumers.
- */
-export type SampleGasPricesControllerEvents = SampleGasPricesControllerStateChangeEvent;
-/**
- * Events from other messengers that {@link SampleGasPricesMessenger} subscribes
- * to.
- */
-type AllowedEvents = NetworkControllerStateChangeEvent;
-/**
- * The messenger restricted to actions and events accessed by
- * {@link SampleGasPricesController}.
- */
-export type SampleGasPricesControllerMessenger = Messenger<typeof CONTROLLER_NAME, SampleGasPricesControllerActions | AllowedActions, SampleGasPricesControllerEvents | AllowedEvents>;
-/**
- * `SampleGasPricesController` fetches and persists gas prices for various chains.
- *
- * @example
- *
- * ``` ts
- * import { Messenger } from '@metamask/messenger';
- * import type {
- *   NetworkControllerActions,
- *   NetworkControllerEvents,
- * } from '@metamask/network-controller';
- * import type {
- *   SampleGasPricesControllerActions,
- *   SampleGasPricesControllerEvents,
- *   SampleGasPricesServiceActions,
- *   SampleGasPricesServiceEvents,
- * } from '@metamask/sample-controllers';
- * import {
- *   SampleGasPricesController,
- *   SampleGasPricesService,
- *   selectGasPrices,
- * } from '@metamask/sample-controllers';
- *
- * const rootMessenger = new Messenger<
- *  'Root',
- *  SampleGasPricesServiceActions
- *  | SampleGasPricesControllerActions
- *  | NetworkControllerActions,
- *  SampleGasPricesServiceEvents
- *  | SampleGasPricesControllerEvents
- *  | NetworkControllerEvents
- * >({ namespace: 'Root' });
- * const gasPricesServiceMessenger = new Messenger<
- *   'SampleGasPricesService',
- *   SampleGasPricesServiceActions,
- *   SampleGasPricesServiceEvents,
- *   typeof rootMessenger,
- * >({
- *   namespace: 'SampleGasPricesService',
- *   parent: rootMessenger,
- * });
- * // Instantiate the service to register its actions on the messenger
- * new SampleGasPricesService({
- *   messenger: gasPricesServiceMessenger,
- *   // We assume you're using this in the browser.
- *   fetch,
- * });
- * const gasPricesControllerMessenger = new Messenger<
- *   'SampleGasPricesController',
- *   SampleGasPricesControllerActions | NetworkControllerGetNetworkClientByIdAction,
- *   SampleGasPricesControllerEvents | NetworkControllerStateChangeEvent,
- *   typeof rootMessenger,
- * >({
- *   namespace: 'SampleGasPricesController',
- *   parent: rootMessenger,
- * });
- * // Instantiate the controller to register its actions on the messenger
- * new SampleGasPricesController({
- *   messenger: gasPricesControllerMessenger,
- * });
- *
- * // Later...
- * await rootMessenger.call(
- *   'SampleGasPricesController:updateGasPrices',
- *   { chainId: '0x42' },
- * );
- * const gasPricesControllerState = await rootMessenger.call(
- *   'SampleGasPricesController:getState',
- * );
- * gasPricesControllerState.gasPricesByChainId
- * // => { '0x42': { low: 5, average: 10, high: 15, fetchedDate: '2024-01-02T00:00:00.000Z' } }
- * ```
- */
-export declare class SampleGasPricesController extends BaseController<typeof CONTROLLER_NAME, SampleGasPricesControllerState, SampleGasPricesControllerMessenger> {
-    #private;
-    /**
-     * Constructs a new {@link SampleGasPricesController}.
-     *
-     * @param args - The constructor arguments.
-     * @param args.messenger - The messenger suited for this controller.
-     * @param args.state - The desired state with which to initialize this
-     * controller. Missing properties will be filled in with defaults.
-     */
-    constructor({ messenger, state, }: {
-        messenger: SampleGasPricesControllerMessenger;
-        state?: Partial<SampleGasPricesControllerState>;
-    });
-    /**
-     * Fetches the latest gas prices for the given chain and persists them to
-     * state.
-     *
-     * @param args - The arguments to the function.
-     * @param args.chainId - The chain ID for which to fetch gas prices.
-     */
-    updateGasPrices({ chainId }: {
-        chainId: Hex;
-    }): Promise<void>;
-}
-export {};
-//# sourceMappingURL=sample-gas-prices-controller.d.mts.map

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

@@ -1 +0,0 @@
-{"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,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAEV,2CAA2C,EAC3C,iCAAiC,EAClC,qCAAqC;AACtC,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,OAAO,KAAK,EAAE,sCAAsC,EAAE,+DAA8D;AACpH,OAAO,KAAK,EAAE,0CAA0C,EAAE,sFAAqF;AAI/I;;;;GAIG;AACH,QAAA,MAAM,eAAe,8BAA8B,CAAC;AAIpD;;GAEG;AACH,KAAK,SAAS,GAAG;IACf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,kBAAkB,EAAE;QAClB,CAAC,OAAO,EAAE,GAAG,GAAG,SAAS,CAAC;KAC3B,CAAC;CACH,CAAC;AAcF;;;;;;;GAOG;AACH,wBAAgB,wCAAwC,IAAI,8BAA8B,CAIzF;AAMD;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAAG,wBAAwB,CAC5E,OAAO,eAAe,EACtB,8BAA8B,CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GACxC,uCAAuC,GACvC,sCAAsC,CAAC;AAE3C;;GAEG;AACH,KAAK,cAAc,GACf,2CAA2C,GAC3C,0CAA0C,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,yCAAyC,GACnD,0BAA0B,CACxB,OAAO,eAAe,EACtB,8BAA8B,CAC/B,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACzC,yCAAyC,CAAC;AAE5C;;;GAGG;AACH,KAAK,aAAa,GAAG,iCAAiC,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAAG,SAAS,CACxD,OAAO,eAAe,EACtB,gCAAgC,GAAG,cAAc,EACjD,+BAA+B,GAAG,aAAa,CAChD,CAAC;AAIF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwEG;AACH,qBAAa,yBAA0B,SAAQ,cAAc,CAC3D,OAAO,eAAe,EACtB,8BAA8B,EAC9B,kCAAkC,CACnC;;IAMC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,kCAAkC,CAAC;QAC9C,KAAK,CAAC,EAAE,OAAO,CAAC,8BAA8B,CAAC,CAAC;KACjD;IAwBD;;;;;;OAMG;IACG,eAAe,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,GAAG,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAqCpE"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"sample-gas-prices-controller.mjs","sourceRoot":"","sources":["../src/sample-gas-prices-controller.ts"],"names":[],"mappings":";;;;;;;;;;;;AAKA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAY3D,kBAAkB;AAElB;;;;GAIG;AACH,MAAM,eAAe,GAAG,2BAA2B,CAAC;AAsCpD;;GAEG;AACH,MAAM,2BAA2B,GAAG;IAClC,kBAAkB,EAAE;QAClB,sBAAsB,EAAE,KAAK;QAC7B,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,IAAI;KACf;CACsD,CAAC;AAE1D;;;;;;;GAOG;AACH,MAAM,UAAU,wCAAwC;IACtD,OAAO;QACL,kBAAkB,EAAE,EAAE;KACvB,CAAC;AACJ,CAAC;AAED,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,iBAAiB,CAAU,CAAC;AAuD/D,gCAAgC;AAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,cAI9C;IAMC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,2BAA2B;YACrC,IAAI,EAAE,eAAe;YACrB,KAAK,EAAE;gBACL,GAAG,wCAAwC,EAAE;gBAC7C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QA5BL;;WAEG;QACH,6DAAkC;QA2BhC,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,+BAA+B,EAC/B,uBAAA,IAAI,wGAAiC,CAAC,IAAI,CAAC,IAAI,CAAC,EAChD,CAAC,sBAAsB,EAAE,EAAE,CACzB,sBAAsB,CAAC,uBAAuB,CACjD,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CAAC,EAAE,OAAO,EAAoB;QACjD,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACjD,uCAAuC,EACvC,OAAO,CACR,CAAC;QAEF,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;CAyBF;mPAhBG,uBAAwC;IAExC,MAAM,EACJ,aAAa,EAAE,EAAE,OAAO,EAAE,GAC3B,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACrB,wCAAwC,EACxC,uBAAuB,CACxB,CAAC;IAEF,IAAI,OAAO,KAAK,uBAAA,IAAI,kDAAiB,EAAE,CAAC;QACtC,uBAAA,IAAI,8CAAoB,OAAO,MAAA,CAAC;QAChC,IAAI,CAAC,eAAe,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAChD,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport type {\n  NetworkClientId,\n  NetworkControllerGetNetworkClientByIdAction,\n  NetworkControllerStateChangeEvent,\n} from '@metamask/network-controller';\nimport type { Hex } from '@metamask/utils';\n\nimport type { SampleGasPricesControllerMethodActions } from './sample-gas-prices-controller-method-action-types.js';\nimport type { SampleGasPricesServiceFetchGasPricesAction } from './sample-gas-prices-service/sample-gas-prices-service-method-action-types.js';\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 */\nconst CONTROLLER_NAME = '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   * Fetched gas prices categorized by chain ID.\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    includeInDebugSnapshot: false,\n    includeInStateLogs: true,\n    persist: true,\n    usedInUi: true,\n  },\n} satisfies StateMetadata<SampleGasPricesControllerState>;\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// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = ['updateGasPrices'] as const;\n\n/**\n * Retrieves the state of the {@link SampleGasPricesController}.\n */\nexport type SampleGasPricesControllerGetStateAction = ControllerGetStateAction<\n  typeof CONTROLLER_NAME,\n  SampleGasPricesControllerState\n>;\n\n/**\n * Actions that {@link SampleGasPricesMessenger} exposes to other consumers.\n */\nexport type SampleGasPricesControllerActions =\n  | SampleGasPricesControllerGetStateAction\n  | SampleGasPricesControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link SampleGasPricesMessenger} calls.\n */\ntype AllowedActions =\n  | NetworkControllerGetNetworkClientByIdAction\n  | SampleGasPricesServiceFetchGasPricesAction;\n\n/**\n * Published when the state of {@link SampleGasPricesController} changes.\n */\nexport type SampleGasPricesControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof CONTROLLER_NAME,\n    SampleGasPricesControllerState\n  >;\n\n/**\n * Events that {@link SampleGasPricesMessenger} exposes to other consumers.\n */\nexport type SampleGasPricesControllerEvents =\n  SampleGasPricesControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link SampleGasPricesMessenger} subscribes\n * to.\n */\ntype AllowedEvents = NetworkControllerStateChangeEvent;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link SampleGasPricesController}.\n */\nexport type SampleGasPricesControllerMessenger = Messenger<\n  typeof CONTROLLER_NAME,\n  SampleGasPricesControllerActions | AllowedActions,\n  SampleGasPricesControllerEvents | AllowedEvents\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/messenger';\n * import type {\n *   NetworkControllerActions,\n *   NetworkControllerEvents,\n * } from '@metamask/network-controller';\n * import type {\n *   SampleGasPricesControllerActions,\n *   SampleGasPricesControllerEvents,\n *   SampleGasPricesServiceActions,\n *   SampleGasPricesServiceEvents,\n * } from '@metamask/sample-controllers';\n * import {\n *   SampleGasPricesController,\n *   SampleGasPricesService,\n *   selectGasPrices,\n * } from '@metamask/sample-controllers';\n *\n * const rootMessenger = new Messenger<\n *  'Root',\n *  SampleGasPricesServiceActions\n *  | SampleGasPricesControllerActions\n *  | NetworkControllerActions,\n *  SampleGasPricesServiceEvents\n *  | SampleGasPricesControllerEvents\n *  | NetworkControllerEvents\n * >({ namespace: 'Root' });\n * const gasPricesServiceMessenger = new Messenger<\n *   'SampleGasPricesService',\n *   SampleGasPricesServiceActions,\n *   SampleGasPricesServiceEvents,\n *   typeof rootMessenger,\n * >({\n *   namespace: 'SampleGasPricesService',\n *   parent: rootMessenger,\n * });\n * // Instantiate the service to register its actions on the messenger\n * new SampleGasPricesService({\n *   messenger: gasPricesServiceMessenger,\n *   // We assume you're using this in the browser.\n *   fetch,\n * });\n * const gasPricesControllerMessenger = new Messenger<\n *   'SampleGasPricesController',\n *   SampleGasPricesControllerActions | NetworkControllerGetNetworkClientByIdAction,\n *   SampleGasPricesControllerEvents | NetworkControllerStateChangeEvent,\n *   typeof rootMessenger,\n * >({\n *   namespace: 'SampleGasPricesController',\n *   parent: rootMessenger,\n * });\n * // Instantiate the controller to register its actions on the messenger\n * new SampleGasPricesController({\n *   messenger: gasPricesControllerMessenger,\n * });\n *\n * // Later...\n * await rootMessenger.call(\n *   'SampleGasPricesController:updateGasPrices',\n *   { chainId: '0x42' },\n * );\n * const gasPricesControllerState = await rootMessenger.call(\n *   'SampleGasPricesController:getState',\n * );\n * gasPricesControllerState.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 CONTROLLER_NAME,\n  SampleGasPricesControllerState,\n  SampleGasPricesControllerMessenger\n> {\n  /**\n   * The globally selected chain ID.\n   */\n  #selectedChainId: Hex | undefined;\n\n  /**\n   * Constructs a new {@link SampleGasPricesController}.\n   *\n   * @param args - The constructor arguments.\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: SampleGasPricesControllerMessenger;\n    state?: Partial<SampleGasPricesControllerState>;\n  }) {\n    super({\n      messenger,\n      metadata: gasPricesControllerMetadata,\n      name: CONTROLLER_NAME,\n      state: {\n        ...getDefaultSampleGasPricesControllerState(),\n        ...state,\n      },\n    });\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    this.messenger.subscribe(\n      'NetworkController:stateChange',\n      this.#onSelectedNetworkClientIdChange.bind(this),\n      (networkControllerState) =>\n        networkControllerState.selectedNetworkClientId,\n    );\n  }\n\n  /**\n   * Fetches the latest gas prices for the given chain and persists them to\n   * state.\n   *\n   * @param args - The arguments to the function.\n   * @param args.chainId - The chain ID for which to fetch gas prices.\n   */\n  async updateGasPrices({ chainId }: { chainId: Hex }): Promise<void> {\n    const gasPricesResponse = await this.messenger.call(\n      'SampleGasPricesService:fetchGasPrices',\n      chainId,\n    );\n\n    this.update((state) => {\n      state.gasPricesByChainId[chainId] = {\n        ...gasPricesResponse,\n        fetchedDate: new Date().toISOString(),\n      };\n    });\n  }\n\n  /**\n   * Callback to call when the globally selected network client ID changes,\n   * ensuring that gas prices get updated.\n   *\n   * @param selectedNetworkClientId - The globally selected network client ID.\n   */\n  #onSelectedNetworkClientIdChange(\n    selectedNetworkClientId: NetworkClientId,\n  ): void {\n    const {\n      configuration: { chainId },\n    } = this.messenger.call(\n      'NetworkController:getNetworkClientById',\n      selectedNetworkClientId,\n    );\n\n    if (chainId !== this.#selectedChainId) {\n      this.#selectedChainId = chainId;\n      this.updateGasPrices({ chainId }).catch((error) => {\n        this.messenger.captureException?.(error);\n      });\n    }\n  }\n}\n"]}

package/dist/sample-gas-prices-service/sample-gas-prices-service-method-action-types.cjs

@@ -1,7 +0,0 @@
-"use strict";
-/**
- * This file is auto generated.
- * Do not edit manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=sample-gas-prices-service-method-action-types.cjs.map

package/dist/sample-gas-prices-service/sample-gas-prices-service-method-action-types.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"sample-gas-prices-service-method-action-types.cjs","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-gas-prices-service-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { SampleGasPricesService } from './sample-gas-prices-service.js';\n\n/**\n * Makes a request to the API in order to retrieve gas prices for a particular\n * chain.\n *\n * @param chainId - The chain ID for which you want to fetch gas prices.\n * @returns The gas prices for the given chain.\n */\nexport type SampleGasPricesServiceFetchGasPricesAction = {\n  type: `SampleGasPricesService:fetchGasPrices`;\n  handler: SampleGasPricesService['fetchGasPrices'];\n};\n\n/**\n * Union of all SampleGasPricesService action types.\n */\nexport type SampleGasPricesServiceMethodActions =\n  SampleGasPricesServiceFetchGasPricesAction;\n"]}

package/dist/sample-gas-prices-service/sample-gas-prices-service-method-action-types.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sample-gas-prices-service-method-action-types.d.cts","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-gas-prices-service-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAuC;AAE7E;;;;;;GAMG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;CACnD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAC7C,0CAA0C,CAAC"}

package/dist/sample-gas-prices-service/sample-gas-prices-service-method-action-types.d.mts

@@ -1,21 +0,0 @@
-/**
- * This file is auto generated.
- * Do not edit manually.
- */
-import type { SampleGasPricesService } from "./sample-gas-prices-service.mjs";
-/**
- * Makes a request to the API in order to retrieve gas prices for a particular
- * chain.
- *
- * @param chainId - The chain ID for which you want to fetch gas prices.
- * @returns The gas prices for the given chain.
- */
-export type SampleGasPricesServiceFetchGasPricesAction = {
-    type: `SampleGasPricesService:fetchGasPrices`;
-    handler: SampleGasPricesService['fetchGasPrices'];
-};
-/**
- * Union of all SampleGasPricesService action types.
- */
-export type SampleGasPricesServiceMethodActions = SampleGasPricesServiceFetchGasPricesAction;
-//# sourceMappingURL=sample-gas-prices-service-method-action-types.d.mts.map

package/dist/sample-gas-prices-service/sample-gas-prices-service-method-action-types.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sample-gas-prices-service-method-action-types.d.mts","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-gas-prices-service-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAuC;AAE7E;;;;;;GAMG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;CACnD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAC7C,0CAA0C,CAAC"}

package/dist/sample-gas-prices-service/sample-gas-prices-service-method-action-types.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"sample-gas-prices-service-method-action-types.mjs","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-gas-prices-service-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { SampleGasPricesService } from './sample-gas-prices-service.js';\n\n/**\n * Makes a request to the API in order to retrieve gas prices for a particular\n * chain.\n *\n * @param chainId - The chain ID for which you want to fetch gas prices.\n * @returns The gas prices for the given chain.\n */\nexport type SampleGasPricesServiceFetchGasPricesAction = {\n  type: `SampleGasPricesService:fetchGasPrices`;\n  handler: SampleGasPricesService['fetchGasPrices'];\n};\n\n/**\n * Union of all SampleGasPricesService action types.\n */\nexport type SampleGasPricesServiceMethodActions =\n  SampleGasPricesServiceFetchGasPricesAction;\n"]}

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

@@ -1,121 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SampleGasPricesService = exports.serviceName = void 0;
-const base_data_service_1 = require("@metamask/base-data-service");
-const controller_utils_1 = require("@metamask/controller-utils");
-const superstruct_1 = require("@metamask/superstruct");
-// === GENERAL ===
-/**
- * The name of the {@link SampleGasPricesService}, used to namespace the
- * service's actions and events.
- */
-exports.serviceName = 'SampleGasPricesService';
-// === MESSENGER ===
-/**
- * All of the methods within {@link SampleGasPricesService} that are exposed via
- * the messenger.
- */
-const MESSENGER_EXPOSED_METHODS = ['fetchGasPrices'];
-// === SERVICE DEFINITION ===
-/**
- * Struct to validate what the API endpoint returns.
- */
-const GasPricesResponseStruct = (0, superstruct_1.type)({
-    data: (0, superstruct_1.type)({
-        low: (0, superstruct_1.number)(),
-        average: (0, superstruct_1.number)(),
-        high: (0, superstruct_1.number)(),
-    }),
-});
-/**
- * The base URL of the API that the service represents.
- */
-const BASE_URL = 'https://api.example.com';
-/**
- * This service object is responsible for fetching gas prices via an API.
- *
- * @example
- *
- * ``` ts
- * import type { MessengerActions, MessengerEvents } from '@metamask/messenger';
- * import { Messenger } from '@metamask/messenger';
- * import type {
- *   SampleGasPricesServiceMessenger,
- * } from '@metamask/sample-controllers';
- *
- * const rootMessenger = new Messenger<
- *   'Root',
- *   SampleGasPricesServiceActions
- *   SampleGasPricesServiceEvents
- * >({ namespace: 'Root' });
- * const gasPricesServiceMessenger = new Messenger<
- *   'SampleGasPricesService',
- *   MessengerActions<SampleGasPricesServiceMessenger>,
- *   MessengerEvents<SampleGasPricesServiceMessenger>,
- *   typeof rootMessenger,
- * >({
- *   namespace: 'SampleGasPricesService',
- *   parent: rootMessenger,
- * });
- * // Instantiate the service to register its actions on the messenger
- * new SampleGasPricesService({
- *   messenger: gasPricesServiceMessenger,
- * });
- *
- * // Later...
- * // Fetch gas prices for Mainnet
- * const gasPrices = await rootMessenger.call(
- *   'SampleGasPricesService:fetchGasPrices',
- *   '0x1',
- * );
- * // ... Do something with the gas prices ...
- * ```
- */
-class SampleGasPricesService extends base_data_service_1.BaseDataService {
-    /**
-     * Constructs a new SampleGasPricesService object.
-     *
-     * @param args - The constructor arguments.
-     * @param args.messenger - The messenger suited for this service.
-     * @param args.queryClientConfig - Configuration for the underlying TanStack
-     * Query client.
-     * @param args.policyOptions - Options to pass to `createServicePolicy`, which
-     * is used to wrap each request. See {@link CreateServicePolicyOptions}.
-     */
-    constructor({ messenger, queryClientConfig = {}, policyOptions = {}, }) {
-        super({
-            name: exports.serviceName,
-            messenger,
-            queryClientConfig,
-            policyOptions,
-        });
-        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
-    }
-    /**
-     * Makes a request to the API in order to retrieve gas prices for a particular
-     * chain.
-     *
-     * @param chainId - The chain ID for which you want to fetch gas prices.
-     * @returns The gas prices for the given chain.
-     */
-    async fetchGasPrices(chainId) {
-        const url = new URL('/gas-prices', BASE_URL);
-        url.searchParams.append('chainId', `eip155:${(0, controller_utils_1.fromHex)(chainId).toString()}`);
-        const jsonResponse = await this.fetchQuery({
-            queryKey: [`${this.name}:fetchGasPrices`, chainId],
-            queryFn: async () => {
-                const response = await fetch(url);
-                if (!response.ok) {
-                    throw new controller_utils_1.HttpError(response.status, `Gas prices API failed with status '${response.status}'`);
-                }
-                return response.json();
-            },
-        });
-        if (!(0, superstruct_1.is)(jsonResponse, GasPricesResponseStruct)) {
-            throw new Error('Malformed response received from gas prices API');
-        }
-        return jsonResponse.data;
-    }
-}
-exports.SampleGasPricesService = SampleGasPricesService;
-//# sourceMappingURL=sample-gas-prices-service.cjs.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"sample-gas-prices-service.cjs","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-gas-prices-service.ts"],"names":[],"mappings":";;;AAAA,mEAA8D;AAO9D,iEAAgE;AAGhE,uDAAyD;AAMzD,kBAAkB;AAElB;;;GAGG;AACU,QAAA,WAAW,GAAG,wBAAwB,CAAC;AAEpD,oBAAoB;AAEpB;;;GAGG;AACH,MAAM,yBAAyB,GAAG,CAAC,gBAAgB,CAAU,CAAC;AAwD9D,6BAA6B;AAE7B;;GAEG;AACH,MAAM,uBAAuB,GAAG,IAAA,kBAAI,EAAC;IACnC,IAAI,EAAE,IAAA,kBAAI,EAAC;QACT,GAAG,EAAE,IAAA,oBAAM,GAAE;QACb,OAAO,EAAE,IAAA,oBAAM,GAAE;QACjB,IAAI,EAAE,IAAA,oBAAM,GAAE;KACf,CAAC;CACH,CAAC,CAAC;AAOH;;GAEG;AACH,MAAM,QAAQ,GAAG,yBAAyB,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAa,sBAAuB,SAAQ,mCAG3C;IACC;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,iBAAiB,GAAG,EAAE,EACtB,aAAa,GAAG,EAAE,GAKnB;QACC,KAAK,CAAC;YACJ,IAAI,EAAE,mBAAW;YACjB,SAAS;YACT,iBAAiB;YACjB,aAAa;SACd,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,cAAc,CAAC,OAAY;QAC/B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QAC7C,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,UAAU,IAAA,0BAAO,EAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAE5E,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;YACzC,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,iBAAiB,EAAE,OAAO,CAAC;YAClD,OAAO,EAAE,KAAK,IAAI,EAAE;gBAClB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBAElC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACjB,MAAM,IAAI,4BAAS,CACjB,QAAQ,CAAC,MAAM,EACf,sCAAsC,QAAQ,CAAC,MAAM,GAAG,CACzD,CAAC;gBACJ,CAAC;gBAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;YACzB,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,IAAA,gBAAE,EAAC,YAAY,EAAE,uBAAuB,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;QAED,OAAO,YAAY,CAAC,IAAI,CAAC;IAC3B,CAAC;CACF;AArED,wDAqEC","sourcesContent":["import { BaseDataService } from '@metamask/base-data-service';\nimport type {\n  DataServiceCacheUpdatedEvent,\n  DataServiceGranularCacheUpdatedEvent,\n  DataServiceInvalidateQueriesAction,\n} from '@metamask/base-data-service';\nimport type { CreateServicePolicyOptions } from '@metamask/controller-utils';\nimport { HttpError, fromHex } from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport type { Infer } from '@metamask/superstruct';\nimport { is, number, type } from '@metamask/superstruct';\nimport type { Hex } from '@metamask/utils';\nimport type { QueryClientConfig } from '@tanstack/query-core';\n\nimport type { SampleGasPricesServiceMethodActions } from './sample-gas-prices-service-method-action-types.js';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link SampleGasPricesService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'SampleGasPricesService';\n\n// === MESSENGER ===\n\n/**\n * All of the methods within {@link SampleGasPricesService} that are exposed via\n * the messenger.\n */\nconst MESSENGER_EXPOSED_METHODS = ['fetchGasPrices'] as const;\n\n/**\n * Invalidates cached queries for {@link SampleGasPricesService}.\n */\nexport type SampleGasPricesServiceInvalidateQueriesAction =\n  DataServiceInvalidateQueriesAction<typeof serviceName>;\n\n/**\n * Actions that {@link SampleGasPricesService} exposes to other consumers.\n */\nexport type SampleGasPricesServiceActions =\n  | SampleGasPricesServiceMethodActions\n  | SampleGasPricesServiceInvalidateQueriesAction;\n\n/**\n * Actions from other messengers that {@link SampleGasPricesService} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Published when {@link SampleGasPricesService}'s cache is updated.\n */\nexport type SampleGasPricesServiceCacheUpdatedEvent =\n  DataServiceCacheUpdatedEvent<typeof serviceName>;\n\n/**\n * Published when a key within {@link SampleGasPricesService}'s cache is\n * updated.\n */\nexport type SampleGasPricesServiceGranularCacheUpdatedEvent =\n  DataServiceGranularCacheUpdatedEvent<typeof serviceName>;\n\n/**\n * Events that {@link SampleGasPricesService} exposes to other consumers.\n */\nexport type SampleGasPricesServiceEvents =\n  | SampleGasPricesServiceCacheUpdatedEvent\n  | SampleGasPricesServiceGranularCacheUpdatedEvent;\n\n/**\n * Events from other messengers that {@link SampleGasPricesService} subscribes\n * to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link SampleGasPricesService}.\n */\nexport type SampleGasPricesServiceMessenger = Messenger<\n  typeof serviceName,\n  SampleGasPricesServiceActions | AllowedActions,\n  SampleGasPricesServiceEvents | AllowedEvents\n>;\n\n// === SERVICE DEFINITION ===\n\n/**\n * Struct to validate what the API endpoint returns.\n */\nconst GasPricesResponseStruct = type({\n  data: type({\n    low: number(),\n    average: number(),\n    high: number(),\n  }),\n});\n\n/**\n * What the API endpoint returns.\n */\ntype GasPricesResponse = Infer<typeof GasPricesResponseStruct>;\n\n/**\n * The base URL of the API that the service represents.\n */\nconst BASE_URL = 'https://api.example.com';\n\n/**\n * This service object is responsible for fetching gas prices via an API.\n *\n * @example\n *\n * ``` ts\n * import type { MessengerActions, MessengerEvents } from '@metamask/messenger';\n * import { Messenger } from '@metamask/messenger';\n * import type {\n *   SampleGasPricesServiceMessenger,\n * } from '@metamask/sample-controllers';\n *\n * const rootMessenger = new Messenger<\n *   'Root',\n *   SampleGasPricesServiceActions\n *   SampleGasPricesServiceEvents\n * >({ namespace: 'Root' });\n * const gasPricesServiceMessenger = new Messenger<\n *   'SampleGasPricesService',\n *   MessengerActions<SampleGasPricesServiceMessenger>,\n *   MessengerEvents<SampleGasPricesServiceMessenger>,\n *   typeof rootMessenger,\n * >({\n *   namespace: 'SampleGasPricesService',\n *   parent: rootMessenger,\n * });\n * // Instantiate the service to register its actions on the messenger\n * new SampleGasPricesService({\n *   messenger: gasPricesServiceMessenger,\n * });\n *\n * // Later...\n * // Fetch gas prices for Mainnet\n * const gasPrices = await rootMessenger.call(\n *   'SampleGasPricesService:fetchGasPrices',\n *   '0x1',\n * );\n * // ... Do something with the gas prices ...\n * ```\n */\nexport class SampleGasPricesService extends BaseDataService<\n  typeof serviceName,\n  SampleGasPricesServiceMessenger\n> {\n  /**\n   * Constructs a new SampleGasPricesService object.\n   *\n   * @param args - The constructor arguments.\n   * @param args.messenger - The messenger suited for this service.\n   * @param args.queryClientConfig - Configuration for the underlying TanStack\n   * Query client.\n   * @param args.policyOptions - Options to pass to `createServicePolicy`, which\n   * is used to wrap each request. See {@link CreateServicePolicyOptions}.\n   */\n  constructor({\n    messenger,\n    queryClientConfig = {},\n    policyOptions = {},\n  }: {\n    messenger: SampleGasPricesServiceMessenger;\n    queryClientConfig?: QueryClientConfig;\n    policyOptions?: CreateServicePolicyOptions;\n  }) {\n    super({\n      name: serviceName,\n      messenger,\n      queryClientConfig,\n      policyOptions,\n    });\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Makes a request to the API in order to retrieve gas prices for a particular\n   * chain.\n   *\n   * @param chainId - The chain ID for which you want to fetch gas prices.\n   * @returns The gas prices for the given chain.\n   */\n  async fetchGasPrices(chainId: Hex): Promise<GasPricesResponse['data']> {\n    const url = new URL('/gas-prices', BASE_URL);\n    url.searchParams.append('chainId', `eip155:${fromHex(chainId).toString()}`);\n\n    const jsonResponse = await this.fetchQuery({\n      queryKey: [`${this.name}:fetchGasPrices`, chainId],\n      queryFn: async () => {\n        const response = await fetch(url);\n\n        if (!response.ok) {\n          throw new HttpError(\n            response.status,\n            `Gas prices API failed with status '${response.status}'`,\n          );\n        }\n\n        return response.json();\n      },\n    });\n\n    if (!is(jsonResponse, GasPricesResponseStruct)) {\n      throw new Error('Malformed response received from gas prices API');\n    }\n\n    return jsonResponse.data;\n  }\n}\n"]}