@metamask-previews/multichain-api-middleware 0.1.0-preview-b69c669

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0]
+
+### Added
+
+- Initial release
+
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/multichain-api-middleware@0.1.0...HEAD
+[0.1.0]: https://github.com/MetaMask/core/releases/tag/@metamask/multichain-api-middleware@0.1.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/multichain-api-middleware`
+
+JSON-RPC methods and middleware to support the the [MetaMask Multichain API](https://github.com/MetaMask/metamask-improvement-proposals/blob/main/MIPs/mip-5.md).
+
+## Installation
+
+`yarn add @metamask/multichain-api-middleware`
+
+or
+
+`npm install @metamask/multichain-api-middleware`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/handlers/wallet-getSession.cjs

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.walletGetSession = void 0;
+const chain_agnostic_permission_1 = require("@metamask/chain-agnostic-permission");
+/**
+ * Handler for the `wallet_getSession` RPC method as specified by [CAIP-312](https://chainagnostic.org/CAIPs/caip-312).
+ * The implementation below deviates from the linked spec in that it ignores the `sessionId` param entirely,
+ * and that an empty object is returned for the `sessionScopes` result rather than throwing an error if there
+ * is no active session for the origin.
+ *
+ * @param _request - The request object.
+ * @param response - The response object.
+ * @param _next - The next middleware function. Unused.
+ * @param end - The end function.
+ * @param hooks - The hooks object.
+ * @param hooks.getCaveatForOrigin - Function to retrieve a caveat for the origin.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ * @returns Nothing.
+ */
+async function walletGetSessionHandler(_request, response, _next, end, hooks) {
+    let caveat;
+    try {
+        caveat = hooks.getCaveatForOrigin(chain_agnostic_permission_1.Caip25EndowmentPermissionName, chain_agnostic_permission_1.Caip25CaveatType);
+    }
+    catch {
+        // noop
+    }
+    if (!caveat) {
+        response.result = { sessionScopes: {} };
+        return end();
+    }
+    response.result = {
+        sessionScopes: (0, chain_agnostic_permission_1.getSessionScopes)(caveat.value, {
+            getNonEvmSupportedMethods: hooks.getNonEvmSupportedMethods,
+        }),
+    };
+    return end();
+}
+exports.walletGetSession = {
+    methodNames: ['wallet_getSession'],
+    implementation: walletGetSessionHandler,
+    hookNames: {
+        getCaveatForOrigin: true,
+        getNonEvmSupportedMethods: true,
+    },
+};
+//# sourceMappingURL=wallet-getSession.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wallet-getSession.cjs","sourceRoot":"","sources":["../../src/handlers/wallet-getSession.ts"],"names":[],"mappings":";;;AAIA,mFAI6C;AAQ7C;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,uBAAuB,CACpC,QAA6C,EAC7C,QAAmE,EACnE,KAAiB,EACjB,GAAe,EACf,KAMC;IAED,IAAI,MAAM,CAAC;IACX,IAAI;QACF,MAAM,GAAG,KAAK,CAAC,kBAAkB,CAC/B,yDAA6B,EAC7B,4CAAgB,CACjB,CAAC;KACH;IAAC,MAAM;QACN,OAAO;KACR;IAED,IAAI,CAAC,MAAM,EAAE;QACX,QAAQ,CAAC,MAAM,GAAG,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC;QACxC,OAAO,GAAG,EAAE,CAAC;KACd;IAED,QAAQ,CAAC,MAAM,GAAG;QAChB,aAAa,EAAE,IAAA,4CAAgB,EAAC,MAAM,CAAC,KAAK,EAAE;YAC5C,yBAAyB,EAAE,KAAK,CAAC,yBAAyB;SAC3D,CAAC;KACH,CAAC;IACF,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAEY,QAAA,gBAAgB,GAAG;IAC9B,WAAW,EAAE,CAAC,mBAAmB,CAAC;IAClC,cAAc,EAAE,uBAAuB;IACvC,SAAS,EAAE;QACT,kBAAkB,EAAE,IAAI;QACxB,yBAAyB,EAAE,IAAI;KAChC;CACF,CAAC","sourcesContent":["import type {\n  Caip25CaveatValue,\n  NormalizedScopesObject,\n} from '@metamask/chain-agnostic-permission';\nimport {\n  Caip25CaveatType,\n  Caip25EndowmentPermissionName,\n  getSessionScopes,\n} from '@metamask/chain-agnostic-permission';\nimport type { Caveat } from '@metamask/permission-controller';\nimport type {\n  CaipChainId,\n  JsonRpcRequest,\n  JsonRpcSuccess,\n} from '@metamask/utils';\n\n/**\n * Handler for the `wallet_getSession` RPC method as specified by [CAIP-312](https://chainagnostic.org/CAIPs/caip-312).\n * The implementation below deviates from the linked spec in that it ignores the `sessionId` param entirely,\n * and that an empty object is returned for the `sessionScopes` result rather than throwing an error if there\n * is no active session for the origin.\n *\n * @param _request - The request object.\n * @param response - The response object.\n * @param _next - The next middleware function. Unused.\n * @param end - The end function.\n * @param hooks - The hooks object.\n * @param hooks.getCaveatForOrigin - Function to retrieve a caveat for the origin.\n * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.\n * @returns Nothing.\n */\nasync function walletGetSessionHandler(\n  _request: JsonRpcRequest & { origin: string },\n  response: JsonRpcSuccess<{ sessionScopes: NormalizedScopesObject }>,\n  _next: () => void,\n  end: () => void,\n  hooks: {\n    getCaveatForOrigin: (\n      endowmentPermissionName: string,\n      caveatType: string,\n    ) => Caveat<typeof Caip25CaveatType, Caip25CaveatValue>;\n    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];\n  },\n) {\n  let caveat;\n  try {\n    caveat = hooks.getCaveatForOrigin(\n      Caip25EndowmentPermissionName,\n      Caip25CaveatType,\n    );\n  } catch {\n    // noop\n  }\n\n  if (!caveat) {\n    response.result = { sessionScopes: {} };\n    return end();\n  }\n\n  response.result = {\n    sessionScopes: getSessionScopes(caveat.value, {\n      getNonEvmSupportedMethods: hooks.getNonEvmSupportedMethods,\n    }),\n  };\n  return end();\n}\n\nexport const walletGetSession = {\n  methodNames: ['wallet_getSession'],\n  implementation: walletGetSessionHandler,\n  hookNames: {\n    getCaveatForOrigin: true,\n    getNonEvmSupportedMethods: true,\n  },\n};\n"]}

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

@@ -0,0 +1,37 @@
+import type { Caip25CaveatValue, NormalizedScopesObject } from "@metamask/chain-agnostic-permission";
+import { Caip25CaveatType } from "@metamask/chain-agnostic-permission";
+import type { Caveat } from "@metamask/permission-controller";
+import type { CaipChainId, JsonRpcRequest, JsonRpcSuccess } from "@metamask/utils";
+/**
+ * Handler for the `wallet_getSession` RPC method as specified by [CAIP-312](https://chainagnostic.org/CAIPs/caip-312).
+ * The implementation below deviates from the linked spec in that it ignores the `sessionId` param entirely,
+ * and that an empty object is returned for the `sessionScopes` result rather than throwing an error if there
+ * is no active session for the origin.
+ *
+ * @param _request - The request object.
+ * @param response - The response object.
+ * @param _next - The next middleware function. Unused.
+ * @param end - The end function.
+ * @param hooks - The hooks object.
+ * @param hooks.getCaveatForOrigin - Function to retrieve a caveat for the origin.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ * @returns Nothing.
+ */
+declare function walletGetSessionHandler(_request: JsonRpcRequest & {
+    origin: string;
+}, response: JsonRpcSuccess<{
+    sessionScopes: NormalizedScopesObject;
+}>, _next: () => void, end: () => void, hooks: {
+    getCaveatForOrigin: (endowmentPermissionName: string, caveatType: string) => Caveat<typeof Caip25CaveatType, Caip25CaveatValue>;
+    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];
+}): Promise<void>;
+export declare const walletGetSession: {
+    methodNames: string[];
+    implementation: typeof walletGetSessionHandler;
+    hookNames: {
+        getCaveatForOrigin: boolean;
+        getNonEvmSupportedMethods: boolean;
+    };
+};
+export {};
+//# sourceMappingURL=wallet-getSession.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wallet-getSession.d.cts","sourceRoot":"","sources":["../../src/handlers/wallet-getSession.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,sBAAsB,EACvB,4CAA4C;AAC7C,OAAO,EACL,gBAAgB,EAGjB,4CAA4C;AAC7C,OAAO,KAAK,EAAE,MAAM,EAAE,wCAAwC;AAC9D,OAAO,KAAK,EACV,WAAW,EACX,cAAc,EACd,cAAc,EACf,wBAAwB;AAEzB;;;;;;;;;;;;;;GAcG;AACH,iBAAe,uBAAuB,CACpC,QAAQ,EAAE,cAAc,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,EAC7C,QAAQ,EAAE,cAAc,CAAC;IAAE,aAAa,EAAE,sBAAsB,CAAA;CAAE,CAAC,EACnE,KAAK,EAAE,MAAM,IAAI,EACjB,GAAG,EAAE,MAAM,IAAI,EACf,KAAK,EAAE;IACL,kBAAkB,EAAE,CAClB,uBAAuB,EAAE,MAAM,EAC/B,UAAU,EAAE,MAAM,KACf,MAAM,CAAC,OAAO,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;IACxD,yBAAyB,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,MAAM,EAAE,CAAC;CAC7D,iBAuBF;AAED,eAAO,MAAM,gBAAgB;;;;;;;CAO5B,CAAC"}

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

