@etherisc/gif-next 0.0.2-f9bc4c7-556 → 0.0.2-fb8d07b-779

Sign up to get free protection for your applications and to get access to all the features.
Files changed (373) hide show
  1. package/README.md +179 -1
  2. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.dbg.json +1 -1
  3. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.json +176 -23
  4. package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json +4 -0
  5. package/artifacts/contracts/components/Distribution.sol/Distribution.json +618 -0
  6. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json +1 -1
  7. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.json +129 -23
  8. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.dbg.json +4 -0
  9. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.json +152 -0
  10. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.dbg.json +1 -1
  11. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.json +74 -181
  12. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.dbg.json +1 -1
  13. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.json +55 -177
  14. package/artifacts/contracts/components/Pool.sol/Pool.dbg.json +1 -1
  15. package/artifacts/contracts/components/Pool.sol/Pool.json +455 -60
  16. package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
  17. package/artifacts/contracts/components/Product.sol/Product.json +540 -70
  18. package/artifacts/contracts/experiment/cloning/Cloner.sol/Cloner.dbg.json +4 -0
  19. package/artifacts/contracts/experiment/cloning/Cloner.sol/Cloner.json +66 -0
  20. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock1.dbg.json +4 -0
  21. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock1.json +24 -0
  22. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock2.dbg.json +4 -0
  23. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock2.json +42 -0
  24. package/artifacts/contracts/experiment/errors/Require.sol/Require.dbg.json +1 -1
  25. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.dbg.json +1 -1
  26. package/artifacts/contracts/experiment/inheritance/A.sol/A.dbg.json +1 -1
  27. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.dbg.json +1 -1
  28. package/artifacts/contracts/experiment/inheritance/B.sol/B.dbg.json +1 -1
  29. package/artifacts/contracts/experiment/inheritance/C.sol/C.dbg.json +1 -1
  30. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.dbg.json +1 -1
  31. package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.dbg.json +1 -1
  32. package/artifacts/contracts/experiment/inheritance/IB.sol/IB.dbg.json +1 -1
  33. package/artifacts/contracts/experiment/inheritance/IC.sol/IC.dbg.json +1 -1
  34. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.dbg.json +1 -1
  35. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.json +2 -2
  36. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.dbg.json +1 -1
  37. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.dbg.json +1 -1
  38. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.dbg.json +1 -1
  39. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.json +2 -2
  40. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.dbg.json +1 -1
  41. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.json +2 -2
  42. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.dbg.json +1 -1
  43. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.dbg.json +1 -1
  44. package/artifacts/contracts/instance/AccessManagedSimple.sol/AccessManagedSimple.dbg.json +4 -0
  45. package/artifacts/contracts/instance/AccessManagedSimple.sol/AccessManagedSimple.json +101 -0
  46. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.dbg.json +4 -0
  47. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.json +1132 -0
  48. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.dbg.json +4 -0
  49. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.json +1082 -0
  50. package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
  51. package/artifacts/contracts/instance/IInstance.sol/IInstance.json +493 -1606
  52. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.dbg.json +4 -0
  53. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.json +480 -0
  54. package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
  55. package/artifacts/contracts/instance/Instance.sol/Instance.json +2513 -1170
  56. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.dbg.json +4 -0
  57. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.json +917 -0
  58. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.dbg.json +4 -0
  59. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.json +1388 -0
  60. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.dbg.json +4 -0
  61. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.json +891 -0
  62. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.dbg.json +4 -0
  63. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.json +492 -0
  64. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +1 -1
  65. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.json +276 -36
  66. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.dbg.json +1 -1
  67. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.json +51 -1
  68. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.dbg.json +1 -1
  69. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.json +45 -127
  70. package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.dbg.json +1 -1
  71. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.dbg.json +1 -1
  72. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.json +55 -245
  73. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.dbg.json +1 -1
  74. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.json +4 -4
  75. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.dbg.json +4 -0
  76. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.json +211 -0
  77. package/artifacts/contracts/instance/module/IBundle.sol/IBundle.dbg.json +4 -0
  78. package/artifacts/contracts/instance/module/{bundle/IBundle.sol → IBundle.sol}/IBundle.json +1 -1
  79. package/artifacts/contracts/instance/module/IDistribution.sol/IDistribution.dbg.json +4 -0
  80. package/artifacts/contracts/instance/module/{access/IAccess.sol/IAccess.json → IDistribution.sol/IDistribution.json} +2 -2
  81. package/artifacts/contracts/instance/module/IPolicy.sol/IPolicy.dbg.json +4 -0
  82. package/artifacts/contracts/instance/module/{policy/IPolicy.sol → IPolicy.sol}/IPolicy.json +1 -1
  83. package/artifacts/contracts/instance/module/IRisk.sol/IRisk.dbg.json +4 -0
  84. package/artifacts/contracts/instance/module/{risk/IRisk.sol → IRisk.sol}/IRisk.json +1 -1
  85. package/artifacts/contracts/instance/module/ISetup.sol/ISetup.dbg.json +4 -0
  86. package/artifacts/contracts/instance/{base/ModuleBase.sol/ModuleBase.json → module/ISetup.sol/ISetup.json} +2 -2
  87. package/artifacts/contracts/instance/module/ITreasury.sol/ITreasury.dbg.json +4 -0
  88. package/artifacts/contracts/instance/module/{treasury/ITreasury.sol → ITreasury.sol}/ITreasury.json +1 -1
  89. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.dbg.json +1 -1
  90. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.json +381 -77
  91. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.dbg.json +4 -0
  92. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.json +716 -0
  93. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.dbg.json +4 -0
  94. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.json +448 -0
  95. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.dbg.json +1 -1
  96. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.json +177 -75
  97. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.dbg.json +4 -0
  98. package/artifacts/contracts/instance/{base/ServiceBase.sol/ServiceBase.json → service/IDistributionService.sol/IDistributionService.json} +204 -58
  99. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +1 -1
  100. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +235 -50
  101. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +1 -1
  102. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +325 -51
  103. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.dbg.json +1 -1
  104. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.json +436 -52
  105. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.dbg.json +4 -0
  106. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.json +460 -0
  107. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
  108. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.json +186 -12
  109. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
  110. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.json +485 -37
  111. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.dbg.json +4 -0
  112. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.json +853 -0
  113. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.dbg.json +4 -0
  114. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.json +34 -0
  115. package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
  116. package/artifacts/contracts/registry/Registry.sol/Registry.json +597 -122
  117. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.dbg.json +4 -0
  118. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.json +1237 -0
  119. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.dbg.json +4 -0
  120. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.json +525 -0
  121. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.dbg.json +4 -0
  122. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.json +410 -0
  123. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.dbg.json +4 -0
  124. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.json +107 -0
  125. package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json +1 -1
  126. package/artifacts/contracts/shared/ERC165.sol/ERC165.json +2 -2
  127. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.dbg.json +4 -0
  128. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.json +127 -0
  129. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +1 -1
  130. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.json +117 -37
  131. package/artifacts/contracts/shared/IService.sol/IService.dbg.json +4 -0
  132. package/artifacts/contracts/{instance/base → shared}/IService.sol/IService.json +175 -54
  133. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.dbg.json +1 -1
  134. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json +55 -14
  135. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.dbg.json +4 -0
  136. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.json +158 -0
  137. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.dbg.json +4 -0
  138. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.json +349 -0
  139. package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +1 -1
  140. package/artifacts/contracts/shared/Registerable.sol/Registerable.json +190 -37
  141. package/artifacts/contracts/shared/RegisterableUpgradable.sol/RegisterableUpgradable.dbg.json +4 -0
  142. package/artifacts/contracts/{instance/base/InstanceBase.sol/InstanceBase.json → shared/RegisterableUpgradable.sol/RegisterableUpgradable.json} +199 -83
  143. package/artifacts/contracts/shared/Service.sol/Service.dbg.json +4 -0
  144. package/artifacts/contracts/shared/Service.sol/Service.json +468 -0
  145. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.dbg.json +4 -0
  146. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.json +96 -0
  147. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.dbg.json +4 -0
  148. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.json +129 -0
  149. package/artifacts/contracts/shared/Versionable.sol/Versionable.dbg.json +1 -1
  150. package/artifacts/contracts/shared/Versionable.sol/Versionable.json +78 -14
  151. package/artifacts/contracts/test/TestFee.sol/TestFee.dbg.json +1 -1
  152. package/artifacts/contracts/test/TestFee.sol/TestFee.json +4 -4
  153. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.dbg.json +1 -1
  154. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.json +204 -36
  155. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.dbg.json +1 -1
  156. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.json +14 -14
  157. package/artifacts/contracts/test/TestService.sol/TestService.dbg.json +1 -1
  158. package/artifacts/contracts/test/TestService.sol/TestService.json +283 -62
  159. package/artifacts/contracts/test/TestToken.sol/TestUsdc.dbg.json +1 -1
  160. package/artifacts/contracts/test/TestToken.sol/TestUsdc.json +91 -53
  161. package/artifacts/contracts/test/TestVersion.sol/TestVersion.dbg.json +1 -1
  162. package/artifacts/contracts/test/TestVersion.sol/TestVersion.json +2 -2
  163. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.dbg.json +1 -1
  164. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.json +103 -23
  165. package/artifacts/contracts/test/Usdc.sol/USDC.dbg.json +1 -1
  166. package/artifacts/contracts/test/Usdc.sol/USDC.json +91 -53
  167. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.dbg.json +1 -1
  168. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
  169. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.dbg.json +1 -1
  170. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.dbg.json +4 -0
  171. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.json +104 -0
  172. package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +1 -1
  173. package/artifacts/contracts/types/Fee.sol/FeeLib.json +52 -13
  174. package/artifacts/contracts/types/Key32.sol/Key32Lib.dbg.json +1 -1
  175. package/artifacts/contracts/types/Key32.sol/Key32Lib.json +31 -17
  176. package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
  177. package/artifacts/contracts/types/NftId.sol/NftIdLib.json +2 -2
  178. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +1 -1
  179. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +2 -2
  180. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.dbg.json +4 -0
  181. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.json +100 -0
  182. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +1 -1
  183. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +2 -2
  184. package/artifacts/contracts/types/Referral.sol/ReferralLib.dbg.json +4 -0
  185. package/artifacts/contracts/types/Referral.sol/ReferralLib.json +123 -0
  186. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.dbg.json +4 -0
  187. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.json +86 -0
  188. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.dbg.json +1 -1
  189. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.json +134 -8
  190. package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +1 -1
  191. package/artifacts/contracts/types/StateId.sol/StateIdLib.json +2 -2
  192. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
  193. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.json +15 -2
  194. package/artifacts/contracts/types/UFixed.sol/MathLib.dbg.json +4 -0
  195. package/artifacts/contracts/types/UFixed.sol/MathLib.json +10 -0
  196. package/artifacts/contracts/types/UFixed.sol/UFixedLib.dbg.json +4 -0
  197. package/artifacts/contracts/types/UFixed.sol/{UFixedMathLib.json → UFixedLib.json} +3 -3
  198. package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +1 -1
  199. package/artifacts/contracts/types/Version.sol/VersionLib.json +40 -2
  200. package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +1 -1
  201. package/artifacts/contracts/types/Version.sol/VersionPartLib.json +22 -3
  202. package/contracts/components/BaseComponent.sol +26 -23
  203. package/contracts/components/Distribution.sol +160 -0
  204. package/contracts/components/IBaseComponent.sol +9 -3
  205. package/contracts/components/IDistributionComponent.sol +44 -0
  206. package/contracts/components/IPoolComponent.sol +14 -9
  207. package/contracts/components/IProductComponent.sol +25 -9
  208. package/contracts/components/Pool.sol +98 -29
  209. package/contracts/components/Product.sol +212 -32
  210. package/contracts/experiment/cloning/Cloner.sol +47 -0
  211. package/contracts/instance/AccessManagedSimple.sol +115 -0
  212. package/contracts/instance/AccessManagerSimple.sol +692 -0
  213. package/contracts/instance/IAccessManagerSimple.sol +391 -0
  214. package/contracts/instance/IInstance.sol +32 -45
  215. package/contracts/instance/IInstanceService.sol +30 -0
  216. package/contracts/instance/Instance.sol +426 -51
  217. package/contracts/instance/InstanceAccessManager.sol +288 -0
  218. package/contracts/instance/InstanceReader.sol +306 -0
  219. package/contracts/instance/InstanceService.sol +182 -0
  220. package/contracts/instance/InstanceServiceManager.sol +56 -0
  221. package/contracts/instance/base/ComponentServiceBase.sol +93 -10
  222. package/contracts/instance/base/IInstanceBase.sol +11 -2
  223. package/contracts/instance/base/IKeyValueStore.sol +13 -13
  224. package/contracts/instance/base/ILifecycle.sol +3 -3
  225. package/contracts/instance/base/KeyValueStore.sol +53 -37
  226. package/contracts/instance/base/Lifecycle.sol +16 -11
  227. package/contracts/instance/module/IAccess.sol +38 -0
  228. package/contracts/instance/module/IBundle.sol +20 -0
  229. package/contracts/instance/module/IDistribution.sol +39 -0
  230. package/contracts/instance/module/IPolicy.sol +45 -0
  231. package/contracts/instance/module/IRisk.sol +11 -0
  232. package/contracts/instance/module/ISetup.sol +44 -0
  233. package/contracts/instance/module/ITreasury.sol +23 -0
  234. package/contracts/instance/service/ComponentOwnerService.sol +244 -97
  235. package/contracts/instance/service/DistributionService.sol +87 -0
  236. package/contracts/instance/service/DistributionServiceManager.sol +53 -0
  237. package/contracts/instance/service/IComponentOwnerService.sol +1 -3
  238. package/contracts/instance/service/IDistributionService.sol +12 -0
  239. package/contracts/instance/service/IPoolService.sol +8 -1
  240. package/contracts/instance/service/IProductService.sol +56 -7
  241. package/contracts/instance/service/PoolService.sol +117 -47
  242. package/contracts/instance/service/PoolServiceManager.sol +53 -0
  243. package/contracts/registry/ChainNft.sol +80 -37
  244. package/contracts/registry/IRegistry.sol +62 -25
  245. package/contracts/registry/IRegistryService.sol +33 -0
  246. package/contracts/registry/ITransferInterceptor.sol +6 -0
  247. package/contracts/registry/Registry.sol +375 -267
  248. package/contracts/registry/RegistryService.sol +399 -0
  249. package/contracts/registry/RegistryServiceManager.sol +80 -0
  250. package/contracts/registry/TokenRegistry.sol +111 -0
  251. package/contracts/shared/ContractDeployerLib.sol +72 -0
  252. package/contracts/shared/ERC165.sol +6 -2
  253. package/contracts/shared/INftOwnable.sol +22 -0
  254. package/contracts/shared/IRegisterable.sol +8 -15
  255. package/contracts/{instance/base → shared}/IService.sol +3 -3
  256. package/contracts/shared/IVersionable.sol +55 -11
  257. package/contracts/shared/NftOwnable.sol +136 -0
  258. package/contracts/shared/ProxyManager.sol +94 -0
  259. package/contracts/shared/Registerable.sol +63 -59
  260. package/contracts/shared/RegisterableUpgradable.sol +16 -0
  261. package/contracts/shared/Service.sol +55 -0
  262. package/contracts/shared/TokenHandler.sol +27 -0
  263. package/contracts/shared/UpgradableProxyWithAdmin.sol +16 -0
  264. package/contracts/shared/Versionable.sol +113 -55
  265. package/contracts/test/TestFee.sol +2 -2
  266. package/contracts/test/TestRegisterable.sol +5 -6
  267. package/contracts/test/TestRoleId.sol +1 -1
  268. package/contracts/test/TestService.sol +5 -13
  269. package/contracts/types/DistributorType.sol +55 -0
  270. package/contracts/types/Fee.sol +10 -5
  271. package/contracts/types/Key32.sol +8 -3
  272. package/contracts/types/NumberId.sol +52 -0
  273. package/contracts/types/ObjectType.sol +51 -14
  274. package/contracts/types/Referral.sol +85 -0
  275. package/contracts/types/RiskId.sol +43 -0
  276. package/contracts/types/RoleId.sol +61 -10
  277. package/contracts/types/StateId.sol +5 -1
  278. package/contracts/types/Timestamp.sol +7 -3
  279. package/contracts/types/UFixed.sol +128 -12
  280. package/contracts/types/Version.sol +13 -1
  281. package/package.json +4 -3
  282. package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.dbg.json +0 -4
  283. package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.json +0 -24
  284. package/artifacts/contracts/instance/base/IService.sol/IService.dbg.json +0 -4
  285. package/artifacts/contracts/instance/base/InstanceBase.sol/InstanceBase.dbg.json +0 -4
  286. package/artifacts/contracts/instance/base/ModuleBase.sol/ModuleBase.dbg.json +0 -4
  287. package/artifacts/contracts/instance/base/ServiceBase.sol/ServiceBase.dbg.json +0 -4
  288. package/artifacts/contracts/instance/module/access/Access.sol/AccessModule.dbg.json +0 -4
  289. package/artifacts/contracts/instance/module/access/Access.sol/AccessModule.json +0 -333
  290. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccess.dbg.json +0 -4
  291. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccessModule.dbg.json +0 -4
  292. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccessModule.json +0 -333
  293. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.dbg.json +0 -4
  294. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.json +0 -296
  295. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundle.dbg.json +0 -4
  296. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.dbg.json +0 -4
  297. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.json +0 -296
  298. package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.dbg.json +0 -4
  299. package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.json +0 -10
  300. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensation.dbg.json +0 -4
  301. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensation.json +0 -10
  302. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensationModule.dbg.json +0 -4
  303. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensationModule.json +0 -10
  304. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.dbg.json +0 -4
  305. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.json +0 -188
  306. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.dbg.json +0 -4
  307. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.json +0 -10
  308. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.dbg.json +0 -4
  309. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.json +0 -188
  310. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicy.dbg.json +0 -4
  311. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.dbg.json +0 -4
  312. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.json +0 -261
  313. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.dbg.json +0 -4
  314. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.json +0 -261
  315. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPool.dbg.json +0 -4
  316. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPool.json +0 -10
  317. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.dbg.json +0 -4
  318. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.json +0 -149
  319. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.dbg.json +0 -4
  320. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.json +0 -149
  321. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRisk.dbg.json +0 -4
  322. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.dbg.json +0 -4
  323. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.json +0 -10
  324. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.dbg.json +0 -4
  325. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.json +0 -10
  326. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasury.dbg.json +0 -4
  327. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.dbg.json +0 -4
  328. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.json +0 -533
  329. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.dbg.json +0 -4
  330. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.json +0 -76
  331. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.dbg.json +0 -4
  332. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.json +0 -533
  333. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.dbg.json +0 -4
  334. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.json +0 -673
  335. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.dbg.json +0 -4
  336. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.json +0 -452
  337. package/artifacts/contracts/registry/IRegistryLinked.sol/IRegistryLinked.dbg.json +0 -4
  338. package/artifacts/contracts/registry/IRegistryLinked.sol/IRegistryLinked.json +0 -24
  339. package/artifacts/contracts/shared/IOwnable.sol/IOwnable.dbg.json +0 -4
  340. package/artifacts/contracts/shared/IOwnable.sol/IOwnable.json +0 -24
  341. package/artifacts/contracts/test/TestPool.sol/TestPool.dbg.json +0 -4
  342. package/artifacts/contracts/test/TestPool.sol/TestPool.json +0 -387
  343. package/artifacts/contracts/test/TestProduct.sol/TestProduct.dbg.json +0 -4
  344. package/artifacts/contracts/test/TestProduct.sol/TestProduct.json +0 -393
  345. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.dbg.json +0 -4
  346. package/contracts/experiment/statemachine/README.md +0 -112
  347. package/contracts/instance/IInstanceLinked.sol +0 -8
  348. package/contracts/instance/base/InstanceBase.sol +0 -80
  349. package/contracts/instance/base/ModuleBase.sol +0 -52
  350. package/contracts/instance/base/ServiceBase.sol +0 -37
  351. package/contracts/instance/module/access/Access.sol +0 -149
  352. package/contracts/instance/module/access/IAccess.sol +0 -53
  353. package/contracts/instance/module/bundle/BundleModule.sol +0 -136
  354. package/contracts/instance/module/bundle/IBundle.sol +0 -58
  355. package/contracts/instance/module/compensation/CompensationModule.sol +0 -8
  356. package/contracts/instance/module/compensation/ICompensation.sol +0 -10
  357. package/contracts/instance/module/component/ComponentModule.sol +0 -95
  358. package/contracts/instance/module/component/IComponent.sol +0 -53
  359. package/contracts/instance/module/policy/IPolicy.sol +0 -60
  360. package/contracts/instance/module/policy/PolicyModule.sol +0 -76
  361. package/contracts/instance/module/pool/IPoolModule.sol +0 -41
  362. package/contracts/instance/module/pool/PoolModule.sol +0 -87
  363. package/contracts/instance/module/risk/IRisk.sol +0 -10
  364. package/contracts/instance/module/risk/RiskModule.sol +0 -8
  365. package/contracts/instance/module/treasury/ITreasury.sol +0 -103
  366. package/contracts/instance/module/treasury/TokenHandler.sol +0 -48
  367. package/contracts/instance/module/treasury/TreasuryModule.sol +0 -152
  368. package/contracts/instance/service/ProductService.sol +0 -354
  369. package/contracts/registry/IChainNft.sol +0 -21
  370. package/contracts/registry/IRegistryLinked.sol +0 -8
  371. package/contracts/shared/IOwnable.sol +0 -6
  372. package/contracts/test/TestPool.sol +0 -22
  373. package/contracts/test/TestProduct.sol +0 -44
