@etherisc/gif-next 0.0.2-f99f1d2-109 → 0.0.2-faaba97-954

Sign up to get free protection for your applications and to get access to all the features.
Files changed (466) hide show
  1. package/README.md +337 -19
  2. package/artifacts/contracts/components/Component.sol/Component.dbg.json +1 -1
  3. package/artifacts/contracts/components/Component.sol/Component.json +672 -35
  4. package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json +4 -0
  5. package/artifacts/contracts/components/Distribution.sol/Distribution.json +1329 -0
  6. package/artifacts/contracts/components/IComponent.sol/IComponent.dbg.json +4 -0
  7. package/artifacts/contracts/components/IComponent.sol/IComponent.json +605 -0
  8. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.dbg.json +4 -0
  9. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.json +969 -0
  10. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.dbg.json +4 -0
  11. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.json +1064 -0
  12. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.dbg.json +4 -0
  13. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.json +830 -0
  14. package/artifacts/contracts/components/Pool.sol/Pool.dbg.json +1 -1
  15. package/artifacts/contracts/components/Pool.sol/Pool.json +1180 -132
  16. package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
  17. package/artifacts/contracts/components/Product.sol/Product.json +977 -156
  18. package/artifacts/contracts/instance/AccessManagerUpgradeableInitializeable.sol/AccessManagerUpgradeableInitializeable.dbg.json +4 -0
  19. package/artifacts/contracts/instance/AccessManagerUpgradeableInitializeable.sol/AccessManagerUpgradeableInitializeable.json +1206 -0
  20. package/artifacts/contracts/instance/BundleManager.sol/BundleManager.dbg.json +4 -0
  21. package/artifacts/contracts/instance/BundleManager.sol/BundleManager.json +778 -0
  22. package/artifacts/contracts/instance/Cloneable.sol/Cloneable.dbg.json +4 -0
  23. package/artifacts/contracts/instance/Cloneable.sol/Cloneable.json +190 -0
  24. package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
  25. package/artifacts/contracts/instance/IInstance.sol/IInstance.json +1698 -810
  26. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.dbg.json +4 -0
  27. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.json +633 -0
  28. package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
  29. package/artifacts/contracts/instance/Instance.sol/Instance.json +2413 -849
  30. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.dbg.json +4 -0
  31. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.json +1330 -0
  32. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.dbg.json +4 -0
  33. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.json +1289 -0
  34. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.dbg.json +4 -0
  35. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.json +1179 -0
  36. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.dbg.json +4 -0
  37. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.json +741 -0
  38. package/artifacts/contracts/instance/ObjectManager.sol/ObjectManager.dbg.json +4 -0
  39. package/artifacts/contracts/instance/ObjectManager.sol/ObjectManager.json +256 -0
  40. package/artifacts/contracts/instance/base/ComponentService.sol/ComponentService.dbg.json +4 -0
  41. package/artifacts/contracts/instance/base/ComponentService.sol/ComponentService.json +607 -0
  42. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.dbg.json +4 -0
  43. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.json +429 -0
  44. package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.dbg.json +4 -0
  45. package/artifacts/contracts/instance/{lifecycle/ILifecycle.sol/ILifecycleModule.json → base/ILifecycle.sol/ILifecycle.json} +10 -77
  46. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.dbg.json +4 -0
  47. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.json +532 -0
  48. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.dbg.json +4 -0
  49. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.json +194 -0
  50. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.dbg.json +4 -0
  51. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.json +237 -0
  52. package/artifacts/contracts/instance/module/IBundle.sol/IBundle.dbg.json +4 -0
  53. package/artifacts/contracts/instance/{access/IAccess.sol/IAccess.json → module/IBundle.sol/IBundle.json} +2 -2
  54. package/artifacts/contracts/instance/module/IComponents.sol/IComponents.dbg.json +4 -0
  55. package/artifacts/contracts/instance/module/IComponents.sol/IComponents.json +10 -0
  56. package/artifacts/contracts/instance/module/IDistribution.sol/IDistribution.dbg.json +4 -0
  57. package/artifacts/contracts/instance/{component/IComponent.sol/IComponent.json → module/IDistribution.sol/IDistribution.json} +2 -2
  58. package/artifacts/contracts/instance/module/IPolicy.sol/IPolicy.dbg.json +4 -0
  59. package/artifacts/contracts/instance/{policy → module}/IPolicy.sol/IPolicy.json +1 -1
  60. package/artifacts/contracts/instance/module/IRisk.sol/IRisk.dbg.json +4 -0
  61. package/artifacts/contracts/instance/{pool/IPoolModule.sol/IPool.json → module/IRisk.sol/IRisk.json} +2 -2
  62. package/artifacts/contracts/instance/module/ISetup.sol/ISetup.dbg.json +4 -0
  63. package/artifacts/contracts/instance/module/ISetup.sol/ISetup.json +10 -0
  64. package/artifacts/contracts/instance/module/ITreasury.sol/ITreasury.dbg.json +4 -0
  65. package/artifacts/contracts/instance/{treasury → module}/ITreasury.sol/ITreasury.json +1 -1
  66. package/artifacts/contracts/instance/service/ApplicationService.sol/ApplicationService.dbg.json +4 -0
  67. package/artifacts/contracts/instance/service/ApplicationService.sol/ApplicationService.json +1039 -0
  68. package/artifacts/contracts/instance/service/ApplicationServiceManager.sol/ApplicationServiceManager.dbg.json +4 -0
  69. package/artifacts/contracts/instance/service/ApplicationServiceManager.sol/ApplicationServiceManager.json +673 -0
  70. package/artifacts/contracts/instance/service/BundleService.sol/BundleService.dbg.json +4 -0
  71. package/artifacts/contracts/instance/service/BundleService.sol/BundleService.json +1231 -0
  72. package/artifacts/contracts/instance/service/BundleServiceManager.sol/BundleServiceManager.dbg.json +4 -0
  73. package/artifacts/contracts/instance/service/BundleServiceManager.sol/BundleServiceManager.json +721 -0
  74. package/artifacts/contracts/instance/service/ClaimService.sol/ClaimService.dbg.json +4 -0
  75. package/artifacts/contracts/instance/service/ClaimService.sol/ClaimService.json +817 -0
  76. package/artifacts/contracts/instance/service/ClaimServiceManager.sol/ClaimServiceManager.dbg.json +4 -0
  77. package/artifacts/contracts/instance/service/ClaimServiceManager.sol/ClaimServiceManager.json +641 -0
  78. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.dbg.json +4 -0
  79. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.json +1798 -0
  80. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.dbg.json +4 -0
  81. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.json +805 -0
  82. package/artifacts/contracts/instance/service/IApplicationService.sol/IApplicationService.dbg.json +4 -0
  83. package/artifacts/contracts/instance/service/IApplicationService.sol/IApplicationService.json +622 -0
  84. package/artifacts/contracts/instance/service/IBundleService.sol/IBundleService.dbg.json +4 -0
  85. package/artifacts/contracts/instance/service/IBundleService.sol/IBundleService.json +659 -0
  86. package/artifacts/contracts/instance/service/IClaimService.sol/IClaimService.dbg.json +4 -0
  87. package/artifacts/contracts/instance/service/IClaimService.sol/IClaimService.json +475 -0
  88. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.dbg.json +4 -0
  89. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.json +1090 -0
  90. package/artifacts/contracts/instance/service/IPolicyService.sol/IPolicyService.dbg.json +4 -0
  91. package/artifacts/contracts/instance/service/IPolicyService.sol/IPolicyService.json +606 -0
  92. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +4 -0
  93. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +844 -0
  94. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +4 -0
  95. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +450 -0
  96. package/artifacts/contracts/instance/service/PolicyService.sol/PolicyService.dbg.json +4 -0
  97. package/artifacts/contracts/instance/service/PolicyService.sol/PolicyService.json +1092 -0
  98. package/artifacts/contracts/instance/service/PolicyServiceManager.sol/PolicyServiceManager.dbg.json +4 -0
  99. package/artifacts/contracts/instance/service/PolicyServiceManager.sol/PolicyServiceManager.json +697 -0
  100. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.dbg.json +4 -0
  101. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.json +1237 -0
  102. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.dbg.json +4 -0
  103. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.json +661 -0
  104. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.dbg.json +4 -0
  105. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.json +840 -0
  106. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.dbg.json +4 -0
  107. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.json +653 -0
  108. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
  109. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.json +252 -2
  110. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
  111. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.json +595 -27
  112. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.dbg.json +4 -0
  113. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.json +866 -0
  114. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.dbg.json +4 -0
  115. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.json +52 -0
  116. package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
  117. package/artifacts/contracts/registry/Registry.sol/Registry.json +652 -50
  118. package/artifacts/contracts/registry/RegistryAccessManager.sol/RegistryAccessManager.dbg.json +4 -0
  119. package/artifacts/contracts/registry/RegistryAccessManager.sol/RegistryAccessManager.json +285 -0
  120. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.dbg.json +4 -0
  121. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.json +1158 -0
  122. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.dbg.json +4 -0
  123. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.json +670 -0
  124. package/artifacts/contracts/registry/ReleaseManager.sol/ReleaseManager.dbg.json +4 -0
  125. package/artifacts/contracts/registry/ReleaseManager.sol/ReleaseManager.json +559 -0
  126. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.dbg.json +4 -0
  127. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.json +498 -0
  128. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.dbg.json +4 -0
  129. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.json +107 -0
  130. package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json +4 -0
  131. package/artifacts/contracts/shared/ERC165.sol/ERC165.json +73 -0
  132. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.dbg.json +4 -0
  133. package/artifacts/contracts/{registry/Registry.sol/Registerable.json → shared/INftOwnable.sol/INftOwnable.json} +46 -74
  134. package/artifacts/contracts/shared/IPolicyHolder.sol/IPolicyHolder.dbg.json +4 -0
  135. package/artifacts/contracts/{instance/product/IProductService.sol/IProductService.json → shared/IPolicyHolder.sol/IPolicyHolder.json} +68 -66
  136. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +4 -0
  137. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.json +188 -0
  138. package/artifacts/contracts/shared/IRegistryLinked.sol/IRegistryLinked.dbg.json +4 -0
  139. package/artifacts/contracts/{registry/IRegistry.sol → shared/IRegistryLinked.sol}/IRegistryLinked.json +18 -19
  140. package/artifacts/contracts/shared/IService.sol/IService.dbg.json +4 -0
  141. package/artifacts/contracts/{instance/component/ComponentModule.sol/ComponentModule.json → shared/IService.sol/IService.json} +168 -132
  142. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.dbg.json +4 -0
  143. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json +55 -0
  144. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.dbg.json +4 -0
  145. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.json +251 -0
  146. package/artifacts/contracts/shared/PolicyHolder.sol/PolicyHolder.dbg.json +4 -0
  147. package/artifacts/contracts/shared/PolicyHolder.sol/PolicyHolder.json +248 -0
  148. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.dbg.json +4 -0
  149. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.json +582 -0
  150. package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +4 -0
  151. package/artifacts/contracts/shared/Registerable.sol/Registerable.json +352 -0
  152. package/artifacts/contracts/shared/RegistryLinked.sol/RegistryLinked.dbg.json +4 -0
  153. package/artifacts/contracts/shared/RegistryLinked.sol/RegistryLinked.json +84 -0
  154. package/artifacts/contracts/shared/Service.sol/Service.dbg.json +4 -0
  155. package/artifacts/contracts/{registry/IChainNft.sol/IChainNft.json → shared/Service.sol/Service.json} +261 -217
  156. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.dbg.json +4 -0
  157. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.json +96 -0
  158. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.dbg.json +4 -0
  159. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.json +129 -0
  160. package/artifacts/contracts/shared/Versionable.sol/Versionable.dbg.json +4 -0
  161. package/artifacts/contracts/shared/Versionable.sol/Versionable.json +78 -0
  162. package/artifacts/contracts/test/TestFee.sol/TestFee.dbg.json +4 -0
  163. package/artifacts/contracts/test/TestFee.sol/TestFee.json +119 -0
  164. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.dbg.json +4 -0
  165. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.json +383 -0
  166. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.dbg.json +4 -0
  167. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.json +116 -0
  168. package/artifacts/contracts/test/TestService.sol/TestService.dbg.json +4 -0
  169. package/artifacts/contracts/test/TestService.sol/TestService.json +596 -0
  170. package/artifacts/contracts/test/TestToken.sol/TestUsdc.dbg.json +4 -0
  171. package/artifacts/contracts/test/TestToken.sol/TestUsdc.json +376 -0
  172. package/artifacts/contracts/test/TestVersion.sol/TestVersion.dbg.json +4 -0
  173. package/artifacts/contracts/test/TestVersion.sol/TestVersion.json +218 -0
  174. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.dbg.json +4 -0
  175. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.json +104 -0
  176. package/artifacts/contracts/test/Usdc.sol/USDC.dbg.json +4 -0
  177. package/artifacts/contracts/test/Usdc.sol/USDC.json +376 -0
  178. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.dbg.json +4 -0
  179. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.json +10 -0
  180. package/artifacts/contracts/types/Amount.sol/AmountLib.dbg.json +4 -0
  181. package/artifacts/contracts/types/Amount.sol/AmountLib.json +161 -0
  182. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
  183. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.json +2 -2
  184. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.dbg.json +1 -1
  185. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.json +2 -2
  186. package/artifacts/contracts/types/ClaimId.sol/ClaimIdLib.dbg.json +4 -0
  187. package/artifacts/contracts/types/ClaimId.sol/ClaimIdLib.json +100 -0
  188. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.dbg.json +4 -0
  189. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.json +104 -0
  190. package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +4 -0
  191. package/artifacts/contracts/types/Fee.sol/FeeLib.json +288 -0
  192. package/artifacts/contracts/types/Key32.sol/Key32Lib.dbg.json +4 -0
  193. package/artifacts/contracts/types/Key32.sol/Key32Lib.json +125 -0
  194. package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
  195. package/artifacts/contracts/types/NftId.sol/NftIdLib.json +78 -4
  196. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +4 -0
  197. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +33 -0
  198. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.dbg.json +4 -0
  199. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.json +100 -0
  200. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +1 -1
  201. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +2 -2
  202. package/artifacts/contracts/types/PayoutId.sol/PayoutIdLib.dbg.json +4 -0
  203. package/artifacts/contracts/types/PayoutId.sol/PayoutIdLib.json +100 -0
  204. package/artifacts/contracts/types/Referral.sol/ReferralLib.dbg.json +4 -0
  205. package/artifacts/contracts/types/Referral.sol/ReferralLib.json +142 -0
  206. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.dbg.json +4 -0
  207. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.json +86 -0
  208. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.dbg.json +4 -0
  209. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.json +156 -0
  210. package/artifacts/contracts/types/Seconds.sol/SecondsLib.dbg.json +4 -0
  211. package/artifacts/contracts/types/Seconds.sol/SecondsLib.json +124 -0
  212. package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +1 -1
  213. package/artifacts/contracts/types/StateId.sol/StateIdLib.json +2 -2
  214. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
  215. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.json +97 -4
  216. package/artifacts/contracts/types/UFixed.sol/MathLib.dbg.json +4 -0
  217. package/artifacts/contracts/types/UFixed.sol/MathLib.json +10 -0
  218. package/artifacts/contracts/types/UFixed.sol/UFixedLib.dbg.json +4 -0
  219. package/artifacts/contracts/types/UFixed.sol/UFixedLib.json +479 -0
  220. package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +4 -0
  221. package/artifacts/contracts/types/Version.sol/VersionLib.json +177 -0
  222. package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +4 -0
  223. package/artifacts/contracts/types/Version.sol/VersionPartLib.json +49 -0
  224. package/contracts/components/Component.sol +227 -51
  225. package/contracts/components/Distribution.sol +280 -0
  226. package/contracts/components/IComponent.sol +76 -0
  227. package/contracts/components/IDistributionComponent.sol +71 -0
  228. package/contracts/components/IPoolComponent.sol +113 -0
  229. package/contracts/components/IProductComponent.sol +40 -0
  230. package/contracts/components/Pool.sol +281 -30
  231. package/contracts/components/Product.sol +252 -48
  232. package/contracts/instance/AccessManagerUpgradeableInitializeable.sol +13 -0
  233. package/contracts/instance/BundleManager.sol +127 -0
  234. package/contracts/instance/Cloneable.sol +51 -0
  235. package/contracts/instance/IInstance.sol +95 -22
  236. package/contracts/instance/IInstanceService.sol +72 -0
  237. package/contracts/instance/Instance.sol +306 -51
  238. package/contracts/instance/InstanceAccessManager.sol +527 -0
  239. package/contracts/instance/InstanceReader.sol +291 -0
  240. package/contracts/instance/InstanceService.sol +495 -0
  241. package/contracts/instance/InstanceServiceManager.sol +54 -0
  242. package/contracts/instance/ObjectManager.sol +82 -0
  243. package/contracts/instance/base/ComponentService.sol +121 -0
  244. package/contracts/instance/base/IKeyValueStore.sol +49 -0
  245. package/contracts/instance/base/ILifecycle.sol +30 -0
  246. package/contracts/instance/base/KeyValueStore.sol +180 -0
  247. package/contracts/instance/base/Lifecycle.sol +109 -0
  248. package/contracts/instance/module/IAccess.sol +54 -0
  249. package/contracts/instance/module/IBundle.sol +23 -0
  250. package/contracts/instance/module/IComponents.sol +41 -0
  251. package/contracts/instance/module/IDistribution.sol +41 -0
  252. package/contracts/instance/module/IPolicy.sol +72 -0
  253. package/contracts/instance/module/IRisk.sol +11 -0
  254. package/contracts/instance/module/ISetup.sol +33 -0
  255. package/contracts/instance/module/ITreasury.sol +23 -0
  256. package/contracts/instance/service/ApplicationService.sol +350 -0
  257. package/contracts/instance/service/ApplicationServiceManager.sol +35 -0
  258. package/contracts/instance/service/BundleService.sol +431 -0
  259. package/contracts/instance/service/BundleServiceManager.sol +51 -0
  260. package/contracts/instance/service/ClaimService.sol +151 -0
  261. package/contracts/instance/service/ClaimServiceManager.sol +35 -0
  262. package/contracts/instance/service/DistributionService.sol +435 -0
  263. package/contracts/instance/service/DistributionServiceManager.sol +51 -0
  264. package/contracts/instance/service/IApplicationService.sol +82 -0
  265. package/contracts/instance/service/IBundleService.sol +93 -0
  266. package/contracts/instance/service/IClaimService.sol +61 -0
  267. package/contracts/instance/service/IDistributionService.sol +99 -0
  268. package/contracts/instance/service/IPolicyService.sol +72 -0
  269. package/contracts/instance/service/IPoolService.sol +99 -0
  270. package/contracts/instance/service/IProductService.sol +40 -0
  271. package/contracts/instance/service/PolicyService.sol +362 -0
  272. package/contracts/instance/service/PolicyServiceManager.sol +54 -0
  273. package/contracts/instance/service/PoolService.sol +303 -0
  274. package/contracts/instance/service/PoolServiceManager.sol +51 -0
  275. package/contracts/instance/service/ProductService.sol +210 -0
  276. package/contracts/instance/service/ProductServiceManager.sol +54 -0
  277. package/contracts/registry/ChainNft.sol +137 -62
  278. package/contracts/registry/IRegistry.sol +75 -41
  279. package/contracts/registry/IRegistryService.sol +68 -0
  280. package/contracts/registry/ITransferInterceptor.sol +7 -0
  281. package/contracts/registry/Registry.sol +413 -128
  282. package/contracts/registry/RegistryAccessManager.sol +216 -0
  283. package/contracts/registry/RegistryService.sol +282 -0
  284. package/contracts/registry/RegistryServiceManager.sol +62 -0
  285. package/contracts/registry/ReleaseManager.sol +324 -0
  286. package/contracts/registry/TokenRegistry.sol +116 -0
  287. package/contracts/shared/ContractDeployerLib.sol +72 -0
  288. package/contracts/shared/ERC165.sol +27 -0
  289. package/contracts/shared/INftOwnable.sol +23 -0
  290. package/contracts/shared/IPolicyHolder.sol +26 -0
  291. package/contracts/shared/IRegisterable.sol +15 -0
  292. package/contracts/shared/IRegistryLinked.sol +12 -0
  293. package/contracts/shared/IService.sol +16 -0
  294. package/contracts/shared/IVersionable.sol +53 -0
  295. package/contracts/shared/NftOwnable.sol +120 -0
  296. package/contracts/shared/PolicyHolder.sol +81 -0
  297. package/contracts/shared/ProxyManager.sol +169 -0
  298. package/contracts/shared/Registerable.sol +74 -0
  299. package/contracts/shared/RegistryLinked.sol +48 -0
  300. package/contracts/shared/Service.sol +72 -0
  301. package/contracts/shared/TokenHandler.sol +33 -0
  302. package/contracts/shared/UpgradableProxyWithAdmin.sol +16 -0
  303. package/contracts/shared/Versionable.sol +59 -0
  304. package/contracts/test/TestFee.sol +25 -0
  305. package/contracts/test/TestRegisterable.sol +18 -0
  306. package/contracts/test/TestRoleId.sol +14 -0
  307. package/contracts/test/TestService.sol +25 -0
  308. package/contracts/test/TestToken.sol +26 -0
  309. package/contracts/test/TestVersion.sol +44 -0
  310. package/contracts/test/TestVersionable.sol +17 -0
  311. package/contracts/test/Usdc.sol +26 -0
  312. package/contracts/types/AddressSet.sol +58 -0
  313. package/contracts/types/Amount.sol +60 -0
  314. package/contracts/types/Blocknumber.sol +1 -0
  315. package/contracts/types/ClaimId.sol +52 -0
  316. package/contracts/types/DistributorType.sol +55 -0
  317. package/contracts/types/Fee.sol +52 -20
  318. package/contracts/types/Key32.sol +50 -0
  319. package/contracts/types/NftId.sol +30 -1
  320. package/contracts/types/NftIdSet.sol +62 -0
  321. package/contracts/types/NumberId.sol +52 -0
  322. package/contracts/types/ObjectType.sol +65 -15
  323. package/contracts/types/PayoutId.sol +54 -0
  324. package/contracts/types/Referral.sol +89 -0
  325. package/contracts/types/RiskId.sol +43 -0
  326. package/contracts/types/RoleId.sol +97 -0
  327. package/contracts/types/Seconds.sol +54 -0
  328. package/contracts/types/StateId.sol +19 -4
  329. package/contracts/types/Timestamp.sol +31 -6
  330. package/contracts/types/UFixed.sol +151 -31
  331. package/contracts/types/Version.sol +108 -0
  332. package/package.json +12 -5
  333. package/artifacts/contracts/components/Component.sol/InstanceLinked.dbg.json +0 -4
  334. package/artifacts/contracts/components/Component.sol/InstanceLinked.json +0 -35
  335. package/artifacts/contracts/components/IPool.sol/IPoolComponent.dbg.json +0 -4
  336. package/artifacts/contracts/components/IPool.sol/IPoolComponent.json +0 -255
  337. package/artifacts/contracts/components/IProduct.sol/IProductComponent.dbg.json +0 -4
  338. package/artifacts/contracts/components/IProduct.sol/IProductComponent.json +0 -74
  339. package/artifacts/contracts/experiment/errors/Require.sol/Require.dbg.json +0 -4
  340. package/artifacts/contracts/experiment/errors/Require.sol/Require.json +0 -105
  341. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.dbg.json +0 -4
  342. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.json +0 -105
  343. package/artifacts/contracts/experiment/inheritance/A.sol/A.dbg.json +0 -4
  344. package/artifacts/contracts/experiment/inheritance/A.sol/A.json +0 -128
  345. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.dbg.json +0 -4
  346. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.json +0 -42
  347. package/artifacts/contracts/experiment/inheritance/B.sol/B.dbg.json +0 -4
  348. package/artifacts/contracts/experiment/inheritance/B.sol/B.json +0 -76
  349. package/artifacts/contracts/experiment/inheritance/C.sol/C.dbg.json +0 -4
  350. package/artifacts/contracts/experiment/inheritance/C.sol/C.json +0 -89
  351. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.dbg.json +0 -4
  352. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.json +0 -128
  353. package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.dbg.json +0 -4
  354. package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.json +0 -37
  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/experiment/types/TypeB.sol/TypeBLib.json +0 -10
  373. package/artifacts/contracts/instance/access/Access.sol/AccessModule.dbg.json +0 -4
  374. package/artifacts/contracts/instance/access/Access.sol/AccessModule.json +0 -400
  375. package/artifacts/contracts/instance/access/IAccess.sol/IAccess.dbg.json +0 -4
  376. package/artifacts/contracts/instance/access/IAccess.sol/IAccessCheckRole.dbg.json +0 -4
  377. package/artifacts/contracts/instance/access/IAccess.sol/IAccessCheckRole.json +0 -35
  378. package/artifacts/contracts/instance/access/IAccess.sol/IAccessComponentTypeRoles.dbg.json +0 -4
  379. package/artifacts/contracts/instance/access/IAccess.sol/IAccessComponentTypeRoles.json +0 -50
  380. package/artifacts/contracts/instance/access/IAccess.sol/IAccessModule.dbg.json +0 -4
  381. package/artifacts/contracts/instance/access/IAccess.sol/IAccessModule.json +0 -336
  382. package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentModule.dbg.json +0 -4
  383. package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentOwnerService.dbg.json +0 -4
  384. package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentOwnerService.json +0 -202
  385. package/artifacts/contracts/instance/component/IComponent.sol/IComponent.dbg.json +0 -4
  386. package/artifacts/contracts/instance/component/IComponent.sol/IComponentContract.dbg.json +0 -4
  387. package/artifacts/contracts/instance/component/IComponent.sol/IComponentContract.json +0 -205
  388. package/artifacts/contracts/instance/component/IComponent.sol/IComponentModule.dbg.json +0 -4
  389. package/artifacts/contracts/instance/component/IComponent.sol/IComponentModule.json +0 -217
  390. package/artifacts/contracts/instance/component/IComponent.sol/IComponentOwnerService.dbg.json +0 -4
  391. package/artifacts/contracts/instance/component/IComponent.sol/IComponentOwnerService.json +0 -141
  392. package/artifacts/contracts/instance/component/IComponent.sol/IInstanceLinked.dbg.json +0 -4
  393. package/artifacts/contracts/instance/component/IComponent.sol/IInstanceLinked.json +0 -24
  394. package/artifacts/contracts/instance/lifecycle/ILifecycle.sol/ILifecycle.dbg.json +0 -4
  395. package/artifacts/contracts/instance/lifecycle/ILifecycle.sol/ILifecycle.json +0 -134
  396. package/artifacts/contracts/instance/lifecycle/ILifecycle.sol/ILifecycleModule.dbg.json +0 -4
  397. package/artifacts/contracts/instance/lifecycle/LifecycleModule.sol/LifecycleModule.dbg.json +0 -4
  398. package/artifacts/contracts/instance/lifecycle/LifecycleModule.sol/LifecycleModule.json +0 -221
  399. package/artifacts/contracts/instance/policy/IPolicy.sol/IPolicy.dbg.json +0 -4
  400. package/artifacts/contracts/instance/policy/IPolicy.sol/IPolicyModule.dbg.json +0 -4
  401. package/artifacts/contracts/instance/policy/IPolicy.sol/IPolicyModule.json +0 -254
  402. package/artifacts/contracts/instance/policy/PolicyModule.sol/PolicyModule.dbg.json +0 -4
  403. package/artifacts/contracts/instance/policy/PolicyModule.sol/PolicyModule.json +0 -254
  404. package/artifacts/contracts/instance/pool/IPoolModule.sol/IPool.dbg.json +0 -4
  405. package/artifacts/contracts/instance/pool/IPoolModule.sol/IPoolModule.dbg.json +0 -4
  406. package/artifacts/contracts/instance/pool/IPoolModule.sol/IPoolModule.json +0 -129
  407. package/artifacts/contracts/instance/pool/PoolModule.sol/PoolModule.dbg.json +0 -4
  408. package/artifacts/contracts/instance/pool/PoolModule.sol/PoolModule.json +0 -155
  409. package/artifacts/contracts/instance/product/IProductService.sol/IProductModule.dbg.json +0 -4
  410. package/artifacts/contracts/instance/product/IProductService.sol/IProductModule.json +0 -75
  411. package/artifacts/contracts/instance/product/IProductService.sol/IProductService.dbg.json +0 -4
  412. package/artifacts/contracts/instance/product/ProductService.sol/ProductModule.dbg.json +0 -4
  413. package/artifacts/contracts/instance/product/ProductService.sol/ProductModule.json +0 -75
  414. package/artifacts/contracts/instance/product/ProductService.sol/ProductService.dbg.json +0 -4
  415. package/artifacts/contracts/instance/product/ProductService.sol/ProductService.json +0 -196
  416. package/artifacts/contracts/instance/treasury/ITreasury.sol/ITreasury.dbg.json +0 -4
  417. package/artifacts/contracts/instance/treasury/ITreasury.sol/ITreasuryModule.dbg.json +0 -4
  418. package/artifacts/contracts/instance/treasury/ITreasury.sol/ITreasuryModule.json +0 -490
  419. package/artifacts/contracts/instance/treasury/TokenHandler.sol/TokenHandler.dbg.json +0 -4
  420. package/artifacts/contracts/instance/treasury/TokenHandler.sol/TokenHandler.json +0 -45
  421. package/artifacts/contracts/instance/treasury/TreasuryModule.sol/TreasuryModule.dbg.json +0 -4
  422. package/artifacts/contracts/instance/treasury/TreasuryModule.sol/TreasuryModule.json +0 -490
  423. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.dbg.json +0 -4
  424. package/artifacts/contracts/registry/IRegistry.sol/IOwnable.dbg.json +0 -4
  425. package/artifacts/contracts/registry/IRegistry.sol/IOwnable.json +0 -24
  426. package/artifacts/contracts/registry/IRegistry.sol/IRegisterable.dbg.json +0 -4
  427. package/artifacts/contracts/registry/IRegistry.sol/IRegisterable.json +0 -166
  428. package/artifacts/contracts/registry/IRegistry.sol/IRegistryLinked.dbg.json +0 -4
  429. package/artifacts/contracts/registry/Registry.sol/Registerable.dbg.json +0 -4
  430. package/artifacts/contracts/registry/Registry.sol/RegistryLinked.dbg.json +0 -4
  431. package/artifacts/contracts/registry/Registry.sol/RegistryLinked.json +0 -60
  432. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.dbg.json +0 -4
  433. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.json +0 -453
  434. package/contracts/components/IPool.sol +0 -15
  435. package/contracts/components/IProduct.sol +0 -16
  436. package/contracts/experiment/errors/Require.sol +0 -38
  437. package/contracts/experiment/errors/Revert.sol +0 -44
  438. package/contracts/experiment/inheritance/A.sol +0 -53
  439. package/contracts/experiment/inheritance/B.sol +0 -28
  440. package/contracts/experiment/inheritance/C.sol +0 -34
  441. package/contracts/experiment/inheritance/IA.sol +0 -13
  442. package/contracts/experiment/inheritance/IB.sol +0 -10
  443. package/contracts/experiment/inheritance/IC.sol +0 -12
  444. package/contracts/experiment/statemachine/Dummy.sol +0 -27
  445. package/contracts/experiment/statemachine/ISM.sol +0 -25
  446. package/contracts/experiment/statemachine/README.md +0 -112
  447. package/contracts/experiment/statemachine/SM.sol +0 -57
  448. package/contracts/experiment/statemachine/SimpleStateMachine.sol +0 -31
  449. package/contracts/experiment/types/TypeA.sol +0 -47
  450. package/contracts/experiment/types/TypeB.sol +0 -29
  451. package/contracts/instance/access/Access.sol +0 -165
  452. package/contracts/instance/access/IAccess.sol +0 -63
  453. package/contracts/instance/component/ComponentModule.sol +0 -274
  454. package/contracts/instance/component/IComponent.sol +0 -74
  455. package/contracts/instance/lifecycle/ILifecycle.sol +0 -47
  456. package/contracts/instance/lifecycle/LifecycleModule.sol +0 -88
  457. package/contracts/instance/policy/IPolicy.sol +0 -50
  458. package/contracts/instance/policy/PolicyModule.sol +0 -114
  459. package/contracts/instance/pool/IPoolModule.sol +0 -23
  460. package/contracts/instance/pool/PoolModule.sol +0 -81
  461. package/contracts/instance/product/IProductService.sol +0 -36
  462. package/contracts/instance/product/ProductService.sol +0 -136
  463. package/contracts/instance/treasury/ITreasury.sol +0 -91
  464. package/contracts/instance/treasury/TokenHandler.sol +0 -24
  465. package/contracts/instance/treasury/TreasuryModule.sol +0 -168
  466. package/contracts/registry/IChainNft.sol +0 -21
