@etherisc/gif-next 0.0.2-fb8d07b-779 → 0.0.2-fbe22f0-239

Sign up to get free protection for your applications and to get access to all the features.
Files changed (284) hide show
  1. package/README.md +136 -2
  2. package/artifacts/contracts/components/Component.sol/Component.dbg.json +4 -0
  3. package/artifacts/contracts/components/Component.sol/Component.json +858 -0
  4. package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json +1 -1
  5. package/artifacts/contracts/components/Distribution.sol/Distribution.json +588 -92
  6. package/artifacts/contracts/components/IComponent.sol/IComponent.dbg.json +4 -0
  7. package/artifacts/contracts/{shared/RegisterableUpgradable.sol/RegisterableUpgradable.json → components/IComponent.sol/IComponent.json} +208 -143
  8. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.dbg.json +1 -1
  9. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.json +543 -0
  10. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.dbg.json +1 -1
  11. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.json +663 -31
  12. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.dbg.json +1 -1
  13. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.json +648 -5
  14. package/artifacts/contracts/components/Pool.sol/Pool.dbg.json +1 -1
  15. package/artifacts/contracts/components/Pool.sol/Pool.json +818 -273
  16. package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
  17. package/artifacts/contracts/components/Product.sol/Product.json +657 -181
  18. package/artifacts/contracts/experiment/cloning/Cloner.sol/Cloner.dbg.json +1 -1
  19. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock1.dbg.json +1 -1
  20. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock2.dbg.json +1 -1
  21. package/artifacts/contracts/experiment/errors/Require.sol/Require.dbg.json +1 -1
  22. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.dbg.json +1 -1
  23. package/artifacts/contracts/experiment/inheritance/A.sol/A.dbg.json +1 -1
  24. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.dbg.json +1 -1
  25. package/artifacts/contracts/experiment/inheritance/B.sol/B.dbg.json +1 -1
  26. package/artifacts/contracts/experiment/inheritance/C.sol/C.dbg.json +1 -1
  27. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.dbg.json +1 -1
  28. package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.dbg.json +1 -1
  29. package/artifacts/contracts/experiment/inheritance/IB.sol/IB.dbg.json +1 -1
  30. package/artifacts/contracts/experiment/inheritance/IC.sol/IC.dbg.json +1 -1
  31. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.dbg.json +1 -1
  32. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.json +2 -2
  33. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.dbg.json +1 -1
  34. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.dbg.json +1 -1
  35. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.dbg.json +1 -1
  36. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.dbg.json +1 -1
  37. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.dbg.json +1 -1
  38. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.dbg.json +1 -1
  39. package/artifacts/contracts/instance/BundleManager.sol/BundleManager.dbg.json +4 -0
  40. package/artifacts/contracts/instance/BundleManager.sol/BundleManager.json +764 -0
  41. package/artifacts/contracts/instance/Cloneable.sol/Cloneable.dbg.json +4 -0
  42. package/artifacts/contracts/instance/{AccessManagedSimple.sol/AccessManagedSimple.json → Cloneable.sol/Cloneable.json} +86 -2
  43. package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
  44. package/artifacts/contracts/instance/IInstance.sol/IInstance.json +1371 -129
  45. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.dbg.json +1 -1
  46. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.json +132 -21
  47. package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
  48. package/artifacts/contracts/instance/Instance.sol/Instance.json +293 -656
  49. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.dbg.json +1 -1
  50. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.json +211 -144
  51. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.dbg.json +1 -1
  52. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.json +89 -91
  53. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.dbg.json +1 -1
  54. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.json +395 -122
  55. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.dbg.json +1 -1
  56. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.json +149 -57
  57. package/artifacts/contracts/instance/ObjectManager.sol/ObjectManager.dbg.json +4 -0
  58. package/artifacts/contracts/instance/ObjectManager.sol/ObjectManager.json +261 -0
  59. package/artifacts/contracts/instance/base/ComponentService.sol/ComponentService.dbg.json +4 -0
  60. package/artifacts/contracts/instance/base/{ComponentServiceBase.sol/ComponentServiceBase.json → ComponentService.sol/ComponentService.json} +243 -55
  61. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.dbg.json +1 -1
  62. package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.dbg.json +1 -1
  63. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.dbg.json +1 -1
  64. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.json +2 -2
  65. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.dbg.json +1 -1
  66. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.json +2 -2
  67. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.dbg.json +1 -1
  68. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.json +59 -16
  69. package/artifacts/contracts/instance/module/IBundle.sol/IBundle.dbg.json +1 -1
  70. package/artifacts/contracts/instance/module/IDistribution.sol/IDistribution.dbg.json +1 -1
  71. package/artifacts/contracts/instance/module/IPolicy.sol/IPolicy.dbg.json +1 -1
  72. package/artifacts/contracts/instance/module/IRisk.sol/IRisk.dbg.json +1 -1
  73. package/artifacts/contracts/instance/module/ISetup.sol/ISetup.dbg.json +1 -1
  74. package/artifacts/contracts/instance/module/ITreasury.sol/ITreasury.dbg.json +1 -1
  75. package/artifacts/contracts/instance/service/ApplicationService.sol/ApplicationService.dbg.json +4 -0
  76. package/artifacts/contracts/instance/service/ApplicationService.sol/ApplicationService.json +1091 -0
  77. package/artifacts/contracts/instance/service/BundleService.sol/BundleService.dbg.json +4 -0
  78. package/artifacts/contracts/instance/service/BundleService.sol/BundleService.json +1292 -0
  79. package/artifacts/contracts/instance/service/BundleServiceManager.sol/BundleServiceManager.dbg.json +4 -0
  80. package/artifacts/contracts/instance/service/BundleServiceManager.sol/BundleServiceManager.json +560 -0
  81. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.dbg.json +1 -1
  82. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.json +272 -91
  83. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.dbg.json +1 -1
  84. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.json +140 -40
  85. package/artifacts/contracts/instance/service/IApplicationService.sol/IApplicationService.dbg.json +4 -0
  86. package/artifacts/contracts/instance/service/{IComponentOwnerService.sol/IComponentOwnerService.json → IApplicationService.sol/IApplicationService.json} +217 -58
  87. package/artifacts/contracts/instance/service/IBundleService.sol/IBundleService.dbg.json +4 -0
  88. package/artifacts/contracts/instance/service/IBundleService.sol/IBundleService.json +785 -0
  89. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.dbg.json +1 -1
  90. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.json +20 -20
  91. package/artifacts/contracts/instance/service/IPolicyService.sol/IPolicyService.dbg.json +4 -0
  92. package/artifacts/contracts/instance/service/IPolicyService.sol/IPolicyService.json +771 -0
  93. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +1 -1
  94. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +22 -84
  95. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +1 -1
  96. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +32 -247
  97. package/artifacts/contracts/instance/service/PolicyService.sol/PolicyService.dbg.json +4 -0
  98. package/artifacts/contracts/instance/service/PolicyService.sol/PolicyService.json +1352 -0
  99. package/artifacts/contracts/instance/service/PolicyServiceManager.sol/PolicyServiceManager.dbg.json +4 -0
  100. package/artifacts/contracts/instance/service/PolicyServiceManager.sol/PolicyServiceManager.json +616 -0
  101. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.dbg.json +1 -1
  102. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.json +256 -180
  103. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.dbg.json +1 -1
  104. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.json +140 -52
  105. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.dbg.json +4 -0
  106. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.json +981 -0
  107. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.dbg.json +4 -0
  108. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.json +548 -0
  109. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
  110. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.json +2 -2
  111. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
  112. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.json +208 -224
  113. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.dbg.json +1 -1
  114. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.json +228 -95
  115. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.dbg.json +1 -1
  116. package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
  117. package/artifacts/contracts/registry/Registry.sol/Registry.json +222 -330
  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 +1 -1
  121. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.json +197 -109
  122. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.dbg.json +1 -1
  123. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.json +162 -112
  124. package/artifacts/contracts/registry/ReleaseManager.sol/ReleaseManager.dbg.json +4 -0
  125. package/artifacts/contracts/registry/ReleaseManager.sol/ReleaseManager.json +547 -0
  126. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.dbg.json +1 -1
  127. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.json +124 -29
  128. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.dbg.json +1 -1
  129. package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json +1 -1
  130. package/artifacts/contracts/shared/ERC165.sol/ERC165.json +41 -3
  131. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.dbg.json +1 -1
  132. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.json +24 -0
  133. package/artifacts/contracts/shared/IPolicyHolder.sol/IPolicyHolder.dbg.json +4 -0
  134. package/artifacts/contracts/shared/IPolicyHolder.sol/IPolicyHolder.json +129 -0
  135. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +1 -1
  136. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.json +5 -5
  137. package/artifacts/contracts/shared/IService.sol/IService.dbg.json +1 -1
  138. package/artifacts/contracts/shared/IService.sol/IService.json +20 -20
  139. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.dbg.json +1 -1
  140. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json +2 -2
  141. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.dbg.json +1 -1
  142. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.json +130 -11
  143. package/artifacts/contracts/shared/PolicyHolder.sol/PolicyHolder.dbg.json +4 -0
  144. package/artifacts/contracts/shared/PolicyHolder.sol/PolicyHolder.json +172 -0
  145. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.dbg.json +1 -1
  146. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.json +130 -6
  147. package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +1 -1
  148. package/artifacts/contracts/shared/Registerable.sol/Registerable.json +126 -11
  149. package/artifacts/contracts/shared/Service.sol/Service.dbg.json +1 -1
  150. package/artifacts/contracts/shared/Service.sol/Service.json +153 -20
  151. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.dbg.json +1 -1
  152. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.dbg.json +1 -1
  153. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.json +2 -2
  154. package/artifacts/contracts/shared/Versionable.sol/Versionable.dbg.json +1 -1
  155. package/artifacts/contracts/shared/Versionable.sol/Versionable.json +2 -2
  156. package/artifacts/contracts/test/TestFee.sol/TestFee.dbg.json +1 -1
  157. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.dbg.json +1 -1
  158. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.json +126 -11
  159. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.dbg.json +1 -1
  160. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.json +2 -2
  161. package/artifacts/contracts/test/TestService.sol/TestService.dbg.json +1 -1
  162. package/artifacts/contracts/test/TestService.sol/TestService.json +171 -38
  163. package/artifacts/contracts/test/TestToken.sol/TestUsdc.dbg.json +1 -1
  164. package/artifacts/contracts/test/TestVersion.sol/TestVersion.dbg.json +1 -1
  165. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.dbg.json +1 -1
  166. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.json +8 -8
  167. package/artifacts/contracts/test/Usdc.sol/USDC.dbg.json +1 -1
  168. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.dbg.json +1 -1
  169. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
  170. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.dbg.json +1 -1
  171. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.dbg.json +1 -1
  172. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.json +2 -2
  173. package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +1 -1
  174. package/artifacts/contracts/types/Key32.sol/Key32Lib.dbg.json +1 -1
  175. package/artifacts/contracts/types/Key32.sol/Key32Lib.json +2 -2
  176. package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
  177. package/artifacts/contracts/types/NftId.sol/NftIdLib.json +2 -2
  178. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +1 -1
  179. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +26 -3
  180. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.dbg.json +1 -1
  181. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +1 -1
  182. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +2 -2
  183. package/artifacts/contracts/types/Referral.sol/ReferralLib.dbg.json +1 -1
  184. package/artifacts/contracts/types/Referral.sol/ReferralLib.json +2 -2
  185. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.dbg.json +1 -1
  186. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.json +2 -2
  187. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.dbg.json +1 -1
  188. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.json +2 -2
  189. package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +1 -1
  190. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
  191. package/artifacts/contracts/types/UFixed.sol/MathLib.dbg.json +1 -1
  192. package/artifacts/contracts/types/UFixed.sol/UFixedLib.dbg.json +1 -1
  193. package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +1 -1
  194. package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +1 -1
  195. package/contracts/components/Component.sol +230 -0
  196. package/contracts/components/Distribution.sol +53 -57
  197. package/contracts/components/IComponent.sol +50 -0
  198. package/contracts/components/IDistributionComponent.sol +5 -2
  199. package/contracts/components/IPoolComponent.sol +54 -29
  200. package/contracts/components/IProductComponent.sol +7 -3
  201. package/contracts/components/Pool.sol +153 -142
  202. package/contracts/components/Product.sol +109 -128
  203. package/contracts/instance/BundleManager.sol +125 -0
  204. package/contracts/instance/Cloneable.sol +46 -0
  205. package/contracts/instance/IInstance.sol +41 -8
  206. package/contracts/instance/IInstanceService.sol +15 -4
  207. package/contracts/instance/Instance.sol +65 -240
  208. package/contracts/instance/InstanceAccessManager.sol +87 -78
  209. package/contracts/instance/InstanceReader.sol +12 -25
  210. package/contracts/instance/InstanceService.sol +347 -95
  211. package/contracts/instance/InstanceServiceManager.sol +10 -12
  212. package/contracts/instance/ObjectManager.sol +84 -0
  213. package/contracts/instance/base/ComponentService.sol +134 -0
  214. package/contracts/instance/module/IAccess.sol +27 -18
  215. package/contracts/instance/module/ISetup.sol +7 -4
  216. package/contracts/instance/service/ApplicationService.sol +268 -0
  217. package/contracts/instance/service/BundleService.sol +298 -0
  218. package/contracts/instance/service/BundleServiceManager.sol +51 -0
  219. package/contracts/instance/service/DistributionService.sol +45 -27
  220. package/contracts/instance/service/DistributionServiceManager.sol +10 -12
  221. package/contracts/instance/service/IApplicationService.sol +82 -0
  222. package/contracts/instance/service/IBundleService.sol +54 -0
  223. package/contracts/instance/service/IPolicyService.sol +88 -0
  224. package/contracts/instance/service/IPoolService.sol +6 -23
  225. package/contracts/instance/service/IProductService.sol +6 -73
  226. package/contracts/instance/service/PolicyService.sol +524 -0
  227. package/contracts/instance/service/PolicyServiceManager.sol +54 -0
  228. package/contracts/instance/service/PoolService.sol +40 -124
  229. package/contracts/instance/service/PoolServiceManager.sol +10 -12
  230. package/contracts/instance/service/ProductService.sol +233 -0
  231. package/contracts/instance/service/ProductServiceManager.sol +54 -0
  232. package/contracts/registry/ChainNft.sol +1 -1
  233. package/contracts/registry/IRegistry.sol +38 -33
  234. package/contracts/registry/IRegistryService.sol +45 -13
  235. package/contracts/registry/Registry.sol +223 -250
  236. package/contracts/registry/RegistryAccessManager.sol +216 -0
  237. package/contracts/registry/RegistryService.sol +86 -224
  238. package/contracts/registry/RegistryServiceManager.sol +18 -36
  239. package/contracts/registry/ReleaseManager.sol +332 -0
  240. package/contracts/registry/TokenRegistry.sol +11 -9
  241. package/contracts/shared/ERC165.sol +12 -11
  242. package/contracts/shared/INftOwnable.sol +6 -1
  243. package/contracts/shared/IPolicyHolder.sol +26 -0
  244. package/contracts/shared/IRegisterable.sol +4 -6
  245. package/contracts/shared/IService.sol +2 -1
  246. package/contracts/shared/IVersionable.sol +2 -2
  247. package/contracts/shared/NftOwnable.sol +93 -42
  248. package/contracts/shared/PolicyHolder.sol +52 -0
  249. package/contracts/shared/ProxyManager.sol +6 -5
  250. package/contracts/shared/Registerable.sol +15 -24
  251. package/contracts/shared/Service.sol +18 -13
  252. package/contracts/shared/Versionable.sol +3 -2
  253. package/contracts/test/TestRegisterable.sol +1 -1
  254. package/contracts/test/TestService.sol +4 -3
  255. package/contracts/types/NftIdSet.sol +26 -24
  256. package/contracts/types/ObjectType.sol +5 -1
  257. package/contracts/types/RoleId.sol +10 -9
  258. package/package.json +3 -3
  259. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.dbg.json +0 -4
  260. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.json +0 -327
  261. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json +0 -4
  262. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.json +0 -280
  263. package/artifacts/contracts/instance/AccessManagedSimple.sol/AccessManagedSimple.dbg.json +0 -4
  264. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.dbg.json +0 -4
  265. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.json +0 -1132
  266. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.dbg.json +0 -4
  267. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.json +0 -1082
  268. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +0 -4
  269. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.dbg.json +0 -4
  270. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.json +0 -113
  271. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.dbg.json +0 -4
  272. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.json +0 -827
  273. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.dbg.json +0 -4
  274. package/artifacts/contracts/shared/RegisterableUpgradable.sol/RegisterableUpgradable.dbg.json +0 -4
  275. package/contracts/components/BaseComponent.sol +0 -91
  276. package/contracts/components/IBaseComponent.sol +0 -25
  277. package/contracts/instance/AccessManagedSimple.sol +0 -115
  278. package/contracts/instance/AccessManagerSimple.sol +0 -692
  279. package/contracts/instance/IAccessManagerSimple.sol +0 -391
  280. package/contracts/instance/base/ComponentServiceBase.sol +0 -125
  281. package/contracts/instance/base/IInstanceBase.sol +0 -23
  282. package/contracts/instance/service/ComponentOwnerService.sol +0 -317
  283. package/contracts/instance/service/IComponentOwnerService.sol +0 -20
  284. package/contracts/shared/RegisterableUpgradable.sol +0 -16
