@metamask-previews/keyring-api 21.1.0-8202c83 → 21.3.0-ca02a28

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

@@ -0,0 +1,128 @@
+import { type Infer } from "@metamask/superstruct";
+/**
+ * Struct for {@link KeyringCapabilities}.
+ */
+export declare const KeyringCapabilitiesStruct: import("@metamask/superstruct").Struct<{
+    scopes: `${string}:${string}`[];
+    bip44?: {
+        derivePath: boolean;
+        deriveIndex: boolean;
+        discover: boolean;
+    };
+    privateKey?: {
+        importFormats?: {
+            encoding: "hexadecimal" | "base58";
+            type?: "eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account" | "tron:eoa" | "any:account";
+        }[];
+        exportFormats?: {
+            encoding: "hexadecimal" | "base58";
+        }[];
+    };
+}, {
+    /**
+     * List of CAIP-2 chain IDs that this keyring supports.
+     */
+    scopes: import("@metamask/superstruct").Struct<`${string}:${string}`[], import("@metamask/superstruct").Struct<`${string}:${string}`, null>>;
+    /**
+     * BIP-44 capabilities supported by this keyring.
+     */
+    bip44: import("@metamask/superstruct").ExactOptionalStruct<{
+        derivePath: boolean;
+        deriveIndex: boolean;
+        discover: boolean;
+    }, {
+        /**
+         * Whether the keyring supports deriving accounts from a specific BIP-44 path.
+         */
+        derivePath: import("@metamask/superstruct").Struct<boolean, null>;
+        /**
+         * Whether the keyring supports deriving accounts from a BIP-44 account index.
+         */
+        deriveIndex: import("@metamask/superstruct").Struct<boolean, null>;
+        /**
+         * Whether the keyring supports BIP-44 account discovery.
+         */
+        discover: import("@metamask/superstruct").Struct<boolean, null>;
+    }>;
+    /**
+     * Private key capabilities supported by this keyring.
+     */
+    privateKey: import("@metamask/superstruct").ExactOptionalStruct<{
+        importFormats?: {
+            encoding: "hexadecimal" | "base58";
+            type?: "eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account" | "tron:eoa" | "any:account";
+        }[];
+        exportFormats?: {
+            encoding: "hexadecimal" | "base58";
+        }[];
+    }, {
+        /**
+         * List of supported formats for importing private keys.
+         */
+        importFormats: import("@metamask/superstruct").ExactOptionalStruct<{
+            encoding: "hexadecimal" | "base58";
+            type?: "eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account" | "tron:eoa" | "any:account";
+        }[], 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";
+        }, {
+            encoding: import("@metamask/superstruct").Struct<"hexadecimal" | "base58", {
+                hexadecimal: "hexadecimal";
+                base58: "base58";
+            }>;
+            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";
+            }>;
+        }>>;
+        /**
+         * List of supported formats for exporting private keys.
+         */
+        exportFormats: import("@metamask/superstruct").ExactOptionalStruct<{
+            encoding: "hexadecimal" | "base58";
+        }[], import("@metamask/superstruct").Struct<{
+            encoding: "hexadecimal" | "base58";
+        }, {
+            encoding: import("@metamask/superstruct").Struct<"hexadecimal" | "base58", {
+                hexadecimal: "hexadecimal";
+                base58: "base58";
+            }>;
+        }>>;
+    }>;
+}>;
+/**
+ * Type representing the capabilities supported by a keyring.
+ *
+ * @example
+ * ```ts
+ * const capabilities: KeyringCapabilities = {
+ *   scopes: ['bip122:_'],
+ *   bip44: {
+ *     derivePath: true,
+ *     deriveIndex: true,
+ *     discover: true,
+ *   },
+ *   privateKey: {
+ *     importFormats: [
+ *       { encoding: 'base58', type: 'bip122:p2sh' },
+ *       { encoding: 'base58', type: 'bip122:p2tr' },
+ *       { encoding: 'base58', type: 'bip122:p2pkh' },
+ *       { encoding: 'base58', type: 'bip122:p2wpkh' },
+ *     ],
+ *     exportFormats: [
+ *       { encoding: 'base58' },
+ *       { encoding: 'base58' },
+ *     ],
+ *   },
+ * };
+ * ```
+ */
+export type KeyringCapabilities = Infer<typeof KeyringCapabilitiesStruct>;
+//# sourceMappingURL=keyring-capabilities.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"keyring-capabilities.d.mts","sourceRoot":"","sources":["../../../src/api/v2/keyring-capabilities.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,KAAK,EACX,8BAA8B;AAQ/B;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;IACpC;;OAEG;;IAEH;;OAEG;;;;;;QAGC;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;;IAIP;;OAEG;;;;;;;;;;QAGC;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;QAEH;;WAEG;;;;;;;;;;;;EAIP,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC"}

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

