@etherisc/gif-next 0.0.2-f1b01e0-214 → 0.0.2-f1e6957-384

Sign up to get free protection for your applications and to get access to all the features.
Files changed (459) hide show
  1. package/README.md +76 -341
  2. package/artifacts/contracts/accounting/AccountingService.sol/AccountingService.dbg.json +1 -1
  3. package/artifacts/contracts/accounting/AccountingService.sol/AccountingService.json +100 -32
  4. package/artifacts/contracts/accounting/AccountingServiceManager.sol/AccountingServiceManager.dbg.json +1 -1
  5. package/artifacts/contracts/accounting/AccountingServiceManager.sol/AccountingServiceManager.json +111 -45
  6. package/artifacts/contracts/accounting/IAccountingService.sol/IAccountingService.dbg.json +1 -1
  7. package/artifacts/contracts/accounting/IAccountingService.sol/IAccountingService.json +52 -0
  8. package/artifacts/contracts/authorization/AccessAdmin.sol/AccessAdmin.dbg.json +1 -1
  9. package/artifacts/contracts/authorization/AccessAdmin.sol/AccessAdmin.json +367 -126
  10. package/artifacts/contracts/authorization/AccessAdminLib.sol/AccessAdminLib.dbg.json +1 -1
  11. package/artifacts/contracts/authorization/AccessAdminLib.sol/AccessAdminLib.json +1546 -211
  12. package/artifacts/contracts/authorization/AccessManagerCloneable.sol/AccessManagerCloneable.dbg.json +1 -1
  13. package/artifacts/contracts/authorization/AccessManagerCloneable.sol/AccessManagerCloneable.json +2 -2
  14. package/artifacts/contracts/authorization/Authorization.sol/Authorization.dbg.json +1 -1
  15. package/artifacts/contracts/authorization/Authorization.sol/Authorization.json +261 -59
  16. package/artifacts/contracts/authorization/IAccess.sol/IAccess.dbg.json +1 -1
  17. package/artifacts/contracts/authorization/IAccessAdmin.sol/IAccessAdmin.dbg.json +1 -1
  18. package/artifacts/contracts/authorization/IAccessAdmin.sol/IAccessAdmin.json +258 -82
  19. package/artifacts/contracts/authorization/IAuthorization.sol/IAuthorization.dbg.json +1 -1
  20. package/artifacts/contracts/authorization/IAuthorization.sol/IAuthorization.json +97 -14
  21. package/artifacts/contracts/authorization/IServiceAuthorization.sol/IServiceAuthorization.dbg.json +1 -1
  22. package/artifacts/contracts/authorization/IServiceAuthorization.sol/IServiceAuthorization.json +256 -16
  23. package/artifacts/contracts/authorization/ServiceAuthorization.sol/ServiceAuthorization.dbg.json +1 -1
  24. package/artifacts/contracts/authorization/ServiceAuthorization.sol/ServiceAuthorization.json +426 -27
  25. package/artifacts/contracts/distribution/BasicDistribution.sol/BasicDistribution.dbg.json +1 -1
  26. package/artifacts/contracts/distribution/BasicDistribution.sol/BasicDistribution.json +52 -27
  27. package/artifacts/contracts/distribution/BasicDistributionAuthorization.sol/BasicDistributionAuthorization.dbg.json +1 -1
  28. package/artifacts/contracts/distribution/BasicDistributionAuthorization.sol/BasicDistributionAuthorization.json +264 -64
  29. package/artifacts/contracts/distribution/Distribution.sol/Distribution.dbg.json +1 -1
  30. package/artifacts/contracts/distribution/Distribution.sol/Distribution.json +20 -11
  31. package/artifacts/contracts/distribution/DistributionService.sol/DistributionService.dbg.json +1 -1
  32. package/artifacts/contracts/distribution/DistributionService.sol/DistributionService.json +368 -139
  33. package/artifacts/contracts/distribution/DistributionServiceManager.sol/DistributionServiceManager.dbg.json +1 -1
  34. package/artifacts/contracts/distribution/DistributionServiceManager.sol/DistributionServiceManager.json +160 -78
  35. package/artifacts/contracts/distribution/IDistributionComponent.sol/IDistributionComponent.dbg.json +1 -1
  36. package/artifacts/contracts/distribution/IDistributionComponent.sol/IDistributionComponent.json +19 -10
  37. package/artifacts/contracts/distribution/IDistributionService.sol/IDistributionService.dbg.json +1 -1
  38. package/artifacts/contracts/distribution/IDistributionService.sol/IDistributionService.json +228 -15
  39. package/artifacts/contracts/examples/fire/DamageLevel.sol/DamageLevelLib.dbg.json +1 -1
  40. package/artifacts/contracts/examples/fire/FirePool.sol/FirePool.dbg.json +1 -1
  41. package/artifacts/contracts/examples/fire/FirePool.sol/FirePool.json +81 -52
  42. package/artifacts/contracts/examples/fire/FirePoolAuthorization.sol/FirePoolAuthorization.dbg.json +1 -1
  43. package/artifacts/contracts/examples/fire/FirePoolAuthorization.sol/FirePoolAuthorization.json +263 -63
  44. package/artifacts/contracts/examples/fire/FireProduct.sol/FireProduct.dbg.json +1 -1
  45. package/artifacts/contracts/examples/fire/FireProduct.sol/FireProduct.json +109 -68
  46. package/artifacts/contracts/examples/fire/FireProductAuthorization.sol/FireProductAuthorization.dbg.json +1 -1
  47. package/artifacts/contracts/examples/fire/FireProductAuthorization.sol/FireProductAuthorization.json +263 -63
  48. package/artifacts/contracts/examples/fire/FireUSD.sol/FireUSD.dbg.json +1 -1
  49. package/artifacts/contracts/examples/unpermissioned/SimpleDistribution.sol/SimpleDistribution.dbg.json +1 -1
  50. package/artifacts/contracts/examples/unpermissioned/SimpleDistribution.sol/SimpleDistribution.json +74 -33
  51. package/artifacts/contracts/examples/unpermissioned/SimpleDistributionAuthorization.sol/SimpleDistributionAuthorization.dbg.json +1 -1
  52. package/artifacts/contracts/examples/unpermissioned/SimpleDistributionAuthorization.sol/SimpleDistributionAuthorization.json +263 -63
  53. package/artifacts/contracts/examples/unpermissioned/SimpleOracle.sol/SimpleOracle.dbg.json +1 -1
  54. package/artifacts/contracts/examples/unpermissioned/SimpleOracle.sol/SimpleOracle.json +35 -26
  55. package/artifacts/contracts/examples/unpermissioned/SimplePool.sol/SimplePool.dbg.json +1 -1
  56. package/artifacts/contracts/examples/unpermissioned/SimplePool.sol/SimplePool.json +85 -60
  57. package/artifacts/contracts/examples/unpermissioned/SimplePoolAuthorization.sol/SimplePoolAuthorization.dbg.json +1 -1
  58. package/artifacts/contracts/examples/unpermissioned/SimplePoolAuthorization.sol/SimplePoolAuthorization.json +263 -63
  59. package/artifacts/contracts/examples/unpermissioned/SimpleProduct.sol/SimpleProduct.dbg.json +1 -1
  60. package/artifacts/contracts/examples/unpermissioned/SimpleProduct.sol/SimpleProduct.json +264 -78
  61. package/artifacts/contracts/examples/unpermissioned/SimpleProductAuthorization.sol/SimpleProductAuthorization.dbg.json +1 -1
  62. package/artifacts/contracts/examples/unpermissioned/SimpleProductAuthorization.sol/SimpleProductAuthorization.json +263 -63
  63. package/artifacts/contracts/instance/BaseStore.sol/BaseStore.dbg.json +4 -0
  64. package/artifacts/contracts/{shared/IKeyValueStore.sol/IKeyValueStore.json → instance/BaseStore.sol/BaseStore.json} +51 -229
  65. package/artifacts/contracts/instance/BundleSet.sol/BundleSet.dbg.json +1 -1
  66. package/artifacts/contracts/instance/BundleSet.sol/BundleSet.json +2 -2
  67. package/artifacts/contracts/instance/IBaseStore.sol/IBaseStore.dbg.json +4 -0
  68. package/artifacts/contracts/instance/IBaseStore.sol/IBaseStore.json +304 -0
  69. package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
  70. package/artifacts/contracts/instance/IInstance.sol/IInstance.json +359 -33
  71. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.dbg.json +1 -1
  72. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.json +297 -3
  73. package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
  74. package/artifacts/contracts/instance/Instance.sol/Instance.json +407 -97
  75. package/artifacts/contracts/instance/InstanceAdmin.sol/InstanceAdmin.dbg.json +1 -1
  76. package/artifacts/contracts/instance/InstanceAdmin.sol/InstanceAdmin.json +756 -392
  77. package/artifacts/contracts/instance/InstanceAuthorizationV3.sol/InstanceAuthorizationV3.dbg.json +1 -1
  78. package/artifacts/contracts/instance/InstanceAuthorizationV3.sol/InstanceAuthorizationV3.json +231 -75
  79. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.dbg.json +1 -1
  80. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.json +492 -424
  81. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.dbg.json +1 -1
  82. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.json +323 -29
  83. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.dbg.json +1 -1
  84. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.json +100 -42
  85. package/artifacts/contracts/instance/InstanceStore.sol/InstanceStore.dbg.json +1 -1
  86. package/artifacts/contracts/instance/InstanceStore.sol/InstanceStore.json +1444 -2133
  87. package/artifacts/contracts/instance/ProductStore.sol/ProductStore.dbg.json +4 -0
  88. package/artifacts/contracts/instance/ProductStore.sol/ProductStore.json +3427 -0
  89. package/artifacts/contracts/instance/RiskSet.sol/RiskSet.dbg.json +1 -1
  90. package/artifacts/contracts/instance/RiskSet.sol/RiskSet.json +101 -88
  91. package/artifacts/contracts/instance/base/BalanceStore.sol/BalanceStore.dbg.json +1 -1
  92. package/artifacts/contracts/instance/base/BalanceStore.sol/BalanceStore.json +8 -8
  93. package/artifacts/contracts/instance/base/Cloneable.sol/Cloneable.dbg.json +1 -1
  94. package/artifacts/contracts/instance/base/ObjectCounter.sol/ObjectCounter.dbg.json +1 -1
  95. package/artifacts/contracts/instance/base/ObjectCounter.sol/ObjectCounter.json +2 -2
  96. package/artifacts/contracts/instance/base/ObjectLifecycle.sol/ObjectLifecycle.dbg.json +1 -1
  97. package/artifacts/contracts/instance/base/ObjectLifecycle.sol/ObjectLifecycle.json +2 -2
  98. package/artifacts/contracts/instance/base/ObjectSet.sol/ObjectSet.dbg.json +1 -1
  99. package/artifacts/contracts/instance/base/ObjectSet.sol/ObjectSet.json +2 -2
  100. package/artifacts/contracts/instance/base/ObjectSetHelperLib.sol/ObjectSetHelperLib.dbg.json +1 -1
  101. package/artifacts/contracts/instance/base/ObjectSetHelperLib.sol/ObjectSetHelperLib.json +2 -2
  102. package/artifacts/contracts/instance/module/IBundle.sol/IBundle.dbg.json +1 -1
  103. package/artifacts/contracts/instance/module/IComponents.sol/IComponents.dbg.json +1 -1
  104. package/artifacts/contracts/instance/module/IDistribution.sol/IDistribution.dbg.json +1 -1
  105. package/artifacts/contracts/instance/module/IPolicy.sol/IPolicy.dbg.json +1 -1
  106. package/artifacts/contracts/instance/module/IRisk.sol/IRisk.dbg.json +1 -1
  107. package/artifacts/contracts/mock/Dip.sol/Dip.dbg.json +1 -1
  108. package/artifacts/contracts/oracle/BasicOracle.sol/BasicOracle.dbg.json +1 -1
  109. package/artifacts/contracts/oracle/BasicOracle.sol/BasicOracle.json +25 -16
  110. package/artifacts/contracts/oracle/BasicOracleAuthorization.sol/BasicOracleAuthorization.dbg.json +1 -1
  111. package/artifacts/contracts/oracle/BasicOracleAuthorization.sol/BasicOracleAuthorization.json +277 -60
  112. package/artifacts/contracts/oracle/IOracle.sol/IOracle.dbg.json +1 -1
  113. package/artifacts/contracts/oracle/IOracleComponent.sol/IOracleComponent.dbg.json +1 -1
  114. package/artifacts/contracts/oracle/IOracleComponent.sol/IOracleComponent.json +19 -10
  115. package/artifacts/contracts/oracle/IOracleService.sol/IOracleService.dbg.json +1 -1
  116. package/artifacts/contracts/oracle/IOracleService.sol/IOracleService.json +29 -0
  117. package/artifacts/contracts/oracle/Oracle.sol/Oracle.dbg.json +1 -1
  118. package/artifacts/contracts/oracle/Oracle.sol/Oracle.json +19 -10
  119. package/artifacts/contracts/oracle/OracleService.sol/OracleService.dbg.json +1 -1
  120. package/artifacts/contracts/oracle/OracleService.sol/OracleService.json +83 -38
  121. package/artifacts/contracts/oracle/OracleServiceManager.sol/OracleServiceManager.dbg.json +1 -1
  122. package/artifacts/contracts/oracle/OracleServiceManager.sol/OracleServiceManager.json +116 -50
  123. package/artifacts/contracts/pool/BasicPool.sol/BasicPool.dbg.json +1 -1
  124. package/artifacts/contracts/pool/BasicPool.sol/BasicPool.json +37 -36
  125. package/artifacts/contracts/pool/BasicPoolAuthorization.sol/BasicPoolAuthorization.dbg.json +1 -1
  126. package/artifacts/contracts/pool/BasicPoolAuthorization.sol/BasicPoolAuthorization.json +263 -63
  127. package/artifacts/contracts/pool/BundleService.sol/BundleService.dbg.json +1 -1
  128. package/artifacts/contracts/pool/BundleService.sol/BundleService.json +294 -117
  129. package/artifacts/contracts/pool/BundleServiceManager.sol/BundleServiceManager.dbg.json +1 -1
  130. package/artifacts/contracts/pool/BundleServiceManager.sol/BundleServiceManager.json +144 -58
  131. package/artifacts/contracts/pool/IBundleService.sol/IBundleService.dbg.json +1 -1
  132. package/artifacts/contracts/pool/IBundleService.sol/IBundleService.json +180 -27
  133. package/artifacts/contracts/pool/IPoolComponent.sol/IPoolComponent.dbg.json +1 -1
  134. package/artifacts/contracts/pool/IPoolComponent.sol/IPoolComponent.json +19 -10
  135. package/artifacts/contracts/pool/IPoolService.sol/IPoolService.dbg.json +1 -1
  136. package/artifacts/contracts/pool/IPoolService.sol/IPoolService.json +220 -1
  137. package/artifacts/contracts/pool/Pool.sol/Pool.dbg.json +1 -1
  138. package/artifacts/contracts/pool/Pool.sol/Pool.json +19 -10
  139. package/artifacts/contracts/pool/PoolLib.sol/PoolLib.dbg.json +1 -1
  140. package/artifacts/contracts/pool/PoolLib.sol/PoolLib.json +88 -22
  141. package/artifacts/contracts/pool/PoolService.sol/PoolService.dbg.json +1 -1
  142. package/artifacts/contracts/pool/PoolService.sol/PoolService.json +324 -65
  143. package/artifacts/contracts/pool/PoolServiceManager.sol/PoolServiceManager.dbg.json +1 -1
  144. package/artifacts/contracts/pool/PoolServiceManager.sol/PoolServiceManager.json +141 -63
  145. package/artifacts/contracts/product/ApplicationService.sol/ApplicationService.dbg.json +1 -1
  146. package/artifacts/contracts/product/ApplicationService.sol/ApplicationService.json +216 -59
  147. package/artifacts/contracts/product/ApplicationServiceManager.sol/ApplicationServiceManager.dbg.json +1 -1
  148. package/artifacts/contracts/product/ApplicationServiceManager.sol/ApplicationServiceManager.json +113 -43
  149. package/artifacts/contracts/product/BasicProduct.sol/BasicProduct.dbg.json +1 -1
  150. package/artifacts/contracts/product/BasicProduct.sol/BasicProduct.json +19 -10
  151. package/artifacts/contracts/product/BasicProductAuthorization.sol/BasicProductAuthorization.dbg.json +1 -1
  152. package/artifacts/contracts/product/BasicProductAuthorization.sol/BasicProductAuthorization.json +263 -63
  153. package/artifacts/contracts/product/ClaimService.sol/ClaimService.dbg.json +1 -1
  154. package/artifacts/contracts/product/ClaimService.sol/ClaimService.json +142 -102
  155. package/artifacts/contracts/product/ClaimServiceManager.sol/ClaimServiceManager.dbg.json +1 -1
  156. package/artifacts/contracts/product/ClaimServiceManager.sol/ClaimServiceManager.json +128 -70
  157. package/artifacts/contracts/product/IApplicationService.sol/IApplicationService.dbg.json +1 -1
  158. package/artifacts/contracts/product/IApplicationService.sol/IApplicationService.json +166 -1
  159. package/artifacts/contracts/product/IClaimService.sol/IClaimService.dbg.json +1 -1
  160. package/artifacts/contracts/product/IClaimService.sol/IClaimService.json +50 -10
  161. package/artifacts/contracts/product/IPolicyService.sol/IPolicyService.dbg.json +1 -1
  162. package/artifacts/contracts/product/IPolicyService.sol/IPolicyService.json +55 -0
  163. package/artifacts/contracts/product/IPricingService.sol/IPricingService.dbg.json +1 -1
  164. package/artifacts/contracts/product/IPricingService.sol/IPricingService.json +29 -0
  165. package/artifacts/contracts/product/IProductComponent.sol/IProductComponent.dbg.json +1 -1
  166. package/artifacts/contracts/product/IProductComponent.sol/IProductComponent.json +19 -10
  167. package/artifacts/contracts/product/IRiskService.sol/IRiskService.dbg.json +1 -1
  168. package/artifacts/contracts/product/IRiskService.sol/IRiskService.json +203 -18
  169. package/artifacts/contracts/product/PolicyService.sol/PolicyService.dbg.json +1 -1
  170. package/artifacts/contracts/product/PolicyService.sol/PolicyService.json +157 -86
  171. package/artifacts/contracts/product/PolicyServiceLib.sol/PolicyServiceLib.dbg.json +1 -1
  172. package/artifacts/contracts/product/PolicyServiceLib.sol/PolicyServiceLib.json +508 -18
  173. package/artifacts/contracts/product/PolicyServiceManager.sol/PolicyServiceManager.dbg.json +1 -1
  174. package/artifacts/contracts/product/PolicyServiceManager.sol/PolicyServiceManager.json +138 -72
  175. package/artifacts/contracts/product/PricingService.sol/PricingService.dbg.json +1 -1
  176. package/artifacts/contracts/product/PricingService.sol/PricingService.json +93 -72
  177. package/artifacts/contracts/product/PricingServiceManager.sol/PricingServiceManager.dbg.json +1 -1
  178. package/artifacts/contracts/product/PricingServiceManager.sol/PricingServiceManager.json +120 -50
  179. package/artifacts/contracts/product/Product.sol/Product.dbg.json +1 -1
  180. package/artifacts/contracts/product/Product.sol/Product.json +19 -10
  181. package/artifacts/contracts/product/RiskService.sol/RiskService.dbg.json +1 -1
  182. package/artifacts/contracts/product/RiskService.sol/RiskService.json +231 -46
  183. package/artifacts/contracts/product/RiskServiceManager.sol/RiskServiceManager.dbg.json +1 -1
  184. package/artifacts/contracts/product/RiskServiceManager.sol/RiskServiceManager.json +101 -43
  185. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
  186. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
  187. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.json +33 -22
  188. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.dbg.json +1 -1
  189. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.json +29 -0
  190. package/artifacts/contracts/registry/IRelease.sol/IRelease.dbg.json +1 -1
  191. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.dbg.json +1 -1
  192. package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
  193. package/artifacts/contracts/registry/Registry.sol/Registry.json +71 -60
  194. package/artifacts/contracts/registry/RegistryAdmin.sol/RegistryAdmin.dbg.json +1 -1
  195. package/artifacts/contracts/registry/RegistryAdmin.sol/RegistryAdmin.json +537 -300
  196. package/artifacts/contracts/registry/RegistryAuthorization.sol/RegistryAuthorization.dbg.json +1 -1
  197. package/artifacts/contracts/registry/RegistryAuthorization.sol/RegistryAuthorization.json +330 -71
  198. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.dbg.json +1 -1
  199. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.json +41 -12
  200. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.dbg.json +1 -1
  201. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.json +96 -38
  202. package/artifacts/contracts/registry/ReleaseAdmin.sol/ReleaseAdmin.dbg.json +1 -1
  203. package/artifacts/contracts/registry/ReleaseAdmin.sol/ReleaseAdmin.json +543 -226
  204. package/artifacts/contracts/registry/ReleaseLifecycle.sol/ReleaseLifecycle.dbg.json +1 -1
  205. package/artifacts/contracts/registry/ReleaseLifecycle.sol/ReleaseLifecycle.json +2 -2
  206. package/artifacts/contracts/registry/ReleaseRegistry.sol/ReleaseRegistry.dbg.json +1 -1
  207. package/artifacts/contracts/registry/ReleaseRegistry.sol/ReleaseRegistry.json +167 -103
  208. package/artifacts/contracts/registry/ServiceAuthorizationV3.sol/ServiceAuthorizationV3.dbg.json +1 -1
  209. package/artifacts/contracts/registry/ServiceAuthorizationV3.sol/ServiceAuthorizationV3.json +459 -26
  210. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.dbg.json +1 -1
  211. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.json +119 -59
  212. package/artifacts/contracts/shared/Component.sol/Component.dbg.json +1 -1
  213. package/artifacts/contracts/shared/Component.sol/Component.json +19 -10
  214. package/artifacts/contracts/shared/ComponentService.sol/ComponentService.dbg.json +1 -1
  215. package/artifacts/contracts/shared/ComponentService.sol/ComponentService.json +169 -174
  216. package/artifacts/contracts/shared/ComponentServiceManager.sol/ComponentServiceManager.dbg.json +1 -1
  217. package/artifacts/contracts/shared/ComponentServiceManager.sol/ComponentServiceManager.json +130 -64
  218. package/artifacts/contracts/shared/ContractLib.sol/ContractLib.dbg.json +1 -1
  219. package/artifacts/contracts/shared/ContractLib.sol/ContractLib.json +76 -41
  220. package/artifacts/contracts/shared/ContractLib.sol/IInstanceAdminHelper.dbg.json +1 -1
  221. package/artifacts/contracts/shared/ContractLib.sol/ITargetHelper.dbg.json +1 -1
  222. package/artifacts/contracts/shared/ContractLib.sol/ITokenRegistryHelper.dbg.json +1 -1
  223. package/artifacts/contracts/shared/ContractLib.sol/ITokenRegistryHelper.json +2 -2
  224. package/artifacts/contracts/shared/IComponent.sol/IComponent.dbg.json +1 -1
  225. package/artifacts/contracts/shared/IComponent.sol/IComponent.json +19 -10
  226. package/artifacts/contracts/shared/IComponentService.sol/IComponentService.dbg.json +1 -1
  227. package/artifacts/contracts/shared/IComponentService.sol/IComponentService.json +84 -105
  228. package/artifacts/contracts/shared/IInstanceLinkedComponent.sol/IInstanceLinkedComponent.dbg.json +1 -1
  229. package/artifacts/contracts/shared/IInstanceLinkedComponent.sol/IInstanceLinkedComponent.json +19 -10
  230. package/artifacts/contracts/shared/ILifecycle.sol/ILifecycle.dbg.json +1 -1
  231. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.dbg.json +1 -1
  232. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.json +19 -0
  233. package/artifacts/contracts/shared/IPolicyHolder.sol/IPolicyHolder.dbg.json +1 -1
  234. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +1 -1
  235. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.json +19 -0
  236. package/artifacts/contracts/shared/IRegistryLinked.sol/IRegistryLinked.dbg.json +1 -1
  237. package/artifacts/contracts/shared/IService.sol/IService.dbg.json +1 -1
  238. package/artifacts/contracts/shared/IService.sol/IService.json +29 -0
  239. package/artifacts/contracts/shared/InitializableERC165.sol/InitializableERC165.dbg.json +1 -1
  240. package/artifacts/contracts/shared/InstanceLinkedComponent.sol/InstanceLinkedComponent.dbg.json +1 -1
  241. package/artifacts/contracts/shared/InstanceLinkedComponent.sol/InstanceLinkedComponent.json +19 -10
  242. package/artifacts/contracts/shared/Lifecycle.sol/Lifecycle.dbg.json +1 -1
  243. package/artifacts/contracts/shared/NftIdSet.sol/NftIdSet.dbg.json +1 -1
  244. package/artifacts/contracts/shared/NftIdSet.sol/NftIdSet.json +2 -2
  245. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.dbg.json +1 -1
  246. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.json +21 -2
  247. package/artifacts/contracts/shared/PolicyHolder.sol/PolicyHolder.dbg.json +1 -1
  248. package/artifacts/contracts/shared/PolicyHolder.sol/PolicyHolder.json +2 -2
  249. package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +1 -1
  250. package/artifacts/contracts/shared/Registerable.sol/Registerable.json +19 -0
  251. package/artifacts/contracts/shared/RegistryLinked.sol/RegistryLinked.dbg.json +1 -1
  252. package/artifacts/contracts/shared/RegistryLinked.sol/RegistryLinked.json +2 -2
  253. package/artifacts/contracts/shared/Service.sol/Service.dbg.json +1 -1
  254. package/artifacts/contracts/shared/Service.sol/Service.json +29 -0
  255. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.dbg.json +1 -1
  256. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.json +2 -2
  257. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandlerBase.dbg.json +1 -1
  258. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandlerBase.json +2 -2
  259. package/artifacts/contracts/shared/TokenHandlerDeployerLib.sol/TokenHandlerDeployerLib.dbg.json +1 -1
  260. package/artifacts/contracts/shared/TokenHandlerDeployerLib.sol/TokenHandlerDeployerLib.json +2 -2
  261. package/artifacts/contracts/staking/IStaking.sol/IStaking.dbg.json +1 -1
  262. package/artifacts/contracts/staking/IStaking.sol/IStaking.json +1384 -128
  263. package/artifacts/contracts/staking/IStakingService.sol/IStakingService.dbg.json +1 -1
  264. package/artifacts/contracts/staking/IStakingService.sol/IStakingService.json +94 -114
  265. package/artifacts/contracts/staking/ITargetLimitHandler.sol/ITargetLimitHandler.dbg.json +4 -0
  266. package/artifacts/contracts/staking/ITargetLimitHandler.sol/ITargetLimitHandler.json +50 -0
  267. package/artifacts/contracts/staking/Staking.sol/Staking.dbg.json +1 -1
  268. package/artifacts/contracts/staking/Staking.sol/Staking.json +1472 -185
  269. package/artifacts/contracts/staking/StakingLib.sol/StakingLib.dbg.json +1 -1
  270. package/artifacts/contracts/staking/StakingLib.sol/StakingLib.json +73 -72
  271. package/artifacts/contracts/staking/StakingManager.sol/StakingManager.dbg.json +1 -1
  272. package/artifacts/contracts/staking/StakingManager.sol/StakingManager.json +139 -64
  273. package/artifacts/contracts/staking/StakingReader.sol/StakingReader.dbg.json +1 -1
  274. package/artifacts/contracts/staking/StakingReader.sol/StakingReader.json +293 -149
  275. package/artifacts/contracts/staking/StakingService.sol/StakingService.dbg.json +1 -1
  276. package/artifacts/contracts/staking/StakingService.sol/StakingService.json +128 -164
  277. package/artifacts/contracts/staking/StakingServiceManager.sol/StakingServiceManager.dbg.json +1 -1
  278. package/artifacts/contracts/staking/StakingServiceManager.sol/StakingServiceManager.json +96 -46
  279. package/artifacts/contracts/staking/StakingStore.sol/StakingStore.dbg.json +1 -1
  280. package/artifacts/contracts/staking/StakingStore.sol/StakingStore.json +1617 -817
  281. package/artifacts/contracts/staking/TargetHandler.sol/TargetHandler.dbg.json +4 -0
  282. package/artifacts/contracts/staking/TargetHandler.sol/TargetHandler.json +309 -0
  283. package/artifacts/contracts/staking/TargetManagerLib.sol/TargetManagerLib.dbg.json +1 -1
  284. package/artifacts/contracts/staking/TargetManagerLib.sol/TargetManagerLib.json +140 -78
  285. package/artifacts/contracts/type/AddressSet.sol/LibAddressSet.dbg.json +1 -1
  286. package/artifacts/contracts/type/Amount.sol/AmountLib.dbg.json +1 -1
  287. package/artifacts/contracts/type/Amount.sol/AmountLib.json +2 -2
  288. package/artifacts/contracts/type/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
  289. package/artifacts/contracts/type/Blocknumber.sol/BlocknumberLib.json +64 -19
  290. package/artifacts/contracts/type/ChainId.sol/ChainIdLib.dbg.json +4 -0
  291. package/artifacts/contracts/type/ChainId.sol/ChainIdLib.json +193 -0
  292. package/artifacts/contracts/type/ClaimId.sol/ClaimIdLib.dbg.json +1 -1
  293. package/artifacts/contracts/type/ClaimId.sol/ClaimIdLib.json +2 -2
  294. package/artifacts/contracts/type/DistributorType.sol/DistributorTypeLib.dbg.json +1 -1
  295. package/artifacts/contracts/type/DistributorType.sol/DistributorTypeLib.json +2 -2
  296. package/artifacts/contracts/type/Fee.sol/FeeLib.dbg.json +1 -1
  297. package/artifacts/contracts/type/Fee.sol/FeeLib.json +2 -2
  298. package/artifacts/contracts/type/Key32.sol/Key32Lib.dbg.json +1 -1
  299. package/artifacts/contracts/type/Key32.sol/Key32Lib.json +2 -2
  300. package/artifacts/contracts/type/Key32Set.sol/LibKey32Set.dbg.json +1 -1
  301. package/artifacts/contracts/type/Key32Set.sol/LibKey32Set.json +2 -2
  302. package/artifacts/contracts/type/NftId.sol/NftIdLib.dbg.json +1 -1
  303. package/artifacts/contracts/type/NftId.sol/NftIdLib.json +2 -2
  304. package/artifacts/contracts/type/NftIdSet.sol/LibNftIdSet.dbg.json +1 -1
  305. package/artifacts/contracts/type/NftIdSet.sol/LibNftIdSet.json +2 -2
  306. package/artifacts/contracts/type/ObjectType.sol/ObjectTypeLib.dbg.json +1 -1
  307. package/artifacts/contracts/type/ObjectType.sol/ObjectTypeLib.json +6 -6
  308. package/artifacts/contracts/type/PayoutId.sol/PayoutIdLib.dbg.json +1 -1
  309. package/artifacts/contracts/type/PayoutId.sol/PayoutIdLib.json +2 -2
  310. package/artifacts/contracts/type/Referral.sol/ReferralLib.dbg.json +1 -1
  311. package/artifacts/contracts/type/Referral.sol/ReferralLib.json +2 -2
  312. package/artifacts/contracts/type/RequestId.sol/RequestIdLib.dbg.json +1 -1
  313. package/artifacts/contracts/type/RequestId.sol/RequestIdLib.json +2 -2
  314. package/artifacts/contracts/type/RiskId.sol/RiskIdLib.dbg.json +1 -1
  315. package/artifacts/contracts/type/RiskId.sol/RiskIdLib.json +2 -2
  316. package/artifacts/contracts/type/RoleId.sol/RoleIdLib.dbg.json +1 -1
  317. package/artifacts/contracts/type/RoleId.sol/RoleIdLib.json +39 -218
  318. package/artifacts/contracts/type/Seconds.sol/SecondsLib.dbg.json +1 -1
  319. package/artifacts/contracts/type/Seconds.sol/SecondsLib.json +45 -2
  320. package/artifacts/contracts/type/Selector.sol/SelectorLib.dbg.json +1 -1
  321. package/artifacts/contracts/type/Selector.sol/SelectorSetLib.dbg.json +1 -1
  322. package/artifacts/contracts/type/StateId.sol/StateIdLib.dbg.json +1 -1
  323. package/artifacts/contracts/type/String.sol/StrLib.dbg.json +1 -1
  324. package/artifacts/contracts/type/String.sol/StrLib.json +50 -2
  325. package/artifacts/contracts/type/Timestamp.sol/TimestampLib.dbg.json +1 -1
  326. package/artifacts/contracts/type/Timestamp.sol/TimestampLib.json +3 -3
  327. package/artifacts/contracts/type/UFixed.sol/UFixedLib.dbg.json +1 -1
  328. package/artifacts/contracts/type/UFixed.sol/UFixedLib.json +2 -2
  329. package/artifacts/contracts/type/Version.sol/VersionLib.dbg.json +1 -1
  330. package/artifacts/contracts/type/Version.sol/VersionPartLib.dbg.json +1 -1
  331. package/artifacts/contracts/upgradeability/IVersionable.sol/IVersionable.dbg.json +1 -1
  332. package/artifacts/contracts/upgradeability/IVersionable.sol/IVersionable.json +10 -0
  333. package/artifacts/contracts/upgradeability/ProxyManager.sol/ProxyManager.dbg.json +1 -1
  334. package/artifacts/contracts/upgradeability/ProxyManager.sol/ProxyManager.json +81 -27
  335. package/artifacts/contracts/upgradeability/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.dbg.json +1 -1
  336. package/artifacts/contracts/upgradeability/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.json +15 -2
  337. package/artifacts/contracts/upgradeability/Versionable.sol/Versionable.dbg.json +1 -1
  338. package/artifacts/contracts/upgradeability/Versionable.sol/Versionable.json +10 -0
  339. package/contracts/accounting/AccountingService.sol +15 -3
  340. package/contracts/accounting/IAccountingService.sol +2 -0
  341. package/contracts/authorization/AccessAdmin.sol +292 -317
  342. package/contracts/authorization/AccessAdminLib.sol +517 -22
  343. package/contracts/authorization/AccessManagerCloneable.sol +0 -18
  344. package/contracts/authorization/Authorization.sol +64 -239
  345. package/contracts/authorization/IAccess.sol +23 -14
  346. package/contracts/authorization/IAccessAdmin.sol +25 -53
  347. package/contracts/authorization/IAuthorization.sol +3 -57
  348. package/contracts/authorization/IServiceAuthorization.sol +55 -17
  349. package/contracts/authorization/ServiceAuthorization.sol +228 -34
  350. package/contracts/distribution/BasicDistribution.sol +3 -4
  351. package/contracts/distribution/BasicDistributionAuthorization.sol +11 -4
  352. package/contracts/distribution/Distribution.sol +9 -8
  353. package/contracts/distribution/DistributionService.sol +98 -35
  354. package/contracts/distribution/IDistributionComponent.sol +3 -1
  355. package/contracts/distribution/IDistributionService.sol +20 -8
  356. package/contracts/examples/fire/FireProduct.sol +6 -6
  357. package/contracts/examples/unpermissioned/SimpleProduct.sol +83 -19
  358. package/contracts/instance/BaseStore.sol +93 -0
  359. package/contracts/instance/IBaseStore.sol +37 -0
  360. package/contracts/instance/IInstance.sol +55 -5
  361. package/contracts/instance/IInstanceService.sol +37 -6
  362. package/contracts/instance/Instance.sol +103 -56
  363. package/contracts/instance/InstanceAdmin.sol +151 -294
  364. package/contracts/instance/InstanceAuthorizationV3.sol +106 -66
  365. package/contracts/instance/InstanceReader.sol +350 -394
  366. package/contracts/instance/InstanceService.sol +180 -125
  367. package/contracts/instance/InstanceStore.sol +153 -128
  368. package/contracts/instance/ProductStore.sol +290 -0
  369. package/contracts/instance/RiskSet.sol +10 -2
  370. package/contracts/instance/TargetNames.sol +10 -0
  371. package/contracts/instance/base/BalanceStore.sol +4 -6
  372. package/contracts/instance/base/ObjectLifecycle.sol +2 -6
  373. package/contracts/instance/module/IComponents.sol +0 -2
  374. package/contracts/oracle/BasicOracle.sol +2 -3
  375. package/contracts/oracle/BasicOracleAuthorization.sol +18 -2
  376. package/contracts/oracle/Oracle.sol +4 -6
  377. package/contracts/oracle/OracleService.sol +8 -8
  378. package/contracts/pool/BasicPool.sol +4 -16
  379. package/contracts/pool/BasicPoolAuthorization.sol +10 -5
  380. package/contracts/pool/BundleService.sol +34 -43
  381. package/contracts/pool/IBundleService.sol +14 -13
  382. package/contracts/pool/IPoolService.sol +7 -2
  383. package/contracts/pool/Pool.sol +6 -18
  384. package/contracts/pool/PoolLib.sol +127 -2
  385. package/contracts/pool/PoolService.sol +40 -181
  386. package/contracts/product/ApplicationService.sol +64 -11
  387. package/contracts/product/BasicProduct.sol +2 -3
  388. package/contracts/product/BasicProductAuthorization.sol +11 -4
  389. package/contracts/product/ClaimService.sol +99 -105
  390. package/contracts/product/IApplicationService.sol +21 -2
  391. package/contracts/product/IClaimService.sol +5 -4
  392. package/contracts/product/IPolicyService.sol +9 -2
  393. package/contracts/product/IRiskService.sol +18 -3
  394. package/contracts/product/PolicyService.sol +40 -59
  395. package/contracts/product/PolicyServiceLib.sol +79 -5
  396. package/contracts/product/PricingService.sol +22 -25
  397. package/contracts/product/Product.sol +40 -16
  398. package/contracts/product/RiskService.sol +50 -15
  399. package/contracts/registry/IRegistry.sol +11 -9
  400. package/contracts/registry/IRelease.sol +6 -3
  401. package/contracts/registry/Registry.sol +15 -9
  402. package/contracts/registry/RegistryAdmin.sol +33 -118
  403. package/contracts/registry/RegistryAuthorization.sol +139 -69
  404. package/contracts/registry/RegistryService.sol +1 -1
  405. package/contracts/registry/ReleaseAdmin.sol +52 -106
  406. package/contracts/registry/ReleaseRegistry.sol +20 -12
  407. package/contracts/registry/ServiceAuthorizationV3.sol +43 -32
  408. package/contracts/registry/TokenRegistry.sol +56 -52
  409. package/contracts/shared/Component.sol +8 -8
  410. package/contracts/shared/ComponentService.sol +245 -262
  411. package/contracts/shared/ContractLib.sol +106 -75
  412. package/contracts/shared/IComponent.sol +1 -1
  413. package/contracts/shared/IComponentService.sol +12 -13
  414. package/contracts/shared/INftOwnable.sol +2 -0
  415. package/contracts/shared/IRegisterable.sol +0 -1
  416. package/contracts/shared/InstanceLinkedComponent.sol +6 -9
  417. package/contracts/shared/NftOwnable.sol +3 -1
  418. package/contracts/shared/PolicyHolder.sol +3 -2
  419. package/contracts/shared/Service.sol +6 -4
  420. package/contracts/staking/IStaking.sol +261 -70
  421. package/contracts/staking/IStakingService.sol +39 -84
  422. package/contracts/staking/ITargetLimitHandler.sol +17 -0
  423. package/contracts/staking/Staking.sol +468 -217
  424. package/contracts/staking/StakingLib.sol +38 -124
  425. package/contracts/staking/StakingManager.sol +4 -3
  426. package/contracts/staking/StakingReader.sol +62 -71
  427. package/contracts/staking/StakingService.sol +42 -185
  428. package/contracts/staking/StakingServiceManager.sol +1 -0
  429. package/contracts/staking/StakingStore.sol +1093 -331
  430. package/contracts/staking/TargetHandler.sol +132 -0
  431. package/contracts/staking/TargetManagerLib.sol +69 -46
  432. package/contracts/type/Amount.sol +4 -0
  433. package/contracts/type/Blocknumber.sol +17 -22
  434. package/contracts/type/ChainId.sol +101 -0
  435. package/contracts/type/NftId.sol +3 -3
  436. package/contracts/type/ObjectType.sol +16 -3
  437. package/contracts/type/RoleId.sol +57 -59
  438. package/contracts/type/Seconds.sol +19 -0
  439. package/contracts/type/String.sol +12 -0
  440. package/contracts/type/Timestamp.sol +4 -2
  441. package/contracts/type/UFixed.sol +1 -0
  442. package/contracts/upgradeability/IVersionable.sol +3 -0
  443. package/contracts/upgradeability/ProxyManager.sol +26 -12
  444. package/contracts/upgradeability/UpgradableProxyWithAdmin.sol +12 -2
  445. package/contracts/upgradeability/Versionable.sol +6 -3
  446. package/package.json +1 -1
  447. package/artifacts/contracts/authorization/AccessAdmin.sol/IAccessManagedChecker.dbg.json +0 -4
  448. package/artifacts/contracts/authorization/AccessAdmin.sol/IAccessManagedChecker.json +0 -24
  449. package/artifacts/contracts/shared/ComponentVerifyingService.sol/ComponentVerifyingService.dbg.json +0 -4
  450. package/artifacts/contracts/shared/ComponentVerifyingService.sol/ComponentVerifyingService.json +0 -485
  451. package/artifacts/contracts/shared/IKeyValueStore.sol/IKeyValueStore.dbg.json +0 -4
  452. package/artifacts/contracts/shared/KeyValueStore.sol/KeyValueStore.dbg.json +0 -4
  453. package/artifacts/contracts/shared/KeyValueStore.sol/KeyValueStore.json +0 -538
  454. package/artifacts/contracts/staking/StakingLifecycle.sol/StakingLifecycle.dbg.json +0 -4
  455. package/artifacts/contracts/staking/StakingLifecycle.sol/StakingLifecycle.json +0 -205
  456. package/contracts/shared/ComponentVerifyingService.sol +0 -128
  457. package/contracts/shared/IKeyValueStore.sol +0 -54
  458. package/contracts/shared/KeyValueStore.sol +0 -131
  459. package/contracts/staking/StakingLifecycle.sol +0 -23
