@metamask-previews/eth-snap-keyring 22.3.0-e51c895 → 22.4.0-5951828

package/dist/v2/SnapKeyring.d.cts

@@ -1,10 +1,18 @@
 import type { KeyringAccount } from "@metamask/keyring-api";
 import type { CreateAccountOptions, Keyring, KeyringCapabilities } from "@metamask/keyring-api/v2";
 import type { AccountId } from "@metamask/keyring-utils";
+import type { SnapId } from "@metamask/snaps-sdk";
 import type { Infer } from "@metamask/superstruct";
 import type { Json } from "@metamask/utils";
+import type { SnapKeyringMessenger } from "../SnapKeyringMessenger.cjs";
 import { SnapKeyringV1 } from "../SnapKeyringV1.cjs";
-import type { SnapKeyringV1Callbacks, SnapKeyringV1Options } from "../SnapKeyringV1.cjs";
+import type { SnapKeyringV1Callbacks } from "../SnapKeyringV1.cjs";
+/**
+ * Default, empty capabilities used until the snap manifest is read on
+ * `deserialize`. Typed (no cast) so that adding a new required
+ * `KeyringCapabilities` field surfaces here as a compile error.
+ */
+export declare const EMPTY_CAPABILITIES: KeyringCapabilities;
 /**
  * Superstruct schema for {@link SnapKeyringState}.
  *
@@ -46,7 +54,10 @@ export declare const SnapKeyringStateStruct: import("@metamask/superstruct").Str
                 type: "private-key";
             } | {
                 type: "custom";
-            };
+            }; /**
+             * V1 instance, present only when the snap does not declare v2 capabilities.
+             * Created on `deserialize()` after reading the snap manifest.
+             */
             exportable?: boolean;
         };
         methods: string[];
@@ -86,7 +97,10 @@ export declare const SnapKeyringStateStruct: import("@metamask/superstruct").Str
                 type: "private-key";
             } | {
                 type: "custom";
-            };
+            }; /**
+             * V1 instance, present only when the snap does not declare v2 capabilities.
+             * Created on `deserialize()` after reading the snap manifest.
+             */
             exportable?: boolean;
         };
         methods: string[];
@@ -118,8 +132,10 @@ export type SnapKeyringCallbacks = SnapKeyringV1Callbacks & {
      */
     withLock?: <Result>(callback: () => Promise<Result>) => Promise<Result>;
 };
