@etherisc/gif-next 0.0.2-de220d6-949 → 0.0.2-e37834a-021

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 (286) hide show
  1. package/README.md +71 -0
  2. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.dbg.json +1 -1
  3. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.json +80 -41
  4. package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json +4 -0
  5. package/artifacts/contracts/components/Distribution.sol/Distribution.json +445 -0
  6. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json +1 -1
  7. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.json +43 -40
  8. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.dbg.json +4 -0
  9. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.json +177 -0
  10. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.dbg.json +1 -1
  11. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.json +108 -156
  12. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.dbg.json +1 -1
  13. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.json +67 -139
  14. package/artifacts/contracts/components/Pool.sol/Pool.dbg.json +1 -1
  15. package/artifacts/contracts/components/Pool.sol/Pool.json +299 -84
  16. package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
  17. package/artifacts/contracts/components/Product.sol/Product.json +250 -53
  18. package/artifacts/contracts/experiment/errors/Require.sol/Require.dbg.json +1 -1
  19. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.dbg.json +1 -1
  20. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.json +2 -34
  21. package/artifacts/contracts/experiment/inheritance/A.sol/A.dbg.json +1 -1
  22. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.dbg.json +1 -1
  23. package/artifacts/contracts/experiment/inheritance/B.sol/B.dbg.json +1 -1
  24. package/artifacts/contracts/experiment/inheritance/C.sol/C.dbg.json +1 -1
  25. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.dbg.json +1 -1
  26. package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.dbg.json +1 -1
  27. package/artifacts/contracts/experiment/inheritance/IB.sol/IB.dbg.json +1 -1
  28. package/artifacts/contracts/experiment/inheritance/IC.sol/IC.dbg.json +1 -1
  29. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.dbg.json +1 -1
  30. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.json +2 -2
  31. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.dbg.json +1 -1
  32. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.dbg.json +1 -1
  33. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.dbg.json +1 -1
  34. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.dbg.json +1 -1
  35. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.dbg.json +1 -1
  36. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.dbg.json +1 -1
  37. package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
  38. package/artifacts/contracts/instance/IInstance.sol/IInstance.json +882 -586
  39. package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.dbg.json +1 -1
  40. package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
  41. package/artifacts/contracts/instance/Instance.sol/Instance.json +1011 -638
  42. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +1 -1
  43. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.json +139 -46
  44. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.dbg.json +1 -1
  45. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.json +51 -1
  46. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.dbg.json +1 -1
  47. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.json +49 -0
  48. package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.dbg.json +1 -1
  49. package/artifacts/contracts/instance/base/IService.sol/IService.dbg.json +1 -1
  50. package/artifacts/contracts/instance/base/IService.sol/IService.json +99 -55
  51. package/artifacts/contracts/instance/base/InstanceBase.sol/InstanceBase.dbg.json +1 -1
  52. package/artifacts/contracts/instance/base/InstanceBase.sol/InstanceBase.json +178 -48
  53. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.dbg.json +1 -1
  54. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.json +41 -23
  55. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.dbg.json +1 -1
  56. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.json +4 -4
  57. package/artifacts/contracts/instance/base/ModuleBase.sol/ModuleBase.dbg.json +1 -1
  58. package/artifacts/contracts/instance/base/ServiceBase.sol/ServiceBase.dbg.json +1 -1
  59. package/artifacts/contracts/instance/base/ServiceBase.sol/ServiceBase.json +135 -55
  60. package/artifacts/contracts/instance/module/access/Access.sol/AccessModule.dbg.json +1 -1
  61. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccess.dbg.json +1 -1
  62. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccessModule.dbg.json +1 -1
  63. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.dbg.json +1 -1
  64. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.json +55 -54
  65. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundle.dbg.json +1 -1
  66. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.dbg.json +1 -1
  67. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.json +56 -55
  68. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.dbg.json +1 -1
  69. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.json +22 -93
  70. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.dbg.json +1 -1
  71. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.dbg.json +1 -1
  72. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.json +22 -93
  73. package/artifacts/contracts/instance/module/distribution/DistributionModule.sol/DistributionModule.dbg.json +4 -0
  74. package/artifacts/contracts/instance/module/distribution/DistributionModule.sol/DistributionModule.json +10 -0
  75. package/artifacts/contracts/instance/module/distribution/IDistribution.sol/IDistribution.dbg.json +4 -0
  76. package/artifacts/contracts/instance/module/{compensation/ICompensation.sol/ICompensation.json → distribution/IDistribution.sol/IDistribution.json} +2 -2
  77. package/artifacts/contracts/instance/module/distribution/IDistribution.sol/IDistributionModule.dbg.json +4 -0
  78. package/artifacts/contracts/instance/module/{compensation/ICompensation.sol/ICompensationModule.json → distribution/IDistribution.sol/IDistributionModule.json} +2 -2
  79. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicy.dbg.json +1 -1
  80. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.dbg.json +1 -1
  81. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.json +53 -40
  82. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.dbg.json +1 -1
  83. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.json +53 -40
  84. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPool.dbg.json +1 -1
  85. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.dbg.json +1 -1
  86. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.json +29 -14
  87. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.dbg.json +1 -1
  88. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.json +28 -13
  89. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRisk.dbg.json +1 -1
  90. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.dbg.json +1 -1
  91. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.json +104 -1
  92. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.dbg.json +1 -1
  93. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.json +126 -5
  94. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasury.dbg.json +1 -1
  95. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.dbg.json +1 -1
  96. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.json +326 -221
  97. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.dbg.json +1 -1
  98. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.json +2 -2
  99. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.dbg.json +1 -1
  100. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.json +326 -221
  101. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.dbg.json +1 -1
  102. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.json +251 -84
  103. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.dbg.json +4 -0
  104. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.json +526 -0
  105. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.dbg.json +1 -1
  106. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.json +99 -74
  107. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.dbg.json +4 -0
  108. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.json +369 -0
  109. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +1 -1
  110. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +158 -50
  111. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +1 -1
  112. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +246 -49
  113. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.dbg.json +1 -1
  114. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.json +230 -52
  115. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.dbg.json +1 -1
  116. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.json +361 -70
  117. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
  118. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.json +141 -12
  119. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.dbg.json +1 -1
  120. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.json +5 -0
  121. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
  122. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.json +293 -40
  123. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.dbg.json +4 -0
  124. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.json +668 -0
  125. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.dbg.json +4 -0
  126. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.json +34 -0
  127. package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
  128. package/artifacts/contracts/registry/Registry.sol/Registry.json +483 -120
  129. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.dbg.json +4 -0
  130. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.json +885 -0
  131. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.dbg.json +4 -0
  132. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.json +460 -0
  133. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.dbg.json +4 -0
  134. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.json +107 -0
  135. package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json +1 -1
  136. package/artifacts/contracts/shared/ERC165.sol/ERC165.json +2 -2
  137. package/artifacts/contracts/shared/IOwnable.sol/IOwnable.dbg.json +1 -1
  138. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +1 -1
  139. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.json +43 -40
  140. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.dbg.json +1 -1
  141. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json +55 -14
  142. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.dbg.json +4 -0
  143. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.json +132 -0
  144. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.dbg.json +4 -0
  145. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.json +344 -0
  146. package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +1 -1
  147. package/artifacts/contracts/shared/Registerable.sol/Registerable.json +76 -37
  148. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.dbg.json +4 -0
  149. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.json +129 -0
  150. package/artifacts/contracts/shared/Versionable.sol/Versionable.dbg.json +1 -1
  151. package/artifacts/contracts/shared/Versionable.sol/Versionable.json +78 -14
  152. package/artifacts/contracts/test/TestDistribution.sol/TestDistribution.dbg.json +4 -0
  153. package/artifacts/contracts/test/TestDistribution.sol/TestDistribution.json +445 -0
  154. package/artifacts/contracts/test/TestFee.sol/TestFee.dbg.json +1 -1
  155. package/artifacts/contracts/test/TestFee.sol/TestFee.json +2 -2
  156. package/artifacts/contracts/test/TestPool.sol/TestPool.dbg.json +1 -1
  157. package/artifacts/contracts/test/TestPool.sol/TestPool.json +299 -84
  158. package/artifacts/contracts/test/TestProduct.sol/TestProduct.dbg.json +1 -1
  159. package/artifacts/contracts/test/TestProduct.sol/TestProduct.json +297 -58
  160. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.dbg.json +1 -1
  161. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.json +93 -39
  162. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.dbg.json +1 -1
  163. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.json +2 -2
  164. package/artifacts/contracts/test/TestService.sol/TestService.dbg.json +1 -1
  165. package/artifacts/contracts/test/TestService.sol/TestService.json +161 -68
  166. package/artifacts/contracts/test/TestToken.sol/TestUsdc.dbg.json +1 -1
  167. package/artifacts/contracts/test/TestVersion.sol/TestVersion.dbg.json +1 -1
  168. package/artifacts/contracts/test/TestVersion.sol/TestVersion.json +2 -2
  169. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.dbg.json +1 -1
  170. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.json +89 -25
  171. package/artifacts/contracts/test/Usdc.sol/USDC.dbg.json +1 -1
  172. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.dbg.json +1 -1
  173. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
  174. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.dbg.json +1 -1
  175. package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +1 -1
  176. package/artifacts/contracts/types/Fee.sol/FeeLib.json +50 -11
  177. package/artifacts/contracts/types/Key32.sol/Key32Lib.dbg.json +1 -1
  178. package/artifacts/contracts/types/Key32.sol/Key32Lib.json +2 -2
  179. package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
  180. package/artifacts/contracts/types/NftId.sol/NftIdLib.json +2 -2
  181. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +1 -1
  182. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +2 -2
  183. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +1 -1
  184. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +2 -2
  185. package/artifacts/contracts/types/ReferralId.sol/ReferralIdLib.dbg.json +4 -0
  186. package/artifacts/contracts/types/ReferralId.sol/ReferralIdLib.json +99 -0
  187. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.dbg.json +4 -0
  188. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.json +86 -0
  189. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.dbg.json +1 -1
  190. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.json +2 -2
  191. package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +1 -1
  192. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
  193. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.dbg.json +1 -1
  194. package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +1 -1
  195. package/artifacts/contracts/types/Version.sol/VersionLib.json +40 -2
  196. package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +1 -1
  197. package/artifacts/contracts/types/Version.sol/VersionPartLib.json +2 -2
  198. package/contracts/components/BaseComponent.sol +12 -21
  199. package/contracts/components/Distribution.sol +155 -0
  200. package/contracts/components/IBaseComponent.sol +2 -2
  201. package/contracts/components/IDistributionComponent.sol +46 -0
  202. package/contracts/components/IPoolComponent.sol +15 -8
  203. package/contracts/components/IProductComponent.sol +26 -8
  204. package/contracts/components/Pool.sol +99 -27
  205. package/contracts/components/Product.sol +204 -22
  206. package/contracts/experiment/errors/Revert.sol +4 -13
  207. package/contracts/instance/IInstance.sol +10 -8
  208. package/contracts/instance/Instance.sol +25 -8
  209. package/contracts/instance/base/ComponentServiceBase.sol +13 -6
  210. package/contracts/instance/base/IInstanceBase.sol +11 -2
  211. package/contracts/instance/base/IKeyValueStore.sol +4 -3
  212. package/contracts/instance/base/InstanceBase.sol +19 -10
  213. package/contracts/instance/base/KeyValueStore.sol +12 -7
  214. package/contracts/instance/base/Lifecycle.sol +15 -10
  215. package/contracts/instance/base/ModuleBase.sol +22 -17
  216. package/contracts/instance/base/ServiceBase.sol +19 -13
  217. package/contracts/instance/module/access/Access.sol +3 -3
  218. package/contracts/instance/module/bundle/BundleModule.sol +10 -12
  219. package/contracts/instance/module/bundle/IBundle.sol +6 -11
  220. package/contracts/instance/module/component/ComponentModule.sol +34 -58
  221. package/contracts/instance/module/component/IComponent.sol +7 -32
  222. package/contracts/instance/module/distribution/DistributionModule.sol +17 -0
  223. package/contracts/instance/module/distribution/IDistribution.sol +10 -0
  224. package/contracts/instance/module/policy/IPolicy.sol +10 -8
  225. package/contracts/instance/module/policy/PolicyModule.sol +33 -19
  226. package/contracts/instance/module/pool/IPoolModule.sol +4 -4
  227. package/contracts/instance/module/pool/PoolModule.sol +23 -15
  228. package/contracts/instance/module/risk/IRisk.sol +18 -2
  229. package/contracts/instance/module/risk/RiskModule.sol +56 -2
  230. package/contracts/instance/module/treasury/ITreasury.sol +32 -51
  231. package/contracts/instance/module/treasury/TokenHandler.sol +2 -2
  232. package/contracts/instance/module/treasury/TreasuryModule.sol +68 -89
  233. package/contracts/instance/service/ComponentOwnerService.sol +197 -95
  234. package/contracts/instance/service/DistributionService.sol +54 -0
  235. package/contracts/instance/service/IComponentOwnerService.sol +0 -2
  236. package/contracts/instance/service/IDistributionService.sol +12 -0
  237. package/contracts/instance/service/IPoolService.sol +7 -0
  238. package/contracts/instance/service/IProductService.sol +56 -7
  239. package/contracts/instance/service/PoolService.sol +49 -23
  240. package/contracts/instance/service/ProductService.sol +247 -91
  241. package/contracts/registry/ChainNft.sol +43 -15
  242. package/contracts/registry/IChainNft.sol +3 -2
  243. package/contracts/registry/IRegistry.sol +44 -28
  244. package/contracts/registry/IRegistryService.sol +29 -0
  245. package/contracts/registry/ITransferInterceptor.sol +6 -0
  246. package/contracts/registry/Registry.sol +383 -274
  247. package/contracts/registry/RegistryService.sol +375 -0
  248. package/contracts/registry/RegistryServiceManager.sol +52 -0
  249. package/contracts/shared/ContractDeployerLib.sol +72 -0
  250. package/contracts/shared/ERC165.sol +1 -1
  251. package/contracts/shared/IRegisterable.sol +7 -9
  252. package/contracts/shared/IVersionable.sol +55 -11
  253. package/contracts/shared/NftOwnable.sol +87 -0
  254. package/contracts/shared/ProxyManager.sol +103 -0
  255. package/contracts/shared/Registerable.sol +74 -43
  256. package/contracts/shared/UpgradableProxyWithAdmin.sol +16 -0
  257. package/contracts/shared/Versionable.sol +112 -54
  258. package/contracts/test/TestDistribution.sol +22 -0
  259. package/contracts/test/TestPool.sol +7 -2
  260. package/contracts/test/TestProduct.sol +37 -7
  261. package/contracts/test/TestRegisterable.sol +5 -6
  262. package/contracts/test/TestService.sol +5 -11
  263. package/contracts/types/Fee.sol +8 -3
  264. package/contracts/types/ObjectType.sol +24 -8
  265. package/contracts/types/ReferralId.sol +48 -0
  266. package/contracts/types/RiskId.sol +43 -0
  267. package/contracts/types/RoleId.sol +2 -2
  268. package/contracts/types/Version.sol +9 -0
  269. package/package.json +1 -1
  270. package/artifacts/contracts/experiment/errors/IncrementRevert.sol/IIncrementRevert.dbg.json +0 -4
  271. package/artifacts/contracts/experiment/errors/IncrementRevert.sol/IIncrementRevert.json +0 -27
  272. package/artifacts/contracts/experiment/errors/IncrementRevert.sol/IncrementRevert.dbg.json +0 -4
  273. package/artifacts/contracts/experiment/errors/IncrementRevert.sol/IncrementRevert.json +0 -83
  274. package/artifacts/contracts/experiment/errors/Revert.sol/IRevert.dbg.json +0 -4
  275. package/artifacts/contracts/experiment/errors/Revert.sol/IRevert.json +0 -75
  276. package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.dbg.json +0 -4
  277. package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.json +0 -10
  278. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensation.dbg.json +0 -4
  279. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensationModule.dbg.json +0 -4
  280. package/artifacts/contracts/registry/IRegistryLinked.sol/IRegistryLinked.dbg.json +0 -4
  281. package/artifacts/contracts/registry/IRegistryLinked.sol/IRegistryLinked.json +0 -24
  282. package/contracts/experiment/errors/IncrementRevert.sol +0 -43
  283. package/contracts/experiment/statemachine/README.md +0 -112
  284. package/contracts/instance/module/compensation/CompensationModule.sol +0 -8
  285. package/contracts/instance/module/compensation/ICompensation.sol +0 -10
  286. package/contracts/registry/IRegistryLinked.sol +0 -8
