@metamask-previews/multichain-api-middleware 4.0.3-preview-4f4c98e → 4.0.3-preview-5b293ee50

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

@@ -0,0 +1,45 @@
+import type { Caip25CaveatValue } from "@metamask/chain-agnostic-permission";
+import type { JsonRpcEngineEndCallback, JsonRpcEngineNextCallback, MethodHandler } from "@metamask/json-rpc-engine";
+import { GenericPermissionController } from "@metamask/permission-controller";
+import type { Json, JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
+import type { GetCaveatForOriginHook } from "./types.mjs";
+export type WalletRevokeSessionHooks = GetCaveatForOriginHook & {
+    revokePermissionForOrigin: (permissionName: string) => ReturnType<GenericPermissionController['revokePermissions']>;
+    updateCaveat: (target: string, caveatType: string, caveatValue: Caip25CaveatValue) => ReturnType<GenericPermissionController['updateCaveat']>;
+};
+type WalletRevokeSessionParams = {
+    scopes?: string[];
+};
+/**
+ * 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.
+ * @param hooks.updateCaveat - The hook used to conditionally update the caveat rather than fully revoke the permission.
+ * @param hooks.getCaveatForOrigin - The hook to fetch an existing caveat for the origin of the request.
+ * @returns Nothing.
+ */
+declare function handleWalletRevokeSession(request: JsonRpcRequest<WalletRevokeSessionParams> & {
+    origin: string;
+}, response: PendingJsonRpcResponse<Json>, _next: JsonRpcEngineNextCallback, end: JsonRpcEngineEndCallback, hooks: WalletRevokeSessionHooks): Promise<void>;
+export type WalletRevokeSessionHandler = MethodHandler<WalletRevokeSessionHooks, never, WalletRevokeSessionParams, Json, {
+    origin: string;
+}>;
+export declare const walletRevokeSessionHandler: {
+    implementation: typeof handleWalletRevokeSession;
+    hookNames: {
+        revokePermissionForOrigin: true;
+        updateCaveat: true;
+        getCaveatForOrigin: true;
+    };
+};
+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":"AAMA,OAAO,KAAK,EAAE,iBAAiB,EAAE,4CAA4C;AAC7E,OAAO,KAAK,EACV,wBAAwB,EACxB,yBAAyB,EACzB,aAAa,EACd,kCAAkC;AACnC,OAAO,EAEL,2BAA2B,EAG5B,wCAAwC;AAGzC,OAAO,KAAK,EACV,IAAI,EACJ,cAAc,EACd,sBAAsB,EACvB,wBAAwB;AAEzB,OAAO,KAAK,EAAgB,sBAAsB,EAAE,oBAAmB;AAEvE,MAAM,MAAM,wBAAwB,GAAG,sBAAsB,GAAG;IAC9D,yBAAyB,EAAE,CACzB,cAAc,EAAE,MAAM,KACnB,UAAU,CAAC,2BAA2B,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAClE,YAAY,EAAE,CACZ,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,iBAAiB,KAC3B,UAAU,CAAC,2BAA2B,CAAC,cAAc,CAAC,CAAC,CAAC;CAC9D,CAAC;AAEF,KAAK,yBAAyB,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAiFvD;;;;;;;;;;;;;;;;GAgBG;AACH,iBAAe,yBAAyB,CACtC,OAAO,EAAE,cAAc,CAAC,yBAAyB,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,EACvE,QAAQ,EAAE,sBAAsB,CAAC,IAAI,CAAC,EACtC,KAAK,EAAE,yBAAyB,EAChC,GAAG,EAAE,wBAAwB,EAC7B,KAAK,EAAE,wBAAwB,iBAiBhC;AAED,MAAM,MAAM,0BAA0B,GAAG,aAAa,CACpD,wBAAwB,EACxB,KAAK,EACL,yBAAyB,EACzB,IAAI,EACJ;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CACnB,CAAC;AAEF,eAAO,MAAM,0BAA0B;;;;;;;CAOD,CAAC"}

package/dist/handlers/{wallet-revokeSession.js → wallet-revokeSession.mjs}

@@ -1,7 +1,7 @@
-import { Caip25CaveatMutators, Caip25CaveatType, Caip25EndowmentPermissionName, getCaipAccountIdsFromCaip25CaveatValue, } from '@metamask/chain-agnostic-permission';
-import { CaveatMutatorOperation, PermissionDoesNotExistError, UnrecognizedSubjectError, } from '@metamask/permission-controller';
-import { rpcErrors } from '@metamask/rpc-errors';
-import { isObject } from '@metamask/utils';
+import { Caip25CaveatMutators, Caip25CaveatType, Caip25EndowmentPermissionName, getCaipAccountIdsFromCaip25CaveatValue } from "@metamask/chain-agnostic-permission";
+import { CaveatMutatorOperation, PermissionDoesNotExistError, UnrecognizedSubjectError } from "@metamask/permission-controller";
+import { rpcErrors } from "@metamask/rpc-errors";
+import { isObject } from "@metamask/utils";
 /**
  * Check whether the given error is a permission error.
  *
@@ -100,4 +100,4 @@ export const walletRevokeSessionHandler = {
         getCaveatForOrigin: true,
     },
 };
-//# sourceMappingURL=wallet-revokeSession.js.map
+//# 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,EACL,oBAAoB,EACpB,gBAAgB,EAChB,6BAA6B,EAC7B,sCAAsC,EACvC,4CAA4C;AAO7C,OAAO,EACL,sBAAsB,EAEtB,2BAA2B,EAC3B,wBAAwB,EACzB,wCAAwC;AACzC,OAAO,EAAE,SAAS,EAAE,6BAA6B;AACjD,OAAO,EAAE,QAAQ,EAAE,wBAAwB;AAsB3C;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,KAAc;IACvC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC;QAChB,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC;QAClB,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAC9B,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO;QACL,wBAAwB,CAAC,IAAI;QAC7B,2BAA2B,CAAC,IAAI;KACjC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,wBAAwB,CAC/B,MAAgB,EAChB,KAA+B;IAE/B,MAAM,MAAM,GAAG,KAAK,CAAC,kBAAkB,CACrC,6BAA6B,EAC7B,gBAAgB,CACW,CAAC;IAC9B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO;IACT,CAAC;IAED,IAAI,kBAAkB,GAAG,MAAM,CAAC,KAAK,CAAC;IAEtC,KAAK,MAAM,WAAW,IAAI,MAAM,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,CAAC,WAAW,CAC/D,kBAAkB,EAClB,WAAW,CACZ,CAAC;QAEF,0HAA0H;QAC1H,IAAI,MAAM,CAAC,SAAS,KAAK,sBAAsB,CAAC,IAAI,EAAE,CAAC;YACrD,SAAS;QACX,CAAC;QAED,kBAAkB,GAAG,MAAM,EAAE,KAAK,IAAI;YACpC,cAAc,EAAE,EAAE;YAClB,cAAc,EAAE,EAAE;YAClB,iBAAiB,EAAE,EAAE;YACrB,kBAAkB,EAAE,IAAI;SACzB,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAClB,sCAAsC,CAAC,kBAAkB,CAAC,CAAC;IAE7D,+EAA+E;IAC/E,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAC3B,KAAK,CAAC,yBAAyB,CAAC,6BAA6B,CAAC,CAAC;IACjE,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,YAAY,CAChB,6BAA6B,EAC7B,gBAAgB,EAChB,kBAAkB,CACnB,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,yBAAyB,CACtC,OAAuE,EACvE,QAAsC,EACtC,KAAgC,EAChC,GAA6B,EAC7B,KAA+B;IAE/B,IAAI,CAAC;QACH,IAAI,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;YACnC,wBAAwB,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACzD,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,yBAAyB,CAAC,6BAA6B,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnB,OAAO,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAED,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAUD,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,cAAc,EAAE,yBAAyB;IACzC,SAAS,EAAE;QACT,yBAAyB,EAAE,IAAI;QAC/B,YAAY,EAAE,IAAI;QAClB,kBAAkB,EAAE,IAAI;KACzB;CACmC,CAAC","sourcesContent":["import {\n  Caip25CaveatMutators,\n  Caip25CaveatType,\n  Caip25EndowmentPermissionName,\n  getCaipAccountIdsFromCaip25CaveatValue,\n} from '@metamask/chain-agnostic-permission';\nimport type { Caip25CaveatValue } from '@metamask/chain-agnostic-permission';\nimport type {\n  JsonRpcEngineEndCallback,\n  JsonRpcEngineNextCallback,\n  MethodHandler,\n} from '@metamask/json-rpc-engine';\nimport {\n  CaveatMutatorOperation,\n  GenericPermissionController,\n  PermissionDoesNotExistError,\n  UnrecognizedSubjectError,\n} from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { isObject } from '@metamask/utils';\nimport type {\n  Json,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\n\nimport type { Caip25Caveat, GetCaveatForOriginHook } from './types.js';\n\nexport type WalletRevokeSessionHooks = GetCaveatForOriginHook & {\n  revokePermissionForOrigin: (\n    permissionName: string,\n  ) => ReturnType<GenericPermissionController['revokePermissions']>;\n  updateCaveat: (\n    target: string,\n    caveatType: string,\n    caveatValue: Caip25CaveatValue,\n  ) => ReturnType<GenericPermissionController['updateCaveat']>;\n};\n\ntype WalletRevokeSessionParams = { scopes?: string[] };\n\n/**\n * Check whether the given error is a permission error.\n *\n * @param error - The error to check.\n * @returns Whether the error is a permission error.\n */\nfunction isPermissionError(error: unknown) {\n  if (\n    !isObject(error) ||\n    !('name' in error) ||\n    typeof error.name !== 'string'\n  ) {\n    return false;\n  }\n\n  return [\n    UnrecognizedSubjectError.name,\n    PermissionDoesNotExistError.name,\n  ].includes(error.name);\n}\n\n/**\n * Revokes specific session scopes from an existing caveat.\n * Fully revokes permission if no accounts remain permitted after iterating through scopes.\n *\n * @param scopes - Array of scope strings to remove from the caveat.\n * @param hooks - The hooks object.\n * @param hooks.revokePermissionForOrigin - The hook for revoking a permission for an origin function.\n * @param hooks.updateCaveat - The hook used to conditionally update the caveat rather than fully revoke the permission.\n * @param hooks.getCaveatForOrigin - The hook to fetch an existing caveat for the origin of the request.\n */\nfunction partialRevokePermissions(\n  scopes: string[],\n  hooks: WalletRevokeSessionHooks,\n) {\n  const caveat = hooks.getCaveatForOrigin(\n    Caip25EndowmentPermissionName,\n    Caip25CaveatType,\n  ) as Caip25Caveat | undefined;\n  if (!caveat) {\n    return;\n  }\n\n  let updatedCaveatValue = caveat.value;\n\n  for (const scopeString of scopes) {\n    const result = Caip25CaveatMutators[Caip25CaveatType].removeScope(\n      updatedCaveatValue,\n      scopeString,\n    );\n\n    // If operation is a Noop, it means a scope was passed that was not present in the permission, so we proceed with the loop\n    if (result.operation === CaveatMutatorOperation.Noop) {\n      continue;\n    }\n\n    updatedCaveatValue = result?.value ?? {\n      requiredScopes: {},\n      optionalScopes: {},\n      sessionProperties: {},\n      isMultichainOrigin: true,\n    };\n  }\n\n  const caipAccountIds =\n    getCaipAccountIdsFromCaip25CaveatValue(updatedCaveatValue);\n\n  // We fully revoke permission if no accounts are left after scope removal loop.\n  if (!caipAccountIds.length) {\n    hooks.revokePermissionForOrigin(Caip25EndowmentPermissionName);\n  } else {\n    hooks.updateCaveat(\n      Caip25EndowmentPermissionName,\n      Caip25CaveatType,\n      updatedCaveatValue,\n    );\n  }\n}\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 * @param hooks.updateCaveat - The hook used to conditionally update the caveat rather than fully revoke the permission.\n * @param hooks.getCaveatForOrigin - The hook to fetch an existing caveat for the origin of the request.\n * @returns Nothing.\n */\nasync function handleWalletRevokeSession(\n  request: JsonRpcRequest<WalletRevokeSessionParams> & { origin: string },\n  response: PendingJsonRpcResponse<Json>,\n  _next: JsonRpcEngineNextCallback,\n  end: JsonRpcEngineEndCallback,\n  hooks: WalletRevokeSessionHooks,\n) {\n  try {\n    if (request.params?.scopes?.length) {\n      partialRevokePermissions(request.params.scopes, hooks);\n    } else {\n      hooks.revokePermissionForOrigin(Caip25EndowmentPermissionName);\n    }\n  } catch (err) {\n    if (!isPermissionError(err)) {\n      console.error(err);\n      return end(rpcErrors.internal());\n    }\n  }\n\n  response.result = true;\n  return end();\n}\n\nexport type WalletRevokeSessionHandler = MethodHandler<\n  WalletRevokeSessionHooks,\n  never,\n  WalletRevokeSessionParams,\n  Json,\n  { origin: string }\n>;\n\nexport const walletRevokeSessionHandler = {\n  implementation: handleWalletRevokeSession,\n  hookNames: {\n    revokePermissionForOrigin: true,\n    updateCaveat: true,\n    getCaveatForOrigin: true,\n  },\n} satisfies WalletRevokeSessionHandler;\n"]}

package/dist/index.cjs

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultichainApiNotifications = exports.MultichainSubscriptionManager = exports.MultichainMiddlewareManager = exports.multichainMethodCallValidatorMiddleware = exports.methodHandlers = void 0;
+var index_js_1 = require("./handlers/index.cjs");
+Object.defineProperty(exports, "methodHandlers", { enumerable: true, get: function () { return index_js_1.methodHandlers; } });
+var multichainMethodCallValidatorMiddleware_js_1 = require("./middlewares/multichainMethodCallValidatorMiddleware.cjs");
+Object.defineProperty(exports, "multichainMethodCallValidatorMiddleware", { enumerable: true, get: function () { return multichainMethodCallValidatorMiddleware_js_1.multichainMethodCallValidatorMiddleware; } });
+var MultichainMiddlewareManager_js_1 = require("./middlewares/MultichainMiddlewareManager.cjs");
+Object.defineProperty(exports, "MultichainMiddlewareManager", { enumerable: true, get: function () { return MultichainMiddlewareManager_js_1.MultichainMiddlewareManager; } });
+var MultichainSubscriptionManager_js_1 = require("./middlewares/MultichainSubscriptionManager.cjs");
+Object.defineProperty(exports, "MultichainSubscriptionManager", { enumerable: true, get: function () { return MultichainSubscriptionManager_js_1.MultichainSubscriptionManager; } });
+var types_js_1 = require("./handlers/types.cjs");
+Object.defineProperty(exports, "MultichainApiNotifications", { enumerable: true, get: function () { return types_js_1.MultichainApiNotifications; } });
+//# 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,iDAAqD;AAA5C,0GAAA,cAAc,OAAA;AAGvB,wHAAmH;AAA1G,qKAAA,uCAAuC,OAAA;AAChD,gGAA2F;AAAlF,6IAAA,2BAA2B,OAAA;AACpC,oGAA+F;AAAtF,iJAAA,6BAA6B,OAAA;AACtC,iDAAiE;AAAxD,sHAAA,0BAA0B,OAAA","sourcesContent":["export { methodHandlers } from './handlers/index.js';\nexport type { MethodHandlerHooks } from './handlers/index.js';\n\nexport { multichainMethodCallValidatorMiddleware } from './middlewares/multichainMethodCallValidatorMiddleware.js';\nexport { MultichainMiddlewareManager } from './middlewares/MultichainMiddlewareManager.js';\nexport { MultichainSubscriptionManager } from './middlewares/MultichainSubscriptionManager.js';\nexport { MultichainApiNotifications } from './handlers/types.js';\n"]}

package/dist/index.d.cts

@@ -0,0 +1,7 @@
+export { methodHandlers } from "./handlers/index.cjs";
+export type { MethodHandlerHooks } from "./handlers/index.cjs";
+export { multichainMethodCallValidatorMiddleware } from "./middlewares/multichainMethodCallValidatorMiddleware.cjs";
+export { MultichainMiddlewareManager } from "./middlewares/MultichainMiddlewareManager.cjs";
+export { MultichainSubscriptionManager } from "./middlewares/MultichainSubscriptionManager.cjs";
+export { MultichainApiNotifications } from "./handlers/types.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,cAAc,EAAE,6BAA4B;AACrD,YAAY,EAAE,kBAAkB,EAAE,6BAA4B;AAE9D,OAAO,EAAE,uCAAuC,EAAE,kEAAiE;AACnH,OAAO,EAAE,2BAA2B,EAAE,sDAAqD;AAC3F,OAAO,EAAE,6BAA6B,EAAE,wDAAuD;AAC/F,OAAO,EAAE,0BAA0B,EAAE,6BAA4B"}

package/dist/index.d.mts

@@ -0,0 +1,7 @@
+export { methodHandlers } from "./handlers/index.mjs";
+export type { MethodHandlerHooks } from "./handlers/index.mjs";
+export { multichainMethodCallValidatorMiddleware } from "./middlewares/multichainMethodCallValidatorMiddleware.mjs";
+export { MultichainMiddlewareManager } from "./middlewares/MultichainMiddlewareManager.mjs";
+export { MultichainSubscriptionManager } from "./middlewares/MultichainSubscriptionManager.mjs";
+export { MultichainApiNotifications } from "./handlers/types.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,cAAc,EAAE,6BAA4B;AACrD,YAAY,EAAE,kBAAkB,EAAE,6BAA4B;AAE9D,OAAO,EAAE,uCAAuC,EAAE,kEAAiE;AACnH,OAAO,EAAE,2BAA2B,EAAE,sDAAqD;AAC3F,OAAO,EAAE,6BAA6B,EAAE,wDAAuD;AAC/F,OAAO,EAAE,0BAA0B,EAAE,6BAA4B"}

package/dist/index.mjs

@@ -0,0 +1,6 @@
+export { methodHandlers } from "./handlers/index.mjs";
+export { multichainMethodCallValidatorMiddleware } from "./middlewares/multichainMethodCallValidatorMiddleware.mjs";
+export { MultichainMiddlewareManager } from "./middlewares/MultichainMiddlewareManager.mjs";
+export { MultichainSubscriptionManager } from "./middlewares/MultichainSubscriptionManager.mjs";
+export { MultichainApiNotifications } from "./handlers/types.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,cAAc,EAAE,6BAA4B;AAGrD,OAAO,EAAE,uCAAuC,EAAE,kEAAiE;AACnH,OAAO,EAAE,2BAA2B,EAAE,sDAAqD;AAC3F,OAAO,EAAE,6BAA6B,EAAE,wDAAuD;AAC/F,OAAO,EAAE,0BAA0B,EAAE,6BAA4B","sourcesContent":["export { methodHandlers } from './handlers/index.js';\nexport type { MethodHandlerHooks } from './handlers/index.js';\n\nexport { multichainMethodCallValidatorMiddleware } from './middlewares/multichainMethodCallValidatorMiddleware.js';\nexport { MultichainMiddlewareManager } from './middlewares/MultichainMiddlewareManager.js';\nexport { MultichainSubscriptionManager } from './middlewares/MultichainSubscriptionManager.js';\nexport { MultichainApiNotifications } from './handlers/types.js';\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;AAsBjD,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,CAAC;YACxD,uBAAA,IAAI,gDAAa,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC1C,CAAC;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,CAAC;gBACpC,uBAAA,IAAI,6FAAkB,MAAtB,IAAI,EAAmB,eAAe,CAAC,CAAC;YAC1C,CAAC;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,CAAC;gBACD,uBAAA,IAAI,6FAAkB,MAAtB,IAAI,EAAmB,eAAe,CAAC,CAAC;YAC1C,CAAC;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,CAAC;gBACD,uBAAA,IAAI,6FAAkB,MAAtB,IAAI,EAAmB,eAAe,CAAC,CAAC;YAC1C,CAAC;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,CAAC;gBAC7C,IAAI,eAAe,EAAE,CAAC;oBACpB,eAAe,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAClD,CAAC;qBAAM,CAAC;oBACN,sEAAsE;oBACtE,qEAAqE;oBACrE,0BAA0B;oBAC1B,OAAO,GAAG,CAAC,sBAAS,CAAC,cAAc,EAAE,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;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 { JsonRpcRequest, PendingJsonRpcResponse } from '@metamask/utils';\n\nexport type ExtendedJsonRpcMiddleware = {\n  (\n    req: JsonRpcRequest & { scope: string },\n    res: PendingJsonRpcResponse,\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.ts → MultichainMiddlewareManager.d.cts}

@@ -1,6 +1,6 @@
-import type { ExternalScopeString } from '@metamask/chain-agnostic-permission';
-import type { JsonRpcEngineEndCallback, JsonRpcEngineNextCallback } from '@metamask/json-rpc-engine';
-import type { JsonRpcRequest, PendingJsonRpcResponse } from '@metamask/utils';
+import type { ExternalScopeString } from "@metamask/chain-agnostic-permission";
+import type { JsonRpcEngineEndCallback, JsonRpcEngineNextCallback } from "@metamask/json-rpc-engine";
+import type { JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
 export type ExtendedJsonRpcMiddleware = {
     (req: JsonRpcRequest & {
         scope: string;
@@ -32,4 +32,4 @@ export declare class MultichainMiddlewareManager {
     generateMultichainMiddlewareForOriginAndTabId(origin: string, tabId?: number): ExtendedJsonRpcMiddleware;
 }
 export {};
-//# sourceMappingURL=MultichainMiddlewareManager.d.ts.map
+//# 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,EAAE,cAAc,EAAE,sBAAsB,EAAE,wBAAwB;AAE9E,MAAM,MAAM,yBAAyB,GAAG;IACtC,CACE,GAAG,EAAE,cAAc,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EACvC,GAAG,EAAE,sBAAsB,EAC3B,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 { JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
+export type ExtendedJsonRpcMiddleware = {
+    (req: JsonRpcRequest & {
+        scope: string;
+    }, res: PendingJsonRpcResponse, 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,EAAE,cAAc,EAAE,sBAAsB,EAAE,wBAAwB;AAE9E,MAAM,MAAM,yBAAyB,GAAG;IACtC,CACE,GAAG,EAAE,cAAc,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EACvC,GAAG,EAAE,sBAAsB,EAC3B,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.js → MultichainMiddlewareManager.mjs}

@@ -10,7 +10,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     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';
+import { rpcErrors } from "@metamask/rpc-errors";
 // Methods related to eth_subscriptions
 const SubscriptionMethods = ['eth_subscribe', 'eth_unsubscribe'];
 /**
@@ -103,4 +103,4 @@ _MultichainMiddlewareManager_middlewares = new WeakMap(), _MultichainMiddlewareM
     });
     __classPrivateFieldGet(this, _MultichainMiddlewareManager_instances, "m", _MultichainMiddlewareManager_removeMiddlewareEntry).call(this, middlewareEntry);
 };
-//# sourceMappingURL=MultichainMiddlewareManager.js.map
+//# 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;AAsBjD,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,CAAC;YACxD,uBAAA,IAAI,gDAAa,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC1C,CAAC;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,CAAC;gBACpC,uBAAA,IAAI,6FAAkB,MAAtB,IAAI,EAAmB,eAAe,CAAC,CAAC;YAC1C,CAAC;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,CAAC;gBACD,uBAAA,IAAI,6FAAkB,MAAtB,IAAI,EAAmB,eAAe,CAAC,CAAC;YAC1C,CAAC;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,CAAC;gBACD,uBAAA,IAAI,6FAAkB,MAAtB,IAAI,EAAmB,eAAe,CAAC,CAAC;YAC1C,CAAC;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,CAAC;gBAC7C,IAAI,eAAe,EAAE,CAAC;oBACpB,eAAe,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAClD,CAAC;qBAAM,CAAC;oBACN,sEAAsE;oBACtE,qEAAqE;oBACrE,0BAA0B;oBAC1B,OAAO,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;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 { JsonRpcRequest, PendingJsonRpcResponse } from '@metamask/utils';\n\nexport type ExtendedJsonRpcMiddleware = {\n  (\n    req: JsonRpcRequest & { scope: string },\n    res: PendingJsonRpcResponse,\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/MultichainSubscriptionManager.cjs

@@ -0,0 +1,118 @@
+"use strict";
+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 __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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _MultichainSubscriptionManager_instances, _MultichainSubscriptionManager_findNetworkClientIdByChainId, _MultichainSubscriptionManager_getNetworkClientById, _MultichainSubscriptionManager_subscriptions, _MultichainSubscriptionManager_getSubscriptionEntry, _MultichainSubscriptionManager_removeSubscriptionEntry, _MultichainSubscriptionManager_unsubscribe;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultichainSubscriptionManager = void 0;
+const controller_utils_1 = require("@metamask/controller-utils");
+const subscriptionManager_1 = __importDefault(require("@metamask/eth-json-rpc-filters/subscriptionManager.js"));
+const safe_event_emitter_1 = __importDefault(require("@metamask/safe-event-emitter"));
+const utils_1 = require("@metamask/utils");
+const types_js_1 = require("../handlers/types.cjs");
+/**
+ * A helper that facilates the lifecycle of a SubscriptionManager instance that
+ * is meant to handle subscriptons for only one specific scope, origin, and tabId combination.
+ */
+class MultichainSubscriptionManager extends safe_event_emitter_1.default {
+    /**
+     * Construct a MultichainSubscriptionManager.
+     *
+     * @param options - The controller options.
+     * @param options.findNetworkClientIdByChainId - The hook to get the networkClientId from a chainId.
+     * @param options.getNetworkClientById - The hook to get the network client instance by its networkClientId.
+     */
+    constructor(options) {
+        super();
+        _MultichainSubscriptionManager_instances.add(this);
+        _MultichainSubscriptionManager_findNetworkClientIdByChainId.set(this, void 0);
+        _MultichainSubscriptionManager_getNetworkClientById.set(this, void 0);
+        _MultichainSubscriptionManager_subscriptions.set(this, []);
+        __classPrivateFieldSet(this, _MultichainSubscriptionManager_findNetworkClientIdByChainId, options.findNetworkClientIdByChainId, "f");
+        __classPrivateFieldSet(this, _MultichainSubscriptionManager_getNetworkClientById, options.getNetworkClientById, "f");
+    }
+    notify({ scope, origin, tabId }, { method, params }) {
+        this.emit('notification', origin, tabId, {
+            method: types_js_1.MultichainApiNotifications.walletNotify,
+            params: {
+                scope,
+                notification: { method, params },
+            },
+        });
+    }
+    subscribe(subscriptionKey) {
+        const subscriptionEntry = __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_getSubscriptionEntry).call(this, subscriptionKey);
+        if (subscriptionEntry) {
+            return subscriptionEntry.subscriptionManager;
+        }
+        const networkClientId = __classPrivateFieldGet(this, _MultichainSubscriptionManager_findNetworkClientIdByChainId, "f").call(this, (0, controller_utils_1.toHex)((0, utils_1.parseCaipChainId)(subscriptionKey.scope).reference));
+        const networkClient = __classPrivateFieldGet(this, _MultichainSubscriptionManager_getNetworkClientById, "f").call(this, networkClientId);
+        const subscriptionManager = (0, subscriptionManager_1.default)({
+            blockTracker: networkClient.blockTracker,
+            provider: networkClient.provider,
+        });
+        subscriptionManager.events.on('notification', (message) => {
+            this.notify(subscriptionKey, message);
+        });
+        const newSubscriptionManagerEntry = {
+            ...subscriptionKey,
+            subscriptionManager,
+        };
+        subscriptionManager.destroy = subscriptionManager.middleware.destroy;
+        subscriptionManager.middleware.destroy = __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_unsubscribe).bind(this, newSubscriptionManagerEntry);
+        __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").push(newSubscriptionManagerEntry);
+        return subscriptionManager;
+    }
+    unsubscribeByScope(scope) {
+        __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").forEach((subscriptionEntry) => {
+            if (subscriptionEntry.scope === scope) {
+                __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_unsubscribe).call(this, subscriptionEntry);
+            }
+        });
+    }
+    unsubscribeByScopeAndOrigin(scope, origin) {
+        __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").forEach((subscriptionEntry) => {
+            if (subscriptionEntry.scope === scope &&
+                subscriptionEntry.origin === origin) {
+                __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_unsubscribe).call(this, subscriptionEntry);
+            }
+        });
+    }
+    unsubscribeByOriginAndTabId(origin, tabId) {
+        __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").forEach((subscriptionEntry) => {
+            if (subscriptionEntry.origin === origin &&
+                subscriptionEntry.tabId === tabId) {
+                __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_unsubscribe).call(this, subscriptionEntry);
+            }
+        });
+    }
+}
+exports.MultichainSubscriptionManager = MultichainSubscriptionManager;
+_MultichainSubscriptionManager_findNetworkClientIdByChainId = new WeakMap(), _MultichainSubscriptionManager_getNetworkClientById = new WeakMap(), _MultichainSubscriptionManager_subscriptions = new WeakMap(), _MultichainSubscriptionManager_instances = new WeakSet(), _MultichainSubscriptionManager_getSubscriptionEntry = function _MultichainSubscriptionManager_getSubscriptionEntry({ scope, origin, tabId, }) {
+    return __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").find((subscriptionEntry) => {
+        return (subscriptionEntry.scope === scope &&
+            subscriptionEntry.origin === origin &&
+            subscriptionEntry.tabId === tabId);
+    });
+}, _MultichainSubscriptionManager_removeSubscriptionEntry = function _MultichainSubscriptionManager_removeSubscriptionEntry({ scope, origin, tabId }) {
+    __classPrivateFieldSet(this, _MultichainSubscriptionManager_subscriptions, __classPrivateFieldGet(this, _MultichainSubscriptionManager_subscriptions, "f").filter((subscriptionEntry) => {
+        return (subscriptionEntry.scope !== scope ||
+            subscriptionEntry.origin !== origin ||
+            subscriptionEntry.tabId !== tabId);
+    }), "f");
+}, _MultichainSubscriptionManager_unsubscribe = function _MultichainSubscriptionManager_unsubscribe(subscriptionEntry) {
+    subscriptionEntry.subscriptionManager.destroy?.();
+    __classPrivateFieldGet(this, _MultichainSubscriptionManager_instances, "m", _MultichainSubscriptionManager_removeSubscriptionEntry).call(this, subscriptionEntry);
+};
+//# sourceMappingURL=MultichainSubscriptionManager.cjs.map

