@etherisc/gif-next 0.0.2-f7b8c9f-518 → 0.0.2-f7bec40-735

Sign up to get free protection for your applications and to get access to all the features.
Files changed (486) hide show
  1. package/README.md +178 -14
  2. package/artifacts/contracts/components/Component.sol/Component.dbg.json +4 -0
  3. package/artifacts/contracts/components/Component.sol/Component.json +873 -0
  4. package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json +1 -1
  5. package/artifacts/contracts/components/Distribution.sol/Distribution.json +1023 -204
  6. package/artifacts/contracts/components/IComponent.sol/IComponent.dbg.json +4 -0
  7. package/artifacts/contracts/components/IComponent.sol/IComponent.json +636 -0
  8. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.dbg.json +1 -1
  9. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.json +862 -39
  10. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.dbg.json +1 -1
  11. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.json +916 -129
  12. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.dbg.json +1 -1
  13. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.json +694 -40
  14. package/artifacts/contracts/components/Pool.sol/Pool.dbg.json +1 -1
  15. package/artifacts/contracts/components/Pool.sol/Pool.json +958 -267
  16. package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
  17. package/artifacts/contracts/components/Product.sol/Product.json +778 -194
  18. package/artifacts/contracts/instance/BundleManager.sol/BundleManager.dbg.json +4 -0
  19. package/artifacts/contracts/instance/BundleManager.sol/BundleManager.json +778 -0
  20. package/artifacts/contracts/instance/Cloneable.sol/Cloneable.dbg.json +4 -0
  21. package/artifacts/contracts/instance/Cloneable.sol/Cloneable.json +190 -0
  22. package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
  23. package/artifacts/contracts/instance/IInstance.sol/IInstance.json +226 -1822
  24. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.dbg.json +4 -0
  25. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.json +616 -0
  26. package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
  27. package/artifacts/contracts/instance/Instance.sol/Instance.json +444 -2190
  28. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.dbg.json +4 -0
  29. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.json +1348 -0
  30. package/artifacts/contracts/instance/InstanceAuthorizationsLib.sol/InstanceAuthorizationsLib.dbg.json +4 -0
  31. package/artifacts/contracts/instance/InstanceAuthorizationsLib.sol/InstanceAuthorizationsLib.json +124 -0
  32. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.dbg.json +4 -0
  33. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.json +1569 -0
  34. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.dbg.json +4 -0
  35. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.json +979 -0
  36. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.dbg.json +4 -0
  37. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.json +656 -0
  38. package/artifacts/contracts/instance/InstanceStore.sol/InstanceStore.dbg.json +4 -0
  39. package/artifacts/contracts/instance/InstanceStore.sol/InstanceStore.json +2788 -0
  40. package/artifacts/contracts/instance/ObjectManager.sol/ObjectManager.dbg.json +4 -0
  41. package/artifacts/contracts/instance/ObjectManager.sol/ObjectManager.json +256 -0
  42. package/artifacts/contracts/instance/base/ComponentService.sol/ComponentService.dbg.json +4 -0
  43. package/artifacts/contracts/instance/base/{InstanceBase.sol/InstanceBase.json → ComponentService.sol/ComponentService.json} +282 -195
  44. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.dbg.json +1 -1
  45. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.json +27 -158
  46. package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.dbg.json +1 -1
  47. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.dbg.json +1 -1
  48. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.json +67 -245
  49. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.dbg.json +1 -1
  50. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.json +36 -11
  51. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.dbg.json +4 -0
  52. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.json +237 -0
  53. package/artifacts/contracts/instance/module/IBundle.sol/IBundle.dbg.json +4 -0
  54. package/artifacts/contracts/instance/module/{bundle/IBundle.sol → IBundle.sol}/IBundle.json +1 -1
  55. package/artifacts/contracts/instance/module/IComponents.sol/IComponents.dbg.json +4 -0
  56. package/artifacts/contracts/instance/module/{access/IAccess.sol/IAccess.json → IComponents.sol/IComponents.json} +2 -2
  57. package/artifacts/contracts/instance/module/IDistribution.sol/IDistribution.dbg.json +4 -0
  58. package/artifacts/contracts/instance/module/{distribution/IDistribution.sol → IDistribution.sol}/IDistribution.json +1 -1
  59. package/artifacts/contracts/instance/module/IPolicy.sol/IPolicy.dbg.json +4 -0
  60. package/artifacts/contracts/instance/module/{policy/IPolicy.sol → IPolicy.sol}/IPolicy.json +1 -1
  61. package/artifacts/contracts/instance/module/IRisk.sol/IRisk.dbg.json +4 -0
  62. package/artifacts/contracts/instance/module/{risk/IRisk.sol → IRisk.sol}/IRisk.json +1 -1
  63. package/artifacts/contracts/instance/module/ISetup.sol/ISetup.dbg.json +4 -0
  64. package/artifacts/contracts/instance/{base/ModuleBase.sol/ModuleBase.json → module/ISetup.sol/ISetup.json} +2 -2
  65. package/artifacts/contracts/instance/module/ITreasury.sol/ITreasury.dbg.json +4 -0
  66. package/artifacts/contracts/instance/module/{treasury/ITreasury.sol → ITreasury.sol}/ITreasury.json +1 -1
  67. package/artifacts/contracts/instance/service/ApplicationService.sol/ApplicationService.dbg.json +4 -0
  68. package/artifacts/contracts/instance/service/ApplicationService.sol/ApplicationService.json +918 -0
  69. package/artifacts/contracts/instance/service/ApplicationServiceManager.sol/ApplicationServiceManager.dbg.json +4 -0
  70. package/artifacts/contracts/instance/service/ApplicationServiceManager.sol/ApplicationServiceManager.json +648 -0
  71. package/artifacts/contracts/instance/service/BundleService.sol/BundleService.dbg.json +4 -0
  72. package/artifacts/contracts/instance/service/BundleService.sol/BundleService.json +1288 -0
  73. package/artifacts/contracts/instance/service/BundleServiceManager.sol/BundleServiceManager.dbg.json +4 -0
  74. package/artifacts/contracts/instance/service/BundleServiceManager.sol/BundleServiceManager.json +696 -0
  75. package/artifacts/contracts/instance/service/ClaimService.sol/ClaimService.dbg.json +4 -0
  76. package/artifacts/contracts/instance/service/ClaimService.sol/ClaimService.json +1384 -0
  77. package/artifacts/contracts/instance/service/ClaimServiceManager.sol/ClaimServiceManager.dbg.json +4 -0
  78. package/artifacts/contracts/instance/service/ClaimServiceManager.sol/ClaimServiceManager.json +752 -0
  79. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.dbg.json +1 -1
  80. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.json +1103 -177
  81. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.dbg.json +4 -0
  82. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.json +780 -0
  83. package/artifacts/contracts/instance/service/IApplicationService.sol/IApplicationService.dbg.json +4 -0
  84. package/artifacts/contracts/instance/service/{IComponentOwnerService.sol/IComponentOwnerService.json → IApplicationService.sol/IApplicationService.json} +231 -204
  85. package/artifacts/contracts/instance/service/IBundleService.sol/IBundleService.dbg.json +4 -0
  86. package/artifacts/contracts/instance/service/IBundleService.sol/IBundleService.json +735 -0
  87. package/artifacts/contracts/instance/service/IClaimService.sol/IClaimService.dbg.json +4 -0
  88. package/artifacts/contracts/instance/service/IClaimService.sol/IClaimService.json +743 -0
  89. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.dbg.json +1 -1
  90. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.json +540 -146
  91. package/artifacts/contracts/instance/service/IPolicyService.sol/IPolicyService.dbg.json +4 -0
  92. package/artifacts/contracts/instance/service/IPolicyService.sol/IPolicyService.json +651 -0
  93. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +1 -1
  94. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +669 -153
  95. package/artifacts/contracts/instance/service/IPricingService.sol/IPricingService.dbg.json +4 -0
  96. package/artifacts/contracts/instance/{base/ServiceBase.sol/ServiceBase.json → service/IPricingService.sol/IPricingService.json} +245 -203
  97. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +1 -1
  98. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +88 -397
  99. package/artifacts/contracts/instance/service/PolicyService.sol/PolicyService.dbg.json +4 -0
  100. package/artifacts/contracts/instance/service/PolicyService.sol/PolicyService.json +1281 -0
  101. package/artifacts/contracts/instance/service/PolicyServiceManager.sol/PolicyServiceManager.dbg.json +4 -0
  102. package/artifacts/contracts/instance/service/PolicyServiceManager.sol/PolicyServiceManager.json +740 -0
  103. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.dbg.json +1 -1
  104. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.json +1080 -211
  105. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.dbg.json +4 -0
  106. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.json +708 -0
  107. package/artifacts/contracts/instance/service/PricingService.sol/PricingService.dbg.json +4 -0
  108. package/artifacts/contracts/instance/service/PricingService.sol/PricingService.json +1004 -0
  109. package/artifacts/contracts/instance/service/PricingServiceManager.sol/PricingServiceManager.dbg.json +4 -0
  110. package/artifacts/contracts/instance/service/PricingServiceManager.sol/PricingServiceManager.json +688 -0
  111. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.dbg.json +1 -1
  112. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.json +327 -531
  113. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.dbg.json +4 -0
  114. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.json +640 -0
  115. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
  116. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.json +60 -2
  117. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
  118. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.json +255 -63
  119. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.dbg.json +1 -1
  120. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.json +309 -196
  121. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.dbg.json +1 -1
  122. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.json +18 -0
  123. package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
  124. package/artifacts/contracts/registry/Registry.sol/Registry.json +229 -212
  125. package/artifacts/contracts/registry/RegistryAccessManager.sol/RegistryAccessManager.dbg.json +4 -0
  126. package/artifacts/contracts/registry/RegistryAccessManager.sol/RegistryAccessManager.json +285 -0
  127. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.dbg.json +1 -1
  128. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.json +422 -269
  129. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.dbg.json +1 -1
  130. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.json +311 -122
  131. package/artifacts/contracts/registry/ReleaseManager.sol/ReleaseManager.dbg.json +4 -0
  132. package/artifacts/contracts/registry/ReleaseManager.sol/ReleaseManager.json +559 -0
  133. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.dbg.json +4 -0
  134. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.json +485 -0
  135. package/artifacts/contracts/shared/AccessManagerUpgradeableInitializeable.sol/AccessManagerUpgradeableInitializeable.dbg.json +4 -0
  136. package/artifacts/contracts/shared/AccessManagerUpgradeableInitializeable.sol/AccessManagerUpgradeableInitializeable.json +1206 -0
  137. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.dbg.json +1 -1
  138. package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json +1 -1
  139. package/artifacts/contracts/shared/ERC165.sol/ERC165.json +41 -3
  140. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.dbg.json +1 -1
  141. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.json +27 -29
  142. package/artifacts/contracts/shared/IPolicyHolder.sol/IPolicyHolder.dbg.json +4 -0
  143. package/artifacts/contracts/shared/IPolicyHolder.sol/IPolicyHolder.json +189 -0
  144. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +1 -1
  145. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.json +8 -34
  146. package/artifacts/contracts/shared/IRegistryLinked.sol/IRegistryLinked.dbg.json +4 -0
  147. package/artifacts/contracts/{experiment/inheritance/IA.sol/ISharedA.json → shared/IRegistryLinked.sol/IRegistryLinked.json} +15 -17
  148. package/artifacts/contracts/shared/IService.sol/IService.dbg.json +4 -0
  149. package/artifacts/contracts/{components/BaseComponent.sol/BaseComponent.json → shared/IService.sol/IService.json} +93 -67
  150. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.dbg.json +1 -1
  151. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json +2 -152
  152. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.dbg.json +1 -1
  153. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.json +107 -27
  154. package/artifacts/contracts/shared/PolicyHolder.sol/PolicyHolder.dbg.json +4 -0
  155. package/artifacts/contracts/shared/PolicyHolder.sol/PolicyHolder.json +302 -0
  156. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.dbg.json +1 -1
  157. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.json +283 -63
  158. package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +1 -1
  159. package/artifacts/contracts/shared/Registerable.sol/Registerable.json +116 -51
  160. package/artifacts/contracts/shared/RegistryLinked.sol/RegistryLinked.dbg.json +4 -0
  161. package/artifacts/contracts/shared/RegistryLinked.sol/RegistryLinked.json +71 -0
  162. package/artifacts/contracts/shared/Service.sol/Service.dbg.json +4 -0
  163. package/artifacts/contracts/{instance/base/ComponentServiceBase.sol/ComponentServiceBase.json → shared/Service.sol/Service.json} +187 -180
  164. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.dbg.json +4 -0
  165. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.json +114 -0
  166. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.dbg.json +1 -1
  167. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.json +2 -2
  168. package/artifacts/contracts/shared/Versionable.sol/Versionable.dbg.json +1 -1
  169. package/artifacts/contracts/shared/Versionable.sol/Versionable.json +2 -152
  170. package/artifacts/contracts/test/TestFee.sol/TestFee.dbg.json +1 -1
  171. package/artifacts/contracts/test/TestFee.sol/TestFee.json +4 -4
  172. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.dbg.json +1 -1
  173. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.json +116 -51
  174. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.dbg.json +1 -1
  175. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.json +14 -14
  176. package/artifacts/contracts/test/TestService.sol/TestService.dbg.json +1 -1
  177. package/artifacts/contracts/test/TestService.sol/TestService.json +204 -200
  178. package/artifacts/contracts/test/TestToken.sol/TestUsdc.dbg.json +1 -1
  179. package/artifacts/contracts/test/TestToken.sol/TestUsdc.json +91 -53
  180. package/artifacts/contracts/test/TestVersion.sol/TestVersion.dbg.json +1 -1
  181. package/artifacts/contracts/test/TestVersion.sol/TestVersion.json +2 -2
  182. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.dbg.json +1 -1
  183. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.json +8 -174
  184. package/artifacts/contracts/test/Usdc.sol/USDC.dbg.json +1 -1
  185. package/artifacts/contracts/test/Usdc.sol/USDC.json +91 -53
  186. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.dbg.json +1 -1
  187. package/artifacts/contracts/types/Amount.sol/AmountLib.dbg.json +4 -0
  188. package/artifacts/contracts/types/Amount.sol/AmountLib.json +281 -0
  189. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
  190. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.json +2 -2
  191. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.dbg.json +1 -1
  192. package/artifacts/contracts/types/ClaimId.sol/ClaimIdLib.dbg.json +4 -0
  193. package/artifacts/contracts/types/ClaimId.sol/ClaimIdLib.json +179 -0
  194. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.dbg.json +4 -0
  195. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.json +104 -0
  196. package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +1 -1
  197. package/artifacts/contracts/types/Fee.sol/FeeLib.json +74 -19
  198. package/artifacts/contracts/types/Key32.sol/Key32Lib.dbg.json +1 -1
  199. package/artifacts/contracts/types/Key32.sol/Key32Lib.json +31 -17
  200. package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
  201. package/artifacts/contracts/types/NftId.sol/NftIdLib.json +17 -4
  202. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +1 -1
  203. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +26 -3
  204. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.dbg.json +4 -0
  205. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.json +100 -0
  206. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +1 -1
  207. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +2 -2
  208. package/artifacts/contracts/types/PayoutId.sol/PayoutIdLib.dbg.json +4 -0
  209. package/artifacts/contracts/types/PayoutId.sol/PayoutIdLib.json +209 -0
  210. package/artifacts/contracts/types/Referral.sol/ReferralLib.dbg.json +4 -0
  211. package/artifacts/contracts/types/Referral.sol/ReferralLib.json +142 -0
  212. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.dbg.json +1 -1
  213. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.json +2 -2
  214. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.dbg.json +1 -1
  215. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.json +134 -8
  216. package/artifacts/contracts/types/Seconds.sol/SecondsLib.dbg.json +4 -0
  217. package/artifacts/contracts/types/Seconds.sol/SecondsLib.json +124 -0
  218. package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +1 -1
  219. package/artifacts/contracts/types/StateId.sol/StateIdLib.json +2 -2
  220. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
  221. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.json +51 -7
  222. package/artifacts/contracts/types/UFixed.sol/MathLib.dbg.json +4 -0
  223. package/artifacts/contracts/{experiment/types/TypeB.sol/TypeBLib.json → types/UFixed.sol/MathLib.json} +4 -4
  224. package/artifacts/contracts/types/UFixed.sol/UFixedLib.dbg.json +4 -0
  225. package/artifacts/contracts/types/UFixed.sol/{UFixedMathLib.json → UFixedLib.json} +3 -3
  226. package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +1 -1
  227. package/artifacts/contracts/types/Version.sol/VersionLib.json +2 -2
  228. package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +1 -1
  229. package/artifacts/contracts/types/Version.sol/VersionPartLib.json +22 -3
  230. package/contracts/components/Component.sol +272 -0
  231. package/contracts/components/Distribution.sol +209 -79
  232. package/contracts/components/IComponent.sol +90 -0
  233. package/contracts/components/IDistributionComponent.sol +43 -18
  234. package/contracts/components/IPoolComponent.sol +90 -40
  235. package/contracts/components/IProductComponent.sol +17 -13
  236. package/contracts/components/Pool.sol +222 -166
  237. package/contracts/components/Product.sol +258 -182
  238. package/contracts/instance/BundleManager.sol +126 -0
  239. package/contracts/instance/Cloneable.sol +51 -0
  240. package/contracts/instance/IInstance.sol +63 -40
  241. package/contracts/instance/IInstanceService.sol +73 -0
  242. package/contracts/instance/Instance.sol +213 -71
  243. package/contracts/instance/InstanceAccessManager.sol +541 -0
  244. package/contracts/instance/InstanceAuthorizationsLib.sol +308 -0
  245. package/contracts/instance/InstanceReader.sol +368 -0
  246. package/contracts/instance/InstanceService.sol +308 -0
  247. package/contracts/instance/InstanceServiceManager.sol +54 -0
  248. package/contracts/instance/InstanceStore.sol +212 -0
  249. package/contracts/instance/ObjectManager.sol +82 -0
  250. package/contracts/instance/base/ComponentService.sol +148 -0
  251. package/contracts/instance/base/IKeyValueStore.sol +13 -14
  252. package/contracts/instance/base/ILifecycle.sol +3 -3
  253. package/contracts/instance/base/KeyValueStore.sol +30 -42
  254. package/contracts/instance/base/Lifecycle.sol +27 -7
  255. package/contracts/instance/module/IAccess.sol +54 -0
  256. package/contracts/instance/module/IBundle.sol +23 -0
  257. package/contracts/instance/module/IComponents.sol +41 -0
  258. package/contracts/instance/module/IDistribution.sol +42 -0
  259. package/contracts/instance/module/IPolicy.sol +77 -0
  260. package/contracts/instance/module/IRisk.sol +11 -0
  261. package/contracts/instance/module/ISetup.sol +33 -0
  262. package/contracts/instance/module/ITreasury.sol +23 -0
  263. package/contracts/instance/service/ApplicationService.sol +186 -0
  264. package/contracts/instance/service/ApplicationServiceManager.sol +35 -0
  265. package/contracts/instance/service/BundleService.sol +382 -0
  266. package/contracts/instance/service/BundleServiceManager.sol +51 -0
  267. package/contracts/instance/service/ClaimService.sol +437 -0
  268. package/contracts/instance/service/ClaimServiceManager.sol +35 -0
  269. package/contracts/instance/service/DistributionService.sol +317 -23
  270. package/contracts/instance/service/DistributionServiceManager.sol +51 -0
  271. package/contracts/instance/service/IApplicationService.sol +62 -0
  272. package/contracts/instance/service/IBundleService.sol +118 -0
  273. package/contracts/instance/service/IClaimService.sol +90 -0
  274. package/contracts/instance/service/IDistributionService.sol +77 -2
  275. package/contracts/instance/service/IPolicyService.sol +80 -0
  276. package/contracts/instance/service/IPoolService.sol +95 -18
  277. package/contracts/instance/service/IPricingService.sol +37 -0
  278. package/contracts/instance/service/IProductService.sol +9 -76
  279. package/contracts/instance/service/PolicyService.sol +376 -0
  280. package/contracts/instance/service/PolicyServiceManager.sol +54 -0
  281. package/contracts/instance/service/PoolService.sol +339 -85
  282. package/contracts/instance/service/PoolServiceManager.sol +51 -0
  283. package/contracts/instance/service/PricingService.sol +275 -0
  284. package/contracts/instance/service/PricingServiceManager.sol +51 -0
  285. package/contracts/instance/service/ProductService.sol +135 -435
  286. package/contracts/instance/service/ProductServiceManager.sol +54 -0
  287. package/contracts/registry/ChainNft.sol +49 -26
  288. package/contracts/registry/IRegistry.sol +53 -25
  289. package/contracts/registry/IRegistryService.sol +53 -16
  290. package/contracts/registry/ITransferInterceptor.sol +1 -0
  291. package/contracts/registry/Registry.sol +289 -313
  292. package/contracts/registry/RegistryAccessManager.sol +216 -0
  293. package/contracts/registry/RegistryService.sol +165 -247
  294. package/contracts/registry/RegistryServiceManager.sol +30 -11
  295. package/contracts/registry/ReleaseManager.sol +324 -0
  296. package/contracts/registry/TokenRegistry.sol +116 -0
  297. package/contracts/shared/AccessManagerUpgradeableInitializeable.sol +13 -0
  298. package/contracts/shared/ERC165.sol +15 -9
  299. package/contracts/shared/INftOwnable.sol +11 -10
  300. package/contracts/shared/IPolicyHolder.sol +40 -0
  301. package/contracts/shared/IRegisterable.sol +4 -6
  302. package/contracts/shared/IRegistryLinked.sol +11 -0
  303. package/contracts/shared/IService.sol +18 -0
  304. package/contracts/shared/IVersionable.sol +4 -47
  305. package/contracts/shared/NftOwnable.sol +65 -83
  306. package/contracts/shared/PolicyHolder.sol +94 -0
  307. package/contracts/shared/ProxyManager.sol +101 -26
  308. package/contracts/shared/Registerable.sol +25 -39
  309. package/contracts/shared/RegistryLinked.sol +43 -0
  310. package/contracts/shared/Service.sol +72 -0
  311. package/contracts/shared/TokenHandler.sol +35 -0
  312. package/contracts/shared/UpgradableProxyWithAdmin.sol +2 -2
  313. package/contracts/shared/Versionable.sol +5 -93
  314. package/contracts/test/TestFee.sol +2 -2
  315. package/contracts/test/TestRegisterable.sol +1 -1
  316. package/contracts/test/TestRoleId.sol +1 -1
  317. package/contracts/test/TestService.sol +6 -7
  318. package/contracts/types/Amount.sol +109 -0
  319. package/contracts/types/Blocknumber.sol +1 -0
  320. package/contracts/types/ClaimId.sol +75 -0
  321. package/contracts/types/DistributorType.sol +55 -0
  322. package/contracts/types/Fee.sol +19 -10
  323. package/contracts/types/Key32.sol +8 -3
  324. package/contracts/types/NftId.sol +8 -0
  325. package/contracts/types/NftIdSet.sol +26 -24
  326. package/contracts/types/NumberId.sol +52 -0
  327. package/contracts/types/ObjectType.sol +44 -14
  328. package/contracts/types/PayoutId.sol +82 -0
  329. package/contracts/types/Referral.sol +89 -0
  330. package/contracts/types/RoleId.sol +68 -9
  331. package/contracts/types/Seconds.sol +54 -0
  332. package/contracts/types/StateId.sol +12 -3
  333. package/contracts/types/Timestamp.sol +22 -13
  334. package/contracts/types/UFixed.sol +129 -12
  335. package/contracts/types/Version.sol +5 -1
  336. package/package.json +6 -5
  337. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.dbg.json +0 -4
  338. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json +0 -4
  339. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.json +0 -254
  340. package/artifacts/contracts/experiment/errors/Require.sol/Require.dbg.json +0 -4
  341. package/artifacts/contracts/experiment/errors/Require.sol/Require.json +0 -105
  342. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.dbg.json +0 -4
  343. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.json +0 -105
  344. package/artifacts/contracts/experiment/inheritance/A.sol/A.dbg.json +0 -4
  345. package/artifacts/contracts/experiment/inheritance/A.sol/A.json +0 -128
  346. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.dbg.json +0 -4
  347. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.json +0 -42
  348. package/artifacts/contracts/experiment/inheritance/B.sol/B.dbg.json +0 -4
  349. package/artifacts/contracts/experiment/inheritance/B.sol/B.json +0 -76
  350. package/artifacts/contracts/experiment/inheritance/C.sol/C.dbg.json +0 -4
  351. package/artifacts/contracts/experiment/inheritance/C.sol/C.json +0 -89
  352. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.dbg.json +0 -4
  353. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.json +0 -128
  354. package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.dbg.json +0 -4
  355. package/artifacts/contracts/experiment/inheritance/IB.sol/IB.dbg.json +0 -4
  356. package/artifacts/contracts/experiment/inheritance/IB.sol/IB.json +0 -50
  357. package/artifacts/contracts/experiment/inheritance/IC.sol/IC.dbg.json +0 -4
  358. package/artifacts/contracts/experiment/inheritance/IC.sol/IC.json +0 -63
  359. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.dbg.json +0 -4
  360. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.json +0 -59
  361. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.dbg.json +0 -4
  362. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.json +0 -124
  363. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.dbg.json +0 -4
  364. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.json +0 -74
  365. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.dbg.json +0 -4
  366. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.json +0 -124
  367. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.dbg.json +0 -4
  368. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.json +0 -207
  369. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.dbg.json +0 -4
  370. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.json +0 -10
  371. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.dbg.json +0 -4
  372. package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.dbg.json +0 -4
  373. package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.json +0 -24
  374. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +0 -4
  375. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.dbg.json +0 -4
  376. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.json +0 -113
  377. package/artifacts/contracts/instance/base/IService.sol/IService.dbg.json +0 -4
  378. package/artifacts/contracts/instance/base/IService.sol/IService.json +0 -421
  379. package/artifacts/contracts/instance/base/InstanceBase.sol/InstanceBase.dbg.json +0 -4
  380. package/artifacts/contracts/instance/base/ModuleBase.sol/ModuleBase.dbg.json +0 -4
  381. package/artifacts/contracts/instance/base/ServiceBase.sol/ServiceBase.dbg.json +0 -4
  382. package/artifacts/contracts/instance/module/access/Access.sol/AccessModule.dbg.json +0 -4
  383. package/artifacts/contracts/instance/module/access/Access.sol/AccessModule.json +0 -333
  384. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccess.dbg.json +0 -4
  385. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccessModule.dbg.json +0 -4
  386. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccessModule.json +0 -333
  387. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.dbg.json +0 -4
  388. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.json +0 -297
  389. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundle.dbg.json +0 -4
  390. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.dbg.json +0 -4
  391. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.json +0 -297
  392. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.dbg.json +0 -4
  393. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.json +0 -117
  394. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.dbg.json +0 -4
  395. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.json +0 -10
  396. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.dbg.json +0 -4
  397. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.json +0 -117
  398. package/artifacts/contracts/instance/module/distribution/DistributionModule.sol/DistributionModule.dbg.json +0 -4
  399. package/artifacts/contracts/instance/module/distribution/DistributionModule.sol/DistributionModule.json +0 -10
  400. package/artifacts/contracts/instance/module/distribution/IDistribution.sol/IDistribution.dbg.json +0 -4
  401. package/artifacts/contracts/instance/module/distribution/IDistribution.sol/IDistributionModule.dbg.json +0 -4
  402. package/artifacts/contracts/instance/module/distribution/IDistribution.sol/IDistributionModule.json +0 -10
  403. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicy.dbg.json +0 -4
  404. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.dbg.json +0 -4
  405. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.json +0 -271
  406. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.dbg.json +0 -4
  407. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.json +0 -271
  408. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPool.dbg.json +0 -4
  409. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPool.json +0 -10
  410. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.dbg.json +0 -4
  411. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.json +0 -164
  412. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.dbg.json +0 -4
  413. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.json +0 -164
  414. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRisk.dbg.json +0 -4
  415. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.dbg.json +0 -4
  416. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.json +0 -113
  417. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.dbg.json +0 -4
  418. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.json +0 -131
  419. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasury.dbg.json +0 -4
  420. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.dbg.json +0 -4
  421. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.json +0 -638
  422. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.dbg.json +0 -4
  423. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.json +0 -76
  424. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.dbg.json +0 -4
  425. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.json +0 -638
  426. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.dbg.json +0 -4
  427. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.json +0 -794
  428. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.dbg.json +0 -4
  429. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.dbg.json +0 -4
  430. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.json +0 -457
  431. package/artifacts/contracts/test/TestDistribution.sol/TestDistribution.dbg.json +0 -4
  432. package/artifacts/contracts/test/TestDistribution.sol/TestDistribution.json +0 -557
  433. package/artifacts/contracts/test/TestPool.sol/TestPool.dbg.json +0 -4
  434. package/artifacts/contracts/test/TestPool.sol/TestPool.json +0 -716
  435. package/artifacts/contracts/test/TestProduct.sol/TestProduct.dbg.json +0 -4
  436. package/artifacts/contracts/test/TestProduct.sol/TestProduct.json +0 -744
  437. package/artifacts/contracts/types/ReferralId.sol/ReferralIdLib.dbg.json +0 -4
  438. package/artifacts/contracts/types/ReferralId.sol/ReferralIdLib.json +0 -99
  439. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.dbg.json +0 -4
  440. package/contracts/components/BaseComponent.sol +0 -79
  441. package/contracts/components/IBaseComponent.sol +0 -19
  442. package/contracts/experiment/errors/Require.sol +0 -38
  443. package/contracts/experiment/errors/Revert.sol +0 -44
  444. package/contracts/experiment/inheritance/A.sol +0 -53
  445. package/contracts/experiment/inheritance/B.sol +0 -28
  446. package/contracts/experiment/inheritance/C.sol +0 -34
  447. package/contracts/experiment/inheritance/IA.sol +0 -13
  448. package/contracts/experiment/inheritance/IB.sol +0 -10
  449. package/contracts/experiment/inheritance/IC.sol +0 -12
  450. package/contracts/experiment/statemachine/Dummy.sol +0 -27
  451. package/contracts/experiment/statemachine/ISM.sol +0 -25
  452. package/contracts/experiment/statemachine/SM.sol +0 -57
  453. package/contracts/experiment/statemachine/SimpleStateMachine.sol +0 -31
  454. package/contracts/experiment/types/TypeA.sol +0 -47
  455. package/contracts/experiment/types/TypeB.sol +0 -29
  456. package/contracts/instance/IInstanceLinked.sol +0 -8
  457. package/contracts/instance/base/ComponentServiceBase.sol +0 -49
  458. package/contracts/instance/base/IInstanceBase.sol +0 -23
  459. package/contracts/instance/base/IService.sol +0 -15
  460. package/contracts/instance/base/InstanceBase.sol +0 -89
  461. package/contracts/instance/base/ModuleBase.sol +0 -57
  462. package/contracts/instance/base/ServiceBase.sol +0 -44
  463. package/contracts/instance/module/access/Access.sol +0 -149
  464. package/contracts/instance/module/access/IAccess.sol +0 -53
  465. package/contracts/instance/module/bundle/BundleModule.sol +0 -134
  466. package/contracts/instance/module/bundle/IBundle.sol +0 -53
  467. package/contracts/instance/module/component/ComponentModule.sol +0 -71
  468. package/contracts/instance/module/component/IComponent.sol +0 -28
  469. package/contracts/instance/module/distribution/DistributionModule.sol +0 -17
  470. package/contracts/instance/module/distribution/IDistribution.sol +0 -10
  471. package/contracts/instance/module/policy/IPolicy.sol +0 -63
  472. package/contracts/instance/module/policy/PolicyModule.sol +0 -91
  473. package/contracts/instance/module/pool/IPoolModule.sol +0 -41
  474. package/contracts/instance/module/pool/PoolModule.sol +0 -95
  475. package/contracts/instance/module/risk/IRisk.sol +0 -26
  476. package/contracts/instance/module/risk/RiskModule.sol +0 -62
  477. package/contracts/instance/module/treasury/ITreasury.sol +0 -84
  478. package/contracts/instance/module/treasury/TokenHandler.sol +0 -48
  479. package/contracts/instance/module/treasury/TreasuryModule.sol +0 -131
  480. package/contracts/instance/service/ComponentOwnerService.sol +0 -275
  481. package/contracts/instance/service/IComponentOwnerService.sol +0 -20
  482. package/contracts/registry/IChainNft.sol +0 -22
  483. package/contracts/test/TestDistribution.sol +0 -22
  484. package/contracts/test/TestPool.sol +0 -27
  485. package/contracts/test/TestProduct.sol +0 -74
  486. package/contracts/types/ReferralId.sol +0 -48