@@ -0,0 +1,37 @@
+import type { Caip25CaveatValue, NormalizedScopesObject } from "@metamask/chain-agnostic-permission";
+import { Caip25CaveatType } from "@metamask/chain-agnostic-permission";
+import type { Caveat } from "@metamask/permission-controller";
+import type { CaipChainId, JsonRpcRequest, JsonRpcSuccess } from "@metamask/utils";
+/**
+ * Handler for the `wallet_getSession` RPC method as specified by [CAIP-312](https://chainagnostic.org/CAIPs/caip-312).
+ * The implementation below deviates from the linked spec in that it ignores the `sessionId` param entirely,
+ * and that an empty object is returned for the `sessionScopes` result rather than throwing an error if there
+ * is no active session for the origin.
+ *
+ * @param _request - The request object.
+ * @param response - The response object.
+ * @param _next - The next middleware function. Unused.
+ * @param end - The end function.
+ * @param hooks - The hooks object.
+ * @param hooks.getCaveatForOrigin - Function to retrieve a caveat for the origin.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ * @returns Nothing.
+ */
+declare function walletGetSessionHandler(_request: JsonRpcRequest & {
+    origin: string;
+}, response: JsonRpcSuccess<{
+    sessionScopes: NormalizedScopesObject;
+}>, _next: () => void, end: () => void, hooks: {
+    getCaveatForOrigin: (endowmentPermissionName: string, caveatType: string) => Caveat<typeof Caip25CaveatType, Caip25CaveatValue>;
+    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];
+}): Promise<void>;
+export declare const walletGetSession: {
+    methodNames: string[];
+    implementation: typeof walletGetSessionHandler;
+    hookNames: {
+        getCaveatForOrigin: boolean;
+        getNonEvmSupportedMethods: boolean;
+    };
+};
+export {};
+//# sourceMappingURL=wallet-getSession.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wallet-getSession.d.mts","sourceRoot":"","sources":["../../src/handlers/wallet-getSession.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,sBAAsB,EACvB,4CAA4C;AAC7C,OAAO,EACL,gBAAgB,EAGjB,4CAA4C;AAC7C,OAAO,KAAK,EAAE,MAAM,EAAE,wCAAwC;AAC9D,OAAO,KAAK,EACV,WAAW,EACX,cAAc,EACd,cAAc,EACf,wBAAwB;AAEzB;;;;;;;;;;;;;;GAcG;AACH,iBAAe,uBAAuB,CACpC,QAAQ,EAAE,cAAc,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,EAC7C,QAAQ,EAAE,cAAc,CAAC;IAAE,aAAa,EAAE,sBAAsB,CAAA;CAAE,CAAC,EACnE,KAAK,EAAE,MAAM,IAAI,EACjB,GAAG,EAAE,MAAM,IAAI,EACf,KAAK,EAAE;IACL,kBAAkB,EAAE,CAClB,uBAAuB,EAAE,MAAM,EAC/B,UAAU,EAAE,MAAM,KACf,MAAM,CAAC,OAAO,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;IACxD,yBAAyB,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,MAAM,EAAE,CAAC;CAC7D,iBAuBF;AAED,eAAO,MAAM,gBAAgB;;;;;;;CAO5B,CAAC"}

package/dist/handlers/wallet-getSession.mjs

