@metamask/keyring-api 0.1.2 → 0.2.0

package/CHANGELOG.md

@@ -6,6 +6,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0]
+### Added
+- Add `InternalAccount` type and create submodule `internal` ([#65](https://github.com/MetaMask/keyring-api/pull/65))
+- Add keyring events and helper functions ([#74](https://github.com/MetaMask/keyring-api/pull/74))
+- Add a `redirect` field to asynchronous request responses ([#75](https://github.com/MetaMask/keyring-api/pull/75))
+- Add `exportAccount` method ([#60](https://github.com/MetaMask/keyring-api/pull/60))
+- Add `getController` to client ([#43](https://github.com/MetaMask/keyring-api/pull/43))
+
+### Changed
+- Rename `erc4337` -> `eip4337` ([#42](https://github.com/MetaMask/keyring-api/pull/42))
+- Make `options` a mandatory field of `KeyringAccount` ([#30](https://github.com/MetaMask/keyring-api/pull/30))
+- Make `approveRequest` and `rejectRequest` optional ([#63](https://github.com/MetaMask/keyring-api/pull/63))
+- Make `exportAccount`, `listRequests` and `getRequest` optional ([#73](https://github.com/MetaMask/keyring-api/pull/73))
+- Export enums with account methods and types ([#66](https://github.com/MetaMask/keyring-api/pull/66))
+- Make `approveRequest` accept a `result` argument ([#59](https://github.com/MetaMask/keyring-api/pull/59))
+- Remove account name from `KeyringAccount` type ([#55](https://github.com/MetaMask/keyring-api/pull/55))
+- Remove `eth_sendTransaction` method ([#50](https://github.com/MetaMask/keyring-api/pull/50))
+- Rename `supportedMethods` to `methods` ([#35](https://github.com/MetaMask/keyring-api/pull/35))
+
+## [0.1.3]
+### Changed
+- Downgrade snaps dependencies to `0.35.2-flask.1`. ([#25](https://github.com/MetaMask/keyring-api/pull/25))
+
 ## [0.1.2]
 ### Changed
 - Update snaps dependencies. ([#21](https://github.com/MetaMask/keyring-api/pull/21))
@@ -25,7 +48,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - SnapController keyring client. It is intended to be used by MetaMask to talk to the snap.
 - Helper functions to create keyring handler in the snap.
 
-[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v0.1.2...HEAD
+[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/MetaMask/keyring-api/compare/v0.1.3...v0.2.0
+[0.1.3]: https://github.com/MetaMask/keyring-api/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/MetaMask/keyring-api/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/MetaMask/keyring-api/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/MetaMask/keyring-api/releases/tag/v0.1.0

package/dist/JsonRpcRequest.d.ts

@@ -0,0 +1,15 @@
+import { type Infer } from 'superstruct';
+export declare const JsonRpcRequestStruct: import("superstruct").Struct<{
+    jsonrpc: "2.0";
+    id: string | number | null;
+    method: string;
+} | {
+    jsonrpc: "2.0";
+    id: string | number | null;
+    method: string;
+    params: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
+}, null>;
+/**
+ * JSON-RPC request type.
+ */
+export declare type JsonRpcRequest = Infer<typeof JsonRpcRequestStruct>;

package/dist/JsonRpcRequest.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonRpcRequestStruct = void 0;
+const utils_1 = require("@metamask/utils");
+const superstruct_1 = require("superstruct");
+const Common = {
+    jsonrpc: (0, superstruct_1.literal)('2.0'),
+    id: (0, superstruct_1.nullable)((0, superstruct_1.union)([(0, superstruct_1.string)(), (0, superstruct_1.number)()])),
+    method: (0, superstruct_1.string)(),
+};
+const Params = {
+    params: (0, superstruct_1.union)([(0, superstruct_1.array)(utils_1.JsonStruct), (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct)]),
+};
+exports.JsonRpcRequestStruct = (0, superstruct_1.union)([
+    (0, superstruct_1.object)({ ...Common }),
+    (0, superstruct_1.object)({ ...Common, ...Params }),
+]);
+//# sourceMappingURL=JsonRpcRequest.js.map

package/dist/JsonRpcRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsonRpcRequest.js","sourceRoot":"","sources":["../src/JsonRpcRequest.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,6CAUqB;AAErB,MAAM,MAAM,GAAG;IACb,OAAO,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;IACvB,EAAE,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,CAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,oBAAM,GAAE,CAAC,CAAC,CAAC;IACzC,MAAM,EAAE,IAAA,oBAAM,GAAE;CACjB,CAAC;AAEF,MAAM,MAAM,GAAG;IACb,MAAM,EAAE,IAAA,mBAAK,EAAC,CAAC,IAAA,mBAAK,EAAC,kBAAU,CAAC,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC,CAAC;CACjE,CAAC;AAEW,QAAA,oBAAoB,GAAG,IAAA,mBAAK,EAAC;IACxC,IAAA,oBAAM,EAAC,EAAE,GAAG,MAAM,EAAE,CAAC;IACrB,IAAA,oBAAM,EAAC,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;CACjC,CAAC,CAAC","sourcesContent":["import { JsonStruct } from '@metamask/utils';\nimport {\n  type Infer,\n  array,\n  literal,\n  nullable,\n  number,\n  object,\n  record,\n  string,\n  union,\n} from 'superstruct';\n\nconst Common = {\n  jsonrpc: literal('2.0'),\n  id: nullable(union([string(), number()])),\n  method: string(),\n};\n\nconst Params = {\n  params: union([array(JsonStruct), record(string(), JsonStruct)]),\n};\n\nexport const JsonRpcRequestStruct = union([\n  object({ ...Common }),\n  object({ ...Common, ...Params }),\n]);\n\n/**\n * JSON-RPC request type.\n */\nexport type JsonRpcRequest = Infer<typeof JsonRpcRequestStruct>;\n"]}

package/dist/{keyring-client.d.ts → KeyringClient.d.ts}

@@ -1,8 +1,8 @@
 import type { Json } from '@metamask/utils';
-import { Keyring, KeyringAccount, KeyringRequest, SubmitRequestResponse } from './keyring-api';
-import { InternalRequest, InternalResponse } from './keyring-internal-api';
+import type { Keyring, KeyringAccount, KeyringRequest, KeyringAccountData, KeyringResponse } from './api';
+import type { JsonRpcRequest } from './JsonRpcRequest';
 export declare type Sender = {
-    send(request: InternalRequest): Promise<InternalResponse>;
+    send(request: JsonRpcRequest): Promise<Json>;
 };
 export declare class KeyringClient implements Keyring {
     #private;
@@ -14,13 +14,14 @@ export declare class KeyringClient implements Keyring {
     constructor(sender: Sender);
     listAccounts(): Promise<KeyringAccount[]>;
     getAccount(id: string): Promise<KeyringAccount>;
-    createAccount(name: string, options?: Record<string, Json> | null): Promise<KeyringAccount>;
+    createAccount(options?: Record<string, Json>): Promise<KeyringAccount>;
     filterAccountChains(id: string, chains: string[]): Promise<string[]>;
     updateAccount(account: KeyringAccount): Promise<void>;
     deleteAccount(id: string): Promise<void>;
+    exportAccount(id: string): Promise<KeyringAccountData>;
     listRequests(): Promise<KeyringRequest[]>;
     getRequest(id: string): Promise<KeyringRequest>;
-    submitRequest(request: KeyringRequest): Promise<SubmitRequestResponse>;
-    approveRequest(id: string): Promise<void>;
+    submitRequest(request: KeyringRequest): Promise<KeyringResponse>;
+    approveRequest(id: string, data?: Record<string, Json>): Promise<void>;
     rejectRequest(id: string): Promise<void>;
 }

package/dist/{keyring-client.js → KeyringClient.js}

@@ -15,8 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyringClient = void 0;
 const superstruct_1 = require("superstruct");
 const uuid_1 = require("uuid");
-const keyring_api_1 = require("./keyring-api");
-const keyring_internal_api_1 = require("./keyring-internal-api");
+const api_1 = require("./internal/api");
 const utils_1 = require("./utils");
 class KeyringClient {
     /**
@@ -32,66 +31,72 @@ class KeyringClient {
     async listAccounts() {
         return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: 'keyring_listAccounts',
-        }), keyring_internal_api_1.ListAccountsResponseStruct);
+        }), api_1.ListAccountsResponseStruct);
     }
     async getAccount(id) {
         return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: 'keyring_getAccount',
             params: { id },
-        }), keyring_internal_api_1.GetAccountResponseStruct);
+        }), api_1.GetAccountResponseStruct);
     }
-    async createAccount(name, options = null) {
+    async createAccount(options = {}) {
         return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: 'keyring_createAccount',
-            params: { name, options },
-        }), keyring_internal_api_1.CreateAccountResponseStruct);
+            params: { options },
+        }), api_1.CreateAccountResponseStruct);
     }
     async filterAccountChains(id, chains) {
         return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: 'keyring_filterAccountChains',
             params: { id, chains },
-        }), keyring_internal_api_1.FilterAccountChainsResponseStruct);
+        }), api_1.FilterAccountChainsResponseStruct);
     }
     async updateAccount(account) {
         (0, superstruct_1.assert)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: 'keyring_updateAccount',
             params: { account },
-        }), keyring_internal_api_1.UpdateAccountResponseStruct);
+        }), api_1.UpdateAccountResponseStruct);
     }
     async deleteAccount(id) {
         (0, superstruct_1.assert)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: 'keyring_deleteAccount',
             params: { id },
-        }), keyring_internal_api_1.DeleteAccountResponseStruct);
+        }), api_1.DeleteAccountResponseStruct);
+    }
+    async exportAccount(id) {
+        return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+            method: 'keyring_exportAccount',
+            params: { id },
+        }), api_1.ExportAccountResponseStruct);
     }
     async listRequests() {
         return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: 'keyring_listRequests',
-        }), keyring_internal_api_1.ListRequestsResponseStruct);
+        }), api_1.ListRequestsResponseStruct);
     }
     async getRequest(id) {
         return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: 'keyring_getRequest',
             params: { id },
-        }), keyring_internal_api_1.GetRequestResponseStruct);
+        }), api_1.GetRequestResponseStruct);
     }
     async submitRequest(request) {
         return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: 'keyring_submitRequest',
             params: request,
-        }), keyring_api_1.SubmitRequestResponseStruct);
+        }), api_1.SubmitRequestResponseStruct);
     }
-    async approveRequest(id) {
+    async approveRequest(id, data = {}) {
         (0, superstruct_1.assert)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: 'keyring_approveRequest',
-            params: { id },
-        }), keyring_internal_api_1.ApproveRequestResponseStruct);
+            params: { id, data },
+        }), api_1.ApproveRequestResponseStruct);
     }
     async rejectRequest(id) {
         (0, superstruct_1.assert)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: 'keyring_rejectRequest',
             params: { id },
-        }), keyring_internal_api_1.RejectRequestResponseStruct);
+        }), api_1.RejectRequestResponseStruct);
     }
 }
 exports.KeyringClient = KeyringClient;
@@ -99,14 +104,14 @@ _KeyringClient_sender = new WeakMap(), _KeyringClient_instances = new WeakSet(),
 /**
  * Send a request to the snap and return the response.
  *
- * @param partial - Partial internal request (method and params).
+ * @param partial - A partial JSON-RPC request (method and params).
  * @returns A promise that resolves to the response to the request.
  */
 async function _KeyringClient_send(partial) {
-    return await __classPrivateFieldGet(this, _KeyringClient_sender, "f").send({
+    return __classPrivateFieldGet(this, _KeyringClient_sender, "f").send({
         jsonrpc: '2.0',
         id: (0, uuid_1.v4)(),
         ...partial,
     });
 };
-//# sourceMappingURL=keyring-client.js.map
+//# sourceMappingURL=KeyringClient.js.map

package/dist/KeyringClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyringClient.js","sourceRoot":"","sources":["../src/KeyringClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,6CAAqC;AACrC,+BAAkC;AASlC,wCAawB;AAExB,mCAAqD;AAMrD,MAAa,aAAa;IAGxB;;;;OAIG;IACH,YAAY,MAAc;;QAP1B,wCAAgB;QAQd,uBAAA,IAAI,yBAAW,MAAM,MAAA,CAAC;IACxB,CAAC;IAkBD,KAAK,CAAC,YAAY;QAChB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAsB;SAC/B,CAAC,EACF,gCAA0B,CAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,oBAAoB;YAC5B,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,8BAAwB,CACzB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,UAAgC,EAAE;QAElC,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,uBAAuB;YAC/B,MAAM,EAAE,EAAE,OAAO,EAAE;SACpB,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,EAAU,EAAE,MAAgB;QACpD,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,6BAA6B;YACrC,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE;SACvB,CAAC,EACF,uCAAiC,CAClC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAuB;QACzC,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,uBAAuB;YAC/B,MAAM,EAAE,EAAE,OAAO,EAAE;SACpB,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,uBAAuB;YAC/B,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,uBAAuB;YAC/B,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAsB;SAC/B,CAAC,EACF,gCAA0B,CAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,oBAAoB;YAC5B,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,8BAAwB,CACzB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAuB;QACzC,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,uBAAuB;YAC/B,MAAM,EAAE,OAAO;SAChB,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,OAA6B,EAAE;QAE/B,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,wBAAwB;YAChC,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE;SACrB,CAAC,EACF,kCAA4B,CAC7B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,uBAAuB;YAC/B,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;CACF;AAtJD,sCAsJC;;AA1IC;;;;;GAKG;AACH,KAAK,8BACH,OAAoD;IAEpD,OAAO,uBAAA,IAAI,6BAAQ,CAAC,IAAI,CAAC;QACvB,OAAO,EAAE,KAAK;QACd,EAAE,EAAE,IAAA,SAAI,GAAE;QACV,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { assert } from 'superstruct';\nimport { v4 as uuid } from 'uuid';\n\nimport type {\n  Keyring,\n  KeyringAccount,\n  KeyringRequest,\n  KeyringAccountData,\n  KeyringResponse,\n} from './api';\nimport {\n  ApproveRequestResponseStruct,\n  CreateAccountResponseStruct,\n  DeleteAccountResponseStruct,\n  ExportAccountResponseStruct,\n  FilterAccountChainsResponseStruct,\n  GetAccountResponseStruct,\n  GetRequestResponseStruct,\n  ListAccountsResponseStruct,\n  ListRequestsResponseStruct,\n  RejectRequestResponseStruct,\n  SubmitRequestResponseStruct,\n  UpdateAccountResponseStruct,\n} from './internal/api';\nimport type { JsonRpcRequest } from './JsonRpcRequest';\nimport { type OmitUnion, strictMask } from './utils';\n\nexport type Sender = {\n  send(request: JsonRpcRequest): Promise<Json>;\n};\n\nexport class KeyringClient implements Keyring {\n  #sender: Sender;\n\n  /**\n   * Create a new instance of `KeyringClient`.\n   *\n   * @param sender - The `Sender` instance to use to send requests to the snap.\n   */\n  constructor(sender: Sender) {\n    this.#sender = sender;\n  }\n\n  /**\n   * Send a request to the snap and return the response.\n   *\n   * @param partial - A partial JSON-RPC request (method and params).\n   * @returns A promise that resolves to the response to the request.\n   */\n  async #send(\n    partial: OmitUnion<JsonRpcRequest, 'jsonrpc' | 'id'>,\n  ): Promise<Json> {\n    return this.#sender.send({\n      jsonrpc: '2.0',\n      id: uuid(),\n      ...partial,\n    });\n  }\n\n  async listAccounts(): Promise<KeyringAccount[]> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_listAccounts',\n      }),\n      ListAccountsResponseStruct,\n    );\n  }\n\n  async getAccount(id: string): Promise<KeyringAccount> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_getAccount',\n        params: { id },\n      }),\n      GetAccountResponseStruct,\n    );\n  }\n\n  async createAccount(\n    options: Record<string, Json> = {},\n  ): Promise<KeyringAccount> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_createAccount',\n        params: { options },\n      }),\n      CreateAccountResponseStruct,\n    );\n  }\n\n  async filterAccountChains(id: string, chains: string[]): Promise<string[]> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_filterAccountChains',\n        params: { id, chains },\n      }),\n      FilterAccountChainsResponseStruct,\n    );\n  }\n\n  async updateAccount(account: KeyringAccount): Promise<void> {\n    assert(\n      await this.#send({\n        method: 'keyring_updateAccount',\n        params: { account },\n      }),\n      UpdateAccountResponseStruct,\n    );\n  }\n\n  async deleteAccount(id: string): Promise<void> {\n    assert(\n      await this.#send({\n        method: 'keyring_deleteAccount',\n        params: { id },\n      }),\n      DeleteAccountResponseStruct,\n    );\n  }\n\n  async exportAccount(id: string): Promise<KeyringAccountData> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_exportAccount',\n        params: { id },\n      }),\n      ExportAccountResponseStruct,\n    );\n  }\n\n  async listRequests(): Promise<KeyringRequest[]> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_listRequests',\n      }),\n      ListRequestsResponseStruct,\n    );\n  }\n\n  async getRequest(id: string): Promise<KeyringRequest> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_getRequest',\n        params: { id },\n      }),\n      GetRequestResponseStruct,\n    );\n  }\n\n  async submitRequest(request: KeyringRequest): Promise<KeyringResponse> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_submitRequest',\n        params: request,\n      }),\n      SubmitRequestResponseStruct,\n    );\n  }\n\n  async approveRequest(\n    id: string,\n    data: Record<string, Json> = {},\n  ): Promise<void> {\n    assert(\n      await this.#send({\n        method: 'keyring_approveRequest',\n        params: { id, data },\n      }),\n      ApproveRequestResponseStruct,\n    );\n  }\n\n  async rejectRequest(id: string): Promise<void> {\n    assert(\n      await this.#send({\n        method: 'keyring_rejectRequest',\n        params: { id },\n      }),\n      RejectRequestResponseStruct,\n    );\n  }\n}\n"]}

package/dist/{keyring-snap-controller-client.d.ts → KeyringSnapControllerClient.d.ts}

@@ -1,6 +1,6 @@
 import type { SnapController } from '@metamask/snaps-controllers';
 import type { HandlerType } from '@metamask/snaps-utils';
-import { KeyringClient } from './keyring-client';
+import { KeyringClient } from './KeyringClient';
 /**
  * A `KeyringClient` that allows the communication with a snap through the
  * `SnapController`.
@@ -35,4 +35,10 @@ export declare class KeyringSnapControllerClient extends KeyringClient {
      * specified snap ID.
      */
     withSnapId(snapId: string): KeyringSnapControllerClient;
+    /**
+     * Get the `SnapController` instance used by this client.
+     *
+     * @returns The `SnapController` instance used by this client.
+     */
+    getController(): SnapController;
 }

package/dist/{keyring-snap-controller-client.js → KeyringSnapControllerClient.js}

@@ -13,9 +13,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _SnapControllerSender_snapId, _SnapControllerSender_origin, _SnapControllerSender_controller, _SnapControllerSender_handler, _KeyringSnapControllerClient_controller;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyringSnapControllerClient = void 0;
-const keyring_client_1 = require("./keyring-client");
-const keyring_internal_api_1 = require("./keyring-internal-api");
-const utils_1 = require("./utils");
+const KeyringClient_1 = require("./KeyringClient");
 /**
  * Implementation of the `Sender` interface that can be used to send requests
  * to a snap through a `SnapController`.
@@ -46,12 +44,12 @@ class SnapControllerSender {
      * @returns A promise that resolves to the response of the request.
      */
     async send(request) {
-        return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _SnapControllerSender_controller, "f").handleRequest({
+        return __classPrivateFieldGet(this, _SnapControllerSender_controller, "f").handleRequest({
             snapId: __classPrivateFieldGet(this, _SnapControllerSender_snapId, "f"),
             origin: __classPrivateFieldGet(this, _SnapControllerSender_origin, "f"),
             handler: __classPrivateFieldGet(this, _SnapControllerSender_handler, "f"),
             request,
-        }), keyring_internal_api_1.InternalResponseStruct);
+        });
     }
 }
 _SnapControllerSender_snapId = new WeakMap(), _SnapControllerSender_origin = new WeakMap(), _SnapControllerSender_controller = new WeakMap(), _SnapControllerSender_handler = new WeakMap();
@@ -59,7 +57,7 @@ _SnapControllerSender_snapId = new WeakMap(), _SnapControllerSender_origin = new
  * A `KeyringClient` that allows the communication with a snap through the
  * `SnapController`.
  */
-class KeyringSnapControllerClient extends keyring_client_1.KeyringClient {
+class KeyringSnapControllerClient extends KeyringClient_1.KeyringClient {
     /**
      * Create a new instance of `KeyringSnapControllerClient`.
      *
@@ -92,7 +90,15 @@ class KeyringSnapControllerClient extends keyring_client_1.KeyringClient {
             snapId,
         });
     }
+    /**
+     * Get the `SnapController` instance used by this client.
+     *
+     * @returns The `SnapController` instance used by this client.
+     */
+    getController() {
+        return __classPrivateFieldGet(this, _KeyringSnapControllerClient_controller, "f");
+    }
 }
 exports.KeyringSnapControllerClient = KeyringSnapControllerClient;
 _KeyringSnapControllerClient_controller = new WeakMap();
-//# sourceMappingURL=keyring-snap-controller-client.js.map
+//# sourceMappingURL=KeyringSnapControllerClient.js.map

package/dist/KeyringSnapControllerClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyringSnapControllerClient.js","sourceRoot":"","sources":["../src/KeyringSnapControllerClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAKA,mDAA6D;AAE7D;;;GAGG;AACH,MAAM,oBAAoB;IASxB;;;;;;;OAOG;IACH,YACE,UAAe,EACf,MAAc,EACd,MAAc,EACd,OAAoB;QApBtB,+CAAgB;QAEhB,+CAAgB;QAEhB,mDAA4B;QAE5B,gDAAsB;QAgBpB,uBAAA,IAAI,oCAAe,UAAU,MAAA,CAAC;QAC9B,uBAAA,IAAI,gCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,gCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,iCAAY,OAAO,MAAA,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,OAAuB;QAChC,OAAO,uBAAA,IAAI,wCAAY,CAAC,aAAa,CAAC;YACpC,MAAM,EAAE,uBAAA,IAAI,oCAA2B;YACvC,MAAM,EAAE,uBAAA,IAAI,oCAAQ;YACpB,OAAO,EAAE,uBAAA,IAAI,qCAAS;YACtB,OAAO;SACR,CAAkB,CAAC;IACtB,CAAC;CACF;;AAED;;;GAGG;AACH,MAAa,2BAA4B,SAAQ,6BAAa;IAG5D;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,UAAU,EACV,MAAM,GAAG,WAAW,EACpB,MAAM,GAAG,UAAU,EACnB,OAAO,GAAG,cAA6B,GAMxC;QACC,KAAK,CAAC,IAAI,oBAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QA1BvE,0DAA4B;QA2B1B,uBAAA,IAAI,2CAAe,UAAU,MAAA,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,MAAc;QACvB,OAAO,IAAI,2BAA2B,CAAC;YACrC,UAAU,EAAE,uBAAA,IAAI,+CAAY;YAC5B,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,aAAa;QACX,OAAO,uBAAA,IAAI,+CAAY,CAAC;IAC1B,CAAC;CACF;AAtDD,kEAsDC","sourcesContent":["import type { SnapController } from '@metamask/snaps-controllers';\nimport type { HandlerType, ValidatedSnapId } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\n\nimport type { JsonRpcRequest } from './JsonRpcRequest';\nimport { KeyringClient, type Sender } from './KeyringClient';\n\n/**\n * Implementation of the `Sender` interface that can be used to send requests\n * to a snap through a `SnapController`.\n */\nclass SnapControllerSender implements Sender {\n  #snapId: string;\n\n  #origin: string;\n\n  #controller: SnapController;\n\n  #handler: HandlerType;\n\n  /**\n   * Create a new instance of `SnapControllerSender`.\n   *\n   * @param controller - The `SnapController` instance to send requests to.\n   * @param snapId - The ID of the snap to use.\n   * @param origin - The sender's origin.\n   * @param handler - The handler type.\n   */\n  constructor(\n    controller: any,\n    snapId: string,\n    origin: string,\n    handler: HandlerType,\n  ) {\n    this.#controller = controller;\n    this.#snapId = snapId;\n    this.#origin = origin;\n    this.#handler = handler;\n  }\n\n  /**\n   * Send a request to the snap and return the response.\n   *\n   * @param request - JSON-RPC request to send to the snap.\n   * @returns A promise that resolves to the response of the request.\n   */\n  async send(request: JsonRpcRequest): Promise<Json> {\n    return this.#controller.handleRequest({\n      snapId: this.#snapId as ValidatedSnapId,\n      origin: this.#origin,\n      handler: this.#handler,\n      request,\n    }) as Promise<Json>;\n  }\n}\n\n/**\n * A `KeyringClient` that allows the communication with a snap through the\n * `SnapController`.\n */\nexport class KeyringSnapControllerClient extends KeyringClient {\n  #controller: SnapController;\n\n  /**\n   * Create a new instance of `KeyringSnapControllerClient`.\n   *\n   * The `handlerType` argument has a hard-coded default `string` value instead\n   * of a `HandlerType` value to prevent the `@metamask/snaps-utils` module\n   * from being required at runtime.\n   *\n   * @param args - Constructor arguments.\n   * @param args.controller - The `SnapController` instance to use.\n   * @param args.snapId - The ID of the snap to use (default: `'undefined'`).\n   * @param args.origin - The sender's origin (default: `'metamask'`).\n   * @param args.handler - The handler type (default: `'onRpcRequest'`).\n   */\n  constructor({\n    controller,\n    snapId = 'undefined',\n    origin = 'metamask',\n    handler = 'onRpcRequest' as HandlerType,\n  }: {\n    controller: SnapController;\n    snapId?: string;\n    origin?: string;\n    handler?: HandlerType;\n  }) {\n    super(new SnapControllerSender(controller, snapId, origin, handler));\n    this.#controller = controller;\n  }\n\n  /**\n   * Create a new instance of `KeyringSnapControllerClient` with the specified\n   * `snapId`.\n   *\n   * @param snapId - The ID of the snap to use in the new instance.\n   * @returns A new instance of `KeyringSnapControllerClient` with the\n   * specified snap ID.\n   */\n  withSnapId(snapId: string): KeyringSnapControllerClient {\n    return new KeyringSnapControllerClient({\n      controller: this.#controller,\n      snapId,\n    });\n  }\n\n  /**\n   * Get the `SnapController` instance used by this client.\n   *\n   * @returns The `SnapController` instance used by this client.\n   */\n  getController(): SnapController {\n    return this.#controller;\n  }\n}\n"]}

package/dist/{keyring-snap-rpc-client.d.ts → KeyringSnapRpcClient.d.ts}

@@ -1,6 +1,7 @@
 import type { MetaMaskInpageProvider } from '@metamask/providers';
-import { KeyringClient, Sender } from './keyring-client';
-import { type InternalRequest, InternalResponse } from './keyring-internal-api';
+import type { Json } from '@metamask/utils';
+import type { JsonRpcRequest } from './JsonRpcRequest';
+import { KeyringClient, type Sender } from './KeyringClient';
 /**
  * Implementation of the `Sender` interface that can be used to send requests
  * to a snap through the snap JSON-RPC API.
@@ -20,7 +21,7 @@ export declare class SnapRpcSender implements Sender {
      * @param request - The JSON-RPC request to send to the snap.
      * @returns A promise that resolves to the response of the request.
      */
-    send(request: InternalRequest): Promise<InternalResponse>;
+    send(request: JsonRpcRequest): Promise<Json>;
 }
 /**
  * A `KeyringClient` that allows the communication with a snap through the snap

package/dist/{keyring-snap-rpc-client.js → KeyringSnapRpcClient.js}

@@ -13,9 +13,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _SnapRpcSender_origin, _SnapRpcSender_provider;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyringSnapRpcClient = exports.SnapRpcSender = void 0;
-const keyring_client_1 = require("./keyring-client");
-const keyring_internal_api_1 = require("./keyring-internal-api");
-const utils_1 = require("./utils");
+const KeyringClient_1 = require("./KeyringClient");
 /**
  * Implementation of the `Sender` interface that can be used to send requests
  * to a snap through the snap JSON-RPC API.
@@ -40,13 +38,13 @@ class SnapRpcSender {
      * @returns A promise that resolves to the response of the request.
      */
     async send(request) {
-        return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _SnapRpcSender_provider, "f").request({
+        return __classPrivateFieldGet(this, _SnapRpcSender_provider, "f").request({
             method: 'wallet_invokeSnap',
             params: {
                 snapId: __classPrivateFieldGet(this, _SnapRpcSender_origin, "f"),
                 request,
             },
-        }), keyring_internal_api_1.InternalResponseStruct);
+        });
     }
 }
 exports.SnapRpcSender = SnapRpcSender;
@@ -55,7 +53,7 @@ _SnapRpcSender_origin = new WeakMap(), _SnapRpcSender_provider = new WeakMap();
  * A `KeyringClient` that allows the communication with a snap through the snap
  * JSON-RPC API.
  */
-class KeyringSnapRpcClient extends keyring_client_1.KeyringClient {
+class KeyringSnapRpcClient extends KeyringClient_1.KeyringClient {
     /**
      * Create a new instance of `KeyringSnapRpcClient`.
      *
@@ -67,4 +65,4 @@ class KeyringSnapRpcClient extends keyring_client_1.KeyringClient {
     }
 }
 exports.KeyringSnapRpcClient = KeyringSnapRpcClient;
-//# sourceMappingURL=keyring-snap-rpc-client.js.map
+//# sourceMappingURL=KeyringSnapRpcClient.js.map

package/dist/KeyringSnapRpcClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyringSnapRpcClient.js","sourceRoot":"","sources":["../src/KeyringSnapRpcClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAIA,mDAA6D;AAE7D;;;GAGG;AACH,MAAa,aAAa;IAKxB;;;;;OAKG;IACH,YAAY,MAAc,EAAE,QAAgC;QAV5D,wCAAgB;QAEhB,0CAAkC;QAShC,uBAAA,IAAI,yBAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,2BAAa,QAAQ,MAAA,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,OAAuB;QAChC,OAAO,uBAAA,IAAI,+BAAU,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,mBAAmB;YAC3B,MAAM,EAAE;gBACN,MAAM,EAAE,uBAAA,IAAI,6BAAQ;gBACpB,OAAO;aACR;SACF,CAAkB,CAAC;IACtB,CAAC;CACF;AA/BD,sCA+BC;;AAED;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,6BAAa;IACrD;;;;;OAKG;IACH,YAAY,MAAc,EAAE,QAAgC;QAC1D,KAAK,CAAC,IAAI,aAAa,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC7C,CAAC;CACF;AAVD,oDAUC","sourcesContent":["import type { MetaMaskInpageProvider } from '@metamask/providers';\nimport type { Json } from '@metamask/utils';\n\nimport type { JsonRpcRequest } from './JsonRpcRequest';\nimport { KeyringClient, type Sender } from './KeyringClient';\n\n/**\n * Implementation of the `Sender` interface that can be used to send requests\n * to a snap through the snap JSON-RPC API.\n */\nexport class SnapRpcSender implements Sender {\n  #origin: string;\n\n  #provider: MetaMaskInpageProvider;\n\n  /**\n   * Create a new instance of `SnapRpcSender`.\n   *\n   * @param origin - The caller's origin.\n   * @param provider - The `MetaMaskInpageProvider` instance to use.\n   */\n  constructor(origin: string, provider: MetaMaskInpageProvider) {\n    this.#origin = origin;\n    this.#provider = provider;\n  }\n\n  /**\n   * Send a request to the snap and return the response.\n   *\n   * @param request - The JSON-RPC request to send to the snap.\n   * @returns A promise that resolves to the response of the request.\n   */\n  async send(request: JsonRpcRequest): Promise<Json> {\n    return this.#provider.request({\n      method: 'wallet_invokeSnap',\n      params: {\n        snapId: this.#origin,\n        request,\n      },\n    }) as Promise<Json>;\n  }\n}\n\n/**\n * A `KeyringClient` that allows the communication with a snap through the snap\n * JSON-RPC API.\n */\nexport class KeyringSnapRpcClient extends KeyringClient {\n  /**\n   * Create a new instance of `KeyringSnapRpcClient`.\n   *\n   * @param origin - Caller's origin.\n   * @param provider - The `MetaMaskInpageProvider` instance to use.\n   */\n  constructor(origin: string, provider: MetaMaskInpageProvider) {\n    super(new SnapRpcSender(origin, provider));\n  }\n}\n"]}