@etherisc/gif-next 0.0.2-e1e92ab-754 → 0.0.2-e20063b-144

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (458) hide show
  1. package/README.md +167 -14
  2. package/artifacts/contracts/components/Component.sol/Component.dbg.json +4 -0
  3. package/artifacts/contracts/components/Component.sol/Component.json +842 -0
  4. package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json +1 -1
  5. package/artifacts/contracts/components/Distribution.sol/Distribution.json +978 -190
  6. package/artifacts/contracts/components/IComponent.sol/IComponent.dbg.json +4 -0
  7. package/artifacts/contracts/{instance/base/ServiceBase.sol/ServiceBase.json → components/IComponent.sol/IComponent.json} +284 -147
  8. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.dbg.json +1 -1
  9. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.json +816 -24
  10. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.dbg.json +1 -1
  11. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.json +883 -127
  12. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.dbg.json +1 -1
  13. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.json +656 -33
  14. package/artifacts/contracts/components/Pool.sol/Pool.dbg.json +1 -1
  15. package/artifacts/contracts/components/Pool.sol/Pool.json +925 -265
  16. package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
  17. package/artifacts/contracts/components/Product.sol/Product.json +712 -159
  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 +1803 -1132
  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 +2094 -1152
  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 +1403 -0
  34. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.dbg.json +4 -0
  35. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.json +1140 -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/{InstanceBase.sol/InstanceBase.json → ComponentService.sol/ComponentService.json} +250 -187
  42. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.dbg.json +1 -1
  43. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.json +27 -158
  44. package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.dbg.json +1 -1
  45. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.dbg.json +1 -1
  46. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.json +67 -245
  47. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.dbg.json +1 -1
  48. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.json +36 -11
  49. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.dbg.json +4 -0
  50. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.json +237 -0
  51. package/artifacts/contracts/instance/module/IBundle.sol/IBundle.dbg.json +4 -0
  52. package/artifacts/contracts/instance/module/{bundle/IBundle.sol → IBundle.sol}/IBundle.json +1 -1
  53. package/artifacts/contracts/instance/module/IComponents.sol/IComponents.dbg.json +4 -0
  54. package/artifacts/contracts/instance/module/{pool/IPoolModule.sol/IPool.json → IComponents.sol/IComponents.json} +2 -2
  55. package/artifacts/contracts/instance/module/IDistribution.sol/IDistribution.dbg.json +4 -0
  56. package/artifacts/contracts/instance/module/{distribution/IDistribution.sol → IDistribution.sol}/IDistribution.json +1 -1
  57. package/artifacts/contracts/instance/module/IPolicy.sol/IPolicy.dbg.json +4 -0
  58. package/artifacts/contracts/instance/module/{policy/IPolicy.sol → IPolicy.sol}/IPolicy.json +1 -1
  59. package/artifacts/contracts/instance/module/IRisk.sol/IRisk.dbg.json +4 -0
  60. package/artifacts/contracts/instance/module/{risk/IRisk.sol → IRisk.sol}/IRisk.json +1 -1
  61. package/artifacts/contracts/instance/module/ISetup.sol/ISetup.dbg.json +4 -0
  62. package/artifacts/contracts/instance/{base/ModuleBase.sol/ModuleBase.json → module/ISetup.sol/ISetup.json} +2 -2
  63. package/artifacts/contracts/instance/module/ITreasury.sol/ITreasury.dbg.json +4 -0
  64. package/artifacts/contracts/instance/module/{treasury/ITreasury.sol → ITreasury.sol}/ITreasury.json +1 -1
  65. package/artifacts/contracts/instance/service/ApplicationService.sol/ApplicationService.dbg.json +4 -0
  66. package/artifacts/contracts/instance/service/ApplicationService.sol/ApplicationService.json +1060 -0
  67. package/artifacts/contracts/instance/service/ApplicationServiceManager.sol/ApplicationServiceManager.dbg.json +4 -0
  68. package/artifacts/contracts/instance/service/ApplicationServiceManager.sol/ApplicationServiceManager.json +681 -0
  69. package/artifacts/contracts/instance/service/BundleService.sol/BundleService.dbg.json +4 -0
  70. package/artifacts/contracts/instance/service/BundleService.sol/BundleService.json +1266 -0
  71. package/artifacts/contracts/instance/service/BundleServiceManager.sol/BundleServiceManager.dbg.json +4 -0
  72. package/artifacts/contracts/instance/service/BundleServiceManager.sol/BundleServiceManager.json +725 -0
  73. package/artifacts/contracts/instance/service/ClaimService.sol/ClaimService.dbg.json +4 -0
  74. package/artifacts/contracts/instance/service/ClaimService.sol/ClaimService.json +1040 -0
  75. package/artifacts/contracts/instance/service/ClaimServiceManager.sol/ClaimServiceManager.dbg.json +4 -0
  76. package/artifacts/contracts/instance/service/ClaimServiceManager.sol/ClaimServiceManager.json +685 -0
  77. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.dbg.json +1 -1
  78. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.json +1372 -228
  79. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.dbg.json +4 -0
  80. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.json +793 -0
  81. package/artifacts/contracts/instance/service/IApplicationService.sol/IApplicationService.dbg.json +4 -0
  82. package/artifacts/contracts/instance/service/IApplicationService.sol/IApplicationService.json +627 -0
  83. package/artifacts/contracts/instance/service/IBundleService.sol/IBundleService.dbg.json +4 -0
  84. package/artifacts/contracts/instance/service/IBundleService.sol/IBundleService.json +686 -0
  85. package/artifacts/contracts/instance/service/IClaimService.sol/IClaimService.dbg.json +4 -0
  86. package/artifacts/contracts/instance/service/{IComponentOwnerService.sol/IComponentOwnerService.json → IClaimService.sol/IClaimService.json} +327 -191
  87. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.dbg.json +1 -1
  88. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.json +804 -160
  89. package/artifacts/contracts/instance/service/IPolicyService.sol/IPolicyService.dbg.json +4 -0
  90. package/artifacts/contracts/instance/service/IPolicyService.sol/IPolicyService.json +937 -0
  91. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +1 -1
  92. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +437 -154
  93. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +1 -1
  94. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +90 -391
  95. package/artifacts/contracts/instance/service/PolicyService.sol/PolicyService.dbg.json +4 -0
  96. package/artifacts/contracts/instance/service/PolicyService.sol/PolicyService.json +1511 -0
  97. package/artifacts/contracts/instance/service/PolicyServiceManager.sol/PolicyServiceManager.dbg.json +4 -0
  98. package/artifacts/contracts/instance/service/PolicyServiceManager.sol/PolicyServiceManager.json +741 -0
  99. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.dbg.json +1 -1
  100. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.json +674 -190
  101. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.dbg.json +4 -0
  102. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.json +661 -0
  103. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.dbg.json +1 -1
  104. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.json +300 -528
  105. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.dbg.json +4 -0
  106. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.json +653 -0
  107. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
  108. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.json +60 -2
  109. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
  110. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.json +373 -61
  111. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.dbg.json +1 -1
  112. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.json +223 -229
  113. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.dbg.json +1 -1
  114. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.json +18 -0
  115. package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
  116. package/artifacts/contracts/registry/Registry.sol/Registry.json +333 -188
  117. package/artifacts/contracts/registry/RegistryAccessManager.sol/RegistryAccessManager.dbg.json +4 -0
  118. package/artifacts/contracts/registry/RegistryAccessManager.sol/RegistryAccessManager.json +285 -0
  119. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.dbg.json +1 -1
  120. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.json +227 -314
  121. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.dbg.json +1 -1
  122. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.json +312 -132
  123. package/artifacts/contracts/registry/ReleaseManager.sol/ReleaseManager.dbg.json +4 -0
  124. package/artifacts/contracts/registry/ReleaseManager.sol/ReleaseManager.json +559 -0
  125. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.dbg.json +4 -0
  126. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.json +498 -0
  127. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.dbg.json +1 -1
  128. package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json +1 -1
  129. package/artifacts/contracts/shared/ERC165.sol/ERC165.json +41 -3
  130. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.dbg.json +1 -1
  131. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.json +40 -29
  132. package/artifacts/contracts/shared/IPolicyHolder.sol/IPolicyHolder.dbg.json +4 -0
  133. package/artifacts/contracts/{instance/module/component/IComponent.sol/IComponentModule.json → shared/IPolicyHolder.sol/IPolicyHolder.json} +69 -57
  134. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +1 -1
  135. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.json +21 -34
  136. package/artifacts/contracts/shared/IRegistryLinked.sol/IRegistryLinked.dbg.json +4 -0
  137. package/artifacts/contracts/{experiment/inheritance/IB.sol/IB.json → shared/IRegistryLinked.sol/IRegistryLinked.json} +18 -20
  138. package/artifacts/contracts/shared/IService.sol/IService.dbg.json +4 -0
  139. package/artifacts/contracts/{components/BaseComponent.sol/BaseComponent.json → shared/IService.sol/IService.json} +102 -68
  140. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.dbg.json +1 -1
  141. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json +2 -152
  142. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.dbg.json +1 -1
  143. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.json +120 -27
  144. package/artifacts/contracts/shared/PolicyHolder.sol/PolicyHolder.dbg.json +4 -0
  145. package/artifacts/contracts/shared/PolicyHolder.sol/PolicyHolder.json +248 -0
  146. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.dbg.json +1 -1
  147. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.json +294 -61
  148. package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +1 -1
  149. package/artifacts/contracts/shared/Registerable.sol/Registerable.json +129 -51
  150. package/artifacts/contracts/shared/RegistryLinked.sol/RegistryLinked.dbg.json +4 -0
  151. package/artifacts/contracts/shared/RegistryLinked.sol/RegistryLinked.json +84 -0
  152. package/artifacts/contracts/shared/Service.sol/Service.dbg.json +4 -0
  153. package/artifacts/contracts/{instance/base/ComponentServiceBase.sol/ComponentServiceBase.json → shared/Service.sol/Service.json} +185 -170
  154. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.dbg.json +4 -0
  155. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.json +96 -0
  156. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.dbg.json +1 -1
  157. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.json +2 -2
  158. package/artifacts/contracts/shared/Versionable.sol/Versionable.dbg.json +1 -1
  159. package/artifacts/contracts/shared/Versionable.sol/Versionable.json +2 -152
  160. package/artifacts/contracts/test/TestFee.sol/TestFee.dbg.json +1 -1
  161. package/artifacts/contracts/test/TestFee.sol/TestFee.json +2 -2
  162. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.dbg.json +1 -1
  163. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.json +129 -51
  164. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.dbg.json +1 -1
  165. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.json +14 -14
  166. package/artifacts/contracts/test/TestService.sol/TestService.dbg.json +1 -1
  167. package/artifacts/contracts/test/TestService.sol/TestService.json +210 -198
  168. package/artifacts/contracts/test/TestToken.sol/TestUsdc.dbg.json +1 -1
  169. package/artifacts/contracts/test/TestVersion.sol/TestVersion.dbg.json +1 -1
  170. package/artifacts/contracts/test/TestVersion.sol/TestVersion.json +2 -2
  171. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.dbg.json +1 -1
  172. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.json +8 -174
  173. package/artifacts/contracts/test/Usdc.sol/USDC.dbg.json +1 -1
  174. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.dbg.json +1 -1
  175. package/artifacts/contracts/types/Amount.sol/AmountLib.dbg.json +4 -0
  176. package/artifacts/contracts/types/Amount.sol/AmountLib.json +185 -0
  177. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
  178. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.json +2 -2
  179. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.dbg.json +1 -1
  180. package/artifacts/contracts/types/ClaimId.sol/ClaimIdLib.dbg.json +4 -0
  181. package/artifacts/contracts/types/ClaimId.sol/ClaimIdLib.json +179 -0
  182. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.dbg.json +4 -0
  183. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.json +104 -0
  184. package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +1 -1
  185. package/artifacts/contracts/types/Fee.sol/FeeLib.json +40 -9
  186. package/artifacts/contracts/types/Key32.sol/Key32Lib.dbg.json +1 -1
  187. package/artifacts/contracts/types/Key32.sol/Key32Lib.json +31 -17
  188. package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
  189. package/artifacts/contracts/types/NftId.sol/NftIdLib.json +17 -4
  190. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +1 -1
  191. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +26 -3
  192. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.dbg.json +4 -0
  193. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.json +100 -0
  194. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +1 -1
  195. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +2 -2
  196. package/artifacts/contracts/types/PayoutId.sol/PayoutIdLib.dbg.json +4 -0
  197. package/artifacts/contracts/types/PayoutId.sol/PayoutIdLib.json +209 -0
  198. package/artifacts/contracts/types/Referral.sol/ReferralLib.dbg.json +4 -0
  199. package/artifacts/contracts/types/Referral.sol/ReferralLib.json +142 -0
  200. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.dbg.json +1 -1
  201. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.json +2 -2
  202. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.dbg.json +1 -1
  203. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.json +134 -8
  204. package/artifacts/contracts/types/Seconds.sol/SecondsLib.dbg.json +4 -0
  205. package/artifacts/contracts/types/Seconds.sol/SecondsLib.json +124 -0
  206. package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +1 -1
  207. package/artifacts/contracts/types/StateId.sol/StateIdLib.json +2 -2
  208. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
  209. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.json +51 -7
  210. package/artifacts/contracts/types/UFixed.sol/MathLib.dbg.json +1 -1
  211. package/artifacts/contracts/types/UFixed.sol/MathLib.json +2 -2
  212. package/artifacts/contracts/types/UFixed.sol/UFixedLib.dbg.json +1 -1
  213. package/artifacts/contracts/types/UFixed.sol/UFixedLib.json +2 -2
  214. package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +1 -1
  215. package/artifacts/contracts/types/Version.sol/VersionLib.json +2 -2
  216. package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +1 -1
  217. package/artifacts/contracts/types/Version.sol/VersionPartLib.json +22 -3
  218. package/contracts/components/Component.sol +253 -0
  219. package/contracts/components/Distribution.sol +208 -79
  220. package/contracts/components/IComponent.sol +76 -0
  221. package/contracts/components/IDistributionComponent.sol +43 -18
  222. package/contracts/components/IPoolComponent.sol +88 -39
  223. package/contracts/components/IProductComponent.sol +12 -9
  224. package/contracts/components/Pool.sol +221 -165
  225. package/contracts/components/Product.sol +250 -178
  226. package/contracts/instance/AccessManagerUpgradeableInitializeable.sol +13 -0
  227. package/contracts/instance/BundleManager.sol +126 -0
  228. package/contracts/instance/Cloneable.sol +51 -0
  229. package/contracts/instance/IInstance.sol +91 -41
  230. package/contracts/instance/IInstanceService.sol +68 -0
  231. package/contracts/instance/Instance.sol +293 -66
  232. package/contracts/instance/InstanceAccessManager.sol +527 -0
  233. package/contracts/instance/InstanceReader.sol +317 -0
  234. package/contracts/instance/InstanceService.sol +478 -0
  235. package/contracts/instance/InstanceServiceManager.sol +54 -0
  236. package/contracts/instance/ObjectManager.sol +82 -0
  237. package/contracts/instance/base/ComponentService.sol +121 -0
  238. package/contracts/instance/base/IKeyValueStore.sol +13 -14
  239. package/contracts/instance/base/ILifecycle.sol +3 -3
  240. package/contracts/instance/base/KeyValueStore.sol +60 -41
  241. package/contracts/instance/base/Lifecycle.sol +24 -7
  242. package/contracts/instance/module/IAccess.sol +54 -0
  243. package/contracts/instance/module/IBundle.sol +23 -0
  244. package/contracts/instance/module/IComponents.sol +41 -0
  245. package/contracts/instance/module/IDistribution.sol +41 -0
  246. package/contracts/instance/module/IPolicy.sol +77 -0
  247. package/contracts/instance/module/IRisk.sol +11 -0
  248. package/contracts/instance/module/ISetup.sol +33 -0
  249. package/contracts/instance/module/ITreasury.sol +23 -0
  250. package/contracts/instance/service/ApplicationService.sol +355 -0
  251. package/contracts/instance/service/ApplicationServiceManager.sol +35 -0
  252. package/contracts/instance/service/BundleService.sol +436 -0
  253. package/contracts/instance/service/BundleServiceManager.sol +51 -0
  254. package/contracts/instance/service/ClaimService.sol +239 -0
  255. package/contracts/instance/service/ClaimServiceManager.sol +35 -0
  256. package/contracts/instance/service/DistributionService.sol +399 -22
  257. package/contracts/instance/service/DistributionServiceManager.sol +51 -0
  258. package/contracts/instance/service/IApplicationService.sol +78 -0
  259. package/contracts/instance/service/IBundleService.sol +96 -0
  260. package/contracts/instance/service/IClaimService.sol +92 -0
  261. package/contracts/instance/service/IDistributionService.sol +88 -1
  262. package/contracts/instance/service/IPolicyService.sol +137 -0
  263. package/contracts/instance/service/IPoolService.sol +80 -18
  264. package/contracts/instance/service/IProductService.sol +9 -76
  265. package/contracts/instance/service/PolicyService.sol +541 -0
  266. package/contracts/instance/service/PolicyServiceManager.sol +54 -0
  267. package/contracts/instance/service/PoolService.sol +248 -94
  268. package/contracts/instance/service/PoolServiceManager.sol +51 -0
  269. package/contracts/instance/service/ProductService.sol +133 -433
  270. package/contracts/instance/service/ProductServiceManager.sol +54 -0
  271. package/contracts/registry/ChainNft.sol +47 -24
  272. package/contracts/registry/IRegistry.sol +52 -8
  273. package/contracts/registry/IRegistryService.sol +53 -20
  274. package/contracts/registry/ITransferInterceptor.sol +1 -0
  275. package/contracts/registry/Registry.sol +277 -236
  276. package/contracts/registry/RegistryAccessManager.sol +216 -0
  277. package/contracts/registry/RegistryService.sol +114 -273
  278. package/contracts/registry/RegistryServiceManager.sol +24 -25
  279. package/contracts/registry/ReleaseManager.sol +324 -0
  280. package/contracts/registry/TokenRegistry.sol +116 -0
  281. package/contracts/shared/ERC165.sol +14 -8
  282. package/contracts/shared/INftOwnable.sol +11 -10
  283. package/contracts/shared/IPolicyHolder.sol +26 -0
  284. package/contracts/shared/IRegisterable.sol +4 -6
  285. package/contracts/shared/IRegistryLinked.sol +12 -0
  286. package/contracts/shared/IService.sol +16 -0
  287. package/contracts/shared/IVersionable.sol +4 -47
  288. package/contracts/shared/NftOwnable.sol +67 -83
  289. package/contracts/shared/PolicyHolder.sol +81 -0
  290. package/contracts/shared/ProxyManager.sol +100 -25
  291. package/contracts/shared/Registerable.sol +16 -31
  292. package/contracts/shared/RegistryLinked.sol +48 -0
  293. package/contracts/shared/Service.sol +72 -0
  294. package/contracts/shared/TokenHandler.sol +33 -0
  295. package/contracts/shared/Versionable.sol +4 -92
  296. package/contracts/test/TestRegisterable.sol +1 -1
  297. package/contracts/test/TestRoleId.sol +1 -1
  298. package/contracts/test/TestService.sol +6 -7
  299. package/contracts/types/Amount.sol +65 -0
  300. package/contracts/types/Blocknumber.sol +1 -0
  301. package/contracts/types/ClaimId.sol +75 -0
  302. package/contracts/types/DistributorType.sol +55 -0
  303. package/contracts/types/Fee.sol +13 -5
  304. package/contracts/types/Key32.sol +8 -3
  305. package/contracts/types/NftId.sol +8 -0
  306. package/contracts/types/NftIdSet.sol +26 -24
  307. package/contracts/types/NumberId.sol +52 -0
  308. package/contracts/types/ObjectType.sol +41 -15
  309. package/contracts/types/PayoutId.sol +82 -0
  310. package/contracts/types/Referral.sol +89 -0
  311. package/contracts/types/RoleId.sol +67 -15
  312. package/contracts/types/Seconds.sol +54 -0
  313. package/contracts/types/StateId.sol +12 -3
  314. package/contracts/types/Timestamp.sol +22 -13
  315. package/contracts/types/UFixed.sol +1 -0
  316. package/contracts/types/Version.sol +5 -1
  317. package/package.json +3 -3
  318. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.dbg.json +0 -4
  319. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json +0 -4
  320. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.json +0 -254
  321. package/artifacts/contracts/experiment/errors/Require.sol/Require.dbg.json +0 -4
  322. package/artifacts/contracts/experiment/errors/Require.sol/Require.json +0 -105
  323. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.dbg.json +0 -4
  324. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.json +0 -105
  325. package/artifacts/contracts/experiment/inheritance/A.sol/A.dbg.json +0 -4
  326. package/artifacts/contracts/experiment/inheritance/A.sol/A.json +0 -128
  327. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.dbg.json +0 -4
  328. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.json +0 -42
  329. package/artifacts/contracts/experiment/inheritance/B.sol/B.dbg.json +0 -4
  330. package/artifacts/contracts/experiment/inheritance/B.sol/B.json +0 -76
  331. package/artifacts/contracts/experiment/inheritance/C.sol/C.dbg.json +0 -4
  332. package/artifacts/contracts/experiment/inheritance/C.sol/C.json +0 -89
  333. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.dbg.json +0 -4
  334. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.json +0 -128
  335. package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.dbg.json +0 -4
  336. package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.json +0 -37
  337. package/artifacts/contracts/experiment/inheritance/IB.sol/IB.dbg.json +0 -4
  338. package/artifacts/contracts/experiment/inheritance/IC.sol/IC.dbg.json +0 -4
  339. package/artifacts/contracts/experiment/inheritance/IC.sol/IC.json +0 -63
  340. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.dbg.json +0 -4
  341. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.json +0 -59
  342. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.dbg.json +0 -4
  343. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.json +0 -124
  344. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.dbg.json +0 -4
  345. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.json +0 -74
  346. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.dbg.json +0 -4
  347. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.json +0 -124
  348. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.dbg.json +0 -4
  349. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.json +0 -207
  350. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.dbg.json +0 -4
  351. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.json +0 -10
  352. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.dbg.json +0 -4
  353. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.json +0 -10
  354. package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.dbg.json +0 -4
  355. package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.json +0 -24
  356. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +0 -4
  357. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.dbg.json +0 -4
  358. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.json +0 -113
  359. package/artifacts/contracts/instance/base/IService.sol/IService.dbg.json +0 -4
  360. package/artifacts/contracts/instance/base/IService.sol/IService.json +0 -421
  361. package/artifacts/contracts/instance/base/InstanceBase.sol/InstanceBase.dbg.json +0 -4
  362. package/artifacts/contracts/instance/base/ModuleBase.sol/ModuleBase.dbg.json +0 -4
  363. package/artifacts/contracts/instance/base/ServiceBase.sol/ServiceBase.dbg.json +0 -4
  364. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.dbg.json +0 -4
  365. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.json +0 -297
  366. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundle.dbg.json +0 -4
  367. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.dbg.json +0 -4
  368. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.json +0 -297
  369. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.dbg.json +0 -4
  370. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.json +0 -117
  371. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.dbg.json +0 -4
  372. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.json +0 -10
  373. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.dbg.json +0 -4
  374. package/artifacts/contracts/instance/module/distribution/DistributionModule.sol/DistributionModule.dbg.json +0 -4
  375. package/artifacts/contracts/instance/module/distribution/DistributionModule.sol/DistributionModule.json +0 -10
  376. package/artifacts/contracts/instance/module/distribution/IDistribution.sol/IDistribution.dbg.json +0 -4
  377. package/artifacts/contracts/instance/module/distribution/IDistribution.sol/IDistributionModule.dbg.json +0 -4
  378. package/artifacts/contracts/instance/module/distribution/IDistribution.sol/IDistributionModule.json +0 -10
  379. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicy.dbg.json +0 -4
  380. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.dbg.json +0 -4
  381. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.json +0 -271
  382. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.dbg.json +0 -4
  383. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.json +0 -271
  384. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPool.dbg.json +0 -4
  385. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.dbg.json +0 -4
  386. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.json +0 -164
  387. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.dbg.json +0 -4
  388. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.json +0 -164
  389. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRisk.dbg.json +0 -4
  390. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.dbg.json +0 -4
  391. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.json +0 -113
  392. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.dbg.json +0 -4
  393. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.json +0 -131
  394. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasury.dbg.json +0 -4
  395. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.dbg.json +0 -4
  396. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.json +0 -638
  397. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.dbg.json +0 -4
  398. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.json +0 -76
  399. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.dbg.json +0 -4
  400. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.json +0 -638
  401. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.dbg.json +0 -4
  402. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.json +0 -827
  403. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.dbg.json +0 -4
  404. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.dbg.json +0 -4
  405. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.json +0 -457
  406. package/artifacts/contracts/test/TestDistribution.sol/TestDistribution.dbg.json +0 -4
  407. package/artifacts/contracts/test/TestDistribution.sol/TestDistribution.json +0 -557
  408. package/artifacts/contracts/test/TestPool.sol/TestPool.dbg.json +0 -4
  409. package/artifacts/contracts/test/TestPool.sol/TestPool.json +0 -716
  410. package/artifacts/contracts/test/TestProduct.sol/TestProduct.dbg.json +0 -4
  411. package/artifacts/contracts/test/TestProduct.sol/TestProduct.json +0 -744
  412. package/artifacts/contracts/types/ReferralId.sol/ReferralIdLib.dbg.json +0 -4
  413. package/artifacts/contracts/types/ReferralId.sol/ReferralIdLib.json +0 -99
  414. package/contracts/components/BaseComponent.sol +0 -79
  415. package/contracts/components/IBaseComponent.sol +0 -19
  416. package/contracts/experiment/errors/Require.sol +0 -38
  417. package/contracts/experiment/errors/Revert.sol +0 -44
  418. package/contracts/experiment/inheritance/A.sol +0 -53
  419. package/contracts/experiment/inheritance/B.sol +0 -28
  420. package/contracts/experiment/inheritance/C.sol +0 -34
  421. package/contracts/experiment/inheritance/IA.sol +0 -13
  422. package/contracts/experiment/inheritance/IB.sol +0 -10
  423. package/contracts/experiment/inheritance/IC.sol +0 -12
  424. package/contracts/experiment/statemachine/Dummy.sol +0 -27
  425. package/contracts/experiment/statemachine/ISM.sol +0 -25
  426. package/contracts/experiment/statemachine/SM.sol +0 -57
  427. package/contracts/experiment/statemachine/SimpleStateMachine.sol +0 -31
  428. package/contracts/experiment/types/TypeA.sol +0 -47
  429. package/contracts/experiment/types/TypeB.sol +0 -29
  430. package/contracts/instance/IInstanceLinked.sol +0 -8
  431. package/contracts/instance/base/ComponentServiceBase.sol +0 -49
  432. package/contracts/instance/base/IInstanceBase.sol +0 -23
  433. package/contracts/instance/base/IService.sol +0 -15
  434. package/contracts/instance/base/InstanceBase.sol +0 -89
  435. package/contracts/instance/base/ModuleBase.sol +0 -57
  436. package/contracts/instance/base/ServiceBase.sol +0 -44
  437. package/contracts/instance/module/bundle/BundleModule.sol +0 -134
  438. package/contracts/instance/module/bundle/IBundle.sol +0 -53
  439. package/contracts/instance/module/component/ComponentModule.sol +0 -71
  440. package/contracts/instance/module/component/IComponent.sol +0 -28
  441. package/contracts/instance/module/distribution/DistributionModule.sol +0 -17
  442. package/contracts/instance/module/distribution/IDistribution.sol +0 -10
  443. package/contracts/instance/module/policy/IPolicy.sol +0 -63
  444. package/contracts/instance/module/policy/PolicyModule.sol +0 -91
  445. package/contracts/instance/module/pool/IPoolModule.sol +0 -41
  446. package/contracts/instance/module/pool/PoolModule.sol +0 -95
  447. package/contracts/instance/module/risk/IRisk.sol +0 -26
  448. package/contracts/instance/module/risk/RiskModule.sol +0 -62
  449. package/contracts/instance/module/treasury/ITreasury.sol +0 -84
  450. package/contracts/instance/module/treasury/TokenHandler.sol +0 -48
  451. package/contracts/instance/module/treasury/TreasuryModule.sol +0 -131
  452. package/contracts/instance/service/ComponentOwnerService.sol +0 -315
  453. package/contracts/instance/service/IComponentOwnerService.sol +0 -20
  454. package/contracts/registry/IChainNft.sol +0 -22
  455. package/contracts/test/TestDistribution.sol +0 -22
  456. package/contracts/test/TestPool.sol +0 -27
  457. package/contracts/test/TestProduct.sol +0 -74
  458. package/contracts/types/ReferralId.sol +0 -48