package/README.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # GIF-Next (Generic Insurance Framework, next version)
2
2
 
3
+
4
+ ```mermaid
5
+ graph TD
6
+ IPoolComponent --> IComponent
7
+ IComponent --> IRegisterable
8
+ IComponent --> ITransferInterceptor
9
+ IRegistryService --> IService
10
+ IService-->IRegisterable
11
+ IService-->IVersionable
12
+ IRegisterable-->INftOwnable
13
+ INftOwnable-->IERC165
14
+ ```
15
+
3
16
  ## Add OpenZeppelin V5 Dependencies
4
17
 
5
18
  ```shell
@@ -51,7 +64,7 @@ hh docgen
51
64
  The resulting markdown files are written to `docs`
52
65
 
53
66
 
54
- ### Deployment
67
+ ### Full protocol deployment
55
68
 
56
69
  Install the dependencies before running the script below for the first time.
57
70
 
@@ -81,6 +94,25 @@ Environment variables:
81
94
  - `WALLET_MNEMONIC` the mnemonic of the wallet to use for deployment (required for mumbai and mainnet)
82
95
  - `ETHERSCAN_API_KEY` `POLYGONSCAN_API_KEY` the api key for etherscan/polygonscan (required for mumbai and mainnet)
83
96
 
97
+ ### Create a new instance
98
+
99
+ Requires previous step to be completed.
100
+
101
+ ```bash
102
+ # set appropriate values vor env variables (see below)
103
+
104
+ hh run --network <networkname> scripts/new_instance.ts
105
+ ```
106
+
107
+ 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.
108
+ The instance owner will be the 11th address of the wallet.
109
+
110
+ Environment variables:
111
+
112
+ - `WEB3_INFURA_PROJECT_ID` set to infura project id (required for mumbai and mainnet)
113
+ - `WALLET_MNEMONIC` the mnemonic of the wallet to use for deployment (required for mumbai and mainnet)
114
+ - `REGISTRY_ADDRESS` the address of the registry that is already deployed and configured and has a valid master instance
115
+
84
116
 
85
117
  ### Console
86
118
 
@@ -373,9 +405,68 @@ Intercepting property
373
405
 
374
406
  ### Product
375
407
 
408
+ ### Payout Handling
409
+
410
+ Pool specifies **retention level**.
411
+ Retention level defines up to which percentage of the sum insured the pool is payout out using its own/current funds.
412
+ Depending on the amount of a new payout the poolService decides to either execute the payout directly or to add the payout as a pending payout with a notification of the pool.
413
+
414
+ The sequence below sketches the small payout flow (payout < retention amount)
415
+ - retention level: 30%
416
+ - sum insured: 1000
417
+ - payout: 200
418
+
419
+ ```mermaid
420
+ sequenceDiagram
421
+ participant customer
422
+ participant product
423
+ participant productService
424
+ participant poolService
425
+ participant pool
426
+ product->>productService: createPayout()
427
+ productService ->> poolService: requestPayout()
428
+ poolService -->> pool: verifyPayout() *
429
+ poolService ->> poolService: processPayout()
430
+ poolService ->> customer: transfer token for payout
431
+ poolService ->> productService: payoutExecuted()
432
+ poolService -->> customer: payoutExecutedCallback() **
433
+ ```
434
+
435
+ *: if pool is configured to verify payouts before execution
436
+
437
+ **: callback only if customer is contract (IPolicyHolder)
438
+
439
+ The sequence below sketches the call flow for payouts larger than the retention amount
440
+ - retention level: 30%
441
+ - sum insured: 1000
442
+ - payout: 500
443
+ * locally available: 300
444
+ * via policy (re-insurance): 200
445
+
446
+ ```mermaid
447
+ sequenceDiagram
448
+ participant customer
449
+ participant product
450
+ participant productService
451
+ participant poolService
452
+ participant pool
453
+ pool ->> reinsuranceProduct: applyForPolicy()
454
+ product->>productService: createPayout()
455
+ productService ->> poolService: requestPayout()
456
+ poolService ->> pool: pendingPayoutAdded()
457
+ pool ->> pool: getReinsurancePolicy()
458
+ pool ->> reinsuranceProduct: claim()
459
+ reinsuranceProduct -->> reinsurancePool: createPayout
460
+ reinsurancePool ->> pool: transfer token for payout
461
+ reinsurancePool ->> pool: payoutExecutedCallback()
462
+ pool ->> poolService: processPendingPayout()
463
+ poolService ->> customer: transfer token for payout
464
+ poolService ->> productService: payoutExecuted()
465
+ ```
466
+
376
467
  ### Pool
377
468
 
378
- ### Distribution
469
+ ### Distribution
379
470
 
380
471
  ### Oracle
381
472
 
@@ -419,3 +510,46 @@ Distribution Service
419
510
  - registered via registry service by registry owner
420
511
  - registers distribution components for registered products via registry service by distribution owner (distribution owner role is permissend by the product's instance)
421
512
  - registers distributors for registered distribution components via registry service
513
+
514
+ ## Contract Organisation
515
+
516
+ now
517
+
518
+ contracts
519
+ components
520
+ instance
521
+ registry
522
+ shared
523
+ types
524
+
525
+
526
+ contracts
527
+ component
528
+ pool
529
+ Pool.sol
530
+ PoolService.sol
531
+ oracle
532
+ distribution
533
+ product
534
+ Product.sol
535
+ ProductService.sol
536
+ Component.sol
537
+ ComponentService.sol
538
+ instance
539
+ Instance.sol
540
+ InstanceAccessManager.sol
541
+ InstanceReader.sol
542
+ InstanceService.sol
543
+ InstanceServiceManager.sol
544
+ registry
545
+ ChainNft.sol
546
+ Registry.sol
547
+ RegistryService.sol
548
+ RegistryServiceManager.sol
549
+ shared
550
+ Registerable.sol
551
+ RegisterableUpgradable.sol
552
+ type
553
+ NftId.sol
554
+ ObjectType.sol
555
+
@@ -0,0 +1,4 @@
1
+ {
2
+ "_format": "hh-sol-dbg-1",
3
+ "buildInfo": "../../../build-info/ff7d6f99450632e8472f8e5ac690f339.json"
4
+ }