@metamask-previews/keyring-api 21.3.0-e40d1ad → 21.3.0-feb98c5

package/CHANGELOG.md

@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Add support for custom capabilities and entropy types in `KeyringV2` ([#415](https://github.com/MetaMask/accounts/pull/415))
+  - Add `custom` capability to `KeyringCapabilities` for keyrings with non-standard `createAccounts` method.
+  - Add `KeyringAccountEntropyTypeOption.Custom` for custom/opaque entropy sources.
+  - Add `AccountCreationType.Custom` and `CreateAccountCustomOptions` for custom account creation flows.
 - Add `EthKeyringWrapper` abstract class for Ethereum-based `KeyringV2` implementations ([#404](https://github.com/MetaMask/accounts/pull/404))
   - Provides common Ethereum signing method routing (`submitRequest`) for all Ethereum-based keyrings.
 - Add `KeyringWrapper` base class to adapt legacy keyrings to `KeyringV2` ([#398](https://github.com/MetaMask/accounts/pull/398)), ([#410](https://github.com/MetaMask/accounts/pull/410))

package/dist/api/account-options.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyringAccountOptionsStruct = exports.KeyringAccountEntropyOptionsStruct = exports.KeyringAccountEntropyPrivateKeyOptionsStruct = exports.KeyringAccountEntropyMnemonicOptionsStruct = exports.KeyringAccountEntropyTypeOption = void 0;
+exports.KeyringAccountOptionsStruct = exports.KeyringAccountEntropyOptionsStruct = exports.KeyringAccountEntropyCustomOptionsStruct = 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");
@@ -17,6 +17,11 @@ var KeyringAccountEntropyTypeOption;
      * Indicates that the account was imported from a private key.
      */
     KeyringAccountEntropyTypeOption["PrivateKey"] = "private-key";
+    /**
+     * Indicates that the account was created with custom, keyring-specific entropy.
+     * This is an opaque type where the entropy source is managed internally by the keyring.
+     */
+    KeyringAccountEntropyTypeOption["Custom"] = "custom";
 })(KeyringAccountEntropyTypeOption || (exports.KeyringAccountEntropyTypeOption = KeyringAccountEntropyTypeOption = {}));
 /**
  * Keyring account options struct for mnemonics (BIP-44).
@@ -51,20 +56,43 @@ exports.KeyringAccountEntropyPrivateKeyOptionsStruct = (0, superstruct_1.object)
      */
     type: (0, superstruct_1.literal)(`${KeyringAccountEntropyTypeOption.PrivateKey}`),
 });
+/**
+ * Keyring account options struct for custom entropy.
+ *
+ * This is an opaque type where the entropy source is managed internally by the keyring.
+ * It behaves similarly to a private key import but allows keyrings to define their own
+ * entropy management strategy.
+ */
+exports.KeyringAccountEntropyCustomOptionsStruct = (0, superstruct_1.object)({
+    /**
+     * Indicates that the account was created with custom, keyring-specific entropy.
+     */
+    type: (0, superstruct_1.literal)(`${KeyringAccountEntropyTypeOption.Custom}`),
+});
 /**
  * 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;
+    if (!(0, utils_1.isPlainObject)(value)) {
+        return exports.KeyringAccountEntropyMnemonicOptionsStruct;
+    }
+    switch (value.type) {
+        case KeyringAccountEntropyTypeOption.PrivateKey:
+            return exports.KeyringAccountEntropyPrivateKeyOptionsStruct;
+        case KeyringAccountEntropyTypeOption.Custom:
+            return exports.KeyringAccountEntropyCustomOptionsStruct;
+        case KeyringAccountEntropyTypeOption.Mnemonic:
+            return exports.KeyringAccountEntropyMnemonicOptionsStruct;
+        default:
+            return exports.KeyringAccountEntropyMnemonicOptionsStruct;
+    }
 });
 /**
  * Keyring options struct. This represents various options for a Keyring account object.
  *
- * See {@link KeyringAccountEntropyMnemonicOptionsStruct} and
- * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.
+ * See {@link KeyringAccountEntropyMnemonicOptionsStruct},
+ * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}, and
+ * {@link KeyringAccountEntropyCustomOptionsStruct}.
  *
  * @example
  * ```ts
@@ -91,6 +119,15 @@ exports.KeyringAccountEntropyOptionsStruct = (0, keyring_utils_1.selectiveUnion)
  * @example
  * ```ts
  * {
+ *   entropy: {
+ *     type: 'custom',
+ *   },
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
  *   some: {
  *     untyped: 'options',
  *     something: true,

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

@@ -1 +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"]}
+{"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,+BAgBX;AAhBD,WAAY,+BAA+B;IACzC;;OAEG;IACH,wDAAqB,CAAA;IAErB;;OAEG;IACH,6DAA0B,CAAA;IAE1B;;;OAGG;IACH,oDAAiB,CAAA;AACnB,CAAC,EAhBW,+BAA+B,+CAA/B,+BAA+B,QAgB1C;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;;;;;;GAMG;AACU,QAAA,wCAAwC,GAAG,IAAA,oBAAM,EAAC;IAC7D;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,GAAG,+BAA+B,CAAC,MAAM,EAAE,CAAC;CAC3D,CAAC,CAAC;AASH;;GAEG;AACU,QAAA,kCAAkC,GAAG,IAAA,8BAAc,EAC9D,CAAC,KAAU,EAAE,EAAE;IACb,IAAI,CAAC,IAAA,qBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,kDAA0C,CAAC;IACpD,CAAC;IAED,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,+BAA+B,CAAC,UAAU;YAC7C,OAAO,oDAA4C,CAAC;QACtD,KAAK,+BAA+B,CAAC,MAAM;YACzC,OAAO,gDAAwC,CAAC;QAClD,KAAK,+BAA+B,CAAC,QAAQ;YAC3C,OAAO,kDAA0C,CAAC;QACpD;YACE,OAAO,kDAA0C,CAAC;IACtD,CAAC;AACH,CAAC,CACF,CAAC;AASF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;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   * Indicates that the account was created with custom, keyring-specific entropy.\n   * This is an opaque type where the entropy source is managed internally by the keyring.\n   */\n  Custom = 'custom',\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 options struct for custom entropy.\n *\n * This is an opaque type where the entropy source is managed internally by the keyring.\n * It behaves similarly to a private key import but allows keyrings to define their own\n * entropy management strategy.\n */\nexport const KeyringAccountEntropyCustomOptionsStruct = object({\n  /**\n   * Indicates that the account was created with custom, keyring-specific entropy.\n   */\n  type: literal(`${KeyringAccountEntropyTypeOption.Custom}`),\n});\n\n/**\n * Keyring account options for custom entropy {@link KeyringAccountEntropyCustomOptionsStruct}.\n */\nexport type KeyringAccountEntropyCustomOptions = Infer<\n  typeof KeyringAccountEntropyCustomOptionsStruct\n>;\n\n/**\n * Keyring account entropy options struct.\n */\nexport const KeyringAccountEntropyOptionsStruct = selectiveUnion(\n  (value: any) => {\n    if (!isPlainObject(value)) {\n      return KeyringAccountEntropyMnemonicOptionsStruct;\n    }\n\n    switch (value.type) {\n      case KeyringAccountEntropyTypeOption.PrivateKey:\n        return KeyringAccountEntropyPrivateKeyOptionsStruct;\n      case KeyringAccountEntropyTypeOption.Custom:\n        return KeyringAccountEntropyCustomOptionsStruct;\n      case KeyringAccountEntropyTypeOption.Mnemonic:\n        return KeyringAccountEntropyMnemonicOptionsStruct;\n      default:\n        return KeyringAccountEntropyMnemonicOptionsStruct;\n    }\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},\n * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}, and\n * {@link KeyringAccountEntropyCustomOptionsStruct}.\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 *   entropy: {\n *     type: 'custom',\n *   },\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

@@ -10,7 +10,12 @@ export declare enum KeyringAccountEntropyTypeOption {
     /**
      * Indicates that the account was imported from a private key.
      */
-    PrivateKey = "private-key"
+    PrivateKey = "private-key",
+    /**
+     * Indicates that the account was created with custom, keyring-specific entropy.
+     * This is an opaque type where the entropy source is managed internally by the keyring.
+     */
+    Custom = "custom"
 }
 /**
  * Keyring account options struct for mnemonics (BIP-44).
@@ -60,6 +65,25 @@ export declare const KeyringAccountEntropyPrivateKeyOptionsStruct: import("@meta
  * Keyring account options for private keys {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.
  */
 export type KeyringAccountEntropyPrivateKeyOptions = Infer<typeof KeyringAccountEntropyPrivateKeyOptionsStruct>;
+/**
+ * Keyring account options struct for custom entropy.
+ *
+ * This is an opaque type where the entropy source is managed internally by the keyring.
+ * It behaves similarly to a private key import but allows keyrings to define their own
+ * entropy management strategy.
+ */
+export declare const KeyringAccountEntropyCustomOptionsStruct: import("@metamask/superstruct").Struct<{
+    type: "custom";
+}, {
+    /**
+     * Indicates that the account was created with custom, keyring-specific entropy.
+     */
+    type: import("@metamask/superstruct").Struct<"custom", "custom">;
+}>;
+/**
+ * Keyring account options for custom entropy {@link KeyringAccountEntropyCustomOptionsStruct}.
+ */
+export type KeyringAccountEntropyCustomOptions = Infer<typeof KeyringAccountEntropyCustomOptionsStruct>;
 /**
  * Keyring account entropy options struct.
  */
@@ -70,6 +94,8 @@ export declare const KeyringAccountEntropyOptionsStruct: import("@metamask/super
     groupIndex: number;
 } | {
     type: "private-key";
+} | {
+    type: "custom";
 }, null>;
 /**
  * Keyring account entropy options {@link KeyringAccountEntropyOptionsStruct}.
@@ -78,8 +104,9 @@ export type KeyringAccountEntropyOptions = Infer<typeof KeyringAccountEntropyOpt
 /**
  * Keyring options struct. This represents various options for a Keyring account object.
  *
- * See {@link KeyringAccountEntropyMnemonicOptionsStruct} and
- * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.
+ * See {@link KeyringAccountEntropyMnemonicOptionsStruct},
+ * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}, and
+ * {@link KeyringAccountEntropyCustomOptionsStruct}.
  *
  * @example
  * ```ts
@@ -106,6 +133,15 @@ export type KeyringAccountEntropyOptions = Infer<typeof KeyringAccountEntropyOpt
  * @example
  * ```ts
  * {
+ *   entropy: {
+ *     type: 'custom',
+ *   },
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
  *   some: {
  *     untyped: 'options',
  *     something: true,
@@ -121,6 +157,8 @@ export declare const KeyringAccountOptionsStruct: import("@metamask/superstruct"
         groupIndex: number;
     } | {
         type: "private-key";
+    } | {
+        type: "custom";
     };
     exportable?: boolean;
 }, null>;

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

@@ -1 +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"}
+{"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;IAE1B;;;OAGG;IACH,MAAM,WAAW;CAClB;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;;;;;;GAMG;AACH,eAAO,MAAM,wCAAwC;;;IACnD;;OAEG;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG,KAAK,CACpD,OAAO,wCAAwC,CAChD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;QAiB9C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAC9C,OAAO,kCAAkC,CAC1C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;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

@@ -10,7 +10,12 @@ export declare enum KeyringAccountEntropyTypeOption {
     /**
      * Indicates that the account was imported from a private key.
      */
-    PrivateKey = "private-key"
+    PrivateKey = "private-key",
+    /**
+     * Indicates that the account was created with custom, keyring-specific entropy.
+     * This is an opaque type where the entropy source is managed internally by the keyring.
+     */
+    Custom = "custom"
 }
 /**
  * Keyring account options struct for mnemonics (BIP-44).
@@ -60,6 +65,25 @@ export declare const KeyringAccountEntropyPrivateKeyOptionsStruct: import("@meta
  * Keyring account options for private keys {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.
  */
 export type KeyringAccountEntropyPrivateKeyOptions = Infer<typeof KeyringAccountEntropyPrivateKeyOptionsStruct>;
+/**
+ * Keyring account options struct for custom entropy.
+ *
+ * This is an opaque type where the entropy source is managed internally by the keyring.
+ * It behaves similarly to a private key import but allows keyrings to define their own
+ * entropy management strategy.
+ */
+export declare const KeyringAccountEntropyCustomOptionsStruct: import("@metamask/superstruct").Struct<{
+    type: "custom";
+}, {
+    /**
+     * Indicates that the account was created with custom, keyring-specific entropy.
+     */
+    type: import("@metamask/superstruct").Struct<"custom", "custom">;
+}>;
+/**
+ * Keyring account options for custom entropy {@link KeyringAccountEntropyCustomOptionsStruct}.
+ */
+export type KeyringAccountEntropyCustomOptions = Infer<typeof KeyringAccountEntropyCustomOptionsStruct>;
 /**
  * Keyring account entropy options struct.
  */
@@ -70,6 +94,8 @@ export declare const KeyringAccountEntropyOptionsStruct: import("@metamask/super
     groupIndex: number;
 } | {
     type: "private-key";
+} | {
+    type: "custom";
 }, null>;
 /**
  * Keyring account entropy options {@link KeyringAccountEntropyOptionsStruct}.
@@ -78,8 +104,9 @@ export type KeyringAccountEntropyOptions = Infer<typeof KeyringAccountEntropyOpt
 /**
  * Keyring options struct. This represents various options for a Keyring account object.
  *
- * See {@link KeyringAccountEntropyMnemonicOptionsStruct} and
- * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.
+ * See {@link KeyringAccountEntropyMnemonicOptionsStruct},
+ * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}, and
+ * {@link KeyringAccountEntropyCustomOptionsStruct}.
  *
  * @example
  * ```ts
@@ -106,6 +133,15 @@ export type KeyringAccountEntropyOptions = Infer<typeof KeyringAccountEntropyOpt
  * @example
  * ```ts
  * {
+ *   entropy: {
+ *     type: 'custom',
+ *   },
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
  *   some: {
  *     untyped: 'options',
  *     something: true,
@@ -121,6 +157,8 @@ export declare const KeyringAccountOptionsStruct: import("@metamask/superstruct"
         groupIndex: number;
     } | {
         type: "private-key";
+    } | {
+        type: "custom";
     };
     exportable?: boolean;
 }, null>;

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

@@ -1 +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"}
+{"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;IAE1B;;;OAGG;IACH,MAAM,WAAW;CAClB;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;;;;;;GAMG;AACH,eAAO,MAAM,wCAAwC;;;IACnD;;OAEG;;EAEH,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG,KAAK,CACpD,OAAO,wCAAwC,CAChD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;QAiB9C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAC9C,OAAO,kCAAkC,CAC1C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;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

@@ -14,6 +14,11 @@ export var KeyringAccountEntropyTypeOption;
      * Indicates that the account was imported from a private key.
      */
     KeyringAccountEntropyTypeOption["PrivateKey"] = "private-key";
+    /**
+     * Indicates that the account was created with custom, keyring-specific entropy.
+     * This is an opaque type where the entropy source is managed internally by the keyring.
+     */
+    KeyringAccountEntropyTypeOption["Custom"] = "custom";
 })(KeyringAccountEntropyTypeOption || (KeyringAccountEntropyTypeOption = {}));
 /**
  * Keyring account options struct for mnemonics (BIP-44).
@@ -48,20 +53,43 @@ export const KeyringAccountEntropyPrivateKeyOptionsStruct = object({
      */
     type: literal(`${KeyringAccountEntropyTypeOption.PrivateKey}`),
 });
