@metamask/keyring-api 21.2.0 → 21.3.0

package/dist/api/v2/keyring-type.cjs

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyringType = void 0;
+/**
+ * Enum representing the different types of keyrings supported.
+ */
+var KeyringType;
+(function (KeyringType) {
+    /**
+     * Represents a hierarchical deterministic (HD) keyring.
+     */
+    KeyringType["Hd"] = "hd";
+    /**
+     * Represents a keyring that directly stores private keys.
+     */
+    KeyringType["PrivateKey"] = "private-key";
+    /**
+     * Represents a keyring that implements the QR protocol.
+     *
+     * See: https://eips.ethereum.org/EIPS/eip-4527
+     */
+    KeyringType["Qr"] = "qr";
+    /**
+     * Represents keyring backed by a Snap.
+     */
+    KeyringType["Snap"] = "snap";
+    /**
+     * Represents keyring backed by a Ledger hardware wallet.
+     */
+    KeyringType["Ledger"] = "ledger";
+    /**
+     * Represents keyring backed by a Lattice hardware wallet.
+     */
+    KeyringType["Lattice"] = "lattice";
+    /**
+     * Represents keyring backed by a Trezor hardware wallet.
+     */
+    KeyringType["Trezor"] = "trezor";
+    /**
+     * Represents keyring backed by a OneKey hardware wallet.
+     */
+    KeyringType["OneKey"] = "onekey";
+})(KeyringType || (exports.KeyringType = KeyringType = {}));
+//# sourceMappingURL=keyring-type.cjs.map

package/dist/api/v2/keyring-type.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring-type.cjs","sourceRoot":"","sources":["../../../src/api/v2/keyring-type.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,WA0CX;AA1CD,WAAY,WAAW;IACrB;;OAEG;IACH,wBAAS,CAAA;IAET;;OAEG;IACH,yCAA0B,CAAA;IAE1B;;;;OAIG;IACH,wBAAS,CAAA;IAET;;OAEG;IACH,4BAAa,CAAA;IAEb;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,kCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,gCAAiB,CAAA;AACnB,CAAC,EA1CW,WAAW,2BAAX,WAAW,QA0CtB","sourcesContent":["/**\n * Enum representing the different types of keyrings supported.\n */\nexport enum KeyringType {\n  /**\n   * Represents a hierarchical deterministic (HD) keyring.\n   */\n  Hd = 'hd',\n\n  /**\n   * Represents a keyring that directly stores private keys.\n   */\n  PrivateKey = 'private-key',\n\n  /**\n   * Represents a keyring that implements the QR protocol.\n   *\n   * See: https://eips.ethereum.org/EIPS/eip-4527\n   */\n  Qr = 'qr',\n\n  /**\n   * Represents keyring backed by a Snap.\n   */\n  Snap = 'snap',\n\n  /**\n   * Represents keyring backed by a Ledger hardware wallet.\n   */\n  Ledger = 'ledger',\n\n  /**\n   * Represents keyring backed by a Lattice hardware wallet.\n   */\n  Lattice = 'lattice',\n\n  /**\n   * Represents keyring backed by a Trezor hardware wallet.\n   */\n  Trezor = 'trezor',\n\n  /**\n   * Represents keyring backed by a OneKey hardware wallet.\n   */\n  OneKey = 'onekey',\n}\n"]}

package/dist/api/v2/keyring-type.d.cts

@@ -0,0 +1,40 @@
+/**
+ * Enum representing the different types of keyrings supported.
+ */
+export declare enum KeyringType {
+    /**
+     * Represents a hierarchical deterministic (HD) keyring.
+     */
+    Hd = "hd",
+    /**
+     * Represents a keyring that directly stores private keys.
+     */
+    PrivateKey = "private-key",
+    /**
+     * Represents a keyring that implements the QR protocol.
+     *
+     * See: https://eips.ethereum.org/EIPS/eip-4527
+     */
+    Qr = "qr",
+    /**
+     * Represents keyring backed by a Snap.
+     */
+    Snap = "snap",
+    /**
+     * Represents keyring backed by a Ledger hardware wallet.
+     */
+    Ledger = "ledger",
+    /**
+     * Represents keyring backed by a Lattice hardware wallet.
+     */
+    Lattice = "lattice",
+    /**
+     * Represents keyring backed by a Trezor hardware wallet.
+     */
+    Trezor = "trezor",
+    /**
+     * Represents keyring backed by a OneKey hardware wallet.
+     */
+    OneKey = "onekey"
+}
+//# sourceMappingURL=keyring-type.d.cts.map

package/dist/api/v2/keyring-type.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring-type.d.cts","sourceRoot":"","sources":["../../../src/api/v2/keyring-type.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,WAAW;IACrB;;OAEG;IACH,EAAE,OAAO;IAET;;OAEG;IACH,UAAU,gBAAgB;IAE1B;;;;OAIG;IACH,EAAE,OAAO;IAET;;OAEG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,MAAM,WAAW;CAClB"}

