@metamask/multichain-api-middleware 0.1.0

package/dist/handlers/wallet-revokeSession.cjs

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.walletRevokeSession = void 0;
+const chain_agnostic_permission_1 = require("@metamask/chain-agnostic-permission");
+const permission_controller_1 = require("@metamask/permission-controller");
+const rpc_errors_1 = require("@metamask/rpc-errors");
+/**
+ * Handler for the `wallet_revokeSession` RPC method as specified by [CAIP-285](https://chainagnostic.org/CAIPs/caip-285).
+ * The implementation below deviates from the linked spec in that it ignores the `sessionId` param
+ * and instead revokes the singular session for the origin if available. Additionally,
+ * the handler also does not return an error if there is currently no active session and instead
+ * returns true which is the same result returned if an active session was actually revoked.
+ *
+ * @param _request - The JSON-RPC request object. Unused.
+ * @param response - The JSON-RPC response object.
+ * @param _next - The next middleware function. Unused.
+ * @param end - The end callback function.
+ * @param hooks - The hooks object.
+ * @param hooks.revokePermissionForOrigin - The hook for revoking a permission for an origin function.
+ * @returns Nothing.
+ */
+async function walletRevokeSessionHandler(_request, response, _next, end, hooks) {
+    try {
+        hooks.revokePermissionForOrigin(chain_agnostic_permission_1.Caip25EndowmentPermissionName);
+    }
+    catch (err) {
+        if (!(err instanceof permission_controller_1.UnrecognizedSubjectError) &&
+            !(err instanceof permission_controller_1.PermissionDoesNotExistError)) {
+            console.error(err);
+            return end(rpc_errors_1.rpcErrors.internal());
+        }
+    }
+    response.result = true;
+    return end();
+}
+exports.walletRevokeSession = {
+    methodNames: ['wallet_revokeSession'],
+    implementation: walletRevokeSessionHandler,
+    hookNames: {
+        revokePermissionForOrigin: true,
+    },
+};
+//# sourceMappingURL=wallet-revokeSession.cjs.map

package/dist/handlers/wallet-revokeSession.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet-revokeSession.cjs","sourceRoot":"","sources":["../../src/handlers/wallet-revokeSession.ts"],"names":[],"mappings":";;;AAAA,mFAAoF;AAKpF,2EAGyC;AACzC,qDAAiD;AAGjD;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,0BAA0B,CACvC,QAA6C,EAC7C,QAA8B,EAC9B,KAAgC,EAChC,GAA6B,EAC7B,KAEC;IAED,IAAI;QACF,KAAK,CAAC,yBAAyB,CAAC,yDAA6B,CAAC,CAAC;KAChE;IAAC,OAAO,GAAG,EAAE;QACZ,IACE,CAAC,CAAC,GAAG,YAAY,gDAAwB,CAAC;YAC1C,CAAC,CAAC,GAAG,YAAY,mDAA2B,CAAC,EAC7C;YACA,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnB,OAAO,GAAG,CAAC,sBAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;SAClC;KACF;IAED,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AACY,QAAA,mBAAmB,GAAG;IACjC,WAAW,EAAE,CAAC,sBAAsB,CAAC;IACrC,cAAc,EAAE,0BAA0B;IAC1C,SAAS,EAAE;QACT,yBAAyB,EAAE,IAAI;KAChC;CACF,CAAC","sourcesContent":["import { Caip25EndowmentPermissionName } from '@metamask/chain-agnostic-permission';\nimport type {\n  JsonRpcEngineNextCallback,\n  JsonRpcEngineEndCallback,\n} from '@metamask/json-rpc-engine';\nimport {\n  PermissionDoesNotExistError,\n  UnrecognizedSubjectError,\n} from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { JsonRpcSuccess, Json, JsonRpcRequest } from '@metamask/utils';\n\n/**\n * Handler for the `wallet_revokeSession` RPC method as specified by [CAIP-285](https://chainagnostic.org/CAIPs/caip-285).\n * The implementation below deviates from the linked spec in that it ignores the `sessionId` param\n * and instead revokes the singular session for the origin if available. Additionally,\n * the handler also does not return an error if there is currently no active session and instead\n * returns true which is the same result returned if an active session was actually revoked.\n *\n * @param _request - The JSON-RPC request object. Unused.\n * @param response - The JSON-RPC response object.\n * @param _next - The next middleware function. Unused.\n * @param end - The end callback function.\n * @param hooks - The hooks object.\n * @param hooks.revokePermissionForOrigin - The hook for revoking a permission for an origin function.\n * @returns Nothing.\n */\nasync function walletRevokeSessionHandler(\n  _request: JsonRpcRequest & { origin: string },\n  response: JsonRpcSuccess<Json>,\n  _next: JsonRpcEngineNextCallback,\n  end: JsonRpcEngineEndCallback,\n  hooks: {\n    revokePermissionForOrigin: (permissionName: string) => void;\n  },\n) {\n  try {\n    hooks.revokePermissionForOrigin(Caip25EndowmentPermissionName);\n  } catch (err) {\n    if (\n      !(err instanceof UnrecognizedSubjectError) &&\n      !(err instanceof PermissionDoesNotExistError)\n    ) {\n      console.error(err);\n      return end(rpcErrors.internal());\n    }\n  }\n\n  response.result = true;\n  return end();\n}\nexport const walletRevokeSession = {\n  methodNames: ['wallet_revokeSession'],\n  implementation: walletRevokeSessionHandler,\n  hookNames: {\n    revokePermissionForOrigin: true,\n  },\n};\n"]}

package/dist/handlers/wallet-revokeSession.d.cts