package/dist/middlewares/MultichainSubscriptionManager.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultichainSubscriptionManager.cjs","sourceRoot":"","sources":["../../src/middlewares/MultichainSubscriptionManager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AACA,iEAAmD;AACnD,gHAA2F;AAE3F,sFAA4D;AAE5D,2CAAmD;AAEnD,oDAAkE;AAgClE;;;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,qCAA0B,CAAC,YAAY;YAC/C,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,CAAC;YACtB,OAAO,iBAAiB,CAAC,mBAAmB,CAAC;QAC/C,CAAC;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,CAAC;gBACtC,uBAAA,IAAI,4FAAa,MAAjB,IAAI,EAAc,iBAAiB,CAAC,CAAC;YACvC,CAAC;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,CAAC;gBACD,uBAAA,IAAI,4FAAa,MAAjB,IAAI,EAAc,iBAAiB,CAAC,CAAC;YACvC,CAAC;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,CAAC;gBACD,uBAAA,IAAI,4FAAa,MAAjB,IAAI,EAAc,iBAAiB,CAAC,CAAC;YACvC,CAAC;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 { MultichainApiNotifications } from '../handlers/types.js';\nimport type { ExtendedJsonRpcMiddleware } from './MultichainMiddlewareManager.js';\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: MultichainApiNotifications.walletNotify,\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"]}