package/dist/api/v2/keyring-type.d.mts

@@ -0,0 +1,40 @@
+/**
+ * Enum representing the different types of keyrings supported.
+ */
+export declare enum KeyringType {
+    /**
+     * Represents a hierarchical deterministic (HD) keyring.
+     */
+    Hd = "hd",
+    /**
+     * Represents a keyring that directly stores private keys.
+     */
+    PrivateKey = "private-key",
+    /**
+     * Represents a keyring that implements the QR protocol.
+     *
+     * See: https://eips.ethereum.org/EIPS/eip-4527
+     */
+    Qr = "qr",
+    /**
+     * Represents keyring backed by a Snap.
+     */
+    Snap = "snap",
+    /**
+     * Represents keyring backed by a Ledger hardware wallet.
+     */
+    Ledger = "ledger",
+    /**
+     * Represents keyring backed by a Lattice hardware wallet.
+     */
+    Lattice = "lattice",
+    /**
+     * Represents keyring backed by a Trezor hardware wallet.
+     */
+    Trezor = "trezor",
+    /**
+     * Represents keyring backed by a OneKey hardware wallet.
+     */
+    OneKey = "onekey"
+}
+//# sourceMappingURL=keyring-type.d.mts.map

package/dist/api/v2/keyring-type.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring-type.d.mts","sourceRoot":"","sources":["../../../src/api/v2/keyring-type.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,WAAW;IACrB;;OAEG;IACH,EAAE,OAAO;IAET;;OAEG;IACH,UAAU,gBAAgB;IAE1B;;;;OAIG;IACH,EAAE,OAAO;IAET;;OAEG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,MAAM,WAAW;CAClB"}

package/dist/api/v2/keyring-type.mjs

@@ -0,0 +1,41 @@
+/**
+ * Enum representing the different types of keyrings supported.
+ */
+export var KeyringType;
+(function (KeyringType) {
+    /**
+     * Represents a hierarchical deterministic (HD) keyring.
+     */
+    KeyringType["Hd"] = "hd";
+    /**
+     * Represents a keyring that directly stores private keys.
+     */
+    KeyringType["PrivateKey"] = "private-key";
+    /**
+     * Represents a keyring that implements the QR protocol.
+     *
+     * See: https://eips.ethereum.org/EIPS/eip-4527
+     */
+    KeyringType["Qr"] = "qr";
+    /**
+     * Represents keyring backed by a Snap.
+     */
+    KeyringType["Snap"] = "snap";
+    /**
+     * Represents keyring backed by a Ledger hardware wallet.
+     */
+    KeyringType["Ledger"] = "ledger";
+    /**
+     * Represents keyring backed by a Lattice hardware wallet.
+     */
+    KeyringType["Lattice"] = "lattice";
+    /**
+     * Represents keyring backed by a Trezor hardware wallet.
+     */
+    KeyringType["Trezor"] = "trezor";
+    /**
+     * Represents keyring backed by a OneKey hardware wallet.
+     */
+    KeyringType["OneKey"] = "onekey";
+})(KeyringType || (KeyringType = {}));
+//# sourceMappingURL=keyring-type.mjs.map

package/dist/api/v2/keyring-type.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring-type.mjs","sourceRoot":"","sources":["../../../src/api/v2/keyring-type.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,WA0CX;AA1CD,WAAY,WAAW;IACrB;;OAEG;IACH,wBAAS,CAAA;IAET;;OAEG;IACH,yCAA0B,CAAA;IAE1B;;;;OAIG;IACH,wBAAS,CAAA;IAET;;OAEG;IACH,4BAAa,CAAA;IAEb;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,kCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,gCAAiB,CAAA;AACnB,CAAC,EA1CW,WAAW,KAAX,WAAW,QA0CtB","sourcesContent":["/**\n * Enum representing the different types of keyrings supported.\n */\nexport enum KeyringType {\n  /**\n   * Represents a hierarchical deterministic (HD) keyring.\n   */\n  Hd = 'hd',\n\n  /**\n   * Represents a keyring that directly stores private keys.\n   */\n  PrivateKey = 'private-key',\n\n  /**\n   * Represents a keyring that implements the QR protocol.\n   *\n   * See: https://eips.ethereum.org/EIPS/eip-4527\n   */\n  Qr = 'qr',\n\n  /**\n   * Represents keyring backed by a Snap.\n   */\n  Snap = 'snap',\n\n  /**\n   * Represents keyring backed by a Ledger hardware wallet.\n   */\n  Ledger = 'ledger',\n\n  /**\n   * Represents keyring backed by a Lattice hardware wallet.\n   */\n  Lattice = 'lattice',\n\n  /**\n   * Represents keyring backed by a Trezor hardware wallet.\n   */\n  Trezor = 'trezor',\n\n  /**\n   * Represents keyring backed by a OneKey hardware wallet.\n   */\n  OneKey = 'onekey',\n}\n"]}