@@ -0,0 +1,31 @@
+import type { JsonRpcEngineNextCallback, JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { JsonRpcSuccess, Json, JsonRpcRequest } from "@metamask/utils";
+/**
+ * Handler for the `wallet_revokeSession` RPC method as specified by [CAIP-285](https://chainagnostic.org/CAIPs/caip-285).
+ * The implementation below deviates from the linked spec in that it ignores the `sessionId` param
+ * and instead revokes the singular session for the origin if available. Additionally,
+ * the handler also does not return an error if there is currently no active session and instead
+ * returns true which is the same result returned if an active session was actually revoked.
+ *
+ * @param _request - The JSON-RPC request object. Unused.
+ * @param response - The JSON-RPC response object.
+ * @param _next - The next middleware function. Unused.
+ * @param end - The end callback function.
+ * @param hooks - The hooks object.
+ * @param hooks.revokePermissionForOrigin - The hook for revoking a permission for an origin function.
+ * @returns Nothing.
+ */
+declare function walletRevokeSessionHandler(_request: JsonRpcRequest & {
+    origin: string;
+}, response: JsonRpcSuccess<Json>, _next: JsonRpcEngineNextCallback, end: JsonRpcEngineEndCallback, hooks: {
+    revokePermissionForOrigin: (permissionName: string) => void;
+}): Promise<void>;
+export declare const walletRevokeSession: {
+    methodNames: string[];
+    implementation: typeof walletRevokeSessionHandler;
+    hookNames: {
+        revokePermissionForOrigin: boolean;
+    };
+};
+export {};
+//# sourceMappingURL=wallet-revokeSession.d.cts.map

package/dist/handlers/wallet-revokeSession.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet-revokeSession.d.cts","sourceRoot":"","sources":["../../src/handlers/wallet-revokeSession.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,yBAAyB,EACzB,wBAAwB,EACzB,kCAAkC;AAMnC,OAAO,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,cAAc,EAAE,wBAAwB;AAE5E;;;;;;;;;;;;;;GAcG;AACH,iBAAe,0BAA0B,CACvC,QAAQ,EAAE,cAAc,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,EAC7C,QAAQ,EAAE,cAAc,CAAC,IAAI,CAAC,EAC9B,KAAK,EAAE,yBAAyB,EAChC,GAAG,EAAE,wBAAwB,EAC7B,KAAK,EAAE;IACL,yBAAyB,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,IAAI,CAAC;CAC7D,iBAgBF;AACD,eAAO,MAAM,mBAAmB;;;;;;CAM/B,CAAC"}

package/dist/handlers/wallet-revokeSession.d.mts

@@ -0,0 +1,31 @@
+import type { JsonRpcEngineNextCallback, JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { JsonRpcSuccess, Json, JsonRpcRequest } from "@metamask/utils";
+/**
+ * Handler for the `wallet_revokeSession` RPC method as specified by [CAIP-285](https://chainagnostic.org/CAIPs/caip-285).
+ * The implementation below deviates from the linked spec in that it ignores the `sessionId` param
+ * and instead revokes the singular session for the origin if available. Additionally,
+ * the handler also does not return an error if there is currently no active session and instead
+ * returns true which is the same result returned if an active session was actually revoked.
+ *
+ * @param _request - The JSON-RPC request object. Unused.
+ * @param response - The JSON-RPC response object.
+ * @param _next - The next middleware function. Unused.
+ * @param end - The end callback function.
+ * @param hooks - The hooks object.
+ * @param hooks.revokePermissionForOrigin - The hook for revoking a permission for an origin function.
+ * @returns Nothing.
+ */
+declare function walletRevokeSessionHandler(_request: JsonRpcRequest & {
+    origin: string;
+}, response: JsonRpcSuccess<Json>, _next: JsonRpcEngineNextCallback, end: JsonRpcEngineEndCallback, hooks: {
+    revokePermissionForOrigin: (permissionName: string) => void;
+}): Promise<void>;
+export declare const walletRevokeSession: {
+    methodNames: string[];
+    implementation: typeof walletRevokeSessionHandler;
+    hookNames: {
+        revokePermissionForOrigin: boolean;
+    };
+};
+export {};
+//# sourceMappingURL=wallet-revokeSession.d.mts.map

package/dist/handlers/wallet-revokeSession.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet-revokeSession.d.mts","sourceRoot":"","sources":["../../src/handlers/wallet-revokeSession.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,yBAAyB,EACzB,wBAAwB,EACzB,kCAAkC;AAMnC,OAAO,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,cAAc,EAAE,wBAAwB;AAE5E;;;;;;;;;;;;;;GAcG;AACH,iBAAe,0BAA0B,CACvC,QAAQ,EAAE,cAAc,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,EAC7C,QAAQ,EAAE,cAAc,CAAC,IAAI,CAAC,EAC9B,KAAK,EAAE,yBAAyB,EAChC,GAAG,EAAE,wBAAwB,EAC7B,KAAK,EAAE;IACL,yBAAyB,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,IAAI,CAAC;CAC7D,iBAgBF;AACD,eAAO,MAAM,mBAAmB;;;;;;CAM/B,CAAC"}

package/dist/handlers/wallet-revokeSession.mjs

@@ -0,0 +1,40 @@
+import { Caip25EndowmentPermissionName } from "@metamask/chain-agnostic-permission";
+import { PermissionDoesNotExistError, UnrecognizedSubjectError } from "@metamask/permission-controller";
+import { rpcErrors } from "@metamask/rpc-errors";
+/**
+ * Handler for the `wallet_revokeSession` RPC method as specified by [CAIP-285](https://chainagnostic.org/CAIPs/caip-285).
+ * The implementation below deviates from the linked spec in that it ignores the `sessionId` param
+ * and instead revokes the singular session for the origin if available. Additionally,
+ * the handler also does not return an error if there is currently no active session and instead
+ * returns true which is the same result returned if an active session was actually revoked.
+ *
+ * @param _request - The JSON-RPC request object. Unused.
+ * @param response - The JSON-RPC response object.
+ * @param _next - The next middleware function. Unused.
+ * @param end - The end callback function.
+ * @param hooks - The hooks object.
+ * @param hooks.revokePermissionForOrigin - The hook for revoking a permission for an origin function.
+ * @returns Nothing.
+ */
+async function walletRevokeSessionHandler(_request, response, _next, end, hooks) {
+    try {
+        hooks.revokePermissionForOrigin(Caip25EndowmentPermissionName);
+    }
+    catch (err) {
+        if (!(err instanceof UnrecognizedSubjectError) &&
+            !(err instanceof PermissionDoesNotExistError)) {
+            console.error(err);
+            return end(rpcErrors.internal());
+        }
+    }
+    response.result = true;
+    return end();
+}
+export const walletRevokeSession = {
+    methodNames: ['wallet_revokeSession'],
+    implementation: walletRevokeSessionHandler,
+    hookNames: {
+        revokePermissionForOrigin: true,
+    },
+};
+//# sourceMappingURL=wallet-revokeSession.mjs.map

package/dist/handlers/wallet-revokeSession.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet-revokeSession.mjs","sourceRoot":"","sources":["../../src/handlers/wallet-revokeSession.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,6BAA6B,EAAE,4CAA4C;AAKpF,OAAO,EACL,2BAA2B,EAC3B,wBAAwB,EACzB,wCAAwC;AACzC,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAGjD;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,0BAA0B,CACvC,QAA6C,EAC7C,QAA8B,EAC9B,KAAgC,EAChC,GAA6B,EAC7B,KAEC;IAED,IAAI;QACF,KAAK,CAAC,yBAAyB,CAAC,6BAA6B,CAAC,CAAC;KAChE;IAAC,OAAO,GAAG,EAAE;QACZ,IACE,CAAC,CAAC,GAAG,YAAY,wBAAwB,CAAC;YAC1C,CAAC,CAAC,GAAG,YAAY,2BAA2B,CAAC,EAC7C;YACA,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnB,OAAO,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;SAClC;KACF;IAED,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AACD,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,WAAW,EAAE,CAAC,sBAAsB,CAAC;IACrC,cAAc,EAAE,0BAA0B;IAC1C,SAAS,EAAE;QACT,yBAAyB,EAAE,IAAI;KAChC;CACF,CAAC","sourcesContent":["import { Caip25EndowmentPermissionName } from '@metamask/chain-agnostic-permission';\nimport type {\n  JsonRpcEngineNextCallback,\n  JsonRpcEngineEndCallback,\n} from '@metamask/json-rpc-engine';\nimport {\n  PermissionDoesNotExistError,\n  UnrecognizedSubjectError,\n} from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { JsonRpcSuccess, Json, JsonRpcRequest } from '@metamask/utils';\n\n/**\n * Handler for the `wallet_revokeSession` RPC method as specified by [CAIP-285](https://chainagnostic.org/CAIPs/caip-285).\n * The implementation below deviates from the linked spec in that it ignores the `sessionId` param\n * and instead revokes the singular session for the origin if available. Additionally,\n * the handler also does not return an error if there is currently no active session and instead\n * returns true which is the same result returned if an active session was actually revoked.\n *\n * @param _request - The JSON-RPC request object. Unused.\n * @param response - The JSON-RPC response object.\n * @param _next - The next middleware function. Unused.\n * @param end - The end callback function.\n * @param hooks - The hooks object.\n * @param hooks.revokePermissionForOrigin - The hook for revoking a permission for an origin function.\n * @returns Nothing.\n */\nasync function walletRevokeSessionHandler(\n  _request: JsonRpcRequest & { origin: string },\n  response: JsonRpcSuccess<Json>,\n  _next: JsonRpcEngineNextCallback,\n  end: JsonRpcEngineEndCallback,\n  hooks: {\n    revokePermissionForOrigin: (permissionName: string) => void;\n  },\n) {\n  try {\n    hooks.revokePermissionForOrigin(Caip25EndowmentPermissionName);\n  } catch (err) {\n    if (\n      !(err instanceof UnrecognizedSubjectError) &&\n      !(err instanceof PermissionDoesNotExistError)\n    ) {\n      console.error(err);\n      return end(rpcErrors.internal());\n    }\n  }\n\n  response.result = true;\n  return end();\n}\nexport const walletRevokeSession = {\n  methodNames: ['wallet_revokeSession'],\n  implementation: walletRevokeSessionHandler,\n  hookNames: {\n    revokePermissionForOrigin: true,\n  },\n};\n"]}

package/dist/index.cjs

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultichainSubscriptionManager = exports.MultichainMiddlewareManager = exports.multichainMethodCallValidatorMiddleware = exports.walletRevokeSession = exports.walletInvokeMethod = exports.walletGetSession = void 0;
+var wallet_getSession_1 = require("./handlers/wallet-getSession.cjs");
+Object.defineProperty(exports, "walletGetSession", { enumerable: true, get: function () { return wallet_getSession_1.walletGetSession; } });
+var wallet_invokeMethod_1 = require("./handlers/wallet-invokeMethod.cjs");
+Object.defineProperty(exports, "walletInvokeMethod", { enumerable: true, get: function () { return wallet_invokeMethod_1.walletInvokeMethod; } });
+var wallet_revokeSession_1 = require("./handlers/wallet-revokeSession.cjs");
+Object.defineProperty(exports, "walletRevokeSession", { enumerable: true, get: function () { return wallet_revokeSession_1.walletRevokeSession; } });
+var multichainMethodCallValidatorMiddleware_1 = require("./middlewares/multichainMethodCallValidatorMiddleware.cjs");
+Object.defineProperty(exports, "multichainMethodCallValidatorMiddleware", { enumerable: true, get: function () { return multichainMethodCallValidatorMiddleware_1.multichainMethodCallValidatorMiddleware; } });
+var MultichainMiddlewareManager_1 = require("./middlewares/MultichainMiddlewareManager.cjs");
+Object.defineProperty(exports, "MultichainMiddlewareManager", { enumerable: true, get: function () { return MultichainMiddlewareManager_1.MultichainMiddlewareManager; } });
+var MultichainSubscriptionManager_1 = require("./middlewares/MultichainSubscriptionManager.cjs");
+Object.defineProperty(exports, "MultichainSubscriptionManager", { enumerable: true, get: function () { return MultichainSubscriptionManager_1.MultichainSubscriptionManager; } });
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,sEAAgE;AAAvD,qHAAA,gBAAgB,OAAA;AACzB,0EAAoE;AAA3D,yHAAA,kBAAkB,OAAA;AAC3B,4EAAsE;AAA7D,2HAAA,mBAAmB,OAAA;AAE5B,qHAAgH;AAAvG,kKAAA,uCAAuC,OAAA;AAChD,6FAAwF;AAA/E,0IAAA,2BAA2B,OAAA;AACpC,iGAA4F;AAAnF,8IAAA,6BAA6B,OAAA","sourcesContent":["export { walletGetSession } from './handlers/wallet-getSession';\nexport { walletInvokeMethod } from './handlers/wallet-invokeMethod';\nexport { walletRevokeSession } from './handlers/wallet-revokeSession';\n\nexport { multichainMethodCallValidatorMiddleware } from './middlewares/multichainMethodCallValidatorMiddleware';\nexport { MultichainMiddlewareManager } from './middlewares/MultichainMiddlewareManager';\nexport { MultichainSubscriptionManager } from './middlewares/MultichainSubscriptionManager';\n"]}

package/dist/index.d.cts

@@ -0,0 +1,7 @@
+export { walletGetSession } from "./handlers/wallet-getSession.cjs";
+export { walletInvokeMethod } from "./handlers/wallet-invokeMethod.cjs";
+export { walletRevokeSession } from "./handlers/wallet-revokeSession.cjs";
+export { multichainMethodCallValidatorMiddleware } from "./middlewares/multichainMethodCallValidatorMiddleware.cjs";
+export { MultichainMiddlewareManager } from "./middlewares/MultichainMiddlewareManager.cjs";
+export { MultichainSubscriptionManager } from "./middlewares/MultichainSubscriptionManager.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,yCAAqC;AAChE,OAAO,EAAE,kBAAkB,EAAE,2CAAuC;AACpE,OAAO,EAAE,mBAAmB,EAAE,4CAAwC;AAEtE,OAAO,EAAE,uCAAuC,EAAE,kEAA8D;AAChH,OAAO,EAAE,2BAA2B,EAAE,sDAAkD;AACxF,OAAO,EAAE,6BAA6B,EAAE,wDAAoD"}

package/dist/index.d.mts

@@ -0,0 +1,7 @@
+export { walletGetSession } from "./handlers/wallet-getSession.mjs";
+export { walletInvokeMethod } from "./handlers/wallet-invokeMethod.mjs";
+export { walletRevokeSession } from "./handlers/wallet-revokeSession.mjs";
+export { multichainMethodCallValidatorMiddleware } from "./middlewares/multichainMethodCallValidatorMiddleware.mjs";
+export { MultichainMiddlewareManager } from "./middlewares/MultichainMiddlewareManager.mjs";
+export { MultichainSubscriptionManager } from "./middlewares/MultichainSubscriptionManager.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,yCAAqC;AAChE,OAAO,EAAE,kBAAkB,EAAE,2CAAuC;AACpE,OAAO,EAAE,mBAAmB,EAAE,4CAAwC;AAEtE,OAAO,EAAE,uCAAuC,EAAE,kEAA8D;AAChH,OAAO,EAAE,2BAA2B,EAAE,sDAAkD;AACxF,OAAO,EAAE,6BAA6B,EAAE,wDAAoD"}

