@metamask/snaps-rpc-methods 15.1.0 → 16.0.0

package/dist/permitted/index.d.mts

@@ -1,27 +1,31 @@
-import type { CancelBackgroundEventMethodHooks } from "./cancelBackgroundEvent.mjs";
-import type { ClearStateHooks } from "./clearState.mjs";
-import type { CloseWebSocketMethodHooks } from "./closeWebSocket.mjs";
-import type { CreateInterfaceMethodHooks } from "./createInterface.mjs";
-import type { EndTraceMethodHooks } from "./endTrace.mjs";
-import type { GetAllSnapsHooks } from "./getAllSnaps.mjs";
-import type { GetBackgroundEventsMethodHooks } from "./getBackgroundEvents.mjs";
-import type { GetClientStatusHooks } from "./getClientStatus.mjs";
-import type { GetInterfaceStateMethodHooks } from "./getInterfaceState.mjs";
-import type { GetSnapsHooks } from "./getSnaps.mjs";
-import type { GetStateHooks } from "./getState.mjs";
-import type { GetWebSocketsMethodHooks } from "./getWebSockets.mjs";
-import type { ListEntropySourcesHooks } from "./listEntropySources.mjs";
-import type { OpenWebSocketMethodHooks } from "./openWebSocket.mjs";
-import type { RequestSnapsHooks } from "./requestSnaps.mjs";
-import type { ResolveInterfaceMethodHooks } from "./resolveInterface.mjs";
-import type { ScheduleBackgroundEventMethodHooks } from "./scheduleBackgroundEvent.mjs";
-import type { SendWebSocketMessageMethodHooks } from "./sendWebSocketMessage.mjs";
-import type { SetStateHooks } from "./setState.mjs";
-import type { StartTraceMethodHooks } from "./startTrace.mjs";
-import type { TrackErrorMethodHooks } from "./trackError.mjs";
-import type { TrackEventMethodHooks } from "./trackEvent.mjs";
-import type { UpdateInterfaceMethodHooks } from "./updateInterface.mjs";
-export type PermittedRpcMethodHooks = ClearStateHooks & GetAllSnapsHooks & GetClientStatusHooks & GetSnapsHooks & GetStateHooks & ListEntropySourcesHooks & RequestSnapsHooks & CreateInterfaceMethodHooks & UpdateInterfaceMethodHooks & GetInterfaceStateMethodHooks & ResolveInterfaceMethodHooks & ScheduleBackgroundEventMethodHooks & CancelBackgroundEventMethodHooks & GetBackgroundEventsMethodHooks & SetStateHooks & OpenWebSocketMethodHooks & CloseWebSocketMethodHooks & SendWebSocketMessageMethodHooks & GetWebSocketsMethodHooks & TrackEventMethodHooks & TrackErrorMethodHooks & StartTraceMethodHooks & EndTraceMethodHooks;
-export * from "./handlers.mjs";
+import type { CancelBackgroundEventMethodActions } from "./cancelBackgroundEvent.mjs";
+import type { ClearStateMethodActions } from "./clearState.mjs";
+import type { CloseWebSocketMethodActions } from "./closeWebSocket.mjs";
+import type { CreateInterfaceMethodActions } from "./createInterface.mjs";
+import type { EndTraceMethodActions, EndTraceMethodHooks } from "./endTrace.mjs";
+import type { GetAllSnapsMethodActions } from "./getAllSnaps.mjs";
+import type { GetBackgroundEventsMethodActions } from "./getBackgroundEvents.mjs";
+import type { GetClientStatusMethodActions, GetClientStatusMethodHooks } from "./getClientStatus.mjs";
+import type { GetFileMethodActions } from "./getFile.mjs";
+import type { GetInterfaceContextMethodActions } from "./getInterfaceContext.mjs";
+import type { GetInterfaceStateMethodActions } from "./getInterfaceState.mjs";
+import type { GetSnapsMethodActions } from "./getSnaps.mjs";
+import type { GetStateMethodActions, GetStateMethodHooks } from "./getState.mjs";
+import type { GetWebSocketsMethodActions } from "./getWebSockets.mjs";
+import type { InvokeKeyringMethodActions, InvokeKeyringMethodHooks } from "./invokeKeyring.mjs";
+import type { InvokeSnapSugarMethodActions } from "./invokeSnapSugar.mjs";
+import type { ListEntropySourcesMethodActions, ListEntropySourcesMethodHooks } from "./listEntropySources.mjs";
+import type { OpenWebSocketMethodActions } from "./openWebSocket.mjs";
+import type { RequestSnapsMethodActions } from "./requestSnaps.mjs";
+import type { ResolveInterfaceMethodActions } from "./resolveInterface.mjs";
+import type { ScheduleBackgroundEventMethodActions } from "./scheduleBackgroundEvent.mjs";
+import type { SendWebSocketMessageMethodActions } from "./sendWebSocketMessage.mjs";
+import type { SetStateMethodActions, SetStateMethodHooks } from "./setState.mjs";
+import type { StartTraceMethodActions, StartTraceMethodHooks } from "./startTrace.mjs";
+import type { TrackErrorMethodActions, TrackErrorMethodHooks } from "./trackError.mjs";
+import type { TrackEventMethodActions, TrackEventMethodHooks } from "./trackEvent.mjs";
+import type { UpdateInterfaceMethodActions } from "./updateInterface.mjs";
+export type PermittedRpcMethodActions = CancelBackgroundEventMethodActions | ClearStateMethodActions | CloseWebSocketMethodActions | CreateInterfaceMethodActions | EndTraceMethodActions | GetAllSnapsMethodActions | GetBackgroundEventsMethodActions | GetClientStatusMethodActions | GetFileMethodActions | GetInterfaceContextMethodActions | GetInterfaceStateMethodActions | GetSnapsMethodActions | GetStateMethodActions | GetWebSocketsMethodActions | InvokeKeyringMethodActions | InvokeSnapSugarMethodActions | ListEntropySourcesMethodActions | OpenWebSocketMethodActions | RequestSnapsMethodActions | ResolveInterfaceMethodActions | ScheduleBackgroundEventMethodActions | SendWebSocketMessageMethodActions | SetStateMethodActions | StartTraceMethodActions | TrackErrorMethodActions | TrackEventMethodActions | UpdateInterfaceMethodActions;
+export type PermittedRpcMethodHooks = GetClientStatusMethodHooks & GetStateMethodHooks & ListEntropySourcesMethodHooks & SetStateMethodHooks & TrackEventMethodHooks & TrackErrorMethodHooks & StartTraceMethodHooks & EndTraceMethodHooks & InvokeKeyringMethodHooks;
 export * from "./middleware.mjs";
 //# sourceMappingURL=index.d.mts.map

package/dist/permitted/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/permitted/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gCAAgC,EAAE,oCAAgC;AAChF,OAAO,KAAK,EAAE,eAAe,EAAE,yBAAqB;AACpD,OAAO,KAAK,EAAE,yBAAyB,EAAE,6BAAyB;AAClE,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AACpE,OAAO,KAAK,EAAE,mBAAmB,EAAE,uBAAmB;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,0BAAsB;AACtD,OAAO,KAAK,EAAE,8BAA8B,EAAE,kCAA8B;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,8BAA0B;AAC9D,OAAO,KAAK,EAAE,4BAA4B,EAAE,gCAA4B;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,uBAAmB;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,uBAAmB;AAChD,OAAO,KAAK,EAAE,wBAAwB,EAAE,4BAAwB;AAChE,OAAO,KAAK,EAAE,uBAAuB,EAAE,iCAA6B;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,4BAAwB;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,2BAAuB;AACxD,OAAO,KAAK,EAAE,2BAA2B,EAAE,+BAA2B;AACtE,OAAO,KAAK,EAAE,kCAAkC,EAAE,sCAAkC;AACpF,OAAO,KAAK,EAAE,+BAA+B,EAAE,mCAA+B;AAC9E,OAAO,KAAK,EAAE,aAAa,EAAE,uBAAmB;AAChD,OAAO,KAAK,EAAE,qBAAqB,EAAE,yBAAqB;AAC1D,OAAO,KAAK,EAAE,qBAAqB,EAAE,yBAAqB;AAC1D,OAAO,KAAK,EAAE,qBAAqB,EAAE,yBAAqB;AAC1D,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AAEpE,MAAM,MAAM,uBAAuB,GAAG,eAAe,GACnD,gBAAgB,GAChB,oBAAoB,GACpB,aAAa,GACb,aAAa,GACb,uBAAuB,GACvB,iBAAiB,GACjB,0BAA0B,GAC1B,0BAA0B,GAC1B,4BAA4B,GAC5B,2BAA2B,GAC3B,kCAAkC,GAClC,gCAAgC,GAChC,8BAA8B,GAC9B,aAAa,GACb,wBAAwB,GACxB,yBAAyB,GACzB,+BAA+B,GAC/B,wBAAwB,GACxB,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,GACrB,mBAAmB,CAAC;AAEtB,+BAA2B;AAC3B,iCAA6B"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/permitted/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kCAAkC,EAAE,oCAAgC;AAClF,OAAO,KAAK,EAAE,uBAAuB,EAAE,yBAAqB;AAC5D,OAAO,KAAK,EAAE,2BAA2B,EAAE,6BAAyB;AACpE,OAAO,KAAK,EAAE,4BAA4B,EAAE,8BAA0B;AACtE,OAAO,KAAK,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,uBAAmB;AAC7E,OAAO,KAAK,EAAE,wBAAwB,EAAE,0BAAsB;AAC9D,OAAO,KAAK,EAAE,gCAAgC,EAAE,kCAA8B;AAC9E,OAAO,KAAK,EACV,4BAA4B,EAC5B,0BAA0B,EAC3B,8BAA0B;AAC3B,OAAO,KAAK,EAAE,oBAAoB,EAAE,sBAAkB;AACtD,OAAO,KAAK,EAAE,gCAAgC,EAAE,kCAA8B;AAC9E,OAAO,KAAK,EAAE,8BAA8B,EAAE,gCAA4B;AAC1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,uBAAmB;AACxD,OAAO,KAAK,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,uBAAmB;AAC7E,OAAO,KAAK,EAAE,0BAA0B,EAAE,4BAAwB;AAClE,OAAO,KAAK,EACV,0BAA0B,EAC1B,wBAAwB,EACzB,4BAAwB;AACzB,OAAO,KAAK,EAAE,4BAA4B,EAAE,8BAA0B;AACtE,OAAO,KAAK,EACV,+BAA+B,EAC/B,6BAA6B,EAC9B,iCAA6B;AAC9B,OAAO,KAAK,EAAE,0BAA0B,EAAE,4BAAwB;AAClE,OAAO,KAAK,EAAE,yBAAyB,EAAE,2BAAuB;AAChE,OAAO,KAAK,EAAE,6BAA6B,EAAE,+BAA2B;AACxE,OAAO,KAAK,EAAE,oCAAoC,EAAE,sCAAkC;AACtF,OAAO,KAAK,EAAE,iCAAiC,EAAE,mCAA+B;AAChF,OAAO,KAAK,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,uBAAmB;AAC7E,OAAO,KAAK,EACV,uBAAuB,EACvB,qBAAqB,EACtB,yBAAqB;AACtB,OAAO,KAAK,EACV,uBAAuB,EACvB,qBAAqB,EACtB,yBAAqB;AACtB,OAAO,KAAK,EACV,uBAAuB,EACvB,qBAAqB,EACtB,yBAAqB;AACtB,OAAO,KAAK,EAAE,4BAA4B,EAAE,8BAA0B;AAEtE,MAAM,MAAM,yBAAyB,GACjC,kCAAkC,GAClC,uBAAuB,GACvB,2BAA2B,GAC3B,4BAA4B,GAC5B,qBAAqB,GACrB,wBAAwB,GACxB,gCAAgC,GAChC,4BAA4B,GAC5B,oBAAoB,GACpB,gCAAgC,GAChC,8BAA8B,GAC9B,qBAAqB,GACrB,qBAAqB,GACrB,0BAA0B,GAC1B,0BAA0B,GAC1B,4BAA4B,GAC5B,+BAA+B,GAC/B,0BAA0B,GAC1B,yBAAyB,GACzB,6BAA6B,GAC7B,oCAAoC,GACpC,iCAAiC,GACjC,qBAAqB,GACrB,uBAAuB,GACvB,uBAAuB,GACvB,uBAAuB,GACvB,4BAA4B,CAAC;AAEjC,MAAM,MAAM,uBAAuB,GAAG,0BAA0B,GAC9D,mBAAmB,GACnB,6BAA6B,GAC7B,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,GACrB,mBAAmB,GACnB,wBAAwB,CAAC;AAE3B,iCAA6B"}

