@etherisc/gif-next 0.0.2-b8776f3-780 → 0.0.2-b9e9dc3-713

Sign up to get free protection for your applications and to get access to all the features.
Files changed (370) hide show
  1. package/README.md +264 -7
  2. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.dbg.json +4 -0
  3. package/artifacts/contracts/{instance/component/ComponentModule.sol/ComponentModule.json → components/BaseComponent.sol/BaseComponent.json} +162 -147
  4. package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json +4 -0
  5. package/artifacts/contracts/components/Distribution.sol/Distribution.json +610 -0
  6. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json +4 -0
  7. package/artifacts/contracts/components/{IPool.sol/IPoolComponent.json → IBaseComponent.sol/IBaseComponent.json} +125 -113
  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 +4 -0
  11. package/artifacts/contracts/{instance/policy/IPolicy.sol/IPolicyModule.json → components/IPoolComponent.sol/IPoolComponent.json} +124 -129
  12. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.dbg.json +4 -0
  13. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.json +157 -0
  14. package/artifacts/contracts/components/Pool.sol/Pool.dbg.json +1 -1
  15. package/artifacts/contracts/components/Pool.sol/Pool.json +523 -77
  16. package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
  17. package/artifacts/contracts/components/Product.sol/Product.json +505 -97
  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/Require.sol/Require.json +2 -2
  26. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.dbg.json +1 -1
  27. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.json +2 -2
  28. package/artifacts/contracts/experiment/inheritance/A.sol/A.dbg.json +1 -1
  29. package/artifacts/contracts/experiment/inheritance/A.sol/A.json +2 -2
  30. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.dbg.json +1 -1
  31. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.json +2 -2
  32. package/artifacts/contracts/experiment/inheritance/B.sol/B.dbg.json +1 -1
  33. package/artifacts/contracts/experiment/inheritance/C.sol/C.dbg.json +1 -1
  34. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.dbg.json +1 -1
  35. package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.dbg.json +1 -1
  36. package/artifacts/contracts/experiment/inheritance/IB.sol/IB.dbg.json +1 -1
  37. package/artifacts/contracts/experiment/inheritance/IC.sol/IC.dbg.json +1 -1
  38. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.dbg.json +1 -1
  39. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.json +2 -2
  40. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.dbg.json +1 -1
  41. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.dbg.json +1 -1
  42. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.dbg.json +1 -1
  43. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.json +2 -2
  44. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.dbg.json +1 -1
  45. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.json +2 -2
  46. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.dbg.json +1 -1
  47. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.json +2 -2
  48. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.dbg.json +1 -1
  49. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.json +2 -2
  50. package/artifacts/contracts/instance/AccessManagedSimple.sol/AccessManagedSimple.dbg.json +4 -0
  51. package/artifacts/contracts/instance/AccessManagedSimple.sol/AccessManagedSimple.json +101 -0
  52. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.dbg.json +4 -0
  53. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.json +1119 -0
  54. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.dbg.json +4 -0
  55. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.json +1082 -0
  56. package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
  57. package/artifacts/contracts/instance/IInstance.sol/IInstance.json +244 -1372
  58. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.dbg.json +4 -0
  59. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.json +421 -0
  60. package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
  61. package/artifacts/contracts/instance/Instance.sol/Instance.json +2708 -974
  62. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.dbg.json +4 -0
  63. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.json +917 -0
  64. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.dbg.json +4 -0
  65. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.json +1257 -0
  66. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.dbg.json +4 -0
  67. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.json +703 -0
  68. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.dbg.json +4 -0
  69. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.json +424 -0
  70. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +4 -0
  71. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.json +481 -0
  72. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.dbg.json +4 -0
  73. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.json +113 -0
  74. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.dbg.json +4 -0
  75. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.json +429 -0
  76. package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.dbg.json +4 -0
  77. package/artifacts/contracts/instance/{lifecycle/ILifecycle.sol/ILifecycleModule.json → base/ILifecycle.sol/ILifecycle.json} +10 -77
  78. package/artifacts/contracts/instance/base/IService.sol/IService.dbg.json +4 -0
  79. package/artifacts/contracts/instance/base/IService.sol/IService.json +421 -0
  80. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.dbg.json +4 -0
  81. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.json +502 -0
  82. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.dbg.json +4 -0
  83. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.json +169 -0
  84. package/artifacts/contracts/instance/base/ServiceBase.sol/ServiceBase.dbg.json +4 -0
  85. package/artifacts/contracts/instance/base/ServiceBase.sol/ServiceBase.json +468 -0
  86. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.dbg.json +4 -0
  87. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.json +211 -0
  88. package/artifacts/contracts/instance/module/IBundle.sol/IBundle.dbg.json +4 -0
  89. package/artifacts/contracts/instance/{access/IAccess.sol/IAccess.json → module/IBundle.sol/IBundle.json} +2 -2
  90. package/artifacts/contracts/instance/module/IDistribution.sol/IDistribution.dbg.json +4 -0
  91. package/artifacts/contracts/instance/{component/IComponent.sol/IComponent.json → module/IDistribution.sol/IDistribution.json} +2 -2
  92. package/artifacts/contracts/instance/module/IPolicy.sol/IPolicy.dbg.json +4 -0
  93. package/artifacts/contracts/instance/{policy → module}/IPolicy.sol/IPolicy.json +1 -1
  94. package/artifacts/contracts/instance/module/IRisk.sol/IRisk.dbg.json +4 -0
  95. package/artifacts/contracts/instance/{pool/IPoolModule.sol/IPool.json → module/IRisk.sol/IRisk.json} +2 -2
  96. package/artifacts/contracts/instance/module/ISetup.sol/ISetup.dbg.json +4 -0
  97. package/artifacts/contracts/instance/module/ISetup.sol/ISetup.json +10 -0
  98. package/artifacts/contracts/instance/module/ITreasury.sol/ITreasury.dbg.json +4 -0
  99. package/artifacts/contracts/instance/{treasury → module}/ITreasury.sol/ITreasury.json +1 -1
  100. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.dbg.json +4 -0
  101. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.json +827 -0
  102. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.dbg.json +4 -0
  103. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.json +466 -0
  104. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.dbg.json +4 -0
  105. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.json +446 -0
  106. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +4 -0
  107. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +561 -0
  108. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +4 -0
  109. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +751 -0
  110. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
  111. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.json +239 -2
  112. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
  113. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.json +287 -31
  114. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.dbg.json +4 -0
  115. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.json +872 -0
  116. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.dbg.json +4 -0
  117. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.json +34 -0
  118. package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
  119. package/artifacts/contracts/registry/Registry.sol/Registry.json +500 -43
  120. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.dbg.json +4 -0
  121. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.json +1261 -0
  122. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.dbg.json +4 -0
  123. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.json +504 -0
  124. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.dbg.json +4 -0
  125. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.json +107 -0
  126. package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json +4 -0
  127. package/artifacts/contracts/shared/ERC165.sol/ERC165.json +35 -0
  128. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.dbg.json +4 -0
  129. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.json +127 -0
  130. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +4 -0
  131. package/artifacts/contracts/{components/Component.sol/Component.json → shared/IRegisterable.sol/IRegisterable.json} +98 -102
  132. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.dbg.json +4 -0
  133. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json +205 -0
  134. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.dbg.json +4 -0
  135. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.json +158 -0
  136. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.dbg.json +4 -0
  137. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.json +349 -0
  138. package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +4 -0
  139. package/artifacts/contracts/shared/Registerable.sol/Registerable.json +274 -0
  140. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.dbg.json +4 -0
  141. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.json +96 -0
  142. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.dbg.json +4 -0
  143. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.json +129 -0
  144. package/artifacts/contracts/shared/Versionable.sol/Versionable.dbg.json +4 -0
  145. package/artifacts/contracts/shared/Versionable.sol/Versionable.json +228 -0
  146. package/artifacts/contracts/test/TestFee.sol/TestFee.dbg.json +4 -0
  147. package/artifacts/contracts/test/TestFee.sol/TestFee.json +119 -0
  148. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.dbg.json +4 -0
  149. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.json +305 -0
  150. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.dbg.json +4 -0
  151. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.json +116 -0
  152. package/artifacts/contracts/test/TestService.sol/TestService.dbg.json +4 -0
  153. package/artifacts/contracts/test/TestService.sol/TestService.json +600 -0
  154. package/artifacts/contracts/test/TestToken.sol/TestUsdc.dbg.json +4 -0
  155. package/artifacts/contracts/test/TestToken.sol/TestUsdc.json +376 -0
  156. package/artifacts/contracts/test/TestVersion.sol/TestVersion.dbg.json +4 -0
  157. package/artifacts/contracts/test/TestVersion.sol/TestVersion.json +218 -0
  158. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.dbg.json +4 -0
  159. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.json +286 -0
  160. package/artifacts/contracts/test/Usdc.sol/USDC.dbg.json +4 -0
  161. package/artifacts/contracts/test/Usdc.sol/USDC.json +376 -0
  162. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.dbg.json +4 -0
  163. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.json +10 -0
  164. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
  165. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.json +2 -2
  166. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.dbg.json +1 -1
  167. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.json +2 -2
  168. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.dbg.json +4 -0
  169. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.json +104 -0
  170. package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +4 -0
  171. package/artifacts/contracts/types/Fee.sol/FeeLib.json +257 -0
  172. package/artifacts/contracts/types/Key32.sol/Key32Lib.dbg.json +4 -0
  173. package/artifacts/contracts/types/Key32.sol/Key32Lib.json +125 -0
  174. package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
  175. package/artifacts/contracts/types/NftId.sol/NftIdLib.json +65 -4
  176. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +4 -0
  177. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +10 -0
  178. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.dbg.json +4 -0
  179. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.json +100 -0
  180. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +1 -1
  181. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +2 -2
  182. package/artifacts/contracts/types/Referral.sol/ReferralLib.dbg.json +4 -0
  183. package/artifacts/contracts/types/Referral.sol/ReferralLib.json +123 -0
  184. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.dbg.json +4 -0
  185. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.json +86 -0
  186. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.dbg.json +4 -0
  187. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.json +156 -0
  188. package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +1 -1
  189. package/artifacts/contracts/types/StateId.sol/StateIdLib.json +2 -2
  190. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
  191. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.json +77 -2
  192. package/artifacts/contracts/types/UFixed.sol/MathLib.dbg.json +4 -0
  193. package/artifacts/contracts/types/UFixed.sol/MathLib.json +10 -0
  194. package/artifacts/contracts/types/UFixed.sol/UFixedLib.dbg.json +4 -0
  195. package/artifacts/contracts/types/UFixed.sol/UFixedLib.json +479 -0
  196. package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +4 -0
  197. package/artifacts/contracts/types/Version.sol/VersionLib.json +177 -0
  198. package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +4 -0
  199. package/artifacts/contracts/types/Version.sol/VersionPartLib.json +30 -0
  200. package/contracts/components/BaseComponent.sol +86 -0
  201. package/contracts/components/Distribution.sol +166 -0
  202. package/contracts/components/IBaseComponent.sol +24 -0
  203. package/contracts/components/IDistributionComponent.sol +43 -0
  204. package/contracts/components/IPoolComponent.sol +62 -0
  205. package/contracts/components/IProductComponent.sol +35 -0
  206. package/contracts/components/Pool.sol +232 -25
  207. package/contracts/components/Product.sol +254 -46
  208. package/contracts/experiment/cloning/Cloner.sol +47 -0
  209. package/contracts/instance/AccessManagedSimple.sol +114 -0
  210. package/contracts/instance/AccessManagerSimple.sol +682 -0
  211. package/contracts/instance/IAccessManagerSimple.sol +391 -0
  212. package/contracts/instance/IInstance.sol +24 -21
  213. package/contracts/instance/IInstanceService.sol +17 -0
  214. package/contracts/instance/Instance.sol +416 -52
  215. package/contracts/instance/InstanceAccessManager.sol +288 -0
  216. package/contracts/instance/InstanceReader.sol +280 -0
  217. package/contracts/instance/InstanceService.sol +102 -0
  218. package/contracts/instance/InstanceServiceManager.sol +56 -0
  219. package/contracts/instance/base/ComponentServiceBase.sol +49 -0
  220. package/contracts/instance/base/IInstanceBase.sol +23 -0
  221. package/contracts/instance/base/IKeyValueStore.sol +49 -0
  222. package/contracts/instance/base/ILifecycle.sol +30 -0
  223. package/contracts/instance/base/IService.sol +15 -0
  224. package/contracts/instance/base/KeyValueStore.sol +172 -0
  225. package/contracts/instance/base/Lifecycle.sol +100 -0
  226. package/contracts/instance/base/ServiceBase.sol +44 -0
  227. package/contracts/instance/module/IAccess.sol +38 -0
  228. package/contracts/instance/module/IBundle.sol +19 -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 +43 -0
  233. package/contracts/instance/module/ITreasury.sol +23 -0
  234. package/contracts/instance/service/ComponentOwnerService.sol +317 -0
  235. package/contracts/instance/service/IComponentOwnerService.sol +20 -0
  236. package/contracts/instance/service/IDistributionService.sol +12 -0
  237. package/contracts/instance/service/IPoolService.sol +37 -0
  238. package/contracts/instance/service/IProductService.sol +107 -0
  239. package/contracts/registry/ChainNft.sol +129 -62
  240. package/contracts/registry/IRegistry.sol +35 -45
  241. package/contracts/registry/IRegistryService.sol +35 -0
  242. package/contracts/registry/ITransferInterceptor.sol +6 -0
  243. package/contracts/registry/Registry.sol +367 -126
  244. package/contracts/registry/RegistryService.sol +440 -0
  245. package/contracts/registry/RegistryServiceManager.sol +64 -0
  246. package/contracts/shared/ContractDeployerLib.sol +72 -0
  247. package/contracts/shared/ERC165.sol +21 -0
  248. package/contracts/shared/INftOwnable.sol +22 -0
  249. package/contracts/shared/IRegisterable.sol +17 -0
  250. package/contracts/shared/IVersionable.sol +96 -0
  251. package/contracts/shared/NftOwnable.sol +136 -0
  252. package/contracts/shared/ProxyManager.sol +94 -0
  253. package/contracts/shared/Registerable.sol +89 -0
  254. package/contracts/shared/TokenHandler.sol +27 -0
  255. package/contracts/shared/UpgradableProxyWithAdmin.sol +16 -0
  256. package/contracts/shared/Versionable.sol +147 -0
  257. package/contracts/test/TestFee.sol +25 -0
  258. package/contracts/test/TestRegisterable.sol +18 -0
  259. package/contracts/test/TestRoleId.sol +14 -0
  260. package/contracts/test/TestService.sol +26 -0
  261. package/contracts/test/TestToken.sol +26 -0
  262. package/contracts/test/TestVersion.sol +44 -0
  263. package/contracts/test/TestVersionable.sol +17 -0
  264. package/contracts/test/Usdc.sol +26 -0
  265. package/contracts/types/AddressSet.sol +58 -0
  266. package/contracts/types/DistributorType.sol +55 -0
  267. package/contracts/types/Fee.sol +44 -20
  268. package/contracts/types/Key32.sol +50 -0
  269. package/contracts/types/NftId.sol +22 -1
  270. package/contracts/types/NftIdSet.sol +60 -0
  271. package/contracts/types/NumberId.sol +52 -0
  272. package/contracts/types/ObjectType.sol +60 -15
  273. package/contracts/types/Referral.sol +85 -0
  274. package/contracts/types/RiskId.sol +43 -0
  275. package/contracts/types/RoleId.sol +82 -0
  276. package/contracts/types/StateId.sol +14 -4
  277. package/contracts/types/Timestamp.sol +29 -4
  278. package/contracts/types/UFixed.sol +150 -31
  279. package/contracts/types/Version.sol +104 -0
  280. package/package.json +14 -5
  281. package/artifacts/contracts/components/Component.sol/Component.dbg.json +0 -4
  282. package/artifacts/contracts/components/Component.sol/InstanceLinked.dbg.json +0 -4
  283. package/artifacts/contracts/components/Component.sol/InstanceLinked.json +0 -35
  284. package/artifacts/contracts/components/IPool.sol/IPoolComponent.dbg.json +0 -4
  285. package/artifacts/contracts/components/IProduct.sol/IProductComponent.dbg.json +0 -4
  286. package/artifacts/contracts/components/IProduct.sol/IProductComponent.json +0 -74
  287. package/artifacts/contracts/instance/access/Access.sol/AccessModule.dbg.json +0 -4
  288. package/artifacts/contracts/instance/access/Access.sol/AccessModule.json +0 -400
  289. package/artifacts/contracts/instance/access/IAccess.sol/IAccess.dbg.json +0 -4
  290. package/artifacts/contracts/instance/access/IAccess.sol/IAccessCheckRole.dbg.json +0 -4
  291. package/artifacts/contracts/instance/access/IAccess.sol/IAccessCheckRole.json +0 -35
  292. package/artifacts/contracts/instance/access/IAccess.sol/IAccessComponentTypeRoles.dbg.json +0 -4
  293. package/artifacts/contracts/instance/access/IAccess.sol/IAccessComponentTypeRoles.json +0 -50
  294. package/artifacts/contracts/instance/access/IAccess.sol/IAccessModule.dbg.json +0 -4
  295. package/artifacts/contracts/instance/access/IAccess.sol/IAccessModule.json +0 -336
  296. package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentModule.dbg.json +0 -4
  297. package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentOwnerService.dbg.json +0 -4
  298. package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentOwnerService.json +0 -202
  299. package/artifacts/contracts/instance/component/IComponent.sol/IComponent.dbg.json +0 -4
  300. package/artifacts/contracts/instance/component/IComponent.sol/IComponentContract.dbg.json +0 -4
  301. package/artifacts/contracts/instance/component/IComponent.sol/IComponentContract.json +0 -205
  302. package/artifacts/contracts/instance/component/IComponent.sol/IComponentModule.dbg.json +0 -4
  303. package/artifacts/contracts/instance/component/IComponent.sol/IComponentModule.json +0 -217
  304. package/artifacts/contracts/instance/component/IComponent.sol/IComponentOwnerService.dbg.json +0 -4
  305. package/artifacts/contracts/instance/component/IComponent.sol/IComponentOwnerService.json +0 -141
  306. package/artifacts/contracts/instance/component/IComponent.sol/IInstanceLinked.dbg.json +0 -4
  307. package/artifacts/contracts/instance/component/IComponent.sol/IInstanceLinked.json +0 -24
  308. package/artifacts/contracts/instance/lifecycle/ILifecycle.sol/ILifecycle.dbg.json +0 -4
  309. package/artifacts/contracts/instance/lifecycle/ILifecycle.sol/ILifecycle.json +0 -134
  310. package/artifacts/contracts/instance/lifecycle/ILifecycle.sol/ILifecycleModule.dbg.json +0 -4
  311. package/artifacts/contracts/instance/lifecycle/LifecycleModule.sol/LifecycleModule.dbg.json +0 -4
  312. package/artifacts/contracts/instance/lifecycle/LifecycleModule.sol/LifecycleModule.json +0 -221
  313. package/artifacts/contracts/instance/policy/IPolicy.sol/IPolicy.dbg.json +0 -4
  314. package/artifacts/contracts/instance/policy/IPolicy.sol/IPolicyModule.dbg.json +0 -4
  315. package/artifacts/contracts/instance/policy/PolicyModule.sol/PolicyModule.dbg.json +0 -4
  316. package/artifacts/contracts/instance/policy/PolicyModule.sol/PolicyModule.json +0 -254
  317. package/artifacts/contracts/instance/pool/IPoolModule.sol/IPool.dbg.json +0 -4
  318. package/artifacts/contracts/instance/pool/IPoolModule.sol/IPoolModule.dbg.json +0 -4
  319. package/artifacts/contracts/instance/pool/IPoolModule.sol/IPoolModule.json +0 -129
  320. package/artifacts/contracts/instance/pool/PoolModule.sol/PoolModule.dbg.json +0 -4
  321. package/artifacts/contracts/instance/pool/PoolModule.sol/PoolModule.json +0 -155
  322. package/artifacts/contracts/instance/product/IProductService.sol/IProductModule.dbg.json +0 -4
  323. package/artifacts/contracts/instance/product/IProductService.sol/IProductModule.json +0 -75
  324. package/artifacts/contracts/instance/product/IProductService.sol/IProductService.dbg.json +0 -4
  325. package/artifacts/contracts/instance/product/IProductService.sol/IProductService.json +0 -127
  326. package/artifacts/contracts/instance/product/ProductService.sol/ProductModule.dbg.json +0 -4
  327. package/artifacts/contracts/instance/product/ProductService.sol/ProductModule.json +0 -75
  328. package/artifacts/contracts/instance/product/ProductService.sol/ProductService.dbg.json +0 -4
  329. package/artifacts/contracts/instance/product/ProductService.sol/ProductService.json +0 -196
  330. package/artifacts/contracts/instance/treasury/ITreasury.sol/ITreasury.dbg.json +0 -4
  331. package/artifacts/contracts/instance/treasury/ITreasury.sol/ITreasuryModule.dbg.json +0 -4
  332. package/artifacts/contracts/instance/treasury/ITreasury.sol/ITreasuryModule.json +0 -490
  333. package/artifacts/contracts/instance/treasury/TokenHandler.sol/TokenHandler.dbg.json +0 -4
  334. package/artifacts/contracts/instance/treasury/TokenHandler.sol/TokenHandler.json +0 -45
  335. package/artifacts/contracts/instance/treasury/TreasuryModule.sol/TreasuryModule.dbg.json +0 -4
  336. package/artifacts/contracts/instance/treasury/TreasuryModule.sol/TreasuryModule.json +0 -490
  337. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.dbg.json +0 -4
  338. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.json +0 -452
  339. package/artifacts/contracts/registry/IRegistry.sol/IOwnable.dbg.json +0 -4
  340. package/artifacts/contracts/registry/IRegistry.sol/IOwnable.json +0 -24
  341. package/artifacts/contracts/registry/IRegistry.sol/IRegisterable.dbg.json +0 -4
  342. package/artifacts/contracts/registry/IRegistry.sol/IRegisterable.json +0 -166
  343. package/artifacts/contracts/registry/IRegistry.sol/IRegistryLinked.dbg.json +0 -4
  344. package/artifacts/contracts/registry/IRegistry.sol/IRegistryLinked.json +0 -49
  345. package/artifacts/contracts/registry/Registry.sol/Registerable.dbg.json +0 -4
  346. package/artifacts/contracts/registry/Registry.sol/Registerable.json +0 -166
  347. package/artifacts/contracts/registry/Registry.sol/RegistryLinked.dbg.json +0 -4
  348. package/artifacts/contracts/registry/Registry.sol/RegistryLinked.json +0 -60
  349. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.dbg.json +0 -4
  350. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.json +0 -453
  351. package/contracts/components/Component.sol +0 -77
  352. package/contracts/components/IPool.sol +0 -15
  353. package/contracts/components/IProduct.sol +0 -16
  354. package/contracts/experiment/statemachine/README.md +0 -112
  355. package/contracts/instance/access/Access.sol +0 -165
  356. package/contracts/instance/access/IAccess.sol +0 -63
  357. package/contracts/instance/component/ComponentModule.sol +0 -274
  358. package/contracts/instance/component/IComponent.sol +0 -74
  359. package/contracts/instance/lifecycle/ILifecycle.sol +0 -47
  360. package/contracts/instance/lifecycle/LifecycleModule.sol +0 -88
  361. package/contracts/instance/policy/IPolicy.sol +0 -50
  362. package/contracts/instance/policy/PolicyModule.sol +0 -114
  363. package/contracts/instance/pool/IPoolModule.sol +0 -23
  364. package/contracts/instance/pool/PoolModule.sol +0 -81
  365. package/contracts/instance/product/IProductService.sol +0 -36
  366. package/contracts/instance/product/ProductService.sol +0 -136
  367. package/contracts/instance/treasury/ITreasury.sol +0 -91
  368. package/contracts/instance/treasury/TokenHandler.sol +0 -24
  369. package/contracts/instance/treasury/TreasuryModule.sol +0 -168
  370. package/contracts/registry/IChainNft.sol +0 -21
