@metamask/keyring-api 0.1.3 → 0.2.0

package/dist/{keyring-api.d.ts → api.d.ts}

@@ -1,21 +1,35 @@
-import { Json } from '@metamask/utils';
-import { Infer } from 'superstruct';
+import { type Json } from '@metamask/utils';
+import { type Infer } from 'superstruct';
+/**
+ * Supported Ethereum methods.
+ */
+export declare enum EthMethod {
+    PersonalSign = "personal_sign",
+    Sign = "eth_sign",
+    SignTransaction = "eth_signTransaction",
+    SignTypedData = "eth_signTypedData",
+    SignTypedDataV1 = "eth_signTypedData_v1",
+    SignTypedDataV3 = "eth_signTypedData_v3",
+    SignTypedDataV4 = "eth_signTypedData_v4"
+}
+/**
+ * Supported Ethereum account types.
+ */
+export declare enum EthAccountType {
+    Eoa = "eip155:eoa",
+    Eip4337 = "eip155:eip4337"
+}
 export declare const KeyringAccountStruct: import("superstruct").Struct<{
     id: string;
-    name: string;
     address: string;
-    options: Record<string, Json> | null;
-    supportedMethods: ("personal_sign" | "eth_sendTransaction" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v2" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-    type: "eip155:eoa" | "eip155:erc4337";
+    options: Record<string, Json>;
+    methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
+    type: "eip155:eoa" | "eip155:eip4337";
 }, {
     /**
      * Account ID (UUIDv4).
      */
     id: import("superstruct").Struct<string, null>;
-    /**
-     * User-chosen account name.
-     */
-    name: import("superstruct").Struct<string, null>;
     /**
      * Account address or next receive address (UTXO).
      */
@@ -23,27 +37,25 @@ export declare const KeyringAccountStruct: import("superstruct").Struct<{
     /**
      * Keyring-dependent account options.
      */
-    options: import("superstruct").Struct<Record<string, Json> | null, null>;
+    options: import("superstruct").Struct<Record<string, Json>, null>;
     /**
      * Account supported methods.
      */
-    supportedMethods: import("superstruct").Struct<("personal_sign" | "eth_sendTransaction" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v2" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[], import("superstruct").Struct<"personal_sign" | "eth_sendTransaction" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v2" | "eth_signTypedData_v3" | "eth_signTypedData_v4", {
+    methods: import("superstruct").Struct<("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[], import("superstruct").Struct<"personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4", {
         personal_sign: "personal_sign";
-        eth_sendTransaction: "eth_sendTransaction";
         eth_sign: "eth_sign";
         eth_signTransaction: "eth_signTransaction";
         eth_signTypedData: "eth_signTypedData";
         eth_signTypedData_v1: "eth_signTypedData_v1";
-        eth_signTypedData_v2: "eth_signTypedData_v2";
         eth_signTypedData_v3: "eth_signTypedData_v3";
         eth_signTypedData_v4: "eth_signTypedData_v4";
     }>>;
     /**
      * Account type.
      */
-    type: import("superstruct").Struct<"eip155:eoa" | "eip155:erc4337", {
+    type: import("superstruct").Struct<"eip155:eoa" | "eip155:eip4337", {
         "eip155:eoa": "eip155:eoa";
-        "eip155:erc4337": "eip155:erc4337";
+        "eip155:eip4337": "eip155:eip4337";
     }>;
 }>;
 /**
@@ -52,35 +64,18 @@ export declare const KeyringAccountStruct: import("superstruct").Struct<{
  * Represents an account with its properties and capabilities.
  */
 export declare type KeyringAccount = Infer<typeof KeyringAccountStruct>;
-export declare const KeyringJsonRpcRequestStruct: import("superstruct").Struct<{
-    id: string;
-    jsonrpc: "2.0";
-    method: string;
-} | {
-    id: string;
-    jsonrpc: "2.0";
-    method: string;
-    params: Record<string, Json> | Json[];
-}, null>;
-/**
- * JSON-RPC request type.
- *
- * Represents a JSON-RPC request sent by a dApp. The request ID must be a
- * string and the params field cannot be undefined.
- */
-export declare type KeyringJsonRpcRequest = Infer<typeof KeyringJsonRpcRequestStruct>;
 export declare const KeyringRequestStruct: import("superstruct").Struct<{
     account: string;
     scope: string;
     request: {
-        id: string;
         jsonrpc: "2.0";
+        id: string | number | null;
         method: string;
     } | {
-        id: string;
         jsonrpc: "2.0";
+        id: string | number | null;
         method: string;
-        params: Record<string, Json> | Json[];
+        params: Json[] | Record<string, Json>;
     };
 }, {
     /**
@@ -97,14 +92,14 @@ export declare const KeyringRequestStruct: import("superstruct").Struct<{
      * Note: The request ID must be a string.
      */
     request: import("superstruct").Struct<{
-        id: string;
         jsonrpc: "2.0";
+        id: string | number | null;
         method: string;
     } | {
-        id: string;
         jsonrpc: "2.0";
+        id: string | number | null;
         method: string;
-        params: Record<string, Json> | Json[];
+        params: Json[] | Record<string, Json>;
     }, null>;
 }>;
 /**
@@ -113,16 +108,33 @@ export declare const KeyringRequestStruct: import("superstruct").Struct<{
  * Represents a request made to the keyring for account-related operations.
  */
 export declare type KeyringRequest = Infer<typeof KeyringRequestStruct>;
-export declare const SubmitRequestResponseStruct: import("superstruct").Struct<{
+export declare const KeyringAccountDataStruct: import("superstruct").Struct<Record<string, Json>, null>;
+/**
+ * Response to a call to `exportAccount`.
+ *
+ * The exact response depends on the keyring implementation.
+ */
+export declare type KeyringAccountData = Infer<typeof KeyringAccountDataStruct>;
+export declare const KeyringResponseStruct: import("superstruct").Struct<{
     pending: true;
+    redirect: string | null;
 } | {
     pending: false;
     result: Json;
 }, null>;
 /**
- * Response returned when submitting a request to the Keyring.
+ * Response to a call to `submitRequest`.
+ *
+ * Keyring implementations must return a response with `pending: true` if the
+ * request will be handled asynchronously. Otherwise, the response must contain
+ * the result of the request and `pending: false`.
+ *
+ * In the asynchronous case, the keyring can return a redirect URL to be shown
+ * to the user. The user can choose to follow the link or cancel the request.
+ * The main use case for this is to redirect the user to a third-party service
+ * to approve the request.
  */
-export declare type SubmitRequestResponse = Infer<typeof SubmitRequestResponseStruct>;
+export declare type KeyringResponse = Infer<typeof KeyringResponseStruct>;
 /**
  * Keyring interface.
  *
@@ -152,15 +164,13 @@ export declare type Keyring = {
     /**
      * Create an account.
      *
-     * Creates a new account with the given name, supported chains, and optional
-     * account options.
+     * Creates a new account with optional, keyring-defined, account options.
      *
-     * @param name - The name of the account.
      * @param options - Keyring-defined options for the account (optional).
      * @returns A promise that resolves to the newly created KeyringAccount
      * object without any private information.
      */
-    createAccount(name: string, options?: Record<string, Json> | null): Promise<KeyringAccount>;
+    createAccount(options?: Record<string, Json>): Promise<KeyringAccount>;
     /**
      * Filter supported chains for a given account.
      *
@@ -189,6 +199,16 @@ export declare type Keyring = {
      * @returns A promise that resolves when the account is successfully deleted.
      */
     deleteAccount(id: string): Promise<void>;
+    /**
+     * Exports an account's private key.
+     *
+     * If the keyring cannot export a private key, this function should throw an
+     * error.
+     *
+     * @param id - The ID of the account to export.
+     * @returns A promise that resolves to the exported account.
+     */
+    exportAccount?(id: string): Promise<KeyringAccountData>;
     /**
      * List all submitted requests.
      *
@@ -197,7 +217,7 @@ export declare type Keyring = {
      *
      * @returns A promise that resolves to an array of KeyringRequest objects.
      */
-    listRequests(): Promise<KeyringRequest[]>;
+    listRequests?(): Promise<KeyringRequest[]>;
     /**
      * Get a request.
      *
@@ -207,7 +227,7 @@ export declare type Keyring = {
      * @returns A promise that resolves to the KeyringRequest object if found, or
      * undefined otherwise.
      */
-    getRequest(id: string): Promise<KeyringRequest | undefined>;
+    getRequest?(id: string): Promise<KeyringRequest | undefined>;
     /**
      * Submit a request.
      *
@@ -216,18 +236,18 @@ export declare type Keyring = {
      * @param request - The KeyringRequest object to submit.
      * @returns A promise that resolves to the request response.
      */
-    submitRequest(request: KeyringRequest): Promise<SubmitRequestResponse>;
+    submitRequest(request: KeyringRequest): Promise<KeyringResponse>;
     /**
      * Approve a request.
      *
      * Approves the request with the given ID and sets the response if provided.
      *
      * @param id - The ID of the request to approve.
-     * @param result - The response to the request (optional).
+     * @param data - The response to the request (optional).
      * @returns A promise that resolves when the request is successfully
      * approved.
      */
-    approveRequest(id: string, result?: Json): Promise<void>;
+    approveRequest?(id: string, data?: Record<string, Json>): Promise<void>;
     /**
      * Reject a request.
      *
@@ -237,5 +257,5 @@ export declare type Keyring = {
      * @returns A promise that resolves when the request is successfully
      * rejected.
      */
-    rejectRequest(id: string): Promise<void>;
+    rejectRequest?(id: string): Promise<void>;
 };

package/dist/api.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyringResponseStruct = exports.KeyringAccountDataStruct = exports.KeyringRequestStruct = exports.KeyringAccountStruct = exports.EthAccountType = exports.EthMethod = void 0;
+const utils_1 = require("@metamask/utils");
+const superstruct_1 = require("superstruct");
+const JsonRpcRequest_1 = require("./JsonRpcRequest");
+const utils_2 = require("./utils");
+/**
+ * Supported Ethereum methods.
+ */
+var EthMethod;
+(function (EthMethod) {
+    EthMethod["PersonalSign"] = "personal_sign";
+    EthMethod["Sign"] = "eth_sign";
+    EthMethod["SignTransaction"] = "eth_signTransaction";
+    EthMethod["SignTypedData"] = "eth_signTypedData";
+    EthMethod["SignTypedDataV1"] = "eth_signTypedData_v1";
+    EthMethod["SignTypedDataV3"] = "eth_signTypedData_v3";
+    EthMethod["SignTypedDataV4"] = "eth_signTypedData_v4";
+})(EthMethod = exports.EthMethod || (exports.EthMethod = {}));
+/**
+ * Supported Ethereum account types.
+ */
+var EthAccountType;
+(function (EthAccountType) {
+    EthAccountType["Eoa"] = "eip155:eoa";
+    EthAccountType["Eip4337"] = "eip155:eip4337";
+})(EthAccountType = exports.EthAccountType || (exports.EthAccountType = {}));
+exports.KeyringAccountStruct = (0, superstruct_1.object)({
+    /**
+     * Account ID (UUIDv4).
+     */
+    id: utils_2.UuidStruct,
+    /**
+     * Account address or next receive address (UTXO).
+     */
+    address: (0, superstruct_1.string)(),
+    /**
+     * Keyring-dependent account options.
+     */
+    options: (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct),
+    /**
+     * Account supported methods.
+     */
+    methods: (0, superstruct_1.array)((0, superstruct_1.enums)([
+        `${EthMethod.PersonalSign}`,
+        `${EthMethod.Sign}`,
+        `${EthMethod.SignTransaction}`,
+        `${EthMethod.SignTypedData}`,
+        `${EthMethod.SignTypedDataV1}`,
+        `${EthMethod.SignTypedDataV3}`,
+        `${EthMethod.SignTypedDataV4}`,
+    ])),
+    /**
+     * Account type.
+     */
+    type: (0, superstruct_1.enums)([`${EthAccountType.Eoa}`, `${EthAccountType.Eip4337}`]),
+});
+exports.KeyringRequestStruct = (0, superstruct_1.object)({
+    /**
+     * Account ID (UUIDv4).
+     */
+    account: utils_2.UuidStruct,
+    /**
+     * Request's scope (CAIP-2 chain ID).
+     */
+    scope: (0, superstruct_1.string)(),
+    /**
+     * JSON-RPC request sent by the client application.
+     *
+     * Note: The request ID must be a string.
+     */
+    request: JsonRpcRequest_1.JsonRpcRequestStruct,
+});
+exports.KeyringAccountDataStruct = (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct);
+exports.KeyringResponseStruct = (0, superstruct_1.union)([
+    (0, superstruct_1.object)({
+        /**
+         * Pending flag.
+         *
+         * Setting the pending flag to true indicates that the request will be
+         * handled asynchronously. The keyring must be called with `approveRequest`
+         * or `rejectRequest` to resolve the request.
+         */
+        pending: (0, superstruct_1.literal)(true),
+        /**
+         * Redirect URL.
+         *
+         * If present in the response, MetaMask will display a confirmation dialog
+         * with a link to the redirect URL. The user can choose to follow the link
+         * or cancel the request.
+         */
+        redirect: (0, superstruct_1.nullable)((0, superstruct_1.string)()),
+    }),
+    (0, superstruct_1.object)({
+        /**
+         * Pending flag.
+         *
+         * Setting the pending flag to false indicates that the request will be
+         * handled synchronously. The keyring must return the result of the
+         * request execution.
+         */
+        pending: (0, superstruct_1.literal)(false),
+        /**
+         * Request result.
+         */
+        result: utils_1.JsonStruct,
+    }),
+]);
+//# sourceMappingURL=api.js.map

package/dist/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;AAAA,2CAAwD;AACxD,6CAUqB;AAErB,qDAAwD;AACxD,mCAAqC;AAErC;;GAEG;AACH,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,2CAA8B,CAAA;IAC9B,8BAAiB,CAAA;IACjB,oDAAuC,CAAA;IACvC,gDAAmC,CAAA;IACnC,qDAAwC,CAAA;IACxC,qDAAwC,CAAA;IACxC,qDAAwC,CAAA;AAC1C,CAAC,EARW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAQpB;AAED;;GAEG;AACH,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,oCAAkB,CAAA;IAClB,4CAA0B,CAAA;AAC5B,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAEY,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC;;OAEG;IACH,EAAE,EAAE,kBAAU;IAEd;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,GAAE;IAEjB;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC;IAErC;;OAEG;IACH,OAAO,EAAE,IAAA,mBAAK,EACZ,IAAA,mBAAK,EAAC;QACJ,GAAG,SAAS,CAAC,YAAY,EAAE;QAC3B,GAAG,SAAS,CAAC,IAAI,EAAE;QACnB,GAAG,SAAS,CAAC,eAAe,EAAE;QAC9B,GAAG,SAAS,CAAC,aAAa,EAAE;QAC5B,GAAG,SAAS,CAAC,eAAe,EAAE;QAC9B,GAAG,SAAS,CAAC,eAAe,EAAE;QAC9B,GAAG,SAAS,CAAC,eAAe,EAAE;KAC/B,CAAC,CACH;IAED;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC,CAAC,GAAG,cAAc,CAAC,GAAG,EAAE,EAAE,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC;CACpE,CAAC,CAAC;AASU,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC;;OAEG;IACH,OAAO,EAAE,kBAAU;IAEnB;;OAEG;IACH,KAAK,EAAE,IAAA,oBAAM,GAAE;IAEf;;;;OAIG;IACH,OAAO,EAAE,qCAAoB;CAC9B,CAAC,CAAC;AASU,QAAA,wBAAwB,GAAG,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC;AASxD,QAAA,qBAAqB,GAAG,IAAA,mBAAK,EAAC;IACzC,IAAA,oBAAM,EAAC;QACL;;;;;;WAMG;QACH,OAAO,EAAE,IAAA,qBAAO,EAAC,IAAI,CAAC;QAEtB;;;;;;WAMG;QACH,QAAQ,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;KAC7B,CAAC;IACF,IAAA,oBAAM,EAAC;QACL;;;;;;WAMG;QACH,OAAO,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;QAEvB;;WAEG;QACH,MAAM,EAAE,kBAAU;KACnB,CAAC;CACH,CAAC,CAAC","sourcesContent":["import { type Json, JsonStruct } from '@metamask/utils';\nimport {\n  type Infer,\n  array,\n  enums,\n  literal,\n  object,\n  record,\n  string,\n  union,\n  nullable,\n} from 'superstruct';\n\nimport { JsonRpcRequestStruct } from './JsonRpcRequest';\nimport { UuidStruct } from './utils';\n\n/**\n * Supported Ethereum methods.\n */\nexport enum EthMethod {\n  PersonalSign = 'personal_sign',\n  Sign = 'eth_sign',\n  SignTransaction = 'eth_signTransaction',\n  SignTypedData = 'eth_signTypedData',\n  SignTypedDataV1 = 'eth_signTypedData_v1',\n  SignTypedDataV3 = 'eth_signTypedData_v3',\n  SignTypedDataV4 = 'eth_signTypedData_v4',\n}\n\n/**\n * Supported Ethereum account types.\n */\nexport enum EthAccountType {\n  Eoa = 'eip155:eoa',\n  Eip4337 = 'eip155:eip4337',\n}\n\nexport const KeyringAccountStruct = object({\n  /**\n   * Account ID (UUIDv4).\n   */\n  id: UuidStruct,\n\n  /**\n   * Account address or next receive address (UTXO).\n   */\n  address: string(),\n\n  /**\n   * Keyring-dependent account options.\n   */\n  options: record(string(), JsonStruct),\n\n  /**\n   * Account supported methods.\n   */\n  methods: array(\n    enums([\n      `${EthMethod.PersonalSign}`,\n      `${EthMethod.Sign}`,\n      `${EthMethod.SignTransaction}`,\n      `${EthMethod.SignTypedData}`,\n      `${EthMethod.SignTypedDataV1}`,\n      `${EthMethod.SignTypedDataV3}`,\n      `${EthMethod.SignTypedDataV4}`,\n    ]),\n  ),\n\n  /**\n   * Account type.\n   */\n  type: enums([`${EthAccountType.Eoa}`, `${EthAccountType.Eip4337}`]),\n});\n\n/**\n * Account object.\n *\n * Represents an account with its properties and capabilities.\n */\nexport type KeyringAccount = Infer<typeof KeyringAccountStruct>;\n\nexport const KeyringRequestStruct = object({\n  /**\n   * Account ID (UUIDv4).\n   */\n  account: UuidStruct,\n\n  /**\n   * Request's scope (CAIP-2 chain ID).\n   */\n  scope: string(),\n\n  /**\n   * JSON-RPC request sent by the client application.\n   *\n   * Note: The request ID must be a string.\n   */\n  request: JsonRpcRequestStruct,\n});\n\n/**\n * Keyring request.\n *\n * Represents a request made to the keyring for account-related operations.\n */\nexport type KeyringRequest = Infer<typeof KeyringRequestStruct>;\n\nexport const KeyringAccountDataStruct = record(string(), JsonStruct);\n\n/**\n * Response to a call to `exportAccount`.\n *\n * The exact response depends on the keyring implementation.\n */\nexport type KeyringAccountData = Infer<typeof KeyringAccountDataStruct>;\n\nexport const KeyringResponseStruct = union([\n  object({\n    /**\n     * Pending flag.\n     *\n     * Setting the pending flag to true indicates that the request will be\n     * handled asynchronously. The keyring must be called with `approveRequest`\n     * or `rejectRequest` to resolve the request.\n     */\n    pending: literal(true),\n\n    /**\n     * Redirect URL.\n     *\n     * If present in the response, MetaMask will display a confirmation dialog\n     * with a link to the redirect URL. The user can choose to follow the link\n     * or cancel the request.\n     */\n    redirect: nullable(string()),\n  }),\n  object({\n    /**\n     * Pending flag.\n     *\n     * Setting the pending flag to false indicates that the request will be\n     * handled synchronously. The keyring must return the result of the\n     * request execution.\n     */\n    pending: literal(false),\n\n    /**\n     * Request result.\n     */\n    result: JsonStruct,\n  }),\n]);\n\n/**\n * Response to a call to `submitRequest`.\n *\n * Keyring implementations must return a response with `pending: true` if the\n * request will be handled asynchronously. Otherwise, the response must contain\n * the result of the request and `pending: false`.\n *\n * In the asynchronous case, the keyring can return a redirect URL to be shown\n * to the user. The user can choose to follow the link or cancel the request.\n * The main use case for this is to redirect the user to a third-party service\n * to approve the request.\n */\nexport type KeyringResponse = Infer<typeof KeyringResponseStruct>;\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).\n   * @returns A promise that resolves to the newly created KeyringAccount\n   * object without any private information.\n   */\n  createAccount(options?: Record<string, Json>): Promise<KeyringAccount>;\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/events.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Supported keyring events.
+ */
+export declare enum KeyringEvent {
+    AccountCreated = "event:accountCreated",
+    AccountUpdated = "event:accountUpdated",
+    AccountDeleted = "event:accountDeleted",
+    RequestApproved = "event:requestApproved",
+    RequestRejected = "event:requestRejected"
+}

package/dist/events.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyringEvent = void 0;
+/**
+ * Supported keyring events.
+ */
+var KeyringEvent;
+(function (KeyringEvent) {
+    // Account events
+    KeyringEvent["AccountCreated"] = "event:accountCreated";
+    KeyringEvent["AccountUpdated"] = "event:accountUpdated";
+    KeyringEvent["AccountDeleted"] = "event:accountDeleted";
+    // Request events
+    KeyringEvent["RequestApproved"] = "event:requestApproved";
+    KeyringEvent["RequestRejected"] = "event:requestRejected";
+})(KeyringEvent = exports.KeyringEvent || (exports.KeyringEvent = {}));
+//# sourceMappingURL=events.js.map

package/dist/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,YASX;AATD,WAAY,YAAY;IACtB,iBAAiB;IACjB,uDAAuC,CAAA;IACvC,uDAAuC,CAAA;IACvC,uDAAuC,CAAA;IAEvC,iBAAiB;IACjB,yDAAyC,CAAA;IACzC,yDAAyC,CAAA;AAC3C,CAAC,EATW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QASvB","sourcesContent":["/**\n * Supported keyring events.\n */\nexport enum KeyringEvent {\n  // Account events\n  AccountCreated = 'event:accountCreated',\n  AccountUpdated = 'event:accountUpdated',\n  AccountDeleted = 'event:accountDeleted',\n\n  // Request events\n  RequestApproved = 'event:requestApproved',\n  RequestRejected = 'event:requestRejected',\n}\n"]}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-export * from './keyring-api';
-export * from './keyring-client';
-export * from './keyring-rpc-dispatcher';
-export * from './keyring-snap-controller-client';
-export * from './keyring-snap-rpc-client';
+export * from './api';
+export * from './KeyringClient';
+export * from './rpc-handler';
+export * from './KeyringSnapControllerClient';
+export * from './KeyringSnapRpcClient';
+export * from './internal';

package/dist/index.js

@@ -14,9 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./keyring-api"), exports);
-__exportStar(require("./keyring-client"), exports);
-__exportStar(require("./keyring-rpc-dispatcher"), exports);
-__exportStar(require("./keyring-snap-controller-client"), exports);
-__exportStar(require("./keyring-snap-rpc-client"), exports);
+__exportStar(require("./api"), exports);
+__exportStar(require("./KeyringClient"), exports);
+__exportStar(require("./rpc-handler"), exports);
+__exportStar(require("./KeyringSnapControllerClient"), exports);
+__exportStar(require("./KeyringSnapRpcClient"), exports);
+__exportStar(require("./internal"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,mDAAiC;AACjC,2DAAyC;AACzC,mEAAiD;AACjD,4DAA0C","sourcesContent":["export * from './keyring-api';\nexport * from './keyring-client';\nexport * from './keyring-rpc-dispatcher';\nexport * from './keyring-snap-controller-client';\nexport * from './keyring-snap-rpc-client';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,kDAAgC;AAChC,gDAA8B;AAC9B,gEAA8C;AAC9C,yDAAuC;AACvC,6CAA2B","sourcesContent":["export * from './api';\nexport * from './KeyringClient';\nexport * from './rpc-handler';\nexport * from './KeyringSnapControllerClient';\nexport * from './KeyringSnapRpcClient';\nexport * from './internal';\n"]}