@metamask/snaps-execution-environments 0.34.1-flask.1 → 0.35.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 (243) hide show
  1. package/CHANGELOG.md +17 -1
  2. package/dist/cjs/common/BaseSnapExecutor.js +415 -0
  3. package/dist/cjs/common/BaseSnapExecutor.js.map +1 -0
  4. package/dist/cjs/common/commands.js +65 -0
  5. package/dist/cjs/common/commands.js.map +1 -0
  6. package/dist/cjs/common/endowments/commonEndowmentFactory.js +147 -0
  7. package/dist/cjs/common/endowments/commonEndowmentFactory.js.map +1 -0
  8. package/dist/cjs/common/endowments/console.js +134 -0
  9. package/dist/cjs/common/endowments/console.js.map +1 -0
  10. package/dist/cjs/common/endowments/crypto.js +44 -0
  11. package/dist/cjs/common/endowments/crypto.js.map +1 -0
  12. package/dist/cjs/common/endowments/date.js +53 -0
  13. package/dist/cjs/common/endowments/date.js.map +1 -0
  14. package/dist/cjs/common/endowments/index.js +91 -0
  15. package/dist/cjs/common/endowments/index.js.map +1 -0
  16. package/dist/cjs/common/endowments/interval.js +61 -0
  17. package/dist/cjs/common/endowments/interval.js.map +1 -0
  18. package/dist/cjs/common/endowments/math.js +67 -0
  19. package/dist/cjs/common/endowments/math.js.map +1 -0
  20. package/dist/cjs/common/endowments/network.js +206 -0
  21. package/dist/cjs/common/endowments/network.js.map +1 -0
  22. package/dist/cjs/common/endowments/textDecoder.js +28 -0
  23. package/dist/cjs/common/endowments/textDecoder.js.map +1 -0
  24. package/dist/cjs/common/endowments/textEncoder.js +28 -0
  25. package/dist/cjs/common/endowments/textEncoder.js.map +1 -0
  26. package/dist/cjs/common/endowments/timeout.js +63 -0
  27. package/dist/cjs/common/endowments/timeout.js.map +1 -0
  28. package/dist/cjs/common/globalEvents.js +39 -0
  29. package/dist/cjs/common/globalEvents.js.map +1 -0
  30. package/dist/cjs/common/globalObject.js +53 -0
  31. package/dist/{common → cjs/common}/globalObject.js.map +1 -1
  32. package/dist/cjs/common/lockdown/lockdown-events.js +74 -0
  33. package/dist/cjs/common/lockdown/lockdown-events.js.map +1 -0
  34. package/dist/cjs/common/lockdown/lockdown-more.js +73 -0
  35. package/dist/cjs/common/lockdown/lockdown-more.js.map +1 -0
  36. package/dist/cjs/common/lockdown/lockdown.js +30 -0
  37. package/dist/cjs/common/lockdown/lockdown.js.map +1 -0
  38. package/dist/cjs/common/sortParams.js +26 -0
  39. package/dist/cjs/common/sortParams.js.map +1 -0
  40. package/dist/cjs/common/utils.js +116 -0
  41. package/dist/cjs/common/utils.js.map +1 -0
  42. package/dist/cjs/common/validation.js +114 -0
  43. package/dist/cjs/common/validation.js.map +1 -0
  44. package/dist/cjs/iframe/IFrameSnapExecutor.js +50 -0
  45. package/dist/cjs/iframe/IFrameSnapExecutor.js.map +1 -0
  46. package/dist/cjs/iframe/index.js +13 -0
  47. package/dist/cjs/iframe/index.js.map +1 -0
  48. package/dist/cjs/logging.js +15 -0
  49. package/dist/cjs/logging.js.map +1 -0
  50. package/dist/cjs/node-process/ChildProcessSnapExecutor.js +39 -0
  51. package/dist/cjs/node-process/ChildProcessSnapExecutor.js.map +1 -0
  52. package/dist/cjs/node-process/index.js +11 -0
  53. package/dist/cjs/node-process/index.js.map +1 -0
  54. package/dist/cjs/node-thread/ThreadSnapExecutor.js +39 -0
  55. package/dist/cjs/node-thread/ThreadSnapExecutor.js.map +1 -0
  56. package/dist/cjs/node-thread/index.js +11 -0
  57. package/dist/cjs/node-thread/index.js.map +1 -0
  58. package/dist/cjs/offscreen/OffscreenSnapExecutor.js +173 -0
  59. package/dist/cjs/offscreen/OffscreenSnapExecutor.js.map +1 -0
  60. package/dist/cjs/offscreen/index.js +19 -0
  61. package/dist/cjs/offscreen/index.js.map +1 -0
  62. package/dist/cjs/webworker/executor/WebWorkerSnapExecutor.js +45 -0
  63. package/dist/cjs/webworker/executor/WebWorkerSnapExecutor.js.map +1 -0
  64. package/dist/cjs/webworker/executor/index.js +13 -0
  65. package/dist/cjs/webworker/executor/index.js.map +1 -0
  66. package/dist/cjs/webworker/pool/WebWorkerPool.js +248 -0
  67. package/dist/cjs/webworker/pool/WebWorkerPool.js.map +1 -0
  68. package/dist/cjs/webworker/pool/index.js +13 -0
  69. package/dist/cjs/webworker/pool/index.js.map +1 -0
  70. package/dist/esm/common/BaseSnapExecutor.js +400 -0
  71. package/dist/esm/common/BaseSnapExecutor.js.map +1 -0
  72. package/dist/esm/common/commands.js +64 -0
  73. package/dist/esm/common/commands.js.map +1 -0
  74. package/dist/esm/common/endowments/commonEndowmentFactory.js +132 -0
  75. package/dist/esm/common/endowments/commonEndowmentFactory.js.map +1 -0
  76. package/dist/{common → esm/common}/endowments/console.js +46 -33
  77. package/dist/esm/common/endowments/console.js.map +1 -0
  78. package/dist/esm/common/endowments/crypto.js +26 -0
  79. package/dist/esm/common/endowments/crypto.js.map +1 -0
  80. package/dist/{common → esm/common}/endowments/date.js +20 -16
  81. package/dist/esm/common/endowments/date.js.map +1 -0
  82. package/dist/{common → esm/common}/endowments/index.js +33 -35
  83. package/dist/esm/common/endowments/index.js.map +1 -0
  84. package/dist/{common → esm/common}/endowments/interval.js +13 -12
  85. package/dist/esm/common/endowments/interval.js.map +1 -0
  86. package/dist/{common → esm/common}/endowments/math.js +19 -16
  87. package/dist/esm/common/endowments/math.js.map +1 -0
  88. package/dist/esm/common/endowments/network.js +196 -0
  89. package/dist/esm/common/endowments/network.js.map +1 -0
  90. package/dist/esm/common/endowments/textDecoder.js +18 -0
  91. package/dist/esm/common/endowments/textDecoder.js.map +1 -0
  92. package/dist/esm/common/endowments/textEncoder.js +18 -0
  93. package/dist/esm/common/endowments/textEncoder.js.map +1 -0
  94. package/dist/{common → esm/common}/endowments/timeout.js +14 -13
  95. package/dist/esm/common/endowments/timeout.js.map +1 -0
  96. package/dist/esm/common/globalEvents.js +35 -0
  97. package/dist/esm/common/globalEvents.js.map +1 -0
  98. package/dist/esm/common/globalObject.js +36 -0
  99. package/dist/esm/common/globalObject.js.map +1 -0
  100. package/dist/esm/common/lockdown/lockdown-events.js +66 -0
  101. package/dist/esm/common/lockdown/lockdown-events.js.map +1 -0
  102. package/dist/{common → esm/common}/lockdown/lockdown-more.js +15 -22
  103. package/dist/esm/common/lockdown/lockdown-more.js.map +1 -0
  104. package/dist/{common → esm/common}/lockdown/lockdown.js +6 -11
  105. package/dist/esm/common/lockdown/lockdown.js.map +1 -0
  106. package/dist/{common → esm/common}/sortParams.js +7 -13
  107. package/dist/esm/common/sortParams.js.map +1 -0
  108. package/dist/esm/common/utils.js +120 -0
  109. package/dist/esm/common/utils.js.map +1 -0
  110. package/dist/esm/common/validation.js +92 -0
  111. package/dist/esm/common/validation.js.map +1 -0
  112. package/dist/esm/iframe/IFrameSnapExecutor.js +35 -0
  113. package/dist/esm/iframe/IFrameSnapExecutor.js.map +1 -0
  114. package/dist/esm/iframe/index.js +9 -0
  115. package/dist/esm/iframe/index.js.map +1 -0
  116. package/dist/esm/logging.js +10 -0
  117. package/dist/esm/logging.js.map +1 -0
  118. package/dist/esm/node-process/ChildProcessSnapExecutor.js +24 -0
  119. package/dist/esm/node-process/ChildProcessSnapExecutor.js.map +1 -0
  120. package/dist/esm/node-process/index.js +7 -0
  121. package/dist/esm/node-process/index.js.map +1 -0
  122. package/dist/esm/node-thread/ThreadSnapExecutor.js +24 -0
  123. package/dist/esm/node-thread/ThreadSnapExecutor.js.map +1 -0
  124. package/dist/esm/node-thread/index.js +7 -0
  125. package/dist/esm/node-thread/index.js.map +1 -0
  126. package/dist/esm/offscreen/OffscreenSnapExecutor.js +176 -0
  127. package/dist/esm/offscreen/OffscreenSnapExecutor.js.map +1 -0
  128. package/dist/esm/offscreen/index.js +15 -0
  129. package/dist/esm/offscreen/index.js.map +1 -0
  130. package/dist/esm/webworker/executor/WebWorkerSnapExecutor.js +30 -0
  131. package/dist/esm/webworker/executor/WebWorkerSnapExecutor.js.map +1 -0
  132. package/dist/esm/webworker/executor/index.js +9 -0
  133. package/dist/esm/webworker/executor/index.js.map +1 -0
  134. package/dist/esm/webworker/pool/WebWorkerPool.js +245 -0
  135. package/dist/esm/webworker/pool/WebWorkerPool.js.map +1 -0
  136. package/dist/esm/webworker/pool/index.js +9 -0
  137. package/dist/esm/webworker/pool/index.js.map +1 -0
  138. package/package.json +58 -20
  139. package/dist/browserify/iframe/bundle.js +0 -6421
  140. package/dist/browserify/iframe/index.html +0 -11660
  141. package/dist/browserify/node-process/bundle.js +0 -15545
  142. package/dist/browserify/node-thread/bundle.js +0 -15545
  143. package/dist/browserify/offscreen/bundle.js +0 -2478
  144. package/dist/browserify/offscreen/index.html +0 -11660
  145. package/dist/browserify/worker-executor/bundle.js +0 -18072
  146. package/dist/browserify/worker-pool/bundle.js +0 -2492
  147. package/dist/browserify/worker-pool/index.html +0 -11660
  148. package/dist/common/BaseSnapExecutor.js +0 -370
  149. package/dist/common/BaseSnapExecutor.js.map +0 -1
  150. package/dist/common/commands.js +0 -65
  151. package/dist/common/commands.js.map +0 -1
  152. package/dist/common/endowments/commonEndowmentFactory.js +0 -76
  153. package/dist/common/endowments/commonEndowmentFactory.js.map +0 -1
  154. package/dist/common/endowments/console.js.map +0 -1
  155. package/dist/common/endowments/crypto.js +0 -30
  156. package/dist/common/endowments/crypto.js.map +0 -1
  157. package/dist/common/endowments/date.js.map +0 -1
  158. package/dist/common/endowments/index.js.map +0 -1
  159. package/dist/common/endowments/interval.js.map +0 -1
  160. package/dist/common/endowments/math.js.map +0 -1
  161. package/dist/common/endowments/network.js +0 -170
  162. package/dist/common/endowments/network.js.map +0 -1
  163. package/dist/common/endowments/textDecoder.js +0 -18
  164. package/dist/common/endowments/textDecoder.js.map +0 -1
  165. package/dist/common/endowments/textEncoder.js +0 -18
  166. package/dist/common/endowments/textEncoder.js.map +0 -1
  167. package/dist/common/endowments/timeout.js.map +0 -1
  168. package/dist/common/globalEvents.js +0 -47
  169. package/dist/common/globalEvents.js.map +0 -1
  170. package/dist/common/globalObject.js +0 -50
  171. package/dist/common/keyring.d.ts +0 -12
  172. package/dist/common/keyring.js +0 -42
  173. package/dist/common/keyring.js.map +0 -1
  174. package/dist/common/lockdown/lockdown-events.js +0 -60
  175. package/dist/common/lockdown/lockdown-events.js.map +0 -1
  176. package/dist/common/lockdown/lockdown-more.js.map +0 -1
  177. package/dist/common/lockdown/lockdown.js.map +0 -1
  178. package/dist/common/sortParams.js.map +0 -1
  179. package/dist/common/utils.js +0 -133
  180. package/dist/common/utils.js.map +0 -1
  181. package/dist/common/validation.js +0 -109
  182. package/dist/common/validation.js.map +0 -1
  183. package/dist/iframe/IFrameSnapExecutor.js +0 -42
  184. package/dist/iframe/IFrameSnapExecutor.js.map +0 -1
  185. package/dist/iframe/index.js +0 -10
  186. package/dist/iframe/index.js.map +0 -1
  187. package/dist/logging.js +0 -13
  188. package/dist/logging.js.map +0 -1
  189. package/dist/node-process/ChildProcessSnapExecutor.js +0 -30
  190. package/dist/node-process/ChildProcessSnapExecutor.js.map +0 -1
  191. package/dist/node-process/index.js +0 -8
  192. package/dist/node-process/index.js.map +0 -1
  193. package/dist/node-thread/ThreadSnapExecutor.js +0 -30
  194. package/dist/node-thread/ThreadSnapExecutor.js.map +0 -1
  195. package/dist/node-thread/index.js +0 -8
  196. package/dist/node-thread/index.js.map +0 -1
  197. package/dist/offscreen/OffscreenSnapExecutor.js +0 -104
  198. package/dist/offscreen/OffscreenSnapExecutor.js.map +0 -1
  199. package/dist/offscreen/index.js +0 -16
  200. package/dist/offscreen/index.js.map +0 -1
  201. package/dist/openrpc.json +0 -210
  202. package/dist/webworker/executor/WebWorkerSnapExecutor.js +0 -37
  203. package/dist/webworker/executor/WebWorkerSnapExecutor.js.map +0 -1
  204. package/dist/webworker/executor/index.js +0 -10
  205. package/dist/webworker/executor/index.js.map +0 -1
  206. package/dist/webworker/pool/WebWorkerPool.js +0 -168
  207. package/dist/webworker/pool/WebWorkerPool.js.map +0 -1
  208. package/dist/webworker/pool/index.js +0 -10
  209. package/dist/webworker/pool/index.js.map +0 -1
  210. /package/dist/{common → types/common}/BaseSnapExecutor.d.ts +0 -0
  211. /package/dist/{common → types/common}/commands.d.ts +0 -0
  212. /package/dist/{common → types/common}/endowments/commonEndowmentFactory.d.ts +0 -0
  213. /package/dist/{common → types/common}/endowments/console.d.ts +0 -0
  214. /package/dist/{common → types/common}/endowments/crypto.d.ts +0 -0
  215. /package/dist/{common → types/common}/endowments/date.d.ts +0 -0
  216. /package/dist/{common → types/common}/endowments/index.d.ts +0 -0
  217. /package/dist/{common → types/common}/endowments/interval.d.ts +0 -0
  218. /package/dist/{common → types/common}/endowments/math.d.ts +0 -0
  219. /package/dist/{common → types/common}/endowments/network.d.ts +0 -0
  220. /package/dist/{common → types/common}/endowments/textDecoder.d.ts +0 -0
  221. /package/dist/{common → types/common}/endowments/textEncoder.d.ts +0 -0
  222. /package/dist/{common → types/common}/endowments/timeout.d.ts +0 -0
  223. /package/dist/{common → types/common}/globalEvents.d.ts +0 -0
  224. /package/dist/{common → types/common}/globalObject.d.ts +0 -0
  225. /package/dist/{common → types/common}/lockdown/lockdown-events.d.ts +0 -0
  226. /package/dist/{common → types/common}/lockdown/lockdown-more.d.ts +0 -0
  227. /package/dist/{common → types/common}/lockdown/lockdown.d.ts +0 -0
  228. /package/dist/{common → types/common}/sortParams.d.ts +0 -0
  229. /package/dist/{common → types/common}/utils.d.ts +0 -0
  230. /package/dist/{common → types/common}/validation.d.ts +0 -0
  231. /package/dist/{iframe → types/iframe}/IFrameSnapExecutor.d.ts +0 -0
  232. /package/dist/{iframe → types/iframe}/index.d.ts +0 -0
  233. /package/dist/{logging.d.ts → types/logging.d.ts} +0 -0
  234. /package/dist/{node-process → types/node-process}/ChildProcessSnapExecutor.d.ts +0 -0
  235. /package/dist/{node-process → types/node-process}/index.d.ts +0 -0
  236. /package/dist/{node-thread → types/node-thread}/ThreadSnapExecutor.d.ts +0 -0
  237. /package/dist/{node-thread → types/node-thread}/index.d.ts +0 -0
  238. /package/dist/{offscreen → types/offscreen}/OffscreenSnapExecutor.d.ts +0 -0
  239. /package/dist/{offscreen → types/offscreen}/index.d.ts +0 -0
  240. /package/dist/{webworker → types/webworker}/executor/WebWorkerSnapExecutor.d.ts +0 -0
  241. /package/dist/{webworker → types/webworker}/executor/index.d.ts +0 -0
  242. /package/dist/{webworker → types/webworker}/pool/WebWorkerPool.d.ts +0 -0
  243. /package/dist/{webworker → types/webworker}/pool/index.d.ts +0 -0