@@ -0,0 +1,22 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {IRegistry} from "../registry/IRegistry.sol";
5
+ import {NftId} from "../types/NftId.sol";
6
+
7
+ interface INftOwnable {
8
+ error ErrorNotOwner(address account);
9
+
10
+ error ErrorAlreadyLinked(address registry, NftId nftId);
11
+ error ErrorRegistryAlreadyInitialized(address registry);
12
+ error ErrorRegistryNotInitialized();
13
+ error ErrorRegistryAddressZero();
14
+ error ErrorNotRegistry(address registryAddress);
15
+ error ErrorContractNotRegistered(address contractAddress);
16
+
17
+ function linkToRegisteredNftId() external;
18
+
19
+ function getRegistry() external view returns (IRegistry);
20
+ function getNftId() external view returns (NftId);
21
+ function getOwner() external view returns (address);
22
+ }
@@ -1,24 +1,17 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
- pragma solidity ^0.8.19;
2
+ pragma solidity ^0.8.20;
3
3
 
4
4
  import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
5
5
 
6
+ import {INftOwnable} from "./INftOwnable.sol";
6
7
  import {IRegistry} from "../registry/IRegistry.sol";
7
8
  import {NftId} from "../types/NftId.sol";
8
9
  import {ObjectType} from "../types/ObjectType.sol";
