Merge pull request #185 from MetaMask/fix/profile-sync-unauthorized

Fix profile sync unauthorized issue

Author: mj-kiwi

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

@@ -3,10 +3,14 @@
 
 import type { SnapManifest } from '@metamask/7715-permissions-shared/types';
 
-const kernelSnapId = process.env.KERNEL_SNAP_ID;
+// eslint-disable-next-line import/no-relative-packages
+import packageJson from './package.json' with { type: 'json' };
 
+const kernelSnapId = process.env.KERNEL_SNAP_ID;
+const messageSnapId = process.env.MESSAGE_SIGNING_SNAP_ID;
+const snapEnv = process.env.SNAP_ENV;
 const manifest: SnapManifest = {
-  version: '0.2.1',
+  version: packageJson.version,
   description: 'Grants 7715 permissions from a DeleGator smart account',
   proposedName: 'Gator Permissions',
   repository: {
@@ -41,8 +45,25 @@ const manifest: SnapManifest = {
 
 if (kernelSnapId) {
   manifest.initialConnections = {
-    [kernelSnapId]: {},
+    ...(kernelSnapId ? { [kernelSnapId]: {} } : {}),
+    ...(messageSnapId ? { [messageSnapId]: {} } : {}),
   };
 }
 
+if (snapEnv === 'local') {
+  /**
+   * Grant lifecycle hooks permission in local development environment.
+   *
+   * The lifecycle hooks endowment is required to enable the onInstall handler
+   * which automatically installs the message signing snap during local development.
+   * This ensures that the gator permissions snap can establish the necessary
+   * connection to the message signing snap for 7715 permissions functionality.
+   *
+   * In production environments, the message signing snap is pre-installed by
+   * the MetaMask extension, making this endowment unnecessary and it's excluded
+   * to minimize the snap's permission footprint.
+   */
+  manifest.initialPermissions['endowment:lifecycle-hooks'] = {};
+}
+
 export default manifest;

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

@@ -1,4 +1,5 @@
 /* eslint-disable no-restricted-globals */
+import type { GetSnapsResponse } from '@metamask/7715-permissions-shared/types';
 import { logger } from '@metamask/7715-permissions-shared/utils';
 import {
   AuthType,
@@ -7,14 +8,17 @@ import {
   UserStorage,
 } from '@metamask/profile-sync-controller/sdk';
 import {
-  type Json,
-  type JsonRpcParams,
-  type OnRpcRequestHandler,
-  type OnUserInputHandler,
   MethodNotFoundError,
   InvalidRequestError,
   InternalError,
 } from '@metamask/snaps-sdk';
+import type {
+  OnInstallHandler,
+  Json,
+  JsonRpcParams,
+  OnRpcRequestHandler,
+  OnUserInputHandler,
+} from '@metamask/snaps-sdk';
 
 import { AccountApiClient } from './clients/accountApiClient';
 import { BlockchainTokenMetadataClient } from './clients/blockchainMetadataClient';
@@ -228,3 +232,31 @@ export const onRpcRequest: OnRpcRequestHandler = async ({
  */
 export const onUserInput: OnUserInputHandler =
   userEventDispatcher.createUserInputEventHandler();
+
+export const onInstall: OnInstallHandler = async () => {
+  /**
+   * Local Development Only
+   *
+   * The message signing snap must be installed and the gator permissions snap must
+   * have permission to communicate with the message signing snap, or the request is rejected.
+   *
+   * Since the message signing snap is preinstalled in production, and has
+   * initialConnections configured to automatically connect to the gator snap, this is not needed in production.
+   * The following code will be tree-shaken out in production builds.
+   */
+  // eslint-disable-next-line no-restricted-globals
+  if (snapEnv === 'local' && isStorePermissionsFeatureEnabled) {
+    const installedSnaps = (await snap.request({
+      method: 'wallet_getSnaps',
+    })) as unknown as GetSnapsResponse;
+    if (!installedSnaps[messageSigningSnapId]) {
+      logger.debug('Installing local message signing snap');
+      await snap.request({
+        method: 'wallet_requestSnaps',
+        params: {
+          [messageSigningSnapId]: {},
+        },
+      });
+    }
+  }
+};

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

@@ -1,8 +1,12 @@
+/* eslint-disable @typescript-eslint/naming-convention */
 /* eslint-disable no-restricted-globals */
 import type { SnapManifest } from '@metamask/7715-permissions-shared/types';
 
+// eslint-disable-next-line import/no-relative-packages
+import packageJson from './package.json' with { type: 'json' };
+
 const manifest: SnapManifest = {
-  version: '0.2.0',
+  version: packageJson.version,
   description: 'Manage onchain 7715 permissions',
   proposedName: 'MetaMask Permissions Kernel',
   repository: {

packages/site/src/components/Buttons.tsx

@@ -94,17 +94,6 @@ export const ConnectButton = (
   );
 };
 
-export const InstallButton = (
-  props: ComponentProps<typeof Button> & { $isInstalled?: boolean },
-) => {
-  return (
-    <Button {...props}>
-      <FlaskFox />
-      <ButtonText>{props.$isInstalled ? 'Installed' : 'Install'}</ButtonText>
-    </Button>
-  );
-};
-
 export const CustomMessageButton = (
   props: ComponentProps<typeof Button> & { $text?: string },
 ) => {

packages/site/src/pages/index.tsx

@@ -14,7 +14,6 @@ import * as chains from 'viem/chains';
 
 import {
   ConnectButton,
-  InstallButton,
   InstallFlaskButton,
   CustomMessageButton,
   Card,
@@ -33,11 +32,7 @@ import type {
   NativeTokenPeriodicPermissionRequest,
   ERC20TokenPeriodicPermissionRequest,
 } from '../components/permissions/types';
-import {
-  kernelSnapOrigin,
-  gatorSnapOrigin,
-  messageSigningSnapOrigin,
-} from '../config';
+import { kernelSnapOrigin, gatorSnapOrigin } from '../config';
 import {
   useMetaMask,
   useMetaMaskContext,
@@ -98,7 +93,6 @@ const Index = () => {
   const { isFlask, snapsDetected, installedSnaps, provider } = useMetaMask();
   const requestKernelSnap = useRequestSnap(kernelSnapOrigin);
   const requestPermissionSnap = useRequestSnap(gatorSnapOrigin);
-  const requestMessageSigningSnap = useRequestSnap(messageSigningSnapOrigin);
 
   const { delegateAccount } = useDelegateAccount({ chain: selectedChain });
   const { bundlerClient, getFeePerGas } = useBundlerClient({
@@ -122,9 +116,6 @@ const Index = () => {
 
   const isKernelSnapReady = Boolean(installedSnaps[kernelSnapOrigin]);
   const isGatorSnapReady = Boolean(installedSnaps[gatorSnapOrigin]);
-  const isMessageSigningSnapReady = Boolean(
-    installedSnaps[messageSigningSnapOrigin],
-  );
 
   const chainId = selectedChain.id;
   const [permissionType, setPermissionType] = useState('native-token-stream');
@@ -496,23 +487,6 @@ const Index = () => {
           />
         )}
 
-        <Card
-          content={{
-            title: 'Message Signing Snap',
-            description:
-              'Set up by installing and authorizing the message signing snap.',
-            button: (
-              <InstallButton
-                onClick={requestMessageSigningSnap}
-                disabled={!isMetaMaskReady || isMessageSigningSnapReady}
-                $isInstalled={isMessageSigningSnapReady}
-              />
-            ),
-          }}
-          fullWidth
-          disabled={!isMetaMaskReady}
-        />
-
         <Card
           content={{
             title: `${isKernelSnapReady ? 'Reconnect' : 'Connect'}(kernel)`,