package/dist/api/v2/keyring.cjs

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=keyring.cjs.map

package/dist/api/v2/keyring.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring.cjs","sourceRoot":"","sources":["../../../src/api/v2/keyring.ts"],"names":[],"mappings":"","sourcesContent":["import type { AccountId } from '@metamask/keyring-utils';\nimport type { Json } from '@metamask/utils';\n\nimport type { CreateAccountOptions } from './create-account';\nimport type { ExportedAccount, ExportAccountOptions } from './export-account';\nimport type { KeyringCapabilities } from './keyring-capabilities';\nimport type { KeyringType } from './keyring-type';\nimport type { KeyringAccount } from '../account';\nimport type { KeyringRequest } from '../request';\n\n/**\n * The KeyringV2 interface defines methods for managing accounts and signing\n * requests. This interface unifies the existing EVM and Snap keyring interfaces\n * to provide a consistent API for all keyring type.\n *\n * This interface supports both EVM and non-EVM chains, and includes\n * account metadata needed for features like Multi-SRP and Backup and Sync.\n */\nexport type KeyringV2 = {\n  /**\n   * Type of the keyring.\n   */\n  type: `${KeyringType}`;\n\n  /**\n   * List of capabilities supported by the keyring.\n   */\n  capabilities: KeyringCapabilities;\n\n  /**\n   * Serialize the keyring state to a JSON object.\n   *\n   * @returns A promise that resolves to a JSON-serializable representation of\n   * the keyring state.\n   */\n  serialize(): Promise<Json>;\n\n  /**\n   * Restores the keyring state from a serialized JSON object.\n   *\n   * @param state - A JSON object representing a serialized keyring state.\n   * @returns A promise that resolves when the keyring state has been restored.\n   */\n  deserialize(state: Json): Promise<void>;\n\n  /**\n   * Initialize the keyring.\n   *\n   * This method is called after the constructor to allow the keyring to\n   * perform any necessary asynchronous initialization tasks.\n   *\n   * @returns A promise that resolves when initialization is complete.\n   */\n  init?(): Promise<void>;\n\n  /**\n   * Destroy the keyring.\n   *\n   * This method is called before the keyring is removed from the Keyring\n   * Controller, allowing the keyring to perform any necessary cleanup tasks.\n   *\n   * @returns A promise that resolves when cleanup is complete.\n   */\n  destroy?(): Promise<void>;\n\n  /**\n   * Returns all accounts managed by the keyring.\n   *\n   * @returns A promise that resolves to an array of all accounts managed by\n   * this keyring.\n   */\n  getAccounts(): Promise<KeyringAccount[]>;\n\n  /**\n   * Returns the account with the specified ID.\n   *\n   * @param accountId - ID of the account to retrieve.\n   * @returns A promise that resolves to the account with the given ID.\n   */\n  getAccount(accountId: AccountId): Promise<KeyringAccount>;\n\n  /**\n   * Creates one or more new accounts according to the provided options.\n   *\n   * Deterministic account creation MUST be idempotent, meaning that for\n   * deterministic algorithms, like BIP-44, calling this method with the same\n   * options should always return the same accounts, even if the accounts\n   * already exist in the keyring.\n   *\n   * @param options - Options describing how to create the account(s).\n   * @returns A promise that resolves to an array of the created account objects.\n   */\n  createAccounts(options: CreateAccountOptions): Promise<KeyringAccount[]>;\n\n  /**\n   * Deletes the account with the specified ID.\n   *\n   * @param accountId - ID of the account to delete.\n   * @returns A promise that resolves when the account has been deleted.\n   */\n  deleteAccount(accountId: AccountId): Promise<void>;\n\n  /**\n   * Exports the private key or secret material for the specified account.\n   *\n   * @param accountId - ID of the account to export.\n   * @param options - Optional export options.\n   * @returns A promise that resolves to the exported account data.\n   */\n  exportAccount?(\n    accountId: AccountId,\n    options?: ExportAccountOptions,\n  ): Promise<ExportedAccount>;\n\n  /**\n   * Submits a request to the keyring.\n   *\n   * @param request - The `KeyringRequest` object to submit.\n   * @returns A promise that resolves to the response for the request.\n   */\n  submitRequest(request: KeyringRequest): Promise<Json>;\n};\n"]}

package/dist/api/v2/keyring.d.cts

