@etherisc/gif-next 0.0.2-fc8b370-882 → 0.0.2-fca9315-260

Sign up to get free protection for your applications and to get access to all the features.
Files changed (407) hide show
  1. package/README.md +242 -2
  2. package/artifacts/contracts/components/Component.sol/Component.dbg.json +4 -0
  3. package/artifacts/contracts/components/Component.sol/Component.json +656 -0
  4. package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json +4 -0
  5. package/artifacts/contracts/components/Distribution.sol/Distribution.json +849 -0
  6. package/artifacts/contracts/components/IComponent.sol/IComponent.dbg.json +4 -0
  7. package/artifacts/contracts/{registry/IChainNft.sol/IChainNft.json → components/IComponent.sol/IComponent.json} +244 -241
  8. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.dbg.json +4 -0
  9. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.json +648 -0
  10. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.dbg.json +1 -1
  11. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.json +485 -72
  12. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.dbg.json +1 -1
  13. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.json +533 -64
  14. package/artifacts/contracts/components/Pool.sol/Pool.dbg.json +1 -1
  15. package/artifacts/contracts/components/Pool.sol/Pool.json +659 -76
  16. package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
  17. package/artifacts/contracts/components/Product.sol/Product.json +711 -67
  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/BundleManager.sol/BundleManager.dbg.json +4 -0
  45. package/artifacts/contracts/instance/BundleManager.sol/BundleManager.json +764 -0
  46. package/artifacts/contracts/instance/Cloneable.sol/Cloneable.dbg.json +4 -0
  47. package/artifacts/contracts/instance/Cloneable.sol/Cloneable.json +185 -0
  48. package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
  49. package/artifacts/contracts/instance/IInstance.sol/IInstance.json +1137 -1023
  50. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.dbg.json +4 -0
  51. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.json +586 -0
  52. package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
  53. package/artifacts/contracts/instance/Instance.sol/Instance.json +1987 -1124
  54. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.dbg.json +4 -0
  55. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.json +1034 -0
  56. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.dbg.json +4 -0
  57. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.json +1381 -0
  58. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.dbg.json +4 -0
  59. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.json +1024 -0
  60. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.dbg.json +4 -0
  61. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.json +473 -0
  62. package/artifacts/contracts/instance/ObjectManager.sol/ObjectManager.dbg.json +4 -0
  63. package/artifacts/contracts/instance/ObjectManager.sol/ObjectManager.json +261 -0
  64. package/artifacts/contracts/instance/base/ComponentService.sol/ComponentService.dbg.json +4 -0
  65. package/artifacts/contracts/instance/base/ComponentService.sol/ComponentService.json +603 -0
  66. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.dbg.json +1 -1
  67. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.json +45 -127
  68. package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.dbg.json +1 -1
  69. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.dbg.json +1 -1
  70. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.json +55 -245
  71. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.dbg.json +1 -1
  72. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.json +4 -4
  73. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.dbg.json +4 -0
  74. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.json +254 -0
  75. package/artifacts/contracts/instance/module/IBundle.sol/IBundle.dbg.json +4 -0
  76. package/artifacts/contracts/instance/module/{bundle/IBundle.sol → IBundle.sol}/IBundle.json +1 -1
  77. package/artifacts/contracts/instance/module/IDistribution.sol/IDistribution.dbg.json +4 -0
  78. package/artifacts/contracts/instance/module/{access/IAccess.sol/IAccess.json → IDistribution.sol/IDistribution.json} +2 -2
  79. package/artifacts/contracts/instance/module/IPolicy.sol/IPolicy.dbg.json +4 -0
  80. package/artifacts/contracts/instance/module/{policy/IPolicy.sol → IPolicy.sol}/IPolicy.json +1 -1
  81. package/artifacts/contracts/instance/module/IRisk.sol/IRisk.dbg.json +4 -0
  82. package/artifacts/contracts/instance/module/{risk/IRisk.sol → IRisk.sol}/IRisk.json +1 -1
  83. package/artifacts/contracts/instance/module/ISetup.sol/ISetup.dbg.json +4 -0
  84. package/artifacts/contracts/instance/{base/ModuleBase.sol/ModuleBase.json → module/ISetup.sol/ISetup.json} +2 -2
  85. package/artifacts/contracts/instance/module/ITreasury.sol/ITreasury.dbg.json +4 -0
  86. package/artifacts/contracts/instance/module/{treasury/ITreasury.sol → ITreasury.sol}/ITreasury.json +1 -1
  87. package/artifacts/contracts/instance/service/BundleService.sol/BundleService.dbg.json +4 -0
  88. package/artifacts/contracts/instance/service/BundleService.sol/BundleService.json +1102 -0
  89. package/artifacts/contracts/instance/service/BundleServiceManager.sol/BundleServiceManager.dbg.json +4 -0
  90. package/artifacts/contracts/instance/service/BundleServiceManager.sol/BundleServiceManager.json +449 -0
  91. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.dbg.json +4 -0
  92. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.json +772 -0
  93. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.dbg.json +4 -0
  94. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.json +437 -0
  95. package/artifacts/contracts/instance/service/IBundleService.sol/IBundleService.dbg.json +4 -0
  96. package/artifacts/contracts/instance/service/IBundleService.sol/IBundleService.json +715 -0
  97. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.dbg.json +4 -0
  98. package/artifacts/contracts/instance/{base/IService.sol/IService.json → service/IDistributionService.sol/IDistributionService.json} +202 -61
  99. package/artifacts/contracts/instance/service/IPolicyService.sol/IPolicyService.dbg.json +4 -0
  100. package/artifacts/contracts/instance/service/IPolicyService.sol/IPolicyService.json +766 -0
  101. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +1 -1
  102. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +198 -80
  103. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +1 -1
  104. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +204 -150
  105. package/artifacts/contracts/instance/service/PolicyService.sol/PolicyService.dbg.json +4 -0
  106. package/artifacts/contracts/instance/service/PolicyService.sol/PolicyService.json +1227 -0
  107. package/artifacts/contracts/instance/service/PolicyServiceManager.sol/PolicyServiceManager.dbg.json +4 -0
  108. package/artifacts/contracts/instance/service/PolicyServiceManager.sol/PolicyServiceManager.json +505 -0
  109. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.dbg.json +1 -1
  110. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.json +423 -88
  111. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.dbg.json +4 -0
  112. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.json +437 -0
  113. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.dbg.json +1 -1
  114. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.json +398 -215
  115. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.dbg.json +4 -0
  116. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.json +437 -0
  117. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
  118. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.json +186 -12
  119. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
  120. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.json +455 -36
  121. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.dbg.json +4 -0
  122. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.json +981 -0
  123. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.dbg.json +4 -0
  124. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.json +34 -0
  125. package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
  126. package/artifacts/contracts/registry/Registry.sol/Registry.json +465 -111
  127. package/artifacts/contracts/registry/RegistryAccessManager.sol/RegistryAccessManager.dbg.json +4 -0
  128. package/artifacts/contracts/registry/RegistryAccessManager.sol/RegistryAccessManager.json +285 -0
  129. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.dbg.json +4 -0
  130. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.json +1200 -0
  131. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.dbg.json +4 -0
  132. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.json +464 -0
  133. package/artifacts/contracts/registry/ReleaseManager.sol/ReleaseManager.dbg.json +4 -0
  134. package/artifacts/contracts/registry/ReleaseManager.sol/ReleaseManager.json +547 -0
  135. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.dbg.json +4 -0
  136. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.json +394 -0
  137. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.dbg.json +4 -0
  138. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.json +107 -0
  139. package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json +1 -1
  140. package/artifacts/contracts/shared/ERC165.sol/ERC165.json +2 -2
  141. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.dbg.json +4 -0
  142. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.json +127 -0
  143. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +1 -1
  144. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.json +112 -37
  145. package/artifacts/contracts/shared/IService.sol/IService.dbg.json +4 -0
  146. package/artifacts/contracts/{instance/service/IComponentOwnerService.sol/IComponentOwnerService.json → shared/IService.sol/IService.json} +169 -117
  147. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.dbg.json +1 -1
  148. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json +55 -14
  149. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.dbg.json +4 -0
  150. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.json +171 -0
  151. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.dbg.json +4 -0
  152. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.json +362 -0
  153. package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +1 -1
  154. package/artifacts/contracts/shared/Registerable.sol/Registerable.json +193 -32
  155. package/artifacts/contracts/shared/Service.sol/Service.dbg.json +4 -0
  156. package/artifacts/contracts/{instance/base/InstanceBase.sol/InstanceBase.json → shared/Service.sol/Service.json} +221 -71
  157. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.dbg.json +4 -0
  158. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.json +96 -0
  159. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.dbg.json +4 -0
  160. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.json +129 -0
  161. package/artifacts/contracts/shared/Versionable.sol/Versionable.dbg.json +1 -1
  162. package/artifacts/contracts/shared/Versionable.sol/Versionable.json +78 -14
  163. package/artifacts/contracts/test/TestFee.sol/TestFee.dbg.json +1 -1
  164. package/artifacts/contracts/test/TestFee.sol/TestFee.json +4 -4
  165. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.dbg.json +1 -1
  166. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.json +207 -31
  167. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.dbg.json +1 -1
  168. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.json +14 -14
  169. package/artifacts/contracts/test/TestService.sol/TestService.dbg.json +1 -1
  170. package/artifacts/contracts/test/TestService.sol/TestService.json +292 -63
  171. package/artifacts/contracts/test/TestToken.sol/TestUsdc.dbg.json +1 -1
  172. package/artifacts/contracts/test/TestToken.sol/TestUsdc.json +91 -53
  173. package/artifacts/contracts/test/TestVersion.sol/TestVersion.dbg.json +1 -1
  174. package/artifacts/contracts/test/TestVersion.sol/TestVersion.json +2 -2
  175. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.dbg.json +1 -1
  176. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.json +103 -23
  177. package/artifacts/contracts/test/Usdc.sol/USDC.dbg.json +1 -1
  178. package/artifacts/contracts/test/Usdc.sol/USDC.json +91 -53
  179. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.dbg.json +1 -1
  180. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
  181. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.dbg.json +1 -1
  182. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.dbg.json +4 -0
  183. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.json +104 -0
  184. package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +1 -1
  185. package/artifacts/contracts/types/Fee.sol/FeeLib.json +52 -13
  186. package/artifacts/contracts/types/Key32.sol/Key32Lib.dbg.json +1 -1
  187. package/artifacts/contracts/types/Key32.sol/Key32Lib.json +31 -17
  188. package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
  189. package/artifacts/contracts/types/NftId.sol/NftIdLib.json +2 -2
  190. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +1 -1
  191. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +26 -3
  192. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.dbg.json +4 -0
  193. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.json +100 -0
  194. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +1 -1
  195. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +2 -2
  196. package/artifacts/contracts/types/Referral.sol/ReferralLib.dbg.json +4 -0
  197. package/artifacts/contracts/types/Referral.sol/ReferralLib.json +123 -0
  198. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.dbg.json +4 -0
  199. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.json +86 -0
  200. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.dbg.json +1 -1
  201. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.json +134 -8
  202. package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +1 -1
  203. package/artifacts/contracts/types/StateId.sol/StateIdLib.json +2 -2
  204. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
  205. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.json +15 -2
  206. package/artifacts/contracts/types/UFixed.sol/MathLib.dbg.json +4 -0
  207. package/artifacts/contracts/types/UFixed.sol/MathLib.json +10 -0
  208. package/artifacts/contracts/types/UFixed.sol/UFixedLib.dbg.json +4 -0
  209. package/artifacts/contracts/types/UFixed.sol/{UFixedMathLib.json → UFixedLib.json} +3 -3
  210. package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +1 -1
  211. package/artifacts/contracts/types/Version.sol/VersionLib.json +40 -2
  212. package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +1 -1
  213. package/artifacts/contracts/types/Version.sol/VersionPartLib.json +22 -3
  214. package/contracts/components/Component.sol +216 -0
  215. package/contracts/components/Distribution.sol +150 -0
  216. package/contracts/components/IComponent.sol +43 -0
  217. package/contracts/components/IDistributionComponent.sol +47 -0
  218. package/contracts/components/IPoolComponent.sol +22 -19
  219. package/contracts/components/IProductComponent.sol +29 -9
  220. package/contracts/components/Pool.sol +124 -71
  221. package/contracts/components/Product.sol +188 -40
  222. package/contracts/experiment/cloning/Cloner.sol +47 -0
  223. package/contracts/instance/BundleManager.sol +125 -0
  224. package/contracts/instance/Cloneable.sol +46 -0
  225. package/contracts/instance/IInstance.sol +65 -45
  226. package/contracts/instance/IInstanceService.sol +41 -0
  227. package/contracts/instance/Instance.sol +254 -53
  228. package/contracts/instance/InstanceAccessManager.sol +298 -0
  229. package/contracts/instance/InstanceReader.sol +293 -0
  230. package/contracts/instance/InstanceService.sol +432 -0
  231. package/contracts/instance/InstanceServiceManager.sol +54 -0
  232. package/contracts/instance/ObjectManager.sol +84 -0
  233. package/contracts/instance/base/ComponentService.sol +134 -0
  234. package/contracts/instance/base/IKeyValueStore.sol +13 -13
  235. package/contracts/instance/base/ILifecycle.sol +3 -3
  236. package/contracts/instance/base/KeyValueStore.sol +53 -37
  237. package/contracts/instance/base/Lifecycle.sol +16 -11
  238. package/contracts/instance/module/IAccess.sol +48 -0
  239. package/contracts/instance/module/IBundle.sol +20 -0
  240. package/contracts/instance/module/IDistribution.sol +39 -0
  241. package/contracts/instance/module/IPolicy.sol +45 -0
  242. package/contracts/instance/module/IRisk.sol +11 -0
  243. package/contracts/instance/module/ISetup.sol +46 -0
  244. package/contracts/instance/module/ITreasury.sol +23 -0
  245. package/contracts/instance/service/BundleService.sol +293 -0
  246. package/contracts/instance/service/BundleServiceManager.sol +51 -0
  247. package/contracts/instance/service/DistributionService.sol +106 -0
  248. package/contracts/instance/service/DistributionServiceManager.sol +51 -0
  249. package/contracts/instance/service/IBundleService.sol +44 -0
  250. package/contracts/instance/service/IDistributionService.sol +12 -0
  251. package/contracts/instance/service/IPolicyService.sol +94 -0
  252. package/contracts/instance/service/IPoolService.sol +8 -18
  253. package/contracts/instance/service/IProductService.sol +21 -39
  254. package/contracts/instance/service/PolicyService.sol +538 -0
  255. package/contracts/instance/service/PolicyServiceManager.sol +54 -0
  256. package/contracts/instance/service/PoolService.sol +78 -91
  257. package/contracts/instance/service/PoolServiceManager.sol +51 -0
  258. package/contracts/instance/service/ProductService.sol +168 -288
  259. package/contracts/instance/service/ProductServiceManager.sol +54 -0
  260. package/contracts/registry/ChainNft.sol +79 -36
  261. package/contracts/registry/IRegistry.sol +65 -24
  262. package/contracts/registry/IRegistryService.sol +65 -0
  263. package/contracts/registry/ITransferInterceptor.sol +6 -0
  264. package/contracts/registry/Registry.sol +358 -287
  265. package/contracts/registry/RegistryAccessManager.sol +216 -0
  266. package/contracts/registry/RegistryService.sol +262 -0
  267. package/contracts/registry/RegistryServiceManager.sol +62 -0
  268. package/contracts/registry/ReleaseManager.sol +332 -0
  269. package/contracts/registry/TokenRegistry.sol +112 -0
  270. package/contracts/shared/ContractDeployerLib.sol +72 -0
  271. package/contracts/shared/ERC165.sol +6 -2
  272. package/contracts/shared/INftOwnable.sol +22 -0
  273. package/contracts/shared/IRegisterable.sol +8 -17
  274. package/contracts/shared/IService.sol +16 -0
  275. package/contracts/shared/IVersionable.sol +55 -11
  276. package/contracts/shared/NftOwnable.sol +139 -0
  277. package/contracts/shared/ProxyManager.sol +94 -0
  278. package/contracts/shared/Registerable.sol +59 -59
  279. package/contracts/shared/Service.sol +60 -0
  280. package/contracts/shared/TokenHandler.sol +27 -0
  281. package/contracts/shared/UpgradableProxyWithAdmin.sol +16 -0
  282. package/contracts/shared/Versionable.sol +113 -55
  283. package/contracts/test/TestFee.sol +2 -2
  284. package/contracts/test/TestRegisterable.sol +5 -6
  285. package/contracts/test/TestRoleId.sol +1 -1
  286. package/contracts/test/TestService.sol +7 -14
  287. package/contracts/types/DistributorType.sol +55 -0
  288. package/contracts/types/Fee.sol +10 -5
  289. package/contracts/types/Key32.sol +8 -3
  290. package/contracts/types/NftIdSet.sol +26 -24
  291. package/contracts/types/NumberId.sol +52 -0
  292. package/contracts/types/ObjectType.sol +51 -14
  293. package/contracts/types/Referral.sol +85 -0
  294. package/contracts/types/RiskId.sol +43 -0
  295. package/contracts/types/RoleId.sol +62 -10
  296. package/contracts/types/StateId.sol +5 -1
  297. package/contracts/types/Timestamp.sol +7 -3
  298. package/contracts/types/UFixed.sol +128 -12
  299. package/contracts/types/Version.sol +13 -1
  300. package/package.json +4 -3
  301. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.dbg.json +0 -4
  302. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.json +0 -174
  303. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json +0 -4
  304. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.json +0 -174
  305. package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.dbg.json +0 -4
  306. package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.json +0 -24
  307. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +0 -4
  308. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.json +0 -300
  309. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.dbg.json +0 -4
  310. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.json +0 -63
  311. package/artifacts/contracts/instance/base/IService.sol/IService.dbg.json +0 -4
  312. package/artifacts/contracts/instance/base/InstanceBase.sol/InstanceBase.dbg.json +0 -4
  313. package/artifacts/contracts/instance/base/ModuleBase.sol/ModuleBase.dbg.json +0 -4
  314. package/artifacts/contracts/instance/base/ServiceBase.sol/ServiceBase.dbg.json +0 -4
  315. package/artifacts/contracts/instance/base/ServiceBase.sol/ServiceBase.json +0 -300
  316. package/artifacts/contracts/instance/module/access/Access.sol/AccessModule.dbg.json +0 -4
  317. package/artifacts/contracts/instance/module/access/Access.sol/AccessModule.json +0 -333
  318. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccess.dbg.json +0 -4
  319. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccessModule.dbg.json +0 -4
  320. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccessModule.json +0 -333
  321. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.dbg.json +0 -4
  322. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.json +0 -296
  323. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundle.dbg.json +0 -4
  324. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.dbg.json +0 -4
  325. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.json +0 -296
  326. package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.dbg.json +0 -4
  327. package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.json +0 -10
  328. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensation.dbg.json +0 -4
  329. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensation.json +0 -10
  330. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensationModule.dbg.json +0 -4
  331. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensationModule.json +0 -10
  332. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.dbg.json +0 -4
  333. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.json +0 -188
  334. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.dbg.json +0 -4
  335. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.json +0 -10
  336. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.dbg.json +0 -4
  337. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.json +0 -188
  338. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicy.dbg.json +0 -4
  339. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.dbg.json +0 -4
  340. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.json +0 -261
  341. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.dbg.json +0 -4
  342. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.json +0 -261
  343. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPool.dbg.json +0 -4
  344. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPool.json +0 -10
  345. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.dbg.json +0 -4
  346. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.json +0 -149
  347. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.dbg.json +0 -4
  348. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.json +0 -149
  349. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRisk.dbg.json +0 -4
  350. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.dbg.json +0 -4
  351. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.json +0 -10
  352. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.dbg.json +0 -4
  353. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.json +0 -10
  354. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasury.dbg.json +0 -4
  355. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.dbg.json +0 -4
  356. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.json +0 -533
  357. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.dbg.json +0 -4
  358. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.json +0 -76
  359. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.dbg.json +0 -4
  360. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.json +0 -533
  361. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.dbg.json +0 -4
  362. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.json +0 -523
  363. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.dbg.json +0 -4
  364. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.dbg.json +0 -4
  365. package/artifacts/contracts/registry/IRegistryLinked.sol/IRegistryLinked.dbg.json +0 -4
  366. package/artifacts/contracts/registry/IRegistryLinked.sol/IRegistryLinked.json +0 -24
  367. package/artifacts/contracts/shared/IOwnable.sol/IOwnable.dbg.json +0 -4
  368. package/artifacts/contracts/shared/IOwnable.sol/IOwnable.json +0 -24
  369. package/artifacts/contracts/test/TestPool.sol/TestPool.dbg.json +0 -4
  370. package/artifacts/contracts/test/TestPool.sol/TestPool.json +0 -387
  371. package/artifacts/contracts/test/TestProduct.sol/TestProduct.dbg.json +0 -4
  372. package/artifacts/contracts/test/TestProduct.sol/TestProduct.json +0 -393
  373. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.dbg.json +0 -4
  374. package/contracts/components/BaseComponent.sol +0 -88
  375. package/contracts/components/IBaseComponent.sol +0 -19
  376. package/contracts/experiment/statemachine/README.md +0 -112
  377. package/contracts/instance/IInstanceLinked.sol +0 -8
  378. package/contracts/instance/base/ComponentServiceBase.sol +0 -42
  379. package/contracts/instance/base/IInstanceBase.sol +0 -14
  380. package/contracts/instance/base/IService.sol +0 -15
  381. package/contracts/instance/base/InstanceBase.sol +0 -80
  382. package/contracts/instance/base/ModuleBase.sol +0 -52
  383. package/contracts/instance/base/ServiceBase.sol +0 -37
  384. package/contracts/instance/module/access/Access.sol +0 -149
  385. package/contracts/instance/module/access/IAccess.sol +0 -53
  386. package/contracts/instance/module/bundle/BundleModule.sol +0 -136
  387. package/contracts/instance/module/bundle/IBundle.sol +0 -58
  388. package/contracts/instance/module/compensation/CompensationModule.sol +0 -8
  389. package/contracts/instance/module/compensation/ICompensation.sol +0 -10
  390. package/contracts/instance/module/component/ComponentModule.sol +0 -95
  391. package/contracts/instance/module/component/IComponent.sol +0 -53
  392. package/contracts/instance/module/policy/IPolicy.sol +0 -60
  393. package/contracts/instance/module/policy/PolicyModule.sol +0 -76
  394. package/contracts/instance/module/pool/IPoolModule.sol +0 -41
  395. package/contracts/instance/module/pool/PoolModule.sol +0 -87
  396. package/contracts/instance/module/risk/IRisk.sol +0 -10
  397. package/contracts/instance/module/risk/RiskModule.sol +0 -8
  398. package/contracts/instance/module/treasury/ITreasury.sol +0 -103
  399. package/contracts/instance/module/treasury/TokenHandler.sol +0 -48
  400. package/contracts/instance/module/treasury/TreasuryModule.sol +0 -152
  401. package/contracts/instance/service/ComponentOwnerService.sol +0 -170
  402. package/contracts/instance/service/IComponentOwnerService.sol +0 -22
  403. package/contracts/registry/IChainNft.sol +0 -21
  404. package/contracts/registry/IRegistryLinked.sol +0 -8
  405. package/contracts/shared/IOwnable.sol +0 -6
  406. package/contracts/test/TestPool.sol +0 -22
  407. package/contracts/test/TestProduct.sol +0 -44
