@metamask-previews/watch-only-account-service 0.0.0-preview-173a9edb1

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: `WatchOnlyAccountService` with `createAccount` and `isEnabled` actions ([#10794](https://github.com/MetaMask/core/pull/10794))
+
+[Unreleased]: https://github.com/MetaMask/core/

package/LICENSE

@@ -0,0 +1,6 @@
+This project is licensed under either of
+
+ * MIT license ([LICENSE.MIT](LICENSE.MIT))
+ * Apache License, Version 2.0 ([LICENSE.APACHE2](LICENSE.APACHE2))
+
+at your option.

package/LICENSE.APACHE2

@@ -0,0 +1,201 @@
+ Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 MetaMask
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSE.MIT

@@ -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,25 @@
+# `@metamask/watch-only-account-service`
+
+Service for managing watch-only accounts
+
+## Overview
+
+`WatchOnlyAccountService` centralizes the creation of watch-only accounts, providing a single integration point for:
+
+- **Account creation** — Imports an EVM account by address into the `"watch-only"` keyring. No secret material is ever involved, and the resulting account cannot sign. Resolving the corresponding internal account and selecting it is left to the client.
+- **Keyring plumbing** — Atomically creates the watch-only keyring if it does not exist yet.
+- **Feature gating** — Takes an `isEnabled` callback and refuses to create accounts while it reports the feature as disabled. The callback is consulted on each call, so the gate can change dynamically (e.g. driven by a remote feature flag).
+
+The service exposes its functionality through the MetaMask messenger pattern and depends on the `KeyringController`.
+
+## Installation
+
+`yarn add @metamask/watch-only-account-service`
+
+or
+
+`npm install @metamask/watch-only-account-service`
+
+## 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/WatchOnlyAccountService-method-action-types.d.ts

@@ -0,0 +1,37 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { WatchOnlyAccountService } from './WatchOnlyAccountService.js';
+/**
+ * Returns whether the watch-only support is enabled.
+ *
+ * @returns `true` if the watch-only support is enabled.
+ */
+export type WatchOnlyAccountServiceIsEnabledAction = {
+    type: `WatchOnlyAccountService:isEnabled`;
+    handler: WatchOnlyAccountService['isEnabled'];
+};
+/**
+ * Creates (or retrieves, if it already exists) a watch-only account for the
+ * given address.
+ *
+ * The watch-only keyring is created atomically if it does not exist yet.
+ * The account itself is imported by address: no secret material is ever
+ * involved, and the resulting account cannot sign.
+ *
+ * @param address - The EVM address to import.
+ * @returns The keyring account for the imported address.
+ * @throws {WatchOnlyAccountDisabledError} If the watch-only support is
+ * disabled.
+ * @throws If the address is not a valid EVM address.
+ */
+export type WatchOnlyAccountServiceCreateAccountAction = {
+    type: `WatchOnlyAccountService:createAccount`;
+    handler: WatchOnlyAccountService['createAccount'];
+};
+/**
+ * Union of all WatchOnlyAccountService action types.
+ */
+export type WatchOnlyAccountServiceMethodActions = WatchOnlyAccountServiceIsEnabledAction | WatchOnlyAccountServiceCreateAccountAction;
+//# sourceMappingURL=WatchOnlyAccountService-method-action-types.d.ts.map

package/dist/WatchOnlyAccountService-method-action-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WatchOnlyAccountService-method-action-types.d.ts","sourceRoot":"","sources":["../src/WatchOnlyAccountService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAE5E;;;;GAIG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;CAC/C,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,uBAAuB,CAAC,eAAe,CAAC,CAAC;CACnD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAC5C,sCAAsC,GACtC,0CAA0C,CAAC"}

package/dist/WatchOnlyAccountService-method-action-types.js

@@ -0,0 +1,6 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+export {};
+//# sourceMappingURL=WatchOnlyAccountService-method-action-types.js.map

package/dist/WatchOnlyAccountService-method-action-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WatchOnlyAccountService-method-action-types.js","sourceRoot":"","sources":["../src/WatchOnlyAccountService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { WatchOnlyAccountService } from './WatchOnlyAccountService.js';\n\n/**\n * Returns whether the watch-only support is enabled.\n *\n * @returns `true` if the watch-only support is enabled.\n */\nexport type WatchOnlyAccountServiceIsEnabledAction = {\n  type: `WatchOnlyAccountService:isEnabled`;\n  handler: WatchOnlyAccountService['isEnabled'];\n};\n\n/**\n * Creates (or retrieves, if it already exists) a watch-only account for the\n * given address.\n *\n * The watch-only keyring is created atomically if it does not exist yet.\n * The account itself is imported by address: no secret material is ever\n * involved, and the resulting account cannot sign.\n *\n * @param address - The EVM address to import.\n * @returns The keyring account for the imported address.\n * @throws {WatchOnlyAccountDisabledError} If the watch-only support is\n * disabled.\n * @throws If the address is not a valid EVM address.\n */\nexport type WatchOnlyAccountServiceCreateAccountAction = {\n  type: `WatchOnlyAccountService:createAccount`;\n  handler: WatchOnlyAccountService['createAccount'];\n};\n\n/**\n * Union of all WatchOnlyAccountService action types.\n */\nexport type WatchOnlyAccountServiceMethodActions =\n  | WatchOnlyAccountServiceIsEnabledAction\n  | WatchOnlyAccountServiceCreateAccountAction;\n"]}

package/dist/WatchOnlyAccountService.d.ts

@@ -0,0 +1,86 @@
+import type { KeyringAccount } from '@metamask/keyring-api';
+import type { KeyringControllerWithControllerAction, KeyringControllerWithKeyringV2Action } from '@metamask/keyring-controller';
+import type { Messenger } from '@metamask/messenger';
+import type { WatchOnlyAccountServiceCreateAccountAction, WatchOnlyAccountServiceIsEnabledAction } from './WatchOnlyAccountService-method-action-types.js';
+/**
+ * The name of the {@link WatchOnlyAccountService}, used to namespace the
+ * service's actions.
+ */
+export declare const serviceName = "WatchOnlyAccountService";
+/**
+ * Actions that {@link WatchOnlyAccountService} exposes to other consumers.
+ */
+export type WatchOnlyAccountServiceActions = WatchOnlyAccountServiceCreateAccountAction | WatchOnlyAccountServiceIsEnabledAction;
+/**
+ * Actions from other messengers that {@link WatchOnlyAccountService} calls.
+ */
+type AllowedActions = KeyringControllerWithControllerAction | KeyringControllerWithKeyringV2Action;
+/**
+ * The messenger which is restricted to actions accessed by
+ * {@link WatchOnlyAccountService}.
+ */
+export type WatchOnlyAccountServiceMessenger = Messenger<typeof serviceName, WatchOnlyAccountServiceActions | AllowedActions, never>;
+/**
+ * The options that {@link WatchOnlyAccountService} takes.
+ */
+export type WatchOnlyAccountServiceOptions = {
+    /**
+     * The messenger suited for this service.
+     */
+    messenger: WatchOnlyAccountServiceMessenger;
+    /**
+     * A callback that determines whether the watch-only support is currently
+     * enabled. When disabled, the service refuses to create watch-only
+     * accounts. The callback is consulted on each call, so the gating decision
+     * can be made dynamically (e.g. driven by a remote feature flag).
+     */
+    isEnabled?: () => boolean;
+};
+/**
+ * Service responsible for managing watch-only accounts.
+ *
+ * Watch-only accounts are EVM accounts imported by address, held by the
+ * `"watch-only"` keyring. They cannot sign anything. This service hides the
+ * keyring plumbing (notably the atomic creation of the watch-only keyring if
+ * it does not exist yet) behind a single, simple action.
+ */
+export declare class WatchOnlyAccountService {
+    #private;
+    /**
+     * The name of the service.
+     */
+    readonly name: typeof serviceName;
+    /**
+     * Constructs a new {@link WatchOnlyAccountService}.
+     *
+     * @param options - The constructor arguments.
+     * @param options.messenger - The messenger suited for this service.
+     * @param options.isEnabled - A callback that determines whether the
+     * watch-only support is currently enabled. Defaults to a callback that
+     * always returns `false`.
+     */
+    constructor({ messenger, isEnabled, }: WatchOnlyAccountServiceOptions);
+    /**
+     * Returns whether the watch-only support is enabled.
+     *
+     * @returns `true` if the watch-only support is enabled.
+     */
+    isEnabled(): boolean;
+    /**
+     * Creates (or retrieves, if it already exists) a watch-only account for the
+     * given address.
+     *
+     * The watch-only keyring is created atomically if it does not exist yet.
+     * The account itself is imported by address: no secret material is ever
+     * involved, and the resulting account cannot sign.
+     *
+     * @param address - The EVM address to import.
+     * @returns The keyring account for the imported address.
+     * @throws {WatchOnlyAccountDisabledError} If the watch-only support is
+     * disabled.
+     * @throws If the address is not a valid EVM address.
+     */
+    createAccount(address: string): Promise<KeyringAccount>;
+}
+export {};
+//# sourceMappingURL=WatchOnlyAccountService.d.ts.map

package/dist/WatchOnlyAccountService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WatchOnlyAccountService.d.ts","sourceRoot":"","sources":["../src/WatchOnlyAccountService.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAG5D,OAAO,KAAK,EACV,qCAAqC,EACrC,oCAAoC,EACrC,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAGrD,OAAO,KAAK,EACV,0CAA0C,EAC1C,sCAAsC,EACvC,MAAM,kDAAkD,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,WAAW,4BAA4B,CAAC;AAQrD;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACtC,0CAA0C,GAC1C,sCAAsC,CAAC;AAE3C;;GAEG;AACH,KAAK,cAAc,GACf,qCAAqC,GACrC,oCAAoC,CAAC;AAEzC;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GAAG,SAAS,CACtD,OAAO,WAAW,EAClB,8BAA8B,GAAG,cAAc,EAC/C,KAAK,CACN,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,SAAS,EAAE,gCAAgC,CAAC;IAE5C;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,OAAO,CAAC;CAC3B,CAAC;AAEF;;;;;;;GAOG;AACH,qBAAa,uBAAuB;;IAClC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IAUlC;;;;;;;;OAQG;IACH,YAAY,EACV,SAAS,EACT,SAAgC,GACjC,EAAE,8BAA8B,EAShC;IAED;;;;OAIG;IACH,SAAS,IAAI,OAAO,CAEnB;IAED;;;;;;;;;;;;;OAaG;IACG,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAoB5D;CAsDF"}

package/dist/WatchOnlyAccountService.js

@@ -0,0 +1,124 @@
+import { AccountCreationType } from '@metamask/keyring-api';
+import { KeyringType } from '@metamask/keyring-api/v2';
+import { WatchOnlyAccountDisabledError } from './errors.js';
+/**
+ * The name of the {@link WatchOnlyAccountService}, used to namespace the
+ * service's actions.
+ */
+export const serviceName = 'WatchOnlyAccountService';
+/**
+ * All of the methods within {@link WatchOnlyAccountService} that are exposed
+ * via the messenger.
+ */
+const MESSENGER_EXPOSED_METHODS = ['createAccount', 'isEnabled'];
+/**
+ * Service responsible for managing watch-only accounts.
+ *
+ * Watch-only accounts are EVM accounts imported by address, held by the
+ * `"watch-only"` keyring. They cannot sign anything. This service hides the
+ * keyring plumbing (notably the atomic creation of the watch-only keyring if
+ * it does not exist yet) behind a single, simple action.
+ */
+export class WatchOnlyAccountService {
+    /**
+     * The name of the service.
+     */
+    name;
+    #messenger;
+    /**
+     * A callback that determines whether the watch-only support is currently
+     * enabled.
+     */
+    #isEnabled;
+    /**
+     * Constructs a new {@link WatchOnlyAccountService}.
+     *
+     * @param options - The constructor arguments.
+     * @param options.messenger - The messenger suited for this service.
+     * @param options.isEnabled - A callback that determines whether the
+     * watch-only support is currently enabled. Defaults to a callback that
+     * always returns `false`.
+     */
+    constructor({ messenger, isEnabled = () => false, }) {
+        this.name = serviceName;
+        this.#messenger = messenger;
+        this.#isEnabled = isEnabled;
+        this.#messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Returns whether the watch-only support is enabled.
+     *
+     * @returns `true` if the watch-only support is enabled.
+     */
+    isEnabled() {
+        return this.#isEnabled();
+    }
+    /**
+     * Creates (or retrieves, if it already exists) a watch-only account for the
+     * given address.
+     *
+     * The watch-only keyring is created atomically if it does not exist yet.
+     * The account itself is imported by address: no secret material is ever
+     * involved, and the resulting account cannot sign.
+     *
+     * @param address - The EVM address to import.
+     * @returns The keyring account for the imported address.
+     * @throws {WatchOnlyAccountDisabledError} If the watch-only support is
+     * disabled.
+     * @throws If the address is not a valid EVM address.
+     */
+    async createAccount(address) {
+        this.#ensureWatchOnlyEnabled();
+        await this.#ensureWatchOnlyKeyringExists();
+        const accounts = await this.#withWatchOnlyKeyring(async (keyring) => keyring.createAccounts({
+            type: AccountCreationType.AddressImport,
+            address,
+        }));
+        const [account] = accounts;
+        if (!account) {
+            // NOTE: The address is deliberately not included in the error message
+            // to avoid leaking it.
+            throw new Error('No watch-only account was created.');
+        }
+        return account;
+    }
+    /**
+     * Ensures that the watch-only support is enabled.
+     *
+     * @throws {WatchOnlyAccountDisabledError} If the watch-only support is
+     * disabled.
+     */
+    #ensureWatchOnlyEnabled() {
+        if (!this.#isEnabled()) {
+            throw new WatchOnlyAccountDisabledError();
+        }
+    }
+    /**
+     * Runs an operation with the watch-only keyring (v2), selected by type.
+     *
+     * @param operation - The operation to run with the keyring.
+     * @returns The result of the operation.
+     * @template Result - The type of the value resolved by the operation.
+     */
+    async #withWatchOnlyKeyring(operation) {
+        // The result is cast because the callback's return type does not flow
+        // through the messenger's action generics.
+        return this.#messenger.call('KeyringController:withKeyringV2', { type: KeyringType.WatchOnly }, async ({ keyring }) => await operation(keyring));
+    }
+    /**
+     * Ensures that the watch-only keyring exists, creating it if needed.
+     *
+     * The check and the creation are performed within the same
+     * `KeyringController:withController` transaction, so concurrent callers
+     * cannot race each other into creating duplicate keyrings.
+     */
+    async #ensureWatchOnlyKeyringExists() {
+        await this.#messenger.call('KeyringController:withController', async (controller) => {
+            const hasKeyring = controller.keyrings.some(({ keyring }) => keyring.type === KeyringType.WatchOnly);
+            if (!hasKeyring) {
+                await controller.addNewKeyring(KeyringType.WatchOnly);
+            }
+        });
+    }
+}
+//# sourceMappingURL=WatchOnlyAccountService.js.map

