@openzeppelin/upgrades-core 1.9.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 (336) hide show
  1. package/CHANGELOG.md +110 -0
  2. package/artifacts/@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol/ERC1967Proxy.dbg.json +4 -0
  3. package/artifacts/@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol/ERC1967Proxy.json +80 -0
  4. package/artifacts/@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol/ProxyAdmin.json +160 -0
  5. package/artifacts/@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol/TransparentUpgradeableProxy.json +155 -0
  6. package/artifacts/AdminUpgradeabilityProxy.json +155 -0
  7. package/artifacts/ProxyAdmin.json +160 -0
  8. package/artifacts/contracts/proxy/AdminUpgradeabilityProxy.sol/AdminUpgradeabilityProxy.json +155 -0
  9. package/artifacts/contracts/proxy/ProxyAdmin.sol/ProxyAdmin.json +160 -0
  10. package/contracts/Initializable.sol +64 -0
  11. package/dist/ast-dereferencer.d.ts +8 -0
  12. package/dist/ast-dereferencer.d.ts.map +1 -0
  13. package/dist/ast-dereferencer.js +29 -0
  14. package/dist/ast-dereferencer.js.map +1 -0
  15. package/dist/deployment.d.ts +18 -0
  16. package/dist/deployment.d.ts.map +1 -0
  17. package/dist/deployment.js +110 -0
  18. package/dist/deployment.js.map +1 -0
  19. package/dist/deployment.test.d.ts +2 -0
  20. package/dist/deployment.test.d.ts.map +1 -0
  21. package/dist/deployment.test.js +92 -0
  22. package/dist/deployment.test.js.map +1 -0
  23. package/dist/eip-1967.d.ts +7 -0
  24. package/dist/eip-1967.d.ts.map +1 -0
  25. package/dist/eip-1967.js +63 -0
  26. package/dist/eip-1967.js.map +1 -0
  27. package/dist/error.d.ts +21 -0
  28. package/dist/error.d.ts.map +1 -0
  29. package/dist/error.js +21 -0
  30. package/dist/error.js.map +1 -0
  31. package/dist/impl-store.d.ts +7 -0
  32. package/dist/impl-store.d.ts.map +1 -0
  33. package/dist/impl-store.js +94 -0
  34. package/dist/impl-store.js.map +1 -0
  35. package/dist/impl-store.test.d.ts +2 -0
  36. package/dist/impl-store.test.d.ts.map +1 -0
  37. package/dist/impl-store.test.js +55 -0
  38. package/dist/impl-store.test.js.map +1 -0
  39. package/dist/index.d.ts +16 -0
  40. package/dist/index.d.ts.map +1 -0
  41. package/dist/index.js +32 -0
  42. package/dist/index.js.map +1 -0
  43. package/dist/levenshtein.d.ts +12 -0
  44. package/dist/levenshtein.d.ts.map +1 -0
  45. package/dist/levenshtein.js +89 -0
  46. package/dist/levenshtein.js.map +1 -0
  47. package/dist/levenshtein.test.d.ts +2 -0
  48. package/dist/levenshtein.test.d.ts.map +1 -0
  49. package/dist/levenshtein.test.js +88 -0
  50. package/dist/levenshtein.test.js.map +1 -0
  51. package/dist/link-refs.d.ts +11 -0
  52. package/dist/link-refs.d.ts.map +1 -0
  53. package/dist/link-refs.js +36 -0
  54. package/dist/link-refs.js.map +1 -0
  55. package/dist/link-refs.test.d.ts +2 -0
  56. package/dist/link-refs.test.d.ts.map +1 -0
  57. package/dist/link-refs.test.js +76 -0
  58. package/dist/link-refs.test.js.map +1 -0
  59. package/dist/manifest-storage-layout.d.ts +6 -0
  60. package/dist/manifest-storage-layout.d.ts.map +1 -0
  61. package/dist/manifest-storage-layout.js +95 -0
  62. package/dist/manifest-storage-layout.js.map +1 -0
  63. package/dist/manifest-storage-layout.test.d.ts +2 -0
  64. package/dist/manifest-storage-layout.test.d.ts.map +1 -0
  65. package/dist/manifest-storage-layout.test.js +105 -0
  66. package/dist/manifest-storage-layout.test.js.map +1 -0
  67. package/dist/manifest.d.ts +36 -0
  68. package/dist/manifest.d.ts.map +1 -0
  69. package/dist/manifest.js +154 -0
  70. package/dist/manifest.js.map +1 -0
  71. package/dist/manifest.test.d.ts +2 -0
  72. package/dist/manifest.test.d.ts.map +1 -0
  73. package/dist/manifest.test.js +17 -0
  74. package/dist/manifest.test.js.map +1 -0
  75. package/dist/provider.d.ts +37 -0
  76. package/dist/provider.d.ts.map +1 -0
  77. package/dist/provider.js +74 -0
  78. package/dist/provider.js.map +1 -0
  79. package/dist/provider.test.d.ts +2 -0
  80. package/dist/provider.test.d.ts.map +1 -0
  81. package/dist/provider.test.js +41 -0
  82. package/dist/provider.test.js.map +1 -0
  83. package/dist/scripts/migrate-oz-cli-project.d.ts +108 -0
  84. package/dist/scripts/migrate-oz-cli-project.d.ts.map +1 -0
  85. package/dist/scripts/migrate-oz-cli-project.js +321 -0
  86. package/dist/scripts/migrate-oz-cli-project.js.map +1 -0
  87. package/dist/scripts/migrate-oz-cli-project.test.d.ts +2 -0
  88. package/dist/scripts/migrate-oz-cli-project.test.d.ts.map +1 -0
  89. package/dist/scripts/migrate-oz-cli-project.test.js +60 -0
  90. package/dist/scripts/migrate-oz-cli-project.test.js.map +1 -0
  91. package/dist/set-proxy-kind.d.ts +5 -0
  92. package/dist/set-proxy-kind.d.ts.map +1 -0
  93. package/dist/set-proxy-kind.js +25 -0
  94. package/dist/set-proxy-kind.js.map +1 -0
  95. package/dist/solc-api.d.ts +39 -0
  96. package/dist/solc-api.d.ts.map +1 -0
  97. package/dist/solc-api.js +3 -0
  98. package/dist/solc-api.js.map +1 -0
  99. package/dist/src-decoder.d.ts +6 -0
  100. package/dist/src-decoder.d.ts.map +1 -0
  101. package/dist/src-decoder.js +36 -0
  102. package/dist/src-decoder.js.map +1 -0
  103. package/dist/src-decoder.test.d.ts +2 -0
  104. package/dist/src-decoder.test.d.ts.map +1 -0
  105. package/dist/src-decoder.test.js +29 -0
  106. package/dist/src-decoder.test.js.map +1 -0
  107. package/dist/storage/compare.d.ts +55 -0
  108. package/dist/storage/compare.d.ts.map +1 -0
  109. package/dist/storage/compare.js +181 -0
  110. package/dist/storage/compare.js.map +1 -0
  111. package/dist/storage/compat.d.ts +4 -0
  112. package/dist/storage/compat.d.ts.map +1 -0
  113. package/dist/storage/compat.js +9 -0
  114. package/dist/storage/compat.js.map +1 -0
  115. package/dist/storage/extract.d.ts +7 -0
  116. package/dist/storage/extract.d.ts.map +1 -0
  117. package/dist/storage/extract.js +86 -0
  118. package/dist/storage/extract.js.map +1 -0
  119. package/dist/storage/index.d.ts +8 -0
  120. package/dist/storage/index.d.ts.map +1 -0
  121. package/dist/storage/index.js +65 -0
  122. package/dist/storage/index.js.map +1 -0
  123. package/dist/storage/layout.d.ts +31 -0
  124. package/dist/storage/layout.d.ts.map +1 -0
  125. package/dist/storage/layout.js +46 -0
  126. package/dist/storage/layout.js.map +1 -0
  127. package/dist/storage/report.d.ts +8 -0
  128. package/dist/storage/report.d.ts.map +1 -0
  129. package/dist/storage/report.js +175 -0
  130. package/dist/storage/report.js.map +1 -0
  131. package/dist/storage/report.test.d.ts +2 -0
  132. package/dist/storage/report.test.d.ts.map +1 -0
  133. package/dist/storage/report.test.js +82 -0
  134. package/dist/storage/report.test.js.map +1 -0
  135. package/dist/storage.test.d.ts +2 -0
  136. package/dist/storage.test.d.ts.map +1 -0
  137. package/dist/storage.test.js +436 -0
  138. package/dist/storage.test.js.map +1 -0
  139. package/dist/stub-provider.d.ts +14 -0
  140. package/dist/stub-provider.d.ts.map +1 -0
  141. package/dist/stub-provider.js +128 -0
  142. package/dist/stub-provider.js.map +1 -0
  143. package/dist/utils/assert.d.ts +3 -0
  144. package/dist/utils/assert.d.ts.map +1 -0
  145. package/dist/utils/assert.js +14 -0
  146. package/dist/utils/assert.js.map +1 -0
  147. package/dist/utils/curry.d.ts +6 -0
  148. package/dist/utils/curry.d.ts.map +1 -0
  149. package/dist/utils/curry.js +16 -0
  150. package/dist/utils/curry.js.map +1 -0
  151. package/dist/utils/debug.d.ts +4 -0
  152. package/dist/utils/debug.d.ts.map +1 -0
  153. package/dist/utils/debug.js +8 -0
  154. package/dist/utils/debug.js.map +1 -0
  155. package/dist/utils/deep-array.d.ts +3 -0
  156. package/dist/utils/deep-array.d.ts.map +1 -0
  157. package/dist/utils/deep-array.js +13 -0
  158. package/dist/utils/deep-array.js.map +1 -0
  159. package/dist/utils/deep-array.test.d.ts +2 -0
  160. package/dist/utils/deep-array.test.d.ts.map +1 -0
  161. package/dist/utils/deep-array.test.js +23 -0
  162. package/dist/utils/deep-array.test.js.map +1 -0
  163. package/dist/utils/function.d.ts +4 -0
  164. package/dist/utils/function.d.ts.map +1 -0
  165. package/dist/utils/function.js +43 -0
  166. package/dist/utils/function.js.map +1 -0
  167. package/dist/utils/function.test.d.ts +2 -0
  168. package/dist/utils/function.test.d.ts.map +1 -0
  169. package/dist/utils/function.test.js +34 -0
  170. package/dist/utils/function.test.js.map +1 -0
  171. package/dist/utils/indent.d.ts +2 -0
  172. package/dist/utils/indent.d.ts.map +1 -0
  173. package/dist/utils/indent.js +8 -0
  174. package/dist/utils/indent.js.map +1 -0
  175. package/dist/utils/is-nullish.d.ts +2 -0
  176. package/dist/utils/is-nullish.d.ts.map +1 -0
  177. package/dist/utils/is-nullish.js +8 -0
  178. package/dist/utils/is-nullish.js.map +1 -0
  179. package/dist/utils/is-nullish.test.d.ts +2 -0
  180. package/dist/utils/is-nullish.test.d.ts.map +1 -0
  181. package/dist/utils/is-nullish.test.js +17 -0
  182. package/dist/utils/is-nullish.test.js.map +1 -0
  183. package/dist/utils/is-value-type.d.ts +3 -0
  184. package/dist/utils/is-value-type.d.ts.map +1 -0
  185. package/dist/utils/is-value-type.js +8 -0
  186. package/dist/utils/is-value-type.js.map +1 -0
  187. package/dist/utils/itemize.d.ts +3 -0
  188. package/dist/utils/itemize.d.ts.map +1 -0
  189. package/dist/utils/itemize.js +18 -0
  190. package/dist/utils/itemize.js.map +1 -0
  191. package/dist/utils/log.d.ts +4 -0
  192. package/dist/utils/log.d.ts.map +1 -0
  193. package/dist/utils/log.js +35 -0
  194. package/dist/utils/log.js.map +1 -0
  195. package/dist/utils/make-non-enumerable.d.ts +2 -0
  196. package/dist/utils/make-non-enumerable.d.ts.map +1 -0
  197. package/dist/utils/make-non-enumerable.js +9 -0
  198. package/dist/utils/make-non-enumerable.js.map +1 -0
  199. package/dist/utils/map-values.d.ts +2 -0
  200. package/dist/utils/map-values.d.ts.map +1 -0
  201. package/dist/utils/map-values.js +12 -0
  202. package/dist/utils/map-values.js.map +1 -0
  203. package/dist/utils/parse-type-id.d.ts +9 -0
  204. package/dist/utils/parse-type-id.d.ts.map +1 -0
  205. package/dist/utils/parse-type-id.js +92 -0
  206. package/dist/utils/parse-type-id.js.map +1 -0
  207. package/dist/utils/parse-type-id.test.d.ts +2 -0
  208. package/dist/utils/parse-type-id.test.d.ts.map +1 -0
  209. package/dist/utils/parse-type-id.test.js +25 -0
  210. package/dist/utils/parse-type-id.test.js.map +1 -0
  211. package/dist/utils/pick.d.ts +2 -0
  212. package/dist/utils/pick.d.ts.map +1 -0
  213. package/dist/utils/pick.js +12 -0
  214. package/dist/utils/pick.js.map +1 -0
  215. package/dist/utils/type-id.d.ts +4 -0
  216. package/dist/utils/type-id.d.ts.map +1 -0
  217. package/dist/utils/type-id.js +65 -0
  218. package/dist/utils/type-id.js.map +1 -0
  219. package/dist/validate/compat.d.ts +6 -0
  220. package/dist/validate/compat.d.ts.map +1 -0
  221. package/dist/validate/compat.js +4 -0
  222. package/dist/validate/compat.js.map +1 -0
  223. package/dist/validate/data.d.ts +14 -0
  224. package/dist/validate/data.d.ts.map +1 -0
  225. package/dist/validate/data.js +50 -0
  226. package/dist/validate/data.js.map +1 -0
  227. package/dist/validate/error.d.ts +7 -0
  228. package/dist/validate/error.d.ts.map +1 -0
  229. package/dist/validate/error.js +78 -0
  230. package/dist/validate/error.js.map +1 -0
  231. package/dist/validate/index.d.ts +8 -0
  232. package/dist/validate/index.d.ts.map +1 -0
  233. package/dist/validate/index.js +24 -0
  234. package/dist/validate/index.js.map +1 -0
  235. package/dist/validate/overrides.d.ts +14 -0
  236. package/dist/validate/overrides.d.ts.map +1 -0
  237. package/dist/validate/overrides.js +72 -0
  238. package/dist/validate/overrides.js.map +1 -0
  239. package/dist/validate/query.d.ts +15 -0
  240. package/dist/validate/query.d.ts.map +1 -0
  241. package/dist/validate/query.js +111 -0
  242. package/dist/validate/query.js.map +1 -0
  243. package/dist/validate/query.test.d.ts +2 -0
  244. package/dist/validate/query.test.d.ts.map +1 -0
  245. package/dist/validate/query.test.js +48 -0
  246. package/dist/validate/query.test.js.map +1 -0
  247. package/dist/validate/run.d.ts +39 -0
  248. package/dist/validate/run.d.ts.map +1 -0
  249. package/dist/validate/run.js +199 -0
  250. package/dist/validate/run.js.map +1 -0
  251. package/dist/validate.test.d.ts +2 -0
  252. package/dist/validate.test.d.ts.map +1 -0
  253. package/dist/validate.test.js +116 -0
  254. package/dist/validate.test.js.map +1 -0
  255. package/dist/version.d.ts +9 -0
  256. package/dist/version.d.ts.map +1 -0
  257. package/dist/version.js +66 -0
  258. package/dist/version.js.map +1 -0
  259. package/dist/version.test.d.ts +2 -0
  260. package/dist/version.test.d.ts.map +1 -0
  261. package/dist/version.test.js +53 -0
  262. package/dist/version.test.js.map +1 -0
  263. package/package.json +58 -0
  264. package/src/ast-dereferencer.ts +42 -0
  265. package/src/deployment.test.ts +98 -0
  266. package/src/deployment.ts +122 -0
  267. package/src/eip-1967.ts +77 -0
  268. package/src/error.ts +26 -0
  269. package/src/impl-store.test.ts +59 -0
  270. package/src/impl-store.ts +124 -0
  271. package/src/index.ts +18 -0
  272. package/src/levenshtein.test.ts +91 -0
  273. package/src/levenshtein.ts +116 -0
  274. package/src/link-refs.test.ts +77 -0
  275. package/src/link-refs.ts +41 -0
  276. package/src/manifest-storage-layout.test.ts +118 -0
  277. package/src/manifest-storage-layout.ts +107 -0
  278. package/src/manifest.test.ts +13 -0
  279. package/src/manifest.ts +178 -0
  280. package/src/provider.test.ts +43 -0
  281. package/src/provider.ts +103 -0
  282. package/src/scripts/migratable-manifest.test.json +175 -0
  283. package/src/scripts/migrate-oz-cli-project.test.ts +70 -0
  284. package/src/scripts/migrate-oz-cli-project.test.ts.md +146 -0
  285. package/src/scripts/migrate-oz-cli-project.test.ts.snap +0 -0
  286. package/src/scripts/migrate-oz-cli-project.ts +484 -0
  287. package/src/scripts/project-file.test.json +25 -0
  288. package/src/set-proxy-kind.ts +27 -0
  289. package/src/solc-api.ts +42 -0
  290. package/src/src-decoder.test.ts +30 -0
  291. package/src/src-decoder.ts +37 -0
  292. package/src/storage/compare.ts +249 -0
  293. package/src/storage/compat.ts +3 -0
  294. package/src/storage/extract.ts +110 -0
  295. package/src/storage/index.ts +73 -0
  296. package/src/storage/layout.ts +88 -0
  297. package/src/storage/report.test.ts +95 -0
  298. package/src/storage/report.test.ts.md +154 -0
  299. package/src/storage/report.test.ts.snap +0 -0
  300. package/src/storage/report.ts +215 -0
  301. package/src/storage.test.ts +479 -0
  302. package/src/storage.test.ts.md +643 -0
  303. package/src/storage.test.ts.snap +0 -0
  304. package/src/stub-provider.ts +120 -0
  305. package/src/utils/assert.ts +9 -0
  306. package/src/utils/curry.ts +17 -0
  307. package/src/utils/debug.ts +3 -0
  308. package/src/utils/deep-array.test.ts +21 -0
  309. package/src/utils/deep-array.ts +9 -0
  310. package/src/utils/function.test.ts +37 -0
  311. package/src/utils/function.ts +53 -0
  312. package/src/utils/indent.ts +3 -0
  313. package/src/utils/is-nullish.test.ts +15 -0
  314. package/src/utils/is-nullish.ts +3 -0
  315. package/src/utils/is-value-type.ts +5 -0
  316. package/src/utils/itemize.ts +16 -0
  317. package/src/utils/log.ts +34 -0
  318. package/src/utils/make-non-enumerable.ts +4 -0
  319. package/src/utils/map-values.ts +7 -0
  320. package/src/utils/parse-type-id.test.ts +22 -0
  321. package/src/utils/parse-type-id.test.ts.md +264 -0
  322. package/src/utils/parse-type-id.test.ts.snap +0 -0
  323. package/src/utils/parse-type-id.ts +104 -0
  324. package/src/utils/pick.ts +7 -0
  325. package/src/utils/type-id.ts +57 -0
  326. package/src/validate/compat.ts +9 -0
  327. package/src/validate/data.ts +55 -0
  328. package/src/validate/error.ts +75 -0
  329. package/src/validate/index.ts +17 -0
  330. package/src/validate/overrides.ts +93 -0
  331. package/src/validate/query.test.ts +48 -0
  332. package/src/validate/query.ts +127 -0
  333. package/src/validate/run.ts +278 -0
  334. package/src/validate.test.ts +133 -0
  335. package/src/version.test.ts +59 -0
  336. package/src/version.ts +71 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"extract.js","sourceRoot":"","sources":["../../src/storage/extract.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAE5B,8CAAyD;AAGzD,8CAA2D;AAI3D,MAAM,oBAAoB,GAAG,KAAK,CAAC;AAEnC,SAAgB,sBAAsB,CAAC,MAAqB;IAC1D,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,aAAa,MAAK,oBAAoB,CAAC;AACxD,CAAC;AAFD,wDAEC;AAED,SAAgB,oBAAoB,CAClC,WAA+B,EAC/B,SAAqB,EACrB,KAAsB;IAEtB,MAAM,MAAM,GAAkB,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,aAAa,EAAE,oBAAoB,EAAE,CAAC;IAE9F,oGAAoG;IACpG,MAAM,oBAAoB,GAAG,KAAK,CAAC,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAE3E,KAAK,MAAM,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE;QACvC,IAAI,kBAAU,CAAC,qBAAqB,EAAE,OAAO,CAAC,EAAE;YAC9C,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,UAAU,KAAK,WAAW,EAAE;gBAC3D,MAAM,IAAI,GAAG,iCAAuB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,CAAC;gBAE/E,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;oBAClB,QAAQ,EAAE,WAAW,CAAC,IAAI;oBAC1B,KAAK,EAAE,OAAO,CAAC,IAAI;oBACnB,IAAI;oBACJ,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC;iBACxB,CAAC,CAAC;gBAEH,gBAAM,CAAC,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,CAAC;gBAEjC,4GAA4G;gBAC5G,+GAA+G;gBAC/G,0CAA0C;gBAC1C,MAAM,SAAS,GAAG,IAAI,GAAG,CACvB,CAAC,GAAG,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CACvF,CAAC;gBAEF,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,MAAM,EAAE,EAAE;oBACzC,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;oBAEzE,MAAM,IAAI,GAAG,iCAAuB,CAAC,cAAc,CAAC,CAAC;oBAErD,IAAI,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE;wBACxB,SAAS;qBACV;oBAED,IAAI,OAAO,CAAC;oBAEZ,IAAI,uBAAuB,IAAI,QAAQ,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;wBACtE,MAAM,OAAO,GAAG,oBAAoB,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;wBACrE,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;wBAClC,0FAA0F;wBAC1F,KAAK,MAAM,QAAQ,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE;4BAC7C,MAAM,EAAE,cAAc,EAAE,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;4BACtD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE;gCAClC,SAAS,CAAC,GAAG,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;6BACzC;yBACF;qBACF;oBAED,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;iBACzC;aACF;SACF;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AA7DD,oDA6DC;AAED,MAAM,aAAa,GAAG,eAAO,CAAC;IAC5B,eAAe;IACf,oBAAoB;IACpB,kBAAkB;IAClB,SAAS;IACT,qBAAqB;CACtB,CAAC,CAAC;AAOH,SAAS,gBAAgB,CAAC,CAAyC;IACjE,gBAAM,CAAC,OAAO,CAAC,CAAC,gBAAgB,CAAC,cAAc,KAAK,QAAQ,CAAC,CAAC;IAC9D,gBAAM,CAAC,OAAO,CAAC,CAAC,gBAAgB,CAAC,UAAU,KAAK,QAAQ,CAAC,CAAC;IAC1D,OAAO,CAAC,CAAC,gBAA4C,CAAC;AACxD,CAAC;AAED,SAAS,cAAc,CAAC,OAA0C;IAChE,IAAI,OAAO,CAAC,QAAQ,KAAK,kBAAkB,EAAE;QAC3C,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YAC7B,gBAAM,CAAC,OAAO,CAAC,CAAC,gBAAgB,CAAC,cAAc,KAAK,QAAQ,CAAC,CAAC;YAC9D,OAAO;gBACL,KAAK,EAAE,CAAC,CAAC,IAAI;gBACb,IAAI,EAAE,iCAAuB,CAAC,CAAC,CAAC,gBAAgB,CAAC,cAAc,CAAC;aACjE,CAAC;QACJ,CAAC,CAAC,CAAC;KACJ;SAAM;QACL,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;KACzC;AACH,CAAC"}
