@metamask/keyring-api 21.2.0 → 21.3.0

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

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExportAccountPrivateKeyOptionsStruct = exports.PrivateKeyExportedAccountStruct = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+const private_key_1 = require("../private-key.cjs");
+/**
+ * Struct for {@link PrivateKeyExportedAccount}.
+ */
+exports.PrivateKeyExportedAccountStruct = (0, superstruct_1.object)({
+    /**
+     * The type of the account export.
+     */
+    type: (0, superstruct_1.literal)('private-key'),
+    /**
+     * The private key of the exported account.
+     */
+    privateKey: (0, superstruct_1.string)(),
+    /**
+     * The encoding of the exported private key.
+     */
+    encoding: private_key_1.PrivateKeyEncodingStruct,
+});
+/**
+ * Struct for {@link ExportAccountPrivateKeyOptions}.
+ */
+exports.ExportAccountPrivateKeyOptionsStruct = (0, superstruct_1.object)({
+    /**
+     * The type of the account export.
+     */
+    type: (0, superstruct_1.literal)('private-key'),
+    /**
+     * The encoding of the exported private key.
+     */
+    encoding: private_key_1.PrivateKeyEncodingStruct,
+});
+//# sourceMappingURL=private-key.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"private-key.cjs","sourceRoot":"","sources":["../../../../src/api/v2/export-account/private-key.ts"],"names":[],"mappings":";;;AAAA,uDAA4E;AAE5E,oDAA0D;AAE1D;;GAEG;AACU,QAAA,+BAA+B,GAAG,IAAA,oBAAM,EAAC;IACpD;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,aAAa,CAAC;IAC5B;;OAEG;IACH,UAAU,EAAE,IAAA,oBAAM,GAAE;IACpB;;OAEG;IACH,QAAQ,EAAE,sCAAwB;CACnC,CAAC,CAAC;AASH;;GAEG;AACU,QAAA,oCAAoC,GAAG,IAAA,oBAAM,EAAC;IACzD;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,aAAa,CAAC;IAC5B;;OAEG;IACH,QAAQ,EAAE,sCAAwB;CACnC,CAAC,CAAC","sourcesContent":["import { literal, object, string, type Infer } from '@metamask/superstruct';\n\nimport { PrivateKeyEncodingStruct } from '../private-key';\n\n/**\n * Struct for {@link PrivateKeyExportedAccount}.\n */\nexport const PrivateKeyExportedAccountStruct = object({\n  /**\n   * The type of the account export.\n   */\n  type: literal('private-key'),\n  /**\n   * The private key of the exported account.\n   */\n  privateKey: string(),\n  /**\n   * The encoding of the exported private key.\n   */\n  encoding: PrivateKeyEncodingStruct,\n});\n\n/**\n * Represents an account that has been exported using a private key.\n */\nexport type PrivateKeyExportedAccount = Infer<\n  typeof PrivateKeyExportedAccountStruct\n>;\n\n/**\n * Struct for {@link ExportAccountPrivateKeyOptions}.\n */\nexport const ExportAccountPrivateKeyOptionsStruct = object({\n  /**\n   * The type of the account export.\n   */\n  type: literal('private-key'),\n  /**\n   * The encoding of the exported private key.\n   */\n  encoding: PrivateKeyEncodingStruct,\n});\n\n/**\n * Options for exporting an account's private key.\n */\nexport type ExportAccountPrivateKeyOptions = Infer<\n  typeof ExportAccountPrivateKeyOptionsStruct\n>;\n"]}

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