@@ -0,0 +1,107 @@
+import type { AccountId } from "@metamask/keyring-utils";
+import type { Json } from "@metamask/utils";
+import type { CreateAccountOptions } from "./create-account/index.cjs";
+import type { ExportedAccount, ExportAccountOptions } from "./export-account/index.cjs";
+import type { KeyringCapabilities } from "./keyring-capabilities.cjs";
+import type { KeyringType } from "./keyring-type.cjs";
+import type { KeyringAccount } from "../account.cjs";
+import type { KeyringRequest } from "../request.cjs";
+/**
+ * The KeyringV2 interface defines methods for managing accounts and signing
+ * requests. This interface unifies the existing EVM and Snap keyring interfaces
+ * to provide a consistent API for all keyring type.
+ *
+ * This interface supports both EVM and non-EVM chains, and includes
+ * account metadata needed for features like Multi-SRP and Backup and Sync.
+ */
+export type KeyringV2 = {
+    /**
+     * Type of the keyring.
+     */
+    type: `${KeyringType}`;
+    /**
+     * List of capabilities supported by the keyring.
+     */
+    capabilities: KeyringCapabilities;
+    /**
+     * Serialize the keyring state to a JSON object.
+     *
+     * @returns A promise that resolves to a JSON-serializable representation of
+     * the keyring state.
+     */
+    serialize(): Promise<Json>;
+    /**
+     * Restores the keyring state from a serialized JSON object.
+     *
+     * @param state - A JSON object representing a serialized keyring state.
+     * @returns A promise that resolves when the keyring state has been restored.
+     */
+    deserialize(state: Json): Promise<void>;
+    /**
+     * Initialize the keyring.
+     *
+     * This method is called after the constructor to allow the keyring to
+     * perform any necessary asynchronous initialization tasks.
+     *
+     * @returns A promise that resolves when initialization is complete.
+     */
+    init?(): Promise<void>;
+    /**
+     * Destroy the keyring.
+     *
+     * This method is called before the keyring is removed from the Keyring
+     * Controller, allowing the keyring to perform any necessary cleanup tasks.
+     *
+     * @returns A promise that resolves when cleanup is complete.
+     */
+    destroy?(): Promise<void>;
+    /**
+     * Returns all accounts managed by the keyring.
+     *
+     * @returns A promise that resolves to an array of all accounts managed by
+     * this keyring.
+     */
+    getAccounts(): Promise<KeyringAccount[]>;
+    /**
+     * Returns the account with the specified ID.
+     *
+     * @param accountId - ID of the account to retrieve.
+     * @returns A promise that resolves to the account with the given ID.
+     */
+    getAccount(accountId: AccountId): Promise<KeyringAccount>;
+    /**
+     * Creates one or more new accounts according to the provided options.
+     *
+     * Deterministic account creation MUST be idempotent, meaning that for
+     * deterministic algorithms, like BIP-44, calling this method with the same
+     * options should always return the same accounts, even if the accounts
+     * already exist in the keyring.
+     *
+     * @param options - Options describing how to create the account(s).
+     * @returns A promise that resolves to an array of the created account objects.
+     */
+    createAccounts(options: CreateAccountOptions): Promise<KeyringAccount[]>;
+    /**
+     * Deletes the account with the specified ID.
+     *
+     * @param accountId - ID of the account to delete.
+     * @returns A promise that resolves when the account has been deleted.
+     */
+    deleteAccount(accountId: AccountId): Promise<void>;
+    /**
+     * Exports the private key or secret material for the specified account.
+     *
+     * @param accountId - ID of the account to export.
+     * @param options - Optional export options.
+     * @returns A promise that resolves to the exported account data.
+     */
+    exportAccount?(accountId: AccountId, options?: ExportAccountOptions): Promise<ExportedAccount>;
+    /**
+     * Submits a request to the keyring.
+     *
+     * @param request - The `KeyringRequest` object to submit.
+     * @returns A promise that resolves to the response for the request.
+     */
+    submitRequest(request: KeyringRequest): Promise<Json>;
+};
+//# sourceMappingURL=keyring.d.cts.map

package/dist/api/v2/keyring.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring.d.cts","sourceRoot":"","sources":["../../../src/api/v2/keyring.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,gCAAgC;AACzD,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C,OAAO,KAAK,EAAE,oBAAoB,EAAE,mCAAyB;AAC7D,OAAO,KAAK,EAAE,eAAe,EAAE,oBAAoB,EAAE,mCAAyB;AAC9E,OAAO,KAAK,EAAE,mBAAmB,EAAE,mCAA+B;AAClE,OAAO,KAAK,EAAE,WAAW,EAAE,2BAAuB;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,uBAAmB;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,uBAAmB;AAEjD;;;;;;;GAOG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,GAAG,WAAW,EAAE,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,mBAAmB,CAAC;IAElC;;;;;OAKG;IACH,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B;;;;;OAKG;IACH,WAAW,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;;;;;;OAOG;IACH,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;;;;OAKG;IACH,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAEzC;;;;;OAKG;IACH,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAE1D;;;;;;;;;;OAUG;IACH,cAAc,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAEzE;;;;;OAKG;IACH,aAAa,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;;;;;OAMG;IACH,aAAa,CAAC,CACZ,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,eAAe,CAAC,CAAC;IAE5B;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvD,CAAC"}