@@ -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
+ }
@@ -0,0 +1,43 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ import {Key32, KeyId, Key32Lib} from "./Key32.sol";
5
+ import {RISK} from "./ObjectType.sol";
6
+
7
+ type RiskId is bytes8;
8
+
9
+ // type bindings
10
+ using {
11
+ eqRiskId as ==,
12
+ neRiskId as !=,
13
+ RiskIdLib.toKey32
14
+ } for RiskId global;
15
+
16
+ // general pure free functions
17
+
18
+ // @dev Returns true iff risk ids a and b are identical
19
+ function eqRiskId(RiskId a, RiskId b) pure returns (bool isSame) {
20
+ return RiskId.unwrap(a) == RiskId.unwrap(b);
21
+ }
22
+
23
+ // @dev Returns true iff risk ids a and b are different
24
+ function neRiskId(RiskId a, RiskId b) pure returns (bool isDifferent) {
25
+ return RiskId.unwrap(a) != RiskId.unwrap(b);
26
+ }
27
+
28
+ library RiskIdLib {
29
+ // @dev Converts a role string into a role id.
30
+ function toRiskId(string memory risk) public pure returns (RiskId) {
31
+ return RiskId.wrap(bytes8(keccak256(abi.encode(risk))));
32
+ }
33
+
34
+ /// @dev Returns the key32 value for the specified nft id and object type.
35
+ function toKey32(RiskId id) public pure returns (Key32 key) {
36
+ return Key32Lib.toKey32(RISK(), toKeyId(id));
37
+ }
38
+
39
+ /// @dev Returns the key id value for the specified nft id
40
+ function toKeyId(RiskId id) public pure returns (KeyId keyId) {
41
+ return KeyId.wrap(bytes31(RiskId.unwrap(id)));
42
+ }
43
+ }
@@ -0,0 +1,82 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ import {Key32, KeyId, Key32Lib} from "./Key32.sol";
5
+ import {ROLE} from "./ObjectType.sol";
6
+
7
+ type RoleId is uint64;
8
+
9
+ // type bindings
10
+ using {
11
+ eqRoleId as ==,
12
+ neRoleId as !=,
13
+ RoleIdLib.eqz,
14
+ RoleIdLib.gtz,
15
+ RoleIdLib.toInt,
16
+ RoleIdLib.toKey32
17
+ } for RoleId global;
18
+
19
+ // general pure free functions
20
+ function DISTRIBUTION_OWNER_ROLE_NAME() pure returns (string memory) { return "DistributionOwnerRole"; }
21
+ function ORACLE_OWNER_ROLE_NAME() pure returns (string memory) { return "OracleOwnerRole"; }
22
+ function POOL_OWNER_ROLE_NAME() pure returns (string memory) { return "PoolOwnerRole"; }
23
+ function PRODUCT_OWNER_ROLE_NAME() pure returns (string memory) { return "ProductOwnerRole"; }
24
+
25
+ // TODO correct numbers (maybe they are already defined in RegistryService)
26
+ function DISTRIBUTION_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(100); }
27
+ function ORACLE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(200); }
28
+ function POOL_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(300); }
29
+ function PRODUCT_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(400); }
30
+
31
+ function DISTRIBUTION_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1000); }
32
+ function POLICY_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1100); }
33
+ function BUNDLE_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1200); }
34
+ function POOL_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1300); }
35
+ function PRODUCT_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1400); }
36
+
37
+ // @dev Returns true iff role ids a and b are identical
38
+ function eqRoleId(RoleId a, RoleId b) pure returns (bool isSame) {
39
+ return RoleId.unwrap(a) == RoleId.unwrap(b);
40
+ }
41
+
42
+ // @dev Returns true iff role ids a and b are different
43
+ function neRoleId(RoleId a, RoleId b) pure returns (bool isDifferent) {
44
+ return RoleId.unwrap(a) != RoleId.unwrap(b);
45
+ }
46
+
47
+ library RoleIdLib {
48
+ /// @dev Converts the RoleId to a uint.
49
+ function zero() public pure returns (RoleId) {
50
+ return RoleId.wrap(0);
51
+ }
52
+
53
+ /// @dev Converts an uint into a RoleId.
54
+ function toRoleId(uint256 a) public pure returns (RoleId) {
55
+ return RoleId.wrap(uint64(a));
56
+ }
57
+
58
+ /// @dev Converts the RoleId to a uint.
59
+ function toInt(RoleId a) public pure returns (uint64) {
60
+ return uint64(RoleId.unwrap(a));
61
+ }
62
+
63
+ /// @dev Returns true if the value is non-zero (> 0).
64
+ function gtz(RoleId a) public pure returns (bool) {
65
+ return RoleId.unwrap(a) > 0;
66
+ }
67
+
68
+ /// @dev Returns true if the value is zero (== 0).
69
+ function eqz(RoleId a) public pure returns (bool) {
70
+ return RoleId.unwrap(a) == 0;
71
+ }
72
+
73
+ /// @dev Returns the key32 value for the specified id and object type.
74
+ function toKey32(RoleId a) public pure returns (Key32 key) {
75
+ return Key32Lib.toKey32(ROLE(), toKeyId(a));
76
+ }
77
+
78
+ /// @dev Returns the key id value for the specified id
79
+ function toKeyId(RoleId a) public pure returns (KeyId keyId) {
80
+ return KeyId.wrap(bytes31(uint248(RoleId.unwrap(a))));
81
+ }
82
+ }
@@ -1,11 +1,17 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
- pragma solidity ^0.8.19;
2
+ pragma solidity ^0.8.20;
3
3
 