package/dist/permitted/index.mjs

@@ -1,3 +1,2 @@
-export * from "./handlers.mjs";
 export * from "./middleware.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/permitted/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/permitted/index.ts"],"names":[],"mappings":"AAgDA,+BAA2B;AAC3B,iCAA6B","sourcesContent":["import type { CancelBackgroundEventMethodHooks } from './cancelBackgroundEvent';\nimport type { ClearStateHooks } from './clearState';\nimport type { CloseWebSocketMethodHooks } from './closeWebSocket';\nimport type { CreateInterfaceMethodHooks } from './createInterface';\nimport type { EndTraceMethodHooks } from './endTrace';\nimport type { GetAllSnapsHooks } from './getAllSnaps';\nimport type { GetBackgroundEventsMethodHooks } from './getBackgroundEvents';\nimport type { GetClientStatusHooks } from './getClientStatus';\nimport type { GetInterfaceStateMethodHooks } from './getInterfaceState';\nimport type { GetSnapsHooks } from './getSnaps';\nimport type { GetStateHooks } from './getState';\nimport type { GetWebSocketsMethodHooks } from './getWebSockets';\nimport type { ListEntropySourcesHooks } from './listEntropySources';\nimport type { OpenWebSocketMethodHooks } from './openWebSocket';\nimport type { RequestSnapsHooks } from './requestSnaps';\nimport type { ResolveInterfaceMethodHooks } from './resolveInterface';\nimport type { ScheduleBackgroundEventMethodHooks } from './scheduleBackgroundEvent';\nimport type { SendWebSocketMessageMethodHooks } from './sendWebSocketMessage';\nimport type { SetStateHooks } from './setState';\nimport type { StartTraceMethodHooks } from './startTrace';\nimport type { TrackErrorMethodHooks } from './trackError';\nimport type { TrackEventMethodHooks } from './trackEvent';\nimport type { UpdateInterfaceMethodHooks } from './updateInterface';\n\nexport type PermittedRpcMethodHooks = ClearStateHooks &\n  GetAllSnapsHooks &\n  GetClientStatusHooks &\n  GetSnapsHooks &\n  GetStateHooks &\n  ListEntropySourcesHooks &\n  RequestSnapsHooks &\n  CreateInterfaceMethodHooks &\n  UpdateInterfaceMethodHooks &\n  GetInterfaceStateMethodHooks &\n  ResolveInterfaceMethodHooks &\n  ScheduleBackgroundEventMethodHooks &\n  CancelBackgroundEventMethodHooks &\n  GetBackgroundEventsMethodHooks &\n  SetStateHooks &\n  OpenWebSocketMethodHooks &\n  CloseWebSocketMethodHooks &\n  SendWebSocketMessageMethodHooks &\n  GetWebSocketsMethodHooks &\n  TrackEventMethodHooks &\n  TrackErrorMethodHooks &\n  StartTraceMethodHooks &\n  EndTraceMethodHooks;\n\nexport * from './handlers';\nexport * from './middleware';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/permitted/index.ts"],"names":[],"mappings":"AAqFA,iCAA6B","sourcesContent":["import type { CancelBackgroundEventMethodActions } from './cancelBackgroundEvent';\nimport type { ClearStateMethodActions } from './clearState';\nimport type { CloseWebSocketMethodActions } from './closeWebSocket';\nimport type { CreateInterfaceMethodActions } from './createInterface';\nimport type { EndTraceMethodActions, EndTraceMethodHooks } from './endTrace';\nimport type { GetAllSnapsMethodActions } from './getAllSnaps';\nimport type { GetBackgroundEventsMethodActions } from './getBackgroundEvents';\nimport type {\n  GetClientStatusMethodActions,\n  GetClientStatusMethodHooks,\n} from './getClientStatus';\nimport type { GetFileMethodActions } from './getFile';\nimport type { GetInterfaceContextMethodActions } from './getInterfaceContext';\nimport type { GetInterfaceStateMethodActions } from './getInterfaceState';\nimport type { GetSnapsMethodActions } from './getSnaps';\nimport type { GetStateMethodActions, GetStateMethodHooks } from './getState';\nimport type { GetWebSocketsMethodActions } from './getWebSockets';\nimport type {\n  InvokeKeyringMethodActions,\n  InvokeKeyringMethodHooks,\n} from './invokeKeyring';\nimport type { InvokeSnapSugarMethodActions } from './invokeSnapSugar';\nimport type {\n  ListEntropySourcesMethodActions,\n  ListEntropySourcesMethodHooks,\n} from './listEntropySources';\nimport type { OpenWebSocketMethodActions } from './openWebSocket';\nimport type { RequestSnapsMethodActions } from './requestSnaps';\nimport type { ResolveInterfaceMethodActions } from './resolveInterface';\nimport type { ScheduleBackgroundEventMethodActions } from './scheduleBackgroundEvent';\nimport type { SendWebSocketMessageMethodActions } from './sendWebSocketMessage';\nimport type { SetStateMethodActions, SetStateMethodHooks } from './setState';\nimport type {\n  StartTraceMethodActions,\n  StartTraceMethodHooks,\n} from './startTrace';\nimport type {\n  TrackErrorMethodActions,\n  TrackErrorMethodHooks,\n} from './trackError';\nimport type {\n  TrackEventMethodActions,\n  TrackEventMethodHooks,\n} from './trackEvent';\nimport type { UpdateInterfaceMethodActions } from './updateInterface';\n\nexport type PermittedRpcMethodActions =\n  | CancelBackgroundEventMethodActions\n  | ClearStateMethodActions\n  | CloseWebSocketMethodActions\n  | CreateInterfaceMethodActions\n  | EndTraceMethodActions\n  | GetAllSnapsMethodActions\n  | GetBackgroundEventsMethodActions\n  | GetClientStatusMethodActions\n  | GetFileMethodActions\n  | GetInterfaceContextMethodActions\n  | GetInterfaceStateMethodActions\n  | GetSnapsMethodActions\n  | GetStateMethodActions\n  | GetWebSocketsMethodActions\n  | InvokeKeyringMethodActions\n  | InvokeSnapSugarMethodActions\n  | ListEntropySourcesMethodActions\n  | OpenWebSocketMethodActions\n  | RequestSnapsMethodActions\n  | ResolveInterfaceMethodActions\n  | ScheduleBackgroundEventMethodActions\n  | SendWebSocketMessageMethodActions\n  | SetStateMethodActions\n  | StartTraceMethodActions\n  | TrackErrorMethodActions\n  | TrackEventMethodActions\n  | UpdateInterfaceMethodActions;\n\nexport type PermittedRpcMethodHooks = GetClientStatusMethodHooks &\n  GetStateMethodHooks &\n  ListEntropySourcesMethodHooks &\n  SetStateMethodHooks &\n  TrackEventMethodHooks &\n  TrackErrorMethodHooks &\n  StartTraceMethodHooks &\n  EndTraceMethodHooks &\n  InvokeKeyringMethodHooks;\n\nexport * from './middleware';\n"]}

package/dist/permitted/invokeKeyring.cjs

@@ -5,11 +5,7 @@ const rpc_errors_1 = require("@metamask/rpc-errors");
 const snaps_utils_1 = require("@metamask/snaps-utils");
 const utils_1 = require("@metamask/utils");
 const invokeSnapSugar_1 = require("./invokeSnapSugar.cjs");