@@ -0,0 +1,253 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
5
+ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
6
+ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
7
+ import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
8
+
9
+ import {IComponent} from "./IComponent.sol";
10
+ import {IComponents} from "../instance/module/IComponents.sol";
11
+ import {IProductService} from "../instance/service/IProductService.sol";
12
+ import {IInstanceService} from "../instance/IInstanceService.sol";
13
+ import {IInstance} from "../instance/IInstance.sol";
14
+ import {InstanceAccessManager} from "../instance/InstanceAccessManager.sol";
15
+ import {InstanceReader} from "../instance/InstanceReader.sol";
16
+ import {IRegistry} from "../registry/IRegistry.sol";
17
+ import {NftId} from "../types/NftId.sol";
18
+ import {ObjectType, INSTANCE, PRODUCT} from "../types/ObjectType.sol";
19
+ import {VersionPart} from "../types/Version.sol";
20
+ import {Registerable} from "../shared/Registerable.sol";
21
+ import {RoleId, RoleIdLib} from "../types/RoleId.sol";
22
+ import {IAccess} from "../instance/module/IAccess.sol";
23
+ import {VersionPart} from "../types/Version.sol";
24
+
25
+ // TODO discuss to inherit from oz accessmanaged
26
+ // then add (Distribution|Pool|Product)Upradeable that also intherit from Versionable
27
+ // same pattern as for Service which is also upgradeable
28
+ abstract contract Component is
29
+ Registerable,
30
+ IComponent,
31
+ AccessManagedUpgradeable
32
+ {
33
+ // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.component.Component.sol")) - 1)) & ~bytes32(uint256(0xff));
34
+ bytes32 public constant COMPONENT_LOCATION_V1 = 0xffe8d4462baed26a47154f4b8f6db497d2f772496965791d25bd456e342b7f00;
35
+
36
+ struct ComponentStorage {
37
+ string _name; // unique (per instance) component name
38
+ IERC20Metadata _token; // token for this component
39
+ IInstance _instance; // instance for this component
40
+ address _wallet; // wallet for this component (default = component contract itself)
41
+ InstanceReader _instanceReader; // instance reader for this component
42
+ bool _isNftInterceptor; // declares if component is involved in nft transfers
43
+ NftId _productNftId; // only relevant for components that are linked to a aproduct
44
+ }
45
+
46
+ function _getComponentStorage() private pure returns (ComponentStorage storage $) {
47
+ assembly {
48
+ $.slot := COMPONENT_LOCATION_V1
49
+ }
50
+ }
51
+
52
+ modifier onlyChainNft() {
53
+ if(msg.sender != getRegistry().getChainNftAddress()) {
54
+ revert ErrorComponentNotChainNft(msg.sender);
55
+ }
56
+ _;
57
+ }
58
+
59
+ function initializeComponent(
60
+ address registry,
61
+ NftId instanceNftId,
62
+ string memory name,
63
+ address token,
64
+ ObjectType componentType,
65
+ bool isInterceptor,
66
+ address initialOwner,
67
+ bytes memory registryData // writeonly data that will saved in the object info record of the registry
68
+ )
69
+ public
70
+ virtual
71
+ onlyInitializing()
72
+ {
73
+ initializeRegisterable(registry, instanceNftId, componentType, isInterceptor, initialOwner, registryData);
74
+
75
+ // set and check linked instance
76
+ ComponentStorage storage $ = _getComponentStorage();
77
+ $._instance = IInstance(
78
+ getRegistry().getObjectInfo(instanceNftId).objectAddress);
79
+
80
+ if(!$._instance.supportsInterface(type(IInstance).interfaceId)) {
81
+ revert ErrorComponentNotInstance(instanceNftId);
82
+ }
83
+
84
+ // initialize AccessManagedUpgradeable
85
+ __AccessManaged_init($._instance.authority());
86
+
87
+ // set component state
88
+ $._name = name;
89
+ $._isNftInterceptor = isInterceptor;
90
+ $._instanceReader = $._instance.getInstanceReader();
91
+ $._wallet = address(this);
92
+ $._token = IERC20Metadata(token);
93
+
94
+ registerInterface(type(IAccessManaged).interfaceId);
95
+ registerInterface(type(IComponent).interfaceId);
96
+ }
97
+
98
+ function lock() external onlyOwner override {
99
+ IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(true);
100
+ }
101
+
102
+ function unlock() external onlyOwner override {
103
+ IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(false);
104
+ }
105
+
106
+ function setWallet(address newWallet)
107
+ external
108
+ override
109
+ onlyOwner
110
+ {
111
+ ComponentStorage storage $ = _getComponentStorage();
112
+
113
+ address currentWallet = $._wallet;
114
+ uint256 currentBalance = $._token.balanceOf(currentWallet);
115
+
116
+ // checks
117
+ if (newWallet == address(0)) {
118
+ revert ErrorComponentWalletAddressZero();
119
+ }
120
+
121
+ if (newWallet == currentWallet) {
122
+ revert ErrorComponentWalletAddressIsSameAsCurrent();
123
+ }
124
+
125
+ if (currentBalance > 0) {
126
+ if (currentWallet == address(this)) {
127
+ // move tokens from component smart contract to external wallet
128
+ } else {
129
+ // move tokens from external wallet to component smart contract or another external wallet
130
+ uint256 allowance = $._token.allowance(currentWallet, address(this));
131
+ if (allowance < currentBalance) {
132
+ revert ErrorComponentWalletAllowanceTooSmall(currentWallet, newWallet, allowance, currentBalance);
133
+ }
134
+ }
135
+ }
136
+
137
+ // effects
138
+ $._wallet = newWallet;
139
+ emit LogComponentWalletAddressChanged(currentWallet, newWallet);
140
+
141
+ // interactions
142
+ if (currentBalance > 0) {
143
+ // transfer tokens from current wallet to new wallet
144
+ if (currentWallet == address(this)) {
145
+ // transferFrom requires self allowance too
146
+ $._token.approve(address(this), currentBalance);
147
+ }
148
+
149
+ SafeERC20.safeTransferFrom($._token, currentWallet, newWallet, currentBalance);
150
+ emit LogComponentWalletTokensTransferred(currentWallet, newWallet, currentBalance);
151
+ }
152
+ }
153
+
154
+ function setProductNftId(NftId productNftId)
155
+ external
156
+ override
157
+ {
158
+ ComponentStorage storage $ = _getComponentStorage();
159
+
160
+ // verify caller is product service
161
+ if(msg.sender != _getServiceAddress(PRODUCT())) {
162
+ revert ErrorComponentNotProductService(msg.sender);
163
+ }
164
+
165
+ // verify component is not yet linked to a product
166
+ if($._productNftId.gtz()) {
167
+ revert ErrorComponentProductNftAlreadySet();
168
+ }
169
+
170
+ $._productNftId = productNftId;
171
+ }
172
+
173
+ function nftMint(address to, uint256 tokenId)
174
+ external
175
+ virtual
176
+ onlyChainNft
177
+ {}
178
+
179
+ /// @dev callback function for nft transfers
180
+ /// may only be called by chain nft contract.
181
+ /// do not override this function to implement business logic for handling transfers
182
+ /// override internal function _nftTransferFrom instead
183
+ function nftTransferFrom(address from, address to, uint256 tokenId)
184
+ external
185
+ virtual
186
+ onlyChainNft
187
+ {
188
+ _nftTransferFrom(from, to, tokenId);
189
+ }
190
+
191
+ function getWallet() public view override returns (address walletAddress)
192
+ {
193
+ return _getComponentStorage()._wallet;
194
+ }
195
+
196
+ function getToken() public view override returns (IERC20Metadata token) {
197
+ return _getComponentStorage()._token;
198
+ }
199
+
200
+ function isNftInterceptor() public view override returns(bool isInterceptor) {
201
+ return _getComponentStorage()._isNftInterceptor;
202
+ }
203
+
204
+ function getInstance() public view override returns (IInstance instance) {
205
+ return _getComponentStorage()._instance;
206
+ }
207
+
208
+ function getName() public view override returns(string memory name) {
209
+ return _getComponentStorage()._name;
210
+ }
211
+
212
+ function getProductNftId() public view override returns (NftId productNftId) {
213
+ return _getComponentStorage()._productNftId;
214
+ }
215
+
216
+ function getComponentInfo() public view returns (IComponents.ComponentInfo memory info) {
217
+ info = _getInstanceReader().getComponentInfo(getNftId());
218
+
219
+ // fallback to initial info (wallet is always != address(0))
220
+ if(info.wallet == address(0)) {
221
+ info = _getInitialInfo();
222
+ }
223
+ }
224
+
225
+ /// @dev defines initial component specification
226
+ /// overwrite this function according to your use case
227
+ function _getInitialInfo()
228
+ internal
229
+ view
230
+ virtual
231
+ returns (IComponents.ComponentInfo memory info)
232
+ { }
233
+
234
+
235
+ /// @dev internal function for nft transfers.
236
+ /// handling logic that deals with nft transfers need to overwrite this function
237
+ function _nftTransferFrom(address from, address to, uint256 tokenId)
238
+ internal
239
+ virtual
240
+ { }
241
+
242
+ /// @dev returns reader for linked instance
243
+ function _getInstanceReader() internal view returns (InstanceReader reader) {
244
+ return _getComponentStorage()._instanceReader;
245
+ }
246
+
247
+ /// @dev returns the service address for the specified domain
248
+ /// gets address via lookup from registry using the major version form the linked instance
249
+ function _getServiceAddress(ObjectType domain) internal view returns (address service) {
250
+ VersionPart majorVersion = _getComponentStorage()._instance.getMajorVersion();
251
+ return getRegistry().getServiceAddress(domain, majorVersion);
252
+ }
253
+ }
@@ -4,77 +4,216 @@ pragma solidity ^0.8.19;
4
4
  import {DISTRIBUTION} from "../types/ObjectType.sol";