+/**
+ * Keyring account options struct for custom entropy.
+ *
+ * This is an opaque type where the entropy source is managed internally by the keyring.
+ * It behaves similarly to a private key import but allows keyrings to define their own
+ * entropy management strategy.
+ */
+export const KeyringAccountEntropyCustomOptionsStruct = object({
+    /**
+     * Indicates that the account was created with custom, keyring-specific entropy.
+     */
+    type: literal(`${KeyringAccountEntropyTypeOption.Custom}`),
+});
 /**
  * Keyring account entropy options struct.
  */
 export const KeyringAccountEntropyOptionsStruct = selectiveUnion((value) => {
-    return isPlainObject(value) &&
-        value.type === KeyringAccountEntropyTypeOption.PrivateKey
-        ? KeyringAccountEntropyPrivateKeyOptionsStruct
-        : KeyringAccountEntropyMnemonicOptionsStruct;
+    if (!isPlainObject(value)) {
+        return KeyringAccountEntropyMnemonicOptionsStruct;
+    }
+    switch (value.type) {
+        case KeyringAccountEntropyTypeOption.PrivateKey:
+            return KeyringAccountEntropyPrivateKeyOptionsStruct;
+        case KeyringAccountEntropyTypeOption.Custom:
+            return KeyringAccountEntropyCustomOptionsStruct;
+        case KeyringAccountEntropyTypeOption.Mnemonic:
+            return KeyringAccountEntropyMnemonicOptionsStruct;
+        default:
+            return KeyringAccountEntropyMnemonicOptionsStruct;
+    }
 });
 /**
  * Keyring options struct. This represents various options for a Keyring account object.
  *
- * See {@link KeyringAccountEntropyMnemonicOptionsStruct} and
- * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}.
+ * See {@link KeyringAccountEntropyMnemonicOptionsStruct},
+ * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}, and
+ * {@link KeyringAccountEntropyCustomOptionsStruct}.
  *
  * @example
  * ```ts
@@ -88,6 +116,15 @@ export const KeyringAccountEntropyOptionsStruct = selectiveUnion((value) => {
  * @example
  * ```ts
  * {
+ *   entropy: {
+ *     type: 'custom',
+ *   },
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * {
  *   some: {
  *     untyped: 'options',
  *     something: true,

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

@@ -1 +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"]}
+{"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,+BAgBX;AAhBD,WAAY,+BAA+B;IACzC;;OAEG;IACH,wDAAqB,CAAA;IAErB;;OAEG;IACH,6DAA0B,CAAA;IAE1B;;;OAGG;IACH,oDAAiB,CAAA;AACnB,CAAC,EAhBW,+BAA+B,KAA/B,+BAA+B,QAgB1C;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;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,wCAAwC,GAAG,MAAM,CAAC;IAC7D;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,GAAG,+BAA+B,CAAC,MAAM,EAAE,CAAC;CAC3D,CAAC,CAAC;AASH;;GAEG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,cAAc,CAC9D,CAAC,KAAU,EAAE,EAAE;IACb,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,0CAA0C,CAAC;IACpD,CAAC;IAED,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,+BAA+B,CAAC,UAAU;YAC7C,OAAO,4CAA4C,CAAC;QACtD,KAAK,+BAA+B,CAAC,MAAM;YACzC,OAAO,wCAAwC,CAAC;QAClD,KAAK,+BAA+B,CAAC,QAAQ;YAC3C,OAAO,0CAA0C,CAAC;QACpD;YACE,OAAO,0CAA0C,CAAC;IACtD,CAAC;AACH,CAAC,CACF,CAAC;AASF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;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   * Indicates that the account was created with custom, keyring-specific entropy.\n   * This is an opaque type where the entropy source is managed internally by the keyring.\n   */\n  Custom = 'custom',\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 options struct for custom entropy.\n *\n * This is an opaque type where the entropy source is managed internally by the keyring.\n * It behaves similarly to a private key import but allows keyrings to define their own\n * entropy management strategy.\n */\nexport const KeyringAccountEntropyCustomOptionsStruct = object({\n  /**\n   * Indicates that the account was created with custom, keyring-specific entropy.\n   */\n  type: literal(`${KeyringAccountEntropyTypeOption.Custom}`),\n});\n\n/**\n * Keyring account options for custom entropy {@link KeyringAccountEntropyCustomOptionsStruct}.\n */\nexport type KeyringAccountEntropyCustomOptions = Infer<\n  typeof KeyringAccountEntropyCustomOptionsStruct\n>;\n\n/**\n * Keyring account entropy options struct.\n */\nexport const KeyringAccountEntropyOptionsStruct = selectiveUnion(\n  (value: any) => {\n    if (!isPlainObject(value)) {\n      return KeyringAccountEntropyMnemonicOptionsStruct;\n    }\n\n    switch (value.type) {\n      case KeyringAccountEntropyTypeOption.PrivateKey:\n        return KeyringAccountEntropyPrivateKeyOptionsStruct;\n      case KeyringAccountEntropyTypeOption.Custom:\n        return KeyringAccountEntropyCustomOptionsStruct;\n      case KeyringAccountEntropyTypeOption.Mnemonic:\n        return KeyringAccountEntropyMnemonicOptionsStruct;\n      default:\n        return KeyringAccountEntropyMnemonicOptionsStruct;\n    }\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},\n * {@link KeyringAccountEntropyPrivateKeyOptionsStruct}, and\n * {@link KeyringAccountEntropyCustomOptionsStruct}.\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 *   entropy: {\n *     type: 'custom',\n *   },\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.d.cts

@@ -70,6 +70,8 @@ export declare const KeyringAccountStruct: import("@metamask/superstruct").Struc
             groupIndex: number;
         } | {
             type: "private-key";
+        } | {
+            type: "custom";
         };
         exportable?: boolean;
     };