package/dist/index.mjs

@@ -0,0 +1,7 @@
+export { walletGetSession } from "./handlers/wallet-getSession.mjs";
+export { walletInvokeMethod } from "./handlers/wallet-invokeMethod.mjs";
+export { walletRevokeSession } from "./handlers/wallet-revokeSession.mjs";
+export { multichainMethodCallValidatorMiddleware } from "./middlewares/multichainMethodCallValidatorMiddleware.mjs";
+export { MultichainMiddlewareManager } from "./middlewares/MultichainMiddlewareManager.mjs";
+export { MultichainSubscriptionManager } from "./middlewares/MultichainSubscriptionManager.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,yCAAqC;AAChE,OAAO,EAAE,kBAAkB,EAAE,2CAAuC;AACpE,OAAO,EAAE,mBAAmB,EAAE,4CAAwC;AAEtE,OAAO,EAAE,uCAAuC,EAAE,kEAA8D;AAChH,OAAO,EAAE,2BAA2B,EAAE,sDAAkD;AACxF,OAAO,EAAE,6BAA6B,EAAE,wDAAoD","sourcesContent":["export { walletGetSession } from './handlers/wallet-getSession';\nexport { walletInvokeMethod } from './handlers/wallet-invokeMethod';\nexport { walletRevokeSession } from './handlers/wallet-revokeSession';\n\nexport { multichainMethodCallValidatorMiddleware } from './middlewares/multichainMethodCallValidatorMiddleware';\nexport { MultichainMiddlewareManager } from './middlewares/MultichainMiddlewareManager';\nexport { MultichainSubscriptionManager } from './middlewares/MultichainSubscriptionManager';\n"]}

