@metamask/snaps-rpc-methods 3.3.0 → 4.0.1

package/dist/esm/restricted/notify.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/restricted/notify.ts"],"sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  RestrictedMethodOptions,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { assertLinksAreSafe } from '@metamask/snaps-ui';\nimport type { EnumToUnion } from '@metamask/snaps-utils';\nimport type { NonEmptyArray } from '@metamask/utils';\nimport { isObject } from '@metamask/utils';\n\nimport { type MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_notify';\n\n// TODO: Move all the types to a shared place when implementing more\n//  notifications.\nexport enum NotificationType {\n  InApp = 'inApp',\n  Native = 'native',\n}\n\nexport type NotificationArgs = {\n  /**\n   * Enum type to determine notification type.\n   */\n  type: EnumToUnion<NotificationType>;\n\n  /**\n   * A message to show on the notification.\n   */\n  message: string;\n};\n\nexport type NotifyMethodHooks = {\n  /**\n   * @param snapId - The ID of the Snap that created the notification.\n   * @param args - The notification arguments.\n   */\n  showNativeNotification: (\n    snapId: string,\n    args: NotificationArgs,\n  ) => Promise<null>;\n\n  /**\n   * @param snapId - The ID of the Snap that created the notification.\n   * @param args - The notification arguments.\n   */\n  showInAppNotification: (\n    snapId: string,\n    args: NotificationArgs,\n  ) => Promise<null>;\n\n  isOnPhishingList: (url: string) => boolean;\n\n  maybeUpdatePhishingList: () => Promise<void>;\n};\n\ntype SpecificationBuilderOptions = {\n  allowedCaveats?: Readonly<NonEmptyArray<string>> | null;\n  methodHooks: NotifyMethodHooks;\n};\n\ntype Specification = ValidPermissionSpecification<{\n  permissionType: PermissionType.RestrictedMethod;\n  targetName: typeof methodName;\n  methodImplementation: ReturnType<typeof getImplementation>;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * The specification builder for the `snap_notify` permission.\n * `snap_notify` allows snaps to send multiple types of notifications to its users.\n *\n * @param options - The specification builder options.\n * @param options.allowedCaveats - The optional allowed caveats for the permission.\n * @param options.methodHooks - The RPC method hooks needed by the method implementation.\n * @returns The specification for the `snap_notify` permission.\n */\nexport const specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.RestrictedMethod,\n  SpecificationBuilderOptions,\n  Specification\n> = ({ allowedCaveats = null, methodHooks }: SpecificationBuilderOptions) => {\n  return {\n    permissionType: PermissionType.RestrictedMethod,\n    targetName: methodName,\n    allowedCaveats,\n    methodImplementation: getImplementation(methodHooks),\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nconst methodHooks: MethodHooksObject<NotifyMethodHooks> = {\n  showNativeNotification: true,\n  showInAppNotification: true,\n  isOnPhishingList: true,\n  maybeUpdatePhishingList: true,\n};\n\nexport const notifyBuilder = Object.freeze({\n  targetName: methodName,\n  specificationBuilder,\n  methodHooks,\n} as const);\n\n/**\n * Builds the method implementation for `snap_notify`.\n *\n * @param hooks - The RPC method hooks.\n * @param hooks.showNativeNotification - A function that shows a native browser notification.\n * @param hooks.showInAppNotification - A function that shows a notification in the MetaMask UI.\n * @param hooks.isOnPhishingList - A function that checks for links against the phishing list.\n * @param hooks.maybeUpdatePhishingList - A function that updates the phishing list if needed.\n * @returns The method implementation which returns `null` on success.\n * @throws If the params are invalid.\n */\nexport function getImplementation({\n  showNativeNotification,\n  showInAppNotification,\n  isOnPhishingList,\n  maybeUpdatePhishingList,\n}: NotifyMethodHooks) {\n  return async function implementation(\n    args: RestrictedMethodOptions<NotificationArgs>,\n  ): Promise<null> {\n    const {\n      params,\n      context: { origin },\n    } = args;\n\n    const validatedParams = getValidatedParams(params);\n\n    await maybeUpdatePhishingList();\n\n    assertLinksAreSafe(validatedParams.message, isOnPhishingList);\n\n    switch (validatedParams.type) {\n      case NotificationType.Native:\n        return await showNativeNotification(origin, validatedParams);\n      case NotificationType.InApp:\n        return await showInAppNotification(origin, validatedParams);\n      default:\n        throw rpcErrors.invalidParams({\n          message: 'Must specify a valid notification \"type\".',\n        });\n    }\n  };\n}\n\n/**\n * Validates the notify 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): NotificationArgs {\n  if (!isObject(params)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected params to be a single object.',\n    });\n  }\n\n  const { type, message } = params;\n\n  if (\n    !type ||\n    typeof type !== 'string' ||\n    !Object.values(NotificationType).includes(type as NotificationType)\n  ) {\n    throw rpcErrors.invalidParams({\n      message: 'Must specify a valid notification \"type\".',\n    });\n  }\n\n  // Set to the max message length on a Mac notification for now.\n  if (!message || typeof message !== 'string' || message.length >= 50) {\n    throw rpcErrors.invalidParams({\n      message:\n        'Must specify a non-empty string \"message\" less than 50 characters long.',\n    });\n  }\n\n  return params as NotificationArgs;\n}\n"],"names":["PermissionType","SubjectType","rpcErrors","assertLinksAreSafe","isObject","methodName","NotificationType","InApp","Native","specificationBuilder","allowedCaveats","methodHooks","permissionType","RestrictedMethod","targetName","methodImplementation","getImplementation","subjectTypes","Snap","showNativeNotification","showInAppNotification","isOnPhishingList","maybeUpdatePhishingList","notifyBuilder","Object","freeze","implementation","args","params","context","origin","validatedParams","getValidatedParams","message","type","invalidParams","values","includes","length"],"mappings":"AAKA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,SAAS,QAAQ,uBAAuB;AACjD,SAASC,kBAAkB,QAAQ,qBAAqB;AAGxD,SAASC,QAAQ,QAAQ,kBAAkB;AAI3C,MAAMC,aAAa;WAIZ;UAAKC,gBAAgB;IAAhBA,iBACVC,WAAQ;IADED,iBAEVE,YAAS;GAFCF,qBAAAA;AAqDZ;;;;;;;;CAQC,GACD,OAAO,MAAMG,uBAIT,CAAC,EAAEC,iBAAiB,IAAI,EAAEC,WAAW,EAA+B;IACtE,OAAO;QACLC,gBAAgBZ,eAAea,gBAAgB;QAC/CC,YAAYT;QACZK;QACAK,sBAAsBC,kBAAkBL;QACxCM,cAAc;YAAChB,YAAYiB,IAAI;SAAC;IAClC;AACF,EAAE;AAEF,MAAMP,cAAoD;IACxDQ,wBAAwB;IACxBC,uBAAuB;IACvBC,kBAAkB;IAClBC,yBAAyB;AAC3B;AAEA,OAAO,MAAMC,gBAAgBC,OAAOC,MAAM,CAAC;IACzCX,YAAYT;IACZI;IACAE;AACF,GAAY;AAEZ;;;;;;;;;;CAUC,GACD,OAAO,SAASK,kBAAkB,EAChCG,sBAAsB,EACtBC,qBAAqB,EACrBC,gBAAgB,EAChBC,uBAAuB,EACL;IAClB,OAAO,eAAeI,eACpBC,IAA+C;QAE/C,MAAM,EACJC,MAAM,EACNC,SAAS,EAAEC,MAAM,EAAE,EACpB,GAAGH;QAEJ,MAAMI,kBAAkBC,mBAAmBJ;QAE3C,MAAMN;QAENnB,mBAAmB4B,gBAAgBE,OAAO,EAAEZ;QAE5C,OAAQU,gBAAgBG,IAAI;YAC1B,KAAK5B,iBAAiBE,MAAM;gBAC1B,OAAO,MAAMW,uBAAuBW,QAAQC;YAC9C,KAAKzB,iBAAiBC,KAAK;gBACzB,OAAO,MAAMa,sBAAsBU,QAAQC;YAC7C;gBACE,MAAM7B,UAAUiC,aAAa,CAAC;oBAC5BF,SAAS;gBACX;QACJ;IACF;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASD,mBAAmBJ,MAAe;IAChD,IAAI,CAACxB,SAASwB,SAAS;QACrB,MAAM1B,UAAUiC,aAAa,CAAC;YAC5BF,SAAS;QACX;IACF;IAEA,MAAM,EAAEC,IAAI,EAAED,OAAO,EAAE,GAAGL;IAE1B,IACE,CAACM,QACD,OAAOA,SAAS,YAChB,CAACV,OAAOY,MAAM,CAAC9B,kBAAkB+B,QAAQ,CAACH,OAC1C;QACA,MAAMhC,UAAUiC,aAAa,CAAC;YAC5BF,SAAS;QACX;IACF;IAEA,+DAA+D;IAC/D,IAAI,CAACA,WAAW,OAAOA,YAAY,YAAYA,QAAQK,MAAM,IAAI,IAAI;QACnE,MAAMpC,UAAUiC,aAAa,CAAC;YAC5BF,SACE;QACJ;IACF;IAEA,OAAOL;AACT"}
+{"version":3,"sources":["../../../src/restricted/notify.ts"],"sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  RestrictedMethodOptions,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { NotificationType } from '@metamask/snaps-sdk';\nimport type {\n  NotifyParams,\n  NotifyResult,\n  EnumToUnion,\n} from '@metamask/snaps-sdk';\nimport { validateTextLinks } from '@metamask/snaps-utils';\nimport type { NonEmptyArray } from '@metamask/utils';\nimport { isObject } from '@metamask/utils';\n\nimport { type MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_notify';\n\nexport type NotificationArgs = {\n  /**\n   * Enum type to determine notification type.\n   */\n  type: EnumToUnion<NotificationType>;\n\n  /**\n   * A message to show on the notification.\n   */\n  message: string;\n};\n\nexport type NotifyMethodHooks = {\n  /**\n   * @param snapId - The ID of the Snap that created the notification.\n   * @param args - The notification arguments.\n   */\n  showNativeNotification: (\n    snapId: string,\n    args: NotificationArgs,\n  ) => Promise<null>;\n\n  /**\n   * @param snapId - The ID of the Snap that created the notification.\n   * @param args - The notification arguments.\n   */\n  showInAppNotification: (\n    snapId: string,\n    args: NotificationArgs,\n  ) => Promise<null>;\n\n  isOnPhishingList: (url: string) => boolean;\n\n  maybeUpdatePhishingList: () => Promise<void>;\n};\n\ntype SpecificationBuilderOptions = {\n  allowedCaveats?: Readonly<NonEmptyArray<string>> | null;\n  methodHooks: NotifyMethodHooks;\n};\n\ntype Specification = ValidPermissionSpecification<{\n  permissionType: PermissionType.RestrictedMethod;\n  targetName: typeof methodName;\n  methodImplementation: ReturnType<typeof getImplementation>;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * The specification builder for the `snap_notify` permission.\n * `snap_notify` allows snaps to send multiple types of notifications to its users.\n *\n * @param options - The specification builder options.\n * @param options.allowedCaveats - The optional allowed caveats for the permission.\n * @param options.methodHooks - The RPC method hooks needed by the method implementation.\n * @returns The specification for the `snap_notify` permission.\n */\nexport const specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.RestrictedMethod,\n  SpecificationBuilderOptions,\n  Specification\n> = ({ allowedCaveats = null, methodHooks }: SpecificationBuilderOptions) => {\n  return {\n    permissionType: PermissionType.RestrictedMethod,\n    targetName: methodName,\n    allowedCaveats,\n    methodImplementation: getImplementation(methodHooks),\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nconst methodHooks: MethodHooksObject<NotifyMethodHooks> = {\n  showNativeNotification: true,\n  showInAppNotification: true,\n  isOnPhishingList: true,\n  maybeUpdatePhishingList: true,\n};\n\nexport const notifyBuilder = Object.freeze({\n  targetName: methodName,\n  specificationBuilder,\n  methodHooks,\n} as const);\n\n/**\n * Builds the method implementation for `snap_notify`.\n *\n * @param hooks - The RPC method hooks.\n * @param hooks.showNativeNotification - A function that shows a native browser notification.\n * @param hooks.showInAppNotification - A function that shows a notification in the MetaMask UI.\n * @param hooks.isOnPhishingList - A function that checks for links against the phishing list.\n * @param hooks.maybeUpdatePhishingList - A function that updates the phishing list if needed.\n * @returns The method implementation which returns `null` on success.\n * @throws If the params are invalid.\n */\nexport function getImplementation({\n  showNativeNotification,\n  showInAppNotification,\n  isOnPhishingList,\n  maybeUpdatePhishingList,\n}: NotifyMethodHooks) {\n  return async function implementation(\n    args: RestrictedMethodOptions<NotifyParams>,\n  ): Promise<NotifyResult> {\n    const {\n      params,\n      context: { origin },\n    } = args;\n\n    const validatedParams = getValidatedParams(params);\n\n    await maybeUpdatePhishingList();\n\n    validateTextLinks(validatedParams.message, isOnPhishingList);\n\n    switch (validatedParams.type) {\n      case NotificationType.Native:\n        return await showNativeNotification(origin, validatedParams);\n      case NotificationType.InApp:\n        return await showInAppNotification(origin, validatedParams);\n      default:\n        throw rpcErrors.invalidParams({\n          message: 'Must specify a valid notification \"type\".',\n        });\n    }\n  };\n}\n\n/**\n * Validates the notify 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): NotifyParams {\n  if (!isObject(params)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected params to be a single object.',\n    });\n  }\n\n  const { type, message } = params;\n\n  if (\n    !type ||\n    typeof type !== 'string' ||\n    !Object.values(NotificationType).includes(type as NotificationType)\n  ) {\n    throw rpcErrors.invalidParams({\n      message: 'Must specify a valid notification \"type\".',\n    });\n  }\n\n  // Set to the max message length on a Mac notification for now.\n  if (!message || typeof message !== 'string' || message.length >= 50) {\n    throw rpcErrors.invalidParams({\n      message:\n        'Must specify a non-empty string \"message\" less than 50 characters long.',\n    });\n  }\n\n  return params as NotificationArgs;\n}\n"],"names":["PermissionType","SubjectType","rpcErrors","NotificationType","validateTextLinks","isObject","methodName","specificationBuilder","allowedCaveats","methodHooks","permissionType","RestrictedMethod","targetName","methodImplementation","getImplementation","subjectTypes","Snap","showNativeNotification","showInAppNotification","isOnPhishingList","maybeUpdatePhishingList","notifyBuilder","Object","freeze","implementation","args","params","context","origin","validatedParams","getValidatedParams","message","type","Native","InApp","invalidParams","values","includes","length"],"mappings":"AAKA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,SAAS,QAAQ,uBAAuB;AACjD,SAASC,gBAAgB,QAAQ,sBAAsB;AAMvD,SAASC,iBAAiB,QAAQ,wBAAwB;AAE1D,SAASC,QAAQ,QAAQ,kBAAkB;AAI3C,MAAMC,aAAa;AAkDnB;;;;;;;;CAQC,GACD,OAAO,MAAMC,uBAIT,CAAC,EAAEC,iBAAiB,IAAI,EAAEC,WAAW,EAA+B;IACtE,OAAO;QACLC,gBAAgBV,eAAeW,gBAAgB;QAC/CC,YAAYN;QACZE;QACAK,sBAAsBC,kBAAkBL;QACxCM,cAAc;YAACd,YAAYe,IAAI;SAAC;IAClC;AACF,EAAE;AAEF,MAAMP,cAAoD;IACxDQ,wBAAwB;IACxBC,uBAAuB;IACvBC,kBAAkB;IAClBC,yBAAyB;AAC3B;AAEA,OAAO,MAAMC,gBAAgBC,OAAOC,MAAM,CAAC;IACzCX,YAAYN;IACZC;IACAE;AACF,GAAY;AAEZ;;;;;;;;;;CAUC,GACD,OAAO,SAASK,kBAAkB,EAChCG,sBAAsB,EACtBC,qBAAqB,EACrBC,gBAAgB,EAChBC,uBAAuB,EACL;IAClB,OAAO,eAAeI,eACpBC,IAA2C;QAE3C,MAAM,EACJC,MAAM,EACNC,SAAS,EAAEC,MAAM,EAAE,EACpB,GAAGH;QAEJ,MAAMI,kBAAkBC,mBAAmBJ;QAE3C,MAAMN;QAENhB,kBAAkByB,gBAAgBE,OAAO,EAAEZ;QAE3C,OAAQU,gBAAgBG,IAAI;YAC1B,KAAK7B,iBAAiB8B,MAAM;gBAC1B,OAAO,MAAMhB,uBAAuBW,QAAQC;YAC9C,KAAK1B,iBAAiB+B,KAAK;gBACzB,OAAO,MAAMhB,sBAAsBU,QAAQC;YAC7C;gBACE,MAAM3B,UAAUiC,aAAa,CAAC;oBAC5BJ,SAAS;gBACX;QACJ;IACF;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASD,mBAAmBJ,MAAe;IAChD,IAAI,CAACrB,SAASqB,SAAS;QACrB,MAAMxB,UAAUiC,aAAa,CAAC;YAC5BJ,SAAS;QACX;IACF;IAEA,MAAM,EAAEC,IAAI,EAAED,OAAO,EAAE,GAAGL;IAE1B,IACE,CAACM,QACD,OAAOA,SAAS,YAChB,CAACV,OAAOc,MAAM,CAACjC,kBAAkBkC,QAAQ,CAACL,OAC1C;QACA,MAAM9B,UAAUiC,aAAa,CAAC;YAC5BJ,SAAS;QACX;IACF;IAEA,+DAA+D;IAC/D,IAAI,CAACA,WAAW,OAAOA,YAAY,YAAYA,QAAQO,MAAM,IAAI,IAAI;QACnE,MAAMpC,UAAUiC,aAAa,CAAC;YAC5BJ,SACE;QACJ;IACF;IAEA,OAAOL;AACT"}

