Decouple default permission offer from kernel snap

Author: V00D00-child

packages/gator-permissions-snap/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-7715-permissions.git"
   },
   "source": {
-    "shasum": "B/45l1lyLyqYX2GkYxvKAmCCWOCSu030Do+IEMdQV+c=",
+    "shasum": "rBYfwKftRHT6Ubb97mXlM4mpyS5QuNDEiRnoo7jUpAo=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/gator-permissions-snap/src/index.ts

@@ -137,6 +137,8 @@ const boundRpcHandlers: {
 } = {
   [RpcMethod.PermissionProviderGrantAttenuatedPermissions]:
     rpcHandler.grantPermission.bind(rpcHandler),
+  [RpcMethod.PermissionProviderGetPermissionOffers]:
+    rpcHandler.getPermissionOffers.bind(rpcHandler),
 };
 
 /**

…ed/src/utils/snap-permission-registry.ts …nap/src/permissions/permission-offers.tspackages/shared/src/utils/snap-permission-registry.ts renamed to packages/gator-permissions-snap/src/permissions/permission-offers.ts packages/shared/src/utils/snap-permission-registry.ts renamed to packages/gator-permissions-snap/src/permissions/permission-offers.ts

@@ -1,9 +1,20 @@
-import type { GatorPermission } from '../types';
+import { zTypeDescriptor } from '@metamask/7715-permissions-shared/types';
+import { z } from 'zod';
+
+export const zGatorPermission = z.object({
+  // A type used for matching requests:
+  type: zTypeDescriptor,
+
+  // Used to represent the permission to the user:
+  proposedName: z.string(),
+});
+
+export type GatorPermission = z.infer<typeof zGatorPermission>;
 
 /**
  * The default permission offers that the Gator snap will offer to the kernel snap
  */
-export const DEFAULT_OFFERS: GatorPermission[] = [
+export const DEFAULT_GATOR_PERMISSION_TO_OFFER: GatorPermission[] = [
   {
     type: 'native-token-stream',
     proposedName: 'Native Token Stream',

packages/gator-permissions-snap/src/rpc/permissions.ts

@@ -3,7 +3,10 @@ import { KERNEL_SNAP_ID } from '@metamask/7715-permissions-shared/constants';
 import { RpcMethod } from './rpcMethod';
 
 const allowedPermissionsByOrigin: { [origin: string]: string[] } = {
-  [KERNEL_SNAP_ID]: [RpcMethod.PermissionProviderGrantAttenuatedPermissions],
+  [KERNEL_SNAP_ID]: [
+    RpcMethod.PermissionProviderGrantAttenuatedPermissions,
+    RpcMethod.PermissionProviderGetPermissionOffers,
+  ],
 };
 
 /**

packages/gator-permissions-snap/src/rpc/rpcHandler.ts

@@ -1,7 +1,12 @@
+import type { PermissionOffer } from '@metamask/7715-permissions-shared/types';
 import { logger } from '@metamask/7715-permissions-shared/utils';
 import type { Json } from '@metamask/snaps-sdk';
 
 import type { PermissionHandlerFactory } from '../core/permissionHandlerFactory';
+import {
+  DEFAULT_GATOR_PERMISSION_TO_OFFER,
+  getIdFor,
+} from '../permissions/permission-offers';
 import type { ProfileSyncManager } from '../profileSync';
 import { validatePermissionRequestParam } from '../utils/validate';
 
@@ -16,6 +21,13 @@ export type RpcHandler = {
    * @returns The result of the grant permission request.
    */
   grantPermission(params?: Json): Promise<Json>;
+
+  /**
+   * Handles get permission offers requests.
+   *
+   * @returns The permission offers.
+   */
+  getPermissionOffers(): Promise<Json>;
 };
 
 /**
@@ -69,7 +81,28 @@ export function createRpcHandler(config: {
     return responses as Json[];
   };
 
+  /**
+   * Handles get permission offers requests.
+   *
+   * @returns The permission offers.
+   */
+  const getPermissionOffers = async (): Promise<Json> => {
+    logger.debug('getPermissionOffers()');
+    const gatorSnapDefaultsOffers = await Promise.all(
+      DEFAULT_GATOR_PERMISSION_TO_OFFER.map(async (per) => {
+        const id = await getIdFor(per);
+        return {
+          type: per.type,
+          id,
+          proposedName: per.proposedName,
+        } as PermissionOffer;
+      }),
+    );
+    return gatorSnapDefaultsOffers;
+  };
+
   return {
     grantPermission,
+    getPermissionOffers,
   };
 }

packages/gator-permissions-snap/src/rpc/rpcMethod.ts

@@ -3,14 +3,9 @@
 */
 export enum RpcMethod {
   /**
-   * This method is used by snaps to offer its cryptographic abilities as permissions to kernel.
+   * This method is used by the kernel to request a permissions provider to get its permission offers.
    */
-  WalletOfferOnchainPermission = 'wallet_offerOnchainPermission',
-
-  /**
-   * This method is used by permissions provider to request the kernel to get the registered onchain permission offers.
-   */
-  WalletGetRegisteredOnchainPermissionOffers = 'wallet_getRegisteredOnchainPermissionOffers',
+  PermissionProviderGetPermissionOffers = 'permissionProvider_getPermissionOffers',
 
   /**
    * This method is used by the kernel to request a permissions provider to grant attenuated permissions to a site.

packages/permissions-kernel-snap/snap.config.ts

@@ -11,7 +11,7 @@ if (!process.env.SNAP_ENV) {
 
 const config: SnapConfig = {
   bundler: 'webpack',
-  input: resolve(__dirname, 'src/index.tsx'),
+  input: resolve(__dirname, 'src/index.ts'),
   server: {
     port: 8081,
   },

packages/permissions-kernel-snap/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-7715-permissions.git"
   },
   "source": {
-    "shasum": "VvmzRf0CQohjyCGxQipja9d4Ghoq1q9w5kAJryTTw/8=",
+    "shasum": "HdcS9CdcQhLxR01pW6ReMNEspjGyKj15XtUzagTt+Us=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/permissions-kernel-snap/src/index.ts

@@ -0,0 +1,73 @@
+import { logger } from '@metamask/7715-permissions-shared/utils';
+import type {
+  Json,
+  JsonRpcParams,
+  OnHomePageHandler,
+} from '@metamask/snaps-sdk';
+import { type OnRpcRequestHandler } from '@metamask/snaps-sdk';
+
+import { createRegistry } from './registry';
+import { createRpcHandler } from './rpc/rpcHandler';
+import { RpcMethod } from './rpc/rpcMethod';
+import { createStateManager } from './stateManagement';
+import { HomePageContent } from './ui';
+
+// set up dependencies
+const stateManager = createStateManager();
+const registry = createRegistry(snap);
+
+const rpcHandler = createRpcHandler({
+  stateManager,
+  registry,
+  snapsProvider: snap,
+});
+
+// configure RPC methods bindings
+const boundRpcHandlers: {
+  [RpcMethod: string]: (
+    siteOrigin: string,
+    params?: JsonRpcParams,
+  ) => Promise<Json>;
+} = {
+  [RpcMethod.WalletGrantPermissions]:
+    rpcHandler.grantPermissions.bind(rpcHandler),
+};
+
+/**
+ * Handle incoming JSON-RPC requests, sent through `wallet_invokeSnap`.
+ *
+ * @param args - The request handler args as object.
+ * @param args.origin - The origin of the request, e.g., the website that
+ * invoked the snap.
+ * @param args.request - A validated JSON-RPC request object.
+ * @returns The result of `snap_dialog`.
+ * @throws If the request method is not valid for this snap.
+ */
+export const onRpcRequest: OnRpcRequestHandler = async ({
+  origin,
+  request,
+}) => {
+  logger.info(
+    `Custom request (origin="${origin}"):`,
+    JSON.stringify(request, undefined, 2),
+  );
+
+  const handler = boundRpcHandlers[request.method];
+
+  if (!handler) {
+    throw new Error(`Method ${request.method} not found.`);
+  }
+
+  const result = await handler(origin, request.params);
+
+  return result;
+};
+
+/**
+ * Handle the onHomePage event.
+ * @returns The content to display on the home page.
+ */
+export const onHomePage: OnHomePageHandler = async () => {
+  const { permissionOfferRegistry } = await stateManager.getState();
+  return HomePageContent(permissionOfferRegistry);
+};