-type SnapKeyringOptions = Omit<SnapKeyringV1Options, 'callbacks'> & {
+type SnapKeyringOptions = {
+    messenger: SnapKeyringMessenger;
     callbacks: SnapKeyringCallbacks;
+    isAnyAccountTypeAllowed?: boolean;
 };
 /**
  * Checks if a given keyring is a Snap keyring (v2).
@@ -129,17 +145,15 @@ type SnapKeyringOptions = Omit<SnapKeyringV1Options, 'callbacks'> & {
  */
 export declare function isSnapKeyring(keyring: Keyring): keyring is SnapKeyring;
 /**
- * Per-snap keyring wrapper that implements `Keyring`.
+ * Per-snap keyring that implements `Keyring` (v2).
  *
- * Extends `SnapKeyringV1` — the v1 event-driven flow (account lifecycle,
- * request handling, asset events) is inherited. This class adds the
- * `KeyringV2` batch interface (`createAccounts`, `deleteAccount`, etc.) and
- * owns the `capabilities` property.
- *
- * The `KeyringAccountRegistry`, snap client, and messenger are all inherited
- * from `SnapKeyringV1` so there is no duplicated state.
+ * Owns the account registry and messenger. For v1 snaps (those that do not
+ * declare `endowment:keyring` capabilities in their manifest), a
+ * {@link SnapKeyringV1} instance is created on `deserialize` and held under
+ * {@link SnapKeyring.v1}. V2 snaps have `v1 === undefined` and communicate
+ * directly through the v2 client without the `{ pending, result }` envelope.
  */
-export declare class SnapKeyring extends SnapKeyringV1 implements Keyring {
+export declare class SnapKeyring implements Keyring {
     #private;
     readonly type: "snap";
     static readonly type: "snap";
@@ -148,12 +162,38 @@ export declare class SnapKeyring extends SnapKeyringV1 implements Keyring {
      * by the parent when snap metadata becomes available.
      */
     capabilities: KeyringCapabilities;
-    constructor(options: SnapKeyringOptions);
+    constructor({ messenger, callbacks, isAnyAccountTypeAllowed, }: SnapKeyringOptions);
+    /**
+     * Gets the v1 instance for this snap, or `undefined` if the snap is v2-only.
+     *
+     * @returns The v1 instance, or `undefined` if the snap is v2-only.
+     *
+     * Use this to make v1 calls explicit:
+     * ```ts
+     * keyring.v1?.signTransaction(account, tx);
+     * ```
+     */
+    get v1(): SnapKeyringV1 | undefined;
+    /**
+     * The snap ID this instance is scoped to.
+     *
+     * @returns The snap ID.
+     * @throws If the keyring has not been initialized yet.
+     */
+    get snapId(): SnapId;
+    /**
+     * Bind this keyring to a snap ID and initialize the v2 client.
+     *
+     * Idempotent for the same `snapId`; throws if called again with a different
+     * one to prevent accidentally swapping a keyring's identity.
+     *
+     * @param snapId - The snap ID to bind to.
+     */
+    protected bindSnapId(snapId: SnapId): void;
     /**
-     * Destroy this keyring.
+     * Destroy this keyring, rejecting any pending v1 requests.
      *
-     * Delegates to the parent `SnapKeyringV1.destroy()` to reject any pending
-     * requests inherited from the v1 flow.
+     * @returns A promise that resolves when the keyring is destroyed.
      */
     destroy(): Promise<void>;
     /**
@@ -197,12 +237,13 @@ export declare class SnapKeyring extends SnapKeyringV1 implements Keyring {
     /**
      * Submits a request to the keyring.
      *
-     * Validates that the account belongs to this wrapper, then delegates
-     * to the inherited `submitSnapRequest` for the full request lifecycle
-     * (sync / async / redirect).
+     * For v1 snaps (those without declared capabilities), delegates to the v1
+     * event-driven flow that handles the `{ pending, result }` envelope.
+     * For v2 snaps, calls the snap directly via the v2 client which returns
+     * `Json` with no envelope.
      *
      * @param request - The keyring request to submit.
-     * @param request.id - The request ID (unused — a fresh ID is generated internally).
+     * @param request.id - The request ID.
      * @param request.origin - The sender origin.
      * @param request.scope - The CAIP-2 chain ID.
      * @param request.account - The account ID.
@@ -287,9 +328,11 @@ export declare class SnapKeyring extends SnapKeyringV1 implements Keyring {
     /**
      * Restore this keyring from a serialized state.
      *
-     * Validates the payload (accepting both v1 and v2 accounts), migrates any
-     * v1 accounts to v2, then replaces the registry. If validation fails, the
-     * existing registry is left untouched.
+     * Validates the payload (accepting both v1 and v2 account shapes), migrates
+     * any v1 accounts to v2, then replaces the registry. Also determines whether
+     * the snap is v1 or v2 by reading its manifest capabilities: if no
+     * capabilities are declared, a {@link SnapKeyringV1} instance is created and
+     * held under {@link SnapKeyring.v1}.
      *
      * @param state - The state to deserialize.
      * @returns A promise that resolves when deserialization is complete.

package/dist/v2/SnapKeyring.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"SnapKeyring.d.cts","sourceRoot":"","sources":["../../src/v2/SnapKeyring.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAE5D,OAAO,KAAK,EACV,oBAAoB,EACpB,OAAO,EACP,mBAAmB,EACpB,iCAAiC;AAElC,OAAO,KAAK,EAAE,SAAS,EAAE,gCAAgC;AAEzD,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAEnD,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAS5C,OAAO,EAAE,aAAa,EAAE,6BAAyB;AACjD,OAAO,KAAK,EAEV,sBAAsB,EACtB,oBAAoB,EACrB,6BAAyB;AAG1B;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMjC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,GAAG;IAC1D;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CACzE,CAAC;AAEF,KAAK,kBAAkB,GAAG,IAAI,CAAC,oBAAoB,EAAE,WAAW,CAAC,GAAG;IAClE,SAAS,EAAE,oBAAoB,CAAC;CACjC,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,WAAW,CAEtE;AAED;;;;;;;;;;GAUG;AACH,qBAAa,WAAY,SAAQ,aAAc,YAAW,OAAO;;IAkB/D,QAAQ,CAAC,IAAI,SAAkC;IAE/C,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAkC;IAEtD;;;OAGG;IACH,YAAY,EAAE,mBAAmB,CAAC;gBAEtB,OAAO,EAAE,kBAAkB;IAWvC;;;;;OAKG;IACY,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA2BvC;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAI9C;;;;;OAKG;IACG,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC;IAU/D;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAClB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,cAAc,EAAE,CAAC;IA6E5B;;;;;;;OAOG;IACG,aAAa,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBxD;;;;;;;;;;;;;;;;OAgBG;IACG,aAAa,CAAC,OAAO,EAAE;QAC3B,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,SAAS,CAAC;QACnB,OAAO,EAAE;YACP,MAAM,EAAE,MAAM,CAAC;YACf,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;SACxC,CAAC;KACH,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBjB;;;;;;;;OAQG;IACH,UAAU,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI;IAQzC;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO;IASrC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO;IAIlC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,EAAE,SAAS,GAAG,cAAc,GAAG,SAAS;IAIxD;;;;;;;;OAQG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAc5D;;;;;;;;OAQG;IACH,QAAQ,IAAI,cAAc,EAAE;IAI5B;;;;;;;;OAQG;IACG,SAAS,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAY5C;;;;;;;;;OASG;IACG,WAAW,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAkC9C"}
+{"version":3,"file":"SnapKeyring.d.cts","sourceRoot":"","sources":["../../src/v2/SnapKeyring.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAE5D,OAAO,KAAK,EACV,oBAAoB,EACpB,OAAO,EACP,mBAAmB,EACpB,iCAAiC;AAIlC,OAAO,KAAK,EAAE,SAAS,EAAE,gCAAgC;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAEnD,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAU5C,OAAO,KAAK,EAAE,oBAAoB,EAAE,oCAAgC;AACpE,OAAO,EAAE,aAAa,EAAE,6BAAyB;AACjD,OAAO,KAAK,EAAiB,sBAAsB,EAAE,6BAAyB;AAG9E;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,mBAE/B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eA0FjC;;;eAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAHH;;;eAGG;;;;;EAvFH,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,GAAG;IAC1D;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CACzE,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB,SAAS,EAAE,oBAAoB,CAAC;IAChC,SAAS,EAAE,oBAAoB,CAAC;IAChC,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC,CAAC;AAWF;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,WAAW,CAEtE;AAED;;;;;;;;GAQG;AACH,qBAAa,WAAY,YAAW,OAAO;;IA8BzC,QAAQ,CAAC,IAAI,SAAkC;IAE/C,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAkC;IAEtD;;;OAGG;IACH,YAAY,EAAE,mBAAmB,CAAC;gBAEtB,EACV,SAAS,EACT,SAAS,EACT,uBAA+B,GAChC,EAAE,kBAAkB;IAWrB;;;;;;;;;OASG;IACH,IAAI,EAAE,IAAI,aAAa,GAAG,SAAS,CAElC;IAED;;;;;OAKG;IACH,IAAI,MAAM,IAAI,MAAM,CAQnB;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IA+B1C;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA4B9B;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAK9C;;;;;OAKG;IACG,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC;IAW/D;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAClB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,cAAc,EAAE,CAAC;IAuF5B;;;;;;;OAOG;IACG,aAAa,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBxD;;;;;;;;;;;;;;;;;OAiBG;IACG,aAAa,CAAC,OAAO,EAAE;QAC3B,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,SAAS,CAAC;QACnB,OAAO,EAAE;YACP,MAAM,EAAE,MAAM,CAAC;YACf,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;SACxC,CAAC;KACH,GAAG,OAAO,CAAC,IAAI,CAAC;IAiCjB;;;;;;;;OAQG;IACH,UAAU,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI;IAQzC;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO;IASrC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO;IAIlC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,EAAE,SAAS,GAAG,cAAc,GAAG,SAAS;IAIxD;;;;;;;;OAQG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAc5D;;;;;;;;OAQG;IACH,QAAQ,IAAI,cAAc,EAAE;IAI5B;;;;;;;;OAQG;IACG,SAAS,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAY5C;;;;;;;;;;;OAWG;IACG,WAAW,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CA0G9C"}

package/dist/v2/SnapKeyring.d.mts

@@ -1,10 +1,18 @@
 import type { KeyringAccount } from "@metamask/keyring-api";
 import type { CreateAccountOptions, Keyring, KeyringCapabilities } from "@metamask/keyring-api/v2";
 import type { AccountId } from "@metamask/keyring-utils";
+import type { SnapId } from "@metamask/snaps-sdk";
 import type { Infer } from "@metamask/superstruct";
 import type { Json } from "@metamask/utils";
+import type { SnapKeyringMessenger } from "../SnapKeyringMessenger.mjs";
 import { SnapKeyringV1 } from "../SnapKeyringV1.mjs";
-import type { SnapKeyringV1Callbacks, SnapKeyringV1Options } from "../SnapKeyringV1.mjs";
+import type { SnapKeyringV1Callbacks } from "../SnapKeyringV1.mjs";
+/**
+ * Default, empty capabilities used until the snap manifest is read on
+ * `deserialize`. Typed (no cast) so that adding a new required
+ * `KeyringCapabilities` field surfaces here as a compile error.
+ */
+export declare const EMPTY_CAPABILITIES: KeyringCapabilities;
 /**
  * Superstruct schema for {@link SnapKeyringState}.
  *
@@ -46,7 +54,10 @@ export declare const SnapKeyringStateStruct: import("@metamask/superstruct").Str
                 type: "private-key";
             } | {
                 type: "custom";
-            };
+            }; /**
+             * V1 instance, present only when the snap does not declare v2 capabilities.
+             * Created on `deserialize()` after reading the snap manifest.
+             */
             exportable?: boolean;
         };
         methods: string[];
@@ -86,7 +97,10 @@ export declare const SnapKeyringStateStruct: import("@metamask/superstruct").Str
                 type: "private-key";
             } | {
                 type: "custom";
-            };
+            }; /**
+             * V1 instance, present only when the snap does not declare v2 capabilities.
+             * Created on `deserialize()` after reading the snap manifest.
+             */
             exportable?: boolean;
         };
         methods: string[];
