@metamask/keyring-api 1.1.0 → 3.0.0

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.
Files changed (46) hide show
  1. package/CHANGELOG.md +48 -1
  2. package/README.md +7 -7
  3. package/dist/api.d.ts +13 -7
  4. package/dist/api.js +10 -2
  5. package/dist/api.js.map +1 -1
  6. package/dist/eth/erc4337/index.d.ts +1 -0
  7. package/dist/eth/erc4337/index.js +18 -0
  8. package/dist/eth/erc4337/index.js.map +1 -0
  9. package/dist/eth/erc4337/types.d.ts +90 -0
  10. package/dist/eth/erc4337/types.js +58 -0
  11. package/dist/eth/erc4337/types.js.map +1 -0
  12. package/dist/eth/index.d.ts +2 -0
  13. package/dist/eth/index.js +19 -0
  14. package/dist/eth/index.js.map +1 -0
  15. package/dist/eth/types.d.ts +3 -0
  16. package/dist/eth/types.js +8 -0
  17. package/dist/eth/types.js.map +1 -0
  18. package/dist/index.d.ts +1 -1
  19. package/dist/index.js +1 -1
  20. package/dist/index.js.map +1 -1
  21. package/dist/internal/api.d.ts +38 -26
  22. package/dist/internal/eth/EthKeyring.d.ts +29 -0
  23. package/dist/internal/eth/EthKeyring.js +3 -0
  24. package/dist/internal/eth/EthKeyring.js.map +1 -0
  25. package/dist/internal/eth/index.d.ts +1 -0
  26. package/dist/internal/eth/index.js +18 -0
  27. package/dist/internal/eth/index.js.map +1 -0
  28. package/dist/internal/events.d.ts +30 -20
  29. package/dist/internal/index.d.ts +1 -0
  30. package/dist/internal/index.js +1 -0
  31. package/dist/internal/index.js.map +1 -1
  32. package/dist/internal/types.d.ts +8 -5
  33. package/dist/snap-utils.d.ts +2 -2
  34. package/dist/snap-utils.js.map +1 -1
  35. package/dist/superstruct.d.ts +14 -0
  36. package/dist/superstruct.js +18 -1
  37. package/dist/superstruct.js.map +1 -1
  38. package/dist/utils.js +2 -2
  39. package/dist/utils.js.map +1 -1
  40. package/package.json +3 -5
  41. package/dist/KeyringSnapControllerClient.d.ts +0 -44
  42. package/dist/KeyringSnapControllerClient.js +0 -104
  43. package/dist/KeyringSnapControllerClient.js.map +0 -1
  44. package/dist/superstruct.test-d.d.ts +0 -1
  45. package/dist/superstruct.test-d.js +0 -17
  46. package/dist/superstruct.test-d.js.map +0 -1