@@ -0,0 +1,53 @@
+import { type Infer } from "@metamask/superstruct";
+/**
+ * Struct for {@link PrivateKeyExportedAccount}.
+ */
+export declare const PrivateKeyExportedAccountStruct: import("@metamask/superstruct").Struct<{
+    type: "private-key";
+    encoding: "hexadecimal" | "base58";
+    privateKey: string;
+}, {
+    /**
+     * The type of the account export.
+     */
+    type: import("@metamask/superstruct").Struct<"private-key", "private-key">;
+    /**
+     * The private key of the exported account.
+     */
+    privateKey: import("@metamask/superstruct").Struct<string, null>;
+    /**
+     * The encoding of the exported private key.
+     */
+    encoding: import("@metamask/superstruct").Struct<"hexadecimal" | "base58", {
+        hexadecimal: "hexadecimal";
+        base58: "base58";
+    }>;
+}>;
+/**
+ * Represents an account that has been exported using a private key.
+ */
+export type PrivateKeyExportedAccount = Infer<typeof PrivateKeyExportedAccountStruct>;
+/**
+ * Struct for {@link ExportAccountPrivateKeyOptions}.
+ */
+export declare const ExportAccountPrivateKeyOptionsStruct: import("@metamask/superstruct").Struct<{
+    type: "private-key";
+    encoding: "hexadecimal" | "base58";
+}, {
+    /**
+     * The type of the account export.
+     */
+    type: import("@metamask/superstruct").Struct<"private-key", "private-key">;
+    /**
+     * The encoding of the exported private key.
+     */
+    encoding: import("@metamask/superstruct").Struct<"hexadecimal" | "base58", {
+        hexadecimal: "hexadecimal";
+        base58: "base58";
+    }>;
+}>;
+/**
+ * Options for exporting an account's private key.
+ */
+export type ExportAccountPrivateKeyOptions = Infer<typeof ExportAccountPrivateKeyOptionsStruct>;
+//# sourceMappingURL=private-key.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"private-key.d.cts","sourceRoot":"","sources":["../../../../src/api/v2/export-account/private-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,KAAK,KAAK,EAAE,8BAA8B;AAI5E;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;IAC1C;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;;;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAC3C,OAAO,+BAA+B,CACvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oCAAoC;;;;IAC/C;;OAEG;;IAEH;;OAEG;;;;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,KAAK,CAChD,OAAO,oCAAoC,CAC5C,CAAC"}

package/dist/api/v2/export-account/private-key.d.mts

@@ -0,0 +1,53 @@
+import { type Infer } from "@metamask/superstruct";
+/**
+ * Struct for {@link PrivateKeyExportedAccount}.
+ */
+export declare const PrivateKeyExportedAccountStruct: import("@metamask/superstruct").Struct<{
+    type: "private-key";
+    encoding: "hexadecimal" | "base58";
+    privateKey: string;
+}, {
+    /**
+     * The type of the account export.
+     */
+    type: import("@metamask/superstruct").Struct<"private-key", "private-key">;
+    /**
+     * The private key of the exported account.
+     */
+    privateKey: import("@metamask/superstruct").Struct<string, null>;
+    /**
+     * The encoding of the exported private key.
+     */
+    encoding: import("@metamask/superstruct").Struct<"hexadecimal" | "base58", {
+        hexadecimal: "hexadecimal";
+        base58: "base58";
+    }>;
+}>;
+/**
+ * Represents an account that has been exported using a private key.
+ */
+export type PrivateKeyExportedAccount = Infer<typeof PrivateKeyExportedAccountStruct>;
+/**
+ * Struct for {@link ExportAccountPrivateKeyOptions}.
+ */
+export declare const ExportAccountPrivateKeyOptionsStruct: import("@metamask/superstruct").Struct<{
+    type: "private-key";
+    encoding: "hexadecimal" | "base58";
+}, {
+    /**
+     * The type of the account export.
+     */
+    type: import("@metamask/superstruct").Struct<"private-key", "private-key">;
+    /**
+     * The encoding of the exported private key.
+     */
+    encoding: import("@metamask/superstruct").Struct<"hexadecimal" | "base58", {
+        hexadecimal: "hexadecimal";
+        base58: "base58";
+    }>;
+}>;
+/**
+ * Options for exporting an account's private key.
+ */
+export type ExportAccountPrivateKeyOptions = Infer<typeof ExportAccountPrivateKeyOptionsStruct>;
+//# sourceMappingURL=private-key.d.mts.map