9
10
 
10
- import {IOwnable} from "./IOwnable.sol";
11
+ interface IRegisterable is IERC165, INftOwnable {
11
12
 
12
- interface IRegisterable is IERC165, IOwnable {
13
- function getRegistry() external view returns (IRegistry registry);
14
-
15
- function register() external returns (NftId nftId);
16
-
17
- function getType() external pure returns (ObjectType objectType);
18
-
19
- function getNftId() external view returns (NftId nftId);
20
-
21
- function getParentNftId() external view returns (NftId nftId);
22
-
23
- function getData() external view returns (bytes memory data);
24
- }
13
+ function getInitialInfo()
14
+ external
15
+ view
16
+ returns (IRegistry.ObjectInfo memory, bytes memory data);
17
+ }
@@ -1,10 +1,10 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
2
  pragma solidity ^0.8.19;
3
3
 
4
- import {VersionPart} from "../../types/Version.sol";
4
+ import {VersionPart} from "../types/Version.sol";
5
5
 
6
- import {IRegisterable} from "../../shared/IRegisterable.sol";
7
- import {IVersionable} from "../../shared/IVersionable.sol";
6
+ import {IRegisterable} from "./IRegisterable.sol";
7
+ import {IVersionable} from "./IVersionable.sol";
8
8
 