5
5
  import {IDistributionService} from "../instance/service/IDistributionService.sol";
6
6
  import {IProductService} from "../instance/service/IProductService.sol";
7
- import {NftId} from "../types/NftId.sol";
8
- import {ReferralId} from "../types/ReferralId.sol";
7
+ import {NftId, zeroNftId, NftIdLib, toNftId} from "../types/NftId.sol";
8
+ import {ReferralId, ReferralStatus, ReferralLib} from "../types/Referral.sol";
9
9
  import {Fee, FeeLib} from "../types/Fee.sol";
10
- import {BaseComponent} from "./BaseComponent.sol";
10
+ import {Component} from "./Component.sol";
11
+ import {IDistribution} from "../instance/module/IDistribution.sol";
11
12
  import {IDistributionComponent} from "./IDistributionComponent.sol";
12
13
  import {IRegistry} from "../registry/IRegistry.sol";
13
14
  import {IRegisterable} from "../shared/IRegisterable.sol";
15
+ import {ISetup} from "../instance/module/ISetup.sol";
14
16
  import {Registerable} from "../shared/Registerable.sol";
17
+ import {TokenHandler} from "../shared/TokenHandler.sol";
18
+ import {InstanceReader} from "../instance/InstanceReader.sol";
19
+ import {UFixed} from "../types/UFixed.sol";
20
+ import {DistributorType} from "../types/DistributorType.sol";
21
+ import {Timestamp, TimestampLib} from "../types/Timestamp.sol";
22
+ import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
15
23
 