package/dist/api/v2/export-account/private-key.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"private-key.d.mts","sourceRoot":"","sources":["../../../../src/api/v2/export-account/private-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,KAAK,KAAK,EAAE,8BAA8B;AAI5E;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;IAC1C;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;;;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAC3C,OAAO,+BAA+B,CACvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oCAAoC;;;;IAC/C;;OAEG;;IAEH;;OAEG;;;;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,KAAK,CAChD,OAAO,oCAAoC,CAC5C,CAAC"}

package/dist/api/v2/export-account/private-key.mjs

@@ -0,0 +1,33 @@
+import { literal, object, string } from "@metamask/superstruct";
+import { PrivateKeyEncodingStruct } from "../private-key.mjs";
+/**
+ * Struct for {@link PrivateKeyExportedAccount}.
+ */
+export const PrivateKeyExportedAccountStruct = object({
+    /**
+     * The type of the account export.
+     */
+    type: literal('private-key'),
+    /**
+     * The private key of the exported account.
+     */
+    privateKey: string(),
+    /**
+     * The encoding of the exported private key.
+     */
+    encoding: PrivateKeyEncodingStruct,
+});
+/**
+ * Struct for {@link ExportAccountPrivateKeyOptions}.
+ */
+export const ExportAccountPrivateKeyOptionsStruct = object({
+    /**
+     * The type of the account export.
+     */
+    type: literal('private-key'),
+    /**
+     * The encoding of the exported private key.
+     */
+    encoding: PrivateKeyEncodingStruct,
+});
+//# sourceMappingURL=private-key.mjs.map

package/dist/api/v2/export-account/private-key.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"private-key.mjs","sourceRoot":"","sources":["../../../../src/api/v2/export-account/private-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAc,8BAA8B;AAE5E,OAAO,EAAE,wBAAwB,EAAE,2BAAuB;AAE1D;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,MAAM,CAAC;IACpD;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC;IAC5B;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE;IACpB;;OAEG;IACH,QAAQ,EAAE,wBAAwB;CACnC,CAAC,CAAC;AASH;;GAEG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAG,MAAM,CAAC;IACzD;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC;IAC5B;;OAEG;IACH,QAAQ,EAAE,wBAAwB;CACnC,CAAC,CAAC","sourcesContent":["import { literal, object, string, type Infer } from '@metamask/superstruct';\n\nimport { PrivateKeyEncodingStruct } from '../private-key';\n\n/**\n * Struct for {@link PrivateKeyExportedAccount}.\n */\nexport const PrivateKeyExportedAccountStruct = object({\n  /**\n   * The type of the account export.\n   */\n  type: literal('private-key'),\n  /**\n   * The private key of the exported account.\n   */\n  privateKey: string(),\n  /**\n   * The encoding of the exported private key.\n   */\n  encoding: PrivateKeyEncodingStruct,\n});\n\n/**\n * Represents an account that has been exported using a private key.\n */\nexport type PrivateKeyExportedAccount = Infer<\n  typeof PrivateKeyExportedAccountStruct\n>;\n\n/**\n * Struct for {@link ExportAccountPrivateKeyOptions}.\n */\nexport const ExportAccountPrivateKeyOptionsStruct = object({\n  /**\n   * The type of the account export.\n   */\n  type: literal('private-key'),\n  /**\n   * The encoding of the exported private key.\n   */\n  encoding: PrivateKeyEncodingStruct,\n});\n\n/**\n * Options for exporting an account's private key.\n */\nexport type ExportAccountPrivateKeyOptions = Infer<\n  typeof ExportAccountPrivateKeyOptionsStruct\n>;\n"]}

