@etherisc/gif-next 0.0.2-cf606cd → 0.0.2-cff6256-424

Sign up to get free protection for your applications and to get access to all the features.
Files changed (384) hide show
  1. package/README.md +295 -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} +156 -156
  4. package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json +4 -0
  5. package/artifacts/contracts/components/Distribution.sol/Distribution.json +670 -0
  6. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json +4 -0
  7. package/artifacts/contracts/{instance/component/IComponent.sol/IComponentModule.json → components/IBaseComponent.sol/IBaseComponent.json} +139 -104
  8. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.dbg.json +4 -0
  9. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.json +204 -0
  10. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.dbg.json +4 -0
  11. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.json +249 -0
  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 +614 -37
  16. package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
  17. package/artifacts/contracts/components/Product.sol/Product.json +590 -46
  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 +4 -0
  39. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.json +59 -0
  40. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.dbg.json +4 -0
  41. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.json +124 -0
  42. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.dbg.json +4 -0
  43. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.json +74 -0
  44. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.dbg.json +4 -0
  45. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.json +124 -0
  46. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.dbg.json +4 -0
  47. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.json +207 -0
  48. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.dbg.json +1 -1
  49. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.json +2 -2
  50. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.dbg.json +1 -1
  51. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.json +2 -2
  52. package/artifacts/contracts/instance/AccessManagedSimple.sol/AccessManagedSimple.dbg.json +4 -0
  53. package/artifacts/contracts/instance/AccessManagedSimple.sol/AccessManagedSimple.json +101 -0
  54. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.dbg.json +4 -0
  55. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.json +1132 -0
  56. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.dbg.json +4 -0
  57. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.json +1082 -0
  58. package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
  59. package/artifacts/contracts/instance/IInstance.sol/IInstance.json +273 -721
  60. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.dbg.json +4 -0
  61. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.json +480 -0
  62. package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
  63. package/artifacts/contracts/instance/Instance.sol/Instance.json +2995 -546
  64. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.dbg.json +4 -0
  65. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.json +917 -0
  66. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.dbg.json +4 -0
  67. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.json +1283 -0
  68. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.dbg.json +4 -0
  69. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.json +827 -0
  70. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.dbg.json +4 -0
  71. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.json +468 -0
  72. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +4 -0
  73. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.json +481 -0
  74. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.dbg.json +4 -0
  75. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.json +113 -0
  76. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.dbg.json +4 -0
  77. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.json +429 -0
  78. package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.dbg.json +4 -0
  79. package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.json +115 -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/module/IAccess.sol/IAccess.dbg.json +4 -0
  85. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.json +211 -0
  86. package/artifacts/contracts/instance/module/IBundle.sol/IBundle.dbg.json +4 -0
  87. package/artifacts/contracts/instance/{access/IAccess.sol/IAccess.json → module/IBundle.sol/IBundle.json} +2 -2
  88. package/artifacts/contracts/instance/module/IDistribution.sol/IDistribution.dbg.json +4 -0
  89. package/artifacts/contracts/instance/module/IDistribution.sol/IDistribution.json +10 -0
  90. package/artifacts/contracts/instance/module/IPolicy.sol/IPolicy.dbg.json +4 -0
  91. package/artifacts/contracts/instance/{policy → module}/IPolicy.sol/IPolicy.json +1 -1
  92. package/artifacts/contracts/instance/module/IRisk.sol/IRisk.dbg.json +4 -0
  93. package/artifacts/contracts/instance/{pool/IPoolModule.sol/IPool.json → module/IRisk.sol/IRisk.json} +2 -2
  94. package/artifacts/contracts/instance/module/ISetup.sol/ISetup.dbg.json +4 -0
  95. package/artifacts/contracts/instance/{component/IComponent.sol/IComponent.json → module/ISetup.sol/ISetup.json} +2 -2
  96. package/artifacts/contracts/instance/module/ITreasury.sol/ITreasury.dbg.json +4 -0
  97. package/artifacts/contracts/instance/module/ITreasury.sol/ITreasury.json +10 -0
  98. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.dbg.json +4 -0
  99. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.json +827 -0
  100. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.dbg.json +4 -0
  101. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.json +641 -0
  102. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.dbg.json +4 -0
  103. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.json +428 -0
  104. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.dbg.json +4 -0
  105. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.json +466 -0
  106. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.dbg.json +4 -0
  107. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.json +446 -0
  108. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +4 -0
  109. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +561 -0
  110. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +4 -0
  111. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +751 -0
  112. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
  113. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.json +239 -2
  114. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
  115. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.json +537 -63
  116. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.dbg.json +4 -0
  117. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.json +853 -0
  118. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.dbg.json +4 -0
  119. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.json +34 -0
  120. package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
  121. package/artifacts/contracts/registry/Registry.sol/Registry.json +676 -76
  122. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.dbg.json +4 -0
  123. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.json +1237 -0
  124. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.dbg.json +4 -0
  125. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.json +525 -0
  126. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.dbg.json +4 -0
  127. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.json +410 -0
  128. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.dbg.json +4 -0
  129. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.json +107 -0
  130. package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json +4 -0
  131. package/artifacts/contracts/shared/ERC165.sol/ERC165.json +35 -0
  132. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.dbg.json +4 -0
  133. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.json +127 -0
  134. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +4 -0
  135. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.json +201 -0
  136. package/artifacts/contracts/shared/IService.sol/IService.dbg.json +4 -0
  137. package/artifacts/contracts/shared/IService.sol/IService.json +421 -0
  138. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.dbg.json +4 -0
  139. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json +205 -0
  140. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.dbg.json +4 -0
  141. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.json +158 -0
  142. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.dbg.json +4 -0
  143. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.json +349 -0
  144. package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +4 -0
  145. package/artifacts/contracts/shared/Registerable.sol/Registerable.json +274 -0
  146. package/artifacts/contracts/shared/RegisterableUpgradable.sol/RegisterableUpgradable.dbg.json +4 -0
  147. package/artifacts/contracts/shared/RegisterableUpgradable.sol/RegisterableUpgradable.json +442 -0
  148. package/artifacts/contracts/shared/Service.sol/Service.dbg.json +4 -0
  149. package/artifacts/contracts/shared/Service.sol/Service.json +468 -0
  150. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.dbg.json +4 -0
  151. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.json +96 -0
  152. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.dbg.json +4 -0
  153. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.json +129 -0
  154. package/artifacts/contracts/shared/Versionable.sol/Versionable.dbg.json +4 -0
  155. package/artifacts/contracts/shared/Versionable.sol/Versionable.json +228 -0
  156. package/artifacts/contracts/test/TestFee.sol/TestFee.dbg.json +4 -0
  157. package/artifacts/contracts/test/TestFee.sol/TestFee.json +119 -0
  158. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.dbg.json +4 -0
  159. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.json +305 -0
  160. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.dbg.json +4 -0
  161. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.json +116 -0
  162. package/artifacts/contracts/test/TestService.sol/TestService.dbg.json +4 -0
  163. package/artifacts/contracts/test/TestService.sol/TestService.json +600 -0
  164. package/artifacts/contracts/test/TestToken.sol/TestUsdc.dbg.json +4 -0
  165. package/artifacts/contracts/test/TestToken.sol/TestUsdc.json +376 -0
  166. package/artifacts/contracts/test/TestVersion.sol/TestVersion.dbg.json +4 -0
  167. package/artifacts/contracts/test/TestVersion.sol/TestVersion.json +218 -0
  168. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.dbg.json +4 -0
  169. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.json +286 -0
  170. package/artifacts/contracts/test/Usdc.sol/USDC.dbg.json +4 -0
  171. package/artifacts/contracts/test/Usdc.sol/USDC.json +376 -0
  172. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.dbg.json +4 -0
  173. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.json +10 -0
  174. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
  175. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.json +2 -2
  176. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.dbg.json +1 -1
  177. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.json +2 -2
  178. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.dbg.json +4 -0
  179. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.json +104 -0
  180. package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +4 -0
  181. package/artifacts/contracts/types/Fee.sol/FeeLib.json +257 -0
  182. package/artifacts/contracts/types/Key32.sol/Key32Lib.dbg.json +4 -0
  183. package/artifacts/contracts/types/Key32.sol/Key32Lib.json +125 -0
  184. package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
  185. package/artifacts/contracts/types/NftId.sol/NftIdLib.json +65 -4
  186. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +4 -0
  187. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +10 -0
  188. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.dbg.json +4 -0
  189. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.json +100 -0
  190. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +4 -0
  191. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +92 -0
  192. package/artifacts/contracts/types/Referral.sol/ReferralLib.dbg.json +4 -0
  193. package/artifacts/contracts/types/Referral.sol/ReferralLib.json +123 -0
  194. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.dbg.json +4 -0
  195. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.json +86 -0
  196. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.dbg.json +4 -0
  197. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.json +156 -0
  198. package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +4 -0
  199. package/artifacts/contracts/types/StateId.sol/StateIdLib.json +92 -0
  200. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
  201. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.json +77 -2
  202. package/artifacts/contracts/types/UFixed.sol/MathLib.dbg.json +4 -0
  203. package/artifacts/contracts/types/UFixed.sol/MathLib.json +10 -0
  204. package/artifacts/contracts/types/UFixed.sol/UFixedLib.dbg.json +4 -0
  205. package/artifacts/contracts/types/UFixed.sol/UFixedLib.json +479 -0
  206. package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +4 -0
  207. package/artifacts/contracts/types/Version.sol/VersionLib.json +177 -0
  208. package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +4 -0
  209. package/artifacts/contracts/types/Version.sol/VersionPartLib.json +49 -0
  210. package/contracts/components/BaseComponent.sol +91 -0
  211. package/contracts/components/Distribution.sol +166 -0
  212. package/contracts/components/IBaseComponent.sol +25 -0
  213. package/contracts/components/IDistributionComponent.sol +46 -0
  214. package/contracts/components/IPoolComponent.sol +62 -0
  215. package/contracts/components/IProductComponent.sol +35 -0
  216. package/contracts/components/Pool.sol +247 -18
  217. package/contracts/components/Product.sol +267 -36
  218. package/contracts/experiment/cloning/Cloner.sol +47 -0
  219. package/contracts/experiment/errors/Require.sol +10 -5
  220. package/contracts/experiment/errors/Revert.sol +13 -8
  221. package/contracts/experiment/inheritance/A.sol +8 -11
  222. package/contracts/experiment/inheritance/B.sol +10 -5
  223. package/contracts/experiment/inheritance/C.sol +11 -5
  224. package/contracts/experiment/inheritance/IA.sol +2 -7
  225. package/contracts/experiment/inheritance/IB.sol +3 -2
  226. package/contracts/experiment/inheritance/IC.sol +4 -3
  227. package/contracts/experiment/statemachine/Dummy.sol +27 -0
  228. package/contracts/experiment/statemachine/ISM.sol +25 -0
  229. package/contracts/experiment/statemachine/SM.sol +57 -0
  230. package/contracts/experiment/statemachine/SimpleStateMachine.sol +31 -0
  231. package/contracts/experiment/types/TypeA.sol +14 -9
  232. package/contracts/experiment/types/TypeB.sol +14 -9
  233. package/contracts/instance/AccessManagedSimple.sol +115 -0
  234. package/contracts/instance/AccessManagerSimple.sol +692 -0
  235. package/contracts/instance/IAccessManagerSimple.sol +391 -0
  236. package/contracts/instance/IInstance.sol +28 -15
  237. package/contracts/instance/IInstanceService.sol +30 -0
  238. package/contracts/instance/Instance.sol +423 -44
  239. package/contracts/instance/InstanceAccessManager.sol +288 -0
  240. package/contracts/instance/InstanceReader.sol +290 -0
  241. package/contracts/instance/InstanceService.sol +158 -0
  242. package/contracts/instance/InstanceServiceManager.sol +56 -0
  243. package/contracts/instance/base/ComponentServiceBase.sol +39 -0
  244. package/contracts/instance/base/IInstanceBase.sol +23 -0
  245. package/contracts/instance/base/IKeyValueStore.sol +49 -0
  246. package/contracts/instance/base/ILifecycle.sol +30 -0
  247. package/contracts/instance/base/KeyValueStore.sol +172 -0
  248. package/contracts/instance/base/Lifecycle.sol +100 -0
  249. package/contracts/instance/module/IAccess.sol +38 -0
  250. package/contracts/instance/module/IBundle.sol +19 -0
  251. package/contracts/instance/module/IDistribution.sol +39 -0
  252. package/contracts/instance/module/IPolicy.sol +45 -0
  253. package/contracts/instance/module/IRisk.sol +11 -0
  254. package/contracts/instance/module/ISetup.sol +43 -0
  255. package/contracts/instance/module/ITreasury.sol +23 -0
  256. package/contracts/instance/service/ComponentOwnerService.sol +317 -0
  257. package/contracts/instance/service/DistributionService.sol +96 -0
  258. package/contracts/instance/service/DistributionServiceManager.sol +53 -0
  259. package/contracts/instance/service/IComponentOwnerService.sol +20 -0
  260. package/contracts/instance/service/IDistributionService.sol +12 -0
  261. package/contracts/instance/service/IPoolService.sol +37 -0
  262. package/contracts/instance/service/IProductService.sol +107 -0
  263. package/contracts/registry/ChainNft.sol +138 -109
  264. package/contracts/registry/IRegistry.sol +81 -57
  265. package/contracts/registry/IRegistryService.sol +33 -0
  266. package/contracts/registry/ITransferInterceptor.sol +6 -0
  267. package/contracts/registry/Registry.sol +427 -120
  268. package/contracts/registry/RegistryService.sol +399 -0
  269. package/contracts/registry/RegistryServiceManager.sol +80 -0
  270. package/contracts/registry/TokenRegistry.sol +111 -0
  271. package/contracts/shared/ContractDeployerLib.sol +72 -0
  272. package/contracts/shared/ERC165.sol +25 -0
  273. package/contracts/shared/INftOwnable.sol +22 -0
  274. package/contracts/shared/IRegisterable.sol +17 -0
  275. package/contracts/shared/IService.sol +15 -0
  276. package/contracts/shared/IVersionable.sol +96 -0
  277. package/contracts/shared/NftOwnable.sol +136 -0
  278. package/contracts/shared/ProxyManager.sol +94 -0
  279. package/contracts/shared/Registerable.sol +90 -0
  280. package/contracts/shared/RegisterableUpgradable.sol +16 -0
  281. package/contracts/shared/Service.sol +54 -0
  282. package/contracts/shared/TokenHandler.sol +27 -0
  283. package/contracts/shared/UpgradableProxyWithAdmin.sol +16 -0
  284. package/contracts/shared/Versionable.sol +147 -0
  285. package/contracts/test/TestFee.sol +25 -0
  286. package/contracts/test/TestRegisterable.sol +18 -0
  287. package/contracts/test/TestRoleId.sol +14 -0
  288. package/contracts/test/TestService.sol +24 -0
  289. package/contracts/test/TestToken.sol +26 -0
  290. package/contracts/test/TestVersion.sol +44 -0
  291. package/contracts/test/TestVersionable.sol +17 -0
  292. package/contracts/test/Usdc.sol +26 -0
  293. package/contracts/types/AddressSet.sol +58 -0
  294. package/contracts/types/Blocknumber.sol +76 -18
  295. package/contracts/types/ChainId.sol +18 -10
  296. package/contracts/types/DistributorType.sol +55 -0
  297. package/contracts/types/Fee.sol +56 -0
  298. package/contracts/types/Key32.sol +50 -0
  299. package/contracts/types/NftId.sol +48 -11
  300. package/contracts/types/NftIdSet.sol +60 -0
  301. package/contracts/types/NumberId.sol +52 -0
  302. package/contracts/types/ObjectType.sol +152 -0
  303. package/contracts/types/Referral.sol +85 -0
  304. package/contracts/types/RiskId.sol +43 -0
  305. package/contracts/types/RoleId.sol +88 -0
  306. package/contracts/types/StateId.sol +105 -0
  307. package/contracts/types/Timestamp.sol +89 -17
  308. package/contracts/types/UFixed.sol +189 -75
  309. package/contracts/types/Version.sol +107 -0
  310. package/package.json +21 -6
  311. package/artifacts/contracts/components/Component.sol/Component.dbg.json +0 -4
  312. package/artifacts/contracts/components/Component.sol/Component.json +0 -179
  313. package/artifacts/contracts/components/Component.sol/InstanceLinked.dbg.json +0 -4
  314. package/artifacts/contracts/components/Component.sol/InstanceLinked.json +0 -35
  315. package/artifacts/contracts/components/IPool.sol/IPoolComponent.dbg.json +0 -4
  316. package/artifacts/contracts/components/IPool.sol/IPoolComponent.json +0 -179
  317. package/artifacts/contracts/components/IProduct.sol/IProductComponent.dbg.json +0 -4
  318. package/artifacts/contracts/components/IProduct.sol/IProductComponent.json +0 -192
  319. package/artifacts/contracts/instance/access/Access.sol/AccessModule.dbg.json +0 -4
  320. package/artifacts/contracts/instance/access/Access.sol/AccessModule.json +0 -400
  321. package/artifacts/contracts/instance/access/IAccess.sol/IAccess.dbg.json +0 -4
  322. package/artifacts/contracts/instance/access/IAccess.sol/IAccessCheckRole.dbg.json +0 -4
  323. package/artifacts/contracts/instance/access/IAccess.sol/IAccessCheckRole.json +0 -35
  324. package/artifacts/contracts/instance/access/IAccess.sol/IAccessComponentTypeRoles.dbg.json +0 -4
  325. package/artifacts/contracts/instance/access/IAccess.sol/IAccessComponentTypeRoles.json +0 -50
  326. package/artifacts/contracts/instance/access/IAccess.sol/IAccessModule.dbg.json +0 -4
  327. package/artifacts/contracts/instance/access/IAccess.sol/IAccessModule.json +0 -336
  328. package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentModule.dbg.json +0 -4
  329. package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentOwnerService.dbg.json +0 -4
  330. package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentOwnerService.json +0 -147
  331. package/artifacts/contracts/instance/component/IComponent.sol/IComponent.dbg.json +0 -4
  332. package/artifacts/contracts/instance/component/IComponent.sol/IComponentContract.dbg.json +0 -4
  333. package/artifacts/contracts/instance/component/IComponent.sol/IComponentContract.json +0 -179
  334. package/artifacts/contracts/instance/component/IComponent.sol/IComponentModule.dbg.json +0 -4
  335. package/artifacts/contracts/instance/component/IComponent.sol/IComponentOwnerService.dbg.json +0 -4
  336. package/artifacts/contracts/instance/component/IComponent.sol/IComponentOwnerService.json +0 -94
  337. package/artifacts/contracts/instance/component/IComponent.sol/IInstanceLinked.dbg.json +0 -4
  338. package/artifacts/contracts/instance/component/IComponent.sol/IInstanceLinked.json +0 -24
  339. package/artifacts/contracts/instance/policy/IPolicy.sol/IPolicy.dbg.json +0 -4
  340. package/artifacts/contracts/instance/policy/IPolicy.sol/IPolicyModule.dbg.json +0 -4
  341. package/artifacts/contracts/instance/policy/IPolicy.sol/IPolicyModule.json +0 -231
  342. package/artifacts/contracts/instance/policy/PolicyModule.sol/PolicyModule.dbg.json +0 -4
  343. package/artifacts/contracts/instance/policy/PolicyModule.sol/PolicyModule.json +0 -231
  344. package/artifacts/contracts/instance/pool/IPoolModule.sol/IPool.dbg.json +0 -4
  345. package/artifacts/contracts/instance/pool/IPoolModule.sol/IPoolModule.dbg.json +0 -4
  346. package/artifacts/contracts/instance/pool/IPoolModule.sol/IPoolModule.json +0 -149
  347. package/artifacts/contracts/instance/pool/PoolModule.sol/PoolModule.dbg.json +0 -4
  348. package/artifacts/contracts/instance/pool/PoolModule.sol/PoolModule.json +0 -162
  349. package/artifacts/contracts/instance/product/IProductService.sol/IProductModule.dbg.json +0 -4
  350. package/artifacts/contracts/instance/product/IProductService.sol/IProductModule.json +0 -75
  351. package/artifacts/contracts/instance/product/IProductService.sol/IProductService.dbg.json +0 -4
  352. package/artifacts/contracts/instance/product/IProductService.sol/IProductService.json +0 -114
  353. package/artifacts/contracts/instance/product/ProductService.sol/ProductModule.dbg.json +0 -4
  354. package/artifacts/contracts/instance/product/ProductService.sol/ProductModule.json +0 -75
  355. package/artifacts/contracts/instance/product/ProductService.sol/ProductService.dbg.json +0 -4
  356. package/artifacts/contracts/instance/product/ProductService.sol/ProductService.json +0 -167
  357. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.dbg.json +0 -4
  358. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.json +0 -452
  359. package/artifacts/contracts/registry/IRegistry.sol/IOwnable.dbg.json +0 -4
  360. package/artifacts/contracts/registry/IRegistry.sol/IOwnable.json +0 -24
  361. package/artifacts/contracts/registry/IRegistry.sol/IRegisterable.dbg.json +0 -4
  362. package/artifacts/contracts/registry/IRegistry.sol/IRegisterable.json +0 -166
  363. package/artifacts/contracts/registry/IRegistry.sol/IRegistryLinked.dbg.json +0 -4
  364. package/artifacts/contracts/registry/IRegistry.sol/IRegistryLinked.json +0 -49
  365. package/artifacts/contracts/registry/Registry.sol/Registerable.dbg.json +0 -4
  366. package/artifacts/contracts/registry/Registry.sol/Registerable.json +0 -166
  367. package/artifacts/contracts/registry/Registry.sol/RegistryLinked.dbg.json +0 -4
  368. package/artifacts/contracts/registry/Registry.sol/RegistryLinked.json +0 -60
  369. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.dbg.json +0 -4
  370. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.json +0 -453
  371. package/contracts/components/Component.sol +0 -62
  372. package/contracts/components/IPool.sol +0 -9
  373. package/contracts/components/IProduct.sol +0 -12
  374. package/contracts/instance/access/Access.sol +0 -218
  375. package/contracts/instance/access/IAccess.sol +0 -83
  376. package/contracts/instance/component/ComponentModule.sol +0 -248
  377. package/contracts/instance/component/IComponent.sol +0 -95
  378. package/contracts/instance/policy/IPolicy.sol +0 -66
  379. package/contracts/instance/policy/PolicyModule.sol +0 -107
  380. package/contracts/instance/pool/IPoolModule.sol +0 -41
  381. package/contracts/instance/pool/PoolModule.sol +0 -86
  382. package/contracts/instance/product/IProductService.sol +0 -46
  383. package/contracts/instance/product/ProductService.sol +0 -108
  384. package/contracts/registry/IChainNft.sol +0 -18