@@ -0,0 +1,44 @@
+import { Caip25CaveatType, Caip25EndowmentPermissionName, getSessionScopes } from "@metamask/chain-agnostic-permission";
+/**
+ * Handler for the `wallet_getSession` RPC method as specified by [CAIP-312](https://chainagnostic.org/CAIPs/caip-312).
+ * The implementation below deviates from the linked spec in that it ignores the `sessionId` param entirely,
+ * and that an empty object is returned for the `sessionScopes` result rather than throwing an error if there
+ * is no active session for the origin.
+ *
+ * @param _request - The request object.
+ * @param response - The response object.
+ * @param _next - The next middleware function. Unused.
+ * @param end - The end function.
+ * @param hooks - The hooks object.
+ * @param hooks.getCaveatForOrigin - Function to retrieve a caveat for the origin.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ * @returns Nothing.
+ */
+async function walletGetSessionHandler(_request, response, _next, end, hooks) {
+    let caveat;
+    try {
+        caveat = hooks.getCaveatForOrigin(Caip25EndowmentPermissionName, Caip25CaveatType);
+    }
+    catch {
+        // noop
+    }
+    if (!caveat) {
+        response.result = { sessionScopes: {} };
+        return end();
+    }
+    response.result = {
+        sessionScopes: getSessionScopes(caveat.value, {
+            getNonEvmSupportedMethods: hooks.getNonEvmSupportedMethods,
+        }),
+    };
+    return end();
+}
+export const walletGetSession = {
+    methodNames: ['wallet_getSession'],
+    implementation: walletGetSessionHandler,
+    hookNames: {
+        getCaveatForOrigin: true,
+        getNonEvmSupportedMethods: true,
+    },
+};
+//# sourceMappingURL=wallet-getSession.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wallet-getSession.mjs","sourceRoot":"","sources":["../../src/handlers/wallet-getSession.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,gBAAgB,EAChB,6BAA6B,EAC7B,gBAAgB,EACjB,4CAA4C;AAQ7C;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,uBAAuB,CACpC,QAA6C,EAC7C,QAAmE,EACnE,KAAiB,EACjB,GAAe,EACf,KAMC;IAED,IAAI,MAAM,CAAC;IACX,IAAI;QACF,MAAM,GAAG,KAAK,CAAC,kBAAkB,CAC/B,6BAA6B,EAC7B,gBAAgB,CACjB,CAAC;KACH;IAAC,MAAM;QACN,OAAO;KACR;IAED,IAAI,CAAC,MAAM,EAAE;QACX,QAAQ,CAAC,MAAM,GAAG,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC;QACxC,OAAO,GAAG,EAAE,CAAC;KACd;IAED,QAAQ,CAAC,MAAM,GAAG;QAChB,aAAa,EAAE,gBAAgB,CAAC,MAAM,CAAC,KAAK,EAAE;YAC5C,yBAAyB,EAAE,KAAK,CAAC,yBAAyB;SAC3D,CAAC;KACH,CAAC;IACF,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,WAAW,EAAE,CAAC,mBAAmB,CAAC;IAClC,cAAc,EAAE,uBAAuB;IACvC,SAAS,EAAE;QACT,kBAAkB,EAAE,IAAI;QACxB,yBAAyB,EAAE,IAAI;KAChC;CACF,CAAC","sourcesContent":["import type {\n  Caip25CaveatValue,\n  NormalizedScopesObject,\n} from '@metamask/chain-agnostic-permission';\nimport {\n  Caip25CaveatType,\n  Caip25EndowmentPermissionName,\n  getSessionScopes,\n} from '@metamask/chain-agnostic-permission';\nimport type { Caveat } from '@metamask/permission-controller';\nimport type {\n  CaipChainId,\n  JsonRpcRequest,\n  JsonRpcSuccess,\n} from '@metamask/utils';\n\n/**\n * Handler for the `wallet_getSession` RPC method as specified by [CAIP-312](https://chainagnostic.org/CAIPs/caip-312).\n * The implementation below deviates from the linked spec in that it ignores the `sessionId` param entirely,\n * and that an empty object is returned for the `sessionScopes` result rather than throwing an error if there\n * is no active session for the origin.\n *\n * @param _request - The request object.\n * @param response - The response object.\n * @param _next - The next middleware function. Unused.\n * @param end - The end function.\n * @param hooks - The hooks object.\n * @param hooks.getCaveatForOrigin - Function to retrieve a caveat for the origin.\n * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.\n * @returns Nothing.\n */\nasync function walletGetSessionHandler(\n  _request: JsonRpcRequest & { origin: string },\n  response: JsonRpcSuccess<{ sessionScopes: NormalizedScopesObject }>,\n  _next: () => void,\n  end: () => void,\n  hooks: {\n    getCaveatForOrigin: (\n      endowmentPermissionName: string,\n      caveatType: string,\n    ) => Caveat<typeof Caip25CaveatType, Caip25CaveatValue>;\n    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];\n  },\n) {\n  let caveat;\n  try {\n    caveat = hooks.getCaveatForOrigin(\n      Caip25EndowmentPermissionName,\n      Caip25CaveatType,\n    );\n  } catch {\n    // noop\n  }\n\n  if (!caveat) {\n    response.result = { sessionScopes: {} };\n    return end();\n  }\n\n  response.result = {\n    sessionScopes: getSessionScopes(caveat.value, {\n      getNonEvmSupportedMethods: hooks.getNonEvmSupportedMethods,\n    }),\n  };\n  return end();\n}\n\nexport const walletGetSession = {\n  methodNames: ['wallet_getSession'],\n  implementation: walletGetSessionHandler,\n  hookNames: {\n    getCaveatForOrigin: true,\n    getNonEvmSupportedMethods: true,\n  },\n};\n"]}