package/dist/types/index.d.ts

@@ -3,4 +3,3 @@ export { handlers as permittedMethods, createSnapsMethodMiddleware, } from './pe
 export * from './restricted';
 export { SnapCaveatType } from '@metamask/snaps-utils';
 export { selectHooks } from './utils';
-export type { RequestFunction, SnapsGlobalObject } from './request';

package/dist/types/permitted/common/snapInstallation.d.ts

@@ -1,7 +1,5 @@
-import type { RequestedPermissions } from '@metamask/permission-controller';
-import type { InstallSnapsResult } from '@metamask/snaps-utils';
-export type { InstallSnapsResult } from '@metamask/snaps-utils';
-export declare type InstallSnapsHook = (requestedSnaps: RequestedPermissions) => Promise<InstallSnapsResult>;
+import type { RequestSnapsParams, RequestSnapsResult } from '@metamask/snaps-sdk';
+export declare type InstallSnapsHook = (requestedSnaps: RequestSnapsParams) => Promise<RequestSnapsResult>;
 /**
  * Typechecks the requested snaps and passes them to the permissions
  * controller for installation.
@@ -13,4 +11,4 @@ export declare type InstallSnapsHook = (requestedSnaps: RequestedPermissions) =>
  * @returns An object containing the installed snaps.
  * @throws If the params are invalid or the snap installation fails.
  */