@@ -0,0 +1,375 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {IERC20Metadata} from "@openzeppelin5/contracts/token/ERC20/extensions/IERC20Metadata.sol";
5
+
6
+ import {IRegistry} from "../registry/IRegistry.sol";
7
+ import {IInstance} from "../instance/IInstance.sol";
8
+
9
+ import {ContractDeployerLib} from "../shared/ContractDeployerLib.sol";
10
+ import {IComponent, IComponentModule} from "../../contracts/instance/module/component/IComponent.sol";
11
+ import {IPool} from "../../contracts/instance/module/pool/IPoolModule.sol";
12
+ import {IBaseComponent} from "../../contracts/components/IBaseComponent.sol";
13
+ import {IPoolComponent} from "../../contracts/components/IPoolComponent.sol";
14
+ import {IProductComponent} from "../../contracts/components/IProductComponent.sol";
15
+ import {IDistributionComponent} from "../../contracts/components/IDistributionComponent.sol";
16
+
17
+ import {IVersionable} from "../../contracts/shared/IVersionable.sol";
18
+ import {Versionable} from "../../contracts/shared/Versionable.sol";
19
+ import {IRegisterable} from "../../contracts/shared/IRegisterable.sol";
20
+
21
+ import {RoleId, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../contracts/types/RoleId.sol";
22
+ import {ObjectType, REGISTRY, TOKEN, SERVICE, PRODUCT, ORACLE, POOL, TOKEN, INSTANCE, DISTRIBUTION, POLICY, BUNDLE} from "../../contracts/types/ObjectType.sol";
23
+ import {StateId, ACTIVE, PAUSED} from "../../contracts/types/StateId.sol";
24
+ import {NftId, NftIdLib, zeroNftId} from "../../contracts/types/NftId.sol";
25
+ import {Fee, FeeLib} from "../../contracts/types/Fee.sol";
26
+ import {Version, VersionPart, VersionLib} from "../../contracts/types/Version.sol";
27
+
28
+ import {ServiceBase} from "../../contracts/instance/base/ServiceBase.sol";
29
+ import {IService} from "../../contracts/instance/base/IService.sol";
30
+ import {IRegistryService} from "./IRegistryService.sol";
31
+ import {Registry} from "../registry/Registry.sol";
32
+
33
+ contract RegistryService is
34
+ ServiceBase,
35
+ IRegistryService
36
+ {
37
+ using NftIdLib for NftId;
38
+
39
+ error NotRegistryOwner();
40
+ error MissingAllowance();
41
+
42
+ error NotToken();
43
+ error NotService();
44
+ error NotComponent();
45
+ error NotInstance();
46
+
47
+ error InvalidAddress(address registerableAddress);
48
+ error InvalidInitialOwner(address initialOwner);
49
+ error SelfRegistration();
50
+ error InvalidType(ObjectType objectType);
51
+
52
+ string public constant NAME = "RegistryService";
53
+
54
+ // TODO update to real hash when registry is stable
55
+ bytes32 public constant REGISTRY_CREATION_CODE_HASH = bytes32(0);
56
+
57
+ address constant public NFT_LOCK_ADDRESS = address(0x1);
58
+
59
+ /// @dev
60
+ // msg.sender - ONLY registry owner
61
+ // CAN register ANY non IRegisterable address
62
+ // CAN register ONLY valid object-parent types combinations for TOKEN
63
+ // CAN NOT register itself
64
+ // IMPORTANT: MUST NOT call untrusted contract inbetween calls to registry/instance (trusted contracts)
65
+ // motivation: registry/instance state may change during external call
66
+ // TODO it may be usefull to have transferable token nft in order to delist token, make it invalid for new beginings
67
+ // TODO: MUST prohibit registration of precompiles addresses
68
+ function registerToken(address tokenAddress)
69
+ external
70
+ returns(NftId nftId)
71
+ {
72
+ IRegisterable registerable = IRegisterable(tokenAddress);
73
+ bool isRegisterable;
74
+
75
+ // registryOwner can not register IRegisterable as TOKEN
76
+ try registerable.supportsInterface(type(IRegisterable).interfaceId) returns(bool result) {
77
+ isRegisterable = result;
78
+ } catch {
79
+ isRegisterable = false;
80
+ }
81
+
82
+ if(isRegisterable) {
83
+ revert NotToken();
84
+ }
85
+
86
+ IRegistry registry = getRegistry();
87
+
88
+ if(msg.sender != registry.ownerOf(address(registry))) {
89
+ revert NotRegistryOwner();
90
+ }
91
+
92
+ IRegistry.ObjectInfo memory info = IRegistry.ObjectInfo(
93
+ zeroNftId(), // any value
94
+ registry.getNftId(address(registry)),
95
+ TOKEN(),
96
+ false, // isInterceptor
97
+ tokenAddress,
98
+ NFT_LOCK_ADDRESS,
99
+ "" // any value
100
+ );
101
+
102
+ nftId = registry.register(info);
103
+ }
104
+
105
+ /// @dev
106
+ // msg.sender - ONLY registry owner
107
+ // CAN register ONLY valid object-parent types combinations for SERVICE
108
+ // CAN register ONLY IRegisterable address he owns
109
+ // CAN NOT register itself
110
+ // IMPORTANT: MUST NOT check owner before calling external contract
111
+ function registerService(IService service)
112
+ external
113
+ returns(
114
+ IRegistry.ObjectInfo memory info,
115
+ bytes memory data
116
+ )
117
+ {
118
+ if(service.supportsInterface(type(IService).interfaceId) == false) {
119
+ revert NotService();
120
+ }
121
+
122
+ (
123
+ info,
124
+ data
125
+ ) = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
126
+
127
+ IRegistry registry = getRegistry();
128
+
129
+ if(msg.sender != registry.ownerOf(address(registry))) {
130
+ revert NotRegistryOwner();
131
+ }
132
+
133
+ info.initialOwner = NFT_LOCK_ADDRESS;//registry.getLockAddress();
134
+ info.nftId = registry.register(info);
135
+
136
+ return (
137
+ info,
138
+ data
139
+ );
140
+ }
141
+
142
+ // anybody can register component if instance gives a corresponding role
143
+ //function registerComponent(IBaseComponent component, ObjectType componentType)
144
+ function registerComponent(IBaseComponent component, ObjectType componentType, address owner)
145
+ external
146
+ returns(
147
+ IRegistry.ObjectInfo memory info,
148
+ bytes memory data
149
+ )
150
+ {
151
+ if(component.supportsInterface(type(IBaseComponent).interfaceId) == false) {
152
+ revert NotComponent();
153
+ }
154
+
155
+ (
156
+ info,
157
+ data
158
+ ) = _getAndVerifyContractInfo(component, componentType, owner);
159
+
160
+ IRegistry registry = getRegistry();
161
+ NftId serviceNftId = registry.getNftId(msg.sender);
162
+
163
+ if(registry.allowance(serviceNftId, componentType) == false) {
164
+ revert MissingAllowance();
165
+ }
166
+
167
+ info.nftId = registry.register(info);
168
+
169
+ return (
170
+ info,
171
+ data
172
+ );
173
+ }
174
+
175
+ // TODO: when called by approved service: add owner arg (service must pass it's msg.sender as owner) & check service allowance
176
+ //function registerInstance(IRegisterable instance, address owner)
177
+ function registerInstance(IRegisterable instance)
178
+ external
179
+ returns(
180
+ IRegistry.ObjectInfo memory info,
181
+ bytes memory data
182
+ )
183
+ {
184
+ if(instance.supportsInterface(type(IInstance).interfaceId) == false) {
185
+ revert NotInstance();
186
+ }
187
+
188
+ (
189
+ info,
190
+ data
191
+ ) = _getAndVerifyContractInfo(instance, INSTANCE(), msg.sender);// owner);
192
+
193
+ IRegistry registry = getRegistry();
194
+
195
+ //if(registry.allowance(registry.getNftId(msg.sender), INSTANCE()) == false) {
196
+ // revert MissingAllowance();
197
+ //}
198
+
199
+ info.nftId = registry.register(info);
200
+
201
+ return (
202
+ info,
203
+ data
204
+ );
205
+ }
206
+
207
+ function registerPolicy(IRegistry.ObjectInfo memory info)
208
+ external
209
+ returns(NftId nftId)
210
+ {
211
+ IRegistry registry = getRegistry();
212
+ NftId senderNftId = registry.getNftId(msg.sender);
213
+
214
+ if(registry.allowance(senderNftId, POLICY()) == false) {
215
+ revert MissingAllowance();
216
+ }
217
+
218
+ _verifyObjectInfo(info, POLICY());
219
+
220
+ nftId = registry.register(info);
221
+ }
222
+
223
+ function registerBundle(IRegistry.ObjectInfo memory info)
224
+ external
225
+ returns(NftId nftId)
226
+ {
227
+ IRegistry registry = getRegistry();
228
+ NftId senderNftId = registry.getNftId(msg.sender);
229
+
230
+ if(registry.allowance(senderNftId, BUNDLE()) == false) {
231
+ revert MissingAllowance();
232
+ }
233
+
234
+ _verifyObjectInfo(info, BUNDLE());
235
+
236
+ nftId = registry.register(info);
237
+ }
238
+
239
+
240
+ // From IService
241
+ function getName() public pure override(IService, ServiceBase) returns(string memory) {
242
+ return NAME;
243
+ }
244
+
245
+
246
+ // from Versionable
247
+
248
+ /// @dev top level initializer
249
+ // 1) registry is non upgradeable -> don't need a proxy and uses constructor !
250
+ // 2) deploy registry service first -> from its initialization func it is easier to deploy registry then vice versa
251
+ // 3) deploy registry -> pass registry service address as constructor argument
252
+ // registry is getting instantiated and locked to registry service address forever
253
+ function _initialize(
254
+ address owner,
255
+ bytes memory registryByteCodeWithInitCode
256
+ )
257
+ internal
258
+ initializer
259
+ virtual override
260
+ {
261
+ bytes memory encodedConstructorArguments = abi.encode(
262
+ owner,
263
+ getMajorVersion());
264
+
265
+ bytes memory registryCreationCode = ContractDeployerLib.getCreationCode(
266
+ registryByteCodeWithInitCode,
267
+ encodedConstructorArguments);
268
+
269
+ address registryAddress = ContractDeployerLib.deploy(
270
+ registryCreationCode,
271
+ REGISTRY_CREATION_CODE_HASH);
272
+
273
+ IRegistry registry = IRegistry(registryAddress);
274
+ NftId registryNftId = registry.getNftId(registryAddress);
275
+
276
+ _initializeServiceBase(registryAddress, registryNftId, owner);
277
+
278
+ _registerInterface(type(IRegistryService).interfaceId);
279
+ }
280
+
281
+ // parent check done in registry because of approve()
282
+ function _getAndVerifyContractInfo(
283
+ IRegisterable registerable,
284
+ ObjectType objectType,
285
+ address owner
286
+ )
287
+ internal
288
+ returns(
289
+ IRegistry.ObjectInfo memory info,
290
+ bytes memory data
291
+ )
292
+ {
293
+ (
294
+ info,
295
+ data
296
+ ) = registerable.getInitialInfo();
297
+
298
+ if(info.objectAddress != address(registerable)) {
299
+ revert InvalidAddress(info.objectAddress);
300
+ }
301
+
302
+ if(
303
+ getRegistry().isRegistered(owner) ||
304
+ info.initialOwner != owner) { // contract owner protection
305
+ revert InvalidInitialOwner(info.initialOwner);
306
+ }
307
+
308
+ if(msg.sender == address(registerable)) {
309
+ revert SelfRegistration();
310
+ }
311
+
312
+ if(info.objectType != objectType) {
313
+ revert InvalidType(info.objectType);
314
+ }
315
+
316
+ /*NftId parentNftId = info.parentNftId;
317
+ IRegistry.ObjectInfo memory parentInfo = getRegistry().getObjectInfo(parentNftId);
318
+
319
+ if(parentInfo.objectType != parentType) { // parent registration + type
320
+ revert InvalidParent(parentNftId);
321
+ }*/
322
+
323
+ return(
324
+ info,
325
+ data
326
+ );
327
+ }
328
+
329
+ // parent checks done in registry because of approve()
330
+ function _verifyObjectInfo(
331
+ IRegistry.ObjectInfo memory info,
332
+ ObjectType objectType
333
+ )
334
+ internal
335
+ view
336
+ {
337
+ if(info.objectAddress > address(0)) {
338
+ revert InvalidAddress(info.objectAddress);
339
+ }
340
+
341
+ if(
342
+ getRegistry().isRegistered(info.initialOwner) ||
343
+ info.initialOwner == address(0)) {
344
+ // TODO non registered address can register object(e.g. POLICY()) and then transfer associated nft to registered contract
345
+ // what are motivations to do so?
346
+ // at least registered contract can not register objects by itself, SERVICE,
347
+ revert InvalidInitialOwner(info.initialOwner);
348
+ }
349
+
350
+ // can catch all 3 if check that initialOwner is not registered
351
+ /*if(info.initialOwner == msg.sender) {
352
+ revert InitialOwnerIsParent();
353
+ }
354
+
355
+ if(info.initialOwner == address(this)) {
356
+ revert InitialOwnerIsService();
357
+ }
358
+
359
+ if(info.initialOwner == address(getRegistry())) {
360
+ revert InitialOwnerIsRegistry();
361
+ }*/
362
+
363
+
364
+ if(info.objectType != objectType) {
365
+ revert InvalidType(info.objectType);
366
+ }
367
+
368
+ /*NftId parentNftId = info.parentNftId;
369
+ IRegistry.ObjectInfo memory parentInfo = getRegistry().getObjectInfo(parentNftId);
370
+
371
+ if(parentInfo.objectType != parentType) { // parent registration + type
372
+ revert InvalidParent(parentNftId);
373
+ }*/
374
+ }
375
+ }
@@ -0,0 +1,52 @@
1
+ // SPDX-License-Identifier: UNLICENSED
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {Registry} from "./Registry.sol";
5
+ import {IRegistry} from "./IRegistry.sol";
6
+ import {IVersionable} from "../shared/IVersionable.sol";
7
+ import {ProxyManager} from "../shared/ProxyManager.sol";
8
+ import {RegistryService} from "./RegistryService.sol";
9
+
10
+
11
+ contract RegistryServiceManager is
12
+ ProxyManager
13
+ {
14
+ error ErrorRegistryServiceWithZeroAddress();
15
+
16
+ RegistryService private _registryService;
17
+
18
+ /// @dev initializes proxy manager with registry service implementation and deploys registry
19
+ constructor(
20
+ // address registryServiceImplementationAddress,
21
+ // bytes memory registryBytecodeWithInitCode // type(Registry).creationCode
22
+ )
23
+ ProxyManager()
24
+ {
25
+ // if (registryServiceImplementationAddress == address(0)) {
26
+ // revert ErrorRegistryServiceWithZeroAddress();
27
+ // }
28
+
29
+ IVersionable versionable = deploy(
30
+ address(new RegistryService()),
31
+ type(Registry).creationCode);
32
+
33
+ _registryService = RegistryService(address(versionable));
34
+
35
+ // link ownership of registry service manager ot nft owner of registry service
36
+ linkToRegistry(
37
+ address(_registryService.getRegistry()),
38
+ address(_registryService));
39
+
40
+ // implies that after this constructor call only upgrade functionality is available
41
+ _isDeployed = true;
42
+ }
43
+
44
+ //--- view functions ----------------------------------------------------//
45
+ function getRegistryService()
46
+ external
47
+ view
48
+ returns (RegistryService registryService)
49
+ {
50
+ return _registryService;
51
+ }
52
+ }
@@ -0,0 +1,72 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ library ContractDeployerLib {
5
+
6
+ event LogContractDeployed(address contractAddress);
7
+
8
+ error ErrorCreationCodeHashMismatch(bytes32 expectedHash, bytes32 actualHash);
9
+
10
+ /// @dev deploys a new contract using the provided creation code
11
+ function deploy(
12
+ bytes memory creationCode,
13
+ bytes32 expectedCreationCodeHash
14
+ )
15
+ public
16
+ returns (address contractAdress)
17
+ {
18
+ // check against expected hash, if provided
19
+ if (expectedCreationCodeHash != bytes32(0)) {
20
+ bytes32 creationCodeHash = getHash(creationCode);
21
+ if (creationCodeHash != expectedCreationCodeHash) {
22
+ revert ErrorCreationCodeHashMismatch(expectedCreationCodeHash, creationCodeHash);
23
+ }
24
+ }
25
+
26
+ // solhint-disable no-inline-assembly
27
+ assembly {
28
+ contractAdress := create(0, add(creationCode, 0x20), mload(creationCode))
29
+
30
+ if iszero(extcodesize(contractAdress)) {
31
+ revert(0, 0)
32
+ }
33
+ }
34
+ // solhint enable
35
+
36
+ emit LogContractDeployed(contractAdress);
37
+ }
38
+
39
+ /// @dev gets the creation code for the new contract
40
+ // for terminology see eg https://www.rareskills.io/post/ethereum-contract-creation-code
41
+ function getCreationCode(
42
+ bytes memory byteCodeWithInitCode, // what you get with type(<Contract>).creationCode
43
+ bytes memory encodedConstructorArguments // what you get with
44
+ )
45
+ public
46
+ pure
47
+ returns (bytes memory creationCode)
48
+ {
49
+ return abi.encodePacked(byteCodeWithInitCode, encodedConstructorArguments);
50
+ }
51
+
52
+
53
+ function matchesWithHash(
54
+ bytes memory creationCode,
55
+ bytes32 expectedHash
56
+ )
57
+ public
58
+ pure
59
+ returns (bool isMatching)
60
+ {
61
+ return getHash(creationCode) == expectedHash;
62
+ }
63
+
64
+
65
+ function getHash(bytes memory creationCode)
66
+ public
67
+ pure
68
+ returns (bytes32 hash)
69
+ {
70
+ return keccak256(creationCode);
71
+ }
72
+ }
@@ -1,7 +1,7 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
2
  pragma solidity ^0.8.19;
3
3
 
4
- import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
4
+ import {IERC165} from "@openzeppelin5/contracts/utils/introspection/IERC165.sol";
5
5
 
6
6
  contract ERC165 is IERC165 {
7
7
  mapping(bytes4 => bool) private _isSupported;
@@ -1,7 +1,7 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
- pragma solidity ^0.8.19;
2
+ pragma solidity ^0.8.20;
3
3
 
4
- import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
4
+ import {IERC165} from "@openzeppelin5/contracts/utils/introspection/IERC165.sol";
5
5
 
6
6
  import {IRegistry} from "../registry/IRegistry.sol";
7
7
  import {NftId} from "../types/NftId.sol";
@@ -12,13 +12,11 @@ import {IOwnable} from "./IOwnable.sol";
12
12
  interface IRegisterable is IERC165, IOwnable {
13
13
  function getRegistry() external view returns (IRegistry registry);
14
14
 
15
- function register() external returns (NftId nftId);
16
-
17
- function getType() external pure returns (ObjectType objectType);
18
-
19
15
  function getNftId() external view returns (NftId nftId);
20
16
 
21
- function getParentNftId() external view returns (NftId nftId);
17
+ function getInitialInfo()
18
+ external
19
+ view
20
+ returns (IRegistry.ObjectInfo memory, bytes memory data);
22
21
 
23
- function getData() external view returns (bytes memory data);
24
- }
22
+ }
@@ -1,9 +1,34 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
- pragma solidity ^0.8.19;
2
+ pragma solidity ^0.8.20;
3
3
 
4
- import {Blocknumber, blockNumber} from "../types/Blocknumber.sol";
5
- import {Timestamp, blockTimestamp} from "../types/Timestamp.sol";
6
- import {Version, VersionPart} from "../types/Version.sol";
4
+ import {Blocknumber} from "../types/Blocknumber.sol";
5
+ import {Timestamp} from "../types/Timestamp.sol";
6
+ import {Version} from "../types/Version.sol";
7
+
8
+
9
+ /// IMPORTANT
10
+ // Upgradeable contract MUST:
11
+ // 1) inherit from Versionable
12
+ // 2) implement version() function
13
+ // 3) implement internal _initialize() function with onlyInitializing modifier
14
+ // 4) implement internal _upgrade() function with onlyInitializing modifier (1st version MUST revert)
15
+ // 5) have onlyInitialising modifier for each function callable inside _initialize()/_upgrade() (MUST use different functions for initialization/upgrade and normal operations)
16
+ // 6) use default empty constructor -> _disableInitializer() is called from Versionable contructor
17
+ // 7) use namespace storage
18
+ // 8) since now inheritance is used for upgradability, contract MUST BE inherited ONLY by the next version
19
+ // Upgradeable contract SHOULD:
20
+ // 9) define all non private methods as virtual (in order to be able to upgrade them latter)
21
+ // otherwise, it is still possible to upgrade contract, but everyone who is using it will have to switch to a new fucntions
22
+ // in some cases this ok but not in the others...
23
+ //
24
+ // IMPORTANT
25
+ // Each version MUST:
26
+ // 1) define namespace storage struct if accessing storage
27
+ // - DO NOT use structs inside, except
28
+ // - CAN use structs ONLY inside mappings
29
+ // 2) ALWAYS define private getter if accessing storage
30
+ // - MUST use default implementation, CAN change ONLY return type
31
+ // - MUST use the same "LOCATION_V1"
7
32
 
8
33
  interface IVersionable {
9
34
 
@@ -15,22 +40,35 @@ interface IVersionable {
15
40
  Blocknumber activatedIn;
16
41
  }
17
42
 
18
- event LogVersionableActivated(Version version, address implementation, address activatedBy);
43
+ event LogVersionableInitialized(Version version, address implementation, address activatedBy);
44
+
45
+ // TODO uncomment when all implementations are ready
46
+ /**
47
+ * @dev IMPORTANT
48
+ * implementation MUST be guarded by initializer modifier
49
+ * implementation MUST call internal function Versionable._updateVersionHistory
50
+ * new version MUST inherit from previous version
51
+ */
52
+ function initialize(address implementation, address activatedBy, bytes memory activationData) external;
19
53
 
20
54
  /**
21
- * @dev IMPORTANT this function needs to be implemented by each new version
22
- * any such activate implementation needs to call internal function call _activate()
23
- * any new version needs to inherit from previous version
55
+ * @dev
56
+ * implementation MUST be guarded by reinitializer(version().toUint64()) modifier
57
+ * implementation MUST call internal function Versionable._updateVersionHistory
58
+ * new version MUST inherit from previous version
59
+ * the first verion MUST revert
24
60
  */
25
- function activate(address implementation, address activatedBy) external;
61
+ function upgrade(address implementation, address activatedBy, bytes memory upgradeData) external;
26
62
 
27
63
  /**
28
64
  * @dev returns true if the specified version has been activated for the current contract
29
65
  */
30
- function isActivated(Version version) external view returns(bool);
66
+ function isInitialized(Version version) external view returns(bool);
31
67
 
32
68
  /**
33
- * @dev returns currently active version of this contract
69
+ * @dev returns version of this contract
70
+ * each new implementation MUST implement this function
71
+ * version number MUST increase
34
72
  */
35
73
  function getVersion() external pure returns(Version);
36
74
 
@@ -49,4 +87,10 @@ interface IVersionable {
49
87
  */
50
88
  function getVersionInfo(Version version) external view returns(VersionInfo memory versionInfo);
51
89
 
90
+ // TODO make sure it is needed here
91
+ /**
92
+ * @dev returns currently active version
93
+ */
94
+ function getInitializedVersion() external view returns(uint64);
95
+
52
96
  }