package/CHANGELOG.md CHANGED
@@ -6,6 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6
6
 
7
7
  ## [Unreleased]
8
8
 
9
+ ## [0.35.1-flask.1]
10
+ ### Changed
11
+ - No changes this release.
12
+
13
+ ## [0.35.0-flask.1]
14
+ ### Changed
15
+ - **BREAKING:** Build packages as both CJS and ESM ([#1519](https://github.com/MetaMask/snaps/pull/1519), ([#1532](https://github.com/MetaMask/snaps/pull/1532)))
16
+ - This is breaking in the sense that imports to `dist/` will now require you to import either `dist/cjs` or `dist/esm`.
17
+ - Add `sideEffects: false` ([#1486](https://github.com/MetaMask/snaps/pull/1486))
18
+ - Refactored bundling process to reduce bundle size ([#1458](https://github.com/MetaMask/snaps/pull/1458))
19
+
20
+ ### Removed
21
+ - **BREAKING:** Remove support for `keyring` export ([#1527](https://github.com/MetaMask/snaps/pull/1527))
22
+
9
23
  ## [0.34.1-flask.1]
10
24
  ### Changed
11
25
  - Deploy `iframe-execution-environment` from this repository ([#1406](https://github.com/MetaMask/snaps/pull/1406))
@@ -264,7 +278,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
264
278
  - Previously, default endowments were specified in the execution environment itself. Now, all endowments must be specified in the `executeSnap` RPC parameters, except for the `wallet` API object.
265
279
  - Add endowments to the global `self` in addition to `window` ([#263](https://github.com/MetaMask/snaps-monorepo/pull/263))
266
280
 
267
- [Unreleased]: https://github.com/MetaMask/snaps/compare/v0.34.1-flask.1...HEAD
281
+ [Unreleased]: https://github.com/MetaMask/snaps/compare/v0.35.1-flask.1...HEAD
282
+ [0.35.1-flask.1]: https://github.com/MetaMask/snaps/compare/v0.35.0-flask.1...v0.35.1-flask.1
283
+ [0.35.0-flask.1]: https://github.com/MetaMask/snaps/compare/v0.34.1-flask.1...v0.35.0-flask.1
268
284
  [0.34.1-flask.1]: https://github.com/MetaMask/snaps/compare/v0.34.0-flask.1...v0.34.1-flask.1
269
285
  [0.34.0-flask.1]: https://github.com/MetaMask/snaps/compare/v0.33.1-flask.1...v0.34.0-flask.1
270
286
  [0.33.1-flask.1]: https://github.com/MetaMask/snaps/compare/v0.33.0-flask.1...v0.33.1-flask.1
@@ -0,0 +1,415 @@
1
+ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
2
+ /// <reference path="../../../../node_modules/ses/index.d.ts" />
3
+ "use strict";
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ Object.defineProperty(exports, "BaseSnapExecutor", {
8
+ enumerable: true,
9
+ get: function() {
10
+ return BaseSnapExecutor;
11
+ }
12
+ });
13
+ const _providers = require("@metamask/providers");
14
+ const _snapsutils = require("@metamask/snaps-utils");
15
+ const _utils = require("@metamask/utils");
16
+ const _ethrpcerrors = require("eth-rpc-errors");
17
+ const _jsonrpcengine = require("json-rpc-engine");
18
+ const _superstruct = require("superstruct");
19
+ const _logging = require("../logging");
20
+ const _openrpcjson = /*#__PURE__*/ _interop_require_default(require("../openrpc.json"));
21
+ const _commands = require("./commands");
22
+ const _endowments = require("./endowments");
23
+ const _globalEvents = require("./globalEvents");
24
+ const _sortParams = require("./sortParams");
25
+ const _utils1 = require("./utils");
26
+ const _validation = require("./validation");
27
+ function _define_property(obj, key, value) {
28
+ if (key in obj) {
29
+ Object.defineProperty(obj, key, {
30
+ value: value,
31
+ enumerable: true,
32
+ configurable: true,
33
+ writable: true
34
+ });
35
+ } else {
36
+ obj[key] = value;
37
+ }
38
+ return obj;
39
+ }
40
+ function _interop_require_default(obj) {
41
+ return obj && obj.__esModule ? obj : {
42
+ default: obj
43
+ };
44
+ }
45
+ const fallbackError = {
46
+ code: _ethrpcerrors.errorCodes.rpc.internal,
47
+ message: 'Execution Environment Error'
48
+ };
49
+ /**
50
+ * The supported methods in the execution environment. The validator checks the
51
+ * incoming JSON-RPC request, and the `params` property is used for sorting the
52
+ * parameters, if they are an object.
53
+ */ const EXECUTION_ENVIRONMENT_METHODS = {
54
+ ping: {
55
+ struct: _validation.PingRequestArgumentsStruct,
56
+ params: []
57
+ },
58
+ executeSnap: {
59
+ struct: _validation.ExecuteSnapRequestArgumentsStruct,
60
+ params: [
61
+ 'snapId',
62
+ 'sourceCode',
63
+ 'endowments'
64
+ ]
65
+ },
66
+ terminate: {
67
+ struct: _validation.TerminateRequestArgumentsStruct,
68
+ params: []
69
+ },
70
+ snapRpc: {
71
+ struct: _validation.SnapRpcRequestArgumentsStruct,
72
+ params: [
73
+ 'target',
74
+ 'handler',
75
+ 'origin',
76
+ 'request'
77
+ ]
78
+ }
79
+ };
80
+ class BaseSnapExecutor {
81
+ errorHandler(error, data) {
82
+ const constructedError = (0, _utils1.constructError)(error);
83
+ const serializedError = (0, _ethrpcerrors.serializeError)(constructedError, {
84
+ fallbackError,
85
+ shouldIncludeStack: false
86
+ });
87
+ // We're setting it this way to avoid sentData.stack = undefined
88
+ const sentData = {
89
+ ...data,
90
+ stack: constructedError?.stack ?? null
91
+ };
92
+ this.notify({
93
+ method: 'UnhandledError',
94
+ params: {
95
+ error: {
96
+ ...serializedError,
97
+ data: sentData
98
+ }
99
+ }
100
+ });
101
+ }
102
+ async onCommandRequest(message) {
103
+ if (!(0, _utils.isJsonRpcRequest)(message)) {
104
+ throw new Error('Command stream received a non-JSON-RPC request.');
105
+ }
106
+ const { id, method, params } = message;
107
+ if (method === 'rpc.discover') {
108
+ this.respond(id, {
109
+ result: _openrpcjson.default
110
+ });
111
+ return;
112
+ }
113
+ if (!(0, _utils.hasProperty)(EXECUTION_ENVIRONMENT_METHODS, method)) {
114
+ this.respond(id, {
115
+ error: _ethrpcerrors.ethErrors.rpc.methodNotFound({
116
+ data: {
117
+ method
118
+ }
119
+ }).serialize()
120
+ });
121
+ return;
122
+ }
123
+ const methodObject = EXECUTION_ENVIRONMENT_METHODS[method];
124
+ // support params by-name and by-position
125
+ const paramsAsArray = (0, _sortParams.sortParamKeys)(methodObject.params, params);
126
+ const [error] = (0, _superstruct.validate)(paramsAsArray, methodObject.struct);
127
+ if (error) {
128
+ this.respond(id, {
129
+ error: _ethrpcerrors.ethErrors.rpc.invalidParams({
130
+ message: `Invalid parameters for method "${method}": ${error.message}.`,
131
+ data: {
132
+ method,
133
+ params: paramsAsArray
134
+ }
135
+ }).serialize()
136
+ });
137
+ return;
138
+ }
139
+ try {
140
+ const result = await this.methods[method](...paramsAsArray);
141
+ this.respond(id, {
142
+ result
143
+ });
144
+ } catch (rpcError) {
145
+ this.respond(id, {
146
+ error: (0, _ethrpcerrors.serializeError)(rpcError, {
147
+ fallbackError
148
+ })
149
+ });
150
+ }
151
+ }
152
+ notify(requestObject) {
153
+ if (!(0, _utils.isValidJson)(requestObject) || !(0, _utils.isObject)(requestObject)) {
154
+ throw new Error('JSON-RPC notifications must be JSON serializable objects');
155
+ }
156
+ this.commandStream.write({
157
+ ...requestObject,
158
+ jsonrpc: '2.0'
159
+ });
160
+ }
161
+ respond(id, requestObject) {
162
+ if (!(0, _utils.isValidJson)(requestObject) || !(0, _utils.isObject)(requestObject)) {
163
+ throw new Error('JSON-RPC responses must be JSON serializable objects.');
164
+ }
165
+ this.commandStream.write({
166
+ ...requestObject,
167
+ id,
168
+ jsonrpc: '2.0'
169
+ });
170
+ }
171
+ /**
172
+ * Attempts to evaluate a snap in SES. Generates APIs for the snap. May throw
173
+ * on errors.
174
+ *
175
+ * @param snapId - The id of the snap.
176
+ * @param sourceCode - The source code of the snap, in IIFE format.
177
+ * @param _endowments - An array of the names of the endowments.
178
+ */ async startSnap(snapId, sourceCode, _endowments1) {
179
+ (0, _logging.log)(`Starting snap '${snapId}' in worker.`);
180
+ if (this.snapPromiseErrorHandler) {
181
+ (0, _globalEvents.removeEventListener)('unhandledrejection', this.snapPromiseErrorHandler);
182
+ }
183
+ if (this.snapErrorHandler) {
184
+ (0, _globalEvents.removeEventListener)('error', this.snapErrorHandler);
185
+ }
186
+ this.snapErrorHandler = (error)=>{
187
+ this.errorHandler(error.error, {
188
+ snapId
189
+ });
190
+ };
191
+ this.snapPromiseErrorHandler = (error)=>{
192
+ this.errorHandler(error instanceof Error ? error : error.reason, {
193
+ snapId
194
+ });
195
+ };
196
+ const provider = new _providers.StreamProvider(this.rpcStream, {
197
+ jsonRpcStreamName: 'metamask-provider',
198
+ rpcMiddleware: [
199
+ (0, _jsonrpcengine.createIdRemapMiddleware)()
200
+ ]
201
+ });
202
+ await provider.initialize();
203
+ const snap = this.createSnapGlobal(provider);
204
+ const ethereum = this.createEIP1193Provider(provider);
205
+ // We specifically use any type because the Snap can modify the object any way they want
206
+ const snapModule = {
207
+ exports: {}
208
+ };
209
+ try {
210
+ const { endowments, teardown: endowmentTeardown } = (0, _endowments.createEndowments)(snap, ethereum, snapId, _endowments1);
211
+ // !!! Ensure that this is the only place the data is being set.
212
+ // Other methods access the object value and mutate its properties.
213
+ this.snapData.set(snapId, {
214
+ idleTeardown: endowmentTeardown,
215
+ runningEvaluations: new Set(),
216
+ exports: {}
217
+ });
218
+ (0, _globalEvents.addEventListener)('unhandledRejection', this.snapPromiseErrorHandler);
219
+ (0, _globalEvents.addEventListener)('error', this.snapErrorHandler);
220
+ const compartment = new Compartment({
221
+ ...endowments,
222
+ module: snapModule,
223
+ exports: snapModule.exports
224
+ });
225
+ // All of those are JavaScript runtime specific and self referential,
226
+ // but we add them for compatibility sake with external libraries.
227
+ //
228
+ // We can't do that in the injected globals object above
229
+ // because SES creates its own globalThis
230
+ compartment.globalThis.self = compartment.globalThis;
231
+ compartment.globalThis.global = compartment.globalThis;
232
+ compartment.globalThis.window = compartment.globalThis;
233
+ await this.executeInSnapContext(snapId, ()=>{
234
+ compartment.evaluate(sourceCode);
235
+ this.registerSnapExports(snapId, snapModule);
236
+ });
237
+ } catch (error) {
238
+ this.removeSnap(snapId);
239
+ throw new Error(`Error while running snap '${snapId}': ${error.message}`);
240
+ }
241
+ }
242
+ /**
243
+ * Cancels all running evaluations of all snaps and clears all snap data.
244
+ * NOTE:** Should only be called in response to the `terminate` RPC command.
245
+ */ onTerminate() {
246
+ // `stop()` tears down snap endowments.
247
+ // Teardown will also be run for each snap as soon as there are
248
+ // no more running evaluations for that snap.
249
+ this.snapData.forEach((data)=>data.runningEvaluations.forEach((evaluation)=>evaluation.stop()));
250
+ this.snapData.clear();
251
+ }
252
+ registerSnapExports(snapId, snapModule) {
253
+ const data = this.snapData.get(snapId);
254
+ // Somebody deleted the Snap before we could register
255
+ if (!data) {
256
+ return;
257
+ }
258
+ data.exports = _snapsutils.SNAP_EXPORT_NAMES.reduce((acc, exportName)=>{
259
+ const snapExport = snapModule.exports[exportName];
260
+ if ((0, _validation.validateExport)(exportName, snapExport)) {
261
+ return {
262
+ ...acc,
263
+ [exportName]: snapExport
264
+ };
265
+ }
266
+ return acc;
267
+ }, {});
268
+ }
269
+ /**
270
+ * Instantiates a snap API object (i.e. `globalThis.snap`).
271
+ *
272
+ * @param provider - A StreamProvider connected to MetaMask.
273
+ * @returns The snap provider object.
274
+ */ createSnapGlobal(provider) {
275
+ const originalRequest = provider.request.bind(provider);
276
+ const request = async (args)=>{
277
+ (0, _utils1.assertSnapOutboundRequest)(args);
278
+ const sanitizedArgs = (0, _utils.getSafeJson)(args);
279
+ this.notify({
280
+ method: 'OutboundRequest'
281
+ });
282
+ try {
283
+ return await (0, _utils1.withTeardown)(originalRequest(sanitizedArgs), this);
284
+ } finally{
285
+ this.notify({
286
+ method: 'OutboundResponse'
287
+ });
288
+ }
289
+ };
290
+ // Proxy target is intentionally set to be an empty object, to ensure
291
+ // that access to the prototype chain is not possible.
292
+ const snapGlobalProxy = new Proxy({}, {
293
+ has (_target, prop) {
294
+ return typeof prop === 'string' && [
295
+ 'request'
296
+ ].includes(prop);
297
+ },
298
+ get (_target, prop) {
299
+ if (prop === 'request') {
300
+ return request;
301
+ }
302
+ return undefined;
303
+ }
304
+ });
305
+ return harden(snapGlobalProxy);
306
+ }
307
+ /**
308
+ * Instantiates an EIP-1193 Ethereum provider object (i.e. `globalThis.ethereum`).
309
+ *
310
+ * @param provider - A StreamProvider connected to MetaMask.
311
+ * @returns The EIP-1193 Ethereum provider object.
312
+ */ createEIP1193Provider(provider) {
313
+ const originalRequest = provider.request.bind(provider);
314
+ const request = async (args)=>{
315
+ (0, _utils1.assertEthereumOutboundRequest)(args);
316
+ const sanitizedArgs = (0, _utils.getSafeJson)(args);
317
+ this.notify({
318
+ method: 'OutboundRequest'
319
+ });
320
+ try {
321
+ return await (0, _utils1.withTeardown)(originalRequest(sanitizedArgs), this);
322
+ } finally{
323
+ this.notify({
324
+ method: 'OutboundResponse'
325
+ });
326
+ }
327
+ };
328
+ const streamProviderProxy = (0, _utils1.proxyStreamProvider)(provider, request);
329
+ return harden(streamProviderProxy);
330
+ }
331
+ /**
332
+ * Removes the snap with the given name.
333
+ *
334
+ * @param snapId - The id of the snap to remove.
335
+ */ removeSnap(snapId) {
336
+ this.snapData.delete(snapId);
337
+ }
338
+ /**
339
+ * Calls the specified executor function in the context of the specified snap.
340
+ * Essentially, this means that the operation performed by the executor is
341
+ * counted as an evaluation of the specified snap. When the count of running
342
+ * evaluations of a snap reaches zero, its endowments are torn down.
343
+ *
344
+ * @param snapId - The id of the snap whose context to execute in.
345
+ * @param executor - The function that will be executed in the snap's context.
346
+ * @returns The executor's return value.
347
+ * @template Result - The return value of the executor.
348
+ */ async executeInSnapContext(snapId, executor) {
349
+ const data = this.snapData.get(snapId);
350
+ if (data === undefined) {
351
+ throw new Error(`Tried to execute in context of unknown snap: "${snapId}".`);
352
+ }
353
+ let stop;
354
+ const stopPromise = new Promise((_, reject)=>stop = ()=>reject(// TODO(rekmarks): Specify / standardize error code for this case.
355
+ _ethrpcerrors.ethErrors.rpc.internal(`The snap "${snapId}" has been terminated during execution.`)));
356
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
357
+ const evaluationData = {
358
+ stop: stop
359
+ };
360
+ try {
361
+ data.runningEvaluations.add(evaluationData);
362
+ // Notice that we have to await this executor.
363
+ // If we didn't, we would decrease the amount of running evaluations
364
+ // before the promise actually resolves
365
+ return await Promise.race([
366
+ executor(),
367
+ stopPromise
368
+ ]);
369
+ } finally{
370
+ data.runningEvaluations.delete(evaluationData);
371
+ if (data.runningEvaluations.size === 0) {
372
+ this.lastTeardown += 1;
373
+ await data.idleTeardown();
374
+ }
375
+ }
376
+ }
377
+ constructor(commandStream, rpcStream){
378
+ _define_property(this, "snapData", void 0);
379
+ _define_property(this, "commandStream", void 0);
380
+ _define_property(this, "rpcStream", void 0);
381
+ _define_property(this, "methods", void 0);
382
+ _define_property(this, "snapErrorHandler", void 0);
383
+ _define_property(this, "snapPromiseErrorHandler", void 0);
384
+ _define_property(this, "lastTeardown", 0);
385
+ this.snapData = new Map();
386
+ this.commandStream = commandStream;
387
+ this.commandStream.on('data', (data)=>{
388
+ this.onCommandRequest(data).catch((error)=>{
389
+ // TODO: Decide how to handle errors.
390
+ (0, _snapsutils.logError)(error);
391
+ });
392
+ });
393
+ this.rpcStream = rpcStream;
394
+ this.methods = (0, _commands.getCommandMethodImplementations)(this.startSnap.bind(this), async (target, handlerName, args)=>{
395
+ const data = this.snapData.get(target);
396
+ // We're capturing the handler in case someone modifies the data object before the call
397
+ const handler = data?.exports[handlerName];
398
+ (0, _utils.assert)(handler !== undefined, `No ${handlerName} handler exported for snap "${target}`);
399
+ // TODO: fix handler args type cast
400
+ let result = await this.executeInSnapContext(target, ()=>handler(args));
401
+ // The handler might not return anything, but undefined is not valid JSON.
402
+ if (result === undefined) {
403
+ result = null;
404
+ }
405
+ // /!\ Always return only sanitized JSON to prevent security flaws. /!\
406
+ try {
407
+ return (0, _utils.getSafeJson)(result);
408
+ } catch (error) {
409
+ throw new TypeError(`Received non-JSON-serializable value: ${error.message.replace(/^Assertion failed: /u, '')}`);
410
+ }
411
+ }, this.onTerminate.bind(this));
412
+ }
413
+ }
414
+
415
+ //# sourceMappingURL=BaseSnapExecutor.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../src/common/BaseSnapExecutor.ts"],"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 getSafeJson,\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 { 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\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 = 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 // /!\\ Always return only sanitized JSON to prevent security flaws. /!\\\n try {\n return getSafeJson(result);\n } catch (error) {\n throw new TypeError(\n `Received non-JSON-serializable value: ${error.message.replace(\n /^Assertion failed: /u,\n '',\n )}`,\n );\n }\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 const sanitizedArgs = getSafeJson(args);\n this.notify({ method: 'OutboundRequest' });\n try {\n return await withTeardown(\n originalRequest(sanitizedArgs as unknown as RequestArguments),\n this as any,\n );\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 const sanitizedArgs = getSafeJson(args);\n this.notify({ method: 'OutboundRequest' });\n try {\n return await withTeardown(\n originalRequest(sanitizedArgs as unknown as RequestArguments),\n this as any,\n );\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"],"names":["BaseSnapExecutor","fallbackError","code","errorCodes","rpc","internal","message","EXECUTION_ENVIRONMENT_METHODS","ping","struct","PingRequestArgumentsStruct","params","executeSnap","ExecuteSnapRequestArgumentsStruct","terminate","TerminateRequestArgumentsStruct","snapRpc","SnapRpcRequestArgumentsStruct","errorHandler","error","data","constructedError","constructError","serializedError","serializeError","shouldIncludeStack","sentData","stack","notify","method","onCommandRequest","isJsonRpcRequest","Error","id","respond","result","EEOpenRPCDocument","hasProperty","ethErrors","methodNotFound","serialize","methodObject","paramsAsArray","sortParamKeys","validate","invalidParams","methods","rpcError","requestObject","isValidJson","isObject","commandStream","write","jsonrpc","startSnap","snapId","sourceCode","_endowments","log","snapPromiseErrorHandler","removeEventListener","snapErrorHandler","reason","provider","StreamProvider","rpcStream","jsonRpcStreamName","rpcMiddleware","createIdRemapMiddleware","initialize","snap","createSnapGlobal","ethereum","createEIP1193Provider","snapModule","exports","endowments","teardown","endowmentTeardown","createEndowments","snapData","set","idleTeardown","runningEvaluations","Set","addEventListener","compartment","Compartment","module","globalThis","self","global","window","executeInSnapContext","evaluate","registerSnapExports","removeSnap","onTerminate","forEach","evaluation","stop","clear","get","SNAP_EXPORT_NAMES","reduce","acc","exportName","snapExport","validateExport","originalRequest","request","bind","args","assertSnapOutboundRequest","sanitizedArgs","getSafeJson","withTeardown","snapGlobalProxy","Proxy","has","_target","prop","includes","undefined","harden","assertEthereumOutboundRequest","streamProviderProxy","proxyStreamProvider","delete","executor","stopPromise","Promise","_","reject","evaluationData","add","race","size","lastTeardown","Map","on","catch","logError","getCommandMethodImplementations","target","handlerName","handler","assert","TypeError","replace"],"mappings":"AAAA,qFAAqF;AACrF,gEAAgE;;;;;+BAqGnDA;;;eAAAA;;;2BApGkB;4BASxB;uBAYA;8BAC+C;+BACd;6BAEf;yBAEL;oEACU;0BAIvB;4BAC0B;8BACqB;4BACxB;wBAOvB;4BAOA;;;;;;;;;;;;;;;;;;;AAYP,MAAMC,gBAAgB;IACpBC,MAAMC,wBAAU,CAACC,GAAG,CAACC,QAAQ;IAC7BC,SAAS;AACX;AAUA;;;;CAIC,GACD,MAAMC,gCAAgC;IACpCC,MAAM;QACJC,QAAQC,sCAA0B;QAClCC,QAAQ,EAAE;IACZ;IACAC,aAAa;QACXH,QAAQI,6CAAiC;QACzCF,QAAQ;YAAC;YAAU;YAAc;SAAa;IAChD;IACAG,WAAW;QACTL,QAAQM,2CAA+B;QACvCJ,QAAQ,EAAE;IACZ;IACAK,SAAS;QACPP,QAAQQ,yCAA6B;QACrCN,QAAQ;YAAC;YAAU;YAAW;YAAU;SAAU;IACpD;AACF;AAIO,MAAMX;IA8DHkB,aAAaC,KAAc,EAAEC,IAA0B,EAAE;QAC/D,MAAMC,mBAAmBC,IAAAA,sBAAc,EAACH;QACxC,MAAMI,kBAAkBC,IAAAA,4BAAc,EAACH,kBAAkB;YACvDpB;YACAwB,oBAAoB;QACtB;QAEA,gEAAgE;QAChE,MAAMC,WAAiB;YAAE,GAAGN,IAAI;YAAEO,OAAON,kBAAkBM,SAAS;QAAK;QAEzE,IAAI,CAACC,MAAM,CAAC;YACVC,QAAQ;YACRlB,QAAQ;gBACNQ,OAAO;oBACL,GAAGI,eAAe;oBAClBH,MAAMM;gBACR;YACF;QACF;IACF;IAEA,MAAcI,iBAAiBxB,OAAuB,EAAE;QACtD,IAAI,CAACyB,IAAAA,uBAAgB,EAACzB,UAAU;YAC9B,MAAM,IAAI0B,MAAM;QAClB;QAEA,MAAM,EAAEC,EAAE,EAAEJ,MAAM,EAAElB,MAAM,EAAE,GAAGL;QAC/B,IAAIuB,WAAW,gBAAgB;YAC7B,IAAI,CAACK,OAAO,CAACD,IAAI;gBACfE,QAAQC,oBAAiB;YAC3B;YACA;QACF;QAEA,IAAI,CAACC,IAAAA,kBAAW,EAAC9B,+BAA+BsB,SAAS;YACvD,IAAI,CAACK,OAAO,CAACD,IAAI;gBACfd,OAAOmB,uBAAS,CAAClC,GAAG,CACjBmC,cAAc,CAAC;oBACdnB,MAAM;wBACJS;oBACF;gBACF,GACCW,SAAS;YACd;YACA;QACF;QAEA,MAAMC,eAAelC,6BAA6B,CAACsB,OAAwB;QAE3E,yCAAyC;QACzC,MAAMa,gBAAgBC,IAAAA,yBAAa,EAACF,aAAa9B,MAAM,EAAEA;QAEzD,MAAM,CAACQ,MAAM,GAAGyB,IAAAA,qBAAQ,EAAWF,eAAeD,aAAahC,MAAM;QACrE,IAAIU,OAAO;YACT,IAAI,CAACe,OAAO,CAACD,IAAI;gBACfd,OAAOmB,uBAAS,CAAClC,GAAG,CACjByC,aAAa,CAAC;oBACbvC,SAAS,CAAC,+BAA+B,EAAEuB,OAAO,GAAG,EAAEV,MAAMb,OAAO,CAAC,CAAC,CAAC;oBACvEc,MAAM;wBACJS;wBACAlB,QAAQ+B;oBACV;gBACF,GACCF,SAAS;YACd;YACA;QACF;QAEA,IAAI;YACF,MAAML,SAAS,MAAM,AAAC,IAAI,CAACW,OAAO,AAAQ,CAACjB,OAAO,IAAIa;YACtD,IAAI,CAACR,OAAO,CAACD,IAAI;gBAAEE;YAAO;QAC5B,EAAE,OAAOY,UAAU;YACjB,IAAI,CAACb,OAAO,CAACD,IAAI;gBACfd,OAAOK,IAAAA,4BAAc,EAACuB,UAAU;oBAC9B9C;gBACF;YACF;QACF;IACF;IAEU2B,OAAOoB,aAAmD,EAAE;QACpE,IAAI,CAACC,IAAAA,kBAAW,EAACD,kBAAkB,CAACE,IAAAA,eAAQ,EAACF,gBAAgB;YAC3D,MAAM,IAAIhB,MACR;QAEJ;QAEA,IAAI,CAACmB,aAAa,CAACC,KAAK,CAAC;YACvB,GAAGJ,aAAa;YAChBK,SAAS;QACX;IACF;IAEUnB,QAAQD,EAAa,EAAEe,aAAsC,EAAE;QACvE,IAAI,CAACC,IAAAA,kBAAW,EAACD,kBAAkB,CAACE,IAAAA,eAAQ,EAACF,gBAAgB;YAC3D,MAAM,IAAIhB,MAAM;QAClB;QAEA,IAAI,CAACmB,aAAa,CAACC,KAAK,CAAC;YACvB,GAAGJ,aAAa;YAChBf;YACAoB,SAAS;QACX;IACF;IAEA;;;;;;;GAOC,GACD,MAAgBC,UACdC,MAAc,EACdC,UAAkB,EAClBC,YAAsB,EACP;QACfC,IAAAA,YAAG,EAAC,CAAC,eAAe,EAAEH,OAAO,YAAY,CAAC;QAC1C,IAAI,IAAI,CAACI,uBAAuB,EAAE;YAChCC,IAAAA,iCAAmB,EAAC,sBAAsB,IAAI,CAACD,uBAAuB;QACxE;QAEA,IAAI,IAAI,CAACE,gBAAgB,EAAE;YACzBD,IAAAA,iCAAmB,EAAC,SAAS,IAAI,CAACC,gBAAgB;QACpD;QAEA,IAAI,CAACA,gBAAgB,GAAG,CAAC1C;YACvB,IAAI,CAACD,YAAY,CAACC,MAAMA,KAAK,EAAE;gBAAEoC;YAAO;QAC1C;QAEA,IAAI,CAACI,uBAAuB,GAAG,CAACxC;YAC9B,IAAI,CAACD,YAAY,CAACC,iBAAiBa,QAAQb,QAAQA,MAAM2C,MAAM,EAAE;gBAC/DP;YACF;QACF;QAEA,MAAMQ,WAAW,IAAIC,yBAAc,CAAC,IAAI,CAACC,SAAS,EAAE;YAClDC,mBAAmB;YACnBC,eAAe;gBAACC,IAAAA,sCAAuB;aAAG;QAC5C;QAEA,MAAML,SAASM,UAAU;QAEzB,MAAMC,OAAO,IAAI,CAACC,gBAAgB,CAACR;QACnC,MAAMS,WAAW,IAAI,CAACC,qBAAqB,CAACV;QAC5C,wFAAwF;QACxF,MAAMW,aAAkB;YAAEC,SAAS,CAAC;QAAE;QAEtC,IAAI;YACF,MAAM,EAAEC,UAAU,EAAEC,UAAUC,iBAAiB,EAAE,GAAGC,IAAAA,4BAAgB,EAClET,MACAE,UACAjB,QACAE;YAGF,gEAAgE;YAChE,mEAAmE;YACnE,IAAI,CAACuB,QAAQ,CAACC,GAAG,CAAC1B,QAAQ;gBACxB2B,cAAcJ;gBACdK,oBAAoB,IAAIC;gBACxBT,SAAS,CAAC;YACZ;YAEAU,IAAAA,8BAAgB,EAAC,sBAAsB,IAAI,CAAC1B,uBAAuB;YACnE0B,IAAAA,8BAAgB,EAAC,SAAS,IAAI,CAACxB,gBAAgB;YAE/C,MAAMyB,cAAc,IAAIC,YAAY;gBAClC,GAAGX,UAAU;gBACbY,QAAQd;gBACRC,SAASD,WAAWC,OAAO;YAC7B;YACA,qEAAqE;YACrE,kEAAkE;YAClE,EAAE;YACF,wDAAwD;YACxD,yCAAyC;YACzCW,YAAYG,UAAU,CAACC,IAAI,GAAGJ,YAAYG,UAAU;YACpDH,YAAYG,UAAU,CAACE,MAAM,GAAGL,YAAYG,UAAU;YACtDH,YAAYG,UAAU,CAACG,MAAM,GAAGN,YAAYG,UAAU;YAEtD,MAAM,IAAI,CAACI,oBAAoB,CAACtC,QAAQ;gBACtC+B,YAAYQ,QAAQ,CAACtC;gBACrB,IAAI,CAACuC,mBAAmB,CAACxC,QAAQmB;YACnC;QACF,EAAE,OAAOvD,OAAO;YACd,IAAI,CAAC6E,UAAU,CAACzC;YAChB,MAAM,IAAIvB,MACR,CAAC,0BAA0B,EAAEuB,OAAO,GAAG,EAAE,AAACpC,MAAgBb,OAAO,CAAC,CAAC;QAEvE;IACF;IAEA;;;GAGC,GACD,AAAU2F,cAAc;QACtB,uCAAuC;QACvC,+DAA+D;QAC/D,6CAA6C;QAC7C,IAAI,CAACjB,QAAQ,CAACkB,OAAO,CAAC,CAAC9E,OACrBA,KAAK+D,kBAAkB,CAACe,OAAO,CAAC,CAACC,aAAeA,WAAWC,IAAI;QAEjE,IAAI,CAACpB,QAAQ,CAACqB,KAAK;IACrB;IAEQN,oBAAoBxC,MAAc,EAAEmB,UAAe,EAAE;QAC3D,MAAMtD,OAAO,IAAI,CAAC4D,QAAQ,CAACsB,GAAG,CAAC/C;QAC/B,qDAAqD;QACrD,IAAI,CAACnC,MAAM;YACT;QACF;QAEAA,KAAKuD,OAAO,GAAG4B,6BAAiB,CAACC,MAAM,CAAC,CAACC,KAAKC;YAC5C,MAAMC,aAAajC,WAAWC,OAAO,CAAC+B,WAAW;YACjD,IAAIE,IAAAA,0BAAc,EAACF,YAAYC,aAAa;gBAC1C,OAAO;oBAAE,GAAGF,GAAG;oBAAE,CAACC,WAAW,EAAEC;gBAAW;YAC5C;YACA,OAAOF;QACT,GAAG,CAAC;IACN;IAEA;;;;;GAKC,GACD,AAAQlC,iBAAiBR,QAAwB,EAAqB;QACpE,MAAM8C,kBAAkB9C,SAAS+C,OAAO,CAACC,IAAI,CAAChD;QAE9C,MAAM+C,UAAU,OAAOE;YACrBC,IAAAA,iCAAyB,EAACD;YAC1B,MAAME,gBAAgBC,IAAAA,kBAAW,EAACH;YAClC,IAAI,CAACpF,MAAM,CAAC;gBAAEC,QAAQ;YAAkB;YACxC,IAAI;gBACF,OAAO,MAAMuF,IAAAA,oBAAY,EACvBP,gBAAgBK,gBAChB,IAAI;YAER,SAAU;gBACR,IAAI,CAACtF,MAAM,CAAC;oBAAEC,QAAQ;gBAAmB;YAC3C;QACF;QAEA,qEAAqE;QACrE,sDAAsD;QACtD,MAAMwF,kBAAkB,IAAIC,MAC1B,CAAC,GACD;YACEC,KAAIC,OAAe,EAAEC,IAAqB;gBACxC,OAAO,OAAOA,SAAS,YAAY;oBAAC;iBAAU,CAACC,QAAQ,CAACD;YAC1D;YACAnB,KAAIkB,OAAO,EAAEC,IAA0B;gBACrC,IAAIA,SAAS,WAAW;oBACtB,OAAOX;gBACT;gBAEA,OAAOa;YACT;QACF;QAGF,OAAOC,OAAOP;IAChB;IAEA;;;;;GAKC,GACD,AAAQ5C,sBAAsBV,QAAwB,EAAkB;QACtE,MAAM8C,kBAAkB9C,SAAS+C,OAAO,CAACC,IAAI,CAAChD;QAE9C,MAAM+C,UAAU,OAAOE;YACrBa,IAAAA,qCAA6B,EAACb;YAC9B,MAAME,gBAAgBC,IAAAA,kBAAW,EAACH;YAClC,IAAI,CAACpF,MAAM,CAAC;gBAAEC,QAAQ;YAAkB;YACxC,IAAI;gBACF,OAAO,MAAMuF,IAAAA,oBAAY,EACvBP,gBAAgBK,gBAChB,IAAI;YAER,SAAU;gBACR,IAAI,CAACtF,MAAM,CAAC;oBAAEC,QAAQ;gBAAmB;YAC3C;QACF;QAEA,MAAMiG,sBAAsBC,IAAAA,2BAAmB,EAAChE,UAAU+C;QAE1D,OAAOc,OAAOE;IAChB;IAEA;;;;GAIC,GACD,AAAQ9B,WAAWzC,MAAc,EAAQ;QACvC,IAAI,CAACyB,QAAQ,CAACgD,MAAM,CAACzE;IACvB;IAEA;;;;;;;;;;GAUC,GACD,MAAcsC,qBACZtC,MAAc,EACd0E,QAAwC,EACvB;QACjB,MAAM7G,OAAO,IAAI,CAAC4D,QAAQ,CAACsB,GAAG,CAAC/C;QAC/B,IAAInC,SAASuG,WAAW;YACtB,MAAM,IAAI3F,MACR,CAAC,8CAA8C,EAAEuB,OAAO,EAAE,CAAC;QAE/D;QAEA,IAAI6C;QACJ,MAAM8B,cAAc,IAAIC,QACtB,CAACC,GAAGC,SACDjC,OAAO,IACNiC,OACE,kEAAkE;gBAClE/F,uBAAS,CAAClC,GAAG,CAACC,QAAQ,CACpB,CAAC,UAAU,EAAEkD,OAAO,uCAAuC,CAAC;QAKtE,oEAAoE;QACpE,MAAM+E,iBAAiB;YAAElC,MAAMA;QAAM;QAErC,IAAI;YACFhF,KAAK+D,kBAAkB,CAACoD,GAAG,CAACD;YAC5B,8CAA8C;YAC9C,oEAAoE;YACpE,uCAAuC;YACvC,OAAO,MAAMH,QAAQK,IAAI,CAAC;gBAACP;gBAAYC;aAAY;QACrD,SAAU;YACR9G,KAAK+D,kBAAkB,CAAC6C,MAAM,CAACM;YAE/B,IAAIlH,KAAK+D,kBAAkB,CAACsD,IAAI,KAAK,GAAG;gBACtC,IAAI,CAACC,YAAY,IAAI;gBACrB,MAAMtH,KAAK8D,YAAY;YACzB;QACF;IACF;IAnZA,YAAsB/B,aAAqB,EAAEc,SAAiB,CAAE;QAdhE,uBAAiBe,YAAjB,KAAA;QAEA,uBAAiB7B,iBAAjB,KAAA;QAEA,uBAAiBc,aAAjB,KAAA;QAEA,uBAAiBnB,WAAjB,KAAA;QAEA,uBAAQe,oBAAR,KAAA;QAEA,uBAAQF,2BAAR,KAAA;QAEA,uBAAQ+E,gBAAe;QAGrB,IAAI,CAAC1D,QAAQ,GAAG,IAAI2D;QACpB,IAAI,CAACxF,aAAa,GAAGA;QACrB,IAAI,CAACA,aAAa,CAACyF,EAAE,CAAC,QAAQ,CAACxH;YAC7B,IAAI,CAACU,gBAAgB,CAACV,MAAMyH,KAAK,CAAC,CAAC1H;gBACjC,qCAAqC;gBACrC2H,IAAAA,oBAAQ,EAAC3H;YACX;QACF;QACA,IAAI,CAAC8C,SAAS,GAAGA;QAEjB,IAAI,CAACnB,OAAO,GAAGiG,IAAAA,yCAA+B,EAC5C,IAAI,CAACzF,SAAS,CAACyD,IAAI,CAAC,IAAI,GACxB,OAAOiC,QAAQC,aAAajC;YAC1B,MAAM5F,OAAO,IAAI,CAAC4D,QAAQ,CAACsB,GAAG,CAAC0C;YAC/B,uFAAuF;YACvF,MAAME,UAAU9H,MAAMuD,OAAO,CAACsE,YAAY;YAC1CE,IAAAA,aAAM,EACJD,YAAYvB,WACZ,CAAC,GAAG,EAAEsB,YAAY,4BAA4B,EAAED,OAAO,CAAC;YAE1D,mCAAmC;YACnC,IAAI7G,SAAS,MAAM,IAAI,CAAC0D,oBAAoB,CAACmD,QAAQ,IACnDE,QAAQlC;YAGV,0EAA0E;YAC1E,IAAI7E,WAAWwF,WAAW;gBACxBxF,SAAS;YACX;YAEA,uEAAuE;YACvE,IAAI;gBACF,OAAOgF,IAAAA,kBAAW,EAAChF;YACrB,EAAE,OAAOhB,OAAO;gBACd,MAAM,IAAIiI,UACR,CAAC,sCAAsC,EAAEjI,MAAMb,OAAO,CAAC+I,OAAO,CAC5D,wBACA,IACA,CAAC;YAEP;QACF,GACA,IAAI,CAACpD,WAAW,CAACc,IAAI,CAAC,IAAI;IAE9B;AAuWF"}
@@ -0,0 +1,65 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", {
3
+ value: true
4
+ });
5
+ function _export(target, all) {
6
+ for(var name in all)Object.defineProperty(target, name, {
7
+ enumerable: true,
8
+ get: all[name]
9
+ });
10
+ }
11
+ _export(exports, {
12
+ getHandlerArguments: function() {
13
+ return getHandlerArguments;
14
+ },
15
+ getCommandMethodImplementations: function() {
16
+ return getCommandMethodImplementations;
17
+ }
18
+ });
19
+ const _snapsutils = require("@metamask/snaps-utils");
20
+ const _utils = require("@metamask/utils");
21
+ const _validation = require("./validation");
22
+ function getHandlerArguments(origin, handler, request) {
23
+ // `request` is already validated by the time this function is called.
24
+ switch(handler){
25
+ case _snapsutils.HandlerType.OnTransaction:
26
+ {
27
+ (0, _validation.assertIsOnTransactionRequestArguments)(request.params);
28
+ const { transaction, chainId, transactionOrigin } = request.params;
29
+ return {
30
+ transaction,
31
+ chainId,
32
+ transactionOrigin
33
+ };
34
+ }
35
+ case _snapsutils.HandlerType.OnRpcRequest:
36
+ return {
37
+ origin,
38
+ request
39
+ };
40
+ case _snapsutils.HandlerType.OnCronjob:
41
+ return {
42
+ request
43
+ };
44
+ default:
45
+ return (0, _utils.assertExhaustive)(handler);
46
+ }
47
+ }
48
+ function getCommandMethodImplementations(startSnap, invokeSnap, onTerminate) {
49
+ return {
50
+ ping: async ()=>Promise.resolve('OK'),
51
+ terminate: async ()=>{
52
+ onTerminate();
53
+ return Promise.resolve('OK');
54
+ },
55
+ executeSnap: async (snapId, sourceCode, endowments)=>{
56
+ await startSnap(snapId, sourceCode, endowments);
57
+ return 'OK';
58
+ },
59
+ snapRpc: async (target, handler, origin, request)=>{
60
+ return await invokeSnap(target, handler, getHandlerArguments(origin, handler, request)) ?? null;
61
+ }
62
+ };
63
+ }
64
+
65
+ //# sourceMappingURL=commands.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../src/common/commands.ts"],"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 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"],"names":["getHandlerArguments","getCommandMethodImplementations","origin","handler","request","HandlerType","OnTransaction","assertIsOnTransactionRequestArguments","params","transaction","chainId","transactionOrigin","OnRpcRequest","OnCronjob","assertExhaustive","startSnap","invokeSnap","onTerminate","ping","Promise","resolve","terminate","executeSnap","snapId","sourceCode","endowments","snapRpc","target"],"mappings":";;;;;;;;;;;IA4BgBA,mBAAmB;eAAnBA;;IAyCAC,+BAA+B;eAA/BA;;;4BArEY;uBACK;4BAU1B;AAiBA,SAASD,oBACdE,MAAc,EACdC,OAAoB,EACpBC,OAAgC;IAEhC,sEAAsE;IAEtE,OAAQD;QACN,KAAKE,uBAAW,CAACC,aAAa;YAAE;gBAC9BC,IAAAA,iDAAqC,EAACH,QAAQI,MAAM;gBAEpD,MAAM,EAAEC,WAAW,EAAEC,OAAO,EAAEC,iBAAiB,EAAE,GAAGP,QAAQI,MAAM;gBAClE,OAAO;oBACLC;oBACAC;oBACAC;gBACF;YACF;QAEA,KAAKN,uBAAW,CAACO,YAAY;YAC3B,OAAO;gBAAEV;gBAAQE;YAAQ;QAE3B,KAAKC,uBAAW,CAACQ,SAAS;YACxB,OAAO;gBAAET;YAAQ;QAEnB;YACE,OAAOU,IAAAA,uBAAgB,EAACX;IAC5B;AACF;AAaO,SAASF,gCACdc,SAA8D,EAC9DC,UAAsB,EACtBC,WAAuB;IAEvB,OAAO;QACLC,MAAM,UAAYC,QAAQC,OAAO,CAAC;QAClCC,WAAW;YACTJ;YACA,OAAOE,QAAQC,OAAO,CAAC;QACzB;QAEAE,aAAa,OAAOC,QAAQC,YAAYC;YACtC,MAAMV,UAAUQ,QAAQC,YAAYC;YACpC,OAAO;QACT;QAEAC,SAAS,OAAOC,QAAQxB,SAASD,QAAQE;YACvC,OACE,AAAC,MAAMY,WACLW,QACAxB,SACAH,oBAAoBE,QAAQC,SAASC,aACjC;QAEV;IACF;AACF"}