package/dist/middlewares/MultichainMiddlewareManager.cjs

@@ -0,0 +1,110 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    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");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    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");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var _MultichainMiddlewareManager_instances, _MultichainMiddlewareManager_middlewares, _MultichainMiddlewareManager_getMiddlewareEntry, _MultichainMiddlewareManager_removeMiddlewareEntry, _MultichainMiddlewareManager_removeMiddleware;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultichainMiddlewareManager = void 0;
+const rpc_errors_1 = require("@metamask/rpc-errors");
+// Methods related to eth_subscriptions
+const SubscriptionMethods = ['eth_subscribe', 'eth_unsubscribe'];
+/**
+ * A helper that facilates registering and calling of provided middleware instances
+ * in the RPC pipeline based on the incoming request's scope, origin, and tabId.
+ * The core purpose of this class is to enable and manage multichain subscriptions
+ * (i.e. eth_subscribe called accross different chains and domains).
+ *
+ * Note that only one middleware instance can be registered per scope, origin, tabId key.
+ */
+class MultichainMiddlewareManager {
+    constructor() {
+        _MultichainMiddlewareManager_instances.add(this);
+        _MultichainMiddlewareManager_middlewares.set(this, []);
+    }
+    addMiddleware(middlewareEntry) {
+        const { scope, origin, tabId } = middlewareEntry;
+        if (!__classPrivateFieldGet(this, _MultichainMiddlewareManager_instances, "m", _MultichainMiddlewareManager_getMiddlewareEntry).call(this, { scope, origin, tabId })) {
+            __classPrivateFieldGet(this, _MultichainMiddlewareManager_middlewares, "f").push(middlewareEntry);
+        }
+    }
+    removeMiddlewareByScope(scope) {
+        __classPrivateFieldGet(this, _MultichainMiddlewareManager_middlewares, "f").forEach((middlewareEntry) => {
+            if (middlewareEntry.scope === scope) {
+                __classPrivateFieldGet(this, _MultichainMiddlewareManager_instances, "m", _MultichainMiddlewareManager_removeMiddleware).call(this, middlewareEntry);
+            }
+        });
+    }
+    removeMiddlewareByScopeAndOrigin(scope, origin) {
+        __classPrivateFieldGet(this, _MultichainMiddlewareManager_middlewares, "f").forEach((middlewareEntry) => {
+            if (middlewareEntry.scope === scope &&
+                middlewareEntry.origin === origin) {
+                __classPrivateFieldGet(this, _MultichainMiddlewareManager_instances, "m", _MultichainMiddlewareManager_removeMiddleware).call(this, middlewareEntry);
+            }
+        });
+    }
+    removeMiddlewareByOriginAndTabId(origin, tabId) {
+        __classPrivateFieldGet(this, _MultichainMiddlewareManager_middlewares, "f").forEach((middlewareEntry) => {
+            if (middlewareEntry.origin === origin &&
+                middlewareEntry.tabId === tabId) {
+                __classPrivateFieldGet(this, _MultichainMiddlewareManager_instances, "m", _MultichainMiddlewareManager_removeMiddleware).call(this, middlewareEntry);
+            }
+        });
+    }
+    generateMultichainMiddlewareForOriginAndTabId(origin, tabId) {
+        const middleware = (req, res, next, end) => {
+            const { scope } = req;
+            const middlewareEntry = __classPrivateFieldGet(this, _MultichainMiddlewareManager_instances, "m", _MultichainMiddlewareManager_getMiddlewareEntry).call(this, {
+                scope,
+                origin,
+                tabId,
+            });
+            if (SubscriptionMethods.includes(req.method)) {
+                if (middlewareEntry) {
+                    middlewareEntry.middleware(req, res, next, end);
+                }
+                else {
+                    // TODO: Temporary safety guard to prevent requests with these methods
+                    // from being forwarded to the RPC endpoint even though this scenario
+                    // should not be possible.
+                    return end(rpc_errors_1.rpcErrors.methodNotFound());
+                }
+            }
+            else {
+                return next();
+            }
+            return undefined;
+        };
+        middleware.destroy = this.removeMiddlewareByOriginAndTabId.bind(this, origin, tabId);
+        return middleware;
+    }
+}
+exports.MultichainMiddlewareManager = MultichainMiddlewareManager;
+_MultichainMiddlewareManager_middlewares = new WeakMap(), _MultichainMiddlewareManager_instances = new WeakSet(), _MultichainMiddlewareManager_getMiddlewareEntry = function _MultichainMiddlewareManager_getMiddlewareEntry({ scope, origin, tabId, }) {
+    return __classPrivateFieldGet(this, _MultichainMiddlewareManager_middlewares, "f").find((middlewareEntry) => {
+        return (middlewareEntry.scope === scope &&
+            middlewareEntry.origin === origin &&
+            middlewareEntry.tabId === tabId);
+    });
+}, _MultichainMiddlewareManager_removeMiddlewareEntry = function _MultichainMiddlewareManager_removeMiddlewareEntry({ scope, origin, tabId }) {
+    __classPrivateFieldSet(this, _MultichainMiddlewareManager_middlewares, __classPrivateFieldGet(this, _MultichainMiddlewareManager_middlewares, "f").filter((middlewareEntry) => {
+        return (middlewareEntry.scope !== scope ||
+            middlewareEntry.origin !== origin ||
+            middlewareEntry.tabId !== tabId);
+    }), "f");
+}, _MultichainMiddlewareManager_removeMiddleware = function _MultichainMiddlewareManager_removeMiddleware(middlewareEntry) {
+    // When the destroy function on the middleware is async,
+    // we don't need to wait for it complete
+    Promise.resolve(middlewareEntry.middleware.destroy?.()).catch(() => {
+        // do nothing
+    });
+    __classPrivateFieldGet(this, _MultichainMiddlewareManager_instances, "m", _MultichainMiddlewareManager_removeMiddlewareEntry).call(this, middlewareEntry);
+};
+//# sourceMappingURL=MultichainMiddlewareManager.cjs.map