-export declare function handleInstallSnaps(requestedSnaps: RequestedPermissions, installSnaps: InstallSnapsHook): Promise<InstallSnapsResult>;
+export declare function handleInstallSnaps(requestedSnaps: RequestSnapsParams, installSnaps: InstallSnapsHook): Promise<RequestSnapsResult>;

package/dist/types/permitted/getFile.d.ts

@@ -1,5 +1,6 @@
 import type { PermittedHandlerExport } from '@metamask/permission-controller';
-import type { Infer } from 'superstruct';
+import type { GetFileParams } from '@metamask/snaps-sdk';
+import type { InferMatching } from '@metamask/snaps-utils';
 export declare const GetFileArgsStruct: import("superstruct").Struct<{
     path: string;
     encoding?: "base64" | "utf8" | "hex" | undefined;
@@ -7,8 +8,8 @@ export declare const GetFileArgsStruct: import("superstruct").Struct<{
     path: import("superstruct").Struct<string, null>;
     encoding: import("superstruct").Struct<"base64" | "utf8" | "hex" | undefined, null>;
 }>;
-export declare type GetFileArgs = Infer<typeof GetFileArgsStruct>;
-export declare const getFileHandler: PermittedHandlerExport<GetFileHooks, GetFileArgs, string>;
+export declare type InferredGetFileParams = InferMatching<typeof GetFileArgsStruct, GetFileParams>;
+export declare const getFileHandler: PermittedHandlerExport<GetFileHooks, InferredGetFileParams, string>;
 export declare type GetFileHooks = {
-    getSnapFile: (path: GetFileArgs['path'], encoding: GetFileArgs['encoding']) => Promise<string>;
+    getSnapFile: (path: InferredGetFileParams['path'], encoding: InferredGetFileParams['encoding']) => Promise<string>;
 };

package/dist/types/permitted/getSnaps.d.ts

@@ -1,13 +1,13 @@
 import type { PermittedHandlerExport } from '@metamask/permission-controller';
-import type { InstallSnapsResult } from '@metamask/snaps-utils';
+import type { GetSnapsResult } from '@metamask/snaps-sdk';
 import type { JsonRpcParams } from '@metamask/utils';
 /**
  * `wallet_getSnaps` gets the requester's permitted and installed Snaps.
  */
-export declare const getSnapsHandler: PermittedHandlerExport<GetSnapsHooks, JsonRpcParams, InstallSnapsResult>;
+export declare const getSnapsHandler: PermittedHandlerExport<GetSnapsHooks, JsonRpcParams, GetSnapsResult>;
 export declare type GetSnapsHooks = {
     /**
      * @returns The permitted and installed snaps for the requesting origin.
      */
-    getSnaps: () => Promise<InstallSnapsResult>;
+    getSnaps: () => Promise<GetSnapsResult>;
 };

package/dist/types/permitted/handlers.d.ts

@@ -1,14 +1,8 @@
 export declare const methodHandlers: {
-    wallet_getSnaps: import("@metamask/permission-controller").PermittedHandlerExport<import("./getSnaps").GetSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-utils").InstallSnapsResult>;
-    wallet_requestSnaps: import("@metamask/permission-controller").PermittedHandlerExport<import("./requestSnaps").RequestSnapsHooks, import("@metamask/permission-controller").RequestedPermissions, import("@metamask/snaps-utils").InstallSnapsResult>;
-    wallet_invokeSnap: import("@metamask/permission-controller").PermittedHandlerExport<void, import("./invokeSnapSugar").InvokeSnapSugarArgs, import("@metamask/utils").Json>;
-    wallet_invokeKeyring: import("@metamask/permission-controller").PermittedHandlerExport<import("./invokeKeyring").InvokeKeyringHooks, import("@metamask/utils").JsonRpcRequest<import("@metamask/utils").JsonRpcParams>, import("@metamask/utils").Json>;
-    snap_getFile: import("@metamask/permission-controller").PermittedHandlerExport<import("./getFile").GetFileHooks, {
-        path: string;
-        encoding?: "base64" | "utf8" | "hex" | undefined;
-    }, string>;
+    wallet_getSnaps: import("@metamask/permission-controller").PermittedHandlerExport<import("./getSnaps").GetSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult>;
+    wallet_requestSnaps: import("@metamask/permission-controller").PermittedHandlerExport<import("./requestSnaps").RequestSnapsHooks, import("@metamask/snaps-sdk").RequestSnapsParams, import("@metamask/snaps-sdk").RequestSnapsResult>;
+    wallet_invokeSnap: import("@metamask/permission-controller").PermittedHandlerExport<void, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>;
+    wallet_invokeKeyring: import("@metamask/permission-controller").PermittedHandlerExport<import("./invokeKeyring").InvokeKeyringHooks, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>;
+    snap_getFile: import("@metamask/permission-controller").PermittedHandlerExport<import("./getFile").GetFileHooks, import("@metamask/snaps-sdk").GetFileParams, string>;
 };
-export declare const handlers: (import("@metamask/permission-controller").PermittedHandlerExport<import("./getSnaps").GetSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-utils").InstallSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./requestSnaps").RequestSnapsHooks, import("@metamask/permission-controller").RequestedPermissions, import("@metamask/snaps-utils").InstallSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getFile").GetFileHooks, {
-    path: string;
-    encoding?: "base64" | "utf8" | "hex" | undefined;
-}, string> | import("@metamask/permission-controller").PermittedHandlerExport<void, import("./invokeSnapSugar").InvokeSnapSugarArgs, import("@metamask/utils").Json> | import("@metamask/permission-controller").PermittedHandlerExport<import("./invokeKeyring").InvokeKeyringHooks, import("@metamask/utils").JsonRpcRequest<import("@metamask/utils").JsonRpcParams>, import("@metamask/utils").Json>)[];
+export declare const handlers: (import("@metamask/permission-controller").PermittedHandlerExport<import("./getSnaps").GetSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./requestSnaps").RequestSnapsHooks, import("@metamask/snaps-sdk").RequestSnapsParams, import("@metamask/snaps-sdk").RequestSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getFile").GetFileHooks, import("@metamask/snaps-sdk").GetFileParams, string> | import("@metamask/permission-controller").PermittedHandlerExport<void, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json> | import("@metamask/permission-controller").PermittedHandlerExport<import("./invokeKeyring").InvokeKeyringHooks, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>)[];

