@metamask-previews/sample-controllers 5.0.6-preview-8bfa290fb → 6.0.0-preview-0a30e47

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

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

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

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

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

@@ -1,139 +0,0 @@
-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 { 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 | SampleGasPricesServiceInvalidateQueriesAction;
-/**
- * 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 = SampleGasPricesServiceCacheUpdatedEvent | SampleGasPricesServiceGranularCacheUpdatedEvent;
-/**
- * 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 = Messenger<typeof serviceName, SampleGasPricesServiceActions | AllowedActions, SampleGasPricesServiceEvents | AllowedEvents>;
-/**
- * Struct to validate what the API endpoint returns.
- */
-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 {
- *   SampleGasPricesServiceMessenger,
- * } from '@metamask/sample-controllers';
- *
- * const rootMessenger = new Messenger<
- *   'Root',
- *   SampleGasPricesServiceActions
- *   SampleGasPricesServiceEvents
- * >({ namespace: 'Root' });
- * const gasPricesServiceMessenger = new Messenger<
- *   'SampleGasPricesService',
- *   MessengerActions<SampleGasPricesServiceMessenger>,
- *   MessengerEvents<SampleGasPricesServiceMessenger>,
- *   typeof rootMessenger,
- * >({
- *   namespace: 'SampleGasPricesService',
- *   parent: rootMessenger,
- * });
- * // Instantiate the service to register its actions on the messenger
- * new SampleGasPricesService({
- *   messenger: gasPricesServiceMessenger,
- * });
- *
- * // Later...
- * // Fetch gas prices for Mainnet
- * const gasPrices = await rootMessenger.call(
- *   'SampleGasPricesService:fetchGasPrices',
- *   '0x1',
- * );
- * // ... Do something with the gas prices ...
- * ```
- */
-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.queryClientConfig - Configuration for the underlying TanStack
-     * Query client.
-     * @param args.policyOptions - Options to pass to `createServicePolicy`, which
-     * is used to wrap each request. See {@link CreateServicePolicyOptions}.
-     */
-    constructor({ messenger, queryClientConfig, policyOptions, }: {
-        messenger: SampleGasPricesServiceMessenger;
-        queryClientConfig?: QueryClientConfig;
-        policyOptions?: CreateServicePolicyOptions;
-    });
-    /**
-     * Makes a request to the API in order to retrieve gas prices for a particular
-     * chain.
-     *
-     * @param chainId - The chain ID for which you want to fetch gas prices.
-     * @returns The gas prices for the given chain.
-     */
-    fetchGasPrices(chainId: Hex): Promise<GasPricesResponse['data']>;
-}
-export {};
-//# sourceMappingURL=sample-gas-prices-service.d.cts.map

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

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

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

@@ -1 +0,0 @@
-{"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.js';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link SampleGasPricesService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'SampleGasPricesService';\n\n// === MESSENGER ===\n\n/**\n * All of the methods within {@link SampleGasPricesService} that are exposed via\n * the messenger.\n */\nconst MESSENGER_EXPOSED_METHODS = ['fetchGasPrices'] as const;\n\n/**\n * Invalidates cached queries for {@link SampleGasPricesService}.\n */\nexport type SampleGasPricesServiceInvalidateQueriesAction =\n  DataServiceInvalidateQueriesAction<typeof serviceName>;\n\n/**\n * Actions that {@link SampleGasPricesService} exposes to other consumers.\n */\nexport type SampleGasPricesServiceActions =\n  | SampleGasPricesServiceMethodActions\n  | SampleGasPricesServiceInvalidateQueriesAction;\n\n/**\n * Actions from other messengers that {@link SampleGasPricesService} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Published when {@link SampleGasPricesService}'s cache is updated.\n */\nexport type SampleGasPricesServiceCacheUpdatedEvent =\n  DataServiceCacheUpdatedEvent<typeof serviceName>;\n\n/**\n * Published when a key within {@link SampleGasPricesService}'s cache is\n * updated.\n */\nexport type SampleGasPricesServiceGranularCacheUpdatedEvent =\n  DataServiceGranularCacheUpdatedEvent<typeof serviceName>;\n\n/**\n * Events that {@link SampleGasPricesService} exposes to other consumers.\n */\nexport type SampleGasPricesServiceEvents =\n  | SampleGasPricesServiceCacheUpdatedEvent\n  | SampleGasPricesServiceGranularCacheUpdatedEvent;\n\n/**\n * Events from other messengers that {@link SampleGasPricesService} subscribes\n * to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link SampleGasPricesService}.\n */\nexport type SampleGasPricesServiceMessenger = Messenger<\n  typeof serviceName,\n  SampleGasPricesServiceActions | AllowedActions,\n  SampleGasPricesServiceEvents | AllowedEvents\n>;\n\n// === SERVICE DEFINITION ===\n\n/**\n * Struct to validate what the API endpoint returns.\n */\nconst GasPricesResponseStruct = type({\n  data: type({\n    low: number(),\n    average: number(),\n    high: number(),\n  }),\n});\n\n/**\n * What the API endpoint returns.\n */\ntype GasPricesResponse = Infer<typeof GasPricesResponseStruct>;\n\n/**\n * The base URL of the API that the service represents.\n */\nconst BASE_URL = 'https://api.example.com';\n\n/**\n * This service object is responsible for fetching gas prices via an API.\n *\n * @example\n *\n * ``` ts\n * import type { MessengerActions, MessengerEvents } from '@metamask/messenger';\n * import { Messenger } from '@metamask/messenger';\n * import type {\n *   SampleGasPricesServiceMessenger,\n * } from '@metamask/sample-controllers';\n *\n * const rootMessenger = new Messenger<\n *   'Root',\n *   SampleGasPricesServiceActions\n *   SampleGasPricesServiceEvents\n * >({ namespace: 'Root' });\n * const gasPricesServiceMessenger = new Messenger<\n *   'SampleGasPricesService',\n *   MessengerActions<SampleGasPricesServiceMessenger>,\n *   MessengerEvents<SampleGasPricesServiceMessenger>,\n *   typeof rootMessenger,\n * >({\n *   namespace: 'SampleGasPricesService',\n *   parent: rootMessenger,\n * });\n * // Instantiate the service to register its actions on the messenger\n * new SampleGasPricesService({\n *   messenger: gasPricesServiceMessenger,\n * });\n *\n * // Later...\n * // Fetch gas prices for Mainnet\n * const gasPrices = await rootMessenger.call(\n *   'SampleGasPricesService:fetchGasPrices',\n *   '0x1',\n * );\n * // ... Do something with the gas prices ...\n * ```\n */\nexport class SampleGasPricesService extends BaseDataService<\n  typeof serviceName,\n  SampleGasPricesServiceMessenger\n> {\n  /**\n   * Constructs a new SampleGasPricesService object.\n   *\n   * @param args - The constructor arguments.\n   * @param args.messenger - The messenger suited for this service.\n   * @param args.queryClientConfig - Configuration for the underlying TanStack\n   * Query client.\n   * @param args.policyOptions - Options to pass to `createServicePolicy`, which\n   * is used to wrap each request. See {@link CreateServicePolicyOptions}.\n   */\n  constructor({\n    messenger,\n    queryClientConfig = {},\n    policyOptions = {},\n  }: {\n    messenger: SampleGasPricesServiceMessenger;\n    queryClientConfig?: QueryClientConfig;\n    policyOptions?: CreateServicePolicyOptions;\n  }) {\n    super({\n      name: serviceName,\n      messenger,\n      queryClientConfig,\n      policyOptions,\n    });\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Makes a request to the API in order to retrieve gas prices for a particular\n   * chain.\n   *\n   * @param chainId - The chain ID for which you want to fetch gas prices.\n   * @returns The gas prices for the given chain.\n   */\n  async fetchGasPrices(chainId: Hex): Promise<GasPricesResponse['data']> {\n    const url = new URL('/gas-prices', BASE_URL);\n    url.searchParams.append('chainId', `eip155:${fromHex(chainId).toString()}`);\n\n    const jsonResponse = await this.fetchQuery({\n      queryKey: [`${this.name}:fetchGasPrices`, chainId],\n      queryFn: async () => {\n        const response = await fetch(url);\n\n        if (!response.ok) {\n          throw new HttpError(\n            response.status,\n            `Gas prices API failed with status '${response.status}'`,\n          );\n        }\n\n        return response.json();\n      },\n    });\n\n    if (!is(jsonResponse, GasPricesResponseStruct)) {\n      throw new Error('Malformed response received from gas prices API');\n    }\n\n    return jsonResponse.data;\n  }\n}\n"]}

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

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

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

@@ -1 +0,0 @@
-{"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.\n * Do not edit manually.\n */\n\nimport type { SamplePetnamesController } from './sample-petnames-controller.js';\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.map

@@ -1 +0,0 @@
-{"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,yCAAwC;AAEhF;;;;;;;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

@@ -1,22 +0,0 @@
-/**
- * This file is auto generated.
- * 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

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

@@ -1 +0,0 @@
-{"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.\n * Do not edit manually.\n */\n\nimport type { SamplePetnamesController } from './sample-petnames-controller.js';\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,130 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SamplePetnamesController = exports.getDefaultPetnamesControllerState = void 0;
-const base_controller_1 = require("@metamask/base-controller");
-const controller_utils_1 = require("@metamask/controller-utils");
-// === GENERAL ===
-/**
- * The name of the {@link SamplePetnamesController}, used to namespace the
- * controller's actions and events and to namespace the controller's state data
- * when composed with other controllers.
- */
-const CONTROLLER_NAME = 'SamplePetnamesController';
-/**
- * The metadata for each property in {@link SamplePetnamesControllerState}.
- */
-const samplePetnamesControllerMetadata = {
-    namesByChainIdAndAddress: {
-        includeInDebugSnapshot: false,
-        includeInStateLogs: true,
-        persist: true,
-        usedInUi: true,
-    },
-};
-/**
- * Constructs the default {@link SamplePetnamesController} state. This allows
- * consumers to provide a partial state object when initializing the controller
- * and also helps in constructing complete state objects for this controller in
- * tests.
- *
- * @returns The default {@link SamplePetnamesController} state.
- */
-function getDefaultPetnamesControllerState() {
-    return {
-        namesByChainIdAndAddress: {},
-    };
-}
-exports.getDefaultPetnamesControllerState = getDefaultPetnamesControllerState;
-// === MESSENGER ===
-const MESSENGER_EXPOSED_METHODS = ['assignPetname'];
-// === CONTROLLER DEFINITION ===
-/**
- * `SamplePetnamesController` records user-provided nicknames for various
- * addresses on various chains.
- *
- * @example
- *
- * ``` ts
- * import { Messenger } from '@metamask/messenger';
- * import type {
- *   SamplePetnamesControllerActions,
- *   SamplePetnamesControllerEvents,
- * } from '@metamask/sample-controllers';
- *
- * const rootMessenger = new Messenger<
- *  'Root',
- *  SamplePetnamesControllerActions,
- *  SamplePetnamesControllerEvents
- * >({ namespace: 'Root' });
- * const samplePetnamesMessenger = new Messenger<
- *  'SamplePetnamesController',
- *  SamplePetnamesControllerActions,
- *  SamplePetnamesControllerEvents,
- *  typeof rootMessenger,
- * >({
- *  namespace: 'SamplePetnamesController',
- *  parent: rootMessenger,
- * });
- * // Instantiate the controller to register its actions on the messenger
- * new SamplePetnamesController({
- *   messenger: samplePetnamesMessenger,
- * });
- *
- * rootMessenger.call(
- *   'SamplePetnamesController:assignPetname',
- *   [
- *     '0x1',
- *     '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99',
- *     'Primary Account',
- *   ],
- * );
- * const samplePetnamesControllerState = await rootMessenger.call(
- *   'SamplePetnamesController:getState',
- * );
- * samplePetnamesControllerState.namesByChainIdAndAddress
- * // => { '0x1': { '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99': 'Primary Account' } }
- * ```
- */
-class SamplePetnamesController extends base_controller_1.BaseController {
-    /**
-     * Constructs a new {@link SamplePetnamesController}.
-     *
-     * @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.
-     */
-    constructor({ messenger, state, }) {
-        super({
-            messenger,
-            metadata: samplePetnamesControllerMetadata,
-            name: CONTROLLER_NAME,
-            state: {
-                ...getDefaultPetnamesControllerState(),
-                ...state,
-            },
-        });
-        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
-    }
-    /**
-     * 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.
-     */
-    assignPetname(chainId, address, name) {
-        if (!(0, controller_utils_1.isSafeDynamicKey)(chainId)) {
-            throw new Error('Invalid chain ID');
-        }
-        const normalizedAddress = address.toLowerCase();
-        this.update((state) => {
-            var _a;
-            (_a = state.namesByChainIdAndAddress)[chainId] ?? (_a[chainId] = {});
-            state.namesByChainIdAndAddress[chainId][normalizedAddress] = name;
-        });
-    }
-}
-exports.SamplePetnamesController = SamplePetnamesController;
-//# sourceMappingURL=sample-petnames-controller.cjs.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"sample-petnames-controller.cjs","sourceRoot":"","sources":["../src/sample-petnames-controller.ts"],"names":[],"mappings":";;;AAKA,+DAA2D;AAC3D,iEAA8D;AAM9D,kBAAkB;AAElB;;;;GAIG;AACH,MAAM,eAAe,GAAG,0BAA0B,CAAC;AAmBnD;;GAEG;AACH,MAAM,gCAAgC,GAAG;IACvC,wBAAwB,EAAE;QACxB,sBAAsB,EAAE,KAAK;QAC7B,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,IAAI;KACf;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;AAqD7D,gCAAgC;AAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;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,eAAe;YACrB,KAAK,EAAE;gBACL,GAAG,iCAAiC,EAAE;gBACtC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,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,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;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  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport { isSafeDynamicKey } from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport type { Hex } from '@metamask/utils';\n\nimport type { SamplePetnamesControllerMethodActions } from './sample-petnames-controller-method-action-types.js';\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 */\nconst CONTROLLER_NAME = '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    includeInDebugSnapshot: false,\n    includeInStateLogs: true,\n    persist: true,\n    usedInUi: true,\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 CONTROLLER_NAME,\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 CONTROLLER_NAME,\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 = Messenger<\n  typeof CONTROLLER_NAME,\n  SamplePetnamesControllerActions | AllowedActions,\n  SamplePetnamesControllerEvents | AllowedEvents\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/messenger';\n * import type {\n *   SamplePetnamesControllerActions,\n *   SamplePetnamesControllerEvents,\n * } from '@metamask/sample-controllers';\n *\n * const rootMessenger = new Messenger<\n *  'Root',\n *  SamplePetnamesControllerActions,\n *  SamplePetnamesControllerEvents\n * >({ namespace: 'Root' });\n * const samplePetnamesMessenger = new Messenger<\n *  'SamplePetnamesController',\n *  SamplePetnamesControllerActions,\n *  SamplePetnamesControllerEvents,\n *  typeof rootMessenger,\n * >({\n *  namespace: 'SamplePetnamesController',\n *  parent: rootMessenger,\n * });\n * // Instantiate the controller to register its actions on the messenger\n * new SamplePetnamesController({\n *   messenger: samplePetnamesMessenger,\n * });\n *\n * rootMessenger.call(\n *   'SamplePetnamesController:assignPetname',\n *   [\n *     '0x1',\n *     '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99',\n *     'Primary Account',\n *   ],\n * );\n * const samplePetnamesControllerState = await rootMessenger.call(\n *   'SamplePetnamesController:getState',\n * );\n * samplePetnamesControllerState.namesByChainIdAndAddress\n * // => { '0x1': { '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99': 'Primary Account' } }\n * ```\n */\nexport class SamplePetnamesController extends BaseController<\n  typeof CONTROLLER_NAME,\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: CONTROLLER_NAME,\n      state: {\n        ...getDefaultPetnamesControllerState(),\n        ...state,\n      },\n    });\n\n    this.messenger.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): void {\n    if (!isSafeDynamicKey(chainId)) {\n      throw new Error('Invalid chain ID');\n    }\n\n    const normalizedAddress = address.toLowerCase() as Hex;\n\n    this.update((state) => {\n      state.namesByChainIdAndAddress[chainId] ??= {};\n      state.namesByChainIdAndAddress[chainId][normalizedAddress] = name;\n    });\n  }\n}\n"]}

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

@@ -1,136 +0,0 @@
-import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
-import { BaseController } from "@metamask/base-controller";
-import type { Messenger } from "@metamask/messenger";
-import type { Hex } from "@metamask/utils";
-import type { SamplePetnamesControllerMethodActions } from "./sample-petnames-controller-method-action-types.cjs";
-/**
- * The name of the {@link SamplePetnamesController}, used to namespace the
- * controller's actions and events and to namespace the controller's state data
- * when composed with other controllers.
- */
-declare const CONTROLLER_NAME = "SamplePetnamesController";
-/**
- * Describes the shape of the state object for {@link SamplePetnamesController}.
- */
-export type SamplePetnamesControllerState = {
-    /**
-     * The registry of pet names, categorized by chain ID first and address
-     * second.
-     */
-    namesByChainIdAndAddress: {
-        [chainId: Hex]: {
-            [address: Hex]: string;
-        };
-    };
-};
-/**
- * Constructs the default {@link SamplePetnamesController} state. This allows
- * consumers to provide a partial state object when initializing the controller
- * and also helps in constructing complete state objects for this controller in
- * tests.
- *
- * @returns The default {@link SamplePetnamesController} state.
- */
-export declare function getDefaultPetnamesControllerState(): SamplePetnamesControllerState;
-/**
- * Retrieves the state of the {@link SamplePetnamesController}.
- */
-export type SamplePetnamesControllerGetStateAction = ControllerGetStateAction<typeof CONTROLLER_NAME, SamplePetnamesControllerState>;
-/**
- * Actions that {@link SampleGasPricesMessenger} exposes to other consumers.
- */
-export type SamplePetnamesControllerActions = SamplePetnamesControllerGetStateAction | SamplePetnamesControllerMethodActions;
-/**
- * Actions from other messengers that {@link SampleGasPricesMessenger} calls.
- */
-type AllowedActions = never;
-/**
- * Published when the state of {@link SamplePetnamesController} changes.
- */
-export type SamplePetnamesControllerStateChangeEvent = ControllerStateChangeEvent<typeof CONTROLLER_NAME, SamplePetnamesControllerState>;
-/**
- * Events that {@link SampleGasPricesMessenger} exposes to other consumers.
- */
-export type SamplePetnamesControllerEvents = SamplePetnamesControllerStateChangeEvent;
-/**
- * Events from other messengers that {@link SampleGasPricesMessenger} subscribes
- * to.
- */
-type AllowedEvents = never;
-/**
- * The messenger restricted to actions and events accessed by
- * {@link SamplePetnamesController}.
- */
-export type SamplePetnamesControllerMessenger = Messenger<typeof CONTROLLER_NAME, SamplePetnamesControllerActions | AllowedActions, SamplePetnamesControllerEvents | AllowedEvents>;
-/**
- * `SamplePetnamesController` records user-provided nicknames for various
- * addresses on various chains.
- *
- * @example
- *
- * ``` ts
- * import { Messenger } from '@metamask/messenger';
- * import type {
- *   SamplePetnamesControllerActions,
- *   SamplePetnamesControllerEvents,
- * } from '@metamask/sample-controllers';
- *
- * const rootMessenger = new Messenger<
- *  'Root',
- *  SamplePetnamesControllerActions,
- *  SamplePetnamesControllerEvents
- * >({ namespace: 'Root' });
- * const samplePetnamesMessenger = new Messenger<
- *  'SamplePetnamesController',
- *  SamplePetnamesControllerActions,
- *  SamplePetnamesControllerEvents,
- *  typeof rootMessenger,
- * >({
- *  namespace: 'SamplePetnamesController',
- *  parent: rootMessenger,
- * });
- * // Instantiate the controller to register its actions on the messenger
- * new SamplePetnamesController({
- *   messenger: samplePetnamesMessenger,
- * });
- *
- * rootMessenger.call(
- *   'SamplePetnamesController:assignPetname',
- *   [
- *     '0x1',
- *     '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99',
- *     'Primary Account',
- *   ],
- * );
- * const samplePetnamesControllerState = await rootMessenger.call(
- *   'SamplePetnamesController:getState',
- * );
- * samplePetnamesControllerState.namesByChainIdAndAddress
- * // => { '0x1': { '0xF57F855e17483B1f09bFec62783C9d3b6c8b3A99': 'Primary Account' } }
- * ```
- */
-export declare class SamplePetnamesController extends BaseController<typeof CONTROLLER_NAME, SamplePetnamesControllerState, SamplePetnamesControllerMessenger> {
-    /**
-     * Constructs a new {@link SamplePetnamesController}.
-     *
-     * @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.
-     */
-    constructor({ messenger, state, }: {
-        messenger: SamplePetnamesControllerMessenger;
-        state?: Partial<SamplePetnamesControllerState>;
-    });
-    /**
-     * 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.
-     */
-    assignPetname(chainId: Hex, address: Hex, name: string): void;
-}
-export {};
-//# sourceMappingURL=sample-petnames-controller.d.cts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"sample-petnames-controller.d.cts","sourceRoot":"","sources":["../src/sample-petnames-controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,OAAO,KAAK,EAAE,qCAAqC,EAAE,6DAA4D;AAIjH;;;;GAIG;AACH,QAAA,MAAM,eAAe,6BAA6B,CAAC;AAInD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;OAGG;IACH,wBAAwB,EAAE;QACxB,CAAC,OAAO,EAAE,GAAG,GAAG;YACd,CAAC,OAAO,EAAE,GAAG,GAAG,MAAM,CAAC;SACxB,CAAC;KACH,CAAC;CACH,CAAC;AAcF;;;;;;;GAOG;AACH,wBAAgB,iCAAiC,IAAI,6BAA6B,CAIjF;AAMD;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,eAAe,EACtB,6BAA6B,CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,sCAAsC,GACtC,qCAAqC,CAAC;AAE1C;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAClD,0BAA0B,CACxB,OAAO,eAAe,EACtB,6BAA6B,CAC9B,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,wCAAwC,CAAC;AAE3C;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,eAAe,EACtB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;AAIF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,qBAAa,wBAAyB,SAAQ,cAAc,CAC1D,OAAO,eAAe,EACtB,6BAA6B,EAC7B,iCAAiC,CAClC;IACC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,iCAAiC,CAAC;QAC7C,KAAK,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC;KAChD;IAiBD;;;;;;;OAOG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;CAY9D"}