package/README.md CHANGED
@@ -1,4 +1,23 @@
1
- # gif-next (Generic Insurance Framework next version)
1
+ # GIF-Next (Generic Insurance Framework, next version)
2
+
3
+ ## Add OpenZeppelin V5 Dependencies
4
+
5
+ ```shell
6
+ forge install openzeppelin-contracts-500=OpenZeppelin/openzeppelin-contracts@v5.0.0
7
+ cd cd lib/openzeppelin-contracts-500
8
+ git checkout tags/v5.0.0
9
+ cd ../..
10
+ ```
11
+
12
+ See `remappings.txt` to see how to work with different OpenZeppelin versions in parallel
13
+
14
+ ```
15
+ cat remappings.txt
16
+ @openzeppelin5/contracts/=lib/openzeppelin-contracts-500/contracts/
17
+ @openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/
18
+ @openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/
19
+ ```
20
+
2
21
 
3
22
  ## Submodules checkout
4
23
 
@@ -21,13 +40,35 @@ npm run test-with-gas
21
40
  npm run coverage
22
41
  ```
23
42
 
24
- ### Deployment
43
+ ### Docgen
44
+
45
+ Produce `solidty-docgen` documentation using the command below.
46
+
47
+ ```shell
48
+ hh docgen
49
+ ```
50
+
51
+ The resulting markdown files are written to `docs`
52
+
53
+
54
+ ### Full protocol deployment
55
+
56
+ Install the dependencies before running the script below for the first time.
57
+
58
+ ```bash
59
+ npm install
60
+ ```
25
61
 
26
62
  The deploy script will deploy all required contracts and create a test instance with a test product and a test pool.
27
63
 
28
64
  ```bash