@@ -0,0 +1,43 @@
+import { array, boolean, exactOptional, nonempty, object } from "@metamask/superstruct";
+import { ExportPrivateKeyFormatStruct, ImportPrivateKeyFormatStruct } from "./private-key.mjs";
+import { CaipChainIdStruct } from "../caip.mjs";
+/**
+ * Struct for {@link KeyringCapabilities}.
+ */
+export const KeyringCapabilitiesStruct = object({
+    /**
+     * List of CAIP-2 chain IDs that this keyring supports.
+     */
+    scopes: nonempty(array(CaipChainIdStruct)),
+    /**
+     * BIP-44 capabilities supported by this keyring.
+     */
+    bip44: exactOptional(object({
+        /**
+         * Whether the keyring supports deriving accounts from a specific BIP-44 path.
+         */
+        derivePath: boolean(),
+        /**
+         * Whether the keyring supports deriving accounts from a BIP-44 account index.
+         */
+        deriveIndex: boolean(),
+        /**
+         * Whether the keyring supports BIP-44 account discovery.
+         */
+        discover: boolean(),
+    })),
+    /**
+     * Private key capabilities supported by this keyring.
+     */
+    privateKey: exactOptional(object({
+        /**
+         * List of supported formats for importing private keys.
+         */
+        importFormats: exactOptional(array(ImportPrivateKeyFormatStruct)),
+        /**
+         * List of supported formats for exporting private keys.
+         */
+        exportFormats: exactOptional(array(ExportPrivateKeyFormatStruct)),
+    })),
+});
+//# sourceMappingURL=keyring-capabilities.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"keyring-capabilities.mjs","sourceRoot":"","sources":["../../../src/api/v2/keyring-capabilities.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,OAAO,EACP,aAAa,EACb,QAAQ,EACR,MAAM,EAEP,8BAA8B;AAE/B,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,EAC7B,0BAAsB;AACvB,OAAO,EAAE,iBAAiB,EAAE,oBAAgB;AAE5C;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC;IAC9C;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAC1C;;OAEG;IACH,KAAK,EAAE,aAAa,CAClB,MAAM,CAAC;QACL;;WAEG;QACH,UAAU,EAAE,OAAO,EAAE;QACrB;;WAEG;QACH,WAAW,EAAE,OAAO,EAAE;QACtB;;WAEG;QACH,QAAQ,EAAE,OAAO,EAAE;KACpB,CAAC,CACH;IACD;;OAEG;IACH,UAAU,EAAE,aAAa,CACvB,MAAM,CAAC;QACL;;WAEG;QACH,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;QACjE;;WAEG;QACH,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAClE,CAAC,CACH;CACF,CAAC,CAAC","sourcesContent":["import {\n  array,\n  boolean,\n  exactOptional,\n  nonempty,\n  object,\n  type Infer,\n} from '@metamask/superstruct';\n\nimport {\n  ExportPrivateKeyFormatStruct,\n  ImportPrivateKeyFormatStruct,\n} from './private-key';\nimport { CaipChainIdStruct } from '../caip';\n\n/**\n * Struct for {@link KeyringCapabilities}.\n */\nexport const KeyringCapabilitiesStruct = object({\n  /**\n   * List of CAIP-2 chain IDs that this keyring supports.\n   */\n  scopes: nonempty(array(CaipChainIdStruct)),\n  /**\n   * BIP-44 capabilities supported by this keyring.\n   */\n  bip44: exactOptional(\n    object({\n      /**\n       * Whether the keyring supports deriving accounts from a specific BIP-44 path.\n       */\n      derivePath: boolean(),\n      /**\n       * Whether the keyring supports deriving accounts from a BIP-44 account index.\n       */\n      deriveIndex: boolean(),\n      /**\n       * Whether the keyring supports BIP-44 account discovery.\n       */\n      discover: boolean(),\n    }),\n  ),\n  /**\n   * Private key capabilities supported by this keyring.\n   */\n  privateKey: exactOptional(\n    object({\n      /**\n       * List of supported formats for importing private keys.\n       */\n      importFormats: exactOptional(array(ImportPrivateKeyFormatStruct)),\n      /**\n       * List of supported formats for exporting private keys.\n       */\n      exportFormats: exactOptional(array(ExportPrivateKeyFormatStruct)),\n    }),\n  ),\n});\n\n/**\n * Type representing the capabilities supported by a keyring.\n *\n * @example\n * ```ts\n * const capabilities: KeyringCapabilities = {\n *   scopes: ['bip122:_'],\n *   bip44: {\n *     derivePath: true,\n *     deriveIndex: true,\n *     discover: true,\n *   },\n *   privateKey: {\n *     importFormats: [\n *       { encoding: 'base58', type: 'bip122:p2sh' },\n *       { encoding: 'base58', type: 'bip122:p2tr' },\n *       { encoding: 'base58', type: 'bip122:p2pkh' },\n *       { encoding: 'base58', type: 'bip122:p2wpkh' },\n *     ],\n *     exportFormats: [\n *       { encoding: 'base58' },\n *       { encoding: 'base58' },\n *     ],\n *   },\n * };\n * ```\n */\nexport type KeyringCapabilities = Infer<typeof KeyringCapabilitiesStruct>;\n"]}

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"]}