@@ -114,6 +116,8 @@ export declare const KeyringAccountStruct: import("@metamask/superstruct").Struc
             groupIndex: number;
         } | {
             type: "private-key";
+        } | {
+            type: "custom";
         };
         exportable?: boolean;
     }, null>;

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,oBAAY,cAAc;IACxB,GAAG,aAAa;CACjB;AAED;;;GAGG;AACH,oBAAY,cAAc;IACxB,OAAO,gBAAgB;CACxB;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,GAC/B,GAAG,cAAc,CAAC,GAAG,EAAE,GACvB,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC;AAEhC;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;EAUnC,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;IAC/B;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;IAaH;;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,oBAAY,cAAc;IACxB,GAAG,aAAa;CACjB;AAED;;;GAGG;AACH,oBAAY,cAAc;IACxB,OAAO,gBAAgB;CACxB;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,GAC/B,GAAG,cAAc,CAAC,GAAG,EAAE,GACvB,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC;AAEhC;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;EAUnC,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;IAC/B;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;IAaH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;;;IAGH;;OAEG;;EAEH,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/dist/api/account.d.mts

@@ -70,6 +70,8 @@ export declare const KeyringAccountStruct: import("@metamask/superstruct").Struc
             groupIndex: number;
         } | {
             type: "private-key";
+        } | {
+            type: "custom";
         };
         exportable?: boolean;
     };