package/dist/api/v2/index.cjs

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./keyring-capabilities.cjs"), exports);
+__exportStar(require("./keyring-type.cjs"), exports);
+__exportStar(require("./create-account/index.cjs"), exports);
+__exportStar(require("./export-account/index.cjs"), exports);
+__exportStar(require("./private-key.cjs"), exports);
+//# sourceMappingURL=index.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../../src/api/v2/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AACA,6DAAuC;AACvC,qDAA+B;AAC/B,6DAAiC;AACjC,6DAAiC;AACjC,oDAA8B","sourcesContent":["export type * from './keyring';\nexport * from './keyring-capabilities';\nexport * from './keyring-type';\nexport * from './create-account';\nexport * from './export-account';\nexport * from './private-key';\n"]}

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

@@ -0,0 +1,7 @@
+export type * from "./keyring.cjs";
+export * from "./keyring-capabilities.cjs";
+export * from "./keyring-type.cjs";
+export * from "./create-account/index.cjs";
+export * from "./export-account/index.cjs";
+export * from "./private-key.cjs";
+//# sourceMappingURL=index.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../../src/api/v2/index.ts"],"names":[],"mappings":"AAAA,mCAA+B;AAC/B,2CAAuC;AACvC,mCAA+B;AAC/B,2CAAiC;AACjC,2CAAiC;AACjC,kCAA8B"}

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

@@ -0,0 +1,7 @@
+export type * from "./keyring.mjs";
+export * from "./keyring-capabilities.mjs";
+export * from "./keyring-type.mjs";
+export * from "./create-account/index.mjs";
+export * from "./export-account/index.mjs";
+export * from "./private-key.mjs";
+//# sourceMappingURL=index.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/api/v2/index.ts"],"names":[],"mappings":"AAAA,mCAA+B;AAC/B,2CAAuC;AACvC,mCAA+B;AAC/B,2CAAiC;AACjC,2CAAiC;AACjC,kCAA8B"}

package/dist/api/v2/index.mjs

@@ -0,0 +1,6 @@
+export * from "./keyring-capabilities.mjs";
+export * from "./keyring-type.mjs";
+export * from "./create-account/index.mjs";
+export * from "./export-account/index.mjs";
+export * from "./private-key.mjs";
+//# sourceMappingURL=index.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/api/v2/index.ts"],"names":[],"mappings":"AACA,2CAAuC;AACvC,mCAA+B;AAC/B,2CAAiC;AACjC,2CAAiC;AACjC,kCAA8B","sourcesContent":["export type * from './keyring';\nexport * from './keyring-capabilities';\nexport * from './keyring-type';\nexport * from './create-account';\nexport * from './export-account';\nexport * from './private-key';\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"keyring-capabilities.cjs","sourceRoot":"","sources":["../../../src/api/v2/keyring-capabilities.ts"],"names":[],"mappings":";;;AAAA,uDAO+B;AAE/B,mDAGuB;AACvB,sCAA4C;AAE5C;;GAEG;AACU,QAAA,yBAAyB,GAAG,IAAA,oBAAM,EAAC;IAC9C;;OAEG;IACH,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,wBAAiB,CAAC,CAAC;IAC1C;;OAEG;IACH,KAAK,EAAE,IAAA,2BAAa,EAClB,IAAA,oBAAM,EAAC;QACL;;WAEG;QACH,UAAU,EAAE,IAAA,qBAAO,GAAE;QACrB;;WAEG;QACH,WAAW,EAAE,IAAA,qBAAO,GAAE;QACtB;;WAEG;QACH,QAAQ,EAAE,IAAA,qBAAO,GAAE;KACpB,CAAC,CACH;IACD;;OAEG;IACH,UAAU,EAAE,IAAA,2BAAa,EACvB,IAAA,oBAAM,EAAC;QACL;;WAEG;QACH,aAAa,EAAE,IAAA,2BAAa,EAAC,IAAA,mBAAK,EAAC,0CAA4B,CAAC,CAAC;QACjE;;WAEG;QACH,aAAa,EAAE,IAAA,2BAAa,EAAC,IAAA,mBAAK,EAAC,0CAA4B,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-capabilities.d.cts

@@ -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.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"keyring-capabilities.d.cts","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.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"]}