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

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

@@ -1,44 +1,141 @@
-import type { Hex } from "@metamask/utils";
+import type { RestrictedMessenger } from "@metamask/base-controller";
+import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
+import { type Hex } from "@metamask/utils";
+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";
+/**
+ * Actions that {@link SampleGasPricesService} exposes to other consumers.
+ */
+export type SampleGasPricesServiceActions = SampleGasPricesServiceMethodActions;
+/**
+ * Actions from other messengers that {@link SampleGasPricesMessenger} calls.
+ */
+type AllowedActions = never;
+/**
+ * Events that {@link SampleGasPricesService} exposes to other consumers.
+ */
+export type SampleGasPricesServiceEvents = never;
+/**
+ * Events from other messengers that {@link SampleGasPricesService} subscribes
+ * to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger which is restricted to actions and events accessed by
+ * {@link SampleGasPricesService}.
+ */
+export type SampleGasPricesServiceMessenger = RestrictedMessenger<typeof serviceName, SampleGasPricesServiceActions | AllowedActions, SampleGasPricesServiceEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+/**
+ * What the API endpoint returns.
+ */
+type GasPricesResponse = {
+    data: {
+        low: number;
+        average: number;
+        high: number;
+    };
+};
 /**
  * This service object is responsible for fetching gas prices via an API.
  *
  * @example
  *
- * On its own:
- *
  * ``` ts
- * const gasPricesService = new SampleGasPricesService({ fetch });
- * // Fetch gas prices for Mainnet
- * const gasPricesResponse = await gasPricesService.fetchGasPrices('0x1');
- * // ... Do something with the response ...
- * ```
+ * import type {
+ *   SampleGasPricesServiceActions,
+ *   SampleGasPricesServiceEvents
+ * } from '@metamask/sample-controllers';
  *
- * In conjunction with `SampleGasPricesController`:
- *
- * ``` ts
- * const gasPricesService = new SampleGasPricesService({ fetch });
- * const gasPricesController = new SampleGasPricesController({
- *   // ... state, messenger, etc. ...
- *   gasPricesService,
+ * const globalMessenger = new Messenger<
+ *   SampleGasPricesServiceActions
+ *   SampleGasPricesServiceEvents
+ * >();
+ * const gasPricesServiceMessenger = globalMessenger.getRestricted({
+ *   name: 'SampleGasPricesService',
+ *   allowedActions: [],
+ *   allowedEvents: [],
+ * });
+ * // Instantiate the service to register its actions on the messenger
+ * new SampleGasPricesService({
+ *   messenger: gasPricesServiceMessenger,
+ *   fetch,
  * });
- * // This will use the service object internally
- * gasPricesController.updateGasPrices();
+ *
+ * // Later...
+ * // Fetch gas prices for Mainnet
+ * const gasPrices = await globalMessenger.call(
+ *   'SampleGasPricesService:fetchGasPrices',
+ *   '0x1',
+ * );
+ * // ... Do something with the gas prices ...
  * ```
  */
 export declare class SampleGasPricesService {
     #private;
+    /**
+     * The name of the service.
+     */
+    readonly name: typeof serviceName;
     /**
      * Constructs a new SampleGasPricesService object.
      *
-     * @param args - The arguments.
-     * @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 - 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.policyOptions - Options to pass to `createServicePolicy`, which
+     * is used to wrap each request. See {@link CreateServicePolicyOptions}.
      */
-    constructor({ fetch: fetchFunction }: {
+    constructor({ messenger, fetch: fetchFunction, policyOptions, }: {
+        messenger: SampleGasPricesServiceMessenger;
         fetch: typeof fetch;
+        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]): import("cockatiel").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]): import("cockatiel").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]): import("cockatiel").IDisposable;
     /**
      * Makes a request to the API in order to retrieve gas prices for a particular
      * chain.
@@ -46,10 +143,7 @@ export declare class SampleGasPricesService {
      * @param chainId - The chain ID for which you want to fetch gas prices.
      * @returns The gas prices for the given chain.
      */
-    fetchGasPrices(chainId: Hex): Promise<{
-        low: number;
-        average: number;
-        high: number;
-    }>;
+    fetchGasPrices(chainId: Hex): Promise<GasPricesResponse['data']>;
 }