package/dist/handlers/wallet-invokeMethod.cjs

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.walletInvokeMethod = void 0;
+const chain_agnostic_permission_1 = require("@metamask/chain-agnostic-permission");
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const utils_1 = require("@metamask/utils");
+/**
+ * Handler for the `wallet_invokeMethod` RPC method as specified by [CAIP-27](https://chainagnostic.org/CAIPs/caip-27).
+ * The implementation below deviates from the linked spec in that it ignores the `sessionId` param
+ * and instead uses the singular session for the origin if available.
+ *
+ * @param request - The request object.
+ * @param response - The response object. Unused.
+ * @param next - The next middleware function.
+ * @param end - The end function.
+ * @param hooks - The hooks object.
+ * @param hooks.getCaveatForOrigin - the hook for getting a caveat from a permission for an origin.
+ * @param hooks.findNetworkClientIdByChainId - the hook for finding the networkClientId for a chainId.
+ * @param hooks.getSelectedNetworkClientId - the hook for getting the current globally selected networkClientId.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ * @param hooks.handleNonEvmRequestForOrigin - A function that sends a request to the MultichainRouter for processing.
+ * @returns Nothing.
+ */
+async function walletInvokeMethodHandler(request, response, next, end, hooks) {
+    const { scope, request: wrappedRequest } = request.params;
+    (0, chain_agnostic_permission_1.assertIsInternalScopeString)(scope);
+    let caveat;
+    try {
+        caveat = hooks.getCaveatForOrigin(chain_agnostic_permission_1.Caip25EndowmentPermissionName, chain_agnostic_permission_1.Caip25CaveatType);
+    }
+    catch {
+        // noop
+    }
+    if (!caveat?.value?.isMultichainOrigin) {
+        return end(rpc_errors_1.providerErrors.unauthorized());
+    }
+    const scopeObject = (0, chain_agnostic_permission_1.getSessionScopes)(caveat.value, {
+        getNonEvmSupportedMethods: hooks.getNonEvmSupportedMethods,
+    })[scope];
+    if (!scopeObject?.methods?.includes(wrappedRequest.method)) {
+        return end(rpc_errors_1.providerErrors.unauthorized());
+    }
+    const { namespace, reference } = (0, chain_agnostic_permission_1.parseScopeString)(scope);
+    const isEvmRequest = (namespace === utils_1.KnownCaipNamespace.Wallet &&
+        (!reference || reference === utils_1.KnownCaipNamespace.Eip155)) ||
+        namespace === utils_1.KnownCaipNamespace.Eip155;
+    const unwrappedRequest = {
+        ...request,
+        scope,
+        method: wrappedRequest.method,
+        params: wrappedRequest.params,
+    };
+    if (isEvmRequest) {
+        let networkClientId;
+        if (namespace === utils_1.KnownCaipNamespace.Wallet) {
+            networkClientId = hooks.getSelectedNetworkClientId();
+        }
+        else if (namespace === utils_1.KnownCaipNamespace.Eip155) {
+            if (reference) {
+                networkClientId = hooks.findNetworkClientIdByChainId((0, utils_1.numberToHex)(parseInt(reference, 10)));
+            }
+        }
+        if (!networkClientId) {
+            console.error('failed to resolve network client for wallet_invokeMethod', request);
+            return end(rpc_errors_1.rpcErrors.internal());
+        }
+        Object.assign(request, {
+            ...unwrappedRequest,
+            networkClientId,
+        });
+        return next();
+    }
+    try {
+        response.result = await hooks.handleNonEvmRequestForOrigin({
+            connectedAddresses: scopeObject.accounts,
+            // Type assertion: We know that scope is not "wallet" by now because it
+            // is already being handled above.
+            scope: scope,
+            request: unwrappedRequest,
+        });
+    }
+    catch (err) {
+        return end(err);
+    }
+    return end();
+}
+exports.walletInvokeMethod = {
+    methodNames: ['wallet_invokeMethod'],
+    implementation: walletInvokeMethodHandler,
+    hookNames: {
+        getCaveatForOrigin: true,
+        findNetworkClientIdByChainId: true,
+        getSelectedNetworkClientId: true,
+        getNonEvmSupportedMethods: true,
+        handleNonEvmRequestForOrigin: true,
+    },
+};
+//# sourceMappingURL=wallet-invokeMethod.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wallet-invokeMethod.cjs","sourceRoot":"","sources":["../../src/handlers/wallet-invokeMethod.ts"],"names":[],"mappings":";;;AAIA,mFAM6C;AAG7C,qDAAiE;AASjE,2CAAkE;AAUlE;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,yBAAyB,CACtC,OAAkC,EAClC,QAAsC,EACtC,IAAgB,EAChB,GAA4B,EAC5B,KAaC;IAED,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAE1D,IAAA,uDAA2B,EAAC,KAAK,CAAC,CAAC;IAEnC,IAAI,MAAM,CAAC;IACX,IAAI;QACF,MAAM,GAAG,KAAK,CAAC,kBAAkB,CAC/B,yDAA6B,EAC7B,4CAAgB,CACjB,CAAC;KACH;IAAC,MAAM;QACN,OAAO;KACR;IACD,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,kBAAkB,EAAE;QACtC,OAAO,GAAG,CAAC,2BAAc,CAAC,YAAY,EAAE,CAAC,CAAC;KAC3C;IAED,MAAM,WAAW,GAAG,IAAA,4CAAgB,EAAC,MAAM,CAAC,KAAK,EAAE;QACjD,yBAAyB,EAAE,KAAK,CAAC,yBAAyB;KAC3D,CAAC,CAAC,KAAK,CAAC,CAAC;IAEV,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;QAC1D,OAAO,GAAG,CAAC,2BAAc,CAAC,YAAY,EAAE,CAAC,CAAC;KAC3C;IAED,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,IAAA,4CAAgB,EAAC,KAAK,CAAC,CAAC;IAEzD,MAAM,YAAY,GAChB,CAAC,SAAS,KAAK,0BAAkB,CAAC,MAAM;QACtC,CAAC,CAAC,SAAS,IAAI,SAAS,KAAK,0BAAkB,CAAC,MAAM,CAAC,CAAC;QAC1D,SAAS,KAAK,0BAAkB,CAAC,MAAM,CAAC;IAE1C,MAAM,gBAAgB,GAAG;QACvB,GAAG,OAAO;QACV,KAAK;QACL,MAAM,EAAE,cAAc,CAAC,MAAM;QAC7B,MAAM,EAAE,cAAc,CAAC,MAAM;KAC9B,CAAC;IAEF,IAAI,YAAY,EAAE;QAChB,IAAI,eAAe,CAAC;QACpB,IAAI,SAAS,KAAK,0BAAkB,CAAC,MAAM,EAAE;YAC3C,eAAe,GAAG,KAAK,CAAC,0BAA0B,EAAE,CAAC;SACtD;aAAM,IAAI,SAAS,KAAK,0BAAkB,CAAC,MAAM,EAAE;YAClD,IAAI,SAAS,EAAE;gBACb,eAAe,GAAG,KAAK,CAAC,4BAA4B,CAClD,IAAA,mBAAW,EAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CACrC,CAAC;aACH;SACF;QAED,IAAI,CAAC,eAAe,EAAE;YACpB,OAAO,CAAC,KAAK,CACX,0DAA0D,EAC1D,OAAO,CACR,CAAC;YACF,OAAO,GAAG,CAAC,sBAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;SAClC;QAED,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;YACrB,GAAG,gBAAgB;YACnB,eAAe;SAChB,CAAC,CAAC;QACH,OAAO,IAAI,EAAE,CAAC;KACf;IAED,IAAI;QACF,QAAQ,CAAC,MAAM,GAAG,MAAM,KAAK,CAAC,4BAA4B,CAAC;YACzD,kBAAkB,EAAE,WAAW,CAAC,QAAQ;YACxC,uEAAuE;YACvE,kCAAkC;YAClC,KAAK,EAAE,KAAoB;YAC3B,OAAO,EAAE,gBAAgB;SAC1B,CAAC,CAAC;KACJ;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,GAAG,CAAC,GAAY,CAAC,CAAC;KAC1B;IACD,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AACY,QAAA,kBAAkB,GAAG;IAChC,WAAW,EAAE,CAAC,qBAAqB,CAAC;IACpC,cAAc,EAAE,yBAAyB;IACzC,SAAS,EAAE;QACT,kBAAkB,EAAE,IAAI;QACxB,4BAA4B,EAAE,IAAI;QAClC,0BAA0B,EAAE,IAAI;QAChC,yBAAyB,EAAE,IAAI;QAC/B,4BAA4B,EAAE,IAAI;KACnC;CACF,CAAC","sourcesContent":["import type {\n  Caip25CaveatValue,\n  ExternalScopeString,\n} from '@metamask/chain-agnostic-permission';\nimport {\n  Caip25CaveatType,\n  Caip25EndowmentPermissionName,\n  assertIsInternalScopeString,\n  getSessionScopes,\n  parseScopeString,\n} from '@metamask/chain-agnostic-permission';\nimport type { NetworkClientId } from '@metamask/network-controller';\nimport type { Caveat } from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  CaipAccountId,\n  CaipChainId,\n  Hex,\n  Json,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\nimport { KnownCaipNamespace, numberToHex } from '@metamask/utils';\n\nexport type WalletInvokeMethodRequest = JsonRpcRequest & {\n  origin: string;\n  params: {\n    scope: ExternalScopeString;\n    request: Pick<JsonRpcRequest, 'method' | 'params'>;\n  };\n};\n\n/**\n * Handler for the `wallet_invokeMethod` RPC method as specified by [CAIP-27](https://chainagnostic.org/CAIPs/caip-27).\n * The implementation below deviates from the linked spec in that it ignores the `sessionId` param\n * and instead uses the singular session for the origin if available.\n *\n * @param request - The request object.\n * @param response - The response object. Unused.\n * @param next - The next middleware function.\n * @param end - The end function.\n * @param hooks - The hooks object.\n * @param hooks.getCaveatForOrigin - the hook for getting a caveat from a permission for an origin.\n * @param hooks.findNetworkClientIdByChainId - the hook for finding the networkClientId for a chainId.\n * @param hooks.getSelectedNetworkClientId - the hook for getting the current globally selected networkClientId.\n * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.\n * @param hooks.handleNonEvmRequestForOrigin - A function that sends a request to the MultichainRouter for processing.\n * @returns Nothing.\n */\nasync function walletInvokeMethodHandler(\n  request: WalletInvokeMethodRequest,\n  response: PendingJsonRpcResponse<Json>,\n  next: () => void,\n  end: (error?: Error) => void,\n  hooks: {\n    getCaveatForOrigin: (\n      endowmentPermissionName: string,\n      caveatType: string,\n    ) => Caveat<typeof Caip25CaveatType, Caip25CaveatValue>;\n    findNetworkClientIdByChainId: (chainId: Hex) => NetworkClientId | undefined;\n    getSelectedNetworkClientId: () => NetworkClientId;\n    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];\n    handleNonEvmRequestForOrigin: (params: {\n      connectedAddresses: CaipAccountId[];\n      scope: CaipChainId;\n      request: JsonRpcRequest;\n    }) => Promise<Json>;\n  },\n) {\n  const { scope, request: wrappedRequest } = request.params;\n\n  assertIsInternalScopeString(scope);\n\n  let caveat;\n  try {\n    caveat = hooks.getCaveatForOrigin(\n      Caip25EndowmentPermissionName,\n      Caip25CaveatType,\n    );\n  } catch {\n    // noop\n  }\n  if (!caveat?.value?.isMultichainOrigin) {\n    return end(providerErrors.unauthorized());\n  }\n\n  const scopeObject = getSessionScopes(caveat.value, {\n    getNonEvmSupportedMethods: hooks.getNonEvmSupportedMethods,\n  })[scope];\n\n  if (!scopeObject?.methods?.includes(wrappedRequest.method)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  const { namespace, reference } = parseScopeString(scope);\n\n  const isEvmRequest =\n    (namespace === KnownCaipNamespace.Wallet &&\n      (!reference || reference === KnownCaipNamespace.Eip155)) ||\n    namespace === KnownCaipNamespace.Eip155;\n\n  const unwrappedRequest = {\n    ...request,\n    scope,\n    method: wrappedRequest.method,\n    params: wrappedRequest.params,\n  };\n\n  if (isEvmRequest) {\n    let networkClientId;\n    if (namespace === KnownCaipNamespace.Wallet) {\n      networkClientId = hooks.getSelectedNetworkClientId();\n    } else if (namespace === KnownCaipNamespace.Eip155) {\n      if (reference) {\n        networkClientId = hooks.findNetworkClientIdByChainId(\n          numberToHex(parseInt(reference, 10)),\n        );\n      }\n    }\n\n    if (!networkClientId) {\n      console.error(\n        'failed to resolve network client for wallet_invokeMethod',\n        request,\n      );\n      return end(rpcErrors.internal());\n    }\n\n    Object.assign(request, {\n      ...unwrappedRequest,\n      networkClientId,\n    });\n    return next();\n  }\n\n  try {\n    response.result = await hooks.handleNonEvmRequestForOrigin({\n      connectedAddresses: scopeObject.accounts,\n      // Type assertion: We know that scope is not \"wallet\" by now because it\n      // is already being handled above.\n      scope: scope as CaipChainId,\n      request: unwrappedRequest,\n    });\n  } catch (err) {\n    return end(err as Error);\n  }\n  return end();\n}\nexport const walletInvokeMethod = {\n  methodNames: ['wallet_invokeMethod'],\n  implementation: walletInvokeMethodHandler,\n  hookNames: {\n    getCaveatForOrigin: true,\n    findNetworkClientIdByChainId: true,\n    getSelectedNetworkClientId: true,\n    getNonEvmSupportedMethods: true,\n    handleNonEvmRequestForOrigin: true,\n  },\n};\n"]}

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