package/dist/middlewares/MultichainMiddlewareManager.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultichainMiddlewareManager.cjs","sourceRoot":"","sources":["../../src/middlewares/MultichainMiddlewareManager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAKA,qDAAiD;AA0BjD,uCAAuC;AACvC,MAAM,mBAAmB,GAAG,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;AAEjE;;;;;;;GAOG;AACH,MAAa,2BAA2B;IAAxC;;QACE,mDAAkC,EAAE,EAAC;IA2GvC,CAAC;IAjFC,aAAa,CAAC,eAAgC;QAC5C,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,eAAe,CAAC;QACjD,IAAI,CAAC,uBAAA,IAAI,+FAAoB,MAAxB,IAAI,EAAqB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE;YACvD,uBAAA,IAAI,gDAAa,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;SACzC;IACH,CAAC;IAYD,uBAAuB,CAAC,KAA0B;QAChD,uBAAA,IAAI,gDAAa,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;YAC5C,IAAI,eAAe,CAAC,KAAK,KAAK,KAAK,EAAE;gBACnC,uBAAA,IAAI,6FAAkB,MAAtB,IAAI,EAAmB,eAAe,CAAC,CAAC;aACzC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gCAAgC,CAAC,KAA0B,EAAE,MAAc;QACzE,uBAAA,IAAI,gDAAa,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;YAC5C,IACE,eAAe,CAAC,KAAK,KAAK,KAAK;gBAC/B,eAAe,CAAC,MAAM,KAAK,MAAM,EACjC;gBACA,uBAAA,IAAI,6FAAkB,MAAtB,IAAI,EAAmB,eAAe,CAAC,CAAC;aACzC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gCAAgC,CAAC,MAAc,EAAE,KAAc;QAC7D,uBAAA,IAAI,gDAAa,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;YAC5C,IACE,eAAe,CAAC,MAAM,KAAK,MAAM;gBACjC,eAAe,CAAC,KAAK,KAAK,KAAK,EAC/B;gBACA,uBAAA,IAAI,6FAAkB,MAAtB,IAAI,EAAmB,eAAe,CAAC,CAAC;aACzC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,6CAA6C,CAC3C,MAAc,EACd,KAAc;QAEd,MAAM,UAAU,GAA8B,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;YACpE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,CAAC;YACtB,MAAM,eAAe,GAAG,uBAAA,IAAI,+FAAoB,MAAxB,IAAI,EAAqB;gBAC/C,KAAK;gBACL,MAAM;gBACN,KAAK;aACN,CAAC,CAAC;YAEH,IAAI,mBAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;gBAC5C,IAAI,eAAe,EAAE;oBACnB,eAAe,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;iBACjD;qBAAM;oBACL,sEAAsE;oBACtE,qEAAqE;oBACrE,0BAA0B;oBAC1B,OAAO,GAAG,CAAC,sBAAS,CAAC,cAAc,EAAE,CAAC,CAAC;iBACxC;aACF;iBAAM;gBACL,OAAO,IAAI,EAAE,CAAC;aACf;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC;QACF,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC,gCAAgC,CAAC,IAAI,CAC7D,IAAI,EACJ,MAAM,EACN,KAAK,CACN,CAAC;QAEF,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AA5GD,kEA4GC;6NAzGqB,EAClB,KAAK,EACL,MAAM,EACN,KAAK,GACS;IACd,OAAO,uBAAA,IAAI,gDAAa,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,EAAE;QAChD,OAAO,CACL,eAAe,CAAC,KAAK,KAAK,KAAK;YAC/B,eAAe,CAAC,MAAM,KAAK,MAAM;YACjC,eAAe,CAAC,KAAK,KAAK,KAAK,CAChC,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,mHAEsB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAmB;IAC9D,uBAAA,IAAI,4CAAgB,uBAAA,IAAI,gDAAa,CAAC,MAAM,CAAC,CAAC,eAAe,EAAE,EAAE;QAC/D,OAAO,CACL,eAAe,CAAC,KAAK,KAAK,KAAK;YAC/B,eAAe,CAAC,MAAM,KAAK,MAAM;YACjC,eAAe,CAAC,KAAK,KAAK,KAAK,CAChC,CAAC;IACJ,CAAC,CAAC,MAAA,CAAC;AACL,CAAC,yGASiB,eAAgC;IAChD,wDAAwD;IACxD,wCAAwC;IACxC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE;QACjE,aAAa;IACf,CAAC,CAAC,CAAC;IAEH,uBAAA,IAAI,kGAAuB,MAA3B,IAAI,EAAwB,eAAe,CAAC,CAAC;AAC/C,CAAC","sourcesContent":["import type { ExternalScopeString } from '@metamask/chain-agnostic-permission';\nimport type {\n  JsonRpcEngineEndCallback,\n  JsonRpcEngineNextCallback,\n} from '@metamask/json-rpc-engine';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  Json,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\n\nexport type ExtendedJsonRpcMiddleware = {\n  (\n    req: JsonRpcRequest & { scope: string },\n    res: PendingJsonRpcResponse<Json>,\n    next: JsonRpcEngineNextCallback,\n    end: JsonRpcEngineEndCallback,\n  ): void;\n  destroy?: () => void | Promise<void>;\n};\n\ntype MiddlewareKey = {\n  scope: ExternalScopeString;\n  origin: string;\n  tabId?: number;\n};\ntype MiddlewareEntry = MiddlewareKey & {\n  middleware: ExtendedJsonRpcMiddleware;\n};\n\n// Methods related to eth_subscriptions\nconst SubscriptionMethods = ['eth_subscribe', 'eth_unsubscribe'];\n\n/**\n * A helper that facilates registering and calling of provided middleware instances\n * in the RPC pipeline based on the incoming request's scope, origin, and tabId.\n * The core purpose of this class is to enable and manage multichain subscriptions\n * (i.e. eth_subscribe called accross different chains and domains).\n *\n * Note that only one middleware instance can be registered per scope, origin, tabId key.\n */\nexport class MultichainMiddlewareManager {\n  #middlewares: MiddlewareEntry[] = [];\n\n  #getMiddlewareEntry({\n    scope,\n    origin,\n    tabId,\n  }: MiddlewareKey): MiddlewareEntry | undefined {\n    return this.#middlewares.find((middlewareEntry) => {\n      return (\n        middlewareEntry.scope === scope &&\n        middlewareEntry.origin === origin &&\n        middlewareEntry.tabId === tabId\n      );\n    });\n  }\n\n  #removeMiddlewareEntry({ scope, origin, tabId }: MiddlewareEntry) {\n    this.#middlewares = this.#middlewares.filter((middlewareEntry) => {\n      return (\n        middlewareEntry.scope !== scope ||\n        middlewareEntry.origin !== origin ||\n        middlewareEntry.tabId !== tabId\n      );\n    });\n  }\n\n  addMiddleware(middlewareEntry: MiddlewareEntry) {\n    const { scope, origin, tabId } = middlewareEntry;\n    if (!this.#getMiddlewareEntry({ scope, origin, tabId })) {\n      this.#middlewares.push(middlewareEntry);\n    }\n  }\n\n  #removeMiddleware(middlewareEntry: MiddlewareEntry) {\n    // When the destroy function on the middleware is async,\n    // we don't need to wait for it complete\n    Promise.resolve(middlewareEntry.middleware.destroy?.()).catch(() => {\n      // do nothing\n    });\n\n    this.#removeMiddlewareEntry(middlewareEntry);\n  }\n\n  removeMiddlewareByScope(scope: ExternalScopeString) {\n    this.#middlewares.forEach((middlewareEntry) => {\n      if (middlewareEntry.scope === scope) {\n        this.#removeMiddleware(middlewareEntry);\n      }\n    });\n  }\n\n  removeMiddlewareByScopeAndOrigin(scope: ExternalScopeString, origin: string) {\n    this.#middlewares.forEach((middlewareEntry) => {\n      if (\n        middlewareEntry.scope === scope &&\n        middlewareEntry.origin === origin\n      ) {\n        this.#removeMiddleware(middlewareEntry);\n      }\n    });\n  }\n\n  removeMiddlewareByOriginAndTabId(origin: string, tabId?: number) {\n    this.#middlewares.forEach((middlewareEntry) => {\n      if (\n        middlewareEntry.origin === origin &&\n        middlewareEntry.tabId === tabId\n      ) {\n        this.#removeMiddleware(middlewareEntry);\n      }\n    });\n  }\n\n  generateMultichainMiddlewareForOriginAndTabId(\n    origin: string,\n    tabId?: number,\n  ) {\n    const middleware: ExtendedJsonRpcMiddleware = (req, res, next, end) => {\n      const { scope } = req;\n      const middlewareEntry = this.#getMiddlewareEntry({\n        scope,\n        origin,\n        tabId,\n      });\n\n      if (SubscriptionMethods.includes(req.method)) {\n        if (middlewareEntry) {\n          middlewareEntry.middleware(req, res, next, end);\n        } else {\n          // TODO: Temporary safety guard to prevent requests with these methods\n          // from being forwarded to the RPC endpoint even though this scenario\n          // should not be possible.\n          return end(rpcErrors.methodNotFound());\n        }\n      } else {\n        return next();\n      }\n      return undefined;\n    };\n    middleware.destroy = this.removeMiddlewareByOriginAndTabId.bind(\n      this,\n      origin,\n      tabId,\n    );\n\n    return middleware;\n  }\n}\n"]}