package/dist/api/v2/keyring.d.mts

@@ -0,0 +1,107 @@
+import type { AccountId } from "@metamask/keyring-utils";
+import type { Json } from "@metamask/utils";
+import type { CreateAccountOptions } from "./create-account/index.mjs";
+import type { ExportedAccount, ExportAccountOptions } from "./export-account/index.mjs";
+import type { KeyringCapabilities } from "./keyring-capabilities.mjs";
+import type { KeyringType } from "./keyring-type.mjs";
+import type { KeyringAccount } from "../account.mjs";
+import type { KeyringRequest } from "../request.mjs";
+/**
+ * The KeyringV2 interface defines methods for managing accounts and signing
+ * requests. This interface unifies the existing EVM and Snap keyring interfaces
+ * to provide a consistent API for all keyring type.
+ *
+ * This interface supports both EVM and non-EVM chains, and includes
+ * account metadata needed for features like Multi-SRP and Backup and Sync.
+ */
+export type KeyringV2 = {
+    /**
+     * Type of the keyring.
+     */
+    type: `${KeyringType}`;
+    /**
+     * List of capabilities supported by the keyring.
+     */
+    capabilities: KeyringCapabilities;
+    /**
+     * Serialize the keyring state to a JSON object.
+     *
+     * @returns A promise that resolves to a JSON-serializable representation of
+     * the keyring state.
+     */
+    serialize(): Promise<Json>;
+    /**
+     * Restores the keyring state from a serialized JSON object.
+     *
+     * @param state - A JSON object representing a serialized keyring state.
+     * @returns A promise that resolves when the keyring state has been restored.
+     */
+    deserialize(state: Json): Promise<void>;
+    /**
+     * Initialize the keyring.
+     *
+     * This method is called after the constructor to allow the keyring to
+     * perform any necessary asynchronous initialization tasks.
+     *
+     * @returns A promise that resolves when initialization is complete.
+     */
+    init?(): Promise<void>;
+    /**
+     * Destroy the keyring.
+     *
+     * This method is called before the keyring is removed from the Keyring
+     * Controller, allowing the keyring to perform any necessary cleanup tasks.
+     *
+     * @returns A promise that resolves when cleanup is complete.
+     */
+    destroy?(): Promise<void>;
+    /**
+     * Returns all accounts managed by the keyring.
+     *
+     * @returns A promise that resolves to an array of all accounts managed by
+     * this keyring.
+     */
+    getAccounts(): Promise<KeyringAccount[]>;
+    /**
+     * Returns the account with the specified ID.
+     *
+     * @param accountId - ID of the account to retrieve.
+     * @returns A promise that resolves to the account with the given ID.
+     */
+    getAccount(accountId: AccountId): Promise<KeyringAccount>;
+    /**
+     * Creates one or more new accounts according to the provided options.
+     *
+     * Deterministic account creation MUST be idempotent, meaning that for
+     * deterministic algorithms, like BIP-44, calling this method with the same
+     * options should always return the same accounts, even if the accounts
+     * already exist in the keyring.
+     *
+     * @param options - Options describing how to create the account(s).
+     * @returns A promise that resolves to an array of the created account objects.
+     */
+    createAccounts(options: CreateAccountOptions): Promise<KeyringAccount[]>;
+    /**
+     * Deletes the account with the specified ID.
+     *
+     * @param accountId - ID of the account to delete.
+     * @returns A promise that resolves when the account has been deleted.
+     */
+    deleteAccount(accountId: AccountId): Promise<void>;
+    /**
+     * Exports the private key or secret material for the specified account.
+     *
+     * @param accountId - ID of the account to export.
+     * @param options - Optional export options.
+     * @returns A promise that resolves to the exported account data.
+     */
+    exportAccount?(accountId: AccountId, options?: ExportAccountOptions): Promise<ExportedAccount>;
+    /**
+     * Submits a request to the keyring.
+     *
+     * @param request - The `KeyringRequest` object to submit.
+     * @returns A promise that resolves to the response for the request.
+     */
+    submitRequest(request: KeyringRequest): Promise<Json>;
+};
+//# sourceMappingURL=keyring.d.mts.map

