@metamask/snaps-controllers 5.0.1 → 6.0.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 (532) hide show
  1. package/CHANGELOG.md +18 -1
  2. package/dist/chunk-36YC4Z3T.mjs +109 -0
  3. package/dist/chunk-36YC4Z3T.mjs.map +1 -0
  4. package/dist/chunk-3RNW7OKG.mjs +1 -0
  5. package/dist/chunk-3RNW7OKG.mjs.map +1 -0
  6. package/dist/chunk-43ODL57R.js +39 -0
  7. package/dist/chunk-43ODL57R.js.map +1 -0
  8. package/dist/chunk-4HVWEABQ.mjs +9 -0
  9. package/dist/chunk-4HVWEABQ.mjs.map +1 -0
  10. package/dist/chunk-4LGL4A3M.js +105 -0
  11. package/dist/chunk-4LGL4A3M.js.map +1 -0
  12. package/dist/chunk-4URGXJP7.js +1 -0
  13. package/dist/chunk-4URGXJP7.js.map +1 -0
  14. package/dist/chunk-5R4ENIDN.mjs +2307 -0
  15. package/dist/chunk-5R4ENIDN.mjs.map +1 -0
  16. package/dist/chunk-5YBORD3A.js +19 -0
  17. package/dist/chunk-5YBORD3A.js.map +1 -0
  18. package/dist/chunk-6EZSNS4O.mjs +59 -0
  19. package/dist/chunk-6EZSNS4O.mjs.map +1 -0
  20. package/dist/chunk-6GMWL4JR.mjs +92 -0
  21. package/dist/chunk-6GMWL4JR.mjs.map +1 -0
  22. package/dist/chunk-6N6KZYVD.js +12 -0
  23. package/dist/chunk-6N6KZYVD.js.map +1 -0
  24. package/dist/chunk-6NYC5VNK.mjs +354 -0
  25. package/dist/chunk-6NYC5VNK.mjs.map +1 -0
  26. package/dist/chunk-6XGUJ27X.js +72 -0
  27. package/dist/chunk-6XGUJ27X.js.map +1 -0
  28. package/dist/chunk-6YVCFPP6.mjs +58 -0
  29. package/dist/chunk-6YVCFPP6.mjs.map +1 -0
  30. package/dist/chunk-7JY5VENP.js +273 -0
  31. package/dist/chunk-7JY5VENP.js.map +1 -0
  32. package/dist/chunk-7PZECZV3.mjs +38 -0
  33. package/dist/chunk-7PZECZV3.mjs.map +1 -0
  34. package/dist/chunk-7WOG63YY.js +40 -0
  35. package/dist/chunk-7WOG63YY.js.map +1 -0
  36. package/dist/chunk-7Y6P5FRN.js +60 -0
  37. package/dist/chunk-7Y6P5FRN.js.map +1 -0
  38. package/dist/chunk-A6WJEA3C.js +1 -0
  39. package/dist/chunk-A6WJEA3C.js.map +1 -0
  40. package/dist/chunk-AP7CJ6DA.js +47 -0
  41. package/dist/chunk-AP7CJ6DA.js.map +1 -0
  42. package/dist/chunk-B3UTLNYS.mjs +48 -0
  43. package/dist/chunk-B3UTLNYS.mjs.map +1 -0
  44. package/dist/chunk-B67RDBZ4.mjs +40 -0
  45. package/dist/chunk-B67RDBZ4.mjs.map +1 -0
  46. package/dist/chunk-B7R3EWM3.mjs +1 -0
  47. package/dist/chunk-B7R3EWM3.mjs.map +1 -0
  48. package/dist/chunk-BAEXVO3U.mjs +1 -0
  49. package/dist/chunk-BAEXVO3U.mjs.map +1 -0
  50. package/dist/chunk-BO2ZDPWV.js +59 -0
  51. package/dist/chunk-BO2ZDPWV.js.map +1 -0
  52. package/dist/chunk-C4D6GBMY.js +71 -0
  53. package/dist/chunk-C4D6GBMY.js.map +1 -0
  54. package/dist/chunk-D74XJG2L.js +1 -0
  55. package/dist/chunk-D74XJG2L.js.map +1 -0
  56. package/dist/chunk-DSQYZGBH.mjs +273 -0
  57. package/dist/chunk-DSQYZGBH.mjs.map +1 -0
  58. package/dist/chunk-ESQPQNEF.mjs +1 -0
  59. package/dist/chunk-ESQPQNEF.mjs.map +1 -0
  60. package/dist/chunk-EXN2TFDJ.js +38 -0
  61. package/dist/chunk-EXN2TFDJ.js.map +1 -0
  62. package/dist/chunk-FX5AADOV.mjs +1 -0
  63. package/dist/chunk-FX5AADOV.mjs.map +1 -0
  64. package/dist/chunk-FZY2Z5NP.js +38 -0
  65. package/dist/chunk-FZY2Z5NP.js.map +1 -0
  66. package/dist/chunk-G66GQJS6.js +1 -0
  67. package/dist/chunk-G66GQJS6.js.map +1 -0
  68. package/dist/chunk-G7U6WKWS.mjs +1 -0
  69. package/dist/chunk-G7U6WKWS.mjs.map +1 -0
  70. package/dist/chunk-HOY6NKQR.js +1 -0
  71. package/dist/chunk-HOY6NKQR.js.map +1 -0
  72. package/dist/chunk-HWJE3SDW.mjs +1 -0
  73. package/dist/chunk-HWJE3SDW.mjs.map +1 -0
  74. package/dist/chunk-IABOI7TW.mjs +1 -0
  75. package/dist/chunk-IABOI7TW.mjs.map +1 -0
  76. package/dist/chunk-IGC4E7PI.mjs +71 -0
  77. package/dist/chunk-IGC4E7PI.mjs.map +1 -0
  78. package/dist/chunk-IMBPDTVN.mjs +72 -0
  79. package/dist/chunk-IMBPDTVN.mjs.map +1 -0
  80. package/dist/chunk-J4PGHMLL.js +38 -0
  81. package/dist/chunk-J4PGHMLL.js.map +1 -0
  82. package/dist/chunk-JAUAKTUL.js +1 -0
  83. package/dist/chunk-JAUAKTUL.js.map +1 -0
  84. package/dist/chunk-JDHKH5YU.js +354 -0
  85. package/dist/chunk-JDHKH5YU.js.map +1 -0
  86. package/dist/chunk-JW7WBUL7.js +1 -0
  87. package/dist/chunk-JW7WBUL7.js.map +1 -0
  88. package/dist/chunk-K276CM3B.mjs +197 -0
  89. package/dist/chunk-K276CM3B.mjs.map +1 -0
  90. package/dist/chunk-KBVG3CL2.js +58 -0
  91. package/dist/chunk-KBVG3CL2.js.map +1 -0
  92. package/dist/chunk-KCMULJ2M.mjs +1 -0
  93. package/dist/chunk-KCMULJ2M.mjs.map +1 -0
  94. package/dist/chunk-KF4PCKG7.mjs +74 -0
  95. package/dist/chunk-KF4PCKG7.mjs.map +1 -0
  96. package/dist/chunk-KLK7ZRMH.js +55 -0
  97. package/dist/chunk-KLK7ZRMH.js.map +1 -0
  98. package/dist/chunk-LWBPKSU2.js +48 -0
  99. package/dist/chunk-LWBPKSU2.js.map +1 -0
  100. package/dist/chunk-MYWDTEX2.js +283 -0
  101. package/dist/chunk-MYWDTEX2.js.map +1 -0
  102. package/dist/chunk-NC5PBDKD.mjs +47 -0
  103. package/dist/chunk-NC5PBDKD.mjs.map +1 -0
  104. package/dist/chunk-NOLPMHXS.js +101 -0
  105. package/dist/chunk-NOLPMHXS.js.map +1 -0
  106. package/dist/chunk-NXZVKBSV.js +9 -0
  107. package/dist/chunk-NXZVKBSV.js.map +1 -0
  108. package/dist/chunk-OHMCPTOI.js +1 -0
  109. package/dist/chunk-OHMCPTOI.js.map +1 -0
  110. package/dist/chunk-OIEUL55W.js +1 -0
  111. package/dist/chunk-OIEUL55W.js.map +1 -0
  112. package/dist/chunk-P7Y6MIZW.mjs +7 -0
  113. package/dist/chunk-P7Y6MIZW.mjs.map +1 -0
  114. package/dist/chunk-PGKMKSAR.mjs +105 -0
  115. package/dist/chunk-PGKMKSAR.mjs.map +1 -0
  116. package/dist/chunk-PXECEHH7.mjs +39 -0
  117. package/dist/chunk-PXECEHH7.mjs.map +1 -0
  118. package/dist/chunk-Q2ON6SMV.js +197 -0
  119. package/dist/chunk-Q2ON6SMV.js.map +1 -0
  120. package/dist/chunk-QL3QGUTM.mjs +1 -0
  121. package/dist/chunk-QL3QGUTM.mjs.map +1 -0
  122. package/dist/chunk-RDBT3ZJQ.js +92 -0
  123. package/dist/chunk-RDBT3ZJQ.js.map +1 -0
  124. package/dist/chunk-RIU3ZIXZ.mjs +55 -0
  125. package/dist/chunk-RIU3ZIXZ.mjs.map +1 -0
  126. package/dist/chunk-RU67JKBV.mjs +12 -0
  127. package/dist/chunk-RU67JKBV.mjs.map +1 -0
  128. package/dist/chunk-TG6OXBLR.js +1 -0
  129. package/dist/chunk-TG6OXBLR.js.map +1 -0
  130. package/dist/chunk-TMWMIQV4.js +1 -0
  131. package/dist/chunk-TMWMIQV4.js.map +1 -0
  132. package/dist/chunk-U6T2MPXT.js +74 -0
  133. package/dist/chunk-U6T2MPXT.js.map +1 -0
  134. package/dist/chunk-U74FML7Z.mjs +1 -0
  135. package/dist/chunk-U74FML7Z.mjs.map +1 -0
  136. package/dist/chunk-V6NFZ47P.mjs +1 -0
  137. package/dist/chunk-V6NFZ47P.mjs.map +1 -0
  138. package/dist/chunk-VNOCJWOK.js +1 -0
  139. package/dist/chunk-VNOCJWOK.js.map +1 -0
  140. package/dist/chunk-VOZOZKRC.mjs +101 -0
  141. package/dist/chunk-VOZOZKRC.mjs.map +1 -0
  142. package/dist/chunk-WEY7ICES.js +1 -0
  143. package/dist/chunk-WEY7ICES.js.map +1 -0
  144. package/dist/chunk-WKQRCGUW.mjs +331 -0
  145. package/dist/chunk-WKQRCGUW.mjs.map +1 -0
  146. package/dist/chunk-XE5IWVNV.js +109 -0
  147. package/dist/chunk-XE5IWVNV.js.map +1 -0
  148. package/dist/chunk-XWDEGRM5.js +331 -0
  149. package/dist/chunk-XWDEGRM5.js.map +1 -0
  150. package/dist/chunk-YIQM6ZKA.mjs +19 -0
  151. package/dist/chunk-YIQM6ZKA.mjs.map +1 -0
  152. package/dist/chunk-YRZVIDCF.mjs +38 -0
  153. package/dist/chunk-YRZVIDCF.mjs.map +1 -0
  154. package/dist/chunk-YYPUPKQY.js +7 -0
  155. package/dist/chunk-YYPUPKQY.js.map +1 -0
  156. package/dist/chunk-ZAMIT33L.js +2307 -0
  157. package/dist/chunk-ZAMIT33L.js.map +1 -0
  158. package/dist/chunk-ZETJVFUS.mjs +283 -0
  159. package/dist/chunk-ZETJVFUS.mjs.map +1 -0
  160. package/dist/chunk-ZQAGLOXD.mjs +1 -0
  161. package/dist/chunk-ZQAGLOXD.mjs.map +1 -0
  162. package/dist/chunk-ZRS2VVUV.mjs +38 -0
  163. package/dist/chunk-ZRS2VVUV.mjs.map +1 -0
  164. package/dist/chunk-ZVOYOZFT.mjs +60 -0
  165. package/dist/chunk-ZVOYOZFT.mjs.map +1 -0
  166. package/dist/cronjob/CronjobController.js +41 -0
  167. package/dist/cronjob/CronjobController.js.map +1 -0
  168. package/dist/cronjob/CronjobController.mjs +41 -0
  169. package/dist/cronjob/CronjobController.mjs.map +1 -0
  170. package/dist/cronjob/index.js +41 -0
  171. package/dist/cronjob/index.js.map +1 -0
  172. package/dist/cronjob/index.mjs +41 -0
  173. package/dist/cronjob/index.mjs.map +1 -0
  174. package/dist/fsm.js +10 -0
  175. package/dist/fsm.js.map +1 -0
  176. package/dist/fsm.mjs +10 -0
  177. package/dist/fsm.mjs.map +1 -0
  178. package/dist/index.js +118 -0
  179. package/dist/index.js.map +1 -0
  180. package/dist/index.mjs +118 -0
  181. package/dist/index.mjs.map +1 -0
  182. package/dist/interface/SnapInterfaceController.js +9 -0
  183. package/dist/interface/SnapInterfaceController.js.map +1 -0
  184. package/dist/interface/SnapInterfaceController.mjs +9 -0
  185. package/dist/interface/SnapInterfaceController.mjs.map +1 -0
  186. package/dist/interface/index.js +10 -0
  187. package/dist/interface/index.js.map +1 -0
  188. package/dist/interface/index.mjs +10 -0
  189. package/dist/interface/index.mjs.map +1 -0
  190. package/dist/interface/utils.js +14 -0
  191. package/dist/interface/utils.js.map +1 -0
  192. package/dist/interface/utils.mjs +14 -0
  193. package/dist/interface/utils.mjs.map +1 -0
  194. package/dist/logging.js +8 -0
  195. package/dist/logging.js.map +1 -0
  196. package/dist/logging.mjs +8 -0
  197. package/dist/logging.mjs.map +1 -0
  198. package/dist/node.js +128 -0
  199. package/dist/node.js.map +1 -0
  200. package/dist/node.mjs +128 -0
  201. package/dist/node.mjs.map +1 -0
  202. package/dist/react-native.js +125 -0
  203. package/dist/react-native.js.map +1 -0
  204. package/dist/react-native.mjs +125 -0
  205. package/dist/react-native.mjs.map +1 -0
  206. package/dist/services/AbstractExecutionService.js +13 -0
  207. package/dist/services/AbstractExecutionService.js.map +1 -0
  208. package/dist/services/AbstractExecutionService.mjs +13 -0
  209. package/dist/services/AbstractExecutionService.mjs.map +1 -0
  210. package/dist/services/ExecutionService.js +2 -0
  211. package/dist/services/ExecutionService.js.map +1 -0
  212. package/dist/services/ExecutionService.mjs +2 -0
  213. package/dist/services/ExecutionService.mjs.map +1 -0
  214. package/dist/services/ProxyPostMessageStream.js +8 -0
  215. package/dist/services/ProxyPostMessageStream.js.map +1 -0
  216. package/dist/services/ProxyPostMessageStream.mjs +8 -0
  217. package/dist/services/ProxyPostMessageStream.mjs.map +1 -0
  218. package/dist/services/browser.js +40 -0
  219. package/dist/services/browser.js.map +1 -0
  220. package/dist/services/browser.mjs +40 -0
  221. package/dist/services/browser.mjs.map +1 -0
  222. package/dist/services/iframe/IframeExecutionService.js +12 -0
  223. package/dist/services/iframe/IframeExecutionService.js.map +1 -0
  224. package/dist/services/iframe/IframeExecutionService.mjs +12 -0
  225. package/dist/services/iframe/IframeExecutionService.mjs.map +1 -0
  226. package/dist/services/iframe/index.js +13 -0
  227. package/dist/services/iframe/index.js.map +1 -0
  228. package/dist/services/iframe/index.mjs +13 -0
  229. package/dist/services/iframe/index.mjs.map +1 -0
  230. package/dist/services/index.js +35 -0
  231. package/dist/services/index.js.map +1 -0
  232. package/dist/services/index.mjs +35 -0
  233. package/dist/services/index.mjs.map +1 -0
  234. package/dist/services/node-js/NodeProcessExecutionService.js +22 -0
  235. package/dist/services/node-js/NodeProcessExecutionService.js.map +1 -0
  236. package/dist/services/node-js/NodeProcessExecutionService.mjs +22 -0
  237. package/dist/services/node-js/NodeProcessExecutionService.mjs.map +1 -0
  238. package/dist/services/node-js/NodeThreadExecutionService.js +22 -0
  239. package/dist/services/node-js/NodeThreadExecutionService.js.map +1 -0
  240. package/dist/services/node-js/NodeThreadExecutionService.mjs +22 -0
  241. package/dist/services/node-js/NodeThreadExecutionService.mjs.map +1 -0
  242. package/dist/services/node-js/index.js +27 -0
  243. package/dist/services/node-js/index.js.map +1 -0
  244. package/dist/services/node-js/index.mjs +27 -0
  245. package/dist/services/node-js/index.mjs.map +1 -0
  246. package/dist/services/node.js +45 -0
  247. package/dist/services/node.js.map +1 -0
  248. package/dist/services/node.mjs +45 -0
  249. package/dist/services/node.mjs.map +1 -0
  250. package/dist/services/offscreen/OffscreenExecutionService.js +14 -0
  251. package/dist/services/offscreen/OffscreenExecutionService.js.map +1 -0
  252. package/dist/services/offscreen/OffscreenExecutionService.mjs +14 -0
  253. package/dist/services/offscreen/OffscreenExecutionService.mjs.map +1 -0
  254. package/dist/services/offscreen/index.js +15 -0
  255. package/dist/services/offscreen/index.js.map +1 -0
  256. package/dist/services/offscreen/index.mjs +15 -0
  257. package/dist/services/offscreen/index.mjs.map +1 -0
  258. package/dist/services/proxy/ProxyExecutionService.js +13 -0
  259. package/dist/services/proxy/ProxyExecutionService.js.map +1 -0
  260. package/dist/services/proxy/ProxyExecutionService.mjs +13 -0
  261. package/dist/services/proxy/ProxyExecutionService.mjs.map +1 -0
  262. package/dist/services/react-native.js +42 -0
  263. package/dist/services/react-native.js.map +1 -0
  264. package/dist/services/react-native.mjs +42 -0
  265. package/dist/services/react-native.mjs.map +1 -0
  266. package/dist/services/webview/WebViewExecutionService.js +15 -0
  267. package/dist/services/webview/WebViewExecutionService.js.map +1 -0
  268. package/dist/services/webview/WebViewExecutionService.mjs +15 -0
  269. package/dist/services/webview/WebViewExecutionService.mjs.map +1 -0
  270. package/dist/services/webview/WebViewMessageStream.js +8 -0
  271. package/dist/services/webview/WebViewMessageStream.js.map +1 -0
  272. package/dist/services/webview/WebViewMessageStream.mjs +8 -0
  273. package/dist/services/webview/WebViewMessageStream.mjs.map +1 -0
  274. package/dist/services/webview/index.js +16 -0
  275. package/dist/services/webview/index.js.map +1 -0
  276. package/dist/services/webview/index.mjs +16 -0
  277. package/dist/services/webview/index.mjs.map +1 -0
  278. package/dist/services/webworker/WebWorkerExecutionService.js +15 -0
  279. package/dist/services/webworker/WebWorkerExecutionService.js.map +1 -0
  280. package/dist/services/webworker/WebWorkerExecutionService.mjs +15 -0
  281. package/dist/services/webworker/WebWorkerExecutionService.mjs.map +1 -0
  282. package/dist/services/webworker/index.js +16 -0
  283. package/dist/services/webworker/index.js.map +1 -0
  284. package/dist/services/webworker/index.mjs +16 -0
  285. package/dist/services/webworker/index.mjs.map +1 -0
  286. package/dist/snaps/RequestQueue.js +8 -0
  287. package/dist/snaps/RequestQueue.js.map +1 -0
  288. package/dist/snaps/RequestQueue.mjs +8 -0
  289. package/dist/snaps/RequestQueue.mjs.map +1 -0
  290. package/dist/snaps/SnapController.js +30 -0
  291. package/dist/snaps/SnapController.js.map +1 -0
  292. package/dist/snaps/SnapController.mjs +30 -0
  293. package/dist/snaps/SnapController.mjs.map +1 -0
  294. package/dist/snaps/Timer.js +8 -0
  295. package/dist/snaps/Timer.js.map +1 -0
  296. package/dist/snaps/Timer.mjs +8 -0
  297. package/dist/snaps/Timer.mjs.map +1 -0
  298. package/dist/snaps/constants.js +8 -0
  299. package/dist/snaps/constants.js.map +1 -0
  300. package/dist/snaps/constants.mjs +8 -0
  301. package/dist/snaps/constants.mjs.map +1 -0
  302. package/dist/snaps/index.js +63 -0
  303. package/dist/snaps/index.js.map +1 -0
  304. package/dist/snaps/index.mjs +63 -0
  305. package/dist/snaps/index.mjs.map +1 -0
  306. package/dist/snaps/location/http.js +8 -0
  307. package/dist/snaps/location/http.js.map +1 -0
  308. package/dist/snaps/location/http.mjs +8 -0
  309. package/dist/snaps/location/http.mjs.map +1 -0
  310. package/dist/snaps/location/index.js +31 -0
  311. package/dist/snaps/location/index.js.map +1 -0
  312. package/dist/snaps/location/index.mjs +31 -0
  313. package/dist/snaps/location/index.mjs.map +1 -0
  314. package/dist/snaps/location/local.js +9 -0
  315. package/dist/snaps/location/local.js.map +1 -0
  316. package/dist/snaps/location/local.mjs +9 -0
  317. package/dist/snaps/location/local.mjs.map +1 -0
  318. package/dist/snaps/location/location.js +11 -0
  319. package/dist/snaps/location/location.js.map +1 -0
  320. package/dist/snaps/location/location.mjs +11 -0
  321. package/dist/snaps/location/location.mjs.map +1 -0
  322. package/dist/snaps/location/npm.js +18 -0
  323. package/dist/snaps/location/npm.js.map +1 -0
  324. package/dist/snaps/location/npm.mjs +18 -0
  325. package/dist/snaps/location/npm.mjs.map +1 -0
  326. package/dist/snaps/registry/index.js +13 -0
  327. package/dist/snaps/registry/index.js.map +1 -0
  328. package/dist/snaps/registry/index.mjs +13 -0
  329. package/dist/snaps/registry/index.mjs.map +1 -0
  330. package/dist/snaps/registry/json.js +9 -0
  331. package/dist/snaps/registry/json.js.map +1 -0
  332. package/dist/snaps/registry/json.mjs +9 -0
  333. package/dist/snaps/registry/json.mjs.map +1 -0
  334. package/dist/snaps/registry/registry.js +8 -0
  335. package/dist/snaps/registry/registry.js.map +1 -0
  336. package/dist/snaps/registry/registry.mjs +8 -0
  337. package/dist/snaps/registry/registry.mjs.map +1 -0
  338. package/dist/snaps/selectors.js +8 -0
  339. package/dist/snaps/selectors.js.map +1 -0
  340. package/dist/snaps/selectors.mjs +8 -0
  341. package/dist/snaps/selectors.mjs.map +1 -0
  342. package/dist/tsconfig.build.tsbuildinfo +1 -0
  343. package/dist/types/node.d.ts +2 -0
  344. package/dist/types/react-native.d.ts +2 -0
  345. package/dist/types/services/index.d.ts +0 -2
  346. package/dist/types/services/node.d.ts +2 -0
  347. package/dist/types/services/react-native.d.ts +2 -0
  348. package/dist/types/utils.d.ts +1 -1
  349. package/dist/types/vendor/global.d.js +1 -0
  350. package/dist/types/vendor/global.d.js.map +1 -0
  351. package/dist/types/vendor/global.d.mjs +1 -0
  352. package/dist/types/vendor/global.d.mjs.map +1 -0
  353. package/dist/types/vendor/readable-stream.d.js +1 -0
  354. package/dist/types/vendor/readable-stream.d.js.map +1 -0
  355. package/dist/types/vendor/readable-stream.d.mjs +1 -0
  356. package/dist/types/vendor/readable-stream.d.mjs.map +1 -0
  357. package/dist/types/vendor/zlib.d.js +1 -0
  358. package/dist/types/vendor/zlib.d.js.map +1 -0
  359. package/dist/types/vendor/zlib.d.mjs +1 -0
  360. package/dist/types/vendor/zlib.d.mjs.map +1 -0
  361. package/dist/utils.js +21 -0
  362. package/dist/utils.js.map +1 -0
  363. package/dist/utils.mjs +21 -0
  364. package/dist/utils.mjs.map +1 -0
  365. package/package.json +31 -22
  366. package/dist/cjs/cronjob/CronjobController.js +0 -296
  367. package/dist/cjs/cronjob/CronjobController.js.map +0 -1
  368. package/dist/cjs/cronjob/index.js +0 -20
  369. package/dist/cjs/cronjob/index.js.map +0 -1
  370. package/dist/cjs/fsm.js +0 -69
  371. package/dist/cjs/fsm.js.map +0 -1
  372. package/dist/cjs/index.js +0 -24
  373. package/dist/cjs/index.js.map +0 -1
  374. package/dist/cjs/interface/SnapInterfaceController.js +0 -166
  375. package/dist/cjs/interface/SnapInterfaceController.js.map +0 -1
  376. package/dist/cjs/interface/index.js +0 -20
  377. package/dist/cjs/interface/index.js.map +0 -1
  378. package/dist/cjs/interface/utils.js +0 -59
  379. package/dist/cjs/interface/utils.js.map +0 -1
  380. package/dist/cjs/logging.js +0 -15
  381. package/dist/cjs/logging.js.map +0 -1
  382. package/dist/cjs/services/AbstractExecutionService.js +0 -387
  383. package/dist/cjs/services/AbstractExecutionService.js.map +0 -1
  384. package/dist/cjs/services/ExecutionService.js +0 -7
  385. package/dist/cjs/services/ExecutionService.js.map +0 -1
  386. package/dist/cjs/services/ProxyPostMessageStream.js +0 -109
  387. package/dist/cjs/services/ProxyPostMessageStream.js.map +0 -1
  388. package/dist/cjs/services/browser.js +0 -33
  389. package/dist/cjs/services/browser.js.map +0 -1
  390. package/dist/cjs/services/iframe/IframeExecutionService.js +0 -54
  391. package/dist/cjs/services/iframe/IframeExecutionService.js.map +0 -1
  392. package/dist/cjs/services/iframe/index.js +0 -20
  393. package/dist/cjs/services/iframe/index.js.map +0 -1
  394. package/dist/cjs/services/index.js +0 -33
  395. package/dist/cjs/services/index.js.map +0 -1
  396. package/dist/cjs/services/node/NodeProcessExecutionService.js +0 -42
  397. package/dist/cjs/services/node/NodeProcessExecutionService.js.map +0 -1
  398. package/dist/cjs/services/node/NodeThreadExecutionService.js +0 -43
  399. package/dist/cjs/services/node/NodeThreadExecutionService.js.map +0 -1
  400. package/dist/cjs/services/node/index.js +0 -21
  401. package/dist/cjs/services/node/index.js.map +0 -1
  402. package/dist/cjs/services/offscreen/OffscreenExecutionService.js +0 -96
  403. package/dist/cjs/services/offscreen/OffscreenExecutionService.js.map +0 -1
  404. package/dist/cjs/services/offscreen/index.js +0 -20
  405. package/dist/cjs/services/offscreen/index.js.map +0 -1
  406. package/dist/cjs/services/proxy/ProxyExecutionService.js +0 -110
  407. package/dist/cjs/services/proxy/ProxyExecutionService.js.map +0 -1
  408. package/dist/cjs/services/webview/WebViewExecutionService.js +0 -99
  409. package/dist/cjs/services/webview/WebViewExecutionService.js.map +0 -1
  410. package/dist/cjs/services/webview/WebViewMessageStream.js +0 -127
  411. package/dist/cjs/services/webview/WebViewMessageStream.js.map +0 -1
  412. package/dist/cjs/services/webview/index.js +0 -20
  413. package/dist/cjs/services/webview/index.js.map +0 -1
  414. package/dist/cjs/services/webworker/WebWorkerExecutionService.js +0 -148
  415. package/dist/cjs/services/webworker/WebWorkerExecutionService.js.map +0 -1
  416. package/dist/cjs/services/webworker/index.js +0 -20
  417. package/dist/cjs/services/webworker/index.js.map +0 -1
  418. package/dist/cjs/snaps/RequestQueue.js +0 -63
  419. package/dist/cjs/snaps/RequestQueue.js.map +0 -1
  420. package/dist/cjs/snaps/SnapController.js +0 -1968
  421. package/dist/cjs/snaps/SnapController.js.map +0 -1
  422. package/dist/cjs/snaps/Timer.js +0 -117
  423. package/dist/cjs/snaps/Timer.js.map +0 -1
  424. package/dist/cjs/snaps/constants.js +0 -25
  425. package/dist/cjs/snaps/constants.js.map +0 -1
  426. package/dist/cjs/snaps/index.js +0 -23
  427. package/dist/cjs/snaps/index.js.map +0 -1
  428. package/dist/cjs/snaps/location/http.js +0 -106
  429. package/dist/cjs/snaps/location/http.js.map +0 -1
  430. package/dist/cjs/snaps/location/index.js +0 -23
  431. package/dist/cjs/snaps/location/index.js.map +0 -1
  432. package/dist/cjs/snaps/location/local.js +0 -93
  433. package/dist/cjs/snaps/location/local.js.map +0 -1
  434. package/dist/cjs/snaps/location/location.js +0 -34
  435. package/dist/cjs/snaps/location/location.js.map +0 -1
  436. package/dist/cjs/snaps/location/npm.js +0 -389
  437. package/dist/cjs/snaps/location/npm.js.map +0 -1
  438. package/dist/cjs/snaps/registry/index.js +0 -21
  439. package/dist/cjs/snaps/registry/index.js.map +0 -1
  440. package/dist/cjs/snaps/registry/json.js +0 -311
  441. package/dist/cjs/snaps/registry/json.js.map +0 -1
  442. package/dist/cjs/snaps/registry/registry.js +0 -18
  443. package/dist/cjs/snaps/registry/registry.js.map +0 -1
  444. package/dist/cjs/snaps/selectors.js +0 -13
  445. package/dist/cjs/snaps/selectors.js.map +0 -1
  446. package/dist/cjs/utils.js +0 -111
  447. package/dist/cjs/utils.js.map +0 -1
  448. package/dist/esm/cronjob/CronjobController.js +0 -281
  449. package/dist/esm/cronjob/CronjobController.js.map +0 -1
  450. package/dist/esm/cronjob/index.js +0 -3
  451. package/dist/esm/cronjob/index.js.map +0 -1
  452. package/dist/esm/fsm.js +0 -70
  453. package/dist/esm/fsm.js.map +0 -1
  454. package/dist/esm/index.js +0 -7
  455. package/dist/esm/index.js.map +0 -1
  456. package/dist/esm/interface/SnapInterfaceController.js +0 -158
  457. package/dist/esm/interface/SnapInterfaceController.js.map +0 -1
  458. package/dist/esm/interface/index.js +0 -3
  459. package/dist/esm/interface/index.js.map +0 -1
  460. package/dist/esm/interface/utils.js +0 -62
  461. package/dist/esm/interface/utils.js.map +0 -1
  462. package/dist/esm/logging.js +0 -10
  463. package/dist/esm/logging.js.map +0 -1
  464. package/dist/esm/services/AbstractExecutionService.js +0 -370
  465. package/dist/esm/services/AbstractExecutionService.js.map +0 -1
  466. package/dist/esm/services/ExecutionService.js +0 -4
  467. package/dist/esm/services/ExecutionService.js.map +0 -1
  468. package/dist/esm/services/ProxyPostMessageStream.js +0 -102
  469. package/dist/esm/services/ProxyPostMessageStream.js.map +0 -1
  470. package/dist/esm/services/browser.js +0 -10
  471. package/dist/esm/services/browser.js.map +0 -1
  472. package/dist/esm/services/iframe/IframeExecutionService.js +0 -44
  473. package/dist/esm/services/iframe/IframeExecutionService.js.map +0 -1
  474. package/dist/esm/services/iframe/index.js +0 -3
  475. package/dist/esm/services/iframe/index.js.map +0 -1
  476. package/dist/esm/services/index.js +0 -10
  477. package/dist/esm/services/index.js.map +0 -1
  478. package/dist/esm/services/node/NodeProcessExecutionService.js +0 -32
  479. package/dist/esm/services/node/NodeProcessExecutionService.js.map +0 -1
  480. package/dist/esm/services/node/NodeThreadExecutionService.js +0 -34
  481. package/dist/esm/services/node/NodeThreadExecutionService.js.map +0 -1
  482. package/dist/esm/services/node/index.js +0 -4
  483. package/dist/esm/services/node/index.js.map +0 -1
  484. package/dist/esm/services/offscreen/OffscreenExecutionService.js +0 -86
  485. package/dist/esm/services/offscreen/OffscreenExecutionService.js.map +0 -1
  486. package/dist/esm/services/offscreen/index.js +0 -3
  487. package/dist/esm/services/offscreen/index.js.map +0 -1
  488. package/dist/esm/services/proxy/ProxyExecutionService.js +0 -100
  489. package/dist/esm/services/proxy/ProxyExecutionService.js.map +0 -1
  490. package/dist/esm/services/webview/WebViewExecutionService.js +0 -89
  491. package/dist/esm/services/webview/WebViewExecutionService.js.map +0 -1
  492. package/dist/esm/services/webview/WebViewMessageStream.js +0 -119
  493. package/dist/esm/services/webview/WebViewMessageStream.js.map +0 -1
  494. package/dist/esm/services/webview/index.js +0 -3
  495. package/dist/esm/services/webview/index.js.map +0 -1
  496. package/dist/esm/services/webworker/WebWorkerExecutionService.js +0 -130
  497. package/dist/esm/services/webworker/WebWorkerExecutionService.js.map +0 -1
  498. package/dist/esm/services/webworker/index.js +0 -3
  499. package/dist/esm/services/webworker/index.js.map +0 -1
  500. package/dist/esm/snaps/RequestQueue.js +0 -53
  501. package/dist/esm/snaps/RequestQueue.js.map +0 -1
  502. package/dist/esm/snaps/SnapController.js +0 -1947
  503. package/dist/esm/snaps/SnapController.js.map +0 -1
  504. package/dist/esm/snaps/Timer.js +0 -107
  505. package/dist/esm/snaps/Timer.js.map +0 -1
  506. package/dist/esm/snaps/constants.js +0 -16
  507. package/dist/esm/snaps/constants.js.map +0 -1
  508. package/dist/esm/snaps/index.js +0 -6
  509. package/dist/esm/snaps/index.js.map +0 -1
  510. package/dist/esm/snaps/location/http.js +0 -96
  511. package/dist/esm/snaps/location/http.js.map +0 -1
  512. package/dist/esm/snaps/location/index.js +0 -6
  513. package/dist/esm/snaps/location/index.js.map +0 -1
  514. package/dist/esm/snaps/location/local.js +0 -83
  515. package/dist/esm/snaps/location/local.js.map +0 -1
  516. package/dist/esm/snaps/location/location.js +0 -30
  517. package/dist/esm/snaps/location/location.js.map +0 -1
  518. package/dist/esm/snaps/location/npm.js +0 -373
  519. package/dist/esm/snaps/location/npm.js.map +0 -1
  520. package/dist/esm/snaps/registry/index.js +0 -4
  521. package/dist/esm/snaps/registry/index.js.map +0 -1
  522. package/dist/esm/snaps/registry/json.js +0 -301
  523. package/dist/esm/snaps/registry/json.js.map +0 -1
  524. package/dist/esm/snaps/registry/registry.js +0 -8
  525. package/dist/esm/snaps/registry/registry.js.map +0 -1
  526. package/dist/esm/snaps/selectors.js +0 -3
  527. package/dist/esm/snaps/selectors.js.map +0 -1
  528. package/dist/esm/utils.js +0 -132
  529. package/dist/esm/utils.js.map +0 -1
  530. /package/dist/types/services/{node → node-js}/NodeProcessExecutionService.d.ts +0 -0
  531. /package/dist/types/services/{node → node-js}/NodeThreadExecutionService.d.ts +0 -0
  532. /package/dist/types/services/{node → node-js}/index.d.ts +0 -0
