@metamask-previews/keyring-internal-snap-client 9.0.1-d23a1b9 → 10.0.1-7275dbc
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 +27 -1
- package/LICENSE +21 -0
- package/dist/KeyringInternalSnapClient.cjs +2 -1
- package/dist/KeyringInternalSnapClient.cjs.map +1 -1
- package/dist/KeyringInternalSnapClient.d.cts +26 -1
- package/dist/KeyringInternalSnapClient.d.cts.map +1 -1
- package/dist/KeyringInternalSnapClient.d.mts +26 -1
- package/dist/KeyringInternalSnapClient.d.mts.map +1 -1
- package/dist/KeyringInternalSnapClient.mjs +1 -1
- package/dist/KeyringInternalSnapClient.mjs.map +1 -1
- package/dist/v2/KeyringInternalSnapClient.cjs +58 -0
- package/dist/v2/KeyringInternalSnapClient.cjs.map +1 -0
- package/dist/v2/KeyringInternalSnapClient.d.cts +40 -0
- package/dist/v2/KeyringInternalSnapClient.d.cts.map +1 -0
- package/dist/v2/KeyringInternalSnapClient.d.mts +40 -0
- package/dist/v2/KeyringInternalSnapClient.d.mts.map +1 -0
- package/dist/v2/KeyringInternalSnapClient.mjs +54 -0
- package/dist/v2/KeyringInternalSnapClient.mjs.map +1 -0
- package/dist/v2/index.cjs +18 -0
- package/dist/v2/index.cjs.map +1 -0
- package/dist/v2/index.d.cts +2 -0
- package/dist/v2/index.d.cts.map +1 -0
- package/dist/v2/index.d.mts +2 -0
- package/dist/v2/index.d.mts.map +1 -0
- package/dist/v2/index.mjs +2 -0
- package/dist/v2/index.mjs.map +1 -0
- package/package.json +45 -28
- package/v2.js +3 -0
package/CHANGELOG.md
CHANGED
|
@@ -7,9 +7,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [10.0.1]
|
|
11
|
+
|
|
12
|
+
### Changed
|
|
13
|
+
|
|
14
|
+
- Bump `@metamask/keyring-api` from `^23.0.0` to `^23.0.1` ([#518](https://github.com/MetaMask/accounts/pull/518))
|
|
15
|
+
- Bump `@metamask/keyring-internal-api` from `^10.1.0` to `^10.1.1` ([#518](https://github.com/MetaMask/accounts/pull/518))
|
|
16
|
+
- Bump `@metamask/keyring-snap-client` from `^9.0.0` to `^9.0.1` ([#518](https://github.com/MetaMask/accounts/pull/518))
|
|
17
|
+
|
|
18
|
+
### Fixed
|
|
19
|
+
|
|
20
|
+
- Workaround Browserify subpath export for `/v2` ([#516](https://github.com/MetaMask/accounts/pull/516))
|
|
21
|
+
|
|
22
|
+
## [10.0.0]
|
|
23
|
+
|
|
24
|
+
### Added
|
|
25
|
+
|
|
26
|
+
- Add `KeyringInternalSnapClientV2` class for communicating with a Snap using the keyring v2 RPC protocol ([#408](https://github.com/MetaMask/accounts/pull/408))
|
|
27
|
+
|
|
10
28
|
### Changed
|
|
11
29
|
|
|
30
|
+
- **BREAKING:** Move and rename `KeyringInternalSnapClientV2` to the new `./v2` subpath export ([#513](https://github.com/MetaMask/accounts/pull/513))
|
|
31
|
+
- `KeyringInternalSnapClientV2` is now `KeyringInternalSnapClient` from `@metamask/keyring-internal-snap-client/v2`.
|
|
12
32
|
- Bump `@metamask/messenger` from `^0.3.0` to `^1.1.1` ([#489](https://github.com/MetaMask/accounts/pull/489), [#500](https://github.com/MetaMask/accounts/pull/500))
|
|
33
|
+
- Bump `@metamask/utils` from `^11.1.0` to `^11.11.0` ([#489](https://github.com/MetaMask/accounts/pull/489), [#483](https://github.com/MetaMask/accounts/pull/483))
|
|
34
|
+
- Bump `@metamask/keyring-api` from `^22.0.0` to `^23.0.0` ([#515](https://github.com/MetaMask/accounts/pull/515))
|
|
35
|
+
- Bump `@metamask/keyring-internal-api` from `^10.0.1` to `^10.1.0` ([#515](https://github.com/MetaMask/accounts/pull/515))
|
|
36
|
+
- Bump `@metamask/keyring-snap-client` from `^8.2.1` to `^9.0.0` ([#515](https://github.com/MetaMask/accounts/pull/515))
|
|
13
37
|
|
|
14
38
|
## [9.0.1]
|
|
15
39
|
|
|
@@ -190,7 +214,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
190
214
|
- This new version fixes a bug with CJS re-exports.
|
|
191
215
|
- Initial release ([#24](https://github.com/MetaMask/accounts/pull/24))
|
|
192
216
|
|
|
193
|
-
[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-internal-snap-client@
|
|
217
|
+
[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-internal-snap-client@10.0.1...HEAD
|
|
218
|
+
[10.0.1]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-internal-snap-client@10.0.0...@metamask/keyring-internal-snap-client@10.0.1
|
|
219
|
+
[10.0.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-internal-snap-client@9.0.1...@metamask/keyring-internal-snap-client@10.0.0
|
|
194
220
|
[9.0.1]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-internal-snap-client@9.0.0...@metamask/keyring-internal-snap-client@9.0.1
|
|
195
221
|
[9.0.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-internal-snap-client@8.0.1...@metamask/keyring-internal-snap-client@9.0.0
|
|
196
222
|
[8.0.1]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-internal-snap-client@8.0.0...@metamask/keyring-internal-snap-client@8.0.1
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 MetaMask
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -12,7 +12,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
|
|
|
12
12
|
};
|
|
13
13
|
var _SnapControllerMessengerSender_snapId, _SnapControllerMessengerSender_origin, _SnapControllerMessengerSender_messenger, _SnapControllerMessengerSender_handler, _KeyringInternalSnapClient_messenger;
|
|
14
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
-
exports.KeyringInternalSnapClient = void 0;
|
|
15
|
+
exports.KeyringInternalSnapClient = exports.SnapControllerMessengerSender = void 0;
|
|
16
16
|
const keyring_api_1 = require("@metamask/keyring-api");
|
|
17
17
|
const keyring_internal_api_1 = require("@metamask/keyring-internal-api");
|
|
18
18
|
const keyring_snap_client_1 = require("@metamask/keyring-snap-client");
|
|
@@ -55,6 +55,7 @@ class SnapControllerMessengerSender {
|
|
|
55
55
|
});
|
|
56
56
|
}
|
|
57
57
|
}
|
|
58
|
+
exports.SnapControllerMessengerSender = SnapControllerMessengerSender;
|
|
58
59
|
_SnapControllerMessengerSender_snapId = new WeakMap(), _SnapControllerMessengerSender_origin = new WeakMap(), _SnapControllerMessengerSender_messenger = new WeakMap(), _SnapControllerMessengerSender_handler = new WeakMap();
|
|
59
60
|
/**
|
|
60
61
|
* A `KeyringClient` that allows the communication with a Snap through a
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"KeyringInternalSnapClient.cjs","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAyD;AAKzD,yEAA+E;
|
|
1
|
+
{"version":3,"file":"KeyringInternalSnapClient.cjs","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAyD;AAKzD,yEAA+E;AAE/E,uEAA8D;AAC9D,2DAAqD;AAmBrD;;;GAGG;AACH,MAAa,6BAA6B;IASxC;;;;;;;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;AA3CD,sEA2CC;;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,0BAA0B,CAC9B,OAAoC;QAEpC,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;AAjED,8DAiEC","sourcesContent":["import { KeyringRpcMethod } from '@metamask/keyring-api';\nimport type {\n KeyringRequestWithoutOrigin,\n KeyringResponseWithoutOrigin,\n} from '@metamask/keyring-internal-api';\nimport { SubmitRequestResponseV1Struct } from '@metamask/keyring-internal-api';\nimport type { Sender } from '@metamask/keyring-snap-client';\nimport { KeyringClient } from '@metamask/keyring-snap-client';\nimport { strictMask } from '@metamask/keyring-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport type { SnapControllerHandleRequestAction } from '@metamask/snaps-controllers';\nimport type { JsonRpcRequest, 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 = SnapControllerHandleRequestAction;\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 */\nexport class 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 submitRequestWithoutOrigin(\n request: KeyringRequestWithoutOrigin,\n ): Promise<KeyringResponseWithoutOrigin> {\n return strictMask(\n await this.send({\n method: KeyringRpcMethod.SubmitRequest,\n params: request,\n }),\n SubmitRequestResponseV1Struct,\n );\n }\n}\n"]}
|
|
@@ -1,15 +1,40 @@
|
|
|
1
1
|
import type { KeyringRequestWithoutOrigin, KeyringResponseWithoutOrigin } from "@metamask/keyring-internal-api";
|
|
2
|
+
import type { Sender } from "@metamask/keyring-snap-client";
|
|
2
3
|
import { KeyringClient } from "@metamask/keyring-snap-client";
|
|
3
4
|
import type { Messenger } from "@metamask/messenger";
|
|
4
5
|
import type { SnapControllerHandleRequestAction } from "@metamask/snaps-controllers";
|
|
5
|
-
import type { SnapId } from "@metamask/snaps-sdk";
|
|
6
|
+
import type { JsonRpcRequest, SnapId } from "@metamask/snaps-sdk";
|
|
6
7
|
import type { HandlerType } from "@metamask/snaps-utils";
|
|
8
|
+
import type { Json } from "@metamask/utils";
|
|
7
9
|
type AllowedActions = SnapControllerHandleRequestAction;
|
|
8
10
|
/**
|
|
9
11
|
* A restricted-`Messenger` used by `KeyringInternalSnapClient` to dispatch
|
|
10
12
|
* internal Snap requests.
|
|
11
13
|
*/
|
|
12
14
|
export type KeyringInternalSnapClientMessenger = Messenger<'KeyringInternalSnapClient', AllowedActions>;
|
|
15
|
+
/**
|
|
16
|
+
* Implementation of the `Sender` interface that can be used to send requests
|
|
17
|
+
* to a Snap through a `Messenger`.
|
|
18
|
+
*/
|
|
19
|
+
export declare class SnapControllerMessengerSender implements Sender {
|
|
20
|
+
#private;
|
|
21
|
+
/**
|
|
22
|
+
* Create a new instance of `SnapControllerSender`.
|
|
23
|
+
*
|
|
24
|
+
* @param messenger - The `Messenger` instance used when dispatching controllers actions.
|
|
25
|
+
* @param snapId - The ID of the Snap to use.
|
|
26
|
+
* @param origin - The sender's origin.
|
|
27
|
+
* @param handler - The handler type.
|
|
28
|
+
*/
|
|
29
|
+
constructor(messenger: KeyringInternalSnapClientMessenger, snapId: SnapId, origin: string, handler: HandlerType);
|
|
30
|
+
/**
|
|
31
|
+
* Send a request to the Snap and return the response.
|
|
32
|
+
*
|
|
33
|
+
* @param request - JSON-RPC request to send to the Snap.
|
|
34
|
+
* @returns A promise that resolves to the response of the request.
|
|
35
|
+
*/
|
|
36
|
+
send(request: JsonRpcRequest): Promise<Json>;
|
|
37
|
+
}
|
|
13
38
|
/**
|
|
14
39
|
* A `KeyringClient` that allows the communication with a Snap through a
|
|
15
40
|
* `Messenger`.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"KeyringInternalSnapClient.d.cts","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,2BAA2B,EAC3B,4BAA4B,EAC7B,uCAAuC;AAExC,OAAO,EAAE,aAAa,
|
|
1
|
+
{"version":3,"file":"KeyringInternalSnapClient.d.cts","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,2BAA2B,EAC3B,4BAA4B,EAC7B,uCAAuC;AAExC,OAAO,KAAK,EAAE,MAAM,EAAE,sCAAsC;AAC5D,OAAO,EAAE,aAAa,EAAE,sCAAsC;AAE9D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,iCAAiC,EAAE,oCAAoC;AACrF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,4BAA4B;AAClE,OAAO,KAAK,EAAE,WAAW,EAAE,8BAA8B;AACzD,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAG5C,KAAK,cAAc,GAAG,iCAAiC,CAAC;AAExD;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAAG,SAAS,CACxD,2BAA2B,EAC3B,cAAc,CACf,CAAC;AAEF;;;GAGG;AACH,qBAAa,6BAA8B,YAAW,MAAM;;IAS1D;;;;;;;OAOG;gBAED,SAAS,EAAE,kCAAkC,EAC7C,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,WAAW;IAQtB;;;;;OAKG;IACG,IAAI,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAQnD;AAED;;;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,0BAA0B,CAC9B,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;CASzC"}
|
|
@@ -1,15 +1,40 @@
|
|
|
1
1
|
import type { KeyringRequestWithoutOrigin, KeyringResponseWithoutOrigin } from "@metamask/keyring-internal-api";
|
|
2
|
+
import type { Sender } from "@metamask/keyring-snap-client";
|
|
2
3
|
import { KeyringClient } from "@metamask/keyring-snap-client";
|
|
3
4
|
import type { Messenger } from "@metamask/messenger";
|
|
4
5
|
import type { SnapControllerHandleRequestAction } from "@metamask/snaps-controllers";
|
|
5
|
-
import type { SnapId } from "@metamask/snaps-sdk";
|
|
6
|
+
import type { JsonRpcRequest, SnapId } from "@metamask/snaps-sdk";
|
|
6
7
|
import type { HandlerType } from "@metamask/snaps-utils";
|
|
8
|
+
import type { Json } from "@metamask/utils";
|
|
7
9
|
type AllowedActions = SnapControllerHandleRequestAction;
|
|
8
10
|
/**
|
|
9
11
|
* A restricted-`Messenger` used by `KeyringInternalSnapClient` to dispatch
|
|
10
12
|
* internal Snap requests.
|
|
11
13
|
*/
|
|
12
14
|
export type KeyringInternalSnapClientMessenger = Messenger<'KeyringInternalSnapClient', AllowedActions>;
|
|
15
|
+
/**
|
|
16
|
+
* Implementation of the `Sender` interface that can be used to send requests
|
|
17
|
+
* to a Snap through a `Messenger`.
|
|
18
|
+
*/
|
|
19
|
+
export declare class SnapControllerMessengerSender implements Sender {
|
|
20
|
+
#private;
|
|
21
|
+
/**
|
|
22
|
+
* Create a new instance of `SnapControllerSender`.
|
|
23
|
+
*
|
|
24
|
+
* @param messenger - The `Messenger` instance used when dispatching controllers actions.
|
|
25
|
+
* @param snapId - The ID of the Snap to use.
|
|
26
|
+
* @param origin - The sender's origin.
|
|
27
|
+
* @param handler - The handler type.
|
|
28
|
+
*/
|
|
29
|
+
constructor(messenger: KeyringInternalSnapClientMessenger, snapId: SnapId, origin: string, handler: HandlerType);
|
|
30
|
+
/**
|
|
31
|
+
* Send a request to the Snap and return the response.
|
|
32
|
+
*
|
|
33
|
+
* @param request - JSON-RPC request to send to the Snap.
|
|
34
|
+
* @returns A promise that resolves to the response of the request.
|
|
35
|
+
*/
|
|
36
|
+
send(request: JsonRpcRequest): Promise<Json>;
|
|
37
|
+
}
|
|
13
38
|
/**
|
|
14
39
|
* A `KeyringClient` that allows the communication with a Snap through a
|
|
15
40
|
* `Messenger`.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"KeyringInternalSnapClient.d.mts","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,2BAA2B,EAC3B,4BAA4B,EAC7B,uCAAuC;AAExC,OAAO,EAAE,aAAa,
|
|
1
|
+
{"version":3,"file":"KeyringInternalSnapClient.d.mts","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,2BAA2B,EAC3B,4BAA4B,EAC7B,uCAAuC;AAExC,OAAO,KAAK,EAAE,MAAM,EAAE,sCAAsC;AAC5D,OAAO,EAAE,aAAa,EAAE,sCAAsC;AAE9D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,iCAAiC,EAAE,oCAAoC;AACrF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,4BAA4B;AAClE,OAAO,KAAK,EAAE,WAAW,EAAE,8BAA8B;AACzD,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAG5C,KAAK,cAAc,GAAG,iCAAiC,CAAC;AAExD;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAAG,SAAS,CACxD,2BAA2B,EAC3B,cAAc,CACf,CAAC;AAEF;;;GAGG;AACH,qBAAa,6BAA8B,YAAW,MAAM;;IAS1D;;;;;;;OAOG;gBAED,SAAS,EAAE,kCAAkC,EAC7C,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,WAAW;IAQtB;;;;;OAKG;IACG,IAAI,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAQnD;AAED;;;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,0BAA0B,CAC9B,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;CASzC"}
|
|
@@ -18,7 +18,7 @@ import { strictMask } from "@metamask/keyring-utils";
|
|
|
18
18
|
* Implementation of the `Sender` interface that can be used to send requests
|
|
19
19
|
* to a Snap through a `Messenger`.
|
|
20
20
|
*/
|
|
21
|
-
class SnapControllerMessengerSender {
|
|
21
|
+
export class SnapControllerMessengerSender {
|
|
22
22
|
/**
|
|
23
23
|
* Create a new instance of `SnapControllerSender`.
|
|
24
24
|
*
|
|
@@ -1 +1 @@
|
|
|
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;
|
|
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;AAE/E,OAAO,EAAE,aAAa,EAAE,sCAAsC;AAC9D,OAAO,EAAE,UAAU,EAAE,gCAAgC;AAmBrD;;;GAGG;AACH,MAAM,OAAO,6BAA6B;IASxC;;;;;;;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,0BAA0B,CAC9B,OAAoC;QAEpC,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 KeyringRequestWithoutOrigin,\n KeyringResponseWithoutOrigin,\n} from '@metamask/keyring-internal-api';\nimport { SubmitRequestResponseV1Struct } from '@metamask/keyring-internal-api';\nimport type { Sender } from '@metamask/keyring-snap-client';\nimport { KeyringClient } from '@metamask/keyring-snap-client';\nimport { strictMask } from '@metamask/keyring-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport type { SnapControllerHandleRequestAction } from '@metamask/snaps-controllers';\nimport type { JsonRpcRequest, 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 = SnapControllerHandleRequestAction;\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 */\nexport class 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 submitRequestWithoutOrigin(\n request: KeyringRequestWithoutOrigin,\n ): Promise<KeyringResponseWithoutOrigin> {\n return strictMask(\n await this.send({\n method: KeyringRpcMethod.SubmitRequest,\n params: request,\n }),\n SubmitRequestResponseV1Struct,\n );\n }\n}\n"]}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
|
|
3
|
+
if (kind === "m") throw new TypeError("Private method is not writable");
|
|
4
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
|
|
5
|
+
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");
|
|
6
|
+
return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
|
|
7
|
+
};
|
|
8
|
+
var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
|
|
9
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
|
|
10
|
+
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");
|
|
11
|
+
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
12
|
+
};
|
|
13
|
+
var _KeyringInternalSnapClient_messenger;
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.KeyringInternalSnapClient = void 0;
|
|
16
|
+
const v2_1 = require("@metamask/keyring-snap-client/v2");
|
|
17
|
+
const KeyringInternalSnapClient_1 = require("../KeyringInternalSnapClient.cjs");
|
|
18
|
+
/**
|
|
19
|
+
* A `KeyringClient` that allows the communication with a Snap through a
|
|
20
|
+
* `Messenger`.
|
|
21
|
+
*/
|
|
22
|
+
class KeyringInternalSnapClient extends v2_1.KeyringClient {
|
|
23
|
+
/**
|
|
24
|
+
* Create a new instance of `KeyringInternalSnapClient`.
|
|
25
|
+
*
|
|
26
|
+
* The `handlerType` argument has a hard-coded default `string` value instead
|
|
27
|
+
* of a `HandlerType` value to prevent the `@metamask/snaps-utils` module
|
|
28
|
+
* from being required at runtime.
|
|
29
|
+
*
|
|
30
|
+
* @param args - Constructor arguments.
|
|
31
|
+
* @param args.messenger - The `KeyringInternalSnapClientMessenger` instance to use.
|
|
32
|
+
* @param args.snapId - The ID of the Snap to use (default: `'undefined'`).
|
|
33
|
+
* @param args.origin - The sender's origin (default: `'metamask'`).
|
|
34
|
+
* @param args.handler - The handler type (default: `'onKeyringRequest'`).
|
|
35
|
+
*/
|
|
36
|
+
constructor({ messenger, snapId = 'undefined', origin = 'metamask', handler = 'onKeyringRequest', }) {
|
|
37
|
+
super(new KeyringInternalSnapClient_1.SnapControllerMessengerSender(messenger, snapId, origin, handler));
|
|
38
|
+
_KeyringInternalSnapClient_messenger.set(this, void 0);
|
|
39
|
+
__classPrivateFieldSet(this, _KeyringInternalSnapClient_messenger, messenger, "f");
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Create a new instance of `KeyringInternalSnapClient` with the specified
|
|
43
|
+
* `snapId`.
|
|
44
|
+
*
|
|
45
|
+
* @param snapId - The ID of the Snap to use in the new instance.
|
|
46
|
+
* @returns A new instance of `KeyringInternalSnapClient` with the
|
|
47
|
+
* specified Snap ID.
|
|
48
|
+
*/
|
|
49
|
+
withSnapId(snapId) {
|
|
50
|
+
return new KeyringInternalSnapClient({
|
|
51
|
+
messenger: __classPrivateFieldGet(this, _KeyringInternalSnapClient_messenger, "f"),
|
|
52
|
+
snapId,
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
exports.KeyringInternalSnapClient = KeyringInternalSnapClient;
|
|
57
|
+
_KeyringInternalSnapClient_messenger = new WeakMap();
|
|
58
|
+
//# sourceMappingURL=KeyringInternalSnapClient.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"KeyringInternalSnapClient.cjs","sourceRoot":"","sources":["../../src/v2/KeyringInternalSnapClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,yDAAiE;AAKjE,gFAA6E;AAE7E;;;GAGG;AACH,MAAa,yBAA0B,SAAQ,kBAAa;IAG1D;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,SAAS,EACT,MAAM,GAAG,WAAqB,EAC9B,MAAM,GAAG,UAAU,EACnB,OAAO,GAAG,kBAAiC,GAM5C;QACC,KAAK,CACH,IAAI,yDAA6B,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;CACF;AA/CD,8DA+CC","sourcesContent":["import { KeyringClient } from '@metamask/keyring-snap-client/v2';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport type { HandlerType } from '@metamask/snaps-utils';\n\nimport type { KeyringInternalSnapClientMessenger } from '../KeyringInternalSnapClient';\nimport { SnapControllerMessengerSender } from '../KeyringInternalSnapClient';\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"]}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { KeyringClient } from "@metamask/keyring-snap-client/v2";
|
|
2
|
+
import type { SnapId } from "@metamask/snaps-sdk";
|
|
3
|
+
import type { HandlerType } from "@metamask/snaps-utils";
|
|
4
|
+
import type { KeyringInternalSnapClientMessenger } from "../KeyringInternalSnapClient.cjs";
|
|
5
|
+
/**
|
|
6
|
+
* A `KeyringClient` that allows the communication with a Snap through a
|
|
7
|
+
* `Messenger`.
|
|
8
|
+
*/
|
|
9
|
+
export declare class KeyringInternalSnapClient extends KeyringClient {
|
|
10
|
+
#private;
|
|
11
|
+
/**
|
|
12
|
+
* Create a new instance of `KeyringInternalSnapClient`.
|
|
13
|
+
*
|
|
14
|
+
* The `handlerType` argument has a hard-coded default `string` value instead
|
|
15
|
+
* of a `HandlerType` value to prevent the `@metamask/snaps-utils` module
|
|
16
|
+
* from being required at runtime.
|
|
17
|
+
*
|
|
18
|
+
* @param args - Constructor arguments.
|
|
19
|
+
* @param args.messenger - The `KeyringInternalSnapClientMessenger` instance to use.
|
|
20
|
+
* @param args.snapId - The ID of the Snap to use (default: `'undefined'`).
|
|
21
|
+
* @param args.origin - The sender's origin (default: `'metamask'`).
|
|
22
|
+
* @param args.handler - The handler type (default: `'onKeyringRequest'`).
|
|
23
|
+
*/
|
|
24
|
+
constructor({ messenger, snapId, origin, handler, }: {
|
|
25
|
+
messenger: KeyringInternalSnapClientMessenger;
|
|
26
|
+
snapId?: SnapId;
|
|
27
|
+
origin?: string;
|
|
28
|
+
handler?: HandlerType;
|
|
29
|
+
});
|
|
30
|
+
/**
|
|
31
|
+
* Create a new instance of `KeyringInternalSnapClient` with the specified
|
|
32
|
+
* `snapId`.
|
|
33
|
+
*
|
|
34
|
+
* @param snapId - The ID of the Snap to use in the new instance.
|
|
35
|
+
* @returns A new instance of `KeyringInternalSnapClient` with the
|
|
36
|
+
* specified Snap ID.
|
|
37
|
+
*/
|
|
38
|
+
withSnapId(snapId: SnapId): KeyringInternalSnapClient;
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=KeyringInternalSnapClient.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"KeyringInternalSnapClient.d.cts","sourceRoot":"","sources":["../../src/v2/KeyringInternalSnapClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,yCAAyC;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,8BAA8B;AAEzD,OAAO,KAAK,EAAE,kCAAkC,EAAE,yCAAqC;AAGvF;;;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;CAMtD"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { KeyringClient } from "@metamask/keyring-snap-client/v2";
|
|
2
|
+
import type { SnapId } from "@metamask/snaps-sdk";
|
|
3
|
+
import type { HandlerType } from "@metamask/snaps-utils";
|
|
4
|
+
import type { KeyringInternalSnapClientMessenger } from "../KeyringInternalSnapClient.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* A `KeyringClient` that allows the communication with a Snap through a
|
|
7
|
+
* `Messenger`.
|
|
8
|
+
*/
|
|
9
|
+
export declare class KeyringInternalSnapClient extends KeyringClient {
|
|
10
|
+
#private;
|
|
11
|
+
/**
|
|
12
|
+
* Create a new instance of `KeyringInternalSnapClient`.
|
|
13
|
+
*
|
|
14
|
+
* The `handlerType` argument has a hard-coded default `string` value instead
|
|
15
|
+
* of a `HandlerType` value to prevent the `@metamask/snaps-utils` module
|
|
16
|
+
* from being required at runtime.
|
|
17
|
+
*
|
|
18
|
+
* @param args - Constructor arguments.
|
|
19
|
+
* @param args.messenger - The `KeyringInternalSnapClientMessenger` instance to use.
|
|
20
|
+
* @param args.snapId - The ID of the Snap to use (default: `'undefined'`).
|
|
21
|
+
* @param args.origin - The sender's origin (default: `'metamask'`).
|
|
22
|
+
* @param args.handler - The handler type (default: `'onKeyringRequest'`).
|
|
23
|
+
*/
|
|
24
|
+
constructor({ messenger, snapId, origin, handler, }: {
|
|
25
|
+
messenger: KeyringInternalSnapClientMessenger;
|
|
26
|
+
snapId?: SnapId;
|
|
27
|
+
origin?: string;
|
|
28
|
+
handler?: HandlerType;
|
|
29
|
+
});
|
|
30
|
+
/**
|
|
31
|
+
* Create a new instance of `KeyringInternalSnapClient` with the specified
|
|
32
|
+
* `snapId`.
|
|
33
|
+
*
|
|
34
|
+
* @param snapId - The ID of the Snap to use in the new instance.
|
|
35
|
+
* @returns A new instance of `KeyringInternalSnapClient` with the
|
|
36
|
+
* specified Snap ID.
|
|
37
|
+
*/
|
|
38
|
+
withSnapId(snapId: SnapId): KeyringInternalSnapClient;
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=KeyringInternalSnapClient.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"KeyringInternalSnapClient.d.mts","sourceRoot":"","sources":["../../src/v2/KeyringInternalSnapClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,yCAAyC;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,8BAA8B;AAEzD,OAAO,KAAK,EAAE,kCAAkC,EAAE,yCAAqC;AAGvF;;;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;CAMtD"}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
|
|
2
|
+
if (kind === "m") throw new TypeError("Private method is not writable");
|
|
3
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
|
|
4
|
+
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");
|
|
5
|
+
return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
|
|
6
|
+
};
|
|
7
|
+
var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
|
|
8
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
|
|
9
|
+
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");
|
|
10
|
+
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
11
|
+
};
|
|
12
|
+
var _KeyringInternalSnapClient_messenger;
|
|
13
|
+
import { KeyringClient } from "@metamask/keyring-snap-client/v2";
|
|
14
|
+
import { SnapControllerMessengerSender } from "../KeyringInternalSnapClient.mjs";
|
|
15
|
+
/**
|
|
16
|
+
* A `KeyringClient` that allows the communication with a Snap through a
|
|
17
|
+
* `Messenger`.
|
|
18
|
+
*/
|
|
19
|
+
export class KeyringInternalSnapClient extends KeyringClient {
|
|
20
|
+
/**
|
|
21
|
+
* Create a new instance of `KeyringInternalSnapClient`.
|
|
22
|
+
*
|
|
23
|
+
* The `handlerType` argument has a hard-coded default `string` value instead
|
|
24
|
+
* of a `HandlerType` value to prevent the `@metamask/snaps-utils` module
|
|
25
|
+
* from being required at runtime.
|
|
26
|
+
*
|
|
27
|
+
* @param args - Constructor arguments.
|
|
28
|
+
* @param args.messenger - The `KeyringInternalSnapClientMessenger` instance to use.
|
|
29
|
+
* @param args.snapId - The ID of the Snap to use (default: `'undefined'`).
|
|
30
|
+
* @param args.origin - The sender's origin (default: `'metamask'`).
|
|
31
|
+
* @param args.handler - The handler type (default: `'onKeyringRequest'`).
|
|
32
|
+
*/
|
|
33
|
+
constructor({ messenger, snapId = 'undefined', origin = 'metamask', handler = 'onKeyringRequest', }) {
|
|
34
|
+
super(new SnapControllerMessengerSender(messenger, snapId, origin, handler));
|
|
35
|
+
_KeyringInternalSnapClient_messenger.set(this, void 0);
|
|
36
|
+
__classPrivateFieldSet(this, _KeyringInternalSnapClient_messenger, messenger, "f");
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Create a new instance of `KeyringInternalSnapClient` with the specified
|
|
40
|
+
* `snapId`.
|
|
41
|
+
*
|
|
42
|
+
* @param snapId - The ID of the Snap to use in the new instance.
|
|
43
|
+
* @returns A new instance of `KeyringInternalSnapClient` with the
|
|
44
|
+
* specified Snap ID.
|
|
45
|
+
*/
|
|
46
|
+
withSnapId(snapId) {
|
|
47
|
+
return new KeyringInternalSnapClient({
|
|
48
|
+
messenger: __classPrivateFieldGet(this, _KeyringInternalSnapClient_messenger, "f"),
|
|
49
|
+
snapId,
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
_KeyringInternalSnapClient_messenger = new WeakMap();
|
|
54
|
+
//# sourceMappingURL=KeyringInternalSnapClient.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"KeyringInternalSnapClient.mjs","sourceRoot":"","sources":["../../src/v2/KeyringInternalSnapClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,aAAa,EAAE,yCAAyC;AAKjE,OAAO,EAAE,6BAA6B,EAAE,yCAAqC;AAE7E;;;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;CACF","sourcesContent":["import { KeyringClient } from '@metamask/keyring-snap-client/v2';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport type { HandlerType } from '@metamask/snaps-utils';\n\nimport type { KeyringInternalSnapClientMessenger } from '../KeyringInternalSnapClient';\nimport { SnapControllerMessengerSender } from '../KeyringInternalSnapClient';\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"]}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./KeyringInternalSnapClient.cjs"), exports);
|
|
18
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kEAA4C","sourcesContent":["export * from './KeyringInternalSnapClient';\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":"AAAA,gDAA4C"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":"AAAA,gDAA4C"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":"AAAA,gDAA4C","sourcesContent":["export * from './KeyringInternalSnapClient';\n"]}
|
package/package.json
CHANGED
|
@@ -1,19 +1,27 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@metamask-previews/keyring-internal-snap-client",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "10.0.1-7275dbc",
|
|
4
4
|
"description": "MetaMask Keyring Snap internal clients",
|
|
5
5
|
"keywords": [
|
|
6
|
-
"
|
|
7
|
-
"
|
|
6
|
+
"keyring",
|
|
7
|
+
"metamask"
|
|
8
8
|
],
|
|
9
9
|
"homepage": "https://github.com/MetaMask/accounts/tree/main/packages/keyring-internal-snap-client#readme",
|
|
10
10
|
"bugs": {
|
|
11
11
|
"url": "https://github.com/MetaMask/accounts/issues"
|
|
12
12
|
},
|
|
13
|
+
"license": "MIT",
|
|
13
14
|
"repository": {
|
|
14
15
|
"type": "git",
|
|
15
16
|
"url": "https://github.com/MetaMask/accounts.git"
|
|
16
17
|
},
|
|
18
|
+
"files": [
|
|
19
|
+
"dist/",
|
|
20
|
+
"v2.js"
|
|
21
|
+
],
|
|
22
|
+
"sideEffects": false,
|
|
23
|
+
"main": "./dist/index.cjs",
|
|
24
|
+
"types": "./dist/index.d.cts",
|
|
17
25
|
"exports": {
|
|
18
26
|
".": {
|
|
19
27
|
"import": {
|
|
@@ -24,41 +32,54 @@
|
|
|
24
32
|
"types": "./dist/index.d.cts",
|
|
25
33
|
"default": "./dist/index.cjs"
|
|
26
34
|
}
|
|
27
|
-
}
|
|
35
|
+
},
|
|
36
|
+
"./v2": {
|
|
37
|
+
"import": {
|
|
38
|
+
"types": "./dist/v2/index.d.mts",
|
|
39
|
+
"default": "./dist/v2/index.mjs"
|
|
40
|
+
},
|
|
41
|
+
"require": {
|
|
42
|
+
"types": "./dist/v2/index.d.cts",
|
|
43
|
+
"default": "./dist/v2/index.cjs"
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
"./package.json": "./package.json"
|
|
47
|
+
},
|
|
48
|
+
"publishConfig": {
|
|
49
|
+
"access": "public",
|
|
50
|
+
"registry": "https://registry.npmjs.org/"
|
|
28
51
|
},
|
|
29
|
-
"main": "./dist/index.cjs",
|
|
30
|
-
"types": "./dist/index.d.cts",
|
|
31
|
-
"files": [
|
|
32
|
-
"dist/"
|
|
33
|
-
],
|
|
34
52
|
"scripts": {
|
|
35
|
-
"build": "ts-bridge --project tsconfig.build.json --no-references",
|
|
53
|
+
"build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
|
|
54
|
+
"build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
|
|
36
55
|
"build:clean": "yarn build --clean",
|
|
37
56
|
"build:docs": "typedoc",
|
|
38
57
|
"changelog:update": "../../scripts/update-changelog.sh @metamask/keyring-internal-snap-client",
|
|
39
58
|
"changelog:validate": "../../scripts/validate-changelog.sh @metamask/keyring-internal-snap-client",
|
|
40
59
|
"publish:preview": "yarn npm publish --tag preview",
|
|
60
|
+
"since-latest-release": "../../scripts/since-latest-release.sh",
|
|
41
61
|
"test": "yarn test:source && yarn test:types",
|
|
42
|
-
"test:clean": "jest --clearCache",
|
|
43
|
-
"test:source": "jest
|
|
62
|
+
"test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
|
|
63
|
+
"test:source": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
|
|
44
64
|
"test:types": "../../scripts/tsd-test.sh ./src",
|
|
45
|
-
"test:
|
|
65
|
+
"test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
|
|
66
|
+
"test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
|
|
46
67
|
},
|
|
47
68
|
"dependencies": {
|
|
48
|
-
"@metamask/keyring-api": "
|
|
49
|
-
"@metamask/keyring-internal-api": "10.
|
|
50
|
-
"@metamask/keyring-snap-client": "
|
|
69
|
+
"@metamask/keyring-api": "23.0.1",
|
|
70
|
+
"@metamask/keyring-internal-api": "10.1.1",
|
|
71
|
+
"@metamask/keyring-snap-client": "9.0.1",
|
|
51
72
|
"@metamask/keyring-utils": "3.2.0",
|
|
52
73
|
"@metamask/messenger": "^1.1.1"
|
|
53
74
|
},
|
|
54
75
|
"devDependencies": {
|
|
55
76
|
"@lavamoat/allow-scripts": "^3.2.1",
|
|
56
77
|
"@lavamoat/preinstall-always-fail": "^2.1.0",
|
|
57
|
-
"@metamask/auto-changelog": "^
|
|
78
|
+
"@metamask/auto-changelog": "^6.1.0",
|
|
58
79
|
"@metamask/snaps-controllers": "^19.0.1",
|
|
59
80
|
"@metamask/snaps-sdk": "^11.0.0",
|
|
60
81
|
"@metamask/snaps-utils": "^12.1.3",
|
|
61
|
-
"@metamask/utils": "^11.
|
|
82
|
+
"@metamask/utils": "^11.11.0",
|
|
62
83
|
"@ts-bridge/cli": "^0.6.3",
|
|
63
84
|
"@types/jest": "^29.5.12",
|
|
64
85
|
"@types/node": "^20.12.12",
|
|
@@ -73,22 +94,18 @@
|
|
|
73
94
|
"typedoc": "^0.25.13",
|
|
74
95
|
"typescript": "~5.6.3"
|
|
75
96
|
},
|
|
97
|
+
"tsd": {
|
|
98
|
+
"compilerOptions": {
|
|
99
|
+
"composite": "false"
|
|
100
|
+
},
|
|
101
|
+
"directory": "src"
|
|
102
|
+
},
|
|
76
103
|
"engines": {
|
|
77
104
|
"node": "^18.18 || >=20"
|
|
78
105
|
},
|
|
79
|
-
"publishConfig": {
|
|
80
|
-
"access": "public",
|
|
81
|
-
"registry": "https://registry.npmjs.org/"
|
|
82
|
-
},
|
|
83
106
|
"lavamoat": {
|
|
84
107
|
"allowScripts": {
|
|
85
108
|
"@lavamoat/preinstall-always-fail": false
|
|
86
109
|
}
|
|
87
|
-
},
|
|
88
|
-
"tsd": {
|
|
89
|
-
"directory": "src",
|
|
90
|
-
"compilerOptions": {
|
|
91
|
-
"composite": "false"
|
|
92
|
-
}
|
|
93
110
|
}
|
|
94
111
|
}
|
package/v2.js
ADDED