chore: Bump Snaps packages (#37971)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

This bumps Snaps packages to the latest version. Notable changes
include:

- Ensure the user has onboarded before allowing usage of Snaps.
- Use a mutex for `snap_setState` operations
- Support specified `clientVersions` in the registry

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/37971?quickstart=1)

## **Changelog**

<!--
If this PR is not End-User-Facing and should not show up in the
CHANGELOG, you can choose to either:
1. Write `CHANGELOG entry: null`
2. Label with `no-changelog`

If this PR is End-User-Facing, please write a short User-Facing
description in the past tense like:
`CHANGELOG entry: Added a new tab for users to see their NFTs`
`CHANGELOG entry: Fixed a bug that was causing some NFTs to flicker`

(This helps the Release Engineer do their job more quickly and
accurately)
-->

CHANGELOG entry: Fixed a rare issue where Snaps updating state rapidly
would lose data

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Bumps Snaps packages, requires onboarding completion before Snap
operations, and passes extension client version to the Snaps registry;
updates messengers, tests, and LavaMoat policy.
> 
> - **Snaps Init**:
> - Add `OnboardingController:getState` and subscribe to
`OnboardingController:stateChange` in `SnapControllerInit` messenger.
>   - Implement and pass `ensureOnboardingComplete` to `SnapController`.
> - **Snaps Registry**:
> - Provide `clientConfig` with `{ type: 'extension', version }`,
parsing `METAMASK_VERSION` to strip prerelease tags.
> - **Dependencies/Policies**:
> - Bump `@metamask/snaps-controllers` to `^17.0.0` and
`@metamask/snaps-rpc-methods` to `^14.1.1` (lockfile updates incl.
`@metamask/snaps-registry@^3.3.0`).
> - Update LavaMoat policies to allow
`@metamask/eth-qr-keyring>async-mutex` under
`@metamask/snaps-rpc-methods`.
> - **Tests**:
> - Update tests to assert `ensureOnboardingComplete` wiring and
`clientConfig.version` behavior.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
62f9d5b. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: MetaMask Bot <[email protected]>

Author: FrederikBolding

app/scripts/controller-init/messengers/snaps/snap-controller-messenger.ts

@@ -44,6 +44,10 @@ import { NetworkControllerGetNetworkClientByIdAction } from '@metamask/network-c
 import { PreferencesControllerGetStateAction } from '../../../controllers/preferences-controller';
 import { MetaMetricsControllerTrackEventAction } from '../../../controllers/metametrics-controller';
 import { RootMessenger } from '../../../lib/messenger';
+import {
+  OnboardingControllerGetStateAction,
+  OnboardingControllerStateChangeEvent,
+} from '../../../controllers/onboarding';
 
 type Actions =
   | GetEndowments
@@ -148,9 +152,13 @@ type InitActions =
   | KeyringControllerGetKeyringsByTypeAction
   | PreferencesControllerGetStateAction
   | MetaMetricsControllerTrackEventAction
-  | SetClientActive;
+  | SetClientActive
+  | OnboardingControllerGetStateAction;
 
-type InitEvents = KeyringControllerUnlockEvent | KeyringControllerLockEvent;
+type InitEvents =
+  | KeyringControllerUnlockEvent
+  | KeyringControllerLockEvent
+  | OnboardingControllerStateChangeEvent;
 
 export type SnapControllerInitMessenger = ReturnType<
   typeof getSnapControllerInitMessenger
@@ -182,8 +190,13 @@ export function getSnapControllerInitMessenger(
       'PreferencesController:getState',
       'MetaMetricsController:trackEvent',
       'SnapController:setClientActive',
+      'OnboardingController:getState',
+    ],
+    events: [
+      'KeyringController:lock',
+      'KeyringController:unlock',
+      'OnboardingController:stateChange',
     ],
-    events: ['KeyringController:lock', 'KeyringController:unlock'],
   });
   return controllerInitMessenger;
 }

app/scripts/controller-init/snaps/snap-controller-init.test.ts

@@ -68,6 +68,7 @@ describe('SnapControllerInit', () => {
       getMnemonicSeed: expect.any(Function),
       preinstalledSnaps: expect.any(Array),
       trackEvent: expect.any(Function),
+      ensureOnboardingComplete: expect.any(Function),
     });
   });
 

app/scripts/controller-init/snaps/snap-controller-init.ts

@@ -1,5 +1,5 @@
 import { SnapController } from '@metamask/snaps-controllers';
-import { hasProperty, Json } from '@metamask/utils';
+import { createDeferredPromise, hasProperty, Json } from '@metamask/utils';
 import { ControllerInitFunction } from '../types';
 import {
   EndowmentPermissions,
@@ -13,6 +13,7 @@ import {
   SnapControllerMessenger,
 } from '../messengers/snaps';
 import { getBooleanFlag } from '../../lib/util';
+import { OnboardingControllerState } from '../../controllers/onboarding';
 
 // Copied from `@metamask/snaps-controllers`, since it is not exported.
 type TrackingEventPayload = {
@@ -93,6 +94,34 @@ export const SnapControllerInit: ControllerInitFunction<
     };
   }
 