package/dist/types/permitted/invokeKeyring.d.ts

@@ -1,17 +1,15 @@
 import type { PermittedHandlerExport } from '@metamask/permission-controller';
-import type { Snap } from '@metamask/snaps-utils';
-import { type SnapId, type SnapRpcHookArgs } from '@metamask/snaps-utils';
-import type { JsonRpcRequest } from '@metamask/utils';
-import { type Json } from '@metamask/utils';
+import type { InvokeKeyringResult, InvokeSnapParams } from '@metamask/snaps-sdk';
+import type { Snap, SnapRpcHookArgs } from '@metamask/snaps-utils';
 /**
  * `wallet_invokeKeyring` gets the requester's permitted and installed Snaps.
  */
-export declare const invokeKeyringHandler: PermittedHandlerExport<InvokeKeyringHooks, JsonRpcRequest, Json>;
+export declare const invokeKeyringHandler: PermittedHandlerExport<InvokeKeyringHooks, InvokeSnapParams, InvokeKeyringResult>;
 export declare type InvokeKeyringHooks = {
     hasPermission: (origin: string, permissionName: string) => boolean;
     handleSnapRpcRequest: ({ snapId, origin, handler, request, }: SnapRpcHookArgs & {
-        snapId: SnapId;
+        snapId: string;
     }) => Promise<unknown>;
-    getSnap: (snapId: SnapId) => Snap | undefined;
+    getSnap: (snapId: string) => Snap | undefined;
     getAllowedKeyringMethods: (origin: string) => string[];
 };