@@ -0,0 +1,105 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ // uint96 allows for chain ids up to 13 digits
5
+ type StateId is uint8;
6
+
7
+ // type bindings
8
+ using {
9
+ eqStateId as ==,
10
+ neStateId as !=,
11
+ StateIdLib.eqz,
12
+ StateIdLib.gtz,
13
+ StateIdLib.toInt
14
+ } for StateId global;
15
+
16
+ // general pure free functions
17
+ function APPLIED() pure returns (StateId) {
18
+ return toStateId(10);
19
+ }
20
+
21
+ function REVOKED() pure returns (StateId) {
22
+ return toStateId(20);
23
+ }
24
+
25
+ function DECLINED() pure returns (StateId) {
26
+ return toStateId(30);
27
+ }
28
+
29
+ function UNDERWRITTEN() pure returns (StateId) {
30
+ return toStateId(40);
31
+ }
32
+
33
+ function CONFIRMED() pure returns (StateId) {
34
+ return toStateId(50);
35
+ }
36
+
37
+ function EXPECTED() pure returns (StateId) {
38
+ return toStateId(60);
39
+ }
40
+
41
+ function ACTIVE() pure returns (StateId) {
42
+ return toStateId(100);
43
+ }
44
+
45
+ function PAUSED() pure returns (StateId) {
46
+ return toStateId(110);
47
+ }
48
+
49
+ function CLOSED() pure returns (StateId) {
50
+ return toStateId(200);
51
+ }
52
+
53
+ function ARCHIVED() pure returns (StateId) {
54
+ return toStateId(210);
55
+ }
56
+
57
+ function PAID() pure returns (StateId) {
58
+ return toStateId(220);
59
+ }
60
+
61
+ function KEEP_STATE() pure returns (StateId) {
62
+ return toStateId(type(uint8).max);
63
+ }
64
+
65
+ /// @dev Converts the uint8 to a StateId.
66
+ function toStateId(uint256 id) pure returns (StateId) {
67
+ return StateId.wrap(uint8(id));
68
+ }
69
+
70
+ /// @dev Return the StateId zero (0)
71
+ function zeroStateId() pure returns (StateId) {
72
+ return StateId.wrap(0);
73
+ }
74
+
75
+ // pure free functions for operators
76
+ function eqStateId(StateId a, StateId b) pure returns (bool isSame) {
77
+ return StateId.unwrap(a) == StateId.unwrap(b);
78
+ }
79
+
80
+ function neStateId(StateId a, StateId b) pure returns (bool isDifferent) {
81
+ return StateId.unwrap(a) != StateId.unwrap(b);
82
+ }
83
+
84
+ // library functions that operate on user defined type
85
+ library StateIdLib {
86
+ /// @dev Converts the NftId to a uint256.
87
+ function toInt(StateId stateId) public pure returns (uint96) {
88
+ return uint96(StateId.unwrap(stateId));
89
+ }
90
+
91
+ /// @dev Returns true if the value is non-zero (> 0).
92
+ function gtz(StateId a) public pure returns (bool) {
93
+ return StateId.unwrap(a) > 0;
94
+ }
95
+
96
+ /// @dev Returns true if the value is zero (== 0).
97
+ function eqz(StateId a) public pure returns (bool) {
98
+ return StateId.unwrap(a) == 0;
99
+ }
100
+
101
+ /// @dev Returns true if the values are equal (==).
102
+ function eq(StateId a, StateId b) public pure returns (bool isSame) {
103
+ return eqStateId(a, b);
104
+ }
105
+ }
@@ -9,47 +9,119 @@ 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
16
- function gtTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) > Timestamp.unwrap(b); }
19
+ function gtTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
20
+ return Timestamp.unwrap(a) > Timestamp.unwrap(b);
21
+ }
22
+
17
23
  /// @dev return true if Timestamp a is after or equal to Timestamp b