16
- contract Distribution is
17
- BaseComponent,
24
+
25
+ abstract contract Distribution is
26
+ Component,
18
27
  IDistributionComponent
19
28
  {
29
+ // keccak256(abi.encode(uint256(keccak256("etherisc.storage.Distribution")) - 1)) & ~bytes32(uint256(0xff));
30
+ bytes32 public constant DISTRIBUTION_STORAGE_LOCATION_V1 = 0xaab7c5ea03d290056d6c060e0833d3ebcbe647f7694616a2ec52738a64b2f900;
20
31
 
21
- Fee internal _initialDistributionFee;
22
- bool internal _isVerifying;
23
-
24
- IDistributionService private _distributionService;
25
- IProductService private _productService;
26
-
27
- modifier onlyProductService() {
28
- require(
29
- msg.sender == address(_productService),
30
- "ERROR:POL-002:NOT_PRODUCT_SERVICE");
31
- _;
32
+ struct DistributionStorage {
33
+ Fee _minDistributionOwnerFee;
34
+ Fee _distributionFee;
35
+ TokenHandler _tokenHandler;
36
+ IDistributionService _distributionService;
37
+ mapping(address distributor => NftId distributorNftId) _distributorNftId;
32
38
  }
33
39
 
34
- constructor(
40
+ error ErrorDistributionAlreadyDistributor(address distributor, NftId distributorNftId);
41
+
42
+ function initializeDistribution(
35
43
  address registry,
36
44
  NftId instanceNftId,
37
- // TODO refactor into tokenNftId
45
+ string memory name,
38
46
  address token,
39
- bool verifying,
47
+ Fee memory minDistributionOwnerFee,
40
48
  Fee memory distributionFee,
41
- address initialOwner
49
+ address initialOwner,
50
+ bytes memory registryData // writeonly data that will saved in the object info record of the registry
42
51
  )
43
- BaseComponent(registry, instanceNftId, token, DISTRIBUTION(), true, initialOwner)
52
+ public
53
+ virtual
54
+ onlyInitializing()
44
55
  {
45
- _isVerifying = verifying;
46
- _initialDistributionFee = distributionFee;
56
+ initializeComponent(registry, instanceNftId, name, token, DISTRIBUTION(), true, initialOwner, registryData);
47
57
 
48
- _distributionService = _instance.getDistributionService();
49
- _productService = _instance.getProductService();
58
+ DistributionStorage storage $ = _getDistributionStorage();
59
+ // TODO add validation
60
+ $._minDistributionOwnerFee = minDistributionOwnerFee;
61
+ $._distributionFee = distributionFee;
62
+ $._tokenHandler = new TokenHandler(token);
63
+ $._distributionService = IDistributionService(_getServiceAddress(DISTRIBUTION()));
50
64
 
51
- _registerInterface(type(IDistributionComponent).interfaceId);
65
+ registerInterface(type(IDistributionComponent).interfaceId);
52
66
  }
53
67
 
54
-
55
68
  function setFees(
69
+ Fee memory minDistributionOwnerFee,
56
70
  Fee memory distributionFee
57
71
  )
58
72
  external
59
73
  override
74
+ onlyOwner
75
+ restricted()
60
76
  {
61
- _distributionService.setFees(distributionFee);
77
+ _getDistributionStorage()._distributionService.setFees(minDistributionOwnerFee, distributionFee);
62
78
  }
63
79
 
64
- function calculateFeeAmount(
65
- ReferralId referralId,
66
- uint256 netPremiumAmount
80
+ function getDistributionFee() external view returns (Fee memory distributionFee) {
81
+ DistributionStorage storage $ = _getDistributionStorage();
82
+ return $._distributionFee;
83
+ }
84
+
85
+ function createDistributorType(
86
+ string memory name,
87
+ UFixed minDiscountPercentage,
88
+ UFixed maxDiscountPercentage,
89
+ UFixed commissionPercentage,
90
+ uint32 maxReferralCount,
91
+ uint32 maxReferralLifetime,
92
+ bool allowSelfReferrals,
93
+ bool allowRenewals,
94
+ bytes memory data
95
+ )
96
+ public
97
+ returns (DistributorType distributorType)
98
+ {
99
+ DistributionStorage storage $ = _getDistributionStorage();
100
+ distributorType = $._distributionService.createDistributorType(
101
+ name,
102
+ minDiscountPercentage,
103
+ maxDiscountPercentage,
104
+ commissionPercentage,
105
+ maxReferralCount,
106
+ maxReferralLifetime,
107
+ allowSelfReferrals,
108
+ allowRenewals,
109
+ data);
110
+ }
111
+
112
+ function createDistributor(
113
+ address distributor,
114
+ DistributorType distributorType,
115
+ bytes memory data
67
116
  )
117
+ public
118
+ returns(NftId distributorNftId)
119
+ {
120
+ DistributionStorage storage $ = _getDistributionStorage();
121
+ if($._distributorNftId[distributor].gtz()) {
122
+ revert ErrorDistributionAlreadyDistributor(distributor, $._distributorNftId[distributor]);
123
+ }
124
+
125
+ distributorNftId = $._distributionService.createDistributor(
126
+ distributor,
127
+ distributorType,
128
+ data);
129
+
130
+ $._distributorNftId[distributor] = distributorNftId;
131
+ }
132
+
133
+ function updateDistributorType(
134
+ NftId distributorNftId,
135
+ DistributorType distributorType,
136
+ bytes memory data
137
+ )
138
+ public
139
+ // TODO figure out what we need for authz
140
+ // and add it
141
+ {
142
+ DistributionStorage storage $ = _getDistributionStorage();
143
+ $._distributionService.updateDistributorType(
144
+ distributorNftId,
145
+ distributorType,
146
+ data);
147
+ }
148
+
149
+ /**
150
+ * @dev lets distributors create referral codes.
151
+ * referral codes need to be unique
152
+ */
153
+ function _createReferral(
154
+ NftId distributorNftId,
155
+ string memory code,
156
+ UFixed discountPercentage,
157
+ uint32 maxReferrals,
158
+ Timestamp expiryAt,
159
+ bytes memory data
160
+ )
161
+ internal
162
+ returns (ReferralId referralId)
163
+ {
164
+ DistributionStorage storage $ = _getDistributionStorage();
165
+ referralId = $._distributionService.createReferral(
166
+ distributorNftId,
167
+ code,
168
+ discountPercentage,
169
+ maxReferrals,
170
+ expiryAt,
171
+ data);
172
+ }
173
+
174
+ function isDistributor(address candidate)
175
+ public
176
+ view
177
+ returns (bool)
178
+ {
179
+ DistributionStorage storage $ = _getDistributionStorage();
180
+ return $._distributorNftId[candidate].gtz();
181
+ }
182
+
183
+ function getDistributorNftId(address distributor)
184
+ public
185
+ view
186
+ returns (NftId distributorNftId)
187
+ {
188
+ DistributionStorage storage $ = _getDistributionStorage();
189
+ return $._distributorNftId[distributor];
190
+ }
191
+
192
+ function getDiscountPercentage(string memory referralCode)
68
193
  external
69
194
  view
70
- virtual override
71
- returns (uint256 feeAmount)
195
+ returns (
196
+ UFixed discountPercentage,
197
+ ReferralStatus status
198
+ )
72
199
  {
73
- Fee memory fee = getDistributionFee();
74
- (feeAmount,) = FeeLib.calculateFee(fee, netPremiumAmount);
200
+ ReferralId referralId = getReferralId(referralCode);
201
+ return _getInstanceReader().getDiscountPercentage(referralId);
75
202
  }
76
203
 
77
204
 
205
+ function getReferralId(
206
+ string memory referralCode
207
+ )
208
+ public
209
+ view
210
+ returns (ReferralId referralId)
211
+ {
212
+ return ReferralLib.toReferralId(
213
+ getNftId(),
214
+ referralCode);
215
+ }
216
+
78
217
  function calculateRenewalFeeAmount(
79
218
  ReferralId referralId,
80
219
  uint256 netPremiumAmount
@@ -88,68 +227,58 @@ contract Distribution is
88
227
  return 0 * netPremiumAmount;
89
228
  }
90
229
 
91
- function processSale(
92
- ReferralId referralId,
93
- uint256 feeAmount
94
- )
95
- external
96
- onlyProductService
97
- virtual override
98
- {
99
- // default is no action
100
- }
101
-
102
230
  function processRenewal(
103
231
  ReferralId referralId,
104
232
  uint256 feeAmount
105
233
  )
106
234
  external
107
- onlyProductService
235
+ onlyOwner
236
+ restricted()
108
237
  virtual override
109
238
  {
110
239
  // default is no action
111
240
  }
112
241
 
113
- function referralIsValid(ReferralId referralId) external view returns (bool isValid) {
114
- // default is invalid
115
- return false;
116
- }
242
+ function getSetupInfo() public view returns (ISetup.DistributionSetupInfo memory setupInfo) {
243
+ InstanceReader reader = getInstance().getInstanceReader();
244
+ setupInfo = reader.getDistributionSetupInfo(getNftId());
117
245
 
118
- /// @dev default distribution fee, ie when not using any valid referralId
119
- function getDistributionFee() public view returns (Fee memory distributionFee) {
120
- NftId productNftId = _instance.getProductNftId(getNftId());
121
- if (_instance.hasTreasuryInfo(productNftId)) {
122
- return _instance.getTreasuryInfo(productNftId).distributionFee;
123
- } else {
124
- return _initialDistributionFee;
246
+ // fallback to initial setup info (wallet is always != address(0))
247
+ if(setupInfo.wallet == address(0)) {
248
+ setupInfo = _getInitialSetupInfo();
125
249
  }
126
250
  }
127
251
 
252
+ function _getInitialSetupInfo() internal view returns (ISetup.DistributionSetupInfo memory setupInfo) {
253
+ DistributionStorage storage $ = _getDistributionStorage();
254
+ return ISetup.DistributionSetupInfo(
255
+ zeroNftId(),
256
+ $._tokenHandler,
257
+ $._minDistributionOwnerFee,
258
+ $._distributionFee,
259
+ address(this),
260
+ 0
261
+ );
262
+ }
263
+
264
+
265
+ function _nftTransferFrom(address from, address to, uint256 tokenId) internal virtual override {
266
+ // keep track of distributor nft owner
267
+ emit LogDistributorUpdated(to, msg.sender);
268
+ DistributionStorage storage $ = _getDistributionStorage();
269
+ $._distributorNftId[from] = zeroNftId();
270
+ $._distributorNftId[to] = toNftId(tokenId);
271
+ }
272
+
128
273
 
129
274
  /// @dev returns true iff the component needs to be called when selling/renewing policis
130
275
  function isVerifying() external view returns (bool verifying) {
131
- return _isVerifying;
276
+ return true;
132
277
  }
133
278
 
134
- // from IRegisterable
135
-
136
- function getInitialInfo()
137
- public
138
- view
139
- override (IRegisterable, Registerable)
140
- returns(IRegistry.ObjectInfo memory, bytes memory)
141
- {
142
- (
143
- IRegistry.ObjectInfo memory info,
144
- bytes memory data
145
- ) = super.getInitialInfo();
146
-
147
- return (
148
- info,
149
- abi.encode(
150
- _initialDistributionFee,
151
- _isVerifying
152
- )
153
- );
279
+ function _getDistributionStorage() private pure returns (DistributionStorage storage $) {
280
+ assembly {
281
+ $.slot := DISTRIBUTION_STORAGE_LOCATION_V1
282
+ }
154
283
  }
155
284
  }
@@ -0,0 +1,76 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
5
+ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
6
+
7
+ import {IComponents} from "../instance/module/IComponents.sol";
8
+ import {IInstance} from "../instance/IInstance.sol";
9
+ import {IInstanceService} from "../instance/IInstanceService.sol";
10
+ import {IProductService} from "../instance/service/IProductService.sol";
11
+ import {IRegisterable} from "../shared/IRegisterable.sol";
12
+ import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
13
+ import {NftId} from "../types/NftId.sol";
14
+ import {ObjectType} from "../types/ObjectType.sol";
15
+
16
+ /// @dev component base class
17
+ /// component examples are product, distribution, pool and oracle
18
+ interface IComponent is
19
+ IRegisterable,
20
+ ITransferInterceptor,
21
+ IAccessManaged
22
+ {
23
+ error ErrorComponentNotChainNft(address caller);
24
+ error ErrorComponentNotProductService(address caller);
25
+ error ErrorComponentNotInstance(NftId instanceNftId);
26
+ error ErrorComponentProductNftAlreadySet();
27
+
28
+ error ErrorComponentWalletAddressZero();
29
+ error ErrorComponentWalletAddressIsSameAsCurrent();
30
+ error ErrorComponentWalletAllowanceTooSmall(address oldWallet, address newWallet, uint256 allowance, uint256 balance);
31
+
32
+ event LogComponentWalletAddressChanged(address oldWallet, address newWallet);
33
+ event LogComponentWalletTokensTransferred(address from, address to, uint256 amount);
34
+
35
+ /// @dev locks component to disable functions that may change state related to this component, the only exception is function "unlock"
36
+ /// only component owner (nft holder) is authorizes to call this function
37
+ function lock() external;
38
+
39
+ /// @dev unlocks component to (re-)enable functions that may change state related to this component
40
+ /// only component owner (nft holder) is authorizes to call this function
41
+ function unlock() external;
42
+
43
+ /// @dev sets the wallet address for the component
44
+ /// if the current wallet has tokens, these will be transferred
45
+ /// if the new wallet address is externally owned, an approval from the
46
+ /// owner of the external wallet for the component to move all tokens must exist
47
+ function setWallet(address walletAddress) external;
48
+
49
+ /// @dev only product service may set product nft id during registration of product setup
50
+ function setProductNftId(NftId productNftId) external;
51
+
52
+ /// @dev returns the name of this component
53
+ /// to successfully register the component with an instance the name MUST be unique in the linked instance
54
+ function getName() external view returns (string memory name);
55
+
56
+ /// @dev defines which ERC20 token is used by this component
57
+ function getToken() external view returns (IERC20Metadata token);
58
+
59
+ /// @dev defines the instance to which this component is linked to
60
+ function getInstance() external view returns (IInstance instance);
61
+
62
+ /// @dev defines the wallet address used to hold the ERC20 tokens related to this component
63
+ /// the default address is the component token address
64
+ function getWallet() external view returns (address walletAddress);
65
+
66
+ /// @dev defines the product to which this component is linked to
67
+ /// this is only relevant for pool and distribution components
68
+ function getProductNftId() external view returns (NftId productNftId);
69
+
70
+ function isNftInterceptor() external view returns(bool isInterceptor);
71
+
72
+ /// @dev returns component infos for this pool
73
+ /// when registered with an instance the info is obtained from the data stored in the instance
74
+ /// when not registered the function returns the info from the component contract
75
+ function getComponentInfo() external view returns (IComponents.ComponentInfo memory info);
76
+ }