@metamask/snaps-controllers 8.4.0 → 9.1.0

package/dist/types/interface/utils.d.ts

@@ -20,11 +20,10 @@ export declare function assertNameIsUnique(state: InterfaceState, name: string):
  * Construct the interface state for a given component tree.
  *
  * @param oldState - The previous state.
- * @param component - The UI component to construct state from.
- * @param newState - The state that is being constructed.
+ * @param rootComponent - The UI component to construct state from.
  * @returns The interface state of the passed component.
  */
-export declare function constructState(oldState: InterfaceState, component: JSXElement, newState?: InterfaceState): InterfaceState;
+export declare function constructState(oldState: InterfaceState, rootComponent: JSXElement): InterfaceState;
 /**
  * Validate a JSON blob to be used as the interface context.
  *

package/dist/types/services/offscreen/OffscreenExecutionService.d.ts

@@ -1,29 +1,28 @@
 import type { ExecutionServiceArgs } from '../AbstractExecutionService';
 import { ProxyExecutionService } from '../proxy/ProxyExecutionService';
 declare type OffscreenExecutionEnvironmentServiceArgs = {
-    documentUrl: URL;
+    offscreenPromise: Promise<unknown>;
 } & ExecutionServiceArgs;
 export declare class OffscreenExecutionService extends ProxyExecutionService {
     #private;
-    readonly documentUrl: URL;
     /**
      * Create a new offscreen execution service.
      *
      * @param args - The constructor arguments.
-     * @param args.documentUrl - The URL of the offscreen document to use as the
-     * execution environment. This must be a URL relative to the location where
-     * this is called. This cannot be a public (http(s)) URL.
      * @param args.messenger - The messenger to use for communication with the
      * `SnapController`.
      * @param args.setupSnapProvider - The function to use to set up the snap
      * provider.
+     * @param args.offscreenPromise - A promise that resolves when the offscreen
+     * environment is ready.
      */