29
65
  # run deployment on a locally created ganache instance
66
+ export SKIP_VERIFICATION=true
30
67
  hh run scripts/deploy_all.ts
68
+ ```
69
+
70
+ ```bash
71
+ # set appropriate values vor env variables (see below)
31
72
 
32
73
  # run deployment on another network
33
74
  hh run --network <networkname> scripts/deploy_all.ts
@@ -40,6 +81,25 @@ Environment variables:
40
81
  - `WALLET_MNEMONIC` the mnemonic of the wallet to use for deployment (required for mumbai and mainnet)
41
82
  - `ETHERSCAN_API_KEY` `POLYGONSCAN_API_KEY` the api key for etherscan/polygonscan (required for mumbai and mainnet)
42
83
 
84
+ ### Create a new instance
85
+
86
+ Requires previous step to be completed.
87
+
88
+ ```bash
89
+ # set appropriate values vor env variables (see below)
90
+
91
+ hh run --network <networkname> scripts/new_instance.ts
92
+ ```
93
+
94
+ Currently an HD wallet is expected to be used for the deployment. The mnemonic of the wallet needs to be provided via the `WALLET_MNEMONIC` environment variable.
95
+ The instance owner will be the 11th address of the wallet.
96
+
97
+ Environment variables:
98
+
99
+ - `WEB3_INFURA_PROJECT_ID` set to infura project id (required for mumbai and mainnet)
100
+ - `WALLET_MNEMONIC` the mnemonic of the wallet to use for deployment (required for mumbai and mainnet)
101
+ - `REGISTRY_ADDRESS` the address of the registry that is already deployed and configured and has a valid master instance
102
+
43
103
 