package/README.md CHANGED
@@ -1,4 +1,5 @@
1
- # gif-next (Generic Insurance Framework next version)
1
+ # GIF-Next (Generic Insurance Framework, next version)
2
+
2
3
 
3
4
  ## Add OpenZeppelin V5 Dependencies
4
5
 
@@ -27,6 +28,10 @@ This repository uses submodules. To checkout or update to the latest submodules,
27
28
  git submodule update --recursive
28
29
  ```
29
30
 
31
+ ## Example components
32
+
33
+ A (very early) example of a product and a pool can be found in the [gif-next-sandbox repository](https://github.com/etherisc/gif-next-sandbox).
34
+
30
35
  ## Hardhat
31
36
 
32
37
  ### NPM Commands
@@ -40,7 +45,18 @@ npm run test-with-gas
40
45
  npm run coverage
41
46
  ```
42
47
 
43
- ### Deployment
48
+ ### Docgen
49
+
50
+ Produce `solidty-docgen` documentation using the command below.
51
+
52
+ ```shell
53
+ hh docgen
54
+ ```
55
+
56
+ The resulting markdown files are written to `docs`
57
+
58
+
59
+ ### Full protocol deployment
44
60
 
45
61
  Install the dependencies before running the script below for the first time.
46
62
 
@@ -70,6 +86,25 @@ Environment variables:
70
86
  - `WALLET_MNEMONIC` the mnemonic of the wallet to use for deployment (required for mumbai and mainnet)