package/README.md CHANGED
@@ -1,4 +1,24 @@
1
- # gif-next (Generic Insurance Framework next version)
1
+ # GIF-Next (Generic Insurance Framework, next version)
2
+
3
+
4
+ ## Add OpenZeppelin V5 Dependencies
5
+
6
+ ```shell
7
+ forge install openzeppelin-contracts-500=OpenZeppelin/openzeppelin-contracts@v5.0.0
8
+ cd cd lib/openzeppelin-contracts-500
9
+ git checkout tags/v5.0.0
10
+ cd ../..
11
+ ```
12
+
13
+ See `remappings.txt` to see how to work with different OpenZeppelin versions in parallel
14
+
15
+ ```
16
+ cat remappings.txt
17
+ @openzeppelin5/contracts/=lib/openzeppelin-contracts-500/contracts/
18
+ @openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/
19
+ @openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/
20
+ ```
21
+
2
22
 
3
23
  ## Submodules checkout
4
24
 
@@ -8,6 +28,10 @@ This repository uses submodules. To checkout or update to the latest submodules,
8
28
  git submodule update --recursive
9
29
  ```
10
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
+
11
35
  ## Hardhat
12
36
 
13
37
  ### NPM Commands
@@ -21,17 +45,65 @@ npm run test-with-gas
21
45
  npm run coverage
22
46
  ```