package/dist/middlewares/{MultichainSubscriptionManager.d.ts → MultichainSubscriptionManager.d.cts}

@@ -1,8 +1,8 @@
-import type { ExternalScopeString } from '@metamask/chain-agnostic-permission';
-import type { NetworkController } from '@metamask/network-controller';
-import SafeEventEmitter from '@metamask/safe-event-emitter';
-import type { Hex } from '@metamask/utils';
-import type { ExtendedJsonRpcMiddleware } from './MultichainMiddlewareManager.js';
+import type { ExternalScopeString } from "@metamask/chain-agnostic-permission";
+import type { NetworkController } from "@metamask/network-controller";
+import SafeEventEmitter from "@metamask/safe-event-emitter";
+import type { Hex } from "@metamask/utils";
+import type { ExtendedJsonRpcMiddleware } from "./MultichainMiddlewareManager.cjs";
 export type SubscriptionManager = {
     events: SafeEventEmitter;
     destroy?: () => void;
@@ -46,4 +46,4 @@ export declare class MultichainSubscriptionManager extends SafeEventEmitter {
     unsubscribeByOriginAndTabId(origin: string, tabId?: number): void;
 }
 export {};
-//# sourceMappingURL=MultichainSubscriptionManager.d.ts.map
+//# sourceMappingURL=MultichainSubscriptionManager.d.cts.map

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

@@ -0,0 +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;AAIxD,OAAO,KAAK,EAAE,yBAAyB,EAAE,0CAAyC;AAElF,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"}

package/dist/middlewares/MultichainSubscriptionManager.d.mts

@@ -0,0 +1,49 @@
+import type { ExternalScopeString } from "@metamask/chain-agnostic-permission";
+import type { NetworkController } from "@metamask/network-controller";
+import SafeEventEmitter from "@metamask/safe-event-emitter";
+import type { Hex } from "@metamask/utils";
+import type { ExtendedJsonRpcMiddleware } from "./MultichainMiddlewareManager.mjs";
+export type SubscriptionManager = {
+    events: SafeEventEmitter;
+    destroy?: () => void;
+    middleware: ExtendedJsonRpcMiddleware;
+};
+type SubscriptionNotificationEvent = {
+    jsonrpc: '2.0';
+    method: 'eth_subscription';
+    params: {
+        subscription: Hex;
+        result: unknown;
+    };
+};
+type SubscriptionKey = {
+    scope: ExternalScopeString;
+    origin: string;
+    tabId?: number;
+};
+type MultichainSubscriptionManagerOptions = {
+    findNetworkClientIdByChainId: NetworkController['findNetworkClientIdByChainId'];
+    getNetworkClientById: NetworkController['getNetworkClientById'];
+};
+/**
+ * A helper that facilates the lifecycle of a SubscriptionManager instance that
+ * is meant to handle subscriptons for only one specific scope, origin, and tabId combination.
+ */
+export declare class MultichainSubscriptionManager extends SafeEventEmitter {
+    #private;
+    /**
+     * Construct a MultichainSubscriptionManager.
+     *
+     * @param options - The controller options.
+     * @param options.findNetworkClientIdByChainId - The hook to get the networkClientId from a chainId.
+     * @param options.getNetworkClientById - The hook to get the network client instance by its networkClientId.
+     */
+    constructor(options: MultichainSubscriptionManagerOptions);
+    notify({ scope, origin, tabId }: SubscriptionKey, { method, params }: SubscriptionNotificationEvent): void;
+    subscribe(subscriptionKey: SubscriptionKey): any;
+    unsubscribeByScope(scope: ExternalScopeString): void;
+    unsubscribeByScopeAndOrigin(scope: ExternalScopeString, origin: string): void;
+    unsubscribeByOriginAndTabId(origin: string, tabId?: number): void;
+}
+export {};
+//# sourceMappingURL=MultichainSubscriptionManager.d.mts.map

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

@@ -0,0 +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;AAIxD,OAAO,KAAK,EAAE,yBAAyB,EAAE,0CAAyC;AAElF,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"}