+export {};
 //# sourceMappingURL=sample-gas-prices-service.d.mts.map

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,EAAE,GAAG,EAAE,wBAAwB;AAa3C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,sBAAsB;;IAGjC;;;;;;;;OAQG;gBACS,EAAE,KAAK,EAAE,aAAa,EAAE,EAAE;QAAE,KAAK,EAAE,OAAO,KAAK,CAAA;KAAE;IAI7D;;;;;;OAMG;IACG,cAAc,CAAC,OAAO,EAAE,GAAG;;;;;CASlC"}
+{"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,EAAE,mBAAmB,EAAE,kCAAkC;AACrE,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,mCAAmC;AAMpC,OAAO,EAA8B,KAAK,GAAG,EAAE,wBAAwB;AAEvE,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,mBAAmB,CAC/D,OAAO,WAAW,EAClB,6BAA6B,GAAG,cAAc,EAC9C,4BAA4B,GAAG,aAAa,EAC5C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;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;IAIzD;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAKzD;;;;;;;;;;;;;;;;OAgBG;IAEH,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAI/D;;;;;;OAMG;IACG,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;CAqCvE"}

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

@@ -9,46 +9,132 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _SampleGasPricesService_fetch;
+var _a, _SampleGasPricesService_messenger, _SampleGasPricesService_fetch, _SampleGasPricesService_policy;
+import { createServicePolicy, fromHex, HttpError } from "@metamask/controller-utils";
+import { hasProperty, isPlainObject } from "@metamask/utils";
+// === GENERAL ===
+/**
+ * The name of the {@link SampleGasPricesService}, used to namespace the
+ * service's actions and events.
+ */
+export const serviceName = 'SampleGasPricesService';
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = ['fetchGasPrices'];
 /**
  * This service object is responsible for fetching gas prices via an API.
  *
  * @example
  *
- * On its own:
- *
  * ``` ts
- * const gasPricesService = new SampleGasPricesService({ fetch });
- * // Fetch gas prices for Mainnet
- * const gasPricesResponse = await gasPricesService.fetchGasPrices('0x1');
- * // ... Do something with the response ...
- * ```
- *
- * In conjunction with `SampleGasPricesController`:
+ * import type {
+ *   SampleGasPricesServiceActions,
+ *   SampleGasPricesServiceEvents
+ * } from '@metamask/sample-controllers';
  *
- * ``` ts
- * const gasPricesService = new SampleGasPricesService({ fetch });
- * const gasPricesController = new SampleGasPricesController({
- *   // ... state, messenger, etc. ...
- *   gasPricesService,
+ * const globalMessenger = new Messenger<
+ *   SampleGasPricesServiceActions
+ *   SampleGasPricesServiceEvents
+ * >();
+ * const gasPricesServiceMessenger = globalMessenger.getRestricted({
+ *   name: 'SampleGasPricesService',
+ *   allowedActions: [],
+ *   allowedEvents: [],
+ * });
+ * // Instantiate the service to register its actions on the messenger
+ * new SampleGasPricesService({
+ *   messenger: gasPricesServiceMessenger,
+ *   fetch,
  * });
- * // This will use the service object internally
- * gasPricesController.updateGasPrices();
+ *
+ * // Later...
+ * // Fetch gas prices for Mainnet
+ * const gasPrices = await globalMessenger.call(
+ *   'SampleGasPricesService:fetchGasPrices',
+ *   '0x1',
+ * );
+ * // ... Do something with the gas prices ...
  * ```
  */
 export class SampleGasPricesService {
     /**
      * Constructs a new SampleGasPricesService object.
      *
-     * @param args - The arguments.
-     * @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 - 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.policyOptions - Options to pass to `createServicePolicy`, which
+     * is used to wrap each request. See {@link CreateServicePolicyOptions}.
      */
-    constructor({ fetch: fetchFunction }) {
+    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);
+    }
+    /* eslint-disable jsdoc/check-indentation */
+    /**
+     * 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}.
+     */
+    /* eslint-enable jsdoc/check-indentation */
+    onDegraded(listener) {
+        return __classPrivateFieldGet(this, _SampleGasPricesService_policy, "f").onDegraded(listener);
     }
     /**
      * Makes a request to the API in order to retrieve gas prices for a particular
@@ -58,11 +144,31 @@ export class SampleGasPricesService {
      * @returns The gas prices for the given chain.
      */
     async fetchGasPrices(chainId) {
-        const response = await __classPrivateFieldGet(this, _SampleGasPricesService_fetch, "f").call(this, `https://example.com/gas-prices/${chainId}.json`);
-        // Type assertion: We have to assume the shape of the response data.
-        const gasPricesResponse = (await response.json());
-        return gasPricesResponse.data;
+        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)}`);
+            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 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 };
+            }
+        }
+        throw new Error('Malformed response received from gas prices API');
     }
 }
-_SampleGasPricesService_fetch = new WeakMap();
+_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":";;;;;;;;;;;;AAaA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAO,sBAAsB;IAGjC;;;;;;;;OAQG;IACH,YAAY,EAAE,KAAK,EAAE,aAAa,EAA2B;QAXpD,gDAAqB;QAY5B,uBAAA,IAAI,iCAAU,aAAa,MAAA,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,cAAc,CAAC,OAAY;QAC/B,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,qCAAO,MAAX,IAAI,EACzB,kCAAkC,OAAO,OAAO,CACjD,CAAC;QACF,oEAAoE;QACpE,MAAM,iBAAiB,GACrB,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAiC,CAAC;QAC1D,OAAO,iBAAiB,CAAC,IAAI,CAAC;IAChC,CAAC;CACF","sourcesContent":["import type { Hex } from '@metamask/utils';\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 * On its own:\n *\n * ``` ts\n * const gasPricesService = new SampleGasPricesService({ fetch });\n * // Fetch gas prices for Mainnet\n * const gasPricesResponse = await gasPricesService.fetchGasPrices('0x1');\n * // ... Do something with the response ...\n * ```\n *\n * In conjunction with `SampleGasPricesController`:\n *\n * ``` ts\n * const gasPricesService = new SampleGasPricesService({ fetch });\n * const gasPricesController = new SampleGasPricesController({\n *   // ... state, messenger, etc. ...\n *   gasPricesService,\n * });\n * // This will use the service object internally\n * gasPricesController.updateGasPrices();\n * ```\n */\nexport class SampleGasPricesService {\n  readonly #fetch: typeof fetch;\n\n  /**\n   * Constructs a new SampleGasPricesService object.\n   *\n   * @param args - The arguments.\n   * @param args.fetch - A function that can be used to make an HTTP request.\n   * If your JavaScript environment supports `fetch` natively, you'll probably\n   * want to pass that; otherwise you can pass an equivalent (such as `fetch`\n   * via `node-fetch`).\n   */\n  constructor({ fetch: fetchFunction }: { fetch: typeof fetch }) {\n    this.#fetch = fetchFunction;\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) {\n    const response = await this.#fetch(\n      `https://example.com/gas-prices/${chainId}.json`,\n    );\n    // Type assertion: We have to assume the shape of the response data.\n    const gasPricesResponse =\n      (await response.json()) as unknown as GasPricesResponse;\n    return gasPricesResponse.data;\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":";;;;;;;;;;;;AAKA,OAAO,EACL,mBAAmB,EACnB,OAAO,EACP,SAAS,EACV,mCAAmC;AACpC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAY,wBAAwB;AAIvE,kBAAkB;AAElB;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,wBAAwB,CAAC;AAEpD,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,gBAAgB,CAAU,CAAC;AAgD9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;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,4CAA4C;IAC5C;;;;;;;;;;;;;;;;OAgBG;IACH,2CAA2C;IAC3C,UAAU,CAAC,QAAoD;QAC7D,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,CAAC,SAAS,EAAE,UAAU,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACjE,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,qCAAO,MAAX,IAAI,EAAQ,GAAG,CAAC,CAAC;YAC7C,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE;gBACrB,MAAM,IAAI,SAAS,CACjB,aAAa,CAAC,MAAM,EACpB,aAAa,GAAG,CAAC,QAAQ,EAAE,yBAAyB,aAAa,CAAC,MAAM,GAAG,CAC5E,CAAC;aACH;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;YACA,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;gBACA,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;aAC/B;SACF;QAED,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;CACF","sourcesContent":["import type { RestrictedMessenger } from '@metamask/base-controller';\nimport type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from '@metamask/controller-utils';\nimport {\n  createServicePolicy,\n  fromHex,\n  HttpError,\n} from '@metamask/controller-utils';\nimport { hasProperty, isPlainObject, type Hex } from '@metamask/utils';\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 = RestrictedMessenger<\n  typeof serviceName,\n  SampleGasPricesServiceActions | AllowedActions,\n  SampleGasPricesServiceEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\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 type {\n *   SampleGasPricesServiceActions,\n *   SampleGasPricesServiceEvents\n * } from '@metamask/sample-controllers';\n *\n * const globalMessenger = new Messenger<\n *   SampleGasPricesServiceActions\n *   SampleGasPricesServiceEvents\n * >();\n * const gasPricesServiceMessenger = globalMessenger.getRestricted({\n *   name: 'SampleGasPricesService',\n *   allowedActions: [],\n *   allowedEvents: [],\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 globalMessenger.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]) {\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]) {\n    return this.#policy.onBreak(listener);\n  }\n\n  /* eslint-disable jsdoc/check-indentation */\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  /* eslint-enable jsdoc/check-indentation */\n  onDegraded(listener: Parameters<ServicePolicy['onDegraded']>[0]) {\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('chainId', `eip155:${fromHex(chainId)}`);\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"]}