package/dist/middlewares/MultichainMiddlewareManager.d.cts

@@ -0,0 +1,35 @@
+import type { ExternalScopeString } from "@metamask/chain-agnostic-permission";
+import type { JsonRpcEngineEndCallback, JsonRpcEngineNextCallback } from "@metamask/json-rpc-engine";
+import type { Json, JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
+export type ExtendedJsonRpcMiddleware = {
+    (req: JsonRpcRequest & {
+        scope: string;
+    }, res: PendingJsonRpcResponse<Json>, next: JsonRpcEngineNextCallback, end: JsonRpcEngineEndCallback): void;
+    destroy?: () => void | Promise<void>;
+};
+type MiddlewareKey = {
+    scope: ExternalScopeString;
+    origin: string;
+    tabId?: number;
+};
+type MiddlewareEntry = MiddlewareKey & {
+    middleware: ExtendedJsonRpcMiddleware;
+};
+/**
+ * A helper that facilates registering and calling of provided middleware instances
+ * in the RPC pipeline based on the incoming request's scope, origin, and tabId.
+ * The core purpose of this class is to enable and manage multichain subscriptions
+ * (i.e. eth_subscribe called accross different chains and domains).
+ *
+ * Note that only one middleware instance can be registered per scope, origin, tabId key.
+ */
+export declare class MultichainMiddlewareManager {
+    #private;
+    addMiddleware(middlewareEntry: MiddlewareEntry): void;
+    removeMiddlewareByScope(scope: ExternalScopeString): void;
+    removeMiddlewareByScopeAndOrigin(scope: ExternalScopeString, origin: string): void;
+    removeMiddlewareByOriginAndTabId(origin: string, tabId?: number): void;
+    generateMultichainMiddlewareForOriginAndTabId(origin: string, tabId?: number): ExtendedJsonRpcMiddleware;
+}
+export {};
+//# sourceMappingURL=MultichainMiddlewareManager.d.cts.map

package/dist/middlewares/MultichainMiddlewareManager.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultichainMiddlewareManager.d.cts","sourceRoot":"","sources":["../../src/middlewares/MultichainMiddlewareManager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,4CAA4C;AAC/E,OAAO,KAAK,EACV,wBAAwB,EACxB,yBAAyB,EAC1B,kCAAkC;AAEnC,OAAO,KAAK,EACV,IAAI,EACJ,cAAc,EACd,sBAAsB,EACvB,wBAAwB;AAEzB,MAAM,MAAM,yBAAyB,GAAG;IACtC,CACE,GAAG,EAAE,cAAc,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EACvC,GAAG,EAAE,sBAAsB,CAAC,IAAI,CAAC,EACjC,IAAI,EAAE,yBAAyB,EAC/B,GAAG,EAAE,wBAAwB,GAC5B,IAAI,CAAC;IACR,OAAO,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtC,CAAC;AAEF,KAAK,aAAa,GAAG;IACnB,KAAK,EAAE,mBAAmB,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AACF,KAAK,eAAe,GAAG,aAAa,GAAG;IACrC,UAAU,EAAE,yBAAyB,CAAC;CACvC,CAAC;AAKF;;;;;;;GAOG;AACH,qBAAa,2BAA2B;;IA2BtC,aAAa,CAAC,eAAe,EAAE,eAAe;IAiB9C,uBAAuB,CAAC,KAAK,EAAE,mBAAmB;IAQlD,gCAAgC,CAAC,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,MAAM;IAW3E,gCAAgC,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IAW/D,6CAA6C,CAC3C,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM;CAgCjB"}

package/dist/middlewares/MultichainMiddlewareManager.d.mts

@@ -0,0 +1,35 @@
+import type { ExternalScopeString } from "@metamask/chain-agnostic-permission";
+import type { JsonRpcEngineEndCallback, JsonRpcEngineNextCallback } from "@metamask/json-rpc-engine";
+import type { Json, JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
+export type ExtendedJsonRpcMiddleware = {
+    (req: JsonRpcRequest & {
+        scope: string;
+    }, res: PendingJsonRpcResponse<Json>, next: JsonRpcEngineNextCallback, end: JsonRpcEngineEndCallback): void;
+    destroy?: () => void | Promise<void>;
+};
+type MiddlewareKey = {
+    scope: ExternalScopeString;
+    origin: string;
+    tabId?: number;
+};
+type MiddlewareEntry = MiddlewareKey & {
+    middleware: ExtendedJsonRpcMiddleware;
+};
+/**
+ * A helper that facilates registering and calling of provided middleware instances
+ * in the RPC pipeline based on the incoming request's scope, origin, and tabId.
+ * The core purpose of this class is to enable and manage multichain subscriptions
+ * (i.e. eth_subscribe called accross different chains and domains).
+ *
+ * Note that only one middleware instance can be registered per scope, origin, tabId key.
+ */
+export declare class MultichainMiddlewareManager {
+    #private;
+    addMiddleware(middlewareEntry: MiddlewareEntry): void;
+    removeMiddlewareByScope(scope: ExternalScopeString): void;
+    removeMiddlewareByScopeAndOrigin(scope: ExternalScopeString, origin: string): void;
+    removeMiddlewareByOriginAndTabId(origin: string, tabId?: number): void;
+    generateMultichainMiddlewareForOriginAndTabId(origin: string, tabId?: number): ExtendedJsonRpcMiddleware;
+}
+export {};
+//# sourceMappingURL=MultichainMiddlewareManager.d.mts.map

package/dist/middlewares/MultichainMiddlewareManager.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultichainMiddlewareManager.d.mts","sourceRoot":"","sources":["../../src/middlewares/MultichainMiddlewareManager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,4CAA4C;AAC/E,OAAO,KAAK,EACV,wBAAwB,EACxB,yBAAyB,EAC1B,kCAAkC;AAEnC,OAAO,KAAK,EACV,IAAI,EACJ,cAAc,EACd,sBAAsB,EACvB,wBAAwB;AAEzB,MAAM,MAAM,yBAAyB,GAAG;IACtC,CACE,GAAG,EAAE,cAAc,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EACvC,GAAG,EAAE,sBAAsB,CAAC,IAAI,CAAC,EACjC,IAAI,EAAE,yBAAyB,EAC/B,GAAG,EAAE,wBAAwB,GAC5B,IAAI,CAAC;IACR,OAAO,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtC,CAAC;AAEF,KAAK,aAAa,GAAG;IACnB,KAAK,EAAE,mBAAmB,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AACF,KAAK,eAAe,GAAG,aAAa,GAAG;IACrC,UAAU,EAAE,yBAAyB,CAAC;CACvC,CAAC;AAKF;;;;;;;GAOG;AACH,qBAAa,2BAA2B;;IA2BtC,aAAa,CAAC,eAAe,EAAE,eAAe;IAiB9C,uBAAuB,CAAC,KAAK,EAAE,mBAAmB;IAQlD,gCAAgC,CAAC,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,MAAM;IAW3E,gCAAgC,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IAW/D,6CAA6C,CAC3C,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM;CAgCjB"}

package/dist/middlewares/MultichainMiddlewareManager.mjs

@@ -0,0 +1,106 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    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");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    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");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var _MultichainMiddlewareManager_instances, _MultichainMiddlewareManager_middlewares, _MultichainMiddlewareManager_getMiddlewareEntry, _MultichainMiddlewareManager_removeMiddlewareEntry, _MultichainMiddlewareManager_removeMiddleware;
+import { rpcErrors } from "@metamask/rpc-errors";
+// Methods related to eth_subscriptions
+const SubscriptionMethods = ['eth_subscribe', 'eth_unsubscribe'];
+/**
+ * A helper that facilates registering and calling of provided middleware instances
+ * in the RPC pipeline based on the incoming request's scope, origin, and tabId.
+ * The core purpose of this class is to enable and manage multichain subscriptions
+ * (i.e. eth_subscribe called accross different chains and domains).
+ *
+ * Note that only one middleware instance can be registered per scope, origin, tabId key.
+ */
+export class MultichainMiddlewareManager {
+    constructor() {
+        _MultichainMiddlewareManager_instances.add(this);
+        _MultichainMiddlewareManager_middlewares.set(this, []);
+    }
+    addMiddleware(middlewareEntry) {
+        const { scope, origin, tabId } = middlewareEntry;
+        if (!__classPrivateFieldGet(this, _MultichainMiddlewareManager_instances, "m", _MultichainMiddlewareManager_getMiddlewareEntry).call(this, { scope, origin, tabId })) {
+            __classPrivateFieldGet(this, _MultichainMiddlewareManager_middlewares, "f").push(middlewareEntry);
+        }
+    }
+    removeMiddlewareByScope(scope) {
+        __classPrivateFieldGet(this, _MultichainMiddlewareManager_middlewares, "f").forEach((middlewareEntry) => {
+            if (middlewareEntry.scope === scope) {
+                __classPrivateFieldGet(this, _MultichainMiddlewareManager_instances, "m", _MultichainMiddlewareManager_removeMiddleware).call(this, middlewareEntry);
+            }
+        });
+    }
+    removeMiddlewareByScopeAndOrigin(scope, origin) {
+        __classPrivateFieldGet(this, _MultichainMiddlewareManager_middlewares, "f").forEach((middlewareEntry) => {
+            if (middlewareEntry.scope === scope &&
+                middlewareEntry.origin === origin) {
+                __classPrivateFieldGet(this, _MultichainMiddlewareManager_instances, "m", _MultichainMiddlewareManager_removeMiddleware).call(this, middlewareEntry);
+            }
+        });
+    }
+    removeMiddlewareByOriginAndTabId(origin, tabId) {
+        __classPrivateFieldGet(this, _MultichainMiddlewareManager_middlewares, "f").forEach((middlewareEntry) => {
+            if (middlewareEntry.origin === origin &&
+                middlewareEntry.tabId === tabId) {
+                __classPrivateFieldGet(this, _MultichainMiddlewareManager_instances, "m", _MultichainMiddlewareManager_removeMiddleware).call(this, middlewareEntry);
+            }
+        });
+    }
+    generateMultichainMiddlewareForOriginAndTabId(origin, tabId) {
+        const middleware = (req, res, next, end) => {
+            const { scope } = req;
+            const middlewareEntry = __classPrivateFieldGet(this, _MultichainMiddlewareManager_instances, "m", _MultichainMiddlewareManager_getMiddlewareEntry).call(this, {
+                scope,
+                origin,
+                tabId,
+            });
+            if (SubscriptionMethods.includes(req.method)) {
+                if (middlewareEntry) {
+                    middlewareEntry.middleware(req, res, next, end);
+                }
+                else {
+                    // TODO: Temporary safety guard to prevent requests with these methods
+                    // from being forwarded to the RPC endpoint even though this scenario
+                    // should not be possible.
+                    return end(rpcErrors.methodNotFound());
+                }
+            }
+            else {
+                return next();
+            }
+            return undefined;
+        };
+        middleware.destroy = this.removeMiddlewareByOriginAndTabId.bind(this, origin, tabId);
+        return middleware;
+    }
+}
+_MultichainMiddlewareManager_middlewares = new WeakMap(), _MultichainMiddlewareManager_instances = new WeakSet(), _MultichainMiddlewareManager_getMiddlewareEntry = function _MultichainMiddlewareManager_getMiddlewareEntry({ scope, origin, tabId, }) {
+    return __classPrivateFieldGet(this, _MultichainMiddlewareManager_middlewares, "f").find((middlewareEntry) => {
+        return (middlewareEntry.scope === scope &&
+            middlewareEntry.origin === origin &&
+            middlewareEntry.tabId === tabId);
+    });
+}, _MultichainMiddlewareManager_removeMiddlewareEntry = function _MultichainMiddlewareManager_removeMiddlewareEntry({ scope, origin, tabId }) {
+    __classPrivateFieldSet(this, _MultichainMiddlewareManager_middlewares, __classPrivateFieldGet(this, _MultichainMiddlewareManager_middlewares, "f").filter((middlewareEntry) => {
+        return (middlewareEntry.scope !== scope ||
+            middlewareEntry.origin !== origin ||
+            middlewareEntry.tabId !== tabId);
+    }), "f");
+}, _MultichainMiddlewareManager_removeMiddleware = function _MultichainMiddlewareManager_removeMiddleware(middlewareEntry) {
+    // When the destroy function on the middleware is async,
+    // we don't need to wait for it complete
+    Promise.resolve(middlewareEntry.middleware.destroy?.()).catch(() => {
+        // do nothing
+    });
+    __classPrivateFieldGet(this, _MultichainMiddlewareManager_instances, "m", _MultichainMiddlewareManager_removeMiddlewareEntry).call(this, middlewareEntry);
+};
+//# sourceMappingURL=MultichainMiddlewareManager.mjs.map

package/dist/middlewares/MultichainMiddlewareManager.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultichainMiddlewareManager.mjs","sourceRoot":"","sources":["../../src/middlewares/MultichainMiddlewareManager.ts"],"names":[],"mappings":";;;;;;;;;;;;AAKA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AA0BjD,uCAAuC;AACvC,MAAM,mBAAmB,GAAG,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;AAEjE;;;;;;;GAOG;AACH,MAAM,OAAO,2BAA2B;IAAxC;;QACE,mDAAkC,EAAE,EAAC;IA2GvC,CAAC;IAjFC,aAAa,CAAC,eAAgC;QAC5C,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,eAAe,CAAC;QACjD,IAAI,CAAC,uBAAA,IAAI,+FAAoB,MAAxB,IAAI,EAAqB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE;YACvD,uBAAA,IAAI,gDAAa,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;SACzC;IACH,CAAC;IAYD,uBAAuB,CAAC,KAA0B;QAChD,uBAAA,IAAI,gDAAa,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;YAC5C,IAAI,eAAe,CAAC,KAAK,KAAK,KAAK,EAAE;gBACnC,uBAAA,IAAI,6FAAkB,MAAtB,IAAI,EAAmB,eAAe,CAAC,CAAC;aACzC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gCAAgC,CAAC,KAA0B,EAAE,MAAc;QACzE,uBAAA,IAAI,gDAAa,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;YAC5C,IACE,eAAe,CAAC,KAAK,KAAK,KAAK;gBAC/B,eAAe,CAAC,MAAM,KAAK,MAAM,EACjC;gBACA,uBAAA,IAAI,6FAAkB,MAAtB,IAAI,EAAmB,eAAe,CAAC,CAAC;aACzC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gCAAgC,CAAC,MAAc,EAAE,KAAc;QAC7D,uBAAA,IAAI,gDAAa,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;YAC5C,IACE,eAAe,CAAC,MAAM,KAAK,MAAM;gBACjC,eAAe,CAAC,KAAK,KAAK,KAAK,EAC/B;gBACA,uBAAA,IAAI,6FAAkB,MAAtB,IAAI,EAAmB,eAAe,CAAC,CAAC;aACzC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,6CAA6C,CAC3C,MAAc,EACd,KAAc;QAEd,MAAM,UAAU,GAA8B,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;YACpE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,CAAC;YACtB,MAAM,eAAe,GAAG,uBAAA,IAAI,+FAAoB,MAAxB,IAAI,EAAqB;gBAC/C,KAAK;gBACL,MAAM;gBACN,KAAK;aACN,CAAC,CAAC;YAEH,IAAI,mBAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;gBAC5C,IAAI,eAAe,EAAE;oBACnB,eAAe,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;iBACjD;qBAAM;oBACL,sEAAsE;oBACtE,qEAAqE;oBACrE,0BAA0B;oBAC1B,OAAO,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC,CAAC;iBACxC;aACF;iBAAM;gBACL,OAAO,IAAI,EAAE,CAAC;aACf;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC;QACF,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC,gCAAgC,CAAC,IAAI,CAC7D,IAAI,EACJ,MAAM,EACN,KAAK,CACN,CAAC;QAEF,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;6NAzGqB,EAClB,KAAK,EACL,MAAM,EACN,KAAK,GACS;IACd,OAAO,uBAAA,IAAI,gDAAa,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,EAAE;QAChD,OAAO,CACL,eAAe,CAAC,KAAK,KAAK,KAAK;YAC/B,eAAe,CAAC,MAAM,KAAK,MAAM;YACjC,eAAe,CAAC,KAAK,KAAK,KAAK,CAChC,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,mHAEsB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAmB;IAC9D,uBAAA,IAAI,4CAAgB,uBAAA,IAAI,gDAAa,CAAC,MAAM,CAAC,CAAC,eAAe,EAAE,EAAE;QAC/D,OAAO,CACL,eAAe,CAAC,KAAK,KAAK,KAAK;YAC/B,eAAe,CAAC,MAAM,KAAK,MAAM;YACjC,eAAe,CAAC,KAAK,KAAK,KAAK,CAChC,CAAC;IACJ,CAAC,CAAC,MAAA,CAAC;AACL,CAAC,yGASiB,eAAgC;IAChD,wDAAwD;IACxD,wCAAwC;IACxC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE;QACjE,aAAa;IACf,CAAC,CAAC,CAAC;IAEH,uBAAA,IAAI,kGAAuB,MAA3B,IAAI,EAAwB,eAAe,CAAC,CAAC;AAC/C,CAAC","sourcesContent":["import type { ExternalScopeString } from '@metamask/chain-agnostic-permission';\nimport type {\n  JsonRpcEngineEndCallback,\n  JsonRpcEngineNextCallback,\n} from '@metamask/json-rpc-engine';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  Json,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\n\nexport type ExtendedJsonRpcMiddleware = {\n  (\n    req: JsonRpcRequest & { scope: string },\n    res: PendingJsonRpcResponse<Json>,\n    next: JsonRpcEngineNextCallback,\n    end: JsonRpcEngineEndCallback,\n  ): void;\n  destroy?: () => void | Promise<void>;\n};\n\ntype MiddlewareKey = {\n  scope: ExternalScopeString;\n  origin: string;\n  tabId?: number;\n};\ntype MiddlewareEntry = MiddlewareKey & {\n  middleware: ExtendedJsonRpcMiddleware;\n};\n\n// Methods related to eth_subscriptions\nconst SubscriptionMethods = ['eth_subscribe', 'eth_unsubscribe'];\n\n/**\n * A helper that facilates registering and calling of provided middleware instances\n * in the RPC pipeline based on the incoming request's scope, origin, and tabId.\n * The core purpose of this class is to enable and manage multichain subscriptions\n * (i.e. eth_subscribe called accross different chains and domains).\n *\n * Note that only one middleware instance can be registered per scope, origin, tabId key.\n */\nexport class MultichainMiddlewareManager {\n  #middlewares: MiddlewareEntry[] = [];\n\n  #getMiddlewareEntry({\n    scope,\n    origin,\n    tabId,\n  }: MiddlewareKey): MiddlewareEntry | undefined {\n    return this.#middlewares.find((middlewareEntry) => {\n      return (\n        middlewareEntry.scope === scope &&\n        middlewareEntry.origin === origin &&\n        middlewareEntry.tabId === tabId\n      );\n    });\n  }\n\n  #removeMiddlewareEntry({ scope, origin, tabId }: MiddlewareEntry) {\n    this.#middlewares = this.#middlewares.filter((middlewareEntry) => {\n      return (\n        middlewareEntry.scope !== scope ||\n        middlewareEntry.origin !== origin ||\n        middlewareEntry.tabId !== tabId\n      );\n    });\n  }\n\n  addMiddleware(middlewareEntry: MiddlewareEntry) {\n    const { scope, origin, tabId } = middlewareEntry;\n    if (!this.#getMiddlewareEntry({ scope, origin, tabId })) {\n      this.#middlewares.push(middlewareEntry);\n    }\n  }\n\n  #removeMiddleware(middlewareEntry: MiddlewareEntry) {\n    // When the destroy function on the middleware is async,\n    // we don't need to wait for it complete\n    Promise.resolve(middlewareEntry.middleware.destroy?.()).catch(() => {\n      // do nothing\n    });\n\n    this.#removeMiddlewareEntry(middlewareEntry);\n  }\n\n  removeMiddlewareByScope(scope: ExternalScopeString) {\n    this.#middlewares.forEach((middlewareEntry) => {\n      if (middlewareEntry.scope === scope) {\n        this.#removeMiddleware(middlewareEntry);\n      }\n    });\n  }\n\n  removeMiddlewareByScopeAndOrigin(scope: ExternalScopeString, origin: string) {\n    this.#middlewares.forEach((middlewareEntry) => {\n      if (\n        middlewareEntry.scope === scope &&\n        middlewareEntry.origin === origin\n      ) {\n        this.#removeMiddleware(middlewareEntry);\n      }\n    });\n  }\n\n  removeMiddlewareByOriginAndTabId(origin: string, tabId?: number) {\n    this.#middlewares.forEach((middlewareEntry) => {\n      if (\n        middlewareEntry.origin === origin &&\n        middlewareEntry.tabId === tabId\n      ) {\n        this.#removeMiddleware(middlewareEntry);\n      }\n    });\n  }\n\n  generateMultichainMiddlewareForOriginAndTabId(\n    origin: string,\n    tabId?: number,\n  ) {\n    const middleware: ExtendedJsonRpcMiddleware = (req, res, next, end) => {\n      const { scope } = req;\n      const middlewareEntry = this.#getMiddlewareEntry({\n        scope,\n        origin,\n        tabId,\n      });\n\n      if (SubscriptionMethods.includes(req.method)) {\n        if (middlewareEntry) {\n          middlewareEntry.middleware(req, res, next, end);\n        } else {\n          // TODO: Temporary safety guard to prevent requests with these methods\n          // from being forwarded to the RPC endpoint even though this scenario\n          // should not be possible.\n          return end(rpcErrors.methodNotFound());\n        }\n      } else {\n        return next();\n      }\n      return undefined;\n    };\n    middleware.destroy = this.removeMiddlewareByOriginAndTabId.bind(\n      this,\n      origin,\n      tabId,\n    );\n\n    return middleware;\n  }\n}\n"]}