@metamask-previews/keyring-internal-snap-client 4.0.2-308fbe1 → 4.0.2-747bf47
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/dist/KeyringInternalSnapClient.cjs +15 -0
- package/dist/KeyringInternalSnapClient.cjs.map +1 -1
- package/dist/KeyringInternalSnapClient.d.cts +8 -0
- package/dist/KeyringInternalSnapClient.d.cts.map +1 -1
- package/dist/KeyringInternalSnapClient.d.mts +8 -0
- package/dist/KeyringInternalSnapClient.d.mts.map +1 -1
- package/dist/KeyringInternalSnapClient.mjs +15 -0
- package/dist/KeyringInternalSnapClient.mjs.map +1 -1
- package/package.json +6 -5
|
@@ -13,7 +13,10 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
|
|
|
13
13
|
var _SnapControllerMessengerSender_snapId, _SnapControllerMessengerSender_origin, _SnapControllerMessengerSender_messenger, _SnapControllerMessengerSender_handler, _KeyringInternalSnapClient_messenger;
|
|
14
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
15
|
exports.KeyringInternalSnapClient = void 0;
|
|
16
|
+
const keyring_api_1 = require("@metamask/keyring-api");
|
|
17
|
+
const keyring_internal_api_1 = require("@metamask/keyring-internal-api");
|
|
16
18
|
const keyring_snap_client_1 = require("@metamask/keyring-snap-client");
|
|
19
|
+
const keyring_utils_1 = require("@metamask/keyring-utils");
|
|
17
20
|
/**
|
|
18
21
|
* Implementation of the `Sender` interface that can be used to send requests
|
|
19
22
|
* to a Snap through a `Messenger`.
|
|
@@ -90,6 +93,18 @@ class KeyringInternalSnapClient extends keyring_snap_client_1.KeyringClient {
|
|
|
90
93
|
snapId,
|
|
91
94
|
});
|
|
92
95
|
}
|
|
96
|
+
/**
|
|
97
|
+
* Submit a keyring request v1 (with no `origin`).
|
|
98
|
+
*
|
|
99
|
+
* @param request - Keyring request.
|
|
100
|
+
* @returns Keyring request's response.
|
|
101
|
+
*/
|
|
102
|
+
async submitRequestV1(request) {
|
|
103
|
+
return (0, keyring_utils_1.strictMask)(await this.send({
|
|
104
|
+
method: keyring_api_1.KeyringRpcMethod.SubmitRequest,
|
|
105
|
+
params: request,
|
|
106
|
+
}), keyring_internal_api_1.SubmitRequestResponseV1Struct);
|
|
107
|
+
}
|
|
93
108
|
}
|
|
94
109
|
exports.KeyringInternalSnapClient = KeyringInternalSnapClient;
|
|
95
110
|
_KeyringInternalSnapClient_messenger = new WeakMap();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"KeyringInternalSnapClient.cjs","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,uEAA2E;
|
|
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,4 +1,5 @@
|
|
|
1
1
|
import type { RestrictedMessenger } from "@metamask/base-controller";
|
|
2
|
+
import type { KeyringRequestV1, KeyringResponseV1 } from "@metamask/keyring-internal-api";
|
|
2
3
|
import { KeyringClient } from "@metamask/keyring-snap-client";
|
|
3
4
|
import type { HandleSnapRequest } from "@metamask/snaps-controllers";
|
|
4
5
|
import type { SnapId } from "@metamask/snaps-sdk";
|
|
@@ -43,6 +44,13 @@ export declare class KeyringInternalSnapClient extends KeyringClient {
|
|
|
43
44
|
* specified Snap ID.
|
|
44
45
|
*/
|
|
45
46
|
withSnapId(snapId: SnapId): KeyringInternalSnapClient;
|
|
47
|
+
/**
|
|
48
|
+
* Submit a keyring request v1 (with no `origin`).
|
|
49
|
+
*
|
|
50
|
+
* @param request - Keyring request.
|
|
51
|
+
* @returns Keyring request's response.
|
|
52
|
+
*/
|
|
53
|
+
submitRequestV1(request: KeyringRequestV1): Promise<KeyringResponseV1>;
|
|
46
54
|
}
|
|
47
55
|
export {};
|
|
48
56
|
//# sourceMappingURL=KeyringInternalSnapClient.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"KeyringInternalSnapClient.d.cts","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,kCAAkC;
|
|
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,4 +1,5 @@
|
|
|
1
1
|
import type { RestrictedMessenger } from "@metamask/base-controller";
|
|
2
|
+
import type { KeyringRequestV1, KeyringResponseV1 } from "@metamask/keyring-internal-api";
|
|
2
3
|
import { KeyringClient } from "@metamask/keyring-snap-client";
|
|
3
4
|
import type { HandleSnapRequest } from "@metamask/snaps-controllers";
|
|
4
5
|
import type { SnapId } from "@metamask/snaps-sdk";
|
|
@@ -43,6 +44,13 @@ export declare class KeyringInternalSnapClient extends KeyringClient {
|
|
|
43
44
|
* specified Snap ID.
|
|
44
45
|
*/
|
|
45
46
|
withSnapId(snapId: SnapId): KeyringInternalSnapClient;
|
|
47
|
+
/**
|
|
48
|
+
* Submit a keyring request v1 (with no `origin`).
|
|
49
|
+
*
|
|
50
|
+
* @param request - Keyring request.
|
|
51
|
+
* @returns Keyring request's response.
|
|
52
|
+
*/
|
|
53
|
+
submitRequestV1(request: KeyringRequestV1): Promise<KeyringResponseV1>;
|
|
46
54
|
}
|
|
47
55
|
export {};
|
|
48
56
|
//# sourceMappingURL=KeyringInternalSnapClient.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"KeyringInternalSnapClient.d.mts","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,kCAAkC;
|
|
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"}
|
|
@@ -10,7 +10,10 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
|
|
|
10
10
|
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
11
11
|
};
|
|
12
12
|
var _SnapControllerMessengerSender_snapId, _SnapControllerMessengerSender_origin, _SnapControllerMessengerSender_messenger, _SnapControllerMessengerSender_handler, _KeyringInternalSnapClient_messenger;
|
|
13
|
+
import { KeyringRpcMethod } from "@metamask/keyring-api";
|
|
14
|
+
import { SubmitRequestResponseV1Struct } from "@metamask/keyring-internal-api";
|
|
13
15
|
import { KeyringClient } from "@metamask/keyring-snap-client";
|
|
16
|
+
import { strictMask } from "@metamask/keyring-utils";
|
|
14
17
|
/**
|
|
15
18
|
* Implementation of the `Sender` interface that can be used to send requests
|
|
16
19
|
* to a Snap through a `Messenger`.
|
|
@@ -87,6 +90,18 @@ export class KeyringInternalSnapClient extends KeyringClient {
|
|
|
87
90
|
snapId,
|
|
88
91
|
});
|
|
89
92
|
}
|
|
93
|
+
/**
|
|
94
|
+
* Submit a keyring request v1 (with no `origin`).
|
|
95
|
+
*
|
|
96
|
+
* @param request - Keyring request.
|
|
97
|
+
* @returns Keyring request's response.
|
|
98
|
+
*/
|
|
99
|
+
async submitRequestV1(request) {
|
|
100
|
+
return strictMask(await this.send({
|
|
101
|
+
method: KeyringRpcMethod.SubmitRequest,
|
|
102
|
+
params: request,
|
|
103
|
+
}), SubmitRequestResponseV1Struct);
|
|
104
|
+
}
|
|
90
105
|
}
|
|
91
106
|
_KeyringInternalSnapClient_messenger = new WeakMap();
|
|
92
107
|
//# sourceMappingURL=KeyringInternalSnapClient.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"KeyringInternalSnapClient.mjs","sourceRoot":"","sources":["../src/KeyringInternalSnapClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,OAAO,EAAE,aAAa,EAAe,sCAAsC;
|
|
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"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@metamask-previews/keyring-internal-snap-client",
|
|
3
|
-
"version": "4.0.2-
|
|
3
|
+
"version": "4.0.2-747bf47",
|
|
4
4
|
"description": "MetaMask Keyring Snap internal clients",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"metamask",
|
|
@@ -46,7 +46,8 @@
|
|
|
46
46
|
},
|
|
47
47
|
"dependencies": {
|
|
48
48
|
"@metamask/base-controller": "^7.1.1",
|
|
49
|
-
"@metamask/keyring-api": "17.
|
|
49
|
+
"@metamask/keyring-api": "17.5.0",
|
|
50
|
+
"@metamask/keyring-internal-api": "6.0.1",
|
|
50
51
|
"@metamask/keyring-snap-client": "4.1.0",
|
|
51
52
|
"@metamask/keyring-utils": "3.0.0"
|
|
52
53
|
},
|
|
@@ -54,9 +55,9 @@
|
|
|
54
55
|
"@lavamoat/allow-scripts": "^3.2.1",
|
|
55
56
|
"@lavamoat/preinstall-always-fail": "^2.1.0",
|
|
56
57
|
"@metamask/auto-changelog": "^3.4.4",
|
|
57
|
-
"@metamask/snaps-controllers": "^
|
|
58
|
-
"@metamask/snaps-sdk": "^
|
|
59
|
-
"@metamask/snaps-utils": "^
|
|
58
|
+
"@metamask/snaps-controllers": "^12.2.0",
|
|
59
|
+
"@metamask/snaps-sdk": "^7.0.0",
|
|
60
|
+
"@metamask/snaps-utils": "^9.3.0",
|
|
60
61
|
"@metamask/utils": "^11.1.0",
|
|
61
62
|
"@ts-bridge/cli": "^0.6.3",
|
|
62
63
|
"@types/jest": "^29.5.12",
|