71
87
  - `ETHERSCAN_API_KEY` `POLYGONSCAN_API_KEY` the api key for etherscan/polygonscan (required for mumbai and mainnet)
72
88
 
89
+ ### Create a new instance
90
+
91
+ Requires previous step to be completed.
92
+
93
+ ```bash
94
+ # set appropriate values vor env variables (see below)
95
+
96
+ hh run --network <networkname> scripts/new_instance.ts
97
+ ```
98
+
99
+ 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.
100
+ The instance owner will be the 11th address of the wallet.
101
+
102
+ Environment variables:
103
+
104
+ - `WEB3_INFURA_PROJECT_ID` set to infura project id (required for mumbai and mainnet)
105
+ - `WALLET_MNEMONIC` the mnemonic of the wallet to use for deployment (required for mumbai and mainnet)
106
+ - `REGISTRY_ADDRESS` the address of the registry that is already deployed and configured and has a valid master instance
107
+
73
108
 
74
109
  ### Console
75
110
 
@@ -108,7 +143,11 @@ forge test -vvvv --mt test_decimals
108
143
  # provide gas report for a single test
109
144
  forge test --mt test_decimals --gas-report
110
145
 
146
+ # provide code coverage report
111
147
  forge coverage
148
+ forge coverage --report lcov
149
+
150
+
112
151
  ```
113
152
 
114
153
  Chisel session
@@ -185,17 +224,7 @@ https://book.getfoundry.sh/reference/
185
224
 
186
225
  ## Style Guide
187
226
 
188
- Solidity code is to be written according to the [Solidity Style Guide](https://docs.soliditylang.org/en/latest/style-guide.html).
189
-
190
- Documentation of the code should be written inline using [NatSpec](https://docs.soliditylang.org/en/latest/natspec-format.html).
191
-
192
- ### Naming conventions
193
-
194
- Additionally, we use the following naming conventions:
195
-
196
- - Function arguments and return types: If using custom data types, make the name include the type by appending the Type to the argument name, e.g. `function getInfo(NftId bundleNftId)` instead of `function getInfo(NftId bundleId)`. Background: Custom data types are lost when using the ABI or Typescript binding classes (e.g. instead of `NftID` a `uint96` is used), so the type needs to be included in the name to make it clear what the argument is without having to look at the documentation or checking the solidity source code.
197
- - When naming a field or an attribute `id` and the context is not clear, call it `nftId` instead so its clear what type if id it is as there will be multiple ids for different kind of objects. Example: if you the function has a bundle nft id and a policy nft id as arguments, call them `bundleNftId` and `policyNftId` instead of `id` and `policyId`. In case of doubt, be a bit more verbose for the sake of clarity.
198
- - When naming things, remember that the code will likely be used in Javascript/Typescript as well, so avoid names that are reserved in Javascript/Typescript. A list of reserved words in Javascript can be found [here](https://www.w3schools.com/js/js_reserved.asp) and a list of reserved words in Typescript can be found [here](https://www.tektutorialshub.com/typescript/identifiers-keywords-in-typescript/).
227
+ Please see https://docs.etherisc.com/gif-next/3.x/ for style guide and general coding rules.
199
228
 
200
229
  ### Automatic code formatting
201
230
 
@@ -210,7 +239,7 @@ We use solhint to lint the code.
210
239
  To execute linting run `npm run lint`.
211
240
 
212
241
 
213
- ### Adding Brownie (Legacy)
242
+ ### Adding Brownie (Legacy - don't do that :wink: )
214
243
 
215
244
  python3 is already installed
216
245
 
@@ -272,6 +301,98 @@ pool_id = pool.getNftId()
272
301
  product_id = product.getNftId()
273
302
  ```