package/dist/sample-petnames-controller-method-action-types.cjs

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

package/dist/sample-petnames-controller-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sample-petnames-controller-method-action-types.cjs","sourceRoot":"","sources":["../src/sample-petnames-controller-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { SamplePetnamesController } from './sample-petnames-controller';\n\n/**\n * Registers the given name with the given address (relative to the given\n * chain).\n *\n * @param chainId - The chain ID that the address belongs to.\n * @param address - The account address to name.\n * @param name - The name to assign to the address.\n */\nexport type SamplePetnamesControllerAssignPetnameAction = {\n  type: `SamplePetnamesController:assignPetname`;\n  handler: SamplePetnamesController['assignPetname'];\n};\n\n/**\n * Union of all SamplePetnamesController action types.\n */\nexport type SamplePetnamesControllerMethodActions =\n  SamplePetnamesControllerAssignPetnameAction;\n"]}

package/dist/sample-petnames-controller-method-action-types.d.cts

@@ -0,0 +1,22 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { SamplePetnamesController } from "./sample-petnames-controller.cjs";
+/**
+ * Registers the given name with the given address (relative to the given
+ * chain).
+ *
+ * @param chainId - The chain ID that the address belongs to.
+ * @param address - The account address to name.
+ * @param name - The name to assign to the address.
+ */
+export type SamplePetnamesControllerAssignPetnameAction = {
+    type: `SamplePetnamesController:assignPetname`;
+    handler: SamplePetnamesController['assignPetname'];
+};
+/**
+ * Union of all SamplePetnamesController action types.
+ */
+export type SamplePetnamesControllerMethodActions = SamplePetnamesControllerAssignPetnameAction;
+//# sourceMappingURL=sample-petnames-controller-method-action-types.d.cts.map

