@metamask/snaps-execution-environments 0.27.1 → 0.29.0

package/dist/common/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/common/utils.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,aAAsB;IACnD,IAAI,cAAiC,CAAC;IACtC,IAAI,aAAa,YAAY,KAAK,EAAE;QAClC,cAAc,GAAG,aAAa,CAAC;KAChC;SAAM,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;QAC5C,cAAc,GAAG,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;QAC1C,qCAAqC;QACrC,OAAO,cAAc,CAAC,KAAK,CAAC;KAC7B;IACD,OAAO,cAAc,CAAC;AACxB,CAAC;AAVD,wCAUC;AAED;;;;;;GAMG;AACH,SAAgB,aAAa,CAAC,GAAQ;IACpC,MAAM,UAAU,GAAG,IAAI,GAAG,EAAc,CAAC;IACzC,IAAI,OAAO,GAAG,GAAG,CAAC;IAClB,GAAG;QACD,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC1C,UAAU,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;SAChC;KACF,QACC,CAAC,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,KAAK,MAAM,CAAC,SAAS,EAC5B;IACF,OAAO,UAAU,CAAC;AACpB,CAAC;AAZD,sCAYC;AAED;;;;;;GAMG;AACH,SAAgB,YAAY,CAAC,GAAQ;IACnC,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,aAAa,CAAC,GAAG,CAAC,EAAE;QAC9C,IAAI,GAAG,KAAK,aAAa,EAAE;YACzB,SAAS;SACV;QACD,MAAM,UAAU,GAAG,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjE,IAAI,UAAU,KAAK,SAAS,IAAI,OAAO,UAAU,CAAC,KAAK,KAAK,UAAU,EAAE;YACtE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAClB;KACF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAZD,oCAYC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,YAAY,CAChC,eAA2B,EAC3B,WAAqC;IAErC,MAAM,UAAU,GAAG,WAAW,CAAC,YAAY,CAAC;IAC5C,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACxC,eAAe;aACZ,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACd,IAAI,WAAW,CAAC,YAAY,KAAK,UAAU,EAAE;gBAC3C,OAAO,CAAC,KAAK,CAAC,CAAC;aAChB;iBAAM;gBACL,OAAO,CAAC,IAAI,CACV,+EAA+E,CAChF,CAAC;aACH;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;YAChB,IAAI,WAAW,CAAC,YAAY,KAAK,UAAU,EAAE;gBAC3C,MAAM,CAAC,MAAM,CAAC,CAAC;aAChB;iBAAM;gBACL,OAAO,CAAC,IAAI,CACV,+EAA+E,CAChF,CAAC;aACH;QACH,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC;AA1BD,oCA0BC","sourcesContent":["/**\n * Takes an error that was thrown, determines if it is\n * an error object. If it is then it will return that. Otherwise,\n * an error object is created with the original error message.\n *\n * @param originalError - The error that was originally thrown.\n * @returns An error object.\n */\nexport function constructError(originalError: unknown) {\n  let _originalError: Error | undefined;\n  if (originalError instanceof Error) {\n    _originalError = originalError;\n  } else if (typeof originalError === 'string') {\n    _originalError = new Error(originalError);\n    // The stack is useless in this case.\n    delete _originalError.stack;\n  }\n  return _originalError;\n}\n\n/**\n * Get all properties of an object, including its prototype chain.\n *\n * @param obj - The object to get all properties for.\n * @returns All properties of `obj` as a tuple set, containing the property name\n * and value.\n */\nexport function allProperties(obj: any): Set<[object, string | symbol]> {\n  const properties = new Set<[any, any]>();\n  let current = obj;\n  do {\n    for (const key of Reflect.ownKeys(current)) {\n      properties.add([current, key]);\n    }\n  } while (\n    (current = Reflect.getPrototypeOf(current)) &&\n    current !== Object.prototype\n  );\n  return properties;\n}\n\n/**\n * Get all functions of an object, including its prototype chain. This does not\n * include constructor functions.\n *\n * @param obj - The object to get all functions for.\n * @returns An array with all functions of `obj` as string or symbol.\n */\nexport function allFunctions(obj: any): (string | symbol)[] {\n  const result = [];\n  for (const [object, key] of allProperties(obj)) {\n    if (key === 'constructor') {\n      continue;\n    }\n    const descriptor = Reflect.getOwnPropertyDescriptor(object, key);\n    if (descriptor !== undefined && typeof descriptor.value === 'function') {\n      result.push(key);\n    }\n  }\n  return result;\n}\n\n/**\n * Make proxy for Promise and handle the teardown process properly.\n * If the teardown is called in the meanwhile, Promise result will not be\n * exposed to the snap anymore and warning will be logged to the console.\n *\n * @param originalPromise - Original promise.\n * @param teardownRef - Reference containing teardown count.\n * @param teardownRef.lastTeardown - Number of the last teardown.\n * @returns New proxy promise.\n */\nexport async function withTeardown<T>(\n  originalPromise: Promise<T>,\n  teardownRef: { lastTeardown: number },\n): Promise<T> {\n  const myTeardown = teardownRef.lastTeardown;\n  return new Promise<T>((resolve, reject) => {\n    originalPromise\n      .then((value) => {\n        if (teardownRef.lastTeardown === myTeardown) {\n          resolve(value);\n        } else {\n          console.warn(\n            'Late promise received after Snap finished execution. Promise will be dropped.',\n          );\n        }\n      })\n      .catch((reason) => {\n        if (teardownRef.lastTeardown === myTeardown) {\n          reject(reason);\n        } else {\n          console.warn(\n            'Late promise received after Snap finished execution. Promise will be dropped.',\n          );\n        }\n      });\n  });\n}\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/common/utils.ts"],"names":[],"mappings":";;;AAAA,wCAAiC;AAEjC;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,aAAsB;IACnD,IAAI,cAAiC,CAAC;IACtC,IAAI,aAAa,YAAY,KAAK,EAAE;QAClC,cAAc,GAAG,aAAa,CAAC;KAChC;SAAM,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;QAC5C,cAAc,GAAG,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;QAC1C,qCAAqC;QACrC,OAAO,cAAc,CAAC,KAAK,CAAC;KAC7B;IACD,OAAO,cAAc,CAAC;AACxB,CAAC;AAVD,wCAUC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,YAAY,CAChC,eAA2B,EAC3B,WAAqC;IAErC,MAAM,UAAU,GAAG,WAAW,CAAC,YAAY,CAAC;IAC5C,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACxC,eAAe;aACZ,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACd,IAAI,WAAW,CAAC,YAAY,KAAK,UAAU,EAAE;gBAC3C,OAAO,CAAC,KAAK,CAAC,CAAC;aAChB;iBAAM;gBACL,IAAA,aAAG,EACD,+EAA+E,CAChF,CAAC;aACH;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;YAChB,IAAI,WAAW,CAAC,YAAY,KAAK,UAAU,EAAE;gBAC3C,MAAM,CAAC,MAAM,CAAC,CAAC;aAChB;iBAAM;gBACL,IAAA,aAAG,EACD,+EAA+E,CAChF,CAAC;aACH;QACH,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC;AA1BD,oCA0BC","sourcesContent":["import { log } from '../logging';\n\n/**\n * Takes an error that was thrown, determines if it is\n * an error object. If it is then it will return that. Otherwise,\n * an error object is created with the original error message.\n *\n * @param originalError - The error that was originally thrown.\n * @returns An error object.\n */\nexport function constructError(originalError: unknown) {\n  let _originalError: Error | undefined;\n  if (originalError instanceof Error) {\n    _originalError = originalError;\n  } else if (typeof originalError === 'string') {\n    _originalError = new Error(originalError);\n    // The stack is useless in this case.\n    delete _originalError.stack;\n  }\n  return _originalError;\n}\n\n/**\n * Make proxy for Promise and handle the teardown process properly.\n * If the teardown is called in the meanwhile, Promise result will not be\n * exposed to the snap anymore and warning will be logged to the console.\n *\n * @param originalPromise - Original promise.\n * @param teardownRef - Reference containing teardown count.\n * @param teardownRef.lastTeardown - Number of the last teardown.\n * @returns New proxy promise.\n */\nexport async function withTeardown<T>(\n  originalPromise: Promise<T>,\n  teardownRef: { lastTeardown: number },\n): Promise<T> {\n  const myTeardown = teardownRef.lastTeardown;\n  return new Promise<T>((resolve, reject) => {\n    originalPromise\n      .then((value) => {\n        if (teardownRef.lastTeardown === myTeardown) {\n          resolve(value);\n        } else {\n          log(\n            'Late promise received after Snap finished execution. Promise will be dropped.',\n          );\n        }\n      })\n      .catch((reason) => {\n        if (teardownRef.lastTeardown === myTeardown) {\n          reject(reason);\n        } else {\n          log(\n            'Late promise received after Snap finished execution. Promise will be dropped.',\n          );\n        }\n      });\n  });\n}\n"]}

package/dist/common/validation.d.ts

@@ -10,15 +10,15 @@ import { Infer } from 'superstruct';
  */
 export declare function validateExport(type: HandlerType, snapExport: unknown): boolean;
 export declare const JsonRpcRequestWithoutIdStruct: import("superstruct").Struct<{
-    jsonrpc: "2.0";
     method: string;
+    jsonrpc: "2.0";
+    params?: Record<string, Json> | Json[] | undefined;
     id?: string | number | null | undefined;
-    params?: Json[] | Record<string, Json> | undefined;
 }, {
     id: import("superstruct").Struct<string | number | null | undefined, null>;
-    jsonrpc: import("superstruct").Struct<"2.0", "2.0">;
+    params: import("superstruct").Struct<Record<string, Json> | Json[] | undefined, null>;
     method: import("superstruct").Struct<string, null>;
-    params: import("superstruct").Struct<Json[] | Record<string, Json> | undefined, null>;
+    jsonrpc: import("superstruct").Struct<"2.0", "2.0">;
 }>;
 export declare type JsonRpcRequestWithoutId = Infer<typeof JsonRpcRequestWithoutIdStruct>;
 export declare const EndowmentStruct: import("superstruct").Struct<string, null>;
@@ -41,10 +41,10 @@ export declare const PingRequestArgumentsStruct: import("superstruct").Struct<un
 export declare const TerminateRequestArgumentsStruct: import("superstruct").Struct<unknown[] | undefined, null>;
 export declare const ExecuteSnapRequestArgumentsStruct: import("superstruct").Struct<[string, string, string[] | undefined], null>;
 export declare const SnapRpcRequestArgumentsStruct: import("superstruct").Struct<[string, HandlerType, string, {
-    jsonrpc: "2.0";
     method: string;
-    id?: string | number | null | undefined;
+    jsonrpc: "2.0";
     params?: Record<string, Json> | undefined;
+    id?: string | number | null | undefined;
 }], null>;
 export declare type PingRequestArguments = Infer<typeof PingRequestArgumentsStruct>;
 export declare type TerminateRequestArguments = Infer<typeof TerminateRequestArgumentsStruct>;
@@ -71,13 +71,13 @@ export declare type OnTransactionRequestArguments = Infer<typeof OnTransactionRe
  */
 export declare function assertIsOnTransactionRequestArguments(value: unknown): asserts value is OnTransactionRequestArguments;
 declare const OkResponseStruct: import("superstruct").Struct<{
-    jsonrpc: "2.0";
     id: string | number | null;
+    jsonrpc: "2.0";
     result: "OK";
 }, {
     result: import("superstruct").Struct<"OK", "OK">;
-    jsonrpc: import("superstruct").Struct<"2.0", "2.0">;
     id: import("superstruct").Struct<string | number | null, null>;
+    jsonrpc: import("superstruct").Struct<"2.0", "2.0">;
 }>;
 declare const SnapRpcResponse: import("superstruct").Struct<{
     id: string | number | null;

package/dist/iframe/IFrameSnapExecutor.js

@@ -9,6 +9,7 @@ const post_message_stream_1 = require("@metamask/post-message-stream");
 const snaps_utils_1 = require("@metamask/snaps-utils");
 const pump_1 = __importDefault(require("pump"));
 const BaseSnapExecutor_1 = require("../common/BaseSnapExecutor");
+const logging_1 = require("../logging");
 class IFrameSnapExecutor extends BaseSnapExecutor_1.BaseSnapExecutor {
     /**
      * Initialize the IFrameSnapExecutor. This creates a post message stream from
@@ -18,7 +19,7 @@ class IFrameSnapExecutor extends BaseSnapExecutor_1.BaseSnapExecutor {
      * message streams.
      */
     static initialize() {
-        console.log('Worker: Connecting to parent.');
+        (0, logging_1.log)('Worker: Connecting to parent.');
         const parentStream = new post_message_stream_1.WindowPostMessageStream({
             name: 'child',
             target: 'parent',
@@ -28,7 +29,7 @@ class IFrameSnapExecutor extends BaseSnapExecutor_1.BaseSnapExecutor {
         const mux = new object_multiplex_1.default();
         (0, pump_1.default)(parentStream, mux, parentStream, (error) => {
             if (error) {
-                console.error(`Parent stream failure, closing worker.`, error);
+                (0, snaps_utils_1.logError)(`Parent stream failure, closing worker.`, error);
             }
             self.close();
         });

package/dist/iframe/IFrameSnapExecutor.js.map

@@ -1 +1 @@
-{"version":3,"file":"IFrameSnapExecutor.js","sourceRoot":"","sources":["../../src/iframe/IFrameSnapExecutor.ts"],"names":[],"mappings":";;;;;;AAAA,kFAAyD;AACzD,uEAAwE;AACxE,uDAA0D;AAC1D,gDAAwB;AAExB,iEAA8D;AAE9D,MAAa,kBAAmB,SAAQ,mCAAgB;IACtD;;;;;;OAMG;IACH,MAAM,CAAC,UAAU;QACf,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;QAE7C,MAAM,YAAY,GAAG,IAAI,6CAAuB,CAAC;YAC/C,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,IAAI,CAAC,MAAM;YACzB,YAAY,EAAE,GAAG;SAClB,CAAC,CAAC;QAEH,MAAM,GAAG,GAAG,IAAI,0BAAe,EAAE,CAAC;QAClC,IAAA,cAAI,EAAC,YAAY,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE;YAC9C,IAAI,KAAK,EAAE;gBACT,OAAO,CAAC,KAAK,CAAC,wCAAwC,EAAE,KAAK,CAAC,CAAC;aAChE;YACD,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,OAAO,CAAC,CAAC;QAClE,MAAM,SAAS,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,QAAQ,CAAC,CAAC;QAE/D,OAAO,IAAI,kBAAkB,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAC1D,CAAC;CACF;AA/BD,gDA+BC","sourcesContent":["import ObjectMultiplex from '@metamask/object-multiplex';\nimport { WindowPostMessageStream } from '@metamask/post-message-stream';\nimport { SNAP_STREAM_NAMES } from '@metamask/snaps-utils';\nimport pump from 'pump';\n\nimport { BaseSnapExecutor } from '../common/BaseSnapExecutor';\n\nexport class IFrameSnapExecutor extends BaseSnapExecutor {\n  /**\n   * Initialize the IFrameSnapExecutor. This creates a post message stream from\n   * and to the parent window, for two-way communication with the iframe.\n   *\n   * @returns An instance of `IFrameSnapExecutor`, with the initialized post\n   * message streams.\n   */\n  static initialize() {\n    console.log('Worker: Connecting to parent.');\n\n    const parentStream = new WindowPostMessageStream({\n      name: 'child',\n      target: 'parent',\n      targetWindow: self.parent,\n      targetOrigin: '*',\n    });\n\n    const mux = new ObjectMultiplex();\n    pump(parentStream, mux, parentStream, (error) => {\n      if (error) {\n        console.error(`Parent stream failure, closing worker.`, error);\n      }\n      self.close();\n    });\n\n    const commandStream = mux.createStream(SNAP_STREAM_NAMES.COMMAND);\n    const rpcStream = mux.createStream(SNAP_STREAM_NAMES.JSON_RPC);\n\n    return new IFrameSnapExecutor(commandStream, rpcStream);\n  }\n}\n"]}
+{"version":3,"file":"IFrameSnapExecutor.js","sourceRoot":"","sources":["../../src/iframe/IFrameSnapExecutor.ts"],"names":[],"mappings":";;;;;;AAAA,kFAAyD;AACzD,uEAAwE;AACxE,uDAAoE;AACpE,gDAAwB;AAExB,iEAA8D;AAC9D,wCAAiC;AAEjC,MAAa,kBAAmB,SAAQ,mCAAgB;IACtD;;;;;;OAMG;IACH,MAAM,CAAC,UAAU;QACf,IAAA,aAAG,EAAC,+BAA+B,CAAC,CAAC;QAErC,MAAM,YAAY,GAAG,IAAI,6CAAuB,CAAC;YAC/C,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,IAAI,CAAC,MAAM;YACzB,YAAY,EAAE,GAAG;SAClB,CAAC,CAAC;QAEH,MAAM,GAAG,GAAG,IAAI,0BAAe,EAAE,CAAC;QAClC,IAAA,cAAI,EAAC,YAAY,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE;YAC9C,IAAI,KAAK,EAAE;gBACT,IAAA,sBAAQ,EAAC,wCAAwC,EAAE,KAAK,CAAC,CAAC;aAC3D;YACD,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,OAAO,CAAC,CAAC;QAClE,MAAM,SAAS,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,QAAQ,CAAC,CAAC;QAE/D,OAAO,IAAI,kBAAkB,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAC1D,CAAC;CACF;AA/BD,gDA+BC","sourcesContent":["import ObjectMultiplex from '@metamask/object-multiplex';\nimport { WindowPostMessageStream } from '@metamask/post-message-stream';\nimport { logError, SNAP_STREAM_NAMES } from '@metamask/snaps-utils';\nimport pump from 'pump';\n\nimport { BaseSnapExecutor } from '../common/BaseSnapExecutor';\nimport { log } from '../logging';\n\nexport class IFrameSnapExecutor extends BaseSnapExecutor {\n  /**\n   * Initialize the IFrameSnapExecutor. This creates a post message stream from\n   * and to the parent window, for two-way communication with the iframe.\n   *\n   * @returns An instance of `IFrameSnapExecutor`, with the initialized post\n   * message streams.\n   */\n  static initialize() {\n    log('Worker: Connecting to parent.');\n\n    const parentStream = new WindowPostMessageStream({\n      name: 'child',\n      target: 'parent',\n      targetWindow: self.parent,\n      targetOrigin: '*',\n    });\n\n    const mux = new ObjectMultiplex();\n    pump(parentStream, mux, parentStream, (error) => {\n      if (error) {\n        logError(`Parent stream failure, closing worker.`, error);\n      }\n      self.close();\n    });\n\n    const commandStream = mux.createStream(SNAP_STREAM_NAMES.COMMAND);\n    const rpcStream = mux.createStream(SNAP_STREAM_NAMES.JSON_RPC);\n\n    return new IFrameSnapExecutor(commandStream, rpcStream);\n  }\n}\n"]}

package/dist/logging.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="debug" />
+/**
+ * A logging function specific to this package. The log messages don't show up
+ * by default, but they can be enabled by setting the environment variable:
+ * - `DEBUG=metamask:snaps:snaps-execution-environments`, or
+ * - `DEBUG=metamask:snaps:*` to enable all logs from `@metamask/snaps-*`.
+ */
+export declare const log: import("debug").Debugger;

package/dist/logging.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.log = void 0;
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+/**
+ * A logging function specific to this package. The log messages don't show up
+ * by default, but they can be enabled by setting the environment variable:
+ * - `DEBUG=metamask:snaps:snaps-execution-environments`, or
+ * - `DEBUG=metamask:snaps:*` to enable all logs from `@metamask/snaps-*`.
+ */
+exports.log = (0, utils_1.createModuleLogger)(snaps_utils_1.snapsLogger, 'snaps-execution-environments');
+//# sourceMappingURL=logging.js.map

package/dist/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AACpD,2CAAqD;AAErD;;;;;GAKG;AACU,QAAA,GAAG,GAAG,IAAA,0BAAkB,EACnC,yBAAW,EACX,8BAA8B,CAC/B,CAAC","sourcesContent":["import { snapsLogger } from '@metamask/snaps-utils';\nimport { createModuleLogger } from '@metamask/utils';\n\n/**\n * A logging function specific to this package. The log messages don't show up\n * by default, but they can be enabled by setting the environment variable:\n * - `DEBUG=metamask:snaps:snaps-execution-environments`, or\n * - `DEBUG=metamask:snaps:*` to enable all logs from `@metamask/snaps-*`.\n */\nexport const log = createModuleLogger(\n  snapsLogger,\n  'snaps-execution-environments',\n);\n"]}

package/dist/node-process/ChildProcessSnapExecutor.js

@@ -9,14 +9,15 @@ const post_message_stream_1 = require("@metamask/post-message-stream");
 const snaps_utils_1 = require("@metamask/snaps-utils");
 const pump_1 = __importDefault(require("pump"));
 const BaseSnapExecutor_1 = require("../common/BaseSnapExecutor");
+const logging_1 = require("../logging");
 class ChildProcessSnapExecutor extends BaseSnapExecutor_1.BaseSnapExecutor {
     static initialize() {
-        console.log('Worker: Connecting to parent.');
+        (0, logging_1.log)('Worker: Connecting to parent.');
         const parentStream = new post_message_stream_1.ProcessMessageStream();
         const mux = new object_multiplex_1.default();
         (0, pump_1.default)(parentStream, mux, parentStream, (error) => {
             if (error) {
-                console.error(`Parent stream failure, closing worker.`, error);
+                (0, snaps_utils_1.logError)(`Parent stream failure, closing worker.`, error);
             }
             self.close();
         });

package/dist/node-process/ChildProcessSnapExecutor.js.map

@@ -1 +1 @@
-{"version":3,"file":"ChildProcessSnapExecutor.js","sourceRoot":"","sources":["../../src/node-process/ChildProcessSnapExecutor.ts"],"names":[],"mappings":";;;;;;AAAA,kFAAyD;AACzD,uEAAqE;AACrE,uDAA0D;AAC1D,gDAAwB;AAExB,iEAA8D;AAE9D,MAAa,wBAAyB,SAAQ,mCAAgB;IAC5D,MAAM,CAAC,UAAU;QACf,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;QAE7C,MAAM,YAAY,GAAG,IAAI,0CAAoB,EAAE,CAAC;QAChD,MAAM,GAAG,GAAG,IAAI,0BAAe,EAAE,CAAC;QAClC,IAAA,cAAI,EAAC,YAAY,EAAE,GAAU,EAAE,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE;YACrD,IAAI,KAAK,EAAE;gBACT,OAAO,CAAC,KAAK,CAAC,wCAAwC,EAAE,KAAK,CAAC,CAAC;aAChE;YACD,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,OAAO,CAAC,CAAC;QAClE,MAAM,SAAS,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,QAAQ,CAAQ,CAAC;QACtE,OAAO,IAAI,wBAAwB,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAChE,CAAC;CACF;AAjBD,4DAiBC","sourcesContent":["import ObjectMultiplex from '@metamask/object-multiplex';\nimport { ProcessMessageStream } from '@metamask/post-message-stream';\nimport { SNAP_STREAM_NAMES } from '@metamask/snaps-utils';\nimport pump from 'pump';\n\nimport { BaseSnapExecutor } from '../common/BaseSnapExecutor';\n\nexport class ChildProcessSnapExecutor extends BaseSnapExecutor {\n  static initialize() {\n    console.log('Worker: Connecting to parent.');\n\n    const parentStream = new ProcessMessageStream();\n    const mux = new ObjectMultiplex();\n    pump(parentStream, mux as any, parentStream, (error) => {\n      if (error) {\n        console.error(`Parent stream failure, closing worker.`, error);\n      }\n      self.close();\n    });\n\n    const commandStream = mux.createStream(SNAP_STREAM_NAMES.COMMAND);\n    const rpcStream = mux.createStream(SNAP_STREAM_NAMES.JSON_RPC) as any;\n    return new ChildProcessSnapExecutor(commandStream, rpcStream);\n  }\n}\n"]}
+{"version":3,"file":"ChildProcessSnapExecutor.js","sourceRoot":"","sources":["../../src/node-process/ChildProcessSnapExecutor.ts"],"names":[],"mappings":";;;;;;AAAA,kFAAyD;AACzD,uEAAqE;AACrE,uDAAoE;AACpE,gDAAwB;AAExB,iEAA8D;AAC9D,wCAAiC;AAEjC,MAAa,wBAAyB,SAAQ,mCAAgB;IAC5D,MAAM,CAAC,UAAU;QACf,IAAA,aAAG,EAAC,+BAA+B,CAAC,CAAC;QAErC,MAAM,YAAY,GAAG,IAAI,0CAAoB,EAAE,CAAC;QAChD,MAAM,GAAG,GAAG,IAAI,0BAAe,EAAE,CAAC;QAClC,IAAA,cAAI,EAAC,YAAY,EAAE,GAAU,EAAE,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE;YACrD,IAAI,KAAK,EAAE;gBACT,IAAA,sBAAQ,EAAC,wCAAwC,EAAE,KAAK,CAAC,CAAC;aAC3D;YACD,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,OAAO,CAAC,CAAC;QAClE,MAAM,SAAS,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,QAAQ,CAAQ,CAAC;QACtE,OAAO,IAAI,wBAAwB,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAChE,CAAC;CACF;AAjBD,4DAiBC","sourcesContent":["import ObjectMultiplex from '@metamask/object-multiplex';\nimport { ProcessMessageStream } from '@metamask/post-message-stream';\nimport { logError, SNAP_STREAM_NAMES } from '@metamask/snaps-utils';\nimport pump from 'pump';\n\nimport { BaseSnapExecutor } from '../common/BaseSnapExecutor';\nimport { log } from '../logging';\n\nexport class ChildProcessSnapExecutor extends BaseSnapExecutor {\n  static initialize() {\n    log('Worker: Connecting to parent.');\n\n    const parentStream = new ProcessMessageStream();\n    const mux = new ObjectMultiplex();\n    pump(parentStream, mux as any, parentStream, (error) => {\n      if (error) {\n        logError(`Parent stream failure, closing worker.`, error);\n      }\n      self.close();\n    });\n\n    const commandStream = mux.createStream(SNAP_STREAM_NAMES.COMMAND);\n    const rpcStream = mux.createStream(SNAP_STREAM_NAMES.JSON_RPC) as any;\n    return new ChildProcessSnapExecutor(commandStream, rpcStream);\n  }\n}\n"]}

package/dist/node-thread/ThreadSnapExecutor.js

@@ -9,14 +9,15 @@ const post_message_stream_1 = require("@metamask/post-message-stream");
 const snaps_utils_1 = require("@metamask/snaps-utils");
 const pump_1 = __importDefault(require("pump"));
 const BaseSnapExecutor_1 = require("../common/BaseSnapExecutor");
+const logging_1 = require("../logging");
 class ThreadSnapExecutor extends BaseSnapExecutor_1.BaseSnapExecutor {
     static initialize() {
-        console.log('Worker: Connecting to parent.');
+        (0, logging_1.log)('Worker: Connecting to parent.');
         const parentStream = new post_message_stream_1.ThreadMessageStream();
         const mux = new object_multiplex_1.default();
         (0, pump_1.default)(parentStream, mux, parentStream, (error) => {
             if (error) {
-                console.error(`Parent stream failure, closing worker.`, error);
+                (0, snaps_utils_1.logError)(`Parent stream failure, closing worker.`, error);
             }
             self.close();
         });

package/dist/node-thread/ThreadSnapExecutor.js.map

@@ -1 +1 @@
-{"version":3,"file":"ThreadSnapExecutor.js","sourceRoot":"","sources":["../../src/node-thread/ThreadSnapExecutor.ts"],"names":[],"mappings":";;;;;;AAAA,kFAAyD;AACzD,uEAAoE;AACpE,uDAA0D;AAC1D,gDAAwB;AAExB,iEAA8D;AAE9D,MAAa,kBAAmB,SAAQ,mCAAgB;IACtD,MAAM,CAAC,UAAU;QACf,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;QAE7C,MAAM,YAAY,GAAG,IAAI,yCAAmB,EAAE,CAAC;QAC/C,MAAM,GAAG,GAAG,IAAI,0BAAe,EAAE,CAAC;QAClC,IAAA,cAAI,EAAC,YAAY,EAAE,GAAU,EAAE,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE;YACrD,IAAI,KAAK,EAAE;gBACT,OAAO,CAAC,KAAK,CAAC,wCAAwC,EAAE,KAAK,CAAC,CAAC;aAChE;YACD,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,OAAO,CAAC,CAAC;QAClE,MAAM,SAAS,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,QAAQ,CAAQ,CAAC;QACtE,OAAO,IAAI,kBAAkB,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAC1D,CAAC;CACF;AAjBD,gDAiBC","sourcesContent":["import ObjectMultiplex from '@metamask/object-multiplex';\nimport { ThreadMessageStream } from '@metamask/post-message-stream';\nimport { SNAP_STREAM_NAMES } from '@metamask/snaps-utils';\nimport pump from 'pump';\n\nimport { BaseSnapExecutor } from '../common/BaseSnapExecutor';\n\nexport class ThreadSnapExecutor extends BaseSnapExecutor {\n  static initialize() {\n    console.log('Worker: Connecting to parent.');\n\n    const parentStream = new ThreadMessageStream();\n    const mux = new ObjectMultiplex();\n    pump(parentStream, mux as any, parentStream, (error) => {\n      if (error) {\n        console.error(`Parent stream failure, closing worker.`, error);\n      }\n      self.close();\n    });\n\n    const commandStream = mux.createStream(SNAP_STREAM_NAMES.COMMAND);\n    const rpcStream = mux.createStream(SNAP_STREAM_NAMES.JSON_RPC) as any;\n    return new ThreadSnapExecutor(commandStream, rpcStream);\n  }\n}\n"]}
+{"version":3,"file":"ThreadSnapExecutor.js","sourceRoot":"","sources":["../../src/node-thread/ThreadSnapExecutor.ts"],"names":[],"mappings":";;;;;;AAAA,kFAAyD;AACzD,uEAAoE;AACpE,uDAAoE;AACpE,gDAAwB;AAExB,iEAA8D;AAC9D,wCAAiC;AAEjC,MAAa,kBAAmB,SAAQ,mCAAgB;IACtD,MAAM,CAAC,UAAU;QACf,IAAA,aAAG,EAAC,+BAA+B,CAAC,CAAC;QAErC,MAAM,YAAY,GAAG,IAAI,yCAAmB,EAAE,CAAC;QAC/C,MAAM,GAAG,GAAG,IAAI,0BAAe,EAAE,CAAC;QAClC,IAAA,cAAI,EAAC,YAAY,EAAE,GAAU,EAAE,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE;YACrD,IAAI,KAAK,EAAE;gBACT,IAAA,sBAAQ,EAAC,wCAAwC,EAAE,KAAK,CAAC,CAAC;aAC3D;YACD,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,OAAO,CAAC,CAAC;QAClE,MAAM,SAAS,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,QAAQ,CAAQ,CAAC;QACtE,OAAO,IAAI,kBAAkB,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAC1D,CAAC;CACF;AAjBD,gDAiBC","sourcesContent":["import ObjectMultiplex from '@metamask/object-multiplex';\nimport { ThreadMessageStream } from '@metamask/post-message-stream';\nimport { logError, SNAP_STREAM_NAMES } from '@metamask/snaps-utils';\nimport pump from 'pump';\n\nimport { BaseSnapExecutor } from '../common/BaseSnapExecutor';\nimport { log } from '../logging';\n\nexport class ThreadSnapExecutor extends BaseSnapExecutor {\n  static initialize() {\n    log('Worker: Connecting to parent.');\n\n    const parentStream = new ThreadMessageStream();\n    const mux = new ObjectMultiplex();\n    pump(parentStream, mux as any, parentStream, (error) => {\n      if (error) {\n        logError(`Parent stream failure, closing worker.`, error);\n      }\n      self.close();\n    });\n\n    const commandStream = mux.createStream(SNAP_STREAM_NAMES.COMMAND);\n    const rpcStream = mux.createStream(SNAP_STREAM_NAMES.JSON_RPC) as any;\n    return new ThreadSnapExecutor(commandStream, rpcStream);\n  }\n}\n"]}

package/dist/offscreen/OffscreenSnapExecutor.d.ts

@@ -0,0 +1,34 @@
+import { BasePostMessageStream, WindowPostMessageStream } from '@metamask/post-message-stream';
+declare type ExecutorJob = {
+    id: string;
+    window: Window;
+    stream: WindowPostMessageStream;
+};
+/**
+ * A snap executor using the Offscreen Documents API.
+ *
+ * This is not a traditional snap executor, as it does not execute snaps itself.
+ * Instead, it creates an iframe window for each snap execution, and sends the
+ * snap execution request to the iframe window. The iframe window is responsible
+ * for executing the snap.
+ *
+ * Extensions can only have a single offscreen document, so this executor is
+ * persisted between snap executions. The offscreen snap executor essentially
+ * acts as a proxy between the extension and the iframe execution environment.
+ *
+ * @see https://developer.chrome.com/docs/extensions/reference/offscreen/
+ */
+export declare class OffscreenSnapExecutor {
+    #private;
+    readonly jobs: Record<string, ExecutorJob>;
+    /**
+     * Initialize the executor with the given stream. This is a wrapper around the
+     * constructor.
+     *
+     * @param stream - The stream to use for communication.
+     * @returns The initialized executor.
+     */
+    static initialize(stream: BasePostMessageStream): OffscreenSnapExecutor;
+    constructor(stream: BasePostMessageStream);
+}
+export {};

package/dist/offscreen/OffscreenSnapExecutor.js

@@ -0,0 +1,104 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _OffscreenSnapExecutor_instances, _OffscreenSnapExecutor_stream, _OffscreenSnapExecutor_onData, _OffscreenSnapExecutor_initializeJob, _OffscreenSnapExecutor_terminateJob;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OffscreenSnapExecutor = void 0;
+const post_message_stream_1 = require("@metamask/post-message-stream");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+/**
+ * A snap executor using the Offscreen Documents API.
+ *
+ * This is not a traditional snap executor, as it does not execute snaps itself.
+ * Instead, it creates an iframe window for each snap execution, and sends the
+ * snap execution request to the iframe window. The iframe window is responsible
+ * for executing the snap.
+ *
+ * Extensions can only have a single offscreen document, so this executor is
+ * persisted between snap executions. The offscreen snap executor essentially
+ * acts as a proxy between the extension and the iframe execution environment.
+ *
+ * @see https://developer.chrome.com/docs/extensions/reference/offscreen/
+ */
+class OffscreenSnapExecutor {
+    constructor(stream) {
+        _OffscreenSnapExecutor_instances.add(this);
+        _OffscreenSnapExecutor_stream.set(this, void 0);
+        this.jobs = {};
+        __classPrivateFieldSet(this, _OffscreenSnapExecutor_stream, stream, "f");
+        __classPrivateFieldGet(this, _OffscreenSnapExecutor_stream, "f").on('data', __classPrivateFieldGet(this, _OffscreenSnapExecutor_instances, "m", _OffscreenSnapExecutor_onData).bind(this));
+    }
+    /**
+     * Initialize the executor with the given stream. This is a wrapper around the
+     * constructor.
+     *
+     * @param stream - The stream to use for communication.
+     * @returns The initialized executor.
+     */
+    static initialize(stream) {
+        return new OffscreenSnapExecutor(stream);
+    }
+}
+exports.OffscreenSnapExecutor = OffscreenSnapExecutor;
+_OffscreenSnapExecutor_stream = new WeakMap(), _OffscreenSnapExecutor_instances = new WeakSet(), _OffscreenSnapExecutor_onData = function _OffscreenSnapExecutor_onData(data) {
+    const { jobId, frameUrl, data: request } = data;
+    if (!this.jobs[jobId]) {
+        // This ensures that a job is initialized before it is used. To avoid
+        // code duplication, we call the `#onData` method again, which will
+        // run the rest of the logic after initialization.
+        __classPrivateFieldGet(this, _OffscreenSnapExecutor_instances, "m", _OffscreenSnapExecutor_initializeJob).call(this, jobId, frameUrl)
+            .then(() => {
+            __classPrivateFieldGet(this, _OffscreenSnapExecutor_instances, "m", _OffscreenSnapExecutor_onData).call(this, data);
+        })
+            .catch((error) => {
+            (0, snaps_utils_1.logError)('[Worker] Error initializing job:', error);
+        });
+        return;
+    }
+    // This is a method specific to the `OffscreenSnapExecutor`, as the service
+    // itself does not have access to the iframes directly.
+    if (request.method === 'terminateJob') {
+        __classPrivateFieldGet(this, _OffscreenSnapExecutor_instances, "m", _OffscreenSnapExecutor_terminateJob).call(this, jobId);
+        return;
+    }
+    this.jobs[jobId].stream.write(request);
+}, _OffscreenSnapExecutor_initializeJob = 
+/**
+ * Create a new iframe and set up a stream to communicate with it.
+ *
+ * @param jobId - The job ID.
+ * @param frameUrl - The URL to load in the iframe.
+ */
+async function _OffscreenSnapExecutor_initializeJob(jobId, frameUrl) {
+    const window = await (0, snaps_utils_1.createWindow)(frameUrl, jobId);
+    const jobStream = new post_message_stream_1.WindowPostMessageStream({
+        name: 'parent',
+        target: 'child',
+        targetWindow: window,
+        targetOrigin: '*',
+    });
+    // Write messages from the iframe to the parent, wrapped with the job ID.
+    jobStream.on('data', (data) => {
+        __classPrivateFieldGet(this, _OffscreenSnapExecutor_stream, "f").write({ data, jobId });
+    });
+    this.jobs[jobId] = { id: jobId, window, stream: jobStream };
+    return this.jobs[jobId];
+}, _OffscreenSnapExecutor_terminateJob = function _OffscreenSnapExecutor_terminateJob(jobId) {
+    (0, utils_1.assert)(this.jobs[jobId], `Job "${jobId}" not found.`);
+    const iframe = document.getElementById(jobId);
+    (0, utils_1.assert)(iframe, `Iframe with ID "${jobId}" not found.`);
+    iframe.remove();
+    this.jobs[jobId].stream.destroy();
+    delete this.jobs[jobId];
+};
+//# sourceMappingURL=OffscreenSnapExecutor.js.map

package/dist/offscreen/OffscreenSnapExecutor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OffscreenSnapExecutor.js","sourceRoot":"","sources":["../../src/offscreen/OffscreenSnapExecutor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uEAGuC;AACvC,uDAA+D;AAC/D,2CAAyD;AAQzD;;;;;;;;;;;;;GAaG;AACH,MAAa,qBAAqB;IAgBhC,YAAY,MAA6B;;QAfzC,gDAAwC;QAE/B,SAAI,GAAgC,EAAE,CAAC;QAc9C,uBAAA,IAAI,iCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,qCAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,uBAAA,IAAI,uEAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACnD,CAAC;IAdD;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,MAA6B;QAC7C,OAAO,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;CAqFF;AAnGD,sDAmGC;wKApES,IAA+D;IACrE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAEhD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;QACrB,qEAAqE;QACrE,mEAAmE;QACnE,kDAAkD;QAClD,uBAAA,IAAI,8EAAe,MAAnB,IAAI,EAAgB,KAAK,EAAE,QAAQ,CAAC;aACjC,IAAI,CAAC,GAAG,EAAE;YACT,uBAAA,IAAI,uEAAQ,MAAZ,IAAI,EAAS,IAAI,CAAC,CAAC;QACrB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,IAAA,sBAAQ,EAAC,kCAAkC,EAAE,KAAK,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEL,OAAO;KACR;IAED,2EAA2E;IAC3E,uDAAuD;IACvD,IAAI,OAAO,CAAC,MAAM,KAAK,cAAc,EAAE;QACrC,uBAAA,IAAI,6EAAc,MAAlB,IAAI,EAAe,KAAK,CAAC,CAAC;QAC1B,OAAO;KACR;IAED,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AACzC,CAAC;AAED;;;;;GAKG;AACH,KAAK,+CAAgB,KAAa,EAAE,QAAgB;IAClD,MAAM,MAAM,GAAG,MAAM,IAAA,0BAAY,EAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACnD,MAAM,SAAS,GAAG,IAAI,6CAAuB,CAAC;QAC5C,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,OAAO;QACf,YAAY,EAAE,MAAM;QACpB,YAAY,EAAE,GAAG;KAClB,CAAC,CAAC;IAEH,yEAAyE;IACzE,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;QAC5B,uBAAA,IAAI,qCAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IAC5D,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC,qFAQa,KAAa;IACzB,IAAA,cAAM,EAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,QAAQ,KAAK,cAAc,CAAC,CAAC;IAEtD,MAAM,MAAM,GAAG,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC9C,IAAA,cAAM,EAAC,MAAM,EAAE,mBAAmB,KAAK,cAAc,CAAC,CAAC;IAEvD,MAAM,CAAC,MAAM,EAAE,CAAC;IAChB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IAClC,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC","sourcesContent":["import {\n  BasePostMessageStream,\n  WindowPostMessageStream,\n} from '@metamask/post-message-stream';\nimport { createWindow, logError } from '@metamask/snaps-utils';\nimport { JsonRpcRequest, assert } from '@metamask/utils';\n\ntype ExecutorJob = {\n  id: string;\n  window: Window;\n  stream: WindowPostMessageStream;\n};\n\n/**\n * A snap executor using the Offscreen Documents API.\n *\n * This is not a traditional snap executor, as it does not execute snaps itself.\n * Instead, it creates an iframe window for each snap execution, and sends the\n * snap execution request to the iframe window. The iframe window is responsible\n * for executing the snap.\n *\n * Extensions can only have a single offscreen document, so this executor is\n * persisted between snap executions. The offscreen snap executor essentially\n * acts as a proxy between the extension and the iframe execution environment.\n *\n * @see https://developer.chrome.com/docs/extensions/reference/offscreen/\n */\nexport class OffscreenSnapExecutor {\n  readonly #stream: BasePostMessageStream;\n\n  readonly jobs: Record<string, ExecutorJob> = {};\n\n  /**\n   * Initialize the executor with the given stream. This is a wrapper around the\n   * constructor.\n   *\n   * @param stream - The stream to use for communication.\n   * @returns The initialized executor.\n   */\n  static initialize(stream: BasePostMessageStream) {\n    return new OffscreenSnapExecutor(stream);\n  }\n\n  constructor(stream: BasePostMessageStream) {\n    this.#stream = stream;\n    this.#stream.on('data', this.#onData.bind(this));\n  }\n\n  /**\n   * Handle an incoming message from the `OffscreenExecutionService`. This\n   * assumes that the message contains a `jobId` property, and a JSON-RPC\n   * request in the `data` property.\n   *\n   * @param data - The message data.\n   * @param data.data - The JSON-RPC request.\n   * @param data.jobId - The job ID.\n   * @param data.frameUrl - The URL to load in the iframe.\n   */\n  #onData(data: { data: JsonRpcRequest; jobId: string; frameUrl: string }) {\n    const { jobId, frameUrl, data: request } = data;\n\n    if (!this.jobs[jobId]) {\n      // This ensures that a job is initialized before it is used. To avoid\n      // code duplication, we call the `#onData` method again, which will\n      // run the rest of the logic after initialization.\n      this.#initializeJob(jobId, frameUrl)\n        .then(() => {\n          this.#onData(data);\n        })\n        .catch((error) => {\n          logError('[Worker] Error initializing job:', error);\n        });\n\n      return;\n    }\n\n    // This is a method specific to the `OffscreenSnapExecutor`, as the service\n    // itself does not have access to the iframes directly.\n    if (request.method === 'terminateJob') {\n      this.#terminateJob(jobId);\n      return;\n    }\n\n    this.jobs[jobId].stream.write(request);\n  }\n\n  /**\n   * Create a new iframe and set up a stream to communicate with it.\n   *\n   * @param jobId - The job ID.\n   * @param frameUrl - The URL to load in the iframe.\n   */\n  async #initializeJob(jobId: string, frameUrl: string): Promise<ExecutorJob> {\n    const window = await createWindow(frameUrl, jobId);\n    const jobStream = new WindowPostMessageStream({\n      name: 'parent',\n      target: 'child',\n      targetWindow: window,\n      targetOrigin: '*',\n    });\n\n    // Write messages from the iframe to the parent, wrapped with the job ID.\n    jobStream.on('data', (data) => {\n      this.#stream.write({ data, jobId });\n    });\n\n    this.jobs[jobId] = { id: jobId, window, stream: jobStream };\n    return this.jobs[jobId];\n  }\n\n  /**\n   * Terminate the job with the given ID. This will close the iframe and delete\n   * the job from the internal job map.\n   *\n   * @param jobId - The job ID.\n   */\n  #terminateJob(jobId: string) {\n    assert(this.jobs[jobId], `Job \"${jobId}\" not found.`);\n\n    const iframe = document.getElementById(jobId);\n    assert(iframe, `Iframe with ID \"${jobId}\" not found.`);\n\n    iframe.remove();\n    this.jobs[jobId].stream.destroy();\n    delete this.jobs[jobId];\n  }\n}\n"]}

package/dist/offscreen/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/offscreen/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const post_message_stream_1 = require("@metamask/post-message-stream");
+const lockdown_1 = require("../common/lockdown/lockdown");
+const lockdown_more_1 = require("../common/lockdown/lockdown-more");
+const OffscreenSnapExecutor_1 = require("./OffscreenSnapExecutor");
+(0, lockdown_1.executeLockdown)();
+(0, lockdown_more_1.executeLockdownMore)();
+// The stream from the offscreen document to the execution service.
+const parentStream = new post_message_stream_1.BrowserRuntimePostMessageStream({
+    name: 'child',
+    target: 'parent',
+});
+OffscreenSnapExecutor_1.OffscreenSnapExecutor.initialize(parentStream);
+//# sourceMappingURL=index.js.map

package/dist/offscreen/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/offscreen/index.ts"],"names":[],"mappings":";;AAAA,uEAAgF;AAEhF,0DAA8D;AAC9D,oEAAuE;AACvE,mEAAgE;AAEhE,IAAA,0BAAe,GAAE,CAAC;AAClB,IAAA,mCAAmB,GAAE,CAAC;AAEtB,mEAAmE;AACnE,MAAM,YAAY,GAAG,IAAI,qDAA+B,CAAC;IACvD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,QAAQ;CACjB,CAAC,CAAC;AAEH,6CAAqB,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC","sourcesContent":["import { BrowserRuntimePostMessageStream } from '@metamask/post-message-stream';\n\nimport { executeLockdown } from '../common/lockdown/lockdown';\nimport { executeLockdownMore } from '../common/lockdown/lockdown-more';\nimport { OffscreenSnapExecutor } from './OffscreenSnapExecutor';\n\nexecuteLockdown();\nexecuteLockdownMore();\n\n// The stream from the offscreen document to the execution service.\nconst parentStream = new BrowserRuntimePostMessageStream({\n  name: 'child',\n  target: 'parent',\n});\n\nOffscreenSnapExecutor.initialize(parentStream);\n"]}