package/dist/api/v2/keyring.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring.d.mts","sourceRoot":"","sources":["../../../src/api/v2/keyring.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,gCAAgC;AACzD,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C,OAAO,KAAK,EAAE,oBAAoB,EAAE,mCAAyB;AAC7D,OAAO,KAAK,EAAE,eAAe,EAAE,oBAAoB,EAAE,mCAAyB;AAC9E,OAAO,KAAK,EAAE,mBAAmB,EAAE,mCAA+B;AAClE,OAAO,KAAK,EAAE,WAAW,EAAE,2BAAuB;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,uBAAmB;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,uBAAmB;AAEjD;;;;;;;GAOG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,GAAG,WAAW,EAAE,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,mBAAmB,CAAC;IAElC;;;;;OAKG;IACH,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B;;;;;OAKG;IACH,WAAW,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;;;;;;OAOG;IACH,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;;;;OAKG;IACH,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAEzC;;;;;OAKG;IACH,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAE1D;;;;;;;;;;OAUG;IACH,cAAc,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAEzE;;;;;OAKG;IACH,aAAa,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;;;;;OAMG;IACH,aAAa,CAAC,CACZ,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,eAAe,CAAC,CAAC;IAE5B;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvD,CAAC"}

package/dist/api/v2/keyring.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=keyring.mjs.map

package/dist/api/v2/keyring.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring.mjs","sourceRoot":"","sources":["../../../src/api/v2/keyring.ts"],"names":[],"mappings":"","sourcesContent":["import type { AccountId } from '@metamask/keyring-utils';\nimport type { Json } from '@metamask/utils';\n\nimport type { CreateAccountOptions } from './create-account';\nimport type { ExportedAccount, ExportAccountOptions } from './export-account';\nimport type { KeyringCapabilities } from './keyring-capabilities';\nimport type { KeyringType } from './keyring-type';\nimport type { KeyringAccount } from '../account';\nimport type { KeyringRequest } from '../request';\n\n/**\n * The KeyringV2 interface defines methods for managing accounts and signing\n * requests. This interface unifies the existing EVM and Snap keyring interfaces\n * to provide a consistent API for all keyring type.\n *\n * This interface supports both EVM and non-EVM chains, and includes\n * account metadata needed for features like Multi-SRP and Backup and Sync.\n */\nexport type KeyringV2 = {\n  /**\n   * Type of the keyring.\n   */\n  type: `${KeyringType}`;\n\n  /**\n   * List of capabilities supported by the keyring.\n   */\n  capabilities: KeyringCapabilities;\n\n  /**\n   * Serialize the keyring state to a JSON object.\n   *\n   * @returns A promise that resolves to a JSON-serializable representation of\n   * the keyring state.\n   */\n  serialize(): Promise<Json>;\n\n  /**\n   * Restores the keyring state from a serialized JSON object.\n   *\n   * @param state - A JSON object representing a serialized keyring state.\n   * @returns A promise that resolves when the keyring state has been restored.\n   */\n  deserialize(state: Json): Promise<void>;\n\n  /**\n   * Initialize the keyring.\n   *\n   * This method is called after the constructor to allow the keyring to\n   * perform any necessary asynchronous initialization tasks.\n   *\n   * @returns A promise that resolves when initialization is complete.\n   */\n  init?(): Promise<void>;\n\n  /**\n   * Destroy the keyring.\n   *\n   * This method is called before the keyring is removed from the Keyring\n   * Controller, allowing the keyring to perform any necessary cleanup tasks.\n   *\n   * @returns A promise that resolves when cleanup is complete.\n   */\n  destroy?(): Promise<void>;\n\n  /**\n   * Returns all accounts managed by the keyring.\n   *\n   * @returns A promise that resolves to an array of all accounts managed by\n   * this keyring.\n   */\n  getAccounts(): Promise<KeyringAccount[]>;\n\n  /**\n   * Returns the account with the specified ID.\n   *\n   * @param accountId - ID of the account to retrieve.\n   * @returns A promise that resolves to the account with the given ID.\n   */\n  getAccount(accountId: AccountId): Promise<KeyringAccount>;\n\n  /**\n   * Creates one or more new accounts according to the provided options.\n   *\n   * Deterministic account creation MUST be idempotent, meaning that for\n   * deterministic algorithms, like BIP-44, calling this method with the same\n   * options should always return the same accounts, even if the accounts\n   * already exist in the keyring.\n   *\n   * @param options - Options describing how to create the account(s).\n   * @returns A promise that resolves to an array of the created account objects.\n   */\n  createAccounts(options: CreateAccountOptions): Promise<KeyringAccount[]>;\n\n  /**\n   * Deletes the account with the specified ID.\n   *\n   * @param accountId - ID of the account to delete.\n   * @returns A promise that resolves when the account has been deleted.\n   */\n  deleteAccount(accountId: AccountId): Promise<void>;\n\n  /**\n   * Exports the private key or secret material for the specified account.\n   *\n   * @param accountId - ID of the account to export.\n   * @param options - Optional export options.\n   * @returns A promise that resolves to the exported account data.\n   */\n  exportAccount?(\n    accountId: AccountId,\n    options?: ExportAccountOptions,\n  ): Promise<ExportedAccount>;\n\n  /**\n   * Submits a request to the keyring.\n   *\n   * @param request - The `KeyringRequest` object to submit.\n   * @returns A promise that resolves to the response for the request.\n   */\n  submitRequest(request: KeyringRequest): Promise<Json>;\n};\n"]}