274
303
 
304
+ ## Objects
305
+
306
+ ### Registry
307
+
308
+ Mandatory properties
309
+
310
+ * One registry per chain
311
+ * Global registry: the registry on mainnet
312
+ * One entry per protocol object
313
+ * Once registered object properties are immutable
314
+ * Globally unique NFT minted per protocol object (chain id is embedded in NFT id)
315
+ * Object ownership defined by NFT ownernship
316
+ * Typed objects (instance, product, policy, ...)
317
+ * Each object has parent object (only one exception: protocol object does not have parent object)
318
+ * Parent object type is defined by type of child object
319
+
320
+ Object properties (for smart contracts)
321
+ * Objects that represent a smart contract record its contract address
322
+ * With one exception (see next point) smart contract addresses refer to the address on the same chain as the registry
323
+ * 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)
324
+
325
+ Optional properties
326
+
327
+ * Objects can have names
328
+ * Object names are unique per chain
329
+ * 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)
330
+ *
331
+
332
+ Ownership property
333
+
334
+ * Object ownership defined by ownership of NFT representing the object
335
+ * Protocol
336
+ * Fixed/predefined owner (address without private key)
337
+ * Registry
338
+ * Allows registration of token and services (per major release)
339
+ * May transfer ownership
340
+ * Token
341
+ * Fixed/predefined owner (address without private key)
342
+ * TODO add whitelisting for token per major release
343
+ * Service
344
+ * Allows upgrades of services as long as major version is same
345
+ * Until further notice the same entity as the registry owner
346
+ * May transfer ownership
347
+ * Instance
348
+ * Granting/revoking of roles (both default + custom)
349
+ * Management of custom roles and targets
350
+ * May lock instance and/or components
351
+ * May transfer ownership
352
+ * Component (Product, Pool, Distribution, Oracle)
353
+ * Register component
354
+ * Set component wallet (which receives fees, holds funds)
355
+ * May lock component
356
+ * May transfer ownership
357
+ * Additional use case specific features
358
+ * Policy
359
+ * Represents policy holder
360
+ * Receive payouts (GIF default behaviour)
361
+ * May transfer ownership
362
+ * Bundle
363
+ * Represents funds owner
364
+ * May withdraw funds not locked by active policies
365
+ * May transfer ownership
366
+ * Distributor
367
+ * Receives commissions from sales (GIF default behaviour)
368
+ * May transfer ownership
369
+
370
+ Intercepting property
371
+ * Service owner is indirectly owner of service manager contract
372
+
373
+ * Instance
374
+ * intercepts transfer of instance owner (new owner needs access manager admin rights for custom roles and targets)
375
+ * intercepts transfer of components, to do what? check that new owner has necessary roles?
376
+ * Product
377
+ * intercepts transfer of policies (use case specific: eg. limit/disallow transfers)
378
+ * Pool:
379
+ * intercepts transfer of bundles (use case specific: eg. limit/disallow transfers)
380
+ * Distribution
381
+ * intercepts transfer of distributors (bookkeeping: only one distributor per address allowed)
382
+ * Oracle
383
+ * likely meaningless
384
+
385
+
386
+ ### Instance
387
+
388
+ ### Product
389
+
390
+ ### Pool
391
+
392
+ ### Distribution
393
+
394
+ ### Oracle
395
+
275
396
  ## Registry and Services
