@metamask/keyring-api 17.6.0 → 19.0.0

package/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [19.0.0]
+
+### Changed
+
+- **BREAKING:** Add typed `KeyringAccount.options` ([#316](https://github.com/MetaMask/accounts/pull/316))
+  - We still support the old `Record<string, Json>` type for `options`, however we now constrain 2 fields (`entropy` and `exportable`) and type their shapes to meet new requirements.
+
+## [18.0.0]
+
+### Changed
+
+- **BREAKING:** Add `KeyringRequest.origin` ([#273](https://github.com/MetaMask/accounts/pull/273))
+  - **This requires a `platformVersion` version `7.0.0` or newer.**
+  - This field will allow Snap to display the real `origin` of the caller (e.g dapp) when processing/confirming a keyring request (`submitRequest`).
+
 ## [17.6.0]
 
 ### Added
@@ -575,7 +590,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - SnapController keyring client. It is intended to be used by MetaMask to talk to the snap.
 - Helper functions to create keyring handler in the snap.
 
-[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-api@17.6.0...HEAD
+[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-api@19.0.0...HEAD
+[19.0.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-api@18.0.0...@metamask/keyring-api@19.0.0
+[18.0.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-api@17.6.0...@metamask/keyring-api@18.0.0
 [17.6.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-api@17.5.0...@metamask/keyring-api@17.6.0
 [17.5.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-api@17.4.0...@metamask/keyring-api@17.5.0
 [17.4.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-api@17.3.0...@metamask/keyring-api@17.4.0

package/dist/api/account-options.cjs

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyringAccountOptionsStruct = exports.KeyringAccountEntropyOptionsStruct = exports.KeyringAccountEntropyPrivateKeyOptionsStruct = exports.KeyringAccountEntropyMnemonicOptionsStruct = exports.KeyringAccountEntropyTypeOption = void 0;
+const keyring_utils_1 = require("@metamask/keyring-utils");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+/**
+ * Keyring account entropy valid types.
+ */
+var KeyringAccountEntropyTypeOption;
+(function (KeyringAccountEntropyTypeOption) {
+    /**
+     * Indicates that the account was created from a mnemonic phrase.
+     */
+    KeyringAccountEntropyTypeOption["Mnemonic"] = "mnemonic";
+    /**
+     * Indicates that the account was imported from a private key.
+     */
+    KeyringAccountEntropyTypeOption["PrivateKey"] = "private-key";
+})(KeyringAccountEntropyTypeOption || (exports.KeyringAccountEntropyTypeOption = KeyringAccountEntropyTypeOption = {}));
+/**
+ * Keyring account options struct for mnemonics (BIP-44).
+ */
+exports.KeyringAccountEntropyMnemonicOptionsStruct = (0, superstruct_1.object)({
+    /**
+     * Indicates that the account was created from a mnemonic phrase.
+     */
+    type: (0, superstruct_1.literal)(`${KeyringAccountEntropyTypeOption.Mnemonic}`),
+    /**
+     * The ID of the entropy source.
+     */
+    id: (0, superstruct_1.string)(), // TODO: Define a struct for entropy source.
+    /**
+     * The BIP-44 derivation path used to derive the account.
+     */
+    derivationPath: (0, superstruct_1.string)(),
+    /**
+     * Index used to group accounts in the UI.
+     *
+     * Accounts sharing the same `groupIndex` are displayed together as a
+     * multichain account group.
+     */
+    groupIndex: (0, superstruct_1.number)(),
+});
+/**
+ * Keyring account options struct for private keys.
+ */
+exports.KeyringAccountEntropyPrivateKeyOptionsStruct = (0, superstruct_1.object)({
+    /**
+     * Indicates that the account was imported from a private key.
+     */
+    type: (0, superstruct_1.literal)(`${KeyringAccountEntropyTypeOption.PrivateKey}`),
+});
+/**
+ * Keyring account entropy options struct.
+ */
+exports.KeyringAccountEntropyOptionsStruct = (0, keyring_utils_1.selectiveUnion)((value) => {
+    return (0, utils_1.isPlainObject)(value) &&
+        value.type === KeyringAccountEntropyTypeOption.PrivateKey
+        ? exports.KeyringAccountEntropyPrivateKeyOptionsStruct
+        : exports.KeyringAccountEntropyMnemonicOptionsStruct;
+});
+/**
+ * Keyring options struct. This represents various options for a Keyring account object.
+ *
+ * See {@link KeyringAccountEntropyMnemonicOptionsStruct} and
+ * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.
+ *
+ * @example
+ * ```ts
+ * {
+ *   entropy: {
+ *     type: 'mnemonic',
+ *     id: '01K0BX6VDR5DPDPGGNA8PZVBVB',
+ *     derivationPath: "m/44'/60'/0'/0/0",
+ *     groupIndex: 0,
+ *   },
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
+ *   entropy: {
+ *     type: 'private-key',
+ *   },
+ *   exportable: true,
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
+ *   some: {
+ *     untyped: 'options',
+ *     something: true,
+ *   },
+ * }
+ * ```
+ */
+exports.KeyringAccountOptionsStruct = (0, superstruct_1.intersection)([
+    // Non-Typed options (retro-compatibility):
+    (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct),
+    // Typed options. We use `type` instead of `object` here, to allow
+    // extra properties. Also, since we use `record` + `intersection` we
+    // are guaranteed that all field values will match the `JsonStruct`.
+    //
+    // READ THIS CAREFULLY:
+    // Previous options that can be matched by this struct will be breaking
+    // existing keyring account options.
+    (0, keyring_utils_1.type)({
+        /**
+         * Entropy options.
+         */
+        entropy: (0, keyring_utils_1.exactOptional)(exports.KeyringAccountEntropyOptionsStruct),
+        /**
+         * Indicates whether the account can be exported.
+         */
+        exportable: (0, keyring_utils_1.exactOptional)((0, superstruct_1.boolean)()),
+    }),
+]);
+//# sourceMappingURL=account-options.cjs.map

package/dist/api/account-options.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-options.cjs","sourceRoot":"","sources":["../../src/api/account-options.ts"],"names":[],"mappings":";;;AAAA,2DAA8E;AAE9E,uDAQ+B;AAC/B,2CAA4D;AAE5D;;GAEG;AACH,IAAY,+BAUX;AAVD,WAAY,+BAA+B;IACzC;;OAEG;IACH,wDAAqB,CAAA;IAErB;;OAEG;IACH,6DAA0B,CAAA;AAC5B,CAAC,EAVW,+BAA+B,+CAA/B,+BAA+B,QAU1C;AAED;;GAEG;AACU,QAAA,0CAA0C,GAAG,IAAA,oBAAM,EAAC;IAC/D;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,GAAG,+BAA+B,CAAC,QAAQ,EAAE,CAAC;IAE5D;;OAEG;IACH,EAAE,EAAE,IAAA,oBAAM,GAAE,EAAE,4CAA4C;IAE1D;;OAEG;IACH,cAAc,EAAE,IAAA,oBAAM,GAAE;IAExB;;;;;OAKG;IACH,UAAU,EAAE,IAAA,oBAAM,GAAE;CACrB,CAAC,CAAC;AASH;;GAEG;AACU,QAAA,4CAA4C,GAAG,IAAA,oBAAM,EAAC;IACjE;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,GAAG,+BAA+B,CAAC,UAAU,EAAE,CAAC;CAC/D,CAAC,CAAC;AASH;;GAEG;AACU,QAAA,kCAAkC,GAAG,IAAA,8BAAc,EAC9D,CAAC,KAAU,EAAE,EAAE;IACb,OAAO,IAAA,qBAAa,EAAC,KAAK,CAAC;QACzB,KAAK,CAAC,IAAI,KAAK,+BAA+B,CAAC,UAAU;QACzD,CAAC,CAAC,oDAA4C;QAC9C,CAAC,CAAC,kDAA0C,CAAC;AACjD,CAAC,CACF,CAAC;AASF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACU,QAAA,2BAA2B,GAAG,IAAA,0BAAY,EAAC;IACtD,2CAA2C;IAC3C,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC;IAE5B,kEAAkE;IAClE,oEAAoE;IACpE,oEAAoE;IACpE,EAAE;IACF,uBAAuB;IACvB,uEAAuE;IACvE,oCAAoC;IACpC,IAAA,oBAAI,EAAC;QACH;;WAEG;QACH,OAAO,EAAE,IAAA,6BAAa,EAAC,0CAAkC,CAAC;QAE1D;;WAEG;QACH,UAAU,EAAE,IAAA,6BAAa,EAAC,IAAA,qBAAO,GAAE,CAAC;KACrC,CAAC;CACH,CAAC,CAAC","sourcesContent":["import { exactOptional, selectiveUnion, type } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport {\n  boolean,\n  intersection,\n  literal,\n  number,\n  object,\n  record,\n  string,\n} from '@metamask/superstruct';\nimport { isPlainObject, JsonStruct } from '@metamask/utils';\n\n/**\n * Keyring account entropy valid types.\n */\nexport enum KeyringAccountEntropyTypeOption {\n  /**\n   * Indicates that the account was created from a mnemonic phrase.\n   */\n  Mnemonic = 'mnemonic',\n\n  /**\n   * Indicates that the account was imported from a private key.\n   */\n  PrivateKey = 'private-key',\n}\n\n/**\n * Keyring account options struct for mnemonics (BIP-44).\n */\nexport const KeyringAccountEntropyMnemonicOptionsStruct = object({\n  /**\n   * Indicates that the account was created from a mnemonic phrase.\n   */\n  type: literal(`${KeyringAccountEntropyTypeOption.Mnemonic}`),\n\n  /**\n   * The ID of the entropy source.\n   */\n  id: string(), // TODO: Define a struct for entropy source.\n\n  /**\n   * The BIP-44 derivation path used to derive the account.\n   */\n  derivationPath: string(),\n\n  /**\n   * Index used to group accounts in the UI.\n   *\n   * Accounts sharing the same `groupIndex` are displayed together as a\n   * multichain account group.\n   */\n  groupIndex: number(),\n});\n\n/**\n * Keyring account options for mnemonics (BIP-44) {@link KeyringAccountEntropyMnemonicOptionsStruct}.\n */\nexport type KeyringAccountEntropyMnemonicOptions = Infer<\n  typeof KeyringAccountEntropyMnemonicOptionsStruct\n>;\n\n/**\n * Keyring account options struct for private keys.\n */\nexport const KeyringAccountEntropyPrivateKeyOptionsStruct = object({\n  /**\n   * Indicates that the account was imported from a private key.\n   */\n  type: literal(`${KeyringAccountEntropyTypeOption.PrivateKey}`),\n});\n\n/**\n * Keyring account options for private keys {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.\n */\nexport type KeyringAccountEntropyPrivateKeyOptions = Infer<\n  typeof KeyringAccountEntropyPrivateKeyOptionsStruct\n>;\n\n/**\n * Keyring account entropy options struct.\n */\nexport const KeyringAccountEntropyOptionsStruct = selectiveUnion(\n  (value: any) => {\n    return isPlainObject(value) &&\n      value.type === KeyringAccountEntropyTypeOption.PrivateKey\n      ? KeyringAccountEntropyPrivateKeyOptionsStruct\n      : KeyringAccountEntropyMnemonicOptionsStruct;\n  },\n);\n\n/**\n * Keyring account entropy options {@link KeyringAccountEntropyOptionsStruct}.\n */\nexport type KeyringAccountEntropyOptions = Infer<\n  typeof KeyringAccountEntropyOptionsStruct\n>;\n\n/**\n * Keyring options struct. This represents various options for a Keyring account object.\n *\n * See {@link KeyringAccountEntropyMnemonicOptionsStruct} and\n * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.\n *\n * @example\n * ```ts\n * {\n *   entropy: {\n *     type: 'mnemonic',\n *     id: '01K0BX6VDR5DPDPGGNA8PZVBVB',\n *     derivationPath: \"m/44'/60'/0'/0/0\",\n *     groupIndex: 0,\n *   },\n * }\n * ```\n *\n * @example\n * ```ts\n * {\n *   entropy: {\n *     type: 'private-key',\n *   },\n *   exportable: true,\n * }\n * ```\n *\n * @example\n * ```ts\n * {\n *   some: {\n *     untyped: 'options',\n *     something: true,\n *   },\n * }\n * ```\n */\nexport const KeyringAccountOptionsStruct = intersection([\n  // Non-Typed options (retro-compatibility):\n  record(string(), JsonStruct),\n\n  // Typed options. We use `type` instead of `object` here, to allow\n  // extra properties. Also, since we use `record` + `intersection` we\n  // are guaranteed that all field values will match the `JsonStruct`.\n  //\n  // READ THIS CAREFULLY:\n  // Previous options that can be matched by this struct will be breaking\n  // existing keyring account options.\n  type({\n    /**\n     * Entropy options.\n     */\n    entropy: exactOptional(KeyringAccountEntropyOptionsStruct),\n\n    /**\n     * Indicates whether the account can be exported.\n     */\n    exportable: exactOptional(boolean()),\n  }),\n]);\n\n/**\n * Keyring account options {@link KeyringAccountOptionsStruct}.\n */\nexport type KeyringAccountOptions = Infer<typeof KeyringAccountOptionsStruct>;\n"]}

package/dist/api/account-options.d.cts

@@ -0,0 +1,131 @@
+import type { Infer } from "@metamask/superstruct";
+/**
+ * Keyring account entropy valid types.
+ */
+export declare enum KeyringAccountEntropyTypeOption {
+    /**
+     * Indicates that the account was created from a mnemonic phrase.
+     */
+    Mnemonic = "mnemonic",
+    /**
+     * Indicates that the account was imported from a private key.
+     */
+    PrivateKey = "private-key"
+}
+/**
+ * Keyring account options struct for mnemonics (BIP-44).
+ */
+export declare const KeyringAccountEntropyMnemonicOptionsStruct: import("@metamask/superstruct").Struct<{
+    type: "mnemonic";
+    id: string;
+    derivationPath: string;
+    groupIndex: number;
+}, {
+    /**
+     * Indicates that the account was created from a mnemonic phrase.
+     */
+    type: import("@metamask/superstruct").Struct<"mnemonic", "mnemonic">;
+    /**
+     * The ID of the entropy source.
+     */
+    id: import("@metamask/superstruct").Struct<string, null>;
+    /**
+     * The BIP-44 derivation path used to derive the account.
+     */
+    derivationPath: import("@metamask/superstruct").Struct<string, null>;
+    /**
+     * Index used to group accounts in the UI.
+     *
+     * Accounts sharing the same `groupIndex` are displayed together as a
+     * multichain account group.
+     */
+    groupIndex: import("@metamask/superstruct").Struct<number, null>;
+}>;
+/**
+ * Keyring account options for mnemonics (BIP-44) {@link KeyringAccountEntropyMnemonicOptionsStruct}.
+ */
+export type KeyringAccountEntropyMnemonicOptions = Infer<typeof KeyringAccountEntropyMnemonicOptionsStruct>;
+/**
+ * Keyring account options struct for private keys.
+ */
+export declare const KeyringAccountEntropyPrivateKeyOptionsStruct: import("@metamask/superstruct").Struct<{
+    type: "private-key";
+}, {
+    /**
+     * Indicates that the account was imported from a private key.
+     */
+    type: import("@metamask/superstruct").Struct<"private-key", "private-key">;
+}>;
+/**
+ * Keyring account options for private keys {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.
+ */
+export type KeyringAccountEntropyPrivateKeyOptions = Infer<typeof KeyringAccountEntropyPrivateKeyOptionsStruct>;
+/**
+ * Keyring account entropy options struct.
+ */
+export declare const KeyringAccountEntropyOptionsStruct: import("@metamask/superstruct").Struct<{
+    type: "mnemonic";
+    id: string;
+    derivationPath: string;
+    groupIndex: number;
+} | {
+    type: "private-key";
+}, null>;
+/**
+ * Keyring account entropy options {@link KeyringAccountEntropyOptionsStruct}.
+ */
+export type KeyringAccountEntropyOptions = Infer<typeof KeyringAccountEntropyOptionsStruct>;
+/**
+ * Keyring options struct. This represents various options for a Keyring account object.
+ *
+ * See {@link KeyringAccountEntropyMnemonicOptionsStruct} and
+ * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.
+ *
+ * @example
+ * ```ts
+ * {
+ *   entropy: {
+ *     type: 'mnemonic',
+ *     id: '01K0BX6VDR5DPDPGGNA8PZVBVB',
+ *     derivationPath: "m/44'/60'/0'/0/0",
+ *     groupIndex: 0,
+ *   },
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
+ *   entropy: {
+ *     type: 'private-key',
+ *   },
+ *   exportable: true,
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
+ *   some: {
+ *     untyped: 'options',
+ *     something: true,
+ *   },
+ * }
+ * ```
+ */
+export declare const KeyringAccountOptionsStruct: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json> & {
+    entropy?: {
+        type: "mnemonic";
+        id: string;
+        derivationPath: string;
+        groupIndex: number;
+    } | {
+        type: "private-key";
+    };
+    exportable?: boolean;
+}, null>;
+/**
+ * Keyring account options {@link KeyringAccountOptionsStruct}.
+ */
+export type KeyringAccountOptions = Infer<typeof KeyringAccountOptionsStruct>;
+//# sourceMappingURL=account-options.d.cts.map

package/dist/api/account-options.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-options.d.cts","sourceRoot":"","sources":["../../src/api/account-options.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAYnD;;GAEG;AACH,oBAAY,+BAA+B;IACzC;;OAEG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,UAAU,gBAAgB;CAC3B;AAED;;GAEG;AACH,eAAO,MAAM,0CAA0C;;;;;;IACrD;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG,KAAK,CACtD,OAAO,0CAA0C,CAClD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4CAA4C;;;IACvD;;OAEG;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,KAAK,CACxD,OAAO,4CAA4C,CACpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;;;;QAO9C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAC9C,OAAO,kCAAkC,CAC1C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;QAsBtC,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC"}

package/dist/api/account-options.d.mts

@@ -0,0 +1,131 @@
+import type { Infer } from "@metamask/superstruct";
+/**
+ * Keyring account entropy valid types.
+ */
+export declare enum KeyringAccountEntropyTypeOption {
+    /**
+     * Indicates that the account was created from a mnemonic phrase.
+     */
+    Mnemonic = "mnemonic",
+    /**
+     * Indicates that the account was imported from a private key.
+     */
+    PrivateKey = "private-key"
+}
+/**
+ * Keyring account options struct for mnemonics (BIP-44).
+ */
+export declare const KeyringAccountEntropyMnemonicOptionsStruct: import("@metamask/superstruct").Struct<{
+    type: "mnemonic";
+    id: string;
+    derivationPath: string;
+    groupIndex: number;
+}, {
+    /**
+     * Indicates that the account was created from a mnemonic phrase.
+     */
+    type: import("@metamask/superstruct").Struct<"mnemonic", "mnemonic">;
+    /**
+     * The ID of the entropy source.
+     */
+    id: import("@metamask/superstruct").Struct<string, null>;
+    /**
+     * The BIP-44 derivation path used to derive the account.
+     */
+    derivationPath: import("@metamask/superstruct").Struct<string, null>;
+    /**
+     * Index used to group accounts in the UI.
+     *
+     * Accounts sharing the same `groupIndex` are displayed together as a
+     * multichain account group.
+     */
+    groupIndex: import("@metamask/superstruct").Struct<number, null>;
+}>;
+/**
+ * Keyring account options for mnemonics (BIP-44) {@link KeyringAccountEntropyMnemonicOptionsStruct}.
+ */
+export type KeyringAccountEntropyMnemonicOptions = Infer<typeof KeyringAccountEntropyMnemonicOptionsStruct>;
+/**
+ * Keyring account options struct for private keys.
+ */
+export declare const KeyringAccountEntropyPrivateKeyOptionsStruct: import("@metamask/superstruct").Struct<{
+    type: "private-key";
+}, {
+    /**
+     * Indicates that the account was imported from a private key.
+     */
+    type: import("@metamask/superstruct").Struct<"private-key", "private-key">;
+}>;
+/**
+ * Keyring account options for private keys {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.
+ */
+export type KeyringAccountEntropyPrivateKeyOptions = Infer<typeof KeyringAccountEntropyPrivateKeyOptionsStruct>;
+/**
+ * Keyring account entropy options struct.
+ */
+export declare const KeyringAccountEntropyOptionsStruct: import("@metamask/superstruct").Struct<{
+    type: "mnemonic";
+    id: string;
+    derivationPath: string;
+    groupIndex: number;
+} | {
+    type: "private-key";
+}, null>;
+/**
+ * Keyring account entropy options {@link KeyringAccountEntropyOptionsStruct}.
+ */
+export type KeyringAccountEntropyOptions = Infer<typeof KeyringAccountEntropyOptionsStruct>;
+/**
+ * Keyring options struct. This represents various options for a Keyring account object.
+ *
+ * See {@link KeyringAccountEntropyMnemonicOptionsStruct} and
+ * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.
+ *
+ * @example
+ * ```ts
+ * {
+ *   entropy: {
+ *     type: 'mnemonic',
+ *     id: '01K0BX6VDR5DPDPGGNA8PZVBVB',
+ *     derivationPath: "m/44'/60'/0'/0/0",
+ *     groupIndex: 0,
+ *   },
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
+ *   entropy: {
+ *     type: 'private-key',
+ *   },
+ *   exportable: true,
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
+ *   some: {
+ *     untyped: 'options',
+ *     something: true,
+ *   },
+ * }
+ * ```
+ */
+export declare const KeyringAccountOptionsStruct: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json> & {
+    entropy?: {
+        type: "mnemonic";
+        id: string;
+        derivationPath: string;
+        groupIndex: number;
+    } | {
+        type: "private-key";
+    };
+    exportable?: boolean;
+}, null>;
+/**
+ * Keyring account options {@link KeyringAccountOptionsStruct}.
+ */
+export type KeyringAccountOptions = Infer<typeof KeyringAccountOptionsStruct>;
+//# sourceMappingURL=account-options.d.mts.map

package/dist/api/account-options.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-options.d.mts","sourceRoot":"","sources":["../../src/api/account-options.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAYnD;;GAEG;AACH,oBAAY,+BAA+B;IACzC;;OAEG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,UAAU,gBAAgB;CAC3B;AAED;;GAEG;AACH,eAAO,MAAM,0CAA0C;;;;;;IACrD;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG,KAAK,CACtD,OAAO,0CAA0C,CAClD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4CAA4C;;;IACvD;;OAEG;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,KAAK,CACxD,OAAO,4CAA4C,CACpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;;;;QAO9C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAC9C,OAAO,kCAAkC,CAC1C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;QAsBtC,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC"}

package/dist/api/account-options.mjs

@@ -0,0 +1,119 @@
+import { exactOptional, selectiveUnion, type } from "@metamask/keyring-utils";
+import { boolean, intersection, literal, number, object, record, string } from "@metamask/superstruct";
+import { isPlainObject, JsonStruct } from "@metamask/utils";
+/**
+ * Keyring account entropy valid types.
+ */
+export var KeyringAccountEntropyTypeOption;
+(function (KeyringAccountEntropyTypeOption) {
+    /**
+     * Indicates that the account was created from a mnemonic phrase.
+     */
+    KeyringAccountEntropyTypeOption["Mnemonic"] = "mnemonic";
+    /**
+     * Indicates that the account was imported from a private key.
+     */
+    KeyringAccountEntropyTypeOption["PrivateKey"] = "private-key";
+})(KeyringAccountEntropyTypeOption || (KeyringAccountEntropyTypeOption = {}));
+/**
+ * Keyring account options struct for mnemonics (BIP-44).
+ */
+export const KeyringAccountEntropyMnemonicOptionsStruct = object({
+    /**
+     * Indicates that the account was created from a mnemonic phrase.
+     */
+    type: literal(`${KeyringAccountEntropyTypeOption.Mnemonic}`),
+    /**
+     * The ID of the entropy source.
+     */
+    id: string(), // TODO: Define a struct for entropy source.
+    /**
+     * The BIP-44 derivation path used to derive the account.
+     */
+    derivationPath: string(),
+    /**
+     * Index used to group accounts in the UI.
+     *
+     * Accounts sharing the same `groupIndex` are displayed together as a
+     * multichain account group.
+     */
+    groupIndex: number(),
+});
+/**
+ * Keyring account options struct for private keys.
+ */
+export const KeyringAccountEntropyPrivateKeyOptionsStruct = object({
+    /**
+     * Indicates that the account was imported from a private key.
+     */
+    type: literal(`${KeyringAccountEntropyTypeOption.PrivateKey}`),
+});
+/**
+ * Keyring account entropy options struct.
+ */
+export const KeyringAccountEntropyOptionsStruct = selectiveUnion((value) => {
+    return isPlainObject(value) &&
+        value.type === KeyringAccountEntropyTypeOption.PrivateKey
+        ? KeyringAccountEntropyPrivateKeyOptionsStruct
+        : KeyringAccountEntropyMnemonicOptionsStruct;
+});
+/**
+ * Keyring options struct. This represents various options for a Keyring account object.
+ *
+ * See {@link KeyringAccountEntropyMnemonicOptionsStruct} and
+ * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.
+ *
+ * @example
+ * ```ts
+ * {
+ *   entropy: {
+ *     type: 'mnemonic',
+ *     id: '01K0BX6VDR5DPDPGGNA8PZVBVB',
+ *     derivationPath: "m/44'/60'/0'/0/0",
+ *     groupIndex: 0,
+ *   },
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
+ *   entropy: {
+ *     type: 'private-key',
+ *   },
+ *   exportable: true,
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
+ *   some: {
+ *     untyped: 'options',
+ *     something: true,
+ *   },
+ * }
+ * ```
+ */
+export const KeyringAccountOptionsStruct = intersection([
+    // Non-Typed options (retro-compatibility):
+    record(string(), JsonStruct),
+    // Typed options. We use `type` instead of `object` here, to allow
+    // extra properties. Also, since we use `record` + `intersection` we
+    // are guaranteed that all field values will match the `JsonStruct`.
+    //
+    // READ THIS CAREFULLY:
+    // Previous options that can be matched by this struct will be breaking
+    // existing keyring account options.
+    type({
+        /**
+         * Entropy options.
+         */
+        entropy: exactOptional(KeyringAccountEntropyOptionsStruct),
+        /**
+         * Indicates whether the account can be exported.
+         */
+        exportable: exactOptional(boolean()),
+    }),
+]);
+//# sourceMappingURL=account-options.mjs.map

package/dist/api/account-options.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-options.mjs","sourceRoot":"","sources":["../../src/api/account-options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,IAAI,EAAE,gCAAgC;AAE9E,OAAO,EACL,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACP,8BAA8B;AAC/B,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,wBAAwB;AAE5D;;GAEG;AACH,MAAM,CAAN,IAAY,+BAUX;AAVD,WAAY,+BAA+B;IACzC;;OAEG;IACH,wDAAqB,CAAA;IAErB;;OAEG;IACH,6DAA0B,CAAA;AAC5B,CAAC,EAVW,+BAA+B,KAA/B,+BAA+B,QAU1C;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,0CAA0C,GAAG,MAAM,CAAC;IAC/D;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,GAAG,+BAA+B,CAAC,QAAQ,EAAE,CAAC;IAE5D;;OAEG;IACH,EAAE,EAAE,MAAM,EAAE,EAAE,4CAA4C;IAE1D;;OAEG;IACH,cAAc,EAAE,MAAM,EAAE;IAExB;;;;;OAKG;IACH,UAAU,EAAE,MAAM,EAAE;CACrB,CAAC,CAAC;AASH;;GAEG;AACH,MAAM,CAAC,MAAM,4CAA4C,GAAG,MAAM,CAAC;IACjE;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,GAAG,+BAA+B,CAAC,UAAU,EAAE,CAAC;CAC/D,CAAC,CAAC;AASH;;GAEG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,cAAc,CAC9D,CAAC,KAAU,EAAE,EAAE;IACb,OAAO,aAAa,CAAC,KAAK,CAAC;QACzB,KAAK,CAAC,IAAI,KAAK,+BAA+B,CAAC,UAAU;QACzD,CAAC,CAAC,4CAA4C;QAC9C,CAAC,CAAC,0CAA0C,CAAC;AACjD,CAAC,CACF,CAAC;AASF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,YAAY,CAAC;IACtD,2CAA2C;IAC3C,MAAM,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC;IAE5B,kEAAkE;IAClE,oEAAoE;IACpE,oEAAoE;IACpE,EAAE;IACF,uBAAuB;IACvB,uEAAuE;IACvE,oCAAoC;IACpC,IAAI,CAAC;QACH;;WAEG;QACH,OAAO,EAAE,aAAa,CAAC,kCAAkC,CAAC;QAE1D;;WAEG;QACH,UAAU,EAAE,aAAa,CAAC,OAAO,EAAE,CAAC;KACrC,CAAC;CACH,CAAC,CAAC","sourcesContent":["import { exactOptional, selectiveUnion, type } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport {\n  boolean,\n  intersection,\n  literal,\n  number,\n  object,\n  record,\n  string,\n} from '@metamask/superstruct';\nimport { isPlainObject, JsonStruct } from '@metamask/utils';\n\n/**\n * Keyring account entropy valid types.\n */\nexport enum KeyringAccountEntropyTypeOption {\n  /**\n   * Indicates that the account was created from a mnemonic phrase.\n   */\n  Mnemonic = 'mnemonic',\n\n  /**\n   * Indicates that the account was imported from a private key.\n   */\n  PrivateKey = 'private-key',\n}\n\n/**\n * Keyring account options struct for mnemonics (BIP-44).\n */\nexport const KeyringAccountEntropyMnemonicOptionsStruct = object({\n  /**\n   * Indicates that the account was created from a mnemonic phrase.\n   */\n  type: literal(`${KeyringAccountEntropyTypeOption.Mnemonic}`),\n\n  /**\n   * The ID of the entropy source.\n   */\n  id: string(), // TODO: Define a struct for entropy source.\n\n  /**\n   * The BIP-44 derivation path used to derive the account.\n   */\n  derivationPath: string(),\n\n  /**\n   * Index used to group accounts in the UI.\n   *\n   * Accounts sharing the same `groupIndex` are displayed together as a\n   * multichain account group.\n   */\n  groupIndex: number(),\n});\n\n/**\n * Keyring account options for mnemonics (BIP-44) {@link KeyringAccountEntropyMnemonicOptionsStruct}.\n */\nexport type KeyringAccountEntropyMnemonicOptions = Infer<\n  typeof KeyringAccountEntropyMnemonicOptionsStruct\n>;\n\n/**\n * Keyring account options struct for private keys.\n */\nexport const KeyringAccountEntropyPrivateKeyOptionsStruct = object({\n  /**\n   * Indicates that the account was imported from a private key.\n   */\n  type: literal(`${KeyringAccountEntropyTypeOption.PrivateKey}`),\n});\n\n/**\n * Keyring account options for private keys {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.\n */\nexport type KeyringAccountEntropyPrivateKeyOptions = Infer<\n  typeof KeyringAccountEntropyPrivateKeyOptionsStruct\n>;\n\n/**\n * Keyring account entropy options struct.\n */\nexport const KeyringAccountEntropyOptionsStruct = selectiveUnion(\n  (value: any) => {\n    return isPlainObject(value) &&\n      value.type === KeyringAccountEntropyTypeOption.PrivateKey\n      ? KeyringAccountEntropyPrivateKeyOptionsStruct\n      : KeyringAccountEntropyMnemonicOptionsStruct;\n  },\n);\n\n/**\n * Keyring account entropy options {@link KeyringAccountEntropyOptionsStruct}.\n */\nexport type KeyringAccountEntropyOptions = Infer<\n  typeof KeyringAccountEntropyOptionsStruct\n>;\n\n/**\n * Keyring options struct. This represents various options for a Keyring account object.\n *\n * See {@link KeyringAccountEntropyMnemonicOptionsStruct} and\n * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.\n *\n * @example\n * ```ts\n * {\n *   entropy: {\n *     type: 'mnemonic',\n *     id: '01K0BX6VDR5DPDPGGNA8PZVBVB',\n *     derivationPath: \"m/44'/60'/0'/0/0\",\n *     groupIndex: 0,\n *   },\n * }\n * ```\n *\n * @example\n * ```ts\n * {\n *   entropy: {\n *     type: 'private-key',\n *   },\n *   exportable: true,\n * }\n * ```\n *\n * @example\n * ```ts\n * {\n *   some: {\n *     untyped: 'options',\n *     something: true,\n *   },\n * }\n * ```\n */\nexport const KeyringAccountOptionsStruct = intersection([\n  // Non-Typed options (retro-compatibility):\n  record(string(), JsonStruct),\n\n  // Typed options. We use `type` instead of `object` here, to allow\n  // extra properties. Also, since we use `record` + `intersection` we\n  // are guaranteed that all field values will match the `JsonStruct`.\n  //\n  // READ THIS CAREFULLY:\n  // Previous options that can be matched by this struct will be breaking\n  // existing keyring account options.\n  type({\n    /**\n     * Entropy options.\n     */\n    entropy: exactOptional(KeyringAccountEntropyOptionsStruct),\n\n    /**\n     * Indicates whether the account can be exported.\n     */\n    exportable: exactOptional(boolean()),\n  }),\n]);\n\n/**\n * Keyring account options {@link KeyringAccountOptionsStruct}.\n */\nexport type KeyringAccountOptions = Infer<typeof KeyringAccountOptionsStruct>;\n"]}

package/dist/api/account.cjs

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyringAccountStruct = exports.SolAccountType = exports.BtcAccountType = exports.EthAccountType = void 0;
 const keyring_utils_1 = require("@metamask/keyring-utils");
 const superstruct_1 = require("@metamask/superstruct");
-const utils_1 = require("@metamask/utils");
+const account_options_1 = require("./account-options.cjs");
 const caip_1 = require("./caip.cjs");
 /**
  * Supported Ethereum account types.
@@ -65,7 +65,7 @@ exports.KeyringAccountStruct = (0, keyring_utils_1.object)({
     /**
      * Account options.
      */
-    options: (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct),
+    options: account_options_1.KeyringAccountOptionsStruct,
     /**
      * Account supported methods.
      */

package/dist/api/account.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"account.cjs","sourceRoot":"","sources":["../../src/api/account.ts"],"names":[],"mappings":";;;AAAA,2DAAkE;AAElE,uDAA+E;AAC/E,2CAA6C;AAE7C,qCAA2C;AAE3C;;GAEG;AACH,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,oCAAkB,CAAA;IAClB,4CAA0B,CAAA;AAC5B,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AAED;;GAEG;AACH,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,wCAAsB,CAAA;IACtB,sCAAoB,CAAA;IACpB,0CAAwB,CAAA;IACxB,sCAAoB,CAAA;AACtB,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AAED;;GAEG;AACH,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,qDAAmC,CAAA;AACrC,CAAC,EAFW,cAAc,8BAAd,cAAc,QAEzB;AAcD;;;;;;GAMG;AACU,QAAA,oBAAoB,GAAG,IAAA,sBAAM,EAAC;IACzC;;OAEG;IACH,EAAE,EAAE,+BAAe;IAEnB;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC;QACV,GAAG,cAAc,CAAC,GAAG,EAAE;QACvB,GAAG,cAAc,CAAC,OAAO,EAAE;QAC3B,GAAG,cAAc,CAAC,KAAK,EAAE;QACzB,GAAG,cAAc,CAAC,IAAI,EAAE;QACxB,GAAG,cAAc,CAAC,MAAM,EAAE;QAC1B,GAAG,cAAc,CAAC,IAAI,EAAE;QACxB,GAAG,cAAc,CAAC,WAAW,EAAE;KAChC,CAAC;IAEF;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,GAAE;IAEjB;;OAEG;IACH,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,wBAAiB,CAAC,CAAC;IAE1C;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC;IAErC;;OAEG;IACH,OAAO,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC;CACzB,CAAC,CAAC","sourcesContent":["import { AccountIdStruct, object } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { nonempty, array, enums, record, string } from '@metamask/superstruct';\nimport { JsonStruct } from '@metamask/utils';\n\nimport { CaipChainIdStruct } from './caip';\n\n/**\n * Supported Ethereum account types.\n */\nexport enum EthAccountType {\n  Eoa = 'eip155:eoa',\n  Erc4337 = 'eip155:erc4337',\n}\n\n/**\n * Supported Bitcoin account types.\n */\nexport enum BtcAccountType {\n  P2pkh = 'bip122:p2pkh',\n  P2sh = 'bip122:p2sh',\n  P2wpkh = 'bip122:p2wpkh',\n  P2tr = 'bip122:p2tr',\n}\n\n/**\n * Supported Solana account types.\n */\nexport enum SolAccountType {\n  DataAccount = 'solana:data-account',\n}\n\n/**\n * Supported account types.\n */\nexport type KeyringAccountType =\n  | `${EthAccountType.Eoa}`\n  | `${EthAccountType.Erc4337}`\n  | `${BtcAccountType.P2pkh}`\n  | `${BtcAccountType.P2sh}`\n  | `${BtcAccountType.P2wpkh}`\n  | `${BtcAccountType.P2tr}`\n  | `${SolAccountType.DataAccount}`;\n\n/**\n * A struct which represents a Keyring account object. It is abstract enough to\n * be used with any blockchain. Specific blockchain account types should extend\n * this struct.\n *\n * See {@link KeyringAccount}.\n */\nexport const KeyringAccountStruct = object({\n  /**\n   * Account ID (UUIDv4).\n   */\n  id: AccountIdStruct,\n\n  /**\n   * Account type.\n   */\n  type: enums([\n    `${EthAccountType.Eoa}`,\n    `${EthAccountType.Erc4337}`,\n    `${BtcAccountType.P2pkh}`,\n    `${BtcAccountType.P2sh}`,\n    `${BtcAccountType.P2wpkh}`,\n    `${BtcAccountType.P2tr}`,\n    `${SolAccountType.DataAccount}`,\n  ]),\n\n  /**\n   * Account main address.\n   */\n  address: string(),\n\n  /**\n   * Account supported scopes (CAIP-2 chain IDs).\n   */\n  scopes: nonempty(array(CaipChainIdStruct)),\n\n  /**\n   * Account options.\n   */\n  options: record(string(), JsonStruct),\n\n  /**\n   * Account supported methods.\n   */\n  methods: array(string()),\n});\n\n/**\n * Keyring Account type represents an account and its properties from the\n * point of view of the keyring.\n */\nexport type KeyringAccount = Infer<typeof KeyringAccountStruct>;\n"]}
+{"version":3,"file":"account.cjs","sourceRoot":"","sources":["../../src/api/account.ts"],"names":[],"mappings":";;;AAAA,2DAAkE;AAElE,uDAAuE;AAEvE,2DAAgE;AAChE,qCAA2C;AAE3C;;GAEG;AACH,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,oCAAkB,CAAA;IAClB,4CAA0B,CAAA;AAC5B,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AAED;;GAEG;AACH,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,wCAAsB,CAAA;IACtB,sCAAoB,CAAA;IACpB,0CAAwB,CAAA;IACxB,sCAAoB,CAAA;AACtB,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AAED;;GAEG;AACH,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,qDAAmC,CAAA;AACrC,CAAC,EAFW,cAAc,8BAAd,cAAc,QAEzB;AAcD;;;;;;GAMG;AACU,QAAA,oBAAoB,GAAG,IAAA,sBAAM,EAAC;IACzC;;OAEG;IACH,EAAE,EAAE,+BAAe;IAEnB;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC;QACV,GAAG,cAAc,CAAC,GAAG,EAAE;QACvB,GAAG,cAAc,CAAC,OAAO,EAAE;QAC3B,GAAG,cAAc,CAAC,KAAK,EAAE;QACzB,GAAG,cAAc,CAAC,IAAI,EAAE;QACxB,GAAG,cAAc,CAAC,MAAM,EAAE;QAC1B,GAAG,cAAc,CAAC,IAAI,EAAE;QACxB,GAAG,cAAc,CAAC,WAAW,EAAE;KAChC,CAAC;IAEF;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,GAAE;IAEjB;;OAEG;IACH,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,wBAAiB,CAAC,CAAC;IAE1C;;OAEG;IACH,OAAO,EAAE,6CAA2B;IAEpC;;OAEG;IACH,OAAO,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC;CACzB,CAAC,CAAC","sourcesContent":["import { AccountIdStruct, object } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { nonempty, array, enums, string } from '@metamask/superstruct';\n\nimport { KeyringAccountOptionsStruct } from './account-options';\nimport { CaipChainIdStruct } from './caip';\n\n/**\n * Supported Ethereum account types.\n */\nexport enum EthAccountType {\n  Eoa = 'eip155:eoa',\n  Erc4337 = 'eip155:erc4337',\n}\n\n/**\n * Supported Bitcoin account types.\n */\nexport enum BtcAccountType {\n  P2pkh = 'bip122:p2pkh',\n  P2sh = 'bip122:p2sh',\n  P2wpkh = 'bip122:p2wpkh',\n  P2tr = 'bip122:p2tr',\n}\n\n/**\n * Supported Solana account types.\n */\nexport enum SolAccountType {\n  DataAccount = 'solana:data-account',\n}\n\n/**\n * Supported account types.\n */\nexport type KeyringAccountType =\n  | `${EthAccountType.Eoa}`\n  | `${EthAccountType.Erc4337}`\n  | `${BtcAccountType.P2pkh}`\n  | `${BtcAccountType.P2sh}`\n  | `${BtcAccountType.P2wpkh}`\n  | `${BtcAccountType.P2tr}`\n  | `${SolAccountType.DataAccount}`;\n\n/**\n * A struct which represents a Keyring account object. It is abstract enough to\n * be used with any blockchain. Specific blockchain account types should extend\n * this struct.\n *\n * See {@link KeyringAccount}.\n */\nexport const KeyringAccountStruct = object({\n  /**\n   * Account ID (UUIDv4).\n   */\n  id: AccountIdStruct,\n\n  /**\n   * Account type.\n   */\n  type: enums([\n    `${EthAccountType.Eoa}`,\n    `${EthAccountType.Erc4337}`,\n    `${BtcAccountType.P2pkh}`,\n    `${BtcAccountType.P2sh}`,\n    `${BtcAccountType.P2wpkh}`,\n    `${BtcAccountType.P2tr}`,\n    `${SolAccountType.DataAccount}`,\n  ]),\n\n  /**\n   * Account main address.\n   */\n  address: string(),\n\n  /**\n   * Account supported scopes (CAIP-2 chain IDs).\n   */\n  scopes: nonempty(array(CaipChainIdStruct)),\n\n  /**\n   * Account options.\n   */\n  options: KeyringAccountOptionsStruct,\n\n  /**\n   * Account supported methods.\n   */\n  methods: array(string()),\n});\n\n/**\n * Keyring Account type represents an account and its properties from the\n * point of view of the keyring.\n */\nexport type KeyringAccount = Infer<typeof KeyringAccountStruct>;\n"]}

package/dist/api/account.d.cts

@@ -35,7 +35,17 @@ export type KeyringAccountType = `${EthAccountType.Eoa}` | `${EthAccountType.Erc
 export declare const KeyringAccountStruct: import("@metamask/superstruct").Struct<{
     type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account";
     id: string;
-    options: Record<string, import("@metamask/utils").Json>;
+    options: Record<string, import("@metamask/utils").Json> & {
+        entropy?: {
+            type: "mnemonic";
+            id: string;
+            derivationPath: string;
+            groupIndex: number;
+        } | {
+            type: "private-key";
+        };
+        exportable?: boolean;
+    };
     address: string;
     scopes: `${string}:${string}`[];
     methods: string[];
@@ -67,7 +77,17 @@ export declare const KeyringAccountStruct: import("@metamask/superstruct").Struc
     /**
      * Account options.
      */
-    options: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>;
+    options: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json> & {
+        entropy?: {
+            type: "mnemonic";
+            id: string;
+            derivationPath: string;
+            groupIndex: number;
+        } | {
+            type: "private-key";
+        };
+        exportable?: boolean;
+    }, null>;
     /**
      * Account supported methods.
      */

package/dist/api/account.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"account.d.cts","sourceRoot":"","sources":["../../src/api/account.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAMnD;;GAEG;AACH,oBAAY,cAAc;IACxB,GAAG,eAAe;IAClB,OAAO,mBAAmB;CAC3B;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,KAAK,iBAAiB;IACtB,IAAI,gBAAgB;IACpB,MAAM,kBAAkB;IACxB,IAAI,gBAAgB;CACrB;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,WAAW,wBAAwB;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,GAAG,cAAc,CAAC,GAAG,EAAE,GACvB,GAAG,cAAc,CAAC,OAAO,EAAE,GAC3B,GAAG,cAAc,CAAC,KAAK,EAAE,GACzB,GAAG,cAAc,CAAC,IAAI,EAAE,GACxB,GAAG,cAAc,CAAC,MAAM,EAAE,GAC1B,GAAG,cAAc,CAAC,IAAI,EAAE,GACxB,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC;AAEpC;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;IAC/B;;OAEG;;IAGH;;OAEG;;;;;;;;;;IAWH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;EAEH,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}
+{"version":3,"file":"account.d.cts","sourceRoot":"","sources":["../../src/api/account.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAMnD;;GAEG;AACH,oBAAY,cAAc;IACxB,GAAG,eAAe;IAClB,OAAO,mBAAmB;CAC3B;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,KAAK,iBAAiB;IACtB,IAAI,gBAAgB;IACpB,MAAM,kBAAkB;IACxB,IAAI,gBAAgB;CACrB;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,WAAW,wBAAwB;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,GAAG,cAAc,CAAC,GAAG,EAAE,GACvB,GAAG,cAAc,CAAC,OAAO,EAAE,GAC3B,GAAG,cAAc,CAAC,KAAK,EAAE,GACzB,GAAG,cAAc,CAAC,IAAI,EAAE,GACxB,GAAG,cAAc,CAAC,MAAM,EAAE,GAC1B,GAAG,cAAc,CAAC,IAAI,EAAE,GACxB,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC;AAEpC;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;IAC/B;;OAEG;;IAGH;;OAEG;;;;;;;;;;IAWH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;IAGH;;OAEG;;EAEH,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}