@metamask/snaps-controllers 16.1.0 → 17.0.0

package/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [17.0.0]
+
+### Added
+
+- **BREAKING:** Ensure user has onboarded before allowing usage of SnapController ([#3731](https://github.com/MetaMask/snaps/pull/3731))
+  - This is breaking as it adds a new required constructor argument to `SnapController` called `ensureOnboardingComplete`.
+- **BREAKING:** Support specified `clientVersions` in the registry ([#3737](https://github.com/MetaMask/snaps/pull/3737))
+  - This is breaking as it adds a new required constructor argument to `JsonSnapsRegistry` called `clientConfig`.
+
+## [16.1.1]
+
+### Fixed
+
+- Override `disableSnapInstallation` feature flag when using automatic updates ([#3735](https://github.com/MetaMask/snaps/pull/3735))
+
 ## [16.1.0]
 
 ### Added
@@ -954,7 +969,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The version of the package no longer needs to match the version of all other
     MetaMask Snaps packages.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@16.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@17.0.0...HEAD
+[17.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@16.1.1...@metamask/snaps-controllers@17.0.0
+[16.1.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@16.1.0...@metamask/snaps-controllers@16.1.1
 [16.1.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@16.0.0...@metamask/snaps-controllers@16.1.0
 [16.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@15.0.2...@metamask/snaps-controllers@16.0.0
 [15.0.2]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@15.0.1...@metamask/snaps-controllers@15.0.2

package/dist/snaps/SnapController.cjs

@@ -83,7 +83,8 @@ class SnapController extends base_controller_1.BaseController {
     #preinstalledSnaps;
     #trackEvent;
     #trackSnapExport;
-    constructor({ closeAllConnections, messenger, state, dynamicPermissions = ['endowment:caip25', 'wallet_snap'], environmentEndowmentPermissions = [], excludedPermissions = {}, idleTimeCheckInterval = (0, utils_1.inMilliseconds)(5, utils_1.Duration.Second), maxIdleTime = (0, utils_1.inMilliseconds)(30, utils_1.Duration.Second), maxRequestTime = (0, utils_1.inMilliseconds)(60, utils_1.Duration.Second), fetchFunction = globalThis.fetch.bind(undefined), featureFlags = {}, detectSnapLocation: detectSnapLocationFunction = location_1.detectSnapLocation, preinstalledSnaps = null, encryptor, getMnemonicSeed, getFeatureFlags = () => ({}), clientCryptography, trackEvent, }) {
+    #ensureOnboardingComplete;
+    constructor({ closeAllConnections, messenger, state, dynamicPermissions = ['endowment:caip25', 'wallet_snap'], environmentEndowmentPermissions = [], excludedPermissions = {}, idleTimeCheckInterval = (0, utils_1.inMilliseconds)(5, utils_1.Duration.Second), maxIdleTime = (0, utils_1.inMilliseconds)(30, utils_1.Duration.Second), maxRequestTime = (0, utils_1.inMilliseconds)(60, utils_1.Duration.Second), fetchFunction = globalThis.fetch.bind(undefined), featureFlags = {}, detectSnapLocation: detectSnapLocationFunction = location_1.detectSnapLocation, preinstalledSnaps = null, encryptor, getMnemonicSeed, getFeatureFlags = () => ({}), clientCryptography, trackEvent, ensureOnboardingComplete, }) {
         super({
             messenger,
             metadata: {
@@ -160,6 +161,7 @@ class SnapController extends base_controller_1.BaseController {
         this.#rollbackSnapshots = new Map();
         this.#snapsRuntimeData = new Map();
         this.#trackEvent = trackEvent;
+        this.#ensureOnboardingComplete = ensureOnboardingComplete;
         this.#pollForLastRequestStatus();
         /* eslint-disable @typescript-eslint/unbound-method */
         this.messenger.subscribe('ExecutionService:unhandledError', this._onUnhandledSnapError);
@@ -383,7 +385,7 @@ class SnapController extends base_controller_1.BaseController {
      * Also updates any preinstalled Snaps to the latest allowlisted version.
      */
     async updateRegistry() {
-        this.#assertCanUsePlatform();
+        await this.#assertCanUsePlatform();
         await this.messenger.call('SnapsRegistry:update');
         const blockedSnaps = await this.messenger.call('SnapsRegistry:get', Object.values(this.state.snaps).reduce((blockListArg, snap) => {
             blockListArg[snap.id] = {
@@ -489,9 +491,11 @@ class SnapController extends base_controller_1.BaseController {
         (0, utils_1.assert)(this.#featureFlags.disableSnapInstallation !== true, 'Installing Snaps is currently disabled in this version of MetaMask.');
     }
     /**
-     * Asserts whether the Snaps platform is allowed to run.
+     * Waits for onboarding and then asserts whether the Snaps platform is allowed to run.
      */
-    #assertCanUsePlatform() {
+    async #assertCanUsePlatform() {
+        // Ensure the user has onboarded before allowing access to Snaps.
+        await this.#ensureOnboardingComplete();
         const flags = this.#getFeatureFlags();
         (0, utils_1.assert)(flags.disableSnaps !== true, 'The Snaps platform requires basic functionality to be used. Enable basic functionality in the settings to use the Snaps platform.');
     }
@@ -558,7 +562,7 @@ class SnapController extends base_controller_1.BaseController {
      * @param snapId - The id of the Snap to start.
      */
     async startSnap(snapId) {
-        this.#assertCanUsePlatform();
+        await this.#assertCanUsePlatform();
         const snap = this.state.snaps[snapId];
         if (!snap.enabled) {
             throw new Error(`Snap "${snapId}" is disabled.`);
@@ -1226,7 +1230,7 @@ class SnapController extends base_controller_1.BaseController {
      * snap couldn't be installed.
      */
     async installSnaps(origin, requestedSnaps) {
-        this.#assertCanUsePlatform();
+        await this.#assertCanUsePlatform();
         const result = {};
         const snapIds = Object.keys(requestedSnaps);
         const pendingUpdates = [];
@@ -1408,8 +1412,10 @@ class SnapController extends base_controller_1.BaseController {
      * @returns The snap metadata if updated, `null` otherwise.
      */
     async #updateSnap({ origin, snapId, location, versionRange, automaticUpdate = false, }) {
-        this.#assertCanInstallSnaps();
-        this.#assertCanUsePlatform();
+        if (!automaticUpdate) {
+            this.#assertCanInstallSnaps();
+        }
+        await this.#assertCanUsePlatform();
         const snap = this.getExpect(snapId);
         const { preinstalled, removable, hidden, hideSnapBranding } = snap;
         if (preinstalled && !automaticUpdate) {
@@ -1832,7 +1838,7 @@ class SnapController extends base_controller_1.BaseController {
      * @returns The result of the JSON-RPC request.
      */
     async handleRequest({ snapId, origin, handler: handlerType, request: rawRequest, }) {
-        this.#assertCanUsePlatform();
+        await this.#assertCanUsePlatform();
         const snap = this.get(snapId);
         (0, utils_1.assert)(snap, `The Snap "${snapId}" is not installed. Please install it before invoking it.`);
         (0, utils_1.assert)(origin === constants_1.METAMASK_ORIGIN || (0, snaps_utils_1.isValidUrl)(origin), "'origin' must be a valid URL or 'metamask'.");