4
4
  // uint96 allows for chain ids up to 13 digits
5
5
  type StateId is uint8;
6
6
 
7
7
  // type bindings
8
- using {eqStateId as ==, neStateId as !=, StateIdLib.toInt} for StateId global;
8
+ using {
9
+ eqStateId as ==,
10
+ neStateId as !=,
11
+ StateIdLib.eqz,
12
+ StateIdLib.gtz,
13
+ StateIdLib.toInt
14
+ } for StateId global;
9
15
 
10
16
  // general pure free functions
11
17
  function APPLIED() pure returns (StateId) {
@@ -20,14 +26,18 @@ function DECLINED() pure returns (StateId) {
20
26
  return toStateId(30);
21
27
  }
22
28
 
23
- function CONFIRMED() pure returns (StateId) {
29
+ function UNDERWRITTEN() pure returns (StateId) {
24
30
  return toStateId(40);
25
31
  }
26
32
 
27
- function EXPECTED() pure returns (StateId) {
33
+ function CONFIRMED() pure returns (StateId) {
28
34
  return toStateId(50);
29
35
  }
30
36
 
37
+ function EXPECTED() pure returns (StateId) {
38
+ return toStateId(60);
39
+ }
40
+
31
41
  function ACTIVE() pure returns (StateId) {
32
42
  return toStateId(100);
33
43
  }
@@ -9,7 +9,10 @@ using {
9
9
  ltTimestamp as <,
10
10
  lteTimestamp as <=,
11
11
  eqTimestamp as ==,
12
- neTimestamp as !=
12
+ neTimestamp as !=,
13
+ TimestampLib.gtz,
14
+ TimestampLib.eqz,
15
+ TimestampLib.addSeconds
13
16
  } for Timestamp global;
14
17
 
15
18
  /// @dev return true if Timestamp a is after Timestamp b
@@ -47,9 +50,9 @@ function toTimestamp(uint256 timestamp) pure returns (Timestamp) {
47
50
  return Timestamp.wrap(uint40(timestamp));
48
51
  }
49
52
 
50
- function blockTimestamp() view returns (Timestamp) {
51
- return toTimestamp(block.timestamp);
52
- }
53
+ // function blockTimestamp() view returns (Timestamp) {
54
+ // return toTimestamp(block.timestamp);
55
+ // }
53
56
 
54
57
  /// @dev Return the Timestamp zero (0)
55
58
  function zeroTimestamp() pure returns (Timestamp) {
@@ -57,6 +60,10 @@ function zeroTimestamp() pure returns (Timestamp) {
57
60
  }
58
61
 
59
62
  library TimestampLib {
63
+ function blockTimestamp() public view returns (Timestamp) {
64
+ return Timestamp.wrap(uint40(block.timestamp));
65
+ }
66
+
60
67
  /// @dev return true if Timestamp a is after Timestamp b
61
68
  function gt(Timestamp a, Timestamp b) public pure returns (bool isAfter) {
62
69
  return gtTimestamp(a, b);
@@ -96,6 +103,24 @@ library TimestampLib {
96
103
  return neTimestamp(a, b);
97
104
  }
98
105
 
106
+ /// @dev return true if Timestamp is larger than 0
107
+ function gtz(Timestamp timestamp) public pure returns (bool) {
108
+ return Timestamp.unwrap(timestamp) > 0;
109
+ }
110
+
111
+ /// @dev return true if Timestamp equals 0
112
+ function eqz(Timestamp timestamp) public pure returns (bool) {
113
+ return Timestamp.unwrap(timestamp) == 0;
114
+ }
115
+
116
+ /// @dev return true if Timestamp a is not equal to Timestamp b
117
+ function addSeconds(
118
+ Timestamp timestamp,
119
+ uint256 timeDelta
120
+ ) public pure returns (Timestamp) {
121
+ return toTimestamp(Timestamp.unwrap(timestamp) + uint40(timeDelta));
122
+ }
123
+
99
124
  function toInt(Timestamp timestamp) public pure returns (uint256) {
100
125
  return uint256(uint40(Timestamp.unwrap(timestamp)));
101
126
  }
@@ -1,7 +1,5 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
- pragma solidity ^0.8.19;
3
-
4
- import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
2
+ pragma solidity ^0.8.20;
5
3
 
6
4
  /// @dev UFixed is a fixed point number with 18 decimals precision.
7
5
  type UFixed is uint256;
@@ -15,9 +13,16 @@ using {
15
13
  gteUFixed as >=,
16
14
  ltUFixed as <,
17
15
  lteUFixed as <=,
18
- eqUFixed as ==
16
+ eqUFixed as ==,
17
+ neUFixed as !=,
18
+ UFixedLib.toInt,
19
+ UFixedLib.gtz
19
20
  } for UFixed global;
20
21
 
22
+ function zeroUFixed() pure returns (UFixed zero) {
23
+ return UFixed.wrap(0);
24
+ }
25
+
21
26
  function addUFixed(UFixed a, UFixed b) pure returns (UFixed) {
22
27
  return UFixed.wrap(UFixed.unwrap(a) + UFixed.unwrap(b));
23
28
  }
@@ -29,14 +34,14 @@ function subUFixed(UFixed a, UFixed b) pure returns (UFixed) {
29
34
 
30
35
  function mulUFixed(UFixed a, UFixed b) pure returns (UFixed) {
31
36
  return
32
- UFixed.wrap(Math.mulDiv(UFixed.unwrap(a), UFixed.unwrap(b), 10 ** 18));
37
+ UFixed.wrap(MathLib.mulDiv(UFixed.unwrap(a), UFixed.unwrap(b), 10 ** 18));
33
38
  }
34
39
 
35
40
  function divUFixed(UFixed a, UFixed b) pure returns (UFixed) {
36
41
  require(UFixed.unwrap(b) > 0, "ERROR:UFM-020:DIVISOR_ZERO");
37
42
 
38
43
  return
39
- UFixed.wrap(Math.mulDiv(UFixed.unwrap(a), 10 ** 18, UFixed.unwrap(b)));
44
+ UFixed.wrap(MathLib.mulDiv(UFixed.unwrap(a), 10 ** 18, UFixed.unwrap(b)));
40
45
  }
41
46
 
42
47
  function gtUFixed(UFixed a, UFixed b) pure returns (bool isGreaterThan) {
@@ -59,6 +64,10 @@ function eqUFixed(UFixed a, UFixed b) pure returns (bool isEqual) {
59
64
  return UFixed.unwrap(a) == UFixed.unwrap(b);
60
65
  }
61
66
 
67
+ function neUFixed(UFixed a, UFixed b) pure returns (bool isEqual) {
68
+ return UFixed.unwrap(a) != UFixed.unwrap(b);
69
+ }
70
+
62
71
  function gtzUFixed(UFixed a) pure returns (bool isZero) {
63
72
  return UFixed.unwrap(a) > 0;
64
73
  }
@@ -75,68 +84,178 @@ function deltaUFixed(UFixed a, UFixed b) pure returns (UFixed) {
75
84
  return b - a;
76
85
  }
77
86
 
78
- library UFixedMathLib {
87
+ /// @dev copied from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.3/contracts/utils/math/Math.sol
88
+ library MathLib {
89
+
79
90
  enum Rounding {
80
- /// @dev Round down - floor(value)
81
- Down,
82
- /// @dev Round up - ceil(value)
83
- Up,
84
- /// @dev Round half up - round(value)
85
- HalfUp
91
+ Down, // Toward negative infinity
92
+ Up, // Toward infinity
93
+ Zero // Toward zero
86
94
  }
87
95
 
96
+ /**
97
+ * @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or denominator == 0
98
+ * @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv)
99
+ * with further edits by Uniswap Labs also under MIT license.
100
+ */
101
+ function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
102
+ unchecked {
103
+ // 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
104
+ // use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
105
+ // variables such that product = prod1 * 2^256 + prod0.
106
+ uint256 prod0; // Least significant 256 bits of the product
107
+ uint256 prod1; // Most significant 256 bits of the product
108
+ assembly {
109
+ let mm := mulmod(x, y, not(0))
110
+ prod0 := mul(x, y)
111
+ prod1 := sub(sub(mm, prod0), lt(mm, prod0))
112
+ }
113
+
114
+ // Handle non-overflow cases, 256 by 256 division.
115
+ if (prod1 == 0) {
116
+ // Solidity will revert if denominator == 0, unlike the div opcode on its own.
117
+ // The surrounding unchecked block does not change this fact.
118
+ // See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
119
+ return prod0 / denominator;
120
+ }
121
+
122
+ // Make sure the result is less than 2^256. Also prevents denominator == 0.
123
+ require(denominator > prod1, "Math: mulDiv overflow");
124
+
125
+ ///////////////////////////////////////////////
126
+ // 512 by 256 division.
127
+ ///////////////////////////////////////////////
128
+
129
+ // Make division exact by subtracting the remainder from [prod1 prod0].
130
+ uint256 remainder;
131
+ assembly {
132
+ // Compute remainder using mulmod.
133
+ remainder := mulmod(x, y, denominator)
134
+
135
+ // Subtract 256 bit number from 512 bit number.
136
+ prod1 := sub(prod1, gt(remainder, prod0))
137
+ prod0 := sub(prod0, remainder)
138
+ }
139
+
140
+ // Factor powers of two out of denominator and compute largest power of two divisor of denominator. Always >= 1.
141
+ // See https://cs.stackexchange.com/q/138556/92363.
142
+
143
+ // Does not overflow because the denominator cannot be zero at this stage in the function.
144
+ uint256 twos = denominator & (~denominator + 1);
145
+ assembly {
146
+ // Divide denominator by twos.
147
+ denominator := div(denominator, twos)
148
+
149
+ // Divide [prod1 prod0] by twos.
150
+ prod0 := div(prod0, twos)
151
+
152
+ // Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.
153
+ twos := add(div(sub(0, twos), twos), 1)
154
+ }
155
+
156
+ // Shift in bits from prod1 into prod0.
157
+ prod0 |= prod1 * twos;
158
+
159
+ // Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
160
+ // that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
161
+ // four bits. That is, denominator * inv = 1 mod 2^4.
162
+ uint256 inverse = (3 * denominator) ^ 2;
163
+
164
+ // Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works
165
+ // in modular arithmetic, doubling the correct bits in each step.
166
+ inverse *= 2 - denominator * inverse; // inverse mod 2^8
167
+ inverse *= 2 - denominator * inverse; // inverse mod 2^16
168
+ inverse *= 2 - denominator * inverse; // inverse mod 2^32
169
+ inverse *= 2 - denominator * inverse; // inverse mod 2^64
170
+ inverse *= 2 - denominator * inverse; // inverse mod 2^128
171
+ inverse *= 2 - denominator * inverse; // inverse mod 2^256
172
+
173
+ // Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
174
+ // This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
175
+ // less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
176
+ // is no longer required.
177
+ result = prod0 * inverse;
178
+ return result;
179
+ }
180
+ }
181
+
182
+ /**
183
+ * @notice Calculates x * y / denominator with full precision, following the selected rounding direction.
184
+ */
185
+ function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
186
+ uint256 result = mulDiv(x, y, denominator);
187
+ if (rounding == Rounding.Up && mulmod(x, y, denominator) > 0) {
188
+ result += 1;
189
+ }
190
+ return result;
191
+ }
192
+
193
+ }
194
+
195
+ library UFixedLib {
88
196
  int8 public constant EXP = 18;
89
197
  uint256 public constant MULTIPLIER = 10 ** uint256(int256(EXP));
90
198
  uint256 public constant MULTIPLIER_HALF = MULTIPLIER / 2;
91
199
 
92
- /// @dev Default rounding mode used by ftoi is HalfUp
93
- Rounding public constant ROUNDING_DEFAULT = Rounding.HalfUp;
200
+ /// @dev returns the rounding mode DOWN - 0.4 becomes 0, 0.5 becomes 0, 0.6 becomes 0
201
+ function ROUNDING_DOWN() public pure returns (uint8) {
202
+ return uint8(0);
203
+ }
94
204
 
95
- /// @dev returns the decimals precision of the UFixed type
96
- function decimals() public pure returns (uint256) {
97
- return uint8(EXP);
205
+ /// @dev returns the rounding mode UP - 0.4 becomes 1, 0.5 becomes 1, 0.6 becomes 1
206
+ function ROUNDING_UP() public pure returns (uint8) {
207
+ return uint8(1);
208
+ }
209
+
210
+ /// @dev returns the rounding mode HALF_UP - 0.4 becomes 0, 0.5 becomes 1, 0.6 becomes 1
211
+ function ROUNDING_HALF_UP() public pure returns (uint8) {
212
+ return uint8(2);
98
213
  }
99
214
 
100
215
  /// @dev Converts the uint256 to a UFixed.
101
- function itof(uint256 a) public pure returns (UFixed) {
216
+ function toUFixed(uint256 a) public pure returns (UFixed) {
102
217
  return UFixed.wrap(a * MULTIPLIER);
103
218
  }
104
219
 
105
- // TODO rename to toUFixed
106
220
  /// @dev Converts the uint256 to a UFixed with given exponent.
107
- function itof(uint256 a, int8 exp) public pure returns (UFixed) {
221
+ function toUFixed(uint256 a, int8 exp) public pure returns (UFixed) {
108
222
  require(EXP + exp >= 0, "ERROR:FM-010:EXPONENT_TOO_SMALL");
109
223
  require(EXP + exp <= 64, "ERROR:FM-011:EXPONENT_TOO_LARGE");
110
224
 
111
225
  return UFixed.wrap(a * 10 ** uint8(EXP + exp));
112
226
  }
113
227
 
228
+ /// @dev returns the decimals precision of the UFixed type
229
+ function decimals() public pure returns (uint256) {
230
+ return uint8(EXP);
231
+ }
232
+
114
233
  /// @dev Converts a UFixed to a uint256.
115
- function ftoi(UFixed a) public pure returns (uint256) {
116
- return ftoi(a, ROUNDING_DEFAULT);
234
+ function toInt(UFixed a) public pure returns (uint256) {
235
+ return toIntWithRounding(a, ROUNDING_HALF_UP());
117
236
  }
118
237
 
119
238
  /// @dev Converts a UFixed to a uint256 with given rounding mode.
120
- function ftoi(UFixed a, Rounding rounding) public pure returns (uint256) {
121
- if (rounding == Rounding.HalfUp) {
239
+ function toIntWithRounding(UFixed a, uint8 rounding) public pure returns (uint256) {
240
+ if (rounding == ROUNDING_HALF_UP()) {
122
241
  return
123
- Math.mulDiv(
242
+ MathLib.mulDiv(
124
243
  UFixed.unwrap(a) + MULTIPLIER_HALF,
125
244
  1,
126
245
  MULTIPLIER,
127
- Math.Rounding.Down
246
+ MathLib.Rounding.Down
128
247
  );
129
- } else if (rounding == Rounding.Down) {
248
+ } else if (rounding == ROUNDING_DOWN()) {
130
249
  return
131
- Math.mulDiv(
250
+ MathLib.mulDiv(
132
251
  UFixed.unwrap(a),
133
252
  1,
134
253
  MULTIPLIER,
135
- Math.Rounding.Down
254
+ MathLib.Rounding.Down
136
255
  );
137
256
  } else {
138
257
  return
139
- Math.mulDiv(UFixed.unwrap(a), 1, MULTIPLIER, Math.Rounding.Up);
258
+ MathLib.mulDiv(UFixed.unwrap(a), 1, MULTIPLIER, MathLib.Rounding.Up);
140
259
  }
141
260
  }
142
261
 
@@ -0,0 +1,104 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ type VersionPart is uint8;
5
+
6
+ using {
7
+ versionPartGt as >,
8
+ versionPartEq as ==,
9
+ VersionPartLib.toInt
10
+ }
11
+ for VersionPart global;
12
+
13
+ function versionPartGt(VersionPart a, VersionPart b) pure returns(bool isGreaterThan) { return VersionPart.unwrap(a) > VersionPart.unwrap(b); }
14
+ function versionPartEq(VersionPart a, VersionPart b) pure returns(bool isSame) { return VersionPart.unwrap(a) == VersionPart.unwrap(b); }
15
+
16
+ library VersionPartLib {
17
+ function toInt(VersionPart x) external pure returns(uint) { return VersionPart.unwrap(x); }
18
+ }
19
+
20
+ type Version is uint24; // contains major,minor,patch version parts
21
+
22
+ using {
23
+ versionGt as >,
24
+ versionEq as ==,
25
+ VersionLib.toInt,
26
+ VersionLib.toUint64,
27
+ VersionLib.toMajorPart,
28
+ VersionLib.toVersionParts
29
+ }
30
+ for Version global;
31
+
32
+ function versionGt(Version a, Version b) pure returns(bool isGreaterThan) { return Version.unwrap(a) > Version.unwrap(b); }
33
+ function versionEq(Version a, Version b) pure returns(bool isSame) { return Version.unwrap(a) == Version.unwrap(b); }
34
+
35
+ library VersionLib {
36
+ function toInt(Version version) external pure returns(uint) { return Version.unwrap(version); }
37
+
38
+ function toUint64(Version version) external pure returns(uint64) { return Version.unwrap(version); }
39
+
40
+ function toMajorPart(Version version)
41
+ external
42
+ pure
43
+ returns(VersionPart major)
44
+ {
45
+ uint24 versionInt = Version.unwrap(version);
46
+ uint8 majorInt = uint8(versionInt >> 16);
47
+ return VersionPart.wrap(majorInt);
48
+ }
49
+
50
+ function toVersionParts(Version version)
51
+ external
52
+ pure
53
+ returns(
54
+ VersionPart major,
55
+ VersionPart minor,
56
+ VersionPart patch
57
+ )
58
+ {
59
+ uint24 versionInt = Version.unwrap(version);
60
+ uint8 majorInt = uint8(versionInt >> 16);
61
+
62
+ versionInt -= majorInt << 16;
63
+ uint8 minorInt = uint8(versionInt >> 8);
64
+ uint8 patchInt = uint8(versionInt - (minorInt << 8));
65
+
66
+ return (
67
+ VersionPart.wrap(majorInt),
68
+ VersionPart.wrap(minorInt),
69
+ VersionPart.wrap(patchInt)
70
+ );
71
+ }
72
+
73
+ function toVersionPart(uint256 versionPart) external pure returns(VersionPart) {
74
+ return VersionPart.wrap(uint8(versionPart));
75
+ }
76
+
77
+ function toVersion(
78
+ uint256 major,
79
+ uint256 minor,
80
+ uint256 patch
81
+ )
82
+ external
83
+ pure
84
+ returns(Version)
85
+ {
86
+ require(
87
+ major < 256 && minor < 256 && patch < 256,
88
+ "ERROR:VRS-010:VERSION_PART_TOO_BIG");
89
+
90
+ return Version.wrap(
91
+ uint24(
92
+ (major << 16) + (minor << 8) + patch));
93
+ }
94
+
95
+ // TODO check for overflow?
96
+ function toVersion(uint64 versionNumber) external pure returns(Version) {
97
+ //assert(versionNumber <= type(Version).max);
98
+ return Version.wrap(uint24(versionNumber));
99
+ }
100
+
101
+ function zeroVersion() external pure returns(Version) {
102
+ return Version.wrap(0);
103
+ }
104
+ }