+  /**
+   * Async function that resolves when onboarding has been completed.
+   *
+   * @returns A promise that resolves when onboarding is complete.
+   */
+  async function ensureOnboardingComplete() {
+    const { completedOnboarding } = initMessenger.call(
+      'OnboardingController:getState',
+    );
+
+    if (completedOnboarding) {
+      return;
+    }
+
+    const { promise, resolve } = createDeferredPromise();
+
+    const listener = (state: OnboardingControllerState) => {
+      if (state.completedOnboarding) {
+        resolve();
+        initMessenger.unsubscribe('OnboardingController:stateChange', listener);
+      }
+    };
+
+    initMessenger.subscribe('OnboardingController:stateChange', listener);
+
+    await promise;
+  }
+
   const controller = new SnapController({
     environmentEndowmentPermissions: Object.values(EndowmentPermissions),
     excludedPermissions: {
@@ -131,6 +160,8 @@ export const SnapControllerInit: ControllerInitFunction<
     preinstalledSnaps,
     getFeatureFlags,
 
+    ensureOnboardingComplete,
+
     // `TrackEventHook` from `snaps-controllers` uses `Json | undefined` for
     // properties, but `MetaMetricsEventPayload` uses `Json`, even though
     // `undefined` is supported.

app/scripts/controller-init/snaps/snaps-registry-init.test.ts

@@ -25,6 +25,15 @@ function getInitRequestMock(): jest.Mocked<
 }
 
 describe('SnapsRegistryInit', () => {
+  const metamaskVersion = process.env.METAMASK_VERSION;
+  beforeAll(() => {
+    process.env.METAMASK_VERSION = '13.9.0-flask.0';
+  });
+
+  afterAll(() => {
+    process.env.METAMASK_VERSION = metamaskVersion;
+  });
+
   it('initializes the controller', () => {
     const { controller } = SnapsRegistryInit(getInitRequestMock());
     expect(controller).toBeInstanceOf(JsonSnapsRegistry);
@@ -38,6 +47,10 @@ describe('SnapsRegistryInit', () => {
       messenger: expect.any(Object),
       state: undefined,
       refetchOnAllowlistMiss: false,
+      clientConfig: {
+        type: 'extension',
+        version: '13.9.0',
+      },
     });
   });
 });

app/scripts/controller-init/snaps/snaps-registry-init.ts

@@ -1,4 +1,6 @@
 import { JsonSnapsRegistry } from '@metamask/snaps-controllers';
+import { SemVerVersion } from '@metamask/utils';
+import { parse } from 'semver';
 import { ControllerInitFunction } from '../types';
 import { SnapsRegistryMessenger } from '../messengers/snaps';
 import { getBooleanFlag } from '../../lib/util';
@@ -17,13 +19,26 @@ export const SnapsRegistryInit: ControllerInitFunction<
 > = ({ controllerMessenger, persistedState }) => {
   const requireAllowlist = getBooleanFlag(process.env.REQUIRE_SNAPS_ALLOWLIST);
 
+  const originalVersion = process.env.METAMASK_VERSION;
+  const parsedVersion = parse(originalVersion);
+  // Strip prerelease versions as they just indicate build types.
+  const version = (
+    parsedVersion
+      ? `${parsedVersion.major}.${parsedVersion.minor}.${parsedVersion.patch}`
+      : originalVersion
+  ) as SemVerVersion;
+
   const controller = new JsonSnapsRegistry({
     // @ts-expect-error: `persistedState.SnapsRegistry` is not compatible
     // with the expected type.
     // TODO: Look into the type mismatch.
     state: persistedState.SnapsRegistry,
     messenger: controllerMessenger,
     refetchOnAllowlistMiss: requireAllowlist,
+    clientConfig: {
+      type: 'extension',
+      version,
+    },
   });
 
   return {

lavamoat/browserify/beta/policy.json

@@ -1957,7 +1957,8 @@
         "@metamask/snaps-utils": true,
         "@metamask/superstruct": true,
         "@metamask/utils": true,
-        "@noble/hashes": true
+        "@noble/hashes": true,
+        "@metamask/eth-qr-keyring>async-mutex": true
       }
     },
     "@metamask/snaps-sdk": {

lavamoat/browserify/experimental/policy.json

@@ -1957,7 +1957,8 @@
         "@metamask/snaps-utils": true,
         "@metamask/superstruct": true,
         "@metamask/utils": true,
-        "@noble/hashes": true
+        "@noble/hashes": true,
+        "@metamask/eth-qr-keyring>async-mutex": true
       }
     },
     "@metamask/snaps-sdk": {

lavamoat/browserify/flask/policy.json

@@ -1957,7 +1957,8 @@
         "@metamask/snaps-utils": true,
         "@metamask/superstruct": true,
         "@metamask/utils": true,
-        "@noble/hashes": true
+        "@noble/hashes": true,
+        "@metamask/eth-qr-keyring>async-mutex": true
       }
     },
     "@metamask/snaps-sdk": {

lavamoat/browserify/main/policy.json

@@ -1957,7 +1957,8 @@
         "@metamask/snaps-utils": true,
         "@metamask/superstruct": true,
         "@metamask/utils": true,
-        "@noble/hashes": true
+        "@noble/hashes": true,
+        "@metamask/eth-qr-keyring>async-mutex": true
       }
     },
     "@metamask/snaps-sdk": {

lavamoat/webpack/mv2/policy.json

@@ -2017,7 +2017,8 @@
         "@metamask/snaps-utils": true,
         "@metamask/superstruct": true,
         "@metamask/utils": true,
-        "@noble/hashes": true
+        "@noble/hashes": true,
+        "@metamask/eth-qr-keyring>async-mutex": true
       }
     },
     "@metamask/snaps-sdk": {