@@ -1,44 +0,0 @@
1
- import type { SnapController } from '@metamask/snaps-controllers';
2
- import type { HandlerType } from '@metamask/snaps-utils';
3
- import { KeyringClient } from './KeyringClient';
4
- /**
5
- * A `KeyringClient` that allows the communication with a snap through the
6
- * `SnapController`.
7
- */
8
- export declare class KeyringSnapControllerClient extends KeyringClient {
9
- #private;
10
- /**
11
- * Create a new instance of `KeyringSnapControllerClient`.
12
- *
13
- * The `handlerType` argument has a hard-coded default `string` value instead
14
- * of a `HandlerType` value to prevent the `@metamask/snaps-utils` module
15
- * from being required at runtime.
16
- *
17
- * @param args - Constructor arguments.
18
- * @param args.controller - The `SnapController` instance to use.
19
- * @param args.snapId - The ID of the snap to use (default: `'undefined'`).
20
- * @param args.origin - The sender's origin (default: `'metamask'`).
21
- * @param args.handler - The handler type (default: `'onKeyringRequest'`).
22
- */
23
- constructor({ controller, snapId, origin, handler, }: {
24
- controller: SnapController;
25
- snapId?: string;
26
- origin?: string;
27
- handler?: HandlerType;
28
- });
29
- /**
30
- * Create a new instance of `KeyringSnapControllerClient` with the specified
31
- * `snapId`.
32
- *
33
- * @param snapId - The ID of the snap to use in the new instance.
34
- * @returns A new instance of `KeyringSnapControllerClient` with the
35
- * specified snap ID.
36
- */
37
- withSnapId(snapId: string): KeyringSnapControllerClient;
38
- /**
39
- * Get the `SnapController` instance used by this client.
40
- *
41
- * @returns The `SnapController` instance used by this client.
42
- */
43
- getController(): SnapController;
44
- }
@@ -1,104 +0,0 @@
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 _SnapControllerSender_snapId, _SnapControllerSender_origin, _SnapControllerSender_controller, _SnapControllerSender_handler, _KeyringSnapControllerClient_controller;
14
- Object.defineProperty(exports, "__esModule", { value: true });
15
- exports.KeyringSnapControllerClient = void 0;
16
- const KeyringClient_1 = require("./KeyringClient");
17
- /**
18
- * Implementation of the `Sender` interface that can be used to send requests
19
- * to a snap through a `SnapController`.
20
- */
21
- class SnapControllerSender {
22
- /**
23
- * Create a new instance of `SnapControllerSender`.
24
- *
25
- * @param controller - The `SnapController` instance to send requests to.
26
- * @param snapId - The ID of the snap to use.
27
- * @param origin - The sender's origin.
28
- * @param handler - The handler type.
29
- */
30
- constructor(controller, snapId, origin, handler) {
31
- _SnapControllerSender_snapId.set(this, void 0);
32
- _SnapControllerSender_origin.set(this, void 0);
33
- _SnapControllerSender_controller.set(this, void 0);
34
- _SnapControllerSender_handler.set(this, void 0);
35
- __classPrivateFieldSet(this, _SnapControllerSender_controller, controller, "f");
36
- __classPrivateFieldSet(this, _SnapControllerSender_snapId, snapId, "f");
37
- __classPrivateFieldSet(this, _SnapControllerSender_origin, origin, "f");
38
- __classPrivateFieldSet(this, _SnapControllerSender_handler, handler, "f");
39
- }
40
- /**
41
- * Send a request to the snap and return the response.
42
- *
43
- * @param request - JSON-RPC request to send to the snap.
44
- * @returns A promise that resolves to the response of the request.
45
- */
46
- async send(request) {
47
- return __classPrivateFieldGet(this, _SnapControllerSender_controller, "f").handleRequest({
48
- snapId: __classPrivateFieldGet(this, _SnapControllerSender_snapId, "f"),
49
- origin: __classPrivateFieldGet(this, _SnapControllerSender_origin, "f"),
50
- handler: __classPrivateFieldGet(this, _SnapControllerSender_handler, "f"),
51
- request,
52
- });
53
- }
54
- }
55
- _SnapControllerSender_snapId = new WeakMap(), _SnapControllerSender_origin = new WeakMap(), _SnapControllerSender_controller = new WeakMap(), _SnapControllerSender_handler = new WeakMap();
56
- /**
57
- * A `KeyringClient` that allows the communication with a snap through the
58
- * `SnapController`.
59
- */
60
- class KeyringSnapControllerClient extends KeyringClient_1.KeyringClient {
61
- /**
62
- * Create a new instance of `KeyringSnapControllerClient`.
63
- *
64
- * The `handlerType` argument has a hard-coded default `string` value instead
65
- * of a `HandlerType` value to prevent the `@metamask/snaps-utils` module
66
- * from being required at runtime.
67
- *
68
- * @param args - Constructor arguments.
69
- * @param args.controller - The `SnapController` instance to use.
70
- * @param args.snapId - The ID of the snap to use (default: `'undefined'`).
71
- * @param args.origin - The sender's origin (default: `'metamask'`).
72
- * @param args.handler - The handler type (default: `'onKeyringRequest'`).
73
- */
74
- constructor({ controller, snapId = 'undefined', origin = 'metamask', handler = 'onKeyringRequest', }) {
75
- super(new SnapControllerSender(controller, snapId, origin, handler));
76
- _KeyringSnapControllerClient_controller.set(this, void 0);
77
- __classPrivateFieldSet(this, _KeyringSnapControllerClient_controller, controller, "f");
78
- }
79
- /**
80
- * Create a new instance of `KeyringSnapControllerClient` with the specified
81
- * `snapId`.
82
- *
83
- * @param snapId - The ID of the snap to use in the new instance.
84
- * @returns A new instance of `KeyringSnapControllerClient` with the
85
- * specified snap ID.
86
- */
87
- withSnapId(snapId) {
88
- return new KeyringSnapControllerClient({
89
- controller: __classPrivateFieldGet(this, _KeyringSnapControllerClient_controller, "f"),
90
- snapId,
91
- });
92
- }
93
- /**
94
- * Get the `SnapController` instance used by this client.
95
- *
96
- * @returns The `SnapController` instance used by this client.
97
- */
98
- getController() {
99
- return __classPrivateFieldGet(this, _KeyringSnapControllerClient_controller, "f");
100
- }
101
- }
102
- exports.KeyringSnapControllerClient = KeyringSnapControllerClient;
103
- _KeyringSnapControllerClient_controller = new WeakMap();
104
- //# sourceMappingURL=KeyringSnapControllerClient.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"KeyringSnapControllerClient.js","sourceRoot":"","sources":["../src/KeyringSnapControllerClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAKA,mDAA6D;AAE7D;;;GAGG;AACH,MAAM,oBAAoB;IASxB;;;;;;;OAOG;IACH,YACE,UAAe,EACf,MAAc,EACd,MAAc,EACd,OAAoB;QApBtB,+CAAgB;QAEhB,+CAAgB;QAEhB,mDAA4B;QAE5B,gDAAsB;QAgBpB,uBAAA,IAAI,oCAAe,UAAU,MAAA,CAAC;QAC9B,uBAAA,IAAI,gCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,gCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,iCAAY,OAAO,MAAA,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,OAAuB;QAChC,OAAO,uBAAA,IAAI,wCAAY,CAAC,aAAa,CAAC;YACpC,MAAM,EAAE,uBAAA,IAAI,oCAA2B;YACvC,MAAM,EAAE,uBAAA,IAAI,oCAAQ;YACpB,OAAO,EAAE,uBAAA,IAAI,qCAAS;YACtB,OAAO;SACR,CAAkB,CAAC;IACtB,CAAC;CACF;;AAED;;;GAGG;AACH,MAAa,2BAA4B,SAAQ,6BAAa;IAG5D;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,UAAU,EACV,MAAM,GAAG,WAAW,EACpB,MAAM,GAAG,UAAU,EACnB,OAAO,GAAG,kBAAiC,GAM5C;QACC,KAAK,CAAC,IAAI,oBAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QA1BvE,0DAA4B;QA2B1B,uBAAA,IAAI,2CAAe,UAAU,MAAA,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,MAAc;QACvB,OAAO,IAAI,2BAA2B,CAAC;YACrC,UAAU,EAAE,uBAAA,IAAI,+CAAY;YAC5B,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,aAAa;QACX,OAAO,uBAAA,IAAI,+CAAY,CAAC;IAC1B,CAAC;CACF;AAtDD,kEAsDC","sourcesContent":["import type { SnapController } from '@metamask/snaps-controllers';\nimport type { HandlerType, ValidatedSnapId } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\n\nimport type { JsonRpcRequest } from './JsonRpcRequest';\nimport { KeyringClient, type Sender } from './KeyringClient';\n\n/**\n * Implementation of the `Sender` interface that can be used to send requests\n * to a snap through a `SnapController`.\n */\nclass SnapControllerSender implements Sender {\n #snapId: string;\n\n #origin: string;\n\n #controller: SnapController;\n\n #handler: HandlerType;\n\n /**\n * Create a new instance of `SnapControllerSender`.\n *\n * @param controller - The `SnapController` instance to send requests to.\n * @param snapId - The ID of the snap to use.\n * @param origin - The sender's origin.\n * @param handler - The handler type.\n */\n constructor(\n controller: any,\n snapId: string,\n origin: string,\n handler: HandlerType,\n ) {\n this.#controller = controller;\n this.#snapId = snapId;\n this.#origin = origin;\n this.#handler = handler;\n }\n\n /**\n * Send a request to the snap and return the response.\n *\n * @param request - JSON-RPC request to send to the snap.\n * @returns A promise that resolves to the response of the request.\n */\n async send(request: JsonRpcRequest): Promise<Json> {\n return this.#controller.handleRequest({\n snapId: this.#snapId as ValidatedSnapId,\n origin: this.#origin,\n handler: this.#handler,\n request,\n }) as Promise<Json>;\n }\n}\n\n/**\n * A `KeyringClient` that allows the communication with a snap through the\n * `SnapController`.\n */\nexport class KeyringSnapControllerClient extends KeyringClient {\n #controller: SnapController;\n\n /**\n * Create a new instance of `KeyringSnapControllerClient`.\n *\n * The `handlerType` argument has a hard-coded default `string` value instead\n * of a `HandlerType` value to prevent the `@metamask/snaps-utils` module\n * from being required at runtime.\n *\n * @param args - Constructor arguments.\n * @param args.controller - The `SnapController` instance to use.\n * @param args.snapId - The ID of the snap to use (default: `'undefined'`).\n * @param args.origin - The sender's origin (default: `'metamask'`).\n * @param args.handler - The handler type (default: `'onKeyringRequest'`).\n */\n constructor({\n controller,\n snapId = 'undefined',\n origin = 'metamask',\n handler = 'onKeyringRequest' as HandlerType,\n }: {\n controller: SnapController;\n snapId?: string;\n origin?: string;\n handler?: HandlerType;\n }) {\n super(new SnapControllerSender(controller, snapId, origin, handler));\n this.#controller = controller;\n }\n\n /**\n * Create a new instance of `KeyringSnapControllerClient` with the specified\n * `snapId`.\n *\n * @param snapId - The ID of the snap to use in the new instance.\n * @returns A new instance of `KeyringSnapControllerClient` with the\n * specified snap ID.\n */\n withSnapId(snapId: string): KeyringSnapControllerClient {\n return new KeyringSnapControllerClient({\n controller: this.#controller,\n snapId,\n });\n }\n\n /**\n * Get the `SnapController` instance used by this client.\n *\n * @returns The `SnapController` instance used by this client.\n */\n getController(): SnapController {\n return this.#controller;\n }\n}\n"]}
@@ -1 +0,0 @@
1
- export {};
@@ -1,17 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const superstruct_1 = require("superstruct");
4
- const tsd_1 = require("tsd");
5
- const _1 = require(".");
6
- const exactOptionalObject = (0, _1.object)({
7
- a: (0, superstruct_1.number)(),
8
- b: (0, superstruct_1.optional)((0, superstruct_1.string)()),
9
- c: (0, _1.exactOptional)((0, superstruct_1.boolean)()),
10
- });
11
- (0, tsd_1.expectAssignable)({ a: 0 });
12
- (0, tsd_1.expectAssignable)({ a: 0, b: 'test' });
13
- (0, tsd_1.expectAssignable)({ a: 0, b: 'test', c: true });
14
- (0, tsd_1.expectAssignable)({ a: 0, b: undefined });
15
- (0, tsd_1.expectNotAssignable)({ a: 0, b: 'test', c: 0 });
16
- (0, tsd_1.expectNotAssignable)({ a: 0, b: 'test', c: undefined });
17
- //# sourceMappingURL=superstruct.test-d.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"superstruct.test-d.js","sourceRoot":"","sources":["../src/superstruct.test-d.ts"],"names":[],"mappings":";;AACA,6CAAgE;AAChE,6BAA4D;AAE5D,wBAA0C;AAE1C,MAAM,mBAAmB,GAAG,IAAA,SAAM,EAAC;IACjC,CAAC,EAAE,IAAA,oBAAM,GAAE;IACX,CAAC,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IACrB,CAAC,EAAE,IAAA,gBAAa,EAAC,IAAA,qBAAO,GAAE,CAAC;CAC5B,CAAC,CAAC;AAIH,IAAA,sBAAgB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;AAChD,IAAA,sBAAgB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;AAC3D,IAAA,sBAAgB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AACpE,IAAA,sBAAgB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;AAC9D,IAAA,yBAAmB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;AACpE,IAAA,yBAAmB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC","sourcesContent":["import type { Infer } from 'superstruct';\nimport { boolean, number, optional, string } from 'superstruct';\nimport { expectAssignable, expectNotAssignable } from 'tsd';\n\nimport { exactOptional, object } from '.';\n\nconst exactOptionalObject = object({\n a: number(),\n b: optional(string()),\n c: exactOptional(boolean()),\n});\n\ntype ExactOptionalObject = Infer<typeof exactOptionalObject>;\n\nexpectAssignable<ExactOptionalObject>({ a: 0 });\nexpectAssignable<ExactOptionalObject>({ a: 0, b: 'test' });\nexpectAssignable<ExactOptionalObject>({ a: 0, b: 'test', c: true });\nexpectAssignable<ExactOptionalObject>({ a: 0, b: undefined });\nexpectNotAssignable<ExactOptionalObject>({ a: 0, b: 'test', c: 0 });\nexpectNotAssignable<ExactOptionalObject>({ a: 0, b: 'test', c: undefined });\n"]}