18
- function gteTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) >= Timestamp.unwrap(b); }
24
+ function gteTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
25
+ return Timestamp.unwrap(a) >= Timestamp.unwrap(b);
26
+ }
19
27
 
20
28
  /// @dev return true if Timestamp a is before Timestamp b
21
- function ltTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) < Timestamp.unwrap(b); }
29
+ function ltTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
30
+ return Timestamp.unwrap(a) < Timestamp.unwrap(b);
31
+ }
32
+
22
33
  /// @dev return true if Timestamp a is before or equal to Timestamp b
23
- function lteTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) <= Timestamp.unwrap(b); }
34
+ function lteTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
35
+ return Timestamp.unwrap(a) <= Timestamp.unwrap(b);
36
+ }
24
37
 
25
38
  /// @dev return true if Timestamp a is equal to Timestamp b
26
- function eqTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) == Timestamp.unwrap(b); }
39
+ function eqTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
40
+ return Timestamp.unwrap(a) == Timestamp.unwrap(b);
41
+ }
42
+
27
43
  /// @dev return true if Timestamp a is not equal to Timestamp b
28
- function neTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) != Timestamp.unwrap(b); }
44
+ function neTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
45
+ return Timestamp.unwrap(a) != Timestamp.unwrap(b);
46
+ }
29
47
 