@@ -0,0 +1,53 @@
+import type { Caip25CaveatValue, ExternalScopeString } from "@metamask/chain-agnostic-permission";
+import { Caip25CaveatType } from "@metamask/chain-agnostic-permission";
+import type { NetworkClientId } from "@metamask/network-controller";
+import type { Caveat } from "@metamask/permission-controller";
+import type { CaipAccountId, CaipChainId, Hex, Json, JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
+export type WalletInvokeMethodRequest = JsonRpcRequest & {
+    origin: string;
+    params: {
+        scope: ExternalScopeString;
+        request: Pick<JsonRpcRequest, 'method' | 'params'>;
+    };
+};
+/**
+ * Handler for the `wallet_invokeMethod` RPC method as specified by [CAIP-27](https://chainagnostic.org/CAIPs/caip-27).
+ * The implementation below deviates from the linked spec in that it ignores the `sessionId` param
+ * and instead uses the singular session for the origin if available.
+ *
+ * @param request - The request object.
+ * @param response - The response object. Unused.
+ * @param next - The next middleware function.
+ * @param end - The end function.
+ * @param hooks - The hooks object.
+ * @param hooks.getCaveatForOrigin - the hook for getting a caveat from a permission for an origin.
+ * @param hooks.findNetworkClientIdByChainId - the hook for finding the networkClientId for a chainId.
+ * @param hooks.getSelectedNetworkClientId - the hook for getting the current globally selected networkClientId.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ * @param hooks.handleNonEvmRequestForOrigin - A function that sends a request to the MultichainRouter for processing.
+ * @returns Nothing.
+ */
+declare function walletInvokeMethodHandler(request: WalletInvokeMethodRequest, response: PendingJsonRpcResponse<Json>, next: () => void, end: (error?: Error) => void, hooks: {
+    getCaveatForOrigin: (endowmentPermissionName: string, caveatType: string) => Caveat<typeof Caip25CaveatType, Caip25CaveatValue>;
+    findNetworkClientIdByChainId: (chainId: Hex) => NetworkClientId | undefined;
+    getSelectedNetworkClientId: () => NetworkClientId;
+    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];
+    handleNonEvmRequestForOrigin: (params: {
+        connectedAddresses: CaipAccountId[];
+        scope: CaipChainId;
+        request: JsonRpcRequest;
+    }) => Promise<Json>;
+}): Promise<void>;
+export declare const walletInvokeMethod: {
+    methodNames: string[];
+    implementation: typeof walletInvokeMethodHandler;
+    hookNames: {
+        getCaveatForOrigin: boolean;
+        findNetworkClientIdByChainId: boolean;
+        getSelectedNetworkClientId: boolean;
+        getNonEvmSupportedMethods: boolean;
+        handleNonEvmRequestForOrigin: boolean;
+    };
+};
+export {};
+//# sourceMappingURL=wallet-invokeMethod.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wallet-invokeMethod.d.cts","sourceRoot":"","sources":["../../src/handlers/wallet-invokeMethod.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,mBAAmB,EACpB,4CAA4C;AAC7C,OAAO,EACL,gBAAgB,EAKjB,4CAA4C;AAC7C,OAAO,KAAK,EAAE,eAAe,EAAE,qCAAqC;AACpE,OAAO,KAAK,EAAE,MAAM,EAAE,wCAAwC;AAE9D,OAAO,KAAK,EACV,aAAa,EACb,WAAW,EACX,GAAG,EACH,IAAI,EACJ,cAAc,EACd,sBAAsB,EACvB,wBAAwB;AAGzB,MAAM,MAAM,yBAAyB,GAAG,cAAc,GAAG;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE;QACN,KAAK,EAAE,mBAAmB,CAAC;QAC3B,OAAO,EAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,GAAG,QAAQ,CAAC,CAAC;KACpD,CAAC;CACH,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,iBAAe,yBAAyB,CACtC,OAAO,EAAE,yBAAyB,EAClC,QAAQ,EAAE,sBAAsB,CAAC,IAAI,CAAC,EACtC,IAAI,EAAE,MAAM,IAAI,EAChB,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,IAAI,EAC5B,KAAK,EAAE;IACL,kBAAkB,EAAE,CAClB,uBAAuB,EAAE,MAAM,EAC/B,UAAU,EAAE,MAAM,KACf,MAAM,CAAC,OAAO,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;IACxD,4BAA4B,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,eAAe,GAAG,SAAS,CAAC;IAC5E,0BAA0B,EAAE,MAAM,eAAe,CAAC;IAClD,yBAAyB,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,MAAM,EAAE,CAAC;IAC5D,4BAA4B,EAAE,CAAC,MAAM,EAAE;QACrC,kBAAkB,EAAE,aAAa,EAAE,CAAC;QACpC,KAAK,EAAE,WAAW,CAAC;QACnB,OAAO,EAAE,cAAc,CAAC;KACzB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACrB,iBAgFF;AACD,eAAO,MAAM,kBAAkB;;;;;;;;;;CAU9B,CAAC"}

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