package/dist/sample-petnames-controller-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sample-petnames-controller-method-action-types.d.cts","sourceRoot":"","sources":["../src/sample-petnames-controller-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,wBAAwB,EAAE,yCAAqC;AAE7E;;;;;;;GAOG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,wBAAwB,CAAC,eAAe,CAAC,CAAC;CACpD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC/C,2CAA2C,CAAC"}

package/dist/sample-petnames-controller-method-action-types.d.mts

@@ -0,0 +1,22 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { SamplePetnamesController } from "./sample-petnames-controller.mjs";
+/**
+ * Registers the given name with the given address (relative to the given
+ * chain).
+ *
+ * @param chainId - The chain ID that the address belongs to.
+ * @param address - The account address to name.
+ * @param name - The name to assign to the address.
+ */
+export type SamplePetnamesControllerAssignPetnameAction = {
+    type: `SamplePetnamesController:assignPetname`;
+    handler: SamplePetnamesController['assignPetname'];
+};
+/**
+ * Union of all SamplePetnamesController action types.
+ */
+export type SamplePetnamesControllerMethodActions = SamplePetnamesControllerAssignPetnameAction;
+//# sourceMappingURL=sample-petnames-controller-method-action-types.d.mts.map

package/dist/sample-petnames-controller-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sample-petnames-controller-method-action-types.d.mts","sourceRoot":"","sources":["../src/sample-petnames-controller-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,wBAAwB,EAAE,yCAAqC;AAE7E;;;;;;;GAOG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,wBAAwB,CAAC,eAAe,CAAC,CAAC;CACpD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC/C,2CAA2C,CAAC"}