package/README.md CHANGED
@@ -1,38 +1,72 @@
1
- # GIF-Next (Generic Insurance Framework, next version)
1
+ # GIF-Next (Generic Insurance Framework, version 3)
2
2
 
3
+ For technical reason, this repository is called `gif-next`, but it contains the code of the version 3 of the Generic Insurance Framework (GIF).
3
4
 
4
- ## Add OpenZeppelin V5 Dependencies
5
+ ## Submodules checkout
6
+
7
+ The project depends heavily on the use of submodules for dependencies, so it is important to checkout the submodules when cloning the repository.
8
+
9
+ For initial checkout call
5
10
 
6
11
  ```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 ../..
12
+ git submodule update --init --recursive
11
13
  ```
12
14
 
13
- See `remappings.txt` to see how to work with different OpenZeppelin versions in parallel
15
+ To update to the latest submodules, run the following command after updating to any revision (or checking out the repository)
14
16
 
17
+ ```shell
18
+ git submodule update --recursive
15
19
  ```
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
+ ## Recommended IDE & Development Environment
22
+
23
+ The project is setup with a devcontainer for Visual Studio Code. This is the recommended way for use with the project.
24
+ It will provide a consistent development environment for all developers with all the required dependencies installed.
25
+
26
+ Hardhat is used for compiling the smart contracts and all deployment scripts are hardhat based.
27
+ Unit tests are written using the forge testing framework. See below for most important commands to run tests and deployments.
28
+
29
+ If you are interested in creating your own products, have a look at our [example sandbox repository](https://github.com/etherisc/gif-next-sandbox) that contains a simple example of how to build new products on top of the GIF.
30
+
31
+ ### Running all unit tests
32
+
33
+ ```bash
34
+ forge test
20
35
  ```
21
36
 
37
+ ### Staring a full protocol deployment
22
38
 
23
- ## Submodules checkout
39
+ ```bash
40
+ hh run scripts/deploy_gif.ts
41
+ ```
24
42
 
25
- This repository uses submodules. To checkout or update to the latest submodules, run the following command after updating to any revision (or checking out the repository)
43
+ To include the fire example components instead run the following command
26
44
 
27
- ```shell
28
- git submodule update --recursive
45
+ ```bash
46
+ hh run scripts/deploy_all.ts
29
47
  ```
30
48
 
31
- ## Example components
49
+ The command accepts regular hardhat parameters for network selection and other configuration. Also some environment variables are required for deployment.
32
50
 
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).
51
+ Code verification is done separately using the following command (which read data from the serialized deployment state of the deploymnent script that ran beforehand)
34
52
 
35
- ## Hardhat
53
+ ```bash
54
+ hh run scripts/verify_deployment.ts
55
+ ```
56
+
57
+ This uses the same environment variables as the deployment script.
58
+
59
+ #### Important environment variables
60
+
61
+ - `NETWORK_URL` the rpc endpoint to use
62
+ - `WALLET_MNEMONIC` the HD wallet mnemonic to use for deployment. Wallet #0 will be the protocol owner.
63
+ - `GAS_PRICE` the gas price to use for deployment
64
+ - `RESUMEABLE_DEPLOYMENT` if this flag is set to `true`, the deployment will write all transactions to a state file so the deployment can be resumed after a failure (or after a manual stop). data is stored in the `deployment/<chainid>/` directory.
65
+
66
+ - `POLYGONSCAN_API_KEY` the api key for polygonscan
67
+
68
+
69
+ ## Hardhat commands
36
70
 
37
71
  ### NPM Commands
38
72
 
@@ -93,7 +127,7 @@ Environment variables:
93
127
  - `RESUMEABLE_DEPLOYMENT` set to `true` to have all (deployment) transactions written to a state file so the script can be resumed after a failure (or after a manual stop) (default: `false`)
94
128
  - `GAS_PRICE` set to the gas price to use for deployment (default: `undefined`)
95
129
  - `WALLET_MNEMONIC` the mnemonic of the wallet to use for deployment (required for mumbai and mainnet)
96
-
130
+ - `DIP_ADDRESS` the address of the already deployed DIP token. if not set, the script will deploy a new DIP token
97
131
  - `WEB3_INFURA_PROJECT_ID` set to infura project id (required for mumbai and mainnet)
98
132
  - `ETHERSCAN_API_KEY` `POLYGONSCAN_API_KEY` the api key for etherscan/polygonscan (required for mumbai and mainnet)
99
133
 
@@ -115,24 +149,6 @@ Ensure that the deployment runs on a chain where a compatible version of the GIF
115
149
 
116
150
  Like before, use the `--network` option to deploy on a different network.
117
151
 
118
- ### Create a new instance
119
-
120
- Requires previous step to be completed.
121
-
122
- ```bash
123
- # set appropriate values vor env variables (see below)
124
-
125
- hh run --network <networkname> scripts/new_instance.ts
126
- ```
127
-
128
- 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.
129
- The instance owner will be the 11th address of the wallet.
130
-
131
- Environment variables:
132
-
133
- - `WEB3_INFURA_PROJECT_ID` set to infura project id (required for mumbai and mainnet)
134
- - `WALLET_MNEMONIC` the mnemonic of the wallet to use for deployment (required for mumbai and mainnet)
135
- - `REGISTRY_ADDRESS` the address of the registry that is already deployed and configured and has a valid master instance
136
152
 
137
153
  ### Console
138
154
 
@@ -145,16 +161,13 @@ await provider.getBalance(me)
145
161
  ```
146
162
 
147
163
 
148
- ### Documentation
149
-
150
- https://hardhat.org/hardhat-runner/docs/guides/compile-contracts
151
164
 
152
165
  ### Scripts to find syntax bugs in code
153
166
 
154
167
  #### find methods missing the `restricted` modifier
155
168
 
156
169
  ```bash
157
- hh run scripts/find_unrestricted_methods.ts.ts
170
+ hh run scripts/find_unrestricted_methods.ts
158
171
  ```
159
172
 
160
173
  Checks all public/external methods in services and components for methods that are missing the `restricted` modifier but should have one.
@@ -178,16 +191,20 @@ Checks all public/external methods in services and components for methods that a
178
191
  forge build
179
192
 
180
193
  # contract sizes
181
- forge build --sizes | grep Instance
194
+ forge build --sizes
182
195
 
183
196
  forge test
184
197
 
185
198
  # run single test case
186
- forge test --mt test_decimals
199
+ forge test --mt test_deployAllSetup
200
+
201
+ # run all tests except long running
202
+ forge test --nmt longRunning
187
203
 
188
- # run single test case with substantial logginglogging
204
+ # run single test case with substantial logging
189
205
  # to include logs as well use -vvvvv
190
- forge test -vvvv --mt test_decimals
206
+ # to add internal functions to trace add --
207
+ forge test --decode-internal --mt test_decimals -vvvv
191
208
 
192
209
  # provide gas report for a single test
193
210
  forge test --mt test_decimals --gas-report
@@ -197,7 +214,7 @@ forge coverage
197
214
  forge coverage --report lcov
198
215
  ```
199
216
 
200
- ### Aliases
217
+ ### Aliases configured in the devcontainer setup
201
218
 
202
219
 
203
220
  | Alias | Command |
@@ -209,68 +226,15 @@ forge coverage --report lcov
209
226
  | ft | forge test |
210
227
  | ftf | forge test --nmt "_longRunning" |
211
228
  | ftt | forge test -vvvv --mt |
229
+ | fttg | forge test -vvvv --gas-report --mt |
212
230
  | fttw | forge test -vvvv --watch --mt |
213
231
  | ftc | forge test -vvvv --mc |
214
232
  | ftcw | forge test -vvvv --watch --mc |
233
+ | fcf | forge coverage --nmt "_longRunning" |
234
+ | fcfr | forge coverage --nmt "_longRunning" --report lcov |
215
235
 
216
236
  **Important**: All profiles are run using the foundry `ci` profile which disables the optimizer (for speed).
217
237
 
218
- ### Chisel session
219
-
220
- ```typescript
221
- import "./contracts/components/Component.sol";
222
- import "./contracts/components/IPool.sol";
223
- import "./contracts/components/IProduct.sol";
224
- import "./contracts/components/Pool.sol";
225
- import "./contracts/components/Product.sol";
226
- import "./contracts/instance/access/Access.sol";
227
- import "./contracts/instance/access/IAccess.sol";
228
- import "./contracts/instance/component/ComponentModule.sol";
229
- import "./contracts/instance/component/IComponent.sol";
230
- import "./contracts/instance/IInstance.sol";
231
- import "./contracts/instance/policy/IPolicy.sol";
232
- import "./contracts/instance/policy/PolicyModule.sol";
233
- import "./contracts/instance/product/IProductService.sol";
234
- import "./contracts/instance/product/ProductService.sol";
235
- import "./contracts/registry/IRegistry.sol";
236
-
237
- import {Instance} from "./contracts/instance/Instance.sol";
238
- import {Registry} from "./contracts/registry/Registry.sol";
239
- import {DeployAll} from "./scripts/DeployAll.s.sol";
240
- import {TestPool} from "./test_forge/mock/TestPool.sol";
241
- import {TestProduct} from "./test_forge/mock/TestProduct.sol";
242
-
243
- string memory instanceOwnerName = "instanceOwner";
244
- address instanceOwner = vm.addr(uint256(keccak256(abi.encodePacked(instanceOwnerName))));
245
-
246
- string memory productOwnerName = "productOwner";
247
- address productOwner = vm.addr(uint256(keccak256(abi.encodePacked(productOwnerName))));
248
-
249
- string memory poolOwnerName = "poolOwner";
250
- address poolOwner = vm.addr(uint256(keccak256(abi.encodePacked(poolOwnerName))));
251
-
252
- string memory customerName = "customer";
253
- address customer = vm.addr(uint256(keccak256(abi.encodePacked(customerName))));
254
-
255
- DeployAll deployer = new DeployAll();
256
- (
257
- Registry registry,
258
- Instance instance,
259
- TestProduct product,
260
- TestPool pool
261
- ) = deployer.run(
262
- instanceOwner,
263
- productOwner,
264
- poolOwner);
265
-
266
- ProductService ps = ProductService(address(registry));
267
-
268
- uint256 bundleNftId = 99;
269
- uint256 sumInsuredAmount = 1000*10**6;
270
- uint256 premiumAmount = 110*10**6;
271
- uint256 lifetime =365*24*3600;
272
- uint256 policyNftId = ps.createApplicationForBundle(customer, bundleNftId, sumInsuredAmount, premiumAmount, lifetime);
273
-
274
238
  ```
275
239
  ### Library Linking
276
240
 
@@ -304,245 +268,6 @@ To execute formatting run `npm run styleFix`.
304
268
  We use solhint to lint the code.
305
269
  To execute linting run `npm run lint`.
306
270
 
307
-
308
- ### Adding Brownie (Legacy - don't do that :wink: )
309
-
310
- python3 is already installed
311
-
312
- ```bash
313
- npm install -g ganache
314
- sudo apt update
315
- sudo apt install python3-pip
316
- pip install eth-brownie
317
- brownie pm install OpenZeppelin/openzeppelin-contracts@4.9.3
318
- brownie pm install OpenZeppelin/openzeppelin-contracts@5.0.0
319
- ```
320
-
321
- ```bash
322
- brownie compile --all
323
- brownie console
324
- ```
325
-
326
- ```python
327
- registry_owner = accounts[0]
328
- instance_owner = accounts[1]
329
- product_owner = accounts[2]
330
-
331
- # deploy libs and helper contracts
332
- nft_id_lib = NftIdLib.deploy({'from': registry_owner})
333
- ufixed_math_lib = UFixedMathLib.deploy({'from': registry_owner})
334
- test_fee = TestFee.deploy({'from': registry_owner})
335
-
336
- # deploy registry and a token
337
- registry = Registry.deploy({'from': registry_owner})
338
- nft = ChainNft.deploy(registry, {'from': registry_owner})
339
- registry.initialize(nft, {'from': registry_owner})
340
- token = TestUsdc.deploy({'from': registry_owner})
341
-
342
- # deploy services
343
- component_owner_service = ComponentOwnerService.deploy(registry, {'from': registry_owner})
344
- product_service = ProductService.deploy(registry, {'from': registry_owner})
345
-
346
- # deploy an instance
347
- instance = Instance.deploy(registry, component_owner_service, product_service, {'from': instance_owner})
348
-
349
- # deploy product
350
- pool = TestPool.deploy(registry, instance, token, {'from': product_owner})
351
- policy_fee = test_fee.createFee(1, -1, 0)
352
- product = TestProduct.deploy(registry, instance, token, pool, policy_fee, {'from': product_owner})
353
-
354
- # grant roles
355
- pool_owner_role = instance.getRoleForName("PoolOwner")
356
- product_owner_role = instance.getRoleForName("ProductOwner")
357
- instance.grantRole(pool_owner_role, product_owner, {'from': instance_owner})
358
- instance.grantRole(product_owner_role, product_owner, {'from': instance_owner})
359
-
360
- # register objects
361
- instance.register()
362
- component_owner_service.register(pool, {'from': product_owner})
363
- component_owner_service.register(product, {'from': product_owner})
364
-
365
- instance_id = instance.getNftId()
366
- pool_id = pool.getNftId()
367
- product_id = product.getNftId()
368
- ```
369
-
370
- ## Objects
371
-
372
- ### Registry
373
-
374
- Mandatory properties
375
-
376
- * One registry per chain
377
- * Global registry: the registry on mainnet
378
- * One entry per protocol object
379
- * Once registered object properties are immutable
380
- * Globally unique NFT minted per protocol object (chain id is embedded in NFT id)
381
- * Object ownership defined by NFT ownernship
382
- * Typed objects (instance, product, policy, ...)
383
- * Each object has parent object (only one exception: protocol object does not have parent object)
384
- * Parent object type is defined by type of child object
385
-
386
- Object properties (for smart contracts)
387
- * Objects that represent a smart contract record its contract address
388
- * With one exception (see next point) smart contract addresses refer to the address on the same chain as the registry
389
- * 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)
390
-
391
- Optional properties
392
-
393
- * Objects can have names
394
- * Object names are unique per chain
395
- * 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)
396
- *
397
-
398
- Ownership property
399
-
400
- * Object ownership defined by ownership of NFT representing the object
401
- * Protocol
402
- * Fixed/predefined owner (address without private key)
403
- * Registry
404
- * Allows registration of token and services (per major release)
405
- * May transfer ownership
406
- * Token
407
- * Fixed/predefined owner (address without private key)
408
- * TODO add whitelisting for token per major release
409
- * Service
410
- * Allows upgrades of services as long as major version is same
411
- * Until further notice the same entity as the registry owner
412
- * May transfer ownership
413
- * Instance
414
- * Granting/revoking of roles (both default + custom)
415
- * Management of custom roles and targets
416
- * May lock instance and/or components
417
- * May transfer ownership
418
- * Component (Product, Pool, Distribution, Oracle)
419
- * Register component
420
- * Set component wallet (which receives fees, holds funds)
421
- * May lock component
422
- * May transfer ownership
423
- * Additional use case specific features
424
- * Policy
425
- * Represents policy holder
426
- * Receive payouts (GIF default behaviour)
427
- * May transfer ownership
428
- * Bundle
429
- * Represents funds owner
430
- * May withdraw funds not locked by active policies
431
- * May transfer ownership
432
- * Distributor
433
- * Receives commissions from sales (GIF default behaviour)
434
- * May transfer ownership
435
-
436
- Intercepting property
437
- * Service owner is indirectly owner of service manager contract
438
-
439
- * Instance
440
- * intercepts transfer of instance owner (new owner needs access manager admin rights for custom roles and targets)
441
- * intercepts transfer of components, to do what? check that new owner has necessary roles?
442
- * Product
443
- * intercepts transfer of policies (use case specific: eg. limit/disallow transfers)
444
- * Pool:
445
- * intercepts transfer of bundles (use case specific: eg. limit/disallow transfers)
446
- * Distribution
447
- * intercepts transfer of distributors (bookkeeping: only one distributor per address allowed)
448
- * Oracle
449
- * likely meaningless
450
-
451
-
452
- ### Instance
453
-
454
- ### Product
455
-
456
- ### Pool
457
-
458
- ### Distribution
459
-
460
- ### Oracle
461
-
462
- ## Registry and Services
463
-
464
- ### Principles
465
-
466
- - 1 service per object type and major version
467
- - registry service guards write access to registry
468
- - all other objects registered via registry service
469
- - root object for the complete tree is the protocol object
470
- - under the root object a single registry object is registered (= global registry/ethereum mainnet)
471
-
472
-
473
- ### Service Responsibilities
474
-
475
- Registry Service
476
-
477
- - deployed and registered during bootstrapping of registry
478
- - used to register tokens and other services by registry owner
479
- - an object may only be registered by the service designated by the type of the object
480
- - to register an object the parent object needs already be registered
481
- - the type of the object to be registered needs to match a valid child type/parent type combination
482
-
483
- Instance Service
484
-
485
- - deploys master instance during its own bootstrapping (if allowed by contract size)
486
- - registered via registry service by registry owner
487
- - registeres master instance during its own registration by regsitry owner
488
- - deploys and registeres new instances (= instance factory) by instance owner (instance owner is a permissionless role, anybody may creates a new instance)
489
- - provides upgrade functionality to instance owners
490
-
491
- Product Service
492
-
493
- - registered via registry service by registry owner
494
- - registers products for registered instances via registry service by product owner (product owner role is permissend by the product's instance)
495
- - registers applications/policies for registered products via registry service
496
-
497
- Distribution Service
498
-
499
- - registered via registry service by registry owner
500
- - registers distribution components for registered products via registry service by distribution owner (distribution owner role is permissend by the product's instance)
501
- - registers distributors for registered distribution components via registry service
502
-
503
- ## Contract Organisation
504
-
505
- now
506
-
507
- contracts
508
- components
509
- instance
510
- registry
511
- shared
512
- types
513
-
514
-
515
- contracts
516
- component
517
- pool
518
- Pool.sol
519
- PoolService.sol
520
- oracle
521
- distribution
522
- product
523
- Product.sol
524
- ProductService.sol
525
- Component.sol
526
- ComponentService.sol
527
- instance
528
- Instance.sol
529
- InstanceAdmin.sol
530
- InstanceReader.sol
531
- InstanceService.sol
532
- InstanceServiceManager.sol
533
- registry
534
- ChainNft.sol
535
- Registry.sol
536
- RegistryAdmin.sol
537
- RegistryService.sol
538
- RegistryServiceManager.sol
539
- shared
540
- Registerable.sol
541
- RegisterableUpgradable.sol
542
- type
543
- NftId.sol
544
- ObjectType.sol
545
-
546
271
  ## Storage layout
547
272
 
548
273
  ### Analysis tool
@@ -556,6 +281,14 @@ hh run scripts/analyze_storage_layout.ts
556
281
  Analyses contract `MockStorageLayout.sol` and writes the storage layout to `storage_layout.json` and `storage_layout.csv`.
557
282
  New structs must be added to `MockStorageLayout` to be included in analysis.
558
283
 
284
+ Storage layout details:
285
+ - Items fill up the current slot if possible
286
+ - If not enough space is left in the current slot, the item is placed in the next slot
287
+ - Stucts and arrays always start a new slot
288
+ - Items following a struct or array always start a new slot
289
+
290
+ More at https://docs.soliditylang.org/en/latest/internals/layout_in_storage.html
291
+
559
292
  ### Custom types sizes
560
293
 
561
294
  | Type | Size |
@@ -574,6 +307,8 @@ New structs must be added to `MockStorageLayout` to be included in analysis.
574
307
  | StateId | 1 byte |
575
308
  | Str | 32 bytes |
576
309
  | Timestamp | 5 bytes |
310
+ | Version | 3 byte |
311
+ | VersionPart | 1 byte |
577
312
  | UFixed | 20 bytes |
578
313
  | address | 20 bytes |
579
314
  | uint256 | 32 bytes |
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "_format": "hh-sol-dbg-1",
3
- "buildInfo": "../../../build-info/49cf76454bc9678c0cab9d2da194f1c8.json"
3
+ "buildInfo": "../../../build-info/a11472d155cc1e3900b16d2850f59142.json"
4
4
  }