@@ -0,0 +1,53 @@
+import type { Caip25CaveatValue, ExternalScopeString } from "@metamask/chain-agnostic-permission";
+import { Caip25CaveatType } from "@metamask/chain-agnostic-permission";
+import type { NetworkClientId } from "@metamask/network-controller";
+import type { Caveat } from "@metamask/permission-controller";
+import type { CaipAccountId, CaipChainId, Hex, Json, JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
+export type WalletInvokeMethodRequest = JsonRpcRequest & {
+    origin: string;
+    params: {
+        scope: ExternalScopeString;
+        request: Pick<JsonRpcRequest, 'method' | 'params'>;
+    };
+};
+/**
+ * Handler for the `wallet_invokeMethod` RPC method as specified by [CAIP-27](https://chainagnostic.org/CAIPs/caip-27).
+ * The implementation below deviates from the linked spec in that it ignores the `sessionId` param
+ * and instead uses the singular session for the origin if available.
+ *
+ * @param request - The request object.
+ * @param response - The response object. Unused.
+ * @param next - The next middleware function.
+ * @param end - The end function.
+ * @param hooks - The hooks object.
+ * @param hooks.getCaveatForOrigin - the hook for getting a caveat from a permission for an origin.
+ * @param hooks.findNetworkClientIdByChainId - the hook for finding the networkClientId for a chainId.
+ * @param hooks.getSelectedNetworkClientId - the hook for getting the current globally selected networkClientId.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ * @param hooks.handleNonEvmRequestForOrigin - A function that sends a request to the MultichainRouter for processing.
+ * @returns Nothing.
+ */
+declare function walletInvokeMethodHandler(request: WalletInvokeMethodRequest, response: PendingJsonRpcResponse<Json>, next: () => void, end: (error?: Error) => void, hooks: {
+    getCaveatForOrigin: (endowmentPermissionName: string, caveatType: string) => Caveat<typeof Caip25CaveatType, Caip25CaveatValue>;
+    findNetworkClientIdByChainId: (chainId: Hex) => NetworkClientId | undefined;
+    getSelectedNetworkClientId: () => NetworkClientId;
+    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];
+    handleNonEvmRequestForOrigin: (params: {
+        connectedAddresses: CaipAccountId[];
+        scope: CaipChainId;
+        request: JsonRpcRequest;
+    }) => Promise<Json>;
+}): Promise<void>;
+export declare const walletInvokeMethod: {
+    methodNames: string[];
+    implementation: typeof walletInvokeMethodHandler;
+    hookNames: {
+        getCaveatForOrigin: boolean;
+        findNetworkClientIdByChainId: boolean;
+        getSelectedNetworkClientId: boolean;
+        getNonEvmSupportedMethods: boolean;
+        handleNonEvmRequestForOrigin: boolean;
+    };
+};
+export {};
+//# sourceMappingURL=wallet-invokeMethod.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wallet-invokeMethod.d.mts","sourceRoot":"","sources":["../../src/handlers/wallet-invokeMethod.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,mBAAmB,EACpB,4CAA4C;AAC7C,OAAO,EACL,gBAAgB,EAKjB,4CAA4C;AAC7C,OAAO,KAAK,EAAE,eAAe,EAAE,qCAAqC;AACpE,OAAO,KAAK,EAAE,MAAM,EAAE,wCAAwC;AAE9D,OAAO,KAAK,EACV,aAAa,EACb,WAAW,EACX,GAAG,EACH,IAAI,EACJ,cAAc,EACd,sBAAsB,EACvB,wBAAwB;AAGzB,MAAM,MAAM,yBAAyB,GAAG,cAAc,GAAG;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE;QACN,KAAK,EAAE,mBAAmB,CAAC;QAC3B,OAAO,EAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,GAAG,QAAQ,CAAC,CAAC;KACpD,CAAC;CACH,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,iBAAe,yBAAyB,CACtC,OAAO,EAAE,yBAAyB,EAClC,QAAQ,EAAE,sBAAsB,CAAC,IAAI,CAAC,EACtC,IAAI,EAAE,MAAM,IAAI,EAChB,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,IAAI,EAC5B,KAAK,EAAE;IACL,kBAAkB,EAAE,CAClB,uBAAuB,EAAE,MAAM,EAC/B,UAAU,EAAE,MAAM,KACf,MAAM,CAAC,OAAO,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;IACxD,4BAA4B,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,eAAe,GAAG,SAAS,CAAC;IAC5E,0BAA0B,EAAE,MAAM,eAAe,CAAC;IAClD,yBAAyB,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,MAAM,EAAE,CAAC;IAC5D,4BAA4B,EAAE,CAAC,MAAM,EAAE;QACrC,kBAAkB,EAAE,aAAa,EAAE,CAAC;QACpC,KAAK,EAAE,WAAW,CAAC;QACnB,OAAO,EAAE,cAAc,CAAC;KACzB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACrB,iBAgFF;AACD,eAAO,MAAM,kBAAkB;;;;;;;;;;CAU9B,CAAC"}