@@ -1,1947 +0,0 @@
1
- function _check_private_redeclaration(obj, privateCollection) {
2
- if (privateCollection.has(obj)) {
3
- throw new TypeError("Cannot initialize the same private elements twice on an object");
4
- }
5
- }
6
- function _class_apply_descriptor_get(receiver, descriptor) {
7
- if (descriptor.get) {
8
- return descriptor.get.call(receiver);
9
- }
10
- return descriptor.value;
11
- }
12
- function _class_apply_descriptor_set(receiver, descriptor, value) {
13
- if (descriptor.set) {
14
- descriptor.set.call(receiver, value);
15
- } else {
16
- if (!descriptor.writable) {
17
- throw new TypeError("attempted to set read only private field");
18
- }
19
- descriptor.value = value;
20
- }
21
- }
22
- function _class_extract_field_descriptor(receiver, privateMap, action) {
23
- if (!privateMap.has(receiver)) {
24
- throw new TypeError("attempted to " + action + " private field on non-instance");
25
- }
26
- return privateMap.get(receiver);
27
- }
28
- function _class_private_field_get(receiver, privateMap) {
29
- var descriptor = _class_extract_field_descriptor(receiver, privateMap, "get");
30
- return _class_apply_descriptor_get(receiver, descriptor);
31
- }
32
- function _class_private_field_init(obj, privateMap, value) {
33
- _check_private_redeclaration(obj, privateMap);
34
- privateMap.set(obj, value);
35
- }
36
- function _class_private_field_set(receiver, privateMap, value) {
37
- var descriptor = _class_extract_field_descriptor(receiver, privateMap, "set");
38
- _class_apply_descriptor_set(receiver, descriptor, value);
39
- return value;
40
- }
41
- function _class_private_method_get(receiver, privateSet, fn) {
42
- if (!privateSet.has(receiver)) {
43
- throw new TypeError("attempted to get private field on non-instance");
44
- }
45
- return fn;
46
- }
47
- function _class_private_method_init(obj, privateSet) {
48
- _check_private_redeclaration(obj, privateSet);
49
- privateSet.add(obj);
50
- }
51
- function _define_property(obj, key, value) {
52
- if (key in obj) {
53
- Object.defineProperty(obj, key, {
54
- value: value,
55
- enumerable: true,
56
- configurable: true,
57
- writable: true
58
- });
59
- } else {
60
- obj[key] = value;
61
- }
62
- return obj;
63
- }
64
- import { BaseController } from '@metamask/base-controller';
65
- import { SubjectType } from '@metamask/permission-controller';
66
- import { rpcErrors } from '@metamask/rpc-errors';
67
- import { WALLET_SNAP_PERMISSION_KEY, getMaxRequestTimeCaveat, handlerEndowments, SnapEndowments, getKeyringCaveatOrigins, getRpcCaveatOrigins, processSnapPermissions } from '@metamask/snaps-rpc-methods';
68
- import { AuxiliaryFileEncoding, getErrorMessage } from '@metamask/snaps-sdk';
69
- import { assertIsSnapManifest, assertIsValidSnapId, DEFAULT_ENDOWMENTS, DEFAULT_REQUESTED_SNAP_VERSION, encodeAuxiliaryFile, HandlerType, isOriginAllowed, logError, normalizeRelative, OnTransactionResponseStruct, OnSignatureResponseStruct, resolveVersionRange, SnapCaveatType, SnapStatus, SnapStatusEvents, unwrapError, OnHomePageResponseStruct, getValidatedLocalizationFiles, VirtualFile, NpmSnapFileNames, OnNameLookupResponseStruct, getLocalizedSnapManifest } from '@metamask/snaps-utils';
70
- import { assert, assertIsJsonRpcRequest, assertStruct, Duration, gtRange, gtVersion, hasProperty, inMilliseconds, isNonEmptyArray, isValidSemVerRange, satisfiesVersionRange, timeSince } from '@metamask/utils';
71
- import { createMachine, interpret } from '@xstate/fsm';
72
- import { nanoid } from 'nanoid';
73
- import { forceStrict, validateMachine } from '../fsm';
74
- import { log } from '../logging';
75
- import { fetchSnap, hasTimedOut, setDiff, withTimeout } from '../utils';
76
- import { ALLOWED_PERMISSIONS } from './constants';
77
- import { detectSnapLocation } from './location';
78
- import { SnapsRegistryStatus } from './registry';
79
- import { RequestQueue } from './RequestQueue';
80
- import { Timer } from './Timer';
81
- export const controllerName = 'SnapController';
82
- // TODO: Figure out how to name these
83
- export const SNAP_APPROVAL_INSTALL = 'wallet_installSnap';
84
- export const SNAP_APPROVAL_UPDATE = 'wallet_updateSnap';
85
- export const SNAP_APPROVAL_RESULT = 'wallet_installSnapResult';
86
- const TRUNCATED_SNAP_PROPERTIES = new Set([
87
- 'initialPermissions',
88
- 'id',
89
- 'version',
90
- 'enabled',
91
- 'blocked'
92
- ]);
93
- const defaultState = {
94
- snaps: {},
95
- snapStates: {},
96
- unencryptedSnapStates: {}
97
- };
98
- /**
99
- * Truncates the properties of a snap to only ones that are easily serializable.
100
- *
101
- * @param snap - The snap to truncate.
102
- * @returns Object with serializable snap properties.
103
- */ function truncateSnap(snap) {
104
- const truncatedSnap = Object.keys(snap).reduce((serialized, key)=>{
105
- if (TRUNCATED_SNAP_PROPERTIES.has(key)) {
106
- serialized[key] = snap[key];
107
- }
108
- return serialized;
109
- }, {});
110
- // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
111
- return truncatedSnap;
112
- }
113
- const name = 'SnapController';
114
- var _closeAllConnections = /*#__PURE__*/ new WeakMap(), _dynamicPermissions = /*#__PURE__*/ new WeakMap(), _environmentEndowmentPermissions = /*#__PURE__*/ new WeakMap(), _excludedPermissions = /*#__PURE__*/ new WeakMap(), _featureFlags = /*#__PURE__*/ new WeakMap(), _fetchFunction = /*#__PURE__*/ new WeakMap(), _idleTimeCheckInterval = /*#__PURE__*/ new WeakMap(), _maxIdleTime = /*#__PURE__*/ new WeakMap(), _detectSnapLocation = /*#__PURE__*/ new WeakMap(), _snapsRuntimeData = /*#__PURE__*/ new WeakMap(), _rollbackSnapshots = /*#__PURE__*/ new WeakMap(), _timeoutForLastRequestStatus = /*#__PURE__*/ new WeakMap(), _statusMachine = /*#__PURE__*/ new WeakMap(), /**
115
- * We track status of a Snap using a finite-state-machine.
116
- * It keeps track of whether the snap is started / stopped / etc.
117
- *
118
- * @see {@link SnapController.transition} for interacting with the machine.
119
- */ // We initialize the machine in the instance because the status is currently tightly coupled
120
- // with the SnapController - the guard checks for enabled status inside the SnapController state.
121
- // In the future, side-effects could be added to the machine during transitions.
122
- _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
123
- * Constructor helper for registering the controller's messaging system
124
- * actions.
125
- */ _registerMessageHandlers = /*#__PURE__*/ new WeakSet(), _handlePreinstalledSnaps = /*#__PURE__*/ new WeakSet(), _pollForLastRequestStatus = /*#__PURE__*/ new WeakSet(), _blockSnap = /*#__PURE__*/ new WeakSet(), /**
126
- * Unblocks a snap so that it can be enabled and started again. Emits
127
- * {@link SnapUnblocked}. Does nothing if the snap is not installed or already
128
- * unblocked.
129
- *
130
- * @param snapId - The id of the snap to unblock.
131
- */ _unblockSnap = /*#__PURE__*/ new WeakSet(), _assertIsInstallAllowed = /*#__PURE__*/ new WeakSet(), _stopSnapsLastRequestPastMax = /*#__PURE__*/ new WeakSet(), /**
132
- * Transitions between states using `snapStatusStateMachineConfig` as the template to figure out
133
- * the next state. This transition function uses a very minimal subset of XState conventions:
134
- * - supports initial state
135
- * - .on supports raw event target string
136
- * - .on supports {target, cond} object
137
- * - the arguments for `cond` is the `SerializedSnap` instead of Xstate convention of `(event,
138
- * context) => boolean`
139
- *
140
- * @param snapId - The id of the snap to transition.
141
- * @param event - The event enum to use to transition.
142
- */ _transition = /*#__PURE__*/ new WeakSet(), _terminateSnap = /*#__PURE__*/ new WeakSet(), _handleInitialConnections = /*#__PURE__*/ new WeakSet(), _addSnapToSubject = /*#__PURE__*/ new WeakSet(), /**
143
- * Removes a snap's permission (caveat) from all subjects.
144
- *
145
- * @param snapId - The id of the Snap.
146
- */ _removeSnapFromSubjects = /*#__PURE__*/ new WeakSet(), /**
147
- * Safely revokes all permissions granted to a Snap.
148
- *
149
- * @param snapId - The snap ID.
150
- */ _revokeAllSnapPermissions = /*#__PURE__*/ new WeakSet(), _createApproval = /*#__PURE__*/ new WeakSet(), _updateApproval = /*#__PURE__*/ new WeakSet(), _resolveAllowlistVersion = /*#__PURE__*/ new WeakSet(), _add = /*#__PURE__*/ new WeakSet(), _startSnap = /*#__PURE__*/ new WeakSet(), _getEndowments = /*#__PURE__*/ new WeakSet(), /**
151
- * Sets a snap in state. Called when a snap is installed or updated. Performs
152
- * various validation checks on the received arguments, and will throw if
153
- * validation fails.
154
- *
155
- * The snap will be enabled and unblocked by the time this method returns,
156
- * regardless of its previous state.
157
- *
158
- * See {@link SnapController.add} and {@link SnapController.updateSnap} for
159
- * usage.
160
- *
161
- * @param args - The add snap args.
162
- * @returns The resulting snap object.
163
- */ _set = /*#__PURE__*/ new WeakSet(), _validateSnapPermissions = /*#__PURE__*/ new WeakSet(), /**
164
- * Determine the execution timeout for a given handler permission.
165
- *
166
- * If no permission is specified or the permission itself has no execution timeout defined
167
- * the constructor argument `maxRequestTime` will be used.
168
- *
169
- * @param permission - An optional permission constraint for the handler being called.
170
- * @returns The execution timeout for the given handler.
171
- */ _getExecutionTimeout = /*#__PURE__*/ new WeakSet(), /**
172
- * Gets the RPC message handler for the given snap.
173
- *
174
- * @param snapId - The id of the Snap whose message handler to get.
175
- * @returns The RPC handler for the given snap.
176
- */ _getRpcRequestHandler = /*#__PURE__*/ new WeakSet(), _createInterface = /*#__PURE__*/ new WeakSet(), _assertInterfaceExists = /*#__PURE__*/ new WeakSet(), _transformSnapRpcRequestResult = /*#__PURE__*/ new WeakSet(), _assertSnapRpcRequestResult = /*#__PURE__*/ new WeakSet(), _executeWithTimeout = /*#__PURE__*/ new WeakSet(), _recordSnapRpcRequestStart = /*#__PURE__*/ new WeakSet(), _recordSnapRpcRequestFinish = /*#__PURE__*/ new WeakSet(), /**
177
- * Retrieves the rollback snapshot of a snap.
178
- *
179
- * @param snapId - The snap id.
180
- * @returns A `RollbackSnapshot` or `undefined` if one doesn't exist.
181
- */ _getRollbackSnapshot = /*#__PURE__*/ new WeakSet(), /**
182
- * Creates a `RollbackSnapshot` that is used to help ensure
183
- * atomicity in multiple snap updates.
184
- *
185
- * @param snapId - The snap id.
186
- * @throws {@link Error}. If the snap exists before creation or if creation fails.
187
- * @returns A `RollbackSnapshot`.
188
- */ _createRollbackSnapshot = /*#__PURE__*/ new WeakSet(), _rollbackSnap = /*#__PURE__*/ new WeakSet(), _rollbackSnaps = /*#__PURE__*/ new WeakSet(), _getRuntime = /*#__PURE__*/ new WeakSet(), _getRuntimeExpect = /*#__PURE__*/ new WeakSet(), _setupRuntime = /*#__PURE__*/ new WeakSet(), _calculatePermissionsChange = /*#__PURE__*/ new WeakSet(), /**
189
- * Updates the permissions for a snap following an install, update or rollback.
190
- *
191
- * Grants newly requested permissions and revokes unused/revoked permissions.
192
- *
193
- * @param args - An options bag.
194
- * @param args.snapId - The snap ID.
195
- * @param args.newPermissions - New permissions to be granted.
196
- * @param args.unusedPermissions - Unused permissions to be revoked.
197
- * @param args.requestData - Optional request data from an approval.
198
- */ _updatePermissions = /*#__PURE__*/ new WeakSet(), /**
199
- * Checks if a snap will pass version validation checks
200
- * with the new version range that is requested. The first
201
- * check that is done is to check if the existing snap version
202
- * falls inside the requested range. If it does, we want to return
203
- * false because we do not care to create a rollback snapshot in
204
- * that scenario. The second check is to ensure that the current
205
- * snap version is not greater than all possible versions in
206
- * the requested version range. If it is, then we also want
207
- * to return false in that scenario.
208
- *
209
- * @param snapId - The snap id.
210
- * @param newVersionRange - The new version range being requsted.
211
- * @returns `true` if validation checks pass and `false` if they do not.
212
- */ _isValidUpdate = /*#__PURE__*/ new WeakSet(), _callLifecycleHook = /*#__PURE__*/ new WeakSet();
213
- /*
214
- * A snap is initialized in three phases:
215
- * - Add: Loads the snap from a remote source and parses it.
216
- * - Authorize: Requests the snap's required permissions from the user.
217
- * - Start: Initializes the snap in its SES realm with the authorized permissions.
218
- */ export class SnapController extends BaseController {
219
- /**
220
- * Checks all installed snaps against the block list and
221
- * blocks/unblocks snaps as appropriate. See {@link SnapController.blockSnap}
222
- * for more information.
223
- */ async updateBlockedSnaps() {
224
- await this.messagingSystem.call('SnapsRegistry:update');
225
- const blockedSnaps = await this.messagingSystem.call('SnapsRegistry:get', Object.values(this.state.snaps).reduce((blockListArg, snap)=>{
226
- blockListArg[snap.id] = {
227
- version: snap.version,
228
- checksum: snap.manifest.source.shasum
229
- };
230
- return blockListArg;
231
- }, {}));
232
- await Promise.all(Object.entries(blockedSnaps).map(async ([snapId, { status, reason }])=>{
233
- if (status === SnapsRegistryStatus.Blocked) {
234
- return _class_private_method_get(this, _blockSnap, blockSnap).call(this, snapId, reason);
235
- }
236
- return _class_private_method_get(this, _unblockSnap, unblockSnap).call(this, snapId);
237
- }));
238
- }
239
- _onUnhandledSnapError(snapId, _error) {
240
- this.stopSnap(snapId, SnapStatusEvents.Crash).catch((stopSnapError)=>{
241
- // TODO: Decide how to handle errors.
242
- logError(stopSnapError);
243
- });
244
- }
245
- _onOutboundRequest(snapId) {
246
- const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
247
- // Ideally we would only pause the pending request that is making the outbound request
248
- // but right now we don't have a way to know which request initiated the outbound request
249
- runtime.pendingInboundRequests.filter((pendingRequest)=>pendingRequest.timer.status === 'running').forEach((pendingRequest)=>pendingRequest.timer.pause());
250
- runtime.pendingOutboundRequests += 1;
251
- }
252
- _onOutboundResponse(snapId) {
253
- const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
254
- runtime.pendingOutboundRequests -= 1;
255
- if (runtime.pendingOutboundRequests === 0) {
256
- runtime.pendingInboundRequests.filter((pendingRequest)=>pendingRequest.timer.status === 'paused').forEach((pendingRequest)=>pendingRequest.timer.resume());
257
- }
258
- }
259
- /**
260
- * Starts the given snap. Throws an error if no such snap exists
261
- * or if it is already running.
262
- *
263
- * @param snapId - The id of the Snap to start.
264
- */ async startSnap(snapId) {
265
- const snap = this.state.snaps[snapId];
266
- if (snap.enabled === false) {
267
- throw new Error(`Snap "${snapId}" is disabled.`);
268
- }
269
- await _class_private_method_get(this, _startSnap, startSnap).call(this, {
270
- snapId,
271
- sourceCode: snap.sourceCode
272
- });
273
- }
274
- /**
275
- * Enables the given snap. A snap can only be started if it is enabled. A snap
276
- * can only be enabled if it isn't blocked.
277
- *
278
- * @param snapId - The id of the Snap to enable.
279
- */ enableSnap(snapId) {
280
- this.getExpect(snapId);
281
- if (this.state.snaps[snapId].blocked) {
282
- throw new Error(`Snap "${snapId}" is blocked and cannot be enabled.`);
283
- }
284
- this.update((state)=>{
285
- state.snaps[snapId].enabled = true;
286
- });
287
- this.messagingSystem.publish('SnapController:snapEnabled', this.getTruncatedExpect(snapId));
288
- }
289
- /**
290
- * Disables the given snap. A snap can only be started if it is enabled.
291
- *
292
- * @param snapId - The id of the Snap to disable.
293
- * @returns A promise that resolves once the snap has been disabled.
294
- */ async disableSnap(snapId) {
295
- if (!this.has(snapId)) {
296
- throw new Error(`Snap "${snapId}" not found.`);
297
- }
298
- this.update((state)=>{
299
- state.snaps[snapId].enabled = false;
300
- });
301
- if (this.isRunning(snapId)) {
302
- await this.stopSnap(snapId, SnapStatusEvents.Stop);
303
- }
304
- this.messagingSystem.publish('SnapController:snapDisabled', this.getTruncatedExpect(snapId));
305
- }
306
- /**
307
- * Stops the given snap, removes all hooks, closes all connections, and
308
- * terminates its worker.
309
- *
310
- * @param snapId - The id of the Snap to stop.
311
- * @param statusEvent - The Snap status event that caused the snap to be
312
- * stopped.
313
- */ async stopSnap(snapId, statusEvent = SnapStatusEvents.Stop) {
314
- const runtime = _class_private_method_get(this, _getRuntime, getRuntime).call(this, snapId);
315
- if (!runtime) {
316
- throw new Error(`The snap "${snapId}" is not running.`);
317
- }
318
- // Reset request tracking
319
- runtime.lastRequest = null;
320
- runtime.pendingInboundRequests = [];
321
- runtime.pendingOutboundRequests = 0;
322
- try {
323
- if (this.isRunning(snapId)) {
324
- _class_private_field_get(this, _closeAllConnections)?.call(this, snapId);
325
- await _class_private_method_get(this, _terminateSnap, terminateSnap).call(this, snapId);
326
- }
327
- } finally{
328
- if (this.isRunning(snapId)) {
329
- _class_private_method_get(this, _transition, transition).call(this, snapId, statusEvent);
330
- }
331
- }
332
- }
333
- /**
334
- * Returns whether the given snap is running.
335
- * Throws an error if the snap doesn't exist.
336
- *
337
- * @param snapId - The id of the Snap to check.
338
- * @returns `true` if the snap is running, otherwise `false`.
339
- */ isRunning(snapId) {
340
- return this.getExpect(snapId).status === 'running';
341
- }
342
- /**
343
- * Returns whether the given snap has been added to state.
344
- *
345
- * @param snapId - The id of the Snap to check for.
346
- * @returns `true` if the snap exists in the controller state, otherwise `false`.
347
- */ has(snapId) {
348
- return Boolean(this.get(snapId));
349
- }
350
- /**
351
- * Gets the snap with the given id if it exists, including all data.
352
- * This should not be used if the snap is to be serializable, as e.g.
353
- * the snap sourceCode may be quite large.
354
- *
355
- * @param snapId - The id of the Snap to get.
356
- * @returns The entire snap object from the controller state.
357
- */ get(snapId) {
358
- return this.state.snaps[snapId];
359
- }
360
- /**
361
- * Gets the snap with the given id, throws if doesn't.
362
- * This should not be used if the snap is to be serializable, as e.g.
363
- * the snap sourceCode may be quite large.
364
- *
365
- * @see {@link SnapController.get}
366
- * @throws {@link Error}. If the snap doesn't exist
367
- * @param snapId - The id of the snap to get.
368
- * @returns The entire snap object.
369
- */ getExpect(snapId) {
370
- const snap = this.get(snapId);
371
- assert(snap !== undefined, new Error(`Snap "${snapId}" not found.`));
372
- return snap;
373
- }
374
- /**
375
- * Gets the snap with the given id if it exists, excluding any
376
- * non-serializable or expensive-to-serialize data.
377
- *
378
- * @param snapId - The id of the Snap to get.
379
- * @returns A truncated version of the snap state, that is less expensive to serialize.
380
- */ // TODO(ritave): this.get returns undefined, this.getTruncated returns null
381
- getTruncated(snapId) {
382
- const snap = this.get(snapId);
383
- return snap ? truncateSnap(snap) : null;
384
- }
385
- /**
386
- * Gets the snap with the given id, throw if it doesn't exist.
387
- *
388
- * @throws {@link Error}. If snap doesn't exist
389
- * @param snapId - The id of the snap to get.
390
- * @returns A truncated version of the snap state, that is less expensive to serialize.
391
- */ getTruncatedExpect(snapId) {
392
- return truncateSnap(this.getExpect(snapId));
393
- }
394
- /**
395
- * Updates the own state of the snap with the given id.
396
- * This is distinct from the state MetaMask uses to manage snaps.
397
- *
398
- * @param snapId - The id of the Snap whose state should be updated.
399
- * @param newSnapState - The new state of the snap.
400
- * @param encrypted - A flag to indicate whether to use encrypted storage or not.
401
- */ updateSnapState(snapId, newSnapState, encrypted) {
402
- this.update((state)=>{
403
- if (encrypted) {
404
- state.snapStates[snapId] = newSnapState;
405
- } else {
406
- state.unencryptedSnapStates[snapId] = newSnapState;
407
- }
408
- });
409
- }
410
- /**
411
- * Clears the state of the snap with the given id.
412
- * This is distinct from the state MetaMask uses to manage snaps.
413
- *
414
- * @param snapId - The id of the Snap whose state should be cleared.
415
- * @param encrypted - A flag to indicate whether to use encrypted storage or not.
416
- */ clearSnapState(snapId, encrypted) {
417
- this.update((state)=>{
418
- if (encrypted) {
419
- state.snapStates[snapId] = null;
420
- } else {
421
- state.unencryptedSnapStates[snapId] = null;
422
- }
423
- });
424
- }
425
- /**
426
- * Gets the own state of the snap with the given id.
427
- * This is distinct from the state MetaMask uses to manage snaps.
428
- *
429
- * @param snapId - The id of the Snap whose state to get.
430
- * @param encrypted - A flag to indicate whether to use encrypted storage or not.
431
- * @returns The requested snap state or null if no state exists.
432
- */ getSnapState(snapId, encrypted) {
433
- const state = encrypted ? this.state.snapStates[snapId] : this.state.unencryptedSnapStates[snapId];
434
- return state ?? null;
435
- }
436
- /**
437
- * Gets a static auxiliary snap file in a chosen file encoding.
438
- *
439
- * @param snapId - The id of the Snap whose state to get.
440
- * @param path - The path to the requested file.
441
- * @param encoding - An optional requested file encoding.
442
- * @returns The file requested in the chosen file encoding or null if the file is not found.
443
- */ async getSnapFile(snapId, path, encoding = AuxiliaryFileEncoding.Base64) {
444
- const snap = this.getExpect(snapId);
445
- const normalizedPath = normalizeRelative(path);
446
- const value = snap.auxiliaryFiles?.find((file)=>file.path === normalizedPath)?.value;
447
- if (!value) {
448
- return null;
449
- }
450
- return encodeAuxiliaryFile(value, encoding);
451
- }
452
- /**
453
- * Completely clear the controller's state: delete all associated data,
454
- * handlers, event listeners, and permissions; tear down all snap providers.
455
- */ async clearState() {
456
- const snapIds = Object.keys(this.state.snaps);
457
- if (_class_private_field_get(this, _closeAllConnections)) {
458
- snapIds.forEach((snapId)=>{
459
- _class_private_field_get(this, _closeAllConnections)?.call(this, snapId);
460
- });
461
- }
462
- await this.messagingSystem.call('ExecutionService:terminateAllSnaps');
463
- snapIds.forEach((snapId)=>_class_private_method_get(this, _revokeAllSnapPermissions, revokeAllSnapPermissions).call(this, snapId));
464
- this.update((state)=>{
465
- state.snaps = {};
466
- state.snapStates = {};
467
- });
468
- }
469
- /**
470
- * Removes the given snap from state, and clears all associated handlers
471
- * and listeners.
472
- *
473
- * @param snapId - The id of the Snap.
474
- * @returns A promise that resolves once the snap has been removed.
475
- */ async removeSnap(snapId) {
476
- return this.removeSnaps([
477
- snapId
478
- ]);
479
- }
480
- /**
481
- * Stops the given snaps, removes them from state, and clears all associated
482
- * permissions, handlers, and listeners.
483
- *
484
- * @param snapIds - The ids of the Snaps.
485
- */ async removeSnaps(snapIds) {
486
- if (!Array.isArray(snapIds)) {
487
- throw new Error('Expected array of snap ids.');
488
- }
489
- snapIds.forEach((snapId)=>{
490
- const snap = this.getExpect(snapId);
491
- assert(snap.removable !== false, `${snapId} is not removable.`);
492
- });
493
- await Promise.all(snapIds.map(async (snapId)=>{
494
- const snap = this.getExpect(snapId);
495
- const truncated = this.getTruncatedExpect(snapId);
496
- // Disable the snap and revoke all of its permissions before deleting
497
- // it. This ensures that the snap will not be restarted or otherwise
498
- // affect the host environment while we are deleting it.
499
- await this.disableSnap(snapId);
500
- _class_private_method_get(this, _revokeAllSnapPermissions, revokeAllSnapPermissions).call(this, snapId);
501
- _class_private_method_get(this, _removeSnapFromSubjects, removeSnapFromSubjects).call(this, snapId);
502
- _class_private_field_get(this, _snapsRuntimeData).delete(snapId);
503
- this.update((state)=>{
504
- delete state.snaps[snapId];
505
- delete state.snapStates[snapId];
506
- });
507
- // If the snap has been fully installed before, also emit snapUninstalled.
508
- if (snap.status !== SnapStatus.Installing) {
509
- this.messagingSystem.publish(`SnapController:snapUninstalled`, truncated);
510
- }
511
- }));
512
- }
513
- /**
514
- * Removes a snap's permission (caveat) from the specified subject.
515
- *
516
- * @param origin - The origin from which to remove the snap.
517
- * @param snapId - The id of the snap to remove.
518
- */ removeSnapFromSubject(origin, snapId) {
519
- const subjectPermissions = this.messagingSystem.call('PermissionController:getPermissions', origin);
520
- const snapIdsCaveat = subjectPermissions?.[WALLET_SNAP_PERMISSION_KEY]?.caveats?.find((caveat)=>caveat.type === SnapCaveatType.SnapIds);
521
- if (!snapIdsCaveat) {
522
- return;
523
- }
524
- const caveatHasSnap = Boolean(snapIdsCaveat.value?.[snapId]);
525
- if (caveatHasSnap) {
526
- const newCaveatValue = {
527
- ...snapIdsCaveat.value
528
- };
529
- delete newCaveatValue[snapId];
530
- if (Object.keys(newCaveatValue).length > 0) {
531
- this.messagingSystem.call('PermissionController:updateCaveat', origin, WALLET_SNAP_PERMISSION_KEY, SnapCaveatType.SnapIds, newCaveatValue);
532
- } else {
533
- this.messagingSystem.call('PermissionController:revokePermissions', {
534
- [origin]: [
535
- WALLET_SNAP_PERMISSION_KEY
536
- ]
537
- });
538
- }
539
- }
540
- }
541
- /**
542
- * Checks if a list of permissions are dynamic and allowed to be revoked, if they are they will all be revoked.
543
- *
544
- * @param snapId - The snap ID.
545
- * @param permissionNames - The names of the permissions.
546
- * @throws If non-dynamic permissions are passed.
547
- */ revokeDynamicSnapPermissions(snapId, permissionNames) {
548
- assert(permissionNames.every((permissionName)=>_class_private_field_get(this, _dynamicPermissions).includes(permissionName)), 'Non-dynamic permissions cannot be revoked');
549
- this.messagingSystem.call('PermissionController:revokePermissions', {
550
- [snapId]: permissionNames
551
- });
552
- }
553
- /**
554
- * Handles incrementing the activeReferences counter.
555
- *
556
- * @param snapId - The snap id of the snap that was referenced.
557
- */ incrementActiveReferences(snapId) {
558
- const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
559
- runtime.activeReferences += 1;
560
- }
561
- /**
562
- * Handles decrement the activeReferences counter.
563
- *
564
- * @param snapId - The snap id of the snap that was referenced..
565
- */ decrementActiveReferences(snapId) {
566
- const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
567
- assert(runtime.activeReferences > 0, 'SnapController reference management is in an invalid state.');
568
- runtime.activeReferences -= 1;
569
- }
570
- /**
571
- * Gets all snaps in their truncated format.
572
- *
573
- * @returns All installed snaps in their truncated format.
574
- */ getAllSnaps() {
575
- return Object.values(this.state.snaps).map(truncateSnap);
576
- }
577
- /**
578
- * Gets the serialized permitted snaps of the given origin, if any.
579
- *
580
- * @param origin - The origin whose permitted snaps to retrieve.
581
- * @returns The serialized permitted snaps for the origin.
582
- */ getPermittedSnaps(origin) {
583
- const permissions = this.messagingSystem.call('PermissionController:getPermissions', origin) ?? {};
584
- const snaps = permissions[WALLET_SNAP_PERMISSION_KEY]?.caveats?.find((caveat)=>caveat.type === SnapCaveatType.SnapIds)?.value ?? {};
585
- return Object.keys(snaps).reduce((permittedSnaps, snapId)=>{
586
- const snap = this.get(snapId);
587
- const truncatedSnap = this.getTruncated(snapId);
588
- if (truncatedSnap && snap?.status !== SnapStatus.Installing) {
589
- permittedSnaps[snapId] = truncatedSnap;
590
- }
591
- return permittedSnaps;
592
- }, {});
593
- }
594
- /**
595
- * Installs the snaps requested by the given origin, returning the snap
596
- * object if the origin is permitted to install it, and an authorization error
597
- * otherwise.
598
- *
599
- * @param origin - The origin that requested to install the snaps.
600
- * @param requestedSnaps - The snaps to install.
601
- * @returns An object of snap ids and snap objects, or errors if a
602
- * snap couldn't be installed.
603
- */ async installSnaps(origin, requestedSnaps) {
604
- const result = {};
605
- const snapIds = Object.keys(requestedSnaps);
606
- const pendingUpdates = [];
607
- const pendingInstalls = [];
608
- try {
609
- for (const [snapId, { version: rawVersion }] of Object.entries(requestedSnaps)){
610
- assertIsValidSnapId(snapId);
611
- const [error, version] = resolveVersionRange(rawVersion);
612
- if (error) {
613
- throw rpcErrors.invalidParams(`The "version" field must be a valid SemVer version range if specified. Received: "${rawVersion}".`);
614
- }
615
- const location = _class_private_field_get(this, _detectSnapLocation).call(this, snapId, {
616
- versionRange: version,
617
- fetch: _class_private_field_get(this, _fetchFunction),
618
- allowLocal: _class_private_field_get(this, _featureFlags).allowLocalSnaps,
619
- resolveVersion: async (range)=>_class_private_field_get(this, _featureFlags).requireAllowlist ? await _class_private_method_get(this, _resolveAllowlistVersion, resolveAllowlistVersion).call(this, snapId, range) : range
620
- });
621
- // Existing snaps may need to be updated, unless they should be re-installed (e.g. local snaps)
622
- // Everything else is treated as an install
623
- const isUpdate = this.has(snapId) && !location.shouldAlwaysReload;
624
- if (isUpdate && _class_private_method_get(this, _isValidUpdate, isValidUpdate).call(this, snapId, version)) {
625
- const existingSnap = this.getExpect(snapId);
626
- pendingUpdates.push({
627
- snapId,
628
- oldVersion: existingSnap.version
629
- });
630
- let rollbackSnapshot = _class_private_method_get(this, _getRollbackSnapshot, getRollbackSnapshot).call(this, snapId);
631
- if (rollbackSnapshot === undefined) {
632
- rollbackSnapshot = _class_private_method_get(this, _createRollbackSnapshot, createRollbackSnapshot).call(this, snapId);
633
- rollbackSnapshot.newVersion = version;
634
- } else {
635
- throw new Error('This snap is already being updated.');
636
- }
637
- } else if (!isUpdate) {
638
- pendingInstalls.push(snapId);
639
- }
640
- result[snapId] = await this.processRequestedSnap(origin, snapId, location, version);
641
- }
642
- // Once we finish all installs / updates, emit events.
643
- pendingInstalls.forEach((snapId)=>this.messagingSystem.publish(`SnapController:snapInstalled`, this.getTruncatedExpect(snapId), origin));
644
- pendingUpdates.forEach(({ snapId, oldVersion })=>this.messagingSystem.publish(`SnapController:snapUpdated`, this.getTruncatedExpect(snapId), oldVersion, origin));
645
- snapIds.forEach((snapId)=>_class_private_field_get(this, _rollbackSnapshots).delete(snapId));
646
- } catch (error) {
647
- const installed = pendingInstalls.filter((snapId)=>this.has(snapId));
648
- await this.removeSnaps(installed);
649
- const snapshottedSnaps = [
650
- ..._class_private_field_get(this, _rollbackSnapshots).keys()
651
- ];
652
- const snapsToRollback = pendingUpdates.map(({ snapId })=>snapId).filter((snapId)=>snapshottedSnaps.includes(snapId));
653
- await _class_private_method_get(this, _rollbackSnaps, rollbackSnaps).call(this, snapsToRollback);
654
- throw error;
655
- }
656
- return result;
657
- }
658
- /**
659
- * Adds, authorizes, and runs the given snap with a snap provider.
660
- * Results from this method should be efficiently serializable.
661
- *
662
- * @param origin - The origin requesting the snap.
663
- * @param snapId - The id of the snap.
664
- * @param location - The location implementation of the snap.
665
- * @param versionRange - The semver range of the snap to install.
666
- * @returns The resulting snap object, or an error if something went wrong.
667
- */ async processRequestedSnap(origin, snapId, location, versionRange) {
668
- const existingSnap = this.getTruncated(snapId);
669
- // For devX we always re-install local snaps.
670
- if (existingSnap && !location.shouldAlwaysReload) {
671
- if (satisfiesVersionRange(existingSnap.version, versionRange)) {
672
- return existingSnap;
673
- }
674
- return await this.updateSnap(origin, snapId, location, versionRange, // Since we are requesting an update from within processRequestedSnap,
675
- // we disable the emitting of the snapUpdated event and rely on the caller
676
- // to publish this event after the update is complete.
677
- // This is necessary as installSnaps may be installing multiple snaps
678
- // and we don't want to emit events prematurely.
679
- false);
680
- }
681
- let pendingApproval = _class_private_method_get(this, _createApproval, createApproval).call(this, {
682
- origin,
683
- snapId,
684
- type: SNAP_APPROVAL_INSTALL
685
- });
686
- this.messagingSystem.publish('SnapController:snapInstallStarted', snapId, origin, false);
687
- // Existing snaps must be stopped before overwriting
688
- if (existingSnap && this.isRunning(snapId)) {
689
- await this.stopSnap(snapId, SnapStatusEvents.Stop);
690
- }
691
- // Existing snaps that should be re-installed should not maintain their existing permissions
692
- if (existingSnap && location.shouldAlwaysReload) {
693
- _class_private_method_get(this, _revokeAllSnapPermissions, revokeAllSnapPermissions).call(this, snapId);
694
- }
695
- try {
696
- const { sourceCode } = await _class_private_method_get(this, _add, add).call(this, {
697
- origin,
698
- id: snapId,
699
- location,
700
- versionRange
701
- });
702
- await this.authorize(snapId, pendingApproval);
703
- pendingApproval = _class_private_method_get(this, _createApproval, createApproval).call(this, {
704
- origin,
705
- snapId,
706
- type: SNAP_APPROVAL_RESULT
707
- });
708
- await _class_private_method_get(this, _startSnap, startSnap).call(this, {
709
- snapId,
710
- sourceCode
711
- });
712
- const truncated = this.getTruncatedExpect(snapId);
713
- _class_private_method_get(this, _updateApproval, updateApproval).call(this, pendingApproval.id, {
714
- loading: false,
715
- type: SNAP_APPROVAL_INSTALL
716
- });
717
- return truncated;
718
- } catch (error) {
719
- logError(`Error when adding ${snapId}.`, error);
720
- const errorString = error instanceof Error ? error.message : error.toString();
721
- _class_private_method_get(this, _updateApproval, updateApproval).call(this, pendingApproval.id, {
722
- loading: false,
723
- type: SNAP_APPROVAL_INSTALL,
724
- error: errorString
725
- });
726
- this.messagingSystem.publish('SnapController:snapInstallFailed', snapId, origin, false, errorString);
727
- throw error;
728
- }
729
- }
730
- /**
731
- * Updates an installed snap. The flow is similar to
732
- * {@link SnapController.installSnaps}. The user will be asked if they want
733
- * to update, then approve any permission changes, and finally the snap will
734
- * be restarted.
735
- *
736
- * The update will fail if the user rejects any prompt or if the new version
737
- * of the snap is blocked.
738
- *
739
- * If the original version of the snap was blocked and the update succeeded,
740
- * the snap will be unblocked and enabled before it is restarted.
741
- *
742
- * @param origin - The origin requesting the snap update.
743
- * @param snapId - The id of the Snap to be updated.
744
- * @param location - The location implementation of the snap.
745
- * @param newVersionRange - A semver version range in which the maximum version will be chosen.
746
- * @param emitEvent - An optional boolean flag to indicate whether this update should emit an event.
747
- * @returns The snap metadata if updated, `null` otherwise.
748
- */ async updateSnap(origin, snapId, location, newVersionRange = DEFAULT_REQUESTED_SNAP_VERSION, emitEvent = true) {
749
- if (!isValidSemVerRange(newVersionRange)) {
750
- throw new Error(`Received invalid snap version range: "${newVersionRange}".`);
751
- }
752
- let pendingApproval = _class_private_method_get(this, _createApproval, createApproval).call(this, {
753
- origin,
754
- snapId,
755
- type: SNAP_APPROVAL_UPDATE
756
- });
757
- try {
758
- this.messagingSystem.publish('SnapController:snapInstallStarted', snapId, origin, true);
759
- const snap = this.getExpect(snapId);
760
- const oldManifest = snap.manifest;
761
- const newSnap = await fetchSnap(snapId, location);
762
- const { sourceCode: sourceCodeFile, manifest: manifestFile } = newSnap;
763
- const manifest = manifestFile.result;
764
- const newVersion = manifest.version;
765
- if (!gtVersion(newVersion, snap.version)) {
766
- throw rpcErrors.invalidParams(`Snap "${snapId}@${snap.version}" is already installed. Couldn't update to a version inside requested "${newVersionRange}" range.`);
767
- }
768
- if (!satisfiesVersionRange(newVersion, newVersionRange)) {
769
- throw new Error(`Version mismatch. Manifest for "${snapId}" specifies version "${newVersion}" which doesn't satisfy requested version range "${newVersionRange}".`);
770
- }
771
- await _class_private_method_get(this, _assertIsInstallAllowed, assertIsInstallAllowed).call(this, snapId, {
772
- version: newVersion,
773
- checksum: manifest.source.shasum,
774
- permissions: manifest.initialPermissions
775
- });
776
- const processedPermissions = processSnapPermissions(manifest.initialPermissions);
777
- _class_private_method_get(this, _validateSnapPermissions, validateSnapPermissions).call(this, processedPermissions);
778
- const { newPermissions, unusedPermissions, approvedPermissions } = _class_private_method_get(this, _calculatePermissionsChange, calculatePermissionsChange).call(this, snapId, processedPermissions);
779
- _class_private_method_get(this, _updateApproval, updateApproval).call(this, pendingApproval.id, {
780
- permissions: newPermissions,
781
- newVersion: manifest.version,
782
- newPermissions,
783
- approvedPermissions,
784
- unusedPermissions,
785
- loading: false
786
- });
787
- const { permissions: approvedNewPermissions, ...requestData } = await pendingApproval.promise;
788
- pendingApproval = _class_private_method_get(this, _createApproval, createApproval).call(this, {
789
- origin,
790
- snapId,
791
- type: SNAP_APPROVAL_RESULT
792
- });
793
- if (this.isRunning(snapId)) {
794
- await this.stopSnap(snapId, SnapStatusEvents.Stop);
795
- }
796
- _class_private_method_get(this, _transition, transition).call(this, snapId, SnapStatusEvents.Update);
797
- _class_private_method_get(this, _set, set).call(this, {
798
- origin,
799
- id: snapId,
800
- files: newSnap,
801
- isUpdate: true
802
- });
803
- _class_private_method_get(this, _updatePermissions, updatePermissions).call(this, {
804
- snapId,
805
- unusedPermissions,
806
- newPermissions: approvedNewPermissions,
807
- requestData
808
- });
809
- if (manifest.initialConnections) {
810
- _class_private_method_get(this, _handleInitialConnections, handleInitialConnections).call(this, snapId, oldManifest.initialConnections ?? null, manifest.initialConnections);
811
- }
812
- const rollbackSnapshot = _class_private_method_get(this, _getRollbackSnapshot, getRollbackSnapshot).call(this, snapId);
813
- if (rollbackSnapshot !== undefined) {
814
- rollbackSnapshot.permissions.revoked = unusedPermissions;
815
- rollbackSnapshot.permissions.granted = approvedNewPermissions;
816
- rollbackSnapshot.permissions.requestData = requestData;
817
- }
818
- const sourceCode = sourceCodeFile.toString();
819
- assert(typeof sourceCode === 'string' && sourceCode.length > 0, `Invalid source code for snap "${snapId}".`);
820
- try {
821
- await _class_private_method_get(this, _startSnap, startSnap).call(this, {
822
- snapId,
823
- sourceCode
824
- });
825
- } catch {
826
- throw new Error(`Snap ${snapId} crashed with updated source code.`);
827
- }
828
- const truncatedSnap = this.getTruncatedExpect(snapId);
829
- if (emitEvent) {
830
- this.messagingSystem.publish('SnapController:snapUpdated', truncatedSnap, snap.version, origin);
831
- }
832
- _class_private_method_get(this, _updateApproval, updateApproval).call(this, pendingApproval.id, {
833
- loading: false,
834
- type: SNAP_APPROVAL_UPDATE
835
- });
836
- return truncatedSnap;
837
- } catch (error) {
838
- logError(`Error when updating ${snapId},`, error);
839
- const errorString = error instanceof Error ? error.message : error.toString();
840
- _class_private_method_get(this, _updateApproval, updateApproval).call(this, pendingApproval.id, {
841
- loading: false,
842
- error: errorString,
843
- type: SNAP_APPROVAL_UPDATE
844
- });
845
- this.messagingSystem.publish('SnapController:snapInstallFailed', snapId, origin, true, errorString);
846
- throw error;
847
- }
848
- }
849
- /**
850
- * Get metadata for the given snap ID.
851
- *
852
- * @param snapId - The ID of the snap to get metadata for.
853
- * @returns The metadata for the given snap ID, or `null` if the snap is not
854
- * verified.
855
- */ async getRegistryMetadata(snapId) {
856
- return await this.messagingSystem.call('SnapsRegistry:getMetadata', snapId);
857
- }
858
- /**
859
- * Initiates a request for the given snap's initial permissions.
860
- * Must be called in order. See processRequestedSnap.
861
- *
862
- * This function is not hash private yet because of tests.
863
- *
864
- * @param snapId - The id of the Snap.
865
- * @param pendingApproval - Pending approval to update.
866
- * @returns The snap's approvedPermissions.
867
- */ async authorize(snapId, pendingApproval) {
868
- log(`Authorizing snap: ${snapId}`);
869
- const snapsState = this.state.snaps;
870
- const snap = snapsState[snapId];
871
- const { initialPermissions } = snap;
872
- try {
873
- const processedPermissions = processSnapPermissions(initialPermissions);
874
- _class_private_method_get(this, _validateSnapPermissions, validateSnapPermissions).call(this, processedPermissions);
875
- _class_private_method_get(this, _updateApproval, updateApproval).call(this, pendingApproval.id, {
876
- loading: false,
877
- permissions: processedPermissions
878
- });
879
- const { permissions: approvedPermissions, ...requestData } = await pendingApproval.promise;
880
- _class_private_method_get(this, _updatePermissions, updatePermissions).call(this, {
881
- snapId,
882
- newPermissions: approvedPermissions,
883
- requestData
884
- });
885
- if (snap.manifest.initialConnections) {
886
- _class_private_method_get(this, _handleInitialConnections, handleInitialConnections).call(this, snapId, null, snap.manifest.initialConnections);
887
- }
888
- } finally{
889
- const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
890
- runtime.installPromise = null;
891
- }
892
- }
893
- destroy() {
894
- super.destroy();
895
- if (_class_private_field_get(this, _timeoutForLastRequestStatus)) {
896
- clearTimeout(_class_private_field_get(this, _timeoutForLastRequestStatus));
897
- }
898
- /* eslint-disable @typescript-eslint/unbound-method */ this.messagingSystem.unsubscribe('ExecutionService:unhandledError', this._onUnhandledSnapError);
899
- this.messagingSystem.unsubscribe('ExecutionService:outboundRequest', this._onOutboundRequest);
900
- this.messagingSystem.unsubscribe('ExecutionService:outboundResponse', this._onOutboundResponse);
901
- this.messagingSystem.clearEventSubscriptions('SnapController:snapInstalled');
902
- this.messagingSystem.clearEventSubscriptions('SnapController:snapUpdated');
903
- /* eslint-enable @typescript-eslint/unbound-method */ }
904
- /**
905
- * Passes a JSON-RPC request object to the RPC handler function of a snap.
906
- *
907
- * @param options - A bag of options.
908
- * @param options.snapId - The ID of the recipient snap.
909
- * @param options.origin - The origin of the RPC request.
910
- * @param options.handler - The handler to trigger on the snap for the request.
911
- * @param options.request - The JSON-RPC request object.
912
- * @returns The result of the JSON-RPC request.
913
- */ async handleRequest({ snapId, origin, handler: handlerType, request: rawRequest }) {
914
- const request = {
915
- jsonrpc: '2.0',
916
- id: nanoid(),
917
- ...rawRequest
918
- };
919
- assertIsJsonRpcRequest(request);
920
- const permissionName = handlerEndowments[handlerType];
921
- assert(typeof permissionName === 'string' || permissionName === null, "'permissionName' must be either a string or null.");
922
- const permissions = this.messagingSystem.call('PermissionController:getPermissions', snapId);
923
- // If permissionName is null, the handler does not require a permission.
924
- if (permissionName !== null && (!permissions || !hasProperty(permissions, permissionName))) {
925
- throw new Error(`Snap "${snapId}" is not permitted to use "${permissionName}".`);
926
- }
927
- const handlerPermissions = permissionName ? permissions[permissionName] : undefined;
928
- if (permissionName === SnapEndowments.Rpc || permissionName === SnapEndowments.Keyring) {
929
- assert(handlerPermissions);
930
- const subject = this.messagingSystem.call('SubjectMetadataController:getSubjectMetadata', origin);
931
- const origins = permissionName === SnapEndowments.Rpc ? getRpcCaveatOrigins(handlerPermissions) : getKeyringCaveatOrigins(handlerPermissions);
932
- assert(origins);
933
- if (!isOriginAllowed(origins, subject?.subjectType ?? SubjectType.Website, origin)) {
934
- throw new Error(`Snap "${snapId}" is not permitted to handle requests from "${origin}".`);
935
- }
936
- }
937
- const handler = _class_private_method_get(this, _getRpcRequestHandler, getRpcRequestHandler).call(this, snapId);
938
- if (!handler) {
939
- throw new Error(`Snap RPC message handler not found for snap "${snapId}".`);
940
- }
941
- const timeout = _class_private_method_get(this, _getExecutionTimeout, getExecutionTimeout).call(this, handlerPermissions);
942
- return handler({
943
- origin,
944
- handler: handlerType,
945
- request,
946
- timeout
947
- });
948
- }
949
- constructor({ closeAllConnections, messenger, state, dynamicPermissions = [
950
- 'eth_accounts'
951
- ], environmentEndowmentPermissions = [], excludedPermissions = {}, idleTimeCheckInterval = inMilliseconds(5, Duration.Second), maxIdleTime = inMilliseconds(30, Duration.Second), maxRequestTime = inMilliseconds(60, Duration.Second), fetchFunction = globalThis.fetch.bind(globalThis), featureFlags = {}, detectSnapLocation: detectSnapLocationFunction = detectSnapLocation, preinstalledSnaps }){
952
- super({
953
- messenger,
954
- metadata: {
955
- snapStates: {
956
- persist: true,
957
- anonymous: false
958
- },
959
- unencryptedSnapStates: {
960
- persist: true,
961
- anonymous: false
962
- },
963
- snaps: {
964
- persist: (snaps)=>{
965
- return Object.values(snaps)// We should not persist snaps that are in the installing state,
966
- // since they haven't completed installation and would be unusable
967
- .filter((snap)=>snap.status !== SnapStatus.Installing).map((snap)=>{
968
- return {
969
- ...snap,
970
- // At the time state is rehydrated, no snap will be running.
971
- status: SnapStatus.Stopped
972
- };
973
- }).reduce((memo, snap)=>{
974
- memo[snap.id] = snap;
975
- return memo;
976
- }, {});
977
- },
978
- anonymous: false
979
- }
980
- },
981
- name,
982
- state: {
983
- ...defaultState,
984
- ...state
985
- }
986
- });
987
- _class_private_method_init(this, _initializeStateMachine);
988
- _class_private_method_init(this, _registerMessageHandlers);
989
- _class_private_method_init(this, _handlePreinstalledSnaps);
990
- _class_private_method_init(this, _pollForLastRequestStatus);
991
- /**
992
- * Blocks an installed snap and prevents it from being started again. Emits
993
- * {@link SnapBlocked}. Does nothing if the snap is not installed.
994
- *
995
- * @param snapId - The snap to block.
996
- * @param blockedSnapInfo - Information detailing why the snap is blocked.
997
- */ _class_private_method_init(this, _blockSnap);
998
- _class_private_method_init(this, _unblockSnap);
999
- _class_private_method_init(this, _assertIsInstallAllowed);
1000
- _class_private_method_init(this, _stopSnapsLastRequestPastMax);
1001
- _class_private_method_init(this, _transition);
1002
- /**
1003
- * Terminates the specified snap and emits the `snapTerminated` event.
1004
- *
1005
- * @param snapId - The snap to terminate.
1006
- */ _class_private_method_init(this, _terminateSnap);
1007
- _class_private_method_init(this, _handleInitialConnections);
1008
- _class_private_method_init(this, _addSnapToSubject);
1009
- _class_private_method_init(this, _removeSnapFromSubjects);
1010
- _class_private_method_init(this, _revokeAllSnapPermissions);
1011
- _class_private_method_init(this, _createApproval);
1012
- _class_private_method_init(this, _updateApproval);
1013
- _class_private_method_init(this, _resolveAllowlistVersion);
1014
- /**
1015
- * Returns a promise representing the complete installation of the requested snap.
1016
- * If the snap is already being installed, the previously pending promise will be returned.
1017
- *
1018
- * @param args - Object containing the snap id and either the URL of the snap's manifest,
1019
- * or the snap's manifest and source code. The object may also optionally contain a target
1020
- * version.
1021
- * @returns The resulting snap object.
1022
- */ _class_private_method_init(this, _add);
1023
- _class_private_method_init(this, _startSnap);
1024
- /**
1025
- * Gets the names of all endowments that will be added to the Snap's
1026
- * Compartment when it executes. These should be the names of global
1027
- * JavaScript APIs accessible in the root realm of the execution environment.
1028
- *
1029
- * Throws an error if the endowment getter for a permission returns a truthy
1030
- * value that is not an array of strings.
1031
- *
1032
- * @param snapId - The id of the snap whose SES endowments to get.
1033
- * @returns An array of the names of the endowments.
1034
- */ _class_private_method_init(this, _getEndowments);
1035
- _class_private_method_init(this, _set);
1036
- _class_private_method_init(this, _validateSnapPermissions);
1037
- _class_private_method_init(this, _getExecutionTimeout);
1038
- _class_private_method_init(this, _getRpcRequestHandler);
1039
- /**
1040
- * Create a dynamic interface in the SnapInterfaceController.
1041
- *
1042
- * @param snapId - The snap ID.
1043
- * @param content - The initial interface content.
1044
- * @returns An identifier that can be used to identify the interface.
1045
- */ _class_private_method_init(this, _createInterface);
1046
- _class_private_method_init(this, _assertInterfaceExists);
1047
- /**
1048
- * Transform a RPC request result if necessary.
1049
- *
1050
- * @param snapId - The snap ID of the snap that produced the result.
1051
- * @param handlerType - The handler type that produced the result.
1052
- * @param result - The result.
1053
- * @returns The transformed result if applicable, otherwise the original result.
1054
- */ _class_private_method_init(this, _transformSnapRpcRequestResult);
1055
- /**
1056
- * Assert that the returned result of a Snap RPC call is the expected shape.
1057
- *
1058
- * @param snapId - The snap ID.
1059
- * @param handlerType - The handler type of the RPC Request.
1060
- * @param result - The result of the RPC request.
1061
- */ _class_private_method_init(this, _assertSnapRpcRequestResult);
1062
- /**
1063
- * Awaits the specified promise and rejects if the promise doesn't resolve
1064
- * before the timeout.
1065
- *
1066
- * @param promise - The promise to await.
1067
- * @param timer - An optional timer object to control the timeout.
1068
- * @returns The result of the promise or rejects if the promise times out.
1069
- * @template PromiseValue - The value of the Promise.
1070
- */ _class_private_method_init(this, _executeWithTimeout);
1071
- _class_private_method_init(this, _recordSnapRpcRequestStart);
1072
- _class_private_method_init(this, _recordSnapRpcRequestFinish);
1073
- _class_private_method_init(this, _getRollbackSnapshot);
1074
- _class_private_method_init(this, _createRollbackSnapshot);
1075
- /**
1076
- * Rolls back a snap to its previous state, permissions
1077
- * and source code based on the `RollbackSnapshot` that
1078
- * is captured during the update process. After rolling back,
1079
- * the function also emits an event indicating that the
1080
- * snap has been rolled back and it clears the snapshot
1081
- * for that snap.
1082
- *
1083
- * @param snapId - The snap id.
1084
- * @throws {@link Error}. If a snapshot does not exist.
1085
- */ _class_private_method_init(this, _rollbackSnap);
1086
- /**
1087
- * Iterates through an array of snap ids
1088
- * and calls `rollbackSnap` on them.
1089
- *
1090
- * @param snapIds - An array of snap ids.
1091
- */ _class_private_method_init(this, _rollbackSnaps);
1092
- _class_private_method_init(this, _getRuntime);
1093
- _class_private_method_init(this, _getRuntimeExpect);
1094
- _class_private_method_init(this, _setupRuntime);
1095
- _class_private_method_init(this, _calculatePermissionsChange);
1096
- _class_private_method_init(this, _updatePermissions);
1097
- _class_private_method_init(this, _isValidUpdate);
1098
- /**
1099
- * Call a lifecycle hook on a snap, if the snap has the
1100
- * `endowment:lifecycle-hooks` permission. If the snap does not have the
1101
- * permission, nothing happens.
1102
- *
1103
- * @param snapId - The snap ID.
1104
- * @param handler - The lifecycle hook to call. This should be one of the
1105
- * supported lifecycle hooks.
1106
- * @private
1107
- */ _class_private_method_init(this, _callLifecycleHook);
1108
- _class_private_field_init(this, _closeAllConnections, {
1109
- writable: true,
1110
- value: void 0
1111
- });
1112
- _class_private_field_init(this, _dynamicPermissions, {
1113
- writable: true,
1114
- value: void 0
1115
- });
1116
- _class_private_field_init(this, _environmentEndowmentPermissions, {
1117
- writable: true,
1118
- value: void 0
1119
- });
1120
- _class_private_field_init(this, _excludedPermissions, {
1121
- writable: true,
1122
- value: void 0
1123
- });
1124
- _class_private_field_init(this, _featureFlags, {
1125
- writable: true,
1126
- value: void 0
1127
- });
1128
- _class_private_field_init(this, _fetchFunction, {
1129
- writable: true,
1130
- value: void 0
1131
- });
1132
- _class_private_field_init(this, _idleTimeCheckInterval, {
1133
- writable: true,
1134
- value: void 0
1135
- });
1136
- _class_private_field_init(this, _maxIdleTime, {
1137
- writable: true,
1138
- value: void 0
1139
- });
1140
- // This property cannot be hash private yet because of tests.
1141
- _define_property(this, "maxRequestTime", void 0);
1142
- _class_private_field_init(this, _detectSnapLocation, {
1143
- writable: true,
1144
- value: void 0
1145
- });
1146
- _class_private_field_init(this, _snapsRuntimeData, {
1147
- writable: true,
1148
- value: void 0
1149
- });
1150
- _class_private_field_init(this, _rollbackSnapshots, {
1151
- writable: true,
1152
- value: void 0
1153
- });
1154
- _class_private_field_init(this, _timeoutForLastRequestStatus, {
1155
- writable: true,
1156
- value: void 0
1157
- });
1158
- _class_private_field_init(this, _statusMachine, {
1159
- writable: true,
1160
- value: void 0
1161
- });
1162
- _class_private_field_set(this, _closeAllConnections, closeAllConnections);
1163
- _class_private_field_set(this, _dynamicPermissions, dynamicPermissions);
1164
- _class_private_field_set(this, _environmentEndowmentPermissions, environmentEndowmentPermissions);
1165
- _class_private_field_set(this, _excludedPermissions, excludedPermissions);
1166
- _class_private_field_set(this, _featureFlags, featureFlags);
1167
- _class_private_field_set(this, _fetchFunction, fetchFunction);
1168
- _class_private_field_set(this, _idleTimeCheckInterval, idleTimeCheckInterval);
1169
- _class_private_field_set(this, _maxIdleTime, maxIdleTime);
1170
- this.maxRequestTime = maxRequestTime;
1171
- _class_private_field_set(this, _detectSnapLocation, detectSnapLocationFunction);
1172
- this._onUnhandledSnapError = this._onUnhandledSnapError.bind(this);
1173
- this._onOutboundRequest = this._onOutboundRequest.bind(this);
1174
- this._onOutboundResponse = this._onOutboundResponse.bind(this);
1175
- _class_private_field_set(this, _rollbackSnapshots, new Map());
1176
- _class_private_field_set(this, _snapsRuntimeData, new Map());
1177
- _class_private_method_get(this, _pollForLastRequestStatus, pollForLastRequestStatus).call(this);
1178
- /* eslint-disable @typescript-eslint/unbound-method */ this.messagingSystem.subscribe('ExecutionService:unhandledError', this._onUnhandledSnapError);
1179
- this.messagingSystem.subscribe('ExecutionService:outboundRequest', this._onOutboundRequest);
1180
- this.messagingSystem.subscribe('ExecutionService:outboundResponse', this._onOutboundResponse);
1181
- /* eslint-enable @typescript-eslint/unbound-method */ this.messagingSystem.subscribe('SnapController:snapInstalled', ({ id })=>{
1182
- _class_private_method_get(this, _callLifecycleHook, callLifecycleHook).call(this, id, HandlerType.OnInstall).catch((error)=>{
1183
- logError(`Error when calling \`onInstall\` lifecycle hook for snap "${id}": ${getErrorMessage(error)}`);
1184
- });
1185
- });
1186
- this.messagingSystem.subscribe('SnapController:snapUpdated', ({ id })=>{
1187
- _class_private_method_get(this, _callLifecycleHook, callLifecycleHook).call(this, id, HandlerType.OnUpdate).catch((error)=>{
1188
- logError(`Error when calling \`onUpdate\` lifecycle hook for snap "${id}": ${getErrorMessage(error)}`);
1189
- });
1190
- });
1191
- _class_private_method_get(this, _initializeStateMachine, initializeStateMachine).call(this);
1192
- _class_private_method_get(this, _registerMessageHandlers, registerMessageHandlers).call(this);
1193
- if (preinstalledSnaps) {
1194
- _class_private_method_get(this, _handlePreinstalledSnaps, handlePreinstalledSnaps).call(this, preinstalledSnaps);
1195
- }
1196
- Object.values(this.state?.snaps ?? {}).forEach((snap)=>_class_private_method_get(this, _setupRuntime, setupRuntime).call(this, snap.id));
1197
- }
1198
- }
1199
- function initializeStateMachine() {
1200
- const disableGuard = ({ snapId })=>{
1201
- return this.getExpect(snapId).enabled;
1202
- };
1203
- const statusConfig = {
1204
- initial: SnapStatus.Installing,
1205
- states: {
1206
- [SnapStatus.Installing]: {
1207
- on: {
1208
- [SnapStatusEvents.Start]: {
1209
- target: SnapStatus.Running,
1210
- cond: disableGuard
1211
- }
1212
- }
1213
- },
1214
- [SnapStatus.Updating]: {
1215
- on: {
1216
- [SnapStatusEvents.Start]: {
1217
- target: SnapStatus.Running,
1218
- cond: disableGuard
1219
- },
1220
- [SnapStatusEvents.Stop]: SnapStatus.Stopped
1221
- }
1222
- },
1223
- [SnapStatus.Running]: {
1224
- on: {
1225
- [SnapStatusEvents.Stop]: SnapStatus.Stopped,
1226
- [SnapStatusEvents.Crash]: SnapStatus.Crashed
1227
- }
1228
- },
1229
- [SnapStatus.Stopped]: {
1230
- on: {
1231
- [SnapStatusEvents.Start]: {
1232
- target: SnapStatus.Running,
1233
- cond: disableGuard
1234
- },
1235
- [SnapStatusEvents.Update]: SnapStatus.Updating
1236
- }
1237
- },
1238
- [SnapStatus.Crashed]: {
1239
- on: {
1240
- [SnapStatusEvents.Start]: {
1241
- target: SnapStatus.Running,
1242
- cond: disableGuard
1243
- },
1244
- [SnapStatusEvents.Update]: SnapStatus.Updating
1245
- }
1246
- }
1247
- }
1248
- };
1249
- _class_private_field_set(this, _statusMachine, createMachine(statusConfig));
1250
- validateMachine(_class_private_field_get(this, _statusMachine));
1251
- }
1252
- function registerMessageHandlers() {
1253
- this.messagingSystem.registerActionHandler(`${controllerName}:clearSnapState`, (...args)=>this.clearSnapState(...args));
1254
- this.messagingSystem.registerActionHandler(`${controllerName}:get`, (...args)=>this.get(...args));
1255
- this.messagingSystem.registerActionHandler(`${controllerName}:getSnapState`, (...args)=>this.getSnapState(...args));
1256
- this.messagingSystem.registerActionHandler(`${controllerName}:handleRequest`, async (...args)=>this.handleRequest(...args));
1257
- this.messagingSystem.registerActionHandler(`${controllerName}:has`, (...args)=>this.has(...args));
1258
- this.messagingSystem.registerActionHandler(`${controllerName}:updateBlockedSnaps`, async ()=>this.updateBlockedSnaps());
1259
- this.messagingSystem.registerActionHandler(`${controllerName}:updateSnapState`, (...args)=>this.updateSnapState(...args));
1260
- this.messagingSystem.registerActionHandler(`${controllerName}:enable`, (...args)=>this.enableSnap(...args));
1261
- this.messagingSystem.registerActionHandler(`${controllerName}:disable`, async (...args)=>this.disableSnap(...args));
1262
- this.messagingSystem.registerActionHandler(`${controllerName}:remove`, async (...args)=>this.removeSnap(...args));
1263
- this.messagingSystem.registerActionHandler(`${controllerName}:getPermitted`, (...args)=>this.getPermittedSnaps(...args));
1264
- this.messagingSystem.registerActionHandler(`${controllerName}:install`, async (...args)=>this.installSnaps(...args));
1265
- this.messagingSystem.registerActionHandler(`${controllerName}:getAll`, (...args)=>this.getAllSnaps(...args));
1266
- this.messagingSystem.registerActionHandler(`${controllerName}:incrementActiveReferences`, (...args)=>this.incrementActiveReferences(...args));
1267
- this.messagingSystem.registerActionHandler(`${controllerName}:decrementActiveReferences`, (...args)=>this.decrementActiveReferences(...args));
1268
- this.messagingSystem.registerActionHandler(`${controllerName}:getRegistryMetadata`, async (...args)=>this.getRegistryMetadata(...args));
1269
- this.messagingSystem.registerActionHandler(`${controllerName}:disconnectOrigin`, (...args)=>this.removeSnapFromSubject(...args));
1270
- this.messagingSystem.registerActionHandler(`${controllerName}:revokeDynamicPermissions`, (...args)=>this.revokeDynamicSnapPermissions(...args));
1271
- this.messagingSystem.registerActionHandler(`${controllerName}:getFile`, async (...args)=>this.getSnapFile(...args));
1272
- }
1273
- function handlePreinstalledSnaps(preinstalledSnaps) {
1274
- for (const { snapId, manifest, files, removable } of preinstalledSnaps){
1275
- const existingSnap = this.get(snapId);
1276
- const isAlreadyInstalled = existingSnap !== undefined;
1277
- const isUpdate = isAlreadyInstalled && gtVersion(manifest.version, existingSnap.version);
1278
- // Disallow downgrades and overwriting non preinstalled snaps
1279
- if (isAlreadyInstalled && (!isUpdate || existingSnap.preinstalled !== true)) {
1280
- continue;
1281
- }
1282
- const manifestFile = new VirtualFile({
1283
- path: NpmSnapFileNames.Manifest,
1284
- value: JSON.stringify(manifest),
1285
- result: manifest
1286
- });
1287
- const virtualFiles = files.map(({ path, value })=>new VirtualFile({
1288
- value,
1289
- path
1290
- }));
1291
- const { filePath, iconPath } = manifest.source.location.npm;
1292
- const sourceCode = virtualFiles.find((file)=>file.path === filePath);
1293
- const svgIcon = iconPath ? virtualFiles.find((file)=>file.path === iconPath) : undefined;
1294
- assert(sourceCode, 'Source code not provided for preinstalled snap.');
1295
- assert(!iconPath || iconPath && svgIcon, 'Icon not provided for preinstalled snap.');
1296
- assert(manifest.source.files === undefined, 'Auxiliary files are not currently supported for preinstalled snaps.');
1297
- const localizationFiles = manifest.source.locales?.map((path)=>virtualFiles.find((file)=>file.path === path)) ?? [];
1298
- const validatedLocalizationFiles = getValidatedLocalizationFiles(localizationFiles.filter(Boolean));
1299
- assert(localizationFiles.length === validatedLocalizationFiles.length, 'Missing localization files for preinstalled snap.');
1300
- const filesObject = {
1301
- manifest: manifestFile,
1302
- sourceCode,
1303
- svgIcon,
1304
- auxiliaryFiles: [],
1305
- localizationFiles: validatedLocalizationFiles
1306
- };
1307
- // Add snap to the SnapController state
1308
- _class_private_method_get(this, _set, set).call(this, {
1309
- id: snapId,
1310
- origin: 'metamask',
1311
- files: filesObject,
1312
- removable,
1313
- preinstalled: true
1314
- });
1315
- // Setup permissions
1316
- const processedPermissions = processSnapPermissions(manifest.initialPermissions);
1317
- _class_private_method_get(this, _validateSnapPermissions, validateSnapPermissions).call(this, processedPermissions);
1318
- const { newPermissions, unusedPermissions } = _class_private_method_get(this, _calculatePermissionsChange, calculatePermissionsChange).call(this, snapId, processedPermissions);
1319
- _class_private_method_get(this, _updatePermissions, updatePermissions).call(this, {
1320
- snapId,
1321
- newPermissions,
1322
- unusedPermissions
1323
- });
1324
- // Set status
1325
- this.update((state)=>{
1326
- state.snaps[snapId].status = SnapStatus.Stopped;
1327
- });
1328
- }
1329
- }
1330
- function pollForLastRequestStatus() {
1331
- _class_private_field_set(this, _timeoutForLastRequestStatus, setTimeout(()=>{
1332
- _class_private_method_get(this, _stopSnapsLastRequestPastMax, stopSnapsLastRequestPastMax).call(this).catch((error)=>{
1333
- // TODO: Decide how to handle errors.
1334
- logError(error);
1335
- });
1336
- _class_private_method_get(this, _pollForLastRequestStatus, pollForLastRequestStatus).call(this);
1337
- }, _class_private_field_get(this, _idleTimeCheckInterval)));
1338
- }
1339
- async function blockSnap(snapId, blockedSnapInfo) {
1340
- if (!this.has(snapId)) {
1341
- return;
1342
- }
1343
- try {
1344
- this.update((state)=>{
1345
- state.snaps[snapId].blocked = true;
1346
- state.snaps[snapId].blockInformation = blockedSnapInfo;
1347
- });
1348
- await this.disableSnap(snapId);
1349
- } catch (error) {
1350
- logError(`Encountered error when stopping blocked snap "${snapId}".`, error);
1351
- }
1352
- this.messagingSystem.publish(`${controllerName}:snapBlocked`, snapId, blockedSnapInfo);
1353
- }
1354
- function unblockSnap(snapId) {
1355
- if (!this.has(snapId) || !this.state.snaps[snapId].blocked) {
1356
- return;
1357
- }
1358
- this.update((state)=>{
1359
- state.snaps[snapId].blocked = false;
1360
- delete state.snaps[snapId].blockInformation;
1361
- });
1362
- this.messagingSystem.publish(`${controllerName}:snapUnblocked`, snapId);
1363
- }
1364
- async function assertIsInstallAllowed(snapId, snapInfo) {
1365
- const results = await this.messagingSystem.call('SnapsRegistry:get', {
1366
- [snapId]: snapInfo
1367
- });
1368
- const result = results[snapId];
1369
- if (result.status === SnapsRegistryStatus.Blocked) {
1370
- throw new Error(`Cannot install version "${snapInfo.version}" of snap "${snapId}": The version is blocked. ${result.reason?.explanation ?? ''}`);
1371
- }
1372
- const isAllowlistingRequired = Object.keys(snapInfo.permissions).some((permission)=>!ALLOWED_PERMISSIONS.includes(permission));
1373
- if (_class_private_field_get(this, _featureFlags).requireAllowlist && isAllowlistingRequired && result.status !== SnapsRegistryStatus.Verified) {
1374
- throw new Error(`Cannot install version "${snapInfo.version}" of snap "${snapId}": The snap is not on the allowlist.`);
1375
- }
1376
- }
1377
- async function stopSnapsLastRequestPastMax() {
1378
- const entries = [
1379
- ..._class_private_field_get(this, _snapsRuntimeData).entries()
1380
- ];
1381
- return Promise.all(entries.filter(([_snapId, runtime])=>runtime.activeReferences === 0 && runtime.pendingInboundRequests.length === 0 && runtime.lastRequest && _class_private_field_get(this, _maxIdleTime) && timeSince(runtime.lastRequest) > _class_private_field_get(this, _maxIdleTime)).map(async ([snapId])=>this.stopSnap(snapId, SnapStatusEvents.Stop)));
1382
- }
1383
- function transition(snapId, event) {
1384
- const { interpreter } = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
1385
- interpreter.send(event);
1386
- this.update((state)=>{
1387
- state.snaps[snapId].status = interpreter.state.value;
1388
- });
1389
- }
1390
- async function terminateSnap(snapId) {
1391
- await this.messagingSystem.call('ExecutionService:terminateSnap', snapId);
1392
- this.messagingSystem.publish('SnapController:snapTerminated', this.getTruncatedExpect(snapId));
1393
- }
1394
- function handleInitialConnections(snapId, previousInitialConnections, initialConnections) {
1395
- if (previousInitialConnections) {
1396
- const revokedInitialConnections = setDiff(previousInitialConnections, initialConnections);
1397
- for (const origin of Object.keys(revokedInitialConnections)){
1398
- this.removeSnapFromSubject(origin, snapId);
1399
- }
1400
- }
1401
- for (const origin of Object.keys(initialConnections)){
1402
- _class_private_method_get(this, _addSnapToSubject, addSnapToSubject).call(this, origin, snapId);
1403
- }
1404
- }
1405
- function addSnapToSubject(origin, snapId) {
1406
- const subjectPermissions = this.messagingSystem.call('PermissionController:getPermissions', origin);
1407
- const existingCaveat = subjectPermissions?.[WALLET_SNAP_PERMISSION_KEY]?.caveats?.find((caveat)=>caveat.type === SnapCaveatType.SnapIds);
1408
- const subjectHasSnap = Boolean((existingCaveat?.value)?.[snapId]);
1409
- // If the subject is already connected to the snap, this is a no-op.
1410
- if (subjectHasSnap) {
1411
- return;
1412
- }
1413
- // If an existing caveat exists, we add the snap to that.
1414
- if (existingCaveat) {
1415
- this.messagingSystem.call('PermissionController:updateCaveat', origin, WALLET_SNAP_PERMISSION_KEY, SnapCaveatType.SnapIds, {
1416
- ...existingCaveat,
1417
- [snapId]: {}
1418
- });
1419
- return;
1420
- }
1421
- const approvedPermissions = {
1422
- [WALLET_SNAP_PERMISSION_KEY]: {
1423
- caveats: [
1424
- {
1425
- type: SnapCaveatType.SnapIds,
1426
- value: {
1427
- [snapId]: {}
1428
- }
1429
- }
1430
- ]
1431
- }
1432
- };
1433
- this.messagingSystem.call('PermissionController:grantPermissions', {
1434
- approvedPermissions,
1435
- subject: {
1436
- origin
1437
- }
1438
- });
1439
- }
1440
- function removeSnapFromSubjects(snapId) {
1441
- const subjects = this.messagingSystem.call('PermissionController:getSubjectNames');
1442
- for (const subject of subjects){
1443
- this.removeSnapFromSubject(subject, snapId);
1444
- }
1445
- }
1446
- function revokeAllSnapPermissions(snapId) {
1447
- if (this.messagingSystem.call('PermissionController:hasPermissions', snapId)) {
1448
- this.messagingSystem.call('PermissionController:revokeAllPermissions', snapId);
1449
- }
1450
- }
1451
- function createApproval({ origin, snapId, type }) {
1452
- const id = nanoid();
1453
- const promise = this.messagingSystem.call('ApprovalController:addRequest', {
1454
- origin,
1455
- id,
1456
- type,
1457
- requestData: {
1458
- // Mirror previous installation metadata
1459
- metadata: {
1460
- id,
1461
- origin: snapId,
1462
- dappOrigin: origin
1463
- },
1464
- snapId
1465
- },
1466
- requestState: {
1467
- loading: true
1468
- }
1469
- }, true);
1470
- return {
1471
- id,
1472
- promise
1473
- };
1474
- }
1475
- function updateApproval(id, requestState) {
1476
- try {
1477
- this.messagingSystem.call('ApprovalController:updateRequestState', {
1478
- id,
1479
- requestState
1480
- });
1481
- } catch {
1482
- // Do nothing
1483
- }
1484
- }
1485
- async function resolveAllowlistVersion(snapId, versionRange) {
1486
- return await this.messagingSystem.call('SnapsRegistry:resolveVersion', snapId, versionRange);
1487
- }
1488
- async function add(args) {
1489
- const { id: snapId, location, versionRange } = args;
1490
- _class_private_method_get(this, _setupRuntime, setupRuntime).call(this, snapId);
1491
- const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
1492
- if (!runtime.installPromise) {
1493
- log(`Adding snap: ${snapId}`);
1494
- // If fetching and setting the snap succeeds, this property will be set
1495
- // to null in the authorize() method.
1496
- runtime.installPromise = (async ()=>{
1497
- const fetchedSnap = await fetchSnap(snapId, location);
1498
- const manifest = fetchedSnap.manifest.result;
1499
- if (!satisfiesVersionRange(manifest.version, versionRange)) {
1500
- throw new Error(`Version mismatch. Manifest for "${snapId}" specifies version "${manifest.version}" which doesn't satisfy requested version range "${versionRange}".`);
1501
- }
1502
- await _class_private_method_get(this, _assertIsInstallAllowed, assertIsInstallAllowed).call(this, snapId, {
1503
- version: manifest.version,
1504
- checksum: manifest.source.shasum,
1505
- permissions: manifest.initialPermissions
1506
- });
1507
- return _class_private_method_get(this, _set, set).call(this, {
1508
- ...args,
1509
- files: fetchedSnap,
1510
- id: snapId
1511
- });
1512
- })();
1513
- }
1514
- try {
1515
- return await runtime.installPromise;
1516
- } catch (error) {
1517
- // Reset promise so users can retry installation in case the problem is
1518
- // temporary.
1519
- runtime.installPromise = null;
1520
- throw error;
1521
- }
1522
- }
1523
- async function startSnap(snapData) {
1524
- const { snapId } = snapData;
1525
- if (this.isRunning(snapId)) {
1526
- throw new Error(`Snap "${snapId}" is already started.`);
1527
- }
1528
- try {
1529
- const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
1530
- const result = await _class_private_method_get(this, _executeWithTimeout, executeWithTimeout).call(this, this.messagingSystem.call('ExecutionService:executeSnap', {
1531
- ...snapData,
1532
- endowments: await _class_private_method_get(this, _getEndowments, getEndowments).call(this, snapId)
1533
- }));
1534
- _class_private_method_get(this, _transition, transition).call(this, snapId, SnapStatusEvents.Start);
1535
- // We treat the initialization of the snap as the first request, for idle timing purposes.
1536
- runtime.lastRequest = Date.now();
1537
- return result;
1538
- } catch (error) {
1539
- await _class_private_method_get(this, _terminateSnap, terminateSnap).call(this, snapId);
1540
- throw error;
1541
- }
1542
- }
1543
- async function getEndowments(snapId) {
1544
- let allEndowments = [];
1545
- for (const permissionName of _class_private_field_get(this, _environmentEndowmentPermissions)){
1546
- if (this.messagingSystem.call('PermissionController:hasPermission', snapId, permissionName)) {
1547
- const endowments = await this.messagingSystem.call('PermissionController:getEndowments', snapId, permissionName);
1548
- if (endowments) {
1549
- // We don't have any guarantees about the type of the endowments
1550
- // value, so we have to guard at runtime.
1551
- if (!Array.isArray(endowments) || endowments.some((value)=>typeof value !== 'string')) {
1552
- throw new Error('Expected an array of string endowment names.');
1553
- }
1554
- allEndowments = allEndowments.concat(endowments);
1555
- }
1556
- }
1557
- }
1558
- const dedupedEndowments = [
1559
- ...new Set([
1560
- ...DEFAULT_ENDOWMENTS,
1561
- ...allEndowments
1562
- ])
1563
- ];
1564
- if (dedupedEndowments.length < // This is a bug in TypeScript: https://github.com/microsoft/TypeScript/issues/48313
1565
- // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
1566
- DEFAULT_ENDOWMENTS.length + allEndowments.length) {
1567
- logError(`Duplicate endowments found for ${snapId}. Default endowments should not be requested.`, allEndowments);
1568
- }
1569
- return dedupedEndowments;
1570
- }
1571
- function set(args) {
1572
- const { id: snapId, origin, files, isUpdate = false, removable, preinstalled } = args;
1573
- const { manifest, sourceCode: sourceCodeFile, svgIcon, auxiliaryFiles: rawAuxiliaryFiles, localizationFiles } = files;
1574
- assertIsSnapManifest(manifest.result);
1575
- const { version } = manifest.result;
1576
- const sourceCode = sourceCodeFile.toString();
1577
- assert(typeof sourceCode === 'string' && sourceCode.length > 0, `Invalid source code for snap "${snapId}".`);
1578
- const auxiliaryFiles = rawAuxiliaryFiles.map((file)=>{
1579
- assert(typeof file.data.base64 === 'string');
1580
- return {
1581
- path: file.path,
1582
- value: file.data.base64
1583
- };
1584
- });
1585
- const snapsState = this.state.snaps;
1586
- const existingSnap = snapsState[snapId];
1587
- const previousVersionHistory = existingSnap?.versionHistory ?? [];
1588
- const versionHistory = [
1589
- ...previousVersionHistory,
1590
- {
1591
- version,
1592
- date: Date.now(),
1593
- origin
1594
- }
1595
- ];
1596
- const localizedFiles = localizationFiles.map((file)=>file.result);
1597
- const snap = {
1598
- // Restore relevant snap state if it exists
1599
- ...existingSnap,
1600
- // Note that the snap will be unblocked and enabled, regardless of its
1601
- // previous state.
1602
- blocked: false,
1603
- enabled: true,
1604
- removable,
1605
- preinstalled,
1606
- id: snapId,
1607
- initialPermissions: manifest.result.initialPermissions,
1608
- manifest: manifest.result,
1609
- status: _class_private_field_get(this, _statusMachine).config.initial,
1610
- sourceCode,
1611
- version,
1612
- versionHistory,
1613
- auxiliaryFiles,
1614
- localizationFiles: localizedFiles
1615
- };
1616
- // If the snap was blocked, it isn't any longer
1617
- delete snap.blockInformation;
1618
- // store the snap back in state
1619
- const { inversePatches } = this.update((state)=>{
1620
- state.snaps[snapId] = snap;
1621
- });
1622
- // checking for isUpdate here as this function is also used in
1623
- // the install flow, we do not care to create snapshots for installs
1624
- if (isUpdate) {
1625
- const rollbackSnapshot = _class_private_method_get(this, _getRollbackSnapshot, getRollbackSnapshot).call(this, snapId);
1626
- if (rollbackSnapshot !== undefined) {
1627
- rollbackSnapshot.statePatches = inversePatches;
1628
- }
1629
- }
1630
- // In case the Snap uses a localized manifest, we need to get the
1631
- // proposed name from the localized manifest.
1632
- const { proposedName } = getLocalizedSnapManifest(manifest.result, 'en', localizedFiles);
1633
- this.messagingSystem.call('SubjectMetadataController:addSubjectMetadata', {
1634
- subjectType: SubjectType.Snap,
1635
- name: proposedName,
1636
- origin: snap.id,
1637
- version,
1638
- svgIcon: svgIcon?.toString() ?? null
1639
- });
1640
- return {
1641
- ...snap,
1642
- sourceCode
1643
- };
1644
- }
1645
- function validateSnapPermissions(processedPermissions) {
1646
- const permissionKeys = Object.keys(processedPermissions);
1647
- const handlerPermissions = Array.from(new Set(Object.values(handlerEndowments)));
1648
- assert(permissionKeys.some((key)=>handlerPermissions.includes(key)), `A snap must request at least one of the following permissions: ${handlerPermissions.filter((handler)=>handler !== null).join(', ')}.`);
1649
- const excludedPermissionErrors = permissionKeys.reduce((errors, permission)=>{
1650
- if (hasProperty(_class_private_field_get(this, _excludedPermissions), permission)) {
1651
- errors.push(_class_private_field_get(this, _excludedPermissions)[permission]);
1652
- }
1653
- return errors;
1654
- }, []);
1655
- assert(excludedPermissionErrors.length === 0, `One or more permissions are not allowed:\n${excludedPermissionErrors.join('\n')}`);
1656
- }
1657
- function getExecutionTimeout(permission) {
1658
- return getMaxRequestTimeCaveat(permission) ?? this.maxRequestTime;
1659
- }
1660
- function getRpcRequestHandler(snapId) {
1661
- const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
1662
- const existingHandler = runtime.rpcHandler;
1663
- if (existingHandler) {
1664
- return existingHandler;
1665
- }
1666
- const requestQueue = new RequestQueue(5);
1667
- // We need to set up this promise map to map snapIds to their respective startPromises,
1668
- // because otherwise we would lose context on the correct startPromise.
1669
- const startPromises = new Map();
1670
- const rpcHandler = async ({ origin, handler: handlerType, request, timeout })=>{
1671
- if (this.state.snaps[snapId].enabled === false) {
1672
- throw new Error(`Snap "${snapId}" is disabled.`);
1673
- }
1674
- if (this.state.snaps[snapId].status === SnapStatus.Installing) {
1675
- throw new Error(`Snap "${snapId}" is currently being installed. Please try again later.`);
1676
- }
1677
- if (!this.isRunning(snapId)) {
1678
- let localStartPromise = startPromises.get(snapId);
1679
- if (!localStartPromise) {
1680
- localStartPromise = this.startSnap(snapId);
1681
- startPromises.set(snapId, localStartPromise);
1682
- } else if (requestQueue.get(origin) >= requestQueue.maxQueueSize) {
1683
- throw new Error('Exceeds maximum number of requests waiting to be resolved, please try again.');
1684
- }
1685
- requestQueue.increment(origin);
1686
- try {
1687
- await localStartPromise;
1688
- } finally{
1689
- requestQueue.decrement(origin);
1690
- // Only delete startPromise for a snap if its value hasn't changed
1691
- if (startPromises.get(snapId) === localStartPromise) {
1692
- startPromises.delete(snapId);
1693
- }
1694
- }
1695
- }
1696
- const timer = new Timer(timeout);
1697
- _class_private_method_get(this, _recordSnapRpcRequestStart, recordSnapRpcRequestStart).call(this, snapId, request.id, timer);
1698
- const handleRpcRequestPromise = this.messagingSystem.call('ExecutionService:handleRpcRequest', snapId, {
1699
- origin,
1700
- handler: handlerType,
1701
- request
1702
- });
1703
- // This will either get the result or reject due to the timeout.
1704
- try {
1705
- const result = await _class_private_method_get(this, _executeWithTimeout, executeWithTimeout).call(this, handleRpcRequestPromise, timer);
1706
- await _class_private_method_get(this, _assertSnapRpcRequestResult, assertSnapRpcRequestResult).call(this, snapId, handlerType, result);
1707
- return _class_private_method_get(this, _transformSnapRpcRequestResult, transformSnapRpcRequestResult).call(this, snapId, handlerType, result);
1708
- } catch (error) {
1709
- const [jsonRpcError, handled] = unwrapError(error);
1710
- if (!handled) {
1711
- await this.stopSnap(snapId, SnapStatusEvents.Crash);
1712
- }
1713
- throw jsonRpcError;
1714
- } finally{
1715
- _class_private_method_get(this, _recordSnapRpcRequestFinish, recordSnapRpcRequestFinish).call(this, snapId, request.id);
1716
- }
1717
- };
1718
- runtime.rpcHandler = rpcHandler;
1719
- return rpcHandler;
1720
- }
1721
- async function createInterface(snapId, content) {
1722
- return this.messagingSystem.call('SnapInterfaceController:createInterface', snapId, content);
1723
- }
1724
- function assertInterfaceExists(snapId, id) {
1725
- // This will throw if the interface isn't accessible, but we assert nevertheless.
1726
- assert(this.messagingSystem.call('SnapInterfaceController:getInterface', snapId, id));
1727
- }
1728
- async function transformSnapRpcRequestResult(snapId, handlerType, result) {
1729
- switch(handlerType){
1730
- case HandlerType.OnTransaction:
1731
- case HandlerType.OnSignature:
1732
- case HandlerType.OnHomePage:
1733
- {
1734
- // Since this type has been asserted earlier we can cast
1735
- const castResult = result;
1736
- // If a handler returns static content, we turn it into a dynamic UI
1737
- if (castResult && hasProperty(castResult, 'content')) {
1738
- const { content, ...rest } = castResult;
1739
- const id = await _class_private_method_get(this, _createInterface, createInterface).call(this, snapId, content);
1740
- return {
1741
- ...rest,
1742
- id
1743
- };
1744
- }
1745
- return result;
1746
- }
1747
- default:
1748
- return result;
1749
- }
1750
- }
1751
- async function assertSnapRpcRequestResult(snapId, handlerType, result) {
1752
- switch(handlerType){
1753
- case HandlerType.OnTransaction:
1754
- {
1755
- assertStruct(result, OnTransactionResponseStruct);
1756
- if (result && hasProperty(result, 'id')) {
1757
- _class_private_method_get(this, _assertInterfaceExists, assertInterfaceExists).call(this, snapId, result.id);
1758
- }
1759
- break;
1760
- }
1761
- case HandlerType.OnSignature:
1762
- {
1763
- assertStruct(result, OnSignatureResponseStruct);
1764
- if (result && hasProperty(result, 'id')) {
1765
- _class_private_method_get(this, _assertInterfaceExists, assertInterfaceExists).call(this, snapId, result.id);
1766
- }
1767
- break;
1768
- }
1769
- case HandlerType.OnHomePage:
1770
- {
1771
- assertStruct(result, OnHomePageResponseStruct);
1772
- if (result && hasProperty(result, 'id')) {
1773
- _class_private_method_get(this, _assertInterfaceExists, assertInterfaceExists).call(this, snapId, result.id);
1774
- }
1775
- break;
1776
- }
1777
- case HandlerType.OnNameLookup:
1778
- assertStruct(result, OnNameLookupResponseStruct);
1779
- break;
1780
- default:
1781
- break;
1782
- }
1783
- }
1784
- async function executeWithTimeout(promise, timer) {
1785
- const result = await withTimeout(promise, timer ?? this.maxRequestTime);
1786
- if (result === hasTimedOut) {
1787
- throw new Error('The request timed out.');
1788
- }
1789
- return result;
1790
- }
1791
- function recordSnapRpcRequestStart(snapId, requestId, timer) {
1792
- const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
1793
- runtime.pendingInboundRequests.push({
1794
- requestId,
1795
- timer
1796
- });
1797
- runtime.lastRequest = null;
1798
- }
1799
- function recordSnapRpcRequestFinish(snapId, requestId) {
1800
- const runtime = _class_private_method_get(this, _getRuntimeExpect, getRuntimeExpect).call(this, snapId);
1801
- runtime.pendingInboundRequests = runtime.pendingInboundRequests.filter((request)=>request.requestId !== requestId);
1802
- if (runtime.pendingInboundRequests.length === 0) {
1803
- runtime.lastRequest = Date.now();
1804
- }
1805
- }
1806
- function getRollbackSnapshot(snapId) {
1807
- return _class_private_field_get(this, _rollbackSnapshots).get(snapId);
1808
- }
1809
- function createRollbackSnapshot(snapId) {
1810
- assert(_class_private_field_get(this, _rollbackSnapshots).get(snapId) === undefined, new Error(`Snap "${snapId}" rollback snapshot already exists.`));
1811
- _class_private_field_get(this, _rollbackSnapshots).set(snapId, {
1812
- statePatches: [],
1813
- permissions: {},
1814
- newVersion: ''
1815
- });
1816
- const newRollbackSnapshot = _class_private_field_get(this, _rollbackSnapshots).get(snapId);
1817
- assert(newRollbackSnapshot !== undefined, new Error(`Snapshot creation failed for ${snapId}.`));
1818
- return newRollbackSnapshot;
1819
- }
1820
- async function rollbackSnap(snapId) {
1821
- const rollbackSnapshot = _class_private_method_get(this, _getRollbackSnapshot, getRollbackSnapshot).call(this, snapId);
1822
- if (!rollbackSnapshot) {
1823
- throw new Error('A snapshot does not exist for this snap.');
1824
- }
1825
- await this.stopSnap(snapId, SnapStatusEvents.Stop);
1826
- // Always set to stopped even if it wasn't running initially
1827
- if (this.get(snapId)?.status !== SnapStatus.Stopped) {
1828
- _class_private_method_get(this, _transition, transition).call(this, snapId, SnapStatusEvents.Stop);
1829
- }
1830
- const { statePatches, permissions } = rollbackSnapshot;
1831
- if (statePatches?.length) {
1832
- this.applyPatches(statePatches);
1833
- }
1834
- // Reset snap status, as we may have been in another state when we stored state patches
1835
- // But now we are 100% in a stopped state
1836
- if (this.get(snapId)?.status !== SnapStatus.Stopped) {
1837
- this.update((state)=>{
1838
- state.snaps[snapId].status = SnapStatus.Stopped;
1839
- });
1840
- }
1841
- _class_private_method_get(this, _updatePermissions, updatePermissions).call(this, {
1842
- snapId,
1843
- unusedPermissions: permissions.granted,
1844
- newPermissions: permissions.revoked,
1845
- requestData: permissions.requestData
1846
- });
1847
- const truncatedSnap = this.getTruncatedExpect(snapId);
1848
- this.messagingSystem.publish('SnapController:snapRolledback', truncatedSnap, rollbackSnapshot.newVersion);
1849
- _class_private_field_get(this, _rollbackSnapshots).delete(snapId);
1850
- }
1851
- async function rollbackSnaps(snapIds) {
1852
- for (const snapId of snapIds){
1853
- await _class_private_method_get(this, _rollbackSnap, rollbackSnap).call(this, snapId);
1854
- }
1855
- }
1856
- function getRuntime(snapId) {
1857
- return _class_private_field_get(this, _snapsRuntimeData).get(snapId);
1858
- }
1859
- function getRuntimeExpect(snapId) {
1860
- const runtime = _class_private_method_get(this, _getRuntime, getRuntime).call(this, snapId);
1861
- assert(runtime !== undefined, new Error(`Snap "${snapId}" runtime data not found`));
1862
- return runtime;
1863
- }
1864
- function setupRuntime(snapId) {
1865
- if (_class_private_field_get(this, _snapsRuntimeData).has(snapId)) {
1866
- return;
1867
- }
1868
- const snap = this.get(snapId);
1869
- const interpreter = interpret(_class_private_field_get(this, _statusMachine));
1870
- interpreter.start({
1871
- context: {
1872
- snapId
1873
- },
1874
- value: snap?.status ?? _class_private_field_get(this, _statusMachine).config.initial
1875
- });
1876
- forceStrict(interpreter);
1877
- _class_private_field_get(this, _snapsRuntimeData).set(snapId, {
1878
- lastRequest: null,
1879
- rpcHandler: null,
1880
- installPromise: null,
1881
- activeReferences: 0,
1882
- pendingInboundRequests: [],
1883
- pendingOutboundRequests: 0,
1884
- interpreter
1885
- });
1886
- }
1887
- function calculatePermissionsChange(snapId, desiredPermissionsSet) {
1888
- const oldPermissions = this.messagingSystem.call('PermissionController:getPermissions', snapId) ?? {};
1889
- const newPermissions = setDiff(desiredPermissionsSet, oldPermissions);
1890
- // TODO(ritave): The assumption that these are unused only holds so long as we do not
1891
- // permit dynamic permission requests.
1892
- const unusedPermissions = setDiff(oldPermissions, desiredPermissionsSet);
1893
- // It's a Set Intersection of oldPermissions and desiredPermissionsSet
1894
- // oldPermissions ∖ (oldPermissions ∖ desiredPermissionsSet) ⟺ oldPermissions ∩ desiredPermissionsSet
1895
- const approvedPermissions = setDiff(oldPermissions, unusedPermissions);
1896
- return {
1897
- newPermissions,
1898
- unusedPermissions,
1899
- approvedPermissions
1900
- };
1901
- }
1902
- function updatePermissions({ snapId, unusedPermissions = {}, newPermissions = {}, requestData }) {
1903
- const unusedPermissionsKeys = Object.keys(unusedPermissions);
1904
- if (isNonEmptyArray(unusedPermissionsKeys)) {
1905
- this.messagingSystem.call('PermissionController:revokePermissions', {
1906
- [snapId]: unusedPermissionsKeys
1907
- });
1908
- }
1909
- if (isNonEmptyArray(Object.keys(newPermissions))) {
1910
- this.messagingSystem.call('PermissionController:grantPermissions', {
1911
- approvedPermissions: newPermissions,
1912
- subject: {
1913
- origin: snapId
1914
- },
1915
- requestData
1916
- });
1917
- }
1918
- }
1919
- function isValidUpdate(snapId, newVersionRange) {
1920
- const existingSnap = this.getExpect(snapId);
1921
- if (satisfiesVersionRange(existingSnap.version, newVersionRange)) {
1922
- return false;
1923
- }
1924
- if (gtRange(existingSnap.version, newVersionRange)) {
1925
- return false;
1926
- }
1927
- return true;
1928
- }
1929
- async function callLifecycleHook(snapId, handler) {
1930
- const permissionName = handlerEndowments[handler];
1931
- assert(permissionName, 'Lifecycle hook must have an endowment.');
1932
- const hasPermission = this.messagingSystem.call('PermissionController:hasPermission', snapId, permissionName);
1933
- if (!hasPermission) {
1934
- return;
1935
- }
1936
- await this.handleRequest({
1937
- snapId,
1938
- handler,
1939
- origin: '',
1940
- request: {
1941
- jsonrpc: '2.0',
1942
- method: handler
1943
- }
1944
- });
1945
- }
1946
-
1947
- //# sourceMappingURL=SnapController.js.map