package/dist/types/permitted/invokeSnapSugar.d.ts

@@ -1,14 +1,11 @@
 import type { JsonRpcEngineEndCallback, JsonRpcEngineNextCallback } from '@metamask/json-rpc-engine';
 import type { PermittedHandlerExport } from '@metamask/permission-controller';
-import type { Json, JsonRpcRequest } from '@metamask/utils';
-export declare type InvokeSnapSugarArgs = {
-    snapId: string;
-    request: Record<string, Json>;
-};
+import type { InvokeSnapParams, InvokeSnapResult } from '@metamask/snaps-sdk';
+import type { JsonRpcRequest } from '@metamask/utils';
 /**
  * `wallet_invokeSnap` attempts to invoke an RPC method of the specified Snap.
  */
-export declare const invokeSnapSugarHandler: PermittedHandlerExport<void, InvokeSnapSugarArgs, Json>;
+export declare const invokeSnapSugarHandler: PermittedHandlerExport<void, InvokeSnapParams, InvokeSnapResult>;
 /**
  * The `wallet_invokeSnap` method implementation.
  * Reroutes incoming JSON-RPC requests that are targeting snaps, by modifying the method and params.
@@ -21,7 +18,7 @@ export declare const invokeSnapSugarHandler: PermittedHandlerExport<void, Invoke
  * @returns Nothing.
  * @throws If the params are invalid.
  */
