@metamask-previews/assets-controller 0.0.0-preview-f5ec6061

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Initial release ([#7587](https://github.com/MetaMask/core/pull/7587))
+
+[Unreleased]: https://github.com/MetaMask/core/

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2026 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/assets-controller`
+
+Tracks assets balances/prices and handles token detection across all digital assets.
+
+## Installation
+
+`yarn add @metamask/assets-controller`
+
+or
+
+`npm install @metamask/assets-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/AssetsController.cjs

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssetsController = exports.getDefaultAssetsControllerState = exports.controllerName = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+/**
+ * The name of the {@link AssetsController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+exports.controllerName = 'AssetsController';
+/**
+ * The metadata for each property in {@link AssetsControllerState}.
+ */
+const assetsControllerMetadata = {};
+/**
+ * Constructs the default {@link AssetsController} 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 AssetsController} state.
+ */
+function getDefaultAssetsControllerState() {
+    return {};
+}
+exports.getDefaultAssetsControllerState = getDefaultAssetsControllerState;
+/**
+ * `AssetsController` manages asset tracking for accounts.
+ *
+ * This controller is a placeholder for future consolidation of asset tracking
+ * functionality including account balances, token balances, and asset detection.
+ *
+ * @example
+ *
+ * ``` ts
+ * import { Messenger } from '@metamask/messenger';
+ * import type {
+ *   AssetsControllerActions,
+ *   AssetsControllerEvents,
+ * } from '@metamask/assets-controller';
+ * import { AssetsController } from '@metamask/assets-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   AssetsControllerActions,
+ *   AssetsControllerEvents
+ * >({ namespace: 'Root' });
+ * const assetsControllerMessenger = new Messenger<
+ *   'AssetsController',
+ *   AssetsControllerActions,
+ *   AssetsControllerEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'AssetsController',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the controller to register its actions on the messenger
+ * new AssetsController({
+ *   messenger: assetsControllerMessenger,
+ * });
+ *
+ * const assetsControllerState = await rootMessenger.call(
+ *   'AssetsController:getState',
+ * );
+ * ```
+ */
+class AssetsController extends base_controller_1.BaseController {
+    /**
+     * Constructs a new {@link AssetsController}.
+     *
+     * @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: assetsControllerMetadata,
+            name: exports.controllerName,
+            state: {
+                ...getDefaultAssetsControllerState(),
+                ...state,
+            },
+        });
+    }
+}
+exports.AssetsController = AssetsController;
+//# sourceMappingURL=AssetsController.cjs.map

package/dist/AssetsController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetsController.cjs","sourceRoot":"","sources":["../src/AssetsController.ts"],"names":[],"mappings":";;;AAKA,+DAA2D;AAG3D;;;;GAIG;AACU,QAAA,cAAc,GAAG,kBAAkB,CAAC;AAgBjD;;GAEG;AACH,MAAM,wBAAwB,GAC5B,EAAiD,CAAC;AAEpD;;;;;;;GAOG;AACH,SAAgB,+BAA+B;IAC7C,OAAO,EAAE,CAAC;AACZ,CAAC;AAFD,0EAEC;AAiDD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAa,gBAAiB,SAAQ,gCAIrC;IACC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,wBAAwB;YAClC,IAAI,EAAE,sBAAc;YACpB,KAAK,EAAE;gBACL,GAAG,+BAA+B,EAAE;gBACpC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;IACL,CAAC;CACF;AA9BD,4CA8BC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\n\n/**\n * The name of the {@link AssetsController}, 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 = 'AssetsController';\n\n// TODO: Implement AssetsController - the goal is to split and consolidate the old one\n// This controller will consolidate asset tracking functionality including:\n// - Account balance tracking\n// - Token balance tracking\n// - Asset detection\n\n/**\n * Describes the shape of the state object for {@link AssetsController}.\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type\nexport type AssetsControllerState = {\n  // Empty state - to be implemented\n};\n\n/**\n * The metadata for each property in {@link AssetsControllerState}.\n */\nconst assetsControllerMetadata =\n  {} satisfies StateMetadata<AssetsControllerState>;\n\n/**\n * Constructs the default {@link AssetsController} 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 AssetsController} state.\n */\nexport function getDefaultAssetsControllerState(): AssetsControllerState {\n  return {};\n}\n\n/**\n * Retrieves the state of the {@link AssetsController}.\n */\nexport type AssetsControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  AssetsControllerState\n>;\n\n/**\n * Actions that {@link AssetsControllerMessenger} exposes to other consumers.\n */\nexport type AssetsControllerActions = AssetsControllerGetStateAction;\n\n/**\n * Actions from other messengers that {@link AssetsControllerMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Published when the state of {@link AssetsController} changes.\n */\nexport type AssetsControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  AssetsControllerState\n>;\n\n/**\n * Events that {@link AssetsControllerMessenger} exposes to other consumers.\n */\nexport type AssetsControllerEvents = AssetsControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link AssetsControllerMessenger} subscribes\n * to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link AssetsController}.\n */\nexport type AssetsControllerMessenger = Messenger<\n  typeof controllerName,\n  AssetsControllerActions | AllowedActions,\n  AssetsControllerEvents | AllowedEvents\n>;\n\n/**\n * `AssetsController` manages asset tracking for accounts.\n *\n * This controller is a placeholder for future consolidation of asset tracking\n * functionality including account balances, token balances, and asset detection.\n *\n * @example\n *\n * ``` ts\n * import { Messenger } from '@metamask/messenger';\n * import type {\n *   AssetsControllerActions,\n *   AssetsControllerEvents,\n * } from '@metamask/assets-controller';\n * import { AssetsController } from '@metamask/assets-controller';\n *\n * const rootMessenger = new Messenger<\n *   'Root',\n *   AssetsControllerActions,\n *   AssetsControllerEvents\n * >({ namespace: 'Root' });\n * const assetsControllerMessenger = new Messenger<\n *   'AssetsController',\n *   AssetsControllerActions,\n *   AssetsControllerEvents,\n *   typeof rootMessenger,\n * >({\n *   namespace: 'AssetsController',\n *   parent: rootMessenger,\n * });\n * // Instantiate the controller to register its actions on the messenger\n * new AssetsController({\n *   messenger: assetsControllerMessenger,\n * });\n *\n * const assetsControllerState = await rootMessenger.call(\n *   'AssetsController:getState',\n * );\n * ```\n */\nexport class AssetsController extends BaseController<\n  typeof controllerName,\n  AssetsControllerState,\n  AssetsControllerMessenger\n> {\n  /**\n   * Constructs a new {@link AssetsController}.\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: AssetsControllerMessenger;\n    state?: Partial<AssetsControllerState>;\n  }) {\n    super({\n      messenger,\n      metadata: assetsControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultAssetsControllerState(),\n        ...state,\n      },\n    });\n  }\n}\n"]}

package/dist/AssetsController.d.cts

@@ -0,0 +1,108 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { Messenger } from "@metamask/messenger";
+/**
+ * The name of the {@link AssetsController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+export declare const controllerName = "AssetsController";
+/**
+ * Describes the shape of the state object for {@link AssetsController}.
+ */
+export type AssetsControllerState = {};
+/**
+ * Constructs the default {@link AssetsController} 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 AssetsController} state.
+ */
+export declare function getDefaultAssetsControllerState(): AssetsControllerState;
+/**
+ * Retrieves the state of the {@link AssetsController}.
+ */
+export type AssetsControllerGetStateAction = ControllerGetStateAction<typeof controllerName, AssetsControllerState>;
+/**
+ * Actions that {@link AssetsControllerMessenger} exposes to other consumers.
+ */
+export type AssetsControllerActions = AssetsControllerGetStateAction;
+/**
+ * Actions from other messengers that {@link AssetsControllerMessenger} calls.
+ */
+type AllowedActions = never;
+/**
+ * Published when the state of {@link AssetsController} changes.
+ */
+export type AssetsControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, AssetsControllerState>;
+/**
+ * Events that {@link AssetsControllerMessenger} exposes to other consumers.
+ */
+export type AssetsControllerEvents = AssetsControllerStateChangeEvent;
+/**
+ * Events from other messengers that {@link AssetsControllerMessenger} subscribes
+ * to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link AssetsController}.
+ */
+export type AssetsControllerMessenger = Messenger<typeof controllerName, AssetsControllerActions | AllowedActions, AssetsControllerEvents | AllowedEvents>;
+/**
+ * `AssetsController` manages asset tracking for accounts.
+ *
+ * This controller is a placeholder for future consolidation of asset tracking
+ * functionality including account balances, token balances, and asset detection.
+ *
+ * @example
+ *
+ * ``` ts
+ * import { Messenger } from '@metamask/messenger';
+ * import type {
+ *   AssetsControllerActions,
+ *   AssetsControllerEvents,
+ * } from '@metamask/assets-controller';
+ * import { AssetsController } from '@metamask/assets-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   AssetsControllerActions,
+ *   AssetsControllerEvents
+ * >({ namespace: 'Root' });
+ * const assetsControllerMessenger = new Messenger<
+ *   'AssetsController',
+ *   AssetsControllerActions,
+ *   AssetsControllerEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'AssetsController',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the controller to register its actions on the messenger
+ * new AssetsController({
+ *   messenger: assetsControllerMessenger,
+ * });
+ *
+ * const assetsControllerState = await rootMessenger.call(
+ *   'AssetsController:getState',
+ * );
+ * ```
+ */
+export declare class AssetsController extends BaseController<typeof controllerName, AssetsControllerState, AssetsControllerMessenger> {
+    /**
+     * Constructs a new {@link AssetsController}.
+     *
+     * @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: AssetsControllerMessenger;
+        state?: Partial<AssetsControllerState>;
+    });
+}
+export {};
+//# sourceMappingURL=AssetsController.d.cts.map

package/dist/AssetsController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetsController.d.cts","sourceRoot":"","sources":["../src/AssetsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD;;;;GAIG;AACH,eAAO,MAAM,cAAc,qBAAqB,CAAC;AAQjD;;GAEG;AAEH,MAAM,MAAM,qBAAqB,GAAG,EAEnC,CAAC;AAQF;;;;;;;GAOG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAEvE;AAED;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,wBAAwB,CACnE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,8BAA8B,CAAC;AAErE;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,gCAAgC,CAAC;AAEtE;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,SAAS,CAC/C,OAAO,cAAc,EACrB,uBAAuB,GAAG,cAAc,EACxC,sBAAsB,GAAG,aAAa,CACvC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,cAAc,EACrB,qBAAqB,EACrB,yBAAyB,CAC1B;IACC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,yBAAyB,CAAC;QACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;KACxC;CAWF"}

package/dist/AssetsController.d.mts

@@ -0,0 +1,108 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { Messenger } from "@metamask/messenger";
+/**
+ * The name of the {@link AssetsController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+export declare const controllerName = "AssetsController";
+/**
+ * Describes the shape of the state object for {@link AssetsController}.
+ */
+export type AssetsControllerState = {};
+/**
+ * Constructs the default {@link AssetsController} 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 AssetsController} state.
+ */
+export declare function getDefaultAssetsControllerState(): AssetsControllerState;
+/**
+ * Retrieves the state of the {@link AssetsController}.
+ */
+export type AssetsControllerGetStateAction = ControllerGetStateAction<typeof controllerName, AssetsControllerState>;
+/**
+ * Actions that {@link AssetsControllerMessenger} exposes to other consumers.
+ */
+export type AssetsControllerActions = AssetsControllerGetStateAction;
+/**
+ * Actions from other messengers that {@link AssetsControllerMessenger} calls.
+ */
+type AllowedActions = never;
+/**
+ * Published when the state of {@link AssetsController} changes.
+ */
+export type AssetsControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, AssetsControllerState>;
+/**
+ * Events that {@link AssetsControllerMessenger} exposes to other consumers.
+ */
+export type AssetsControllerEvents = AssetsControllerStateChangeEvent;
+/**
+ * Events from other messengers that {@link AssetsControllerMessenger} subscribes
+ * to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link AssetsController}.
+ */
+export type AssetsControllerMessenger = Messenger<typeof controllerName, AssetsControllerActions | AllowedActions, AssetsControllerEvents | AllowedEvents>;
+/**
+ * `AssetsController` manages asset tracking for accounts.
+ *
+ * This controller is a placeholder for future consolidation of asset tracking
+ * functionality including account balances, token balances, and asset detection.
+ *
+ * @example
+ *
+ * ``` ts
+ * import { Messenger } from '@metamask/messenger';
+ * import type {
+ *   AssetsControllerActions,
+ *   AssetsControllerEvents,
+ * } from '@metamask/assets-controller';
+ * import { AssetsController } from '@metamask/assets-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   AssetsControllerActions,
+ *   AssetsControllerEvents
+ * >({ namespace: 'Root' });
+ * const assetsControllerMessenger = new Messenger<
+ *   'AssetsController',
+ *   AssetsControllerActions,
+ *   AssetsControllerEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'AssetsController',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the controller to register its actions on the messenger
+ * new AssetsController({
+ *   messenger: assetsControllerMessenger,
+ * });
+ *
+ * const assetsControllerState = await rootMessenger.call(
+ *   'AssetsController:getState',
+ * );
+ * ```
+ */
+export declare class AssetsController extends BaseController<typeof controllerName, AssetsControllerState, AssetsControllerMessenger> {
+    /**
+     * Constructs a new {@link AssetsController}.
+     *
+     * @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: AssetsControllerMessenger;
+        state?: Partial<AssetsControllerState>;
+    });
+}
+export {};
+//# sourceMappingURL=AssetsController.d.mts.map

package/dist/AssetsController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetsController.d.mts","sourceRoot":"","sources":["../src/AssetsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD;;;;GAIG;AACH,eAAO,MAAM,cAAc,qBAAqB,CAAC;AAQjD;;GAEG;AAEH,MAAM,MAAM,qBAAqB,GAAG,EAEnC,CAAC;AAQF;;;;;;;GAOG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAEvE;AAED;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,wBAAwB,CACnE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,8BAA8B,CAAC;AAErE;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,gCAAgC,CAAC;AAEtE;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,SAAS,CAC/C,OAAO,cAAc,EACrB,uBAAuB,GAAG,cAAc,EACxC,sBAAsB,GAAG,aAAa,CACvC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,cAAc,EACrB,qBAAqB,EACrB,yBAAyB,CAC1B;IACC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,yBAAyB,CAAC;QACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;KACxC;CAWF"}

package/dist/AssetsController.mjs

@@ -0,0 +1,84 @@
+import { BaseController } from "@metamask/base-controller";
+/**
+ * The name of the {@link AssetsController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+export const controllerName = 'AssetsController';
+/**
+ * The metadata for each property in {@link AssetsControllerState}.
+ */
+const assetsControllerMetadata = {};
+/**
+ * Constructs the default {@link AssetsController} 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 AssetsController} state.
+ */
+export function getDefaultAssetsControllerState() {
+    return {};
+}
+/**
+ * `AssetsController` manages asset tracking for accounts.
+ *
+ * This controller is a placeholder for future consolidation of asset tracking
+ * functionality including account balances, token balances, and asset detection.
+ *
+ * @example
+ *
+ * ``` ts
+ * import { Messenger } from '@metamask/messenger';
+ * import type {
+ *   AssetsControllerActions,
+ *   AssetsControllerEvents,
+ * } from '@metamask/assets-controller';
+ * import { AssetsController } from '@metamask/assets-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   AssetsControllerActions,
+ *   AssetsControllerEvents
+ * >({ namespace: 'Root' });
+ * const assetsControllerMessenger = new Messenger<
+ *   'AssetsController',
+ *   AssetsControllerActions,
+ *   AssetsControllerEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'AssetsController',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the controller to register its actions on the messenger
+ * new AssetsController({
+ *   messenger: assetsControllerMessenger,
+ * });
+ *
+ * const assetsControllerState = await rootMessenger.call(
+ *   'AssetsController:getState',
+ * );
+ * ```
+ */
+export class AssetsController extends BaseController {
+    /**
+     * Constructs a new {@link AssetsController}.
+     *
+     * @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: assetsControllerMetadata,
+            name: controllerName,
+            state: {
+                ...getDefaultAssetsControllerState(),
+                ...state,
+            },
+        });
+    }
+}
+//# sourceMappingURL=AssetsController.mjs.map

package/dist/AssetsController.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetsController.mjs","sourceRoot":"","sources":["../src/AssetsController.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAG3D;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,kBAAkB,CAAC;AAgBjD;;GAEG;AACH,MAAM,wBAAwB,GAC5B,EAAiD,CAAC;AAEpD;;;;;;;GAOG;AACH,MAAM,UAAU,+BAA+B;IAC7C,OAAO,EAAE,CAAC;AACZ,CAAC;AAiDD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,OAAO,gBAAiB,SAAQ,cAIrC;IACC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,wBAAwB;YAClC,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE;gBACL,GAAG,+BAA+B,EAAE;gBACpC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\n\n/**\n * The name of the {@link AssetsController}, 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 = 'AssetsController';\n\n// TODO: Implement AssetsController - the goal is to split and consolidate the old one\n// This controller will consolidate asset tracking functionality including:\n// - Account balance tracking\n// - Token balance tracking\n// - Asset detection\n\n/**\n * Describes the shape of the state object for {@link AssetsController}.\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type\nexport type AssetsControllerState = {\n  // Empty state - to be implemented\n};\n\n/**\n * The metadata for each property in {@link AssetsControllerState}.\n */\nconst assetsControllerMetadata =\n  {} satisfies StateMetadata<AssetsControllerState>;\n\n/**\n * Constructs the default {@link AssetsController} 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 AssetsController} state.\n */\nexport function getDefaultAssetsControllerState(): AssetsControllerState {\n  return {};\n}\n\n/**\n * Retrieves the state of the {@link AssetsController}.\n */\nexport type AssetsControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  AssetsControllerState\n>;\n\n/**\n * Actions that {@link AssetsControllerMessenger} exposes to other consumers.\n */\nexport type AssetsControllerActions = AssetsControllerGetStateAction;\n\n/**\n * Actions from other messengers that {@link AssetsControllerMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Published when the state of {@link AssetsController} changes.\n */\nexport type AssetsControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  AssetsControllerState\n>;\n\n/**\n * Events that {@link AssetsControllerMessenger} exposes to other consumers.\n */\nexport type AssetsControllerEvents = AssetsControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link AssetsControllerMessenger} subscribes\n * to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link AssetsController}.\n */\nexport type AssetsControllerMessenger = Messenger<\n  typeof controllerName,\n  AssetsControllerActions | AllowedActions,\n  AssetsControllerEvents | AllowedEvents\n>;\n\n/**\n * `AssetsController` manages asset tracking for accounts.\n *\n * This controller is a placeholder for future consolidation of asset tracking\n * functionality including account balances, token balances, and asset detection.\n *\n * @example\n *\n * ``` ts\n * import { Messenger } from '@metamask/messenger';\n * import type {\n *   AssetsControllerActions,\n *   AssetsControllerEvents,\n * } from '@metamask/assets-controller';\n * import { AssetsController } from '@metamask/assets-controller';\n *\n * const rootMessenger = new Messenger<\n *   'Root',\n *   AssetsControllerActions,\n *   AssetsControllerEvents\n * >({ namespace: 'Root' });\n * const assetsControllerMessenger = new Messenger<\n *   'AssetsController',\n *   AssetsControllerActions,\n *   AssetsControllerEvents,\n *   typeof rootMessenger,\n * >({\n *   namespace: 'AssetsController',\n *   parent: rootMessenger,\n * });\n * // Instantiate the controller to register its actions on the messenger\n * new AssetsController({\n *   messenger: assetsControllerMessenger,\n * });\n *\n * const assetsControllerState = await rootMessenger.call(\n *   'AssetsController:getState',\n * );\n * ```\n */\nexport class AssetsController extends BaseController<\n  typeof controllerName,\n  AssetsControllerState,\n  AssetsControllerMessenger\n> {\n  /**\n   * Constructs a new {@link AssetsController}.\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: AssetsControllerMessenger;\n    state?: Partial<AssetsControllerState>;\n  }) {\n    super({\n      messenger,\n      metadata: assetsControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultAssetsControllerState(),\n        ...state,\n      },\n    });\n  }\n}\n"]}

package/dist/index.cjs

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultAssetsControllerState = exports.AssetsController = void 0;
+var AssetsController_1 = require("./AssetsController.cjs");
+Object.defineProperty(exports, "AssetsController", { enumerable: true, get: function () { return AssetsController_1.AssetsController; } });
+Object.defineProperty(exports, "getDefaultAssetsControllerState", { enumerable: true, get: function () { return AssetsController_1.getDefaultAssetsControllerState; } });
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAQA,2DAG4B;AAF1B,oHAAA,gBAAgB,OAAA;AAChB,mIAAA,+BAA+B,OAAA","sourcesContent":["export type {\n  AssetsControllerState,\n  AssetsControllerGetStateAction,\n  AssetsControllerActions,\n  AssetsControllerStateChangeEvent,\n  AssetsControllerEvents,\n  AssetsControllerMessenger,\n} from './AssetsController';\nexport {\n  AssetsController,\n  getDefaultAssetsControllerState,\n} from './AssetsController';\n"]}

package/dist/index.d.cts

@@ -0,0 +1,3 @@
+export type { AssetsControllerState, AssetsControllerGetStateAction, AssetsControllerActions, AssetsControllerStateChangeEvent, AssetsControllerEvents, AssetsControllerMessenger, } from "./AssetsController.cjs";
+export { AssetsController, getDefaultAssetsControllerState, } from "./AssetsController.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,qBAAqB,EACrB,8BAA8B,EAC9B,uBAAuB,EACvB,gCAAgC,EAChC,sBAAsB,EACtB,yBAAyB,GAC1B,+BAA2B;AAC5B,OAAO,EACL,gBAAgB,EAChB,+BAA+B,GAChC,+BAA2B"}

package/dist/index.d.mts

@@ -0,0 +1,3 @@
+export type { AssetsControllerState, AssetsControllerGetStateAction, AssetsControllerActions, AssetsControllerStateChangeEvent, AssetsControllerEvents, AssetsControllerMessenger, } from "./AssetsController.mjs";
+export { AssetsController, getDefaultAssetsControllerState, } from "./AssetsController.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,qBAAqB,EACrB,8BAA8B,EAC9B,uBAAuB,EACvB,gCAAgC,EAChC,sBAAsB,EACtB,yBAAyB,GAC1B,+BAA2B;AAC5B,OAAO,EACL,gBAAgB,EAChB,+BAA+B,GAChC,+BAA2B"}

package/dist/index.mjs

@@ -0,0 +1,2 @@
+export { AssetsController, getDefaultAssetsControllerState } from "./AssetsController.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,gBAAgB,EAChB,+BAA+B,EAChC,+BAA2B","sourcesContent":["export type {\n  AssetsControllerState,\n  AssetsControllerGetStateAction,\n  AssetsControllerActions,\n  AssetsControllerStateChangeEvent,\n  AssetsControllerEvents,\n  AssetsControllerMessenger,\n} from './AssetsController';\nexport {\n  AssetsController,\n  getDefaultAssetsControllerState,\n} from './AssetsController';\n"]}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@metamask-previews/assets-controller",
+  "version": "0.0.0-preview-f5ec6061",
+  "description": "Tracks assets balances/prices and handles token detection across all digital assets",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/assets-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/assets-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/assets-controller",
+    "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "dependencies": {
+    "@metamask/base-controller": "^9.0.0",
+    "@metamask/messenger": "^0.3.0"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.4",
+    "@ts-bridge/cli": "^0.6.4",
+    "@types/jest": "^27.4.1",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.3.3"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}