@metamask/multichain-api-middleware 0.1.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 (60) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/LICENSE +20 -0
  3. package/README.md +15 -0
  4. package/dist/handlers/wallet-getSession.cjs +47 -0
  5. package/dist/handlers/wallet-getSession.cjs.map +1 -0
  6. package/dist/handlers/wallet-getSession.d.cts +37 -0
  7. package/dist/handlers/wallet-getSession.d.cts.map +1 -0
  8. package/dist/handlers/wallet-getSession.d.mts +37 -0
  9. package/dist/handlers/wallet-getSession.d.mts.map +1 -0
  10. package/dist/handlers/wallet-getSession.mjs +44 -0
  11. package/dist/handlers/wallet-getSession.mjs.map +1 -0
  12. package/dist/handlers/wallet-invokeMethod.cjs +98 -0
  13. package/dist/handlers/wallet-invokeMethod.cjs.map +1 -0
  14. package/dist/handlers/wallet-invokeMethod.d.cts +53 -0
  15. package/dist/handlers/wallet-invokeMethod.d.cts.map +1 -0
  16. package/dist/handlers/wallet-invokeMethod.d.mts +53 -0
  17. package/dist/handlers/wallet-invokeMethod.d.mts.map +1 -0
  18. package/dist/handlers/wallet-invokeMethod.mjs +95 -0
  19. package/dist/handlers/wallet-invokeMethod.mjs.map +1 -0
  20. package/dist/handlers/wallet-revokeSession.cjs +43 -0
  21. package/dist/handlers/wallet-revokeSession.cjs.map +1 -0
  22. package/dist/handlers/wallet-revokeSession.d.cts +31 -0
  23. package/dist/handlers/wallet-revokeSession.d.cts.map +1 -0
  24. package/dist/handlers/wallet-revokeSession.d.mts +31 -0
  25. package/dist/handlers/wallet-revokeSession.d.mts.map +1 -0
  26. package/dist/handlers/wallet-revokeSession.mjs +40 -0
  27. package/dist/handlers/wallet-revokeSession.mjs.map +1 -0
  28. package/dist/index.cjs +16 -0
  29. package/dist/index.cjs.map +1 -0
  30. package/dist/index.d.cts +7 -0
  31. package/dist/index.d.cts.map +1 -0
  32. package/dist/index.d.mts +7 -0
  33. package/dist/index.d.mts.map +1 -0
  34. package/dist/index.mjs +7 -0
  35. package/dist/index.mjs.map +1 -0
  36. package/dist/middlewares/MultichainMiddlewareManager.cjs +110 -0
  37. package/dist/middlewares/MultichainMiddlewareManager.cjs.map +1 -0
  38. package/dist/middlewares/MultichainMiddlewareManager.d.cts +35 -0
  39. package/dist/middlewares/MultichainMiddlewareManager.d.cts.map +1 -0
  40. package/dist/middlewares/MultichainMiddlewareManager.d.mts +35 -0
  41. package/dist/middlewares/MultichainMiddlewareManager.d.mts.map +1 -0
  42. package/dist/middlewares/MultichainMiddlewareManager.mjs +106 -0
  43. package/dist/middlewares/MultichainMiddlewareManager.mjs.map +1 -0
  44. package/dist/middlewares/MultichainSubscriptionManager.cjs +117 -0
  45. package/dist/middlewares/MultichainSubscriptionManager.cjs.map +1 -0
  46. package/dist/middlewares/MultichainSubscriptionManager.d.cts +49 -0
  47. package/dist/middlewares/MultichainSubscriptionManager.d.cts.map +1 -0
  48. package/dist/middlewares/MultichainSubscriptionManager.d.mts +49 -0
  49. package/dist/middlewares/MultichainSubscriptionManager.d.mts.map +1 -0
  50. package/dist/middlewares/MultichainSubscriptionManager.mjs +117 -0
  51. package/dist/middlewares/MultichainSubscriptionManager.mjs.map +1 -0
  52. package/dist/middlewares/multichainMethodCallValidatorMiddleware.cjs +74 -0
  53. package/dist/middlewares/multichainMethodCallValidatorMiddleware.cjs.map +1 -0
  54. package/dist/middlewares/multichainMethodCallValidatorMiddleware.d.cts +7 -0
  55. package/dist/middlewares/multichainMethodCallValidatorMiddleware.d.cts.map +1 -0
  56. package/dist/middlewares/multichainMethodCallValidatorMiddleware.d.mts +7 -0
  57. package/dist/middlewares/multichainMethodCallValidatorMiddleware.d.mts.map +1 -0
  58. package/dist/middlewares/multichainMethodCallValidatorMiddleware.mjs +75 -0
  59. package/dist/middlewares/multichainMethodCallValidatorMiddleware.mjs.map +1 -0
  60. package/package.json +80 -0
