feat(manifest): add environment-based manifest management (#153)

* feat(manifest): add environment-based manifest management

Add scripts to update snap manifests based on SNAP_ENV variable for different environments (local/production). Update build and start scripts to run manifest updates automatically. Add documentation explaining the manifest management system.

Author: mj-kiwi

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

@@ -19,15 +19,15 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [21.x]
+        node-version: [22.x]
     outputs:
       child-workspace-package-names: ${{ steps.workspace-package-names.outputs.child-workspace-package-names }}
     steps:
       - name: Checkout and setup environment
         uses: MetaMask/action-checkout-and-setup@v1
         with:
           is-high-risk-environment: false
-          cache-node-modules: ${{ matrix.node-version == '21.x' }}
+          cache-node-modules: ${{ matrix.node-version == '22.x' }}
       - name: Fetch workspace package names
         id: workspace-package-names
         run: |
@@ -41,7 +41,7 @@ jobs:
       - prepare
     strategy:
       matrix:
-        node-version: [21.x]
+        node-version: [22.x]
     steps:
       - name: Checkout and setup environment
         uses: MetaMask/action-checkout-and-setup@v1
@@ -63,7 +63,7 @@ jobs:
       - prepare
     strategy:
       matrix:
-        node-version: [21.x]
+        node-version: [22.x]
     steps:
       - name: Checkout and setup environment
         uses: MetaMask/action-checkout-and-setup@v1
@@ -82,7 +82,6 @@ jobs:
           key: gator-permissions-${{ runner.os }}-${{ github.sha }}
       - name: Cache manifests
         uses: actions/cache@v4
-        if: ${{ github.base_ref == 'dev' }}
         with:
           path: |
             ./packages/gator-permissions-snap/snap.manifest.json
@@ -91,18 +90,9 @@ jobs:
       - name: Require clean working directory
         shell: bash
         run: |
-          # Check if target branch is 'dev' and exclude snap.manifest.json files if so
-          if [[ "${{ github.base_ref }}" == "dev" || "${{ github.ref_name }}" == "dev" ]]; then
-            echo "Target branch is 'dev', ignoring changes to snap.manifest.json files"
-            if ! git diff --exit-code -- . ':!**/snap.manifest.json'; then
-              echo "Working tree dirty at end of job (excluding snap.manifest.json)"
-              exit 1
-            fi
-          else
-            if ! git diff --exit-code; then
-              echo "Working tree dirty at end of job"
-              exit 1
-            fi
+          if ! git diff --exit-code; then
+            echo "Working tree dirty at end of job"
+            exit 1
           fi
 
   lint:
@@ -112,7 +102,7 @@ jobs:
       - prepare
     strategy:
       matrix:
-        node-version: [21.x]
+        node-version: [22.x]
     steps:
       - name: Checkout and setup environment
         uses: MetaMask/action-checkout-and-setup@v1
@@ -135,7 +125,7 @@ jobs:
       - build
     strategy:
       matrix:
-        node-version: [21.x]
+        node-version: [22.x]
     steps:
       - name: Checkout and setup environment
         uses: MetaMask/action-checkout-and-setup@v1
@@ -153,7 +143,6 @@ jobs:
           key: gator-permissions-${{ runner.os }}-${{ github.sha }}
       - name: Restore manifests
         uses: actions/cache@v4
-        if: ${{ github.base_ref == 'dev' }}
         with:
           path: |
             ./packages/gator-permissions-snap/snap.manifest.json
@@ -164,16 +153,7 @@ jobs:
       - name: Require clean working directory
         shell: bash
         run: |
-          # Check if target branch is 'dev' and exclude snap.manifest.json files if so
-          if [[ "${{ github.base_ref }}" == "dev" || "${{ github.ref_name }}" == "dev" ]]; then
-            echo "Target branch is 'dev', ignoring changes to snap.manifest.json files"
-            if ! git diff --exit-code -- . ':!**/snap.manifest.json'; then
-              echo "Working tree dirty at end of job (excluding snap.manifest.json)"
-              exit 1
-            fi
-          else
-            if ! git diff --exit-code; then
-              echo "Working tree dirty at end of job"
-              exit 1
-            fi
+          if ! git diff --exit-code; then
+            echo "Working tree dirty at end of job"
+            exit 1
           fi

.gitignore

@@ -78,3 +78,6 @@ node_modules/
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+# Generated manifest files
+packages/*/snap.manifest.json

.nvmrc

@@ -1 +1 @@
-v22.17.0
+v22.19.0

docs/manifest-management.md

@@ -0,0 +1,81 @@
+# Manifest Management Guide
+
+The 7715 permissions snaps use environment-based manifest configuration via `SNAP_ENV`.
+
+## Quick Start
+
+### Local Development
+```bash
+# Build or start with development environment
+SNAP_ENV=local yarn start
+```
+
+### Production Build
+```bash
+# Default is production
+yarn build
+
+# Or explicit
+SNAP_ENV=production yarn build
+```
+
+## Configuration
+
+| Environment | Gator Snap | Kernel Snap |
+|------------|------------|-------------|
+| `local`/`development` | Adds localhost:8081 | Adds localhost:8082 + gator snap |
+| `production` (default) | Only kernel snap connection | No connections |
+
+
+## How It Works
+
+1. Each snap has a `snap.manifest.ts` file that defines the manifest using the `defineSnapManifest` helper
+2. The shared `generate-snap-manifest` command (provided by `@metamask/7715-permissions-shared`) compiles and executes the TypeScript file to generate `snap.manifest.json`
+3. The build/start commands automatically run this generation command
+
+## Available Commands
+
+### From individual snap packages:
+```bash
+# Generate manifest for current package
+yarn generate-snap-manifest .
+
+# Build with manifest generation
+yarn build
+
+# Start with manifest generation
+yarn start
+```
+
+## File Structure
+
+```
+packages/
+├── shared/
+│   └── src/
+│       └── scripts/
+│           └── generate-manifest.ts  # Shared manifest generation script
+├── gator-permissions-snap/
+│   ├── snap.manifest.ts              # TypeScript manifest definition (source of truth)
+│   └── snap.manifest.json           # Generated from .ts file (git ignored)
+└── permissions-kernel-snap/
+    ├── snap.manifest.ts              # TypeScript manifest definition (source of truth)
+    └── snap.manifest.json           # Generated from .ts file (git ignored)
+```
+
+## Environment Variables
+
+- `SNAP_ENV` - Controls which manifest template to use
+  - `local` or `development` - Uses dev manifest
+  - `production` (default) - Uses production manifest
+  - Any other value - Falls back to production
+
+## CI/CD Example
+
+```yaml
+- name: Build for production
+  env:
+    SNAP_ENV: production
+  run: yarn build
+```
+

packages/gator-permissions-snap/docs/architecture.md

@@ -51,7 +51,6 @@ This document outlines the architecture of the Permissions Provider Snap system
 
 ### UI Components
 
-- **HomePage**: Component that builds the snap's homepage, showing feature introduction, as well as granted permissions. This is only part of the pre-production feature, as the snap will be pre-installed in which case the homepage is not accessible.
 - **ConfirmationDialogFactory**: Creates confirmation dialogs for permission requests.
 - **ConfirmationDialog**: Manages the lifecycle and user interaction of confirmation dialogs.
 
@@ -80,7 +79,6 @@ src/
 ├── services/                  # Business logic services (token prices, metadata)
 ├── clients/                   # External API clients (Account API, Price API, blockchain)
 ├── profileSync/               # Cross-device permission storage synchronization
-├── homepage/                  # Snap homepage UI component
 ├── ui/                        # Reusable UI components and utilities
 ├── utils/                     # Static utility functions
 └── permissions/               # Permission-specific implementations
@@ -103,8 +101,6 @@ src/
 
 - **`profileSync/`**: Manages encrypted storage and synchronization of granted permissions across devices using MetaMask's profile sync infrastructure.
 
-- **`homepage/`**: Class-based component that builds the snap's homepage interface, displaying account information and granted permissions.
-
 - **`ui/`**: Reusable UI components and utilities used across different permission types and dialogs.
 
 - **`utils/`**: Static utility functions for common operations like address formatting, validation, time handling, and value conversion.
@@ -201,7 +197,7 @@ The EntryPoint serves as the main initialization and configuration point for the
    - Core services (TokenMetadataService, TokenPricesService, AccountController)
    - State management (StateManager for snap persistence)
    - Profile sync (ProfileSyncManager for cross-device permission sync)
-   - UI components (HomePage, ConfirmationDialogFactory, UserEventDispatcher)
+   - UI components (ConfirmationDialogFactory, UserEventDispatcher)
    - Permission handling (PermissionHandlerFactory, PermissionRequestLifecycleOrchestrator)
    - RPC handling (createRpcHandler for processing requests)
 
@@ -212,8 +208,7 @@ The EntryPoint serves as the main initialization and configuration point for the
 3. Handling lifecycle events:
    - `onRpcRequest`: Processes incoming JSON-RPC requests with origin validation
    - `onUserInput`: Handles user input events via UserEventDispatcher
-   - `onHomePage`: Returns the snap's homepage content
-   - `onInstall`: Shows welcome screen and handles local development setup
+   - `onInstall`: Handles local development setup
 
 4. Managing dependencies and configuration:
    - Uses dependency injection to create and wire up components

packages/gator-permissions-snap/package.json

@@ -26,7 +26,7 @@
   ],
   "scripts": {
     "allow-scripts": "yarn workspace root allow-scripts",
-    "build": "mm-snap build && yarn build:preinstalled-snap",
+    "build": "yarn generate-snap-manifest . && mm-snap build && yarn build:preinstalled-snap",
     "build:clean": "yarn clean && yarn build",
     "build:pack": "yarn build:clean && yarn pack --filename ../../deps/snap-b-0.1.0.tgz",
     "build:preinstalled-snap": "node scripts/build-preinstalled-snap.js",
@@ -43,7 +43,7 @@
     "lint:misc": "prettier '**/*.json' '**/*.md' '**/*.yml' '!.yarnrc.yml' --ignore-path .gitignore --no-error-on-unmatched-pattern",
     "prepublishOnly": "mm-snap manifest",
     "serve": "mm-snap serve",
-    "start": "mm-snap watch",
+    "start": "yarn generate-snap-manifest . && mm-snap watch",
     "test": "TZ=UTC jest"
   },
   "dependencies": {

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

@@ -0,0 +1,49 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+/* eslint-disable no-restricted-globals */
+
+import type { SnapManifest } from '@metamask/7715-permissions-shared/types';
+
+const kernelSnapId = process.env.KERNEL_SNAP_ID;
+
+const manifest: SnapManifest = {
+  version: '0.2.1',
+  description: 'Grants 7715 permissions from a DeleGator smart account',
+  proposedName: 'Gator Permissions',
+  repository: {
+    type: 'git',
+    url: 'https://github.com/MetaMask/snap-7715-permissions.git',
+  },
+  source: {
+    shasum: 'tQRss8KLZ2+OlG2QQyH81XYBcTLsWUzYXf/Xy0cHZsk=',
+    location: {
+      npm: {
+        filePath: 'dist/bundle.js',
+        iconPath: 'images/icon.svg',
+        packageName: '@metamask/gator-permissions-snap',
+        registry: 'https://registry.npmjs.org/',
+      },
+    },
+  },
+  initialPermissions: {
+    'endowment:rpc': {
+      dapps: false,
+      snaps: true,
+    },
+    snap_manageState: {},
+    'endowment:ethereum-provider': {},
+    'endowment:network-access': {},
+    snap_dialog: {},
+    'endowment:lifecycle-hooks': {},
+    snap_getPreferences: {},
+  },
+  platformVersion: '8.1.0',
+  manifestVersion: '0.1',
+};
+
+if (kernelSnapId) {
+  manifest.initialConnections = {
+    [kernelSnapId]: {},
+  };
+}
+
+export default manifest;