@metamask/snaps-rpc-methods 15.1.0 → 16.0.0

package/dist/permitted/trackEvent.cjs

@@ -4,7 +4,6 @@ exports.trackEventHandler = void 0;
 const rpc_errors_1 = require("@metamask/rpc-errors");
 const superstruct_1 = require("@metamask/superstruct");
 const utils_1 = require("@metamask/utils");
-const methodName = 'snap_trackEvent';
 const PropertiesStruct = (0, superstruct_1.optional)((0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct));
 const snakeCaseRegex = /^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$/u;
 const SnakeCasePropertiesStruct = (0, superstruct_1.refine)(PropertiesStruct, 'snake_case_keys', (value) => {
@@ -15,7 +14,6 @@ const SnakeCasePropertiesStruct = (0, superstruct_1.refine)(PropertiesStruct, 's
 });
 const hookNames = {
     trackEvent: true,
-    getSnap: true,
 };
 const TrackEventParametersStruct = (0, superstruct_1.object)({
     event: (0, superstruct_1.object)({
@@ -30,9 +28,9 @@ const TrackEventParametersStruct = (0, superstruct_1.object)({
  * @internal
  */
 exports.trackEventHandler = {
-    methodNames: [methodName],
     implementation: getTrackEventImplementation,
     hookNames,
+    actionNames: ['SnapController:getSnap'],
 };
 /**
  * The `snap_trackEvent` method implementation.
@@ -44,11 +42,11 @@ exports.trackEventHandler = {
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
  * @param hooks.trackEvent - The function to track the event.
- * @param hooks.getSnap - The function to get Snap metadata.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-function getTrackEventImplementation(req, res, _next, end, { trackEvent, getSnap }) {
-    const snap = getSnap(req.origin);
+function getTrackEventImplementation(req, res, _next, end, { trackEvent }, messenger) {
+    const snap = messenger.call('SnapController:getSnap', req.origin);
     if (!snap?.preinstalled) {
         return end(rpc_errors_1.rpcErrors.methodNotFound());
     }

package/dist/permitted/trackEvent.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"trackEvent.cjs","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAOjD,uDAQ+B;AAE/B,2CAA6C;AAI7C,MAAM,UAAU,GAAG,iBAAiB,CAAC;AAErC,MAAM,gBAAgB,GAAG,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC,CAAC;AAEhE,MAAM,cAAc,GAAG,kCAAkC,CAAC;AAE1D,MAAM,yBAAyB,GAAG,IAAA,oBAAM,EACtC,gBAAgB,EAChB,iBAAiB,EACjB,CAAC,KAAK,EAAE,EAAE;IACR,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACrE,CAAC,CACF,CAAC;AAEF,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;CACd,CAAC;AAuBF,MAAM,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IACxC,KAAK,EAAE,IAAA,oBAAM,EAAC;QACZ,KAAK,EAAE,IAAA,oBAAM,GAAE;QACf,UAAU,EAAE,yBAAyB;QACrC,mBAAmB,EAAE,yBAAyB;KAC/C,CAAC;CACH,CAAC,CAAC;AAOH;;;;GAIG;AACU,QAAA,iBAAiB,GAAG;IAC/B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CAKV,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,SAAS,2BAA2B,CAClC,GAAyC,EACzC,GAA6C,EAC7C,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAyB;IAE9C,MAAM,IAAI,GAAG,OAAO,CACjB,GAA6D,CAAC,MAAM,CACtE,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,sBAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAClC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,IAAI,KAAK,CAAC,UAAU,KAAK,iBAAiB,EAAE,CAAC;gBAC3C,MAAM,sBAAS,CAAC,aAAa,CAAC;oBAC5B,OAAO,EAAE,mHAAmH,KAAK,CAAC,GAAG,IAAI;iBAC1I,CAAC,CAAC;YACL,CAAC;YAED,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,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  JsonRpcRequest,\n  TrackEventParams,\n  TrackEventResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching, Snap } from '@metamask/snaps-utils';\nimport {\n  create,\n  object,\n  optional,\n  record,\n  refine,\n  string,\n  StructError,\n} from '@metamask/superstruct';\nimport type { Json, PendingJsonRpcResponse } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_trackEvent';\n\nconst PropertiesStruct = optional(record(string(), JsonStruct));\n\nconst snakeCaseRegex = /^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$/u;\n\nconst SnakeCasePropertiesStruct = refine(\n  PropertiesStruct,\n  'snake_case_keys',\n  (value) => {\n    if (!value) {\n      return true;\n    }\n\n    return Object.keys(value).every((key) => snakeCaseRegex.test(key));\n  },\n);\n\nconst hookNames: MethodHooksObject<TrackEventMethodHooks> = {\n  trackEvent: true,\n  getSnap: true,\n};\n\nexport type TrackEventMethodHooks = {\n  /**\n   * Track an event.\n   *\n   * @param event - The event object containing event details and properties.\n   */\n  trackEvent: (event: TrackEventObject) => void;\n  /**\n   * Get Snap metadata.\n   *\n   * @param snapId - The ID of a Snap.\n   */\n  getSnap: (snapId: string) => Snap | undefined;\n};\n\nexport type TrackEventObject = {\n  event: string;\n  properties?: Record<string, Json>;\n  sensitiveProperties?: Record<string, Json>;\n};\n\nconst TrackEventParametersStruct = object({\n  event: object({\n    event: string(),\n    properties: SnakeCasePropertiesStruct,\n    sensitiveProperties: SnakeCasePropertiesStruct,\n  }),\n});\n\nexport type TrackEventParameters = InferMatching<\n  typeof TrackEventParametersStruct,\n  TrackEventParams\n>;\n\n/**\n * Handler for the `snap_trackEvent` method.\n *\n * @internal\n */\nexport const trackEventHandler = {\n  methodNames: [methodName] as const,\n  implementation: getTrackEventImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  TrackEventMethodHooks,\n  TrackEventParameters,\n  TrackEventResult\n>;\n\n/**\n * The `snap_trackEvent` method implementation.\n * This method allows pre-installed Snaps to submit tracking events to the client.\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 function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.trackEvent - The function to track the event.\n * @param hooks.getSnap - The function to get Snap metadata.\n * @returns Nothing.\n */\nfunction getTrackEventImplementation(\n  req: JsonRpcRequest<TrackEventParameters>,\n  res: PendingJsonRpcResponse<TrackEventResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { trackEvent, getSnap }: TrackEventMethodHooks,\n): void {\n  const snap = getSnap(\n    (req as JsonRpcRequest<TrackEventParams> & { origin: string }).origin,\n  );\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    trackEvent(validatedParams.event);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validates the parameters for the snap_trackEvent method.\n *\n * @param params - Parameters to validate.\n * @returns Validated parameters.\n * @throws Throws RPC error if validation fails.\n */\nfunction getValidatedParams(params: unknown): TrackEventParameters {\n  try {\n    return create(params, TrackEventParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      if (error.refinement === 'snake_case_keys') {\n        throw rpcErrors.invalidParams({\n          message: `Invalid params: All property keys must be in snake_case format. The following key contains invalid properties: \"${error.key}\".`,\n        });\n      }\n\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}
+{"version":3,"file":"trackEvent.cjs","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":";;;AAKA,qDAAiD;AAGjD,uDAQ+B;AAE/B,2CAA6C;AAQ7C,MAAM,gBAAgB,GAAG,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC,CAAC;AAEhE,MAAM,cAAc,GAAG,kCAAkC,CAAC;AAE1D,MAAM,yBAAyB,GAAG,IAAA,oBAAM,EACtC,gBAAgB,EAChB,iBAAiB,EACjB,CAAC,KAAK,EAAE,EAAE;IACR,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACrE,CAAC,CACF,CAAC;AAEF,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;CACjB,CAAC;AAmBF,MAAM,0BAA0B,GAAG,IAAA,oBAAM,EAAC;IACxC,KAAK,EAAE,IAAA,oBAAM,EAAC;QACZ,KAAK,EAAE,IAAA,oBAAM,GAAE;QACf,UAAU,EAAE,yBAAyB;QACrC,mBAAmB,EAAE,yBAAyB;KAC/C,CAAC;CACH,CAAC,CAAC;AAOH;;;;GAIG;AACU,QAAA,iBAAiB,GAAG;IAC/B,cAAc,EAAE,2BAA2B;IAC3C,SAAS;IACT,WAAW,EAAE,CAAC,wBAAwB,CAAC;CAOxC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,SAAS,2BAA2B,CAClC,GAAmD,EACnD,GAA6C,EAC7C,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAyB,EACrC,SAAqD;IAErD,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,wBAAwB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAElE,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,sBAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAClC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,IAAI,KAAK,CAAC,UAAU,KAAK,iBAAiB,EAAE,CAAC;gBAC3C,MAAM,sBAAS,CAAC,aAAa,CAAC;oBAC5B,OAAO,EAAE,mHAAmH,KAAK,CAAC,GAAG,IAAI;iBAC1I,CAAC,CAAC;YACL,CAAC;YAED,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type {\n  JsonRpcEngineEndCallback,\n  MethodHandler,\n} from '@metamask/json-rpc-engine';\nimport type { Messenger } from '@metamask/messenger';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { TrackEventParams, TrackEventResult } from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport {\n  create,\n  object,\n  optional,\n  record,\n  refine,\n  string,\n  StructError,\n} from '@metamask/superstruct';\nimport type { Json, PendingJsonRpcResponse } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\n\nimport type {\n  JsonRpcRequestWithOrigin,\n  SnapControllerGetSnapAction,\n} from '../types';\nimport type { MethodHooksObject } from '../utils';\n\nconst PropertiesStruct = optional(record(string(), JsonStruct));\n\nconst snakeCaseRegex = /^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$/u;\n\nconst SnakeCasePropertiesStruct = refine(\n  PropertiesStruct,\n  'snake_case_keys',\n  (value) => {\n    if (!value) {\n      return true;\n    }\n\n    return Object.keys(value).every((key) => snakeCaseRegex.test(key));\n  },\n);\n\nconst hookNames: MethodHooksObject<TrackEventMethodHooks> = {\n  trackEvent: true,\n};\n\nexport type TrackEventMethodHooks = {\n  /**\n   * Track an event.\n   *\n   * @param event - The event object containing event details and properties.\n   */\n  trackEvent: (event: TrackEventObject) => void;\n};\n\nexport type TrackEventMethodActions = SnapControllerGetSnapAction;\n\nexport type TrackEventObject = {\n  event: string;\n  properties?: Record<string, Json>;\n  sensitiveProperties?: Record<string, Json>;\n};\n\nconst TrackEventParametersStruct = object({\n  event: object({\n    event: string(),\n    properties: SnakeCasePropertiesStruct,\n    sensitiveProperties: SnakeCasePropertiesStruct,\n  }),\n});\n\nexport type TrackEventParameters = InferMatching<\n  typeof TrackEventParametersStruct,\n  TrackEventParams\n>;\n\n/**\n * Handler for the `snap_trackEvent` method.\n *\n * @internal\n */\nexport const trackEventHandler = {\n  implementation: getTrackEventImplementation,\n  hookNames,\n  actionNames: ['SnapController:getSnap'],\n} satisfies MethodHandler<\n  TrackEventMethodHooks,\n  TrackEventMethodActions,\n  TrackEventParameters,\n  TrackEventResult,\n  { origin: string }\n>;\n\n/**\n * The `snap_trackEvent` method implementation.\n * This method allows pre-installed Snaps to submit tracking events to the client.\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 function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.trackEvent - The function to track the event.\n * @param messenger - The messenger used to call controller actions.\n * @returns Nothing.\n */\nfunction getTrackEventImplementation(\n  req: JsonRpcRequestWithOrigin<TrackEventParameters>,\n  res: PendingJsonRpcResponse<TrackEventResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { trackEvent }: TrackEventMethodHooks,\n  messenger: Messenger<string, TrackEventMethodActions>,\n): void {\n  const snap = messenger.call('SnapController:getSnap', req.origin);\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    trackEvent(validatedParams.event);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validates the parameters for the snap_trackEvent method.\n *\n * @param params - Parameters to validate.\n * @returns Validated parameters.\n * @throws Throws RPC error if validation fails.\n */\nfunction getValidatedParams(params: unknown): TrackEventParameters {\n  try {\n    return create(params, TrackEventParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      if (error.refinement === 'snake_case_keys') {\n        throw rpcErrors.invalidParams({\n          message: `Invalid params: All property keys must be in snake_case format. The following key contains invalid properties: \"${error.key}\".`,\n        });\n      }\n\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}

package/dist/permitted/trackEvent.d.cts

@@ -1,7 +1,9 @@
 import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
-import type { JsonRpcRequest, TrackEventParams, TrackEventResult } from "@metamask/snaps-sdk";
-import type { InferMatching, Snap } from "@metamask/snaps-utils";
+import type { Messenger } from "@metamask/messenger";
+import type { TrackEventParams, TrackEventResult } from "@metamask/snaps-sdk";
+import type { InferMatching } from "@metamask/snaps-utils";
 import type { Json, PendingJsonRpcResponse } from "@metamask/utils";
+import type { JsonRpcRequestWithOrigin, SnapControllerGetSnapAction } from "../types.cjs";
 import type { MethodHooksObject } from "../utils.cjs";
 export type TrackEventMethodHooks = {
     /**
@@ -10,13 +12,8 @@ export type TrackEventMethodHooks = {
      * @param event - The event object containing event details and properties.
      */
     trackEvent: (event: TrackEventObject) => void;
-    /**
-     * Get Snap metadata.
-     *
-     * @param snapId - The ID of a Snap.
-     */
-    getSnap: (snapId: string) => Snap | undefined;
 };
+export type TrackEventMethodActions = SnapControllerGetSnapAction;
 export type TrackEventObject = {
     event: string;
     properties?: Record<string, Json>;
@@ -46,9 +43,9 @@ export type TrackEventParameters = InferMatching<typeof TrackEventParametersStru
  * @internal
  */
 export declare const trackEventHandler: {
-    methodNames: ["snap_trackEvent"];
     implementation: typeof getTrackEventImplementation;
     hookNames: MethodHooksObject<TrackEventMethodHooks>;
+    actionNames: "SnapController:getSnap"[];
 };
 /**
  * The `snap_trackEvent` method implementation.
@@ -60,9 +57,9 @@ export declare const trackEventHandler: {
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
  * @param hooks.trackEvent - The function to track the event.
- * @param hooks.getSnap - The function to get Snap metadata.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-declare function getTrackEventImplementation(req: JsonRpcRequest<TrackEventParameters>, res: PendingJsonRpcResponse<TrackEventResult>, _next: unknown, end: JsonRpcEngineEndCallback, { trackEvent, getSnap }: TrackEventMethodHooks): void;
+declare function getTrackEventImplementation(req: JsonRpcRequestWithOrigin<TrackEventParameters>, res: PendingJsonRpcResponse<TrackEventResult>, _next: unknown, end: JsonRpcEngineEndCallback, { trackEvent }: TrackEventMethodHooks, messenger: Messenger<string, TrackEventMethodActions>): void;
 export {};
 //# sourceMappingURL=trackEvent.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"trackEvent.d.cts","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EACjB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,8BAA8B;AAUjE,OAAO,KAAK,EAAE,IAAI,EAAE,sBAAsB,EAAE,wBAAwB;AAGpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAyBlD,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;OAIG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC9C;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC5C,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;;;;;;;;;;;;;EAM9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;CAQ7B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,iBAAS,2BAA2B,CAClC,GAAG,EAAE,cAAc,CAAC,oBAAoB,CAAC,EACzC,GAAG,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,EAC7C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,qBAAqB,GAC7C,IAAI,CAoBN"}
+{"version":3,"file":"trackEvent.d.cts","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,4BAA4B;AAC9E,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAU3D,OAAO,KAAK,EAAE,IAAI,EAAE,sBAAsB,EAAE,wBAAwB;AAGpE,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAC5B,qBAAiB;AAClB,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAsBlD,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;OAIG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,2BAA2B,CAAC;AAElE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC5C,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;;;;;;;;;;;;;EAM9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;CAU7B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,iBAAS,2BAA2B,CAClC,GAAG,EAAE,wBAAwB,CAAC,oBAAoB,CAAC,EACnD,GAAG,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,EAC7C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,UAAU,EAAE,EAAE,qBAAqB,EACrC,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,uBAAuB,CAAC,GACpD,IAAI,CAkBN"}

package/dist/permitted/trackEvent.d.mts

@@ -1,7 +1,9 @@
 import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
-import type { JsonRpcRequest, TrackEventParams, TrackEventResult } from "@metamask/snaps-sdk";
-import type { InferMatching, Snap } from "@metamask/snaps-utils";
+import type { Messenger } from "@metamask/messenger";
+import type { TrackEventParams, TrackEventResult } from "@metamask/snaps-sdk";
+import type { InferMatching } from "@metamask/snaps-utils";
 import type { Json, PendingJsonRpcResponse } from "@metamask/utils";
+import type { JsonRpcRequestWithOrigin, SnapControllerGetSnapAction } from "../types.mjs";
 import type { MethodHooksObject } from "../utils.mjs";
 export type TrackEventMethodHooks = {
     /**
@@ -10,13 +12,8 @@ export type TrackEventMethodHooks = {
      * @param event - The event object containing event details and properties.
      */
     trackEvent: (event: TrackEventObject) => void;
-    /**
-     * Get Snap metadata.
-     *
-     * @param snapId - The ID of a Snap.
-     */
-    getSnap: (snapId: string) => Snap | undefined;
 };
+export type TrackEventMethodActions = SnapControllerGetSnapAction;
 export type TrackEventObject = {
     event: string;
     properties?: Record<string, Json>;
@@ -46,9 +43,9 @@ export type TrackEventParameters = InferMatching<typeof TrackEventParametersStru
  * @internal
  */
 export declare const trackEventHandler: {
-    methodNames: ["snap_trackEvent"];
     implementation: typeof getTrackEventImplementation;
     hookNames: MethodHooksObject<TrackEventMethodHooks>;
+    actionNames: "SnapController:getSnap"[];
 };
 /**
  * The `snap_trackEvent` method implementation.
@@ -60,9 +57,9 @@ export declare const trackEventHandler: {
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
  * @param hooks.trackEvent - The function to track the event.
- * @param hooks.getSnap - The function to get Snap metadata.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-declare function getTrackEventImplementation(req: JsonRpcRequest<TrackEventParameters>, res: PendingJsonRpcResponse<TrackEventResult>, _next: unknown, end: JsonRpcEngineEndCallback, { trackEvent, getSnap }: TrackEventMethodHooks): void;
+declare function getTrackEventImplementation(req: JsonRpcRequestWithOrigin<TrackEventParameters>, res: PendingJsonRpcResponse<TrackEventResult>, _next: unknown, end: JsonRpcEngineEndCallback, { trackEvent }: TrackEventMethodHooks, messenger: Messenger<string, TrackEventMethodActions>): void;
 export {};
 //# sourceMappingURL=trackEvent.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"trackEvent.d.mts","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EACjB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,8BAA8B;AAUjE,OAAO,KAAK,EAAE,IAAI,EAAE,sBAAsB,EAAE,wBAAwB;AAGpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAyBlD,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;OAIG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC9C;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC5C,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;;;;;;;;;;;;;EAM9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;CAQ7B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,iBAAS,2BAA2B,CAClC,GAAG,EAAE,cAAc,CAAC,oBAAoB,CAAC,EACzC,GAAG,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,EAC7C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,qBAAqB,GAC7C,IAAI,CAoBN"}
+{"version":3,"file":"trackEvent.d.mts","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,4BAA4B;AAC9E,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAU3D,OAAO,KAAK,EAAE,IAAI,EAAE,sBAAsB,EAAE,wBAAwB;AAGpE,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAC5B,qBAAiB;AAClB,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAsBlD,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;OAIG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,2BAA2B,CAAC;AAElE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC5C,CAAC;AAEF,QAAA,MAAM,0BAA0B;;;;;;;;;;;;;;;;EAM9B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,OAAO,0BAA0B,EACjC,gBAAgB,CACjB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;CAU7B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,iBAAS,2BAA2B,CAClC,GAAG,EAAE,wBAAwB,CAAC,oBAAoB,CAAC,EACnD,GAAG,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,EAC7C,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,UAAU,EAAE,EAAE,qBAAqB,EACrC,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,uBAAuB,CAAC,GACpD,IAAI,CAkBN"}

package/dist/permitted/trackEvent.mjs

@@ -1,7 +1,6 @@
 import { rpcErrors } from "@metamask/rpc-errors";
 import { create, object, optional, record, refine, string, StructError } from "@metamask/superstruct";
 import { JsonStruct } from "@metamask/utils";
-const methodName = 'snap_trackEvent';
 const PropertiesStruct = optional(record(string(), JsonStruct));
 const snakeCaseRegex = /^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$/u;
 const SnakeCasePropertiesStruct = refine(PropertiesStruct, 'snake_case_keys', (value) => {
@@ -12,7 +11,6 @@ const SnakeCasePropertiesStruct = refine(PropertiesStruct, 'snake_case_keys', (v
 });
 const hookNames = {
     trackEvent: true,
-    getSnap: true,
 };
 const TrackEventParametersStruct = object({
     event: object({
@@ -27,9 +25,9 @@ const TrackEventParametersStruct = object({
  * @internal
  */
 export const trackEventHandler = {
-    methodNames: [methodName],
     implementation: getTrackEventImplementation,
     hookNames,
+    actionNames: ['SnapController:getSnap'],
 };
 /**
  * The `snap_trackEvent` method implementation.
@@ -41,11 +39,11 @@ export const trackEventHandler = {
  * @param end - The `json-rpc-engine` "end" callback.
  * @param hooks - The RPC method hooks.
  * @param hooks.trackEvent - The function to track the event.
- * @param hooks.getSnap - The function to get Snap metadata.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-function getTrackEventImplementation(req, res, _next, end, { trackEvent, getSnap }) {
-    const snap = getSnap(req.origin);
+function getTrackEventImplementation(req, res, _next, end, { trackEvent }, messenger) {
+    const snap = messenger.call('SnapController:getSnap', req.origin);
     if (!snap?.preinstalled) {
         return end(rpcErrors.methodNotFound());
     }

package/dist/permitted/trackEvent.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"trackEvent.mjs","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAOjD,OAAO,EACL,MAAM,EACN,MAAM,EACN,QAAQ,EACR,MAAM,EACN,MAAM,EACN,MAAM,EACN,WAAW,EACZ,8BAA8B;AAE/B,OAAO,EAAE,UAAU,EAAE,wBAAwB;AAI7C,MAAM,UAAU,GAAG,iBAAiB,CAAC;AAErC,MAAM,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;AAEhE,MAAM,cAAc,GAAG,kCAAkC,CAAC;AAE1D,MAAM,yBAAyB,GAAG,MAAM,CACtC,gBAAgB,EAChB,iBAAiB,EACjB,CAAC,KAAK,EAAE,EAAE;IACR,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACrE,CAAC,CACF,CAAC;AAEF,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;CACd,CAAC;AAuBF,MAAM,0BAA0B,GAAG,MAAM,CAAC;IACxC,KAAK,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,EAAE;QACf,UAAU,EAAE,yBAAyB;QACrC,mBAAmB,EAAE,yBAAyB;KAC/C,CAAC;CACH,CAAC,CAAC;AAOH;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,2BAA2B;IAC3C,SAAS;CAKV,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,SAAS,2BAA2B,CAClC,GAAyC,EACzC,GAA6C,EAC7C,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAE,OAAO,EAAyB;IAE9C,MAAM,IAAI,GAAG,OAAO,CACjB,GAA6D,CAAC,MAAM,CACtE,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAClC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,IAAI,KAAK,CAAC,UAAU,KAAK,iBAAiB,EAAE,CAAC;gBAC3C,MAAM,SAAS,CAAC,aAAa,CAAC;oBAC5B,OAAO,EAAE,mHAAmH,KAAK,CAAC,GAAG,IAAI;iBAC1I,CAAC,CAAC;YACL,CAAC;YAED,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,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  JsonRpcRequest,\n  TrackEventParams,\n  TrackEventResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching, Snap } from '@metamask/snaps-utils';\nimport {\n  create,\n  object,\n  optional,\n  record,\n  refine,\n  string,\n  StructError,\n} from '@metamask/superstruct';\nimport type { Json, PendingJsonRpcResponse } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_trackEvent';\n\nconst PropertiesStruct = optional(record(string(), JsonStruct));\n\nconst snakeCaseRegex = /^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$/u;\n\nconst SnakeCasePropertiesStruct = refine(\n  PropertiesStruct,\n  'snake_case_keys',\n  (value) => {\n    if (!value) {\n      return true;\n    }\n\n    return Object.keys(value).every((key) => snakeCaseRegex.test(key));\n  },\n);\n\nconst hookNames: MethodHooksObject<TrackEventMethodHooks> = {\n  trackEvent: true,\n  getSnap: true,\n};\n\nexport type TrackEventMethodHooks = {\n  /**\n   * Track an event.\n   *\n   * @param event - The event object containing event details and properties.\n   */\n  trackEvent: (event: TrackEventObject) => void;\n  /**\n   * Get Snap metadata.\n   *\n   * @param snapId - The ID of a Snap.\n   */\n  getSnap: (snapId: string) => Snap | undefined;\n};\n\nexport type TrackEventObject = {\n  event: string;\n  properties?: Record<string, Json>;\n  sensitiveProperties?: Record<string, Json>;\n};\n\nconst TrackEventParametersStruct = object({\n  event: object({\n    event: string(),\n    properties: SnakeCasePropertiesStruct,\n    sensitiveProperties: SnakeCasePropertiesStruct,\n  }),\n});\n\nexport type TrackEventParameters = InferMatching<\n  typeof TrackEventParametersStruct,\n  TrackEventParams\n>;\n\n/**\n * Handler for the `snap_trackEvent` method.\n *\n * @internal\n */\nexport const trackEventHandler = {\n  methodNames: [methodName] as const,\n  implementation: getTrackEventImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  TrackEventMethodHooks,\n  TrackEventParameters,\n  TrackEventResult\n>;\n\n/**\n * The `snap_trackEvent` method implementation.\n * This method allows pre-installed Snaps to submit tracking events to the client.\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 function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.trackEvent - The function to track the event.\n * @param hooks.getSnap - The function to get Snap metadata.\n * @returns Nothing.\n */\nfunction getTrackEventImplementation(\n  req: JsonRpcRequest<TrackEventParameters>,\n  res: PendingJsonRpcResponse<TrackEventResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { trackEvent, getSnap }: TrackEventMethodHooks,\n): void {\n  const snap = getSnap(\n    (req as JsonRpcRequest<TrackEventParams> & { origin: string }).origin,\n  );\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    trackEvent(validatedParams.event);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validates the parameters for the snap_trackEvent method.\n *\n * @param params - Parameters to validate.\n * @returns Validated parameters.\n * @throws Throws RPC error if validation fails.\n */\nfunction getValidatedParams(params: unknown): TrackEventParameters {\n  try {\n    return create(params, TrackEventParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      if (error.refinement === 'snake_case_keys') {\n        throw rpcErrors.invalidParams({\n          message: `Invalid params: All property keys must be in snake_case format. The following key contains invalid properties: \"${error.key}\".`,\n        });\n      }\n\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}
+{"version":3,"file":"trackEvent.mjs","sourceRoot":"","sources":["../../src/permitted/trackEvent.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAGjD,OAAO,EACL,MAAM,EACN,MAAM,EACN,QAAQ,EACR,MAAM,EACN,MAAM,EACN,MAAM,EACN,WAAW,EACZ,8BAA8B;AAE/B,OAAO,EAAE,UAAU,EAAE,wBAAwB;AAQ7C,MAAM,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;AAEhE,MAAM,cAAc,GAAG,kCAAkC,CAAC;AAE1D,MAAM,yBAAyB,GAAG,MAAM,CACtC,gBAAgB,EAChB,iBAAiB,EACjB,CAAC,KAAK,EAAE,EAAE;IACR,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACrE,CAAC,CACF,CAAC;AAEF,MAAM,SAAS,GAA6C;IAC1D,UAAU,EAAE,IAAI;CACjB,CAAC;AAmBF,MAAM,0BAA0B,GAAG,MAAM,CAAC;IACxC,KAAK,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,EAAE;QACf,UAAU,EAAE,yBAAyB;QACrC,mBAAmB,EAAE,yBAAyB;KAC/C,CAAC;CACH,CAAC,CAAC;AAOH;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,cAAc,EAAE,2BAA2B;IAC3C,SAAS;IACT,WAAW,EAAE,CAAC,wBAAwB,CAAC;CAOxC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,SAAS,2BAA2B,CAClC,GAAmD,EACnD,GAA6C,EAC7C,KAAc,EACd,GAA6B,EAC7B,EAAE,UAAU,EAAyB,EACrC,SAAqD;IAErD,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,wBAAwB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAElE,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAClC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,IAAI,KAAK,CAAC,UAAU,KAAK,iBAAiB,EAAE,CAAC;gBAC3C,MAAM,SAAS,CAAC,aAAa,CAAC;oBAC5B,OAAO,EAAE,mHAAmH,KAAK,CAAC,GAAG,IAAI;iBAC1I,CAAC,CAAC;YACL,CAAC;YAED,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type {\n  JsonRpcEngineEndCallback,\n  MethodHandler,\n} from '@metamask/json-rpc-engine';\nimport type { Messenger } from '@metamask/messenger';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { TrackEventParams, TrackEventResult } from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport {\n  create,\n  object,\n  optional,\n  record,\n  refine,\n  string,\n  StructError,\n} from '@metamask/superstruct';\nimport type { Json, PendingJsonRpcResponse } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\n\nimport type {\n  JsonRpcRequestWithOrigin,\n  SnapControllerGetSnapAction,\n} from '../types';\nimport type { MethodHooksObject } from '../utils';\n\nconst PropertiesStruct = optional(record(string(), JsonStruct));\n\nconst snakeCaseRegex = /^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$/u;\n\nconst SnakeCasePropertiesStruct = refine(\n  PropertiesStruct,\n  'snake_case_keys',\n  (value) => {\n    if (!value) {\n      return true;\n    }\n\n    return Object.keys(value).every((key) => snakeCaseRegex.test(key));\n  },\n);\n\nconst hookNames: MethodHooksObject<TrackEventMethodHooks> = {\n  trackEvent: true,\n};\n\nexport type TrackEventMethodHooks = {\n  /**\n   * Track an event.\n   *\n   * @param event - The event object containing event details and properties.\n   */\n  trackEvent: (event: TrackEventObject) => void;\n};\n\nexport type TrackEventMethodActions = SnapControllerGetSnapAction;\n\nexport type TrackEventObject = {\n  event: string;\n  properties?: Record<string, Json>;\n  sensitiveProperties?: Record<string, Json>;\n};\n\nconst TrackEventParametersStruct = object({\n  event: object({\n    event: string(),\n    properties: SnakeCasePropertiesStruct,\n    sensitiveProperties: SnakeCasePropertiesStruct,\n  }),\n});\n\nexport type TrackEventParameters = InferMatching<\n  typeof TrackEventParametersStruct,\n  TrackEventParams\n>;\n\n/**\n * Handler for the `snap_trackEvent` method.\n *\n * @internal\n */\nexport const trackEventHandler = {\n  implementation: getTrackEventImplementation,\n  hookNames,\n  actionNames: ['SnapController:getSnap'],\n} satisfies MethodHandler<\n  TrackEventMethodHooks,\n  TrackEventMethodActions,\n  TrackEventParameters,\n  TrackEventResult,\n  { origin: string }\n>;\n\n/**\n * The `snap_trackEvent` method implementation.\n * This method allows pre-installed Snaps to submit tracking events to the client.\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 function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.trackEvent - The function to track the event.\n * @param messenger - The messenger used to call controller actions.\n * @returns Nothing.\n */\nfunction getTrackEventImplementation(\n  req: JsonRpcRequestWithOrigin<TrackEventParameters>,\n  res: PendingJsonRpcResponse<TrackEventResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { trackEvent }: TrackEventMethodHooks,\n  messenger: Messenger<string, TrackEventMethodActions>,\n): void {\n  const snap = messenger.call('SnapController:getSnap', req.origin);\n\n  if (!snap?.preinstalled) {\n    return end(rpcErrors.methodNotFound());\n  }\n\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n    trackEvent(validatedParams.event);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validates the parameters for the snap_trackEvent method.\n *\n * @param params - Parameters to validate.\n * @returns Validated parameters.\n * @throws Throws RPC error if validation fails.\n */\nfunction getValidatedParams(params: unknown): TrackEventParameters {\n  try {\n    return create(params, TrackEventParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      if (error.refinement === 'snake_case_keys') {\n        throw rpcErrors.invalidParams({\n          message: `Invalid params: All property keys must be in snake_case format. The following key contains invalid properties: \"${error.key}\".`,\n        });\n      }\n\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}

package/dist/permitted/updateInterface.cjs

@@ -5,11 +5,6 @@ const rpc_errors_1 = require("@metamask/rpc-errors");
 const snaps_sdk_1 = require("@metamask/snaps-sdk");
 const superstruct_1 = require("@metamask/superstruct");
 const utils_1 = require("../utils.cjs");
-const methodName = 'snap_updateInterface';
-const hookNames = {
-    hasPermission: true,
-    updateInterface: true,
-};
 /**
  * Update an interactive interface. For use in
  * [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).
@@ -46,9 +41,11 @@ const hookNames = {
  * ```
  */
 exports.updateInterfaceHandler = {
-    methodNames: [methodName],
     implementation: getUpdateInterfaceImplementation,
-    hookNames,
+    actionNames: [
+        'PermissionController:hasPermission',
+        'SnapInterfaceController:updateInterface',
+    ],
 };
 const UpdateInterfaceParametersStruct = (0, superstruct_1.object)({
     id: (0, superstruct_1.string)(),
@@ -63,23 +60,22 @@ const UpdateInterfaceParametersStruct = (0, superstruct_1.object)({
  * @param _next - The `json-rpc-engine` "next" callback. Not used by this
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
- * @param hooks - The RPC method hooks.
- * @param hooks.hasPermission - The function to check if the Snap has a given
- * permission.
- * @param hooks.updateInterface - The function to update the interface.
+ * @param _hooks - The RPC method hooks. Not used by this function.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-function getUpdateInterfaceImplementation(req, res, _next, end, { hasPermission, updateInterface }) {
-    if (!utils_1.UI_PERMISSIONS.some(hasPermission)) {
+function getUpdateInterfaceImplementation(req, res, _next, end, _hooks, messenger) {
+    const { params, origin } = req;
+    const isPermitted = utils_1.UI_PERMISSIONS.some((permission) => messenger.call('PermissionController:hasPermission', origin, permission));
+    if (!isPermitted) {
         return end(rpc_errors_1.providerErrors.unauthorized({
             message: `This method can only be used if the Snap has one of the following permissions: ${utils_1.UI_PERMISSIONS.join(', ')}.`,
         }));
     }
-    const { params } = req;
     try {
         const validatedParams = getValidatedParams(params);
         const { id, ui, context } = validatedParams;
-        updateInterface(id, ui, context);
+        messenger.call('SnapInterfaceController:updateInterface', origin, id, ui, context);
         res.result = null;
     }
     catch (error) {

package/dist/permitted/updateInterface.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"updateInterface.cjs","sourceRoot":"","sources":["../../src/permitted/updateInterface.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AAQjE,mDAG6B;AAE7B,uDAM+B;AAI/B,wCAA0C;AAE1C,MAAM,UAAU,GAAG,sBAAsB,CAAC;AAE1C,MAAM,SAAS,GAAkD;IAC/D,aAAa,EAAE,IAAI;IACnB,eAAe,EAAE,IAAI;CACtB,CAAC;AAqBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACU,QAAA,sBAAsB,GAAG;IACpC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,gCAAgC;IAChD,SAAS;CAKV,CAAC;AAEF,MAAM,+BAA+B,GAAG,IAAA,oBAAM,EAAC;IAC7C,EAAE,EAAE,IAAA,oBAAM,GAAE;IACZ,EAAE,EAAE,oCAAwB;IAC5B,OAAO,EAAE,IAAA,sBAAQ,EAAC,kCAAsB,CAAC;CAC1C,CAAC,CAAC;AAOH;;;;;;;;;;;;;GAaG;AACH,SAAS,gCAAgC,CACvC,GAA8C,EAC9C,GAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,eAAe,EAA8B;IAE9D,IAAI,CAAC,sBAAc,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;QACxC,OAAO,GAAG,CACR,2BAAc,CAAC,YAAY,CAAC;YAC1B,OAAO,EAAE,kFAAkF,sBAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;SACxH,CAAC,CACH,CAAC;IACJ,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAE5C,eAAe,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QACjC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,+BAA+B,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  UpdateInterfaceParams,\n  UpdateInterfaceResult,\n  JsonRpcRequest,\n  ComponentOrElement,\n  InterfaceContext,\n} from '@metamask/snaps-sdk';\nimport {\n  ComponentOrElementStruct,\n  InterfaceContextStruct,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  StructError,\n  create,\n  object,\n  optional,\n  string,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\nimport { UI_PERMISSIONS } from '../utils';\n\nconst methodName = 'snap_updateInterface';\n\nconst hookNames: MethodHooksObject<UpdateInterfaceMethodHooks> = {\n  hasPermission: true,\n  updateInterface: true,\n};\n\nexport type UpdateInterfaceMethodHooks = {\n  /**\n   * @param permissionName - The name of the permission to check.\n   * @returns Whether the Snap has the permission.\n   */\n  hasPermission: (permissionName: string) => boolean;\n\n  /**\n   * @param id - The interface ID.\n   * @param ui - The UI components.\n   * @param context - The optional interface context object.\n   */\n  updateInterface: (\n    id: string,\n    ui: ComponentOrElement,\n    context?: InterfaceContext,\n  ) => void;\n};\n\n/**\n * Update an interactive interface. For use in\n * [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).\n *\n * @example\n * ```tsx\n * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';\n *\n * // First, create an interface and get its ID.\n * const id = await snap.request({\n *   method: 'snap_createInterface',\n *   params: {\n *     ui: (\n *       <Box>\n *         ...\n *       </Box>\n *     ),\n *   },\n * });\n *\n * // Later, update the interface with new content using the ID.\n * snap.request({\n *   method: 'snap_updateInterface',\n *   params: {\n *     id: 'interface-id',\n *     ui: (\n *       <Box>\n *         <Heading>Updated Interface</Heading>\n *         <Text>This interface has been updated.</Text>\n *       </Box>\n *     ),\n *   },\n * });\n * ```\n */\nexport const updateInterfaceHandler = {\n  methodNames: [methodName] as const,\n  implementation: getUpdateInterfaceImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  UpdateInterfaceMethodHooks,\n  UpdateInterfaceParameters,\n  UpdateInterfaceResult\n>;\n\nconst UpdateInterfaceParametersStruct = object({\n  id: string(),\n  ui: ComponentOrElementStruct,\n  context: optional(InterfaceContextStruct),\n});\n\nexport type UpdateInterfaceParameters = InferMatching<\n  typeof UpdateInterfaceParametersStruct,\n  UpdateInterfaceParams\n>;\n\n/**\n * The `snap_updateInterface` method implementation.\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.hasPermission - The function to check if the Snap has a given\n * permission.\n * @param hooks.updateInterface - The function to update the interface.\n * @returns Nothing.\n */\nfunction getUpdateInterfaceImplementation(\n  req: JsonRpcRequest<UpdateInterfaceParameters>,\n  res: PendingJsonRpcResponse<UpdateInterfaceResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, updateInterface }: UpdateInterfaceMethodHooks,\n): void {\n  if (!UI_PERMISSIONS.some(hasPermission)) {\n    return end(\n      providerErrors.unauthorized({\n        message: `This method can only be used if the Snap has one of the following permissions: ${UI_PERMISSIONS.join(', ')}.`,\n      }),\n    );\n  }\n\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id, ui, context } = validatedParams;\n\n    updateInterface(id, ui, context);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the updateInterface 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 updateInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): UpdateInterfaceParameters {\n  try {\n    return create(params, UpdateInterfaceParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}
+{"version":3,"file":"updateInterface.cjs","sourceRoot":"","sources":["../../src/permitted/updateInterface.ts"],"names":[],"mappings":";;;AAMA,qDAAiE;AAKjE,mDAG6B;AAE7B,uDAM+B;AAO/B,wCAA0C;AAM1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACU,QAAA,sBAAsB,GAAG;IACpC,cAAc,EAAE,gCAAgC;IAChD,WAAW,EAAE;QACX,oCAAoC;QACpC,yCAAyC;KAC1C;CAOF,CAAC;AAEF,MAAM,+BAA+B,GAAG,IAAA,oBAAM,EAAC;IAC7C,EAAE,EAAE,IAAA,oBAAM,GAAE;IACZ,EAAE,EAAE,oCAAwB;IAC5B,OAAO,EAAE,IAAA,sBAAQ,EAAC,kCAAsB,CAAC;CAC1C,CAAC,CAAC;AAOH;;;;;;;;;;;GAWG;AACH,SAAS,gCAAgC,CACvC,GAAwD,EACxD,GAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,MAAa,EACb,SAA0D;IAE1D,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAE/B,MAAM,WAAW,GAAG,sBAAc,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CACrD,SAAS,CAAC,IAAI,CAAC,oCAAoC,EAAE,MAAM,EAAE,UAAU,CAAC,CACzE,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,GAAG,CACR,2BAAc,CAAC,YAAY,CAAC;YAC1B,OAAO,EAAE,kFAAkF,sBAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;SACxH,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAE5C,SAAS,CAAC,IAAI,CACZ,yCAAyC,EACzC,MAAM,EACN,EAAE,EACF,EAAE,EACF,OAAO,CACR,CAAC;QACF,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,+BAA+B,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,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 { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  UpdateInterfaceParams,\n  UpdateInterfaceResult,\n} from '@metamask/snaps-sdk';\nimport {\n  ComponentOrElementStruct,\n  InterfaceContextStruct,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  StructError,\n  create,\n  object,\n  optional,\n  string,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type {\n  JsonRpcRequestWithOrigin,\n  SnapInterfaceControllerUpdateInterfaceAction,\n} from '../types';\nimport { UI_PERMISSIONS } from '../utils';\n\nexport type UpdateInterfaceMethodActions =\n  | PermissionControllerHasPermissionAction\n  | SnapInterfaceControllerUpdateInterfaceAction;\n\n/**\n * Update an interactive interface. For use in\n * [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).\n *\n * @example\n * ```tsx\n * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';\n *\n * // First, create an interface and get its ID.\n * const id = await snap.request({\n *   method: 'snap_createInterface',\n *   params: {\n *     ui: (\n *       <Box>\n *         ...\n *       </Box>\n *     ),\n *   },\n * });\n *\n * // Later, update the interface with new content using the ID.\n * snap.request({\n *   method: 'snap_updateInterface',\n *   params: {\n *     id: 'interface-id',\n *     ui: (\n *       <Box>\n *         <Heading>Updated Interface</Heading>\n *         <Text>This interface has been updated.</Text>\n *       </Box>\n *     ),\n *   },\n * });\n * ```\n */\nexport const updateInterfaceHandler = {\n  implementation: getUpdateInterfaceImplementation,\n  actionNames: [\n    'PermissionController:hasPermission',\n    'SnapInterfaceController:updateInterface',\n  ],\n} satisfies MethodHandler<\n  never,\n  UpdateInterfaceMethodActions,\n  UpdateInterfaceParameters,\n  UpdateInterfaceResult,\n  { origin: string }\n>;\n\nconst UpdateInterfaceParametersStruct = object({\n  id: string(),\n  ui: ComponentOrElementStruct,\n  context: optional(InterfaceContextStruct),\n});\n\nexport type UpdateInterfaceParameters = InferMatching<\n  typeof UpdateInterfaceParametersStruct,\n  UpdateInterfaceParams\n>;\n\n/**\n * The `snap_updateInterface` method implementation.\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. Not used by this function.\n * @param messenger - The messenger used to call controller actions.\n * @returns Nothing.\n */\nfunction getUpdateInterfaceImplementation(\n  req: JsonRpcRequestWithOrigin<UpdateInterfaceParameters>,\n  res: PendingJsonRpcResponse<UpdateInterfaceResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  _hooks: never,\n  messenger: Messenger<string, UpdateInterfaceMethodActions>,\n): void {\n  const { params, origin } = req;\n\n  const isPermitted = UI_PERMISSIONS.some((permission) =>\n    messenger.call('PermissionController:hasPermission', origin, permission),\n  );\n\n  if (!isPermitted) {\n    return end(\n      providerErrors.unauthorized({\n        message: `This method can only be used if the Snap has one of the following permissions: ${UI_PERMISSIONS.join(', ')}.`,\n      }),\n    );\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id, ui, context } = validatedParams;\n\n    messenger.call(\n      'SnapInterfaceController:updateInterface',\n      origin,\n      id,\n      ui,\n      context,\n    );\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the updateInterface 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 updateInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): UpdateInterfaceParameters {\n  try {\n    return create(params, UpdateInterfaceParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}

package/dist/permitted/updateInterface.d.cts

@@ -1,21 +1,11 @@
 import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
-import type { UpdateInterfaceParams, UpdateInterfaceResult, JsonRpcRequest, ComponentOrElement, InterfaceContext } from "@metamask/snaps-sdk";
+import type { Messenger } from "@metamask/messenger";
+import type { PermissionControllerHasPermissionAction } from "@metamask/permission-controller";
+import type { UpdateInterfaceParams, UpdateInterfaceResult } from "@metamask/snaps-sdk";
 import { type InferMatching } from "@metamask/snaps-utils";
 import type { PendingJsonRpcResponse } from "@metamask/utils";
-import type { MethodHooksObject } from "../utils.cjs";
-export type UpdateInterfaceMethodHooks = {
-    /**
-     * @param permissionName - The name of the permission to check.
-     * @returns Whether the Snap has the permission.
-     */
-    hasPermission: (permissionName: string) => boolean;
-    /**
-     * @param id - The interface ID.
-     * @param ui - The UI components.
-     * @param context - The optional interface context object.
-     */
-    updateInterface: (id: string, ui: ComponentOrElement, context?: InterfaceContext) => void;
-};
+import type { JsonRpcRequestWithOrigin, SnapInterfaceControllerUpdateInterfaceAction } from "../types.cjs";
+export type UpdateInterfaceMethodActions = PermissionControllerHasPermissionAction | SnapInterfaceControllerUpdateInterfaceAction;
 /**
  * Update an interactive interface. For use in
  * [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).
@@ -52,9 +42,8 @@ export type UpdateInterfaceMethodHooks = {
  * ```
  */
 export declare const updateInterfaceHandler: {
-    methodNames: ["snap_updateInterface"];
     implementation: typeof getUpdateInterfaceImplementation;
-    hookNames: MethodHooksObject<UpdateInterfaceMethodHooks>;
+    actionNames: ("SnapInterfaceController:updateInterface" | "PermissionController:hasPermission")[];
 };
 declare const UpdateInterfaceParametersStruct: import("@metamask/superstruct").Struct<{
     id: string;
@@ -246,12 +235,10 @@ export type UpdateInterfaceParameters = InferMatching<typeof UpdateInterfacePara
  * @param _next - The `json-rpc-engine` "next" callback. Not used by this
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
- * @param hooks - The RPC method hooks.
- * @param hooks.hasPermission - The function to check if the Snap has a given
- * permission.
- * @param hooks.updateInterface - The function to update the interface.
+ * @param _hooks - The RPC method hooks. Not used by this function.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-declare function getUpdateInterfaceImplementation(req: JsonRpcRequest<UpdateInterfaceParameters>, res: PendingJsonRpcResponse<UpdateInterfaceResult>, _next: unknown, end: JsonRpcEngineEndCallback, { hasPermission, updateInterface }: UpdateInterfaceMethodHooks): void;
+declare function getUpdateInterfaceImplementation(req: JsonRpcRequestWithOrigin<UpdateInterfaceParameters>, res: PendingJsonRpcResponse<UpdateInterfaceResult>, _next: unknown, end: JsonRpcEngineEndCallback, _hooks: never, messenger: Messenger<string, UpdateInterfaceMethodActions>): void;
 export {};
 //# sourceMappingURL=updateInterface.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"updateInterface.d.cts","sourceRoot":"","sources":["../../src/permitted/updateInterface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EACjB,4BAA4B;AAK7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAQ3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAE9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAUlD,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;OAGG;IACH,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IAEnD;;;;OAIG;IACH,eAAe,EAAE,CACf,EAAE,EAAE,MAAM,EACV,EAAE,EAAE,kBAAkB,EACtB,OAAO,CAAC,EAAE,gBAAgB,KACvB,IAAI,CAAC;CACX,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAO,MAAM,sBAAsB;;;;CAQlC,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAInC,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,iBAAS,gCAAgC,CACvC,GAAG,EAAE,cAAc,CAAC,yBAAyB,CAAC,EAC9C,GAAG,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,EAClD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,0BAA0B,GAC7D,IAAI,CAuBN"}
+{"version":3,"file":"updateInterface.d.cts","sourceRoot":"","sources":["../../src/permitted/updateInterface.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,qBAAqB,EACrB,qBAAqB,EACtB,4BAA4B;AAK7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAQ3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAE9D,OAAO,KAAK,EACV,wBAAwB,EACxB,4CAA4C,EAC7C,qBAAiB;AAGlB,MAAM,MAAM,4BAA4B,GACpC,uCAAuC,GACvC,4CAA4C,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAO,MAAM,sBAAsB;;;CAYlC,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAInC,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,iBAAS,gCAAgC,CACvC,GAAG,EAAE,wBAAwB,CAAC,yBAAyB,CAAC,EACxD,GAAG,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,EAClD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,MAAM,EAAE,KAAK,EACb,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,4BAA4B,CAAC,GACzD,IAAI,CAiCN"}

package/dist/permitted/updateInterface.d.mts

@@ -1,21 +1,11 @@
 import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
-import type { UpdateInterfaceParams, UpdateInterfaceResult, JsonRpcRequest, ComponentOrElement, InterfaceContext } from "@metamask/snaps-sdk";
+import type { Messenger } from "@metamask/messenger";
+import type { PermissionControllerHasPermissionAction } from "@metamask/permission-controller";
+import type { UpdateInterfaceParams, UpdateInterfaceResult } from "@metamask/snaps-sdk";
 import { type InferMatching } from "@metamask/snaps-utils";
 import type { PendingJsonRpcResponse } from "@metamask/utils";
-import type { MethodHooksObject } from "../utils.mjs";
-export type UpdateInterfaceMethodHooks = {
-    /**
-     * @param permissionName - The name of the permission to check.
-     * @returns Whether the Snap has the permission.
-     */
-    hasPermission: (permissionName: string) => boolean;
-    /**
-     * @param id - The interface ID.
-     * @param ui - The UI components.
-     * @param context - The optional interface context object.
-     */
-    updateInterface: (id: string, ui: ComponentOrElement, context?: InterfaceContext) => void;
-};
+import type { JsonRpcRequestWithOrigin, SnapInterfaceControllerUpdateInterfaceAction } from "../types.mjs";
+export type UpdateInterfaceMethodActions = PermissionControllerHasPermissionAction | SnapInterfaceControllerUpdateInterfaceAction;
 /**
  * Update an interactive interface. For use in
  * [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).
@@ -52,9 +42,8 @@ export type UpdateInterfaceMethodHooks = {
  * ```
  */
 export declare const updateInterfaceHandler: {
-    methodNames: ["snap_updateInterface"];
     implementation: typeof getUpdateInterfaceImplementation;
-    hookNames: MethodHooksObject<UpdateInterfaceMethodHooks>;
+    actionNames: ("SnapInterfaceController:updateInterface" | "PermissionController:hasPermission")[];
 };
 declare const UpdateInterfaceParametersStruct: import("@metamask/superstruct").Struct<{
     id: string;
@@ -246,12 +235,10 @@ export type UpdateInterfaceParameters = InferMatching<typeof UpdateInterfacePara
  * @param _next - The `json-rpc-engine` "next" callback. Not used by this
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
- * @param hooks - The RPC method hooks.
- * @param hooks.hasPermission - The function to check if the Snap has a given
- * permission.
- * @param hooks.updateInterface - The function to update the interface.
+ * @param _hooks - The RPC method hooks. Not used by this function.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-declare function getUpdateInterfaceImplementation(req: JsonRpcRequest<UpdateInterfaceParameters>, res: PendingJsonRpcResponse<UpdateInterfaceResult>, _next: unknown, end: JsonRpcEngineEndCallback, { hasPermission, updateInterface }: UpdateInterfaceMethodHooks): void;
+declare function getUpdateInterfaceImplementation(req: JsonRpcRequestWithOrigin<UpdateInterfaceParameters>, res: PendingJsonRpcResponse<UpdateInterfaceResult>, _next: unknown, end: JsonRpcEngineEndCallback, _hooks: never, messenger: Messenger<string, UpdateInterfaceMethodActions>): void;
 export {};
 //# sourceMappingURL=updateInterface.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"updateInterface.d.mts","sourceRoot":"","sources":["../../src/permitted/updateInterface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAG1E,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EACjB,4BAA4B;AAK7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAQ3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAE9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAiB;AAUlD,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;OAGG;IACH,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;IAEnD;;;;OAIG;IACH,eAAe,EAAE,CACf,EAAE,EAAE,MAAM,EACV,EAAE,EAAE,kBAAkB,EACtB,OAAO,CAAC,EAAE,gBAAgB,KACvB,IAAI,CAAC;CACX,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAO,MAAM,sBAAsB;;;;CAQlC,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAInC,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,iBAAS,gCAAgC,CACvC,GAAG,EAAE,cAAc,CAAC,yBAAyB,CAAC,EAC9C,GAAG,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,EAClD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,0BAA0B,GAC7D,IAAI,CAuBN"}
+{"version":3,"file":"updateInterface.d.mts","sourceRoot":"","sources":["../../src/permitted/updateInterface.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,qBAAqB,EACrB,qBAAqB,EACtB,4BAA4B;AAK7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAQ3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAE9D,OAAO,KAAK,EACV,wBAAwB,EACxB,4CAA4C,EAC7C,qBAAiB;AAGlB,MAAM,MAAM,4BAA4B,GACpC,uCAAuC,GACvC,4CAA4C,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAO,MAAM,sBAAsB;;;CAYlC,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAInC,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,iBAAS,gCAAgC,CACvC,GAAG,EAAE,wBAAwB,CAAC,yBAAyB,CAAC,EACxD,GAAG,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,EAClD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,MAAM,EAAE,KAAK,EACb,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,4BAA4B,CAAC,GACzD,IAAI,CAiCN"}

package/dist/permitted/updateInterface.mjs

@@ -2,11 +2,6 @@ import { providerErrors, rpcErrors } from "@metamask/rpc-errors";
 import { ComponentOrElementStruct, InterfaceContextStruct } from "@metamask/snaps-sdk";
 import { StructError, create, object, optional, string } from "@metamask/superstruct";
 import { UI_PERMISSIONS } from "../utils.mjs";
-const methodName = 'snap_updateInterface';
-const hookNames = {
-    hasPermission: true,
-    updateInterface: true,
-};
 /**
  * Update an interactive interface. For use in
  * [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).
@@ -43,9 +38,11 @@ const hookNames = {
  * ```
  */
 export const updateInterfaceHandler = {
-    methodNames: [methodName],
     implementation: getUpdateInterfaceImplementation,
-    hookNames,
+    actionNames: [
+        'PermissionController:hasPermission',
+        'SnapInterfaceController:updateInterface',
+    ],
 };
 const UpdateInterfaceParametersStruct = object({
     id: string(),
@@ -60,23 +57,22 @@ const UpdateInterfaceParametersStruct = object({
  * @param _next - The `json-rpc-engine` "next" callback. Not used by this
  * function.
  * @param end - The `json-rpc-engine` "end" callback.
- * @param hooks - The RPC method hooks.
- * @param hooks.hasPermission - The function to check if the Snap has a given
- * permission.
- * @param hooks.updateInterface - The function to update the interface.
+ * @param _hooks - The RPC method hooks. Not used by this function.
+ * @param messenger - The messenger used to call controller actions.
  * @returns Nothing.
  */
-function getUpdateInterfaceImplementation(req, res, _next, end, { hasPermission, updateInterface }) {
-    if (!UI_PERMISSIONS.some(hasPermission)) {
+function getUpdateInterfaceImplementation(req, res, _next, end, _hooks, messenger) {
+    const { params, origin } = req;
+    const isPermitted = UI_PERMISSIONS.some((permission) => messenger.call('PermissionController:hasPermission', origin, permission));
+    if (!isPermitted) {
         return end(providerErrors.unauthorized({
             message: `This method can only be used if the Snap has one of the following permissions: ${UI_PERMISSIONS.join(', ')}.`,
         }));
     }
-    const { params } = req;
     try {
         const validatedParams = getValidatedParams(params);
         const { id, ui, context } = validatedParams;
-        updateInterface(id, ui, context);
+        messenger.call('SnapInterfaceController:updateInterface', origin, id, ui, context);
         res.result = null;
     }
     catch (error) {

package/dist/permitted/updateInterface.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"updateInterface.mjs","sourceRoot":"","sources":["../../src/permitted/updateInterface.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAQjE,OAAO,EACL,wBAAwB,EACxB,sBAAsB,EACvB,4BAA4B;AAE7B,OAAO,EACL,WAAW,EACX,MAAM,EACN,MAAM,EACN,QAAQ,EACR,MAAM,EACP,8BAA8B;AAI/B,OAAO,EAAE,cAAc,EAAE,qBAAiB;AAE1C,MAAM,UAAU,GAAG,sBAAsB,CAAC;AAE1C,MAAM,SAAS,GAAkD;IAC/D,aAAa,EAAE,IAAI;IACnB,eAAe,EAAE,IAAI;CACtB,CAAC;AAqBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,WAAW,EAAE,CAAC,UAAU,CAAU;IAClC,cAAc,EAAE,gCAAgC;IAChD,SAAS;CAKV,CAAC;AAEF,MAAM,+BAA+B,GAAG,MAAM,CAAC;IAC7C,EAAE,EAAE,MAAM,EAAE;IACZ,EAAE,EAAE,wBAAwB;IAC5B,OAAO,EAAE,QAAQ,CAAC,sBAAsB,CAAC;CAC1C,CAAC,CAAC;AAOH;;;;;;;;;;;;;GAaG;AACH,SAAS,gCAAgC,CACvC,GAA8C,EAC9C,GAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,aAAa,EAAE,eAAe,EAA8B;IAE9D,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;QACxC,OAAO,GAAG,CACR,cAAc,CAAC,YAAY,CAAC;YAC1B,OAAO,EAAE,kFAAkF,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;SACxH,CAAC,CACH,CAAC;IACJ,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAE5C,eAAe,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QACjC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,+BAA+B,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  UpdateInterfaceParams,\n  UpdateInterfaceResult,\n  JsonRpcRequest,\n  ComponentOrElement,\n  InterfaceContext,\n} from '@metamask/snaps-sdk';\nimport {\n  ComponentOrElementStruct,\n  InterfaceContextStruct,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  StructError,\n  create,\n  object,\n  optional,\n  string,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\nimport { UI_PERMISSIONS } from '../utils';\n\nconst methodName = 'snap_updateInterface';\n\nconst hookNames: MethodHooksObject<UpdateInterfaceMethodHooks> = {\n  hasPermission: true,\n  updateInterface: true,\n};\n\nexport type UpdateInterfaceMethodHooks = {\n  /**\n   * @param permissionName - The name of the permission to check.\n   * @returns Whether the Snap has the permission.\n   */\n  hasPermission: (permissionName: string) => boolean;\n\n  /**\n   * @param id - The interface ID.\n   * @param ui - The UI components.\n   * @param context - The optional interface context object.\n   */\n  updateInterface: (\n    id: string,\n    ui: ComponentOrElement,\n    context?: InterfaceContext,\n  ) => void;\n};\n\n/**\n * Update an interactive interface. For use in\n * [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).\n *\n * @example\n * ```tsx\n * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';\n *\n * // First, create an interface and get its ID.\n * const id = await snap.request({\n *   method: 'snap_createInterface',\n *   params: {\n *     ui: (\n *       <Box>\n *         ...\n *       </Box>\n *     ),\n *   },\n * });\n *\n * // Later, update the interface with new content using the ID.\n * snap.request({\n *   method: 'snap_updateInterface',\n *   params: {\n *     id: 'interface-id',\n *     ui: (\n *       <Box>\n *         <Heading>Updated Interface</Heading>\n *         <Text>This interface has been updated.</Text>\n *       </Box>\n *     ),\n *   },\n * });\n * ```\n */\nexport const updateInterfaceHandler = {\n  methodNames: [methodName] as const,\n  implementation: getUpdateInterfaceImplementation,\n  hookNames,\n} satisfies PermittedHandlerExport<\n  UpdateInterfaceMethodHooks,\n  UpdateInterfaceParameters,\n  UpdateInterfaceResult\n>;\n\nconst UpdateInterfaceParametersStruct = object({\n  id: string(),\n  ui: ComponentOrElementStruct,\n  context: optional(InterfaceContextStruct),\n});\n\nexport type UpdateInterfaceParameters = InferMatching<\n  typeof UpdateInterfaceParametersStruct,\n  UpdateInterfaceParams\n>;\n\n/**\n * The `snap_updateInterface` method implementation.\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.hasPermission - The function to check if the Snap has a given\n * permission.\n * @param hooks.updateInterface - The function to update the interface.\n * @returns Nothing.\n */\nfunction getUpdateInterfaceImplementation(\n  req: JsonRpcRequest<UpdateInterfaceParameters>,\n  res: PendingJsonRpcResponse<UpdateInterfaceResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { hasPermission, updateInterface }: UpdateInterfaceMethodHooks,\n): void {\n  if (!UI_PERMISSIONS.some(hasPermission)) {\n    return end(\n      providerErrors.unauthorized({\n        message: `This method can only be used if the Snap has one of the following permissions: ${UI_PERMISSIONS.join(', ')}.`,\n      }),\n    );\n  }\n\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id, ui, context } = validatedParams;\n\n    updateInterface(id, ui, context);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the updateInterface 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 updateInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): UpdateInterfaceParameters {\n  try {\n    return create(params, UpdateInterfaceParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}
+{"version":3,"file":"updateInterface.mjs","sourceRoot":"","sources":["../../src/permitted/updateInterface.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAKjE,OAAO,EACL,wBAAwB,EACxB,sBAAsB,EACvB,4BAA4B;AAE7B,OAAO,EACL,WAAW,EACX,MAAM,EACN,MAAM,EACN,QAAQ,EACR,MAAM,EACP,8BAA8B;AAO/B,OAAO,EAAE,cAAc,EAAE,qBAAiB;AAM1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,cAAc,EAAE,gCAAgC;IAChD,WAAW,EAAE;QACX,oCAAoC;QACpC,yCAAyC;KAC1C;CAOF,CAAC;AAEF,MAAM,+BAA+B,GAAG,MAAM,CAAC;IAC7C,EAAE,EAAE,MAAM,EAAE;IACZ,EAAE,EAAE,wBAAwB;IAC5B,OAAO,EAAE,QAAQ,CAAC,sBAAsB,CAAC;CAC1C,CAAC,CAAC;AAOH;;;;;;;;;;;GAWG;AACH,SAAS,gCAAgC,CACvC,GAAwD,EACxD,GAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,MAAa,EACb,SAA0D;IAE1D,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAE/B,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CACrD,SAAS,CAAC,IAAI,CAAC,oCAAoC,EAAE,MAAM,EAAE,UAAU,CAAC,CACzE,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,GAAG,CACR,cAAc,CAAC,YAAY,CAAC;YAC1B,OAAO,EAAE,kFAAkF,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;SACxH,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAE5C,SAAS,CAAC,IAAI,CACZ,yCAAyC,EACzC,MAAM,EACN,EAAE,EACF,EAAE,EACF,OAAO,CACR,CAAC;QACF,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,+BAA+B,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,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 { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  UpdateInterfaceParams,\n  UpdateInterfaceResult,\n} from '@metamask/snaps-sdk';\nimport {\n  ComponentOrElementStruct,\n  InterfaceContextStruct,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport {\n  StructError,\n  create,\n  object,\n  optional,\n  string,\n} from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type {\n  JsonRpcRequestWithOrigin,\n  SnapInterfaceControllerUpdateInterfaceAction,\n} from '../types';\nimport { UI_PERMISSIONS } from '../utils';\n\nexport type UpdateInterfaceMethodActions =\n  | PermissionControllerHasPermissionAction\n  | SnapInterfaceControllerUpdateInterfaceAction;\n\n/**\n * Update an interactive interface. For use in\n * [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).\n *\n * @example\n * ```tsx\n * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';\n *\n * // First, create an interface and get its ID.\n * const id = await snap.request({\n *   method: 'snap_createInterface',\n *   params: {\n *     ui: (\n *       <Box>\n *         ...\n *       </Box>\n *     ),\n *   },\n * });\n *\n * // Later, update the interface with new content using the ID.\n * snap.request({\n *   method: 'snap_updateInterface',\n *   params: {\n *     id: 'interface-id',\n *     ui: (\n *       <Box>\n *         <Heading>Updated Interface</Heading>\n *         <Text>This interface has been updated.</Text>\n *       </Box>\n *     ),\n *   },\n * });\n * ```\n */\nexport const updateInterfaceHandler = {\n  implementation: getUpdateInterfaceImplementation,\n  actionNames: [\n    'PermissionController:hasPermission',\n    'SnapInterfaceController:updateInterface',\n  ],\n} satisfies MethodHandler<\n  never,\n  UpdateInterfaceMethodActions,\n  UpdateInterfaceParameters,\n  UpdateInterfaceResult,\n  { origin: string }\n>;\n\nconst UpdateInterfaceParametersStruct = object({\n  id: string(),\n  ui: ComponentOrElementStruct,\n  context: optional(InterfaceContextStruct),\n});\n\nexport type UpdateInterfaceParameters = InferMatching<\n  typeof UpdateInterfaceParametersStruct,\n  UpdateInterfaceParams\n>;\n\n/**\n * The `snap_updateInterface` method implementation.\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. Not used by this function.\n * @param messenger - The messenger used to call controller actions.\n * @returns Nothing.\n */\nfunction getUpdateInterfaceImplementation(\n  req: JsonRpcRequestWithOrigin<UpdateInterfaceParameters>,\n  res: PendingJsonRpcResponse<UpdateInterfaceResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  _hooks: never,\n  messenger: Messenger<string, UpdateInterfaceMethodActions>,\n): void {\n  const { params, origin } = req;\n\n  const isPermitted = UI_PERMISSIONS.some((permission) =>\n    messenger.call('PermissionController:hasPermission', origin, permission),\n  );\n\n  if (!isPermitted) {\n    return end(\n      providerErrors.unauthorized({\n        message: `This method can only be used if the Snap has one of the following permissions: ${UI_PERMISSIONS.join(', ')}.`,\n      }),\n    );\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id, ui, context } = validatedParams;\n\n    messenger.call(\n      'SnapInterfaceController:updateInterface',\n      origin,\n      id,\n      ui,\n      context,\n    );\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the updateInterface 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 updateInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): UpdateInterfaceParameters {\n  try {\n    return create(params, UpdateInterfaceParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}