30
48
  /// @dev Converts the uint256 to a Timestamp.
31
- function toTimestamp(uint256 timestamp) pure returns(Timestamp) { return Timestamp.wrap(uint40(timestamp));}
49
+ function toTimestamp(uint256 timestamp) pure returns (Timestamp) {
50
+ return Timestamp.wrap(uint40(timestamp));
51
+ }
32
52
 
33
- function blockTimestamp() view returns(Timestamp) { return toTimestamp(block.timestamp); }
53
+ // function blockTimestamp() view returns (Timestamp) {
54
+ // return toTimestamp(block.timestamp);
55
+ // }
34
56
 
35
57
  /// @dev Return the Timestamp zero (0)
36
- function zeroTimestamp() pure returns(Timestamp) { return toTimestamp(0); }
58
+ function zeroTimestamp() pure returns (Timestamp) {
59
+ return toTimestamp(0);
60
+ }
37
61
 
38
62
  library TimestampLib {
63
+ function blockTimestamp() public view returns (Timestamp) {
64
+ return Timestamp.wrap(uint40(block.timestamp));
65
+ }
66
+
39
67
  /// @dev return true if Timestamp a is after Timestamp b
40
- function gt(Timestamp a, Timestamp b) public pure returns(bool isAfter) { return gtTimestamp(a, b); }
68
+ function gt(Timestamp a, Timestamp b) public pure returns (bool isAfter) {
69
+ return gtTimestamp(a, b);
70
+ }
71
+
41
72
  /// @dev return true if Timestamp a is after or the same than Timestamp b
42
- function gte(Timestamp a, Timestamp b) public pure returns(bool isAfterOrSame) { return gteTimestamp(a, b); }
73
+ function gte(
74
+ Timestamp a,
75
+ Timestamp b
76
+ ) public pure returns (bool isAfterOrSame) {
77
+ return gteTimestamp(a, b);
78
+ }
43
79
 
44
80
  /// @dev return true if Timestamp a is before Timestamp b
45
- function lt(Timestamp a, Timestamp b) public pure returns(bool isBefore) { return ltTimestamp(a, b); }
81
+ function lt(Timestamp a, Timestamp b) public pure returns (bool isBefore) {
82
+ return ltTimestamp(a, b);
83
+ }
84
+
46
85
  /// @dev return true if Timestamp a is before or the same than Timestamp b
47
- function lte(Timestamp a, Timestamp b) public pure returns(bool isBeforeOrSame) { return lteTimestamp(a, b); }
86
+ function lte(
87
+ Timestamp a,
88
+ Timestamp b
89
+ ) public pure returns (bool isBeforeOrSame) {
90
+ return lteTimestamp(a, b);
91
+ }
48
92
 
49
93
  /// @dev return true if Timestamp a is equal to Timestamp b
50
- function eq(Timestamp a, Timestamp b) public pure returns(bool isSame) { return eqTimestamp(a, b); }
94
+ function eq(Timestamp a, Timestamp b) public pure returns (bool isSame) {
95
+ return eqTimestamp(a, b);
96
+ }
97
+
98
+ /// @dev return true if Timestamp a is not equal to Timestamp b
99
+ function ne(
100
+ Timestamp a,
101
+ Timestamp b
102
+ ) public pure returns (bool isDifferent) {
103
+ return neTimestamp(a, b);
104
+ }
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
+
51
116
  /// @dev return true if Timestamp a is not equal to Timestamp b
52
- function ne(Timestamp a, Timestamp b) public pure returns(bool isDifferent) { return neTimestamp(a, b); }
117
+ function addSeconds(
118
+ Timestamp timestamp,
119
+ uint256 timeDelta
120
+ ) public pure returns (Timestamp) {
121
+ return toTimestamp(Timestamp.unwrap(timestamp) + uint40(timeDelta));
122
+ }
53
123
 
54
- function toInt(Timestamp timestamp) public pure returns(uint256) { return uint256(uint40(Timestamp.unwrap(timestamp))); }
124
+ function toInt(Timestamp timestamp) public pure returns (uint256) {
125
+ return uint256(uint40(Timestamp.unwrap(timestamp)));
126
+ }
55
127
  }