-const methodName = 'wallet_invokeKeyring';
 const hookNames = {
-    hasPermission: true,
-    handleSnapRpcRequest: true,
-    getSnap: true,
     getAllowedKeyringMethods: true,
 };
 /**
@@ -21,9 +17,13 @@ const hookNames = {
  * request permission to communicate with it using [`wallet_requestSnaps`](https://docs.metamask.io/snaps/reference/snaps-api/wallet_requestsnaps).
  */
 exports.invokeKeyringHandler = {
-    methodNames: [methodName],
     implementation: invokeKeyringImplementation,
     hookNames,
+    actionNames: [
+        'PermissionController:hasPermission',
+        'SnapController:handleRequest',
+        'SnapController:getSnap',
+    ],
 };
 /**
  * The `wallet_invokeKeyring` method implementation.
@@ -35,11 +35,9 @@ exports.invokeKeyringHandler = {
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
- * @param hooks.handleSnapRpcRequest - Invokes a snap with a given RPC request.
- * @param hooks.hasPermission - Checks whether a given origin has a given permission.
- * @param hooks.getSnap - Gets information about a given snap.
  * @param hooks.getAllowedKeyringMethods - Get the list of allowed Keyring
  * methods for a given origin.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
 async function invokeKeyringImplementation(req, 
@@ -48,7 +46,7 @@ async function invokeKeyringImplementation(req,
 // future. We use `InvokeKeyringResult` here to make it clear that this is the
 // expected type of the result.
 // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments
-res, _next, end, { handleSnapRpcRequest, hasPermission, getSnap, getAllowedKeyringMethods, }) {
+res, _next, end, { getAllowedKeyringMethods }, messenger) {
     let params;
     try {
         params = (0, invokeSnapSugar_1.getValidatedParams)(req.params);
@@ -56,15 +54,15 @@ res, _next, end, { handleSnapRpcRequest, hasPermission, getSnap, getAllowedKeyri
     catch (error) {
         return end(error);
     }
-    // We expect the MM middleware stack to always add the origin to requests
     const { origin } = req;
     const { snapId, request } = params;
-    if (!origin || !hasPermission(snaps_utils_1.WALLET_SNAP_PERMISSION_KEY)) {
+    if (!origin ||
+        !messenger.call('PermissionController:hasPermission', origin, snaps_utils_1.WALLET_SNAP_PERMISSION_KEY)) {
         return end(rpc_errors_1.rpcErrors.invalidRequest({
             message: `The snap "${snapId}" is not connected to "${origin}". Please connect before invoking the snap.`,
         }));
     }
-    if (!getSnap(snapId)) {
+    if (!messenger.call('SnapController:getSnap', snapId)) {
         return end(
         // Mirror error message from SnapController.
         rpc_errors_1.rpcErrors.invalidRequest({
@@ -83,7 +81,8 @@ res, _next, end, { handleSnapRpcRequest, hasPermission, getSnap, getAllowedKeyri
         }));
     }
     try {
-        res.result = (await handleSnapRpcRequest({
+        res.result = (await messenger.call('SnapController:handleRequest', {
+            origin,
             snapId,
             request,
             handler: snaps_utils_1.HandlerType.OnKeyringRequest,

package/dist/permitted/invokeKeyring.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"invokeKeyring.cjs","sourceRoot":"","sources":["../../src/permitted/invokeKeyring.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAOjD,uDAAgF;AAMhF,2CAA8C;AAE9C,2DAAuD;AAGvD,MAAM,UAAU,GAAG,sBAAsB,CAAC;AAE1C,MAAM,SAAS,GAA0C;IACvD,aAAa,EAAE,IAAI;IACnB,oBAAoB,EAAE,IAAI;IAC1B,OAAO,EAAE,IAAI;IACb,wBAAwB,EAAE,IAAI;CAC/B,CAAC;AAEF;;;;;;;GAOG;AACU,QAAA,oBAAoB,GAAG;IAClC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CAKV,CAAC;AAgBF;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,2BAA2B,CACxC,GAAwC;AACxC,0EAA0E;AAC1E,8EAA8E;AAC9E,8EAA8E;AAC9E,+BAA+B;AAC/B,4EAA4E;AAC5E,GAAgD,EAChD,KAAc,EACd,GAA6B,EAC7B,EACE,oBAAoB,EACpB,aAAa,EACb,OAAO,EACP,wBAAwB,GACL;IAErB,IAAI,MAAwB,CAAC;IAC7B,IAAI,CAAC;QACH,MAAM,GAAG,IAAA,oCAAkB,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,yEAAyE;IACzE,MAAM,EAAE,MAAM,EAAE,GAAG,GAA0C,CAAC;IAC9D,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAEnC,IAAI,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,wCAA0B,CAAC,EAAE,CAAC;QAC1D,OAAO,GAAG,CACR,sBAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,aAAa,MAAM,0BAA0B,MAAM,6CAA6C;SAC1G,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACrB,OAAO,GAAG;QACR,4CAA4C;QAC5C,sBAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,aAAa,MAAM,2DAA2D;SACxF,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,IAAA,mBAAW,EAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC1E,OAAO,GAAG,CACR,sBAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,iCAAiC;SAC3C,CAAC,CACH,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAG,wBAAwB,EAAE,CAAC;IAClD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7C,OAAO,GAAG,CACR,sBAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,eAAe,MAAM,0CAA0C,OAAO,CAAC,MAAM,IAAI;SAC3F,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,GAAG,CAAC,MAAM,GAAG,CAAC,MAAM,oBAAoB,CAAC;YACvC,MAAM;YACN,OAAO;YACP,OAAO,EAAE,yBAAW,CAAC,gBAAgB;SACtC,CAAC,CAAS,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  InvokeKeyringParams,\n  InvokeKeyringResult,\n  InvokeSnapParams,\n} from '@metamask/snaps-sdk';\nimport type { Snap, SnapRpcHookArgs } from '@metamask/snaps-utils';\nimport { HandlerType, WALLET_SNAP_PERMISSION_KEY } from '@metamask/snaps-utils';\nimport type {\n  PendingJsonRpcResponse,\n  Json,\n  JsonRpcRequest,\n} from '@metamask/utils';\nimport { hasProperty } from '@metamask/utils';\n\nimport { getValidatedParams } from './invokeSnapSugar';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'wallet_invokeKeyring';\n\nconst hookNames: MethodHooksObject<InvokeKeyringHooks> = {\n  hasPermission: true,\n  handleSnapRpcRequest: true,\n  getSnap: true,\n  getAllowedKeyringMethods: true,\n};\n\n/**\n * Invoke a keyring method of a Snap. This calls the `onKeyringRequest` handler\n * of the Snap.\n *\n * The Snap must be installed and the dapp must have permission to communicate\n * with the Snap, or the request is rejected. The dapp can install the Snap and\n * request permission to communicate with it using [`wallet_requestSnaps`](https://docs.metamask.io/snaps/reference/snaps-api/wallet_requestsnaps).\n */\nexport const invokeKeyringHandler = {\n  methodNames: [methodName] as const,\n  implementation: invokeKeyringImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  InvokeKeyringHooks,\n  InvokeSnapParams,\n  InvokeKeyringResult\n>;\n\nexport type InvokeKeyringHooks = {\n  hasPermission: (permissionName: string) => boolean;\n\n  handleSnapRpcRequest: ({\n    snapId,\n    handler,\n    request,\n  }: Omit<SnapRpcHookArgs, 'origin'> & { snapId: string }) => Promise<unknown>;\n\n  getSnap: (snapId: string) => Snap | undefined;\n\n  getAllowedKeyringMethods: () => string[];\n};\n\n/**\n * The `wallet_invokeKeyring` method implementation.\n * Invokes onKeyringRequest if the snap requested is installed and connected to the dapp.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.handleSnapRpcRequest - Invokes a snap with a given RPC request.\n * @param hooks.hasPermission - Checks whether a given origin has a given permission.\n * @param hooks.getSnap - Gets information about a given snap.\n * @param hooks.getAllowedKeyringMethods - Get the list of allowed Keyring\n * methods for a given origin.\n * @returns Nothing.\n */\nasync function invokeKeyringImplementation(\n  req: JsonRpcRequest<InvokeKeyringParams>,\n  // `InvokeKeyringResult` is an alias for `Json` (which is the default type\n  // argument for `PendingJsonRpcResponse`), but that may not be the case in the\n  // future. We use `InvokeKeyringResult` here to make it clear that this is the\n  // expected type of the result.\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments\n  res: PendingJsonRpcResponse<InvokeKeyringResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  {\n    handleSnapRpcRequest,\n    hasPermission,\n    getSnap,\n    getAllowedKeyringMethods,\n  }: InvokeKeyringHooks,\n): Promise<void> {\n  let params: InvokeSnapParams;\n  try {\n    params = getValidatedParams(req.params);\n  } catch (error) {\n    return end(error);\n  }\n\n  // We expect the MM middleware stack to always add the origin to requests\n  const { origin } = req as JsonRpcRequest & { origin: string };\n  const { snapId, request } = params;\n\n  if (!origin || !hasPermission(WALLET_SNAP_PERMISSION_KEY)) {\n    return end(\n      rpcErrors.invalidRequest({\n        message: `The snap \"${snapId}\" is not connected to \"${origin}\". Please connect before invoking the snap.`,\n      }),\n    );\n  }\n\n  if (!getSnap(snapId)) {\n    return end(\n      // Mirror error message from SnapController.\n      rpcErrors.invalidRequest({\n        message: `The Snap \"${snapId}\" is not installed. Please install it before invoking it.`,\n      }),\n    );\n  }\n\n  if (!hasProperty(request, 'method') || typeof request.method !== 'string') {\n    return end(\n      rpcErrors.invalidRequest({\n        message: 'The request must have a method.',\n      }),\n    );\n  }\n\n  const allowedMethods = getAllowedKeyringMethods();\n  if (!allowedMethods.includes(request.method)) {\n    return end(\n      rpcErrors.invalidRequest({\n        message: `The origin \"${origin}\" is not allowed to invoke the method \"${request.method}\".`,\n      }),\n    );\n  }\n\n  try {\n    res.result = (await handleSnapRpcRequest({\n      snapId,\n      request,\n      handler: HandlerType.OnKeyringRequest,\n    })) as Json;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}
+{"version":3,"file":"invokeKeyring.cjs","sourceRoot":"","sources":["../../src/permitted/invokeKeyring.ts"],"names":[],"mappings":";;;AAMA,qDAAiD;AAMjD,uDAAgF;AAEhF,2CAA8C;AAE9C,2DAAuD;AAQvD,MAAM,SAAS,GAAgD;IAC7D,wBAAwB,EAAE,IAAI;CAC/B,CAAC;AAgBF;;;;;;;GAOG;AACU,QAAA,oBAAoB,GAAG;IAClC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;IACT,WAAW,EAAE;QACX,oCAAoC;QACpC,8BAA8B;QAC9B,wBAAwB;KACzB;CAOF,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,2BAA2B,CACxC,GAAkD;AAClD,0EAA0E;AAC1E,8EAA8E;AAC9E,8EAA8E;AAC9E,+BAA+B;AAC/B,4EAA4E;AAC5E,GAAgD,EAChD,KAAc,EACd,GAA6B,EAC7B,EAAE,wBAAwB,EAA4B,EACtD,SAAwD;IAExD,IAAI,MAAwB,CAAC;IAC7B,IAAI,CAAC;QACH,MAAM,GAAG,IAAA,oCAAkB,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IACvB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAEnC,IACE,CAAC,MAAM;QACP,CAAC,SAAS,CAAC,IAAI,CACb,oCAAoC,EACpC,MAAM,EACN,wCAA0B,CAC3B,EACD,CAAC;QACD,OAAO,GAAG,CACR,sBAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,aAAa,MAAM,0BAA0B,MAAM,6CAA6C;SAC1G,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,wBAAwB,EAAE,MAAM,CAAC,EAAE,CAAC;QACtD,OAAO,GAAG;QACR,4CAA4C;QAC5C,sBAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,aAAa,MAAM,2DAA2D;SACxF,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,IAAA,mBAAW,EAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC1E,OAAO,GAAG,CACR,sBAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,iCAAiC;SAC3C,CAAC,CACH,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAG,wBAAwB,EAAE,CAAC;IAClD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7C,OAAO,GAAG,CACR,sBAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,eAAe,MAAM,0CAA0C,OAAO,CAAC,MAAM,IAAI;SAC3F,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,GAAG,CAAC,MAAM,GAAG,CAAC,MAAM,SAAS,CAAC,IAAI,CAAC,8BAA8B,EAAE;YACjE,MAAM;YACN,MAAM;YACN,OAAO;YACP,OAAO,EAAE,yBAAW,CAAC,gBAAgB;SACtC,CAAC,CAAS,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type {\n  JsonRpcEngineEndCallback,\n  MethodHandler,\n} from '@metamask/json-rpc-engine';\nimport type { Messenger } from '@metamask/messenger';\nimport type { PermissionControllerHasPermissionAction } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  InvokeKeyringParams,\n  InvokeKeyringResult,\n  InvokeSnapParams,\n} from '@metamask/snaps-sdk';\nimport { HandlerType, WALLET_SNAP_PERMISSION_KEY } from '@metamask/snaps-utils';\nimport type { PendingJsonRpcResponse, Json } from '@metamask/utils';\nimport { hasProperty } from '@metamask/utils';\n\nimport { getValidatedParams } from './invokeSnapSugar';\nimport type {\n  JsonRpcRequestWithOrigin,\n  SnapControllerGetSnapAction,\n  SnapControllerHandleRequestAction,\n} from '../types';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<InvokeKeyringMethodHooks> = {\n  getAllowedKeyringMethods: true,\n};\n\nexport type InvokeKeyringMethodHooks = {\n  /**\n   * Get the list of allowed Keyring methods for a given origin.\n   *\n   * @returns The list of allowed Keyring methods.\n   */\n  getAllowedKeyringMethods: () => string[];\n};\n\nexport type InvokeKeyringMethodActions =\n  | PermissionControllerHasPermissionAction\n  | SnapControllerHandleRequestAction\n  | SnapControllerGetSnapAction;\n\n/**\n * Invoke a keyring method of a Snap. This calls the `onKeyringRequest` handler\n * of the Snap.\n *\n * The Snap must be installed and the dapp must have permission to communicate\n * with the Snap, or the request is rejected. The dapp can install the Snap and\n * request permission to communicate with it using [`wallet_requestSnaps`](https://docs.metamask.io/snaps/reference/snaps-api/wallet_requestsnaps).\n */\nexport const invokeKeyringHandler = {\n  implementation: invokeKeyringImplementation,\n  hookNames,\n  actionNames: [\n    'PermissionController:hasPermission',\n    'SnapController:handleRequest',\n    'SnapController:getSnap',\n  ],\n} satisfies MethodHandler<\n  InvokeKeyringMethodHooks,\n  InvokeKeyringMethodActions,\n  InvokeSnapParams,\n  InvokeKeyringResult,\n  { origin: string }\n>;\n\n/**\n * The `wallet_invokeKeyring` method implementation.\n * Invokes onKeyringRequest if the snap requested is installed and connected to the dapp.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.getAllowedKeyringMethods - Get the list of allowed Keyring\n * methods for a given origin.\n * @param messenger - The messenger used to call controller actions.\n * @returns Nothing.\n */\nasync function invokeKeyringImplementation(\n  req: JsonRpcRequestWithOrigin<InvokeKeyringParams>,\n  // `InvokeKeyringResult` is an alias for `Json` (which is the default type\n  // argument for `PendingJsonRpcResponse`), but that may not be the case in the\n  // future. We use `InvokeKeyringResult` here to make it clear that this is the\n  // expected type of the result.\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments\n  res: PendingJsonRpcResponse<InvokeKeyringResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getAllowedKeyringMethods }: InvokeKeyringMethodHooks,\n  messenger: Messenger<string, InvokeKeyringMethodActions>,\n): Promise<void> {\n  let params: InvokeSnapParams;\n  try {\n    params = getValidatedParams(req.params);\n  } catch (error) {\n    return end(error);\n  }\n\n  const { origin } = req;\n  const { snapId, request } = params;\n\n  if (\n    !origin ||\n    !messenger.call(\n      'PermissionController:hasPermission',\n      origin,\n      WALLET_SNAP_PERMISSION_KEY,\n    )\n  ) {\n    return end(\n      rpcErrors.invalidRequest({\n        message: `The snap \"${snapId}\" is not connected to \"${origin}\". Please connect before invoking the snap.`,\n      }),\n    );\n  }\n\n  if (!messenger.call('SnapController:getSnap', snapId)) {\n    return end(\n      // Mirror error message from SnapController.\n      rpcErrors.invalidRequest({\n        message: `The Snap \"${snapId}\" is not installed. Please install it before invoking it.`,\n      }),\n    );\n  }\n\n  if (!hasProperty(request, 'method') || typeof request.method !== 'string') {\n    return end(\n      rpcErrors.invalidRequest({\n        message: 'The request must have a method.',\n      }),\n    );\n  }\n\n  const allowedMethods = getAllowedKeyringMethods();\n  if (!allowedMethods.includes(request.method)) {\n    return end(\n      rpcErrors.invalidRequest({\n        message: `The origin \"${origin}\" is not allowed to invoke the method \"${request.method}\".`,\n      }),\n    );\n  }\n\n  try {\n    res.result = (await messenger.call('SnapController:handleRequest', {\n      origin,\n      snapId,\n      request,\n      handler: HandlerType.OnKeyringRequest,\n    })) as Json;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}

package/dist/permitted/invokeKeyring.d.cts

@@ -1,8 +1,19 @@
 import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { Messenger } from "@metamask/messenger";
+import type { PermissionControllerHasPermissionAction } from "@metamask/permission-controller";
 import type { InvokeKeyringParams, InvokeKeyringResult } from "@metamask/snaps-sdk";
-import type { Snap, SnapRpcHookArgs } from "@metamask/snaps-utils";
-import type { PendingJsonRpcResponse, JsonRpcRequest } from "@metamask/utils";
+import type { PendingJsonRpcResponse } from "@metamask/utils";
+import type { JsonRpcRequestWithOrigin, SnapControllerGetSnapAction, SnapControllerHandleRequestAction } from "../types.cjs";
 import type { MethodHooksObject } from "../utils.cjs";
+export type InvokeKeyringMethodHooks = {
+    /**
+     * Get the list of allowed Keyring methods for a given origin.
+     *
+     * @returns The list of allowed Keyring methods.
+     */
+    getAllowedKeyringMethods: () => string[];
+};
+export type InvokeKeyringMethodActions = PermissionControllerHasPermissionAction | SnapControllerHandleRequestAction | SnapControllerGetSnapAction;
 /**
  * Invoke a keyring method of a Snap. This calls the `onKeyringRequest` handler
  * of the Snap.
@@ -12,17 +23,9 @@ import type { MethodHooksObject } from "../utils.cjs";
  * request permission to communicate with it using [`wallet_requestSnaps`](https://docs.metamask.io/snaps/reference/snaps-api/wallet_requestsnaps).
  */
 export declare const invokeKeyringHandler: {
-    methodNames: ["wallet_invokeKeyring"];
     implementation: typeof invokeKeyringImplementation;
-    hookNames: MethodHooksObject<InvokeKeyringHooks>;
-};
-export type InvokeKeyringHooks = {
-    hasPermission: (permissionName: string) => boolean;
-    handleSnapRpcRequest: ({ snapId, handler, request, }: Omit<SnapRpcHookArgs, 'origin'> & {
-        snapId: string;
-    }) => Promise<unknown>;
-    getSnap: (snapId: string) => Snap | undefined;
-    getAllowedKeyringMethods: () => string[];
+    hookNames: MethodHooksObject<InvokeKeyringMethodHooks>;
+    actionNames: ("SnapController:handleRequest" | "SnapController:getSnap" | "PermissionController:hasPermission")[];
 };
 /**
  * The `wallet_invokeKeyring` method implementation.
@@ -34,13 +37,11 @@ export type InvokeKeyringHooks = {
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
- * @param hooks.handleSnapRpcRequest - Invokes a snap with a given RPC request.
- * @param hooks.hasPermission - Checks whether a given origin has a given permission.
- * @param hooks.getSnap - Gets information about a given snap.
  * @param hooks.getAllowedKeyringMethods - Get the list of allowed Keyring
  * methods for a given origin.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-declare function invokeKeyringImplementation(req: JsonRpcRequest<InvokeKeyringParams>, res: PendingJsonRpcResponse<InvokeKeyringResult>, _next: unknown, end: JsonRpcEngineEndCallback, { handleSnapRpcRequest, hasPermission, getSnap, getAllowedKeyringMethods, }: InvokeKeyringHooks): Promise<void>;
+declare function invokeKeyringImplementation(req: JsonRpcRequestWithOrigin<InvokeKeyringParams>, res: PendingJsonRpcResponse<InvokeKeyringResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getAllowedKeyringMethods }: InvokeKeyringMethodHooks, messenger: Messenger<string, InvokeKeyringMethodActions>): Promise<void>;
 export {};
 //# sourceMappingURL=invokeKeyring.d.cts.map

package/dist/permitted/invokeKeyring.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"invokeKeyring.d.cts","sourceRoot":"","sources":["../../src/permitted/invokeKeyring.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EAEpB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,8BAA8B;AAEnE,OAAO,KAAK,EACV,sBAAsB,EAEtB,cAAc,EACf,wBAAwB;AAIzB,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAWlD;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB;;;;CAQhC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IAEnD,oBAAoB,EAAE,CAAC,EACrB,MAAM,EACN,OAAO,EACP,OAAO,GACR,EAAE,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7E,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;IAE9C,wBAAwB,EAAE,MAAM,MAAM,EAAE,CAAC;CAC1C,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,iBAAe,2BAA2B,CACxC,GAAG,EAAE,cAAc,CAAC,mBAAmB,CAAC,EAMxC,GAAG,EAAE,sBAAsB,CAAC,mBAAmB,CAAC,EAChD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EACE,oBAAoB,EACpB,aAAa,EACb,OAAO,EACP,wBAAwB,GACzB,EAAE,kBAAkB,GACpB,OAAO,CAAC,IAAI,CAAC,CAyDf"}
+{"version":3,"file":"invokeKeyring.d.cts","sourceRoot":"","sources":["../../src/permitted/invokeKeyring.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,uCAAuC,EAAE,wCAAwC;AAE/F,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EAEpB,4BAA4B;AAE7B,OAAO,KAAK,EAAE,sBAAsB,EAAQ,wBAAwB;AAIpE,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAC3B,iCAAiC,EAClC,qBAAiB;AAClB,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAMlD,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;OAIG;IACH,wBAAwB,EAAE,MAAM,MAAM,EAAE,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAClC,uCAAuC,GACvC,iCAAiC,GACjC,2BAA2B,CAAC;AAEhC;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB;;;;CAchC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,iBAAe,2BAA2B,CACxC,GAAG,EAAE,wBAAwB,CAAC,mBAAmB,CAAC,EAMlD,GAAG,EAAE,sBAAsB,CAAC,mBAAmB,CAAC,EAChD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,wBAAwB,EAAE,EAAE,wBAAwB,EACtD,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,0BAA0B,CAAC,GACvD,OAAO,CAAC,IAAI,CAAC,CAgEf"}

package/dist/permitted/invokeKeyring.d.mts

@@ -1,8 +1,19 @@
 import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
+import type { Messenger } from "@metamask/messenger";
+import type { PermissionControllerHasPermissionAction } from "@metamask/permission-controller";
 import type { InvokeKeyringParams, InvokeKeyringResult } from "@metamask/snaps-sdk";
-import type { Snap, SnapRpcHookArgs } from "@metamask/snaps-utils";
-import type { PendingJsonRpcResponse, JsonRpcRequest } from "@metamask/utils";
+import type { PendingJsonRpcResponse } from "@metamask/utils";
+import type { JsonRpcRequestWithOrigin, SnapControllerGetSnapAction, SnapControllerHandleRequestAction } from "../types.mjs";
 import type { MethodHooksObject } from "../utils.mjs";
+export type InvokeKeyringMethodHooks = {
+    /**
+     * Get the list of allowed Keyring methods for a given origin.
+     *
+     * @returns The list of allowed Keyring methods.
+     */
+    getAllowedKeyringMethods: () => string[];
+};
+export type InvokeKeyringMethodActions = PermissionControllerHasPermissionAction | SnapControllerHandleRequestAction | SnapControllerGetSnapAction;
 /**
  * Invoke a keyring method of a Snap. This calls the `onKeyringRequest` handler
  * of the Snap.
@@ -12,17 +23,9 @@ import type { MethodHooksObject } from "../utils.mjs";
  * request permission to communicate with it using [`wallet_requestSnaps`](https://docs.metamask.io/snaps/reference/snaps-api/wallet_requestsnaps).
  */
 export declare const invokeKeyringHandler: {
-    methodNames: ["wallet_invokeKeyring"];
     implementation: typeof invokeKeyringImplementation;
-    hookNames: MethodHooksObject<InvokeKeyringHooks>;
-};
-export type InvokeKeyringHooks = {
-    hasPermission: (permissionName: string) => boolean;
-    handleSnapRpcRequest: ({ snapId, handler, request, }: Omit<SnapRpcHookArgs, 'origin'> & {
-        snapId: string;
-    }) => Promise<unknown>;
-    getSnap: (snapId: string) => Snap | undefined;
-    getAllowedKeyringMethods: () => string[];
+    hookNames: MethodHooksObject<InvokeKeyringMethodHooks>;
+    actionNames: ("SnapController:handleRequest" | "SnapController:getSnap" | "PermissionController:hasPermission")[];
 };
 /**
  * The `wallet_invokeKeyring` method implementation.
@@ -34,13 +37,11 @@ export type InvokeKeyringHooks = {
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
- * @param hooks.handleSnapRpcRequest - Invokes a snap with a given RPC request.
- * @param hooks.hasPermission - Checks whether a given origin has a given permission.
- * @param hooks.getSnap - Gets information about a given snap.
  * @param hooks.getAllowedKeyringMethods - Get the list of allowed Keyring
  * methods for a given origin.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-declare function invokeKeyringImplementation(req: JsonRpcRequest<InvokeKeyringParams>, res: PendingJsonRpcResponse<InvokeKeyringResult>, _next: unknown, end: JsonRpcEngineEndCallback, { handleSnapRpcRequest, hasPermission, getSnap, getAllowedKeyringMethods, }: InvokeKeyringHooks): Promise<void>;
+declare function invokeKeyringImplementation(req: JsonRpcRequestWithOrigin<InvokeKeyringParams>, res: PendingJsonRpcResponse<InvokeKeyringResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getAllowedKeyringMethods }: InvokeKeyringMethodHooks, messenger: Messenger<string, InvokeKeyringMethodActions>): Promise<void>;
 export {};
 //# sourceMappingURL=invokeKeyring.d.mts.map

package/dist/permitted/invokeKeyring.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"invokeKeyring.d.mts","sourceRoot":"","sources":["../../src/permitted/invokeKeyring.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EAEpB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,8BAA8B;AAEnE,OAAO,KAAK,EACV,sBAAsB,EAEtB,cAAc,EACf,wBAAwB;AAIzB,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAWlD;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB;;;;CAQhC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IAEnD,oBAAoB,EAAE,CAAC,EACrB,MAAM,EACN,OAAO,EACP,OAAO,GACR,EAAE,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7E,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;IAE9C,wBAAwB,EAAE,MAAM,MAAM,EAAE,CAAC;CAC1C,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,iBAAe,2BAA2B,CACxC,GAAG,EAAE,cAAc,CAAC,mBAAmB,CAAC,EAMxC,GAAG,EAAE,sBAAsB,CAAC,mBAAmB,CAAC,EAChD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EACE,oBAAoB,EACpB,aAAa,EACb,OAAO,EACP,wBAAwB,GACzB,EAAE,kBAAkB,GACpB,OAAO,CAAC,IAAI,CAAC,CAyDf"}
+{"version":3,"file":"invokeKeyring.d.mts","sourceRoot":"","sources":["../../src/permitted/invokeKeyring.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,uCAAuC,EAAE,wCAAwC;AAE/F,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EAEpB,4BAA4B;AAE7B,OAAO,KAAK,EAAE,sBAAsB,EAAQ,wBAAwB;AAIpE,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAC3B,iCAAiC,EAClC,qBAAiB;AAClB,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAMlD,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;OAIG;IACH,wBAAwB,EAAE,MAAM,MAAM,EAAE,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAClC,uCAAuC,GACvC,iCAAiC,GACjC,2BAA2B,CAAC;AAEhC;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB;;;;CAchC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,iBAAe,2BAA2B,CACxC,GAAG,EAAE,wBAAwB,CAAC,mBAAmB,CAAC,EAMlD,GAAG,EAAE,sBAAsB,CAAC,mBAAmB,CAAC,EAChD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,wBAAwB,EAAE,EAAE,wBAAwB,EACtD,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,0BAA0B,CAAC,GACvD,OAAO,CAAC,IAAI,CAAC,CAgEf"}

package/dist/permitted/invokeKeyring.mjs

@@ -2,11 +2,7 @@ import { rpcErrors } from "@metamask/rpc-errors";
 import { HandlerType, WALLET_SNAP_PERMISSION_KEY } from "@metamask/snaps-utils";
 import { hasProperty } from "@metamask/utils";
 import { getValidatedParams } from "./invokeSnapSugar.mjs";
-const methodName = 'wallet_invokeKeyring';
 const hookNames = {
-    hasPermission: true,
-    handleSnapRpcRequest: true,
-    getSnap: true,
     getAllowedKeyringMethods: true,
 };
 /**
@@ -18,9 +14,13 @@ const hookNames = {
  * request permission to communicate with it using [`wallet_requestSnaps`](https://docs.metamask.io/snaps/reference/snaps-api/wallet_requestsnaps).
  */
 export const invokeKeyringHandler = {
-    methodNames: [methodName],
     implementation: invokeKeyringImplementation,
     hookNames,
+    actionNames: [
+        'PermissionController:hasPermission',
+        'SnapController:handleRequest',
+        'SnapController:getSnap',
+    ],
 };
 /**
  * The `wallet_invokeKeyring` method implementation.
@@ -32,11 +32,9 @@ export const invokeKeyringHandler = {
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
- * @param hooks.handleSnapRpcRequest - Invokes a snap with a given RPC request.
- * @param hooks.hasPermission - Checks whether a given origin has a given permission.
- * @param hooks.getSnap - Gets information about a given snap.
  * @param hooks.getAllowedKeyringMethods - Get the list of allowed Keyring
  * methods for a given origin.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
 async function invokeKeyringImplementation(req, 
@@ -45,7 +43,7 @@ async function invokeKeyringImplementation(req,
 // future. We use `InvokeKeyringResult` here to make it clear that this is the
 // expected type of the result.
 // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments
-res, _next, end, { handleSnapRpcRequest, hasPermission, getSnap, getAllowedKeyringMethods, }) {
+res, _next, end, { getAllowedKeyringMethods }, messenger) {
     let params;
     try {
         params = getValidatedParams(req.params);
@@ -53,15 +51,15 @@ res, _next, end, { handleSnapRpcRequest, hasPermission, getSnap, getAllowedKeyri
     catch (error) {
         return end(error);
     }
-    // We expect the MM middleware stack to always add the origin to requests
     const { origin } = req;
     const { snapId, request } = params;
-    if (!origin || !hasPermission(WALLET_SNAP_PERMISSION_KEY)) {
+    if (!origin ||
+        !messenger.call('PermissionController:hasPermission', origin, WALLET_SNAP_PERMISSION_KEY)) {
         return end(rpcErrors.invalidRequest({
             message: `The snap "${snapId}" is not connected to "${origin}". Please connect before invoking the snap.`,
         }));
     }
-    if (!getSnap(snapId)) {
+    if (!messenger.call('SnapController:getSnap', snapId)) {
         return end(
         // Mirror error message from SnapController.
         rpcErrors.invalidRequest({
@@ -80,7 +78,8 @@ res, _next, end, { handleSnapRpcRequest, hasPermission, getSnap, getAllowedKeyri
         }));
     }
     try {
-        res.result = (await handleSnapRpcRequest({
+        res.result = (await messenger.call('SnapController:handleRequest', {
+            origin,
             snapId,
             request,
             handler: HandlerType.OnKeyringRequest,

package/dist/permitted/invokeKeyring.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"invokeKeyring.mjs","sourceRoot":"","sources":["../../src/permitted/invokeKeyring.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAOjD,OAAO,EAAE,WAAW,EAAE,0BAA0B,EAAE,8BAA8B;AAMhF,OAAO,EAAE,WAAW,EAAE,wBAAwB;AAE9C,OAAO,EAAE,kBAAkB,EAAE,8BAA0B;AAGvD,MAAM,UAAU,GAAG,sBAAsB,CAAC;AAE1C,MAAM,SAAS,GAA0C;IACvD,aAAa,EAAE,IAAI;IACnB,oBAAoB,EAAE,IAAI;IAC1B,OAAO,EAAE,IAAI;IACb,wBAAwB,EAAE,IAAI;CAC/B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CAKV,CAAC;AAgBF;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,2BAA2B,CACxC,GAAwC;AACxC,0EAA0E;AAC1E,8EAA8E;AAC9E,8EAA8E;AAC9E,+BAA+B;AAC/B,4EAA4E;AAC5E,GAAgD,EAChD,KAAc,EACd,GAA6B,EAC7B,EACE,oBAAoB,EACpB,aAAa,EACb,OAAO,EACP,wBAAwB,GACL;IAErB,IAAI,MAAwB,CAAC;IAC7B,IAAI,CAAC;QACH,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,yEAAyE;IACzE,MAAM,EAAE,MAAM,EAAE,GAAG,GAA0C,CAAC;IAC9D,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAEnC,IAAI,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,0BAA0B,CAAC,EAAE,CAAC;QAC1D,OAAO,GAAG,CACR,SAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,aAAa,MAAM,0BAA0B,MAAM,6CAA6C;SAC1G,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACrB,OAAO,GAAG;QACR,4CAA4C;QAC5C,SAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,aAAa,MAAM,2DAA2D;SACxF,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC1E,OAAO,GAAG,CACR,SAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,iCAAiC;SAC3C,CAAC,CACH,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAG,wBAAwB,EAAE,CAAC;IAClD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7C,OAAO,GAAG,CACR,SAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,eAAe,MAAM,0CAA0C,OAAO,CAAC,MAAM,IAAI;SAC3F,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,GAAG,CAAC,MAAM,GAAG,CAAC,MAAM,oBAAoB,CAAC;YACvC,MAAM;YACN,OAAO;YACP,OAAO,EAAE,WAAW,CAAC,gBAAgB;SACtC,CAAC,CAAS,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  InvokeKeyringParams,\n  InvokeKeyringResult,\n  InvokeSnapParams,\n} from '@metamask/snaps-sdk';\nimport type { Snap, SnapRpcHookArgs } from '@metamask/snaps-utils';\nimport { HandlerType, WALLET_SNAP_PERMISSION_KEY } from '@metamask/snaps-utils';\nimport type {\n  PendingJsonRpcResponse,\n  Json,\n  JsonRpcRequest,\n} from '@metamask/utils';\nimport { hasProperty } from '@metamask/utils';\n\nimport { getValidatedParams } from './invokeSnapSugar';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'wallet_invokeKeyring';\n\nconst hookNames: MethodHooksObject<InvokeKeyringHooks> = {\n  hasPermission: true,\n  handleSnapRpcRequest: true,\n  getSnap: true,\n  getAllowedKeyringMethods: true,\n};\n\n/**\n * Invoke a keyring method of a Snap. This calls the `onKeyringRequest` handler\n * of the Snap.\n *\n * The Snap must be installed and the dapp must have permission to communicate\n * with the Snap, or the request is rejected. The dapp can install the Snap and\n * request permission to communicate with it using [`wallet_requestSnaps`](https://docs.metamask.io/snaps/reference/snaps-api/wallet_requestsnaps).\n */\nexport const invokeKeyringHandler = {\n  methodNames: [methodName] as const,\n  implementation: invokeKeyringImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  InvokeKeyringHooks,\n  InvokeSnapParams,\n  InvokeKeyringResult\n>;\n\nexport type InvokeKeyringHooks = {\n  hasPermission: (permissionName: string) => boolean;\n\n  handleSnapRpcRequest: ({\n    snapId,\n    handler,\n    request,\n  }: Omit<SnapRpcHookArgs, 'origin'> & { snapId: string }) => Promise<unknown>;\n\n  getSnap: (snapId: string) => Snap | undefined;\n\n  getAllowedKeyringMethods: () => string[];\n};\n\n/**\n * The `wallet_invokeKeyring` method implementation.\n * Invokes onKeyringRequest if the snap requested is installed and connected to the dapp.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.handleSnapRpcRequest - Invokes a snap with a given RPC request.\n * @param hooks.hasPermission - Checks whether a given origin has a given permission.\n * @param hooks.getSnap - Gets information about a given snap.\n * @param hooks.getAllowedKeyringMethods - Get the list of allowed Keyring\n * methods for a given origin.\n * @returns Nothing.\n */\nasync function invokeKeyringImplementation(\n  req: JsonRpcRequest<InvokeKeyringParams>,\n  // `InvokeKeyringResult` is an alias for `Json` (which is the default type\n  // argument for `PendingJsonRpcResponse`), but that may not be the case in the\n  // future. We use `InvokeKeyringResult` here to make it clear that this is the\n  // expected type of the result.\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments\n  res: PendingJsonRpcResponse<InvokeKeyringResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  {\n    handleSnapRpcRequest,\n    hasPermission,\n    getSnap,\n    getAllowedKeyringMethods,\n  }: InvokeKeyringHooks,\n): Promise<void> {\n  let params: InvokeSnapParams;\n  try {\n    params = getValidatedParams(req.params);\n  } catch (error) {\n    return end(error);\n  }\n\n  // We expect the MM middleware stack to always add the origin to requests\n  const { origin } = req as JsonRpcRequest & { origin: string };\n  const { snapId, request } = params;\n\n  if (!origin || !hasPermission(WALLET_SNAP_PERMISSION_KEY)) {\n    return end(\n      rpcErrors.invalidRequest({\n        message: `The snap \"${snapId}\" is not connected to \"${origin}\". Please connect before invoking the snap.`,\n      }),\n    );\n  }\n\n  if (!getSnap(snapId)) {\n    return end(\n      // Mirror error message from SnapController.\n      rpcErrors.invalidRequest({\n        message: `The Snap \"${snapId}\" is not installed. Please install it before invoking it.`,\n      }),\n    );\n  }\n\n  if (!hasProperty(request, 'method') || typeof request.method !== 'string') {\n    return end(\n      rpcErrors.invalidRequest({\n        message: 'The request must have a method.',\n      }),\n    );\n  }\n\n  const allowedMethods = getAllowedKeyringMethods();\n  if (!allowedMethods.includes(request.method)) {\n    return end(\n      rpcErrors.invalidRequest({\n        message: `The origin \"${origin}\" is not allowed to invoke the method \"${request.method}\".`,\n      }),\n    );\n  }\n\n  try {\n    res.result = (await handleSnapRpcRequest({\n      snapId,\n      request,\n      handler: HandlerType.OnKeyringRequest,\n    })) as Json;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}
+{"version":3,"file":"invokeKeyring.mjs","sourceRoot":"","sources":["../../src/permitted/invokeKeyring.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAMjD,OAAO,EAAE,WAAW,EAAE,0BAA0B,EAAE,8BAA8B;AAEhF,OAAO,EAAE,WAAW,EAAE,wBAAwB;AAE9C,OAAO,EAAE,kBAAkB,EAAE,8BAA0B;AAQvD,MAAM,SAAS,GAAgD;IAC7D,wBAAwB,EAAE,IAAI;CAC/B,CAAC;AAgBF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;IACT,WAAW,EAAE;QACX,oCAAoC;QACpC,8BAA8B;QAC9B,wBAAwB;KACzB;CAOF,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,2BAA2B,CACxC,GAAkD;AAClD,0EAA0E;AAC1E,8EAA8E;AAC9E,8EAA8E;AAC9E,+BAA+B;AAC/B,4EAA4E;AAC5E,GAAgD,EAChD,KAAc,EACd,GAA6B,EAC7B,EAAE,wBAAwB,EAA4B,EACtD,SAAwD;IAExD,IAAI,MAAwB,CAAC;IAC7B,IAAI,CAAC;QACH,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IACvB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAEnC,IACE,CAAC,MAAM;QACP,CAAC,SAAS,CAAC,IAAI,CACb,oCAAoC,EACpC,MAAM,EACN,0BAA0B,CAC3B,EACD,CAAC;QACD,OAAO,GAAG,CACR,SAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,aAAa,MAAM,0BAA0B,MAAM,6CAA6C;SAC1G,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,wBAAwB,EAAE,MAAM,CAAC,EAAE,CAAC;QACtD,OAAO,GAAG;QACR,4CAA4C;QAC5C,SAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,aAAa,MAAM,2DAA2D;SACxF,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC1E,OAAO,GAAG,CACR,SAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,iCAAiC;SAC3C,CAAC,CACH,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAG,wBAAwB,EAAE,CAAC;IAClD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7C,OAAO,GAAG,CACR,SAAS,CAAC,cAAc,CAAC;YACvB,OAAO,EAAE,eAAe,MAAM,0CAA0C,OAAO,CAAC,MAAM,IAAI;SAC3F,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,GAAG,CAAC,MAAM,GAAG,CAAC,MAAM,SAAS,CAAC,IAAI,CAAC,8BAA8B,EAAE;YACjE,MAAM;YACN,MAAM;YACN,OAAO;YACP,OAAO,EAAE,WAAW,CAAC,gBAAgB;SACtC,CAAC,CAAS,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type {\n  JsonRpcEngineEndCallback,\n  MethodHandler,\n} from '@metamask/json-rpc-engine';\nimport type { Messenger } from '@metamask/messenger';\nimport type { PermissionControllerHasPermissionAction } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  InvokeKeyringParams,\n  InvokeKeyringResult,\n  InvokeSnapParams,\n} from '@metamask/snaps-sdk';\nimport { HandlerType, WALLET_SNAP_PERMISSION_KEY } from '@metamask/snaps-utils';\nimport type { PendingJsonRpcResponse, Json } from '@metamask/utils';\nimport { hasProperty } from '@metamask/utils';\n\nimport { getValidatedParams } from './invokeSnapSugar';\nimport type {\n  JsonRpcRequestWithOrigin,\n  SnapControllerGetSnapAction,\n  SnapControllerHandleRequestAction,\n} from '../types';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<InvokeKeyringMethodHooks> = {\n  getAllowedKeyringMethods: true,\n};\n\nexport type InvokeKeyringMethodHooks = {\n  /**\n   * Get the list of allowed Keyring methods for a given origin.\n   *\n   * @returns The list of allowed Keyring methods.\n   */\n  getAllowedKeyringMethods: () => string[];\n};\n\nexport type InvokeKeyringMethodActions =\n  | PermissionControllerHasPermissionAction\n  | SnapControllerHandleRequestAction\n  | SnapControllerGetSnapAction;\n\n/**\n * Invoke a keyring method of a Snap. This calls the `onKeyringRequest` handler\n * of the Snap.\n *\n * The Snap must be installed and the dapp must have permission to communicate\n * with the Snap, or the request is rejected. The dapp can install the Snap and\n * request permission to communicate with it using [`wallet_requestSnaps`](https://docs.metamask.io/snaps/reference/snaps-api/wallet_requestsnaps).\n */\nexport const invokeKeyringHandler = {\n  implementation: invokeKeyringImplementation,\n  hookNames,\n  actionNames: [\n    'PermissionController:hasPermission',\n    'SnapController:handleRequest',\n    'SnapController:getSnap',\n  ],\n} satisfies MethodHandler<\n  InvokeKeyringMethodHooks,\n  InvokeKeyringMethodActions,\n  InvokeSnapParams,\n  InvokeKeyringResult,\n  { origin: string }\n>;\n\n/**\n * The `wallet_invokeKeyring` method implementation.\n * Invokes onKeyringRequest if the snap requested is installed and connected to the dapp.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.getAllowedKeyringMethods - Get the list of allowed Keyring\n * methods for a given origin.\n * @param messenger - The messenger used to call controller actions.\n * @returns Nothing.\n */\nasync function invokeKeyringImplementation(\n  req: JsonRpcRequestWithOrigin<InvokeKeyringParams>,\n  // `InvokeKeyringResult` is an alias for `Json` (which is the default type\n  // argument for `PendingJsonRpcResponse`), but that may not be the case in the\n  // future. We use `InvokeKeyringResult` here to make it clear that this is the\n  // expected type of the result.\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments\n  res: PendingJsonRpcResponse<InvokeKeyringResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { getAllowedKeyringMethods }: InvokeKeyringMethodHooks,\n  messenger: Messenger<string, InvokeKeyringMethodActions>,\n): Promise<void> {\n  let params: InvokeSnapParams;\n  try {\n    params = getValidatedParams(req.params);\n  } catch (error) {\n    return end(error);\n  }\n\n  const { origin } = req;\n  const { snapId, request } = params;\n\n  if (\n    !origin ||\n    !messenger.call(\n      'PermissionController:hasPermission',\n      origin,\n      WALLET_SNAP_PERMISSION_KEY,\n    )\n  ) {\n    return end(\n      rpcErrors.invalidRequest({\n        message: `The snap \"${snapId}\" is not connected to \"${origin}\". Please connect before invoking the snap.`,\n      }),\n    );\n  }\n\n  if (!messenger.call('SnapController:getSnap', snapId)) {\n    return end(\n      // Mirror error message from SnapController.\n      rpcErrors.invalidRequest({\n        message: `The Snap \"${snapId}\" is not installed. Please install it before invoking it.`,\n      }),\n    );\n  }\n\n  if (!hasProperty(request, 'method') || typeof request.method !== 'string') {\n    return end(\n      rpcErrors.invalidRequest({\n        message: 'The request must have a method.',\n      }),\n    );\n  }\n\n  const allowedMethods = getAllowedKeyringMethods();\n  if (!allowedMethods.includes(request.method)) {\n    return end(\n      rpcErrors.invalidRequest({\n        message: `The origin \"${origin}\" is not allowed to invoke the method \"${request.method}\".`,\n      }),\n    );\n  }\n\n  try {\n    res.result = (await messenger.call('SnapController:handleRequest', {\n      origin,\n      snapId,\n      request,\n      handler: HandlerType.OnKeyringRequest,\n    })) as Json;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n"]}

package/dist/permitted/invokeSnapSugar.cjs

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getValidatedParams = exports.invokeSnapSugar = exports.invokeSnapSugarHandler = void 0;
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const utils_1 = require("@metamask/utils");
-const methodName = 'wallet_invokeSnap';
+const invokeSnap_1 = require("../restricted/invokeSnap.cjs");
 /**
  * Invoke a method of a Snap, designated by the `snapId` parameter, with a
  * JSON-RPC request specified in the `request` parameter. This is effectively a
@@ -30,11 +30,8 @@ const methodName = 'wallet_invokeSnap';
  * ```
  */
 exports.invokeSnapSugarHandler = {
-    methodNames: [methodName],
     implementation: invokeSnapSugar,
-    hookNames: {
-        invokeSnap: true,
-    },
+    actionNames: ['PermissionController:executeRestrictedMethod'],
 };
 /**
  * The `wallet_invokeSnap` method implementation.
@@ -44,9 +41,8 @@ exports.invokeSnapSugarHandler = {
  * @param res - The JSON-RPC response object.
  * @param _next - The `json-rpc-engine` "next" callback.
  * @param end - The `json-rpc-engine` "end" callback.
- * @param hooks - The RPC method hooks.
- * @param hooks.invokeSnap - A function to invoke a snap designated by its parameters,
- * bound to the requesting origin.
+ * @param _hooks - The RPC method hooks. Not used by this function.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  * @throws If the params are invalid.
  */
@@ -56,10 +52,10 @@ async function invokeSnapSugar(req,
 // future. We use `InvokeSnapResult` here to make it clear that this is the
 // expected type of the result.
 // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments
-res, _next, end, { invokeSnap }) {
+res, _next, end, _hooks, messenger) {
     try {
         const params = getValidatedParams(req.params);
-        res.result = await invokeSnap(params);
+        res.result = await messenger.call('PermissionController:executeRestrictedMethod', req.origin, invokeSnap_1.WALLET_SNAP_PERMISSION_KEY, params);
     }
     catch (error) {
         return end(error);

package/dist/permitted/invokeSnapSugar.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"invokeSnapSugar.cjs","sourceRoot":"","sources":["../../src/permitted/invokeSnapSugar.ts"],"names":[],"mappings":";;;AAKA,qDAAiD;AAGjD,2CAA2C;AAE3C,MAAM,UAAU,GAAG,mBAAmB,CAAC;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACU,QAAA,sBAAsB,GAAG;IACpC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,eAAe;IAC/B,SAAS,EAAE;QACT,UAAU,EAAE,IAAI;KACjB;CAKF,CAAC;AAMF;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,eAAe,CACnC,GAAqC;AACrC,uEAAuE;AACvE,8EAA8E;AAC9E,2EAA2E;AAC3E,+BAA+B;AAC/B,4EAA4E;AAC5E,GAA6C,EAC7C,KAAgC,EAChC,GAA6B,EAC7B,EAAE,UAAU,EAAwB;IAEpC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC9C,GAAG,CAAC,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IACD,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAnBD,0CAmBC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAAC,MAAe;IAChD,IAAI,CAAC,IAAA,gBAAQ,EAAC,MAAM,CAAC,EAAE,CAAC;QACtB,MAAM,sBAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,wCAAwC;SAClD,CAAC,CAAC;IACL,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAEnC,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;QAC3D,MAAM,sBAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,+BAA+B;SACzC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,IAAA,gBAAQ,EAAC,OAAO,CAAC,EAAE,CAAC;QACvB,MAAM,sBAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,yCAAyC;SACnD,CAAC,CAAC;IACL,CAAC;IAED,OAAO,MAA0B,CAAC;AACpC,CAAC;AAtBD,gDAsBC","sourcesContent":["import type {\n  JsonRpcEngineEndCallback,\n  JsonRpcEngineNextCallback,\n} from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { InvokeSnapParams, InvokeSnapResult } from '@metamask/snaps-sdk';\nimport type { JsonRpcRequest, PendingJsonRpcResponse } from '@metamask/utils';\nimport { isObject } from '@metamask/utils';\n\nconst methodName = 'wallet_invokeSnap';\n\n/**\n * Invoke a method of a Snap, designated by the `snapId` parameter, with a\n * JSON-RPC request specified in the `request` parameter. This is effectively a\n * wrapper around [`wallet_snap`](https://docs.metamask.io/snaps/reference/snaps-api/wallet_snap)\n * that allows for more convenient invocation of Snap methods without needing to\n * specify the full `wallet_snap` parameters.\n *\n * The Snap must be installed and the dapp must have permission to communicate\n * with the Snap, or the request is rejected. The dapp can install the Snap and\n * request permission to communicate with it using [`wallet_requestSnaps`](https://docs.metamask.io/snaps/reference/snaps-api/wallet_requestsnaps).\n *\n * @example\n * ```ts\n * const result = await snap.request({\n *   method: 'wallet_invokeSnap',\n *   params: {\n *     snapId: 'npm:@metamask/example-snap',\n *     request: {\n *       method: 'someMethod',\n *       params: { some: 'params' },\n *     },\n *   },\n * });\n * ```\n */\nexport const invokeSnapSugarHandler = {\n  methodNames: [methodName] as const,\n  implementation: invokeSnapSugar,\n  hookNames: {\n    invokeSnap: true,\n  },\n} satisfies PermittedHandlerExport<\n  InvokeSnapSugarHooks,\n  InvokeSnapParams,\n  InvokeSnapResult\n>;\n\nexport type InvokeSnapSugarHooks = {\n  invokeSnap: (params: InvokeSnapParams) => Promise<InvokeSnapResult>;\n};\n\n/**\n * The `wallet_invokeSnap` method implementation.\n * Effectively calls `wallet_snap` under the hood.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.invokeSnap - A function to invoke a snap designated by its parameters,\n * bound to the requesting origin.\n * @returns Nothing.\n * @throws If the params are invalid.\n */\nexport async function invokeSnapSugar(\n  req: JsonRpcRequest<InvokeSnapParams>,\n  // `InvokeSnapResult` is an alias for `Json` (which is the default type\n  // argument for `PendingJsonRpcResponse`), but that may not be the case in the\n  // future. We use `InvokeSnapResult` here to make it clear that this is the\n  // expected type of the result.\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments\n  res: PendingJsonRpcResponse<InvokeSnapResult>,\n  _next: JsonRpcEngineNextCallback,\n  end: JsonRpcEngineEndCallback,\n  { invokeSnap }: InvokeSnapSugarHooks,\n): Promise<void> {\n  try {\n    const params = getValidatedParams(req.params);\n    res.result = await invokeSnap(params);\n  } catch (error) {\n    return end(error);\n  }\n  return end();\n}\n\n/**\n * Validates the wallet_invokeSnap method `params` and returns them cast to the correct\n * type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated method parameter object.\n */\nexport function getValidatedParams(params: unknown): InvokeSnapParams {\n  if (!isObject(params)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected params to be a single object.',\n    });\n  }\n\n  const { snapId, request } = params;\n\n  if (!snapId || typeof snapId !== 'string' || snapId === '') {\n    throw rpcErrors.invalidParams({\n      message: 'Must specify a valid snap ID.',\n    });\n  }\n\n  if (!isObject(request)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected request to be a single object.',\n    });\n  }\n\n  return params as InvokeSnapParams;\n}\n"]}
+{"version":3,"file":"invokeSnapSugar.cjs","sourceRoot":"","sources":["../../src/permitted/invokeSnapSugar.ts"],"names":[],"mappings":";;;AAOA,qDAAiD;AAGjD,2CAA2C;AAE3C,6DAAsE;AAMtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACU,QAAA,sBAAsB,GAAG;IACpC,cAAc,EAAE,eAAe;IAC/B,WAAW,EAAE,CAAC,8CAA8C,CAAC;CAO9D,CAAC;AAEF;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,eAAe,CACnC,GAA+C;AAC/C,uEAAuE;AACvE,8EAA8E;AAC9E,2EAA2E;AAC3E,+BAA+B;AAC/B,4EAA4E;AAC5E,GAA6C,EAC7C,KAAgC,EAChC,GAA6B,EAC7B,MAAa,EACb,SAA0D;IAE1D,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC9C,GAAG,CAAC,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,CAC/B,8CAA8C,EAC9C,GAAG,CAAC,MAAM,EACV,uCAA0B,EAC1B,MAAM,CACP,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IACD,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAzBD,0CAyBC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAAC,MAAe;IAChD,IAAI,CAAC,IAAA,gBAAQ,EAAC,MAAM,CAAC,EAAE,CAAC;QACtB,MAAM,sBAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,wCAAwC;SAClD,CAAC,CAAC;IACL,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAEnC,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;QAC3D,MAAM,sBAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,+BAA+B;SACzC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,IAAA,gBAAQ,EAAC,OAAO,CAAC,EAAE,CAAC;QACvB,MAAM,sBAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,yCAAyC;SACnD,CAAC,CAAC;IACL,CAAC;IAED,OAAO,MAA0B,CAAC;AACpC,CAAC;AAtBD,gDAsBC","sourcesContent":["import type {\n  JsonRpcEngineEndCallback,\n  JsonRpcEngineNextCallback,\n  MethodHandler,\n} from '@metamask/json-rpc-engine';\nimport type { Messenger } from '@metamask/messenger';\nimport type { PermissionControllerExecuteRestrictedMethodAction } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { InvokeSnapParams, InvokeSnapResult } from '@metamask/snaps-sdk';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\nimport { isObject } from '@metamask/utils';\n\nimport { WALLET_SNAP_PERMISSION_KEY } from '../restricted/invokeSnap';\nimport type { JsonRpcRequestWithOrigin } from '../types';\n\nexport type InvokeSnapSugarMethodActions =\n  PermissionControllerExecuteRestrictedMethodAction;\n\n/**\n * Invoke a method of a Snap, designated by the `snapId` parameter, with a\n * JSON-RPC request specified in the `request` parameter. This is effectively a\n * wrapper around [`wallet_snap`](https://docs.metamask.io/snaps/reference/snaps-api/wallet_snap)\n * that allows for more convenient invocation of Snap methods without needing to\n * specify the full `wallet_snap` parameters.\n *\n * The Snap must be installed and the dapp must have permission to communicate\n * with the Snap, or the request is rejected. The dapp can install the Snap and\n * request permission to communicate with it using [`wallet_requestSnaps`](https://docs.metamask.io/snaps/reference/snaps-api/wallet_requestsnaps).\n *\n * @example\n * ```ts\n * const result = await snap.request({\n *   method: 'wallet_invokeSnap',\n *   params: {\n *     snapId: 'npm:@metamask/example-snap',\n *     request: {\n *       method: 'someMethod',\n *       params: { some: 'params' },\n *     },\n *   },\n * });\n * ```\n */\nexport const invokeSnapSugarHandler = {\n  implementation: invokeSnapSugar,\n  actionNames: ['PermissionController:executeRestrictedMethod'],\n} satisfies MethodHandler<\n  never,\n  InvokeSnapSugarMethodActions,\n  InvokeSnapParams,\n  InvokeSnapResult,\n  { origin: string }\n>;\n\n/**\n * The `wallet_invokeSnap` method implementation.\n * Effectively calls `wallet_snap` under the hood.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param _hooks - The RPC method hooks. Not used by this function.\n * @param messenger - The messenger used to call controller actions.\n * @returns Nothing.\n * @throws If the params are invalid.\n */\nexport async function invokeSnapSugar(\n  req: JsonRpcRequestWithOrigin<InvokeSnapParams>,\n  // `InvokeSnapResult` is an alias for `Json` (which is the default type\n  // argument for `PendingJsonRpcResponse`), but that may not be the case in the\n  // future. We use `InvokeSnapResult` here to make it clear that this is the\n  // expected type of the result.\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments\n  res: PendingJsonRpcResponse<InvokeSnapResult>,\n  _next: JsonRpcEngineNextCallback,\n  end: JsonRpcEngineEndCallback,\n  _hooks: never,\n  messenger: Messenger<string, InvokeSnapSugarMethodActions>,\n): Promise<void> {\n  try {\n    const params = getValidatedParams(req.params);\n    res.result = await messenger.call(\n      'PermissionController:executeRestrictedMethod',\n      req.origin,\n      WALLET_SNAP_PERMISSION_KEY,\n      params,\n    );\n  } catch (error) {\n    return end(error);\n  }\n  return end();\n}\n\n/**\n * Validates the wallet_invokeSnap method `params` and returns them cast to the correct\n * type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated method parameter object.\n */\nexport function getValidatedParams(params: unknown): InvokeSnapParams {\n  if (!isObject(params)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected params to be a single object.',\n    });\n  }\n\n  const { snapId, request } = params;\n\n  if (!snapId || typeof snapId !== 'string' || snapId === '') {\n    throw rpcErrors.invalidParams({\n      message: 'Must specify a valid snap ID.',\n    });\n  }\n\n  if (!isObject(request)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected request to be a single object.',\n    });\n  }\n\n  return params as InvokeSnapParams;\n}\n"]}

package/dist/permitted/invokeSnapSugar.d.cts

@@ -1,6 +1,10 @@
 import type { JsonRpcEngineEndCallback, JsonRpcEngineNextCallback } from "@metamask/json-rpc-engine";
+import type { Messenger } from "@metamask/messenger";
+import type { PermissionControllerExecuteRestrictedMethodAction } from "@metamask/permission-controller";
 import type { InvokeSnapParams, InvokeSnapResult } from "@metamask/snaps-sdk";
-import type { JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
+import type { PendingJsonRpcResponse } from "@metamask/utils";
+import type { JsonRpcRequestWithOrigin } from "../types.cjs";
+export type InvokeSnapSugarMethodActions = PermissionControllerExecuteRestrictedMethodAction;
 /**
  * Invoke a method of a Snap, designated by the `snapId` parameter, with a
  * JSON-RPC request specified in the `request` parameter. This is effectively a
@@ -27,14 +31,8 @@ import type { JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
  * ```
  */
 export declare const invokeSnapSugarHandler: {
-    methodNames: ["wallet_invokeSnap"];
     implementation: typeof invokeSnapSugar;
-    hookNames: {
-        invokeSnap: true;
-    };
-};
-export type InvokeSnapSugarHooks = {
-    invokeSnap: (params: InvokeSnapParams) => Promise<InvokeSnapResult>;
+    actionNames: "PermissionController:executeRestrictedMethod"[];
 };
 /**
  * The `wallet_invokeSnap` method implementation.
@@ -44,13 +42,12 @@ export type InvokeSnapSugarHooks = {
  * @param res - The JSON-RPC response object.
  * @param _next - The `json-rpc-engine` "next" callback.
  * @param end - The `json-rpc-engine` "end" callback.
- * @param hooks - The RPC method hooks.
- * @param hooks.invokeSnap - A function to invoke a snap designated by its parameters,
- * bound to the requesting origin.
+ * @param _hooks - The RPC method hooks. Not used by this function.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  * @throws If the params are invalid.
  */
-export declare function invokeSnapSugar(req: JsonRpcRequest<InvokeSnapParams>, res: PendingJsonRpcResponse<InvokeSnapResult>, _next: JsonRpcEngineNextCallback, end: JsonRpcEngineEndCallback, { invokeSnap }: InvokeSnapSugarHooks): Promise<void>;
+export declare function invokeSnapSugar(req: JsonRpcRequestWithOrigin<InvokeSnapParams>, res: PendingJsonRpcResponse<InvokeSnapResult>, _next: JsonRpcEngineNextCallback, end: JsonRpcEngineEndCallback, _hooks: never, messenger: Messenger<string, InvokeSnapSugarMethodActions>): Promise<void>;
 /**
  * Validates the wallet_invokeSnap method `params` and returns them cast to the correct
  * type. Throws if validation fails.