-export declare function invokeSnapSugar(req: JsonRpcRequest<InvokeSnapSugarArgs>, _res: unknown, next: JsonRpcEngineNextCallback, end: JsonRpcEngineEndCallback): void;
+export declare function invokeSnapSugar(req: JsonRpcRequest<InvokeSnapParams>, _res: unknown, next: JsonRpcEngineNextCallback, end: JsonRpcEngineEndCallback): void;
 /**
  * Validates the wallet_invokeSnap method `params` and returns them cast to the correct
  * type. Throws if validation fails.
@@ -29,4 +26,4 @@ export declare function invokeSnapSugar(req: JsonRpcRequest<InvokeSnapSugarArgs>
  * @param params - The unvalidated params object from the method request.
  * @returns The validated method parameter object.
  */
-export declare function getValidatedParams(params: unknown): InvokeSnapSugarArgs;
+export declare function getValidatedParams(params: unknown): InvokeSnapParams;

package/dist/types/permitted/requestSnaps.d.ts

@@ -1,10 +1,11 @@
 import type { PermissionConstraint, RequestedPermissions, PermittedHandlerExport } from '@metamask/permission-controller';
+import type { RequestSnapsParams, RequestSnapsResult } from '@metamask/snaps-sdk';
 import type { SnapsPermissionRequest } from '@metamask/snaps-utils';
-import type { InstallSnapsHook, InstallSnapsResult } from './common/snapInstallation';
+import type { InstallSnapsHook } from './common/snapInstallation';
 /**
  * `wallet_requestSnaps` installs the requested Snaps and requests permission to use them if necessary.
  */
