@metamask/snaps-controllers 17.1.2 → 17.2.1

package/dist/services/webview/WebViewExecutionService.d.cts

@@ -20,6 +20,6 @@ export declare class WebViewExecutionService extends AbstractExecutionService<We
         worker: WebViewInterface;
         stream: WebViewMessageStream;
     }>;
-    protected terminateJob(jobWrapper: TerminateJobArgs<WebViewInterface>): void;
+    protected terminateJob(jobWrapper: TerminateJobArgs<WebViewInterface>): Promise<void>;
 }
 //# sourceMappingURL=WebViewExecutionService.d.cts.map

package/dist/services/webview/WebViewExecutionService.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"WebViewExecutionService.d.cts","sourceRoot":"","sources":["../../../src/services/webview/WebViewExecutionService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,mCAA+B;AAC/D,OAAO,EAAE,oBAAoB,EAAE,mCAA+B;AAC9D,OAAO,EAAE,wBAAwB,EAAE,wCAAoC;AACvE,OAAO,KAAK,EACV,oBAAoB,EACpB,gBAAgB,EACjB,wCAAoC;AAErC,MAAM,MAAM,2BAA2B,GAAG,oBAAoB,GAAG;IAC/D,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC5D,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CACxC,CAAC;AAEF,qBAAa,uBAAwB,SAAQ,wBAAwB,CAAC,gBAAgB,CAAC;;gBAKzE,EACV,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,GAAG,IAAI,EACR,EAAE,2BAA2B;IAU9B;;;;;;OAMG;cACa,aAAa,CAAC,MAAM,EAAE,MAAM;;;;IAc5C,SAAS,CAAC,YAAY,CAAC,UAAU,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,GAAG,IAAI;CAG7E"}
+{"version":3,"file":"WebViewExecutionService.d.cts","sourceRoot":"","sources":["../../../src/services/webview/WebViewExecutionService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,mCAA+B;AAC/D,OAAO,EAAE,oBAAoB,EAAE,mCAA+B;AAC9D,OAAO,EAAE,wBAAwB,EAAE,wCAAoC;AACvE,OAAO,KAAK,EACV,oBAAoB,EACpB,gBAAgB,EACjB,wCAAoC;AAErC,MAAM,MAAM,2BAA2B,GAAG,oBAAoB,GAAG;IAC/D,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC5D,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CACxC,CAAC;AAEF,qBAAa,uBAAwB,SAAQ,wBAAwB,CAAC,gBAAgB,CAAC;;gBAKzE,EACV,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,GAAG,IAAI,EACR,EAAE,2BAA2B;IAU9B;;;;;;OAMG;cACa,aAAa,CAAC,MAAM,EAAE,MAAM;;;;cAc5B,YAAY,CAC1B,UAAU,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,GAC7C,OAAO,CAAC,IAAI,CAAC;CAGjB"}

package/dist/services/webview/WebViewExecutionService.d.mts

@@ -20,6 +20,6 @@ export declare class WebViewExecutionService extends AbstractExecutionService<We
         worker: WebViewInterface;
         stream: WebViewMessageStream;
     }>;
-    protected terminateJob(jobWrapper: TerminateJobArgs<WebViewInterface>): void;
+    protected terminateJob(jobWrapper: TerminateJobArgs<WebViewInterface>): Promise<void>;
 }
 //# sourceMappingURL=WebViewExecutionService.d.mts.map

