@etherisc/gif-next 0.0.2-e9148e0-933 → 0.0.2-e922e07-736

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 (352) hide show
  1. package/README.md +136 -2
  2. package/artifacts/contracts/components/Component.sol/Component.dbg.json +4 -0
  3. package/artifacts/contracts/components/Component.sol/Component.json +774 -0
  4. package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json +1 -1
  5. package/artifacts/contracts/components/Distribution.sol/Distribution.json +879 -236
  6. package/artifacts/contracts/components/IComponent.sol/IComponent.dbg.json +4 -0
  7. package/artifacts/contracts/{shared/RegisterableUpgradable.sol/RegisterableUpgradable.json → components/IComponent.sol/IComponent.json} +164 -159
  8. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.dbg.json +1 -1
  9. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.json +689 -30
  10. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.dbg.json +1 -1
  11. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.json +838 -58
  12. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.dbg.json +1 -1
  13. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.json +524 -9
  14. package/artifacts/contracts/components/Pool.sol/Pool.dbg.json +1 -1
  15. package/artifacts/contracts/components/Pool.sol/Pool.json +950 -281
  16. package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
  17. package/artifacts/contracts/components/Product.sol/Product.json +568 -188
  18. package/artifacts/contracts/instance/BundleManager.sol/BundleManager.dbg.json +4 -0
  19. package/artifacts/contracts/instance/BundleManager.sol/BundleManager.json +764 -0
  20. package/artifacts/contracts/instance/Cloneable.sol/Cloneable.dbg.json +4 -0
  21. package/artifacts/contracts/instance/{AccessManagedSimple.sol/AccessManagedSimple.json → Cloneable.sol/Cloneable.json} +86 -2
  22. package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
  23. package/artifacts/contracts/instance/IInstance.sol/IInstance.json +1912 -421
  24. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.dbg.json +1 -1
  25. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.json +194 -165
  26. package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
  27. package/artifacts/contracts/instance/Instance.sol/Instance.json +901 -1127
  28. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.dbg.json +1 -1
  29. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.json +211 -144
  30. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.dbg.json +1 -1
  31. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.json +126 -159
  32. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.dbg.json +1 -1
  33. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.json +420 -305
  34. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.dbg.json +1 -1
  35. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.json +297 -112
  36. package/artifacts/contracts/instance/ObjectManager.sol/ObjectManager.dbg.json +4 -0
  37. package/artifacts/contracts/instance/ObjectManager.sol/ObjectManager.json +261 -0
  38. package/artifacts/contracts/instance/base/ComponentService.sol/ComponentService.dbg.json +4 -0
  39. package/artifacts/contracts/instance/base/{ComponentServiceBase.sol/ComponentServiceBase.json → ComponentService.sol/ComponentService.json} +189 -177
  40. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.dbg.json +1 -1
  41. package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.dbg.json +1 -1
  42. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.dbg.json +1 -1
  43. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.json +2 -2
  44. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.dbg.json +1 -1
  45. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.json +2 -2
  46. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.dbg.json +1 -1
  47. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.json +59 -16
  48. package/artifacts/contracts/instance/module/IBundle.sol/IBundle.dbg.json +1 -1
  49. package/artifacts/contracts/instance/module/IDistribution.sol/IDistribution.dbg.json +1 -1
  50. package/artifacts/contracts/instance/module/IPolicy.sol/IPolicy.dbg.json +1 -1
  51. package/artifacts/contracts/instance/module/IRisk.sol/IRisk.dbg.json +1 -1
  52. package/artifacts/contracts/instance/module/ISetup.sol/ISetup.dbg.json +1 -1
  53. package/artifacts/contracts/instance/module/ITreasury.sol/ITreasury.dbg.json +1 -1
  54. package/artifacts/contracts/instance/service/ApplicationService.sol/ApplicationService.dbg.json +4 -0
  55. package/artifacts/contracts/instance/service/ApplicationService.sol/ApplicationService.json +968 -0
  56. package/artifacts/contracts/instance/service/ApplicationServiceManager.sol/ApplicationServiceManager.dbg.json +4 -0
  57. package/artifacts/contracts/instance/service/ApplicationServiceManager.sol/ApplicationServiceManager.json +665 -0
  58. package/artifacts/contracts/instance/service/BundleService.sol/BundleService.dbg.json +4 -0
  59. package/artifacts/contracts/instance/service/BundleService.sol/BundleService.json +1096 -0
  60. package/artifacts/contracts/instance/service/BundleServiceManager.sol/BundleServiceManager.dbg.json +4 -0
  61. package/artifacts/contracts/instance/service/BundleServiceManager.sol/BundleServiceManager.json +661 -0
  62. package/artifacts/contracts/instance/service/ClaimService.sol/ClaimService.dbg.json +4 -0
  63. package/artifacts/contracts/instance/service/ClaimService.sol/ClaimService.json +754 -0
  64. package/artifacts/contracts/instance/service/ClaimServiceManager.sol/ClaimServiceManager.dbg.json +4 -0
  65. package/artifacts/contracts/instance/service/ClaimServiceManager.sol/ClaimServiceManager.json +637 -0
  66. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.dbg.json +1 -1
  67. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.json +1221 -213
  68. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.dbg.json +1 -1
  69. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.json +436 -79
  70. package/artifacts/contracts/instance/service/IApplicationService.sol/IApplicationService.dbg.json +4 -0
  71. package/artifacts/contracts/instance/service/IApplicationService.sol/IApplicationService.json +556 -0
  72. package/artifacts/contracts/instance/service/IBundleService.sol/IBundleService.dbg.json +4 -0
  73. package/artifacts/contracts/instance/service/IBundleService.sol/IBundleService.json +633 -0
  74. package/artifacts/contracts/instance/service/IClaimService.sol/IClaimService.dbg.json +4 -0
  75. package/artifacts/contracts/instance/service/{IComponentOwnerService.sol/IComponentOwnerService.json → IClaimService.sol/IClaimService.json} +150 -207
  76. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.dbg.json +1 -1
  77. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.json +727 -160
  78. package/artifacts/contracts/instance/service/IPolicyService.sol/IPolicyService.dbg.json +4 -0
  79. package/artifacts/contracts/instance/service/IPolicyService.sol/IPolicyService.json +540 -0
  80. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +1 -1
  81. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +37 -251
  82. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +1 -1
  83. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +47 -414
  84. package/artifacts/contracts/instance/service/PolicyService.sol/PolicyService.dbg.json +4 -0
  85. package/artifacts/contracts/instance/service/PolicyService.sol/PolicyService.json +1021 -0
  86. package/artifacts/contracts/instance/service/PolicyServiceManager.sol/PolicyServiceManager.dbg.json +4 -0
  87. package/artifacts/contracts/instance/service/PolicyServiceManager.sol/PolicyServiceManager.json +689 -0
  88. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.dbg.json +1 -1
  89. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.json +209 -321
  90. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.dbg.json +1 -1
  91. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.json +296 -95
  92. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.dbg.json +1 -1
  93. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.json +218 -499
  94. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.dbg.json +1 -1
  95. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.json +299 -98
  96. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
  97. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.json +2 -2
  98. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
  99. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.json +242 -131
  100. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.dbg.json +1 -1
  101. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.json +158 -215
  102. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.dbg.json +1 -1
  103. package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
  104. package/artifacts/contracts/registry/Registry.sol/Registry.json +256 -226
  105. package/artifacts/contracts/registry/RegistryAccessManager.sol/RegistryAccessManager.dbg.json +4 -0
  106. package/artifacts/contracts/registry/RegistryAccessManager.sol/RegistryAccessManager.json +285 -0
  107. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.dbg.json +1 -1
  108. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.json +202 -318
  109. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.dbg.json +1 -1
  110. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.json +298 -141
  111. package/artifacts/contracts/registry/ReleaseManager.sol/ReleaseManager.dbg.json +4 -0
  112. package/artifacts/contracts/registry/ReleaseManager.sol/ReleaseManager.json +547 -0
  113. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.dbg.json +1 -1
  114. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.json +141 -53
  115. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.dbg.json +1 -1
  116. package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json +1 -1
  117. package/artifacts/contracts/shared/ERC165.sol/ERC165.json +41 -3
  118. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.dbg.json +1 -1
  119. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.json +40 -29
  120. package/artifacts/contracts/shared/IPolicyHolder.sol/IPolicyHolder.dbg.json +4 -0
  121. package/artifacts/contracts/shared/IPolicyHolder.sol/IPolicyHolder.json +129 -0
  122. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +1 -1
  123. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.json +21 -34
  124. package/artifacts/contracts/shared/IRegistryLinked.sol/IRegistryLinked.dbg.json +4 -0
  125. package/artifacts/contracts/{experiment/inheritance/IB.sol/IB.json → shared/IRegistryLinked.sol/IRegistryLinked.json} +18 -20
  126. package/artifacts/contracts/shared/IService.sol/IService.dbg.json +1 -1
  127. package/artifacts/contracts/shared/IService.sol/IService.json +31 -183
  128. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.dbg.json +1 -1
  129. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json +2 -152
  130. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.dbg.json +1 -1
  131. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.json +120 -27
  132. package/artifacts/contracts/shared/PolicyHolder.sol/PolicyHolder.dbg.json +4 -0
  133. package/artifacts/contracts/shared/PolicyHolder.sol/PolicyHolder.json +248 -0
  134. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.dbg.json +1 -1
  135. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.json +294 -61
  136. package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +1 -1
  137. package/artifacts/contracts/shared/Registerable.sol/Registerable.json +129 -51
  138. package/artifacts/contracts/shared/RegistryLinked.sol/RegistryLinked.dbg.json +4 -0
  139. package/artifacts/contracts/shared/RegistryLinked.sol/RegistryLinked.json +84 -0
  140. package/artifacts/contracts/shared/Service.sol/Service.dbg.json +1 -1
  141. package/artifacts/contracts/shared/Service.sol/Service.json +127 -170
  142. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.dbg.json +1 -1
  143. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.dbg.json +1 -1
  144. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.json +2 -2
  145. package/artifacts/contracts/shared/Versionable.sol/Versionable.dbg.json +1 -1
  146. package/artifacts/contracts/shared/Versionable.sol/Versionable.json +2 -152
  147. package/artifacts/contracts/test/TestFee.sol/TestFee.dbg.json +1 -1
  148. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.dbg.json +1 -1
  149. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.json +129 -51
  150. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.dbg.json +1 -1
  151. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.json +2 -2
  152. package/artifacts/contracts/test/TestService.sol/TestService.dbg.json +1 -1
  153. package/artifacts/contracts/test/TestService.sol/TestService.json +148 -227
  154. package/artifacts/contracts/test/TestToken.sol/TestUsdc.dbg.json +1 -1
  155. package/artifacts/contracts/test/TestVersion.sol/TestVersion.dbg.json +1 -1
  156. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.dbg.json +1 -1
  157. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.json +8 -190
  158. package/artifacts/contracts/test/Usdc.sol/USDC.dbg.json +1 -1
  159. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.dbg.json +1 -1
  160. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
  161. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.dbg.json +1 -1
  162. package/artifacts/contracts/types/ClaimId.sol/ClaimIdLib.dbg.json +4 -0
  163. package/artifacts/contracts/types/ClaimId.sol/ClaimIdLib.json +100 -0
  164. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.dbg.json +1 -1
  165. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.json +2 -2
  166. package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +1 -1
  167. package/artifacts/contracts/types/Key32.sol/Key32Lib.dbg.json +1 -1
  168. package/artifacts/contracts/types/Key32.sol/Key32Lib.json +2 -2
  169. package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
  170. package/artifacts/contracts/types/NftId.sol/NftIdLib.json +2 -2
  171. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +1 -1
  172. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +26 -3
  173. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.dbg.json +1 -1
  174. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +1 -1
  175. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +2 -2
  176. package/artifacts/contracts/types/PayoutId.sol/PayoutIdLib.dbg.json +4 -0
  177. package/artifacts/contracts/types/PayoutId.sol/PayoutIdLib.json +100 -0
  178. package/artifacts/contracts/types/Referral.sol/ReferralLib.dbg.json +1 -1
  179. package/artifacts/contracts/types/Referral.sol/ReferralLib.json +23 -4
  180. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.dbg.json +1 -1
  181. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.json +2 -2
  182. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.dbg.json +1 -1
  183. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.json +2 -2
  184. package/artifacts/contracts/types/Seconds.sol/SecondsLib.dbg.json +4 -0
  185. package/artifacts/contracts/types/Seconds.sol/SecondsLib.json +124 -0
  186. package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +1 -1
  187. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
  188. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.json +25 -7
  189. package/artifacts/contracts/types/UFixed.sol/MathLib.dbg.json +1 -1
  190. package/artifacts/contracts/types/UFixed.sol/UFixedLib.dbg.json +1 -1
  191. package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +1 -1
  192. package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +1 -1
  193. package/contracts/components/Component.sol +221 -0
  194. package/contracts/components/Distribution.sol +200 -79
  195. package/contracts/components/IComponent.sol +68 -0
  196. package/contracts/components/IDistributionComponent.sol +44 -17
  197. package/contracts/components/IPoolComponent.sol +126 -37
  198. package/contracts/components/IProductComponent.sol +10 -5
  199. package/contracts/components/Pool.sol +288 -152
  200. package/contracts/components/Product.sol +124 -119
  201. package/contracts/instance/BundleManager.sol +125 -0
  202. package/contracts/instance/Cloneable.sol +46 -0
  203. package/contracts/instance/IInstance.sol +56 -5
  204. package/contracts/instance/IInstanceService.sol +33 -4
  205. package/contracts/instance/Instance.sol +109 -261
  206. package/contracts/instance/InstanceAccessManager.sol +87 -78
  207. package/contracts/instance/InstanceReader.sol +12 -25
  208. package/contracts/instance/InstanceService.sol +401 -104
  209. package/contracts/instance/InstanceServiceManager.sol +6 -9
  210. package/contracts/instance/ObjectManager.sol +84 -0
  211. package/contracts/instance/base/ComponentService.sol +134 -0
  212. package/contracts/instance/module/IAccess.sol +27 -18
  213. package/contracts/instance/module/IBundle.sol +2 -1
  214. package/contracts/instance/module/IDistribution.sol +2 -0
  215. package/contracts/instance/module/IPolicy.sol +30 -3
  216. package/contracts/instance/module/ISetup.sol +12 -10
  217. package/contracts/instance/service/ApplicationService.sol +349 -0
  218. package/contracts/instance/service/ApplicationServiceManager.sol +35 -0
  219. package/contracts/instance/service/BundleService.sol +299 -0
  220. package/contracts/instance/service/BundleServiceManager.sol +51 -0
  221. package/contracts/instance/service/ClaimService.sol +151 -0
  222. package/contracts/instance/service/ClaimServiceManager.sol +35 -0
  223. package/contracts/instance/service/DistributionService.sol +390 -28
  224. package/contracts/instance/service/DistributionServiceManager.sol +7 -10
  225. package/contracts/instance/service/IApplicationService.sol +82 -0
  226. package/contracts/instance/service/IBundleService.sol +55 -0
  227. package/contracts/instance/service/IClaimService.sol +61 -0
  228. package/contracts/instance/service/IDistributionService.sol +86 -0
  229. package/contracts/instance/service/IPolicyService.sol +72 -0
  230. package/contracts/instance/service/IPoolService.sol +6 -23
  231. package/contracts/instance/service/IProductService.sol +6 -73
  232. package/contracts/instance/service/PolicyService.sol +394 -0
  233. package/contracts/instance/service/PolicyServiceManager.sol +54 -0
  234. package/contracts/instance/service/PoolService.sol +38 -123
  235. package/contracts/instance/service/PoolServiceManager.sol +6 -9
  236. package/contracts/instance/service/ProductService.sol +133 -448
  237. package/contracts/instance/service/ProductServiceManager.sol +2 -2
  238. package/contracts/registry/ChainNft.sol +1 -1
  239. package/contracts/registry/IRegistry.sol +39 -19
  240. package/contracts/registry/IRegistryService.sol +30 -13
  241. package/contracts/registry/Registry.sol +236 -216
  242. package/contracts/registry/RegistryAccessManager.sol +216 -0
  243. package/contracts/registry/RegistryService.sol +96 -171
  244. package/contracts/registry/RegistryServiceManager.sol +21 -39
  245. package/contracts/registry/ReleaseManager.sol +322 -0
  246. package/contracts/registry/TokenRegistry.sol +22 -17
  247. package/contracts/shared/ERC165.sol +14 -12
  248. package/contracts/shared/INftOwnable.sol +11 -10
  249. package/contracts/shared/IPolicyHolder.sol +26 -0
  250. package/contracts/shared/IRegisterable.sol +4 -6
  251. package/contracts/shared/IRegistryLinked.sol +12 -0
  252. package/contracts/shared/IService.sol +4 -1
  253. package/contracts/shared/IVersionable.sol +4 -47
  254. package/contracts/shared/NftOwnable.sol +66 -80
  255. package/contracts/shared/PolicyHolder.sol +81 -0
  256. package/contracts/shared/ProxyManager.sol +100 -25
  257. package/contracts/shared/Registerable.sol +16 -32
  258. package/contracts/shared/RegistryLinked.sol +48 -0
  259. package/contracts/shared/Service.sol +25 -22
  260. package/contracts/shared/Versionable.sol +4 -92
  261. package/contracts/test/TestRegisterable.sol +1 -1
  262. package/contracts/test/TestService.sol +4 -3
  263. package/contracts/types/ClaimId.sol +52 -0
  264. package/contracts/types/DistributorType.sol +2 -2
  265. package/contracts/types/NftIdSet.sol +26 -24
  266. package/contracts/types/ObjectType.sol +9 -5
  267. package/contracts/types/PayoutId.sol +54 -0
  268. package/contracts/types/Referral.sol +4 -0
  269. package/contracts/types/RoleId.sol +19 -14
  270. package/contracts/types/Seconds.sol +54 -0
  271. package/contracts/types/Timestamp.sol +12 -13
  272. package/package.json +3 -3
  273. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.dbg.json +0 -4
  274. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.json +0 -327
  275. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json +0 -4
  276. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.json +0 -280
  277. package/artifacts/contracts/experiment/cloning/Cloner.sol/Cloner.dbg.json +0 -4
  278. package/artifacts/contracts/experiment/cloning/Cloner.sol/Cloner.json +0 -66
  279. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock1.dbg.json +0 -4
  280. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock1.json +0 -24
  281. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock2.dbg.json +0 -4
  282. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock2.json +0 -42
  283. package/artifacts/contracts/experiment/errors/Require.sol/Require.dbg.json +0 -4
  284. package/artifacts/contracts/experiment/errors/Require.sol/Require.json +0 -105
  285. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.dbg.json +0 -4
  286. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.json +0 -105
  287. package/artifacts/contracts/experiment/inheritance/A.sol/A.dbg.json +0 -4
  288. package/artifacts/contracts/experiment/inheritance/A.sol/A.json +0 -128
  289. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.dbg.json +0 -4
  290. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.json +0 -42
  291. package/artifacts/contracts/experiment/inheritance/B.sol/B.dbg.json +0 -4
  292. package/artifacts/contracts/experiment/inheritance/B.sol/B.json +0 -76
  293. package/artifacts/contracts/experiment/inheritance/C.sol/C.dbg.json +0 -4
  294. package/artifacts/contracts/experiment/inheritance/C.sol/C.json +0 -89
  295. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.dbg.json +0 -4
  296. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.json +0 -128
  297. package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.dbg.json +0 -4
  298. package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.json +0 -37
  299. package/artifacts/contracts/experiment/inheritance/IB.sol/IB.dbg.json +0 -4
  300. package/artifacts/contracts/experiment/inheritance/IC.sol/IC.dbg.json +0 -4
  301. package/artifacts/contracts/experiment/inheritance/IC.sol/IC.json +0 -63
  302. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.dbg.json +0 -4
  303. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.json +0 -59
  304. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.dbg.json +0 -4
  305. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.json +0 -124
  306. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.dbg.json +0 -4
  307. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.json +0 -74
  308. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.dbg.json +0 -4
  309. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.json +0 -124
  310. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.dbg.json +0 -4
  311. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.json +0 -207
  312. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.dbg.json +0 -4
  313. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.json +0 -10
  314. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.dbg.json +0 -4
  315. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.json +0 -10
  316. package/artifacts/contracts/instance/AccessManagedSimple.sol/AccessManagedSimple.dbg.json +0 -4
  317. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.dbg.json +0 -4
  318. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.json +0 -1132
  319. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.dbg.json +0 -4
  320. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.json +0 -1082
  321. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +0 -4
  322. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.dbg.json +0 -4
  323. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.json +0 -113
  324. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.dbg.json +0 -4
  325. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.json +0 -827
  326. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.dbg.json +0 -4
  327. package/artifacts/contracts/shared/RegisterableUpgradable.sol/RegisterableUpgradable.dbg.json +0 -4
  328. package/contracts/components/BaseComponent.sol +0 -91
  329. package/contracts/components/IBaseComponent.sol +0 -25
  330. package/contracts/experiment/cloning/Cloner.sol +0 -47
  331. package/contracts/experiment/errors/Require.sol +0 -38
  332. package/contracts/experiment/errors/Revert.sol +0 -44
  333. package/contracts/experiment/inheritance/A.sol +0 -53
  334. package/contracts/experiment/inheritance/B.sol +0 -28
  335. package/contracts/experiment/inheritance/C.sol +0 -34
  336. package/contracts/experiment/inheritance/IA.sol +0 -13
  337. package/contracts/experiment/inheritance/IB.sol +0 -10
  338. package/contracts/experiment/inheritance/IC.sol +0 -12
  339. package/contracts/experiment/statemachine/Dummy.sol +0 -27
  340. package/contracts/experiment/statemachine/ISM.sol +0 -25
  341. package/contracts/experiment/statemachine/SM.sol +0 -57
  342. package/contracts/experiment/statemachine/SimpleStateMachine.sol +0 -31
  343. package/contracts/experiment/types/TypeA.sol +0 -47
  344. package/contracts/experiment/types/TypeB.sol +0 -29
  345. package/contracts/instance/AccessManagedSimple.sol +0 -115
  346. package/contracts/instance/AccessManagerSimple.sol +0 -692
  347. package/contracts/instance/IAccessManagerSimple.sol +0 -391
  348. package/contracts/instance/base/ComponentServiceBase.sol +0 -124
  349. package/contracts/instance/base/IInstanceBase.sol +0 -23
  350. package/contracts/instance/service/ComponentOwnerService.sol +0 -317
  351. package/contracts/instance/service/IComponentOwnerService.sol +0 -20
  352. package/contracts/shared/RegisterableUpgradable.sol +0 -16