package/dist/handlers/wallet-invokeMethod.mjs

@@ -0,0 +1,95 @@
+import { Caip25CaveatType, Caip25EndowmentPermissionName, assertIsInternalScopeString, getSessionScopes, parseScopeString } from "@metamask/chain-agnostic-permission";
+import { providerErrors, rpcErrors } from "@metamask/rpc-errors";
+import { KnownCaipNamespace, numberToHex } from "@metamask/utils";
+/**
+ * Handler for the `wallet_invokeMethod` RPC method as specified by [CAIP-27](https://chainagnostic.org/CAIPs/caip-27).
+ * The implementation below deviates from the linked spec in that it ignores the `sessionId` param
+ * and instead uses the singular session for the origin if available.
+ *
+ * @param request - The request object.
+ * @param response - The response object. Unused.
+ * @param next - The next middleware function.
+ * @param end - The end function.
+ * @param hooks - The hooks object.
+ * @param hooks.getCaveatForOrigin - the hook for getting a caveat from a permission for an origin.
+ * @param hooks.findNetworkClientIdByChainId - the hook for finding the networkClientId for a chainId.
+ * @param hooks.getSelectedNetworkClientId - the hook for getting the current globally selected networkClientId.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ * @param hooks.handleNonEvmRequestForOrigin - A function that sends a request to the MultichainRouter for processing.
+ * @returns Nothing.
+ */
+async function walletInvokeMethodHandler(request, response, next, end, hooks) {
+    const { scope, request: wrappedRequest } = request.params;
+    assertIsInternalScopeString(scope);
+    let caveat;
+    try {
+        caveat = hooks.getCaveatForOrigin(Caip25EndowmentPermissionName, Caip25CaveatType);
+    }
+    catch {
+        // noop
+    }
+    if (!caveat?.value?.isMultichainOrigin) {
+        return end(providerErrors.unauthorized());
+    }
+    const scopeObject = getSessionScopes(caveat.value, {
+        getNonEvmSupportedMethods: hooks.getNonEvmSupportedMethods,
+    })[scope];
+    if (!scopeObject?.methods?.includes(wrappedRequest.method)) {
+        return end(providerErrors.unauthorized());
+    }
+    const { namespace, reference } = parseScopeString(scope);
+    const isEvmRequest = (namespace === KnownCaipNamespace.Wallet &&
+        (!reference || reference === KnownCaipNamespace.Eip155)) ||
+        namespace === KnownCaipNamespace.Eip155;
+    const unwrappedRequest = {
+        ...request,
+        scope,
+        method: wrappedRequest.method,
+        params: wrappedRequest.params,
+    };
+    if (isEvmRequest) {
+        let networkClientId;
+        if (namespace === KnownCaipNamespace.Wallet) {
+            networkClientId = hooks.getSelectedNetworkClientId();
+        }
+        else if (namespace === KnownCaipNamespace.Eip155) {
+            if (reference) {
+                networkClientId = hooks.findNetworkClientIdByChainId(numberToHex(parseInt(reference, 10)));
+            }
+        }
+        if (!networkClientId) {
+            console.error('failed to resolve network client for wallet_invokeMethod', request);
+            return end(rpcErrors.internal());
+        }
+        Object.assign(request, {
+            ...unwrappedRequest,
+            networkClientId,
+        });
+        return next();
+    }
+    try {
+        response.result = await hooks.handleNonEvmRequestForOrigin({
+            connectedAddresses: scopeObject.accounts,
+            // Type assertion: We know that scope is not "wallet" by now because it
+            // is already being handled above.
+            scope: scope,
+            request: unwrappedRequest,
+        });
+    }
+    catch (err) {
+        return end(err);
+    }
+    return end();
+}
+export const walletInvokeMethod = {
+    methodNames: ['wallet_invokeMethod'],
+    implementation: walletInvokeMethodHandler,
+    hookNames: {
+        getCaveatForOrigin: true,
+        findNetworkClientIdByChainId: true,
+        getSelectedNetworkClientId: true,
+        getNonEvmSupportedMethods: true,
+        handleNonEvmRequestForOrigin: true,
+    },
+};
+//# sourceMappingURL=wallet-invokeMethod.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wallet-invokeMethod.mjs","sourceRoot":"","sources":["../../src/handlers/wallet-invokeMethod.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,gBAAgB,EAChB,6BAA6B,EAC7B,2BAA2B,EAC3B,gBAAgB,EAChB,gBAAgB,EACjB,4CAA4C;AAG7C,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AASjE,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,wBAAwB;AAUlE;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,yBAAyB,CACtC,OAAkC,EAClC,QAAsC,EACtC,IAAgB,EAChB,GAA4B,EAC5B,KAaC;IAED,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAE1D,2BAA2B,CAAC,KAAK,CAAC,CAAC;IAEnC,IAAI,MAAM,CAAC;IACX,IAAI;QACF,MAAM,GAAG,KAAK,CAAC,kBAAkB,CAC/B,6BAA6B,EAC7B,gBAAgB,CACjB,CAAC;KACH;IAAC,MAAM;QACN,OAAO;KACR;IACD,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,kBAAkB,EAAE;QACtC,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;KAC3C;IAED,MAAM,WAAW,GAAG,gBAAgB,CAAC,MAAM,CAAC,KAAK,EAAE;QACjD,yBAAyB,EAAE,KAAK,CAAC,yBAAyB;KAC3D,CAAC,CAAC,KAAK,CAAC,CAAC;IAEV,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;QAC1D,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;KAC3C;IAED,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAEzD,MAAM,YAAY,GAChB,CAAC,SAAS,KAAK,kBAAkB,CAAC,MAAM;QACtC,CAAC,CAAC,SAAS,IAAI,SAAS,KAAK,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC1D,SAAS,KAAK,kBAAkB,CAAC,MAAM,CAAC;IAE1C,MAAM,gBAAgB,GAAG;QACvB,GAAG,OAAO;QACV,KAAK;QACL,MAAM,EAAE,cAAc,CAAC,MAAM;QAC7B,MAAM,EAAE,cAAc,CAAC,MAAM;KAC9B,CAAC;IAEF,IAAI,YAAY,EAAE;QAChB,IAAI,eAAe,CAAC;QACpB,IAAI,SAAS,KAAK,kBAAkB,CAAC,MAAM,EAAE;YAC3C,eAAe,GAAG,KAAK,CAAC,0BAA0B,EAAE,CAAC;SACtD;aAAM,IAAI,SAAS,KAAK,kBAAkB,CAAC,MAAM,EAAE;YAClD,IAAI,SAAS,EAAE;gBACb,eAAe,GAAG,KAAK,CAAC,4BAA4B,CAClD,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CACrC,CAAC;aACH;SACF;QAED,IAAI,CAAC,eAAe,EAAE;YACpB,OAAO,CAAC,KAAK,CACX,0DAA0D,EAC1D,OAAO,CACR,CAAC;YACF,OAAO,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;SAClC;QAED,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;YACrB,GAAG,gBAAgB;YACnB,eAAe;SAChB,CAAC,CAAC;QACH,OAAO,IAAI,EAAE,CAAC;KACf;IAED,IAAI;QACF,QAAQ,CAAC,MAAM,GAAG,MAAM,KAAK,CAAC,4BAA4B,CAAC;YACzD,kBAAkB,EAAE,WAAW,CAAC,QAAQ;YACxC,uEAAuE;YACvE,kCAAkC;YAClC,KAAK,EAAE,KAAoB;YAC3B,OAAO,EAAE,gBAAgB;SAC1B,CAAC,CAAC;KACJ;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,GAAG,CAAC,GAAY,CAAC,CAAC;KAC1B;IACD,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AACD,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,WAAW,EAAE,CAAC,qBAAqB,CAAC;IACpC,cAAc,EAAE,yBAAyB;IACzC,SAAS,EAAE;QACT,kBAAkB,EAAE,IAAI;QACxB,4BAA4B,EAAE,IAAI;QAClC,0BAA0B,EAAE,IAAI;QAChC,yBAAyB,EAAE,IAAI;QAC/B,4BAA4B,EAAE,IAAI;KACnC;CACF,CAAC","sourcesContent":["import type {\n  Caip25CaveatValue,\n  ExternalScopeString,\n} from '@metamask/chain-agnostic-permission';\nimport {\n  Caip25CaveatType,\n  Caip25EndowmentPermissionName,\n  assertIsInternalScopeString,\n  getSessionScopes,\n  parseScopeString,\n} from '@metamask/chain-agnostic-permission';\nimport type { NetworkClientId } from '@metamask/network-controller';\nimport type { Caveat } from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  CaipAccountId,\n  CaipChainId,\n  Hex,\n  Json,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\nimport { KnownCaipNamespace, numberToHex } from '@metamask/utils';\n\nexport type WalletInvokeMethodRequest = JsonRpcRequest & {\n  origin: string;\n  params: {\n    scope: ExternalScopeString;\n    request: Pick<JsonRpcRequest, 'method' | 'params'>;\n  };\n};\n\n/**\n * Handler for the `wallet_invokeMethod` RPC method as specified by [CAIP-27](https://chainagnostic.org/CAIPs/caip-27).\n * The implementation below deviates from the linked spec in that it ignores the `sessionId` param\n * and instead uses the singular session for the origin if available.\n *\n * @param request - The request object.\n * @param response - The response object. Unused.\n * @param next - The next middleware function.\n * @param end - The end function.\n * @param hooks - The hooks object.\n * @param hooks.getCaveatForOrigin - the hook for getting a caveat from a permission for an origin.\n * @param hooks.findNetworkClientIdByChainId - the hook for finding the networkClientId for a chainId.\n * @param hooks.getSelectedNetworkClientId - the hook for getting the current globally selected networkClientId.\n * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.\n * @param hooks.handleNonEvmRequestForOrigin - A function that sends a request to the MultichainRouter for processing.\n * @returns Nothing.\n */\nasync function walletInvokeMethodHandler(\n  request: WalletInvokeMethodRequest,\n  response: PendingJsonRpcResponse<Json>,\n  next: () => void,\n  end: (error?: Error) => void,\n  hooks: {\n    getCaveatForOrigin: (\n      endowmentPermissionName: string,\n      caveatType: string,\n    ) => Caveat<typeof Caip25CaveatType, Caip25CaveatValue>;\n    findNetworkClientIdByChainId: (chainId: Hex) => NetworkClientId | undefined;\n    getSelectedNetworkClientId: () => NetworkClientId;\n    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];\n    handleNonEvmRequestForOrigin: (params: {\n      connectedAddresses: CaipAccountId[];\n      scope: CaipChainId;\n      request: JsonRpcRequest;\n    }) => Promise<Json>;\n  },\n) {\n  const { scope, request: wrappedRequest } = request.params;\n\n  assertIsInternalScopeString(scope);\n\n  let caveat;\n  try {\n    caveat = hooks.getCaveatForOrigin(\n      Caip25EndowmentPermissionName,\n      Caip25CaveatType,\n    );\n  } catch {\n    // noop\n  }\n  if (!caveat?.value?.isMultichainOrigin) {\n    return end(providerErrors.unauthorized());\n  }\n\n  const scopeObject = getSessionScopes(caveat.value, {\n    getNonEvmSupportedMethods: hooks.getNonEvmSupportedMethods,\n  })[scope];\n\n  if (!scopeObject?.methods?.includes(wrappedRequest.method)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  const { namespace, reference } = parseScopeString(scope);\n\n  const isEvmRequest =\n    (namespace === KnownCaipNamespace.Wallet &&\n      (!reference || reference === KnownCaipNamespace.Eip155)) ||\n    namespace === KnownCaipNamespace.Eip155;\n\n  const unwrappedRequest = {\n    ...request,\n    scope,\n    method: wrappedRequest.method,\n    params: wrappedRequest.params,\n  };\n\n  if (isEvmRequest) {\n    let networkClientId;\n    if (namespace === KnownCaipNamespace.Wallet) {\n      networkClientId = hooks.getSelectedNetworkClientId();\n    } else if (namespace === KnownCaipNamespace.Eip155) {\n      if (reference) {\n        networkClientId = hooks.findNetworkClientIdByChainId(\n          numberToHex(parseInt(reference, 10)),\n        );\n      }\n    }\n\n    if (!networkClientId) {\n      console.error(\n        'failed to resolve network client for wallet_invokeMethod',\n        request,\n      );\n      return end(rpcErrors.internal());\n    }\n\n    Object.assign(request, {\n      ...unwrappedRequest,\n      networkClientId,\n    });\n    return next();\n  }\n\n  try {\n    response.result = await hooks.handleNonEvmRequestForOrigin({\n      connectedAddresses: scopeObject.accounts,\n      // Type assertion: We know that scope is not \"wallet\" by now because it\n      // is already being handled above.\n      scope: scope as CaipChainId,\n      request: unwrappedRequest,\n    });\n  } catch (err) {\n    return end(err as Error);\n  }\n  return end();\n}\nexport const walletInvokeMethod = {\n  methodNames: ['wallet_invokeMethod'],\n  implementation: walletInvokeMethodHandler,\n  hookNames: {\n    getCaveatForOrigin: true,\n    findNetworkClientIdByChainId: true,\n    getSelectedNetworkClientId: true,\n    getNonEvmSupportedMethods: true,\n    handleNonEvmRequestForOrigin: true,\n  },\n};\n"]}