package/dist/services/webview/WebViewExecutionService.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"WebViewExecutionService.d.mts","sourceRoot":"","sources":["../../../src/services/webview/WebViewExecutionService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,mCAA+B;AAC/D,OAAO,EAAE,oBAAoB,EAAE,mCAA+B;AAC9D,OAAO,EAAE,wBAAwB,EAAE,wCAAoC;AACvE,OAAO,KAAK,EACV,oBAAoB,EACpB,gBAAgB,EACjB,wCAAoC;AAErC,MAAM,MAAM,2BAA2B,GAAG,oBAAoB,GAAG;IAC/D,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC5D,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CACxC,CAAC;AAEF,qBAAa,uBAAwB,SAAQ,wBAAwB,CAAC,gBAAgB,CAAC;;gBAKzE,EACV,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,GAAG,IAAI,EACR,EAAE,2BAA2B;IAU9B;;;;;;OAMG;cACa,aAAa,CAAC,MAAM,EAAE,MAAM;;;;IAc5C,SAAS,CAAC,YAAY,CAAC,UAAU,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,GAAG,IAAI;CAG7E"}
+{"version":3,"file":"WebViewExecutionService.d.mts","sourceRoot":"","sources":["../../../src/services/webview/WebViewExecutionService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,mCAA+B;AAC/D,OAAO,EAAE,oBAAoB,EAAE,mCAA+B;AAC9D,OAAO,EAAE,wBAAwB,EAAE,wCAAoC;AACvE,OAAO,KAAK,EACV,oBAAoB,EACpB,gBAAgB,EACjB,wCAAoC;AAErC,MAAM,MAAM,2BAA2B,GAAG,oBAAoB,GAAG;IAC/D,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC5D,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CACxC,CAAC;AAEF,qBAAa,uBAAwB,SAAQ,wBAAwB,CAAC,gBAAgB,CAAC;;gBAKzE,EACV,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,GAAG,IAAI,EACR,EAAE,2BAA2B;IAU9B;;;;;;OAMG;cACa,aAAa,CAAC,MAAM,EAAE,MAAM;;;;cAc5B,YAAY,CAC1B,UAAU,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,GAC7C,OAAO,CAAC,IAAI,CAAC;CAGjB"}

package/dist/services/webview/WebViewExecutionService.mjs

@@ -29,7 +29,7 @@ export class WebViewExecutionService extends AbstractExecutionService {
         });
         return { worker: webView, stream };
     }
-    terminateJob(jobWrapper) {
+    async terminateJob(jobWrapper) {
         this.#removeWebView(jobWrapper.id);
     }
 }