@@ -0,0 +1,221 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
5
+ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
6
+ import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
7
+
8
+ import {IComponent} from "./IComponent.sol";
9
+ import {IProductService} from "../instance/service/IProductService.sol";
10
+ import {IInstanceService} from "../instance/IInstanceService.sol";
11
+ import {IInstance} from "../instance/IInstance.sol";
12
+ import {InstanceAccessManager} from "../instance/InstanceAccessManager.sol";
13
+ import {InstanceReader} from "../instance/InstanceReader.sol";
14
+ import {IRegistry} from "../registry/IRegistry.sol";
15
+ import {NftId} from "../types/NftId.sol";
16
+ import {ObjectType, INSTANCE, PRODUCT} from "../types/ObjectType.sol";
17
+ import {VersionPart} from "../types/Version.sol";
18
+ import {Registerable} from "../shared/Registerable.sol";
19
+ import {RoleId, RoleIdLib} from "../types/RoleId.sol";
20
+ import {IAccess} from "../instance/module/IAccess.sol";
21
+ import {VersionPart} from "../types/Version.sol";
22
+
23
+ // TODO discuss to inherit from oz accessmanaged
24
+ // then add (Distribution|Pool|Product)Upradeable that also intherit from Versionable
25
+ // same pattern as for Service which is also upgradeable
26
+ abstract contract Component is
27
+ Registerable,
28
+ IComponent,
29
+ AccessManagedUpgradeable
30
+ {
31
+ // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.component.Component.sol")) - 1)) & ~bytes32(uint256(0xff));
32
+ bytes32 public constant COMPONENT_LOCATION_V1 = 0xffe8d4462baed26a47154f4b8f6db497d2f772496965791d25bd456e342b7f00;
33
+
34
+ struct ComponentStorage {
35
+ string _name; // unique (per instance) component name
36
+ IERC20Metadata _token; // token for this component
37
+ IInstance _instance; // instance for this component
38
+ address _wallet; // wallet for this component (default = component contract itself)
39
+ InstanceReader _instanceReader; // instance reader for this component
40
+ bool _isNftInterceptor; // declares if component is involved in nft transfers
41
+ NftId _productNftId; // only relevant for components that are linked to a aproduct
42
+ }
43
+
44
+ function _getComponentStorage() private pure returns (ComponentStorage storage $) {
45
+ assembly {
46
+ $.slot := COMPONENT_LOCATION_V1
47
+ }
48
+ }
49
+
50
+ function initializeComponent(
51
+ address registry,
52
+ NftId instanceNftId,
53
+ string memory name,
54
+ address token,
55
+ ObjectType componentType,
56
+ bool isInterceptor,
57
+ address initialOwner,
58
+ bytes memory registryData // writeonly data that will saved in the object info record of the registry
59
+ )
60
+ public
61
+ virtual
62
+ onlyInitializing()
63
+ {
64
+ initializeRegisterable(registry, instanceNftId, componentType, isInterceptor, initialOwner, registryData);
65
+
66
+ // set and check linked instance
67
+ ComponentStorage storage $ = _getComponentStorage();
68
+ $._instance = IInstance(
69
+ getRegistry().getObjectInfo(instanceNftId).objectAddress);
70
+
71
+ if(!$._instance.supportsInterface(type(IInstance).interfaceId)) {
72
+ revert ErrorComponentNotInstance(instanceNftId);
73
+ }
74
+
75
+ // initialize AccessManagedUpgradeable
76
+ __AccessManaged_init($._instance.authority());
77
+
78
+ // set component state
79
+ $._name = name;
80
+ $._isNftInterceptor = isInterceptor;
81
+ $._instanceReader = $._instance.getInstanceReader();
82
+ $._wallet = address(this);
83
+ $._token = IERC20Metadata(token);
84
+
85
+ registerInterface(type(IComponent).interfaceId);
86
+ }
87
+
88
+ function lock() external onlyOwner override {
89
+ IInstanceService(_getServiceAddress(INSTANCE())).setTargetLocked(getName(), true);
90
+ }
91
+
92
+ function unlock() external onlyOwner override {
93
+ IInstanceService(_getServiceAddress(INSTANCE())).setTargetLocked(getName(), false);
94
+ }
95
+
96
+ function setWallet(address newWallet)
97
+ external
98
+ override
99
+ onlyOwner
100
+ {
101
+ ComponentStorage storage $ = _getComponentStorage();
102
+
103
+ address currentWallet = $._wallet;
104
+ uint256 currentBalance = $._token.balanceOf(currentWallet);
105
+
106
+ // checks
107
+ if (newWallet == address(0)) {
108
+ revert ErrorComponentWalletAddressZero();
109
+ }
110
+
111
+ if (newWallet == currentWallet) {
112
+ revert ErrorComponentWalletAddressIsSameAsCurrent();
113
+ }
114
+
115
+ if (currentBalance > 0) {
116
+ if (currentWallet == address(this)) {
117
+ // move tokens from component smart contract to external wallet
118
+ } else {
119
+ // move tokens from external wallet to component smart contract or another external wallet
120
+ uint256 allowance = $._token.allowance(currentWallet, address(this));
121
+ if (allowance < currentBalance) {
122
+ revert ErrorComponentWalletAllowanceTooSmall(currentWallet, newWallet, allowance, currentBalance);
123
+ }
124
+ }
125
+ }
126
+
127
+ // effects
128
+ $._wallet = newWallet;
129
+ emit LogComponentWalletAddressChanged(currentWallet, newWallet);
130
+
131
+ // interactions
132
+ if (currentBalance > 0) {
133
+ // transfer tokens from current wallet to new wallet
134
+ if (currentWallet == address(this)) {
135
+ // transferFrom requires self allowance too
136
+ $._token.approve(address(this), currentBalance);
137
+ }
138
+
139
+ SafeERC20.safeTransferFrom($._token, currentWallet, newWallet, currentBalance);
140
+ emit LogComponentWalletTokensTransferred(currentWallet, newWallet, currentBalance);
141
+ }
142
+ }
143
+
144
+ function setProductNftId(NftId productNftId)
145
+ external
146
+ override
147
+ {
148
+ ComponentStorage storage $ = _getComponentStorage();
149
+
150
+ // verify caller is product service
151
+ if(msg.sender != _getServiceAddress(PRODUCT())) {
152
+ revert ErrorComponentNotProductService(msg.sender);
153
+ }
154
+
155
+ // verify component is not yet linked to a product
156
+ if($._productNftId.gtz()) {
157
+ revert ErrorComponentProductNftAlreadySet();
158
+ }
159
+
160
+ $._productNftId = productNftId;
161
+ }
162
+
163
+ /// @dev callback function for nft transfers
164
+ /// may only be called by chain nft contract.
165
+ /// do not override this function to implement business logic for handling transfers
166
+ /// override internal function _nftTransferFrom instead
167
+ function nftTransferFrom(address from, address to, uint256 tokenId)
168
+ external
169
+ virtual override
170
+ {
171
+ if(msg.sender != getRegistry().getChainNftAddress()) {
172
+ revert ErrorComponentNotChainNft(msg.sender);
173
+ }
174
+
175
+ _nftTransferFrom(from, to, tokenId);
176
+ }
177
+
178
+ function getWallet() public view override returns (address walletAddress)
179
+ {
180
+ return _getComponentStorage()._wallet;
181
+ }
182
+
183
+ function getToken() public view override returns (IERC20Metadata token) {
184
+ return _getComponentStorage()._token;
185
+ }
186
+
187
+ function isNftInterceptor() public view override returns(bool isInterceptor) {
188
+ return _getComponentStorage()._isNftInterceptor;
189
+ }
190
+
191
+ function getInstance() public view override returns (IInstance instance) {
192
+ return _getComponentStorage()._instance;
193
+ }
194
+
195
+ function getName() public view override returns(string memory name) {
196
+ return _getComponentStorage()._name;
197
+ }
198
+
199
+ function getProductNftId() public view override returns (NftId productNftId) {
200
+ return _getComponentStorage()._productNftId;
201
+ }
202
+
203
+ /// @dev internal function for nft transfers.
204
+ /// handling logic that deals with nft transfers need to overwrite this function
205
+ function _nftTransferFrom(address from, address to, uint256 tokenId)
206
+ internal
207
+ virtual
208
+ { }
209
+
210
+ /// @dev returns reader for linked instance
211
+ function _getInstanceReader() internal view returns (InstanceReader reader) {
212
+ return _getComponentStorage()._instanceReader;
213
+ }
214
+
215
+ /// @dev returns the service address for the specified domain
216
+ /// gets address via lookup from registry using the major version form the linked instance
217
+ function _getServiceAddress(ObjectType domain) internal view returns (address service) {
218
+ VersionPart majorVersion = _getComponentStorage()._instance.getMajorVersion();
219
+ return getRegistry().getServiceAddress(domain, majorVersion);
220
+ }
221
+ }
@@ -4,10 +4,11 @@ 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, zeroNftId, NftIdLib} from "../types/NftId.sol";
8
- import {ReferralId} from "../types/Referral.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,71 +16,200 @@ import {ISetup} from "../instance/module/ISetup.sol";
15
16
  import {Registerable} from "../shared/Registerable.sol";