@@ -0,0 +1,117 @@
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 __importDefault = (this && this.__importDefault) || function (mod) {
14
+ return (mod && mod.__esModule) ? mod : { "default": mod };
15
+ };
16
+ var _MultichainSubscriptionManager_instances, _MultichainSubscriptionManager_findNetworkClientIdByChainId, _MultichainSubscriptionManager_getNetworkClientById, _MultichainSubscriptionManager_subscriptions, _MultichainSubscriptionManager_getSubscriptionEntry, _MultichainSubscriptionManager_removeSubscriptionEntry, _MultichainSubscriptionManager_unsubscribe;
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ exports.MultichainSubscriptionManager = void 0;
19
+ const controller_utils_1 = require("@metamask/controller-utils");
20
+ const subscriptionManager_1 = __importDefault(require("@metamask/eth-json-rpc-filters/subscriptionManager.js"));
21
+ const safe_event_emitter_1 = __importDefault(require("@metamask/safe-event-emitter"));
22
+ const utils_1 = require("@metamask/utils");
23
+ /**
24
+ * A helper that facilates the lifecycle of a SubscriptionManager instance that
25
+ * is meant to handle subscriptons for only one specific scope, origin, and tabId combination.
26
+ */
27
+ class MultichainSubscriptionManager extends safe_event_emitter_1.default {
28
+ /**
29
+ * Construct a MultichainSubscriptionManager.
30
+ *
31
+ * @param options - The controller options.
32
+ * @param options.findNetworkClientIdByChainId - The hook to get the networkClientId from a chainId.
33
+ * @param options.getNetworkClientById - The hook to get the network client instance by its networkClientId.
34
+ */
35
+ constructor(options) {
36
+ super();
37
+ _MultichainSubscriptionManager_instances.add(this);
38
+ _MultichainSubscriptionManager_findNetworkClientIdByChainId.set(this, void 0);
39
+ _MultichainSubscriptionManager_getNetworkClientById.set(this, void 0);
40
+ _MultichainSubscriptionManager_subscriptions.set(this, []);
41
+ __classPrivateFieldSet(this, _MultichainSubscriptionManager_findNetworkClientIdByChainId, options.findNetworkClientIdByChainId, "f");
42
+ __classPrivateFieldSet(this, _MultichainSubscriptionManager_getNetworkClientById, options.getNetworkClientById, "f");
43
+ }
44
+ notify({ scope, origin, tabId }, { method, params }) {
45
+ this.emit('notification', origin, tabId, {
46
+ method: 'wallet_notify',
47
+ params: {
48
+ scope,
49
+ notification: { method, params },
50
+ },
51
+ });
52
+ }
53
+ subscribe(subscriptionKey) {
54
+ const subscriptionEntry = __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_getSubscriptionEntry).call(this, subscriptionKey);
55
+ if (subscriptionEntry) {
56
+ return subscriptionEntry.subscriptionManager;
57
+ }
58
+ const networkClientId = __classPrivateFieldGet(this, _MultichainSubscriptionManager_findNetworkClientIdByChainId, "f").call(this, (0, controller_utils_1.toHex)((0, utils_1.parseCaipChainId)(subscriptionKey.scope).reference));
59
+ const networkClient = __classPrivateFieldGet(this, _MultichainSubscriptionManager_getNetworkClientById, "f").call(this, networkClientId);
60
+ const subscriptionManager = (0, subscriptionManager_1.default)({
61
+ blockTracker: networkClient.blockTracker,
62
+ provider: networkClient.provider,
63
+ });
64
+ subscriptionManager.events.on('notification', (message) => {
65
+ this.notify(subscriptionKey, message);
66
+ });
67
+ const newSubscriptionManagerEntry = {
68
+ ...subscriptionKey,
69
+ subscriptionManager,
70
+ };
71
+ subscriptionManager.destroy = subscriptionManager.middleware.destroy;
72
+ subscriptionManager.middleware.destroy = __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_unsubscribe).bind(this, newSubscriptionManagerEntry);
73
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").push(newSubscriptionManagerEntry);
74
+ return subscriptionManager;
75
+ }
76
+ unsubscribeByScope(scope) {
77
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").forEach((subscriptionEntry) => {
78
+ if (subscriptionEntry.scope === scope) {
79
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_unsubscribe).call(this, subscriptionEntry);
80
+ }
81
+ });
82
+ }
83
+ unsubscribeByScopeAndOrigin(scope, origin) {
84
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").forEach((subscriptionEntry) => {
85
+ if (subscriptionEntry.scope === scope &&
86
+ subscriptionEntry.origin === origin) {
87
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_unsubscribe).call(this, subscriptionEntry);
88
+ }
89
+ });
90
+ }
91
+ unsubscribeByOriginAndTabId(origin, tabId) {
92
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").forEach((subscriptionEntry) => {
93
+ if (subscriptionEntry.origin === origin &&
94
+ subscriptionEntry.tabId === tabId) {
95
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_unsubscribe).call(this, subscriptionEntry);
96
+ }
97
+ });
98
+ }
99
+ }
100
+ exports.MultichainSubscriptionManager = MultichainSubscriptionManager;
101
+ _MultichainSubscriptionManager_findNetworkClientIdByChainId = new WeakMap(), _MultichainSubscriptionManager_getNetworkClientById = new WeakMap(), _MultichainSubscriptionManager_subscriptions = new WeakMap(), _MultichainSubscriptionManager_instances = new WeakSet(), _MultichainSubscriptionManager_getSubscriptionEntry = function _MultichainSubscriptionManager_getSubscriptionEntry({ scope, origin, tabId, }) {
102
+ return __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").find((subscriptionEntry) => {
103
+ return (subscriptionEntry.scope === scope &&
104
+ subscriptionEntry.origin === origin &&
105
+ subscriptionEntry.tabId === tabId);
106
+ });
107
+ }, _MultichainSubscriptionManager_removeSubscriptionEntry = function _MultichainSubscriptionManager_removeSubscriptionEntry({ scope, origin, tabId }) {
108
+ __classPrivateFieldSet(this, _MultichainSubscriptionManager_subscriptions, __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").filter((subscriptionEntry) => {
109
+ return (subscriptionEntry.scope !== scope ||
110
+ subscriptionEntry.origin !== origin ||
111
+ subscriptionEntry.tabId !== tabId);
112
+ }), "f");
113
+ }, _MultichainSubscriptionManager_unsubscribe = function _MultichainSubscriptionManager_unsubscribe(subscriptionEntry) {
114
+ subscriptionEntry.subscriptionManager.destroy?.();
115
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_removeSubscriptionEntry).call(this, subscriptionEntry);
116
+ };
117
+ //# sourceMappingURL=MultichainSubscriptionManager.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"MultichainSubscriptionManager.cjs","sourceRoot":"","sources":["../../src/middlewares/MultichainSubscriptionManager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AACA,iEAAmD;AACnD,gHAA2F;AAE3F,sFAA4D;AAE5D,2CAAmD;AAiCnD;;;GAGG;AACH,MAAa,6BAA8B,SAAQ,4BAAgB;IAOjE;;;;;;OAMG;IACH,YAAY,OAA6C;QACvD,KAAK,EAAE,CAAC;;QAdD,8EAAiF;QAEjF,sEAAiE;QAE1E,uDAAsC,EAAE,EAAC;QAWvC,uBAAA,IAAI,+DAAiC,OAAO,CAAC,4BAA4B,MAAA,CAAC;QAC1E,uBAAA,IAAI,uDAAyB,OAAO,CAAC,oBAAoB,MAAA,CAAC;IAC5D,CAAC;IAED,MAAM,CACJ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAmB,EACzC,EAAE,MAAM,EAAE,MAAM,EAAiC;QAEjD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE;YACvC,MAAM,EAAE,eAAe;YACvB,MAAM,EAAE;gBACN,KAAK;gBACL,YAAY,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;aACjC;SACF,CAAC,CAAC;IACL,CAAC;IA0BD,SAAS,CAAC,eAAgC;QACxC,MAAM,iBAAiB,GAAG,uBAAA,IAAI,qGAAsB,MAA1B,IAAI,EAAuB,eAAe,CAAC,CAAC;QACtE,IAAI,iBAAiB,EAAE;YACrB,OAAO,iBAAiB,CAAC,mBAAmB,CAAC;SAC9C;QAED,MAAM,eAAe,GAAG,uBAAA,IAAI,mEAA8B,MAAlC,IAAI,EAC1B,IAAA,wBAAK,EAAC,IAAA,wBAAgB,EAAC,eAAe,CAAC,KAAoB,CAAC,CAAC,SAAS,CAAC,CACxE,CAAC;QACF,MAAM,aAAa,GAAG,uBAAA,IAAI,2DAAsB,MAA1B,IAAI,EAAuB,eAAe,CAAC,CAAC;QAClE,MAAM,mBAAmB,GAAG,IAAA,6BAAyB,EAAC;YACpD,YAAY,EAAE,aAAa,CAAC,YAAY;YACxC,QAAQ,EAAE,aAAa,CAAC,QAAQ;SACjC,CAAC,CAAC;QAEH,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAC3B,cAAc,EACd,CAAC,OAAsC,EAAE,EAAE;YACzC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;QACxC,CAAC,CACF,CAAC;QAEF,MAAM,2BAA2B,GAAG;YAClC,GAAG,eAAe;YAClB,mBAAmB;SACpB,CAAC;QACF,mBAAmB,CAAC,OAAO,GAAG,mBAAmB,CAAC,UAAU,CAAC,OAAO,CAAC;QACrE,mBAAmB,CAAC,UAAU,CAAC,OAAO,GAAG,uBAAA,IAAI,4FAAa,CAAC,IAAI,CAC7D,IAAI,EACJ,2BAA2B,CAC5B,CAAC;QAEF,uBAAA,IAAI,oDAAe,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAEtD,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAQD,kBAAkB,CAAC,KAA0B;QAC3C,uBAAA,IAAI,oDAAe,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE;YAChD,IAAI,iBAAiB,CAAC,KAAK,KAAK,KAAK,EAAE;gBACrC,uBAAA,IAAI,4FAAa,MAAjB,IAAI,EAAc,iBAAiB,CAAC,CAAC;aACtC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,2BAA2B,CAAC,KAA0B,EAAE,MAAc;QACpE,uBAAA,IAAI,oDAAe,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE;YAChD,IACE,iBAAiB,CAAC,KAAK,KAAK,KAAK;gBACjC,iBAAiB,CAAC,MAAM,KAAK,MAAM,EACnC;gBACA,uBAAA,IAAI,4FAAa,MAAjB,IAAI,EAAc,iBAAiB,CAAC,CAAC;aACtC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,2BAA2B,CAAC,MAAc,EAAE,KAAc;QACxD,uBAAA,IAAI,oDAAe,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE;YAChD,IACE,iBAAiB,CAAC,MAAM,KAAK,MAAM;gBACnC,iBAAiB,CAAC,KAAK,KAAK,KAAK,EACjC;gBACA,uBAAA,IAAI,4FAAa,MAAjB,IAAI,EAAc,iBAAiB,CAAC,CAAC;aACtC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAjID,sEAiIC;6XAhGuB,EACpB,KAAK,EACL,MAAM,EACN,KAAK,GACW;IAChB,OAAO,uBAAA,IAAI,oDAAe,CAAC,IAAI,CAAC,CAAC,iBAAiB,EAAE,EAAE;QACpD,OAAO,CACL,iBAAiB,CAAC,KAAK,KAAK,KAAK;YACjC,iBAAiB,CAAC,MAAM,KAAK,MAAM;YACnC,iBAAiB,CAAC,KAAK,KAAK,KAAK,CAClC,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,2HAEwB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAqB;IAClE,uBAAA,IAAI,gDAAkB,uBAAA,IAAI,oDAAe,CAAC,MAAM,CAAC,CAAC,iBAAiB,EAAE,EAAE;QACrE,OAAO,CACL,iBAAiB,CAAC,KAAK,KAAK,KAAK;YACjC,iBAAiB,CAAC,MAAM,KAAK,MAAM;YACnC,iBAAiB,CAAC,KAAK,KAAK,KAAK,CAClC,CAAC;IACJ,CAAC,CAAC,MAAA,CAAC;AACL,CAAC,mGAuCY,iBAAoC;IAC/C,iBAAiB,CAAC,mBAAmB,CAAC,OAAO,EAAE,EAAE,CAAC;IAElD,uBAAA,IAAI,wGAAyB,MAA7B,IAAI,EAA0B,iBAAiB,CAAC,CAAC;AACnD,CAAC","sourcesContent":["import type { ExternalScopeString } from '@metamask/chain-agnostic-permission';\nimport { toHex } from '@metamask/controller-utils';\nimport createSubscriptionManager from '@metamask/eth-json-rpc-filters/subscriptionManager';\nimport type { NetworkController } from '@metamask/network-controller';\nimport SafeEventEmitter from '@metamask/safe-event-emitter';\nimport type { CaipChainId, Hex } from '@metamask/utils';\nimport { parseCaipChainId } from '@metamask/utils';\n\nimport type { ExtendedJsonRpcMiddleware } from './MultichainMiddlewareManager';\n\nexport type SubscriptionManager = {\n events: SafeEventEmitter;\n destroy?: () => void;\n middleware: ExtendedJsonRpcMiddleware;\n};\n\ntype SubscriptionNotificationEvent = {\n jsonrpc: '2.0';\n method: 'eth_subscription';\n params: {\n subscription: Hex;\n result: unknown;\n };\n};\n\ntype SubscriptionKey = {\n scope: ExternalScopeString;\n origin: string;\n tabId?: number;\n};\ntype SubscriptionEntry = SubscriptionKey & {\n subscriptionManager: SubscriptionManager;\n};\n\ntype MultichainSubscriptionManagerOptions = {\n findNetworkClientIdByChainId: NetworkController['findNetworkClientIdByChainId'];\n getNetworkClientById: NetworkController['getNetworkClientById'];\n};\n\n/**\n * A helper that facilates the lifecycle of a SubscriptionManager instance that\n * is meant to handle subscriptons for only one specific scope, origin, and tabId combination.\n */\nexport class MultichainSubscriptionManager extends SafeEventEmitter {\n readonly #findNetworkClientIdByChainId: NetworkController['findNetworkClientIdByChainId'];\n\n readonly #getNetworkClientById: NetworkController['getNetworkClientById'];\n\n #subscriptions: SubscriptionEntry[] = [];\n\n /**\n * Construct a MultichainSubscriptionManager.\n *\n * @param options - The controller options.\n * @param options.findNetworkClientIdByChainId - The hook to get the networkClientId from a chainId.\n * @param options.getNetworkClientById - The hook to get the network client instance by its networkClientId.\n */\n constructor(options: MultichainSubscriptionManagerOptions) {\n super();\n this.#findNetworkClientIdByChainId = options.findNetworkClientIdByChainId;\n this.#getNetworkClientById = options.getNetworkClientById;\n }\n\n notify(\n { scope, origin, tabId }: SubscriptionKey,\n { method, params }: SubscriptionNotificationEvent,\n ) {\n this.emit('notification', origin, tabId, {\n method: 'wallet_notify',\n params: {\n scope,\n notification: { method, params },\n },\n });\n }\n\n #getSubscriptionEntry({\n scope,\n origin,\n tabId,\n }: SubscriptionKey): SubscriptionEntry | undefined {\n return this.#subscriptions.find((subscriptionEntry) => {\n return (\n subscriptionEntry.scope === scope &&\n subscriptionEntry.origin === origin &&\n subscriptionEntry.tabId === tabId\n );\n });\n }\n\n #removeSubscriptionEntry({ scope, origin, tabId }: SubscriptionEntry) {\n this.#subscriptions = this.#subscriptions.filter((subscriptionEntry) => {\n return (\n subscriptionEntry.scope !== scope ||\n subscriptionEntry.origin !== origin ||\n subscriptionEntry.tabId !== tabId\n );\n });\n }\n\n subscribe(subscriptionKey: SubscriptionKey) {\n const subscriptionEntry = this.#getSubscriptionEntry(subscriptionKey);\n if (subscriptionEntry) {\n return subscriptionEntry.subscriptionManager;\n }\n\n const networkClientId = this.#findNetworkClientIdByChainId(\n toHex(parseCaipChainId(subscriptionKey.scope as CaipChainId).reference),\n );\n const networkClient = this.#getNetworkClientById(networkClientId);\n const subscriptionManager = createSubscriptionManager({\n blockTracker: networkClient.blockTracker,\n provider: networkClient.provider,\n });\n\n subscriptionManager.events.on(\n 'notification',\n (message: SubscriptionNotificationEvent) => {\n this.notify(subscriptionKey, message);\n },\n );\n\n const newSubscriptionManagerEntry = {\n ...subscriptionKey,\n subscriptionManager,\n };\n subscriptionManager.destroy = subscriptionManager.middleware.destroy;\n subscriptionManager.middleware.destroy = this.#unsubscribe.bind(\n this,\n newSubscriptionManagerEntry,\n );\n\n this.#subscriptions.push(newSubscriptionManagerEntry);\n\n return subscriptionManager;\n }\n\n #unsubscribe(subscriptionEntry: SubscriptionEntry) {\n subscriptionEntry.subscriptionManager.destroy?.();\n\n this.#removeSubscriptionEntry(subscriptionEntry);\n }\n\n unsubscribeByScope(scope: ExternalScopeString) {\n this.#subscriptions.forEach((subscriptionEntry) => {\n if (subscriptionEntry.scope === scope) {\n this.#unsubscribe(subscriptionEntry);\n }\n });\n }\n\n unsubscribeByScopeAndOrigin(scope: ExternalScopeString, origin: string) {\n this.#subscriptions.forEach((subscriptionEntry) => {\n if (\n subscriptionEntry.scope === scope &&\n subscriptionEntry.origin === origin\n ) {\n this.#unsubscribe(subscriptionEntry);\n }\n });\n }\n\n unsubscribeByOriginAndTabId(origin: string, tabId?: number) {\n this.#subscriptions.forEach((subscriptionEntry) => {\n if (\n subscriptionEntry.origin === origin &&\n subscriptionEntry.tabId === tabId\n ) {\n this.#unsubscribe(subscriptionEntry);\n }\n });\n }\n}\n"]}
@@ -0,0 +1,49 @@
1
+ import type { ExternalScopeString } from "@metamask/chain-agnostic-permission";
2
+ import type { NetworkController } from "@metamask/network-controller";
3
+ import SafeEventEmitter from "@metamask/safe-event-emitter";
4
+ import type { Hex } from "@metamask/utils";
5
+ import type { ExtendedJsonRpcMiddleware } from "./MultichainMiddlewareManager.cjs";
6
+ export type SubscriptionManager = {
7
+ events: SafeEventEmitter;
8
+ destroy?: () => void;
9
+ middleware: ExtendedJsonRpcMiddleware;
10
+ };
11
+ type SubscriptionNotificationEvent = {
12
+ jsonrpc: '2.0';
13
+ method: 'eth_subscription';
14
+ params: {
15
+ subscription: Hex;
16
+ result: unknown;
17
+ };
18
+ };
19
+ type SubscriptionKey = {
20
+ scope: ExternalScopeString;
21
+ origin: string;
22
+ tabId?: number;
23
+ };
24
+ type MultichainSubscriptionManagerOptions = {
25
+ findNetworkClientIdByChainId: NetworkController['findNetworkClientIdByChainId'];
26
+ getNetworkClientById: NetworkController['getNetworkClientById'];
27
+ };
28
+ /**
29
+ * A helper that facilates the lifecycle of a SubscriptionManager instance that
30
+ * is meant to handle subscriptons for only one specific scope, origin, and tabId combination.
31
+ */
32
+ export declare class MultichainSubscriptionManager extends SafeEventEmitter {
33
+ #private;
34
+ /**
35
+ * Construct a MultichainSubscriptionManager.
36
+ *
37
+ * @param options - The controller options.
38
+ * @param options.findNetworkClientIdByChainId - The hook to get the networkClientId from a chainId.
39
+ * @param options.getNetworkClientById - The hook to get the network client instance by its networkClientId.
40
+ */
41
+ constructor(options: MultichainSubscriptionManagerOptions);
42
+ notify({ scope, origin, tabId }: SubscriptionKey, { method, params }: SubscriptionNotificationEvent): void;
43
+ subscribe(subscriptionKey: SubscriptionKey): any;
44
+ unsubscribeByScope(scope: ExternalScopeString): void;
45
+ unsubscribeByScopeAndOrigin(scope: ExternalScopeString, origin: string): void;
46
+ unsubscribeByOriginAndTabId(origin: string, tabId?: number): void;
47
+ }
48
+ export {};
49
+ //# sourceMappingURL=MultichainSubscriptionManager.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"MultichainSubscriptionManager.d.cts","sourceRoot":"","sources":["../../src/middlewares/MultichainSubscriptionManager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,4CAA4C;AAG/E,OAAO,KAAK,EAAE,iBAAiB,EAAE,qCAAqC;AACtE,OAAO,gBAAgB,qCAAqC;AAC5D,OAAO,KAAK,EAAe,GAAG,EAAE,wBAAwB;AAGxD,OAAO,KAAK,EAAE,yBAAyB,EAAE,0CAAsC;AAE/E,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,gBAAgB,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB,UAAU,EAAE,yBAAyB,CAAC;CACvC,CAAC;AAEF,KAAK,6BAA6B,GAAG;IACnC,OAAO,EAAE,KAAK,CAAC;IACf,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE;QACN,YAAY,EAAE,GAAG,CAAC;QAClB,MAAM,EAAE,OAAO,CAAC;KACjB,CAAC;CACH,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,KAAK,EAAE,mBAAmB,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAKF,KAAK,oCAAoC,GAAG;IAC1C,4BAA4B,EAAE,iBAAiB,CAAC,8BAA8B,CAAC,CAAC;IAChF,oBAAoB,EAAE,iBAAiB,CAAC,sBAAsB,CAAC,CAAC;CACjE,CAAC;AAEF;;;GAGG;AACH,qBAAa,6BAA8B,SAAQ,gBAAgB;;IAOjE;;;;;;OAMG;gBACS,OAAO,EAAE,oCAAoC;IAMzD,MAAM,CACJ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,eAAe,EACzC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,6BAA6B;IAmCnD,SAAS,CAAC,eAAe,EAAE,eAAe;IA2C1C,kBAAkB,CAAC,KAAK,EAAE,mBAAmB;IAQ7C,2BAA2B,CAAC,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,MAAM;IAWtE,2BAA2B,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;CAU3D"}
@@ -0,0 +1,49 @@
1
+ import type { ExternalScopeString } from "@metamask/chain-agnostic-permission";
2
+ import type { NetworkController } from "@metamask/network-controller";
3
+ import SafeEventEmitter from "@metamask/safe-event-emitter";
4
+ import type { Hex } from "@metamask/utils";
5
+ import type { ExtendedJsonRpcMiddleware } from "./MultichainMiddlewareManager.mjs";
6
+ export type SubscriptionManager = {
7
+ events: SafeEventEmitter;
8
+ destroy?: () => void;
9
+ middleware: ExtendedJsonRpcMiddleware;
10
+ };
11
+ type SubscriptionNotificationEvent = {
12
+ jsonrpc: '2.0';
13
+ method: 'eth_subscription';
14
+ params: {
15
+ subscription: Hex;
16
+ result: unknown;
17
+ };
18
+ };
19
+ type SubscriptionKey = {
20
+ scope: ExternalScopeString;
21
+ origin: string;
22
+ tabId?: number;
23
+ };
24
+ type MultichainSubscriptionManagerOptions = {
25
+ findNetworkClientIdByChainId: NetworkController['findNetworkClientIdByChainId'];
26
+ getNetworkClientById: NetworkController['getNetworkClientById'];
27
+ };
28
+ /**
29
+ * A helper that facilates the lifecycle of a SubscriptionManager instance that
30
+ * is meant to handle subscriptons for only one specific scope, origin, and tabId combination.
31
+ */
32
+ export declare class MultichainSubscriptionManager extends SafeEventEmitter {
33
+ #private;
34
+ /**
35
+ * Construct a MultichainSubscriptionManager.
36
+ *
37
+ * @param options - The controller options.
38
+ * @param options.findNetworkClientIdByChainId - The hook to get the networkClientId from a chainId.
39
+ * @param options.getNetworkClientById - The hook to get the network client instance by its networkClientId.
40
+ */
41
+ constructor(options: MultichainSubscriptionManagerOptions);
42
+ notify({ scope, origin, tabId }: SubscriptionKey, { method, params }: SubscriptionNotificationEvent): void;
43
+ subscribe(subscriptionKey: SubscriptionKey): any;
44
+ unsubscribeByScope(scope: ExternalScopeString): void;
45
+ unsubscribeByScopeAndOrigin(scope: ExternalScopeString, origin: string): void;
46
+ unsubscribeByOriginAndTabId(origin: string, tabId?: number): void;
47
+ }
48
+ export {};
49
+ //# sourceMappingURL=MultichainSubscriptionManager.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"MultichainSubscriptionManager.d.mts","sourceRoot":"","sources":["../../src/middlewares/MultichainSubscriptionManager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,4CAA4C;AAG/E,OAAO,KAAK,EAAE,iBAAiB,EAAE,qCAAqC;AACtE,OAAO,gBAAgB,qCAAqC;AAC5D,OAAO,KAAK,EAAe,GAAG,EAAE,wBAAwB;AAGxD,OAAO,KAAK,EAAE,yBAAyB,EAAE,0CAAsC;AAE/E,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,gBAAgB,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB,UAAU,EAAE,yBAAyB,CAAC;CACvC,CAAC;AAEF,KAAK,6BAA6B,GAAG;IACnC,OAAO,EAAE,KAAK,CAAC;IACf,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE;QACN,YAAY,EAAE,GAAG,CAAC;QAClB,MAAM,EAAE,OAAO,CAAC;KACjB,CAAC;CACH,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,KAAK,EAAE,mBAAmB,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAKF,KAAK,oCAAoC,GAAG;IAC1C,4BAA4B,EAAE,iBAAiB,CAAC,8BAA8B,CAAC,CAAC;IAChF,oBAAoB,EAAE,iBAAiB,CAAC,sBAAsB,CAAC,CAAC;CACjE,CAAC;AAEF;;;GAGG;AACH,qBAAa,6BAA8B,SAAQ,gBAAgB;;IAOjE;;;;;;OAMG;gBACS,OAAO,EAAE,oCAAoC;IAMzD,MAAM,CACJ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,eAAe,EACzC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,6BAA6B;IAmCnD,SAAS,CAAC,eAAe,EAAE,eAAe;IA2C1C,kBAAkB,CAAC,KAAK,EAAE,mBAAmB;IAQ7C,2BAA2B,CAAC,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,MAAM;IAWtE,2BAA2B,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;CAU3D"}
@@ -0,0 +1,117 @@
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 _MultichainSubscriptionManager_instances, _MultichainSubscriptionManager_findNetworkClientIdByChainId, _MultichainSubscriptionManager_getNetworkClientById, _MultichainSubscriptionManager_subscriptions, _MultichainSubscriptionManager_getSubscriptionEntry, _MultichainSubscriptionManager_removeSubscriptionEntry, _MultichainSubscriptionManager_unsubscribe;
13
+ function $importDefault(module) {
14
+ if (module?.__esModule) {
15
+ return module.default;
16
+ }
17
+ return module;
18
+ }
19
+ import { toHex } from "@metamask/controller-utils";
20
+ import $createSubscriptionManager from "@metamask/eth-json-rpc-filters/subscriptionManager.js";
21
+ const createSubscriptionManager = $importDefault($createSubscriptionManager);
22
+ import SafeEventEmitter from "@metamask/safe-event-emitter";
23
+ import { parseCaipChainId } from "@metamask/utils";
24
+ /**
25
+ * A helper that facilates the lifecycle of a SubscriptionManager instance that
26
+ * is meant to handle subscriptons for only one specific scope, origin, and tabId combination.
27
+ */
28
+ export class MultichainSubscriptionManager extends SafeEventEmitter {
29
+ /**
30
+ * Construct a MultichainSubscriptionManager.
31
+ *
32
+ * @param options - The controller options.
33
+ * @param options.findNetworkClientIdByChainId - The hook to get the networkClientId from a chainId.
34
+ * @param options.getNetworkClientById - The hook to get the network client instance by its networkClientId.
35
+ */
36
+ constructor(options) {
37
+ super();
38
+ _MultichainSubscriptionManager_instances.add(this);
39
+ _MultichainSubscriptionManager_findNetworkClientIdByChainId.set(this, void 0);
40
+ _MultichainSubscriptionManager_getNetworkClientById.set(this, void 0);
41
+ _MultichainSubscriptionManager_subscriptions.set(this, []);
42
+ __classPrivateFieldSet(this, _MultichainSubscriptionManager_findNetworkClientIdByChainId, options.findNetworkClientIdByChainId, "f");
43
+ __classPrivateFieldSet(this, _MultichainSubscriptionManager_getNetworkClientById, options.getNetworkClientById, "f");
44
+ }
45
+ notify({ scope, origin, tabId }, { method, params }) {
46
+ this.emit('notification', origin, tabId, {
47
+ method: 'wallet_notify',
48
+ params: {
49
+ scope,
50
+ notification: { method, params },
51
+ },
52
+ });
53
+ }
54
+ subscribe(subscriptionKey) {
55
+ const subscriptionEntry = __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_getSubscriptionEntry).call(this, subscriptionKey);
56
+ if (subscriptionEntry) {
57
+ return subscriptionEntry.subscriptionManager;
58
+ }
59
+ const networkClientId = __classPrivateFieldGet(this, _MultichainSubscriptionManager_findNetworkClientIdByChainId, "f").call(this, toHex(parseCaipChainId(subscriptionKey.scope).reference));
60
+ const networkClient = __classPrivateFieldGet(this, _MultichainSubscriptionManager_getNetworkClientById, "f").call(this, networkClientId);
61
+ const subscriptionManager = createSubscriptionManager({
62
+ blockTracker: networkClient.blockTracker,
63
+ provider: networkClient.provider,
64
+ });
65
+ subscriptionManager.events.on('notification', (message) => {
66
+ this.notify(subscriptionKey, message);
67
+ });
68
+ const newSubscriptionManagerEntry = {
69
+ ...subscriptionKey,
70
+ subscriptionManager,
71
+ };
72
+ subscriptionManager.destroy = subscriptionManager.middleware.destroy;
73
+ subscriptionManager.middleware.destroy = __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_unsubscribe).bind(this, newSubscriptionManagerEntry);
74
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").push(newSubscriptionManagerEntry);
75
+ return subscriptionManager;
76
+ }
77
+ unsubscribeByScope(scope) {
78
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").forEach((subscriptionEntry) => {
79
+ if (subscriptionEntry.scope === scope) {
80
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_unsubscribe).call(this, subscriptionEntry);
81
+ }
82
+ });
83
+ }
84
+ unsubscribeByScopeAndOrigin(scope, origin) {
85
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").forEach((subscriptionEntry) => {
86
+ if (subscriptionEntry.scope === scope &&
87
+ subscriptionEntry.origin === origin) {
88
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_unsubscribe).call(this, subscriptionEntry);
89
+ }
90
+ });
91
+ }
92
+ unsubscribeByOriginAndTabId(origin, tabId) {
93
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").forEach((subscriptionEntry) => {
94
+ if (subscriptionEntry.origin === origin &&
95
+ subscriptionEntry.tabId === tabId) {
96
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_unsubscribe).call(this, subscriptionEntry);
97
+ }
98
+ });
99
+ }
100
+ }
101
+ _MultichainSubscriptionManager_findNetworkClientIdByChainId = new WeakMap(), _MultichainSubscriptionManager_getNetworkClientById = new WeakMap(), _MultichainSubscriptionManager_subscriptions = new WeakMap(), _MultichainSubscriptionManager_instances = new WeakSet(), _MultichainSubscriptionManager_getSubscriptionEntry = function _MultichainSubscriptionManager_getSubscriptionEntry({ scope, origin, tabId, }) {
102
+ return __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").find((subscriptionEntry) => {
103
+ return (subscriptionEntry.scope === scope &&
104
+ subscriptionEntry.origin === origin &&
105
+ subscriptionEntry.tabId === tabId);
106
+ });
107
+ }, _MultichainSubscriptionManager_removeSubscriptionEntry = function _MultichainSubscriptionManager_removeSubscriptionEntry({ scope, origin, tabId }) {
108
+ __classPrivateFieldSet(this, _MultichainSubscriptionManager_subscriptions, __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").filter((subscriptionEntry) => {
109
+ return (subscriptionEntry.scope !== scope ||
110
+ subscriptionEntry.origin !== origin ||
111
+ subscriptionEntry.tabId !== tabId);
112
+ }), "f");
113
+ }, _MultichainSubscriptionManager_unsubscribe = function _MultichainSubscriptionManager_unsubscribe(subscriptionEntry) {
114
+ subscriptionEntry.subscriptionManager.destroy?.();
115
+ __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_removeSubscriptionEntry).call(this, subscriptionEntry);
116
+ };
117
+ //# sourceMappingURL=MultichainSubscriptionManager.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"MultichainSubscriptionManager.mjs","sourceRoot":"","sources":["../../src/middlewares/MultichainSubscriptionManager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,KAAK,EAAE,mCAAmC;AACnD,OAAO,0BAAyB,8DAA2D;;AAE3F,OAAO,gBAAgB,qCAAqC;AAE5D,OAAO,EAAE,gBAAgB,EAAE,wBAAwB;AAiCnD;;;GAGG;AACH,MAAM,OAAO,6BAA8B,SAAQ,gBAAgB;IAOjE;;;;;;OAMG;IACH,YAAY,OAA6C;QACvD,KAAK,EAAE,CAAC;;QAdD,8EAAiF;QAEjF,sEAAiE;QAE1E,uDAAsC,EAAE,EAAC;QAWvC,uBAAA,IAAI,+DAAiC,OAAO,CAAC,4BAA4B,MAAA,CAAC;QAC1E,uBAAA,IAAI,uDAAyB,OAAO,CAAC,oBAAoB,MAAA,CAAC;IAC5D,CAAC;IAED,MAAM,CACJ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAmB,EACzC,EAAE,MAAM,EAAE,MAAM,EAAiC;QAEjD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE;YACvC,MAAM,EAAE,eAAe;YACvB,MAAM,EAAE;gBACN,KAAK;gBACL,YAAY,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;aACjC;SACF,CAAC,CAAC;IACL,CAAC;IA0BD,SAAS,CAAC,eAAgC;QACxC,MAAM,iBAAiB,GAAG,uBAAA,IAAI,qGAAsB,MAA1B,IAAI,EAAuB,eAAe,CAAC,CAAC;QACtE,IAAI,iBAAiB,EAAE;YACrB,OAAO,iBAAiB,CAAC,mBAAmB,CAAC;SAC9C;QAED,MAAM,eAAe,GAAG,uBAAA,IAAI,mEAA8B,MAAlC,IAAI,EAC1B,KAAK,CAAC,gBAAgB,CAAC,eAAe,CAAC,KAAoB,CAAC,CAAC,SAAS,CAAC,CACxE,CAAC;QACF,MAAM,aAAa,GAAG,uBAAA,IAAI,2DAAsB,MAA1B,IAAI,EAAuB,eAAe,CAAC,CAAC;QAClE,MAAM,mBAAmB,GAAG,yBAAyB,CAAC;YACpD,YAAY,EAAE,aAAa,CAAC,YAAY;YACxC,QAAQ,EAAE,aAAa,CAAC,QAAQ;SACjC,CAAC,CAAC;QAEH,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAC3B,cAAc,EACd,CAAC,OAAsC,EAAE,EAAE;YACzC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;QACxC,CAAC,CACF,CAAC;QAEF,MAAM,2BAA2B,GAAG;YAClC,GAAG,eAAe;YAClB,mBAAmB;SACpB,CAAC;QACF,mBAAmB,CAAC,OAAO,GAAG,mBAAmB,CAAC,UAAU,CAAC,OAAO,CAAC;QACrE,mBAAmB,CAAC,UAAU,CAAC,OAAO,GAAG,uBAAA,IAAI,4FAAa,CAAC,IAAI,CAC7D,IAAI,EACJ,2BAA2B,CAC5B,CAAC;QAEF,uBAAA,IAAI,oDAAe,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAEtD,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAQD,kBAAkB,CAAC,KAA0B;QAC3C,uBAAA,IAAI,oDAAe,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE;YAChD,IAAI,iBAAiB,CAAC,KAAK,KAAK,KAAK,EAAE;gBACrC,uBAAA,IAAI,4FAAa,MAAjB,IAAI,EAAc,iBAAiB,CAAC,CAAC;aACtC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,2BAA2B,CAAC,KAA0B,EAAE,MAAc;QACpE,uBAAA,IAAI,oDAAe,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE;YAChD,IACE,iBAAiB,CAAC,KAAK,KAAK,KAAK;gBACjC,iBAAiB,CAAC,MAAM,KAAK,MAAM,EACnC;gBACA,uBAAA,IAAI,4FAAa,MAAjB,IAAI,EAAc,iBAAiB,CAAC,CAAC;aACtC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,2BAA2B,CAAC,MAAc,EAAE,KAAc;QACxD,uBAAA,IAAI,oDAAe,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE;YAChD,IACE,iBAAiB,CAAC,MAAM,KAAK,MAAM;gBACnC,iBAAiB,CAAC,KAAK,KAAK,KAAK,EACjC;gBACA,uBAAA,IAAI,4FAAa,MAAjB,IAAI,EAAc,iBAAiB,CAAC,CAAC;aACtC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;6XAhGuB,EACpB,KAAK,EACL,MAAM,EACN,KAAK,GACW;IAChB,OAAO,uBAAA,IAAI,oDAAe,CAAC,IAAI,CAAC,CAAC,iBAAiB,EAAE,EAAE;QACpD,OAAO,CACL,iBAAiB,CAAC,KAAK,KAAK,KAAK;YACjC,iBAAiB,CAAC,MAAM,KAAK,MAAM;YACnC,iBAAiB,CAAC,KAAK,KAAK,KAAK,CAClC,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,2HAEwB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAqB;IAClE,uBAAA,IAAI,gDAAkB,uBAAA,IAAI,oDAAe,CAAC,MAAM,CAAC,CAAC,iBAAiB,EAAE,EAAE;QACrE,OAAO,CACL,iBAAiB,CAAC,KAAK,KAAK,KAAK;YACjC,iBAAiB,CAAC,MAAM,KAAK,MAAM;YACnC,iBAAiB,CAAC,KAAK,KAAK,KAAK,CAClC,CAAC;IACJ,CAAC,CAAC,MAAA,CAAC;AACL,CAAC,mGAuCY,iBAAoC;IAC/C,iBAAiB,CAAC,mBAAmB,CAAC,OAAO,EAAE,EAAE,CAAC;IAElD,uBAAA,IAAI,wGAAyB,MAA7B,IAAI,EAA0B,iBAAiB,CAAC,CAAC;AACnD,CAAC","sourcesContent":["import type { ExternalScopeString } from '@metamask/chain-agnostic-permission';\nimport { toHex } from '@metamask/controller-utils';\nimport createSubscriptionManager from '@metamask/eth-json-rpc-filters/subscriptionManager';\nimport type { NetworkController } from '@metamask/network-controller';\nimport SafeEventEmitter from '@metamask/safe-event-emitter';\nimport type { CaipChainId, Hex } from '@metamask/utils';\nimport { parseCaipChainId } from '@metamask/utils';\n\nimport type { ExtendedJsonRpcMiddleware } from './MultichainMiddlewareManager';\n\nexport type SubscriptionManager = {\n events: SafeEventEmitter;\n destroy?: () => void;\n middleware: ExtendedJsonRpcMiddleware;\n};\n\ntype SubscriptionNotificationEvent = {\n jsonrpc: '2.0';\n method: 'eth_subscription';\n params: {\n subscription: Hex;\n result: unknown;\n };\n};\n\ntype SubscriptionKey = {\n scope: ExternalScopeString;\n origin: string;\n tabId?: number;\n};\ntype SubscriptionEntry = SubscriptionKey & {\n subscriptionManager: SubscriptionManager;\n};\n\ntype MultichainSubscriptionManagerOptions = {\n findNetworkClientIdByChainId: NetworkController['findNetworkClientIdByChainId'];\n getNetworkClientById: NetworkController['getNetworkClientById'];\n};\n\n/**\n * A helper that facilates the lifecycle of a SubscriptionManager instance that\n * is meant to handle subscriptons for only one specific scope, origin, and tabId combination.\n */\nexport class MultichainSubscriptionManager extends SafeEventEmitter {\n readonly #findNetworkClientIdByChainId: NetworkController['findNetworkClientIdByChainId'];\n\n readonly #getNetworkClientById: NetworkController['getNetworkClientById'];\n\n #subscriptions: SubscriptionEntry[] = [];\n\n /**\n * Construct a MultichainSubscriptionManager.\n *\n * @param options - The controller options.\n * @param options.findNetworkClientIdByChainId - The hook to get the networkClientId from a chainId.\n * @param options.getNetworkClientById - The hook to get the network client instance by its networkClientId.\n */\n constructor(options: MultichainSubscriptionManagerOptions) {\n super();\n this.#findNetworkClientIdByChainId = options.findNetworkClientIdByChainId;\n this.#getNetworkClientById = options.getNetworkClientById;\n }\n\n notify(\n { scope, origin, tabId }: SubscriptionKey,\n { method, params }: SubscriptionNotificationEvent,\n ) {\n this.emit('notification', origin, tabId, {\n method: 'wallet_notify',\n params: {\n scope,\n notification: { method, params },\n },\n });\n }\n\n #getSubscriptionEntry({\n scope,\n origin,\n tabId,\n }: SubscriptionKey): SubscriptionEntry | undefined {\n return this.#subscriptions.find((subscriptionEntry) => {\n return (\n subscriptionEntry.scope === scope &&\n subscriptionEntry.origin === origin &&\n subscriptionEntry.tabId === tabId\n );\n });\n }\n\n #removeSubscriptionEntry({ scope, origin, tabId }: SubscriptionEntry) {\n this.#subscriptions = this.#subscriptions.filter((subscriptionEntry) => {\n return (\n subscriptionEntry.scope !== scope ||\n subscriptionEntry.origin !== origin ||\n subscriptionEntry.tabId !== tabId\n );\n });\n }\n\n subscribe(subscriptionKey: SubscriptionKey) {\n const subscriptionEntry = this.#getSubscriptionEntry(subscriptionKey);\n if (subscriptionEntry) {\n return subscriptionEntry.subscriptionManager;\n }\n\n const networkClientId = this.#findNetworkClientIdByChainId(\n toHex(parseCaipChainId(subscriptionKey.scope as CaipChainId).reference),\n );\n const networkClient = this.#getNetworkClientById(networkClientId);\n const subscriptionManager = createSubscriptionManager({\n blockTracker: networkClient.blockTracker,\n provider: networkClient.provider,\n });\n\n subscriptionManager.events.on(\n 'notification',\n (message: SubscriptionNotificationEvent) => {\n this.notify(subscriptionKey, message);\n },\n );\n\n const newSubscriptionManagerEntry = {\n ...subscriptionKey,\n subscriptionManager,\n };\n subscriptionManager.destroy = subscriptionManager.middleware.destroy;\n subscriptionManager.middleware.destroy = this.#unsubscribe.bind(\n this,\n newSubscriptionManagerEntry,\n );\n\n this.#subscriptions.push(newSubscriptionManagerEntry);\n\n return subscriptionManager;\n }\n\n #unsubscribe(subscriptionEntry: SubscriptionEntry) {\n subscriptionEntry.subscriptionManager.destroy?.();\n\n this.#removeSubscriptionEntry(subscriptionEntry);\n }\n\n unsubscribeByScope(scope: ExternalScopeString) {\n this.#subscriptions.forEach((subscriptionEntry) => {\n if (subscriptionEntry.scope === scope) {\n this.#unsubscribe(subscriptionEntry);\n }\n });\n }\n\n unsubscribeByScopeAndOrigin(scope: ExternalScopeString, origin: string) {\n this.#subscriptions.forEach((subscriptionEntry) => {\n if (\n subscriptionEntry.scope === scope &&\n subscriptionEntry.origin === origin\n ) {\n this.#unsubscribe(subscriptionEntry);\n }\n });\n }\n\n unsubscribeByOriginAndTabId(origin: string, tabId?: number) {\n this.#subscriptions.forEach((subscriptionEntry) => {\n if (\n subscriptionEntry.origin === origin &&\n subscriptionEntry.tabId === tabId\n ) {\n this.#unsubscribe(subscriptionEntry);\n }\n });\n }\n}\n"]}
@@ -0,0 +1,74 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.multichainMethodCallValidatorMiddleware = void 0;
7
+ const api_specs_1 = require("@metamask/api-specs");
8
+ const json_rpc_engine_1 = require("@metamask/json-rpc-engine");
9
+ const rpc_errors_1 = require("@metamask/rpc-errors");
10
+ const utils_1 = require("@metamask/utils");
11
+ const dereference_document_1 = __importDefault(require("@open-rpc/schema-utils-js/build/dereference-document.js"));
12
+ const parse_open_rpc_document_1 = require("@open-rpc/schema-utils-js/build/parse-open-rpc-document.js");
13
+ const jsonschema_1 = require("jsonschema");
14
+ const transformError = (error, param, got) => {
15
+ // if there is a path, add it to the message
16
+ const message = `${param.name}${error.path.length > 0 ? `.${error.path.join('.')}` : ''} ${error.message}`;
17
+ return rpc_errors_1.rpcErrors.invalidParams({
18
+ message,
19
+ data: {
20
+ param: param.name,
21
+ path: error.path,
22
+ schema: error.schema,
23
+ got,
24
+ },
25
+ });
26
+ };
27
+ const v = new jsonschema_1.Validator();
28
+ const dereffedPromise = (0, dereference_document_1.default)(api_specs_1.MultiChainOpenRPCDocument, (0, parse_open_rpc_document_1.makeCustomResolver)({}));
29
+ /**
30
+ * Helper that utilizes the Multichain method specifications from `@metamask/api-specs`
31
+ * to validate the params of a Multichain request.
32
+ *
33
+ * @param method - The request's method.
34
+ * @param params - The request's optional JsonRpcParams object.
35
+ * @returns an array of error objects for each validation error or an empty array if no errors.
36
+ */
37
+ const multichainMethodCallValidator = async (method, params) => {
38
+ const dereffed = await dereffedPromise;
39
+ const methodToCheck = dereffed.methods.find((m) => m.name === method);
40
+ if (!methodToCheck ||
41
+ !(0, utils_1.isObject)(methodToCheck) ||
42
+ !('params' in methodToCheck)) {
43
+ return [rpc_errors_1.rpcErrors.methodNotFound({ data: { method } })];
44
+ }
45
+ const errors = [];
46
+ for (const param of methodToCheck.params) {
47
+ if (!(0, utils_1.isObject)(params)) {
48
+ return [rpc_errors_1.rpcErrors.invalidParams()];
49
+ }
50
+ const p = param;
51
+ const paramToCheck = params[p.name];
52
+ const result = v.validate(paramToCheck, p.schema, {
53
+ required: p.required,
54
+ });
55
+ if (result.errors) {
56
+ errors.push(...result.errors.map((e) => {
57
+ return transformError(e, p, paramToCheck);
58
+ }));
59
+ }
60
+ }
61
+ return errors;
62
+ };
63
+ /**
64
+ * Middleware that validates the params of a Multichain method request
65
+ * using the specifications from `@metamask/api-specs`.
66
+ */
67
+ exports.multichainMethodCallValidatorMiddleware = (0, json_rpc_engine_1.createAsyncMiddleware)(async (request, _response, next) => {
68
+ const errors = await multichainMethodCallValidator(request.method, request.params);
69
+ if (errors.length > 0) {
70
+ throw rpc_errors_1.rpcErrors.invalidParams({ data: errors });
71
+ }
72
+ return await next();
73
+ });
74
+ //# sourceMappingURL=multichainMethodCallValidatorMiddleware.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"multichainMethodCallValidatorMiddleware.cjs","sourceRoot":"","sources":["../../src/middlewares/multichainMethodCallValidatorMiddleware.ts"],"names":[],"mappings":";;;;;;AAAA,mDAAgE;AAChE,+DAAkE;AAClE,qDAAiD;AACjD,2CAA2C;AAQ3C,mHAAuF;AACvF,wGAA6F;AAE7F,2CAAuC;AAEvC,MAAM,cAAc,GAAG,CACrB,KAAsB,EACtB,KAA8B,EAC9B,GAAY,EACZ,EAAE;IACF,4CAA4C;IAC5C,MAAM,OAAO,GAAG,GAAG,KAAK,CAAC,IAAI,GAC3B,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EACvD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;IAEpB,OAAO,sBAAS,CAAC,aAAa,CAAC;QAC7B,OAAO;QACP,IAAI,EAAE;YACJ,KAAK,EAAE,KAAK,CAAC,IAAI;YACjB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,GAAG;SACJ;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,GAAG,IAAI,sBAAS,EAAE,CAAC;AAE1B,MAAM,eAAe,GAAG,IAAA,8BAAmB,EACzC,qCAAuD,EACvD,IAAA,4CAAkB,EAAC,EAAE,CAAC,CACvB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,6BAA6B,GAAG,KAAK,EACzC,MAAc,EACd,MAAiC,EACjC,EAAE;IACF,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC;IAEvC,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CACzC,CAAC,CAAiC,EAAE,EAAE,CAAE,CAAkB,CAAC,IAAI,KAAK,MAAM,CAC/C,CAAC;IAE9B,IACE,CAAC,aAAa;QACd,CAAC,IAAA,gBAAQ,EAAC,aAAa,CAAC;QACxB,CAAC,CAAC,QAAQ,IAAI,aAAa,CAAC,EAC5B;QACA,OAAO,CAAC,sBAAS,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAmB,CAAC;KAC3E;IAED,MAAM,MAAM,GAAmB,EAAE,CAAC;IAClC,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,MAAM,EAAE;QACxC,IAAI,CAAC,IAAA,gBAAQ,EAAC,MAAM,CAAC,EAAE;YACrB,OAAO,CAAC,sBAAS,CAAC,aAAa,EAAE,CAAmB,CAAC;SACtD;QACD,MAAM,CAAC,GAAG,KAAgC,CAAC;QAC3C,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAEpC,MAAM,MAAM,GAAG,CAAC,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,MAA2B,EAAE;YACrE,QAAQ,EAAE,CAAC,CAAC,QAAQ;SACrB,CAAC,CAAC;QACH,IAAI,MAAM,CAAC,MAAM,EAAE;YACjB,MAAM,CAAC,IAAI,CACT,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBACzB,OAAO,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,YAAY,CAAiB,CAAC;YAC5D,CAAC,CAAC,CACH,CAAC;SACH;KACF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;GAGG;AACU,QAAA,uCAAuC,GAAG,IAAA,uCAAqB,EAC1E,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IACjC,MAAM,MAAM,GAAG,MAAM,6BAA6B,CAChD,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,MAAM,CACf,CAAC;IACF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACrB,MAAM,sBAAS,CAAC,aAAa,CAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;KACjE;IACD,OAAO,MAAM,IAAI,EAAE,CAAC;AACtB,CAAC,CACF,CAAC","sourcesContent":["import { MultiChainOpenRPCDocument } from '@metamask/api-specs';\nimport { createAsyncMiddleware } from '@metamask/json-rpc-engine';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { isObject } from '@metamask/utils';\nimport type { JsonRpcError, JsonRpcParams } from '@metamask/utils';\nimport type {\n ContentDescriptorObject,\n MethodObject,\n OpenrpcDocument,\n ReferenceObject,\n} from '@open-rpc/meta-schema';\nimport dereferenceDocument from '@open-rpc/schema-utils-js/build/dereference-document';\nimport { makeCustomResolver } from '@open-rpc/schema-utils-js/build/parse-open-rpc-document';\nimport type { Schema, ValidationError } from 'jsonschema';\nimport { Validator } from 'jsonschema';\n\nconst transformError = (\n error: ValidationError,\n param: ContentDescriptorObject,\n got: unknown,\n) => {\n // if there is a path, add it to the message\n const message = `${param.name}${\n error.path.length > 0 ? `.${error.path.join('.')}` : ''\n } ${error.message}`;\n\n return rpcErrors.invalidParams({\n message,\n data: {\n param: param.name,\n path: error.path,\n schema: error.schema,\n got,\n },\n });\n};\n\nconst v = new Validator();\n\nconst dereffedPromise = dereferenceDocument(\n MultiChainOpenRPCDocument as unknown as OpenrpcDocument,\n makeCustomResolver({}),\n);\n\n/**\n * Helper that utilizes the Multichain method specifications from `@metamask/api-specs`\n * to validate the params of a Multichain request.\n *\n * @param method - The request's method.\n * @param params - The request's optional JsonRpcParams object.\n * @returns an array of error objects for each validation error or an empty array if no errors.\n */\nconst multichainMethodCallValidator = async (\n method: string,\n params: JsonRpcParams | undefined,\n) => {\n const dereffed = await dereffedPromise;\n\n const methodToCheck = dereffed.methods.find(\n (m: MethodObject | ReferenceObject) => (m as MethodObject).name === method,\n ) as MethodObject | undefined;\n\n if (\n !methodToCheck ||\n !isObject(methodToCheck) ||\n !('params' in methodToCheck)\n ) {\n return [rpcErrors.methodNotFound({ data: { method } })] as JsonRpcError[];\n }\n\n const errors: JsonRpcError[] = [];\n for (const param of methodToCheck.params) {\n if (!isObject(params)) {\n return [rpcErrors.invalidParams()] as JsonRpcError[];\n }\n const p = param as ContentDescriptorObject;\n const paramToCheck = params[p.name];\n\n const result = v.validate(paramToCheck, p.schema as unknown as Schema, {\n required: p.required,\n });\n if (result.errors) {\n errors.push(\n ...result.errors.map((e) => {\n return transformError(e, p, paramToCheck) as JsonRpcError;\n }),\n );\n }\n }\n return errors;\n};\n\n/**\n * Middleware that validates the params of a Multichain method request\n * using the specifications from `@metamask/api-specs`.\n */\nexport const multichainMethodCallValidatorMiddleware = createAsyncMiddleware(\n async (request, _response, next) => {\n const errors = await multichainMethodCallValidator(\n request.method,\n request.params,\n );\n if (errors.length > 0) {\n throw rpcErrors.invalidParams<JsonRpcError[]>({ data: errors });\n }\n return await next();\n },\n);\n"]}
@@ -0,0 +1,7 @@
1
+ import type { JsonRpcParams } from "@metamask/utils";
2
+ /**
3
+ * Middleware that validates the params of a Multichain method request
4
+ * using the specifications from `@metamask/api-specs`.
5
+ */
6
+ export declare const multichainMethodCallValidatorMiddleware: import("@metamask/json-rpc-engine").JsonRpcMiddleware<JsonRpcParams, import("@metamask/utils").Json>;
7
+ //# sourceMappingURL=multichainMethodCallValidatorMiddleware.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"multichainMethodCallValidatorMiddleware.d.cts","sourceRoot":"","sources":["../../src/middlewares/multichainMethodCallValidatorMiddleware.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAgB,aAAa,EAAE,wBAAwB;AAwFnE;;;GAGG;AACH,eAAO,MAAM,uCAAuC,sGAWnD,CAAC"}
@@ -0,0 +1,7 @@
1
+ import type { JsonRpcParams } from "@metamask/utils";
2
+ /**
3
+ * Middleware that validates the params of a Multichain method request
4
+ * using the specifications from `@metamask/api-specs`.
5
+ */
6
+ export declare const multichainMethodCallValidatorMiddleware: import("@metamask/json-rpc-engine").JsonRpcMiddleware<JsonRpcParams, import("@metamask/utils").Json>;
7
+ //# sourceMappingURL=multichainMethodCallValidatorMiddleware.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"multichainMethodCallValidatorMiddleware.d.mts","sourceRoot":"","sources":["../../src/middlewares/multichainMethodCallValidatorMiddleware.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAgB,aAAa,EAAE,wBAAwB;AAwFnE;;;GAGG;AACH,eAAO,MAAM,uCAAuC,sGAWnD,CAAC"}
@@ -0,0 +1,75 @@
1
+ function $importDefault(module) {
2
+ if (module?.__esModule) {
3
+ return module.default;
4
+ }
5
+ return module;
6
+ }
7
+ import { MultiChainOpenRPCDocument } from "@metamask/api-specs";
8
+ import { createAsyncMiddleware } from "@metamask/json-rpc-engine";
9
+ import { rpcErrors } from "@metamask/rpc-errors";
10
+ import { isObject } from "@metamask/utils";
11
+ import $dereferenceDocument from "@open-rpc/schema-utils-js/build/dereference-document.js";
12
+ const dereferenceDocument = $importDefault($dereferenceDocument);
13
+ import { makeCustomResolver } from "@open-rpc/schema-utils-js/build/parse-open-rpc-document.js";
14
+ import { Validator } from "jsonschema";
15
+ const transformError = (error, param, got) => {
16
+ // if there is a path, add it to the message
17
+ const message = `${param.name}${error.path.length > 0 ? `.${error.path.join('.')}` : ''} ${error.message}`;
18
+ return rpcErrors.invalidParams({
19
+ message,
20
+ data: {
21
+ param: param.name,
22
+ path: error.path,
23
+ schema: error.schema,
24
+ got,
25
+ },
26
+ });
27
+ };
28
+ const v = new Validator();
29
+ const dereffedPromise = dereferenceDocument(MultiChainOpenRPCDocument, makeCustomResolver({}));
30
+ /**
31
+ * Helper that utilizes the Multichain method specifications from `@metamask/api-specs`
32
+ * to validate the params of a Multichain request.
33
+ *
34
+ * @param method - The request's method.
35
+ * @param params - The request's optional JsonRpcParams object.
36
+ * @returns an array of error objects for each validation error or an empty array if no errors.
37
+ */
38
+ const multichainMethodCallValidator = async (method, params) => {
39
+ const dereffed = await dereffedPromise;
40
+ const methodToCheck = dereffed.methods.find((m) => m.name === method);
41
+ if (!methodToCheck ||
42
+ !isObject(methodToCheck) ||
43
+ !('params' in methodToCheck)) {
44
+ return [rpcErrors.methodNotFound({ data: { method } })];
45
+ }
46
+ const errors = [];
47
+ for (const param of methodToCheck.params) {
48
+ if (!isObject(params)) {
49
+ return [rpcErrors.invalidParams()];
50
+ }
51
+ const p = param;
52
+ const paramToCheck = params[p.name];
53
+ const result = v.validate(paramToCheck, p.schema, {
54
+ required: p.required,
55
+ });
56
+ if (result.errors) {
57
+ errors.push(...result.errors.map((e) => {
58
+ return transformError(e, p, paramToCheck);
59
+ }));
60
+ }
61
+ }
62
+ return errors;
63
+ };
64
+ /**
65
+ * Middleware that validates the params of a Multichain method request
66
+ * using the specifications from `@metamask/api-specs`.
67
+ */
68
+ export const multichainMethodCallValidatorMiddleware = createAsyncMiddleware(async (request, _response, next) => {
69
+ const errors = await multichainMethodCallValidator(request.method, request.params);
70
+ if (errors.length > 0) {
71
+ throw rpcErrors.invalidParams({ data: errors });
72
+ }
73
+ return await next();
74
+ });
75
+ //# sourceMappingURL=multichainMethodCallValidatorMiddleware.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"multichainMethodCallValidatorMiddleware.mjs","sourceRoot":"","sources":["../../src/middlewares/multichainMethodCallValidatorMiddleware.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,yBAAyB,EAAE,4BAA4B;AAChE,OAAO,EAAE,qBAAqB,EAAE,kCAAkC;AAClE,OAAO,EAAE,SAAS,EAAE,6BAA6B;AACjD,OAAO,EAAE,QAAQ,EAAE,wBAAwB;AAQ3C,OAAO,oBAAmB,gEAA6D;;AACvF,OAAO,EAAE,kBAAkB,EAAE,mEAAgE;AAE7F,OAAO,EAAE,SAAS,EAAE,mBAAmB;AAEvC,MAAM,cAAc,GAAG,CACrB,KAAsB,EACtB,KAA8B,EAC9B,GAAY,EACZ,EAAE;IACF,4CAA4C;IAC5C,MAAM,OAAO,GAAG,GAAG,KAAK,CAAC,IAAI,GAC3B,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EACvD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;IAEpB,OAAO,SAAS,CAAC,aAAa,CAAC;QAC7B,OAAO;QACP,IAAI,EAAE;YACJ,KAAK,EAAE,KAAK,CAAC,IAAI;YACjB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,GAAG;SACJ;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,GAAG,IAAI,SAAS,EAAE,CAAC;AAE1B,MAAM,eAAe,GAAG,mBAAmB,CACzC,yBAAuD,EACvD,kBAAkB,CAAC,EAAE,CAAC,CACvB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,6BAA6B,GAAG,KAAK,EACzC,MAAc,EACd,MAAiC,EACjC,EAAE;IACF,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC;IAEvC,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CACzC,CAAC,CAAiC,EAAE,EAAE,CAAE,CAAkB,CAAC,IAAI,KAAK,MAAM,CAC/C,CAAC;IAE9B,IACE,CAAC,aAAa;QACd,CAAC,QAAQ,CAAC,aAAa,CAAC;QACxB,CAAC,CAAC,QAAQ,IAAI,aAAa,CAAC,EAC5B;QACA,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAmB,CAAC;KAC3E;IAED,MAAM,MAAM,GAAmB,EAAE,CAAC;IAClC,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,MAAM,EAAE;QACxC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YACrB,OAAO,CAAC,SAAS,CAAC,aAAa,EAAE,CAAmB,CAAC;SACtD;QACD,MAAM,CAAC,GAAG,KAAgC,CAAC;QAC3C,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAEpC,MAAM,MAAM,GAAG,CAAC,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,MAA2B,EAAE;YACrE,QAAQ,EAAE,CAAC,CAAC,QAAQ;SACrB,CAAC,CAAC;QACH,IAAI,MAAM,CAAC,MAAM,EAAE;YACjB,MAAM,CAAC,IAAI,CACT,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBACzB,OAAO,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,YAAY,CAAiB,CAAC;YAC5D,CAAC,CAAC,CACH,CAAC;SACH;KACF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAAG,qBAAqB,CAC1E,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IACjC,MAAM,MAAM,GAAG,MAAM,6BAA6B,CAChD,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,MAAM,CACf,CAAC;IACF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACrB,MAAM,SAAS,CAAC,aAAa,CAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;KACjE;IACD,OAAO,MAAM,IAAI,EAAE,CAAC;AACtB,CAAC,CACF,CAAC","sourcesContent":["import { MultiChainOpenRPCDocument } from '@metamask/api-specs';\nimport { createAsyncMiddleware } from '@metamask/json-rpc-engine';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { isObject } from '@metamask/utils';\nimport type { JsonRpcError, JsonRpcParams } from '@metamask/utils';\nimport type {\n ContentDescriptorObject,\n MethodObject,\n OpenrpcDocument,\n ReferenceObject,\n} from '@open-rpc/meta-schema';\nimport dereferenceDocument from '@open-rpc/schema-utils-js/build/dereference-document';\nimport { makeCustomResolver } from '@open-rpc/schema-utils-js/build/parse-open-rpc-document';\nimport type { Schema, ValidationError } from 'jsonschema';\nimport { Validator } from 'jsonschema';\n\nconst transformError = (\n error: ValidationError,\n param: ContentDescriptorObject,\n got: unknown,\n) => {\n // if there is a path, add it to the message\n const message = `${param.name}${\n error.path.length > 0 ? `.${error.path.join('.')}` : ''\n } ${error.message}`;\n\n return rpcErrors.invalidParams({\n message,\n data: {\n param: param.name,\n path: error.path,\n schema: error.schema,\n got,\n },\n });\n};\n\nconst v = new Validator();\n\nconst dereffedPromise = dereferenceDocument(\n MultiChainOpenRPCDocument as unknown as OpenrpcDocument,\n makeCustomResolver({}),\n);\n\n/**\n * Helper that utilizes the Multichain method specifications from `@metamask/api-specs`\n * to validate the params of a Multichain request.\n *\n * @param method - The request's method.\n * @param params - The request's optional JsonRpcParams object.\n * @returns an array of error objects for each validation error or an empty array if no errors.\n */\nconst multichainMethodCallValidator = async (\n method: string,\n params: JsonRpcParams | undefined,\n) => {\n const dereffed = await dereffedPromise;\n\n const methodToCheck = dereffed.methods.find(\n (m: MethodObject | ReferenceObject) => (m as MethodObject).name === method,\n ) as MethodObject | undefined;\n\n if (\n !methodToCheck ||\n !isObject(methodToCheck) ||\n !('params' in methodToCheck)\n ) {\n return [rpcErrors.methodNotFound({ data: { method } })] as JsonRpcError[];\n }\n\n const errors: JsonRpcError[] = [];\n for (const param of methodToCheck.params) {\n if (!isObject(params)) {\n return [rpcErrors.invalidParams()] as JsonRpcError[];\n }\n const p = param as ContentDescriptorObject;\n const paramToCheck = params[p.name];\n\n const result = v.validate(paramToCheck, p.schema as unknown as Schema, {\n required: p.required,\n });\n if (result.errors) {\n errors.push(\n ...result.errors.map((e) => {\n return transformError(e, p, paramToCheck) as JsonRpcError;\n }),\n );\n }\n }\n return errors;\n};\n\n/**\n * Middleware that validates the params of a Multichain method request\n * using the specifications from `@metamask/api-specs`.\n */\nexport const multichainMethodCallValidatorMiddleware = createAsyncMiddleware(\n async (request, _response, next) => {\n const errors = await multichainMethodCallValidator(\n request.method,\n request.params,\n );\n if (errors.length > 0) {\n throw rpcErrors.invalidParams<JsonRpcError[]>({ data: errors });\n }\n return await next();\n },\n);\n"]}