@metamask-previews/sample-controllers 4.0.4-preview-bfb4d9f5a → 4.0.4-preview-1d148d2

package/CHANGELOG.md

@@ -7,6 +7,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add actions and events for accessing and interacting with the new query cache for `SampleGasPricesService` ([#8343](https://github.com/MetaMask/core/pull/8343))
+  - New actions and events are:
+    - `SampleGasPricesServiceInvalidateQueriesAction`
+    - `SampleGasPricesServiceCacheUpdatedEvent`
+    - `SampleGasPricesServiceGranularCacheUpdatedEvent`
+  - Additionally, the actions are available within `SampleGasPricesServiceActions` and the events are available within `SampleGasPricesServiceEvents`
+- Add optional `queryClientConfig` constructor argument which can be used to configure the underlying TanStack Query client ([#8343](https://github.com/MetaMask/core/pull/8343))
+- Add `destroy` method to `BaseDataService` ([#8343](https://github.com/MetaMask/core/pull/8343))
+
+### Changed
+
+- **BREAKING:** `SampleGasPricesService` now inherits from `BaseDataService` from `@metamask/base-data-service` ([#8343](https://github.com/MetaMask/core/pull/8343))
+- Update `SampleGasPricesService.fetchGasPrices` (and messenger action) so requests to API will be cached and/or deduplicated ([#8343](https://github.com/MetaMask/core/pull/8343))
+- Add new dependencies ([#8343](https://github.com/MetaMask/core/pull/8343))
+  - Add `@metamask/base-data-service` ^0.1.1
+  - Add `@tanstack/query-core` ^4.43.0
+  - Add `@metamask/superstruct` ^3.2.1
+- Bump `@metamask/messenger` from `^1.0.0` to `^1.1.0` ([#8364](https://github.com/MetaMask/core/pull/8364))
+
+### Removed
+
+- **BREAKING:** Remove `onRetry`, `onBreak`, and `onDegraded` ([#8343](https://github.com/MetaMask/core/pull/8343))
+  - You are free to implement these methods in your "real" service class if you need them, but we no longer require you to do so.
+
 ## [4.0.4]
 
 ### Changed

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAMA,uGAA+F;AAAtF,mIAAA,sBAAsB,OAAA;AAS/B,mFAGwC;AAFtC,yIAAA,yBAAyB,OAAA;AACzB,wJAAA,wCAAwC,OAAA;AAW1C,+EAGsC;AAFpC,sIAAA,wBAAwB,OAAA;AACxB,+IAAA,iCAAiC,OAAA","sourcesContent":["export type {\n  SampleGasPricesServiceActions,\n  SampleGasPricesServiceEvents,\n  SampleGasPricesServiceMessenger,\n} from './sample-gas-prices-service/sample-gas-prices-service';\nexport type { SampleGasPricesServiceFetchGasPricesAction } from './sample-gas-prices-service/sample-gas-prices-service-method-action-types';\nexport { SampleGasPricesService } from './sample-gas-prices-service/sample-gas-prices-service';\nexport type {\n  SampleGasPricesControllerActions,\n  SampleGasPricesControllerEvents,\n  SampleGasPricesControllerGetStateAction,\n  SampleGasPricesControllerMessenger,\n  SampleGasPricesControllerState,\n  SampleGasPricesControllerStateChangeEvent,\n} from './sample-gas-prices-controller';\nexport {\n  SampleGasPricesController,\n  getDefaultSampleGasPricesControllerState,\n} from './sample-gas-prices-controller';\nexport type { SampleGasPricesControllerUpdateGasPricesAction } from './sample-gas-prices-controller-method-action-types';\nexport type {\n  SamplePetnamesControllerActions,\n  SamplePetnamesControllerEvents,\n  SamplePetnamesControllerGetStateAction,\n  SamplePetnamesControllerMessenger,\n  SamplePetnamesControllerState,\n  SamplePetnamesControllerStateChangeEvent,\n} from './sample-petnames-controller';\nexport {\n  SamplePetnamesController,\n  getDefaultPetnamesControllerState,\n} from './sample-petnames-controller';\nexport type { SamplePetnamesControllerAssignPetnameAction } from './sample-petnames-controller-method-action-types';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AASA,uGAA+F;AAAtF,mIAAA,sBAAsB,OAAA;AAS/B,mFAGwC;AAFtC,yIAAA,yBAAyB,OAAA;AACzB,wJAAA,wCAAwC,OAAA;AAW1C,+EAGsC;AAFpC,sIAAA,wBAAwB,OAAA;AACxB,+IAAA,iCAAiC,OAAA","sourcesContent":["export type {\n  SampleGasPricesServiceInvalidateQueriesAction,\n  SampleGasPricesServiceActions,\n  SampleGasPricesServiceCacheUpdatedEvent,\n  SampleGasPricesServiceGranularCacheUpdatedEvent,\n  SampleGasPricesServiceEvents,\n  SampleGasPricesServiceMessenger,\n} from './sample-gas-prices-service/sample-gas-prices-service';\nexport type { SampleGasPricesServiceFetchGasPricesAction } from './sample-gas-prices-service/sample-gas-prices-service-method-action-types';\nexport { SampleGasPricesService } from './sample-gas-prices-service/sample-gas-prices-service';\nexport type {\n  SampleGasPricesControllerActions,\n  SampleGasPricesControllerEvents,\n  SampleGasPricesControllerGetStateAction,\n  SampleGasPricesControllerMessenger,\n  SampleGasPricesControllerState,\n  SampleGasPricesControllerStateChangeEvent,\n} from './sample-gas-prices-controller';\nexport {\n  SampleGasPricesController,\n  getDefaultSampleGasPricesControllerState,\n} from './sample-gas-prices-controller';\nexport type { SampleGasPricesControllerUpdateGasPricesAction } from './sample-gas-prices-controller-method-action-types';\nexport type {\n  SamplePetnamesControllerActions,\n  SamplePetnamesControllerEvents,\n  SamplePetnamesControllerGetStateAction,\n  SamplePetnamesControllerMessenger,\n  SamplePetnamesControllerState,\n  SamplePetnamesControllerStateChangeEvent,\n} from './sample-petnames-controller';\nexport {\n  SamplePetnamesController,\n  getDefaultPetnamesControllerState,\n} from './sample-petnames-controller';\nexport type { SamplePetnamesControllerAssignPetnameAction } from './sample-petnames-controller-method-action-types';\n"]}

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-export type { SampleGasPricesServiceActions, SampleGasPricesServiceEvents, SampleGasPricesServiceMessenger, } from "./sample-gas-prices-service/sample-gas-prices-service.cjs";
+export type { SampleGasPricesServiceInvalidateQueriesAction, SampleGasPricesServiceActions, SampleGasPricesServiceCacheUpdatedEvent, SampleGasPricesServiceGranularCacheUpdatedEvent, SampleGasPricesServiceEvents, SampleGasPricesServiceMessenger, } from "./sample-gas-prices-service/sample-gas-prices-service.cjs";
 export type { SampleGasPricesServiceFetchGasPricesAction } from "./sample-gas-prices-service/sample-gas-prices-service-method-action-types.cjs";
 export { SampleGasPricesService } from "./sample-gas-prices-service/sample-gas-prices-service.cjs";
 export type { SampleGasPricesControllerActions, SampleGasPricesControllerEvents, SampleGasPricesControllerGetStateAction, SampleGasPricesControllerMessenger, SampleGasPricesControllerState, SampleGasPricesControllerStateChangeEvent, } from "./sample-gas-prices-controller.cjs";

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,6BAA6B,EAC7B,4BAA4B,EAC5B,+BAA+B,GAChC,kEAA8D;AAC/D,YAAY,EAAE,0CAA0C,EAAE,sFAAkF;AAC5I,OAAO,EAAE,sBAAsB,EAAE,kEAA8D;AAC/F,YAAY,EACV,gCAAgC,EAChC,+BAA+B,EAC/B,uCAAuC,EACvC,kCAAkC,EAClC,8BAA8B,EAC9B,yCAAyC,GAC1C,2CAAuC;AACxC,OAAO,EACL,yBAAyB,EACzB,wCAAwC,GACzC,2CAAuC;AACxC,YAAY,EAAE,8CAA8C,EAAE,+DAA2D;AACzH,YAAY,EACV,+BAA+B,EAC/B,8BAA8B,EAC9B,sCAAsC,EACtC,iCAAiC,EACjC,6BAA6B,EAC7B,wCAAwC,GACzC,yCAAqC;AACtC,OAAO,EACL,wBAAwB,EACxB,iCAAiC,GAClC,yCAAqC;AACtC,YAAY,EAAE,2CAA2C,EAAE,6DAAyD"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,6CAA6C,EAC7C,6BAA6B,EAC7B,uCAAuC,EACvC,+CAA+C,EAC/C,4BAA4B,EAC5B,+BAA+B,GAChC,kEAA8D;AAC/D,YAAY,EAAE,0CAA0C,EAAE,sFAAkF;AAC5I,OAAO,EAAE,sBAAsB,EAAE,kEAA8D;AAC/F,YAAY,EACV,gCAAgC,EAChC,+BAA+B,EAC/B,uCAAuC,EACvC,kCAAkC,EAClC,8BAA8B,EAC9B,yCAAyC,GAC1C,2CAAuC;AACxC,OAAO,EACL,yBAAyB,EACzB,wCAAwC,GACzC,2CAAuC;AACxC,YAAY,EAAE,8CAA8C,EAAE,+DAA2D;AACzH,YAAY,EACV,+BAA+B,EAC/B,8BAA8B,EAC9B,sCAAsC,EACtC,iCAAiC,EACjC,6BAA6B,EAC7B,wCAAwC,GACzC,yCAAqC;AACtC,OAAO,EACL,wBAAwB,EACxB,iCAAiC,GAClC,yCAAqC;AACtC,YAAY,EAAE,2CAA2C,EAAE,6DAAyD"}

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-export type { SampleGasPricesServiceActions, SampleGasPricesServiceEvents, SampleGasPricesServiceMessenger, } from "./sample-gas-prices-service/sample-gas-prices-service.mjs";
+export type { SampleGasPricesServiceInvalidateQueriesAction, SampleGasPricesServiceActions, SampleGasPricesServiceCacheUpdatedEvent, SampleGasPricesServiceGranularCacheUpdatedEvent, SampleGasPricesServiceEvents, SampleGasPricesServiceMessenger, } from "./sample-gas-prices-service/sample-gas-prices-service.mjs";
 export type { SampleGasPricesServiceFetchGasPricesAction } from "./sample-gas-prices-service/sample-gas-prices-service-method-action-types.mjs";
 export { SampleGasPricesService } from "./sample-gas-prices-service/sample-gas-prices-service.mjs";
 export type { SampleGasPricesControllerActions, SampleGasPricesControllerEvents, SampleGasPricesControllerGetStateAction, SampleGasPricesControllerMessenger, SampleGasPricesControllerState, SampleGasPricesControllerStateChangeEvent, } from "./sample-gas-prices-controller.mjs";

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,6BAA6B,EAC7B,4BAA4B,EAC5B,+BAA+B,GAChC,kEAA8D;AAC/D,YAAY,EAAE,0CAA0C,EAAE,sFAAkF;AAC5I,OAAO,EAAE,sBAAsB,EAAE,kEAA8D;AAC/F,YAAY,EACV,gCAAgC,EAChC,+BAA+B,EAC/B,uCAAuC,EACvC,kCAAkC,EAClC,8BAA8B,EAC9B,yCAAyC,GAC1C,2CAAuC;AACxC,OAAO,EACL,yBAAyB,EACzB,wCAAwC,GACzC,2CAAuC;AACxC,YAAY,EAAE,8CAA8C,EAAE,+DAA2D;AACzH,YAAY,EACV,+BAA+B,EAC/B,8BAA8B,EAC9B,sCAAsC,EACtC,iCAAiC,EACjC,6BAA6B,EAC7B,wCAAwC,GACzC,yCAAqC;AACtC,OAAO,EACL,wBAAwB,EACxB,iCAAiC,GAClC,yCAAqC;AACtC,YAAY,EAAE,2CAA2C,EAAE,6DAAyD"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,6CAA6C,EAC7C,6BAA6B,EAC7B,uCAAuC,EACvC,+CAA+C,EAC/C,4BAA4B,EAC5B,+BAA+B,GAChC,kEAA8D;AAC/D,YAAY,EAAE,0CAA0C,EAAE,sFAAkF;AAC5I,OAAO,EAAE,sBAAsB,EAAE,kEAA8D;AAC/F,YAAY,EACV,gCAAgC,EAChC,+BAA+B,EAC/B,uCAAuC,EACvC,kCAAkC,EAClC,8BAA8B,EAC9B,yCAAyC,GAC1C,2CAAuC;AACxC,OAAO,EACL,yBAAyB,EACzB,wCAAwC,GACzC,2CAAuC;AACxC,YAAY,EAAE,8CAA8C,EAAE,+DAA2D;AACzH,YAAY,EACV,+BAA+B,EAC/B,8BAA8B,EAC9B,sCAAsC,EACtC,iCAAiC,EACjC,6BAA6B,EAC7B,wCAAwC,GACzC,yCAAqC;AACtC,OAAO,EACL,wBAAwB,EACxB,iCAAiC,GAClC,yCAAqC;AACtC,YAAY,EAAE,2CAA2C,EAAE,6DAAyD"}

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,sBAAsB,EAAE,kEAA8D;AAS/F,OAAO,EACL,yBAAyB,EACzB,wCAAwC,EACzC,2CAAuC;AAUxC,OAAO,EACL,wBAAwB,EACxB,iCAAiC,EAClC,yCAAqC","sourcesContent":["export type {\n  SampleGasPricesServiceActions,\n  SampleGasPricesServiceEvents,\n  SampleGasPricesServiceMessenger,\n} from './sample-gas-prices-service/sample-gas-prices-service';\nexport type { SampleGasPricesServiceFetchGasPricesAction } from './sample-gas-prices-service/sample-gas-prices-service-method-action-types';\nexport { SampleGasPricesService } from './sample-gas-prices-service/sample-gas-prices-service';\nexport type {\n  SampleGasPricesControllerActions,\n  SampleGasPricesControllerEvents,\n  SampleGasPricesControllerGetStateAction,\n  SampleGasPricesControllerMessenger,\n  SampleGasPricesControllerState,\n  SampleGasPricesControllerStateChangeEvent,\n} from './sample-gas-prices-controller';\nexport {\n  SampleGasPricesController,\n  getDefaultSampleGasPricesControllerState,\n} from './sample-gas-prices-controller';\nexport type { SampleGasPricesControllerUpdateGasPricesAction } from './sample-gas-prices-controller-method-action-types';\nexport type {\n  SamplePetnamesControllerActions,\n  SamplePetnamesControllerEvents,\n  SamplePetnamesControllerGetStateAction,\n  SamplePetnamesControllerMessenger,\n  SamplePetnamesControllerState,\n  SamplePetnamesControllerStateChangeEvent,\n} from './sample-petnames-controller';\nexport {\n  SamplePetnamesController,\n  getDefaultPetnamesControllerState,\n} from './sample-petnames-controller';\nexport type { SamplePetnamesControllerAssignPetnameAction } from './sample-petnames-controller-method-action-types';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,sBAAsB,EAAE,kEAA8D;AAS/F,OAAO,EACL,yBAAyB,EACzB,wCAAwC,EACzC,2CAAuC;AAUxC,OAAO,EACL,wBAAwB,EACxB,iCAAiC,EAClC,yCAAqC","sourcesContent":["export type {\n  SampleGasPricesServiceInvalidateQueriesAction,\n  SampleGasPricesServiceActions,\n  SampleGasPricesServiceCacheUpdatedEvent,\n  SampleGasPricesServiceGranularCacheUpdatedEvent,\n  SampleGasPricesServiceEvents,\n  SampleGasPricesServiceMessenger,\n} from './sample-gas-prices-service/sample-gas-prices-service';\nexport type { SampleGasPricesServiceFetchGasPricesAction } from './sample-gas-prices-service/sample-gas-prices-service-method-action-types';\nexport { SampleGasPricesService } from './sample-gas-prices-service/sample-gas-prices-service';\nexport type {\n  SampleGasPricesControllerActions,\n  SampleGasPricesControllerEvents,\n  SampleGasPricesControllerGetStateAction,\n  SampleGasPricesControllerMessenger,\n  SampleGasPricesControllerState,\n  SampleGasPricesControllerStateChangeEvent,\n} from './sample-gas-prices-controller';\nexport {\n  SampleGasPricesController,\n  getDefaultSampleGasPricesControllerState,\n} from './sample-gas-prices-controller';\nexport type { SampleGasPricesControllerUpdateGasPricesAction } from './sample-gas-prices-controller-method-action-types';\nexport type {\n  SamplePetnamesControllerActions,\n  SamplePetnamesControllerEvents,\n  SamplePetnamesControllerGetStateAction,\n  SamplePetnamesControllerMessenger,\n  SamplePetnamesControllerState,\n  SamplePetnamesControllerStateChangeEvent,\n} from './sample-petnames-controller';\nexport {\n  SamplePetnamesController,\n  getDefaultPetnamesControllerState,\n} from './sample-petnames-controller';\nexport type { SamplePetnamesControllerAssignPetnameAction } from './sample-petnames-controller-method-action-types';\n"]}

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

@@ -1,20 +1,9 @@
 "use strict";
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _a, _SampleGasPricesService_messenger, _SampleGasPricesService_fetch, _SampleGasPricesService_policy;
 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 utils_1 = require("@metamask/utils");
+const superstruct_1 = require("@metamask/superstruct");
 // === GENERAL ===
 /**
  * The name of the {@link SampleGasPricesService}, used to namespace the
@@ -22,17 +11,36 @@ const utils_1 = require("@metamask/utils");
  */
 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 {
- *   SampleGasPricesServiceActions,
- *   SampleGasPricesServiceEvents,
+ *   SampleGasPricesServiceMessenger,
  * } from '@metamask/sample-controllers';
  *
  * const rootMessenger = new Messenger<
@@ -42,8 +50,8 @@ const MESSENGER_EXPOSED_METHODS = ['fetchGasPrices'];
  * >({ namespace: 'Root' });
  * const gasPricesServiceMessenger = new Messenger<
  *   'SampleGasPricesService',
- *   SampleGasPricesServiceActions,
- *   SampleGasPricesServiceEvents,
+ *   MessengerActions<SampleGasPricesServiceMessenger>,
+ *   MessengerEvents<SampleGasPricesServiceMessenger>,
  *   typeof rootMessenger,
  * >({
  *   namespace: 'SampleGasPricesService',
@@ -52,7 +60,6 @@ const MESSENGER_EXPOSED_METHODS = ['fetchGasPrices'];
  * // Instantiate the service to register its actions on the messenger
  * new SampleGasPricesService({
  *   messenger: gasPricesServiceMessenger,
- *   fetch,
  * });
  *
  * // Later...
@@ -64,84 +71,25 @@ const MESSENGER_EXPOSED_METHODS = ['fetchGasPrices'];
  * // ... Do something with the gas prices ...
  * ```
  */
-class SampleGasPricesService {
+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.fetch - A function that can be used to make an HTTP request. If
-     * your JavaScript environment supports `fetch` natively, you'll probably want
-     * to pass that; otherwise you can pass an equivalent (such as `fetch` via
-     * `node-fetch`).
+     * @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, fetch: fetchFunction, policyOptions = {}, }) {
-        /**
-         * The messenger suited for this service.
-         */
-        _SampleGasPricesService_messenger.set(this, void 0);
-        /**
-         * A function that can be used to make an HTTP request.
-         */
-        _SampleGasPricesService_fetch.set(this, void 0);
-        /**
-         * The policy that wraps the request.
-         *
-         * @see {@link createServicePolicy}
-         */
-        _SampleGasPricesService_policy.set(this, void 0);
-        this.name = exports.serviceName;
-        __classPrivateFieldSet(this, _SampleGasPricesService_messenger, messenger, "f");
-        __classPrivateFieldSet(this, _SampleGasPricesService_fetch, fetchFunction, "f");
-        __classPrivateFieldSet(this, _SampleGasPricesService_policy, (0, controller_utils_1.createServicePolicy)(policyOptions), "f");
-        __classPrivateFieldGet(this, _SampleGasPricesService_messenger, "f").registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
-    }
-    /**
-     * Registers a handler that will be called after a request returns a non-500
-     * response, causing a retry. Primarily useful in tests where timers are being
-     * mocked.
-     *
-     * @param listener - The handler to be called.
-     * @returns An object that can be used to unregister the handler. See
-     * {@link CockatielEvent}.
-     * @see {@link createServicePolicy}
-     */
-    onRetry(listener) {
-        return __classPrivateFieldGet(this, _SampleGasPricesService_policy, "f").onRetry(listener);
-    }
-    /**
-     * Registers a handler that will be called after a set number of retry rounds
-     * prove that requests to the API endpoint consistently return a 5xx response.
-     *
-     * @param listener - The handler to be called.
-     * @returns An object that can be used to unregister the handler. See
-     * {@link CockatielEvent}.
-     * @see {@link createServicePolicy}
-     */
-    onBreak(listener) {
-        return __classPrivateFieldGet(this, _SampleGasPricesService_policy, "f").onBreak(listener);
-    }
-    /**
-     * Registers a handler that will be called under one of two circumstances:
-     *
-     * 1. After a set number of retries prove that requests to the API
-     * consistently result in one of the following failures:
-     *    1. A connection initiation error
-     *    2. A connection reset error
-     *    3. A timeout error
-     *    4. A non-JSON response
-     *    5. A 502, 503, or 504 response
-     * 2. After a successful request is made to the API, but the response takes
-     * longer than a set duration to return.
-     *
-     * @param listener - The handler to be called.
-     * @returns An object that can be used to unregister the handler. See
-     * {@link CockatielEvent}.
-     */
-    onDegraded(listener) {
-        return __classPrivateFieldGet(this, _SampleGasPricesService_policy, "f").onDegraded(listener);
+    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
@@ -151,32 +99,23 @@ class SampleGasPricesService {
      * @returns The gas prices for the given chain.
      */
     async fetchGasPrices(chainId) {
-        const response = await __classPrivateFieldGet(this, _SampleGasPricesService_policy, "f").execute(async () => {
-            const url = new URL('https://api.example.com/gas-prices');
-            url.searchParams.append('chainId', `eip155:${(0, controller_utils_1.fromHex)(chainId).toString()}`);
-            const localResponse = await __classPrivateFieldGet(this, _SampleGasPricesService_fetch, "f").call(this, url);
-            if (!localResponse.ok) {
-                throw new controller_utils_1.HttpError(localResponse.status, `Fetching '${url.toString()}' failed with status '${localResponse.status}'`);
-            }
-            return localResponse;
+        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();
+            },
         });
-        const jsonResponse = await response.json();
-        if ((0, utils_1.isPlainObject)(jsonResponse) &&
-            (0, utils_1.hasProperty)(jsonResponse, 'data') &&
-            (0, utils_1.isPlainObject)(jsonResponse.data) &&
-            (0, utils_1.hasProperty)(jsonResponse.data, 'low') &&
-            (0, utils_1.hasProperty)(jsonResponse.data, 'average') &&
-            (0, utils_1.hasProperty)(jsonResponse.data, 'high')) {
-            const { data: { low, average, high }, } = jsonResponse;
-            if (typeof low === 'number' &&
-                typeof average === 'number' &&
-                typeof high === 'number') {
-                return { low, average, high };
-            }
+        if (!(0, superstruct_1.is)(jsonResponse, GasPricesResponseStruct)) {
+            throw new Error('Malformed response received from gas prices API');
         }
-        throw new Error('Malformed response received from gas prices API');
+        return jsonResponse.data;
     }
 }
 exports.SampleGasPricesService = SampleGasPricesService;
-_a = SampleGasPricesService, _SampleGasPricesService_messenger = new WeakMap(), _SampleGasPricesService_fetch = new WeakMap(), _SampleGasPricesService_policy = new WeakMap();
 //# sourceMappingURL=sample-gas-prices-service.cjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"sample-gas-prices-service.cjs","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-gas-prices-service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAIA,iEAIoC;AAEpC,2CAA6D;AAM7D,kBAAkB;AAElB;;;GAGG;AACU,QAAA,WAAW,GAAG,wBAAwB,CAAC;AAEpD,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,gBAAgB,CAAU,CAAC;AA8C9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAa,sBAAsB;IA2BjC;;;;;;;;;;;OAWG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EAAE,aAAa,EACpB,aAAa,GAAG,EAAE,GAKnB;QAzCD;;WAEG;QACM,oDAES;QAElB;;WAEG;QACM,gDAEK;QAEd;;;;WAIG;QACM,iDAAuB;QAuB9B,IAAI,CAAC,IAAI,GAAG,mBAAW,CAAC;QACxB,uBAAA,IAAI,qCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,iCAAU,aAAa,MAAA,CAAC;QAC5B,uBAAA,IAAI,kCAAW,IAAA,sCAAmB,EAAC,aAAa,CAAC,MAAA,CAAC;QAElD,uBAAA,IAAI,yCAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CACR,QAAoD;QAEpD,OAAO,uBAAA,IAAI,sCAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,cAAc,CAAC,OAAY;QAC/B,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,oCAAoC,CAAC,CAAC;YAC1D,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,SAAS,EACT,UAAU,IAAA,0BAAO,EAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CACxC,CAAC;YACF,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,qCAAO,MAAX,IAAI,EAAQ,GAAG,CAAC,CAAC;YAC7C,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;gBACtB,MAAM,IAAI,4BAAS,CACjB,aAAa,CAAC,MAAM,EACpB,aAAa,GAAG,CAAC,QAAQ,EAAE,yBAAyB,aAAa,CAAC,MAAM,GAAG,CAC5E,CAAC;YACJ,CAAC;YACD,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAE3C,IACE,IAAA,qBAAa,EAAC,YAAY,CAAC;YAC3B,IAAA,mBAAW,EAAC,YAAY,EAAE,MAAM,CAAC;YACjC,IAAA,qBAAa,EAAC,YAAY,CAAC,IAAI,CAAC;YAChC,IAAA,mBAAW,EAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC;YACrC,IAAA,mBAAW,EAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC;YACzC,IAAA,mBAAW,EAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,EACtC,CAAC;YACD,MAAM,EACJ,IAAI,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,GAC7B,GAAG,YAAY,CAAC;YACjB,IACE,OAAO,GAAG,KAAK,QAAQ;gBACvB,OAAO,OAAO,KAAK,QAAQ;gBAC3B,OAAO,IAAI,KAAK,QAAQ,EACxB,CAAC;gBACD,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;YAChC,CAAC;QACH,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;CACF;AA5JD,wDA4JC","sourcesContent":["import type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from '@metamask/controller-utils';\nimport {\n  createServicePolicy,\n  fromHex,\n  HttpError,\n} from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport { hasProperty, isPlainObject } from '@metamask/utils';\nimport type { Hex } from '@metamask/utils';\nimport type { IDisposable } from 'cockatiel';\n\nimport type { SampleGasPricesServiceMethodActions } from './sample-gas-prices-service-method-action-types';\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\nconst MESSENGER_EXPOSED_METHODS = ['fetchGasPrices'] as const;\n\n/**\n * Actions that {@link SampleGasPricesService} exposes to other consumers.\n */\nexport type SampleGasPricesServiceActions = SampleGasPricesServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link SampleGasPricesMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Events that {@link SampleGasPricesService} exposes to other consumers.\n */\nexport type SampleGasPricesServiceEvents = never;\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 * What the API endpoint returns.\n */\ntype GasPricesResponse = {\n  data: {\n    low: number;\n    average: number;\n    high: number;\n  };\n};\n\n/**\n * This service object is responsible for fetching gas prices via an API.\n *\n * @example\n *\n * ``` ts\n * import { Messenger } from '@metamask/messenger';\n * import type {\n *   SampleGasPricesServiceActions,\n *   SampleGasPricesServiceEvents,\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 *   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 *   fetch,\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 {\n  /**\n   * The name of the service.\n   */\n  readonly name: typeof serviceName;\n\n  /**\n   * The messenger suited for this service.\n   */\n  readonly #messenger: ConstructorParameters<\n    typeof SampleGasPricesService\n  >[0]['messenger'];\n\n  /**\n   * A function that can be used to make an HTTP request.\n   */\n  readonly #fetch: ConstructorParameters<\n    typeof SampleGasPricesService\n  >[0]['fetch'];\n\n  /**\n   * The policy that wraps the request.\n   *\n   * @see {@link createServicePolicy}\n   */\n  readonly #policy: ServicePolicy;\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.fetch - A function that can be used to make an HTTP request. If\n   * your JavaScript environment supports `fetch` natively, you'll probably want\n   * to pass that; otherwise you can pass an equivalent (such as `fetch` via\n   * `node-fetch`).\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    fetch: fetchFunction,\n    policyOptions = {},\n  }: {\n    messenger: SampleGasPricesServiceMessenger;\n    fetch: typeof fetch;\n    policyOptions?: CreateServicePolicyOptions;\n  }) {\n    this.name = serviceName;\n    this.#messenger = messenger;\n    this.#fetch = fetchFunction;\n    this.#policy = createServicePolicy(policyOptions);\n\n    this.#messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Registers a handler that will be called after a request returns a non-500\n   * response, causing a retry. Primarily useful in tests where timers are being\n   * mocked.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable {\n    return this.#policy.onRetry(listener);\n  }\n\n  /**\n   * Registers a handler that will be called after a set number of retry rounds\n   * prove that requests to the API endpoint consistently return a 5xx response.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onBreak(listener: Parameters<ServicePolicy['onBreak']>[0]): IDisposable {\n    return this.#policy.onBreak(listener);\n  }\n\n  /**\n   * Registers a handler that will be called under one of two circumstances:\n   *\n   * 1. After a set number of retries prove that requests to the API\n   * consistently result in one of the following failures:\n   *    1. A connection initiation error\n   *    2. A connection reset error\n   *    3. A timeout error\n   *    4. A non-JSON response\n   *    5. A 502, 503, or 504 response\n   * 2. After a successful request is made to the API, but the response takes\n   * longer than a set duration to return.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   */\n  onDegraded(\n    listener: Parameters<ServicePolicy['onDegraded']>[0],\n  ): IDisposable {\n    return this.#policy.onDegraded(listener);\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 response = await this.#policy.execute(async () => {\n      const url = new URL('https://api.example.com/gas-prices');\n      url.searchParams.append(\n        'chainId',\n        `eip155:${fromHex(chainId).toString()}`,\n      );\n      const localResponse = await this.#fetch(url);\n      if (!localResponse.ok) {\n        throw new HttpError(\n          localResponse.status,\n          `Fetching '${url.toString()}' failed with status '${localResponse.status}'`,\n        );\n      }\n      return localResponse;\n    });\n    const jsonResponse = await response.json();\n\n    if (\n      isPlainObject(jsonResponse) &&\n      hasProperty(jsonResponse, 'data') &&\n      isPlainObject(jsonResponse.data) &&\n      hasProperty(jsonResponse.data, 'low') &&\n      hasProperty(jsonResponse.data, 'average') &&\n      hasProperty(jsonResponse.data, 'high')\n    ) {\n      const {\n        data: { low, average, high },\n      } = jsonResponse;\n      if (\n        typeof low === 'number' &&\n        typeof average === 'number' &&\n        typeof high === 'number'\n      ) {\n        return { low, average, high };\n      }\n    }\n\n    throw new Error('Malformed response received from gas prices API');\n  }\n}\n"]}
+{"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';\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"]}

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

@@ -1,25 +1,41 @@
-import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
+import { BaseDataService } from "@metamask/base-data-service";
+import type { DataServiceCacheUpdatedEvent, DataServiceGranularCacheUpdatedEvent, DataServiceInvalidateQueriesAction } from "@metamask/base-data-service";
+import type { CreateServicePolicyOptions } from "@metamask/controller-utils";
 import type { Messenger } from "@metamask/messenger";
+import type { Infer } from "@metamask/superstruct";
 import type { Hex } from "@metamask/utils";
-import type { IDisposable } from "cockatiel";
+import type { QueryClientConfig } from "@tanstack/query-core";
 import type { SampleGasPricesServiceMethodActions } from "./sample-gas-prices-service-method-action-types.cjs";
 /**
  * The name of the {@link SampleGasPricesService}, used to namespace the
  * service's actions and events.
  */
 export declare const serviceName = "SampleGasPricesService";
+/**
+ * Invalidates cached queries for {@link SampleGasPricesService}.
+ */
+export type SampleGasPricesServiceInvalidateQueriesAction = DataServiceInvalidateQueriesAction<typeof serviceName>;
 /**
  * Actions that {@link SampleGasPricesService} exposes to other consumers.
  */
-export type SampleGasPricesServiceActions = SampleGasPricesServiceMethodActions;
+export type SampleGasPricesServiceActions = SampleGasPricesServiceMethodActions | SampleGasPricesServiceInvalidateQueriesAction;
 /**
- * Actions from other messengers that {@link SampleGasPricesMessenger} calls.
+ * Actions from other messengers that {@link SampleGasPricesService} calls.
  */
 type AllowedActions = never;
+/**
+ * Published when {@link SampleGasPricesService}'s cache is updated.
+ */
+export type SampleGasPricesServiceCacheUpdatedEvent = DataServiceCacheUpdatedEvent<typeof serviceName>;
+/**
+ * Published when a key within {@link SampleGasPricesService}'s cache is
+ * updated.
+ */
+export type SampleGasPricesServiceGranularCacheUpdatedEvent = DataServiceGranularCacheUpdatedEvent<typeof serviceName>;
 /**
  * Events that {@link SampleGasPricesService} exposes to other consumers.
  */
-export type SampleGasPricesServiceEvents = never;
+export type SampleGasPricesServiceEvents = SampleGasPricesServiceCacheUpdatedEvent | SampleGasPricesServiceGranularCacheUpdatedEvent;
 /**
  * Events from other messengers that {@link SampleGasPricesService} subscribes
  * to.
@@ -31,25 +47,39 @@ type AllowedEvents = never;
  */
 export type SampleGasPricesServiceMessenger = Messenger<typeof serviceName, SampleGasPricesServiceActions | AllowedActions, SampleGasPricesServiceEvents | AllowedEvents>;
 /**
- * What the API endpoint returns.
+ * Struct to validate what the API endpoint returns.
  */
-type GasPricesResponse = {
+declare const GasPricesResponseStruct: import("@metamask/superstruct").Struct<{
     data: {
         low: number;
         average: number;
         high: number;
     };
-};
+}, {
+    data: import("@metamask/superstruct").Struct<{
+        low: number;
+        average: number;
+        high: number;
+    }, {
+        low: import("@metamask/superstruct").Struct<number, null>;
+        average: import("@metamask/superstruct").Struct<number, null>;
+        high: import("@metamask/superstruct").Struct<number, null>;
+    }>;
+}>;
+/**
+ * What the API endpoint returns.
+ */
+type GasPricesResponse = Infer<typeof GasPricesResponseStruct>;
 /**
  * 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 {
- *   SampleGasPricesServiceActions,
- *   SampleGasPricesServiceEvents,
+ *   SampleGasPricesServiceMessenger,
  * } from '@metamask/sample-controllers';
  *
  * const rootMessenger = new Messenger<
@@ -59,8 +89,8 @@ type GasPricesResponse = {
  * >({ namespace: 'Root' });
  * const gasPricesServiceMessenger = new Messenger<
  *   'SampleGasPricesService',
- *   SampleGasPricesServiceActions,
- *   SampleGasPricesServiceEvents,
+ *   MessengerActions<SampleGasPricesServiceMessenger>,
+ *   MessengerEvents<SampleGasPricesServiceMessenger>,
  *   typeof rootMessenger,
  * >({
  *   namespace: 'SampleGasPricesService',
@@ -69,7 +99,6 @@ type GasPricesResponse = {
  * // Instantiate the service to register its actions on the messenger
  * new SampleGasPricesService({
  *   messenger: gasPricesServiceMessenger,
- *   fetch,
  * });
  *
  * // Later...
@@ -81,68 +110,22 @@ type GasPricesResponse = {
  * // ... Do something with the gas prices ...
  * ```
  */
-export declare class SampleGasPricesService {
-    #private;
-    /**
-     * The name of the service.
-     */
-    readonly name: typeof serviceName;
+export declare class SampleGasPricesService extends BaseDataService<typeof serviceName, SampleGasPricesServiceMessenger> {
     /**
      * Constructs a new SampleGasPricesService object.
      *
      * @param args - The constructor arguments.
      * @param args.messenger - The messenger suited for this service.
-     * @param args.fetch - A function that can be used to make an HTTP request. If
-     * your JavaScript environment supports `fetch` natively, you'll probably want
-     * to pass that; otherwise you can pass an equivalent (such as `fetch` via
-     * `node-fetch`).
+     * @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, fetch: fetchFunction, policyOptions, }: {
+    constructor({ messenger, queryClientConfig, policyOptions, }: {
         messenger: SampleGasPricesServiceMessenger;
-        fetch: typeof fetch;
+        queryClientConfig?: QueryClientConfig;
         policyOptions?: CreateServicePolicyOptions;
     });
-    /**
-     * Registers a handler that will be called after a request returns a non-500
-     * response, causing a retry. Primarily useful in tests where timers are being
-     * mocked.
-     *
-     * @param listener - The handler to be called.
-     * @returns An object that can be used to unregister the handler. See
-     * {@link CockatielEvent}.
-     * @see {@link createServicePolicy}
-     */
-    onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable;
-    /**
-     * Registers a handler that will be called after a set number of retry rounds
-     * prove that requests to the API endpoint consistently return a 5xx response.
-     *
-     * @param listener - The handler to be called.
-     * @returns An object that can be used to unregister the handler. See
-     * {@link CockatielEvent}.
-     * @see {@link createServicePolicy}
-     */
-    onBreak(listener: Parameters<ServicePolicy['onBreak']>[0]): IDisposable;
-    /**
-     * Registers a handler that will be called under one of two circumstances:
-     *
-     * 1. After a set number of retries prove that requests to the API
-     * consistently result in one of the following failures:
-     *    1. A connection initiation error
-     *    2. A connection reset error
-     *    3. A timeout error
-     *    4. A non-JSON response
-     *    5. A 502, 503, or 504 response
-     * 2. After a successful request is made to the API, but the response takes
-     * longer than a set duration to return.
-     *
-     * @param listener - The handler to be called.
-     * @returns An object that can be used to unregister the handler. See
-     * {@link CockatielEvent}.
-     */
-    onDegraded(listener: Parameters<ServicePolicy['onDegraded']>[0]): IDisposable;
     /**
      * Makes a request to the API in order to retrieve gas prices for a particular
      * chain.

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

@@ -1 +1 @@
-{"version":3,"file":"sample-gas-prices-service.d.cts","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-gas-prices-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,mCAAmC;AAMpC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB;AAE7C,OAAO,KAAK,EAAE,mCAAmC,EAAE,4DAAwD;AAI3G;;;GAGG;AACH,eAAO,MAAM,WAAW,2BAA2B,CAAC;AAMpD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,mCAAmC,CAAC;AAEhF;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAAC;AAEjD;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,SAAS,CACrD,OAAO,WAAW,EAClB,6BAA6B,GAAG,cAAc,EAC9C,4BAA4B,GAAG,aAAa,CAC7C,CAAC;AAIF;;GAEG;AACH,KAAK,iBAAiB,GAAG;IACvB,IAAI,EAAE;QACJ,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,qBAAa,sBAAsB;;IACjC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IAuBlC;;;;;;;;;;;OAWG;gBACS,EACV,SAAS,EACT,KAAK,EAAE,aAAa,EACpB,aAAkB,GACnB,EAAE;QACD,SAAS,EAAE,+BAA+B,CAAC;QAC3C,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,aAAa,CAAC,EAAE,0BAA0B,CAAC;KAC5C;IAYD;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW;IAIvE;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW;IAIvE;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CACR,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GACnD,WAAW;IAId;;;;;;OAMG;IACG,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;CAwCvE"}
+{"version":3,"file":"sample-gas-prices-service.d.cts","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-gas-prices-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,oCAAoC;AAC9D,OAAO,KAAK,EACV,4BAA4B,EAC5B,oCAAoC,EACpC,kCAAkC,EACnC,oCAAoC;AACrC,OAAO,KAAK,EAAE,0BAA0B,EAAE,mCAAmC;AAE7E,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAEnD,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAC3C,OAAO,KAAK,EAAE,iBAAiB,EAAE,6BAA6B;AAE9D,OAAO,KAAK,EAAE,mCAAmC,EAAE,4DAAwD;AAI3G;;;GAGG;AACH,eAAO,MAAM,WAAW,2BAA2B,CAAC;AAUpD;;GAEG;AACH,MAAM,MAAM,6CAA6C,GACvD,kCAAkC,CAAC,OAAO,WAAW,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACrC,mCAAmC,GACnC,6CAA6C,CAAC;AAElD;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,uCAAuC,GACjD,4BAA4B,CAAC,OAAO,WAAW,CAAC,CAAC;AAEnD;;;GAGG;AACH,MAAM,MAAM,+CAA+C,GACzD,oCAAoC,CAAC,OAAO,WAAW,CAAC,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACpC,uCAAuC,GACvC,+CAA+C,CAAC;AAEpD;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,SAAS,CACrD,OAAO,WAAW,EAClB,6BAA6B,GAAG,cAAc,EAC9C,4BAA4B,GAAG,aAAa,CAC7C,CAAC;AAIF;;GAEG;AACH,QAAA,MAAM,uBAAuB;;;;;;;;;;;;;;;;EAM3B,CAAC;AAEH;;GAEG;AACH,KAAK,iBAAiB,GAAG,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAO/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,sBAAuB,SAAQ,eAAe,CACzD,OAAO,WAAW,EAClB,+BAA+B,CAChC;IACC;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,iBAAsB,EACtB,aAAkB,GACnB,EAAE;QACD,SAAS,EAAE,+BAA+B,CAAC;QAC3C,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,aAAa,CAAC,EAAE,0BAA0B,CAAC;KAC5C;IAcD;;;;;;OAMG;IACG,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;CA0BvE"}

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

@@ -1,25 +1,41 @@
-import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
+import { BaseDataService } from "@metamask/base-data-service";
+import type { DataServiceCacheUpdatedEvent, DataServiceGranularCacheUpdatedEvent, DataServiceInvalidateQueriesAction } from "@metamask/base-data-service";
+import type { CreateServicePolicyOptions } from "@metamask/controller-utils";
 import type { Messenger } from "@metamask/messenger";
+import type { Infer } from "@metamask/superstruct";
 import type { Hex } from "@metamask/utils";
-import type { IDisposable } from "cockatiel";
+import type { QueryClientConfig } from "@tanstack/query-core";
 import type { SampleGasPricesServiceMethodActions } from "./sample-gas-prices-service-method-action-types.mjs";
 /**
  * The name of the {@link SampleGasPricesService}, used to namespace the
  * service's actions and events.
  */
 export declare const serviceName = "SampleGasPricesService";
+/**
+ * Invalidates cached queries for {@link SampleGasPricesService}.
+ */
+export type SampleGasPricesServiceInvalidateQueriesAction = DataServiceInvalidateQueriesAction<typeof serviceName>;
 /**
  * Actions that {@link SampleGasPricesService} exposes to other consumers.
  */
-export type SampleGasPricesServiceActions = SampleGasPricesServiceMethodActions;
+export type SampleGasPricesServiceActions = SampleGasPricesServiceMethodActions | SampleGasPricesServiceInvalidateQueriesAction;
 /**
- * Actions from other messengers that {@link SampleGasPricesMessenger} calls.
+ * Actions from other messengers that {@link SampleGasPricesService} calls.
  */
 type AllowedActions = never;
+/**
+ * Published when {@link SampleGasPricesService}'s cache is updated.
+ */
+export type SampleGasPricesServiceCacheUpdatedEvent = DataServiceCacheUpdatedEvent<typeof serviceName>;
+/**
+ * Published when a key within {@link SampleGasPricesService}'s cache is
+ * updated.
+ */
+export type SampleGasPricesServiceGranularCacheUpdatedEvent = DataServiceGranularCacheUpdatedEvent<typeof serviceName>;
 /**
  * Events that {@link SampleGasPricesService} exposes to other consumers.
  */
-export type SampleGasPricesServiceEvents = never;
+export type SampleGasPricesServiceEvents = SampleGasPricesServiceCacheUpdatedEvent | SampleGasPricesServiceGranularCacheUpdatedEvent;
 /**
  * Events from other messengers that {@link SampleGasPricesService} subscribes
  * to.
@@ -31,25 +47,39 @@ type AllowedEvents = never;
  */
 export type SampleGasPricesServiceMessenger = Messenger<typeof serviceName, SampleGasPricesServiceActions | AllowedActions, SampleGasPricesServiceEvents | AllowedEvents>;
 /**
- * What the API endpoint returns.
+ * Struct to validate what the API endpoint returns.
  */
-type GasPricesResponse = {
+declare const GasPricesResponseStruct: import("@metamask/superstruct").Struct<{
     data: {
         low: number;
         average: number;
         high: number;
     };
-};
+}, {
+    data: import("@metamask/superstruct").Struct<{
+        low: number;
+        average: number;
+        high: number;
+    }, {
+        low: import("@metamask/superstruct").Struct<number, null>;
+        average: import("@metamask/superstruct").Struct<number, null>;
+        high: import("@metamask/superstruct").Struct<number, null>;
+    }>;
+}>;
+/**
+ * What the API endpoint returns.
+ */
+type GasPricesResponse = Infer<typeof GasPricesResponseStruct>;
 /**
  * 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 {
- *   SampleGasPricesServiceActions,
- *   SampleGasPricesServiceEvents,
+ *   SampleGasPricesServiceMessenger,
  * } from '@metamask/sample-controllers';
  *
  * const rootMessenger = new Messenger<
@@ -59,8 +89,8 @@ type GasPricesResponse = {
  * >({ namespace: 'Root' });
  * const gasPricesServiceMessenger = new Messenger<
  *   'SampleGasPricesService',
- *   SampleGasPricesServiceActions,
- *   SampleGasPricesServiceEvents,
+ *   MessengerActions<SampleGasPricesServiceMessenger>,
+ *   MessengerEvents<SampleGasPricesServiceMessenger>,
  *   typeof rootMessenger,
  * >({
  *   namespace: 'SampleGasPricesService',
@@ -69,7 +99,6 @@ type GasPricesResponse = {
  * // Instantiate the service to register its actions on the messenger
  * new SampleGasPricesService({
  *   messenger: gasPricesServiceMessenger,
- *   fetch,
  * });
  *
  * // Later...
@@ -81,68 +110,22 @@ type GasPricesResponse = {
  * // ... Do something with the gas prices ...
  * ```
  */
-export declare class SampleGasPricesService {
-    #private;
-    /**
-     * The name of the service.
-     */
-    readonly name: typeof serviceName;
+export declare class SampleGasPricesService extends BaseDataService<typeof serviceName, SampleGasPricesServiceMessenger> {
     /**
      * Constructs a new SampleGasPricesService object.
      *
      * @param args - The constructor arguments.
      * @param args.messenger - The messenger suited for this service.
-     * @param args.fetch - A function that can be used to make an HTTP request. If
-     * your JavaScript environment supports `fetch` natively, you'll probably want
-     * to pass that; otherwise you can pass an equivalent (such as `fetch` via
-     * `node-fetch`).
+     * @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, fetch: fetchFunction, policyOptions, }: {
+    constructor({ messenger, queryClientConfig, policyOptions, }: {
         messenger: SampleGasPricesServiceMessenger;
-        fetch: typeof fetch;
+        queryClientConfig?: QueryClientConfig;
         policyOptions?: CreateServicePolicyOptions;
     });
-    /**
-     * Registers a handler that will be called after a request returns a non-500
-     * response, causing a retry. Primarily useful in tests where timers are being
-     * mocked.
-     *
-     * @param listener - The handler to be called.
-     * @returns An object that can be used to unregister the handler. See
-     * {@link CockatielEvent}.
-     * @see {@link createServicePolicy}
-     */
-    onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable;
-    /**
-     * Registers a handler that will be called after a set number of retry rounds
-     * prove that requests to the API endpoint consistently return a 5xx response.
-     *
-     * @param listener - The handler to be called.
-     * @returns An object that can be used to unregister the handler. See
-     * {@link CockatielEvent}.
-     * @see {@link createServicePolicy}
-     */
-    onBreak(listener: Parameters<ServicePolicy['onBreak']>[0]): IDisposable;
-    /**
-     * Registers a handler that will be called under one of two circumstances:
-     *
-     * 1. After a set number of retries prove that requests to the API
-     * consistently result in one of the following failures:
-     *    1. A connection initiation error
-     *    2. A connection reset error
-     *    3. A timeout error
-     *    4. A non-JSON response
-     *    5. A 502, 503, or 504 response
-     * 2. After a successful request is made to the API, but the response takes
-     * longer than a set duration to return.
-     *
-     * @param listener - The handler to be called.
-     * @returns An object that can be used to unregister the handler. See
-     * {@link CockatielEvent}.
-     */
-    onDegraded(listener: Parameters<ServicePolicy['onDegraded']>[0]): IDisposable;
     /**
      * Makes a request to the API in order to retrieve gas prices for a particular
      * chain.

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

@@ -1 +1 @@
-{"version":3,"file":"sample-gas-prices-service.d.mts","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-gas-prices-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,mCAAmC;AAMpC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB;AAE7C,OAAO,KAAK,EAAE,mCAAmC,EAAE,4DAAwD;AAI3G;;;GAGG;AACH,eAAO,MAAM,WAAW,2BAA2B,CAAC;AAMpD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,mCAAmC,CAAC;AAEhF;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAAC;AAEjD;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,SAAS,CACrD,OAAO,WAAW,EAClB,6BAA6B,GAAG,cAAc,EAC9C,4BAA4B,GAAG,aAAa,CAC7C,CAAC;AAIF;;GAEG;AACH,KAAK,iBAAiB,GAAG;IACvB,IAAI,EAAE;QACJ,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,qBAAa,sBAAsB;;IACjC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IAuBlC;;;;;;;;;;;OAWG;gBACS,EACV,SAAS,EACT,KAAK,EAAE,aAAa,EACpB,aAAkB,GACnB,EAAE;QACD,SAAS,EAAE,+BAA+B,CAAC;QAC3C,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,aAAa,CAAC,EAAE,0BAA0B,CAAC;KAC5C;IAYD;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW;IAIvE;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW;IAIvE;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CACR,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GACnD,WAAW;IAId;;;;;;OAMG;IACG,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;CAwCvE"}
+{"version":3,"file":"sample-gas-prices-service.d.mts","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-gas-prices-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,oCAAoC;AAC9D,OAAO,KAAK,EACV,4BAA4B,EAC5B,oCAAoC,EACpC,kCAAkC,EACnC,oCAAoC;AACrC,OAAO,KAAK,EAAE,0BAA0B,EAAE,mCAAmC;AAE7E,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAEnD,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAC3C,OAAO,KAAK,EAAE,iBAAiB,EAAE,6BAA6B;AAE9D,OAAO,KAAK,EAAE,mCAAmC,EAAE,4DAAwD;AAI3G;;;GAGG;AACH,eAAO,MAAM,WAAW,2BAA2B,CAAC;AAUpD;;GAEG;AACH,MAAM,MAAM,6CAA6C,GACvD,kCAAkC,CAAC,OAAO,WAAW,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACrC,mCAAmC,GACnC,6CAA6C,CAAC;AAElD;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,uCAAuC,GACjD,4BAA4B,CAAC,OAAO,WAAW,CAAC,CAAC;AAEnD;;;GAGG;AACH,MAAM,MAAM,+CAA+C,GACzD,oCAAoC,CAAC,OAAO,WAAW,CAAC,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACpC,uCAAuC,GACvC,+CAA+C,CAAC;AAEpD;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,SAAS,CACrD,OAAO,WAAW,EAClB,6BAA6B,GAAG,cAAc,EAC9C,4BAA4B,GAAG,aAAa,CAC7C,CAAC;AAIF;;GAEG;AACH,QAAA,MAAM,uBAAuB;;;;;;;;;;;;;;;;EAM3B,CAAC;AAEH;;GAEG;AACH,KAAK,iBAAiB,GAAG,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAO/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,sBAAuB,SAAQ,eAAe,CACzD,OAAO,WAAW,EAClB,+BAA+B,CAChC;IACC;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,iBAAsB,EACtB,aAAkB,GACnB,EAAE;QACD,SAAS,EAAE,+BAA+B,CAAC;QAC3C,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,aAAa,CAAC,EAAE,0BAA0B,CAAC;KAC5C;IAcD;;;;;;OAMG;IACG,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;CA0BvE"}

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

@@ -1,17 +1,6 @@
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _a, _SampleGasPricesService_messenger, _SampleGasPricesService_fetch, _SampleGasPricesService_policy;
-import { createServicePolicy, fromHex, HttpError } from "@metamask/controller-utils";
-import { hasProperty, isPlainObject } from "@metamask/utils";
+import { BaseDataService } from "@metamask/base-data-service";
+import { HttpError, fromHex } from "@metamask/controller-utils";
+import { is, number, type } from "@metamask/superstruct";
 // === GENERAL ===
 /**
  * The name of the {@link SampleGasPricesService}, used to namespace the
@@ -19,17 +8,36 @@ import { hasProperty, isPlainObject } from "@metamask/utils";
  */
 export const 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 = type({
+    data: type({
+        low: number(),
+        average: number(),
+        high: 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 {
- *   SampleGasPricesServiceActions,
- *   SampleGasPricesServiceEvents,
+ *   SampleGasPricesServiceMessenger,
  * } from '@metamask/sample-controllers';
  *
  * const rootMessenger = new Messenger<
@@ -39,8 +47,8 @@ const MESSENGER_EXPOSED_METHODS = ['fetchGasPrices'];
  * >({ namespace: 'Root' });
  * const gasPricesServiceMessenger = new Messenger<
  *   'SampleGasPricesService',
- *   SampleGasPricesServiceActions,
- *   SampleGasPricesServiceEvents,
+ *   MessengerActions<SampleGasPricesServiceMessenger>,
+ *   MessengerEvents<SampleGasPricesServiceMessenger>,
  *   typeof rootMessenger,
  * >({
  *   namespace: 'SampleGasPricesService',
@@ -49,7 +57,6 @@ const MESSENGER_EXPOSED_METHODS = ['fetchGasPrices'];
  * // Instantiate the service to register its actions on the messenger
  * new SampleGasPricesService({
  *   messenger: gasPricesServiceMessenger,
- *   fetch,
  * });
  *
  * // Later...
@@ -61,84 +68,25 @@ const MESSENGER_EXPOSED_METHODS = ['fetchGasPrices'];
  * // ... Do something with the gas prices ...
  * ```
  */
-export class SampleGasPricesService {
+export class SampleGasPricesService extends BaseDataService {
     /**
      * Constructs a new SampleGasPricesService object.
      *
      * @param args - The constructor arguments.
      * @param args.messenger - The messenger suited for this service.
-     * @param args.fetch - A function that can be used to make an HTTP request. If
-     * your JavaScript environment supports `fetch` natively, you'll probably want
-     * to pass that; otherwise you can pass an equivalent (such as `fetch` via
-     * `node-fetch`).
+     * @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, fetch: fetchFunction, policyOptions = {}, }) {
-        /**
-         * The messenger suited for this service.
-         */
-        _SampleGasPricesService_messenger.set(this, void 0);
-        /**
-         * A function that can be used to make an HTTP request.
-         */
-        _SampleGasPricesService_fetch.set(this, void 0);
-        /**
-         * The policy that wraps the request.
-         *
-         * @see {@link createServicePolicy}
-         */
-        _SampleGasPricesService_policy.set(this, void 0);
-        this.name = serviceName;
-        __classPrivateFieldSet(this, _SampleGasPricesService_messenger, messenger, "f");
-        __classPrivateFieldSet(this, _SampleGasPricesService_fetch, fetchFunction, "f");
-        __classPrivateFieldSet(this, _SampleGasPricesService_policy, createServicePolicy(policyOptions), "f");
-        __classPrivateFieldGet(this, _SampleGasPricesService_messenger, "f").registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
-    }
-    /**
-     * Registers a handler that will be called after a request returns a non-500
-     * response, causing a retry. Primarily useful in tests where timers are being
-     * mocked.
-     *
-     * @param listener - The handler to be called.
-     * @returns An object that can be used to unregister the handler. See
-     * {@link CockatielEvent}.
-     * @see {@link createServicePolicy}
-     */
-    onRetry(listener) {
-        return __classPrivateFieldGet(this, _SampleGasPricesService_policy, "f").onRetry(listener);
-    }
-    /**
-     * Registers a handler that will be called after a set number of retry rounds
-     * prove that requests to the API endpoint consistently return a 5xx response.
-     *
-     * @param listener - The handler to be called.
-     * @returns An object that can be used to unregister the handler. See
-     * {@link CockatielEvent}.
-     * @see {@link createServicePolicy}
-     */
-    onBreak(listener) {
-        return __classPrivateFieldGet(this, _SampleGasPricesService_policy, "f").onBreak(listener);
-    }
-    /**
-     * Registers a handler that will be called under one of two circumstances:
-     *
-     * 1. After a set number of retries prove that requests to the API
-     * consistently result in one of the following failures:
-     *    1. A connection initiation error
-     *    2. A connection reset error
-     *    3. A timeout error
-     *    4. A non-JSON response
-     *    5. A 502, 503, or 504 response
-     * 2. After a successful request is made to the API, but the response takes
-     * longer than a set duration to return.
-     *
-     * @param listener - The handler to be called.
-     * @returns An object that can be used to unregister the handler. See
-     * {@link CockatielEvent}.
-     */
-    onDegraded(listener) {
-        return __classPrivateFieldGet(this, _SampleGasPricesService_policy, "f").onDegraded(listener);
+    constructor({ messenger, queryClientConfig = {}, policyOptions = {}, }) {
+        super({
+            name: 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
@@ -148,31 +96,22 @@ export class SampleGasPricesService {
      * @returns The gas prices for the given chain.
      */
     async fetchGasPrices(chainId) {
-        const response = await __classPrivateFieldGet(this, _SampleGasPricesService_policy, "f").execute(async () => {
-            const url = new URL('https://api.example.com/gas-prices');
-            url.searchParams.append('chainId', `eip155:${fromHex(chainId).toString()}`);
-            const localResponse = await __classPrivateFieldGet(this, _SampleGasPricesService_fetch, "f").call(this, url);
-            if (!localResponse.ok) {
-                throw new HttpError(localResponse.status, `Fetching '${url.toString()}' failed with status '${localResponse.status}'`);
-            }
-            return localResponse;
+        const url = new URL('/gas-prices', BASE_URL);
+        url.searchParams.append('chainId', `eip155:${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 HttpError(response.status, `Gas prices API failed with status '${response.status}'`);
+                }
+                return response.json();
+            },
         });
-        const jsonResponse = await response.json();
-        if (isPlainObject(jsonResponse) &&
-            hasProperty(jsonResponse, 'data') &&
-            isPlainObject(jsonResponse.data) &&
-            hasProperty(jsonResponse.data, 'low') &&
-            hasProperty(jsonResponse.data, 'average') &&
-            hasProperty(jsonResponse.data, 'high')) {
-            const { data: { low, average, high }, } = jsonResponse;
-            if (typeof low === 'number' &&
-                typeof average === 'number' &&
-                typeof high === 'number') {
-                return { low, average, high };
-            }
+        if (!is(jsonResponse, GasPricesResponseStruct)) {
+            throw new Error('Malformed response received from gas prices API');
         }
-        throw new Error('Malformed response received from gas prices API');
+        return jsonResponse.data;
     }
 }
-_a = SampleGasPricesService, _SampleGasPricesService_messenger = new WeakMap(), _SampleGasPricesService_fetch = new WeakMap(), _SampleGasPricesService_policy = new WeakMap();
 //# sourceMappingURL=sample-gas-prices-service.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"sample-gas-prices-service.mjs","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-gas-prices-service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,OAAO,EACL,mBAAmB,EACnB,OAAO,EACP,SAAS,EACV,mCAAmC;AAEpC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,wBAAwB;AAM7D,kBAAkB;AAElB;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,wBAAwB,CAAC;AAEpD,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,gBAAgB,CAAU,CAAC;AA8C9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,OAAO,sBAAsB;IA2BjC;;;;;;;;;;;OAWG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EAAE,aAAa,EACpB,aAAa,GAAG,EAAE,GAKnB;QAzCD;;WAEG;QACM,oDAES;QAElB;;WAEG;QACM,gDAEK;QAEd;;;;WAIG;QACM,iDAAuB;QAuB9B,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,uBAAA,IAAI,qCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,iCAAU,aAAa,MAAA,CAAC;QAC5B,uBAAA,IAAI,kCAAW,mBAAmB,CAAC,aAAa,CAAC,MAAA,CAAC;QAElD,uBAAA,IAAI,yCAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CACR,QAAoD;QAEpD,OAAO,uBAAA,IAAI,sCAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,cAAc,CAAC,OAAY;QAC/B,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,oCAAoC,CAAC,CAAC;YAC1D,GAAG,CAAC,YAAY,CAAC,MAAM,CACrB,SAAS,EACT,UAAU,OAAO,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CACxC,CAAC;YACF,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,qCAAO,MAAX,IAAI,EAAQ,GAAG,CAAC,CAAC;YAC7C,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;gBACtB,MAAM,IAAI,SAAS,CACjB,aAAa,CAAC,MAAM,EACpB,aAAa,GAAG,CAAC,QAAQ,EAAE,yBAAyB,aAAa,CAAC,MAAM,GAAG,CAC5E,CAAC;YACJ,CAAC;YACD,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAE3C,IACE,aAAa,CAAC,YAAY,CAAC;YAC3B,WAAW,CAAC,YAAY,EAAE,MAAM,CAAC;YACjC,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC;YAChC,WAAW,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC;YACrC,WAAW,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC;YACzC,WAAW,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,EACtC,CAAC;YACD,MAAM,EACJ,IAAI,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,GAC7B,GAAG,YAAY,CAAC;YACjB,IACE,OAAO,GAAG,KAAK,QAAQ;gBACvB,OAAO,OAAO,KAAK,QAAQ;gBAC3B,OAAO,IAAI,KAAK,QAAQ,EACxB,CAAC;gBACD,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;YAChC,CAAC;QACH,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;CACF","sourcesContent":["import type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from '@metamask/controller-utils';\nimport {\n  createServicePolicy,\n  fromHex,\n  HttpError,\n} from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport { hasProperty, isPlainObject } from '@metamask/utils';\nimport type { Hex } from '@metamask/utils';\nimport type { IDisposable } from 'cockatiel';\n\nimport type { SampleGasPricesServiceMethodActions } from './sample-gas-prices-service-method-action-types';\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\nconst MESSENGER_EXPOSED_METHODS = ['fetchGasPrices'] as const;\n\n/**\n * Actions that {@link SampleGasPricesService} exposes to other consumers.\n */\nexport type SampleGasPricesServiceActions = SampleGasPricesServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link SampleGasPricesMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Events that {@link SampleGasPricesService} exposes to other consumers.\n */\nexport type SampleGasPricesServiceEvents = never;\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 * What the API endpoint returns.\n */\ntype GasPricesResponse = {\n  data: {\n    low: number;\n    average: number;\n    high: number;\n  };\n};\n\n/**\n * This service object is responsible for fetching gas prices via an API.\n *\n * @example\n *\n * ``` ts\n * import { Messenger } from '@metamask/messenger';\n * import type {\n *   SampleGasPricesServiceActions,\n *   SampleGasPricesServiceEvents,\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 *   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 *   fetch,\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 {\n  /**\n   * The name of the service.\n   */\n  readonly name: typeof serviceName;\n\n  /**\n   * The messenger suited for this service.\n   */\n  readonly #messenger: ConstructorParameters<\n    typeof SampleGasPricesService\n  >[0]['messenger'];\n\n  /**\n   * A function that can be used to make an HTTP request.\n   */\n  readonly #fetch: ConstructorParameters<\n    typeof SampleGasPricesService\n  >[0]['fetch'];\n\n  /**\n   * The policy that wraps the request.\n   *\n   * @see {@link createServicePolicy}\n   */\n  readonly #policy: ServicePolicy;\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.fetch - A function that can be used to make an HTTP request. If\n   * your JavaScript environment supports `fetch` natively, you'll probably want\n   * to pass that; otherwise you can pass an equivalent (such as `fetch` via\n   * `node-fetch`).\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    fetch: fetchFunction,\n    policyOptions = {},\n  }: {\n    messenger: SampleGasPricesServiceMessenger;\n    fetch: typeof fetch;\n    policyOptions?: CreateServicePolicyOptions;\n  }) {\n    this.name = serviceName;\n    this.#messenger = messenger;\n    this.#fetch = fetchFunction;\n    this.#policy = createServicePolicy(policyOptions);\n\n    this.#messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Registers a handler that will be called after a request returns a non-500\n   * response, causing a retry. Primarily useful in tests where timers are being\n   * mocked.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable {\n    return this.#policy.onRetry(listener);\n  }\n\n  /**\n   * Registers a handler that will be called after a set number of retry rounds\n   * prove that requests to the API endpoint consistently return a 5xx response.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onBreak(listener: Parameters<ServicePolicy['onBreak']>[0]): IDisposable {\n    return this.#policy.onBreak(listener);\n  }\n\n  /**\n   * Registers a handler that will be called under one of two circumstances:\n   *\n   * 1. After a set number of retries prove that requests to the API\n   * consistently result in one of the following failures:\n   *    1. A connection initiation error\n   *    2. A connection reset error\n   *    3. A timeout error\n   *    4. A non-JSON response\n   *    5. A 502, 503, or 504 response\n   * 2. After a successful request is made to the API, but the response takes\n   * longer than a set duration to return.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   */\n  onDegraded(\n    listener: Parameters<ServicePolicy['onDegraded']>[0],\n  ): IDisposable {\n    return this.#policy.onDegraded(listener);\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 response = await this.#policy.execute(async () => {\n      const url = new URL('https://api.example.com/gas-prices');\n      url.searchParams.append(\n        'chainId',\n        `eip155:${fromHex(chainId).toString()}`,\n      );\n      const localResponse = await this.#fetch(url);\n      if (!localResponse.ok) {\n        throw new HttpError(\n          localResponse.status,\n          `Fetching '${url.toString()}' failed with status '${localResponse.status}'`,\n        );\n      }\n      return localResponse;\n    });\n    const jsonResponse = await response.json();\n\n    if (\n      isPlainObject(jsonResponse) &&\n      hasProperty(jsonResponse, 'data') &&\n      isPlainObject(jsonResponse.data) &&\n      hasProperty(jsonResponse.data, 'low') &&\n      hasProperty(jsonResponse.data, 'average') &&\n      hasProperty(jsonResponse.data, 'high')\n    ) {\n      const {\n        data: { low, average, high },\n      } = jsonResponse;\n      if (\n        typeof low === 'number' &&\n        typeof average === 'number' &&\n        typeof high === 'number'\n      ) {\n        return { low, average, high };\n      }\n    }\n\n    throw new Error('Malformed response received from gas prices API');\n  }\n}\n"]}
+{"version":3,"file":"sample-gas-prices-service.mjs","sourceRoot":"","sources":["../../src/sample-gas-prices-service/sample-gas-prices-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,oCAAoC;AAO9D,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,mCAAmC;AAGhE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,8BAA8B;AAMzD,kBAAkB;AAElB;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,wBAAwB,CAAC;AAEpD,oBAAoB;AAEpB;;;GAGG;AACH,MAAM,yBAAyB,GAAG,CAAC,gBAAgB,CAAU,CAAC;AAwD9D,6BAA6B;AAE7B;;GAEG;AACH,MAAM,uBAAuB,GAAG,IAAI,CAAC;IACnC,IAAI,EAAE,IAAI,CAAC;QACT,GAAG,EAAE,MAAM,EAAE;QACb,OAAO,EAAE,MAAM,EAAE;QACjB,IAAI,EAAE,MAAM,EAAE;KACf,CAAC;CACH,CAAC,CAAC;AAOH;;GAEG;AACH,MAAM,QAAQ,GAAG,yBAAyB,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,OAAO,sBAAuB,SAAQ,eAG3C;IACC;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,iBAAiB,GAAG,EAAE,EACtB,aAAa,GAAG,EAAE,GAKnB;QACC,KAAK,CAAC;YACJ,IAAI,EAAE,WAAW;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,OAAO,CAAC,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,SAAS,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,EAAE,CAAC,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","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';\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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/sample-controllers",
-  "version": "4.0.4-preview-bfb4d9f5a",
+  "version": "4.0.4-preview-1d148d2",
   "description": "Sample package to illustrate best practices for controllers",
   "keywords": [
     "MetaMask",
@@ -49,9 +49,12 @@
   },
   "dependencies": {
     "@metamask/base-controller": "^9.0.1",
-    "@metamask/messenger": "^1.0.0",
+    "@metamask/base-data-service": "^0.1.1",
+    "@metamask/messenger": "^1.1.0",
     "@metamask/network-controller": "^30.0.1",
-    "@metamask/utils": "^11.9.0"
+    "@metamask/superstruct": "^3.1.0",
+    "@metamask/utils": "^11.9.0",
+    "@tanstack/query-core": "^4.43.0"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^3.4.4",