-export declare const requestSnapsHandler: PermittedHandlerExport<RequestSnapsHooks, RequestedPermissions, InstallSnapsResult>;
+export declare const requestSnapsHandler: PermittedHandlerExport<RequestSnapsHooks, RequestSnapsParams, RequestSnapsResult>;
 export declare type RequestSnapsHooks = {
     /**
      * Installs the requested snaps if they are permitted.

package/dist/types/restricted/caveats/permittedCoinTypes.d.ts

@@ -1,7 +1,7 @@
 import type { PermissionConstraint, RestrictedMethodCaveatSpecificationConstraint, Caveat } from '@metamask/permission-controller';
+import type { GetBip44EntropyParams } from '@metamask/snaps-sdk';
 import { SnapCaveatType } from '@metamask/snaps-utils';
 import type { Json } from '@metamask/utils';
-import type { GetBip44EntropyParams } from '../getBip44Entropy';
 /**
  * Map a raw value from the `initialPermissions` to a caveat specification.
  * Note that this function does not do any validation, that's handled by the

package/dist/types/restricted/dialog.d.ts

@@ -1,16 +1,12 @@
 import type { PermissionSpecificationBuilder, RestrictedMethodOptions } from '@metamask/permission-controller';
 import { PermissionType } from '@metamask/permission-controller';
-import type { Component } from '@metamask/snaps-ui';
-import type { EnumToUnion } from '@metamask/snaps-utils';
+import { DialogType } from '@metamask/snaps-sdk';
+import type { DialogParams, EnumToUnion, Component } from '@metamask/snaps-sdk';
+import type { InferMatching } from '@metamask/snaps-utils';
 import type { NonEmptyArray } from '@metamask/utils';
 import type { Infer, Struct } from 'superstruct';
 import { type MethodHooksObject } from '../utils';
 declare const methodName = "snap_dialog";
-export declare enum DialogType {
-    Alert = "alert",
-    Confirmation = "confirmation",
-    Prompt = "prompt"
-}
 declare const PlaceholderStruct: Struct<string | undefined, null>;
 export declare type Placeholder = Infer<typeof PlaceholderStruct>;
 declare type ShowDialog = (snapId: string, type: EnumToUnion<DialogType>, content: Component, placeholder?: Placeholder) => Promise<null | boolean | string>;
@@ -46,67 +42,124 @@ export declare const dialogBuilder: Readonly<{
 }>;
 declare const DialogParametersStruct: Struct<{
     type: "alert";
-    content: import("@metamask/snaps-ui").Panel | {
+    content: import("@metamask/snaps-sdk").Panel | {
         value: string;
-        type: import("@metamask/snaps-ui").NodeType.Copyable;
+        type: import("@metamask/snaps-sdk").NodeType.Copyable;
+        sensitive?: boolean | undefined;
     } | {
-        type: import("@metamask/snaps-ui").NodeType.Divider;
+        type: import("@metamask/snaps-sdk").NodeType.Divider;
     } | {
         value: string;
-        type: import("@metamask/snaps-ui").NodeType.Heading;
+        type: import("@metamask/snaps-sdk").NodeType.Heading;
     } | {
-        type: import("@metamask/snaps-ui").NodeType.Spinner;
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Image;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Spinner;
     } | {
         value: string;
-        type: import("@metamask/snaps-ui").NodeType.Text;
+        type: import("@metamask/snaps-sdk").NodeType.Text;
         markdown?: boolean | undefined;
     } | {
         value: string;
-        type: import("@metamask/snaps-ui").NodeType.Image;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
     };
 } | {
     type: "confirmation";
-    content: import("@metamask/snaps-ui").Panel | {
+    content: import("@metamask/snaps-sdk").Panel | {
         value: string;
-        type: import("@metamask/snaps-ui").NodeType.Copyable;
+        type: import("@metamask/snaps-sdk").NodeType.Copyable;
+        sensitive?: boolean | undefined;
     } | {
-        type: import("@metamask/snaps-ui").NodeType.Divider;
+        type: import("@metamask/snaps-sdk").NodeType.Divider;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Heading;
     } | {
         value: string;
-        type: import("@metamask/snaps-ui").NodeType.Heading;
+        type: import("@metamask/snaps-sdk").NodeType.Image;
     } | {
-        type: import("@metamask/snaps-ui").NodeType.Spinner;
+        type: import("@metamask/snaps-sdk").NodeType.Spinner;
     } | {
         value: string;
-        type: import("@metamask/snaps-ui").NodeType.Text;
+        type: import("@metamask/snaps-sdk").NodeType.Text;
         markdown?: boolean | undefined;
     } | {
         value: string;
-        type: import("@metamask/snaps-ui").NodeType.Image;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
     };
 } | {
     type: "prompt";
-    content: import("@metamask/snaps-ui").Panel | {
+    content: import("@metamask/snaps-sdk").Panel | {
         value: string;
-        type: import("@metamask/snaps-ui").NodeType.Copyable;
+        type: import("@metamask/snaps-sdk").NodeType.Copyable;
+        sensitive?: boolean | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Divider;
     } | {
-        type: import("@metamask/snaps-ui").NodeType.Divider;
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Heading;
     } | {
         value: string;
-        type: import("@metamask/snaps-ui").NodeType.Heading;
+        type: import("@metamask/snaps-sdk").NodeType.Image;
     } | {
-        type: import("@metamask/snaps-ui").NodeType.Spinner;
+        type: import("@metamask/snaps-sdk").NodeType.Spinner;
     } | {
         value: string;
-        type: import("@metamask/snaps-ui").NodeType.Text;
+        type: import("@metamask/snaps-sdk").NodeType.Text;
         markdown?: boolean | undefined;
     } | {
         value: string;
-        type: import("@metamask/snaps-ui").NodeType.Image;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
     };
     placeholder?: string | undefined;
 }, null>;
-export declare type DialogParameters = Infer<typeof DialogParametersStruct>;
+export declare type DialogParameters = InferMatching<typeof DialogParametersStruct, DialogParams>;
 /**
  * Builds the method implementation for `snap_dialog`.
  *

package/dist/types/restricted/getBip32Entropy.d.ts

@@ -1,7 +1,6 @@
-import type { JsonSLIP10Node } from '@metamask/key-tree';
 import type { PermissionSpecificationBuilder, PermissionValidatorConstraint, RestrictedMethodOptions } from '@metamask/permission-controller';
 import { PermissionType } from '@metamask/permission-controller';
-import type { Bip32Entropy } from '@metamask/snaps-utils';
+import type { GetBip32EntropyParams, GetBip32EntropyResult } from '@metamask/snaps-sdk';
 import type { NonEmptyArray } from '@metamask/utils';
 import type { MethodHooksObject } from '../utils';
 declare const targetName = "snap_getBip32Entropy";
@@ -41,5 +40,5 @@ export declare const getBip32EntropyBuilder: Readonly<{
  * @returns The method implementation which returns a `JsonSLIP10Node`.
  * @throws If the params are invalid.
  */
-export declare function getBip32EntropyImplementation({ getMnemonic, getUnlockPromise, }: GetBip32EntropyMethodHooks): (args: RestrictedMethodOptions<Bip32Entropy>) => Promise<JsonSLIP10Node>;
+export declare function getBip32EntropyImplementation({ getMnemonic, getUnlockPromise, }: GetBip32EntropyMethodHooks): (args: RestrictedMethodOptions<GetBip32EntropyParams>) => Promise<GetBip32EntropyResult>;
 export {};

package/dist/types/restricted/getBip32PublicKey.d.ts

@@ -1,5 +1,6 @@
 import type { PermissionSpecificationBuilder, PermissionValidatorConstraint, RestrictedMethodOptions } from '@metamask/permission-controller';
 import { PermissionType } from '@metamask/permission-controller';
+import type { GetBip32PublicKeyParams, GetBip32PublicKeyResult } from '@metamask/snaps-sdk';
 import type { NonEmptyArray } from '@metamask/utils';
 import type { MethodHooksObject } from '../utils';
 declare const targetName = "snap_getBip32PublicKey";
@@ -18,11 +19,6 @@ export declare type GetBip32PublicKeyMethodHooks = {
 declare type GetBip32PublicKeySpecificationBuilderOptions = {
     methodHooks: GetBip32PublicKeyMethodHooks;
 };
-declare type GetBip32PublicKeyParameters = {
-    path: ['m', ...(`${number}` | `${number}'`)[]];
-    curve: 'secp256k1' | 'ed25519';
-    compressed?: boolean;
-};
 export declare const Bip32PublicKeyArgsStruct: import("superstruct").Struct<{
     path: string[];
     curve: "ed25519" | "secp256k1";
@@ -56,5 +52,5 @@ export declare const getBip32PublicKeyBuilder: Readonly<{
  * @returns The method implementation which returns a public key.
  * @throws If the params are invalid.
  */
-export declare function getBip32PublicKeyImplementation({ getMnemonic, getUnlockPromise, }: GetBip32PublicKeyMethodHooks): (args: RestrictedMethodOptions<GetBip32PublicKeyParameters>) => Promise<string>;
+export declare function getBip32PublicKeyImplementation({ getMnemonic, getUnlockPromise, }: GetBip32PublicKeyMethodHooks): (args: RestrictedMethodOptions<GetBip32PublicKeyParams>) => Promise<GetBip32PublicKeyResult>;
 export {};

package/dist/types/restricted/getBip44Entropy.d.ts

@@ -1,6 +1,6 @@
-import type { JsonBIP44CoinTypeNode } from '@metamask/key-tree';
 import type { PermissionSpecificationBuilder, PermissionValidatorConstraint, RestrictedMethodOptions } from '@metamask/permission-controller';
 import { PermissionType } from '@metamask/permission-controller';
+import type { GetBip44EntropyParams, GetBip44EntropyResult } from '@metamask/snaps-sdk';
 import type { NonEmptyArray } from '@metamask/utils';
 import type { MethodHooksObject } from '../utils';
 declare const targetName = "snap_getBip44Entropy";
@@ -19,9 +19,6 @@ export declare type GetBip44EntropyMethodHooks = {
 declare type GetBip44EntropySpecificationBuilderOptions = {
     methodHooks: GetBip44EntropyMethodHooks;
 };
-export declare type GetBip44EntropyParams = {
-    coinType: number;
-};
 export declare const getBip44EntropyBuilder: Readonly<{
     readonly targetName: "snap_getBip44Entropy";
     readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.RestrictedMethod, GetBip44EntropySpecificationBuilderOptions, {
@@ -45,5 +42,5 @@ export declare const getBip44EntropyBuilder: Readonly<{
  * @returns The method implementation which returns a `BIP44CoinTypeNode`.
  * @throws If the params are invalid.
  */
-export declare function getBip44EntropyImplementation({ getMnemonic, getUnlockPromise, }: GetBip44EntropyMethodHooks): (args: RestrictedMethodOptions<GetBip44EntropyParams>) => Promise<JsonBIP44CoinTypeNode>;
+export declare function getBip44EntropyImplementation({ getMnemonic, getUnlockPromise, }: GetBip44EntropyMethodHooks): (args: RestrictedMethodOptions<GetBip44EntropyParams>) => Promise<GetBip44EntropyResult>;
 export {};

package/dist/types/restricted/getEntropy.d.ts

@@ -1,6 +1,7 @@
 import type { PermissionSpecificationBuilder, RestrictedMethodOptions } from '@metamask/permission-controller';
 import { PermissionType } from '@metamask/permission-controller';
-import type { Hex, NonEmptyArray } from '@metamask/utils';
+import type { GetEntropyParams, GetEntropyResult } from '@metamask/snaps-sdk';
+import type { NonEmptyArray } from '@metamask/utils';
 import type { Infer } from 'superstruct';
 import type { MethodHooksObject } from '../utils';
 declare const targetName = "snap_getEntropy";
@@ -56,5 +57,5 @@ export declare type GetEntropyHooks = {
  * once the extension is unlocked.
  * @returns The method implementation.
  */
-declare function getEntropyImplementation({ getMnemonic, getUnlockPromise, }: GetEntropyHooks): (options: RestrictedMethodOptions<GetEntropyArgs>) => Promise<Hex>;
+declare function getEntropyImplementation({ getMnemonic, getUnlockPromise, }: GetEntropyHooks): (options: RestrictedMethodOptions<GetEntropyParams>) => Promise<GetEntropyResult>;
 export {};

package/dist/types/restricted/getLocale.d.ts

@@ -1,5 +1,6 @@
 import type { PermissionSpecificationBuilder, ValidPermissionSpecification, RestrictedMethodOptions, RestrictedMethodParameters } from '@metamask/permission-controller';
 import { PermissionType } from '@metamask/permission-controller';
+import type { GetLocaleResult } from '@metamask/snaps-sdk';
 import type { NonEmptyArray } from '@metamask/utils';
 import type { MethodHooksObject } from '../utils';
 declare const methodName = "snap_getLocale";
@@ -43,5 +44,5 @@ export declare const getLocaleBuilder: Readonly<{
  * @param hooks.getLocale - A function that returns the user selected locale.
  * @returns The user selected locale.
  */
-export declare function getImplementation({ getLocale }: GetLocaleMethodHooks): (_args: RestrictedMethodOptions<RestrictedMethodParameters>) => Promise<string>;
+export declare function getImplementation({ getLocale }: GetLocaleMethodHooks): (_args: RestrictedMethodOptions<RestrictedMethodParameters>) => Promise<GetLocaleResult>;
 export {};