@@ -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,197 +13,313 @@ 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
 
21
- function addUFixed(UFixed a, UFixed b) pure returns(UFixed) {
22
+ function zeroUFixed() pure returns (UFixed zero) {
23
+ return UFixed.wrap(0);
24
+ }
25
+
26
+ function addUFixed(UFixed a, UFixed b) pure returns (UFixed) {
22
27
  return UFixed.wrap(UFixed.unwrap(a) + UFixed.unwrap(b));
23
28
  }
24
29
 
25
- function subUFixed(UFixed a, UFixed b) pure returns(UFixed) {
30
+ function subUFixed(UFixed a, UFixed b) pure returns (UFixed) {
26
31
  require(a >= b, "ERROR:UFM-010:NEGATIVE_RESULT");
27
32
  return UFixed.wrap(UFixed.unwrap(a) - UFixed.unwrap(b));
28
33
  }
29
34
 
30
- function mulUFixed(UFixed a, UFixed b) pure returns(UFixed) {
31
- return UFixed.wrap(Math.mulDiv(UFixed.unwrap(a), UFixed.unwrap(b), 10 ** 18));
35
+ function mulUFixed(UFixed a, UFixed b) pure returns (UFixed) {
36
+ return
37
+ UFixed.wrap(MathLib.mulDiv(UFixed.unwrap(a), UFixed.unwrap(b), 10 ** 18));
32
38
  }
33
39
 
34
- function divUFixed(UFixed a, UFixed b) pure returns(UFixed) {
40
+ function divUFixed(UFixed a, UFixed b) pure returns (UFixed) {
35
41
  require(UFixed.unwrap(b) > 0, "ERROR:UFM-020:DIVISOR_ZERO");
36
42
 
37
- return UFixed.wrap(
38
- Math.mulDiv(
39
- UFixed.unwrap(a),
40
- 10 ** 18,
41
- UFixed.unwrap(b)));
43
+ return
44
+ UFixed.wrap(MathLib.mulDiv(UFixed.unwrap(a), 10 ** 18, UFixed.unwrap(b)));
42
45
  }
43
46
 
44
- function gtUFixed(UFixed a, UFixed b) pure returns(bool isGreaterThan) {
47
+ function gtUFixed(UFixed a, UFixed b) pure returns (bool isGreaterThan) {
45
48
  return UFixed.unwrap(a) > UFixed.unwrap(b);
46
49
  }
47
50
 
48
- function gteUFixed(UFixed a, UFixed b) pure returns(bool isGreaterThan) {
51
+ function gteUFixed(UFixed a, UFixed b) pure returns (bool isGreaterThan) {
49
52
  return UFixed.unwrap(a) >= UFixed.unwrap(b);
50
53
  }
51
54
 
52
- function ltUFixed(UFixed a, UFixed b) pure returns(bool isGreaterThan) {
55
+ function ltUFixed(UFixed a, UFixed b) pure returns (bool isGreaterThan) {
53
56
  return UFixed.unwrap(a) < UFixed.unwrap(b);
54
57
  }
55
58
 
56
- function lteUFixed(UFixed a, UFixed b) pure returns(bool isGreaterThan) {
59
+ function lteUFixed(UFixed a, UFixed b) pure returns (bool isGreaterThan) {
57
60
  return UFixed.unwrap(a) <= UFixed.unwrap(b);
58
61
  }
59
62
 
60
- function eqUFixed(UFixed a, UFixed b) pure returns(bool isEqual) {
63
+ function eqUFixed(UFixed a, UFixed b) pure returns (bool isEqual) {
61
64
  return UFixed.unwrap(a) == UFixed.unwrap(b);
62
65
  }
63
66
 
64
- function gtzUFixed(UFixed a) pure returns(bool isZero) {
67
+ function neUFixed(UFixed a, UFixed b) pure returns (bool isEqual) {
68
+ return UFixed.unwrap(a) != UFixed.unwrap(b);
69
+ }
70
+
71
+ function gtzUFixed(UFixed a) pure returns (bool isZero) {
65
72
  return UFixed.unwrap(a) > 0;
66
73
  }
67
74
 
68
- function eqzUFixed(UFixed a) pure returns(bool isZero) {
75
+ function eqzUFixed(UFixed a) pure returns (bool isZero) {
69
76
  return UFixed.unwrap(a) == 0;
70
77
  }
71
78
 
72
- function deltaUFixed(UFixed a, UFixed b) pure returns(UFixed) {
73
- if(a > b) {
79
+ function deltaUFixed(UFixed a, UFixed b) pure returns (UFixed) {
80
+ if (a > b) {
74
81
  return a - b;
75
82
  }
76
83
 
77
84
  return b - a;
78
85
  }
79
86
 
80
- library UFixedMathLib {
87
+ /// @dev copied from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.3/contracts/utils/math/Math.sol
88
+ library MathLib {
81
89
 
82
90
  enum Rounding {
83
- /// @dev Round down - floor(value)
84
- Down,
85
- /// @dev Round up - ceil(value)
86
- Up,
87
- /// @dev Round half up - round(value)
88
- HalfUp
91
+ Down, // Toward negative infinity
92
+ Up, // Toward infinity
93
+ Zero // Toward zero
94
+ }
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;
89
191
  }
90
192
 
193
+ }
194
+
195
+ library UFixedLib {
91
196
  int8 public constant EXP = 18;
92
197
  uint256 public constant MULTIPLIER = 10 ** uint256(int256(EXP));
93
198
  uint256 public constant MULTIPLIER_HALF = MULTIPLIER / 2;
94
-
95
- /// @dev Default rounding mode used by ftoi is HalfUp
96
- Rounding public constant ROUNDING_DEFAULT = Rounding.HalfUp;
97
199
 
98
- /// @dev returns the decimals precision of the UFixed type
99
- function decimals() public pure returns(uint256) {
100
- return uint8(EXP);
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
+ }
204
+
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);
101
213
  }
102
214
 
103
215
  /// @dev Converts the uint256 to a UFixed.
104
- function itof(uint256 a)
105
- public
106
- pure
107
- returns(UFixed)
108
- {
216
+ function toUFixed(uint256 a) public pure returns (UFixed) {
109
217
  return UFixed.wrap(a * MULTIPLIER);
110
218
  }
111
219
 
112
220
  /// @dev Converts the uint256 to a UFixed with given exponent.
113
- function itof(uint256 a, int8 exp)
114
- public
115
- pure
116
- returns(UFixed)
117
- {
221
+ function toUFixed(uint256 a, int8 exp) public pure returns (UFixed) {
118
222
  require(EXP + exp >= 0, "ERROR:FM-010:EXPONENT_TOO_SMALL");
119
223
  require(EXP + exp <= 64, "ERROR:FM-011:EXPONENT_TOO_LARGE");
120
224
 
121
225
  return UFixed.wrap(a * 10 ** uint8(EXP + exp));
122
226
  }
123
227
 
228
+ /// @dev returns the decimals precision of the UFixed type
229
+ function decimals() public pure returns (uint256) {
230
+ return uint8(EXP);
231
+ }
232
+
124
233
  /// @dev Converts a UFixed to a uint256.
125
- function ftoi(UFixed a)
126
- public
127
- pure
128
- returns(uint256)
129
- {
130
- return ftoi(a, ROUNDING_DEFAULT);
234
+ function toInt(UFixed a) public pure returns (uint256) {
235
+ return toIntWithRounding(a, ROUNDING_HALF_UP());
131
236
  }
132
237
 
133
238
  /// @dev Converts a UFixed to a uint256 with given rounding mode.
134
- function ftoi(UFixed a, Rounding rounding)
135
- public
136
- pure
137
- returns(uint256)
138
- {
139
- if(rounding == Rounding.HalfUp) {
140
- return Math.mulDiv(UFixed.unwrap(a) + MULTIPLIER_HALF, 1, MULTIPLIER, Math.Rounding.Down);
141
- } else if(rounding == Rounding.Down) {
142
- return Math.mulDiv(UFixed.unwrap(a), 1, MULTIPLIER, Math.Rounding.Down);
239
+ function toIntWithRounding(UFixed a, uint8 rounding) public pure returns (uint256) {
240
+ if (rounding == ROUNDING_HALF_UP()) {
241
+ return
242
+ MathLib.mulDiv(
243
+ UFixed.unwrap(a) + MULTIPLIER_HALF,
244
+ 1,
245
+ MULTIPLIER,
246
+ MathLib.Rounding.Down
247
+ );
248
+ } else if (rounding == ROUNDING_DOWN()) {
249
+ return
250
+ MathLib.mulDiv(
251
+ UFixed.unwrap(a),
252
+ 1,
253
+ MULTIPLIER,
254
+ MathLib.Rounding.Down
255
+ );
143
256
  } else {
144
- return Math.mulDiv(UFixed.unwrap(a), 1, MULTIPLIER, Math.Rounding.Up);
257
+ return
258
+ MathLib.mulDiv(UFixed.unwrap(a), 1, MULTIPLIER, MathLib.Rounding.Up);
145
259
  }
146
260
  }
147
261
 
148
262
  /// @dev adds two UFixed numbers
149
- function add(UFixed a, UFixed b) public pure returns(UFixed) {
263
+ function add(UFixed a, UFixed b) public pure returns (UFixed) {
150
264
  return addUFixed(a, b);
151
265
  }
152
266
 
153
267
  /// @dev subtracts two UFixed numbers
154
- function sub(UFixed a, UFixed b) public pure returns(UFixed) {
268
+ function sub(UFixed a, UFixed b) public pure returns (UFixed) {
155
269
  return subUFixed(a, b);
156
270
  }
157
271
 
158
272
  /// @dev multiplies two UFixed numbers
159
- function mul(UFixed a, UFixed b) public pure returns(UFixed) {
273
+ function mul(UFixed a, UFixed b) public pure returns (UFixed) {
160
274
  return mulUFixed(a, b);
161
275
  }
162
276
 
163
277
  /// @dev divides two UFixed numbers
164
- function div(UFixed a, UFixed b) public pure returns(UFixed) {
278
+ function div(UFixed a, UFixed b) public pure returns (UFixed) {
165
279
  return divUFixed(a, b);
166
280
  }
167
281
 
168
282
  /// @dev return true if UFixed a is greater than UFixed b
169
- function gt(UFixed a, UFixed b) public pure returns(bool isGreaterThan) {
283
+ function gt(UFixed a, UFixed b) public pure returns (bool isGreaterThan) {
170
284
  return gtUFixed(a, b);
171
285
  }
172
286
 
173
287
  /// @dev return true if UFixed a is greater than or equal to UFixed b
174
- function gte(UFixed a, UFixed b) public pure returns(bool isGreaterThan) {
288
+ function gte(UFixed a, UFixed b) public pure returns (bool isGreaterThan) {
175
289
  return gteUFixed(a, b);
176
290
  }
177
291
 
178
292
  /// @dev return true if UFixed a is less than UFixed b
179
- function lt(UFixed a, UFixed b) public pure returns(bool isGreaterThan) {
293
+ function lt(UFixed a, UFixed b) public pure returns (bool isGreaterThan) {
180
294
  return ltUFixed(a, b);
181
295
  }
182
296
 
183
297
  /// @dev return true if UFixed a is less than or equal to UFixed b
184
- function lte(UFixed a, UFixed b) public pure returns(bool isGreaterThan) {
298
+ function lte(UFixed a, UFixed b) public pure returns (bool isGreaterThan) {
185
299
  return lteUFixed(a, b);
186
300
  }
187
301
 
188
302
  /// @dev return true if UFixed a is equal to UFixed b
189
- function eq(UFixed a, UFixed b) public pure returns(bool isEqual) {
303
+ function eq(UFixed a, UFixed b) public pure returns (bool isEqual) {
190
304
  return eqUFixed(a, b);
191
305
  }
192
306
 
193
307
  /// @dev return true if UFixed a is not zero
194
- function gtz(UFixed a) public pure returns(bool isZero) {
308
+ function gtz(UFixed a) public pure returns (bool isZero) {
195
309
  return gtzUFixed(a);
196
310
  }
197
311
 
198
312
  /// @dev return true if UFixed a is zero
199
- function eqz(UFixed a) public pure returns(bool isZero) {
313
+ function eqz(UFixed a) public pure returns (bool isZero) {
200
314
  return eqzUFixed(a);
201
315
  }
202
316
 
203
- function zero() public pure returns(UFixed) {
317
+ function zero() public pure returns (UFixed) {
204
318
  return UFixed.wrap(0);
205
319
  }
206
320
 
207
321
  /// @dev return the absolute delta between two UFixed numbers
208
- function delta(UFixed a, UFixed b) public pure returns(UFixed) {
322
+ function delta(UFixed a, UFixed b) public pure returns (UFixed) {
209
323
  return deltaUFixed(a, b);
210
324
  }
211
325
  }