276
397
 
277
398
  ### Principles
@@ -312,3 +433,46 @@ Distribution Service
312
433
  - registered via registry service by registry owner
313
434
  - registers distribution components for registered products via registry service by distribution owner (distribution owner role is permissend by the product's instance)
314
435
  - registers distributors for registered distribution components via registry service
436
+
437
+ ## Contract Organisation
438
+
439
+ now
440
+
441
+ contracts
442
+ components
443
+ instance
444
+ registry
445
+ shared
446
+ types
447
+
448
+
449
+ contracts
450
+ component
451
+ pool
452
+ Pool.sol
453
+ PoolService.sol
454
+ oracle
455
+ distribution
456
+ product
457
+ Product.sol
458
+ ProductService.sol
459
+ Component.sol
460
+ ComponentService.sol
461
+ instance
462
+ Instance.sol
463
+ InstanceAccessManager.sol
464
+ InstanceReader.sol
465
+ InstanceService.sol
466
+ InstanceServiceManager.sol
467
+ registry
468
+ ChainNft.sol
469
+ Registry.sol
470
+ RegistryService.sol
471
+ RegistryServiceManager.sol
472
+ shared
473
+ Registerable.sol
474
+ RegisterableUpgradable.sol
475
+ type
476
+ NftId.sol
477
+ ObjectType.sol
478
+
@@ -0,0 +1,4 @@
1
+ {
2
+ "_format": "hh-sol-dbg-1",
3
+ "buildInfo": "../../../build-info/9ad7e5cd40fc44ac9661107a4e6da944.json"
4
+ }