Remove development constants from production artifacts (#148)

* move constants to env

* snap manifest

* update github workflow with new env

Author: MoMannn

.github/workflows/build-lint-test.yml

@@ -9,6 +9,9 @@ env:
   STORE_PERMISSIONS_ENABLED: ${{ vars.STORE_PERMISSIONS_ENABLED }}
   ACCOUNT_API_BASE_URL: ${{ vars.ACCOUNT_API_BASE_URL }}
   SUPPORTED_CHAINS: ${{ vars.SUPPORTED_CHAINS }}
+  GATOR_PERMISSIONS_PROVIDER_SNAP_ID: ${{ vars.GATOR_PERMISSIONS_PROVIDER_SNAP_ID }}
+  MESSAGE_SIGNING_SNAP_ID: ${{ vars.MESSAGE_SIGNING_SNAP_ID }}
+  KERNEL_SNAP_ID: ${{ vars.KERNEL_SNAP_ID }}
 
 jobs:
   prepare:

.github/workflows/publish-release.yml

@@ -19,6 +19,9 @@ jobs:
       PRICE_API_BASE_URL: ${{ vars.PRICE_API_BASE_URL }}
       STORE_PERMISSIONS_ENABLED: ${{ vars.STORE_PERMISSIONS_ENABLED }}
       SUPPORTED_CHAINS: ${{ vars.SUPPORTED_CHAINS }}
+      GATOR_PERMISSIONS_PROVIDER_SNAP_ID: ${{ vars.GATOR_PERMISSIONS_PROVIDER_SNAP_ID }}
+      MESSAGE_SIGNING_SNAP_ID: ${{ vars.MESSAGE_SIGNING_SNAP_ID }}
+      KERNEL_SNAP_ID: ${{ vars.KERNEL_SNAP_ID }}
     steps:
       - name: Checkout and setup environment
         uses: MetaMask/action-checkout-and-setup@v1

packages/gator-permissions-snap/.env.example

@@ -12,8 +12,15 @@ STORE_PERMISSIONS_ENABLED=false
 # Set `SUPPORTED_CHAINS` to comma separated values to support multiple chains.
 SUPPORTED_CHAINS=11155111
 
+# Snap Ids
+KERNEL_SNAP_ID=local:http://localhost:8081
+MESSAGE_SIGNING_SNAP_ID=local:http://localhost:8080
+
+
 # Prod
 SNAP_ENV=production
 STORE_PERMISSIONS_ENABLED=false
 PRICE_API_BASE_URL=https://price.api.cx.metamask.io
-ACCOUNT_API_BASE_URL=https://account.api.cx.metamask.io
+ACCOUNT_API_BASE_URL=https://account.api.cx.metamask.io
+KERNEL_SNAP_ID=npm:@metamask/permissions-kernel-snap
+MESSAGE_SIGNING_SNAP_ID=npm:@metamask/message-signing-snap

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

@@ -12,12 +12,26 @@ const {
   STORE_PERMISSIONS_ENABLED,
   ACCOUNT_API_BASE_URL,
   SUPPORTED_CHAINS,
+  KERNEL_SNAP_ID,
+  MESSAGE_SIGNING_SNAP_ID,
 } = process.env;
 
 if (!SNAP_ENV) {
   throw new InternalError('SNAP_ENV must be set as an environment variable.');
 }
 
+if (!KERNEL_SNAP_ID) {
+  throw new InternalError(
+    'KERNEL_SNAP_ID must be set as an environment variable.',
+  );
+}
+
+if (!MESSAGE_SIGNING_SNAP_ID) {
+  throw new InternalError(
+    'MESSAGE_SIGNING_SNAP_ID must be set as an environment variable.',
+  );
+}
+
 if (!PRICE_API_BASE_URL) {
   throw new InternalError(
     'PRICE_API_BASE_URL must be set as an environment variable.',
@@ -66,6 +80,8 @@ const config: SnapConfig = {
     STORE_PERMISSIONS_ENABLED,
     ACCOUNT_API_BASE_URL,
     SUPPORTED_CHAINS,
+    KERNEL_SNAP_ID,
+    MESSAGE_SIGNING_SNAP_ID,
   },
 };
 

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

@@ -1,5 +1,4 @@
 /* eslint-disable no-restricted-globals */
-import { MESSAGE_SIGNING_SNAP_ID } from '@metamask/7715-permissions-shared/constants';
 import type { GetSnapsResponse } from '@metamask/7715-permissions-shared/types';
 import { logger } from '@metamask/7715-permissions-shared/utils';
 import {
@@ -64,6 +63,11 @@ if (!supportedChainsString) {
   throw new InternalError('SUPPORTED_CHAINS is not set');
 }
 
+const messageSigningSnapId = process.env.MESSAGE_SIGNING_SNAP_ID;
+if (!messageSigningSnapId) {
+  throw new InternalError('MESSAGE_SIGNING_SNAP_ID is not set');
+}
+
 const supportedChains = supportedChainsString.split(',').map(Number);
 
 // set up dependencies
@@ -99,7 +103,7 @@ const stateManager = createStateManager(snap);
 const profileSyncOptions = createProfileSyncOptions(
   stateManager,
   snap,
-  MESSAGE_SIGNING_SNAP_ID,
+  messageSigningSnapId,
 );
 
 const profileSyncSdkEnv = getProfileSyncSdkEnv(snapEnv);
@@ -247,12 +251,12 @@ export const onInstall: OnInstallHandler = async () => {
     const installedSnaps = (await snap.request({
       method: 'wallet_getSnaps',
     })) as unknown as GetSnapsResponse;
-    if (!installedSnaps[MESSAGE_SIGNING_SNAP_ID]) {
+    if (!installedSnaps[messageSigningSnapId]) {
       logger.debug('Installing local message signing snap');
       await snap.request({
         method: 'wallet_requestSnaps',
         params: {
-          [MESSAGE_SIGNING_SNAP_ID]: {},
+          [messageSigningSnapId]: {},
         },
       });
     }

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

@@ -1,12 +1,14 @@
-import { KERNEL_SNAP_ID } from '@metamask/7715-permissions-shared/constants';
-
 import { RpcMethod } from './rpcMethod';
 
 const allowedPermissionsByOrigin: { [origin: string]: string[] } = {
-  [KERNEL_SNAP_ID]: [
-    RpcMethod.PermissionProviderGrantPermissions,
-    RpcMethod.PermissionProviderGetPermissionOffers,
-  ],
+  // eslint-disable-next-line no-restricted-globals
+  ...(process.env.KERNEL_SNAP_ID && {
+    // eslint-disable-next-line no-restricted-globals
+    [process.env.KERNEL_SNAP_ID]: [
+      RpcMethod.PermissionProviderGrantPermissions,
+      RpcMethod.PermissionProviderGetPermissionOffers,
+    ],
+  }),
   metamask: [RpcMethod.PermissionProviderGetGrantedPermissions],
 };
 

packages/permissions-kernel-snap/.env.example

@@ -1,8 +1,11 @@
 # Local dev
 
-# The snap uses `SNAP_ENV` to dynamically map permission provider snapId to registered offers in the `PermissionOfferRegistry`. Please make use `SNAP_ENV=local` before building the snap.
+# Env
 SNAP_ENV=local
+# Permissions snap id
+GATOR_PERMISSIONS_PROVIDER_SNAP_ID=local:http://localhost:8082
 
 
 # Prod
-SNAP_ENV=production
+SNAP_ENV=production
+GATOR_PERMISSIONS_PROVIDER_SNAP_ID=npm:@metamask/gator-permissions-snap

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

@@ -6,10 +6,18 @@ import { resolve } from 'path';
 dotenv.config();
 
 // eslint-disable-next-line n/no-process-env
-if (!process.env.SNAP_ENV) {
+const { SNAP_ENV, GATOR_PERMISSIONS_PROVIDER_SNAP_ID } = process.env;
+
+if (!SNAP_ENV) {
   throw new InternalError('SNAP_ENV must be set as an environment variable.');
 }
 
+if (!GATOR_PERMISSIONS_PROVIDER_SNAP_ID) {
+  throw new InternalError(
+    'GATOR_PERMISSIONS_PROVIDER_SNAP_ID must be set as an environment variable.',
+  );
+}
+
 const config: SnapConfig = {
   input: resolve(__dirname, 'src/index.ts'),
   server: {
@@ -20,8 +28,8 @@ const config: SnapConfig = {
     crypto: true,
   },
   environment: {
-    // eslint-disable-next-line n/no-process-env
-    SNAP_ENV: process.env.SNAP_ENV,
+    SNAP_ENV,
+    GATOR_PERMISSIONS_PROVIDER_SNAP_ID,
   },
 };
 

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

@@ -1,6 +1,6 @@
-import { GATOR_PERMISSIONS_PROVIDER_SNAP_ID } from '@metamask/7715-permissions-shared/constants';
 import { logger } from '@metamask/7715-permissions-shared/utils';
 import {
+  InternalError,
   InvalidInputError,
   type Json,
   type SnapsProvider,
@@ -62,10 +62,20 @@ export function createRpcHandler(config: {
       options.params,
     );
 
+    const gatorPermissionsProviderSnapId =
+      // eslint-disable-next-line no-restricted-globals
+      process.env.GATOR_PERMISSIONS_PROVIDER_SNAP_ID;
+
+    if (!gatorPermissionsProviderSnapId) {
+      throw new InternalError(
+        'GATOR_PERMISSIONS_PROVIDER_SNAP_ID must be set as an environment variable.',
+      );
+    }
+
     // We only want gator-permissions-snap for now but we will use more snaps in the future
     const permissionOfferRegistry =
       await permissionOfferRegistryManager.buildPermissionOffersRegistry(
-        GATOR_PERMISSIONS_PROVIDER_SNAP_ID,
+        gatorPermissionsProviderSnapId,
       );
 
     // Find the relevant permissions to grant by filtering against the registered offers
@@ -85,7 +95,7 @@ export function createRpcHandler(config: {
     const grantedPermissions = await snapsProvider.request({
       method: 'wallet_invokeSnap',
       params: {
-        snapId: GATOR_PERMISSIONS_PROVIDER_SNAP_ID, // We only want gator-permissions-snap for now but we will use more snaps in the future
+        snapId: gatorPermissionsProviderSnapId, // We only want gator-permissions-snap for now but we will use more snaps in the future
         request: {
           method: ExternalMethod.PermissionProviderGrantPermissions,
           params: {

packages/permissions-kernel-snap/test/registryManager.test.ts

@@ -1,4 +1,3 @@
-import { GATOR_PERMISSIONS_PROVIDER_SNAP_ID } from '@metamask/7715-permissions-shared/constants';
 import { createMockSnapsProvider } from '@metamask/7715-permissions-shared/testing';
 import type { PermissionsRequest } from '@metamask/7715-permissions-shared/types';
 import { logger } from '@metamask/7715-permissions-shared/utils';
@@ -12,7 +11,10 @@ import { ExternalMethod } from '../src/rpc/rpcMethod';
 describe('PermissionOfferRegistryManager', () => {
   let permissionOfferRegistryManager: PermissionOfferRegistryManager;
   const mockSnapsProvider = createMockSnapsProvider();
-  const mockSnapId = GATOR_PERMISSIONS_PROVIDER_SNAP_ID;
+  const mockSnapId =
+    // eslint-disable-next-line no-restricted-globals
+    process.env.GATOR_PERMISSIONS_PROVIDER_SNAP_ID ??
+    'local:http://localhost:8082';
 
   beforeEach(() => {
     mockSnapsProvider.request.mockReset();