@@ -114,6 +116,8 @@ export declare const KeyringAccountStruct: import("@metamask/superstruct").Struc
             groupIndex: number;
         } | {
             type: "private-key";
+        } | {
+            type: "custom";
         };
         exportable?: boolean;
     }, null>;

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

@@ -1 +1 @@
-{"version":3,"file":"account.d.mts","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,oBAAY,cAAc;IACxB,GAAG,aAAa;CACjB;AAED;;;GAGG;AACH,oBAAY,cAAc;IACxB,OAAO,gBAAgB;CACxB;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,GAC/B,GAAG,cAAc,CAAC,GAAG,EAAE,GACvB,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC;AAEhC;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;EAUnC,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;IAC/B;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;IAaH;;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.mts","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,oBAAY,cAAc;IACxB,GAAG,aAAa;CACjB;AAED;;;GAGG;AACH,oBAAY,cAAc;IACxB,OAAO,gBAAgB;CACxB;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,GAC/B,GAAG,cAAc,CAAC,GAAG,EAAE,GACvB,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC;AAEhC;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;EAUnC,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;IAC/B;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;IAaH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;;;IAGH;;OAEG;;EAEH,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/dist/api/v2/create-account/custom.cjs

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateAccountCustomOptionsStruct = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+/**
+ * Struct for {@link CreateAccountCustomOptions}.
+ */
+exports.CreateAccountCustomOptionsStruct = (0, superstruct_1.type)({
+    /**
+     * The type of the options.
+     */
+    type: (0, superstruct_1.literal)('custom'),
+});
+//# sourceMappingURL=custom.cjs.map

package/dist/api/v2/create-account/custom.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom.cjs","sourceRoot":"","sources":["../../../../src/api/v2/create-account/custom.ts"],"names":[],"mappings":";;;AAAA,uDAAkE;AAElE;;GAEG;AACU,QAAA,gCAAgC,GAAG,IAAA,kBAAI,EAAC;IACnD;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,QAAQ,CAAC;CACxB,CAAC,CAAC","sourcesContent":["import { literal, type, type Infer } from '@metamask/superstruct';\n\n/**\n * Struct for {@link CreateAccountCustomOptions}.\n */\nexport const CreateAccountCustomOptionsStruct = type({\n  /**\n   * The type of the options.\n   */\n  type: literal('custom'),\n});\n\n/**\n * Options for creating an account using a custom, keyring-specific method.\n *\n * This is an opaque type that allows keyrings with non-standard account\n * creation flows to define their own options. Keyrings using this type\n * should declare `custom.createAccounts: true` in their capabilities.\n *\n * The actual options accepted by the keyring are implementation-specific\n * and not validated by this struct beyond the `type` field. Adaptors should\n * handle any additional options as needed and add type intersections as necessary.\n */\nexport type CreateAccountCustomOptions = Infer<\n  typeof CreateAccountCustomOptionsStruct\n>;\n"]}

package/dist/api/v2/create-account/custom.d.cts

@@ -0,0 +1,25 @@
+import { type Infer } from "@metamask/superstruct";
+/**
+ * Struct for {@link CreateAccountCustomOptions}.
+ */
+export declare const CreateAccountCustomOptionsStruct: import("@metamask/superstruct").Struct<{
+    type: "custom";
+}, {
+    /**
+     * The type of the options.
+     */
+    type: import("@metamask/superstruct").Struct<"custom", "custom">;
+}>;
+/**
+ * Options for creating an account using a custom, keyring-specific method.
+ *
+ * This is an opaque type that allows keyrings with non-standard account
+ * creation flows to define their own options. Keyrings using this type
+ * should declare `custom.createAccounts: true` in their capabilities.
+ *
+ * The actual options accepted by the keyring are implementation-specific
+ * and not validated by this struct beyond the `type` field. Adaptors should
+ * handle any additional options as needed and add type intersections as necessary.
+ */
+export type CreateAccountCustomOptions = Infer<typeof CreateAccountCustomOptionsStruct>;
+//# sourceMappingURL=custom.d.cts.map

package/dist/api/v2/create-account/custom.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom.d.cts","sourceRoot":"","sources":["../../../../src/api/v2/create-account/custom.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,KAAK,EAAE,8BAA8B;AAElE;;GAEG;AACH,eAAO,MAAM,gCAAgC;;;IAC3C;;OAEG;;EAEH,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,MAAM,0BAA0B,GAAG,KAAK,CAC5C,OAAO,gCAAgC,CACxC,CAAC"}

package/dist/api/v2/create-account/custom.d.mts

@@ -0,0 +1,25 @@
+import { type Infer } from "@metamask/superstruct";
+/**
+ * Struct for {@link CreateAccountCustomOptions}.
+ */
+export declare const CreateAccountCustomOptionsStruct: import("@metamask/superstruct").Struct<{
+    type: "custom";
+}, {
+    /**
+     * The type of the options.
+     */
+    type: import("@metamask/superstruct").Struct<"custom", "custom">;
+}>;
+/**
+ * Options for creating an account using a custom, keyring-specific method.
+ *
+ * This is an opaque type that allows keyrings with non-standard account
+ * creation flows to define their own options. Keyrings using this type
+ * should declare `custom.createAccounts: true` in their capabilities.
+ *
+ * The actual options accepted by the keyring are implementation-specific
+ * and not validated by this struct beyond the `type` field. Adaptors should
+ * handle any additional options as needed and add type intersections as necessary.
+ */
+export type CreateAccountCustomOptions = Infer<typeof CreateAccountCustomOptionsStruct>;
+//# sourceMappingURL=custom.d.mts.map

package/dist/api/v2/create-account/custom.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom.d.mts","sourceRoot":"","sources":["../../../../src/api/v2/create-account/custom.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,KAAK,EAAE,8BAA8B;AAElE;;GAEG;AACH,eAAO,MAAM,gCAAgC;;;IAC3C;;OAEG;;EAEH,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,MAAM,0BAA0B,GAAG,KAAK,CAC5C,OAAO,gCAAgC,CACxC,CAAC"}

package/dist/api/v2/create-account/custom.mjs

@@ -0,0 +1,11 @@
+import { literal, type } from "@metamask/superstruct";
+/**
+ * Struct for {@link CreateAccountCustomOptions}.
+ */
+export const CreateAccountCustomOptionsStruct = type({
+    /**
+     * The type of the options.
+     */
+    type: literal('custom'),
+});
+//# sourceMappingURL=custom.mjs.map

package/dist/api/v2/create-account/custom.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom.mjs","sourceRoot":"","sources":["../../../../src/api/v2/create-account/custom.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAc,8BAA8B;AAElE;;GAEG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,IAAI,CAAC;IACnD;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC;CACxB,CAAC,CAAC","sourcesContent":["import { literal, type, type Infer } from '@metamask/superstruct';\n\n/**\n * Struct for {@link CreateAccountCustomOptions}.\n */\nexport const CreateAccountCustomOptionsStruct = type({\n  /**\n   * The type of the options.\n   */\n  type: literal('custom'),\n});\n\n/**\n * Options for creating an account using a custom, keyring-specific method.\n *\n * This is an opaque type that allows keyrings with non-standard account\n * creation flows to define their own options. Keyrings using this type\n * should declare `custom.createAccounts: true` in their capabilities.\n *\n * The actual options accepted by the keyring are implementation-specific\n * and not validated by this struct beyond the `type` field. Adaptors should\n * handle any additional options as needed and add type intersections as necessary.\n */\nexport type CreateAccountCustomOptions = Infer<\n  typeof CreateAccountCustomOptionsStruct\n>;\n"]}

package/dist/api/v2/create-account/index.cjs

@@ -17,8 +17,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CreateAccountOptionsStruct = exports.AccountCreationType = void 0;
 const keyring_utils_1 = require("@metamask/keyring-utils");
 const bip44_1 = require("./bip44.cjs");
+const custom_1 = require("./custom.cjs");
 const private_key_1 = require("./private-key.cjs");
 __exportStar(require("./bip44.cjs"), exports);
+__exportStar(require("./custom.cjs"), exports);
 __exportStar(require("./private-key.cjs"), exports);
 /**
  * Enum representing the different ways an account can be created.
@@ -49,6 +51,13 @@ var AccountCreationType;
      * Represents an account imported from a private key.
      */
     AccountCreationType["PrivateKeyImport"] = "private-key:import";
+    /**
+     * Represents an account created using a custom, keyring-specific method.
+     *
+     * This is used by keyrings that have non-standard account creation flows
+     * and declare `custom.createAccounts: true` in their capabilities.
+     */
+    AccountCreationType["Custom"] = "custom";
 })(AccountCreationType || (exports.AccountCreationType = AccountCreationType = {}));
 /**
  * Struct for {@link CreateAccountOptions}.
@@ -64,6 +73,8 @@ exports.CreateAccountOptionsStruct = (0, keyring_utils_1.selectiveUnion)((value)
             return bip44_1.CreateAccountBip44DiscoverOptionsStruct;
         case AccountCreationType.PrivateKeyImport:
             return private_key_1.CreateAccountPrivateKeyOptionsStruct;
+        case AccountCreationType.Custom:
+            return custom_1.CreateAccountCustomOptionsStruct;
         default:
             // Return first struct as fallback - validation will fail with proper error indicating the type mismatch
             return bip44_1.CreateAccountBip44DerivePathOptionsStruct;