@@ -0,0 +1,8 @@
1
+ export * from './compat';
2
+ import { StorageLayout } from './layout';
3
+ import { StorageOperation, StorageItem } from './compare';
4
+ import { ValidationOptions } from '../validate/overrides';
5
+ export declare function assertStorageUpgradeSafe(original: StorageLayout, updated: StorageLayout, unsafeAllowCustomTypes: boolean): void;
6
+ export declare function assertStorageUpgradeSafe(original: StorageLayout, updated: StorageLayout, opts: Required<ValidationOptions>): void;
7
+ export declare function getStorageUpgradeErrors(original: StorageLayout, updated: StorageLayout, opts?: ValidationOptions): StorageOperation<StorageItem>[];
8
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/storage/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AAGzB,OAAO,EAAE,aAAa,EAAqB,MAAM,UAAU,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAA2B,MAAM,WAAW,CAAC;AAEnF,OAAO,EAAE,iBAAiB,EAA0B,MAAM,uBAAuB,CAAC;AAGlF,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,aAAa,EACvB,OAAO,EAAE,aAAa,EACtB,sBAAsB,EAAE,OAAO,GAC9B,IAAI,CAAC;AAER,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,aAAa,EACvB,OAAO,EAAE,aAAa,EACtB,IAAI,EAAE,QAAQ,CAAC,iBAAiB,CAAC,GAChC,IAAI,CAAC;AAsCR,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,aAAa,EACvB,OAAO,EAAE,aAAa,EACtB,IAAI,GAAE,iBAAsB,GAC3B,gBAAgB,CAAC,WAAW,CAAC,EAAE,CAWjC"}
@@ -0,0 +1,65 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
5
+ }) : (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ o[k2] = m[k];
8
+ }));
9
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
10
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
11
+ };
12
+ Object.defineProperty(exports, "__esModule", { value: true });
13
+ exports.getStorageUpgradeErrors = exports.assertStorageUpgradeSafe = void 0;
14
+ __exportStar(require("./compat"), exports);
15
+ const error_1 = require("../error");
16
+ const layout_1 = require("./layout");
17
+ const compare_1 = require("./compare");
18
+ const overrides_1 = require("../validate/overrides");
19
+ const log_1 = require("../utils/log");
20
+ function assertStorageUpgradeSafe(original, updated, opts = false) {
21
+ if (typeof opts === 'boolean') {
22
+ const unsafeAllowCustomTypes = opts;
23
+ opts = overrides_1.withValidationDefaults({ unsafeAllowCustomTypes });
24
+ }
25
+ const originalDetailed = layout_1.getDetailedLayout(original);
26
+ const updatedDetailed = layout_1.getDetailedLayout(updated);
27
+ const comparator = new compare_1.StorageLayoutComparator(opts.unsafeAllowCustomTypes, opts.unsafeAllowRenames);
28
+ const report = comparator.compareLayouts(originalDetailed, updatedDetailed);
29
+ if (comparator.hasAllowedUncheckedCustomTypes) {
30
+ log_1.logWarning(`Potentially unsafe deployment`, [
31
+ `You are using \`unsafeAllowCustomTypes\` to force approve structs or enums with missing data.`,
32
+ `Make sure you have manually checked the storage layout for incompatibilities.`,
33
+ ]);
34
+ }
35
+ else if (opts.unsafeAllowCustomTypes) {
36
+ log_1.logNote(`\`unsafeAllowCustomTypes\` is no longer necessary. Structs are enums are automatically checked.\n`);
37
+ }
38
+ if (!report.pass) {
39
+ throw new StorageUpgradeErrors(report);
40
+ }
41
+ }
42
+ exports.assertStorageUpgradeSafe = assertStorageUpgradeSafe;
43
+ class StorageUpgradeErrors extends error_1.UpgradesError {
44
+ constructor(report) {
45
+ super(`New storage layout is incompatible`, () => report.explain());
46
+ this.report = report;
47
+ }
48
+ }
49
+ // Kept for backwards compatibility and to avoid rewriting tests
50
+ function getStorageUpgradeErrors(original, updated, opts = {}) {
51
+ try {
52
+ assertStorageUpgradeSafe(original, updated, overrides_1.withValidationDefaults(opts));
53
+ }
54
+ catch (e) {
55
+ if (e instanceof StorageUpgradeErrors) {
56
+ return e.report.ops;
57
+ }
58
+ else {
59
+ throw e;
60
+ }
61
+ }
62
+ return [];
63
+ }
64
+ exports.getStorageUpgradeErrors = getStorageUpgradeErrors;
65
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/storage/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,2CAAyB;AAEzB,oCAAyC;AACzC,qCAA4D;AAC5D,uCAAmF;AAEnF,qDAAkF;AAClF,sCAAmD;AAcnD,SAAgB,wBAAwB,CACtC,QAAuB,EACvB,OAAsB,EACtB,OAA8C,KAAK;IAEnD,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE;QAC7B,MAAM,sBAAsB,GAAG,IAAI,CAAC;QACpC,IAAI,GAAG,kCAAsB,CAAC,EAAE,sBAAsB,EAAE,CAAC,CAAC;KAC3D;IAED,MAAM,gBAAgB,GAAG,0BAAiB,CAAC,QAAQ,CAAC,CAAC;IACrD,MAAM,eAAe,GAAG,0BAAiB,CAAC,OAAO,CAAC,CAAC;IACnD,MAAM,UAAU,GAAG,IAAI,iCAAuB,CAAC,IAAI,CAAC,sBAAsB,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;IACrG,MAAM,MAAM,GAAG,UAAU,CAAC,cAAc,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC;IAE5E,IAAI,UAAU,CAAC,8BAA8B,EAAE;QAC7C,gBAAU,CAAC,+BAA+B,EAAE;YAC1C,+FAA+F;YAC/F,+EAA+E;SAChF,CAAC,CAAC;KACJ;SAAM,IAAI,IAAI,CAAC,sBAAsB,EAAE;QACtC,aAAO,CAAC,mGAAmG,CAAC,CAAC;KAC9G;IAED,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;QAChB,MAAM,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAC;KACxC;AACH,CAAC;AA3BD,4DA2BC;AAED,MAAM,oBAAqB,SAAQ,qBAAa;IAC9C,YAAqB,MAAiC;QACpD,KAAK,CAAC,oCAAoC,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;QADjD,WAAM,GAAN,MAAM,CAA2B;IAEtD,CAAC;CACF;AAED,gEAAgE;AAChE,SAAgB,uBAAuB,CACrC,QAAuB,EACvB,OAAsB,EACtB,OAA0B,EAAE;IAE5B,IAAI;QACF,wBAAwB,CAAC,QAAQ,EAAE,OAAO,EAAE,kCAAsB,CAAC,IAAI,CAAC,CAAC,CAAC;KAC3E;IAAC,OAAO,CAAC,EAAE;QACV,IAAI,CAAC,YAAY,oBAAoB,EAAE;YACrC,OAAO,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;SACrB;aAAM;YACL,MAAM,CAAC,CAAC;SACT;KACF;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAfD,0DAeC"}
@@ -0,0 +1,31 @@
1
+ import { ParsedTypeId } from '../utils/parse-type-id';
2
+ export interface StorageLayout {
3
+ layoutVersion?: string;
4
+ storage: StorageItem[];
5
+ types: Record<string, TypeItem>;
6
+ }
7
+ export interface StorageItem<Type = string> {
8
+ contract: string;
9
+ label: string;
10
+ type: Type;
11
+ src: string;
12
+ }
13
+ export interface TypeItem<Type = string> {
14
+ label: string;
15
+ members?: TypeItemMembers<Type>;
16
+ }
17
+ export declare type TypeItemMembers<Type = string> = StructMember<Type>[] | EnumMember[];
18
+ export interface StructMember<Type = string> {
19
+ label: string;
20
+ type: Type;
21
+ }
22
+ export declare type EnumMember = string;
23
+ export interface ParsedTypeDetailed extends ParsedTypeId {
24
+ item: TypeItem<ParsedTypeDetailed>;
25
+ args?: ParsedTypeDetailed[];
26
+ rets?: ParsedTypeDetailed[];
27
+ }
28
+ export declare function getDetailedLayout(layout: StorageLayout): StorageItem<ParsedTypeDetailed>[];
29
+ export declare function isEnumMembers<T>(members: TypeItemMembers<T>): members is EnumMember[];
30
+ export declare function isStructMembers<T>(members: TypeItemMembers<T>): members is StructMember<T>[];
31
+ //# sourceMappingURL=layout.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"layout.d.ts","sourceRoot":"","sources":["../../src/storage/layout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAOnE,MAAM,WAAW,aAAa;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,WAAW,CAAC,IAAI,GAAG,MAAM;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,IAAI,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,QAAQ,CAAC,IAAI,GAAG,MAAM;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;CACjC;AAED,oBAAY,eAAe,CAAC,IAAI,GAAG,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC;AAEjF,MAAM,WAAW,YAAY,CAAC,IAAI,GAAG,MAAM;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,oBAAY,UAAU,GAAG,MAAM,CAAC;AAEhC,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,IAAI,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IACnC,IAAI,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC5B,IAAI,CAAC,EAAE,kBAAkB,EAAE,CAAC;CAC7B;AAID,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,aAAa,GAAG,WAAW,CAAC,kBAAkB,CAAC,EAAE,CAqC1F;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,UAAU,EAAE,CAErF;AAED,wBAAgB,eAAe,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,YAAY,CAAC,CAAC,CAAC,EAAE,CAE5F"}
@@ -0,0 +1,46 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.isStructMembers = exports.isEnumMembers = exports.getDetailedLayout = void 0;
4
+ const parse_type_id_1 = require("../utils/parse-type-id");
5
+ function getDetailedLayout(layout) {
6
+ const cache = {};
7
+ return layout.storage.map(parseWithDetails);
8
+ function parseWithDetails(item) {
9
+ const parsed = parse_type_id_1.parseTypeId(item.type);
10
+ const withDetails = addDetailsToParsedType(parsed);
11
+ return { ...item, type: withDetails };
12
+ }
13
+ function addDetailsToParsedType(parsed) {
14
+ var _a, _b;
15
+ if (parsed.id in cache) {
16
+ return cache[parsed.id];
17
+ }
18
+ const item = layout.types[parsed.id];
19
+ const detailed = {
20
+ ...parsed,
21
+ args: undefined,
22
+ rets: undefined,
23
+ item: {
24
+ ...item,
25
+ members: undefined,
26
+ },
27
+ };
28
+ // store in cache before recursion below
29
+ cache[parsed.id] = detailed;
30
+ detailed.args = (_a = parsed.args) === null || _a === void 0 ? void 0 : _a.map(addDetailsToParsedType);
31
+ detailed.rets = (_b = parsed.args) === null || _b === void 0 ? void 0 : _b.map(addDetailsToParsedType);
32
+ detailed.item.members =
33
+ (item === null || item === void 0 ? void 0 : item.members) && (isStructMembers(item === null || item === void 0 ? void 0 : item.members) ? item.members.map(parseWithDetails) : item === null || item === void 0 ? void 0 : item.members);
34
+ return detailed;
35
+ }
36
+ }
37
+ exports.getDetailedLayout = getDetailedLayout;
38
+ function isEnumMembers(members) {
39
+ return members.length === 0 || typeof members[0] === 'string';
40
+ }
41
+ exports.isEnumMembers = isEnumMembers;
42
+ function isStructMembers(members) {
43
+ return members.length === 0 || typeof members[0] === 'object';
44
+ }
45
+ exports.isStructMembers = isStructMembers;
46
+ //# sourceMappingURL=layout.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"layout.js","sourceRoot":"","sources":["../../src/storage/layout.ts"],"names":[],"mappings":";;;AAAA,0DAAmE;AA0CnE,SAAgB,iBAAiB,CAAC,MAAqB;IACrD,MAAM,KAAK,GAAuC,EAAE,CAAC;IAErD,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAE5C,SAAS,gBAAgB,CAA6B,IAAO;QAC3D,MAAM,MAAM,GAAG,2BAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,WAAW,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;QACnD,OAAO,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;IACxC,CAAC;IAED,SAAS,sBAAsB,CAAC,MAAoB;;QAClD,IAAI,MAAM,CAAC,EAAE,IAAI,KAAK,EAAE;YACtB,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SACzB;QAED,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAuB;YACnC,GAAG,MAAM;YACT,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,SAAS;YACf,IAAI,EAAE;gBACJ,GAAG,IAAI;gBACP,OAAO,EAAE,SAAS;aACnB;SACF,CAAC;QAEF,wCAAwC;QACxC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC;QAE5B,QAAQ,CAAC,IAAI,GAAG,MAAA,MAAM,CAAC,IAAI,0CAAE,GAAG,CAAC,sBAAsB,CAAC,CAAC;QACzD,QAAQ,CAAC,IAAI,GAAG,MAAA,MAAM,CAAC,IAAI,0CAAE,GAAG,CAAC,sBAAsB,CAAC,CAAC;QACzD,QAAQ,CAAC,IAAI,CAAC,OAAO;YACnB,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,KAAI,CAAC,eAAe,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,CAAC,CAAC;QAEzG,OAAO,QAAQ,CAAC;IAClB,CAAC;AACH,CAAC;AArCD,8CAqCC;AAED,SAAgB,aAAa,CAAI,OAA2B;IAC1D,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,OAAO,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC;AAChE,CAAC;AAFD,sCAEC;AAED,SAAgB,eAAe,CAAI,OAA2B;IAC5D,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,OAAO,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC;AAChE,CAAC;AAFD,0CAEC"}
@@ -0,0 +1,8 @@
1
+ import type { StorageOperation, StorageItem } from './compare';
2
+ export declare class LayoutCompatibilityReport {
3
+ readonly ops: StorageOperation<StorageItem>[];
4
+ readonly pass: boolean;
5
+ constructor(ops: StorageOperation<StorageItem>[]);
6
+ explain(): string;
7
+ }
8
+ //# sourceMappingURL=report.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../../src/storage/report.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAA2C,MAAM,WAAW,CAAC;AAKxG,qBAAa,yBAAyB;IAGxB,QAAQ,CAAC,GAAG,EAAE,gBAAgB,CAAC,WAAW,CAAC,EAAE;IAFzD,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;gBAEF,GAAG,EAAE,gBAAgB,CAAC,WAAW,CAAC,EAAE;IAIzD,OAAO,IAAI,MAAM;CAYlB"}
@@ -0,0 +1,175 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.LayoutCompatibilityReport = void 0;
7
+ const chalk_1 = __importDefault(require("chalk"));
8
+ const itemize_1 = require("../utils/itemize");
9
+ const indent_1 = require("../utils/indent");
10
+ const assert_1 = require("../utils/assert");
11
+ class LayoutCompatibilityReport {
12
+ constructor(ops) {
13
+ this.ops = ops;
14
+ this.pass = ops.length === 0;
15
+ }
16
+ explain() {
17
+ const res = [];
18
+ for (const op of this.ops) {
19
+ const src = 'updated' in op ? op.updated.src : op.original.contract;
20
+ res.push(chalk_1.default.bold(src) + ':' + indent_1.indent(explainStorageOperation(op, { kind: 'layout', allowAppend: true }), 2, 1));
21
+ }
22
+ return res.join('\n\n');
23
+ }
24
+ }
25
+ exports.LayoutCompatibilityReport = LayoutCompatibilityReport;
26
+ function explainStorageOperation(op, ctx) {
27
+ switch (op.kind) {
28
+ case 'typechange': {
29
+ const basic = explainTypeChange(op.change);
30
+ const details = ctx.kind === 'layout' // explain details for layout only
31
+ ? new Set(getAllTypeChanges(op.change)
32
+ .map(explainTypeChangeDetails)
33
+ .filter((d) => d !== undefined))
34
+ : [];
35
+ return `Upgraded ${label(op.updated)} to an incompatible type\n` + itemize_1.itemize(basic, ...details);
36
+ }
37
+ case 'rename':
38
+ return `Renamed ${label(op.original)} to ${label(op.updated)}`;
39
+ case 'replace':
40
+ return `Replaced ${label(op.original)} with ${label(op.updated)} of incompatible type`;
41
+ default: {
42
+ const title = explainBasicOperation(op, t => t.label);
43
+ const hints = [];
44
+ switch (op.kind) {
45
+ case 'insert': {
46
+ if (ctx.kind === 'struct') {
47
+ if (ctx.allowAppend) {
48
+ hints.push('New struct members should be placed after existing ones');
49
+ }
50
+ else {
51
+ hints.push('New struct members are not allowed here. Define a new struct');
52
+ }
53
+ }
54
+ else {
55
+ hints.push('New variables should be placed after all existing inherited variables');
56
+ }
57
+ break;
58
+ }
59
+ case 'delete': {
60
+ hints.push('Keep the variable even if unused');
61
+ break;
62
+ }
63
+ }
64
+ return title + '\n' + itemize_1.itemizeWith('>', ...hints);
65
+ }
66
+ }
67
+ }
68
+ function explainTypeChange(ch) {
69
+ switch (ch.kind) {
70
+ case 'obvious mismatch':
71
+ case 'struct members':
72
+ case 'enum members':
73
+ return `Bad upgrade ${describeTransition(ch.original, ch.updated)}`;
74
+ case 'enum resize':
75
+ return `Bad upgrade ${describeTransition(ch.original, ch.updated)}\nDifferent representation sizes`;
76
+ case 'mapping key':
77
+ return `In key of ${ch.updated.item.label}\n` + itemize_1.itemize(explainTypeChange(ch.inner));
78
+ case 'mapping value':
79
+ case 'array value':
80
+ return `In ${ch.updated.item.label}\n` + itemize_1.itemize(explainTypeChange(ch.inner));
81
+ case 'array shrink':
82
+ case 'array grow': {
83
+ assert_1.assert(ch.original.tail && ch.updated.tail);
84
+ const originalSize = parseInt(ch.original.tail, 10);
85
+ const updatedSize = parseInt(ch.updated.tail, 10);
86
+ const note = ch.kind === 'array shrink' ? 'Size cannot decrease' : 'Size cannot increase here';
87
+ return `Bad array resize from ${originalSize} to ${updatedSize}\n${note}`;
88
+ }
89
+ case 'array dynamic': {
90
+ assert_1.assert(ch.original.tail && ch.updated.tail);
91
+ const [originalSize, updatedSize] = ch.original.tail === 'dyn' ? ['dynamic', 'fixed'] : ['fixed', 'dynamic'];
92
+ return `Bad upgrade from ${originalSize} to ${updatedSize} size array`;
93
+ }
94
+ case 'missing members': {
95
+ const type = ch.updated.head.replace(/^t_/, ''); // t_struct, t_enum -> struct, enum
96
+ return `Insufficient data to compare ${type}s\nManually assess compatibility, then use option \`unsafeAllowCustomTypes: true\``;
97
+ }
98
+ case 'unknown':
99
+ return `Unknown type ${ch.updated.item.label}`;
100
+ }
101
+ }
102
+ function getAllTypeChanges(root) {
103
+ const list = [root];
104
+ for (const ch of list) {
105
+ switch (ch.kind) {
106
+ case 'mapping value':
107
+ case 'array value':
108
+ list.push(ch.inner);
109
+ break;
110
+ case 'struct members': {
111
+ for (const op of ch.ops) {
112
+ if (op.kind === 'typechange') {
113
+ list.push(op.change);
114
+ }
115
+ }
116
+ break;
117
+ }
118
+ // We mention all other kinds explicitly to review any future new kinds
119
+ case 'obvious mismatch':
120
+ case 'enum members':
121
+ case 'enum resize':
122
+ case 'mapping key':
123
+ case 'array shrink':
124
+ case 'array grow':
125
+ case 'array dynamic':
126
+ case 'missing members':
127
+ case 'unknown':
128
+ break;
129
+ }
130
+ }
131
+ return list;
132
+ }
133
+ function explainTypeChangeDetails(ch) {
134
+ switch (ch.kind) {
135
+ case 'struct members': {
136
+ const { allowAppend } = ch;
137
+ return (`In ${ch.updated.item.label}\n` +
138
+ itemize_1.itemize(...ch.ops.map(op => explainStorageOperation(op, { kind: 'struct', allowAppend }))));
139
+ }
140
+ case 'enum members':
141
+ return `In ${ch.updated.item.label}\n` + itemize_1.itemize(...ch.ops.map(explainEnumOperation));
142
+ }
143
+ }
144
+ function explainEnumOperation(op) {
145
+ switch (op.kind) {
146
+ case 'replace':
147
+ return `Replaced \`${op.original}\` with \`${op.updated}\``;
148
+ default:
149
+ return explainBasicOperation(op, t => t);
150
+ }
151
+ }
152
+ function explainBasicOperation(op, getName) {
153
+ switch (op.kind) {
154
+ case 'delete':
155
+ return `Deleted \`${getName(op.original)}\``;
156
+ case 'insert':
157
+ return `Inserted \`${getName(op.updated)}\``;
158
+ case 'append':
159
+ return `Added \`${getName(op.updated)}\``;
160
+ }
161
+ }
162
+ function describeTransition(original, updated) {
163
+ const originalLabel = original.item.label;
164
+ const updatedLabel = updated.item.label;
165
+ if (originalLabel === updatedLabel) {
166
+ return `to ${updatedLabel}`;
167
+ }
168
+ else {
169
+ return `from ${originalLabel} to ${updatedLabel}`;
170
+ }
171
+ }
172
+ function label(variable) {
173
+ return '`' + variable.label + '`';
174
+ }
175
+ //# sourceMappingURL=report.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"report.js","sourceRoot":"","sources":["../../src/storage/report.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAK1B,8CAAwD;AACxD,4CAAyC;AACzC,4CAAyC;AAEzC,MAAa,yBAAyB;IAGpC,YAAqB,GAAoC;QAApC,QAAG,GAAH,GAAG,CAAiC;QACvD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO;QACL,MAAM,GAAG,GAAG,EAAE,CAAC;QAEf,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE;YACzB,MAAM,GAAG,GAAG,SAAS,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACpE,GAAG,CAAC,IAAI,CACN,eAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,eAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CACzG,CAAC;SACH;QAED,OAAO,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;CACF;AAnBD,8DAmBC;AAOD,SAAS,uBAAuB,CAAC,EAAkC,EAAE,GAA4B;IAC/F,QAAQ,EAAE,CAAC,IAAI,EAAE;QACf,KAAK,YAAY,CAAC,CAAC;YACjB,MAAM,KAAK,GAAG,iBAAiB,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;YAC3C,MAAM,OAAO,GACX,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,kCAAkC;gBACtD,CAAC,CAAC,IAAI,GAAG,CACL,iBAAiB,CAAC,EAAE,CAAC,MAAM,CAAC;qBACzB,GAAG,CAAC,wBAAwB,CAAC;qBAC7B,MAAM,CAAC,CAAC,CAAU,EAAe,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CACxD;gBACH,CAAC,CAAC,EAAE,CAAC;YACT,OAAO,YAAY,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,4BAA4B,GAAG,iBAAO,CAAC,KAAK,EAAE,GAAG,OAAO,CAAC,CAAC;SAC/F;QAED,KAAK,QAAQ;YACX,OAAO,WAAW,KAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;QAEjE,KAAK,SAAS;YACZ,OAAO,YAAY,KAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,uBAAuB,CAAC;QAEzF,OAAO,CAAC,CAAC;YACP,MAAM,KAAK,GAAG,qBAAqB,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YACtD,MAAM,KAAK,GAAG,EAAE,CAAC;YAEjB,QAAQ,EAAE,CAAC,IAAI,EAAE;gBACf,KAAK,QAAQ,CAAC,CAAC;oBACb,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE;wBACzB,IAAI,GAAG,CAAC,WAAW,EAAE;4BACnB,KAAK,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;yBACvE;6BAAM;4BACL,KAAK,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;yBAC5E;qBACF;yBAAM;wBACL,KAAK,CAAC,IAAI,CAAC,uEAAuE,CAAC,CAAC;qBACrF;oBACD,MAAM;iBACP;gBAED,KAAK,QAAQ,CAAC,CAAC;oBACb,KAAK,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;oBAC/C,MAAM;iBACP;aACF;YAED,OAAO,KAAK,GAAG,IAAI,GAAG,qBAAW,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC;SAClD;KACF;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,EAAc;IACvC,QAAQ,EAAE,CAAC,IAAI,EAAE;QACf,KAAK,kBAAkB,CAAC;QACxB,KAAK,gBAAgB,CAAC;QACtB,KAAK,cAAc;YACjB,OAAO,eAAe,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;QAEtE,KAAK,aAAa;YAChB,OAAO,eAAe,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,kCAAkC,CAAC;QAEtG,KAAK,aAAa;YAChB,OAAO,aAAa,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,GAAG,iBAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAEvF,KAAK,eAAe,CAAC;QACrB,KAAK,aAAa;YAChB,OAAO,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,GAAG,iBAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAEhF,KAAK,cAAc,CAAC;QACpB,KAAK,YAAY,CAAC,CAAC;YACjB,eAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC5C,MAAM,YAAY,GAAG,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACpD,MAAM,WAAW,GAAG,QAAQ,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAClD,MAAM,IAAI,GAAG,EAAE,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,2BAA2B,CAAC;YAC/F,OAAO,yBAAyB,YAAY,OAAO,WAAW,KAAK,IAAI,EAAE,CAAC;SAC3E;QAED,KAAK,eAAe,CAAC,CAAC;YACpB,eAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC5C,MAAM,CAAC,YAAY,EAAE,WAAW,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAC7G,OAAO,oBAAoB,YAAY,OAAO,WAAW,aAAa,CAAC;SACxE;QAED,KAAK,iBAAiB,CAAC,CAAC;YACtB,MAAM,IAAI,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,mCAAmC;YACpF,OAAO,gCAAgC,IAAI,oFAAoF,CAAC;SACjI;QAED,KAAK,SAAS;YACZ,OAAO,gBAAgB,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;KAClD;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAgB;IACzC,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;IAEpB,KAAK,MAAM,EAAE,IAAI,IAAI,EAAE;QACrB,QAAQ,EAAE,CAAC,IAAI,EAAE;YACf,KAAK,eAAe,CAAC;YACrB,KAAK,aAAa;gBAChB,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;gBACpB,MAAM;YAER,KAAK,gBAAgB,CAAC,CAAC;gBACrB,KAAK,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE;oBACvB,IAAI,EAAE,CAAC,IAAI,KAAK,YAAY,EAAE;wBAC5B,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;qBACtB;iBACF;gBACD,MAAM;aACP;YAED,uEAAuE;YACvE,KAAK,kBAAkB,CAAC;YACxB,KAAK,cAAc,CAAC;YACpB,KAAK,aAAa,CAAC;YACnB,KAAK,aAAa,CAAC;YACnB,KAAK,cAAc,CAAC;YACpB,KAAK,YAAY,CAAC;YAClB,KAAK,eAAe,CAAC;YACrB,KAAK,iBAAiB,CAAC;YACvB,KAAK,SAAS;gBACZ,MAAM;SACT;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,wBAAwB,CAAC,EAAc;IAC9C,QAAQ,EAAE,CAAC,IAAI,EAAE;QACf,KAAK,gBAAgB,CAAC,CAAC;YACrB,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC;YAC3B,OAAO,CACL,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI;gBAC/B,iBAAO,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,uBAAuB,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,CAC3F,CAAC;SACH;QAED,KAAK,cAAc;YACjB,OAAO,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,GAAG,iBAAO,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,CAAC;KACzF;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,EAAiB;IAC7C,QAAQ,EAAE,CAAC,IAAI,EAAE;QACf,KAAK,SAAS;YACZ,OAAO,cAAc,EAAE,CAAC,QAAQ,aAAa,EAAE,CAAC,OAAO,IAAI,CAAC;QAE9D;YACE,OAAO,qBAAqB,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;KAC5C;AACH,CAAC;AAED,SAAS,qBAAqB,CAAI,EAAqB,EAAE,OAAyB;IAChF,QAAQ,EAAE,CAAC,IAAI,EAAE;QACf,KAAK,QAAQ;YACX,OAAO,aAAa,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;QAE/C,KAAK,QAAQ;YACX,OAAO,cAAc,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;QAE/C,KAAK,QAAQ;YACX,OAAO,WAAW,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;KAC7C;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,QAA4B,EAAE,OAA2B;IACnF,MAAM,aAAa,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;IAC1C,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;IAExC,IAAI,aAAa,KAAK,YAAY,EAAE;QAClC,OAAO,MAAM,YAAY,EAAE,CAAC;KAC7B;SAAM;QACL,OAAO,QAAQ,aAAa,OAAO,YAAY,EAAE,CAAC;KACnD;AACH,CAAC;AAED,SAAS,KAAK,CAAC,QAA2B;IACxC,OAAO,GAAG,GAAG,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC;AACpC,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=report.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"report.test.d.ts","sourceRoot":"","sources":["../../src/storage/report.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,82 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const ava_1 = __importDefault(require("ava"));
7
+ const utils_1 = require("solidity-ast/utils");
8
+ const hardhat_1 = require("hardhat");
9
+ const ast_dereferencer_1 = require("../ast-dereferencer");
10
+ const extract_1 = require("../storage/extract");
11
+ const compare_1 = require("./compare");
12
+ const layout_1 = require("./layout");
13
+ const test = ava_1.default;
14
+ const dummyDecodeSrc = () => 'file.sol:1';
15
+ test.before(async (t) => {
16
+ const buildInfo = await hardhat_1.artifacts.getBuildInfo('contracts/test/Storage.sol:Storage1');
17
+ if (buildInfo === undefined) {
18
+ throw new Error('Build info not found');
19
+ }
20
+ const solcOutput = buildInfo.output;
21
+ const contracts = {};
22
+ for (const def of utils_1.findAll('ContractDefinition', solcOutput.sources['contracts/test/Storage.sol'].ast)) {
23
+ contracts[def.name] = def;
24
+ }
25
+ const deref = ast_dereferencer_1.astDereferencer(solcOutput);
26
+ t.context.extractStorageLayout = name => extract_1.extractStorageLayout(contracts[name], dummyDecodeSrc, deref);
27
+ });
28
+ function getReport(original, updated) {
29
+ const originalDetailed = layout_1.getDetailedLayout(original);
30
+ const updatedDetailed = layout_1.getDetailedLayout(updated);
31
+ const comparator = new compare_1.StorageLayoutComparator();
32
+ return comparator.compareLayouts(originalDetailed, updatedDetailed);
33
+ }
34
+ test('structs', t => {
35
+ const v1 = t.context.extractStorageLayout('StorageUpgrade_Struct_V1');
36
+ const v2 = t.context.extractStorageLayout('StorageUpgrade_Struct_V2_Bad');
37
+ const report = getReport(v1, v2);
38
+ t.snapshot(report.explain());
39
+ });
40
+ test('enums', t => {
41
+ const v1 = t.context.extractStorageLayout('StorageUpgrade_Enum_V1');
42
+ const v2 = t.context.extractStorageLayout('StorageUpgrade_Enum_V2_Bad');
43
+ const report = getReport(v1, v2);
44
+ t.snapshot(report.explain());
45
+ });
46
+ test('obvious mismatch', t => {
47
+ const v1 = t.context.extractStorageLayout('StorageUpgrade_ObviousMismatch_V1');
48
+ const v2 = t.context.extractStorageLayout('StorageUpgrade_ObviousMismatch_V2_Bad');
49
+ const report = getReport(v1, v2);
50
+ t.snapshot(report.explain());
51
+ });
52
+ test('array', t => {
53
+ const v1 = t.context.extractStorageLayout('StorageUpgrade_Array_V1');
54
+ const v2 = t.context.extractStorageLayout('StorageUpgrade_Array_V2_Bad');
55
+ const report = getReport(v1, v2);
56
+ t.snapshot(report.explain());
57
+ });
58
+ test('mapping', t => {
59
+ const v1 = t.context.extractStorageLayout('StorageUpgrade_Mapping_V1');
60
+ const v2 = t.context.extractStorageLayout('StorageUpgrade_Mapping_V2_Bad');
61
+ const report = getReport(v1, v2);
62
+ t.snapshot(report.explain());
63
+ });
64
+ test('mapping enum key', t => {
65
+ const v1 = t.context.extractStorageLayout('StorageUpgrade_MappingEnumKey_V1');
66
+ const v2 = t.context.extractStorageLayout('StorageUpgrade_MappingEnumKey_V2_Bad');
67
+ const report = getReport(v1, v2);
68
+ t.snapshot(report.explain());
69
+ });
70
+ test('rename', t => {
71
+ const v1 = t.context.extractStorageLayout('StorageUpgrade_Rename_V1');
72
+ const v2 = t.context.extractStorageLayout('StorageUpgrade_Rename_V2');
73
+ const report = getReport(v1, v2);
74
+ t.snapshot(report.explain());
75
+ });
76
+ test('replace', t => {
77
+ const v1 = t.context.extractStorageLayout('StorageUpgrade_Replace_V1');
78
+ const v2 = t.context.extractStorageLayout('StorageUpgrade_Replace_V2');
79
+ const report = getReport(v1, v2);
80
+ t.snapshot(report.explain());
81
+ });
82
+ //# sourceMappingURL=report.test.js.map