23
47
 
24
- ### 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
60
+
61
+ Install the dependencies before running the script below for the first time.
62
+
63
+ ```bash
64
+ npm install
65
+ ```
66
+
67
+ The deploy script will deploy all required contracts and create a test instance with a test product and a test pool.
25
68
 
69
+ ```bash
70
+ # run deployment on a locally created ganache instance
71
+ export SKIP_VERIFICATION=true
72
+ hh run scripts/deploy_all.ts
26
73
  ```
27
- hh run --network <networkname> scripts/deploy.ts
74
+
75
+ ```bash
76
+ # set appropriate values vor env variables (see below)
77
+
78
+ # run deployment on another network
79
+ hh run --network <networkname> scripts/deploy_all.ts
28
80
  ```
29
81
 
30
- Networks:
31
- - hardhat (dynamically created network - https://hardhat.org/hardhat-network/docs/overview)
32
- - anvil (anvsil chain running in container next when using devcontainer)
33
- - mumbai (polygon testnet, requires WEB3_INFURA_PROJECT_ID)
34
- - mainnet (polygon mainnet, requires WEB3_INFURA_PROJECT_ID)
82
+ Environment variables:
83
+
84
+ - `SKIP_VERIFICATION` set to `true` to skip etherscan verification (required for ganacht and anvil)
85
+ - `WEB3_INFURA_PROJECT_ID` set to infura project id (required for mumbai and mainnet)
86
+ - `WALLET_MNEMONIC` the mnemonic of the wallet to use for deployment (required for mumbai and mainnet)
87
+ - `ETHERSCAN_API_KEY` `POLYGONSCAN_API_KEY` the api key for etherscan/polygonscan (required for mumbai and mainnet)
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
35
107
 
36
108
 
37
109
  ### Console
@@ -56,6 +128,9 @@ https://hardhat.org/hardhat-runner/docs/guides/compile-contracts
56
128
  ```shell
57
129
  forge build
58
130
 
131
+ # contract sizes
132
+ forge build --sizes | grep Instance
133
+
59
134
  forge test
60
135
 
61
136
  # run single test case
@@ -68,7 +143,11 @@ forge test -vvvv --mt test_decimals
68
143
  # provide gas report for a single test
69
144
  forge test --mt test_decimals --gas-report
70
145
 
146
+ # provide code coverage report
71
147
  forge coverage
148
+ forge coverage --report lcov
149
+
150
+
72
151
  ```
73
152
 
74
153
  Chisel session
@@ -127,7 +206,17 @@ uint256 lifetime =365*24*3600;
127
206
  uint256 policyNftId = ps.createApplicationForBundle(customer, bundleNftId, sumInsuredAmount, premiumAmount, lifetime);
128
207
 
129
208
  ```
209
+ ### Library Linking
130
210
 
211
+ https://ethereum.stackexchange.com/questions/153411/does-foundry-support-dynamical-library-linking-in-solidity
212
+
213
+ ```toml
214
+ # foundry.toml
215
+
216
+ [profile.default]
217
+ # expected format(example below): libraries = ["<path>:<lib name>:<address>"]
218
+ libraries = ["src/libraries/MyLibrary.sol:MyLibrary:0x..."]
219
+ ```
131
220
 
132
221
  ### Documentation
133
222
 
@@ -135,17 +224,7 @@ https://book.getfoundry.sh/reference/
135
224
 
136
225
  ## Style Guide
137
226
 
138
- Solidity code is to be written according to the [Solidity Style Guide](https://docs.soliditylang.org/en/latest/style-guide.html).
139
-
140
- Documentation of the code should be written inline using [NatSpec](https://docs.soliditylang.org/en/latest/natspec-format.html).
141
-
142
- ### Naming conventions
143
-
144
- Additionally, we use the following naming conventions:
145
-
146
- - 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.
147
- - 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.
148
- - 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.
149
228
 
150
229
  ### Automatic code formatting
151
230
 
@@ -158,3 +237,242 @@ To execute formatting run `npm run styleFix`.
158
237
 
159
238
  We use solhint to lint the code.
160
239
  To execute linting run `npm run lint`.
240
+
241
+
242
+ ### Adding Brownie (Legacy - don't do that :wink: )
243
+
244
+ python3 is already installed
245
+
246
+ ```bash
247
+ npm install -g ganache
248
+ sudo apt update
249
+ sudo apt install python3-pip
250
+ pip install eth-brownie
251
+ brownie pm install OpenZeppelin/openzeppelin-contracts@4.9.3
252
+ brownie pm install OpenZeppelin/openzeppelin-contracts@5.0.0
253
+ ```
254
+
255
+ ```bash
256
+ brownie compile --all
257
+ brownie console
258
+ ```
259
+
260
+ ```python
261
+ registry_owner = accounts[0]
262
+ instance_owner = accounts[1]
263
+ product_owner = accounts[2]
264
+
265
+ # deploy libs and helper contracts
266
+ nft_id_lib = NftIdLib.deploy({'from': registry_owner})
267
+ ufixed_math_lib = UFixedMathLib.deploy({'from': registry_owner})
268
+ test_fee = TestFee.deploy({'from': registry_owner})
269
+
270
+ # deploy registry and a token
271
+ registry = Registry.deploy({'from': registry_owner})
272
+ nft = ChainNft.deploy(registry, {'from': registry_owner})
273
+ registry.initialize(nft, {'from': registry_owner})
274
+ token = TestUsdc.deploy({'from': registry_owner})
275
+
276
+ # deploy services
277
+ component_owner_service = ComponentOwnerService.deploy(registry, {'from': registry_owner})
278
+ product_service = ProductService.deploy(registry, {'from': registry_owner})
279
+
280
+ # deploy an instance
281
+ instance = Instance.deploy(registry, component_owner_service, product_service, {'from': instance_owner})
282
+
283
+ # deploy product
284
+ pool = TestPool.deploy(registry, instance, token, {'from': product_owner})
285
+ policy_fee = test_fee.createFee(1, -1, 0)
286
+ product = TestProduct.deploy(registry, instance, token, pool, policy_fee, {'from': product_owner})
287
+
288
+ # grant roles
289
+ pool_owner_role = instance.getRoleForName("PoolOwner")
290
+ product_owner_role = instance.getRoleForName("ProductOwner")
291
+ instance.grantRole(pool_owner_role, product_owner, {'from': instance_owner})
292
+ instance.grantRole(product_owner_role, product_owner, {'from': instance_owner})
293
+
294
+ # register objects
295
+ instance.register()
296
+ component_owner_service.register(pool, {'from': product_owner})
297
+ component_owner_service.register(product, {'from': product_owner})
298
+
299
+ instance_id = instance.getNftId()
300
+ pool_id = pool.getNftId()
301
+ product_id = product.getNftId()
302
+ ```
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
+
396
+ ## Registry and Services
397
+
398
+ ### Principles
399
+
400
+ - 1 service per object type and major version
401
+ - registry service guards write access to registry
402
+ - all other objects registered via registry service
403
+ - root object for the complete tree is the protocol object
404
+ - under the root object a single registry object is registered (= global registry/ethereum mainnet)
405
+
406
+
407
+ ### Service Responsibilities
408
+
409
+ Registry Service
410
+
411
+ - deployed and registered during bootstrapping of registry
412
+ - used to register tokens and other services by registry owner
413
+ - an object may only be registered by the service designated by the type of the object
414
+ - to register an object the parent object needs already be registered
415
+ - the type of the object to be registered needs to match a valid child type/parent type combination
416
+
417
+ Instance Service
418
+
419
+ - deploys master instance during its own bootstrapping (if allowed by contract size)
420
+ - registered via registry service by registry owner
421
+ - registeres master instance during its own registration by regsitry owner
422
+ - deploys and registeres new instances (= instance factory) by instance owner (instance owner is a permissionless role, anybody may creates a new instance)
423
+ - provides upgrade functionality to instance owners
424
+
425
+ Product Service
426
+
427
+ - registered via registry service by registry owner
428
+ - registers products for registered instances via registry service by product owner (product owner role is permissend by the product's instance)
429
+ - registers applications/policies for registered products via registry service
430
+
431
+ Distribution Service
432
+
433
+ - registered via registry service by registry owner
434
+ - registers distribution components for registered products via registry service by distribution owner (distribution owner role is permissend by the product's instance)
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
+
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "_format": "hh-sol-dbg-1",
3
- "buildInfo": "../../../build-info/ddbd31d07c8880f0f0a18b3f2b9bcc56.json"
3
+ "buildInfo": "../../../build-info/a217c5bb40d255ef67cb8b4d687de7f1.json"
4
4
  }