16
17
  import {TokenHandler} from "../shared/TokenHandler.sol";
17
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";
18
23
 
19
- contract Distribution is
20
- BaseComponent,
24
+
25
+ abstract contract Distribution is
26
+ Component,
21
27
  IDistributionComponent
22
28
  {
23
- using NftIdLib for NftId;
24
-
25
- Fee internal _initialDistributionFee;
26
- bool internal _isVerifying;
29
+ // keccak256(abi.encode(uint256(keccak256("etherisc.storage.Distribution")) - 1)) & ~bytes32(uint256(0xff));
30
+ bytes32 public constant DISTRIBUTION_STORAGE_LOCATION_V1 = 0xaab7c5ea03d290056d6c060e0833d3ebcbe647f7694616a2ec52738a64b2f900;
27
31
 
28
- IDistributionService private _distributionService;
29
- IProductService private _productService;
30
-
31
- modifier onlyProductService() {
32
- require(
33
- msg.sender == address(_productService),
34
- "ERROR:POL-002:NOT_PRODUCT_SERVICE");
35
- _;
32
+ struct DistributionStorage {
33
+ Fee _minDistributionOwnerFee;
34
+ Fee _distributionFee;
35
+ TokenHandler _tokenHandler;
36
+ IDistributionService _distributionService;
37
+ mapping(address distributor => NftId distributorNftId) _distributorNftId;
36
38
  }
37
39
 
38
- constructor(
40
+ function initializeDistribution(
39
41
  address registry,
40
42
  NftId instanceNftId,
41
- // TODO refactor into tokenNftId
43
+ string memory name,
42
44
  address token,
43
- bool verifying,
45
+ Fee memory minDistributionOwnerFee,
44
46
  Fee memory distributionFee,
45
- address initialOwner
47
+ address initialOwner,
48
+ bytes memory registryData // writeonly data that will saved in the object info record of the registry
46
49
  )
47
- BaseComponent(registry, instanceNftId, token, DISTRIBUTION(), true, initialOwner)
50
+ public
51
+ virtual
52
+ onlyInitializing()
48
53
  {
49
- _isVerifying = verifying;
50
- _initialDistributionFee = distributionFee;
54
+ initializeComponent(registry, instanceNftId, name, token, DISTRIBUTION(), true, initialOwner, registryData);
51
55
 
52
- _distributionService = _instance.getDistributionService();
53
- _productService = _instance.getProductService();
56
+ DistributionStorage storage $ = _getDistributionStorage();
57
+ // TODO add validation
58
+ $._minDistributionOwnerFee = minDistributionOwnerFee;
59
+ $._distributionFee = distributionFee;
60
+ $._tokenHandler = new TokenHandler(token);
61
+ $._distributionService = getInstance().getDistributionService();
54
62
 
55
- _registerInterface(type(IDistributionComponent).interfaceId);
63
+ registerInterface(type(IDistributionComponent).interfaceId);
56
64
  }
57
65
 
58
-
59
66
  function setFees(
67
+ Fee memory minDistributionOwnerFee,
60
68
  Fee memory distributionFee
61
69
  )
62
70
  external
63
71
  override
72
+ onlyOwner
73
+ restricted()
64
74
  {
65
- _distributionService.setFees(distributionFee);
75
+ _getDistributionStorage()._distributionService.setFees(minDistributionOwnerFee, distributionFee);
66
76
  }
67
77
 
68
- function calculateFeeAmount(
69
- ReferralId referralId,
70
- uint256 netPremiumAmount
78
+ function getDistributionFee() external view returns (Fee memory distributionFee) {
79
+ DistributionStorage storage $ = _getDistributionStorage();
80
+ return $._distributionFee;
81
+ }
82
+
83
+ function createDistributorType(
84
+ string memory name,
85
+ UFixed minDiscountPercentage,
86
+ UFixed maxDiscountPercentage,
87
+ UFixed commissionPercentage,
88
+ uint32 maxReferralCount,
89
+ uint32 maxReferralLifetime,
90
+ bool allowSelfReferrals,
91
+ bool allowRenewals,
92
+ bytes memory data
71
93
  )
94
+ public
95
+ returns (DistributorType distributorType)
96
+ {
97
+ DistributionStorage storage $ = _getDistributionStorage();
98
+ distributorType = $._distributionService.createDistributorType(
99
+ name,
100
+ minDiscountPercentage,
101
+ maxDiscountPercentage,
102
+ commissionPercentage,
103
+ maxReferralCount,
104
+ maxReferralLifetime,
105
+ allowSelfReferrals,
106
+ allowRenewals,
107
+ data);
108
+ }
109
+
110
+ function createDistributor(
111
+ address distributor,
112
+ DistributorType distributorType,
113
+ bytes memory data
114
+ )
115
+ public
116
+ returns(NftId distributorNftId)
117
+ {
118
+ DistributionStorage storage $ = _getDistributionStorage();
119
+ require($._distributorNftId[distributor].eqz(), "ERROR:DST-030:ALREADY_DISTRIBUTOR");
120
+
121
+ distributorNftId = $._distributionService.createDistributor(
122
+ distributor,
123
+ distributorType,
124
+ data);
125
+
126
+ $._distributorNftId[distributor] = distributorNftId;
127
+ }
128
+
129
+ function updateDistributorType(
130
+ NftId distributorNftId,
131
+ DistributorType distributorType,
132
+ bytes memory data
133
+ )
134
+ public
135
+ // TODO figure out what we need for authz
136
+ // and add it
137
+ {
138
+ DistributionStorage storage $ = _getDistributionStorage();
139
+ $._distributionService.updateDistributorType(
140
+ distributorNftId,
141
+ distributorType,
142
+ data);
143
+ }
144
+
145
+ /**
146
+ * @dev lets distributors create referral codes.
147
+ * referral codes need to be unique
148
+ */
149
+ function _createReferral(
150
+ NftId distributorNftId,
151
+ string memory code,
152
+ UFixed discountPercentage,
153
+ uint32 maxReferrals,
154
+ Timestamp expiryAt,
155
+ bytes memory data
156
+ )
157
+ internal
158
+ returns (ReferralId referralId)
159
+ {
160
+ DistributionStorage storage $ = _getDistributionStorage();
161
+ referralId = $._distributionService.createReferral(
162
+ distributorNftId,
163
+ code,
164
+ discountPercentage,
165
+ maxReferrals,
166
+ expiryAt,
167
+ data);
168
+ }
169
+
170
+ function isDistributor(address candidate)
171
+ public
172
+ view
173
+ returns (bool)
174
+ {
175
+ DistributionStorage storage $ = _getDistributionStorage();
176
+ return $._distributorNftId[candidate].gtz();
177
+ }
178
+
179
+ function getDistributorNftId(address distributor)
180
+ public
181
+ view
182
+ returns (NftId distributorNftId)
183
+ {
184
+ DistributionStorage storage $ = _getDistributionStorage();
185
+ return $._distributorNftId[distributor];
186
+ }
187
+
188
+ function getDiscountPercentage(string memory referralCode)
72
189
  external
73
190
  view
74
- virtual override
75
- returns (uint256 feeAmount)
191
+ returns (
192
+ UFixed discountPercentage,
193
+ ReferralStatus status
194
+ )
76
195
  {
77
- ISetup.DistributionSetupInfo memory setupInfo = getSetupInfo();
78
- Fee memory fee = setupInfo.distributionFee;
79
- (feeAmount,) = FeeLib.calculateFee(fee, netPremiumAmount);
196
+ ReferralId referralId = getReferralId(referralCode);
197
+ return _getInstanceReader().getDiscountPercentage(referralId);
80
198
  }
81
199
 
82
200
 
201
+ function getReferralId(
202
+ string memory referralCode
203
+ )
204
+ public
205
+ view
206
+ returns (ReferralId referralId)
207
+ {
208
+ return ReferralLib.toReferralId(
209
+ getNftId(),
210
+ referralCode);
211
+ }
212
+
83
213
  function calculateRenewalFeeAmount(
84
214
  ReferralId referralId,
85
215
  uint256 netPremiumAmount
@@ -93,67 +223,58 @@ contract Distribution is
93
223
  return 0 * netPremiumAmount;
94
224
  }
95
225
 
96
- function processSale(
226
+ function processRenewal(
97
227
  ReferralId referralId,
98
228
  uint256 feeAmount
99
229
  )
100
230
  external
101
- onlyProductService
231
+ onlyOwner
232
+ restricted()
102
233
  virtual override
103
234
  {
104
235
  // default is no action
105
236
  }
106
237
 
107
- function processRenewal(
108
- ReferralId referralId,
109
- uint256 feeAmount
110
- )
111
- external
112
- onlyProductService
113
- virtual override
114
- {
115
- // default is no action
238
+ function getSetupInfo() public view returns (ISetup.DistributionSetupInfo memory setupInfo) {
239
+ InstanceReader reader = getInstance().getInstanceReader();
240
+ setupInfo = reader.getDistributionSetupInfo(getNftId());
241
+
242
+ // fallback to initial setup info (wallet is always != address(0))
243
+ if(setupInfo.wallet == address(0)) {
244
+ setupInfo = _getInitialSetupInfo();
245
+ }
116
246
  }
117
247
 
118
- function referralIsValid(ReferralId referralId) external view returns (bool isValid) {
119
- // default is invalid
120
- return false;
248
+ function _getInitialSetupInfo() internal view returns (ISetup.DistributionSetupInfo memory setupInfo) {
249
+ DistributionStorage storage $ = _getDistributionStorage();
250
+ return ISetup.DistributionSetupInfo(
251
+ zeroNftId(),
252
+ $._tokenHandler,
253
+ $._minDistributionOwnerFee,
254
+ $._distributionFee,
255
+ address(this),
256
+ 0
257
+ );
121
258
  }
122
259
 
123
- function getSetupInfo() public view returns (ISetup.DistributionSetupInfo memory setupInfo) {
124
- InstanceReader reader = _instance.getInstanceReader();
125
- return reader.getDistributionSetupInfo(getNftId());
260
+
261
+ function _nftTransferFrom(address from, address to, uint256 tokenId) internal virtual override {
262
+ // keep track of distributor nft owner
263
+ emit LogDistributorUpdated(to, msg.sender);
264
+ DistributionStorage storage $ = _getDistributionStorage();
265
+ $._distributorNftId[from] = zeroNftId();
266
+ $._distributorNftId[to] = toNftId(tokenId);
126
267
  }
127
268
 
128
269
 
129
270
  /// @dev returns true iff the component needs to be called when selling/renewing policis
130
271
  function isVerifying() external view returns (bool verifying) {
131
- return _isVerifying;
272
+ return true;
132
273
  }
133
274
 
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
- ) = super.getInitialInfo();
145
-
146
- return (
147
- info,
148
- abi.encode(
149
- ISetup.DistributionSetupInfo(
150
- _productNftId,
151
- TokenHandler(address(_token)),
152
- _initialDistributionFee,
153
- _isVerifying,
154
- address(this)
155
- )
156
- )
157
- );
275
+ function _getDistributionStorage() private pure returns (DistributionStorage storage $) {
276
+ assembly {
277
+ $.slot := DISTRIBUTION_STORAGE_LOCATION_V1
278
+ }
158
279
  }
159
280
  }
@@ -0,0 +1,68 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
5
+
6
+ import {IInstance} from "../instance/IInstance.sol";
7
+ import {IInstanceService} from "../instance/IInstanceService.sol";
8
+ import {IProductService} from "../instance/service/IProductService.sol";
9
+ import {IRegisterable} from "../shared/IRegisterable.sol";
10
+ import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
11
+ import {NftId} from "../types/NftId.sol";
12
+ import {ObjectType} from "../types/ObjectType.sol";
13
+
14
+ /// @dev component base class
15
+ /// component examples are product, distribution, pool and oracle
16
+ interface IComponent is
17
+ IRegisterable,
18
+ ITransferInterceptor
19
+ {
20
+ error ErrorComponentNotChainNft(address caller);
21
+ error ErrorComponentNotProductService(address caller);
22
+ error ErrorComponentNotInstance(NftId instanceNftId);
23
+ error ErrorComponentProductNftAlreadySet();
24
+
25
+ error ErrorComponentWalletAddressZero();
26
+ error ErrorComponentWalletAddressIsSameAsCurrent();
27
+ error ErrorComponentWalletAllowanceTooSmall(address oldWallet, address newWallet, uint256 allowance, uint256 balance);
28
+
29
+ event LogComponentWalletAddressChanged(address oldWallet, address newWallet);
30
+ event LogComponentWalletTokensTransferred(address from, address to, uint256 amount);
31
+
32
+ /// @dev locks component to disable functions that may change state related to this component, the only exception is function "unlock"
33
+ /// only component owner (nft holder) is authorizes to call this function
34
+ function lock() external;
35
+
36
+ /// @dev unlocks component to (re-)enable functions that may change state related to this component
37
+ /// only component owner (nft holder) is authorizes to call this function
38
+ function unlock() external;
39
+
40
+ /// @dev sets the wallet address for the component
41
+ /// if the current wallet has tokens, these will be transferred
42
+ /// if the new wallet address is externally owned, an approval from the
43
+ /// owner of the external wallet for the component to move all tokens must exist
44
+ function setWallet(address walletAddress) external;
45
+
46
+ /// @dev only product service may set product nft id during registration of product setup
47
+ function setProductNftId(NftId productNftId) external;
48
+
49
+ /// @dev returns the name of this component
50
+ /// to successfully register the component with an instance the name MUST be unique in the linked instance
51
+ function getName() external view returns (string memory name);
52
+
53
+ /// @dev defines which ERC20 token is used by this component
54
+ function getToken() external view returns (IERC20Metadata token);
55
+
56
+ /// @dev defines the instance to which this component is linked to
57
+ function getInstance() external view returns (IInstance instance);
58
+
59
+ /// @dev defines the wallet address used to hold the ERC20 tokens related to this component
60
+ /// the default address is the component token address
61
+ function getWallet() external view returns (address walletAddress);
62
+
63
+ /// @dev defines the product to which this component is linked to
64
+ /// this is only relevant for pool and distribution components
65
+ function getProductNftId() external view returns (NftId productNftId);
66
+
67
+ function isNftInterceptor() external view returns(bool isInterceptor);
68
+ }