@metamask/keyring-api 2.0.0 → 3.0.0

package/CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.0]
+
+### Changed
+
+- Bump `@metamask/utils` from 8.2.1 to 8.3.0 ([#238](https://github.com/MetaMask/keyring-api/pull/238))
+- Bump Snap dependencies ([#236](https://github.com/MetaMask/keyring-api/pull/236))
+  - Bump `@metamask/snaps-controllers` to ^4.0.0
+  - Bump `@metamask/snaps-sdk` to ^1.3.2
+  - Bump `@metamask/snaps-utils` to ^5.1.2
+- Bump `@metamask/approval-controller` from 5.0.0 to 5.1.1 ([#225](https://github.com/MetaMask/keyring-api/pull/225))
+- Bump `@metamask/base-controller` from 4.0.0 to 4.0.1 ([#226](https://github.com/MetaMask/keyring-api/pull/226))
+- Bump `@metamask/json-rpc-engine` from 7.3.0 to 7.3.1 ([#227](https://github.com/MetaMask/keyring-api/pull/227))
+- Bump `@metamask/auto-changelog` from 3.4.3 to 3.4.4 ([#223](https://github.com/MetaMask/keyring-api/pull/223))
+- Bump `@metamask/snaps-sdk` from 1.3.0 to 1.3.1 ([#222](https://github.com/MetaMask/keyring-api/pull/222))
+
+### Removed
+
+- **BREAKING**: remove `KeyringSnapControllerClient` class to fix dependency problems ([#241](https://github.com/MetaMask/keyring-api/pull/241))
+
 ## [2.0.0]
 
 ### Added
@@ -188,7 +207,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/keyring-api/compare/v2.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v3.0.0...HEAD
+[3.0.0]: https://github.com/MetaMask/keyring-api/compare/v2.0.0...v3.0.0
 [2.0.0]: https://github.com/MetaMask/keyring-api/compare/v1.1.0...v2.0.0
 [1.1.0]: https://github.com/MetaMask/keyring-api/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/MetaMask/keyring-api/compare/v1.0.0-rc.1...v1.0.0

package/dist/index.d.ts

@@ -3,7 +3,6 @@ export * from './eth';
 export * from './events';
 export * from './internal';
 export * from './KeyringClient';
-export * from './KeyringSnapControllerClient';
 export * from './KeyringSnapRpcClient';
 export * from './rpc-handler';
 export * from './snap-utils';

package/dist/index.js

@@ -19,7 +19,6 @@ __exportStar(require("./eth"), exports);
 __exportStar(require("./events"), exports);
 __exportStar(require("./internal"), exports);
 __exportStar(require("./KeyringClient"), exports);
-__exportStar(require("./KeyringSnapControllerClient"), exports);
 __exportStar(require("./KeyringSnapRpcClient"), exports);
 __exportStar(require("./rpc-handler"), exports);
 __exportStar(require("./snap-utils"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,wCAAsB;AACtB,2CAAyB;AACzB,6CAA2B;AAC3B,kDAAgC;AAChC,gEAA8C;AAC9C,yDAAuC;AACvC,gDAA8B;AAC9B,+CAA6B;AAC7B,gDAA8B","sourcesContent":["export * from './api';\nexport * from './eth';\nexport * from './events';\nexport * from './internal';\nexport * from './KeyringClient';\nexport * from './KeyringSnapControllerClient';\nexport * from './KeyringSnapRpcClient';\nexport * from './rpc-handler';\nexport * from './snap-utils';\nexport * from './superstruct';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,wCAAsB;AACtB,2CAAyB;AACzB,6CAA2B;AAC3B,kDAAgC;AAChC,yDAAuC;AACvC,gDAA8B;AAC9B,+CAA6B;AAC7B,gDAA8B","sourcesContent":["export * from './api';\nexport * from './eth';\nexport * from './events';\nexport * from './internal';\nexport * from './KeyringClient';\nexport * from './KeyringSnapRpcClient';\nexport * from './rpc-handler';\nexport * from './snap-utils';\nexport * from './superstruct';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/keyring-api",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "MetaMask Keyring API",
   "keywords": [
     "metamask",
@@ -39,9 +39,7 @@
   },
   "dependencies": {
     "@metamask/providers": "^14.0.1",
-    "@metamask/snaps-controllers": "^3.4.1",
-    "@metamask/snaps-sdk": "^1.2.0",
-    "@metamask/snaps-utils": "^5.0.0",
+    "@metamask/snaps-sdk": "^1.3.2",
     "@metamask/utils": "^8.1.0",
     "@types/uuid": "^9.0.1",
     "superstruct": "^1.0.3",

package/dist/KeyringSnapControllerClient.d.ts

@@ -1,45 +0,0 @@
-import type { SnapController } from '@metamask/snaps-controllers';
-import type { SnapId } from '@metamask/snaps-sdk';
-import type { HandlerType } from '@metamask/snaps-utils';
-import { KeyringClient } from './KeyringClient';
-/**
- * A `KeyringClient` that allows the communication with a snap through the
- * `SnapController`.
- */
-export declare class KeyringSnapControllerClient extends KeyringClient {
-    #private;
-    /**
-     * Create a new instance of `KeyringSnapControllerClient`.
-     *
-     * The `handlerType` argument has a hard-coded default `string` value instead
-     * of a `HandlerType` value to prevent the `@metamask/snaps-utils` module
-     * from being required at runtime.
-     *
-     * @param args - Constructor arguments.
-     * @param args.controller - The `SnapController` instance to use.
-     * @param args.snapId - The ID of the snap to use (default: `'undefined'`).
-     * @param args.origin - The sender's origin (default: `'metamask'`).
-     * @param args.handler - The handler type (default: `'onKeyringRequest'`).
-     */
-    constructor({ controller, snapId, origin, handler, }: {
-        controller: SnapController;
-        snapId?: SnapId;
-        origin?: string;
-        handler?: HandlerType;
-    });
-    /**
-     * Create a new instance of `KeyringSnapControllerClient` with the specified
-     * `snapId`.
-     *
-     * @param snapId - The ID of the snap to use in the new instance.
-     * @returns A new instance of `KeyringSnapControllerClient` with the
-     * specified snap ID.
-     */
-    withSnapId(snapId: SnapId): KeyringSnapControllerClient;
-    /**
-     * Get the `SnapController` instance used by this client.
-     *
-     * @returns The `SnapController` instance used by this client.
-     */
-    getController(): SnapController;
-}

package/dist/KeyringSnapControllerClient.js

@@ -1,104 +0,0 @@
-"use strict";
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _SnapControllerSender_snapId, _SnapControllerSender_origin, _SnapControllerSender_controller, _SnapControllerSender_handler, _KeyringSnapControllerClient_controller;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyringSnapControllerClient = void 0;
-const KeyringClient_1 = require("./KeyringClient");
-/**
- * Implementation of the `Sender` interface that can be used to send requests
- * to a snap through a `SnapController`.
- */
-class SnapControllerSender {
-    /**
-     * Create a new instance of `SnapControllerSender`.
-     *
-     * @param controller - The `SnapController` instance to send requests to.
-     * @param snapId - The ID of the snap to use.
-     * @param origin - The sender's origin.
-     * @param handler - The handler type.
-     */
-    constructor(controller, snapId, origin, handler) {
-        _SnapControllerSender_snapId.set(this, void 0);
-        _SnapControllerSender_origin.set(this, void 0);
-        _SnapControllerSender_controller.set(this, void 0);
-        _SnapControllerSender_handler.set(this, void 0);
-        __classPrivateFieldSet(this, _SnapControllerSender_controller, controller, "f");
-        __classPrivateFieldSet(this, _SnapControllerSender_snapId, snapId, "f");
-        __classPrivateFieldSet(this, _SnapControllerSender_origin, origin, "f");
-        __classPrivateFieldSet(this, _SnapControllerSender_handler, handler, "f");
-    }
-    /**
-     * Send a request to the snap and return the response.
-     *
-     * @param request - JSON-RPC request to send to the snap.
-     * @returns A promise that resolves to the response of the request.
-     */
-    async send(request) {
-        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,
-        });
-    }
-}
-_SnapControllerSender_snapId = new WeakMap(), _SnapControllerSender_origin = new WeakMap(), _SnapControllerSender_controller = new WeakMap(), _SnapControllerSender_handler = new WeakMap();
-/**
- * A `KeyringClient` that allows the communication with a snap through the
- * `SnapController`.
- */
-class KeyringSnapControllerClient extends KeyringClient_1.KeyringClient {
-    /**
-     * Create a new instance of `KeyringSnapControllerClient`.
-     *
-     * The `handlerType` argument has a hard-coded default `string` value instead
-     * of a `HandlerType` value to prevent the `@metamask/snaps-utils` module
-     * from being required at runtime.
-     *
-     * @param args - Constructor arguments.
-     * @param args.controller - The `SnapController` instance to use.
-     * @param args.snapId - The ID of the snap to use (default: `'undefined'`).
-     * @param args.origin - The sender's origin (default: `'metamask'`).
-     * @param args.handler - The handler type (default: `'onKeyringRequest'`).
-     */
-    constructor({ controller, snapId = 'undefined', origin = 'metamask', handler = 'onKeyringRequest', }) {
-        super(new SnapControllerSender(controller, snapId, origin, handler));
-        _KeyringSnapControllerClient_controller.set(this, void 0);
-        __classPrivateFieldSet(this, _KeyringSnapControllerClient_controller, controller, "f");
-    }
-    /**
-     * Create a new instance of `KeyringSnapControllerClient` with the specified
-     * `snapId`.
-     *
-     * @param snapId - The ID of the snap to use in the new instance.
-     * @returns A new instance of `KeyringSnapControllerClient` with the
-     * specified snap ID.
-     */
-    withSnapId(snapId) {
-        return new KeyringSnapControllerClient({
-            controller: __classPrivateFieldGet(this, _KeyringSnapControllerClient_controller, "f"),
-            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=KeyringSnapControllerClient.js.map

package/dist/KeyringSnapControllerClient.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"KeyringSnapControllerClient.js","sourceRoot":"","sources":["../src/KeyringSnapControllerClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAMA,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,oCAAQ;YACpB,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,WAAqB,EAC9B,MAAM,GAAG,UAAU,EACnB,OAAO,GAAG,kBAAiC,GAM5C;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 { SnapId } from '@metamask/snaps-sdk';\nimport type { HandlerType } 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: SnapId;\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: SnapId,\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,\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: `'onKeyringRequest'`).\n   */\n  constructor({\n    controller,\n    snapId = 'undefined' as SnapId,\n    origin = 'metamask',\n    handler = 'onKeyringRequest' as HandlerType,\n  }: {\n    controller: SnapController;\n    snapId?: SnapId;\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: SnapId): 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"]}