package/dist/services/webview/WebViewExecutionService.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"WebViewExecutionService.mjs","sourceRoot":"","sources":["../../../src/services/webview/WebViewExecutionService.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,mCAA+B;AAC9D,OAAO,EAAE,wBAAwB,EAAE,wCAAoC;AAWvE,MAAM,OAAO,uBAAwB,SAAQ,wBAA0C;IAC5E,cAAc,CAAC;IAEf,cAAc,CAAC;IAExB,YAAY,EACV,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,GAAG,IAAI,EACqB;QAC5B,KAAK,CAAC;YACJ,GAAG,IAAI;YACP,SAAS;YACT,iBAAiB;SAClB,CAAC,CAAC;QACH,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,aAAa,CAAC,MAAc;QAC1C,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAE3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,IAAI,oBAAoB,CAAC;YACtC,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO;YACf,OAAO;SACR,CAAC,CAAC;QAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IACrC,CAAC;IAES,YAAY,CAAC,UAA8C;QACnE,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IACrC,CAAC;CACF","sourcesContent":["import type { WebViewInterface } from './WebViewMessageStream';\nimport { WebViewMessageStream } from './WebViewMessageStream';\nimport { AbstractExecutionService } from '../AbstractExecutionService';\nimport type {\n  ExecutionServiceArgs,\n  TerminateJobArgs,\n} from '../AbstractExecutionService';\n\nexport type WebViewExecutionServiceArgs = ExecutionServiceArgs & {\n  createWebView: (jobId: string) => Promise<WebViewInterface>;\n  removeWebView: (jobId: string) => void;\n};\n\nexport class WebViewExecutionService extends AbstractExecutionService<WebViewInterface> {\n  readonly #createWebView;\n\n  readonly #removeWebView;\n\n  constructor({\n    messenger,\n    setupSnapProvider,\n    createWebView,\n    removeWebView,\n    ...args\n  }: WebViewExecutionServiceArgs) {\n    super({\n      ...args,\n      messenger,\n      setupSnapProvider,\n    });\n    this.#createWebView = createWebView;\n    this.#removeWebView = removeWebView;\n  }\n\n  /**\n   * Create a new stream for the specified Snap. This wraps the runtime stream\n   * in a stream specific to the Snap.\n   *\n   * @param snapId - The Snap ID.\n   * @returns An object with the webview and stream.\n   */\n  protected async initEnvStream(snapId: string) {\n    this.setSnapStatus(snapId, 'initializing');\n\n    const webView = await this.#createWebView(snapId);\n\n    const stream = new WebViewMessageStream({\n      name: 'parent',\n      target: 'child',\n      webView,\n    });\n\n    return { worker: webView, stream };\n  }\n\n  protected terminateJob(jobWrapper: TerminateJobArgs<WebViewInterface>): void {\n    this.#removeWebView(jobWrapper.id);\n  }\n}\n"]}
+{"version":3,"file":"WebViewExecutionService.mjs","sourceRoot":"","sources":["../../../src/services/webview/WebViewExecutionService.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,mCAA+B;AAC9D,OAAO,EAAE,wBAAwB,EAAE,wCAAoC;AAWvE,MAAM,OAAO,uBAAwB,SAAQ,wBAA0C;IAC5E,cAAc,CAAC;IAEf,cAAc,CAAC;IAExB,YAAY,EACV,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,GAAG,IAAI,EACqB;QAC5B,KAAK,CAAC;YACJ,GAAG,IAAI;YACP,SAAS;YACT,iBAAiB;SAClB,CAAC,CAAC;QACH,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,aAAa,CAAC,MAAc;QAC1C,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAE3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,IAAI,oBAAoB,CAAC;YACtC,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO;YACf,OAAO;SACR,CAAC,CAAC;QAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IACrC,CAAC;IAES,KAAK,CAAC,YAAY,CAC1B,UAA8C;QAE9C,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IACrC,CAAC;CACF","sourcesContent":["import type { WebViewInterface } from './WebViewMessageStream';\nimport { WebViewMessageStream } from './WebViewMessageStream';\nimport { AbstractExecutionService } from '../AbstractExecutionService';\nimport type {\n  ExecutionServiceArgs,\n  TerminateJobArgs,\n} from '../AbstractExecutionService';\n\nexport type WebViewExecutionServiceArgs = ExecutionServiceArgs & {\n  createWebView: (jobId: string) => Promise<WebViewInterface>;\n  removeWebView: (jobId: string) => void;\n};\n\nexport class WebViewExecutionService extends AbstractExecutionService<WebViewInterface> {\n  readonly #createWebView;\n\n  readonly #removeWebView;\n\n  constructor({\n    messenger,\n    setupSnapProvider,\n    createWebView,\n    removeWebView,\n    ...args\n  }: WebViewExecutionServiceArgs) {\n    super({\n      ...args,\n      messenger,\n      setupSnapProvider,\n    });\n    this.#createWebView = createWebView;\n    this.#removeWebView = removeWebView;\n  }\n\n  /**\n   * Create a new stream for the specified Snap. This wraps the runtime stream\n   * in a stream specific to the Snap.\n   *\n   * @param snapId - The Snap ID.\n   * @returns An object with the webview and stream.\n   */\n  protected async initEnvStream(snapId: string) {\n    this.setSnapStatus(snapId, 'initializing');\n\n    const webView = await this.#createWebView(snapId);\n\n    const stream = new WebViewMessageStream({\n      name: 'parent',\n      target: 'child',\n      webView,\n    });\n\n    return { worker: webView, stream };\n  }\n\n  protected async terminateJob(\n    jobWrapper: TerminateJobArgs<WebViewInterface>,\n  ): Promise<void> {\n    this.#removeWebView(jobWrapper.id);\n  }\n}\n"]}

package/dist/snaps/SnapController.cjs

@@ -37,6 +37,7 @@ const defaultState = {
     snaps: {},
     snapStates: {},
     unencryptedSnapStates: {},
+    isReady: false,
 };
 /**
  * Truncates the properties of a snap to only ones that are easily serializable.
@@ -88,6 +89,12 @@ class SnapController extends base_controller_1.BaseController {
         super({
             messenger,
             metadata: {
+                isReady: {
+                    includeInStateLogs: true,
+                    includeInDebugSnapshot: true,
+                    persist: false,
+                    usedInUi: false,
+                },
                 snapStates: {
                     includeInStateLogs: false,
                     persist: true,
@@ -300,6 +307,8 @@ class SnapController extends base_controller_1.BaseController {
      * runnable Snaps.
      */
     init() {
+        // Lazily populate the `isReady` state.
+        this.#ensureCanUsePlatform().catch(snaps_utils_1.logWarning);
         this.#callLifecycleHooks(constants_1.METAMASK_ORIGIN, snaps_utils_1.HandlerType.OnStart);
     }
     #handlePreinstalledSnaps(preinstalledSnaps) {
@@ -417,7 +426,7 @@ class SnapController extends base_controller_1.BaseController {
      * Also updates any preinstalled Snaps to the latest allowlisted version.
      */
     async updateRegistry() {
-        await this.#assertCanUsePlatform();
+        await this.#ensureCanUsePlatform();
         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] = {
@@ -525,11 +534,19 @@ class SnapController extends base_controller_1.BaseController {
     /**
      * Waits for onboarding and then asserts whether the Snaps platform is allowed to run.
      */
-    async #assertCanUsePlatform() {
+    async #ensureCanUsePlatform() {
         // 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.');
+        // If the user has onboarded, the Snaps Platform is considered ready,
+        // if it isn't forced to be disabled via feature flags.
+        const isReady = flags.disableSnaps !== true;
+        if (this.state.isReady !== isReady) {
+            this.update((state) => {
+                state.isReady = isReady;
+            });
+        }
+        (0, utils_1.assert)(isReady, 'The Snaps platform requires basic functionality to be used. Enable basic functionality in the settings to use the Snaps platform.');
     }
     async #stopSnapsLastRequestPastMax() {
         const entries = [...this.#snapsRuntimeData.entries()];
@@ -594,7 +611,7 @@ class SnapController extends base_controller_1.BaseController {
      * @param snapId - The id of the Snap to start.
      */
     async startSnap(snapId) {
-        await this.#assertCanUsePlatform();
+        await this.#ensureCanUsePlatform();
         const snap = this.state.snaps[snapId];
         if (!snap.enabled) {
             throw new Error(`Snap "${snapId}" is disabled.`);
@@ -1039,6 +1056,7 @@ class SnapController extends base_controller_1.BaseController {
         await this.stopAllSnaps();
         snapIds.forEach((snapId) => this.#revokeAllSnapPermissions(snapId));
         this.update((state) => {
+            state.isReady = false;
             state.snaps = {};
             state.snapStates = {};
             state.unencryptedSnapStates = {};
@@ -1262,7 +1280,7 @@ class SnapController extends base_controller_1.BaseController {
      * snap couldn't be installed.
      */
     async installSnaps(origin, requestedSnaps) {
-        await this.#assertCanUsePlatform();
+        await this.#ensureCanUsePlatform();
         const result = {};
         const snapIds = Object.keys(requestedSnaps);
         const pendingUpdates = [];
@@ -1447,7 +1465,7 @@ class SnapController extends base_controller_1.BaseController {
         if (!automaticUpdate) {
             this.#assertCanInstallSnaps();
         }
-        await this.#assertCanUsePlatform();
+        await this.#ensureCanUsePlatform();
         const snap = this.getExpect(snapId);
         const { preinstalled, removable, hidden, hideSnapBranding } = snap;
         if (preinstalled && !automaticUpdate) {
@@ -1870,7 +1888,7 @@ class SnapController extends base_controller_1.BaseController {
      * @returns The result of the JSON-RPC request.
      */
     async handleRequest({ snapId, origin, handler: handlerType, request: rawRequest, }) {
-        await this.#assertCanUsePlatform();
+        await this.#ensureCanUsePlatform();
         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'.");