-    constructor({ documentUrl, messenger, setupSnapProvider, }: OffscreenExecutionEnvironmentServiceArgs);
+    constructor({ messenger, setupSnapProvider, offscreenPromise, }: OffscreenExecutionEnvironmentServiceArgs);
     /**
-     * Create a new stream for the specified job. This wraps the runtime stream
-     * in a stream specific to the job.
+     * Create a new stream for the given job ID. This will wait for the offscreen
+     * environment to be ready before creating the stream.
      *
-     * @param jobId - The job ID.
+     * @param jobId - The job ID to create a stream for.
+     * @returns The stream for the given job ID.
      */
     protected initEnvStream(jobId: string): Promise<{
         worker: string;

package/dist/types/snaps/constants.d.ts

@@ -1 +1,7 @@
 export declare const ALLOWED_PERMISSIONS: readonly string[];
+export declare const LEGACY_ENCRYPTION_KEY_DERIVATION_OPTIONS: {
+    algorithm: "PBKDF2";
+    params: {
+        iterations: number;
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-controllers",
-  "version": "8.4.0",
+  "version": "9.1.0",
   "description": "Controllers for MetaMask Snaps.",
   "repository": {
     "type": "git",
@@ -53,19 +53,19 @@
     "build:ci": "tsup --clean"
   },
   "dependencies": {
-    "@metamask/approval-controller": "^6.0.2",
-    "@metamask/base-controller": "^5.0.2",
-    "@metamask/json-rpc-engine": "^8.0.1",
-    "@metamask/json-rpc-middleware-stream": "^7.0.1",
+    "@metamask/approval-controller": "^7.0.0",
+    "@metamask/base-controller": "^6.0.0",
+    "@metamask/json-rpc-engine": "^9.0.0",
+    "@metamask/json-rpc-middleware-stream": "^8.0.0",
     "@metamask/object-multiplex": "^2.0.0",
-    "@metamask/permission-controller": "^9.0.2",
-    "@metamask/phishing-controller": "^9.0.1",
+    "@metamask/permission-controller": "^10.0.0",
+    "@metamask/phishing-controller": "^10.0.0",
     "@metamask/post-message-stream": "^8.1.0",
     "@metamask/rpc-errors": "^6.2.1",
     "@metamask/snaps-registry": "^3.1.0",
-    "@metamask/snaps-rpc-methods": "^9.1.2",
-    "@metamask/snaps-sdk": "^4.4.2",
-    "@metamask/snaps-utils": "^7.5.0",
+    "@metamask/snaps-rpc-methods": "^9.1.4",
+    "@metamask/snaps-sdk": "^6.0.0",
+    "@metamask/snaps-utils": "^7.7.0",
     "@metamask/utils": "^8.3.0",
     "@xstate/fsm": "^2.0.0",
     "browserify-zlib": "^0.2.0",
@@ -138,7 +138,7 @@
     "webdriverio": "^8.19.0"
   },
   "peerDependencies": {
-    "@metamask/snaps-execution-environments": "^6.3.0"
+    "@metamask/snaps-execution-environments": "^6.5.0"
   },
   "peerDependenciesMeta": {
     "@metamask/snaps-execution-environments": {

package/dist/chunk-3OJFF5CK.mjs

@@ -1,72 +0,0 @@
-import {
-  ProxyExecutionService
-} from "./chunk-3A72M4GC.mjs";
-import {
-  __privateAdd,
-  __privateMethod
-} from "./chunk-YRZVIDCF.mjs";
-
-// src/services/offscreen/OffscreenExecutionService.ts
-import { BrowserRuntimePostMessageStream } from "@metamask/post-message-stream";
-var _createDocument, createDocument_fn;
-var OffscreenExecutionService = class extends ProxyExecutionService {
-  /**
-   * Create a new offscreen execution service.
-   *
-   * @param args - The constructor arguments.
-   * @param args.documentUrl - The URL of the offscreen document to use as the
-   * execution environment. This must be a URL relative to the location where
-   * this is called. This cannot be a public (http(s)) URL.
-   * @param args.messenger - The messenger to use for communication with the
-   * `SnapController`.
-   * @param args.setupSnapProvider - The function to use to set up the snap
-   * provider.
-   */
-  constructor({
-    documentUrl,
-    messenger,
-    setupSnapProvider
-  }) {
-    super({
-      messenger,
-      setupSnapProvider,
-      stream: new BrowserRuntimePostMessageStream({
-        name: "parent",
-        target: "child"
-      })
-    });
-    /**
-     * Creates the offscreen document to be used as the execution environment.
-     *
-     * If the document already exists, this does nothing.
-     */
-    __privateAdd(this, _createDocument);
-    this.documentUrl = documentUrl;
-  }
-  /**
-   * Create a new stream for the specified job. This wraps the runtime stream
-   * in a stream specific to the job.
-   *
-   * @param jobId - The job ID.
-   */
-  async initEnvStream(jobId) {
-    await __privateMethod(this, _createDocument, createDocument_fn).call(this);
-    return super.initEnvStream(jobId);
-  }
-};
-_createDocument = new WeakSet();
-createDocument_fn = async function() {
-  if (await chrome.offscreen.hasDocument()) {
-    return;
-  }
-  await chrome.offscreen.createDocument({
-    justification: "MetaMask Snaps Execution Environment",
-    reasons: ["IFRAME_SCRIPTING"],
-    url: this.documentUrl.toString()
-  });
-};
-
-export {
-  OffscreenExecutionService
-};
-//# sourceMappingURL=chunk-3OJFF5CK.mjs.map

package/dist/chunk-3OJFF5CK.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/services/offscreen/OffscreenExecutionService.ts"],"sourcesContent":["import { BrowserRuntimePostMessageStream } from '@metamask/post-message-stream';\n\nimport type { ExecutionServiceArgs } from '../AbstractExecutionService';\nimport { ProxyExecutionService } from '../proxy/ProxyExecutionService';\n\ntype OffscreenExecutionEnvironmentServiceArgs = {\n  documentUrl: URL;\n} & ExecutionServiceArgs;\n\nexport class OffscreenExecutionService extends ProxyExecutionService {\n  public readonly documentUrl: URL;\n\n  /**\n   * Create a new offscreen execution service.\n   *\n   * @param args - The constructor arguments.\n   * @param args.documentUrl - The URL of the offscreen document to use as the\n   * execution environment. This must be a URL relative to the location where\n   * this is called. This cannot be a public (http(s)) URL.\n   * @param args.messenger - The messenger to use for communication with the\n   * `SnapController`.\n   * @param args.setupSnapProvider - The function to use to set up the snap\n   * provider.\n   */\n  constructor({\n    documentUrl,\n    messenger,\n    setupSnapProvider,\n  }: OffscreenExecutionEnvironmentServiceArgs) {\n    super({\n      messenger,\n      setupSnapProvider,\n      stream: new BrowserRuntimePostMessageStream({\n        name: 'parent',\n        target: 'child',\n      }),\n    });\n\n    this.documentUrl = documentUrl;\n  }\n\n  /**\n   * Create a new stream for the specified job. This wraps the runtime stream\n   * in a stream specific to the job.\n   *\n   * @param jobId - The job ID.\n   */\n  protected async initEnvStream(jobId: string) {\n    // Lazily create the offscreen document.\n    await this.#createDocument();\n\n    return super.initEnvStream(jobId);\n  }\n\n  /**\n   * Creates the offscreen document to be used as the execution environment.\n   *\n   * If the document already exists, this does nothing.\n   */\n  async #createDocument() {\n    // Extensions can only have a single offscreen document.\n    if (await chrome.offscreen.hasDocument()) {\n      return;\n    }\n\n    await chrome.offscreen.createDocument({\n      justification: 'MetaMask Snaps Execution Environment',\n      reasons: ['IFRAME_SCRIPTING' as chrome.offscreen.Reason],\n      url: this.documentUrl.toString(),\n    });\n  }\n}\n"],"mappings":";;;;;;;;;AAAA,SAAS,uCAAuC;AAAhD;AASO,IAAM,4BAAN,cAAwC,sBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAenE,YAAY;AAAA,IACV;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAA6C;AAC3C,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA,QAAQ,IAAI,gCAAgC;AAAA,QAC1C,MAAM;AAAA,QACN,QAAQ;AAAA,MACV,CAAC;AAAA,IACH,CAAC;AAuBH;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AArBJ,SAAK,cAAc;AAAA,EACrB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAgB,cAAc,OAAe;AAE3C,UAAM,sBAAK,oCAAL;AAEN,WAAO,MAAM,cAAc,KAAK;AAAA,EAClC;AAmBF;AAZQ;AAAA,oBAAe,iBAAG;AAEtB,MAAI,MAAM,OAAO,UAAU,YAAY,GAAG;AACxC;AAAA,EACF;AAEA,QAAM,OAAO,UAAU,eAAe;AAAA,IACpC,eAAe;AAAA,IACf,SAAS,CAAC,kBAA6C;AAAA,IACvD,KAAK,KAAK,YAAY,SAAS;AAAA,EACjC,CAAC;AACH;","names":[]}

package/dist/chunk-5YBORD3A.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/snaps/constants.ts"],"names":[],"mappings":";AAAA,SAAS,sBAAsB;AAGxB,IAAM,sBAAsB,OAAO,OAAO;AAAA,EAC/C;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AACjB,CAAC","sourcesContent":["import { SnapEndowments } from '@metamask/snaps-rpc-methods';\n\n// These permissions are allowed without being on the allowlist.\nexport const ALLOWED_PERMISSIONS = Object.freeze([\n  'snap_dialog',\n  'snap_manageState',\n  'snap_notify',\n  'snap_getLocale',\n  SnapEndowments.Cronjob,\n  SnapEndowments.HomePage,\n  SnapEndowments.LifecycleHooks,\n  SnapEndowments.EthereumProvider,\n  SnapEndowments.TransactionInsight,\n  SnapEndowments.SignatureInsight,\n]);\n"]}

package/dist/chunk-HK4OAMJT.js

@@ -1,72 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkKH72WRHRjs = require('./chunk-KH72WRHR.js');
-
-
-
-var _chunkEXN2TFDJjs = require('./chunk-EXN2TFDJ.js');
-
-// src/services/offscreen/OffscreenExecutionService.ts
-var _postmessagestream = require('@metamask/post-message-stream');
-var _createDocument, createDocument_fn;
-var OffscreenExecutionService = class extends _chunkKH72WRHRjs.ProxyExecutionService {
-  /**
-   * Create a new offscreen execution service.
-   *
-   * @param args - The constructor arguments.
-   * @param args.documentUrl - The URL of the offscreen document to use as the
-   * execution environment. This must be a URL relative to the location where
-   * this is called. This cannot be a public (http(s)) URL.
-   * @param args.messenger - The messenger to use for communication with the
-   * `SnapController`.
-   * @param args.setupSnapProvider - The function to use to set up the snap
-   * provider.
-   */
-  constructor({
-    documentUrl,
-    messenger,
-    setupSnapProvider
-  }) {
-    super({
-      messenger,
-      setupSnapProvider,
-      stream: new (0, _postmessagestream.BrowserRuntimePostMessageStream)({
-        name: "parent",
-        target: "child"
-      })
-    });
-    /**
-     * Creates the offscreen document to be used as the execution environment.
-     *
-     * If the document already exists, this does nothing.
-     */
-    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _createDocument);
-    this.documentUrl = documentUrl;
-  }
-  /**
-   * Create a new stream for the specified job. This wraps the runtime stream
-   * in a stream specific to the job.
-   *
-   * @param jobId - The job ID.
-   */
-  async initEnvStream(jobId) {
-    await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _createDocument, createDocument_fn).call(this);
-    return super.initEnvStream(jobId);
-  }
-};
-_createDocument = new WeakSet();
-createDocument_fn = async function() {
-  if (await chrome.offscreen.hasDocument()) {
-    return;
-  }
-  await chrome.offscreen.createDocument({
-    justification: "MetaMask Snaps Execution Environment",
-    reasons: ["IFRAME_SCRIPTING"],
-    url: this.documentUrl.toString()
-  });
-};
-
-
-
-exports.OffscreenExecutionService = OffscreenExecutionService;
-//# sourceMappingURL=chunk-HK4OAMJT.js.map

package/dist/chunk-HK4OAMJT.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/services/offscreen/OffscreenExecutionService.ts"],"names":[],"mappings":";;;;;;;;;AAAA,SAAS,uCAAuC;AAAhD;AASO,IAAM,4BAAN,cAAwC,sBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAenE,YAAY;AAAA,IACV;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAA6C;AAC3C,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA,QAAQ,IAAI,gCAAgC;AAAA,QAC1C,MAAM;AAAA,QACN,QAAQ;AAAA,MACV,CAAC;AAAA,IACH,CAAC;AAuBH;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AArBJ,SAAK,cAAc;AAAA,EACrB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAgB,cAAc,OAAe;AAE3C,UAAM,sBAAK,oCAAL;AAEN,WAAO,MAAM,cAAc,KAAK;AAAA,EAClC;AAmBF;AAZQ;AAAA,oBAAe,iBAAG;AAEtB,MAAI,MAAM,OAAO,UAAU,YAAY,GAAG;AACxC;AAAA,EACF;AAEA,QAAM,OAAO,UAAU,eAAe;AAAA,IACpC,eAAe;AAAA,IACf,SAAS,CAAC,kBAA6C;AAAA,IACvD,KAAK,KAAK,YAAY,SAAS;AAAA,EACjC,CAAC;AACH","sourcesContent":["import { BrowserRuntimePostMessageStream } from '@metamask/post-message-stream';\n\nimport type { ExecutionServiceArgs } from '../AbstractExecutionService';\nimport { ProxyExecutionService } from '../proxy/ProxyExecutionService';\n\ntype OffscreenExecutionEnvironmentServiceArgs = {\n  documentUrl: URL;\n} & ExecutionServiceArgs;\n\nexport class OffscreenExecutionService extends ProxyExecutionService {\n  public readonly documentUrl: URL;\n\n  /**\n   * Create a new offscreen execution service.\n   *\n   * @param args - The constructor arguments.\n   * @param args.documentUrl - The URL of the offscreen document to use as the\n   * execution environment. This must be a URL relative to the location where\n   * this is called. This cannot be a public (http(s)) URL.\n   * @param args.messenger - The messenger to use for communication with the\n   * `SnapController`.\n   * @param args.setupSnapProvider - The function to use to set up the snap\n   * provider.\n   */\n  constructor({\n    documentUrl,\n    messenger,\n    setupSnapProvider,\n  }: OffscreenExecutionEnvironmentServiceArgs) {\n    super({\n      messenger,\n      setupSnapProvider,\n      stream: new BrowserRuntimePostMessageStream({\n        name: 'parent',\n        target: 'child',\n      }),\n    });\n\n    this.documentUrl = documentUrl;\n  }\n\n  /**\n   * Create a new stream for the specified job. This wraps the runtime stream\n   * in a stream specific to the job.\n   *\n   * @param jobId - The job ID.\n   */\n  protected async initEnvStream(jobId: string) {\n    // Lazily create the offscreen document.\n    await this.#createDocument();\n\n    return super.initEnvStream(jobId);\n  }\n\n  /**\n   * Creates the offscreen document to be used as the execution environment.\n   *\n   * If the document already exists, this does nothing.\n   */\n  async #createDocument() {\n    // Extensions can only have a single offscreen document.\n    if (await chrome.offscreen.hasDocument()) {\n      return;\n    }\n\n    await chrome.offscreen.createDocument({\n      justification: 'MetaMask Snaps Execution Environment',\n      reasons: ['IFRAME_SCRIPTING' as chrome.offscreen.Reason],\n      url: this.documentUrl.toString(),\n    });\n  }\n}\n"]}