@metamask/snaps-execution-environments 0.32.2 → 0.33.1-flask.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/CHANGELOG.md +303 -0
  2. package/dist/browserify/iframe/bundle.js +453 -665
  3. package/dist/browserify/iframe/index.html +2 -2
  4. package/dist/browserify/node-process/bundle.js +276 -488
  5. package/dist/browserify/node-thread/bundle.js +276 -488
  6. package/dist/browserify/offscreen/bundle.js +162 -416
  7. package/dist/browserify/offscreen/index.html +2 -2
  8. package/dist/browserify/worker-executor/bundle.js +17874 -0
  9. package/dist/browserify/worker-pool/bundle.js +2026 -0
  10. package/dist/browserify/worker-pool/index.html +11660 -0
  11. package/dist/common/BaseSnapExecutor.d.ts +4 -4
  12. package/dist/common/BaseSnapExecutor.js +22 -22
  13. package/dist/common/BaseSnapExecutor.js.map +1 -1
  14. package/dist/common/commands.js +2 -2
  15. package/dist/common/commands.js.map +1 -1
  16. package/dist/common/endowments/commonEndowmentFactory.d.ts +5 -1
  17. package/dist/common/endowments/commonEndowmentFactory.js +2 -1
  18. package/dist/common/endowments/commonEndowmentFactory.js.map +1 -1
  19. package/dist/common/endowments/console.d.ts +45 -0
  20. package/dist/common/endowments/console.js +103 -0
  21. package/dist/common/endowments/console.js.map +1 -0
  22. package/dist/common/endowments/crypto.d.ts +4 -0
  23. package/dist/common/endowments/crypto.js +3 -1
  24. package/dist/common/endowments/crypto.js.map +1 -1
  25. package/dist/common/endowments/index.d.ts +3 -1
  26. package/dist/common/endowments/index.js +3 -3
  27. package/dist/common/endowments/index.js.map +1 -1
  28. package/dist/common/endowments/math.js +4 -1
  29. package/dist/common/endowments/math.js.map +1 -1
  30. package/dist/common/utils.js +2 -1
  31. package/dist/common/utils.js.map +1 -1
  32. package/dist/offscreen/OffscreenSnapExecutor.js +1 -1
  33. package/dist/offscreen/OffscreenSnapExecutor.js.map +1 -1
  34. package/dist/openrpc.json +2 -2
  35. package/dist/webworker/executor/WebWorkerSnapExecutor.d.ts +13 -0
  36. package/dist/webworker/executor/WebWorkerSnapExecutor.js +37 -0
  37. package/dist/webworker/executor/WebWorkerSnapExecutor.js.map +1 -0
  38. package/dist/webworker/executor/index.d.ts +1 -0
  39. package/dist/webworker/executor/index.js +10 -0
  40. package/dist/webworker/executor/index.js.map +1 -0
  41. package/dist/webworker/pool/WebWorkerPool.d.ts +22 -0
  42. package/dist/webworker/pool/WebWorkerPool.js +168 -0
  43. package/dist/webworker/pool/WebWorkerPool.js.map +1 -0
  44. package/dist/webworker/pool/index.d.ts +1 -0
  45. package/dist/webworker/pool/index.js +10 -0
  46. package/dist/webworker/pool/index.js.map +1 -0
  47. package/package.json +21 -20
