@etherisc/gif-next 0.0.2-f9bc4c7-556 → 0.0.2-fb8d07b-779

Sign up to get free protection for your applications and to get access to all the features.
Files changed (373) hide show
  1. package/README.md +179 -1
  2. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.dbg.json +1 -1
  3. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.json +176 -23
  4. package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json +4 -0
  5. package/artifacts/contracts/components/Distribution.sol/Distribution.json +618 -0
  6. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json +1 -1
  7. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.json +129 -23
  8. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.dbg.json +4 -0
  9. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.json +152 -0
  10. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.dbg.json +1 -1
  11. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.json +74 -181
  12. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.dbg.json +1 -1
  13. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.json +55 -177
  14. package/artifacts/contracts/components/Pool.sol/Pool.dbg.json +1 -1
  15. package/artifacts/contracts/components/Pool.sol/Pool.json +455 -60
  16. package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
  17. package/artifacts/contracts/components/Product.sol/Product.json +540 -70
  18. package/artifacts/contracts/experiment/cloning/Cloner.sol/Cloner.dbg.json +4 -0
  19. package/artifacts/contracts/experiment/cloning/Cloner.sol/Cloner.json +66 -0
  20. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock1.dbg.json +4 -0
  21. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock1.json +24 -0
  22. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock2.dbg.json +4 -0
  23. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock2.json +42 -0
  24. package/artifacts/contracts/experiment/errors/Require.sol/Require.dbg.json +1 -1
  25. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.dbg.json +1 -1
  26. package/artifacts/contracts/experiment/inheritance/A.sol/A.dbg.json +1 -1
  27. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.dbg.json +1 -1
  28. package/artifacts/contracts/experiment/inheritance/B.sol/B.dbg.json +1 -1
  29. package/artifacts/contracts/experiment/inheritance/C.sol/C.dbg.json +1 -1
  30. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.dbg.json +1 -1
  31. package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.dbg.json +1 -1
  32. package/artifacts/contracts/experiment/inheritance/IB.sol/IB.dbg.json +1 -1
  33. package/artifacts/contracts/experiment/inheritance/IC.sol/IC.dbg.json +1 -1
  34. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.dbg.json +1 -1
  35. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.json +2 -2
  36. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.dbg.json +1 -1
  37. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.dbg.json +1 -1
  38. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.dbg.json +1 -1
  39. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.json +2 -2
  40. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.dbg.json +1 -1
  41. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.json +2 -2
  42. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.dbg.json +1 -1
  43. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.dbg.json +1 -1
  44. package/artifacts/contracts/instance/AccessManagedSimple.sol/AccessManagedSimple.dbg.json +4 -0
  45. package/artifacts/contracts/instance/AccessManagedSimple.sol/AccessManagedSimple.json +101 -0
  46. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.dbg.json +4 -0
  47. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.json +1132 -0
  48. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.dbg.json +4 -0
  49. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.json +1082 -0
  50. package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
  51. package/artifacts/contracts/instance/IInstance.sol/IInstance.json +493 -1606
  52. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.dbg.json +4 -0
  53. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.json +480 -0
  54. package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
  55. package/artifacts/contracts/instance/Instance.sol/Instance.json +2513 -1170
  56. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.dbg.json +4 -0
  57. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.json +917 -0
  58. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.dbg.json +4 -0
  59. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.json +1388 -0
  60. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.dbg.json +4 -0
  61. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.json +891 -0
  62. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.dbg.json +4 -0
  63. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.json +492 -0
  64. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +1 -1
  65. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.json +276 -36
  66. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.dbg.json +1 -1
  67. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.json +51 -1
  68. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.dbg.json +1 -1
  69. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.json +45 -127
  70. package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.dbg.json +1 -1
  71. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.dbg.json +1 -1
  72. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.json +55 -245
  73. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.dbg.json +1 -1
  74. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.json +4 -4
  75. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.dbg.json +4 -0
  76. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.json +211 -0
  77. package/artifacts/contracts/instance/module/IBundle.sol/IBundle.dbg.json +4 -0
  78. package/artifacts/contracts/instance/module/{bundle/IBundle.sol → IBundle.sol}/IBundle.json +1 -1
  79. package/artifacts/contracts/instance/module/IDistribution.sol/IDistribution.dbg.json +4 -0
  80. package/artifacts/contracts/instance/module/{access/IAccess.sol/IAccess.json → IDistribution.sol/IDistribution.json} +2 -2
  81. package/artifacts/contracts/instance/module/IPolicy.sol/IPolicy.dbg.json +4 -0
  82. package/artifacts/contracts/instance/module/{policy/IPolicy.sol → IPolicy.sol}/IPolicy.json +1 -1
  83. package/artifacts/contracts/instance/module/IRisk.sol/IRisk.dbg.json +4 -0
  84. package/artifacts/contracts/instance/module/{risk/IRisk.sol → IRisk.sol}/IRisk.json +1 -1
  85. package/artifacts/contracts/instance/module/ISetup.sol/ISetup.dbg.json +4 -0
  86. package/artifacts/contracts/instance/{base/ModuleBase.sol/ModuleBase.json → module/ISetup.sol/ISetup.json} +2 -2
  87. package/artifacts/contracts/instance/module/ITreasury.sol/ITreasury.dbg.json +4 -0
  88. package/artifacts/contracts/instance/module/{treasury/ITreasury.sol → ITreasury.sol}/ITreasury.json +1 -1
  89. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.dbg.json +1 -1
  90. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.json +381 -77
  91. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.dbg.json +4 -0
  92. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.json +716 -0
  93. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.dbg.json +4 -0
  94. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.json +448 -0
  95. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.dbg.json +1 -1
  96. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.json +177 -75
  97. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.dbg.json +4 -0
  98. package/artifacts/contracts/instance/{base/ServiceBase.sol/ServiceBase.json → service/IDistributionService.sol/IDistributionService.json} +204 -58
  99. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +1 -1
  100. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +235 -50
  101. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +1 -1
  102. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +325 -51
  103. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.dbg.json +1 -1
  104. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.json +436 -52
  105. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.dbg.json +4 -0
  106. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.json +460 -0
  107. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
  108. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.json +186 -12
  109. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
  110. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.json +485 -37
  111. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.dbg.json +4 -0
  112. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.json +853 -0
  113. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.dbg.json +4 -0
  114. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.json +34 -0
  115. package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
  116. package/artifacts/contracts/registry/Registry.sol/Registry.json +597 -122
  117. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.dbg.json +4 -0
  118. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.json +1237 -0
  119. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.dbg.json +4 -0
  120. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.json +525 -0
  121. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.dbg.json +4 -0
  122. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.json +410 -0
  123. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.dbg.json +4 -0
  124. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.json +107 -0
  125. package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json +1 -1
  126. package/artifacts/contracts/shared/ERC165.sol/ERC165.json +2 -2
  127. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.dbg.json +4 -0
  128. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.json +127 -0
  129. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +1 -1
  130. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.json +117 -37
  131. package/artifacts/contracts/shared/IService.sol/IService.dbg.json +4 -0
  132. package/artifacts/contracts/{instance/base → shared}/IService.sol/IService.json +175 -54
  133. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.dbg.json +1 -1
  134. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json +55 -14
  135. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.dbg.json +4 -0
  136. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.json +158 -0
  137. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.dbg.json +4 -0
  138. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.json +349 -0
  139. package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +1 -1
  140. package/artifacts/contracts/shared/Registerable.sol/Registerable.json +190 -37
  141. package/artifacts/contracts/shared/RegisterableUpgradable.sol/RegisterableUpgradable.dbg.json +4 -0
  142. package/artifacts/contracts/{instance/base/InstanceBase.sol/InstanceBase.json → shared/RegisterableUpgradable.sol/RegisterableUpgradable.json} +199 -83
  143. package/artifacts/contracts/shared/Service.sol/Service.dbg.json +4 -0
  144. package/artifacts/contracts/shared/Service.sol/Service.json +468 -0
  145. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.dbg.json +4 -0
  146. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.json +96 -0
  147. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.dbg.json +4 -0
  148. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.json +129 -0
  149. package/artifacts/contracts/shared/Versionable.sol/Versionable.dbg.json +1 -1
  150. package/artifacts/contracts/shared/Versionable.sol/Versionable.json +78 -14
  151. package/artifacts/contracts/test/TestFee.sol/TestFee.dbg.json +1 -1
  152. package/artifacts/contracts/test/TestFee.sol/TestFee.json +4 -4
  153. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.dbg.json +1 -1
  154. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.json +204 -36
  155. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.dbg.json +1 -1
  156. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.json +14 -14
  157. package/artifacts/contracts/test/TestService.sol/TestService.dbg.json +1 -1
  158. package/artifacts/contracts/test/TestService.sol/TestService.json +283 -62
  159. package/artifacts/contracts/test/TestToken.sol/TestUsdc.dbg.json +1 -1
  160. package/artifacts/contracts/test/TestToken.sol/TestUsdc.json +91 -53
  161. package/artifacts/contracts/test/TestVersion.sol/TestVersion.dbg.json +1 -1
  162. package/artifacts/contracts/test/TestVersion.sol/TestVersion.json +2 -2
  163. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.dbg.json +1 -1
  164. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.json +103 -23
  165. package/artifacts/contracts/test/Usdc.sol/USDC.dbg.json +1 -1
  166. package/artifacts/contracts/test/Usdc.sol/USDC.json +91 -53
  167. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.dbg.json +1 -1
  168. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
  169. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.dbg.json +1 -1
  170. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.dbg.json +4 -0
  171. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.json +104 -0
  172. package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +1 -1
  173. package/artifacts/contracts/types/Fee.sol/FeeLib.json +52 -13
  174. package/artifacts/contracts/types/Key32.sol/Key32Lib.dbg.json +1 -1
  175. package/artifacts/contracts/types/Key32.sol/Key32Lib.json +31 -17
  176. package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
  177. package/artifacts/contracts/types/NftId.sol/NftIdLib.json +2 -2
  178. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +1 -1
  179. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +2 -2
  180. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.dbg.json +4 -0
  181. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.json +100 -0
  182. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +1 -1
  183. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +2 -2
  184. package/artifacts/contracts/types/Referral.sol/ReferralLib.dbg.json +4 -0
  185. package/artifacts/contracts/types/Referral.sol/ReferralLib.json +123 -0
  186. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.dbg.json +4 -0
  187. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.json +86 -0
  188. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.dbg.json +1 -1
  189. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.json +134 -8
  190. package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +1 -1
  191. package/artifacts/contracts/types/StateId.sol/StateIdLib.json +2 -2
  192. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
  193. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.json +15 -2
  194. package/artifacts/contracts/types/UFixed.sol/MathLib.dbg.json +4 -0
  195. package/artifacts/contracts/types/UFixed.sol/MathLib.json +10 -0
  196. package/artifacts/contracts/types/UFixed.sol/UFixedLib.dbg.json +4 -0
  197. package/artifacts/contracts/types/UFixed.sol/{UFixedMathLib.json → UFixedLib.json} +3 -3
  198. package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +1 -1
  199. package/artifacts/contracts/types/Version.sol/VersionLib.json +40 -2
  200. package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +1 -1
  201. package/artifacts/contracts/types/Version.sol/VersionPartLib.json +22 -3
  202. package/contracts/components/BaseComponent.sol +26 -23
  203. package/contracts/components/Distribution.sol +160 -0
  204. package/contracts/components/IBaseComponent.sol +9 -3
  205. package/contracts/components/IDistributionComponent.sol +44 -0
  206. package/contracts/components/IPoolComponent.sol +14 -9
  207. package/contracts/components/IProductComponent.sol +25 -9
  208. package/contracts/components/Pool.sol +98 -29
  209. package/contracts/components/Product.sol +212 -32
  210. package/contracts/experiment/cloning/Cloner.sol +47 -0
  211. package/contracts/instance/AccessManagedSimple.sol +115 -0
  212. package/contracts/instance/AccessManagerSimple.sol +692 -0
  213. package/contracts/instance/IAccessManagerSimple.sol +391 -0
  214. package/contracts/instance/IInstance.sol +32 -45
  215. package/contracts/instance/IInstanceService.sol +30 -0
  216. package/contracts/instance/Instance.sol +426 -51
  217. package/contracts/instance/InstanceAccessManager.sol +288 -0
  218. package/contracts/instance/InstanceReader.sol +306 -0
  219. package/contracts/instance/InstanceService.sol +182 -0
  220. package/contracts/instance/InstanceServiceManager.sol +56 -0
  221. package/contracts/instance/base/ComponentServiceBase.sol +93 -10
  222. package/contracts/instance/base/IInstanceBase.sol +11 -2
  223. package/contracts/instance/base/IKeyValueStore.sol +13 -13
  224. package/contracts/instance/base/ILifecycle.sol +3 -3
  225. package/contracts/instance/base/KeyValueStore.sol +53 -37
  226. package/contracts/instance/base/Lifecycle.sol +16 -11
  227. package/contracts/instance/module/IAccess.sol +38 -0
  228. package/contracts/instance/module/IBundle.sol +20 -0
  229. package/contracts/instance/module/IDistribution.sol +39 -0
  230. package/contracts/instance/module/IPolicy.sol +45 -0
  231. package/contracts/instance/module/IRisk.sol +11 -0
  232. package/contracts/instance/module/ISetup.sol +44 -0
  233. package/contracts/instance/module/ITreasury.sol +23 -0
  234. package/contracts/instance/service/ComponentOwnerService.sol +244 -97
  235. package/contracts/instance/service/DistributionService.sol +87 -0
  236. package/contracts/instance/service/DistributionServiceManager.sol +53 -0
  237. package/contracts/instance/service/IComponentOwnerService.sol +1 -3
  238. package/contracts/instance/service/IDistributionService.sol +12 -0
  239. package/contracts/instance/service/IPoolService.sol +8 -1
  240. package/contracts/instance/service/IProductService.sol +56 -7
  241. package/contracts/instance/service/PoolService.sol +117 -47
  242. package/contracts/instance/service/PoolServiceManager.sol +53 -0
  243. package/contracts/registry/ChainNft.sol +80 -37
  244. package/contracts/registry/IRegistry.sol +62 -25
  245. package/contracts/registry/IRegistryService.sol +33 -0
  246. package/contracts/registry/ITransferInterceptor.sol +6 -0
  247. package/contracts/registry/Registry.sol +375 -267
  248. package/contracts/registry/RegistryService.sol +399 -0
  249. package/contracts/registry/RegistryServiceManager.sol +80 -0
  250. package/contracts/registry/TokenRegistry.sol +111 -0
  251. package/contracts/shared/ContractDeployerLib.sol +72 -0
  252. package/contracts/shared/ERC165.sol +6 -2
  253. package/contracts/shared/INftOwnable.sol +22 -0
  254. package/contracts/shared/IRegisterable.sol +8 -15
  255. package/contracts/{instance/base → shared}/IService.sol +3 -3
  256. package/contracts/shared/IVersionable.sol +55 -11
  257. package/contracts/shared/NftOwnable.sol +136 -0
  258. package/contracts/shared/ProxyManager.sol +94 -0
  259. package/contracts/shared/Registerable.sol +63 -59
  260. package/contracts/shared/RegisterableUpgradable.sol +16 -0
  261. package/contracts/shared/Service.sol +55 -0
  262. package/contracts/shared/TokenHandler.sol +27 -0
  263. package/contracts/shared/UpgradableProxyWithAdmin.sol +16 -0
  264. package/contracts/shared/Versionable.sol +113 -55
  265. package/contracts/test/TestFee.sol +2 -2
  266. package/contracts/test/TestRegisterable.sol +5 -6
  267. package/contracts/test/TestRoleId.sol +1 -1
  268. package/contracts/test/TestService.sol +5 -13
  269. package/contracts/types/DistributorType.sol +55 -0
  270. package/contracts/types/Fee.sol +10 -5
  271. package/contracts/types/Key32.sol +8 -3
  272. package/contracts/types/NumberId.sol +52 -0
  273. package/contracts/types/ObjectType.sol +51 -14
  274. package/contracts/types/Referral.sol +85 -0
  275. package/contracts/types/RiskId.sol +43 -0
  276. package/contracts/types/RoleId.sol +61 -10
  277. package/contracts/types/StateId.sol +5 -1
  278. package/contracts/types/Timestamp.sol +7 -3
  279. package/contracts/types/UFixed.sol +128 -12
  280. package/contracts/types/Version.sol +13 -1
  281. package/package.json +4 -3
  282. package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.dbg.json +0 -4
  283. package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.json +0 -24
  284. package/artifacts/contracts/instance/base/IService.sol/IService.dbg.json +0 -4
  285. package/artifacts/contracts/instance/base/InstanceBase.sol/InstanceBase.dbg.json +0 -4
  286. package/artifacts/contracts/instance/base/ModuleBase.sol/ModuleBase.dbg.json +0 -4
  287. package/artifacts/contracts/instance/base/ServiceBase.sol/ServiceBase.dbg.json +0 -4
  288. package/artifacts/contracts/instance/module/access/Access.sol/AccessModule.dbg.json +0 -4
  289. package/artifacts/contracts/instance/module/access/Access.sol/AccessModule.json +0 -333
  290. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccess.dbg.json +0 -4
  291. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccessModule.dbg.json +0 -4
  292. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccessModule.json +0 -333
  293. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.dbg.json +0 -4
  294. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.json +0 -296
  295. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundle.dbg.json +0 -4
  296. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.dbg.json +0 -4
  297. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.json +0 -296
  298. package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.dbg.json +0 -4
  299. package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.json +0 -10
  300. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensation.dbg.json +0 -4
  301. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensation.json +0 -10
  302. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensationModule.dbg.json +0 -4
  303. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensationModule.json +0 -10
  304. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.dbg.json +0 -4
  305. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.json +0 -188
  306. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.dbg.json +0 -4
  307. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.json +0 -10
  308. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.dbg.json +0 -4
  309. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.json +0 -188
  310. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicy.dbg.json +0 -4
  311. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.dbg.json +0 -4
  312. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.json +0 -261
  313. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.dbg.json +0 -4
  314. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.json +0 -261
  315. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPool.dbg.json +0 -4
  316. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPool.json +0 -10
  317. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.dbg.json +0 -4
  318. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.json +0 -149
  319. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.dbg.json +0 -4
  320. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.json +0 -149
  321. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRisk.dbg.json +0 -4
  322. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.dbg.json +0 -4
  323. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.json +0 -10
  324. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.dbg.json +0 -4
  325. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.json +0 -10
  326. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasury.dbg.json +0 -4
  327. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.dbg.json +0 -4
  328. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.json +0 -533
  329. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.dbg.json +0 -4
  330. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.json +0 -76
  331. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.dbg.json +0 -4
  332. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.json +0 -533
  333. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.dbg.json +0 -4
  334. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.json +0 -673
  335. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.dbg.json +0 -4
  336. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.json +0 -452
  337. package/artifacts/contracts/registry/IRegistryLinked.sol/IRegistryLinked.dbg.json +0 -4
  338. package/artifacts/contracts/registry/IRegistryLinked.sol/IRegistryLinked.json +0 -24
  339. package/artifacts/contracts/shared/IOwnable.sol/IOwnable.dbg.json +0 -4
  340. package/artifacts/contracts/shared/IOwnable.sol/IOwnable.json +0 -24
  341. package/artifacts/contracts/test/TestPool.sol/TestPool.dbg.json +0 -4
  342. package/artifacts/contracts/test/TestPool.sol/TestPool.json +0 -387
  343. package/artifacts/contracts/test/TestProduct.sol/TestProduct.dbg.json +0 -4
  344. package/artifacts/contracts/test/TestProduct.sol/TestProduct.json +0 -393
  345. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.dbg.json +0 -4
  346. package/contracts/experiment/statemachine/README.md +0 -112
  347. package/contracts/instance/IInstanceLinked.sol +0 -8
  348. package/contracts/instance/base/InstanceBase.sol +0 -80
  349. package/contracts/instance/base/ModuleBase.sol +0 -52
  350. package/contracts/instance/base/ServiceBase.sol +0 -37
  351. package/contracts/instance/module/access/Access.sol +0 -149
  352. package/contracts/instance/module/access/IAccess.sol +0 -53
  353. package/contracts/instance/module/bundle/BundleModule.sol +0 -136
  354. package/contracts/instance/module/bundle/IBundle.sol +0 -58
  355. package/contracts/instance/module/compensation/CompensationModule.sol +0 -8
  356. package/contracts/instance/module/compensation/ICompensation.sol +0 -10
  357. package/contracts/instance/module/component/ComponentModule.sol +0 -95
  358. package/contracts/instance/module/component/IComponent.sol +0 -53
  359. package/contracts/instance/module/policy/IPolicy.sol +0 -60
  360. package/contracts/instance/module/policy/PolicyModule.sol +0 -76
  361. package/contracts/instance/module/pool/IPoolModule.sol +0 -41
  362. package/contracts/instance/module/pool/PoolModule.sol +0 -87
  363. package/contracts/instance/module/risk/IRisk.sol +0 -10
  364. package/contracts/instance/module/risk/RiskModule.sol +0 -8
  365. package/contracts/instance/module/treasury/ITreasury.sol +0 -103
  366. package/contracts/instance/module/treasury/TokenHandler.sol +0 -48
  367. package/contracts/instance/module/treasury/TreasuryModule.sol +0 -152
  368. package/contracts/instance/service/ProductService.sol +0 -354
  369. package/contracts/registry/IChainNft.sol +0 -21
  370. package/contracts/registry/IRegistryLinked.sol +0 -8
  371. package/contracts/shared/IOwnable.sol +0 -6
  372. package/contracts/test/TestPool.sol +0 -22
  373. package/contracts/test/TestProduct.sol +0 -44