44
104
  ### Console
45
105
 
@@ -78,7 +138,11 @@ forge test -vvvv --mt test_decimals
78
138
  # provide gas report for a single test
79
139
  forge test --mt test_decimals --gas-report
80
140
 
141
+ # provide code coverage report
81
142
  forge coverage
143
+ forge coverage --report lcov
144
+
145
+
82
146
  ```
83
147
 
84
148
  Chisel session
@@ -190,6 +254,7 @@ sudo apt update
190
254
  sudo apt install python3-pip
191
255
  pip install eth-brownie
192
256
  brownie pm install OpenZeppelin/openzeppelin-contracts@4.9.3
257
+ brownie pm install OpenZeppelin/openzeppelin-contracts@5.0.0
193
258
  ```
194
259
 
195
260
  ```bash
@@ -241,3 +306,178 @@ pool_id = pool.getNftId()
241
306
  product_id = product.getNftId()
242
307
  ```
243
308
 
309
+ ## Objects
310
+
311
+ ### Registry
312
+
313
+ Mandatory properties
314
+
315
+ * One registry per chain
316
+ * Global registry: the registry on mainnet
317
+ * One entry per protocol object
318
+ * Once registered object properties are immutable
319
+ * Globally unique NFT minted per protocol object (chain id is embedded in NFT id)
320
+ * Object ownership defined by NFT ownernship
321
+ * Typed objects (instance, product, policy, ...)
322
+ * Each object has parent object (only one exception: protocol object does not have parent object)
323
+ * Parent object type is defined by type of child object
324
+
325
+ Object properties (for smart contracts)
326
+ * Objects that represent a smart contract record its contract address
327
+ * With one exception (see next point) smart contract addresses refer to the address on the same chain as the registry
328
+ * The global registry also holds entries for all the registries on different chains than mainnet, in these cases the addresses refer to the chains of these chain specific registries (this is the only case where registered addresses do not refer to the same chain)
329
+
330
+ Optional properties
331
+
332
+ * Objects can have names
333
+ * Object names are unique per chain
334
+ * Objects may define an intercepting property, in which case a predefined smart contract is involved in NFT transfers of the objects NFT (transfer may trigger actions, transfer may be blocked etc)
335
+ *
336
+
337
+ Ownership property
338
+
339
+ * Object ownership defined by ownership of NFT representing the object
340
+ * Protocol
341
+ * Fixed/predefined owner (address without private key)
342
+ * Registry
343
+ * Allows registration of token and services (per major release)
344
+ * May transfer ownership
345
+ * Token
346
+ * Fixed/predefined owner (address without private key)
347
+ * TODO add whitelisting for token per major release
348
+ * Service
349
+ * Allows upgrades of services as long as major version is same
350
+ * Until further notice the same entity as the registry owner
351
+ * May transfer ownership
352
+ * Instance
353
+ * Granting/revoking of roles (both default + custom)
354
+ * Management of custom roles and targets
355
+ * May lock instance and/or components
356
+ * May transfer ownership
357
+ * Component (Product, Pool, Distribution, Oracle)
358
+ * Register component
359
+ * Set component wallet (which receives fees, holds funds)
360
+ * May lock component
361
+ * May transfer ownership
362
+ * Additional use case specific features
363
+ * Policy
364
+ * Represents policy holder
365
+ * Receive payouts (GIF default behaviour)
366
+ * May transfer ownership
367
+ * Bundle
368
+ * Represents funds owner
369
+ * May withdraw funds not locked by active policies
370
+ * May transfer ownership
371
+ * Distributor
372
+ * Receives commissions from sales (GIF default behaviour)
373
+ * May transfer ownership
374
+
375
+ Intercepting property
376
+ * Service owner is indirectly owner of service manager contract
377
+
378
+ * Instance
379
+ * intercepts transfer of instance owner (new owner needs access manager admin rights for custom roles and targets)
380
+ * intercepts transfer of components, to do what? check that new owner has necessary roles?
381
+ * Product
382
+ * intercepts transfer of policies (use case specific: eg. limit/disallow transfers)
383
+ * Pool:
384
+ * intercepts transfer of bundles (use case specific: eg. limit/disallow transfers)
385
+ * Distribution
386
+ * intercepts transfer of distributors (bookkeeping: only one distributor per address allowed)
387
+ * Oracle
388
+ * likely meaningless
389
+
390
+
391
+ ### Instance
392
+
393
+ ### Product
394
+
395
+ ### Pool
396
+
397
+ ### Distribution
398
+
399
+ ### Oracle
400
+
401
+ ## Registry and Services
402
+
403
+ ### Principles
404
+
405
+ - 1 service per object type and major version
406
+ - registry service guards write access to registry
407
+ - all other objects registered via registry service
408
+ - root object for the complete tree is the protocol object
409
+ - under the root object a single registry object is registered (= global registry/ethereum mainnet)
410
+
411
+
412
+ ### Service Responsibilities
413
+
414
+ Registry Service
415
+
416
+ - deployed and registered during bootstrapping of registry
417
+ - used to register tokens and other services by registry owner
418
+ - an object may only be registered by the service designated by the type of the object
419
+ - to register an object the parent object needs already be registered
420
+ - the type of the object to be registered needs to match a valid child type/parent type combination
421
+
422
+ Instance Service
423
+
424
+ - deploys master instance during its own bootstrapping (if allowed by contract size)
425
+ - registered via registry service by registry owner
426
+ - registeres master instance during its own registration by regsitry owner
427
+ - deploys and registeres new instances (= instance factory) by instance owner (instance owner is a permissionless role, anybody may creates a new instance)
428
+ - provides upgrade functionality to instance owners
429
+
430
+ Product Service
431
+
432
+ - registered via registry service by registry owner
433
+ - registers products for registered instances via registry service by product owner (product owner role is permissend by the product's instance)
434
+ - registers applications/policies for registered products via registry service
435
+
436
+ Distribution Service
437
+
438
+ - registered via registry service by registry owner
439
+ - registers distribution components for registered products via registry service by distribution owner (distribution owner role is permissend by the product's instance)
440
+ - registers distributors for registered distribution components via registry service
441
+
442
+ ## Contract Organisation
443
+
444
+ now
445
+
446
+ contracts
447
+ components
448
+ instance
449
+ registry
450
+ shared
451
+ types
452
+
453
+
454
+ contracts
455
+ component
456
+ pool
457
+ Pool.sol
458
+ PoolService.sol
459
+ oracle
460
+ distribution
461
+ product
462
+ Product.sol
463
+ ProductService.sol
464
+ Component.sol
465
+ ComponentService.sol
466
+ instance
467
+ Instance.sol
468
+ InstanceAccessManager.sol
469
+ InstanceReader.sol
470
+ InstanceService.sol
471
+ InstanceServiceManager.sol
472
+ registry
473
+ ChainNft.sol
474
+ Registry.sol
475
+ RegistryService.sol
476
+ RegistryServiceManager.sol
477
+ shared
478
+ Registerable.sol
479
+ RegisterableUpgradable.sol
480
+ type
481
+ NftId.sol
482
+ ObjectType.sol
483
+
@@ -0,0 +1,4 @@
1
+ {
2
+ "_format": "hh-sol-dbg-1",
3
+ "buildInfo": "../../../build-info/4390e4b2e91317183df145552bfd11cb.json"
4
+ }