@@ -22,11 +22,11 @@ export declare class BaseSnapExecutor {
22
22
  * Attempts to evaluate a snap in SES. Generates APIs for the snap. May throw
23
23
  * on errors.
24
24
  *
25
- * @param snapName - The name of the snap.
25
+ * @param snapId - The id of the snap.
26
26
  * @param sourceCode - The source code of the snap, in IIFE format.
27
27
  * @param _endowments - An array of the names of the endowments.
28
28
  */
29
- protected startSnap(snapName: string, sourceCode: string, _endowments?: string[]): Promise<void>;
29
+ protected startSnap(snapId: string, sourceCode: string, _endowments?: string[]): Promise<void>;
30
30
  /**
31
31
  * Cancels all running evaluations of all snaps and clears all snap data.
32
32
  * NOTE:** Should only be called in response to the `terminate` RPC command.
@@ -50,7 +50,7 @@ export declare class BaseSnapExecutor {
50
50
  /**
51
51
  * Removes the snap with the given name.
52
52
  *
53
- * @param snapName - The name of the snap to remove.
53
+ * @param snapId - The id of the snap to remove.
54
54
  */
55
55
  private removeSnap;
56
56
  /**
@@ -59,7 +59,7 @@ export declare class BaseSnapExecutor {
59
59
  * counted as an evaluation of the specified snap. When the count of running
60
60
  * evaluations of a snap reaches zero, its endowments are torn down.
61
61
  *
62
- * @param snapName - The name of the snap whose context to execute in.
62
+ * @param snapId - The id of the snap whose context to execute in.
63
63
  * @param executor - The function that will be executed in the snap's context.
64
64
  * @returns The executor's return value.
65
65
  * @template Result - The return value of the executor.
@@ -37,7 +37,7 @@ const EXECUTION_ENVIRONMENT_METHODS = {
37
37
  },
38
38
  executeSnap: {
39
39
  struct: validation_1.ExecuteSnapRequestArgumentsStruct,
40
- params: ['snapName', 'sourceCode', 'endowments'],
40
+ params: ['snapId', 'sourceCode', 'endowments'],
41
41
  },
42
42
  terminate: {
43
43
  struct: validation_1.TerminateRequestArgumentsStruct,
@@ -171,12 +171,12 @@ class BaseSnapExecutor {
171
171
  * Attempts to evaluate a snap in SES. Generates APIs for the snap. May throw
172
172
  * on errors.
173
173
  *
174
- * @param snapName - The name of the snap.
174
+ * @param snapId - The id of the snap.
175
175
  * @param sourceCode - The source code of the snap, in IIFE format.
176
176
  * @param _endowments - An array of the names of the endowments.
177
177
  */
178
- async startSnap(snapName, sourceCode, _endowments) {
179
- (0, logging_1.log)(`Starting snap '${snapName}' in worker.`);
178
+ async startSnap(snapId, sourceCode, _endowments) {
179
+ (0, logging_1.log)(`Starting snap '${snapId}' in worker.`);
180
180
  if (this.snapPromiseErrorHandler) {
181
181
  (0, globalEvents_1.removeEventListener)('unhandledrejection', this.snapPromiseErrorHandler);
182
182
  }
@@ -184,11 +184,11 @@ class BaseSnapExecutor {
184
184
  (0, globalEvents_1.removeEventListener)('error', this.snapErrorHandler);
185
185
  }
186
186
  this.snapErrorHandler = (error) => {
187
- this.errorHandler(error.error, { snapName });
187
+ this.errorHandler(error.error, { snapId });
188
188
  };
189
189
  this.snapPromiseErrorHandler = (error) => {
190
190
  this.errorHandler(error instanceof Error ? error : error.reason, {
191
- snapName,
191
+ snapId,
192
192
  });
193
193
  };
194
194
  const provider = new providers_1.StreamProvider(this.rpcStream, {
@@ -201,10 +201,10 @@ class BaseSnapExecutor {
201
201
  // We specifically use any type because the Snap can modify the object any way they want
202
202
  const snapModule = { exports: {} };
203
203
  try {
204
- const { endowments, teardown: endowmentTeardown } = (0, endowments_1.createEndowments)(snap, ethereum, _endowments);
204
+ const { endowments, teardown: endowmentTeardown } = (0, endowments_1.createEndowments)(snap, ethereum, snapId, _endowments);
205
205
  // !!! Ensure that this is the only place the data is being set.
206
206
  // Other methods access the object value and mutate its properties.
207
- this.snapData.set(snapName, {
207
+ this.snapData.set(snapId, {
208
208
  idleTeardown: endowmentTeardown,
209
209
  runningEvaluations: new Set(),
210
210
  exports: {},
@@ -224,14 +224,14 @@ class BaseSnapExecutor {
224
224
  compartment.globalThis.self = compartment.globalThis;
225
225
  compartment.globalThis.global = compartment.globalThis;
226
226
  compartment.globalThis.window = compartment.globalThis;
227
- await this.executeInSnapContext(snapName, () => {
227
+ await this.executeInSnapContext(snapId, () => {
228
228
  compartment.evaluate(sourceCode);
229
- this.registerSnapExports(snapName, snapModule);
229
+ this.registerSnapExports(snapId, snapModule);
230
230
  });
231
231
  }
232
232
  catch (error) {
233
- this.removeSnap(snapName);
234
- throw new Error(`Error while running snap '${snapName}': ${error.message}`);
233
+ this.removeSnap(snapId);
234
+ throw new Error(`Error while running snap '${snapId}': ${error.message}`);
235
235
  }
236
236
  }
237
237
  /**
@@ -245,8 +245,8 @@ class BaseSnapExecutor {
245
245
  this.snapData.forEach((data) => data.runningEvaluations.forEach((evaluation) => evaluation.stop()));
246
246
  this.snapData.clear();
247
247
  }
248
- registerSnapExports(snapName, snapModule) {
249
- const data = this.snapData.get(snapName);
248
+ registerSnapExports(snapId, snapModule) {
249
+ const data = this.snapData.get(snapId);
250
250
  // Somebody deleted the Snap before we could register
251
251
  if (!data) {
252
252
  return;
@@ -316,10 +316,10 @@ class BaseSnapExecutor {
316
316
  /**
317
317
  * Removes the snap with the given name.
318
318
  *
319
- * @param snapName - The name of the snap to remove.
319
+ * @param snapId - The id of the snap to remove.
320
320
  */
321
- removeSnap(snapName) {
322
- this.snapData.delete(snapName);
321
+ removeSnap(snapId) {
322
+ this.snapData.delete(snapId);
323
323
  }
324
324
  /**
325
325
  * Calls the specified executor function in the context of the specified snap.
@@ -327,20 +327,20 @@ class BaseSnapExecutor {
327
327
  * counted as an evaluation of the specified snap. When the count of running
328
328
  * evaluations of a snap reaches zero, its endowments are torn down.
329
329
  *
330
- * @param snapName - The name of the snap whose context to execute in.
330
+ * @param snapId - The id of the snap whose context to execute in.
331
331
  * @param executor - The function that will be executed in the snap's context.
332
332
  * @returns The executor's return value.
333
333
  * @template Result - The return value of the executor.
334
334
  */
335
- async executeInSnapContext(snapName, executor) {
336
- const data = this.snapData.get(snapName);
335
+ async executeInSnapContext(snapId, executor) {
336
+ const data = this.snapData.get(snapId);
337
337
  if (data === undefined) {
338
- throw new Error(`Tried to execute in context of unknown snap: "${snapName}".`);
338
+ throw new Error(`Tried to execute in context of unknown snap: "${snapId}".`);
339
339
  }
340
340
  let stop;
341
341
  const stopPromise = new Promise((_, reject) => (stop = () => reject(
342
342
  // TODO(rekmarks): Specify / standardize error code for this case.
343
- eth_rpc_errors_1.ethErrors.rpc.internal(`The snap "${snapName}" has been terminated during execution.`))));
343
+ eth_rpc_errors_1.ethErrors.rpc.internal(`The snap "${snapId}" has been terminated during execution.`))));
344
344
  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
345
345
  const evaluationData = { stop: stop };
346
346
  try {
@@ -1 +1 @@
1
- {"version":3,"file":"BaseSnapExecutor.js","sourceRoot":"","sources":["../../src/common/BaseSnapExecutor.ts"],"names":[],"mappings":";;;;;;AAAA,qFAAqF;AACrF,gEAAgE;AAChE,mDAAqD;AAGrD,uDAM+B;AAC/B,2CAUyB;AACzB,mDAAuE;AACvE,qDAA0D;AAE1D,6CAAuC;AAEvC,wCAAiC;AACjC,mEAAgD;AAChD,yCAGoB;AACpB,6CAAgD;AAChD,iDAAuE;AACvE,uCAAwC;AACxC,6CAA6C;AAC7C,mCAMiB;AACjB,6CAMsB;AAYtB,MAAM,aAAa,GAAG;IACpB,IAAI,EAAE,2BAAU,CAAC,GAAG,CAAC,QAAQ;IAC7B,OAAO,EAAE,6BAA6B;CACvC,CAAC;AAYF;;;;GAIG;AACH,MAAM,6BAA6B,GAAG;IACpC,IAAI,EAAE;QACJ,MAAM,EAAE,uCAA0B;QAClC,MAAM,EAAE,EAAE;KACX;IACD,WAAW,EAAE;QACX,MAAM,EAAE,8CAAiC;QACzC,MAAM,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,YAAY,CAAC;KACjD;IACD,SAAS,EAAE;QACT,MAAM,EAAE,4CAA+B;QACvC,MAAM,EAAE,EAAE;KACX;IACD,OAAO,EAAE;QACP,MAAM,EAAE,0CAA6B;QACrC,MAAM,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC;KACnD;CACF,CAAC;AAIF,MAAa,gBAAgB;IAe3B,YAAsB,aAAqB,EAAE,SAAiB;QAFtD,iBAAY,GAAG,CAAC,CAAC;QAGvB,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;QAC1B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YACrC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC1C,qCAAqC;gBACrC,IAAA,sBAAQ,EAAC,KAAK,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,IAAI,CAAC,OAAO,GAAG,IAAA,0CAA+B,EAC5C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EACzB,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE;YAClC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACvC,uFAAuF;YACvF,MAAM,OAAO,GACX,WAAW,KAAK,yBAAW,CAAC,WAAW;gBACrC,CAAC,CAAC,IAAA,qBAAW,EAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC;gBAC5D,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;YACjC,IAAA,cAAM,EACJ,OAAO,KAAK,SAAS,EACrB,MAAM,WAAW,+BAA+B,MAAM,EAAE,CACzD,CAAC;YACF,mCAAmC;YACnC,IAAI,MAAM,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,GAAG,EAAE,CACxD,OAAO,CAAC,IAAW,CAAC,CACrB,CAAC;YAEF,0EAA0E;YAC1E,IAAI,MAAM,KAAK,SAAS,EAAE;gBACxB,MAAM,GAAG,IAAI,CAAC;aACf;YAED,IAAA,cAAM,EACJ,IAAA,mBAAW,EAAC,MAAM,CAAC,EACnB,IAAI,SAAS,CAAC,uCAAuC,CAAC,CACvD,CAAC;YACF,OAAO,MAAM,CAAC;QAChB,CAAC,EACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAC5B,CAAC;IACJ,CAAC;IAEO,YAAY,CAAC,KAAc,EAAE,IAA0B;QAC7D,MAAM,gBAAgB,GAAG,IAAA,sBAAc,EAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,eAAe,GAAG,IAAA,+BAAc,EAAC,gBAAgB,EAAE;YACvD,aAAa;YACb,kBAAkB,EAAE,KAAK;SAC1B,CAAC,CAAC;QAEH,gEAAgE;QAChE,MAAM,QAAQ,GAAS,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,IAAI,IAAI,EAAE,CAAC;QAE3E,IAAI,CAAC,MAAM,CAAC;YACV,MAAM,EAAE,gBAAgB;YACxB,MAAM,EAAE;gBACN,KAAK,EAAE;oBACL,GAAG,eAAe;oBAClB,IAAI,EAAE,QAAQ;iBACf;aACF;SACF,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,OAAuB;QACpD,IAAI,CAAC,IAAA,wBAAgB,EAAC,OAAO,CAAC,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACpE;QAED,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QACvC,IAAI,MAAM,KAAK,cAAc,EAAE;YAC7B,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACf,MAAM,EAAE,sBAAiB;aAC1B,CAAC,CAAC;YACH,OAAO;SACR;QAED,IAAI,CAAC,IAAA,mBAAW,EAAC,6BAA6B,EAAE,MAAM,CAAC,EAAE;YACvD,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACf,KAAK,EAAE,0BAAS,CAAC,GAAG;qBACjB,cAAc,CAAC;oBACd,IAAI,EAAE;wBACJ,MAAM;qBACP;iBACF,CAAC;qBACD,SAAS,EAAE;aACf,CAAC,CAAC;YACH,OAAO;SACR;QAED,MAAM,YAAY,GAAG,6BAA6B,CAAC,MAAuB,CAAC,CAAC;QAE5E,yCAAyC;QACzC,MAAM,aAAa,GAAG,IAAA,0BAAa,EAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAEjE,MAAM,CAAC,KAAK,CAAC,GAAG,IAAA,sBAAQ,EAAW,aAAa,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;QACvE,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACf,KAAK,EAAE,0BAAS,CAAC,GAAG;qBACjB,aAAa,CAAC;oBACb,OAAO,EAAE,kCAAkC,MAAM,MAAM,KAAK,CAAC,OAAO,GAAG;oBACvE,IAAI,EAAE;wBACJ,MAAM;wBACN,MAAM,EAAE,aAAa;qBACtB;iBACF,CAAC;qBACD,SAAS,EAAE;aACf,CAAC,CAAC;YACH,OAAO;SACR;QAED,IAAI;YACF,MAAM,MAAM,GAAG,MAAO,IAAI,CAAC,OAAe,CAAC,MAAM,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC;YACrE,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;SAC9B;QAAC,OAAO,QAAQ,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACf,KAAK,EAAE,IAAA,+BAAc,EAAC,QAAQ,EAAE;oBAC9B,aAAa;iBACd,CAAC;aACH,CAAC,CAAC;SACJ;IACH,CAAC;IAES,MAAM,CAAC,aAAmD;QAClE,IAAI,CAAC,IAAA,mBAAW,EAAC,aAAa,CAAC,IAAI,CAAC,IAAA,gBAAQ,EAAC,aAAa,CAAC,EAAE;YAC3D,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;SACH;QAED,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;YACvB,GAAG,aAAa;YAChB,OAAO,EAAE,KAAK;SACf,CAAC,CAAC;IACL,CAAC;IAES,OAAO,CAAC,EAAa,EAAE,aAAsC;QACrE,IAAI,CAAC,IAAA,mBAAW,EAAC,aAAa,CAAC,IAAI,CAAC,IAAA,gBAAQ,EAAC,aAAa,CAAC,EAAE;YAC3D,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;SAC1E;QAED,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;YACvB,GAAG,aAAa;YAChB,EAAE;YACF,OAAO,EAAE,KAAK;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,SAAS,CACvB,QAAgB,EAChB,UAAkB,EAClB,WAAsB;QAEtB,IAAA,aAAG,EAAC,kBAAkB,QAAQ,cAAc,CAAC,CAAC;QAC9C,IAAI,IAAI,CAAC,uBAAuB,EAAE;YAChC,IAAA,kCAAmB,EAAC,oBAAoB,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;SACzE;QAED,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,IAAA,kCAAmB,EAAC,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;SACrD;QAED,IAAI,CAAC,gBAAgB,GAAG,CAAC,KAAiB,EAAE,EAAE;YAC5C,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC/C,CAAC,CAAC;QAEF,IAAI,CAAC,uBAAuB,GAAG,CAAC,KAA4B,EAAE,EAAE;YAC9D,IAAI,CAAC,YAAY,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE;gBAC/D,QAAQ;aACT,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,0BAAc,CAAC,IAAI,CAAC,SAAS,EAAE;YAClD,iBAAiB,EAAE,mBAAmB;YACtC,aAAa,EAAE,CAAC,IAAA,yCAAuB,GAAE,CAAC;SAC3C,CAAC,CAAC;QAEH,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;QAE5B,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QACtD,wFAAwF;QACxF,MAAM,UAAU,GAAQ,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAExC,IAAI;YACF,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,iBAAiB,EAAE,GAAG,IAAA,6BAAgB,EAClE,IAAI,EACJ,QAAQ,EACR,WAAW,CACZ,CAAC;YAEF,gEAAgE;YAChE,mEAAmE;YACnE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE;gBAC1B,YAAY,EAAE,iBAAiB;gBAC/B,kBAAkB,EAAE,IAAI,GAAG,EAAE;gBAC7B,OAAO,EAAE,EAAE;aACZ,CAAC,CAAC;YAEH,IAAA,+BAAgB,EAAC,oBAAoB,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;YACrE,IAAA,+BAAgB,EAAC,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAEjD,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC;gBAClC,GAAG,UAAU;gBACb,MAAM,EAAE,UAAU;gBAClB,OAAO,EAAE,UAAU,CAAC,OAAO;aAC5B,CAAC,CAAC;YACH,qEAAqE;YACrE,kEAAkE;YAClE,EAAE;YACF,wDAAwD;YACxD,yCAAyC;YACzC,WAAW,CAAC,UAAU,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,CAAC;YACrD,WAAW,CAAC,UAAU,CAAC,MAAM,GAAG,WAAW,CAAC,UAAU,CAAC;YACvD,WAAW,CAAC,UAAU,CAAC,MAAM,GAAG,WAAW,CAAC,UAAU,CAAC;YAEvD,MAAM,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE,GAAG,EAAE;gBAC7C,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBACjC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;SACJ;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,6BAA6B,QAAQ,MAAO,KAAe,CAAC,OAAO,EAAE,CACtE,CAAC;SACH;IACH,CAAC;IAED;;;OAGG;IACO,WAAW;QACnB,uCAAuC;QACvC,+DAA+D;QAC/D,6CAA6C;QAC7C,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAC7B,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CACnE,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;IAEO,mBAAmB,CAAC,QAAgB,EAAE,UAAe;QAC3D,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzC,qDAAqD;QACrD,IAAI,CAAC,IAAI,EAAE;YACT,OAAO;SACR;QAED,IAAI,CAAC,OAAO,GAAG,+BAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE;YAC1D,MAAM,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAClD,IAAI,IAAA,2BAAc,EAAC,UAAU,EAAE,UAAU,CAAC,EAAE;gBAC1C,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,CAAC;aAC7C;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAED;;;;;OAKG;IACK,gBAAgB,CAAC,QAAwB;QAC/C,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAExD,MAAM,OAAO,GAAG,KAAK,EAAE,IAAsB,EAAE,EAAE;YAC/C,IAAA,iCAAyB,EAAC,IAAI,CAAC,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAC3C,IAAI;gBACF,OAAO,MAAM,IAAA,oBAAY,EAAC,eAAe,CAAC,IAAI,CAAC,EAAE,IAAW,CAAC,CAAC;aAC/D;oBAAS;gBACR,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC,CAAC;aAC7C;QACH,CAAC,CAAC;QAEF,qEAAqE;QACrE,sDAAsD;QACtD,MAAM,eAAe,GAAG,IAAI,KAAK,CAC/B,EAAE,EACF;YACE,GAAG,CAAC,OAAe,EAAE,IAAqB;gBACxC,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAChE,CAAC;YACD,GAAG,CAAC,OAAO,EAAE,IAA0B;gBACrC,IAAI,IAAI,KAAK,SAAS,EAAE;oBACtB,OAAO,OAAO,CAAC;iBAChB;gBAED,OAAO,SAAS,CAAC;YACnB,CAAC;SACF,CACmB,CAAC;QAEvB,OAAO,MAAM,CAAC,eAAe,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACK,qBAAqB,CAAC,QAAwB;QACpD,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAExD,MAAM,OAAO,GAAG,KAAK,EAAE,IAAsB,EAAE,EAAE;YAC/C,IAAA,qCAA6B,EAAC,IAAI,CAAC,CAAC;YACpC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAC3C,IAAI;gBACF,OAAO,MAAM,IAAA,oBAAY,EAAC,eAAe,CAAC,IAAI,CAAC,EAAE,IAAW,CAAC,CAAC;aAC/D;oBAAS;gBACR,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC,CAAC;aAC7C;QACH,CAAC,CAAC;QAEF,MAAM,mBAAmB,GAAG,IAAA,2BAAmB,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAEnE,OAAO,MAAM,CAAC,mBAAmB,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACK,UAAU,CAAC,QAAgB;QACjC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;OAUG;IACK,KAAK,CAAC,oBAAoB,CAChC,QAAgB,EAChB,QAAwC;QAExC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzC,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,MAAM,IAAI,KAAK,CACb,iDAAiD,QAAQ,IAAI,CAC9D,CAAC;SACH;QAED,IAAI,IAAgB,CAAC;QACrB,MAAM,WAAW,GAAG,IAAI,OAAO,CAC7B,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CACZ,CAAC,IAAI,GAAG,GAAG,EAAE,CACX,MAAM;QACJ,kEAAkE;QAClE,0BAAS,CAAC,GAAG,CAAC,QAAQ,CACpB,aAAa,QAAQ,yCAAyC,CAC/D,CACF,CAAC,CACP,CAAC;QAEF,oEAAoE;QACpE,MAAM,cAAc,GAAG,EAAE,IAAI,EAAE,IAAK,EAAE,CAAC;QAEvC,IAAI;YACF,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC5C,8CAA8C;YAC9C,oEAAoE;YACpE,uCAAuC;YACvC,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC;SACtD;gBAAS;YACR,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YAE/C,IAAI,IAAI,CAAC,kBAAkB,CAAC,IAAI,KAAK,CAAC,EAAE;gBACtC,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC;gBACvB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;aAC3B;SACF;IACH,CAAC;CACF;AAvZD,4CAuZC","sourcesContent":["// eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment\n/// <reference path=\"../../../../node_modules/ses/index.d.ts\" />\nimport { StreamProvider } from '@metamask/providers';\nimport { RequestArguments } from '@metamask/providers/dist/BaseProvider';\nimport { SnapsGlobalObject } from '@metamask/rpc-methods';\nimport {\n SnapExports,\n HandlerType,\n SnapExportsParameters,\n SNAP_EXPORT_NAMES,\n logError,\n} from '@metamask/snaps-utils';\nimport {\n isObject,\n isValidJson,\n JsonRpcNotification,\n assert,\n isJsonRpcRequest,\n JsonRpcId,\n JsonRpcRequest,\n Json,\n hasProperty,\n} from '@metamask/utils';\nimport { errorCodes, ethErrors, serializeError } from 'eth-rpc-errors';\nimport { createIdRemapMiddleware } from 'json-rpc-engine';\nimport { Duplex } from 'stream';\nimport { validate } from 'superstruct';\n\nimport { log } from '../logging';\nimport EEOpenRPCDocument from '../openrpc.json';\nimport {\n CommandMethodsMapping,\n getCommandMethodImplementations,\n} from './commands';\nimport { createEndowments } from './endowments';\nimport { addEventListener, removeEventListener } from './globalEvents';\nimport { wrapKeyring } from './keyring';\nimport { sortParamKeys } from './sortParams';\nimport {\n assertEthereumOutboundRequest,\n assertSnapOutboundRequest,\n constructError,\n proxyStreamProvider,\n withTeardown,\n} from './utils';\nimport {\n ExecuteSnapRequestArgumentsStruct,\n PingRequestArgumentsStruct,\n SnapRpcRequestArgumentsStruct,\n TerminateRequestArgumentsStruct,\n validateExport,\n} from './validation';\n\ntype EvaluationData = {\n stop: () => void;\n};\n\ntype SnapData = {\n exports: SnapExports;\n runningEvaluations: Set<EvaluationData>;\n idleTeardown: () => Promise<void>;\n};\n\nconst fallbackError = {\n code: errorCodes.rpc.internal,\n message: 'Execution Environment Error',\n};\n\n// TODO: `KeyringParameters` expects a `chainId` for certain methods, but we're\n// not providing it in `getHandlerArguments`, resulting in type errors.\nexport type InvokeSnapArgs = Omit<SnapExportsParameters[0], 'chainId'>;\n\nexport type InvokeSnap = (\n target: string,\n handler: HandlerType,\n args: InvokeSnapArgs | undefined,\n) => Promise<Json>;\n\n/**\n * The supported methods in the execution environment. The validator checks the\n * incoming JSON-RPC request, and the `params` property is used for sorting the\n * parameters, if they are an object.\n */\nconst EXECUTION_ENVIRONMENT_METHODS = {\n ping: {\n struct: PingRequestArgumentsStruct,\n params: [],\n },\n executeSnap: {\n struct: ExecuteSnapRequestArgumentsStruct,\n params: ['snapName', 'sourceCode', 'endowments'],\n },\n terminate: {\n struct: TerminateRequestArgumentsStruct,\n params: [],\n },\n snapRpc: {\n struct: SnapRpcRequestArgumentsStruct,\n params: ['target', 'handler', 'origin', 'request'],\n },\n};\n\ntype Methods = typeof EXECUTION_ENVIRONMENT_METHODS;\n\nexport class BaseSnapExecutor {\n private readonly snapData: Map<string, SnapData>;\n\n private readonly commandStream: Duplex;\n\n private readonly rpcStream: Duplex;\n\n private readonly methods: CommandMethodsMapping;\n\n private snapErrorHandler?: (event: ErrorEvent) => void;\n\n private snapPromiseErrorHandler?: (event: PromiseRejectionEvent) => void;\n\n private lastTeardown = 0;\n\n protected constructor(commandStream: Duplex, rpcStream: Duplex) {\n this.snapData = new Map();\n this.commandStream = commandStream;\n this.commandStream.on('data', (data) => {\n this.onCommandRequest(data).catch((error) => {\n // TODO: Decide how to handle errors.\n logError(error);\n });\n });\n this.rpcStream = rpcStream;\n\n this.methods = getCommandMethodImplementations(\n this.startSnap.bind(this),\n async (target, handlerName, args) => {\n const data = this.snapData.get(target);\n // We're capturing the handler in case someone modifies the data object before the call\n const handler =\n handlerName === HandlerType.SnapKeyring\n ? wrapKeyring(this.notify.bind(this), data?.exports.keyring)\n : data?.exports[handlerName];\n assert(\n handler !== undefined,\n `No ${handlerName} handler exported for snap \"${target}`,\n );\n // TODO: fix handler args type cast\n let result = await this.executeInSnapContext(target, () =>\n handler(args as any),\n );\n\n // The handler might not return anything, but undefined is not valid JSON.\n if (result === undefined) {\n result = null;\n }\n\n assert(\n isValidJson(result),\n new TypeError('Received non-JSON-serializable value.'),\n );\n return result;\n },\n this.onTerminate.bind(this),\n );\n }\n\n private errorHandler(error: unknown, data: Record<string, Json>) {\n const constructedError = constructError(error);\n const serializedError = serializeError(constructedError, {\n fallbackError,\n shouldIncludeStack: false,\n });\n\n // We're setting it this way to avoid sentData.stack = undefined\n const sentData: Json = { ...data, stack: constructedError?.stack ?? null };\n\n this.notify({\n method: 'UnhandledError',\n params: {\n error: {\n ...serializedError,\n data: sentData,\n },\n },\n });\n }\n\n private async onCommandRequest(message: JsonRpcRequest) {\n if (!isJsonRpcRequest(message)) {\n throw new Error('Command stream received a non-JSON-RPC request.');\n }\n\n const { id, method, params } = message;\n if (method === 'rpc.discover') {\n this.respond(id, {\n result: EEOpenRPCDocument,\n });\n return;\n }\n\n if (!hasProperty(EXECUTION_ENVIRONMENT_METHODS, method)) {\n this.respond(id, {\n error: ethErrors.rpc\n .methodNotFound({\n data: {\n method,\n },\n })\n .serialize(),\n });\n return;\n }\n\n const methodObject = EXECUTION_ENVIRONMENT_METHODS[method as keyof Methods];\n\n // support params by-name and by-position\n const paramsAsArray = sortParamKeys(methodObject.params, params);\n\n const [error] = validate<any, any>(paramsAsArray, methodObject.struct);\n if (error) {\n this.respond(id, {\n error: ethErrors.rpc\n .invalidParams({\n message: `Invalid parameters for method \"${method}\": ${error.message}.`,\n data: {\n method,\n params: paramsAsArray,\n },\n })\n .serialize(),\n });\n return;\n }\n\n try {\n const result = await (this.methods as any)[method](...paramsAsArray);\n this.respond(id, { result });\n } catch (rpcError) {\n this.respond(id, {\n error: serializeError(rpcError, {\n fallbackError,\n }),\n });\n }\n }\n\n protected notify(requestObject: Omit<JsonRpcNotification, 'jsonrpc'>) {\n if (!isValidJson(requestObject) || !isObject(requestObject)) {\n throw new Error(\n 'JSON-RPC notifications must be JSON serializable objects',\n );\n }\n\n this.commandStream.write({\n ...requestObject,\n jsonrpc: '2.0',\n });\n }\n\n protected respond(id: JsonRpcId, requestObject: Record<string, unknown>) {\n if (!isValidJson(requestObject) || !isObject(requestObject)) {\n throw new Error('JSON-RPC responses must be JSON serializable objects.');\n }\n\n this.commandStream.write({\n ...requestObject,\n id,\n jsonrpc: '2.0',\n });\n }\n\n /**\n * Attempts to evaluate a snap in SES. Generates APIs for the snap. May throw\n * on errors.\n *\n * @param snapName - The name of the snap.\n * @param sourceCode - The source code of the snap, in IIFE format.\n * @param _endowments - An array of the names of the endowments.\n */\n protected async startSnap(\n snapName: string,\n sourceCode: string,\n _endowments?: string[],\n ): Promise<void> {\n log(`Starting snap '${snapName}' in worker.`);\n if (this.snapPromiseErrorHandler) {\n removeEventListener('unhandledrejection', this.snapPromiseErrorHandler);\n }\n\n if (this.snapErrorHandler) {\n removeEventListener('error', this.snapErrorHandler);\n }\n\n this.snapErrorHandler = (error: ErrorEvent) => {\n this.errorHandler(error.error, { snapName });\n };\n\n this.snapPromiseErrorHandler = (error: PromiseRejectionEvent) => {\n this.errorHandler(error instanceof Error ? error : error.reason, {\n snapName,\n });\n };\n\n const provider = new StreamProvider(this.rpcStream, {\n jsonRpcStreamName: 'metamask-provider',\n rpcMiddleware: [createIdRemapMiddleware()],\n });\n\n await provider.initialize();\n\n const snap = this.createSnapGlobal(provider);\n const ethereum = this.createEIP1193Provider(provider);\n // We specifically use any type because the Snap can modify the object any way they want\n const snapModule: any = { exports: {} };\n\n try {\n const { endowments, teardown: endowmentTeardown } = createEndowments(\n snap,\n ethereum,\n _endowments,\n );\n\n // !!! Ensure that this is the only place the data is being set.\n // Other methods access the object value and mutate its properties.\n this.snapData.set(snapName, {\n idleTeardown: endowmentTeardown,\n runningEvaluations: new Set(),\n exports: {},\n });\n\n addEventListener('unhandledRejection', this.snapPromiseErrorHandler);\n addEventListener('error', this.snapErrorHandler);\n\n const compartment = new Compartment({\n ...endowments,\n module: snapModule,\n exports: snapModule.exports,\n });\n // All of those are JavaScript runtime specific and self referential,\n // but we add them for compatibility sake with external libraries.\n //\n // We can't do that in the injected globals object above\n // because SES creates its own globalThis\n compartment.globalThis.self = compartment.globalThis;\n compartment.globalThis.global = compartment.globalThis;\n compartment.globalThis.window = compartment.globalThis;\n\n await this.executeInSnapContext(snapName, () => {\n compartment.evaluate(sourceCode);\n this.registerSnapExports(snapName, snapModule);\n });\n } catch (error) {\n this.removeSnap(snapName);\n throw new Error(\n `Error while running snap '${snapName}': ${(error as Error).message}`,\n );\n }\n }\n\n /**\n * Cancels all running evaluations of all snaps and clears all snap data.\n * NOTE:** Should only be called in response to the `terminate` RPC command.\n */\n protected onTerminate() {\n // `stop()` tears down snap endowments.\n // Teardown will also be run for each snap as soon as there are\n // no more running evaluations for that snap.\n this.snapData.forEach((data) =>\n data.runningEvaluations.forEach((evaluation) => evaluation.stop()),\n );\n this.snapData.clear();\n }\n\n private registerSnapExports(snapName: string, snapModule: any) {\n const data = this.snapData.get(snapName);\n // Somebody deleted the Snap before we could register\n if (!data) {\n return;\n }\n\n data.exports = SNAP_EXPORT_NAMES.reduce((acc, exportName) => {\n const snapExport = snapModule.exports[exportName];\n if (validateExport(exportName, snapExport)) {\n return { ...acc, [exportName]: snapExport };\n }\n return acc;\n }, {});\n }\n\n /**\n * Instantiates a snap API object (i.e. `globalThis.snap`).\n *\n * @param provider - A StreamProvider connected to MetaMask.\n * @returns The snap provider object.\n */\n private createSnapGlobal(provider: StreamProvider): SnapsGlobalObject {\n const originalRequest = provider.request.bind(provider);\n\n const request = async (args: RequestArguments) => {\n assertSnapOutboundRequest(args);\n this.notify({ method: 'OutboundRequest' });\n try {\n return await withTeardown(originalRequest(args), this as any);\n } finally {\n this.notify({ method: 'OutboundResponse' });\n }\n };\n\n // Proxy target is intentionally set to be an empty object, to ensure\n // that access to the prototype chain is not possible.\n const snapGlobalProxy = new Proxy(\n {},\n {\n has(_target: object, prop: string | symbol) {\n return typeof prop === 'string' && ['request'].includes(prop);\n },\n get(_target, prop: keyof StreamProvider) {\n if (prop === 'request') {\n return request;\n }\n\n return undefined;\n },\n },\n ) as SnapsGlobalObject;\n\n return harden(snapGlobalProxy);\n }\n\n /**\n * Instantiates an EIP-1193 Ethereum provider object (i.e. `globalThis.ethereum`).\n *\n * @param provider - A StreamProvider connected to MetaMask.\n * @returns The EIP-1193 Ethereum provider object.\n */\n private createEIP1193Provider(provider: StreamProvider): StreamProvider {\n const originalRequest = provider.request.bind(provider);\n\n const request = async (args: RequestArguments) => {\n assertEthereumOutboundRequest(args);\n this.notify({ method: 'OutboundRequest' });\n try {\n return await withTeardown(originalRequest(args), this as any);\n } finally {\n this.notify({ method: 'OutboundResponse' });\n }\n };\n\n const streamProviderProxy = proxyStreamProvider(provider, request);\n\n return harden(streamProviderProxy);\n }\n\n /**\n * Removes the snap with the given name.\n *\n * @param snapName - The name of the snap to remove.\n */\n private removeSnap(snapName: string): void {\n this.snapData.delete(snapName);\n }\n\n /**\n * Calls the specified executor function in the context of the specified snap.\n * Essentially, this means that the operation performed by the executor is\n * counted as an evaluation of the specified snap. When the count of running\n * evaluations of a snap reaches zero, its endowments are torn down.\n *\n * @param snapName - The name of the snap whose context to execute in.\n * @param executor - The function that will be executed in the snap's context.\n * @returns The executor's return value.\n * @template Result - The return value of the executor.\n */\n private async executeInSnapContext<Result>(\n snapName: string,\n executor: () => Promise<Result> | Result,\n ): Promise<Result> {\n const data = this.snapData.get(snapName);\n if (data === undefined) {\n throw new Error(\n `Tried to execute in context of unknown snap: \"${snapName}\".`,\n );\n }\n\n let stop: () => void;\n const stopPromise = new Promise<never>(\n (_, reject) =>\n (stop = () =>\n reject(\n // TODO(rekmarks): Specify / standardize error code for this case.\n ethErrors.rpc.internal(\n `The snap \"${snapName}\" has been terminated during execution.`,\n ),\n )),\n );\n\n // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n const evaluationData = { stop: stop! };\n\n try {\n data.runningEvaluations.add(evaluationData);\n // Notice that we have to await this executor.\n // If we didn't, we would decrease the amount of running evaluations\n // before the promise actually resolves\n return await Promise.race([executor(), stopPromise]);\n } finally {\n data.runningEvaluations.delete(evaluationData);\n\n if (data.runningEvaluations.size === 0) {\n this.lastTeardown += 1;\n await data.idleTeardown();\n }\n }\n }\n}\n"]}
1
+ {"version":3,"file":"BaseSnapExecutor.js","sourceRoot":"","sources":["../../src/common/BaseSnapExecutor.ts"],"names":[],"mappings":";;;;;;AAAA,qFAAqF;AACrF,gEAAgE;AAChE,mDAAqD;AAGrD,uDAM+B;AAC/B,2CAUyB;AACzB,mDAAuE;AACvE,qDAA0D;AAE1D,6CAAuC;AAEvC,wCAAiC;AACjC,mEAAgD;AAChD,yCAGoB;AACpB,6CAAgD;AAChD,iDAAuE;AACvE,uCAAwC;AACxC,6CAA6C;AAC7C,mCAMiB;AACjB,6CAMsB;AAYtB,MAAM,aAAa,GAAG;IACpB,IAAI,EAAE,2BAAU,CAAC,GAAG,CAAC,QAAQ;IAC7B,OAAO,EAAE,6BAA6B;CACvC,CAAC;AAYF;;;;GAIG;AACH,MAAM,6BAA6B,GAAG;IACpC,IAAI,EAAE;QACJ,MAAM,EAAE,uCAA0B;QAClC,MAAM,EAAE,EAAE;KACX;IACD,WAAW,EAAE;QACX,MAAM,EAAE,8CAAiC;QACzC,MAAM,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,YAAY,CAAC;KAC/C;IACD,SAAS,EAAE;QACT,MAAM,EAAE,4CAA+B;QACvC,MAAM,EAAE,EAAE;KACX;IACD,OAAO,EAAE;QACP,MAAM,EAAE,0CAA6B;QACrC,MAAM,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC;KACnD;CACF,CAAC;AAIF,MAAa,gBAAgB;IAe3B,YAAsB,aAAqB,EAAE,SAAiB;QAFtD,iBAAY,GAAG,CAAC,CAAC;QAGvB,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;QAC1B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YACrC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC1C,qCAAqC;gBACrC,IAAA,sBAAQ,EAAC,KAAK,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,IAAI,CAAC,OAAO,GAAG,IAAA,0CAA+B,EAC5C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EACzB,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE;YAClC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACvC,uFAAuF;YACvF,MAAM,OAAO,GACX,WAAW,KAAK,yBAAW,CAAC,WAAW;gBACrC,CAAC,CAAC,IAAA,qBAAW,EAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC;gBAC5D,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;YACjC,IAAA,cAAM,EACJ,OAAO,KAAK,SAAS,EACrB,MAAM,WAAW,+BAA+B,MAAM,EAAE,CACzD,CAAC;YACF,mCAAmC;YACnC,IAAI,MAAM,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,GAAG,EAAE,CACxD,OAAO,CAAC,IAAW,CAAC,CACrB,CAAC;YAEF,0EAA0E;YAC1E,IAAI,MAAM,KAAK,SAAS,EAAE;gBACxB,MAAM,GAAG,IAAI,CAAC;aACf;YAED,IAAA,cAAM,EACJ,IAAA,mBAAW,EAAC,MAAM,CAAC,EACnB,IAAI,SAAS,CAAC,uCAAuC,CAAC,CACvD,CAAC;YACF,OAAO,MAAM,CAAC;QAChB,CAAC,EACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAC5B,CAAC;IACJ,CAAC;IAEO,YAAY,CAAC,KAAc,EAAE,IAA0B;QAC7D,MAAM,gBAAgB,GAAG,IAAA,sBAAc,EAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,eAAe,GAAG,IAAA,+BAAc,EAAC,gBAAgB,EAAE;YACvD,aAAa;YACb,kBAAkB,EAAE,KAAK;SAC1B,CAAC,CAAC;QAEH,gEAAgE;QAChE,MAAM,QAAQ,GAAS,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,IAAI,IAAI,EAAE,CAAC;QAE3E,IAAI,CAAC,MAAM,CAAC;YACV,MAAM,EAAE,gBAAgB;YACxB,MAAM,EAAE;gBACN,KAAK,EAAE;oBACL,GAAG,eAAe;oBAClB,IAAI,EAAE,QAAQ;iBACf;aACF;SACF,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,OAAuB;QACpD,IAAI,CAAC,IAAA,wBAAgB,EAAC,OAAO,CAAC,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACpE;QAED,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QACvC,IAAI,MAAM,KAAK,cAAc,EAAE;YAC7B,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACf,MAAM,EAAE,sBAAiB;aAC1B,CAAC,CAAC;YACH,OAAO;SACR;QAED,IAAI,CAAC,IAAA,mBAAW,EAAC,6BAA6B,EAAE,MAAM,CAAC,EAAE;YACvD,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACf,KAAK,EAAE,0BAAS,CAAC,GAAG;qBACjB,cAAc,CAAC;oBACd,IAAI,EAAE;wBACJ,MAAM;qBACP;iBACF,CAAC;qBACD,SAAS,EAAE;aACf,CAAC,CAAC;YACH,OAAO;SACR;QAED,MAAM,YAAY,GAAG,6BAA6B,CAAC,MAAuB,CAAC,CAAC;QAE5E,yCAAyC;QACzC,MAAM,aAAa,GAAG,IAAA,0BAAa,EAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAEjE,MAAM,CAAC,KAAK,CAAC,GAAG,IAAA,sBAAQ,EAAW,aAAa,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;QACvE,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACf,KAAK,EAAE,0BAAS,CAAC,GAAG;qBACjB,aAAa,CAAC;oBACb,OAAO,EAAE,kCAAkC,MAAM,MAAM,KAAK,CAAC,OAAO,GAAG;oBACvE,IAAI,EAAE;wBACJ,MAAM;wBACN,MAAM,EAAE,aAAa;qBACtB;iBACF,CAAC;qBACD,SAAS,EAAE;aACf,CAAC,CAAC;YACH,OAAO;SACR;QAED,IAAI;YACF,MAAM,MAAM,GAAG,MAAO,IAAI,CAAC,OAAe,CAAC,MAAM,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC;YACrE,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;SAC9B;QAAC,OAAO,QAAQ,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACf,KAAK,EAAE,IAAA,+BAAc,EAAC,QAAQ,EAAE;oBAC9B,aAAa;iBACd,CAAC;aACH,CAAC,CAAC;SACJ;IACH,CAAC;IAES,MAAM,CAAC,aAAmD;QAClE,IAAI,CAAC,IAAA,mBAAW,EAAC,aAAa,CAAC,IAAI,CAAC,IAAA,gBAAQ,EAAC,aAAa,CAAC,EAAE;YAC3D,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;SACH;QAED,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;YACvB,GAAG,aAAa;YAChB,OAAO,EAAE,KAAK;SACf,CAAC,CAAC;IACL,CAAC;IAES,OAAO,CAAC,EAAa,EAAE,aAAsC;QACrE,IAAI,CAAC,IAAA,mBAAW,EAAC,aAAa,CAAC,IAAI,CAAC,IAAA,gBAAQ,EAAC,aAAa,CAAC,EAAE;YAC3D,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;SAC1E;QAED,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;YACvB,GAAG,aAAa;YAChB,EAAE;YACF,OAAO,EAAE,KAAK;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,SAAS,CACvB,MAAc,EACd,UAAkB,EAClB,WAAsB;QAEtB,IAAA,aAAG,EAAC,kBAAkB,MAAM,cAAc,CAAC,CAAC;QAC5C,IAAI,IAAI,CAAC,uBAAuB,EAAE;YAChC,IAAA,kCAAmB,EAAC,oBAAoB,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;SACzE;QAED,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,IAAA,kCAAmB,EAAC,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;SACrD;QAED,IAAI,CAAC,gBAAgB,GAAG,CAAC,KAAiB,EAAE,EAAE;YAC5C,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAC7C,CAAC,CAAC;QAEF,IAAI,CAAC,uBAAuB,GAAG,CAAC,KAA4B,EAAE,EAAE;YAC9D,IAAI,CAAC,YAAY,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE;gBAC/D,MAAM;aACP,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,0BAAc,CAAC,IAAI,CAAC,SAAS,EAAE;YAClD,iBAAiB,EAAE,mBAAmB;YACtC,aAAa,EAAE,CAAC,IAAA,yCAAuB,GAAE,CAAC;SAC3C,CAAC,CAAC;QAEH,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;QAE5B,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QACtD,wFAAwF;QACxF,MAAM,UAAU,GAAQ,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAExC,IAAI;YACF,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,iBAAiB,EAAE,GAAG,IAAA,6BAAgB,EAClE,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,WAAW,CACZ,CAAC;YAEF,gEAAgE;YAChE,mEAAmE;YACnE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE;gBACxB,YAAY,EAAE,iBAAiB;gBAC/B,kBAAkB,EAAE,IAAI,GAAG,EAAE;gBAC7B,OAAO,EAAE,EAAE;aACZ,CAAC,CAAC;YAEH,IAAA,+BAAgB,EAAC,oBAAoB,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;YACrE,IAAA,+BAAgB,EAAC,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAEjD,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC;gBAClC,GAAG,UAAU;gBACb,MAAM,EAAE,UAAU;gBAClB,OAAO,EAAE,UAAU,CAAC,OAAO;aAC5B,CAAC,CAAC;YACH,qEAAqE;YACrE,kEAAkE;YAClE,EAAE;YACF,wDAAwD;YACxD,yCAAyC;YACzC,WAAW,CAAC,UAAU,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,CAAC;YACrD,WAAW,CAAC,UAAU,CAAC,MAAM,GAAG,WAAW,CAAC,UAAU,CAAC;YACvD,WAAW,CAAC,UAAU,CAAC,MAAM,GAAG,WAAW,CAAC,UAAU,CAAC;YAEvD,MAAM,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,GAAG,EAAE;gBAC3C,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBACjC,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;SACJ;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YACxB,MAAM,IAAI,KAAK,CACb,6BAA6B,MAAM,MAAO,KAAe,CAAC,OAAO,EAAE,CACpE,CAAC;SACH;IACH,CAAC;IAED;;;OAGG;IACO,WAAW;QACnB,uCAAuC;QACvC,+DAA+D;QAC/D,6CAA6C;QAC7C,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAC7B,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CACnE,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;IAEO,mBAAmB,CAAC,MAAc,EAAE,UAAe;QACzD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACvC,qDAAqD;QACrD,IAAI,CAAC,IAAI,EAAE;YACT,OAAO;SACR;QAED,IAAI,CAAC,OAAO,GAAG,+BAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE;YAC1D,MAAM,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAClD,IAAI,IAAA,2BAAc,EAAC,UAAU,EAAE,UAAU,CAAC,EAAE;gBAC1C,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,CAAC;aAC7C;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAED;;;;;OAKG;IACK,gBAAgB,CAAC,QAAwB;QAC/C,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAExD,MAAM,OAAO,GAAG,KAAK,EAAE,IAAsB,EAAE,EAAE;YAC/C,IAAA,iCAAyB,EAAC,IAAI,CAAC,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAC3C,IAAI;gBACF,OAAO,MAAM,IAAA,oBAAY,EAAC,eAAe,CAAC,IAAI,CAAC,EAAE,IAAW,CAAC,CAAC;aAC/D;oBAAS;gBACR,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC,CAAC;aAC7C;QACH,CAAC,CAAC;QAEF,qEAAqE;QACrE,sDAAsD;QACtD,MAAM,eAAe,GAAG,IAAI,KAAK,CAC/B,EAAE,EACF;YACE,GAAG,CAAC,OAAe,EAAE,IAAqB;gBACxC,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAChE,CAAC;YACD,GAAG,CAAC,OAAO,EAAE,IAA0B;gBACrC,IAAI,IAAI,KAAK,SAAS,EAAE;oBACtB,OAAO,OAAO,CAAC;iBAChB;gBAED,OAAO,SAAS,CAAC;YACnB,CAAC;SACF,CACmB,CAAC;QAEvB,OAAO,MAAM,CAAC,eAAe,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACK,qBAAqB,CAAC,QAAwB;QACpD,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAExD,MAAM,OAAO,GAAG,KAAK,EAAE,IAAsB,EAAE,EAAE;YAC/C,IAAA,qCAA6B,EAAC,IAAI,CAAC,CAAC;YACpC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAC3C,IAAI;gBACF,OAAO,MAAM,IAAA,oBAAY,EAAC,eAAe,CAAC,IAAI,CAAC,EAAE,IAAW,CAAC,CAAC;aAC/D;oBAAS;gBACR,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC,CAAC;aAC7C;QACH,CAAC,CAAC;QAEF,MAAM,mBAAmB,GAAG,IAAA,2BAAmB,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAEnE,OAAO,MAAM,CAAC,mBAAmB,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACK,UAAU,CAAC,MAAc;QAC/B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;;;;;OAUG;IACK,KAAK,CAAC,oBAAoB,CAChC,MAAc,EACd,QAAwC;QAExC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,MAAM,IAAI,KAAK,CACb,iDAAiD,MAAM,IAAI,CAC5D,CAAC;SACH;QAED,IAAI,IAAgB,CAAC;QACrB,MAAM,WAAW,GAAG,IAAI,OAAO,CAC7B,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CACZ,CAAC,IAAI,GAAG,GAAG,EAAE,CACX,MAAM;QACJ,kEAAkE;QAClE,0BAAS,CAAC,GAAG,CAAC,QAAQ,CACpB,aAAa,MAAM,yCAAyC,CAC7D,CACF,CAAC,CACP,CAAC;QAEF,oEAAoE;QACpE,MAAM,cAAc,GAAG,EAAE,IAAI,EAAE,IAAK,EAAE,CAAC;QAEvC,IAAI;YACF,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC5C,8CAA8C;YAC9C,oEAAoE;YACpE,uCAAuC;YACvC,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC;SACtD;gBAAS;YACR,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YAE/C,IAAI,IAAI,CAAC,kBAAkB,CAAC,IAAI,KAAK,CAAC,EAAE;gBACtC,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC;gBACvB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;aAC3B;SACF;IACH,CAAC;CACF;AAxZD,4CAwZC","sourcesContent":["// eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment\n/// <reference path=\"../../../../node_modules/ses/index.d.ts\" />\nimport { StreamProvider } from '@metamask/providers';\nimport { RequestArguments } from '@metamask/providers/dist/BaseProvider';\nimport { SnapsGlobalObject } from '@metamask/rpc-methods';\nimport {\n SnapExports,\n HandlerType,\n SnapExportsParameters,\n SNAP_EXPORT_NAMES,\n logError,\n} from '@metamask/snaps-utils';\nimport {\n isObject,\n isValidJson,\n JsonRpcNotification,\n assert,\n isJsonRpcRequest,\n JsonRpcId,\n JsonRpcRequest,\n Json,\n hasProperty,\n} from '@metamask/utils';\nimport { errorCodes, ethErrors, serializeError } from 'eth-rpc-errors';\nimport { createIdRemapMiddleware } from 'json-rpc-engine';\nimport { Duplex } from 'stream';\nimport { validate } from 'superstruct';\n\nimport { log } from '../logging';\nimport EEOpenRPCDocument from '../openrpc.json';\nimport {\n CommandMethodsMapping,\n getCommandMethodImplementations,\n} from './commands';\nimport { createEndowments } from './endowments';\nimport { addEventListener, removeEventListener } from './globalEvents';\nimport { wrapKeyring } from './keyring';\nimport { sortParamKeys } from './sortParams';\nimport {\n assertEthereumOutboundRequest,\n assertSnapOutboundRequest,\n constructError,\n proxyStreamProvider,\n withTeardown,\n} from './utils';\nimport {\n ExecuteSnapRequestArgumentsStruct,\n PingRequestArgumentsStruct,\n SnapRpcRequestArgumentsStruct,\n TerminateRequestArgumentsStruct,\n validateExport,\n} from './validation';\n\ntype EvaluationData = {\n stop: () => void;\n};\n\ntype SnapData = {\n exports: SnapExports;\n runningEvaluations: Set<EvaluationData>;\n idleTeardown: () => Promise<void>;\n};\n\nconst fallbackError = {\n code: errorCodes.rpc.internal,\n message: 'Execution Environment Error',\n};\n\n// TODO: `KeyringParameters` expects a `chainId` for certain methods, but we're\n// not providing it in `getHandlerArguments`, resulting in type errors.\nexport type InvokeSnapArgs = Omit<SnapExportsParameters[0], 'chainId'>;\n\nexport type InvokeSnap = (\n target: string,\n handler: HandlerType,\n args: InvokeSnapArgs | undefined,\n) => Promise<Json>;\n\n/**\n * The supported methods in the execution environment. The validator checks the\n * incoming JSON-RPC request, and the `params` property is used for sorting the\n * parameters, if they are an object.\n */\nconst EXECUTION_ENVIRONMENT_METHODS = {\n ping: {\n struct: PingRequestArgumentsStruct,\n params: [],\n },\n executeSnap: {\n struct: ExecuteSnapRequestArgumentsStruct,\n params: ['snapId', 'sourceCode', 'endowments'],\n },\n terminate: {\n struct: TerminateRequestArgumentsStruct,\n params: [],\n },\n snapRpc: {\n struct: SnapRpcRequestArgumentsStruct,\n params: ['target', 'handler', 'origin', 'request'],\n },\n};\n\ntype Methods = typeof EXECUTION_ENVIRONMENT_METHODS;\n\nexport class BaseSnapExecutor {\n private readonly snapData: Map<string, SnapData>;\n\n private readonly commandStream: Duplex;\n\n private readonly rpcStream: Duplex;\n\n private readonly methods: CommandMethodsMapping;\n\n private snapErrorHandler?: (event: ErrorEvent) => void;\n\n private snapPromiseErrorHandler?: (event: PromiseRejectionEvent) => void;\n\n private lastTeardown = 0;\n\n protected constructor(commandStream: Duplex, rpcStream: Duplex) {\n this.snapData = new Map();\n this.commandStream = commandStream;\n this.commandStream.on('data', (data) => {\n this.onCommandRequest(data).catch((error) => {\n // TODO: Decide how to handle errors.\n logError(error);\n });\n });\n this.rpcStream = rpcStream;\n\n this.methods = getCommandMethodImplementations(\n this.startSnap.bind(this),\n async (target, handlerName, args) => {\n const data = this.snapData.get(target);\n // We're capturing the handler in case someone modifies the data object before the call\n const handler =\n handlerName === HandlerType.SnapKeyring\n ? wrapKeyring(this.notify.bind(this), data?.exports.keyring)\n : data?.exports[handlerName];\n assert(\n handler !== undefined,\n `No ${handlerName} handler exported for snap \"${target}`,\n );\n // TODO: fix handler args type cast\n let result = await this.executeInSnapContext(target, () =>\n handler(args as any),\n );\n\n // The handler might not return anything, but undefined is not valid JSON.\n if (result === undefined) {\n result = null;\n }\n\n assert(\n isValidJson(result),\n new TypeError('Received non-JSON-serializable value.'),\n );\n return result;\n },\n this.onTerminate.bind(this),\n );\n }\n\n private errorHandler(error: unknown, data: Record<string, Json>) {\n const constructedError = constructError(error);\n const serializedError = serializeError(constructedError, {\n fallbackError,\n shouldIncludeStack: false,\n });\n\n // We're setting it this way to avoid sentData.stack = undefined\n const sentData: Json = { ...data, stack: constructedError?.stack ?? null };\n\n this.notify({\n method: 'UnhandledError',\n params: {\n error: {\n ...serializedError,\n data: sentData,\n },\n },\n });\n }\n\n private async onCommandRequest(message: JsonRpcRequest) {\n if (!isJsonRpcRequest(message)) {\n throw new Error('Command stream received a non-JSON-RPC request.');\n }\n\n const { id, method, params } = message;\n if (method === 'rpc.discover') {\n this.respond(id, {\n result: EEOpenRPCDocument,\n });\n return;\n }\n\n if (!hasProperty(EXECUTION_ENVIRONMENT_METHODS, method)) {\n this.respond(id, {\n error: ethErrors.rpc\n .methodNotFound({\n data: {\n method,\n },\n })\n .serialize(),\n });\n return;\n }\n\n const methodObject = EXECUTION_ENVIRONMENT_METHODS[method as keyof Methods];\n\n // support params by-name and by-position\n const paramsAsArray = sortParamKeys(methodObject.params, params);\n\n const [error] = validate<any, any>(paramsAsArray, methodObject.struct);\n if (error) {\n this.respond(id, {\n error: ethErrors.rpc\n .invalidParams({\n message: `Invalid parameters for method \"${method}\": ${error.message}.`,\n data: {\n method,\n params: paramsAsArray,\n },\n })\n .serialize(),\n });\n return;\n }\n\n try {\n const result = await (this.methods as any)[method](...paramsAsArray);\n this.respond(id, { result });\n } catch (rpcError) {\n this.respond(id, {\n error: serializeError(rpcError, {\n fallbackError,\n }),\n });\n }\n }\n\n protected notify(requestObject: Omit<JsonRpcNotification, 'jsonrpc'>) {\n if (!isValidJson(requestObject) || !isObject(requestObject)) {\n throw new Error(\n 'JSON-RPC notifications must be JSON serializable objects',\n );\n }\n\n this.commandStream.write({\n ...requestObject,\n jsonrpc: '2.0',\n });\n }\n\n protected respond(id: JsonRpcId, requestObject: Record<string, unknown>) {\n if (!isValidJson(requestObject) || !isObject(requestObject)) {\n throw new Error('JSON-RPC responses must be JSON serializable objects.');\n }\n\n this.commandStream.write({\n ...requestObject,\n id,\n jsonrpc: '2.0',\n });\n }\n\n /**\n * Attempts to evaluate a snap in SES. Generates APIs for the snap. May throw\n * on errors.\n *\n * @param snapId - The id of the snap.\n * @param sourceCode - The source code of the snap, in IIFE format.\n * @param _endowments - An array of the names of the endowments.\n */\n protected async startSnap(\n snapId: string,\n sourceCode: string,\n _endowments?: string[],\n ): Promise<void> {\n log(`Starting snap '${snapId}' in worker.`);\n if (this.snapPromiseErrorHandler) {\n removeEventListener('unhandledrejection', this.snapPromiseErrorHandler);\n }\n\n if (this.snapErrorHandler) {\n removeEventListener('error', this.snapErrorHandler);\n }\n\n this.snapErrorHandler = (error: ErrorEvent) => {\n this.errorHandler(error.error, { snapId });\n };\n\n this.snapPromiseErrorHandler = (error: PromiseRejectionEvent) => {\n this.errorHandler(error instanceof Error ? error : error.reason, {\n snapId,\n });\n };\n\n const provider = new StreamProvider(this.rpcStream, {\n jsonRpcStreamName: 'metamask-provider',\n rpcMiddleware: [createIdRemapMiddleware()],\n });\n\n await provider.initialize();\n\n const snap = this.createSnapGlobal(provider);\n const ethereum = this.createEIP1193Provider(provider);\n // We specifically use any type because the Snap can modify the object any way they want\n const snapModule: any = { exports: {} };\n\n try {\n const { endowments, teardown: endowmentTeardown } = createEndowments(\n snap,\n ethereum,\n snapId,\n _endowments,\n );\n\n // !!! Ensure that this is the only place the data is being set.\n // Other methods access the object value and mutate its properties.\n this.snapData.set(snapId, {\n idleTeardown: endowmentTeardown,\n runningEvaluations: new Set(),\n exports: {},\n });\n\n addEventListener('unhandledRejection', this.snapPromiseErrorHandler);\n addEventListener('error', this.snapErrorHandler);\n\n const compartment = new Compartment({\n ...endowments,\n module: snapModule,\n exports: snapModule.exports,\n });\n // All of those are JavaScript runtime specific and self referential,\n // but we add them for compatibility sake with external libraries.\n //\n // We can't do that in the injected globals object above\n // because SES creates its own globalThis\n compartment.globalThis.self = compartment.globalThis;\n compartment.globalThis.global = compartment.globalThis;\n compartment.globalThis.window = compartment.globalThis;\n\n await this.executeInSnapContext(snapId, () => {\n compartment.evaluate(sourceCode);\n this.registerSnapExports(snapId, snapModule);\n });\n } catch (error) {\n this.removeSnap(snapId);\n throw new Error(\n `Error while running snap '${snapId}': ${(error as Error).message}`,\n );\n }\n }\n\n /**\n * Cancels all running evaluations of all snaps and clears all snap data.\n * NOTE:** Should only be called in response to the `terminate` RPC command.\n */\n protected onTerminate() {\n // `stop()` tears down snap endowments.\n // Teardown will also be run for each snap as soon as there are\n // no more running evaluations for that snap.\n this.snapData.forEach((data) =>\n data.runningEvaluations.forEach((evaluation) => evaluation.stop()),\n );\n this.snapData.clear();\n }\n\n private registerSnapExports(snapId: string, snapModule: any) {\n const data = this.snapData.get(snapId);\n // Somebody deleted the Snap before we could register\n if (!data) {\n return;\n }\n\n data.exports = SNAP_EXPORT_NAMES.reduce((acc, exportName) => {\n const snapExport = snapModule.exports[exportName];\n if (validateExport(exportName, snapExport)) {\n return { ...acc, [exportName]: snapExport };\n }\n return acc;\n }, {});\n }\n\n /**\n * Instantiates a snap API object (i.e. `globalThis.snap`).\n *\n * @param provider - A StreamProvider connected to MetaMask.\n * @returns The snap provider object.\n */\n private createSnapGlobal(provider: StreamProvider): SnapsGlobalObject {\n const originalRequest = provider.request.bind(provider);\n\n const request = async (args: RequestArguments) => {\n assertSnapOutboundRequest(args);\n this.notify({ method: 'OutboundRequest' });\n try {\n return await withTeardown(originalRequest(args), this as any);\n } finally {\n this.notify({ method: 'OutboundResponse' });\n }\n };\n\n // Proxy target is intentionally set to be an empty object, to ensure\n // that access to the prototype chain is not possible.\n const snapGlobalProxy = new Proxy(\n {},\n {\n has(_target: object, prop: string | symbol) {\n return typeof prop === 'string' && ['request'].includes(prop);\n },\n get(_target, prop: keyof StreamProvider) {\n if (prop === 'request') {\n return request;\n }\n\n return undefined;\n },\n },\n ) as SnapsGlobalObject;\n\n return harden(snapGlobalProxy);\n }\n\n /**\n * Instantiates an EIP-1193 Ethereum provider object (i.e. `globalThis.ethereum`).\n *\n * @param provider - A StreamProvider connected to MetaMask.\n * @returns The EIP-1193 Ethereum provider object.\n */\n private createEIP1193Provider(provider: StreamProvider): StreamProvider {\n const originalRequest = provider.request.bind(provider);\n\n const request = async (args: RequestArguments) => {\n assertEthereumOutboundRequest(args);\n this.notify({ method: 'OutboundRequest' });\n try {\n return await withTeardown(originalRequest(args), this as any);\n } finally {\n this.notify({ method: 'OutboundResponse' });\n }\n };\n\n const streamProviderProxy = proxyStreamProvider(provider, request);\n\n return harden(streamProviderProxy);\n }\n\n /**\n * Removes the snap with the given name.\n *\n * @param snapId - The id of the snap to remove.\n */\n private removeSnap(snapId: string): void {\n this.snapData.delete(snapId);\n }\n\n /**\n * Calls the specified executor function in the context of the specified snap.\n * Essentially, this means that the operation performed by the executor is\n * counted as an evaluation of the specified snap. When the count of running\n * evaluations of a snap reaches zero, its endowments are torn down.\n *\n * @param snapId - The id of the snap whose context to execute in.\n * @param executor - The function that will be executed in the snap's context.\n * @returns The executor's return value.\n * @template Result - The return value of the executor.\n */\n private async executeInSnapContext<Result>(\n snapId: string,\n executor: () => Promise<Result> | Result,\n ): Promise<Result> {\n const data = this.snapData.get(snapId);\n if (data === undefined) {\n throw new Error(\n `Tried to execute in context of unknown snap: \"${snapId}\".`,\n );\n }\n\n let stop: () => void;\n const stopPromise = new Promise<never>(\n (_, reject) =>\n (stop = () =>\n reject(\n // TODO(rekmarks): Specify / standardize error code for this case.\n ethErrors.rpc.internal(\n `The snap \"${snapId}\" has been terminated during execution.`,\n ),\n )),\n );\n\n // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n const evaluationData = { stop: stop! };\n\n try {\n data.runningEvaluations.add(evaluationData);\n // Notice that we have to await this executor.\n // If we didn't, we would decrease the amount of running evaluations\n // before the promise actually resolves\n return await Promise.race([executor(), stopPromise]);\n } finally {\n data.runningEvaluations.delete(evaluationData);\n\n if (data.runningEvaluations.size === 0) {\n this.lastTeardown += 1;\n await data.idleTeardown();\n }\n }\n }\n}\n"]}
@@ -52,8 +52,8 @@ function getCommandMethodImplementations(startSnap, invokeSnap, onTerminate) {
52
52
  onTerminate();
53
53
  return Promise.resolve('OK');
54
54
  },
55
- executeSnap: async (snapName, sourceCode, endowments) => {
56
- await startSnap(snapName, sourceCode, endowments);
55
+ executeSnap: async (snapId, sourceCode, endowments) => {
56
+ await startSnap(snapId, sourceCode, endowments);
57
57
  return 'OK';
58
58
  },
59
59
  snapRpc: async (target, handler, origin, request) => {
@@ -1 +1 @@
1
- {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../src/common/commands.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AACpD,2CAAmD;AAGnD,6CAOsB;AAStB;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CACjC,MAAc,EACd,OAAoB,EACpB,OAAgC;IAEhC,sEAAsE;IAEtE,QAAQ,OAAO,EAAE;QACf,KAAK,yBAAW,CAAC,aAAa,CAAC,CAAC;YAC9B,IAAA,kDAAqC,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAEtD,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;YACnE,OAAO;gBACL,WAAW;gBACX,OAAO;gBACP,iBAAiB;aAClB,CAAC;SACH;QAED,KAAK,yBAAW,CAAC,YAAY,CAAC;QAC9B,KAAK,yBAAW,CAAC,WAAW;YAC1B,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;QAE7B,KAAK,yBAAW,CAAC,SAAS;YACxB,OAAO,EAAE,OAAO,EAAE,CAAC;QAErB;YACE,OAAO,IAAA,wBAAgB,EAAC,OAAO,CAAC,CAAC;KACpC;AACH,CAAC;AA7BD,kDA6BC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,+BAA+B,CAC7C,SAA8D,EAC9D,UAAsB,EACtB,WAAuB;IAEvB,OAAO;QACL,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;QACvC,SAAS,EAAE,KAAK,IAAI,EAAE;YACpB,WAAW,EAAE,CAAC;YACd,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QAED,WAAW,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE;YACtD,MAAM,SAAS,CAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;YAClD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;YAClD,OAAO,CACL,CAAC,MAAM,UAAU,CACf,MAAM,EACN,OAAO,EACP,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAC9C,CAAC,IAAI,IAAI,CACX,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AA3BD,0EA2BC","sourcesContent":["import { HandlerType } from '@metamask/snaps-utils';\nimport { assertExhaustive } from '@metamask/utils';\n\nimport { InvokeSnap, InvokeSnapArgs } from './BaseSnapExecutor';\nimport {\n assertIsOnTransactionRequestArguments,\n ExecuteSnap,\n JsonRpcRequestWithoutId,\n Ping,\n SnapRpc,\n Terminate,\n} from './validation';\n\nexport type CommandMethodsMapping = {\n ping: Ping;\n terminate: Terminate;\n executeSnap: ExecuteSnap;\n snapRpc: SnapRpc;\n};\n\n/**\n * Formats the arguments for the given handler.\n *\n * @param origin - The origin of the request.\n * @param handler - The handler to pass the request to.\n * @param request - The request object.\n * @returns The formatted arguments.\n */\nexport function getHandlerArguments(\n origin: string,\n handler: HandlerType,\n request: JsonRpcRequestWithoutId,\n): InvokeSnapArgs {\n // `request` is already validated by the time this function is called.\n\n switch (handler) {\n case HandlerType.OnTransaction: {\n assertIsOnTransactionRequestArguments(request.params);\n\n const { transaction, chainId, transactionOrigin } = request.params;\n return {\n transaction,\n chainId,\n transactionOrigin,\n };\n }\n\n case HandlerType.OnRpcRequest:\n case HandlerType.SnapKeyring:\n return { origin, request };\n\n case HandlerType.OnCronjob:\n return { request };\n\n default:\n return assertExhaustive(handler);\n }\n}\n\n/**\n * Gets an object mapping internal, \"command\" JSON-RPC method names to their\n * implementations.\n *\n * @param startSnap - A function that starts a snap.\n * @param invokeSnap - A function that invokes the RPC method handler of a\n * snap.\n * @param onTerminate - A function that will be called when this executor is\n * terminated in order to handle cleanup tasks.\n * @returns An object containing the \"command\" method implementations.\n */\nexport function getCommandMethodImplementations(\n startSnap: (...args: Parameters<ExecuteSnap>) => Promise<void>,\n invokeSnap: InvokeSnap,\n onTerminate: () => void,\n): CommandMethodsMapping {\n return {\n ping: async () => Promise.resolve('OK'),\n terminate: async () => {\n onTerminate();\n return Promise.resolve('OK');\n },\n\n executeSnap: async (snapName, sourceCode, endowments) => {\n await startSnap(snapName, sourceCode, endowments);\n return 'OK';\n },\n\n snapRpc: async (target, handler, origin, request) => {\n return (\n (await invokeSnap(\n target,\n handler,\n getHandlerArguments(origin, handler, request),\n )) ?? null\n );\n },\n };\n}\n"]}
1
+ {"version":3,"file":"commands.js","sourceRoot":"","sources":["../../src/common/commands.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AACpD,2CAAmD;AAGnD,6CAOsB;AAStB;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CACjC,MAAc,EACd,OAAoB,EACpB,OAAgC;IAEhC,sEAAsE;IAEtE,QAAQ,OAAO,EAAE;QACf,KAAK,yBAAW,CAAC,aAAa,CAAC,CAAC;YAC9B,IAAA,kDAAqC,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAEtD,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;YACnE,OAAO;gBACL,WAAW;gBACX,OAAO;gBACP,iBAAiB;aAClB,CAAC;SACH;QAED,KAAK,yBAAW,CAAC,YAAY,CAAC;QAC9B,KAAK,yBAAW,CAAC,WAAW;YAC1B,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;QAE7B,KAAK,yBAAW,CAAC,SAAS;YACxB,OAAO,EAAE,OAAO,EAAE,CAAC;QAErB;YACE,OAAO,IAAA,wBAAgB,EAAC,OAAO,CAAC,CAAC;KACpC;AACH,CAAC;AA7BD,kDA6BC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,+BAA+B,CAC7C,SAA8D,EAC9D,UAAsB,EACtB,WAAuB;IAEvB,OAAO;QACL,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;QACvC,SAAS,EAAE,KAAK,IAAI,EAAE;YACpB,WAAW,EAAE,CAAC;YACd,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QAED,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE;YACpD,MAAM,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;YAClD,OAAO,CACL,CAAC,MAAM,UAAU,CACf,MAAM,EACN,OAAO,EACP,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAC9C,CAAC,IAAI,IAAI,CACX,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AA3BD,0EA2BC","sourcesContent":["import { HandlerType } from '@metamask/snaps-utils';\nimport { assertExhaustive } from '@metamask/utils';\n\nimport { InvokeSnap, InvokeSnapArgs } from './BaseSnapExecutor';\nimport {\n assertIsOnTransactionRequestArguments,\n ExecuteSnap,\n JsonRpcRequestWithoutId,\n Ping,\n SnapRpc,\n Terminate,\n} from './validation';\n\nexport type CommandMethodsMapping = {\n ping: Ping;\n terminate: Terminate;\n executeSnap: ExecuteSnap;\n snapRpc: SnapRpc;\n};\n\n/**\n * Formats the arguments for the given handler.\n *\n * @param origin - The origin of the request.\n * @param handler - The handler to pass the request to.\n * @param request - The request object.\n * @returns The formatted arguments.\n */\nexport function getHandlerArguments(\n origin: string,\n handler: HandlerType,\n request: JsonRpcRequestWithoutId,\n): InvokeSnapArgs {\n // `request` is already validated by the time this function is called.\n\n switch (handler) {\n case HandlerType.OnTransaction: {\n assertIsOnTransactionRequestArguments(request.params);\n\n const { transaction, chainId, transactionOrigin } = request.params;\n return {\n transaction,\n chainId,\n transactionOrigin,\n };\n }\n\n case HandlerType.OnRpcRequest:\n case HandlerType.SnapKeyring:\n return { origin, request };\n\n case HandlerType.OnCronjob:\n return { request };\n\n default:\n return assertExhaustive(handler);\n }\n}\n\n/**\n * Gets an object mapping internal, \"command\" JSON-RPC method names to their\n * implementations.\n *\n * @param startSnap - A function that starts a snap.\n * @param invokeSnap - A function that invokes the RPC method handler of a\n * snap.\n * @param onTerminate - A function that will be called when this executor is\n * terminated in order to handle cleanup tasks.\n * @returns An object containing the \"command\" method implementations.\n */\nexport function getCommandMethodImplementations(\n startSnap: (...args: Parameters<ExecuteSnap>) => Promise<void>,\n invokeSnap: InvokeSnap,\n onTerminate: () => void,\n): CommandMethodsMapping {\n return {\n ping: async () => Promise.resolve('OK'),\n terminate: async () => {\n onTerminate();\n return Promise.resolve('OK');\n },\n\n executeSnap: async (snapId, sourceCode, endowments) => {\n await startSnap(snapId, sourceCode, endowments);\n return 'OK';\n },\n\n snapRpc: async (target, handler, origin, request) => {\n return (\n (await invokeSnap(\n target,\n handler,\n getHandlerArguments(origin, handler, request),\n )) ?? null\n );\n },\n };\n}\n"]}
@@ -1,6 +1,10 @@
1
+ import { SnapId } from '@metamask/snaps-utils';
2
+ export declare type EndowmentFactoryOptions = {
3
+ snapId?: SnapId;
4
+ };
1
5
  export declare type EndowmentFactory = {
2
6
  names: readonly string[];
3
- factory: () => {
7
+ factory: (options?: EndowmentFactoryOptions) => {
4
8
  [key: string]: unknown;
5
9
  };
6
10
  };
@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  const globalObject_1 = require("../globalObject");
7
+ const console_1 = __importDefault(require("./console"));
7
8
  const crypto_1 = __importDefault(require("./crypto"));
8
9
  const date_1 = __importDefault(require("./date"));
9
10
  const interval_1 = __importDefault(require("./interval"));
@@ -22,7 +23,6 @@ const commonEndowments = [
22
23
  { endowment: BigInt64Array, name: 'BigInt64Array' },
23
24
  { endowment: BigUint64Array, name: 'BigUint64Array' },
24
25
  { endowment: btoa, name: 'btoa', bind: true },
25
- { endowment: console, name: 'console' },
26
26
  { endowment: DataView, name: 'DataView' },
27
27
  { endowment: Float32Array, name: 'Float32Array' },
28
28
  { endowment: Float64Array, name: 'Float64Array' },
@@ -53,6 +53,7 @@ const buildCommonEndowments = () => {
53
53
  textDecoder_1.default,
54
54
  textEncoder_1.default,
55
55
  date_1.default,
56
+ console_1.default,
56
57
  ];
57
58
  commonEndowments.forEach((endowmentSpecification) => {
58
59
  const endowment = {
@@ -1 +1 @@
1
- {"version":3,"file":"commonEndowmentFactory.js","sourceRoot":"","sources":["../../../src/common/endowments/commonEndowmentFactory.ts"],"names":[],"mappings":";;;;;AAAA,kDAAkD;AAClD,sDAA8B;AAC9B,kDAA0B;AAC1B,0DAAkC;AAClC,kDAA0B;AAC1B,wDAAgC;AAChC,gEAAwC;AACxC,gEAAwC;AACxC,wDAAgC;AAahC,6BAA6B;AAC7B,MAAM,gBAAgB,GAAmC;IACvD,EAAE,SAAS,EAAE,eAAe,EAAE,IAAI,EAAE,iBAAiB,EAAE;IACvD,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE;IAC/C,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE;IAC/C,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAC7C,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE;IACrC,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE;IACnD,EAAE,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,gBAAgB,EAAE;IACrD,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAC7C,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;IACvC,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE;IACzC,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE;IACjD,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE;IACjD,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE;IAC3C,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE;IAC7C,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE;IAC7C,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE;IAC7C,EAAE,SAAS,EAAE,iBAAiB,EAAE,IAAI,EAAE,mBAAmB,EAAE;IAC3D,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE;IAC/C,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE;IAC/C,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE;IAC/B,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE;CAChD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,qBAAqB,GAAG,GAAuB,EAAE;IACrD,MAAM,kBAAkB,GAAuB;QAC7C,gBAAM;QACN,kBAAQ;QACR,cAAI;QACJ,iBAAO;QACP,iBAAO;QACP,qBAAW;QACX,qBAAW;QACX,cAAI;KACL,CAAC;IAEF,gBAAgB,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,EAAE;QAClD,MAAM,SAAS,GAAG;YAChB,KAAK,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAU;YAC7C,OAAO,EAAE,GAAG,EAAE;gBACZ,MAAM,cAAc,GAClB,OAAO,sBAAsB,CAAC,SAAS,KAAK,UAAU;oBACtD,sBAAsB,CAAC,IAAI;oBACzB,CAAC,CAAC,sBAAsB,CAAC,SAAS,CAAC,IAAI,CAAC,8BAAe,CAAC;oBACxD,CAAC,CAAC,sBAAsB,CAAC,SAAS,CAAC;gBACvC,OAAO;oBACL,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;iBAC7C,CAAC;YACb,CAAC;SACF,CAAC;QACF,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,OAAO,kBAAkB,CAAC;AAC5B,CAAC,CAAC;AAEF,kBAAe,qBAAqB,CAAC","sourcesContent":["import { rootRealmGlobal } from '../globalObject';\nimport crypto from './crypto';\nimport date from './date';\nimport interval from './interval';\nimport math from './math';\nimport network from './network';\nimport textDecoder from './textDecoder';\nimport textEncoder from './textEncoder';\nimport timeout from './timeout';\n\nexport type EndowmentFactory = {\n names: readonly string[];\n factory: () => { [key: string]: unknown };\n};\n\nexport type CommonEndowmentSpecification = {\n endowment: unknown;\n name: string;\n bind?: boolean;\n};\n\n// Array of common endowments\nconst commonEndowments: CommonEndowmentSpecification[] = [\n { endowment: AbortController, name: 'AbortController' },\n { endowment: AbortSignal, name: 'AbortSignal' },\n { endowment: ArrayBuffer, name: 'ArrayBuffer' },\n { endowment: atob, name: 'atob', bind: true },\n { endowment: BigInt, name: 'BigInt' },\n { endowment: BigInt64Array, name: 'BigInt64Array' },\n { endowment: BigUint64Array, name: 'BigUint64Array' },\n { endowment: btoa, name: 'btoa', bind: true },\n { endowment: console, name: 'console' },\n { endowment: DataView, name: 'DataView' },\n { endowment: Float32Array, name: 'Float32Array' },\n { endowment: Float64Array, name: 'Float64Array' },\n { endowment: Int8Array, name: 'Int8Array' },\n { endowment: Int16Array, name: 'Int16Array' },\n { endowment: Int32Array, name: 'Int32Array' },\n { endowment: Uint8Array, name: 'Uint8Array' },\n { endowment: Uint8ClampedArray, name: 'Uint8ClampedArray' },\n { endowment: Uint16Array, name: 'Uint16Array' },\n { endowment: Uint32Array, name: 'Uint32Array' },\n { endowment: URL, name: 'URL' },\n { endowment: WebAssembly, name: 'WebAssembly' },\n];\n\n/**\n * Creates a consolidated collection of common endowments.\n * This function will return factories for all common endowments including\n * the additionally attenuated. All hardened with SES.\n *\n * @returns An object with common endowments.\n */\nconst buildCommonEndowments = (): EndowmentFactory[] => {\n const endowmentFactories: EndowmentFactory[] = [\n crypto,\n interval,\n math,\n network,\n timeout,\n textDecoder,\n textEncoder,\n date,\n ];\n\n commonEndowments.forEach((endowmentSpecification) => {\n const endowment = {\n names: [endowmentSpecification.name] as const,\n factory: () => {\n const boundEndowment =\n typeof endowmentSpecification.endowment === 'function' &&\n endowmentSpecification.bind\n ? endowmentSpecification.endowment.bind(rootRealmGlobal)\n : endowmentSpecification.endowment;\n return {\n [endowmentSpecification.name]: harden(boundEndowment),\n } as const;\n },\n };\n endowmentFactories.push(endowment);\n });\n\n return endowmentFactories;\n};\n\nexport default buildCommonEndowments;\n"]}
1
+ {"version":3,"file":"commonEndowmentFactory.js","sourceRoot":"","sources":["../../../src/common/endowments/commonEndowmentFactory.ts"],"names":[],"mappings":";;;;;AAEA,kDAAkD;AAClD,wDAAyC;AACzC,sDAA8B;AAC9B,kDAA0B;AAC1B,0DAAkC;AAClC,kDAA0B;AAC1B,wDAAgC;AAChC,gEAAwC;AACxC,gEAAwC;AACxC,wDAAgC;AAiBhC,6BAA6B;AAC7B,MAAM,gBAAgB,GAAmC;IACvD,EAAE,SAAS,EAAE,eAAe,EAAE,IAAI,EAAE,iBAAiB,EAAE;IACvD,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE;IAC/C,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE;IAC/C,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAC7C,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE;IACrC,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE;IACnD,EAAE,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,gBAAgB,EAAE;IACrD,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAC7C,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE;IACzC,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE;IACjD,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE;IACjD,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE;IAC3C,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE;IAC7C,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE;IAC7C,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE;IAC7C,EAAE,SAAS,EAAE,iBAAiB,EAAE,IAAI,EAAE,mBAAmB,EAAE;IAC3D,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE;IAC/C,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE;IAC/C,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE;IAC/B,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE;CAChD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,qBAAqB,GAAG,GAAuB,EAAE;IACrD,MAAM,kBAAkB,GAAuB;QAC7C,gBAAM;QACN,kBAAQ;QACR,cAAI;QACJ,iBAAO;QACP,iBAAO;QACP,qBAAW;QACX,qBAAW;QACX,cAAI;QACJ,iBAAgB;KACjB,CAAC;IAEF,gBAAgB,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,EAAE;QAClD,MAAM,SAAS,GAAG;YAChB,KAAK,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAU;YAC7C,OAAO,EAAE,GAAG,EAAE;gBACZ,MAAM,cAAc,GAClB,OAAO,sBAAsB,CAAC,SAAS,KAAK,UAAU;oBACtD,sBAAsB,CAAC,IAAI;oBACzB,CAAC,CAAC,sBAAsB,CAAC,SAAS,CAAC,IAAI,CAAC,8BAAe,CAAC;oBACxD,CAAC,CAAC,sBAAsB,CAAC,SAAS,CAAC;gBACvC,OAAO;oBACL,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;iBAC7C,CAAC;YACb,CAAC;SACF,CAAC;QACF,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,OAAO,kBAAkB,CAAC;AAC5B,CAAC,CAAC;AAEF,kBAAe,qBAAqB,CAAC","sourcesContent":["import { SnapId } from '@metamask/snaps-utils';\n\nimport { rootRealmGlobal } from '../globalObject';\nimport consoleEndowment from './console';\nimport crypto from './crypto';\nimport date from './date';\nimport interval from './interval';\nimport math from './math';\nimport network from './network';\nimport textDecoder from './textDecoder';\nimport textEncoder from './textEncoder';\nimport timeout from './timeout';\n\nexport type EndowmentFactoryOptions = {\n snapId?: SnapId;\n};\n\nexport type EndowmentFactory = {\n names: readonly string[];\n factory: (options?: EndowmentFactoryOptions) => { [key: string]: unknown };\n};\n\nexport type CommonEndowmentSpecification = {\n endowment: unknown;\n name: string;\n bind?: boolean;\n};\n\n// Array of common endowments\nconst commonEndowments: CommonEndowmentSpecification[] = [\n { endowment: AbortController, name: 'AbortController' },\n { endowment: AbortSignal, name: 'AbortSignal' },\n { endowment: ArrayBuffer, name: 'ArrayBuffer' },\n { endowment: atob, name: 'atob', bind: true },\n { endowment: BigInt, name: 'BigInt' },\n { endowment: BigInt64Array, name: 'BigInt64Array' },\n { endowment: BigUint64Array, name: 'BigUint64Array' },\n { endowment: btoa, name: 'btoa', bind: true },\n { endowment: DataView, name: 'DataView' },\n { endowment: Float32Array, name: 'Float32Array' },\n { endowment: Float64Array, name: 'Float64Array' },\n { endowment: Int8Array, name: 'Int8Array' },\n { endowment: Int16Array, name: 'Int16Array' },\n { endowment: Int32Array, name: 'Int32Array' },\n { endowment: Uint8Array, name: 'Uint8Array' },\n { endowment: Uint8ClampedArray, name: 'Uint8ClampedArray' },\n { endowment: Uint16Array, name: 'Uint16Array' },\n { endowment: Uint32Array, name: 'Uint32Array' },\n { endowment: URL, name: 'URL' },\n { endowment: WebAssembly, name: 'WebAssembly' },\n];\n\n/**\n * Creates a consolidated collection of common endowments.\n * This function will return factories for all common endowments including\n * the additionally attenuated. All hardened with SES.\n *\n * @returns An object with common endowments.\n */\nconst buildCommonEndowments = (): EndowmentFactory[] => {\n const endowmentFactories: EndowmentFactory[] = [\n crypto,\n interval,\n math,\n network,\n timeout,\n textDecoder,\n textEncoder,\n date,\n consoleEndowment,\n ];\n\n commonEndowments.forEach((endowmentSpecification) => {\n const endowment = {\n names: [endowmentSpecification.name] as const,\n factory: () => {\n const boundEndowment =\n typeof endowmentSpecification.endowment === 'function' &&\n endowmentSpecification.bind\n ? endowmentSpecification.endowment.bind(rootRealmGlobal)\n : endowmentSpecification.endowment;\n return {\n [endowmentSpecification.name]: harden(boundEndowment),\n } as const;\n },\n };\n endowmentFactories.push(endowment);\n });\n\n return endowmentFactories;\n};\n\nexport default buildCommonEndowments;\n"]}
@@ -0,0 +1,45 @@
1
+ import { EndowmentFactoryOptions } from './commonEndowmentFactory';
2
+ export declare const consoleAttenuatedMethods: Set<string>;
3
+ /**
4
+ * A set of all the `console` values that will be passed to the snap. This has
5
+ * all the values that are available in both the browser and Node.js.
6
+ */
7
+ export declare const consoleMethods: Set<string>;
8
+ /**
9
+ * Create a a {@link console} object, with the same properties as the global
10
+ * {@link console} object, but with some methods replaced.
11
+ *
12
+ * @param options - Factory options used in construction of the endowment.
13
+ * @param options.snapId - The id of the snap that will interact with the endowment.
14
+ * @returns The {@link console} object with the replaced methods.
15
+ */
16
+ declare function createConsole({ snapId }?: EndowmentFactoryOptions): {
17
+ console: {
18
+ error: {
19
+ (...data: any[]): void;
20
+ (message?: any, ...optionalParams: any[]): void;
21
+ };
22
+ log: {
23
+ (...data: any[]): void;
24
+ (message?: any, ...optionalParams: any[]): void;
25
+ };
26
+ warn: {
27
+ (...data: any[]): void;
28
+ (message?: any, ...optionalParams: any[]): void;
29
+ };
30
+ debug: {
31
+ (...data: any[]): void;
32
+ (message?: any, ...optionalParams: any[]): void;
33
+ };
34
+ info: {
35
+ (...data: any[]): void;
36
+ (message?: any, ...optionalParams: any[]): void;
37
+ };
38
+ assert: (value: any, message?: string | undefined, ...optionalParams: any[]) => void;
39
+ };
40
+ };
41
+ declare const endowmentModule: {
42
+ names: readonly ["console"];
43
+ factory: typeof createConsole;
44
+ };
45
+ export default endowmentModule;
@@ -0,0 +1,103 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.consoleMethods = exports.consoleAttenuatedMethods = void 0;
4
+ const utils_1 = require("@metamask/utils");
5
+ const globalObject_1 = require("../globalObject");
6
+ exports.consoleAttenuatedMethods = new Set([
7
+ 'log',
8
+ 'assert',
9
+ 'error',
10
+ 'debug',
11
+ 'info',
12
+ 'warn',
13
+ ]);
14
+ /**
15
+ * A set of all the `console` values that will be passed to the snap. This has
16
+ * all the values that are available in both the browser and Node.js.
17
+ */
18
+ exports.consoleMethods = new Set([
19
+ 'debug',
20
+ 'error',
21
+ 'info',
22
+ 'log',
23
+ 'warn',
24
+ 'dir',
25
+ 'dirxml',
26
+ 'table',
27
+ 'trace',
28
+ 'group',
29
+ 'groupCollapsed',
30
+ 'groupEnd',
31
+ 'clear',
32
+ 'count',
33
+ 'countReset',
34
+ 'assert',
35
+ 'profile',
36
+ 'profileEnd',
37
+ 'time',
38
+ 'timeLog',
39
+ 'timeEnd',
40
+ 'timeStamp',
41
+ 'context',
42
+ ]);
43
+ const consoleFunctions = ['log', 'error', 'debug', 'info', 'warn'];
44
+ /**
45
+ * Gets the appropriate (prepended) message to pass to one of the attenuated
46
+ * method calls.
47
+ *
48
+ * @param snapId - Id of the snap that we're getting a message for.
49
+ * @param message - The id of the snap that will interact with the endowment.
50
+ * @param args - The array of additional arguments.
51
+ * @returns An array of arguments to be passed into an attenuated console method call.
52
+ */
53
+ function getMessage(snapId, message, ...args) {
54
+ const prefix = `[Snap: ${snapId}]`;
55
+ // If the first argument is a string, prepend the prefix to the message, and keep the
56
+ // rest of the arguments as-is.
57
+ if (typeof message === 'string') {
58
+ return [`${prefix} ${message}`, ...args];
59
+ }
60
+ // Otherwise, the `message` is an object, array, etc., so add the prefix as a separate
61
+ // message to the arguments.
62
+ return [prefix, message, ...args];
63
+ }
64
+ /**
65
+ * Create a a {@link console} object, with the same properties as the global
66
+ * {@link console} object, but with some methods replaced.
67
+ *
68
+ * @param options - Factory options used in construction of the endowment.
69
+ * @param options.snapId - The id of the snap that will interact with the endowment.
70
+ * @returns The {@link console} object with the replaced methods.
71
+ */
72
+ function createConsole({ snapId } = {}) {
73
+ (0, utils_1.assert)(snapId !== undefined);
74
+ const keys = Object.getOwnPropertyNames(globalObject_1.rootRealmGlobal.console);
75
+ const attenuatedConsole = keys.reduce((target, key) => {
76
+ if (exports.consoleMethods.has(key) && !exports.consoleAttenuatedMethods.has(key)) {
77
+ return { ...target, [key]: globalObject_1.rootRealmGlobal.console[key] };
78
+ }
79
+ return target;
80
+ }, {});
81
+ return harden({
82
+ console: {
83
+ ...attenuatedConsole,
84
+ assert: (value, message, ...optionalParams) => {
85
+ globalObject_1.rootRealmGlobal.console.assert(value, ...getMessage(snapId, message, ...optionalParams));
86
+ },
87
+ ...consoleFunctions.reduce((target, key) => {
88
+ return {
89
+ ...target,
90
+ [key]: (message, ...optionalParams) => {
91
+ globalObject_1.rootRealmGlobal.console[key](...getMessage(snapId, message, ...optionalParams));
92
+ },
93
+ };
94
+ }, {}),
95
+ },
96
+ });
97
+ }
98
+ const endowmentModule = {
99
+ names: ['console'],
100
+ factory: createConsole,
101
+ };
102
+ exports.default = endowmentModule;
103
+ //# sourceMappingURL=console.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"console.js","sourceRoot":"","sources":["../../../src/common/endowments/console.ts"],"names":[],"mappings":";;;AACA,2CAAyC;AAEzC,kDAAkD;AAGrC,QAAA,wBAAwB,GAAG,IAAI,GAAG,CAAC;IAC9C,KAAK;IACL,QAAQ;IACR,OAAO;IACP,OAAO;IACP,MAAM;IACN,MAAM;CACP,CAAC,CAAC;AAEH;;;GAGG;AACU,QAAA,cAAc,GAAG,IAAI,GAAG,CAAC;IACpC,OAAO;IACP,OAAO;IACP,MAAM;IACN,KAAK;IACL,MAAM;IACN,KAAK;IACL,QAAQ;IACR,OAAO;IACP,OAAO;IACP,OAAO;IACP,gBAAgB;IAChB,UAAU;IACV,OAAO;IACP,OAAO;IACP,YAAY;IACZ,QAAQ;IACR,SAAS;IACT,YAAY;IACZ,MAAM;IACN,SAAS;IACT,SAAS;IACT,WAAW;IACX,SAAS;CACV,CAAC,CAAC;AAEH,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAU,CAAC;AAM5E;;;;;;;;GAQG;AACH,SAAS,UAAU,CAAC,MAAc,EAAE,OAAgB,EAAE,GAAG,IAAe;IACtE,MAAM,MAAM,GAAG,UAAU,MAAM,GAAG,CAAC;IAEnC,qFAAqF;IACrF,+BAA+B;IAC/B,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC/B,OAAO,CAAC,GAAG,MAAM,IAAI,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;KAC1C;IAED,sFAAsF;IACtF,4BAA4B;IAC5B,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,aAAa,CAAC,EAAE,MAAM,KAA8B,EAAE;IAC7D,IAAA,cAAM,EAAC,MAAM,KAAK,SAAS,CAAC,CAAC;IAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,mBAAmB,CACrC,8BAAe,CAAC,OAAO,CACI,CAAC;IAE9B,MAAM,iBAAiB,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;QACpD,IAAI,sBAAc,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,gCAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACjE,OAAO,EAAE,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,8BAAe,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;SAC3D;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,MAAM,CAAC;QACZ,OAAO,EAAE;YACP,GAAG,iBAAiB;YACpB,MAAM,EAAE,CACN,KAAU,EACV,OAA4B,EAC5B,GAAG,cAAqB,EACxB,EAAE;gBACF,8BAAe,CAAC,OAAO,CAAC,MAAM,CAC5B,KAAK,EACL,GAAG,UAAU,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,CAAC,CAClD,CAAC;YACJ,CAAC;YACD,GAAG,gBAAgB,CAAC,MAAM,CAAmB,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;gBAC3D,OAAO;oBACL,GAAG,MAAM;oBACT,CAAC,GAAG,CAAC,EAAE,CAAC,OAAiB,EAAE,GAAG,cAAqB,EAAE,EAAE;wBACrD,8BAAe,CAAC,OAAO,CAAC,GAAG,CAAC,CAC1B,GAAG,UAAU,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,CAAC,CAClD,CAAC;oBACJ,CAAC;iBACF,CAAC;YACJ,CAAC,EAAE,EAAsB,CAAC;SAC3B;KACF,CAAC,CAAC;AACL,CAAC;AAED,MAAM,eAAe,GAAG;IACtB,KAAK,EAAE,CAAC,SAAS,CAAU;IAC3B,OAAO,EAAE,aAAa;CACvB,CAAC;AAEF,kBAAe,eAAe,CAAC","sourcesContent":["import { SnapId } from '@metamask/snaps-utils';\nimport { assert } from '@metamask/utils';\n\nimport { rootRealmGlobal } from '../globalObject';\nimport { EndowmentFactoryOptions } from './commonEndowmentFactory';\n\nexport const consoleAttenuatedMethods = new Set([\n 'log',\n 'assert',\n 'error',\n 'debug',\n 'info',\n 'warn',\n]);\n\n/**\n * A set of all the `console` values that will be passed to the snap. This has\n * all the values that are available in both the browser and Node.js.\n */\nexport const consoleMethods = new Set([\n 'debug',\n 'error',\n 'info',\n 'log',\n 'warn',\n 'dir',\n 'dirxml',\n 'table',\n 'trace',\n 'group',\n 'groupCollapsed',\n 'groupEnd',\n 'clear',\n 'count',\n 'countReset',\n 'assert',\n 'profile',\n 'profileEnd',\n 'time',\n 'timeLog',\n 'timeEnd',\n 'timeStamp',\n 'context',\n]);\n\nconst consoleFunctions = ['log', 'error', 'debug', 'info', 'warn'] as const;\n\ntype ConsoleFunctions = {\n [Key in typeof consoleFunctions[number]]: typeof rootRealmGlobal.console[Key];\n};\n\n/**\n * Gets the appropriate (prepended) message to pass to one of the attenuated\n * method calls.\n *\n * @param snapId - Id of the snap that we're getting a message for.\n * @param message - The id of the snap that will interact with the endowment.\n * @param args - The array of additional arguments.\n * @returns An array of arguments to be passed into an attenuated console method call.\n */\nfunction getMessage(snapId: SnapId, message: unknown, ...args: unknown[]) {\n const prefix = `[Snap: ${snapId}]`;\n\n // If the first argument is a string, prepend the prefix to the message, and keep the\n // rest of the arguments as-is.\n if (typeof message === 'string') {\n return [`${prefix} ${message}`, ...args];\n }\n\n // Otherwise, the `message` is an object, array, etc., so add the prefix as a separate\n // message to the arguments.\n return [prefix, message, ...args];\n}\n\n/**\n * Create a a {@link console} object, with the same properties as the global\n * {@link console} object, but with some methods replaced.\n *\n * @param options - Factory options used in construction of the endowment.\n * @param options.snapId - The id of the snap that will interact with the endowment.\n * @returns The {@link console} object with the replaced methods.\n */\nfunction createConsole({ snapId }: EndowmentFactoryOptions = {}) {\n assert(snapId !== undefined);\n const keys = Object.getOwnPropertyNames(\n rootRealmGlobal.console,\n ) as (keyof typeof console)[];\n\n const attenuatedConsole = keys.reduce((target, key) => {\n if (consoleMethods.has(key) && !consoleAttenuatedMethods.has(key)) {\n return { ...target, [key]: rootRealmGlobal.console[key] };\n }\n\n return target;\n }, {});\n\n return harden({\n console: {\n ...attenuatedConsole,\n assert: (\n value: any,\n message?: string | undefined,\n ...optionalParams: any[]\n ) => {\n rootRealmGlobal.console.assert(\n value,\n ...getMessage(snapId, message, ...optionalParams),\n );\n },\n ...consoleFunctions.reduce<ConsoleFunctions>((target, key) => {\n return {\n ...target,\n [key]: (message?: unknown, ...optionalParams: any[]) => {\n rootRealmGlobal.console[key](\n ...getMessage(snapId, message, ...optionalParams),\n );\n },\n };\n }, {} as ConsoleFunctions),\n },\n });\n}\n\nconst endowmentModule = {\n names: ['console'] as const,\n factory: createConsole,\n};\n\nexport default endowmentModule;\n"]}
@@ -1,3 +1,7 @@
1
+ export declare const createCrypto: () => {
2
+ readonly crypto: any;
3
+ readonly SubtleCrypto: any;
4
+ };
1
5
  declare const endowmentModule: {
2
6
  names: readonly ["crypto", "SubtleCrypto"];
3
7
  factory: () => {
@@ -1,5 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.createCrypto = void 0;
3
4
  const globalObject_1 = require("../globalObject");
4
5
  const createCrypto = () => {
5
6
  if ('crypto' in globalObject_1.rootRealmGlobal &&
@@ -20,9 +21,10 @@ const createCrypto = () => {
20
21
  SubtleCrypto: harden(crypto.subtle.constructor),
21
22
  };
22
23
  };
24
+ exports.createCrypto = createCrypto;
23
25
  const endowmentModule = {
24
26
  names: ['crypto', 'SubtleCrypto'],
25
- factory: createCrypto,
27
+ factory: exports.createCrypto,
26
28
  };
27
29
  exports.default = endowmentModule;
28
30
  //# sourceMappingURL=crypto.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"crypto.js","sourceRoot":"","sources":["../../../src/common/endowments/crypto.ts"],"names":[],"mappings":";;AAAA,kDAAkD;AAElD,MAAM,YAAY,GAAG,GAAG,EAAE;IACxB,IACE,QAAQ,IAAI,8BAAe;QAC3B,OAAO,8BAAe,CAAC,MAAM,KAAK,QAAQ;QAC1C,cAAc,IAAI,8BAAe;QACjC,OAAO,8BAAe,CAAC,YAAY,KAAK,UAAU,EAClD;QACA,OAAO;YACL,MAAM,EAAE,MAAM,CAAC,8BAAe,CAAC,MAAM,CAAC;YACtC,YAAY,EAAE,MAAM,CAAC,8BAAe,CAAC,YAAY,CAAC;SACnD,CAAC;KACH;IACD,uFAAuF;IACvF,+EAA+E;IAC/E,6HAA6H;IAC7H,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC;IAC3C,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;QACtB,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC;KACvC,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG;IACtB,KAAK,EAAE,CAAC,QAAQ,EAAE,cAAc,CAAU;IAC1C,OAAO,EAAE,YAAY;CACtB,CAAC;AACF,kBAAe,eAAe,CAAC","sourcesContent":["import { rootRealmGlobal } from '../globalObject';\n\nconst createCrypto = () => {\n if (\n 'crypto' in rootRealmGlobal &&\n typeof rootRealmGlobal.crypto === 'object' &&\n 'SubtleCrypto' in rootRealmGlobal &&\n typeof rootRealmGlobal.SubtleCrypto === 'function'\n ) {\n return {\n crypto: harden(rootRealmGlobal.crypto),\n SubtleCrypto: harden(rootRealmGlobal.SubtleCrypto),\n };\n }\n // For now, we expose the experimental webcrypto API for Node.js execution environments\n // TODO: Figure out if this is enough long-term or if we should use a polyfill.\n /* eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires, node/global-require */\n const crypto = require('crypto').webcrypto;\n return {\n crypto: harden(crypto),\n SubtleCrypto: harden(crypto.subtle.constructor),\n } as const;\n};\n\nconst endowmentModule = {\n names: ['crypto', 'SubtleCrypto'] as const,\n factory: createCrypto,\n};\nexport default endowmentModule;\n"]}
1
+ {"version":3,"file":"crypto.js","sourceRoot":"","sources":["../../../src/common/endowments/crypto.ts"],"names":[],"mappings":";;;AAAA,kDAAkD;AAE3C,MAAM,YAAY,GAAG,GAAG,EAAE;IAC/B,IACE,QAAQ,IAAI,8BAAe;QAC3B,OAAO,8BAAe,CAAC,MAAM,KAAK,QAAQ;QAC1C,cAAc,IAAI,8BAAe;QACjC,OAAO,8BAAe,CAAC,YAAY,KAAK,UAAU,EAClD;QACA,OAAO;YACL,MAAM,EAAE,MAAM,CAAC,8BAAe,CAAC,MAAM,CAAC;YACtC,YAAY,EAAE,MAAM,CAAC,8BAAe,CAAC,YAAY,CAAC;SACnD,CAAC;KACH;IACD,uFAAuF;IACvF,+EAA+E;IAC/E,6HAA6H;IAC7H,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC;IAC3C,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;QACtB,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC;KACvC,CAAC;AACb,CAAC,CAAC;AApBW,QAAA,YAAY,gBAoBvB;AAEF,MAAM,eAAe,GAAG;IACtB,KAAK,EAAE,CAAC,QAAQ,EAAE,cAAc,CAAU;IAC1C,OAAO,EAAE,oBAAY;CACtB,CAAC;AACF,kBAAe,eAAe,CAAC","sourcesContent":["import { rootRealmGlobal } from '../globalObject';\n\nexport const createCrypto = () => {\n if (\n 'crypto' in rootRealmGlobal &&\n typeof rootRealmGlobal.crypto === 'object' &&\n 'SubtleCrypto' in rootRealmGlobal &&\n typeof rootRealmGlobal.SubtleCrypto === 'function'\n ) {\n return {\n crypto: harden(rootRealmGlobal.crypto),\n SubtleCrypto: harden(rootRealmGlobal.SubtleCrypto),\n };\n }\n // For now, we expose the experimental webcrypto API for Node.js execution environments\n // TODO: Figure out if this is enough long-term or if we should use a polyfill.\n /* eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires, node/global-require */\n const crypto = require('crypto').webcrypto;\n return {\n crypto: harden(crypto),\n SubtleCrypto: harden(crypto.subtle.constructor),\n } as const;\n};\n\nconst endowmentModule = {\n names: ['crypto', 'SubtleCrypto'] as const,\n factory: createCrypto,\n};\nexport default endowmentModule;\n"]}
@@ -1,5 +1,6 @@
1
1
  import { StreamProvider } from '@metamask/providers';
2
2
  import { SnapsGlobalObject } from '@metamask/rpc-methods';
3
+ import { SnapId } from '@metamask/snaps-utils';
3
4
  /**
4
5
  * Gets the endowments for a particular Snap. Some endowments, like `setTimeout`
5
6
  * and `clearTimeout`, must be attenuated so that they can only affect behavior
@@ -9,10 +10,11 @@ import { SnapsGlobalObject } from '@metamask/rpc-methods';
9
10
  *
10
11
  * @param snap - The Snaps global API object.
11
12
  * @param ethereum - The Snap's EIP-1193 provider object.
13
+ * @param snapId - The id of the snap that will use the created endowments.
12
14
  * @param endowments - The list of endowments to provide to the snap.
13
15
  * @returns An object containing the Snap's endowments.
14
16
  */
15
- export declare function createEndowments(snap: SnapsGlobalObject, ethereum: StreamProvider, endowments?: string[]): {
17
+ export declare function createEndowments(snap: SnapsGlobalObject, ethereum: StreamProvider, snapId: SnapId, endowments?: string[]): {
16
18
  endowments: Record<string, unknown>;
17
19
  teardown: () => Promise<void>;
18
20
  };
@@ -32,10 +32,11 @@ const endowmentFactories = registeredEndowments.reduce((factories, builder) => {
32
32
  *
33
33
  * @param snap - The Snaps global API object.
34
34
  * @param ethereum - The Snap's EIP-1193 provider object.
35
+ * @param snapId - The id of the snap that will use the created endowments.
35
36
  * @param endowments - The list of endowments to provide to the snap.
36
37
  * @returns An object containing the Snap's endowments.
37
38
  */
38
- function createEndowments(snap, ethereum, endowments = []) {
39
+ function createEndowments(snap, ethereum, snapId, endowments = []) {
39
40
  const attenuatedEndowments = {};
40
41
  // TODO: All endowments should be hardened to prevent covert communication
41
42
  // channels. Hardening the returned objects breaks tests elsewhere in the
@@ -50,9 +51,8 @@ function createEndowments(snap, ethereum, endowments = []) {
50
51
  // if explicitly listed among its endowment.
51
52
  // This may not have an actual use case, but, safety first.
52
53
  // We just confirmed that endowmentFactories has the specified key.
53
- const { teardownFunction, ...endowment } =
54
54
  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
55
- endowmentFactories.get(endowmentName)();
55
+ const { teardownFunction, ...endowment } = endowmentFactories.get(endowmentName)({ snapId });
56
56
  Object.assign(attenuatedEndowments, endowment);
57
57
  if (teardownFunction) {
58
58
  teardowns.push(teardownFunction);