package/dist/api/v2/private-key.cjs

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExportPrivateKeyFormatStruct = exports.ImportPrivateKeyFormatStruct = exports.PrivateKeyEncodingStruct = exports.PrivateKeyEncoding = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+const account_1 = require("../account.cjs");
+/**
+ * Supported encoding formats for private keys.
+ */
+var PrivateKeyEncoding;
+(function (PrivateKeyEncoding) {
+    /**
+     * Hexadecimal encoding format.
+     */
+    PrivateKeyEncoding["Hexadecimal"] = "hexadecimal";
+    /**
+     * Base58 encoding format.
+     */
+    PrivateKeyEncoding["Base58"] = "base58";
+})(PrivateKeyEncoding || (exports.PrivateKeyEncoding = PrivateKeyEncoding = {}));
+/**
+ * Struct for {@link PrivateKeyEncoding}.
+ */
+exports.PrivateKeyEncodingStruct = (0, superstruct_1.enums)([
+    `${PrivateKeyEncoding.Hexadecimal}`,
+    `${PrivateKeyEncoding.Base58}`,
+]);
+/**
+ * Struct for {@link ImportPrivateKeyFormat}.
+ */
+exports.ImportPrivateKeyFormatStruct = (0, superstruct_1.object)({
+    /**
+     * Format used to encode the private key as a string.
+     */
+    encoding: exports.PrivateKeyEncodingStruct,
+    /**
+     * Type of the account to be created.
+     *
+     * This field is necessary when there is ambiguity about the type of account
+     * to be created from the private key. For example, in Bitcoin, a private key
+     * can be used to create multiple types of accounts, such as P2WPKH, or P2TR.
+     */
+    type: (0, superstruct_1.exactOptional)(account_1.KeyringAccountTypeStruct),
+});
+/**
+ * Struct for {@link ExportPrivateKeyFormat}.
+ */
+exports.ExportPrivateKeyFormatStruct = (0, superstruct_1.object)({
+    /**
+     * Format used to encode the private key as a string.
+     */
+    encoding: exports.PrivateKeyEncodingStruct,
+});
+//# sourceMappingURL=private-key.cjs.map

package/dist/api/v2/private-key.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"private-key.cjs","sourceRoot":"","sources":["../../../src/api/v2/private-key.ts"],"names":[],"mappings":";;;AAAA,uDAK+B;AAE/B,4CAAsD;AAEtD;;GAEG;AACH,IAAY,kBAUX;AAVD,WAAY,kBAAkB;IAC5B;;OAEG;IACH,iDAA2B,CAAA;IAE3B;;OAEG;IACH,uCAAiB,CAAA;AACnB,CAAC,EAVW,kBAAkB,kCAAlB,kBAAkB,QAU7B;AAED;;GAEG;AACU,QAAA,wBAAwB,GAAG,IAAA,mBAAK,EAAC;IAC5C,GAAG,kBAAkB,CAAC,WAAW,EAAE;IACnC,GAAG,kBAAkB,CAAC,MAAM,EAAE;CAC/B,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,4BAA4B,GAAG,IAAA,oBAAM,EAAC;IACjD;;OAEG;IACH,QAAQ,EAAE,gCAAwB;IAElC;;;;;;OAMG;IACH,IAAI,EAAE,IAAA,2BAAa,EAAC,kCAAwB,CAAC;CAC9C,CAAC,CAAC;AAOH;;GAEG;AACU,QAAA,4BAA4B,GAAG,IAAA,oBAAM,EAAC;IACjD;;OAEG;IACH,QAAQ,EAAE,gCAAwB;CACnC,CAAC,CAAC","sourcesContent":["import {\n  enums,\n  exactOptional,\n  object,\n  type Infer,\n} from '@metamask/superstruct';\n\nimport { KeyringAccountTypeStruct } from '../account';\n\n/**\n * Supported encoding formats for private keys.\n */\nexport enum PrivateKeyEncoding {\n  /**\n   * Hexadecimal encoding format.\n   */\n  Hexadecimal = 'hexadecimal',\n\n  /**\n   * Base58 encoding format.\n   */\n  Base58 = 'base58',\n}\n\n/**\n * Struct for {@link PrivateKeyEncoding}.\n */\nexport const PrivateKeyEncodingStruct = enums([\n  `${PrivateKeyEncoding.Hexadecimal}`,\n  `${PrivateKeyEncoding.Base58}`,\n]);\n\n/**\n * Struct for {@link ImportPrivateKeyFormat}.\n */\nexport const ImportPrivateKeyFormatStruct = object({\n  /**\n   * Format used to encode the private key as a string.\n   */\n  encoding: PrivateKeyEncodingStruct,\n\n  /**\n   * Type of the account to be created.\n   *\n   * This field is necessary when there is ambiguity about the type of account\n   * to be created from the private key. For example, in Bitcoin, a private key\n   * can be used to create multiple types of accounts, such as P2WPKH, or P2TR.\n   */\n  type: exactOptional(KeyringAccountTypeStruct),\n});\n\n/**\n * Represents the format for importing a private key into a keyring.\n */\nexport type ImportPrivateKeyFormat = Infer<typeof ImportPrivateKeyFormatStruct>;\n\n/**\n * Struct for {@link ExportPrivateKeyFormat}.\n */\nexport const ExportPrivateKeyFormatStruct = object({\n  /**\n   * Format used to encode the private key as a string.\n   */\n  encoding: PrivateKeyEncodingStruct,\n});\n\n/**\n * Represents the format for exporting a private key from a keyring.\n */\nexport type ExportPrivateKeyFormat = Infer<typeof ExportPrivateKeyFormatStruct>;\n"]}