package/dist/sample-petnames-controller-method-action-types.mjs

@@ -0,0 +1,6 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+export {};
+//# sourceMappingURL=sample-petnames-controller-method-action-types.mjs.map

package/dist/sample-petnames-controller-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sample-petnames-controller-method-action-types.mjs","sourceRoot":"","sources":["../src/sample-petnames-controller-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { SamplePetnamesController } from './sample-petnames-controller';\n\n/**\n * Registers the given name with the given address (relative to the given\n * chain).\n *\n * @param chainId - The chain ID that the address belongs to.\n * @param address - The account address to name.\n * @param name - The name to assign to the address.\n */\nexport type SamplePetnamesControllerAssignPetnameAction = {\n  type: `SamplePetnamesController:assignPetname`;\n  handler: SamplePetnamesController['assignPetname'];\n};\n\n/**\n * Union of all SamplePetnamesController action types.\n */\nexport type SamplePetnamesControllerMethodActions =\n  SamplePetnamesControllerAssignPetnameAction;\n"]}

package/dist/sample-petnames-controller.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SamplePetnamesController = exports.controllerName = void 0;
+exports.SamplePetnamesController = exports.getDefaultPetnamesControllerState = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
 const controller_utils_1 = require("@metamask/controller-utils");
 // === GENERAL ===
@@ -32,10 +32,13 @@ function getDefaultPetnamesControllerState() {
         namesByChainIdAndAddress: {},
     };
 }
+exports.getDefaultPetnamesControllerState = getDefaultPetnamesControllerState;
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = ['assignPetname'];
 // === CONTROLLER DEFINITION ===
 /**
- * `SamplePetnamesController` records user-provided nicknames for various addresses on
- * various chains.
+ * `SamplePetnamesController` records user-provided nicknames for various
+ * addresses on various chains.
  *
  * @example
  *
@@ -44,27 +47,34 @@ function getDefaultPetnamesControllerState() {
  * import type {
  *   SamplePetnamesControllerActions,
  *   SamplePetnamesControllerEvents
- * } from '@metamask/example-controllers';
+ * } from '@metamask/sample-controllers';
  *
- * const rootMessenger = new Messenger<
+ * const globalMessenger = new Messenger<
  *  SamplePetnamesControllerActions,
  *  SamplePetnamesControllerEvents
  * >();
- * const samplePetnamesMessenger = rootMessenger.getRestricted({
+ * const samplePetnamesMessenger = globalMessenger.getRestricted({
  *   name: 'SamplePetnamesController',
  *   allowedActions: [],
  *   allowedEvents: [],
  * });
- * const samplePetnamesController = new SamplePetnamesController({
+ * // Instantiate the controller to register its actions on the messenger
+ * new SamplePetnamesController({
  *   messenger: samplePetnamesMessenger,
  * });
  *
- * samplePetnamesController.assignPetname(
- *   '0x1',
- *   '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99',
- *   'Primary Account'
+ * globalMessenger.call(
+ *   'SamplePetnamesController:assignPetname',
+ *   [
+ *     '0x1',
+ *     '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99',
+ *     'Primary Account',
+ *   ],
  * );
- * samplePetnamesController.state.namesByChainIdAndAddress
+ * const samplePetnamesControllerState = await globalMessenger.call(
+ *   'SamplePetnamesController:getState',
+ * );
+ * samplePetnamesControllerState.namesByChainIdAndAddress
  * // => { '0x1': { '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99': 'Primary Account' } }
  * ```
  */
@@ -72,7 +82,7 @@ class SamplePetnamesController extends base_controller_1.BaseController {
     /**
      * Constructs a new {@link SamplePetnamesController}.
      *
-     * @param args - The arguments to the controller.
+     * @param args - The arguments to this controller.
      * @param args.messenger - The messenger suited for this controller.
      * @param args.state - The desired state with which to initialize this
      * controller. Missing properties will be filled in with defaults.
@@ -87,6 +97,7 @@ class SamplePetnamesController extends base_controller_1.BaseController {
                 ...state,
             },
         });
+        this.messagingSystem.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
     }
     /**
      * Registers the given name with the given address (relative to the given

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

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