@metamask-previews/perps-controller 0.0.0-preview-903db2da

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 ([#7654](https://github.com/MetaMask/core/pull/7654))
+
+[Unreleased]: https://github.com/MetaMask/core/

package/LICENSE

@@ -0,0 +1,21 @@
+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
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+# `@metamask/perps-controller`
+
+Controller for perpetual trading functionality in MetaMask.
+
+## Installation
+
+`yarn add @metamask/perps-controller`
+
+or
+
+`npm install @metamask/perps-controller`
+
+## Usage
+
+```typescript
+import { PerpsController } from '@metamask/perps-controller';
+
+// Full usage documentation coming in future releases
+```
+
+## 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/PerpsController.cjs

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PerpsController = exports.getDefaultPerpsControllerState = exports.controllerName = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+/**
+ * The name of the {@link PerpsController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+exports.controllerName = 'PerpsController';
+/**
+ * The metadata for each property in {@link PerpsControllerState}.
+ */
+const perpsControllerMetadata = {};
+/**
+ * Constructs the default {@link PerpsController} 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 PerpsController} state.
+ */
+function getDefaultPerpsControllerState() {
+    return {};
+}
+exports.getDefaultPerpsControllerState = getDefaultPerpsControllerState;
+/**
+ * `PerpsController` manages perpetual trading functionality in MetaMask.
+ *
+ * This controller provides platform-agnostic perps trading capabilities.
+ *
+ * @example
+ *
+ * ``` ts
+ * import { Messenger } from '@metamask/messenger';
+ * import type {
+ *   PerpsControllerActions,
+ *   PerpsControllerEvents,
+ * } from '@metamask/perps-controller';
+ * import { PerpsController } from '@metamask/perps-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   PerpsControllerActions,
+ *   PerpsControllerEvents
+ * >({ namespace: 'Root' });
+ * const perpsControllerMessenger = new Messenger<
+ *   'PerpsController',
+ *   PerpsControllerActions,
+ *   PerpsControllerEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'PerpsController',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the controller to register its actions on the messenger
+ * new PerpsController({
+ *   messenger: perpsControllerMessenger,
+ * });
+ *
+ * const perpsControllerState = await rootMessenger.call(
+ *   'PerpsController:getState',
+ * );
+ * ```
+ */
+class PerpsController extends base_controller_1.BaseController {
+    /**
+     * Constructs a new {@link PerpsController}.
+     *
+     * @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: perpsControllerMetadata,
+            name: exports.controllerName,
+            state: {
+                ...getDefaultPerpsControllerState(),
+                ...state,
+            },
+        });
+    }
+}
+exports.PerpsController = PerpsController;
+//# sourceMappingURL=PerpsController.cjs.map

package/dist/PerpsController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"PerpsController.cjs","sourceRoot":"","sources":["../src/PerpsController.ts"],"names":[],"mappings":";;;AAKA,+DAA2D;AAG3D;;;;GAIG;AACU,QAAA,cAAc,GAAG,iBAAiB,CAAC;AAUhD;;GAEG;AACH,MAAM,uBAAuB,GAC3B,EAAgD,CAAC;AAEnD;;;;;;;GAOG;AACH,SAAgB,8BAA8B;IAC5C,OAAO,EAAE,CAAC;AACZ,CAAC;AAFD,wEAEC;AAiDD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAa,eAAgB,SAAQ,gCAIpC;IACC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,uBAAuB;YACjC,IAAI,EAAE,sBAAc;YACpB,KAAK,EAAE;gBACL,GAAG,8BAA8B,EAAE;gBACnC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;IACL,CAAC;CACF;AA9BD,0CA8BC","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 PerpsController}, 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 = 'PerpsController';\n\n/**\n * Describes the shape of the state object for {@link PerpsController}.\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type\nexport type PerpsControllerState = {\n  // Empty state - to be implemented in future PRs\n};\n\n/**\n * The metadata for each property in {@link PerpsControllerState}.\n */\nconst perpsControllerMetadata =\n  {} satisfies StateMetadata<PerpsControllerState>;\n\n/**\n * Constructs the default {@link PerpsController} 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 PerpsController} state.\n */\nexport function getDefaultPerpsControllerState(): PerpsControllerState {\n  return {};\n}\n\n/**\n * Retrieves the state of the {@link PerpsController}.\n */\nexport type PerpsControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  PerpsControllerState\n>;\n\n/**\n * Actions that {@link PerpsControllerMessenger} exposes to other consumers.\n */\nexport type PerpsControllerActions = PerpsControllerGetStateAction;\n\n/**\n * Actions from other messengers that {@link PerpsControllerMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Published when the state of {@link PerpsController} changes.\n */\nexport type PerpsControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  PerpsControllerState\n>;\n\n/**\n * Events that {@link PerpsControllerMessenger} exposes to other consumers.\n */\nexport type PerpsControllerEvents = PerpsControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link PerpsControllerMessenger} subscribes\n * to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link PerpsController}.\n */\nexport type PerpsControllerMessenger = Messenger<\n  typeof controllerName,\n  PerpsControllerActions | AllowedActions,\n  PerpsControllerEvents | AllowedEvents\n>;\n\n/**\n * `PerpsController` manages perpetual trading functionality in MetaMask.\n *\n * This controller provides platform-agnostic perps trading capabilities.\n *\n * @example\n *\n * ``` ts\n * import { Messenger } from '@metamask/messenger';\n * import type {\n *   PerpsControllerActions,\n *   PerpsControllerEvents,\n * } from '@metamask/perps-controller';\n * import { PerpsController } from '@metamask/perps-controller';\n *\n * const rootMessenger = new Messenger<\n *   'Root',\n *   PerpsControllerActions,\n *   PerpsControllerEvents\n * >({ namespace: 'Root' });\n * const perpsControllerMessenger = new Messenger<\n *   'PerpsController',\n *   PerpsControllerActions,\n *   PerpsControllerEvents,\n *   typeof rootMessenger,\n * >({\n *   namespace: 'PerpsController',\n *   parent: rootMessenger,\n * });\n * // Instantiate the controller to register its actions on the messenger\n * new PerpsController({\n *   messenger: perpsControllerMessenger,\n * });\n *\n * const perpsControllerState = await rootMessenger.call(\n *   'PerpsController:getState',\n * );\n * ```\n */\nexport class PerpsController extends BaseController<\n  typeof controllerName,\n  PerpsControllerState,\n  PerpsControllerMessenger\n> {\n  /**\n   * Constructs a new {@link PerpsController}.\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: PerpsControllerMessenger;\n    state?: Partial<PerpsControllerState>;\n  }) {\n    super({\n      messenger,\n      metadata: perpsControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultPerpsControllerState(),\n        ...state,\n      },\n    });\n  }\n}\n"]}

package/dist/PerpsController.d.cts

@@ -0,0 +1,107 @@
+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 PerpsController}, 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 = "PerpsController";
+/**
+ * Describes the shape of the state object for {@link PerpsController}.
+ */
+export type PerpsControllerState = {};
+/**
+ * Constructs the default {@link PerpsController} 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 PerpsController} state.
+ */
+export declare function getDefaultPerpsControllerState(): PerpsControllerState;
+/**
+ * Retrieves the state of the {@link PerpsController}.
+ */
+export type PerpsControllerGetStateAction = ControllerGetStateAction<typeof controllerName, PerpsControllerState>;
+/**
+ * Actions that {@link PerpsControllerMessenger} exposes to other consumers.
+ */
+export type PerpsControllerActions = PerpsControllerGetStateAction;
+/**
+ * Actions from other messengers that {@link PerpsControllerMessenger} calls.
+ */
+type AllowedActions = never;
+/**
+ * Published when the state of {@link PerpsController} changes.
+ */
+export type PerpsControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, PerpsControllerState>;
+/**
+ * Events that {@link PerpsControllerMessenger} exposes to other consumers.
+ */
+export type PerpsControllerEvents = PerpsControllerStateChangeEvent;
+/**
+ * Events from other messengers that {@link PerpsControllerMessenger} subscribes
+ * to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link PerpsController}.
+ */
+export type PerpsControllerMessenger = Messenger<typeof controllerName, PerpsControllerActions | AllowedActions, PerpsControllerEvents | AllowedEvents>;
+/**
+ * `PerpsController` manages perpetual trading functionality in MetaMask.
+ *
+ * This controller provides platform-agnostic perps trading capabilities.
+ *
+ * @example
+ *
+ * ``` ts
+ * import { Messenger } from '@metamask/messenger';
+ * import type {
+ *   PerpsControllerActions,
+ *   PerpsControllerEvents,
+ * } from '@metamask/perps-controller';
+ * import { PerpsController } from '@metamask/perps-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   PerpsControllerActions,
+ *   PerpsControllerEvents
+ * >({ namespace: 'Root' });
+ * const perpsControllerMessenger = new Messenger<
+ *   'PerpsController',
+ *   PerpsControllerActions,
+ *   PerpsControllerEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'PerpsController',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the controller to register its actions on the messenger
+ * new PerpsController({
+ *   messenger: perpsControllerMessenger,
+ * });
+ *
+ * const perpsControllerState = await rootMessenger.call(
+ *   'PerpsController:getState',
+ * );
+ * ```
+ */
+export declare class PerpsController extends BaseController<typeof controllerName, PerpsControllerState, PerpsControllerMessenger> {
+    /**
+     * Constructs a new {@link PerpsController}.
+     *
+     * @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: PerpsControllerMessenger;
+        state?: Partial<PerpsControllerState>;
+    });
+}
+export {};
+//# sourceMappingURL=PerpsController.d.cts.map

package/dist/PerpsController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PerpsController.d.cts","sourceRoot":"","sources":["../src/PerpsController.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,oBAAoB,CAAC;AAEhD;;GAEG;AAEH,MAAM,MAAM,oBAAoB,GAAG,EAElC,CAAC;AAQF;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,IAAI,oBAAoB,CAErE;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,wBAAwB,CAClE,OAAO,cAAc,EACrB,oBAAoB,CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,6BAA6B,CAAC;AAEnE;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG,0BAA0B,CACtE,OAAO,cAAc,EACrB,oBAAoB,CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,+BAA+B,CAAC;AAEpE;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,SAAS,CAC9C,OAAO,cAAc,EACrB,sBAAsB,GAAG,cAAc,EACvC,qBAAqB,GAAG,aAAa,CACtC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,qBAAa,eAAgB,SAAQ,cAAc,CACjD,OAAO,cAAc,EACrB,oBAAoB,EACpB,wBAAwB,CACzB;IACC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,wBAAwB,CAAC;QACpC,KAAK,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;KACvC;CAWF"}

package/dist/PerpsController.d.mts

@@ -0,0 +1,107 @@
+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 PerpsController}, 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 = "PerpsController";
+/**
+ * Describes the shape of the state object for {@link PerpsController}.
+ */
+export type PerpsControllerState = {};
+/**
+ * Constructs the default {@link PerpsController} 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 PerpsController} state.
+ */
+export declare function getDefaultPerpsControllerState(): PerpsControllerState;
+/**
+ * Retrieves the state of the {@link PerpsController}.
+ */
+export type PerpsControllerGetStateAction = ControllerGetStateAction<typeof controllerName, PerpsControllerState>;
+/**
+ * Actions that {@link PerpsControllerMessenger} exposes to other consumers.
+ */
+export type PerpsControllerActions = PerpsControllerGetStateAction;
+/**
+ * Actions from other messengers that {@link PerpsControllerMessenger} calls.
+ */
+type AllowedActions = never;
+/**
+ * Published when the state of {@link PerpsController} changes.
+ */
+export type PerpsControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, PerpsControllerState>;
+/**
+ * Events that {@link PerpsControllerMessenger} exposes to other consumers.
+ */
+export type PerpsControllerEvents = PerpsControllerStateChangeEvent;
+/**
+ * Events from other messengers that {@link PerpsControllerMessenger} subscribes
+ * to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link PerpsController}.
+ */
+export type PerpsControllerMessenger = Messenger<typeof controllerName, PerpsControllerActions | AllowedActions, PerpsControllerEvents | AllowedEvents>;
+/**
+ * `PerpsController` manages perpetual trading functionality in MetaMask.
+ *
+ * This controller provides platform-agnostic perps trading capabilities.
+ *
+ * @example
+ *
+ * ``` ts
+ * import { Messenger } from '@metamask/messenger';
+ * import type {
+ *   PerpsControllerActions,
+ *   PerpsControllerEvents,
+ * } from '@metamask/perps-controller';
+ * import { PerpsController } from '@metamask/perps-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   PerpsControllerActions,
+ *   PerpsControllerEvents
+ * >({ namespace: 'Root' });
+ * const perpsControllerMessenger = new Messenger<
+ *   'PerpsController',
+ *   PerpsControllerActions,
+ *   PerpsControllerEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'PerpsController',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the controller to register its actions on the messenger
+ * new PerpsController({
+ *   messenger: perpsControllerMessenger,
+ * });
+ *
+ * const perpsControllerState = await rootMessenger.call(
+ *   'PerpsController:getState',
+ * );
+ * ```
+ */
+export declare class PerpsController extends BaseController<typeof controllerName, PerpsControllerState, PerpsControllerMessenger> {
+    /**
+     * Constructs a new {@link PerpsController}.
+     *
+     * @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: PerpsControllerMessenger;
+        state?: Partial<PerpsControllerState>;
+    });
+}
+export {};
+//# sourceMappingURL=PerpsController.d.mts.map

package/dist/PerpsController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PerpsController.d.mts","sourceRoot":"","sources":["../src/PerpsController.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,oBAAoB,CAAC;AAEhD;;GAEG;AAEH,MAAM,MAAM,oBAAoB,GAAG,EAElC,CAAC;AAQF;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,IAAI,oBAAoB,CAErE;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,wBAAwB,CAClE,OAAO,cAAc,EACrB,oBAAoB,CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,6BAA6B,CAAC;AAEnE;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG,0BAA0B,CACtE,OAAO,cAAc,EACrB,oBAAoB,CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,+BAA+B,CAAC;AAEpE;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,SAAS,CAC9C,OAAO,cAAc,EACrB,sBAAsB,GAAG,cAAc,EACvC,qBAAqB,GAAG,aAAa,CACtC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,qBAAa,eAAgB,SAAQ,cAAc,CACjD,OAAO,cAAc,EACrB,oBAAoB,EACpB,wBAAwB,CACzB;IACC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,wBAAwB,CAAC;QACpC,KAAK,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;KACvC;CAWF"}

package/dist/PerpsController.mjs

@@ -0,0 +1,83 @@
+import { BaseController } from "@metamask/base-controller";
+/**
+ * The name of the {@link PerpsController}, 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 = 'PerpsController';
+/**
+ * The metadata for each property in {@link PerpsControllerState}.
+ */
+const perpsControllerMetadata = {};
+/**
+ * Constructs the default {@link PerpsController} 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 PerpsController} state.
+ */
+export function getDefaultPerpsControllerState() {
+    return {};
+}
+/**
+ * `PerpsController` manages perpetual trading functionality in MetaMask.
+ *
+ * This controller provides platform-agnostic perps trading capabilities.
+ *
+ * @example
+ *
+ * ``` ts
+ * import { Messenger } from '@metamask/messenger';
+ * import type {
+ *   PerpsControllerActions,
+ *   PerpsControllerEvents,
+ * } from '@metamask/perps-controller';
+ * import { PerpsController } from '@metamask/perps-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   PerpsControllerActions,
+ *   PerpsControllerEvents
+ * >({ namespace: 'Root' });
+ * const perpsControllerMessenger = new Messenger<
+ *   'PerpsController',
+ *   PerpsControllerActions,
+ *   PerpsControllerEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'PerpsController',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the controller to register its actions on the messenger
+ * new PerpsController({
+ *   messenger: perpsControllerMessenger,
+ * });
+ *
+ * const perpsControllerState = await rootMessenger.call(
+ *   'PerpsController:getState',
+ * );
+ * ```
+ */
+export class PerpsController extends BaseController {
+    /**
+     * Constructs a new {@link PerpsController}.
+     *
+     * @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: perpsControllerMetadata,
+            name: controllerName,
+            state: {
+                ...getDefaultPerpsControllerState(),
+                ...state,
+            },
+        });
+    }
+}
+//# sourceMappingURL=PerpsController.mjs.map

package/dist/PerpsController.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"PerpsController.mjs","sourceRoot":"","sources":["../src/PerpsController.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAG3D;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,iBAAiB,CAAC;AAUhD;;GAEG;AACH,MAAM,uBAAuB,GAC3B,EAAgD,CAAC;AAEnD;;;;;;;GAOG;AACH,MAAM,UAAU,8BAA8B;IAC5C,OAAO,EAAE,CAAC;AACZ,CAAC;AAiDD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,OAAO,eAAgB,SAAQ,cAIpC;IACC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,uBAAuB;YACjC,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE;gBACL,GAAG,8BAA8B,EAAE;gBACnC,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 PerpsController}, 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 = 'PerpsController';\n\n/**\n * Describes the shape of the state object for {@link PerpsController}.\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type\nexport type PerpsControllerState = {\n  // Empty state - to be implemented in future PRs\n};\n\n/**\n * The metadata for each property in {@link PerpsControllerState}.\n */\nconst perpsControllerMetadata =\n  {} satisfies StateMetadata<PerpsControllerState>;\n\n/**\n * Constructs the default {@link PerpsController} 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 PerpsController} state.\n */\nexport function getDefaultPerpsControllerState(): PerpsControllerState {\n  return {};\n}\n\n/**\n * Retrieves the state of the {@link PerpsController}.\n */\nexport type PerpsControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  PerpsControllerState\n>;\n\n/**\n * Actions that {@link PerpsControllerMessenger} exposes to other consumers.\n */\nexport type PerpsControllerActions = PerpsControllerGetStateAction;\n\n/**\n * Actions from other messengers that {@link PerpsControllerMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Published when the state of {@link PerpsController} changes.\n */\nexport type PerpsControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  PerpsControllerState\n>;\n\n/**\n * Events that {@link PerpsControllerMessenger} exposes to other consumers.\n */\nexport type PerpsControllerEvents = PerpsControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link PerpsControllerMessenger} subscribes\n * to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link PerpsController}.\n */\nexport type PerpsControllerMessenger = Messenger<\n  typeof controllerName,\n  PerpsControllerActions | AllowedActions,\n  PerpsControllerEvents | AllowedEvents\n>;\n\n/**\n * `PerpsController` manages perpetual trading functionality in MetaMask.\n *\n * This controller provides platform-agnostic perps trading capabilities.\n *\n * @example\n *\n * ``` ts\n * import { Messenger } from '@metamask/messenger';\n * import type {\n *   PerpsControllerActions,\n *   PerpsControllerEvents,\n * } from '@metamask/perps-controller';\n * import { PerpsController } from '@metamask/perps-controller';\n *\n * const rootMessenger = new Messenger<\n *   'Root',\n *   PerpsControllerActions,\n *   PerpsControllerEvents\n * >({ namespace: 'Root' });\n * const perpsControllerMessenger = new Messenger<\n *   'PerpsController',\n *   PerpsControllerActions,\n *   PerpsControllerEvents,\n *   typeof rootMessenger,\n * >({\n *   namespace: 'PerpsController',\n *   parent: rootMessenger,\n * });\n * // Instantiate the controller to register its actions on the messenger\n * new PerpsController({\n *   messenger: perpsControllerMessenger,\n * });\n *\n * const perpsControllerState = await rootMessenger.call(\n *   'PerpsController:getState',\n * );\n * ```\n */\nexport class PerpsController extends BaseController<\n  typeof controllerName,\n  PerpsControllerState,\n  PerpsControllerMessenger\n> {\n  /**\n   * Constructs a new {@link PerpsController}.\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: PerpsControllerMessenger;\n    state?: Partial<PerpsControllerState>;\n  }) {\n    super({\n      messenger,\n      metadata: perpsControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultPerpsControllerState(),\n        ...state,\n      },\n    });\n  }\n}\n"]}

package/dist/index.cjs

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultPerpsControllerState = exports.PerpsController = void 0;
+var PerpsController_1 = require("./PerpsController.cjs");
+Object.defineProperty(exports, "PerpsController", { enumerable: true, get: function () { return PerpsController_1.PerpsController; } });
+Object.defineProperty(exports, "getDefaultPerpsControllerState", { enumerable: true, get: function () { return PerpsController_1.getDefaultPerpsControllerState; } });
+//# 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,yDAG2B;AAFzB,kHAAA,eAAe,OAAA;AACf,iIAAA,8BAA8B,OAAA","sourcesContent":["export type {\n  PerpsControllerState,\n  PerpsControllerGetStateAction,\n  PerpsControllerActions,\n  PerpsControllerStateChangeEvent,\n  PerpsControllerEvents,\n  PerpsControllerMessenger,\n} from './PerpsController';\nexport {\n  PerpsController,\n  getDefaultPerpsControllerState,\n} from './PerpsController';\n"]}

package/dist/index.d.cts

@@ -0,0 +1,3 @@
+export type { PerpsControllerState, PerpsControllerGetStateAction, PerpsControllerActions, PerpsControllerStateChangeEvent, PerpsControllerEvents, PerpsControllerMessenger, } from "./PerpsController.cjs";
+export { PerpsController, getDefaultPerpsControllerState, } from "./PerpsController.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,oBAAoB,EACpB,6BAA6B,EAC7B,sBAAsB,EACtB,+BAA+B,EAC/B,qBAAqB,EACrB,wBAAwB,GACzB,8BAA0B;AAC3B,OAAO,EACL,eAAe,EACf,8BAA8B,GAC/B,8BAA0B"}

package/dist/index.d.mts

@@ -0,0 +1,3 @@
+export type { PerpsControllerState, PerpsControllerGetStateAction, PerpsControllerActions, PerpsControllerStateChangeEvent, PerpsControllerEvents, PerpsControllerMessenger, } from "./PerpsController.mjs";
+export { PerpsController, getDefaultPerpsControllerState, } from "./PerpsController.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,oBAAoB,EACpB,6BAA6B,EAC7B,sBAAsB,EACtB,+BAA+B,EAC/B,qBAAqB,EACrB,wBAAwB,GACzB,8BAA0B;AAC3B,OAAO,EACL,eAAe,EACf,8BAA8B,GAC/B,8BAA0B"}

package/dist/index.mjs

@@ -0,0 +1,2 @@
+export { PerpsController, getDefaultPerpsControllerState } from "./PerpsController.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,eAAe,EACf,8BAA8B,EAC/B,8BAA0B","sourcesContent":["export type {\n  PerpsControllerState,\n  PerpsControllerGetStateAction,\n  PerpsControllerActions,\n  PerpsControllerStateChangeEvent,\n  PerpsControllerEvents,\n  PerpsControllerMessenger,\n} from './PerpsController';\nexport {\n  PerpsController,\n  getDefaultPerpsControllerState,\n} from './PerpsController';\n"]}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@metamask-previews/perps-controller",
+  "version": "0.0.0-preview-903db2da",
+  "description": "Controller for perpetual trading functionality in MetaMask",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/perps-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/perps-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/perps-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/controller-utils": "^11.18.0",
+    "@metamask/messenger": "^0.3.0",
+    "@metamask/utils": "^11.9.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/"
+  }
+}