package/dist/api/v2/private-key.d.cts

@@ -0,0 +1,77 @@
+import { type Infer } from "@metamask/superstruct";
+/**
+ * Supported encoding formats for private keys.
+ */
+export declare enum PrivateKeyEncoding {
+    /**
+     * Hexadecimal encoding format.
+     */
+    Hexadecimal = "hexadecimal",
+    /**
+     * Base58 encoding format.
+     */
+    Base58 = "base58"
+}
+/**
+ * Struct for {@link PrivateKeyEncoding}.
+ */
+export declare const PrivateKeyEncodingStruct: import("@metamask/superstruct").Struct<"hexadecimal" | "base58", {
+    hexadecimal: "hexadecimal";
+    base58: "base58";
+}>;
+/**
+ * Struct for {@link ImportPrivateKeyFormat}.
+ */
+export declare const ImportPrivateKeyFormatStruct: import("@metamask/superstruct").Struct<{
+    encoding: "hexadecimal" | "base58";
+    type?: "eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account" | "tron:eoa" | "any:account";
+}, {
+    /**
+     * Format used to encode the private key as a string.
+     */
+    encoding: import("@metamask/superstruct").Struct<"hexadecimal" | "base58", {
+        hexadecimal: "hexadecimal";
+        base58: "base58";
+    }>;
+    /**
+     * Type of the account to be created.
+     *
+     * This field is necessary when there is ambiguity about the type of account
+     * to be created from the private key. For example, in Bitcoin, a private key
+     * can be used to create multiple types of accounts, such as P2WPKH, or P2TR.
+     */
+    type: import("@metamask/superstruct").ExactOptionalStruct<"eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account" | "tron:eoa" | "any:account", {
+        "eip155:eoa": "eip155:eoa";
+        "eip155:erc4337": "eip155:erc4337";
+        "bip122:p2pkh": "bip122:p2pkh";
+        "bip122:p2sh": "bip122:p2sh";
+        "bip122:p2wpkh": "bip122:p2wpkh";
+        "bip122:p2tr": "bip122:p2tr";
+        "solana:data-account": "solana:data-account";
+        "tron:eoa": "tron:eoa";
+        "any:account": "any:account";
+    }>;
+}>;
+/**
+ * Represents the format for importing a private key into a keyring.
+ */
+export type ImportPrivateKeyFormat = Infer<typeof ImportPrivateKeyFormatStruct>;
+/**
+ * Struct for {@link ExportPrivateKeyFormat}.
+ */
+export declare const ExportPrivateKeyFormatStruct: import("@metamask/superstruct").Struct<{
+    encoding: "hexadecimal" | "base58";
+}, {
+    /**
+     * Format used to encode the private key as a string.
+     */
+    encoding: import("@metamask/superstruct").Struct<"hexadecimal" | "base58", {
+        hexadecimal: "hexadecimal";
+        base58: "base58";
+    }>;
+}>;
+/**
+ * Represents the format for exporting a private key from a keyring.
+ */
+export type ExportPrivateKeyFormat = Infer<typeof ExportPrivateKeyFormatStruct>;
+//# sourceMappingURL=private-key.d.cts.map

package/dist/api/v2/private-key.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"private-key.d.cts","sourceRoot":"","sources":["../../../src/api/v2/private-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,KAAK,EACX,8BAA8B;AAI/B;;GAEG;AACH,oBAAY,kBAAkB;IAC5B;;OAEG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,MAAM,WAAW;CAClB;AAED;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;EAGnC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,4BAA4B;;;;IACvC;;OAEG;;;;;IAGH;;;;;;OAMG;;;;;;;;;;;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,4BAA4B;;;IACvC;;OAEG;;;;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC"}