@@ -118,8 +132,10 @@ export type SnapKeyringCallbacks = SnapKeyringV1Callbacks & {
      */
     withLock?: <Result>(callback: () => Promise<Result>) => Promise<Result>;
 };
-type SnapKeyringOptions = Omit<SnapKeyringV1Options, 'callbacks'> & {
+type SnapKeyringOptions = {
+    messenger: SnapKeyringMessenger;
     callbacks: SnapKeyringCallbacks;
+    isAnyAccountTypeAllowed?: boolean;
 };
 /**
  * Checks if a given keyring is a Snap keyring (v2).
@@ -129,17 +145,15 @@ type SnapKeyringOptions = Omit<SnapKeyringV1Options, 'callbacks'> & {
  */
 export declare function isSnapKeyring(keyring: Keyring): keyring is SnapKeyring;
 /**
- * Per-snap keyring wrapper that implements `Keyring`.
+ * Per-snap keyring that implements `Keyring` (v2).
  *
- * Extends `SnapKeyringV1` — the v1 event-driven flow (account lifecycle,
- * request handling, asset events) is inherited. This class adds the
- * `KeyringV2` batch interface (`createAccounts`, `deleteAccount`, etc.) and
- * owns the `capabilities` property.
- *
- * The `KeyringAccountRegistry`, snap client, and messenger are all inherited
- * from `SnapKeyringV1` so there is no duplicated state.
+ * Owns the account registry and messenger. For v1 snaps (those that do not
+ * declare `endowment:keyring` capabilities in their manifest), a
+ * {@link SnapKeyringV1} instance is created on `deserialize` and held under
+ * {@link SnapKeyring.v1}. V2 snaps have `v1 === undefined` and communicate
+ * directly through the v2 client without the `{ pending, result }` envelope.
  */
-export declare class SnapKeyring extends SnapKeyringV1 implements Keyring {
+export declare class SnapKeyring implements Keyring {
     #private;
     readonly type: "snap";
     static readonly type: "snap";
@@ -148,12 +162,38 @@ export declare class SnapKeyring extends SnapKeyringV1 implements Keyring {
      * by the parent when snap metadata becomes available.
      */
     capabilities: KeyringCapabilities;
-    constructor(options: SnapKeyringOptions);
+    constructor({ messenger, callbacks, isAnyAccountTypeAllowed, }: SnapKeyringOptions);
+    /**
+     * Gets the v1 instance for this snap, or `undefined` if the snap is v2-only.
+     *
+     * @returns The v1 instance, or `undefined` if the snap is v2-only.
+     *
+     * Use this to make v1 calls explicit:
+     * ```ts
+     * keyring.v1?.signTransaction(account, tx);
+     * ```
+     */
+    get v1(): SnapKeyringV1 | undefined;
+    /**
+     * The snap ID this instance is scoped to.
+     *
+     * @returns The snap ID.
+     * @throws If the keyring has not been initialized yet.
+     */
+    get snapId(): SnapId;
+    /**
+     * Bind this keyring to a snap ID and initialize the v2 client.
+     *
+     * Idempotent for the same `snapId`; throws if called again with a different
+     * one to prevent accidentally swapping a keyring's identity.
+     *
+     * @param snapId - The snap ID to bind to.
+     */
+    protected bindSnapId(snapId: SnapId): void;
     /**
-     * Destroy this keyring.
+     * Destroy this keyring, rejecting any pending v1 requests.
      *
-     * Delegates to the parent `SnapKeyringV1.destroy()` to reject any pending
-     * requests inherited from the v1 flow.
+     * @returns A promise that resolves when the keyring is destroyed.
      */
     destroy(): Promise<void>;
     /**
@@ -197,12 +237,13 @@ export declare class SnapKeyring extends SnapKeyringV1 implements Keyring {
     /**
      * Submits a request to the keyring.
      *
-     * Validates that the account belongs to this wrapper, then delegates
-     * to the inherited `submitSnapRequest` for the full request lifecycle
-     * (sync / async / redirect).
+     * For v1 snaps (those without declared capabilities), delegates to the v1
+     * event-driven flow that handles the `{ pending, result }` envelope.
+     * For v2 snaps, calls the snap directly via the v2 client which returns
+     * `Json` with no envelope.
      *
      * @param request - The keyring request to submit.
-     * @param request.id - The request ID (unused — a fresh ID is generated internally).
+     * @param request.id - The request ID.
      * @param request.origin - The sender origin.
      * @param request.scope - The CAIP-2 chain ID.
      * @param request.account - The account ID.
@@ -287,9 +328,11 @@ export declare class SnapKeyring extends SnapKeyringV1 implements Keyring {
     /**
      * Restore this keyring from a serialized state.
      *
-     * Validates the payload (accepting both v1 and v2 accounts), migrates any
-     * v1 accounts to v2, then replaces the registry. If validation fails, the
-     * existing registry is left untouched.
+     * Validates the payload (accepting both v1 and v2 account shapes), migrates
+     * any v1 accounts to v2, then replaces the registry. Also determines whether
+     * the snap is v1 or v2 by reading its manifest capabilities: if no
+     * capabilities are declared, a {@link SnapKeyringV1} instance is created and
+     * held under {@link SnapKeyring.v1}.
      *
      * @param state - The state to deserialize.
      * @returns A promise that resolves when deserialization is complete.

package/dist/v2/SnapKeyring.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"SnapKeyring.d.mts","sourceRoot":"","sources":["../../src/v2/SnapKeyring.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAE5D,OAAO,KAAK,EACV,oBAAoB,EACpB,OAAO,EACP,mBAAmB,EACpB,iCAAiC;AAElC,OAAO,KAAK,EAAE,SAAS,EAAE,gCAAgC;AAEzD,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAEnD,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAS5C,OAAO,EAAE,aAAa,EAAE,6BAAyB;AACjD,OAAO,KAAK,EAEV,sBAAsB,EACtB,oBAAoB,EACrB,6BAAyB;AAG1B;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMjC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,GAAG;IAC1D;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CACzE,CAAC;AAEF,KAAK,kBAAkB,GAAG,IAAI,CAAC,oBAAoB,EAAE,WAAW,CAAC,GAAG;IAClE,SAAS,EAAE,oBAAoB,CAAC;CACjC,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,WAAW,CAEtE;AAED;;;;;;;;;;GAUG;AACH,qBAAa,WAAY,SAAQ,aAAc,YAAW,OAAO;;IAkB/D,QAAQ,CAAC,IAAI,SAAkC;IAE/C,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAkC;IAEtD;;;OAGG;IACH,YAAY,EAAE,mBAAmB,CAAC;gBAEtB,OAAO,EAAE,kBAAkB;IAWvC;;;;;OAKG;IACY,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA2BvC;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAI9C;;;;;OAKG;IACG,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC;IAU/D;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAClB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,cAAc,EAAE,CAAC;IA6E5B;;;;;;;OAOG;IACG,aAAa,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBxD;;;;;;;;;;;;;;;;OAgBG;IACG,aAAa,CAAC,OAAO,EAAE;QAC3B,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,SAAS,CAAC;QACnB,OAAO,EAAE;YACP,MAAM,EAAE,MAAM,CAAC;YACf,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;SACxC,CAAC;KACH,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBjB;;;;;;;;OAQG;IACH,UAAU,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI;IAQzC;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO;IASrC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO;IAIlC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,EAAE,SAAS,GAAG,cAAc,GAAG,SAAS;IAIxD;;;;;;;;OAQG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAc5D;;;;;;;;OAQG;IACH,QAAQ,IAAI,cAAc,EAAE;IAI5B;;;;;;;;OAQG;IACG,SAAS,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAY5C;;;;;;;;;OASG;IACG,WAAW,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAkC9C"}
+{"version":3,"file":"SnapKeyring.d.mts","sourceRoot":"","sources":["../../src/v2/SnapKeyring.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAE5D,OAAO,KAAK,EACV,oBAAoB,EACpB,OAAO,EACP,mBAAmB,EACpB,iCAAiC;AAIlC,OAAO,KAAK,EAAE,SAAS,EAAE,gCAAgC;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAEnD,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAU5C,OAAO,KAAK,EAAE,oBAAoB,EAAE,oCAAgC;AACpE,OAAO,EAAE,aAAa,EAAE,6BAAyB;AACjD,OAAO,KAAK,EAAiB,sBAAsB,EAAE,6BAAyB;AAG9E;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,mBAE/B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eA0FjC;;;eAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAHH;;;eAGG;;;;;EAvFH,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,GAAG;IAC1D;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CACzE,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB,SAAS,EAAE,oBAAoB,CAAC;IAChC,SAAS,EAAE,oBAAoB,CAAC;IAChC,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC,CAAC;AAWF;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,WAAW,CAEtE;AAED;;;;;;;;GAQG;AACH,qBAAa,WAAY,YAAW,OAAO;;IA8BzC,QAAQ,CAAC,IAAI,SAAkC;IAE/C,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAkC;IAEtD;;;OAGG;IACH,YAAY,EAAE,mBAAmB,CAAC;gBAEtB,EACV,SAAS,EACT,SAAS,EACT,uBAA+B,GAChC,EAAE,kBAAkB;IAWrB;;;;;;;;;OASG;IACH,IAAI,EAAE,IAAI,aAAa,GAAG,SAAS,CAElC;IAED;;;;;OAKG;IACH,IAAI,MAAM,IAAI,MAAM,CAQnB;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IA+B1C;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA4B9B;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAK9C;;;;;OAKG;IACG,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC;IAW/D;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAClB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,cAAc,EAAE,CAAC;IAuF5B;;;;;;;OAOG;IACG,aAAa,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBxD;;;;;;;;;;;;;;;;;OAiBG;IACG,aAAa,CAAC,OAAO,EAAE;QAC3B,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,SAAS,CAAC;QACnB,OAAO,EAAE;YACP,MAAM,EAAE,MAAM,CAAC;YACf,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;SACxC,CAAC;KACH,GAAG,OAAO,CAAC,IAAI,CAAC;IAiCjB;;;;;;;;OAQG;IACH,UAAU,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI;IAQzC;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO;IASrC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO;IAIlC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,EAAE,SAAS,GAAG,cAAc,GAAG,SAAS;IAIxD;;;;;;;;OAQG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAc5D;;;;;;;;OAQG;IACH,QAAQ,IAAI,cAAc,EAAE;IAI5B;;;;;;;;OAQG;IACG,SAAS,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAY5C;;;;;;;;;;;OAWG;IACG,WAAW,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CA0G9C"}