@metamask-previews/keyring-internal-snap-client 7.1.0-9fbf2ff → 7.2.0-74cd0f8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
+ ### Changed
11
+
12
+ - **BREAKING:** Migrate `KeyringInternalSnapClientMessenger` to new `Messenger` type from `@metamask/messenger` ([#383](https://github.com/MetaMask/accounts/pull/383))
13
+
14
+ ## [7.2.0]
15
+
16
+ ### Changed
17
+
18
+ - Bump `@metamask/keyring-api` from `^21.0.0` to `^21.1.0` ([#388](https://github.com/MetaMask/accounts/pull/388))
19
+ - Bump `@metamask/keyring-snap-client` from `^8.0.0` to `^8.1.0` ([#388](https://github.com/MetaMask/accounts/pull/388))
20
+ - Bump `@metamask/keyring-internal-api` from `^9.0.0` to `^9.1.0` ([#388](https://github.com/MetaMask/accounts/pull/388))
21
+
10
22
  ## [7.1.0]
11
23
 
12
24
  ### Changed
@@ -139,7 +151,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
139
151
  - This new version fixes a bug with CJS re-exports.
140
152
  - Initial release ([#24](https://github.com/MetaMask/accounts/pull/24))
141
153
 
142
- [Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-internal-snap-client@7.1.0...HEAD
154
+ [Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-internal-snap-client@7.2.0...HEAD
155
+ [7.2.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-internal-snap-client@7.1.0...@metamask/keyring-internal-snap-client@7.2.0
143
156
  [7.1.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-internal-snap-client@7.0.0...@metamask/keyring-internal-snap-client@7.1.0
144
157
  [7.0.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-internal-snap-client@6.0.0...@metamask/keyring-internal-snap-client@7.0.0
145
158
  [6.0.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-internal-snap-client@5.0.0...@metamask/keyring-internal-snap-client@6.0.0
@@ -1 +1 @@
1
- {"version":3,"file":"KeyringInternalSnapClient.cjs","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,uDAAyD;AAKzD,yEAA+E;AAC/E,uEAA2E;AAC3E,2DAA0E;AAqB1E;;;GAGG;AACH,MAAM,6BAA6B;IASjC;;;;;;;OAOG;IACH,YACE,SAA6C,EAC7C,MAAc,EACd,MAAc,EACd,OAAoB;QApBb,wDAAgB;QAEhB,wDAAgB;QAEhB,2DAA+C;QAE/C,yDAAsB;QAgB7B,uBAAA,IAAI,4CAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,yCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,yCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,0CAAY,OAAO,MAAA,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,OAAuB;QAChC,OAAO,uBAAA,IAAI,gDAAW,CAAC,IAAI,CAAC,8BAA8B,EAAE;YAC1D,MAAM,EAAE,uBAAA,IAAI,6CAAQ;YACpB,MAAM,EAAE,uBAAA,IAAI,6CAAQ;YACpB,OAAO,EAAE,uBAAA,IAAI,8CAAS;YACtB,OAAO;SACR,CAAkB,CAAC;IACtB,CAAC;CACF;;AAED;;;GAGG;AACH,MAAa,yBAA0B,SAAQ,mCAAa;IAG1D;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,SAAS,EACT,MAAM,GAAG,WAAqB,EAC9B,MAAM,GAAG,UAAU,EACnB,OAAO,GAAG,kBAAiC,GAM5C;QACC,KAAK,CACH,IAAI,6BAA6B,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CACtE,CAAC;QA5BK,uDAA+C;QA6BtD,uBAAA,IAAI,wCAAc,SAAS,MAAA,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,MAAc;QACvB,OAAO,IAAI,yBAAyB,CAAC;YACnC,SAAS,EAAE,uBAAA,IAAI,4CAAW;YAC1B,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,OAAyB;QAC7C,OAAO,IAAA,0BAAU,EACf,MAAM,IAAI,CAAC,IAAI,CAAC;YACd,MAAM,EAAE,8BAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,OAAO;SAChB,CAAC,EACF,oDAA6B,CAC9B,CAAC;IACJ,CAAC;CACF;AA/DD,8DA+DC","sourcesContent":["import type { RestrictedMessenger } from '@metamask/base-controller';\nimport { KeyringRpcMethod } from '@metamask/keyring-api';\nimport type {\n KeyringRequestV1,\n KeyringResponseV1,\n} from '@metamask/keyring-internal-api';\nimport { SubmitRequestResponseV1Struct } from '@metamask/keyring-internal-api';\nimport { KeyringClient, type Sender } from '@metamask/keyring-snap-client';\nimport { strictMask, type JsonRpcRequest } from '@metamask/keyring-utils';\nimport type { HandleSnapRequest } 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\n// We only need to dispatch Snap request to the Snaps controller for now.\ntype AllowedActions = HandleSnapRequest;\n\n/**\n * A restricted-`Messenger` used by `KeyringInternalSnapClient` to dispatch\n * internal Snap requests.\n */\nexport type KeyringInternalSnapClientMessenger = RestrictedMessenger<\n 'KeyringInternalSnapClient',\n AllowedActions,\n never,\n AllowedActions['type'],\n never\n>;\n\n/**\n * Implementation of the `Sender` interface that can be used to send requests\n * to a Snap through a `Messenger`.\n */\nclass SnapControllerMessengerSender implements Sender {\n readonly #snapId: SnapId;\n\n readonly #origin: string;\n\n readonly #messenger: KeyringInternalSnapClientMessenger;\n\n readonly #handler: HandlerType;\n\n /**\n * Create a new instance of `SnapControllerSender`.\n *\n * @param messenger - The `Messenger` instance used when dispatching controllers actions.\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 messenger: KeyringInternalSnapClientMessenger,\n snapId: SnapId,\n origin: string,\n handler: HandlerType,\n ) {\n this.#messenger = messenger;\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.#messenger.call('SnapController: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 a\n * `Messenger`.\n */\nexport class KeyringInternalSnapClient extends KeyringClient {\n readonly #messenger: KeyringInternalSnapClientMessenger;\n\n /**\n * Create a new instance of `KeyringInternalSnapClient`.\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.messenger - The `KeyringInternalSnapClientMessenger` 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 messenger,\n snapId = 'undefined' as SnapId,\n origin = 'metamask',\n handler = 'onKeyringRequest' as HandlerType,\n }: {\n messenger: KeyringInternalSnapClientMessenger;\n snapId?: SnapId;\n origin?: string;\n handler?: HandlerType;\n }) {\n super(\n new SnapControllerMessengerSender(messenger, snapId, origin, handler),\n );\n this.#messenger = messenger;\n }\n\n /**\n * Create a new instance of `KeyringInternalSnapClient` 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 `KeyringInternalSnapClient` with the\n * specified Snap ID.\n */\n withSnapId(snapId: SnapId): KeyringInternalSnapClient {\n return new KeyringInternalSnapClient({\n messenger: this.#messenger,\n snapId,\n });\n }\n\n /**\n * Submit a keyring request v1 (with no `origin`).\n *\n * @param request - Keyring request.\n * @returns Keyring request's response.\n */\n async submitRequestV1(request: KeyringRequestV1): Promise<KeyringResponseV1> {\n return strictMask(\n await this.send({\n method: KeyringRpcMethod.SubmitRequest,\n params: request,\n }),\n SubmitRequestResponseV1Struct,\n );\n }\n}\n"]}
1
+ {"version":3,"file":"KeyringInternalSnapClient.cjs","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAyD;AAKzD,yEAA+E;AAC/E,uEAA2E;AAC3E,2DAA0E;AAmB1E;;;GAGG;AACH,MAAM,6BAA6B;IASjC;;;;;;;OAOG;IACH,YACE,SAA6C,EAC7C,MAAc,EACd,MAAc,EACd,OAAoB;QApBb,wDAAgB;QAEhB,wDAAgB;QAEhB,2DAA+C;QAE/C,yDAAsB;QAgB7B,uBAAA,IAAI,4CAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,yCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,yCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,0CAAY,OAAO,MAAA,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,OAAuB;QAChC,OAAO,uBAAA,IAAI,gDAAW,CAAC,IAAI,CAAC,8BAA8B,EAAE;YAC1D,MAAM,EAAE,uBAAA,IAAI,6CAAQ;YACpB,MAAM,EAAE,uBAAA,IAAI,6CAAQ;YACpB,OAAO,EAAE,uBAAA,IAAI,8CAAS;YACtB,OAAO;SACR,CAAkB,CAAC;IACtB,CAAC;CACF;;AAED;;;GAGG;AACH,MAAa,yBAA0B,SAAQ,mCAAa;IAG1D;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,SAAS,EACT,MAAM,GAAG,WAAqB,EAC9B,MAAM,GAAG,UAAU,EACnB,OAAO,GAAG,kBAAiC,GAM5C;QACC,KAAK,CACH,IAAI,6BAA6B,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CACtE,CAAC;QA5BK,uDAA+C;QA6BtD,uBAAA,IAAI,wCAAc,SAAS,MAAA,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,MAAc;QACvB,OAAO,IAAI,yBAAyB,CAAC;YACnC,SAAS,EAAE,uBAAA,IAAI,4CAAW;YAC1B,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,OAAyB;QAC7C,OAAO,IAAA,0BAAU,EACf,MAAM,IAAI,CAAC,IAAI,CAAC;YACd,MAAM,EAAE,8BAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,OAAO;SAChB,CAAC,EACF,oDAA6B,CAC9B,CAAC;IACJ,CAAC;CACF;AA/DD,8DA+DC","sourcesContent":["import { KeyringRpcMethod } from '@metamask/keyring-api';\nimport type {\n KeyringRequestV1,\n KeyringResponseV1,\n} from '@metamask/keyring-internal-api';\nimport { SubmitRequestResponseV1Struct } from '@metamask/keyring-internal-api';\nimport { KeyringClient, type Sender } from '@metamask/keyring-snap-client';\nimport { strictMask, type JsonRpcRequest } from '@metamask/keyring-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport type { HandleSnapRequest } 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\n// We only need to dispatch Snap request to the Snaps controller for now.\ntype AllowedActions = HandleSnapRequest;\n\n/**\n * A restricted-`Messenger` used by `KeyringInternalSnapClient` to dispatch\n * internal Snap requests.\n */\nexport type KeyringInternalSnapClientMessenger = Messenger<\n 'KeyringInternalSnapClient',\n AllowedActions\n>;\n\n/**\n * Implementation of the `Sender` interface that can be used to send requests\n * to a Snap through a `Messenger`.\n */\nclass SnapControllerMessengerSender implements Sender {\n readonly #snapId: SnapId;\n\n readonly #origin: string;\n\n readonly #messenger: KeyringInternalSnapClientMessenger;\n\n readonly #handler: HandlerType;\n\n /**\n * Create a new instance of `SnapControllerSender`.\n *\n * @param messenger - The `Messenger` instance used when dispatching controllers actions.\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 messenger: KeyringInternalSnapClientMessenger,\n snapId: SnapId,\n origin: string,\n handler: HandlerType,\n ) {\n this.#messenger = messenger;\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.#messenger.call('SnapController: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 a\n * `Messenger`.\n */\nexport class KeyringInternalSnapClient extends KeyringClient {\n readonly #messenger: KeyringInternalSnapClientMessenger;\n\n /**\n * Create a new instance of `KeyringInternalSnapClient`.\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.messenger - The `KeyringInternalSnapClientMessenger` 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 messenger,\n snapId = 'undefined' as SnapId,\n origin = 'metamask',\n handler = 'onKeyringRequest' as HandlerType,\n }: {\n messenger: KeyringInternalSnapClientMessenger;\n snapId?: SnapId;\n origin?: string;\n handler?: HandlerType;\n }) {\n super(\n new SnapControllerMessengerSender(messenger, snapId, origin, handler),\n );\n this.#messenger = messenger;\n }\n\n /**\n * Create a new instance of `KeyringInternalSnapClient` 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 `KeyringInternalSnapClient` with the\n * specified Snap ID.\n */\n withSnapId(snapId: SnapId): KeyringInternalSnapClient {\n return new KeyringInternalSnapClient({\n messenger: this.#messenger,\n snapId,\n });\n }\n\n /**\n * Submit a keyring request v1 (with no `origin`).\n *\n * @param request - Keyring request.\n * @returns Keyring request's response.\n */\n async submitRequestV1(request: KeyringRequestV1): Promise<KeyringResponseV1> {\n return strictMask(\n await this.send({\n method: KeyringRpcMethod.SubmitRequest,\n params: request,\n }),\n SubmitRequestResponseV1Struct,\n );\n }\n}\n"]}
@@ -1,6 +1,6 @@
1
- import type { RestrictedMessenger } from "@metamask/base-controller";
2
1
  import type { KeyringRequestV1, KeyringResponseV1 } from "@metamask/keyring-internal-api";
3
2
  import { KeyringClient } from "@metamask/keyring-snap-client";
3
+ import type { Messenger } from "@metamask/messenger";
4
4
  import type { HandleSnapRequest } from "@metamask/snaps-controllers";
5
5
  import type { SnapId } from "@metamask/snaps-sdk";
6
6
  import type { HandlerType } from "@metamask/snaps-utils";
@@ -9,7 +9,7 @@ type AllowedActions = HandleSnapRequest;
9
9
  * A restricted-`Messenger` used by `KeyringInternalSnapClient` to dispatch
10
10
  * internal Snap requests.
11
11
  */
12
- export type KeyringInternalSnapClientMessenger = RestrictedMessenger<'KeyringInternalSnapClient', AllowedActions, never, AllowedActions['type'], never>;
12
+ export type KeyringInternalSnapClientMessenger = Messenger<'KeyringInternalSnapClient', AllowedActions>;
13
13
  /**
14
14
  * A `KeyringClient` that allows the communication with a Snap through a
15
15
  * `Messenger`.
@@ -1 +1 @@
1
- {"version":3,"file":"KeyringInternalSnapClient.d.cts","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,kCAAkC;AAErE,OAAO,KAAK,EACV,gBAAgB,EAChB,iBAAiB,EAClB,uCAAuC;AAExC,OAAO,EAAE,aAAa,EAAe,sCAAsC;AAE3E,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAoC;AACrE,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,8BAA8B;AAIzD,KAAK,cAAc,GAAG,iBAAiB,CAAC;AAExC;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAAG,mBAAmB,CAClE,2BAA2B,EAC3B,cAAc,EACd,KAAK,EACL,cAAc,CAAC,MAAM,CAAC,EACtB,KAAK,CACN,CAAC;AAmDF;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,aAAa;;IAG1D;;;;;;;;;;;;OAYG;gBACS,EACV,SAAS,EACT,MAA8B,EAC9B,MAAmB,EACnB,OAA2C,GAC5C,EAAE;QACD,SAAS,EAAE,kCAAkC,CAAC;QAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,WAAW,CAAC;KACvB;IAOD;;;;;;;OAOG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,yBAAyB;IAOrD;;;;;OAKG;IACG,eAAe,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAS7E"}
1
+ {"version":3,"file":"KeyringInternalSnapClient.d.cts","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,gBAAgB,EAChB,iBAAiB,EAClB,uCAAuC;AAExC,OAAO,EAAE,aAAa,EAAe,sCAAsC;AAE3E,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAoC;AACrE,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,8BAA8B;AAIzD,KAAK,cAAc,GAAG,iBAAiB,CAAC;AAExC;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAAG,SAAS,CACxD,2BAA2B,EAC3B,cAAc,CACf,CAAC;AAmDF;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,aAAa;;IAG1D;;;;;;;;;;;;OAYG;gBACS,EACV,SAAS,EACT,MAA8B,EAC9B,MAAmB,EACnB,OAA2C,GAC5C,EAAE;QACD,SAAS,EAAE,kCAAkC,CAAC;QAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,WAAW,CAAC;KACvB;IAOD;;;;;;;OAOG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,yBAAyB;IAOrD;;;;;OAKG;IACG,eAAe,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAS7E"}
@@ -1,6 +1,6 @@
1
- import type { RestrictedMessenger } from "@metamask/base-controller";
2
1
  import type { KeyringRequestV1, KeyringResponseV1 } from "@metamask/keyring-internal-api";
3
2
  import { KeyringClient } from "@metamask/keyring-snap-client";
3
+ import type { Messenger } from "@metamask/messenger";
4
4
  import type { HandleSnapRequest } from "@metamask/snaps-controllers";
5
5
  import type { SnapId } from "@metamask/snaps-sdk";
6
6
  import type { HandlerType } from "@metamask/snaps-utils";
@@ -9,7 +9,7 @@ type AllowedActions = HandleSnapRequest;
9
9
  * A restricted-`Messenger` used by `KeyringInternalSnapClient` to dispatch
10
10
  * internal Snap requests.
11
11
  */
12
- export type KeyringInternalSnapClientMessenger = RestrictedMessenger<'KeyringInternalSnapClient', AllowedActions, never, AllowedActions['type'], never>;
12
+ export type KeyringInternalSnapClientMessenger = Messenger<'KeyringInternalSnapClient', AllowedActions>;
13
13
  /**
14
14
  * A `KeyringClient` that allows the communication with a Snap through a
15
15
  * `Messenger`.
@@ -1 +1 @@
1
- {"version":3,"file":"KeyringInternalSnapClient.d.mts","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,kCAAkC;AAErE,OAAO,KAAK,EACV,gBAAgB,EAChB,iBAAiB,EAClB,uCAAuC;AAExC,OAAO,EAAE,aAAa,EAAe,sCAAsC;AAE3E,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAoC;AACrE,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,8BAA8B;AAIzD,KAAK,cAAc,GAAG,iBAAiB,CAAC;AAExC;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAAG,mBAAmB,CAClE,2BAA2B,EAC3B,cAAc,EACd,KAAK,EACL,cAAc,CAAC,MAAM,CAAC,EACtB,KAAK,CACN,CAAC;AAmDF;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,aAAa;;IAG1D;;;;;;;;;;;;OAYG;gBACS,EACV,SAAS,EACT,MAA8B,EAC9B,MAAmB,EACnB,OAA2C,GAC5C,EAAE;QACD,SAAS,EAAE,kCAAkC,CAAC;QAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,WAAW,CAAC;KACvB;IAOD;;;;;;;OAOG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,yBAAyB;IAOrD;;;;;OAKG;IACG,eAAe,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAS7E"}
1
+ {"version":3,"file":"KeyringInternalSnapClient.d.mts","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,gBAAgB,EAChB,iBAAiB,EAClB,uCAAuC;AAExC,OAAO,EAAE,aAAa,EAAe,sCAAsC;AAE3E,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAoC;AACrE,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,8BAA8B;AAIzD,KAAK,cAAc,GAAG,iBAAiB,CAAC;AAExC;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAAG,SAAS,CACxD,2BAA2B,EAC3B,cAAc,CACf,CAAC;AAmDF;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,aAAa;;IAG1D;;;;;;;;;;;;OAYG;gBACS,EACV,SAAS,EACT,MAA8B,EAC9B,MAAmB,EACnB,OAA2C,GAC5C,EAAE;QACD,SAAS,EAAE,kCAAkC,CAAC;QAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,WAAW,CAAC;KACvB;IAOD;;;;;;;OAOG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,yBAAyB;IAOrD;;;;;OAKG;IACG,eAAe,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAS7E"}
@@ -1 +1 @@
1
- {"version":3,"file":"KeyringInternalSnapClient.mjs","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,OAAO,EAAE,gBAAgB,EAAE,8BAA8B;AAKzD,OAAO,EAAE,6BAA6B,EAAE,uCAAuC;AAC/E,OAAO,EAAE,aAAa,EAAe,sCAAsC;AAC3E,OAAO,EAAE,UAAU,EAAuB,gCAAgC;AAqB1E;;;GAGG;AACH,MAAM,6BAA6B;IASjC;;;;;;;OAOG;IACH,YACE,SAA6C,EAC7C,MAAc,EACd,MAAc,EACd,OAAoB;QApBb,wDAAgB;QAEhB,wDAAgB;QAEhB,2DAA+C;QAE/C,yDAAsB;QAgB7B,uBAAA,IAAI,4CAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,yCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,yCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,0CAAY,OAAO,MAAA,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,OAAuB;QAChC,OAAO,uBAAA,IAAI,gDAAW,CAAC,IAAI,CAAC,8BAA8B,EAAE;YAC1D,MAAM,EAAE,uBAAA,IAAI,6CAAQ;YACpB,MAAM,EAAE,uBAAA,IAAI,6CAAQ;YACpB,OAAO,EAAE,uBAAA,IAAI,8CAAS;YACtB,OAAO;SACR,CAAkB,CAAC;IACtB,CAAC;CACF;;AAED;;;GAGG;AACH,MAAM,OAAO,yBAA0B,SAAQ,aAAa;IAG1D;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,SAAS,EACT,MAAM,GAAG,WAAqB,EAC9B,MAAM,GAAG,UAAU,EACnB,OAAO,GAAG,kBAAiC,GAM5C;QACC,KAAK,CACH,IAAI,6BAA6B,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CACtE,CAAC;QA5BK,uDAA+C;QA6BtD,uBAAA,IAAI,wCAAc,SAAS,MAAA,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,MAAc;QACvB,OAAO,IAAI,yBAAyB,CAAC;YACnC,SAAS,EAAE,uBAAA,IAAI,4CAAW;YAC1B,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,OAAyB;QAC7C,OAAO,UAAU,CACf,MAAM,IAAI,CAAC,IAAI,CAAC;YACd,MAAM,EAAE,gBAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,OAAO;SAChB,CAAC,EACF,6BAA6B,CAC9B,CAAC;IACJ,CAAC;CACF","sourcesContent":["import type { RestrictedMessenger } from '@metamask/base-controller';\nimport { KeyringRpcMethod } from '@metamask/keyring-api';\nimport type {\n KeyringRequestV1,\n KeyringResponseV1,\n} from '@metamask/keyring-internal-api';\nimport { SubmitRequestResponseV1Struct } from '@metamask/keyring-internal-api';\nimport { KeyringClient, type Sender } from '@metamask/keyring-snap-client';\nimport { strictMask, type JsonRpcRequest } from '@metamask/keyring-utils';\nimport type { HandleSnapRequest } 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\n// We only need to dispatch Snap request to the Snaps controller for now.\ntype AllowedActions = HandleSnapRequest;\n\n/**\n * A restricted-`Messenger` used by `KeyringInternalSnapClient` to dispatch\n * internal Snap requests.\n */\nexport type KeyringInternalSnapClientMessenger = RestrictedMessenger<\n 'KeyringInternalSnapClient',\n AllowedActions,\n never,\n AllowedActions['type'],\n never\n>;\n\n/**\n * Implementation of the `Sender` interface that can be used to send requests\n * to a Snap through a `Messenger`.\n */\nclass SnapControllerMessengerSender implements Sender {\n readonly #snapId: SnapId;\n\n readonly #origin: string;\n\n readonly #messenger: KeyringInternalSnapClientMessenger;\n\n readonly #handler: HandlerType;\n\n /**\n * Create a new instance of `SnapControllerSender`.\n *\n * @param messenger - The `Messenger` instance used when dispatching controllers actions.\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 messenger: KeyringInternalSnapClientMessenger,\n snapId: SnapId,\n origin: string,\n handler: HandlerType,\n ) {\n this.#messenger = messenger;\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.#messenger.call('SnapController: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 a\n * `Messenger`.\n */\nexport class KeyringInternalSnapClient extends KeyringClient {\n readonly #messenger: KeyringInternalSnapClientMessenger;\n\n /**\n * Create a new instance of `KeyringInternalSnapClient`.\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.messenger - The `KeyringInternalSnapClientMessenger` 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 messenger,\n snapId = 'undefined' as SnapId,\n origin = 'metamask',\n handler = 'onKeyringRequest' as HandlerType,\n }: {\n messenger: KeyringInternalSnapClientMessenger;\n snapId?: SnapId;\n origin?: string;\n handler?: HandlerType;\n }) {\n super(\n new SnapControllerMessengerSender(messenger, snapId, origin, handler),\n );\n this.#messenger = messenger;\n }\n\n /**\n * Create a new instance of `KeyringInternalSnapClient` 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 `KeyringInternalSnapClient` with the\n * specified Snap ID.\n */\n withSnapId(snapId: SnapId): KeyringInternalSnapClient {\n return new KeyringInternalSnapClient({\n messenger: this.#messenger,\n snapId,\n });\n }\n\n /**\n * Submit a keyring request v1 (with no `origin`).\n *\n * @param request - Keyring request.\n * @returns Keyring request's response.\n */\n async submitRequestV1(request: KeyringRequestV1): Promise<KeyringResponseV1> {\n return strictMask(\n await this.send({\n method: KeyringRpcMethod.SubmitRequest,\n params: request,\n }),\n SubmitRequestResponseV1Struct,\n );\n }\n}\n"]}
1
+ {"version":3,"file":"KeyringInternalSnapClient.mjs","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,gBAAgB,EAAE,8BAA8B;AAKzD,OAAO,EAAE,6BAA6B,EAAE,uCAAuC;AAC/E,OAAO,EAAE,aAAa,EAAe,sCAAsC;AAC3E,OAAO,EAAE,UAAU,EAAuB,gCAAgC;AAmB1E;;;GAGG;AACH,MAAM,6BAA6B;IASjC;;;;;;;OAOG;IACH,YACE,SAA6C,EAC7C,MAAc,EACd,MAAc,EACd,OAAoB;QApBb,wDAAgB;QAEhB,wDAAgB;QAEhB,2DAA+C;QAE/C,yDAAsB;QAgB7B,uBAAA,IAAI,4CAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,yCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,yCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,0CAAY,OAAO,MAAA,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,OAAuB;QAChC,OAAO,uBAAA,IAAI,gDAAW,CAAC,IAAI,CAAC,8BAA8B,EAAE;YAC1D,MAAM,EAAE,uBAAA,IAAI,6CAAQ;YACpB,MAAM,EAAE,uBAAA,IAAI,6CAAQ;YACpB,OAAO,EAAE,uBAAA,IAAI,8CAAS;YACtB,OAAO;SACR,CAAkB,CAAC;IACtB,CAAC;CACF;;AAED;;;GAGG;AACH,MAAM,OAAO,yBAA0B,SAAQ,aAAa;IAG1D;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,SAAS,EACT,MAAM,GAAG,WAAqB,EAC9B,MAAM,GAAG,UAAU,EACnB,OAAO,GAAG,kBAAiC,GAM5C;QACC,KAAK,CACH,IAAI,6BAA6B,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CACtE,CAAC;QA5BK,uDAA+C;QA6BtD,uBAAA,IAAI,wCAAc,SAAS,MAAA,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,MAAc;QACvB,OAAO,IAAI,yBAAyB,CAAC;YACnC,SAAS,EAAE,uBAAA,IAAI,4CAAW;YAC1B,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,OAAyB;QAC7C,OAAO,UAAU,CACf,MAAM,IAAI,CAAC,IAAI,CAAC;YACd,MAAM,EAAE,gBAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,OAAO;SAChB,CAAC,EACF,6BAA6B,CAC9B,CAAC;IACJ,CAAC;CACF","sourcesContent":["import { KeyringRpcMethod } from '@metamask/keyring-api';\nimport type {\n KeyringRequestV1,\n KeyringResponseV1,\n} from '@metamask/keyring-internal-api';\nimport { SubmitRequestResponseV1Struct } from '@metamask/keyring-internal-api';\nimport { KeyringClient, type Sender } from '@metamask/keyring-snap-client';\nimport { strictMask, type JsonRpcRequest } from '@metamask/keyring-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport type { HandleSnapRequest } 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\n// We only need to dispatch Snap request to the Snaps controller for now.\ntype AllowedActions = HandleSnapRequest;\n\n/**\n * A restricted-`Messenger` used by `KeyringInternalSnapClient` to dispatch\n * internal Snap requests.\n */\nexport type KeyringInternalSnapClientMessenger = Messenger<\n 'KeyringInternalSnapClient',\n AllowedActions\n>;\n\n/**\n * Implementation of the `Sender` interface that can be used to send requests\n * to a Snap through a `Messenger`.\n */\nclass SnapControllerMessengerSender implements Sender {\n readonly #snapId: SnapId;\n\n readonly #origin: string;\n\n readonly #messenger: KeyringInternalSnapClientMessenger;\n\n readonly #handler: HandlerType;\n\n /**\n * Create a new instance of `SnapControllerSender`.\n *\n * @param messenger - The `Messenger` instance used when dispatching controllers actions.\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 messenger: KeyringInternalSnapClientMessenger,\n snapId: SnapId,\n origin: string,\n handler: HandlerType,\n ) {\n this.#messenger = messenger;\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.#messenger.call('SnapController: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 a\n * `Messenger`.\n */\nexport class KeyringInternalSnapClient extends KeyringClient {\n readonly #messenger: KeyringInternalSnapClientMessenger;\n\n /**\n * Create a new instance of `KeyringInternalSnapClient`.\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.messenger - The `KeyringInternalSnapClientMessenger` 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 messenger,\n snapId = 'undefined' as SnapId,\n origin = 'metamask',\n handler = 'onKeyringRequest' as HandlerType,\n }: {\n messenger: KeyringInternalSnapClientMessenger;\n snapId?: SnapId;\n origin?: string;\n handler?: HandlerType;\n }) {\n super(\n new SnapControllerMessengerSender(messenger, snapId, origin, handler),\n );\n this.#messenger = messenger;\n }\n\n /**\n * Create a new instance of `KeyringInternalSnapClient` 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 `KeyringInternalSnapClient` with the\n * specified Snap ID.\n */\n withSnapId(snapId: SnapId): KeyringInternalSnapClient {\n return new KeyringInternalSnapClient({\n messenger: this.#messenger,\n snapId,\n });\n }\n\n /**\n * Submit a keyring request v1 (with no `origin`).\n *\n * @param request - Keyring request.\n * @returns Keyring request's response.\n */\n async submitRequestV1(request: KeyringRequestV1): Promise<KeyringResponseV1> {\n return strictMask(\n await this.send({\n method: KeyringRpcMethod.SubmitRequest,\n params: request,\n }),\n SubmitRequestResponseV1Struct,\n );\n }\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@metamask-previews/keyring-internal-snap-client",
3
- "version": "7.1.0-9fbf2ff",
3
+ "version": "7.2.0-74cd0f8",
4
4
  "description": "MetaMask Keyring Snap internal clients",
5
5
  "keywords": [
6
6
  "metamask",
@@ -45,11 +45,11 @@
45
45
  "test:watch": "jest --watch"
46
46
  },
47
47
  "dependencies": {
48
- "@metamask/base-controller": "^8.3.0",
49
- "@metamask/keyring-api": "21.0.0",
50
- "@metamask/keyring-internal-api": "9.0.0",
51
- "@metamask/keyring-snap-client": "8.0.0",
52
- "@metamask/keyring-utils": "3.1.0"
48
+ "@metamask/keyring-api": "21.1.0",
49
+ "@metamask/keyring-internal-api": "9.1.0",
50
+ "@metamask/keyring-snap-client": "8.1.0",
51
+ "@metamask/keyring-utils": "3.1.0",
52
+ "@metamask/messenger": "^0.3.0"
53
53
  },
54
54
  "devDependencies": {
55
55
  "@lavamoat/allow-scripts": "^3.2.1",