package/dist/WatchOnlyAccountService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WatchOnlyAccountService.js","sourceRoot":"","sources":["../src/WatchOnlyAccountService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAQvD,OAAO,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAC;AAM5D;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,yBAAyB,CAAC;AAErD;;;GAGG;AACH,MAAM,yBAAyB,GAAG,CAAC,eAAe,EAAE,WAAW,CAAU,CAAC;AA4C1E;;;;;;;GAOG;AACH,MAAM,OAAO,uBAAuB;IAClC;;OAEG;IACM,IAAI,CAAqB;IAEzB,UAAU,CAAmC;IAEtD;;;OAGG;IACM,UAAU,CAAgB;IAEnC;;;;;;;;OAQG;IACH,YAAY,EACV,SAAS,EACT,SAAS,GAAG,GAAY,EAAE,CAAC,KAAK,GACD;QAC/B,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,aAAa,CAAC,OAAe;QACjC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAE/B,MAAM,IAAI,CAAC,6BAA6B,EAAE,CAAC;QAE3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAClE,OAAO,CAAC,cAAc,CAAC;YACrB,IAAI,EAAE,mBAAmB,CAAC,aAAa;YACvC,OAAO;SACR,CAAC,CACH,CAAC;QAEF,MAAM,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC;QAC3B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,sEAAsE;YACtE,uBAAuB;YACvB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,uBAAuB;QACrB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;YACvB,MAAM,IAAI,6BAA6B,EAAE,CAAC;QAC5C,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,qBAAqB,CACzB,SAAkD;QAElD,sEAAsE;QACtE,2CAA2C;QAC3C,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CACzB,iCAAiC,EACjC,EAAE,IAAI,EAAE,WAAW,CAAC,SAAS,EAAE,EAC/B,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,MAAM,SAAS,CAAC,OAAO,CAAC,CACtC,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,6BAA6B;QACjC,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CACxB,kCAAkC,EAClC,KAAK,EAAE,UAAU,EAAE,EAAE;YACnB,MAAM,UAAU,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,CACzC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,CACxD,CAAC;YAEF,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,MAAM,UAAU,CAAC,aAAa,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;YACxD,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;CACF","sourcesContent":["import { AccountCreationType } from '@metamask/keyring-api';\nimport type { KeyringAccount } from '@metamask/keyring-api';\nimport { KeyringType } from '@metamask/keyring-api/v2';\nimport type { Keyring as KeyringV2 } from '@metamask/keyring-api/v2';\nimport type {\n  KeyringControllerWithControllerAction,\n  KeyringControllerWithKeyringV2Action,\n} from '@metamask/keyring-controller';\nimport type { Messenger } from '@metamask/messenger';\n\nimport { WatchOnlyAccountDisabledError } from './errors.js';\nimport type {\n  WatchOnlyAccountServiceCreateAccountAction,\n  WatchOnlyAccountServiceIsEnabledAction,\n} from './WatchOnlyAccountService-method-action-types.js';\n\n/**\n * The name of the {@link WatchOnlyAccountService}, used to namespace the\n * service's actions.\n */\nexport const serviceName = 'WatchOnlyAccountService';\n\n/**\n * All of the methods within {@link WatchOnlyAccountService} that are exposed\n * via the messenger.\n */\nconst MESSENGER_EXPOSED_METHODS = ['createAccount', 'isEnabled'] as const;\n\n/**\n * Actions that {@link WatchOnlyAccountService} exposes to other consumers.\n */\nexport type WatchOnlyAccountServiceActions =\n  | WatchOnlyAccountServiceCreateAccountAction\n  | WatchOnlyAccountServiceIsEnabledAction;\n\n/**\n * Actions from other messengers that {@link WatchOnlyAccountService} calls.\n */\ntype AllowedActions =\n  | KeyringControllerWithControllerAction\n  | KeyringControllerWithKeyringV2Action;\n\n/**\n * The messenger which is restricted to actions accessed by\n * {@link WatchOnlyAccountService}.\n */\nexport type WatchOnlyAccountServiceMessenger = Messenger<\n  typeof serviceName,\n  WatchOnlyAccountServiceActions | AllowedActions,\n  never\n>;\n\n/**\n * The options that {@link WatchOnlyAccountService} takes.\n */\nexport type WatchOnlyAccountServiceOptions = {\n  /**\n   * The messenger suited for this service.\n   */\n  messenger: WatchOnlyAccountServiceMessenger;\n\n  /**\n   * A callback that determines whether the watch-only support is currently\n   * enabled. When disabled, the service refuses to create watch-only\n   * accounts. The callback is consulted on each call, so the gating decision\n   * can be made dynamically (e.g. driven by a remote feature flag).\n   */\n  isEnabled?: () => boolean;\n};\n\n/**\n * Service responsible for managing watch-only accounts.\n *\n * Watch-only accounts are EVM accounts imported by address, held by the\n * `\"watch-only\"` keyring. They cannot sign anything. This service hides the\n * keyring plumbing (notably the atomic creation of the watch-only keyring if\n * it does not exist yet) behind a single, simple action.\n */\nexport class WatchOnlyAccountService {\n  /**\n   * The name of the service.\n   */\n  readonly name: typeof serviceName;\n\n  readonly #messenger: WatchOnlyAccountServiceMessenger;\n\n  /**\n   * A callback that determines whether the watch-only support is currently\n   * enabled.\n   */\n  readonly #isEnabled: () => boolean;\n\n  /**\n   * Constructs a new {@link WatchOnlyAccountService}.\n   *\n   * @param options - The constructor arguments.\n   * @param options.messenger - The messenger suited for this service.\n   * @param options.isEnabled - A callback that determines whether the\n   * watch-only support is currently enabled. Defaults to a callback that\n   * always returns `false`.\n   */\n  constructor({\n    messenger,\n    isEnabled = (): boolean => false,\n  }: WatchOnlyAccountServiceOptions) {\n    this.name = serviceName;\n    this.#messenger = messenger;\n    this.#isEnabled = isEnabled;\n\n    this.#messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Returns whether the watch-only support is enabled.\n   *\n   * @returns `true` if the watch-only support is enabled.\n   */\n  isEnabled(): boolean {\n    return this.#isEnabled();\n  }\n\n  /**\n   * Creates (or retrieves, if it already exists) a watch-only account for the\n   * given address.\n   *\n   * The watch-only keyring is created atomically if it does not exist yet.\n   * The account itself is imported by address: no secret material is ever\n   * involved, and the resulting account cannot sign.\n   *\n   * @param address - The EVM address to import.\n   * @returns The keyring account for the imported address.\n   * @throws {WatchOnlyAccountDisabledError} If the watch-only support is\n   * disabled.\n   * @throws If the address is not a valid EVM address.\n   */\n  async createAccount(address: string): Promise<KeyringAccount> {\n    this.#ensureWatchOnlyEnabled();\n\n    await this.#ensureWatchOnlyKeyringExists();\n\n    const accounts = await this.#withWatchOnlyKeyring(async (keyring) =>\n      keyring.createAccounts({\n        type: AccountCreationType.AddressImport,\n        address,\n      }),\n    );\n\n    const [account] = accounts;\n    if (!account) {\n      // NOTE: The address is deliberately not included in the error message\n      // to avoid leaking it.\n      throw new Error('No watch-only account was created.');\n    }\n\n    return account;\n  }\n\n  /**\n   * Ensures that the watch-only support is enabled.\n   *\n   * @throws {WatchOnlyAccountDisabledError} If the watch-only support is\n   * disabled.\n   */\n  #ensureWatchOnlyEnabled(): void {\n    if (!this.#isEnabled()) {\n      throw new WatchOnlyAccountDisabledError();\n    }\n  }\n\n  /**\n   * Runs an operation with the watch-only keyring (v2), selected by type.\n   *\n   * @param operation - The operation to run with the keyring.\n   * @returns The result of the operation.\n   * @template Result - The type of the value resolved by the operation.\n   */\n  async #withWatchOnlyKeyring<Result>(\n    operation: (keyring: KeyringV2) => Promise<Result>,\n  ): Promise<Result> {\n    // The result is cast because the callback's return type does not flow\n    // through the messenger's action generics.\n    return this.#messenger.call(\n      'KeyringController:withKeyringV2',\n      { type: KeyringType.WatchOnly },\n      async ({ keyring }) => await operation(keyring),\n    ) as Result;\n  }\n\n  /**\n   * Ensures that the watch-only keyring exists, creating it if needed.\n   *\n   * The check and the creation are performed within the same\n   * `KeyringController:withController` transaction, so concurrent callers\n   * cannot race each other into creating duplicate keyrings.\n   */\n  async #ensureWatchOnlyKeyringExists(): Promise<void> {\n    await this.#messenger.call(\n      'KeyringController:withController',\n      async (controller) => {\n        const hasKeyring = controller.keyrings.some(\n          ({ keyring }) => keyring.type === KeyringType.WatchOnly,\n        );\n\n        if (!hasKeyring) {\n          await controller.addNewKeyring(KeyringType.WatchOnly);\n        }\n      },\n    );\n  }\n}\n"]}

package/dist/errors.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Error thrown when trying to create a watch-only account while the
+ * watch-only support is disabled.
+ */
+export declare class WatchOnlyAccountDisabledError extends Error {
+    constructor();
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,qBAAa,6BAA8B,SAAQ,KAAK;IACtD,cAGC;CACF"}

package/dist/errors.js

@@ -0,0 +1,11 @@
+/**
+ * Error thrown when trying to create a watch-only account while the
+ * watch-only support is disabled.
+ */
+export class WatchOnlyAccountDisabledError extends Error {
+    constructor() {
+        super('Watch-only account support is disabled');
+        this.name = 'WatchOnlyAccountDisabledError';
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,OAAO,6BAA8B,SAAQ,KAAK;IACtD;QACE,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,GAAG,+BAA+B,CAAC;IAC9C,CAAC;CACF","sourcesContent":["/**\n * Error thrown when trying to create a watch-only account while the\n * watch-only support is disabled.\n */\nexport class WatchOnlyAccountDisabledError extends Error {\n  constructor() {\n    super('Watch-only account support is disabled');\n    this.name = 'WatchOnlyAccountDisabledError';\n  }\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { WatchOnlyAccountService, serviceName, } from './WatchOnlyAccountService.js';
+export type { WatchOnlyAccountServiceActions, WatchOnlyAccountServiceMessenger, WatchOnlyAccountServiceOptions, } from './WatchOnlyAccountService.js';
+export type { WatchOnlyAccountServiceCreateAccountAction, WatchOnlyAccountServiceIsEnabledAction, WatchOnlyAccountServiceMethodActions, } from './WatchOnlyAccountService-method-action-types.js';
+export { WatchOnlyAccountDisabledError } from './errors.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,WAAW,GACZ,MAAM,8BAA8B,CAAC;AACtC,YAAY,EACV,8BAA8B,EAC9B,gCAAgC,EAChC,8BAA8B,GAC/B,MAAM,8BAA8B,CAAC;AACtC,YAAY,EACV,0CAA0C,EAC1C,sCAAsC,EACtC,oCAAoC,GACrC,MAAM,kDAAkD,CAAC;AAC1D,OAAO,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { WatchOnlyAccountService, serviceName, } from './WatchOnlyAccountService.js';
+export { WatchOnlyAccountDisabledError } from './errors.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,WAAW,GACZ,MAAM,8BAA8B,CAAC;AAWtC,OAAO,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAC","sourcesContent":["export {\n  WatchOnlyAccountService,\n  serviceName,\n} from './WatchOnlyAccountService.js';\nexport type {\n  WatchOnlyAccountServiceActions,\n  WatchOnlyAccountServiceMessenger,\n  WatchOnlyAccountServiceOptions,\n} from './WatchOnlyAccountService.js';\nexport type {\n  WatchOnlyAccountServiceCreateAccountAction,\n  WatchOnlyAccountServiceIsEnabledAction,\n  WatchOnlyAccountServiceMethodActions,\n} from './WatchOnlyAccountService-method-action-types.js';\nexport { WatchOnlyAccountDisabledError } from './errors.js';\n"]}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@metamask-previews/watch-only-account-service",
+  "version": "0.0.0-preview-173a9edb1",
+  "description": "Service for managing watch-only accounts",
+  "keywords": [
+    "Ethereum",
+    "MetaMask"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/watch-only-account-service#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "license": "(MIT OR Apache-2.0)",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "files": [
+    "dist/"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "build:all": "tsc --build tsconfig.build.json --verbose",
+    "build:clean": "yarn build:only-clean && yarn build",
+    "build:docs": "typedoc",
+    "build:only-clean": "rimraf './dist' './tsconfig.build.tsbuildinfo'",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/watch-only-account-service",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/watch-only-account-service",
+    "lint:tsconfigs": "node --import ../../scripts/resolver/register.ts --experimental-transform-types ../../scripts/lint-tsconfigs/lint-tsconfigs.ts",
+    "lint:tsconfigs:fix": "node --import ../../scripts/resolver/register.ts --experimental-transform-types ../../scripts/lint-tsconfigs/lint-tsconfigs.ts --fix",
+    "messenger-action-types:check": "node --import ../../scripts/resolver/register.ts --experimental-transform-types ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --esm --check",
+    "messenger-action-types:generate": "node --import ../../scripts/resolver/register.ts --experimental-transform-types ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --esm --generate",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "vitest",
+    "test:clean": "vitest --clearCache",
+    "test:verbose": "vitest --reporter=verbose",
+    "test:watch": "vitest --watch"
+  },
+  "dependencies": {
+    "@metamask/keyring-api": "^24.3.0",
+    "@metamask/keyring-controller": "^28.2.0",
+    "@metamask/messenger": "^3.0.0"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^6.2.1",
+    "@typescript/native": "npm:typescript@^7.0.2",
+    "rimraf": "^6.1.3",
+    "typedoc": "^0.28.20",
+    "typedoc-plugin-missing-exports": "^4.1.4",
+    "typescript": "npm:@typescript/typescript6@^6.0.2",
+    "vitest": "^5.0.0"
+  },
+  "engines": {
+    "node": "^22.14.0 || ^24"
+  }
+}