@@ -0,0 +1,288 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
5
+ import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
6
+
7
+ import {AccessManagedSimple} from "./AccessManagedSimple.sol";
8
+ import {AccessManagerSimple} from "./AccessManagerSimple.sol";
9
+ import {IBundle} from "./module/IBundle.sol";
10
+ import {IPolicy} from "./module/IPolicy.sol";
11
+ import {IRisk} from "./module/IRisk.sol";
12
+ import {ISetup} from "./module/ISetup.sol";
13
+ import {Key32, KeyId, Key32Lib} from "../types/Key32.sol";
14
+ import {KeyValueStore} from "./base/KeyValueStore.sol";
15
+ import {NftId} from "../types/NftId.sol";
16
+ import {NumberId} from "../types/NumberId.sol";
17
+ import {ObjectType, BUNDLE, DISTRIBUTION, POLICY, POOL, ROLE, PRODUCT, TARGET} from "../types/ObjectType.sol";
18
+ import {RiskId, RiskIdLib} from "../types/RiskId.sol";
19
+ import {RoleId, RoleIdLib} from "../types/RoleId.sol";
20
+ import {StateId, ACTIVE} from "../types/StateId.sol";
21
+ import {Timestamp, TimestampLib} from "../types/Timestamp.sol";
22
+
23
+ contract InstanceAccessManager is
24
+ AccessManagedSimple
25
+ {
26
+ string public constant ADMIN_ROLE_NAME = "AdminRole";
27
+ string public constant PUBLIC_ROLE_NAME = "PublicRole";
28
+
29
+ uint64 public constant CUSTOM_ROLE_ID_MIN = 10000;
30
+ uint32 public constant EXECUTION_DELAY = 0;
31
+
32
+ struct RoleInfo {
33
+ ShortString name;
34
+ bool isCustom;
35
+ bool isLocked;
36
+ Timestamp createdAt;
37
+ Timestamp updatedAt;
38
+ }
39
+
40
+ struct TargetInfo {
41
+ ShortString name;
42
+ bool isCustom;
43
+ bool isLocked;
44
+ Timestamp createdAt;
45
+ Timestamp updatedAt;
46
+ }
47
+
48
+ error ErrorRoleIdInvalid(RoleId roleId);
49
+ error ErrorRoleIdTooBig(RoleId roleId);
50
+ error ErrorRoleIdTooSmall(RoleId roleId);
51
+ error ErrorRoleIdAlreadyExists(RoleId roleId, ShortString name);
52
+ error ErrorRoleIdNotActive(RoleId roleId);
53
+ error ErrorRoleNameEmpty(RoleId roleId);
54
+ error ErrorRoleNameNotUnique(RoleId roleId, ShortString name);
55
+ error ErrorRoleInvalidUpdate(RoleId roleId, bool isCustom);
56
+ error ErrorRoleIsCustomIsImmutable(RoleId roleId, bool isCustom, bool isCustomExisting);
57
+ error ErrorSetLockedForNonexstentRole(RoleId roleId);
58
+ error ErrorGrantNonexstentRole(RoleId roleId);
59
+ error ErrorRevokeNonexstentRole(RoleId roleId);
60
+ error ErrorRenounceNonexstentRole(RoleId roleId);
61
+
62
+ error ErrorTargetAddressZero();
63
+ error ErrorTargetAlreadyExists(address target, ShortString name);
64
+ error ErrorTargetNameEmpty(address target);
65
+ error ErrorTargetNameExists(address target, address existingTarget, ShortString name);
66
+ error ErrorSetLockedForNonexstentTarget(address target);
67
+
68
+ // role specific state
69
+ mapping(RoleId roleId => RoleInfo info) internal _role;
70
+ mapping(RoleId roleId => EnumerableSet.AddressSet roleMembers) internal _roleMembers;
71
+ mapping(ShortString name => RoleId roleId) internal _roleForName;
72
+ RoleId [] internal _roles;
73
+
74
+ // target specific state
75
+ mapping(address target => TargetInfo info) internal _target;
76
+ mapping(ShortString name => address target) internal _targetForName;
77
+ address [] internal _targets;
78
+
79
+ AccessManagerSimple internal _accessManager;
80
+
81
+ constructor(address accessManager)
82
+ {
83
+ _accessManager = AccessManagerSimple(accessManager);
84
+ initializeAccessManagedSimple(accessManager);
85
+
86
+ _createRole(RoleIdLib.toRoleId(_accessManager.ADMIN_ROLE()), ADMIN_ROLE_NAME, false, false);
87
+ _createRole(RoleIdLib.toRoleId(_accessManager.PUBLIC_ROLE()), PUBLIC_ROLE_NAME, false, false);
88
+ }
89
+
90
+ //--- Role ------------------------------------------------------//
91
+
92
+ function createDefaultRole(RoleId roleId, string memory name) external restricted() {
93
+ _createRole(roleId, name, false, true);
94
+ }
95
+
96
+ function createRole(RoleId roleId, string memory name) external restricted() {
97
+ _createRole(roleId, name, true, true);
98
+ }
99
+
100
+ function setRoleLocked(RoleId roleId, bool locked) external restricted() {
101
+ if (!roleExists(roleId)) {
102
+ revert ErrorSetLockedForNonexstentRole(roleId);
103
+ }
104
+
105
+ _role[roleId].isLocked = locked;
106
+ _role[roleId].updatedAt = TimestampLib.blockTimestamp();
107
+ }
108
+
109
+ function roleExists(RoleId roleId) public view returns (bool exists) {
110
+ return _role[roleId].createdAt.gtz();
111
+ }
112
+
113
+ function grantRole(RoleId roleId, address member) external restricted() returns (bool granted) {
114
+ if (!roleExists(roleId)) {
115
+ revert ErrorGrantNonexstentRole(roleId);
116
+ }
117
+
118
+ if (_role[roleId].isLocked) {
119
+ revert ErrorRoleIdNotActive(roleId);
120
+ }
121
+
122
+ if (!EnumerableSet.contains(_roleMembers[roleId], member)) {
123
+ _accessManager.grantRole(roleId.toInt(), member, EXECUTION_DELAY);
124
+ EnumerableSet.add(_roleMembers[roleId], member);
125
+ return true;
126
+ }
127
+
128
+ return false;
129
+ }
130
+
131
+ function revokeRole(RoleId roleId, address member) external restricted() returns (bool revoked) {
132
+ if (!roleExists(roleId)) {
133
+ revert ErrorRevokeNonexstentRole(roleId);
134
+ }
135
+
136
+ if (EnumerableSet.contains(_roleMembers[roleId], member)) {
137
+ _accessManager.revokeRole(roleId.toInt(), member);
138
+ EnumerableSet.remove(_roleMembers[roleId], member);
139
+ return true;
140
+ }
141
+
142
+ return false;
143
+ }
144
+
145
+ /// @dev not restricted function by intention
146
+ /// the restriction to role members is already enforced by the call to the access manger
147
+ function renounceRole(RoleId roleId) external returns (bool revoked) {
148
+ address member = msg.sender;
149
+
150
+ if (!roleExists(roleId)) {
151
+ revert ErrorRenounceNonexstentRole(roleId);
152
+ }
153
+
154
+ if (EnumerableSet.contains(_roleMembers[roleId], member)) {
155
+ // cannot use accessManger.renounce as it directly checks against msg.sender
156
+ _accessManager.revokeRole(roleId.toInt(), member);
157
+ EnumerableSet.remove(_roleMembers[roleId], member);
158
+ return true;
159
+ }
160
+
161
+ return false;
162
+ }
163
+
164
+ function roles() external view returns (uint256 numberOfRoles) {
165
+ return _roles.length;
166
+ }
167
+
168
+ function getRoleId(uint256 idx) external view returns (RoleId roleId) {
169
+ return _roles[idx];
170
+ }
171
+
172
+ function getRoleIdForName(string memory name) external view returns (RoleId roleId) {
173
+ return _roleForName[ShortStrings.toShortString(name)];
174
+ }
175
+
176
+ function getRole(RoleId roleId) external view returns (RoleInfo memory role) {
177
+ return _role[roleId];
178
+ }
179
+
180
+ function hasRole(RoleId roleId, address account) external view returns (bool accountHasRole) {
181
+ (accountHasRole, ) = _accessManager.hasRole(roleId.toInt(), account);
182
+ }
183
+
184
+ function roleMembers(RoleId roleId) external view returns (uint256 numberOfMembers) {
185
+ return EnumerableSet.length(_roleMembers[roleId]);
186
+ }
187
+
188
+ function getRoleMember(RoleId roleId, uint256 idx) external view returns (address roleMember) {
189
+ return EnumerableSet.at(_roleMembers[roleId], idx);
190
+ }
191
+
192
+ //--- Target ------------------------------------------------------//
193
+ function createTarget(address target, string memory name) external restricted() {
194
+ _createTarget(target, name, true, true);
195
+ }
196
+
197
+ function setTargetLocked(address target, bool locked) external restricted() {
198
+ if (!targetExists(target)) {
199
+ revert ErrorSetLockedForNonexstentTarget(target);
200
+ }
201
+
202
+ _target[target].isLocked = locked;
203
+ _accessManager.setTargetClosed(target, locked);
204
+ }
205
+
206
+ function targetExists(address target) public view returns (bool exists) {
207
+ return _target[target].createdAt.gtz();
208
+ }
209
+
210
+ //--- internal view/pure functions --------------------------------------//
211
+
212
+ function _createRole(RoleId roleId, string memory name, bool isCustom, bool validateParameters) internal {
213
+ if (validateParameters) {
214
+ _validateRoleParameters(roleId, name, isCustom);
215
+ }
216
+
217
+ RoleInfo memory role = RoleInfo(
218
+ ShortStrings.toShortString(name),
219
+ isCustom,
220
+ false, // role un-locked,
221
+ TimestampLib.blockTimestamp(),
222
+ TimestampLib.blockTimestamp());
223
+
224
+ _role[roleId] = role;
225
+ _roleForName[role.name] = roleId;
226
+ _roles.push(roleId);
227
+ }
228
+
229
+ function _validateRoleParameters(
230
+ RoleId roleId,
231
+ string memory name,
232
+ bool isCustom
233
+ )
234
+ internal
235
+ view
236
+ returns (RoleInfo memory existingRole)
237
+ {
238
+ // check role id
239
+ uint64 roleIdInt = RoleId.unwrap(roleId);
240
+ if(roleIdInt == _accessManager.ADMIN_ROLE() || roleIdInt == _accessManager.PUBLIC_ROLE()) {
241
+ revert ErrorRoleIdInvalid(roleId);
242
+ }
243
+
244
+ // prevent changing isCustom for existing roles
245
+ existingRole = _role[roleId];
246
+
247
+ if (existingRole.createdAt.gtz() && isCustom != existingRole.isCustom) {
248
+ revert ErrorRoleIsCustomIsImmutable(roleId, isCustom, existingRole.isCustom);
249
+ }
250
+
251
+ if (isCustom && roleIdInt < CUSTOM_ROLE_ID_MIN) {
252
+ revert ErrorRoleIdTooSmall(roleId);
253
+ } else if (!isCustom && roleIdInt >= CUSTOM_ROLE_ID_MIN) {
254
+ revert ErrorRoleIdTooBig(roleId);
255
+ }
256
+
257
+ // role name checks
258
+ ShortString nameShort = ShortStrings.toShortString(name);
259
+ if (ShortStrings.byteLength(nameShort) == 0) {
260
+ revert ErrorRoleNameEmpty(roleId);
261
+ }
262
+
263
+ if (_roleForName[nameShort] != RoleIdLib.zero() && _roleForName[nameShort] != roleId) {
264
+ revert ErrorRoleNameNotUnique(_roleForName[nameShort], nameShort);
265
+ }
266
+ }
267
+
268
+ function _createTarget(address target, string memory name, bool isCustom, bool validateParameters) internal {
269
+ if (validateParameters) {
270
+ _validateTargetParameters(target, name, isCustom);
271
+ }
272
+
273
+ TargetInfo memory info = TargetInfo(
274
+ ShortStrings.toShortString(name),
275
+ isCustom,
276
+ _accessManager.isTargetClosed(target), // sync with state in access manager
277
+ TimestampLib.blockTimestamp(),
278
+ TimestampLib.blockTimestamp());
279
+
280
+ _target[target] = info;
281
+ _targetForName[info.name] = target;
282
+ _targets.push(target);
283
+ }
284
+
285
+ function _validateTargetParameters(address target, string memory name, bool isCustom) internal view {
286
+
287
+ }
288
+ }
@@ -0,0 +1,306 @@
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 {DistributorType} from "../types/DistributorType.sol";
7
+ import {Fee, FeeLib} from "../types/Fee.sol";
8
+ import {Key32} from "../types/Key32.sol";
9
+ import {NftId} from "../types/NftId.sol";
10
+ import {ObjectType, DISTRIBUTOR, DISTRIBUTION, INSTANCE, PRODUCT, POLICY, POOL, TREASURY, BUNDLE} from "../types/ObjectType.sol";
11
+ import {ReferralId, ReferralStatus, ReferralLib, REFERRAL_OK, REFERRAL_ERROR_UNKNOWN, REFERRAL_ERROR_EXPIRED, REFERRAL_ERROR_EXHAUSTED} from "../types/Referral.sol";
12
+ import {Registerable} from "../shared/Registerable.sol";
13
+ import {RiskId} from "../types/RiskId.sol";
14
+ import {UFixed, MathLib, UFixedLib} from "../types/UFixed.sol";
15
+ import {Version} from "../types/Version.sol";
16
+
17
+ import {IRegistry} from "../registry/IRegistry.sol";
18
+ import {IBundle} from "../instance/module/IBundle.sol";
19
+ import {IDistribution} from "../instance/module/IDistribution.sol";
20
+ import {IInstance} from "./IInstance.sol";
21
+ import {IKeyValueStore} from "../instance/base/IKeyValueStore.sol";
22
+ import {IPolicy} from "../instance/module/IPolicy.sol";
23
+ import {IRisk} from "../instance/module/IRisk.sol";
24
+ import {ISetup} from "../instance/module/ISetup.sol";
25
+ import {ITreasury} from "../instance/module/ITreasury.sol";
26
+ import {TimestampLib} from "../types/Timestamp.sol";
27
+
28
+
29
+ contract InstanceReader {
30
+ bool private _initialized;
31
+
32
+ IRegistry internal _registry;
33
+ NftId internal _instanceNftId;
34
+ IInstance internal _instance;
35
+ IKeyValueStore internal _store;
36
+
37
+ constructor(
38
+ address registry,
39
+ NftId instanceNftId
40
+ )
41
+ {
42
+ initialize(registry, instanceNftId);
43
+ }
44
+
45
+ function initialize(address registry, NftId instanceNftId) public {
46
+ require(!_initialized, "ERROR:CRD-000:ALREADY_INITIALIZED");
47
+
48
+ require(
49
+ address(registry) != address(0),
50
+ "ERROR:CRD-001:REGISTRY_ZERO");
51
+
52
+ require(
53
+ instanceNftId.gtz(),
54
+ "ERROR:CRD-002:NFT_ID_ZERO");
55
+
56
+ _registry = IRegistry(registry);
57
+ _instanceNftId = instanceNftId;
58
+ IRegistry.ObjectInfo memory instanceInfo = _registry.getObjectInfo(_instanceNftId);
59
+
60
+ require(
61
+ instanceInfo.objectType == INSTANCE(),
62
+ "ERROR:CRD-003:PARENT_NOT_INSTANCE");
63
+
64
+ _instance = IInstance(instanceInfo.objectAddress);
65
+ _store = IKeyValueStore(instanceInfo.objectAddress);
66
+
67
+ _initialized = true;
68
+ }
69
+
70
+
71
+ // module specific functions
72
+
73
+ function getPolicyInfo(NftId policyNftId)
74
+ public
75
+ view
76
+ returns (IPolicy.PolicyInfo memory info)
77
+ {
78
+ bytes memory data = _store.getData(toPolicyKey(policyNftId));
79
+ if (data.length > 0) {
80
+ return abi.decode(data, (IPolicy.PolicyInfo));
81
+ }
82
+ }
83
+
84
+ function getRiskInfo(RiskId riskId)
85
+ public
86
+ view
87
+ returns (IRisk.RiskInfo memory info)
88
+ {
89
+ bytes memory data = _store.getData(riskId.toKey32());
90
+ if (data.length > 0) {
91
+ return abi.decode(data, (IRisk.RiskInfo));
92
+ }
93
+ }
94
+
95
+ function getTokenHandler(NftId productNftId)
96
+ public
97
+ view
98
+ returns (address tokenHandler)
99
+ {
100
+ bytes memory data = _store.getData(toTreasuryKey(productNftId));
101
+
102
+ if (data.length > 0) {
103
+ ITreasury.TreasuryInfo memory info = abi.decode(data, (ITreasury.TreasuryInfo));
104
+ return address(info.tokenHandler);
105
+ }
106
+ }
107
+
108
+ function getTreasuryInfo(NftId productNftId)
109
+ public
110
+ view
111
+ returns (ITreasury.TreasuryInfo memory info)
112
+ {
113
+ bytes memory data = _store.getData(toTreasuryKey(productNftId));
114
+ if (data.length > 0) {
115
+ return abi.decode(data, (ITreasury.TreasuryInfo));
116
+ }
117
+ }
118
+
119
+ function getBundleInfo(NftId bundleNftId)
120
+ public
121
+ view
122
+ returns (IBundle.BundleInfo memory info)
123
+ {
124
+ bytes memory data = _store.getData(toBundleKey(bundleNftId));
125
+ if (data.length > 0) {
126
+ return abi.decode(data, (IBundle.BundleInfo));
127
+ }
128
+ }
129
+
130
+ function getDistributorTypeInfo(DistributorType distributorType)
131
+ public
132
+ view
133
+ returns (IDistribution.DistributorTypeInfo memory info)
134
+ {
135
+ bytes memory data = _store.getData(distributorType.toKey32());
136
+ if (data.length > 0) {
137
+ return abi.decode(data, (IDistribution.DistributorTypeInfo));
138
+ }
139
+ }
140
+
141
+ function getDistributorInfo(NftId distributorNftId)
142
+ public
143
+ view
144
+ returns (IDistribution.DistributorInfo memory info)
145
+ {
146
+ bytes memory data = _store.getData(toDistributorKey(distributorNftId));
147
+ if (data.length > 0) {
148
+ return abi.decode(data, (IDistribution.DistributorInfo));
149
+ }
150
+ }
151
+
152
+ function getDistributionSetupInfo(NftId distributionNftId)
153
+ public
154
+ view
155
+ returns (ISetup.DistributionSetupInfo memory info)
156
+ {
157
+ bytes memory data = _store.getData(toDistributionKey(distributionNftId));
158
+ if (data.length > 0) {
159
+ return abi.decode(data, (ISetup.DistributionSetupInfo));
160
+ }
161
+ }
162
+
163
+ function getPoolSetupInfo(NftId poolNftId)
164
+ public
165
+ view
166
+ returns (ISetup.PoolSetupInfo memory info)
167
+ {
168
+ bytes memory data = _store.getData(toPoolKey(poolNftId));
169
+ if (data.length > 0) {
170
+ return abi.decode(data, (ISetup.PoolSetupInfo));
171
+ }
172
+ }
173
+
174
+ function getProductSetupInfo(NftId productNftId)
175
+ public
176
+ view
177
+ returns (ISetup.ProductSetupInfo memory info)
178
+ {
179
+ bytes memory data = _store.getData(toProductKey(productNftId));
180
+ if (data.length > 0) {
181
+ return abi.decode(data, (ISetup.ProductSetupInfo));
182
+ }
183
+ }
184
+
185
+ function getReferralInfo(ReferralId referralId)
186
+ public
187
+ view
188
+ returns (IDistribution.ReferralInfo memory info)
189
+ {
190
+ bytes memory data = _store.getData(referralId.toKey32());
191
+ if (data.length > 0) {
192
+ return abi.decode(data, (IDistribution.ReferralInfo));
193
+ }
194
+ }
195
+
196
+
197
+ function getMetadata(Key32 key)
198
+ public
199
+ view
200
+ returns (IKeyValueStore.Metadata memory metadata)
201
+ {
202
+ return _store.getMetadata(key);
203
+ }
204
+
205
+
206
+ function toReferralId(
207
+ NftId distributionNftId,
208
+ string memory referralCode
209
+ )
210
+ public
211
+ pure
212
+ returns (ReferralId referralId)
213
+ {
214
+ return ReferralLib.toReferralId(
215
+ distributionNftId,
216
+ referralCode);
217
+ }
218
+
219
+
220
+ function getDiscountPercentage(ReferralId referralId)
221
+ public
222
+ view
223
+ returns (
224
+ UFixed discountPercentage,
225
+ ReferralStatus status
226
+ )
227
+ {
228
+ IDistribution.ReferralInfo memory info = getReferralInfo(
229
+ referralId);
230
+
231
+ if (info.expiryAt.eqz()) {
232
+ return (
233
+ UFixedLib.zero(),
234
+ REFERRAL_ERROR_UNKNOWN());
235
+ }
236
+
237
+ if (info.expiryAt < TimestampLib.blockTimestamp()) {
238
+ return (
239
+ UFixedLib.zero(),
240
+ REFERRAL_ERROR_EXPIRED());
241
+ }
242
+
243
+ if (info.usedReferrals >= info.maxReferrals) {
244
+ return (
245
+ UFixedLib.zero(),
246
+ REFERRAL_ERROR_EXHAUSTED());
247
+ }
248
+
249
+ return (
250
+ info.discountPercentage,
251
+ REFERRAL_OK()
252
+ );
253
+ }
254
+
255
+
256
+ function toTreasuryKey(NftId productNftId) public pure returns (Key32) {
257
+ return productNftId.toKey32(TREASURY());
258
+ }
259
+
260
+
261
+ function toPolicyKey(NftId policyNftId) public pure returns (Key32) {
262
+ return policyNftId.toKey32(POLICY());
263
+ }
264
+
265
+
266
+ function toDistributorKey(NftId distributorNftId) public pure returns (Key32) {
267
+ return distributorNftId.toKey32(DISTRIBUTOR());
268
+ }
269
+
270
+ function toDistributionKey(NftId distributionNftId) public pure returns (Key32) {
271
+ return distributionNftId.toKey32(DISTRIBUTION());
272
+ }
273
+
274
+ function toBundleKey(NftId poolNftId) public pure returns (Key32) {
275
+ return poolNftId.toKey32(BUNDLE());
276
+ }
277
+
278
+ function toPoolKey(NftId poolNftId) public pure returns (Key32) {
279
+ return poolNftId.toKey32(POOL());
280
+ }
281
+
282
+ function toProductKey(NftId productNftId) public pure returns (Key32) {
283
+ return productNftId.toKey32(PRODUCT());
284
+ }
285
+
286
+ // low level function
287
+ function getInstance() external view returns (IInstance instance) {
288
+ return _instance;
289
+ }
290
+
291
+ function getInstanceStore() external view returns (IKeyValueStore store) {
292
+ return _store;
293
+ }
294
+
295
+ function getInstanceNftId() external view returns (NftId nftId) {
296
+ return _instanceNftId;
297
+ }
298
+
299
+ function toUFixed(uint256 value, int8 exp) public pure returns (UFixed) {
300
+ return UFixedLib.toUFixed(value, exp);
301
+ }
302
+
303
+ function toInt(UFixed value) public pure returns (uint256) {
304
+ return UFixedLib.toInt(value);
305
+ }
306
+ }