@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
@@ -1,89 +1,147 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
- pragma solidity ^0.8.19;
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
3
5
 
4
6
  import {Blocknumber, blockNumber} from "../types/Blocknumber.sol";
5
- import {Timestamp, blockTimestamp} from "../types/Timestamp.sol";
6
- import {Version, VersionPart} from "../types/Version.sol";
7
+ import {Timestamp, TimestampLib} from "../types/Timestamp.sol";
8
+ import {Version, VersionPart, VersionLib} from "../types/Version.sol";
7
9
 
8
10
  import {IVersionable} from "./IVersionable.sol";
9
11
 
10
- abstract contract Versionable is IVersionable {
11
12
 
12
- mapping(Version version => VersionInfo info) private _versionHistory;
13
- Version [] private _versions;
14
13
 
14
+ abstract contract Versionable is
15
+ Initializable,
16
+ IVersionable
17
+ {
18
+ // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.shared.Versionable.sol")) - 1)) & ~bytes32(uint256(0xff))
19
+ bytes32 private constant VERSIONABLE_LOCATION_V1 = 0x4f61291a8ac3d020d0a7d919a76b8592aa88385744dee3f8b4f3873b969ed900;
15
20
 
16
- // controlled activation for controller contract
17
- constructor() {
18
- _activate(address(0), msg.sender);
19
- }
20
21
 
21
- // IMPORTANT this function needs to be implemented by each new version
22
- // and needs to call internal function call _activate()
23
- function activate(address implementation, address activatedBy)
24
- external
25
- override
26
- {
27
- _activate(implementation, activatedBy);
22
+ /// @custom:storage-location erc7201:gif-next.contracts.shared.Versionable.sol
23
+ struct VersionableStorage {
24
+ mapping(Version version => VersionInfo info) _versionHistory;
25
+ Version [] _versions;
26
+ Version _v1;
28
27
  }
29
28
 
30
29
 
31
- // can only be called once per contract
32
- // needs bo be called inside the proxy upgrade tx
33
- function _activate(
30
+ constructor() {
31
+ _disableInitializers();
32
+ }
33
+ // TODO write test where new version of private _updateVersionHistory is added and used...
34
+ function initialize(
34
35
  address implementation,
35
- address activatedBy
36
+ address activatedBy,
37
+ bytes memory data
36
38
  )
37
- internal
39
+ public
40
+ initializer
38
41
  {
39
- Version thisVersion = getVersion();
40
- require(
41
- !isActivated(thisVersion),
42
- "ERROR:VRN-001:VERSION_ALREADY_ACTIVATED"
43
- );
44
-
45
- // require increasing version number
46
- if(_versions.length > 0) {
47
- Version lastVersion = _versions[_versions.length - 1];
48
- require(
49
- thisVersion > lastVersion,
50
- "ERROR:VRN-002:VERSION_NOT_INCREASING"
51
- );
52
- }
42
+ _updateVersionHistory(implementation, activatedBy);
43
+ _initialize(activatedBy, data);
44
+ }
53
45
 
54
- // update version history
55
- _versions.push(thisVersion);
56
- _versionHistory[thisVersion] = VersionInfo(
57
- thisVersion,
58
- implementation,
59
- activatedBy,
60
- blockTimestamp(),
61
- blockNumber()
62
- );
46
+ // TODO activatedBy MUST ALWAYS be an owner?
47
+ function upgrade(
48
+ address implementation,
49
+ address activatedBy,
50
+ bytes memory data
51
+ )
52
+ external
53
+ reinitializer(VersionLib.toUint64(getVersion()))
54
+ {
55
+ _updateVersionHistory(implementation, activatedBy);
56
+ _upgrade(data);
57
+ }
63
58
 
64
- emit LogVersionableActivated(thisVersion, implementation, activatedBy);
59
+ function isInitialized(Version _version) public override view returns(bool) {
60
+ return _getVersionableStorage()._versionHistory[_version].activatedIn.toInt() > 0;
65
61
  }
66
62
 
63
+ function getVersion() public pure virtual returns(Version);
67
64
 
68
- function isActivated(Version _version) public override view returns(bool) {
69
- return _versionHistory[_version].activatedIn.toInt() > 0;
65
+ function getVersionCount() public view override returns(uint256) {
66
+ return _getVersionableStorage()._versions.length;
70
67
  }
71
68
 
69
+ function getVersion(uint256 idx) public view override returns(Version) {
70
+ return _getVersionableStorage()._versions[idx];
71
+ }
72
72
 
73
- function getVersion() public pure virtual returns(Version);
73
+ function getVersionInfo(Version _version) public override view returns(VersionInfo memory) {
74
+ return _getVersionableStorage()._versionHistory[_version];
75
+ }
76
+
77
+ function getInitializedVersion() public view returns(uint64) {
78
+ return _getInitializedVersion();
79
+ }
74
80
 
75
81
 
76
- function getVersionCount() external view override returns(uint256) {
77
- return _versions.length;
82
+
83
+ // IMPORTANT each version must implement this function
84
+ // each implementation MUST use onlyInitialising modifier
85
+ // each implementation MUST call intializers of all base contracts...
86
+ function _initialize(address owner, bytes memory data)
87
+ internal
88
+ onlyInitializing
89
+ virtual
90
+ {
91
+ revert();
78
92
  }
79
93
 
80
94
 
81
- function getVersion(uint256 idx) external view override returns(Version) {
82
- return _versions[idx];
95
+ // IMPORTANT each version except version "1" must implement this function
96
+ // each implementation MUST use onlyInitialising modifier
97
+ function _upgrade(bytes memory data)
98
+ internal
99
+ onlyInitializing
100
+ virtual
101
+ {
102
+ revert();
103
+ }
104
+
105
+ function _getVersionableStorage() private pure returns (VersionableStorage storage $) {
106
+ assembly {
107
+ $.slot := VERSIONABLE_LOCATION_V1
108
+ }
83
109
  }
84
110
 
111
+ // can only be called once per contract
112
+ // needs to be called inside the proxy upgrade tx
113
+ // TODO run reinitializer(version().toUint64()) modifier after "version()" is checked,
114
+ function _updateVersionHistory(
115
+ address implementation,
116
+ address activatedBy
117
+ )
118
+ private
119
+ onlyInitializing
120
+ {
121
+ VersionableStorage storage $ = _getVersionableStorage();
122
+
123
+ uint64 version = _getInitializedVersion();
124
+
125
+ Version thisVersion = getVersion();
126
+
127
+ if(version == 1) {
128
+ // thisVersion is alias to version "1"
129
+ $._v1 = thisVersion;
130
+ }
131
+ else {
132
+ require(thisVersion > $._v1, "INVALID VERSION");
133
+ }
134
+
135
+ // update version history
136
+ $._versions.push(thisVersion);
137
+ $._versionHistory[thisVersion] = VersionInfo(
138
+ thisVersion,
139
+ implementation,
140
+ activatedBy,
141
+ TimestampLib.blockTimestamp(),
142
+ blockNumber()
143
+ );
85
144
 
86
- function getVersionInfo(Version _version) external override view returns(VersionInfo memory) {
87
- return _versionHistory[_version];
145
+ emit LogVersionableInitialized(thisVersion, implementation, activatedBy);
88
146
  }
89
147
  }
@@ -1,7 +1,7 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
2
  pragma solidity ^0.8.19;
3
3
 
4
- import {UFixed, UFixedMathLib} from "../types/UFixed.sol";
4
+ import {UFixed, UFixedLib} from "../types/UFixed.sol";
5
5
  import {Fee, FeeLib} from "../types/Fee.sol";
6
6
 
7
7
  contract TestFee {
@@ -15,7 +15,7 @@ contract TestFee {
15
15
  pure
16
16
  returns(Fee memory fee)
17
17
  {
18
- return FeeLib.toFee(UFixedMathLib.toUFixed(fractionalValue, exponent), fixedValue);
18
+ return FeeLib.toFee(UFixedLib.toUFixed(fractionalValue, exponent), fixedValue);
19
19
  }
20
20
 
21
21
  function getZeroFee() external pure returns(Fee memory fee) {
@@ -8,12 +8,11 @@ import {Registerable} from "../../contracts/shared/Registerable.sol";
8
8
 
9
9
  contract TestRegisterable is Registerable {
10
10
 
11
- constructor(address registry, NftId registryNftId)
12
- Registerable(registry, registryNftId)
11
+ constructor(address registry, NftId registryNftId, ObjectType objectType, bool isInterceptor, address initialOwner)
12
+ //Registerable(registry, registryNftId)
13
13
  // solhint-disable-next-line no-empty-blocks
14
- {}
15
-
16
- function getType() external pure override returns (ObjectType) {
17
- return TOKEN();
14
+ {
15
+ bytes memory data = "";
16
+ _initializeRegisterable(registry, registryNftId, objectType, isInterceptor, initialOwner, data);
18
17
  }
19
18
  }
@@ -4,7 +4,7 @@ pragma solidity ^0.8.19;
4
4
  import {RoleId, RoleIdLib, PRODUCT_OWNER_ROLE_NAME, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE_NAME, POOL_OWNER_ROLE} from "../../contracts/types/RoleId.sol";
5
5
 
6
6
  contract TestRoleId {
7
- function getRole(string memory roleName) external pure returns (RoleId) { return RoleIdLib.toRoleId(roleName); }
7
+ function getRole(uint256 roleNum) external pure returns (RoleId) { return RoleIdLib.toRoleId(roleNum); }
8
8
 
9
9
  function getProductOwnerRoleName() external pure returns (string memory) { return PRODUCT_OWNER_ROLE_NAME(); }
10
10
  function getProductOwnerRole() external pure returns (RoleId) { return PRODUCT_OWNER_ROLE(); }
@@ -3,30 +3,22 @@ pragma solidity ^0.8.19;
3
3
 
4
4
  import {NftId} from "../../contracts/types/NftId.sol";
5
5
  import {Version, VersionLib} from "../../contracts/types/Version.sol";
6
- import {ServiceBase} from "../../contracts/instance/base/ServiceBase.sol";
6
+ import {Service} from "../../contracts/shared/Service.sol";
7
7
 
8
8
  import {IVersionable} from "../../contracts/shared/IVersionable.sol";
9
9
  import {Versionable} from "../../contracts/shared/Versionable.sol";
10
10
 
11
- contract TestService is ServiceBase {
11
+ contract TestService is Service {
12
12
 
13
13
  string public constant NAME = "TestService";
14
14
 
15
- constructor(address registry, NftId registryNftId)
16
- ServiceBase(registry, registryNftId)
15
+ constructor(address registry, NftId registryNftId, address initialOwner)
17
16
  // solhint-disable-next-line no-empty-blocks
18
- {}
19
-
20
- function getVersion()
21
- public
22
- pure
23
- virtual override (IVersionable, Versionable)
24
- returns(Version)
25
17
  {
26
- return VersionLib.toVersion(3,0,0);
18
+ _initializeService(registry, initialOwner);
27
19
  }
28
20
 
29
- function getName() external pure override returns(string memory name) {
21
+ function getName() public pure override returns(string memory name) {
30
22
  return NAME;
31
23
  }
32
24
  }
@@ -0,0 +1,55 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {Key32, KeyId, Key32Lib} from "./Key32.sol";
5
+ import {NftId} from "./NftId.sol";
6
+ import {DISTRIBUTION_TYPE} from "./ObjectType.sol";
7
+
8
+ type DistributorType is bytes8;
9
+
10
+ // type bindings
11
+ using {
12
+ eqDistributorType as ==,
13
+ neDistributorType as !=,
14
+ DistributorTypeLib.toKey32
15
+ } for DistributorType global;
16
+
17
+ // general pure free functions
18
+
19
+ // pure free functions for operators
20
+ function eqDistributorType(
21
+ DistributorType a,
22
+ DistributorType b
23
+ ) pure returns (bool isSame) {
24
+ return DistributorType.unwrap(a) == DistributorType.unwrap(b);
25
+ }
26
+
27
+ function neDistributorType(
28
+ DistributorType a,
29
+ DistributorType b
30
+ ) pure returns (bool isDifferent) {
31
+ return DistributorType.unwrap(a) != DistributorType.unwrap(b);
32
+ }
33
+
34
+ // library functions that operate on user defined type
35
+ library DistributorTypeLib {
36
+
37
+ function zero() public pure returns (DistributorType) {
38
+ return DistributorType.wrap(bytes8(0));
39
+ }
40
+
41
+ // @dev Converts a referral string into an id.
42
+ function toDistributorType(NftId distributionNftId, string memory name) public pure returns (DistributorType) {
43
+ return DistributorType.wrap(bytes8(keccak256(abi.encode(distributionNftId, name))));
44
+ }
45
+
46
+ /// @dev Returns the key32 value for the specified nft id and object type.
47
+ function toKey32(DistributorType id) public pure returns (Key32 key) {
48
+ return Key32Lib.toKey32(DISTRIBUTION_TYPE(), toKeyId(id));
49
+ }
50
+
51
+ /// @dev Returns the key id value for the specified nft id
52
+ function toKeyId(DistributorType id) public pure returns (KeyId keyId) {
53
+ return KeyId.wrap(bytes31(DistributorType.unwrap(id)));
54
+ }
55
+ }
@@ -1,7 +1,7 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
2
  pragma solidity ^0.8.19;
3
3
 
4
- import {UFixed, UFixedMathLib} from "./UFixed.sol";
4
+ import {UFixed, UFixedLib} from "./UFixed.sol";
5
5
 
6
6
  struct Fee {
7
7
  UFixed fractionalFee;
@@ -11,8 +11,8 @@ struct Fee {
11
11
  library FeeLib {
12
12
 
13
13
  function calculateFee(
14
- uint256 amount,
15
- Fee memory fee
14
+ Fee memory fee,
15
+ uint256 amount
16
16
  )
17
17
  public
18
18
  pure
@@ -21,7 +21,7 @@ library FeeLib {
21
21
  uint256 netAmount
22
22
  )
23
23
  {
24
- UFixed fractionalAmount = UFixedMathLib.toUFixed(amount) *
24
+ UFixed fractionalAmount = UFixedLib.toUFixed(amount) *
25
25
  fee.fractionalFee;
26
26
  feeAmount = fractionalAmount.toInt() + fee.fixedFee;
27
27
  netAmount = amount - feeAmount;
@@ -35,7 +35,12 @@ library FeeLib {
35
35
  return Fee(fractionalFee, fixedFee);
36
36
  }
37
37
 
38
- /// @dev Return the zero fee struct (0, 0)
38
+ /// @dev Return the percent fee struct (x%, 0)
39
+ function percentageFee(uint8 percent) public pure returns (Fee memory fee) {
40
+ return Fee(UFixedLib.toUFixed(percent, -2), 0);
41
+ }
42
+
43
+ /// @dev Return a zero fee struct (0, 0)
39
44
  function zeroFee() public pure returns (Fee memory fee) {
40
45
  return Fee(UFixed.wrap(0), 0);
41
46
  }
@@ -1,5 +1,5 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
- pragma solidity ^0.8.19;
2
+ pragma solidity ^0.8.20;
3
3
 
4
4
  import {ObjectType} from "./ObjectType.sol";
5
5
 
@@ -10,7 +10,8 @@ type KeyId is bytes31;
10
10
  using {
11
11
  eqKey32 as ==,
12
12
  neKey32 as !=,
13
- Key32Lib.toKey
13
+ Key32Lib.toKeyId,
14
+ Key32Lib.toObjectType
14
15
  } for Key32 global;
15
16
 
16
17
  // @dev Returns true iff keys are identical
@@ -37,9 +38,13 @@ library Key32Lib {
37
38
  return Key32.wrap(bytes32(uintKey));
38
39
  }
39
40
 
40
- function toKey(Key32 key) public pure returns (ObjectType objectType, KeyId id) {
41
+ function toObjectType(Key32 key) public pure returns (ObjectType objectType) {
41
42
  bytes32 key32 = Key32.unwrap(key);
42
43
  objectType = ObjectType.wrap(uint8(uint256(key32 & TYPE_MASK) >> TYPE_SHIFT));
44
+ }
45
+
46
+ function toKeyId(Key32 key) public pure returns (KeyId id) {
47
+ bytes32 key32 = Key32.unwrap(key);
43
48
  id = KeyId.wrap(bytes31((key32 & ID_MASK) << ID_SHIFT));
44
49
  }
45
50
  }
@@ -0,0 +1,52 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ // uint32 allows for 4'294'967'296 individual items
5
+ type NumberId is uint32;
6
+
7
+ // type bindings
8
+ using {
9
+ eqNumberId as ==,
10
+ neNumberId as !=,
11
+ NumberIdLib.eqz,
12
+ NumberIdLib.gtz,
13
+ NumberIdLib.toInt
14
+ } for NumberId global;
15
+
16
+
17
+ // pure free functions for operators
18
+ function eqNumberId(NumberId a, NumberId b) pure returns (bool isSame) {
19
+ return NumberId.unwrap(a) == NumberId.unwrap(b);
20
+ }
21
+
22
+ function neNumberId(NumberId a, NumberId b) pure returns (bool isDifferent) {
23
+ return NumberId.unwrap(a) != NumberId.unwrap(b);
24
+ }
25
+
26
+ // library functions that operate on user defined type
27
+ library NumberIdLib {
28
+ /// @dev Converts the NumberId to a uint.
29
+ function zero() public pure returns (NumberId) {
30
+ return NumberId.wrap(0);
31
+ }
32
+
33
+ /// @dev Converts an uint into a NumberId.
34
+ function toNumberId(uint256 a) public pure returns (NumberId) {
35
+ return NumberId.wrap(uint32(a));
36
+ }
37
+
38
+ /// @dev Converts the NumberId to a uint.
39
+ function toInt(NumberId a) public pure returns (uint32) {
40
+ return uint32(NumberId.unwrap(a));
41
+ }
42
+
43
+ /// @dev Returns true if the value is non-zero (> 0).
44
+ function gtz(NumberId a) public pure returns (bool) {
45
+ return NumberId.unwrap(a) > 0;
46
+ }
47
+
48
+ /// @dev Returns true if the value is zero (== 0).
49
+ function eqz(NumberId a) public pure returns (bool) {
50
+ return NumberId.unwrap(a) == 0;
51
+ }
52
+ }
@@ -1,5 +1,5 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
- pragma solidity ^0.8.19;
2
+ pragma solidity ^0.8.20;
3
3
 
4
4
  type ObjectType is uint8;
5
5
 
@@ -17,56 +17,93 @@ function PROTOCOL() pure returns (ObjectType) {
17
17
  return toObjectType(10);
18
18
  }
19
19
 
20
- function REGISTRY() pure returns (ObjectType) {
20
+ function ROLE() pure returns (ObjectType) {
21
21
  return toObjectType(20);
22
22
  }
23
23
 
24
- function TOKEN() pure returns (ObjectType) {
24
+ function TARGET() pure returns (ObjectType) {
25
25
  return toObjectType(30);
26
26
  }
27
27
 
28
- function SERVICE() pure returns (ObjectType) {
28
+ function REGISTRY() pure returns (ObjectType) {
29
29
  return toObjectType(40);
30
30
  }
31
31
 
32
- function INSTANCE() pure returns (ObjectType) {
32
+ function TOKEN() pure returns (ObjectType) {
33
33
  return toObjectType(50);
34
34
  }
35
35
 
36
- function STAKE() pure returns (ObjectType) {
36
+ function SERVICE() pure returns (ObjectType) {
37
37
  return toObjectType(60);
38
38
  }
39
39
 
40
- function PRODUCT() pure returns (ObjectType) {
40
+ function INSTANCE() pure returns (ObjectType) {
41
+ return toObjectType(70);
42
+ }
43
+
44
+ function STAKE() pure returns (ObjectType) {
45
+ return toObjectType(80);
46
+ }
47
+
48
+ function COMPONENT() pure returns (ObjectType) {
41
49
  return toObjectType(100);
42
50
  }
43
51
 
44
- function DISTRIBUTOR() pure returns (ObjectType) {
52
+ // TODO replace by PRODUCT_SETUP
53
+ function TREASURY() pure returns (ObjectType) {
54
+ return toObjectType(101);
55
+ }
56
+
57
+ function PRODUCT_SETUP() pure returns (ObjectType) {
58
+ return toObjectType(101);
59
+ }
60
+
61
+ function PRODUCT() pure returns (ObjectType) {
45
62
  return toObjectType(110);
46
63
  }
47
64
 
48
- function ORACLE() pure returns (ObjectType) {
65
+ function DISTRIBUTION() pure returns (ObjectType) {
49
66
  return toObjectType(120);
50
67
  }
51
68
 
52
- function POOL() pure returns (ObjectType) {
69
+ function DISTRIBUTION_TYPE() pure returns (ObjectType) {
70
+ return toObjectType(121);
71
+ }
72
+
73
+ function DISTRIBUTOR() pure returns (ObjectType) {
74
+ return toObjectType(122);
75
+ }
76
+
77
+ function REFERRAL() pure returns (ObjectType) {
78
+ return toObjectType(123);
79
+ }
80
+
81
+ function ORACLE() pure returns (ObjectType) {
53
82
  return toObjectType(130);
54
83
  }
55
84
 
56
- function POLICY() pure returns (ObjectType) {
85
+ function POOL() pure returns (ObjectType) {
86
+ return toObjectType(140);
87
+ }
88
+
89
+ function RISK() pure returns (ObjectType) {
57
90
  return toObjectType(200);
58
91
  }
59
92
 
60
- function BUNDLE() pure returns (ObjectType) {
93
+ function POLICY() pure returns (ObjectType) {
61
94
  return toObjectType(210);
62
95
  }
63
96
 
97
+ function BUNDLE() pure returns (ObjectType) {
98
+ return toObjectType(220);
99
+ }
100
+
64
101
  function CLAIM() pure returns (ObjectType) {
65
- return toObjectType(201);
102
+ return toObjectType(211);
66
103
  }
67
104
 
68
105
  function PAYOUT() pure returns (ObjectType) {
69
- return toObjectType(202);
106
+ return toObjectType(212);
70
107
  }
71
108
 
72
109
  /// @dev Converts the uint8 to a ObjectType.
@@ -0,0 +1,85 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ import {Key32, KeyId, Key32Lib} from "./Key32.sol";
5
+ import {NftId} from "./NftId.sol";
6
+ import {REFERRAL} from "./ObjectType.sol";
7
+
8
+ type ReferralId is bytes8;
9
+ type ReferralStatus is uint8;
10
+
11
+ // type bindings
12
+ using {
13
+ eqReferralId as ==,
14
+ neReferralId as !=,
15
+ ReferralLib.toKey32
16
+ } for ReferralId global;
17
+
18
+ using {
19
+ eqReferralStatus as ==,
20
+ neReferralStatus as !=
21
+ } for ReferralStatus global;
22
+
23
+ // general pure free functions
24
+
25
+ // @dev Returns true iff a and b are identical
26
+ function eqReferralId(ReferralId a, ReferralId b) pure returns (bool isSame) {
27
+ return ReferralId.unwrap(a) == ReferralId.unwrap(b);
28
+ }
29
+
30
+ // @dev Returns true iff a and b are different
31
+ function neReferralId(ReferralId a, ReferralId b) pure returns (bool isDifferent) {
32
+ return ReferralId.unwrap(a) != ReferralId.unwrap(b);
33
+ }
34
+
35
+ // @dev Returns true iff a and b are identical
36
+ function eqReferralStatus(ReferralStatus a, ReferralStatus b) pure returns (bool isSame) {
37
+ return ReferralStatus.unwrap(a) == ReferralStatus.unwrap(b);
38
+ }
39
+
40
+ // @dev Returns true iff a and b are different
41
+ function neReferralStatus(ReferralStatus a, ReferralStatus b) pure returns (bool isDifferent) {
42
+ return ReferralStatus.unwrap(a) != ReferralStatus.unwrap(b);
43
+ }
44
+
45
+ function REFERRAL_OK() pure returns (ReferralStatus) {
46
+ return ReferralStatus.wrap(10);
47
+ }
48
+
49
+ function REFERRAL_ERROR_UNKNOWN() pure returns (ReferralStatus) {
50
+ return ReferralStatus.wrap(100);
51
+ }
52
+
53
+ function REFERRAL_ERROR_EXPIRED() pure returns (ReferralStatus) {
54
+ return ReferralStatus.wrap(110);
55
+ }
56
+
57
+ function REFERRAL_ERROR_EXHAUSTED() pure returns (ReferralStatus) {
58
+ return ReferralStatus.wrap(120);
59
+ }
60
+
61
+ library ReferralLib {
62
+
63
+ function zero() public pure returns (ReferralId) {
64
+ return ReferralId.wrap(bytes8(0));
65
+ }
66
+
67
+ // @dev Converts a referral string into an id.
68
+ function toReferralId(NftId distributionNftId, string memory referral) public pure returns (ReferralId) {
69
+ return ReferralId.wrap(bytes8(keccak256(abi.encode(distributionNftId, referral))));
70
+ }
71
+
72
+ function toReferralStatus(uint8 status) public pure returns (ReferralStatus) {
73
+ return ReferralStatus.wrap(status);
74
+ }
75
+
76
+ /// @dev Returns the key32 value for the specified nft id and object type.
77
+ function toKey32(ReferralId id) public pure returns (Key32 key) {
78
+ return Key32Lib.toKey32(REFERRAL(), toKeyId(id));
79
+ }
80
+
81
+ /// @dev Returns the key id value for the specified nft id
82
+ function toKeyId(ReferralId id) public pure returns (KeyId keyId) {
83
+ return KeyId.wrap(bytes31(ReferralId.unwrap(id)));
84
+ }
85
+ }