9
9
  interface IService is
10
10
  IRegisterable,
@@ -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
  }
@@ -0,0 +1,136 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {INftOwnable} from "./INftOwnable.sol";
5
+ import {IRegistry} from "../registry/IRegistry.sol";
6
+ import {NftId, zeroNftId} from "../types/NftId.sol";
7
+
8
+ contract NftOwnable is INftOwnable {
9
+
10
+ IRegistry internal _registry;
11
+ NftId private _nftId;
12
+ address private _initialOwner;
13
+
14
+ /// @dev enforces msg.sender is owner of nft (or initial owner of nft ownable)
15
+ modifier onlyOwner() {
16
+ address owner = getOwner();
17
+
18
+ // owner == address(0) is eg uninitialized upgradable contract
19
+ if (owner != address(0) && msg.sender != owner) {
20
+ revert ErrorNotOwner(msg.sender);
21
+ }
22
+ _;
23
+ }
24
+
25
+ constructor() {
26
+ _initialOwner = msg.sender;
27
+ }
28
+
29
+ /// @dev links this contract to nft after registration
30
+ // needs to be done once per registered contract and
31
+ // reduces registry calls to check ownership
32
+ // does not need any protection as function can only do the "right thing"
33
+ function linkToRegisteredNftId() public {
34
+ if (_nftId.gtz()) {
35
+ revert ErrorAlreadyLinked(address(_registry), _nftId);
36
+ }
37
+
38
+ if (address(_registry) == address(0)) {
39
+ revert ErrorRegistryNotInitialized();
40
+ }
41
+
42
+ address contractAddress = address(this);
43
+
44
+ if (!_registry.isRegistered(contractAddress)) {
45
+ revert ErrorContractNotRegistered(contractAddress);
46
+ }
47
+
48
+ _nftId = _registry.getNftId(contractAddress);
49
+ }
50
+
51
+
52
+ function getRegistry() public view virtual override returns (IRegistry) {
53
+ return _registry;
54
+ }
55
+
56
+
57
+ function getNftId() public view virtual override returns (NftId) {
58
+ return _nftId;
59
+ }
60
+
61
+
62
+ function getOwner() public view virtual override returns (address) {
63
+ if (_nftId.gtz()) {
64
+ return _registry.ownerOf(_nftId);
65
+ }
66
+
67
+ return _initialOwner;
68
+ }
69
+
70
+
71
+ /// @dev initialization for upgradable contracts
72
+ // used in _initializeRegisterable
73
+ function _initializeNftOwnable(
74
+ address initialOwner,
75
+ address registryAddress
76
+ )
77
+ internal
78
+ virtual
79
+ {
80
+ _initialOwner = initialOwner;
81
+ _setRegistry(registryAddress);
82
+ }
83
+
84
+
85
+ /// @dev used in constructor of registry service manager
86
+ // links ownership of registry service manager ot nft owner of registry service
87
+ function _linkToNftOwnable(
88
+ address registryAddress,
89
+ address nftOwnableAddress
90
+ )
91
+ internal
92
+ onlyOwner()
93
+ returns (NftId)
94
+ {
95
+ if (_nftId.gtz()) {
96
+ revert ErrorAlreadyLinked(address(_registry), _nftId);
97
+ }
98
+
99
+ _setRegistry(registryAddress);
100
+
101
+ if (!_registry.isRegistered(nftOwnableAddress)) {
102
+ revert ErrorContractNotRegistered(nftOwnableAddress);
103
+ }
104
+
105
+ _nftId = _registry.getNftId(nftOwnableAddress);
106
+
107
+ return _nftId;
108
+ }
109
+
110
+
111
+ function _setRegistry(address registryAddress)
112
+ private
113
+ {
114
+ if (address(_registry) != address(0)) {
115
+ revert ErrorRegistryAlreadyInitialized(address(_registry));
116
+ }
117
+
118
+ if (registryAddress == address(0)) {
119
+ revert ErrorRegistryAddressZero();
120
+ }
121
+
122
+ if (registryAddress.code.length == 0) {
123
+ revert ErrorNotRegistry(registryAddress);
124
+ }
125
+
126
+ _registry = IRegistry(registryAddress);
127
+
128
+ try _registry.supportsInterface(type(IRegistry).interfaceId) returns (bool isRegistry) {
129
+ if (!isRegistry) {
130
+ revert ErrorNotRegistry(registryAddress);
131
+ }
132
+ } catch {
133
+ revert ErrorNotRegistry(registryAddress);
134
+ }
135
+ }
136
+ }
@@ -0,0 +1,94 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
5
+ import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
6
+ import {ITransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
7
+
8
+ import {IVersionable} from "./IVersionable.sol";
9
+ import {NftOwnable} from "./NftOwnable.sol";
10
+ import {UpgradableProxyWithAdmin} from "./UpgradableProxyWithAdmin.sol";
11
+
12
+ /// @dev manages proxy deployments for upgradable contracs of type IVersionable
13
+ contract ProxyManager is
14
+ NftOwnable
15
+ {
16
+
17
+ event LogProxyDeployed(address indexed proxy, address initialImplementation);
18
+ event LogProxyDeployedWithSalt(address indexed proxy, address initialImplementation);
19
+ event LogProxyUpgraded(address indexed proxy, address upgradedImplementation);
20
+
21
+ error ErrorAlreadyDeployed();
22
+ error ErrorAlreadyDeployedWithSalt();
23
+ error ErrorNotYetDeployed();
24
+
25
+ UpgradableProxyWithAdmin internal _proxy;
26
+ bool internal _isDeployed;
27
+
28
+ /// @dev only used to capture proxy owner
29
+ constructor()
30
+ NftOwnable()
31
+ { }
32
+
33
+ /// @dev deploy initial contract
34
+ function deploy(address initialImplementation, bytes memory initializationData)
35
+ public
36
+ virtual
37
+ onlyOwner()
38
+ returns (IVersionable versionable)
39
+ {
40
+ if (_isDeployed) { revert ErrorAlreadyDeployed(); }
41
+
42
+ address currentProxyOwner = getOwner(); // used by implementation
43
+ address initialProxyAdminOwner = address(this); // used by proxy
44
+ bytes memory data = getDeployData(initialImplementation, currentProxyOwner, initializationData);
45
+
46
+ _proxy = new UpgradableProxyWithAdmin(
47
+ initialImplementation,
48
+ initialProxyAdminOwner,
49
+ data
50
+ );
51
+
52
+ _isDeployed = true;
53
+ versionable = IVersionable(address(_proxy));
54
+
55
+ emit LogProxyDeployed(address(_proxy), initialImplementation);
56
+ }
57
+
58
+ /// @dev upgrade existing contract
59
+ function upgrade(address newImplementation, bytes memory upgradeData)
60
+ public
61
+ virtual
62
+ onlyOwner()
63
+ returns (IVersionable versionable)
64
+ {
65
+ if (!_isDeployed) { revert ErrorNotYetDeployed(); }
66
+
67
+ address currentProxyOwner = getOwner();
68
+ ProxyAdmin proxyAdmin = getProxy().getProxyAdmin();
69
+ ITransparentUpgradeableProxy proxy = ITransparentUpgradeableProxy(address(_proxy));
70
+ bytes memory data = getUpgradeData(newImplementation, currentProxyOwner, upgradeData);
71
+
72
+ proxyAdmin.upgradeAndCall(
73
+ proxy,
74
+ newImplementation,
75
+ data);
76
+
77
+ versionable = IVersionable(address(_proxy));
78
+
79
+ emit LogProxyUpgraded(address(_proxy), newImplementation);
80
+
81
+ }
82
+
83
+ function getDeployData(address implementation, address proxyOwner, bytes memory deployData) public pure returns (bytes memory data) {
84
+ return abi.encodeWithSelector(IVersionable.initialize.selector, implementation, proxyOwner, deployData);
85
+ }
86
+
87
+ function getUpgradeData(address implementation, address proxyOwner, bytes memory upgradeData) public pure returns (bytes memory data) {
88
+ return abi.encodeWithSelector(IVersionable.upgrade.selector, implementation, proxyOwner, upgradeData);
89
+ }
90
+
91
+ function getProxy() public returns (UpgradableProxyWithAdmin) {
92
+ return _proxy;
93
+ }
94
+ }
@@ -1,86 +1,90 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
- pragma solidity ^0.8.19;
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
3
5
 
4
6
  import {NftId, zeroNftId} from "../types/NftId.sol";
7
+ import {NftOwnable} from "../shared/NftOwnable.sol";
5
8
  import {ObjectType} from "../types/ObjectType.sol";
6
9
 
7
10
  import {IRegistry} from "../registry/IRegistry.sol";
8
11
  import {IRegisterable} from "./IRegisterable.sol";
12
+ import {Versionable} from "./Versionable.sol";
9
13
 
10
14
  import {ERC165} from "./ERC165.sol";
11
15
 
12
- abstract contract Registerable is
16
+ contract Registerable is
13
17
  ERC165,
18
+ Initializable,
19
+ NftOwnable,
14
20
  IRegisterable
15
21
  {
16
- IRegistry internal immutable _registry;
17
- NftId internal immutable _parentNftId;
18
- address internal immutable _initialOwner;
22
+ // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.shared.Registerable.sol")) - 1)) & ~bytes32(uint256(0xff));
23
+ bytes32 public constant REGISTERABLE_LOCATION_V1 = 0x6548007c3f4340f82f348c576c0ff69f4f529cadd5ad41f96aae61abceeaa300;
19
24
 
20
- modifier onlyOwner() virtual {
21
- require(
22
- msg.sender == getOwner(),
23
- "ERROR:RGB-001:NOT_OWNER"
24
- );
25
- _;
25
+ error ErrorRegisterableNotRegistry(address registryAddress);
26
+
27
+ struct RegisterableStorage {
28
+ NftId _parentNftId;
29
+ ObjectType _objectType;
30
+ bool _isInterceptor;
31
+ bytes _data;
32
+ }
33
+
34
+ function _getRegisterableStorage() private pure returns (RegisterableStorage storage $) {
35
+ assembly {
36
+ $.slot := REGISTERABLE_LOCATION_V1
37
+ }
26
38
  }
27
39
 
28
- constructor(
40
+ function _initializeRegisterable(
29
41
  address registryAddress,
30
- NftId parentNftId
42
+ NftId parentNftId,
43
+ ObjectType objectType,
44
+ bool isInterceptor,
45
+ address initialOwner,
46
+ bytes memory data
31
47
  )
32
- ERC165()
48
+ internal
49
+ //onlyInitializing//TODO uncomment when "fully" upgradeable
50
+ virtual
33
51
  {
34
- require(
35
- address(registryAddress) != address(0),
36
- "ERROR:RGB-010:REGISTRY_ZERO"
37
- );
38
-
39
- _registry = IRegistry(registryAddress);
40
- require(
41
- _registry.supportsInterface(type(IRegistry).interfaceId),
42
- "ERROR:RGB-011:NOT_REGISTRY"
43
- );
52
+ _initializeERC165();
53
+ _initializeNftOwnable(
54
+ initialOwner,
55
+ registryAddress);
44
56
 
45
- _parentNftId = parentNftId;
46
- require(
47
- _registry.isRegistered(_parentNftId),
48
- "ERROR:RGB-012:PARENT_NOT_REGISTERED"
49
- );
57
+ // TODO check parentNftId -> registry.isRegistered(parentNftId)
58
+ // TODO check object-parent type pair -> registry.isValidTypeCombo() or something...verify with registry that setup will be able to register...
50
59
 
51
- _initialOwner = msg.sender;
60
+ RegisterableStorage storage $ = _getRegisterableStorage();
61
+ $._parentNftId = parentNftId;
62
+ $._objectType = objectType;
63
+ $._isInterceptor = isInterceptor;
64
+ $._data = data;
52
65
 
53
- // register support for IRegisterable
54
66
  _registerInterface(type(IRegisterable).interfaceId);
55
67
  }
56
68
 
57
- // from IRegistryLinked
58
- function register() public onlyOwner virtual override returns (NftId nftId) {
59
- return _registry.register(address(this));
60
- }
61
69
 
62
- function getRegistry() public view virtual override returns (IRegistry registry) {
63
- return _registry;
64
- }
65
-
66
- function getOwner() public view virtual override returns (address owner) {
67
- NftId nftId = _registry.getNftId(address(this));
68
- if(nftId == zeroNftId()) {
69
- return _initialOwner;
70
- }
71
-
72
- return _registry.getOwner(nftId);
73
- }
74
-
75
- function getNftId() public view override returns (NftId nftId) {
76
- return _registry.getNftId(address(this));
77
- }
78
-
79
- function getParentNftId() public view override returns (NftId nftId) {
80
- return _parentNftId;
81
- }
82
-
83
- function getData() public view virtual override returns (bytes memory data) {
84
- return "";
70
+ function getInitialInfo()
71
+ public
72
+ view
73
+ virtual
74
+ returns (IRegistry.ObjectInfo memory, bytes memory data)
75
+ {
76
+ RegisterableStorage storage $ = _getRegisterableStorage();
77
+ return (
78
+ IRegistry.ObjectInfo(
79
+ getNftId(),
80
+ $._parentNftId,
81
+ $._objectType,
82
+ $._isInterceptor,
83
+ address(this),
84
+ getOwner(),
85
+ $._data
86
+ ),
87
+ bytes("")
88
+ );
85
89
  }
86
- }
90
+ }
@@ -0,0 +1,16 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ import {Registerable} from "./Registerable.sol";
5
+ import {Versionable} from "./Versionable.sol";
6
+
7
+ /// @dev base contract for upgradable objects like services and upgradable components
8
+ /// deriving contracs need to call _initializeRegisterable
9
+ /// TODO internalizes versionable here, a non-registerable versionalbe might itself have some value but is outside the scope of the gif
10
+ /// after this merge versionable will no longer exist on its own in gif
11
+ /// only registerable and upgradable (which is a registerable too) will remain
12
+ abstract contract RegisterableUpgradable is
13
+ Registerable,
14
+ Versionable
15
+ {
16
+ }
@@ -0,0 +1,55 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ import {IRegistry} from "../registry/IRegistry.sol";
5
+ import {IService} from "./IService.sol";
6
+ import {IVersionable} from "./IVersionable.sol";
7
+ import {NftId, zeroNftId} from "../types/NftId.sol";
8
+ import {RegisterableUpgradable} from "./RegisterableUpgradable.sol";
9
+ import {SERVICE} from "../types/ObjectType.sol";
10
+ import {Version, VersionPart, VersionLib} from "../types/Version.sol";
11
+ import {Versionable} from "./Versionable.sol";
12
+
13
+ /// @dev service base contract
14
+ abstract contract Service is
15
+ RegisterableUpgradable,
16
+ IService
17
+ {
18
+ function getName() public pure virtual override returns(string memory name);
19
+
20
+ function getMajorVersion() public view virtual override returns(VersionPart majorVersion) {
21
+ return getVersion().toMajorPart();
22
+ }
23
+
24
+ // from Versionable
25
+ function getVersion()
26
+ public
27
+ pure
28
+ virtual override (IVersionable, Versionable)
29
+ returns(Version)
30
+ {
31
+ return VersionLib.toVersion(3,0,0);
32
+ }
33
+
34
+ function _initializeService(
35
+ address registry,
36
+ address initialOwner
37
+ )
38
+ internal
39
+ virtual
40
+ //onlyInitializing //TODO uncomment when "fully" upgradeable
41
+ {
42
+ // service must provide its name and version upon registration
43
+ bytes memory data = abi.encode(getName(), getMajorVersion());
44
+ NftId registryNftId = _getRegistryNftId(registry);
45
+ bool isInterceptor = false;
46
+
47
+ _initializeRegisterable(registry, registryNftId, SERVICE(), isInterceptor, initialOwner, data);
48
+ _registerInterface(type(IService).interfaceId);
49
+ }
50
+
51
+ // this is just a conveniene function, actual validation will be done upon registration
52
+ function _getRegistryNftId(address registryAddress) internal view returns (NftId) {
53
+ return IRegistry(registryAddress).getNftId(registryAddress);
54
+ }
55
+ }
@@ -0,0 +1,27 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
5
+ import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
6
+
7
+ contract TokenHandler {
8
+ IERC20Metadata private _token;
9
+
10
+ constructor(address token) {
11
+ _token = IERC20Metadata(token);
12
+ }
13
+
14
+ // TODO add logging
15
+ function transfer(
16
+ address from,
17
+ address to,
18
+ uint256 amount // TODO add authz (only treasury/instance/product/pool/ service)
19
+ ) external {
20
+ SafeERC20.safeTransferFrom(_token, from, to, amount);
21
+ // _token.transferFrom(from, to, amount);
22
+ }
23
+
24
+ function getToken() external view returns (IERC20Metadata) {
25
+ return _token;
26
+ }
27
+ }
@@ -0,0 +1,16 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
5
+ import {TransparentUpgradeableProxy, ITransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
6
+
7
+ import {IVersionable} from "./IVersionable.sol";
8
+
9
+ contract UpgradableProxyWithAdmin is TransparentUpgradeableProxy {
10
+
11
+ constructor(address implementation, address initialProxyAdminOwner, bytes memory data)
12
+ TransparentUpgradeableProxy(implementation, initialProxyAdminOwner, data)
13
+ {}
14
+
15
+ function getProxyAdmin() external returns (ProxyAdmin) { return ProxyAdmin(_proxyAdmin()); }
16
+ }