@metamask/keyring-api 17.3.0 → 17.4.0

package/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [17.4.0]
+
+### Added
+
+- Add `discoverAccounts` keyring method ([#266](https://github.com/MetaMask/accounts/pull/266))
+- Add `KeyringEventPayload` utility type to extract payload `KeyringEvent` enum ([#203](https://github.com/MetaMask/accounts/pull/203))
+- Add event payload types ([#203](https://github.com/MetaMask/accounts/pull/203))
+
 ## [17.3.0]
 
 ### Added
@@ -553,7 +561,8 @@ 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.3.0...HEAD
+[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-api@17.4.0...HEAD
+[17.4.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-api@17.3.0...@metamask/keyring-api@17.4.0
 [17.3.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-api@17.2.1...@metamask/keyring-api@17.3.0
 [17.2.1]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-api@17.2.0...@metamask/keyring-api@17.2.1
 [17.2.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-api@17.1.0...@metamask/keyring-api@17.2.0

package/dist/api/derivation.cjs

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DerivationPathStruct = void 0;
+const utils_1 = require("@metamask/utils");
+exports.DerivationPathStruct = (0, utils_1.definePattern)('DerivationPath', /^m(?:\/\d+'?)+$/u);
+//# sourceMappingURL=derivation.cjs.map

package/dist/api/derivation.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"derivation.cjs","sourceRoot":"","sources":["../../src/api/derivation.ts"],"names":[],"mappings":";;;AACA,2CAAgD;AAEnC,QAAA,oBAAoB,GAAG,IAAA,qBAAa,EAC/C,gBAAgB,EAChB,kBAAkB,CACnB,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport { definePattern } from '@metamask/utils';\n\nexport const DerivationPathStruct = definePattern<`m/${string}`>(\n  'DerivationPath',\n  /^m(?:\\/\\d+'?)+$/u,\n);\n\nexport type DerivationPath = Infer<typeof DerivationPathStruct>;\n"]}

package/dist/api/derivation.d.cts

@@ -0,0 +1,4 @@
+import type { Infer } from "@metamask/superstruct";
+export declare const DerivationPathStruct: import("@metamask/superstruct").Struct<`m/${string}`, null>;
+export type DerivationPath = Infer<typeof DerivationPathStruct>;
+//# sourceMappingURL=derivation.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"derivation.d.cts","sourceRoot":"","sources":["../../src/api/derivation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAGnD,eAAO,MAAM,oBAAoB,6DAGhC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/dist/api/derivation.d.mts

@@ -0,0 +1,4 @@
+import type { Infer } from "@metamask/superstruct";
+export declare const DerivationPathStruct: import("@metamask/superstruct").Struct<`m/${string}`, null>;
+export type DerivationPath = Infer<typeof DerivationPathStruct>;
+//# sourceMappingURL=derivation.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"derivation.d.mts","sourceRoot":"","sources":["../../src/api/derivation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAGnD,eAAO,MAAM,oBAAoB,6DAGhC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/dist/api/derivation.mjs

@@ -0,0 +1,3 @@
+import { definePattern } from "@metamask/utils";
+export const DerivationPathStruct = definePattern('DerivationPath', /^m(?:\/\d+'?)+$/u);
+//# sourceMappingURL=derivation.mjs.map

package/dist/api/derivation.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"derivation.mjs","sourceRoot":"","sources":["../../src/api/derivation.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,wBAAwB;AAEhD,MAAM,CAAC,MAAM,oBAAoB,GAAG,aAAa,CAC/C,gBAAgB,EAChB,kBAAkB,CACnB,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport { definePattern } from '@metamask/utils';\n\nexport const DerivationPathStruct = definePattern<`m/${string}`>(\n  'DerivationPath',\n  /^m(?:\\/\\d+'?)+$/u,\n);\n\nexport type DerivationPath = Infer<typeof DerivationPathStruct>;\n"]}

package/dist/api/discovery.cjs

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DiscoveredAccountStruct = exports.DiscoveredBip44AccountStruct = exports.DiscoveredAccountType = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+const caip_1 = require("./caip.cjs");
+const derivation_1 = require("./derivation.cjs");
+/**
+ * Account type tag.
+ *
+ * The main use of this enum is to tag the {@link DiscoveredAccount} type for
+ * future use.
+ */
+var DiscoveredAccountType;
+(function (DiscoveredAccountType) {
+    // BIP-44 compatible accounts.
+    DiscoveredAccountType["Bip44"] = "bip44";
+})(DiscoveredAccountType || (exports.DiscoveredAccountType = DiscoveredAccountType = {}));
+/**
+ * This struct represents a discovered BIP-44 compatible account.
+ *
+ * It supports BIP-44 in a non-strict way. The derivation path MUST HAVE at
+ * least 1 segment.
+ */
+exports.DiscoveredBip44AccountStruct = (0, superstruct_1.object)({
+    /**
+     * Account type.
+     */
+    type: (0, superstruct_1.literal)(`${DiscoveredAccountType.Bip44}`),
+    /**
+     * Account supported scopes (CAIP-2 chain IDs).
+     */
+    scopes: (0, superstruct_1.array)(caip_1.CaipChainIdStruct),
+    /**
+     * The derivation path for this account. It MUST HAVE at least 1 segment.
+     */
+    derivationPath: derivation_1.DerivationPathStruct,
+});
+// Could become a union if we have new discovered account type.
+exports.DiscoveredAccountStruct = exports.DiscoveredBip44AccountStruct;
+//# sourceMappingURL=discovery.cjs.map

package/dist/api/discovery.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"discovery.cjs","sourceRoot":"","sources":["../../src/api/discovery.ts"],"names":[],"mappings":";;;AACA,uDAA+D;AAE/D,qCAA2C;AAC3C,iDAAoD;AAEpD;;;;;GAKG;AACH,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC/B,8BAA8B;IAC9B,wCAAe,CAAA;AACjB,CAAC,EAHW,qBAAqB,qCAArB,qBAAqB,QAGhC;AAED;;;;;GAKG;AACU,QAAA,4BAA4B,GAAG,IAAA,oBAAM,EAAC;IACjD;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,GAAG,qBAAqB,CAAC,KAAK,EAAE,CAAC;IAE/C;;OAEG;IACH,MAAM,EAAE,IAAA,mBAAK,EAAC,wBAAiB,CAAC;IAEhC;;OAEG;IACH,cAAc,EAAE,iCAAoB;CACrC,CAAC,CAAC;AASH,+DAA+D;AAClD,QAAA,uBAAuB,GAAG,oCAA4B,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport { array, literal, object } from '@metamask/superstruct';\n\nimport { CaipChainIdStruct } from './caip';\nimport { DerivationPathStruct } from './derivation';\n\n/**\n * Account type tag.\n *\n * The main use of this enum is to tag the {@link DiscoveredAccount} type for\n * future use.\n */\nexport enum DiscoveredAccountType {\n  // BIP-44 compatible accounts.\n  Bip44 = 'bip44',\n}\n\n/**\n * This struct represents a discovered BIP-44 compatible account.\n *\n * It supports BIP-44 in a non-strict way. The derivation path MUST HAVE at\n * least 1 segment.\n */\nexport const DiscoveredBip44AccountStruct = object({\n  /**\n   * Account type.\n   */\n  type: literal(`${DiscoveredAccountType.Bip44}`),\n\n  /**\n   * Account supported scopes (CAIP-2 chain IDs).\n   */\n  scopes: array(CaipChainIdStruct),\n\n  /**\n   * The derivation path for this account. It MUST HAVE at least 1 segment.\n   */\n  derivationPath: DerivationPathStruct,\n});\n\n/**\n * Discovered BIP-44 account object.\n *\n * See {@link TransactionStruct}.\n */\nexport type DiscoveredBip44Account = Infer<typeof DiscoveredBip44AccountStruct>;\n\n// Could become a union if we have new discovered account type.\nexport const DiscoveredAccountStruct = DiscoveredBip44AccountStruct;\n\n/**\n * Discovered account object.\n *\n * See {@link DiscoveredAccountStruct}.\n */\nexport type DiscoveredAccount = Infer<typeof DiscoveredAccountStruct>;\n"]}

package/dist/api/discovery.d.cts

@@ -0,0 +1,65 @@
+import type { Infer } from "@metamask/superstruct";
+/**
+ * Account type tag.
+ *
+ * The main use of this enum is to tag the {@link DiscoveredAccount} type for
+ * future use.
+ */
+export declare enum DiscoveredAccountType {
+    Bip44 = "bip44"
+}
+/**
+ * This struct represents a discovered BIP-44 compatible account.
+ *
+ * It supports BIP-44 in a non-strict way. The derivation path MUST HAVE at
+ * least 1 segment.
+ */
+export declare const DiscoveredBip44AccountStruct: import("@metamask/superstruct").Struct<{
+    type: "bip44";
+    scopes: `${string}:${string}`[];
+    derivationPath: `m/${string}`;
+}, {
+    /**
+     * Account type.
+     */
+    type: import("@metamask/superstruct").Struct<"bip44", "bip44">;
+    /**
+     * Account supported scopes (CAIP-2 chain IDs).
+     */
+    scopes: import("@metamask/superstruct").Struct<`${string}:${string}`[], import("@metamask/superstruct").Struct<`${string}:${string}`, null>>;
+    /**
+     * The derivation path for this account. It MUST HAVE at least 1 segment.
+     */
+    derivationPath: import("@metamask/superstruct").Struct<`m/${string}`, null>;
+}>;
+/**
+ * Discovered BIP-44 account object.
+ *
+ * See {@link TransactionStruct}.
+ */
+export type DiscoveredBip44Account = Infer<typeof DiscoveredBip44AccountStruct>;
+export declare const DiscoveredAccountStruct: import("@metamask/superstruct").Struct<{
+    type: "bip44";
+    scopes: `${string}:${string}`[];
+    derivationPath: `m/${string}`;
+}, {
+    /**
+     * Account type.
+     */
+    type: import("@metamask/superstruct").Struct<"bip44", "bip44">;
+    /**
+     * Account supported scopes (CAIP-2 chain IDs).
+     */
+    scopes: import("@metamask/superstruct").Struct<`${string}:${string}`[], import("@metamask/superstruct").Struct<`${string}:${string}`, null>>;
+    /**
+     * The derivation path for this account. It MUST HAVE at least 1 segment.
+     */
+    derivationPath: import("@metamask/superstruct").Struct<`m/${string}`, null>;
+}>;
+/**
+ * Discovered account object.
+ *
+ * See {@link DiscoveredAccountStruct}.
+ */
+export type DiscoveredAccount = Infer<typeof DiscoveredAccountStruct>;
+//# sourceMappingURL=discovery.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"discovery.d.cts","sourceRoot":"","sources":["../../src/api/discovery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAMnD;;;;;GAKG;AACH,oBAAY,qBAAqB;IAE/B,KAAK,UAAU;CAChB;AAED;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B;;;;;IACvC;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;EAEH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAGhF,eAAO,MAAM,uBAAuB;;;;;IAxBlC;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;EAY8D,CAAC;AAEpE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC"}

package/dist/api/discovery.d.mts

@@ -0,0 +1,65 @@
+import type { Infer } from "@metamask/superstruct";
+/**
+ * Account type tag.
+ *
+ * The main use of this enum is to tag the {@link DiscoveredAccount} type for
+ * future use.
+ */
+export declare enum DiscoveredAccountType {
+    Bip44 = "bip44"
+}
+/**
+ * This struct represents a discovered BIP-44 compatible account.
+ *
+ * It supports BIP-44 in a non-strict way. The derivation path MUST HAVE at
+ * least 1 segment.
+ */
+export declare const DiscoveredBip44AccountStruct: import("@metamask/superstruct").Struct<{
+    type: "bip44";
+    scopes: `${string}:${string}`[];
+    derivationPath: `m/${string}`;
+}, {
+    /**
+     * Account type.
+     */
+    type: import("@metamask/superstruct").Struct<"bip44", "bip44">;
+    /**
+     * Account supported scopes (CAIP-2 chain IDs).
+     */
+    scopes: import("@metamask/superstruct").Struct<`${string}:${string}`[], import("@metamask/superstruct").Struct<`${string}:${string}`, null>>;
+    /**
+     * The derivation path for this account. It MUST HAVE at least 1 segment.
+     */
+    derivationPath: import("@metamask/superstruct").Struct<`m/${string}`, null>;
+}>;
+/**
+ * Discovered BIP-44 account object.
+ *
+ * See {@link TransactionStruct}.
+ */
+export type DiscoveredBip44Account = Infer<typeof DiscoveredBip44AccountStruct>;
+export declare const DiscoveredAccountStruct: import("@metamask/superstruct").Struct<{
+    type: "bip44";
+    scopes: `${string}:${string}`[];
+    derivationPath: `m/${string}`;
+}, {
+    /**
+     * Account type.
+     */
+    type: import("@metamask/superstruct").Struct<"bip44", "bip44">;
+    /**
+     * Account supported scopes (CAIP-2 chain IDs).
+     */
+    scopes: import("@metamask/superstruct").Struct<`${string}:${string}`[], import("@metamask/superstruct").Struct<`${string}:${string}`, null>>;
+    /**
+     * The derivation path for this account. It MUST HAVE at least 1 segment.
+     */
+    derivationPath: import("@metamask/superstruct").Struct<`m/${string}`, null>;
+}>;
+/**
+ * Discovered account object.
+ *
+ * See {@link DiscoveredAccountStruct}.
+ */
+export type DiscoveredAccount = Infer<typeof DiscoveredAccountStruct>;
+//# sourceMappingURL=discovery.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"discovery.d.mts","sourceRoot":"","sources":["../../src/api/discovery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAMnD;;;;;GAKG;AACH,oBAAY,qBAAqB;IAE/B,KAAK,UAAU;CAChB;AAED;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B;;;;;IACvC;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;EAEH,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAGhF,eAAO,MAAM,uBAAuB;;;;;IAxBlC;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;EAY8D,CAAC;AAEpE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC"}

package/dist/api/discovery.mjs

@@ -0,0 +1,37 @@
+import { array, literal, object } from "@metamask/superstruct";
+import { CaipChainIdStruct } from "./caip.mjs";
+import { DerivationPathStruct } from "./derivation.mjs";
+/**
+ * Account type tag.
+ *
+ * The main use of this enum is to tag the {@link DiscoveredAccount} type for
+ * future use.
+ */
+export var DiscoveredAccountType;
+(function (DiscoveredAccountType) {
+    // BIP-44 compatible accounts.
+    DiscoveredAccountType["Bip44"] = "bip44";
+})(DiscoveredAccountType || (DiscoveredAccountType = {}));
+/**
+ * This struct represents a discovered BIP-44 compatible account.
+ *
+ * It supports BIP-44 in a non-strict way. The derivation path MUST HAVE at
+ * least 1 segment.
+ */
+export const DiscoveredBip44AccountStruct = object({
+    /**
+     * Account type.
+     */
+    type: literal(`${DiscoveredAccountType.Bip44}`),
+    /**
+     * Account supported scopes (CAIP-2 chain IDs).
+     */
+    scopes: array(CaipChainIdStruct),
+    /**
+     * The derivation path for this account. It MUST HAVE at least 1 segment.
+     */
+    derivationPath: DerivationPathStruct,
+});
+// Could become a union if we have new discovered account type.
+export const DiscoveredAccountStruct = DiscoveredBip44AccountStruct;
+//# sourceMappingURL=discovery.mjs.map

package/dist/api/discovery.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"discovery.mjs","sourceRoot":"","sources":["../../src/api/discovery.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,8BAA8B;AAE/D,OAAO,EAAE,iBAAiB,EAAE,mBAAe;AAC3C,OAAO,EAAE,oBAAoB,EAAE,yBAAqB;AAEpD;;;;;GAKG;AACH,MAAM,CAAN,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC/B,8BAA8B;IAC9B,wCAAe,CAAA;AACjB,CAAC,EAHW,qBAAqB,KAArB,qBAAqB,QAGhC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,MAAM,CAAC;IACjD;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,GAAG,qBAAqB,CAAC,KAAK,EAAE,CAAC;IAE/C;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC;IAEhC;;OAEG;IACH,cAAc,EAAE,oBAAoB;CACrC,CAAC,CAAC;AASH,+DAA+D;AAC/D,MAAM,CAAC,MAAM,uBAAuB,GAAG,4BAA4B,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport { array, literal, object } from '@metamask/superstruct';\n\nimport { CaipChainIdStruct } from './caip';\nimport { DerivationPathStruct } from './derivation';\n\n/**\n * Account type tag.\n *\n * The main use of this enum is to tag the {@link DiscoveredAccount} type for\n * future use.\n */\nexport enum DiscoveredAccountType {\n  // BIP-44 compatible accounts.\n  Bip44 = 'bip44',\n}\n\n/**\n * This struct represents a discovered BIP-44 compatible account.\n *\n * It supports BIP-44 in a non-strict way. The derivation path MUST HAVE at\n * least 1 segment.\n */\nexport const DiscoveredBip44AccountStruct = object({\n  /**\n   * Account type.\n   */\n  type: literal(`${DiscoveredAccountType.Bip44}`),\n\n  /**\n   * Account supported scopes (CAIP-2 chain IDs).\n   */\n  scopes: array(CaipChainIdStruct),\n\n  /**\n   * The derivation path for this account. It MUST HAVE at least 1 segment.\n   */\n  derivationPath: DerivationPathStruct,\n});\n\n/**\n * Discovered BIP-44 account object.\n *\n * See {@link TransactionStruct}.\n */\nexport type DiscoveredBip44Account = Infer<typeof DiscoveredBip44AccountStruct>;\n\n// Could become a union if we have new discovered account type.\nexport const DiscoveredAccountStruct = DiscoveredBip44AccountStruct;\n\n/**\n * Discovered account object.\n *\n * See {@link DiscoveredAccountStruct}.\n */\nexport type DiscoveredAccount = Infer<typeof DiscoveredAccountStruct>;\n"]}

package/dist/api/entropy.cjs

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

package/dist/api/entropy.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"entropy.cjs","sourceRoot":"","sources":["../../src/api/entropy.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Entropy source ID.\n */\nexport type EntropySourceId = string;\n"]}

package/dist/api/entropy.d.cts

@@ -0,0 +1,5 @@
+/**
+ * Entropy source ID.
+ */
+export type EntropySourceId = string;
+//# sourceMappingURL=entropy.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entropy.d.cts","sourceRoot":"","sources":["../../src/api/entropy.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC"}

package/dist/api/entropy.d.mts

@@ -0,0 +1,5 @@
+/**
+ * Entropy source ID.
+ */
+export type EntropySourceId = string;
+//# sourceMappingURL=entropy.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entropy.d.mts","sourceRoot":"","sources":["../../src/api/entropy.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC"}

package/dist/api/entropy.mjs

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

package/dist/api/entropy.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"entropy.mjs","sourceRoot":"","sources":["../../src/api/entropy.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Entropy source ID.\n */\nexport type EntropySourceId = string;\n"]}

package/dist/api/index.cjs

@@ -19,6 +19,7 @@ __exportStar(require("./address.cjs"), exports);
 __exportStar(require("./asset.cjs"), exports);
 __exportStar(require("./balance.cjs"), exports);
 __exportStar(require("./caip.cjs"), exports);
+__exportStar(require("./discovery.cjs"), exports);
 __exportStar(require("./export.cjs"), exports);
 __exportStar(require("./request.cjs"), exports);
 __exportStar(require("./response.cjs"), exports);

package/dist/api/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA0B;AAC1B,gDAA0B;AAC1B,8CAAwB;AACxB,gDAA0B;AAC1B,6CAAuB;AACvB,+CAAyB;AACzB,gDAA0B;AAC1B,iDAA2B;AAC3B,oDAA8B;AAC9B,mDAA6B;AAC7B,gDAA0B","sourcesContent":["export * from './account';\nexport * from './address';\nexport * from './asset';\nexport * from './balance';\nexport * from './caip';\nexport * from './export';\nexport * from './request';\nexport * from './response';\nexport * from './transaction';\nexport * from './pagination';\nexport * from './options';\nexport type * from './keyring';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA0B;AAC1B,gDAA0B;AAC1B,8CAAwB;AACxB,gDAA0B;AAC1B,6CAAuB;AACvB,kDAA4B;AAE5B,+CAAyB;AACzB,gDAA0B;AAC1B,iDAA2B;AAC3B,oDAA8B;AAC9B,mDAA6B;AAC7B,gDAA0B","sourcesContent":["export * from './account';\nexport * from './address';\nexport * from './asset';\nexport * from './balance';\nexport * from './caip';\nexport * from './discovery';\nexport type * from './entropy';\nexport * from './export';\nexport * from './request';\nexport * from './response';\nexport * from './transaction';\nexport * from './pagination';\nexport * from './options';\nexport type * from './keyring';\n"]}

package/dist/api/index.d.cts

@@ -3,6 +3,8 @@ export * from "./address.cjs";
 export * from "./asset.cjs";
 export * from "./balance.cjs";
 export * from "./caip.cjs";
+export * from "./discovery.cjs";
+export type * from "./entropy.cjs";
 export * from "./export.cjs";
 export * from "./request.cjs";
 export * from "./response.cjs";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,8BAA0B;AAC1B,8BAA0B;AAC1B,4BAAwB;AACxB,8BAA0B;AAC1B,2BAAuB;AACvB,6BAAyB;AACzB,8BAA0B;AAC1B,+BAA2B;AAC3B,kCAA8B;AAC9B,iCAA6B;AAC7B,8BAA0B;AAC1B,mCAA+B"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,8BAA0B;AAC1B,8BAA0B;AAC1B,4BAAwB;AACxB,8BAA0B;AAC1B,2BAAuB;AACvB,gCAA4B;AAC5B,mCAA+B;AAC/B,6BAAyB;AACzB,8BAA0B;AAC1B,+BAA2B;AAC3B,kCAA8B;AAC9B,iCAA6B;AAC7B,8BAA0B;AAC1B,mCAA+B"}

package/dist/api/index.d.mts

@@ -3,6 +3,8 @@ export * from "./address.mjs";
 export * from "./asset.mjs";
 export * from "./balance.mjs";
 export * from "./caip.mjs";
+export * from "./discovery.mjs";
+export type * from "./entropy.mjs";
 export * from "./export.mjs";
 export * from "./request.mjs";
 export * from "./response.mjs";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,8BAA0B;AAC1B,8BAA0B;AAC1B,4BAAwB;AACxB,8BAA0B;AAC1B,2BAAuB;AACvB,6BAAyB;AACzB,8BAA0B;AAC1B,+BAA2B;AAC3B,kCAA8B;AAC9B,iCAA6B;AAC7B,8BAA0B;AAC1B,mCAA+B"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,8BAA0B;AAC1B,8BAA0B;AAC1B,4BAAwB;AACxB,8BAA0B;AAC1B,2BAAuB;AACvB,gCAA4B;AAC5B,mCAA+B;AAC/B,6BAAyB;AACzB,8BAA0B;AAC1B,+BAA2B;AAC3B,kCAA8B;AAC9B,iCAA6B;AAC7B,8BAA0B;AAC1B,mCAA+B"}

package/dist/api/index.mjs

@@ -3,6 +3,7 @@ export * from "./address.mjs";
 export * from "./asset.mjs";
 export * from "./balance.mjs";
 export * from "./caip.mjs";
+export * from "./discovery.mjs";
 export * from "./export.mjs";
 export * from "./request.mjs";
 export * from "./response.mjs";

package/dist/api/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,8BAA0B;AAC1B,8BAA0B;AAC1B,4BAAwB;AACxB,8BAA0B;AAC1B,2BAAuB;AACvB,6BAAyB;AACzB,8BAA0B;AAC1B,+BAA2B;AAC3B,kCAA8B;AAC9B,iCAA6B;AAC7B,8BAA0B","sourcesContent":["export * from './account';\nexport * from './address';\nexport * from './asset';\nexport * from './balance';\nexport * from './caip';\nexport * from './export';\nexport * from './request';\nexport * from './response';\nexport * from './transaction';\nexport * from './pagination';\nexport * from './options';\nexport type * from './keyring';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,8BAA0B;AAC1B,8BAA0B;AAC1B,4BAAwB;AACxB,8BAA0B;AAC1B,2BAAuB;AACvB,gCAA4B;AAE5B,6BAAyB;AACzB,8BAA0B;AAC1B,+BAA2B;AAC3B,kCAA8B;AAC9B,iCAA6B;AAC7B,8BAA0B","sourcesContent":["export * from './account';\nexport * from './address';\nexport * from './asset';\nexport * from './balance';\nexport * from './caip';\nexport * from './discovery';\nexport type * from './entropy';\nexport * from './export';\nexport * from './request';\nexport * from './response';\nexport * from './transaction';\nexport * from './pagination';\nexport * from './options';\nexport type * from './keyring';\n"]}

package/dist/api/keyring.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"keyring.cjs","sourceRoot":"","sources":["../../src/api/keyring.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,6EAA6E","sourcesContent":["/* eslint-disable @typescript-eslint/no-redundant-type-constituents */\n// This rule seems to be triggering a false positive on the `KeyringAccount`.\n\nimport type { JsonRpcRequest } from '@metamask/keyring-utils';\nimport type { Json } from '@metamask/utils';\n\nimport type { KeyringAccount } from './account';\nimport type { ResolvedAccountAddress } from './address';\nimport type { Balance } from './balance';\nimport type { CaipChainId, CaipAssetType, CaipAssetTypeOrId } from './caip';\nimport type { KeyringAccountData } from './export';\nimport type { MetaMaskOptions } from './options';\nimport type { Paginated, Pagination } from './pagination';\nimport type { KeyringRequest } from './request';\nimport type { KeyringResponse } from './response';\nimport type { Transaction } from './transaction';\n\n/**\n * Keyring interface.\n *\n * Represents the functionality and operations related to managing accounts and\n * handling requests.\n */\nexport type Keyring = {\n  /**\n   * List accounts.\n   *\n   * Retrieves an array of KeyringAccount objects representing the available\n   * accounts.\n   *\n   * @returns A promise that resolves to an array of KeyringAccount objects.\n   */\n  listAccounts(): Promise<KeyringAccount[]>;\n\n  /**\n   * Get an account.\n   *\n   * Retrieves the KeyringAccount object for the given account ID.\n   *\n   * @param id - The ID of the account to retrieve.\n   * @returns A promise that resolves to the KeyringAccount object if found, or\n   * undefined otherwise.\n   */\n  getAccount(id: string): Promise<KeyringAccount | undefined>;\n\n  /**\n   * Create an account.\n   *\n   * Creates a new account with optional, keyring-defined, account options.\n   *\n   * @param options - Keyring-defined options for the account (optional). The\n   * 'metamask' internal options needs to be re-emitted during `notify:*` events.\n   * @returns A promise that resolves to the newly created KeyringAccount\n   * object without any private information.\n   */\n  createAccount(\n    options?: Record<string, Json> & MetaMaskOptions,\n  ): Promise<KeyringAccount>;\n\n  /**\n   * Lists the assets of an account (fungibles and non-fungibles) represented\n   * by their respective CAIP-19:\n   * - Asset types for fungibles assets.\n   * - Asset IDs for non-fungible ones.\n   *\n   * @param id - The ID of the account to list the assets for.\n   * @returns A promise that resolves to list of assets for that account.\n   */\n  listAccountAssets?(id: string): Promise<CaipAssetTypeOrId[]>;\n\n  /**\n   * Lists the transactions of an account, paginated and ordered by the most\n   * recent first.\n   *\n   * The pagination options are used to limit the number of transactions in the\n   * response and to iterate over the results.\n   *\n   * @param id - The ID of the account to list the transactions for.\n   * @param pagination - The pagination options.\n   * @returns A promise that resolves to the next page of transactions.\n   */\n  listAccountTransactions?(\n    id: string,\n    pagination: Pagination,\n  ): Promise<Paginated<Transaction>>;\n\n  /**\n   * Retrieve the balances of a given account.\n   *\n   * This method fetches the balances of specified assets for a given account\n   * ID. It returns a promise that resolves to an object where the keys are\n   * asset types and the values are balance objects containing the amount and\n   * unit.\n   *\n   * @example\n   * ```ts\n   * await keyring.getAccountBalances(\n   *   '43550276-c7d6-4fac-87c7-00390ad0ce90',\n   *   ['bip122:000000000019d6689c085ae165831e93/slip44:0']\n   * );\n   * // Returns something similar to:\n   * // {\n   * //   'bip122:000000000019d6689c085ae165831e93/slip44:0': {\n   * //     amount: '0.0001',\n   * //     unit: 'BTC',\n   * //   }\n   * // }\n   * ```\n   * @param id - ID of the account to retrieve the balances for.\n   * @param assets - Array of asset types (CAIP-19) to retrieve balances for.\n   * @returns A promise that resolves to an object mapping asset types to their\n   * respective balances.\n   */\n  getAccountBalances?(\n    id: string,\n    assets: CaipAssetType[],\n  ): Promise<Record<CaipAssetType, Balance>>;\n\n  /**\n   * Resolves the address of an account from a signing request.\n   *\n   * This is required by the routing system of MetaMask to dispatch\n   * incoming non-EVM dapp signing requests.\n   *\n   * @param scope - Request's scope (CAIP-2).\n   * @param request - Signing request object.\n   * @returns A Promise that resolves to the account address that must\n   * be used to process this signing request, or null if none candidates\n   * could be found.\n   */\n  resolveAccountAddress?(\n    scope: CaipChainId,\n    request: JsonRpcRequest,\n  ): Promise<ResolvedAccountAddress | null>;\n\n  /**\n   * Filter supported chains for a given account.\n   *\n   * @param id - ID of the account to be checked.\n   * @param chains - List of chains (CAIP-2) to be checked.\n   * @returns A Promise that resolves to a filtered list of CAIP-2 IDs\n   * representing the supported chains.\n   */\n  filterAccountChains(id: string, chains: string[]): Promise<string[]>;\n\n  /**\n   * Update an account.\n   *\n   * Updates the account with the given account object. Does nothing if the\n   * account does not exist.\n   *\n   * @param account - The updated account object.\n   * @returns A promise that resolves when the account is successfully updated.\n   */\n  updateAccount(account: KeyringAccount): Promise<void>;\n\n  /**\n   * Delete an account from the keyring.\n   *\n   * Deletes the account with the given ID from the keyring.\n   *\n   * @param id - The ID of the account to delete.\n   * @returns A promise that resolves when the account is successfully deleted.\n   */\n  deleteAccount(id: string): Promise<void>;\n\n  /**\n   * Exports an account's private key.\n   *\n   * If the keyring cannot export a private key, this function should throw an\n   * error.\n   *\n   * @param id - The ID of the account to export.\n   * @returns A promise that resolves to the exported account.\n   */\n  exportAccount?(id: string): Promise<KeyringAccountData>;\n\n  /**\n   * List all submitted requests.\n   *\n   * Retrieves an array of KeyringRequest objects representing the submitted\n   * requests.\n   *\n   * @returns A promise that resolves to an array of KeyringRequest objects.\n   */\n  listRequests?(): Promise<KeyringRequest[]>;\n\n  /**\n   * Get a request.\n   *\n   * Retrieves the KeyringRequest object for the given request ID.\n   *\n   * @param id - The ID of the request to retrieve.\n   * @returns A promise that resolves to the KeyringRequest object if found, or\n   * undefined otherwise.\n   */\n  getRequest?(id: string): Promise<KeyringRequest | undefined>;\n\n  /**\n   * Submit a request.\n   *\n   * Submits the given KeyringRequest object.\n   *\n   * @param request - The KeyringRequest object to submit.\n   * @returns A promise that resolves to the request response.\n   */\n  submitRequest(request: KeyringRequest): Promise<KeyringResponse>;\n\n  /**\n   * Approve a request.\n   *\n   * Approves the request with the given ID and sets the response if provided.\n   *\n   * @param id - The ID of the request to approve.\n   * @param data - The response to the request (optional).\n   * @returns A promise that resolves when the request is successfully\n   * approved.\n   */\n  approveRequest?(id: string, data?: Record<string, Json>): Promise<void>;\n\n  /**\n   * Reject a request.\n   *\n   * Rejects the request with the given ID.\n   *\n   * @param id - The ID of the request to reject.\n   * @returns A promise that resolves when the request is successfully\n   * rejected.\n   */\n  rejectRequest?(id: string): Promise<void>;\n};\n"]}
+{"version":3,"file":"keyring.cjs","sourceRoot":"","sources":["../../src/api/keyring.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,6EAA6E","sourcesContent":["/* eslint-disable @typescript-eslint/no-redundant-type-constituents */\n// This rule seems to be triggering a false positive on the `KeyringAccount`.\n\nimport type { JsonRpcRequest } from '@metamask/keyring-utils';\nimport type { Json } from '@metamask/utils';\n\nimport type { KeyringAccount } from './account';\nimport type { ResolvedAccountAddress } from './address';\nimport type { Balance } from './balance';\nimport type { CaipChainId, CaipAssetType, CaipAssetTypeOrId } from './caip';\nimport type { DiscoveredAccount } from './discovery';\nimport type { EntropySourceId } from './entropy';\nimport type { KeyringAccountData } from './export';\nimport type { MetaMaskOptions } from './options';\nimport type { Paginated, Pagination } from './pagination';\nimport type { KeyringRequest } from './request';\nimport type { KeyringResponse } from './response';\nimport type { Transaction } from './transaction';\n\n/**\n * Keyring interface.\n *\n * Represents the functionality and operations related to managing accounts and\n * handling requests.\n */\nexport type Keyring = {\n  /**\n   * List accounts.\n   *\n   * Retrieves an array of KeyringAccount objects representing the available\n   * accounts.\n   *\n   * @returns A promise that resolves to an array of KeyringAccount objects.\n   */\n  listAccounts(): Promise<KeyringAccount[]>;\n\n  /**\n   * Get an account.\n   *\n   * Retrieves the KeyringAccount object for the given account ID.\n   *\n   * @param id - The ID of the account to retrieve.\n   * @returns A promise that resolves to the KeyringAccount object if found, or\n   * undefined otherwise.\n   */\n  getAccount(id: string): Promise<KeyringAccount | undefined>;\n\n  /**\n   * Create an account.\n   *\n   * Creates a new account with optional, keyring-defined, account options.\n   *\n   * @param options - Keyring-defined options for the account (optional). The\n   * 'metamask' internal options needs to be re-emitted during `notify:*` events.\n   * @returns A promise that resolves to the newly created KeyringAccount\n   * object without any private information.\n   */\n  createAccount(\n    options?: Record<string, Json> & MetaMaskOptions,\n  ): Promise<KeyringAccount>;\n\n  /**\n   * Lists the assets of an account (fungibles and non-fungibles) represented\n   * by their respective CAIP-19:\n   * - Asset types for fungibles assets.\n   * - Asset IDs for non-fungible ones.\n   *\n   * @param id - The ID of the account to list the assets for.\n   * @returns A promise that resolves to list of assets for that account.\n   */\n  listAccountAssets?(id: string): Promise<CaipAssetTypeOrId[]>;\n\n  /**\n   * Lists the transactions of an account, paginated and ordered by the most\n   * recent first.\n   *\n   * The pagination options are used to limit the number of transactions in the\n   * response and to iterate over the results.\n   *\n   * @param id - The ID of the account to list the transactions for.\n   * @param pagination - The pagination options.\n   * @returns A promise that resolves to the next page of transactions.\n   */\n  listAccountTransactions?(\n    id: string,\n    pagination: Pagination,\n  ): Promise<Paginated<Transaction>>;\n\n  /**\n   * Discover accounts.\n   *\n   * This method is called by the client to allow the keyring to discover\n   * existing accounts based on the provided scopes and entropy source ID. Are\n   * considered existing accounts, accounts that have at least one transaction,\n   * as per BIP-44.\n   *\n   * The `groupIndex` is used to group accounts with the same value. In\n   * strictly BIP-44 wallets, it matches `account_index`, but in wallets that\n   * deviate from BIP-44 recommendations, it may align with a different path\n   * level for compatibility.\n   *\n   * @param scopes - The list of scopes for account discovery.\n   * @param entropySource - The ID of the entropy source used to derive the accounts.\n   * @param groupIndex - The group index that should be used to derive the accounts.\n   * @returns A promise resolving to a list of discovered accounts.\n   */\n  discoverAccounts?(\n    scopes: CaipChainId[],\n    entropySource: EntropySourceId,\n    groupIndex: number,\n  ): Promise<DiscoveredAccount[]>;\n\n  /**\n   * Retrieve the balances of a given account.\n   *\n   * This method fetches the balances of specified assets for a given account\n   * ID. It returns a promise that resolves to an object where the keys are\n   * asset types and the values are balance objects containing the amount and\n   * unit.\n   *\n   * @example\n   * ```ts\n   * await keyring.getAccountBalances(\n   *   '43550276-c7d6-4fac-87c7-00390ad0ce90',\n   *   ['bip122:000000000019d6689c085ae165831e93/slip44:0']\n   * );\n   * // Returns something similar to:\n   * // {\n   * //   'bip122:000000000019d6689c085ae165831e93/slip44:0': {\n   * //     amount: '0.0001',\n   * //     unit: 'BTC',\n   * //   }\n   * // }\n   * ```\n   * @param id - ID of the account to retrieve the balances for.\n   * @param assets - Array of asset types (CAIP-19) to retrieve balances for.\n   * @returns A promise that resolves to an object mapping asset types to their\n   * respective balances.\n   */\n  getAccountBalances?(\n    id: string,\n    assets: CaipAssetType[],\n  ): Promise<Record<CaipAssetType, Balance>>;\n\n  /**\n   * Resolves the address of an account from a signing request.\n   *\n   * This is required by the routing system of MetaMask to dispatch\n   * incoming non-EVM dapp signing requests.\n   *\n   * @param scope - Request's scope (CAIP-2).\n   * @param request - Signing request object.\n   * @returns A Promise that resolves to the account address that must\n   * be used to process this signing request, or null if none candidates\n   * could be found.\n   */\n  resolveAccountAddress?(\n    scope: CaipChainId,\n    request: JsonRpcRequest,\n  ): Promise<ResolvedAccountAddress | null>;\n\n  /**\n   * Filter supported chains for a given account.\n   *\n   * @param id - ID of the account to be checked.\n   * @param chains - List of chains (CAIP-2) to be checked.\n   * @returns A Promise that resolves to a filtered list of CAIP-2 IDs\n   * representing the supported chains.\n   */\n  filterAccountChains(id: string, chains: string[]): Promise<string[]>;\n\n  /**\n   * Update an account.\n   *\n   * Updates the account with the given account object. Does nothing if the\n   * account does not exist.\n   *\n   * @param account - The updated account object.\n   * @returns A promise that resolves when the account is successfully updated.\n   */\n  updateAccount(account: KeyringAccount): Promise<void>;\n\n  /**\n   * Delete an account from the keyring.\n   *\n   * Deletes the account with the given ID from the keyring.\n   *\n   * @param id - The ID of the account to delete.\n   * @returns A promise that resolves when the account is successfully deleted.\n   */\n  deleteAccount(id: string): Promise<void>;\n\n  /**\n   * Exports an account's private key.\n   *\n   * If the keyring cannot export a private key, this function should throw an\n   * error.\n   *\n   * @param id - The ID of the account to export.\n   * @returns A promise that resolves to the exported account.\n   */\n  exportAccount?(id: string): Promise<KeyringAccountData>;\n\n  /**\n   * List all submitted requests.\n   *\n   * Retrieves an array of KeyringRequest objects representing the submitted\n   * requests.\n   *\n   * @returns A promise that resolves to an array of KeyringRequest objects.\n   */\n  listRequests?(): Promise<KeyringRequest[]>;\n\n  /**\n   * Get a request.\n   *\n   * Retrieves the KeyringRequest object for the given request ID.\n   *\n   * @param id - The ID of the request to retrieve.\n   * @returns A promise that resolves to the KeyringRequest object if found, or\n   * undefined otherwise.\n   */\n  getRequest?(id: string): Promise<KeyringRequest | undefined>;\n\n  /**\n   * Submit a request.\n   *\n   * Submits the given KeyringRequest object.\n   *\n   * @param request - The KeyringRequest object to submit.\n   * @returns A promise that resolves to the request response.\n   */\n  submitRequest(request: KeyringRequest): Promise<KeyringResponse>;\n\n  /**\n   * Approve a request.\n   *\n   * Approves the request with the given ID and sets the response if provided.\n   *\n   * @param id - The ID of the request to approve.\n   * @param data - The response to the request (optional).\n   * @returns A promise that resolves when the request is successfully\n   * approved.\n   */\n  approveRequest?(id: string, data?: Record<string, Json>): Promise<void>;\n\n  /**\n   * Reject a request.\n   *\n   * Rejects the request with the given ID.\n   *\n   * @param id - The ID of the request to reject.\n   * @returns A promise that resolves when the request is successfully\n   * rejected.\n   */\n  rejectRequest?(id: string): Promise<void>;\n};\n"]}

package/dist/api/keyring.d.cts

@@ -4,6 +4,8 @@ import type { KeyringAccount } from "./account.cjs";
 import type { ResolvedAccountAddress } from "./address.cjs";
 import type { Balance } from "./balance.cjs";
 import type { CaipChainId, CaipAssetType, CaipAssetTypeOrId } from "./caip.cjs";
+import type { DiscoveredAccount } from "./discovery.cjs";
+import type { EntropySourceId } from "./entropy.cjs";
 import type { KeyringAccountData } from "./export.cjs";
 import type { MetaMaskOptions } from "./options.cjs";
 import type { Paginated, Pagination } from "./pagination.cjs";
@@ -69,6 +71,25 @@ export type Keyring = {
      * @returns A promise that resolves to the next page of transactions.
      */
     listAccountTransactions?(id: string, pagination: Pagination): Promise<Paginated<Transaction>>;
+    /**
+     * Discover accounts.
+     *
+     * This method is called by the client to allow the keyring to discover
+     * existing accounts based on the provided scopes and entropy source ID. Are
+     * considered existing accounts, accounts that have at least one transaction,
+     * as per BIP-44.
+     *
+     * The `groupIndex` is used to group accounts with the same value. In
+     * strictly BIP-44 wallets, it matches `account_index`, but in wallets that
+     * deviate from BIP-44 recommendations, it may align with a different path
+     * level for compatibility.
+     *
+     * @param scopes - The list of scopes for account discovery.
+     * @param entropySource - The ID of the entropy source used to derive the accounts.
+     * @param groupIndex - The group index that should be used to derive the accounts.
+     * @returns A promise resolving to a list of discovered accounts.
+     */
+    discoverAccounts?(scopes: CaipChainId[], entropySource: EntropySourceId, groupIndex: number): Promise<DiscoveredAccount[]>;
     /**
      * Retrieve the balances of a given account.
      *

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

@@ -1 +1 @@
-{"version":3,"file":"keyring.d.cts","sourceRoot":"","sources":["../../src/api/keyring.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,gCAAgC;AAC9D,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C,OAAO,KAAK,EAAE,cAAc,EAAE,sBAAkB;AAChD,OAAO,KAAK,EAAE,sBAAsB,EAAE,sBAAkB;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,sBAAkB;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,iBAAiB,EAAE,mBAAe;AAC5E,OAAO,KAAK,EAAE,kBAAkB,EAAE,qBAAiB;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAkB;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,yBAAqB;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,sBAAkB;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,uBAAmB;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,0BAAsB;AAEjD;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;;;;;;OAOG;IACH,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAE1C;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IAE5D;;;;;;;;;OASG;IACH,aAAa,CACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,eAAe,GAC/C,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;;;;;OAQG;IACH,iBAAiB,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAE7D;;;;;;;;;;OAUG;IACH,uBAAuB,CAAC,CACtB,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,kBAAkB,CAAC,CACjB,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,aAAa,EAAE,GACtB,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC;IAE3C;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,CACpB,KAAK,EAAE,WAAW,EAClB,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC,CAAC;IAE1C;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAErE;;;;;;;;OAQG;IACH,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;;;OAQG;IACH,aAAa,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAExD;;;;;;;OAOG;IACH,YAAY,CAAC,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAE3C;;;;;;;;OAQG;IACH,UAAU,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IAE7D;;;;;;;OAOG;IACH,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEjE;;;;;;;;;OASG;IACH,cAAc,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;;;;;;;OAQG;IACH,aAAa,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3C,CAAC"}
+{"version":3,"file":"keyring.d.cts","sourceRoot":"","sources":["../../src/api/keyring.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,gCAAgC;AAC9D,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C,OAAO,KAAK,EAAE,cAAc,EAAE,sBAAkB;AAChD,OAAO,KAAK,EAAE,sBAAsB,EAAE,sBAAkB;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,sBAAkB;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,iBAAiB,EAAE,mBAAe;AAC5E,OAAO,KAAK,EAAE,iBAAiB,EAAE,wBAAoB;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAkB;AACjD,OAAO,KAAK,EAAE,kBAAkB,EAAE,qBAAiB;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAkB;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,yBAAqB;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,sBAAkB;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,uBAAmB;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,0BAAsB;AAEjD;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;;;;;;OAOG;IACH,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAE1C;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IAE5D;;;;;;;;;OASG;IACH,aAAa,CACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,eAAe,GAC/C,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;;;;;OAQG;IACH,iBAAiB,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAE7D;;;;;;;;;;OAUG;IACH,uBAAuB,CAAC,CACtB,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;IAEnC;;;;;;;;;;;;;;;;;OAiBG;IACH,gBAAgB,CAAC,CACf,MAAM,EAAE,WAAW,EAAE,EACrB,aAAa,EAAE,eAAe,EAC9B,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,kBAAkB,CAAC,CACjB,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,aAAa,EAAE,GACtB,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC;IAE3C;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,CACpB,KAAK,EAAE,WAAW,EAClB,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC,CAAC;IAE1C;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAErE;;;;;;;;OAQG;IACH,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;;;OAQG;IACH,aAAa,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAExD;;;;;;;OAOG;IACH,YAAY,CAAC,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAE3C;;;;;;;;OAQG;IACH,UAAU,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IAE7D;;;;;;;OAOG;IACH,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEjE;;;;;;;;;OASG;IACH,cAAc,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;;;;;;;OAQG;IACH,aAAa,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3C,CAAC"}

package/dist/api/keyring.d.mts

@@ -4,6 +4,8 @@ import type { KeyringAccount } from "./account.mjs";
 import type { ResolvedAccountAddress } from "./address.mjs";
 import type { Balance } from "./balance.mjs";
 import type { CaipChainId, CaipAssetType, CaipAssetTypeOrId } from "./caip.mjs";
+import type { DiscoveredAccount } from "./discovery.mjs";
+import type { EntropySourceId } from "./entropy.mjs";
 import type { KeyringAccountData } from "./export.mjs";
 import type { MetaMaskOptions } from "./options.mjs";
 import type { Paginated, Pagination } from "./pagination.mjs";
@@ -69,6 +71,25 @@ export type Keyring = {
      * @returns A promise that resolves to the next page of transactions.
      */
     listAccountTransactions?(id: string, pagination: Pagination): Promise<Paginated<Transaction>>;
+    /**
+     * Discover accounts.
+     *
+     * This method is called by the client to allow the keyring to discover
+     * existing accounts based on the provided scopes and entropy source ID. Are
+     * considered existing accounts, accounts that have at least one transaction,
+     * as per BIP-44.
+     *
+     * The `groupIndex` is used to group accounts with the same value. In
+     * strictly BIP-44 wallets, it matches `account_index`, but in wallets that
+     * deviate from BIP-44 recommendations, it may align with a different path
+     * level for compatibility.
+     *
+     * @param scopes - The list of scopes for account discovery.
+     * @param entropySource - The ID of the entropy source used to derive the accounts.
+     * @param groupIndex - The group index that should be used to derive the accounts.
+     * @returns A promise resolving to a list of discovered accounts.
+     */
+    discoverAccounts?(scopes: CaipChainId[], entropySource: EntropySourceId, groupIndex: number): Promise<DiscoveredAccount[]>;
     /**
      * Retrieve the balances of a given account.
      *

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

@@ -1 +1 @@
-{"version":3,"file":"keyring.d.mts","sourceRoot":"","sources":["../../src/api/keyring.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,gCAAgC;AAC9D,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C,OAAO,KAAK,EAAE,cAAc,EAAE,sBAAkB;AAChD,OAAO,KAAK,EAAE,sBAAsB,EAAE,sBAAkB;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,sBAAkB;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,iBAAiB,EAAE,mBAAe;AAC5E,OAAO,KAAK,EAAE,kBAAkB,EAAE,qBAAiB;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAkB;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,yBAAqB;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,sBAAkB;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,uBAAmB;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,0BAAsB;AAEjD;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;;;;;;OAOG;IACH,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAE1C;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IAE5D;;;;;;;;;OASG;IACH,aAAa,CACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,eAAe,GAC/C,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;;;;;OAQG;IACH,iBAAiB,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAE7D;;;;;;;;;;OAUG;IACH,uBAAuB,CAAC,CACtB,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,kBAAkB,CAAC,CACjB,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,aAAa,EAAE,GACtB,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC;IAE3C;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,CACpB,KAAK,EAAE,WAAW,EAClB,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC,CAAC;IAE1C;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAErE;;;;;;;;OAQG;IACH,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;;;OAQG;IACH,aAAa,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAExD;;;;;;;OAOG;IACH,YAAY,CAAC,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAE3C;;;;;;;;OAQG;IACH,UAAU,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IAE7D;;;;;;;OAOG;IACH,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEjE;;;;;;;;;OASG;IACH,cAAc,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;;;;;;;OAQG;IACH,aAAa,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3C,CAAC"}
+{"version":3,"file":"keyring.d.mts","sourceRoot":"","sources":["../../src/api/keyring.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,gCAAgC;AAC9D,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C,OAAO,KAAK,EAAE,cAAc,EAAE,sBAAkB;AAChD,OAAO,KAAK,EAAE,sBAAsB,EAAE,sBAAkB;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,sBAAkB;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,iBAAiB,EAAE,mBAAe;AAC5E,OAAO,KAAK,EAAE,iBAAiB,EAAE,wBAAoB;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAkB;AACjD,OAAO,KAAK,EAAE,kBAAkB,EAAE,qBAAiB;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAkB;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,yBAAqB;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,sBAAkB;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,uBAAmB;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,0BAAsB;AAEjD;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;;;;;;OAOG;IACH,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAE1C;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IAE5D;;;;;;;;;OASG;IACH,aAAa,CACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,eAAe,GAC/C,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;;;;;OAQG;IACH,iBAAiB,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAE7D;;;;;;;;;;OAUG;IACH,uBAAuB,CAAC,CACtB,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;IAEnC;;;;;;;;;;;;;;;;;OAiBG;IACH,gBAAgB,CAAC,CACf,MAAM,EAAE,WAAW,EAAE,EACrB,aAAa,EAAE,eAAe,EAC9B,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,kBAAkB,CAAC,CACjB,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,aAAa,EAAE,GACtB,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC;IAE3C;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,CACpB,KAAK,EAAE,WAAW,EAClB,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC,CAAC;IAE1C;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAErE;;;;;;;;OAQG;IACH,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;;;OAQG;IACH,aAAa,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAExD;;;;;;;OAOG;IACH,YAAY,CAAC,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAE3C;;;;;;;;OAQG;IACH,UAAU,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IAE7D;;;;;;;OAOG;IACH,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEjE;;;;;;;;;OASG;IACH,cAAc,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;;;;;;;OAQG;IACH,aAAa,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3C,CAAC"}

package/dist/api/keyring.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"keyring.mjs","sourceRoot":"","sources":["../../src/api/keyring.ts"],"names":[],"mappings":"AAAA,sEAAsE;AACtE,6EAA6E","sourcesContent":["/* eslint-disable @typescript-eslint/no-redundant-type-constituents */\n// This rule seems to be triggering a false positive on the `KeyringAccount`.\n\nimport type { JsonRpcRequest } from '@metamask/keyring-utils';\nimport type { Json } from '@metamask/utils';\n\nimport type { KeyringAccount } from './account';\nimport type { ResolvedAccountAddress } from './address';\nimport type { Balance } from './balance';\nimport type { CaipChainId, CaipAssetType, CaipAssetTypeOrId } from './caip';\nimport type { KeyringAccountData } from './export';\nimport type { MetaMaskOptions } from './options';\nimport type { Paginated, Pagination } from './pagination';\nimport type { KeyringRequest } from './request';\nimport type { KeyringResponse } from './response';\nimport type { Transaction } from './transaction';\n\n/**\n * Keyring interface.\n *\n * Represents the functionality and operations related to managing accounts and\n * handling requests.\n */\nexport type Keyring = {\n  /**\n   * List accounts.\n   *\n   * Retrieves an array of KeyringAccount objects representing the available\n   * accounts.\n   *\n   * @returns A promise that resolves to an array of KeyringAccount objects.\n   */\n  listAccounts(): Promise<KeyringAccount[]>;\n\n  /**\n   * Get an account.\n   *\n   * Retrieves the KeyringAccount object for the given account ID.\n   *\n   * @param id - The ID of the account to retrieve.\n   * @returns A promise that resolves to the KeyringAccount object if found, or\n   * undefined otherwise.\n   */\n  getAccount(id: string): Promise<KeyringAccount | undefined>;\n\n  /**\n   * Create an account.\n   *\n   * Creates a new account with optional, keyring-defined, account options.\n   *\n   * @param options - Keyring-defined options for the account (optional). The\n   * 'metamask' internal options needs to be re-emitted during `notify:*` events.\n   * @returns A promise that resolves to the newly created KeyringAccount\n   * object without any private information.\n   */\n  createAccount(\n    options?: Record<string, Json> & MetaMaskOptions,\n  ): Promise<KeyringAccount>;\n\n  /**\n   * Lists the assets of an account (fungibles and non-fungibles) represented\n   * by their respective CAIP-19:\n   * - Asset types for fungibles assets.\n   * - Asset IDs for non-fungible ones.\n   *\n   * @param id - The ID of the account to list the assets for.\n   * @returns A promise that resolves to list of assets for that account.\n   */\n  listAccountAssets?(id: string): Promise<CaipAssetTypeOrId[]>;\n\n  /**\n   * Lists the transactions of an account, paginated and ordered by the most\n   * recent first.\n   *\n   * The pagination options are used to limit the number of transactions in the\n   * response and to iterate over the results.\n   *\n   * @param id - The ID of the account to list the transactions for.\n   * @param pagination - The pagination options.\n   * @returns A promise that resolves to the next page of transactions.\n   */\n  listAccountTransactions?(\n    id: string,\n    pagination: Pagination,\n  ): Promise<Paginated<Transaction>>;\n\n  /**\n   * Retrieve the balances of a given account.\n   *\n   * This method fetches the balances of specified assets for a given account\n   * ID. It returns a promise that resolves to an object where the keys are\n   * asset types and the values are balance objects containing the amount and\n   * unit.\n   *\n   * @example\n   * ```ts\n   * await keyring.getAccountBalances(\n   *   '43550276-c7d6-4fac-87c7-00390ad0ce90',\n   *   ['bip122:000000000019d6689c085ae165831e93/slip44:0']\n   * );\n   * // Returns something similar to:\n   * // {\n   * //   'bip122:000000000019d6689c085ae165831e93/slip44:0': {\n   * //     amount: '0.0001',\n   * //     unit: 'BTC',\n   * //   }\n   * // }\n   * ```\n   * @param id - ID of the account to retrieve the balances for.\n   * @param assets - Array of asset types (CAIP-19) to retrieve balances for.\n   * @returns A promise that resolves to an object mapping asset types to their\n   * respective balances.\n   */\n  getAccountBalances?(\n    id: string,\n    assets: CaipAssetType[],\n  ): Promise<Record<CaipAssetType, Balance>>;\n\n  /**\n   * Resolves the address of an account from a signing request.\n   *\n   * This is required by the routing system of MetaMask to dispatch\n   * incoming non-EVM dapp signing requests.\n   *\n   * @param scope - Request's scope (CAIP-2).\n   * @param request - Signing request object.\n   * @returns A Promise that resolves to the account address that must\n   * be used to process this signing request, or null if none candidates\n   * could be found.\n   */\n  resolveAccountAddress?(\n    scope: CaipChainId,\n    request: JsonRpcRequest,\n  ): Promise<ResolvedAccountAddress | null>;\n\n  /**\n   * Filter supported chains for a given account.\n   *\n   * @param id - ID of the account to be checked.\n   * @param chains - List of chains (CAIP-2) to be checked.\n   * @returns A Promise that resolves to a filtered list of CAIP-2 IDs\n   * representing the supported chains.\n   */\n  filterAccountChains(id: string, chains: string[]): Promise<string[]>;\n\n  /**\n   * Update an account.\n   *\n   * Updates the account with the given account object. Does nothing if the\n   * account does not exist.\n   *\n   * @param account - The updated account object.\n   * @returns A promise that resolves when the account is successfully updated.\n   */\n  updateAccount(account: KeyringAccount): Promise<void>;\n\n  /**\n   * Delete an account from the keyring.\n   *\n   * Deletes the account with the given ID from the keyring.\n   *\n   * @param id - The ID of the account to delete.\n   * @returns A promise that resolves when the account is successfully deleted.\n   */\n  deleteAccount(id: string): Promise<void>;\n\n  /**\n   * Exports an account's private key.\n   *\n   * If the keyring cannot export a private key, this function should throw an\n   * error.\n   *\n   * @param id - The ID of the account to export.\n   * @returns A promise that resolves to the exported account.\n   */\n  exportAccount?(id: string): Promise<KeyringAccountData>;\n\n  /**\n   * List all submitted requests.\n   *\n   * Retrieves an array of KeyringRequest objects representing the submitted\n   * requests.\n   *\n   * @returns A promise that resolves to an array of KeyringRequest objects.\n   */\n  listRequests?(): Promise<KeyringRequest[]>;\n\n  /**\n   * Get a request.\n   *\n   * Retrieves the KeyringRequest object for the given request ID.\n   *\n   * @param id - The ID of the request to retrieve.\n   * @returns A promise that resolves to the KeyringRequest object if found, or\n   * undefined otherwise.\n   */\n  getRequest?(id: string): Promise<KeyringRequest | undefined>;\n\n  /**\n   * Submit a request.\n   *\n   * Submits the given KeyringRequest object.\n   *\n   * @param request - The KeyringRequest object to submit.\n   * @returns A promise that resolves to the request response.\n   */\n  submitRequest(request: KeyringRequest): Promise<KeyringResponse>;\n\n  /**\n   * Approve a request.\n   *\n   * Approves the request with the given ID and sets the response if provided.\n   *\n   * @param id - The ID of the request to approve.\n   * @param data - The response to the request (optional).\n   * @returns A promise that resolves when the request is successfully\n   * approved.\n   */\n  approveRequest?(id: string, data?: Record<string, Json>): Promise<void>;\n\n  /**\n   * Reject a request.\n   *\n   * Rejects the request with the given ID.\n   *\n   * @param id - The ID of the request to reject.\n   * @returns A promise that resolves when the request is successfully\n   * rejected.\n   */\n  rejectRequest?(id: string): Promise<void>;\n};\n"]}
+{"version":3,"file":"keyring.mjs","sourceRoot":"","sources":["../../src/api/keyring.ts"],"names":[],"mappings":"AAAA,sEAAsE;AACtE,6EAA6E","sourcesContent":["/* eslint-disable @typescript-eslint/no-redundant-type-constituents */\n// This rule seems to be triggering a false positive on the `KeyringAccount`.\n\nimport type { JsonRpcRequest } from '@metamask/keyring-utils';\nimport type { Json } from '@metamask/utils';\n\nimport type { KeyringAccount } from './account';\nimport type { ResolvedAccountAddress } from './address';\nimport type { Balance } from './balance';\nimport type { CaipChainId, CaipAssetType, CaipAssetTypeOrId } from './caip';\nimport type { DiscoveredAccount } from './discovery';\nimport type { EntropySourceId } from './entropy';\nimport type { KeyringAccountData } from './export';\nimport type { MetaMaskOptions } from './options';\nimport type { Paginated, Pagination } from './pagination';\nimport type { KeyringRequest } from './request';\nimport type { KeyringResponse } from './response';\nimport type { Transaction } from './transaction';\n\n/**\n * Keyring interface.\n *\n * Represents the functionality and operations related to managing accounts and\n * handling requests.\n */\nexport type Keyring = {\n  /**\n   * List accounts.\n   *\n   * Retrieves an array of KeyringAccount objects representing the available\n   * accounts.\n   *\n   * @returns A promise that resolves to an array of KeyringAccount objects.\n   */\n  listAccounts(): Promise<KeyringAccount[]>;\n\n  /**\n   * Get an account.\n   *\n   * Retrieves the KeyringAccount object for the given account ID.\n   *\n   * @param id - The ID of the account to retrieve.\n   * @returns A promise that resolves to the KeyringAccount object if found, or\n   * undefined otherwise.\n   */\n  getAccount(id: string): Promise<KeyringAccount | undefined>;\n\n  /**\n   * Create an account.\n   *\n   * Creates a new account with optional, keyring-defined, account options.\n   *\n   * @param options - Keyring-defined options for the account (optional). The\n   * 'metamask' internal options needs to be re-emitted during `notify:*` events.\n   * @returns A promise that resolves to the newly created KeyringAccount\n   * object without any private information.\n   */\n  createAccount(\n    options?: Record<string, Json> & MetaMaskOptions,\n  ): Promise<KeyringAccount>;\n\n  /**\n   * Lists the assets of an account (fungibles and non-fungibles) represented\n   * by their respective CAIP-19:\n   * - Asset types for fungibles assets.\n   * - Asset IDs for non-fungible ones.\n   *\n   * @param id - The ID of the account to list the assets for.\n   * @returns A promise that resolves to list of assets for that account.\n   */\n  listAccountAssets?(id: string): Promise<CaipAssetTypeOrId[]>;\n\n  /**\n   * Lists the transactions of an account, paginated and ordered by the most\n   * recent first.\n   *\n   * The pagination options are used to limit the number of transactions in the\n   * response and to iterate over the results.\n   *\n   * @param id - The ID of the account to list the transactions for.\n   * @param pagination - The pagination options.\n   * @returns A promise that resolves to the next page of transactions.\n   */\n  listAccountTransactions?(\n    id: string,\n    pagination: Pagination,\n  ): Promise<Paginated<Transaction>>;\n\n  /**\n   * Discover accounts.\n   *\n   * This method is called by the client to allow the keyring to discover\n   * existing accounts based on the provided scopes and entropy source ID. Are\n   * considered existing accounts, accounts that have at least one transaction,\n   * as per BIP-44.\n   *\n   * The `groupIndex` is used to group accounts with the same value. In\n   * strictly BIP-44 wallets, it matches `account_index`, but in wallets that\n   * deviate from BIP-44 recommendations, it may align with a different path\n   * level for compatibility.\n   *\n   * @param scopes - The list of scopes for account discovery.\n   * @param entropySource - The ID of the entropy source used to derive the accounts.\n   * @param groupIndex - The group index that should be used to derive the accounts.\n   * @returns A promise resolving to a list of discovered accounts.\n   */\n  discoverAccounts?(\n    scopes: CaipChainId[],\n    entropySource: EntropySourceId,\n    groupIndex: number,\n  ): Promise<DiscoveredAccount[]>;\n\n  /**\n   * Retrieve the balances of a given account.\n   *\n   * This method fetches the balances of specified assets for a given account\n   * ID. It returns a promise that resolves to an object where the keys are\n   * asset types and the values are balance objects containing the amount and\n   * unit.\n   *\n   * @example\n   * ```ts\n   * await keyring.getAccountBalances(\n   *   '43550276-c7d6-4fac-87c7-00390ad0ce90',\n   *   ['bip122:000000000019d6689c085ae165831e93/slip44:0']\n   * );\n   * // Returns something similar to:\n   * // {\n   * //   'bip122:000000000019d6689c085ae165831e93/slip44:0': {\n   * //     amount: '0.0001',\n   * //     unit: 'BTC',\n   * //   }\n   * // }\n   * ```\n   * @param id - ID of the account to retrieve the balances for.\n   * @param assets - Array of asset types (CAIP-19) to retrieve balances for.\n   * @returns A promise that resolves to an object mapping asset types to their\n   * respective balances.\n   */\n  getAccountBalances?(\n    id: string,\n    assets: CaipAssetType[],\n  ): Promise<Record<CaipAssetType, Balance>>;\n\n  /**\n   * Resolves the address of an account from a signing request.\n   *\n   * This is required by the routing system of MetaMask to dispatch\n   * incoming non-EVM dapp signing requests.\n   *\n   * @param scope - Request's scope (CAIP-2).\n   * @param request - Signing request object.\n   * @returns A Promise that resolves to the account address that must\n   * be used to process this signing request, or null if none candidates\n   * could be found.\n   */\n  resolveAccountAddress?(\n    scope: CaipChainId,\n    request: JsonRpcRequest,\n  ): Promise<ResolvedAccountAddress | null>;\n\n  /**\n   * Filter supported chains for a given account.\n   *\n   * @param id - ID of the account to be checked.\n   * @param chains - List of chains (CAIP-2) to be checked.\n   * @returns A Promise that resolves to a filtered list of CAIP-2 IDs\n   * representing the supported chains.\n   */\n  filterAccountChains(id: string, chains: string[]): Promise<string[]>;\n\n  /**\n   * Update an account.\n   *\n   * Updates the account with the given account object. Does nothing if the\n   * account does not exist.\n   *\n   * @param account - The updated account object.\n   * @returns A promise that resolves when the account is successfully updated.\n   */\n  updateAccount(account: KeyringAccount): Promise<void>;\n\n  /**\n   * Delete an account from the keyring.\n   *\n   * Deletes the account with the given ID from the keyring.\n   *\n   * @param id - The ID of the account to delete.\n   * @returns A promise that resolves when the account is successfully deleted.\n   */\n  deleteAccount(id: string): Promise<void>;\n\n  /**\n   * Exports an account's private key.\n   *\n   * If the keyring cannot export a private key, this function should throw an\n   * error.\n   *\n   * @param id - The ID of the account to export.\n   * @returns A promise that resolves to the exported account.\n   */\n  exportAccount?(id: string): Promise<KeyringAccountData>;\n\n  /**\n   * List all submitted requests.\n   *\n   * Retrieves an array of KeyringRequest objects representing the submitted\n   * requests.\n   *\n   * @returns A promise that resolves to an array of KeyringRequest objects.\n   */\n  listRequests?(): Promise<KeyringRequest[]>;\n\n  /**\n   * Get a request.\n   *\n   * Retrieves the KeyringRequest object for the given request ID.\n   *\n   * @param id - The ID of the request to retrieve.\n   * @returns A promise that resolves to the KeyringRequest object if found, or\n   * undefined otherwise.\n   */\n  getRequest?(id: string): Promise<KeyringRequest | undefined>;\n\n  /**\n   * Submit a request.\n   *\n   * Submits the given KeyringRequest object.\n   *\n   * @param request - The KeyringRequest object to submit.\n   * @returns A promise that resolves to the request response.\n   */\n  submitRequest(request: KeyringRequest): Promise<KeyringResponse>;\n\n  /**\n   * Approve a request.\n   *\n   * Approves the request with the given ID and sets the response if provided.\n   *\n   * @param id - The ID of the request to approve.\n   * @param data - The response to the request (optional).\n   * @returns A promise that resolves when the request is successfully\n   * approved.\n   */\n  approveRequest?(id: string, data?: Record<string, Json>): Promise<void>;\n\n  /**\n   * Reject a request.\n   *\n   * Rejects the request with the given ID.\n   *\n   * @param id - The ID of the request to reject.\n   * @returns A promise that resolves when the request is successfully\n   * rejected.\n   */\n  rejectRequest?(id: string): Promise<void>;\n};\n"]}