@etherisc/gif-next 0.0.2-e6ad61d-739 → 0.0.2-e9148e0-933

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (386) hide show
  1. package/README.md +268 -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} +171 -143
  4. package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json +4 -0
  5. package/artifacts/contracts/components/Distribution.sol/Distribution.json +618 -0
  6. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json +4 -0
  7. package/artifacts/contracts/components/{IPool.sol/IPoolComponent.json → IBaseComponent.sol/IBaseComponent.json} +136 -111
  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 +531 -77
  16. package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
  17. package/artifacts/contracts/components/Product.sol/Product.json +470 -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/Revert.sol/Revert.dbg.json +1 -1
  26. package/artifacts/contracts/experiment/inheritance/A.sol/A.dbg.json +1 -1
  27. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.dbg.json +1 -1
  28. package/artifacts/contracts/experiment/inheritance/B.sol/B.dbg.json +1 -1
  29. package/artifacts/contracts/experiment/inheritance/C.sol/C.dbg.json +1 -1
  30. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.dbg.json +1 -1
  31. package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.dbg.json +1 -1
  32. package/artifacts/contracts/experiment/inheritance/IB.sol/IB.dbg.json +1 -1
  33. package/artifacts/contracts/experiment/inheritance/IC.sol/IC.dbg.json +1 -1
  34. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.dbg.json +1 -1
  35. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.json +2 -2
  36. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.dbg.json +1 -1
  37. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.dbg.json +1 -1
  38. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.dbg.json +1 -1
  39. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.json +2 -2
  40. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.dbg.json +1 -1
  41. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.json +2 -2
  42. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.dbg.json +1 -1
  43. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.dbg.json +1 -1
  44. package/artifacts/contracts/instance/AccessManagedSimple.sol/AccessManagedSimple.dbg.json +4 -0
  45. package/artifacts/contracts/instance/AccessManagedSimple.sol/AccessManagedSimple.json +101 -0
  46. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.dbg.json +4 -0
  47. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.json +1132 -0
  48. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.dbg.json +4 -0
  49. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.json +1082 -0
  50. package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
  51. package/artifacts/contracts/instance/IInstance.sol/IInstance.json +536 -1084
  52. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.dbg.json +4 -0
  53. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.json +480 -0
  54. package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
  55. package/artifacts/contracts/instance/Instance.sol/Instance.json +2805 -978
  56. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.dbg.json +4 -0
  57. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.json +917 -0
  58. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.dbg.json +4 -0
  59. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.json +1388 -0
  60. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.dbg.json +4 -0
  61. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.json +931 -0
  62. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.dbg.json +4 -0
  63. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.json +508 -0
  64. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +4 -0
  65. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.json +540 -0
  66. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.dbg.json +4 -0
  67. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.json +113 -0
  68. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.dbg.json +4 -0
  69. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.json +429 -0
  70. package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.dbg.json +4 -0
  71. package/artifacts/contracts/instance/{lifecycle/ILifecycle.sol/ILifecycleModule.json → base/ILifecycle.sol/ILifecycle.json} +10 -77
  72. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.dbg.json +4 -0
  73. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.json +502 -0
  74. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.dbg.json +4 -0
  75. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.json +169 -0
  76. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.dbg.json +4 -0
  77. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.json +211 -0
  78. package/artifacts/contracts/instance/module/IBundle.sol/IBundle.dbg.json +4 -0
  79. package/artifacts/contracts/instance/{access/IAccess.sol/IAccess.json → module/IBundle.sol/IBundle.json} +2 -2
  80. package/artifacts/contracts/instance/module/IDistribution.sol/IDistribution.dbg.json +4 -0
  81. package/artifacts/contracts/instance/{component/IComponent.sol/IComponent.json → module/IDistribution.sol/IDistribution.json} +2 -2
  82. package/artifacts/contracts/instance/module/IPolicy.sol/IPolicy.dbg.json +4 -0
  83. package/artifacts/contracts/instance/{policy → module}/IPolicy.sol/IPolicy.json +1 -1
  84. package/artifacts/contracts/instance/module/IRisk.sol/IRisk.dbg.json +4 -0
  85. package/artifacts/contracts/instance/{pool/IPoolModule.sol/IPool.json → module/IRisk.sol/IRisk.json} +2 -2
  86. package/artifacts/contracts/instance/module/ISetup.sol/ISetup.dbg.json +4 -0
  87. package/artifacts/contracts/instance/module/ISetup.sol/ISetup.json +10 -0
  88. package/artifacts/contracts/instance/module/ITreasury.sol/ITreasury.dbg.json +4 -0
  89. package/artifacts/contracts/instance/{treasury → module}/ITreasury.sol/ITreasury.json +1 -1
  90. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.dbg.json +4 -0
  91. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.json +827 -0
  92. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.dbg.json +4 -0
  93. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.json +716 -0
  94. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.dbg.json +4 -0
  95. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.json +444 -0
  96. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.dbg.json +4 -0
  97. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.json +466 -0
  98. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.dbg.json +4 -0
  99. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.json +446 -0
  100. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +4 -0
  101. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +561 -0
  102. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +4 -0
  103. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +751 -0
  104. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.dbg.json +4 -0
  105. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.json +839 -0
  106. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.dbg.json +4 -0
  107. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.json +448 -0
  108. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.dbg.json +4 -0
  109. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.json +1058 -0
  110. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.dbg.json +4 -0
  111. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.json +448 -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 +465 -27
  116. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.dbg.json +4 -0
  117. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.json +947 -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 +596 -43
  122. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.dbg.json +4 -0
  123. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.json +1293 -0
  124. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.dbg.json +4 -0
  125. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.json +513 -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/{components/Component.sol/Component.json → shared/IRegisterable.sol/IRegisterable.json} +98 -102
  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/ChainId.sol/ChainIdLib.dbg.json +1 -1
  176. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.dbg.json +4 -0
  177. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.json +104 -0
  178. package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +4 -0
  179. package/artifacts/contracts/types/Fee.sol/FeeLib.json +257 -0
  180. package/artifacts/contracts/types/Key32.sol/Key32Lib.dbg.json +4 -0
  181. package/artifacts/contracts/types/Key32.sol/Key32Lib.json +125 -0
  182. package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
  183. package/artifacts/contracts/types/NftId.sol/NftIdLib.json +65 -4
  184. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +4 -0
  185. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +10 -0
  186. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.dbg.json +4 -0
  187. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.json +100 -0
  188. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +1 -1
  189. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +2 -2
  190. package/artifacts/contracts/types/Referral.sol/ReferralLib.dbg.json +4 -0
  191. package/artifacts/contracts/types/Referral.sol/ReferralLib.json +123 -0
  192. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.dbg.json +4 -0
  193. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.json +86 -0
  194. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.dbg.json +4 -0
  195. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.json +156 -0
  196. package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +1 -1
  197. package/artifacts/contracts/types/StateId.sol/StateIdLib.json +2 -2
  198. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
  199. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.json +77 -2
  200. package/artifacts/contracts/types/UFixed.sol/MathLib.dbg.json +4 -0
  201. package/artifacts/contracts/types/UFixed.sol/MathLib.json +10 -0
  202. package/artifacts/contracts/types/UFixed.sol/UFixedLib.dbg.json +4 -0
  203. package/artifacts/contracts/types/UFixed.sol/UFixedLib.json +479 -0
  204. package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +4 -0
  205. package/artifacts/contracts/types/Version.sol/VersionLib.json +177 -0
  206. package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +4 -0
  207. package/artifacts/contracts/types/Version.sol/VersionPartLib.json +49 -0
  208. package/contracts/components/BaseComponent.sol +91 -0
  209. package/contracts/components/Distribution.sol +159 -0
  210. package/contracts/components/IBaseComponent.sol +25 -0
  211. package/contracts/components/IDistributionComponent.sol +44 -0
  212. package/contracts/components/IPoolComponent.sol +62 -0
  213. package/contracts/components/IProductComponent.sol +35 -0
  214. package/contracts/components/Pool.sol +215 -25
  215. package/contracts/components/Product.sol +240 -45
  216. package/contracts/experiment/cloning/Cloner.sol +47 -0
  217. package/contracts/instance/AccessManagedSimple.sol +115 -0
  218. package/contracts/instance/AccessManagerSimple.sol +692 -0
  219. package/contracts/instance/IAccessManagerSimple.sol +391 -0
  220. package/contracts/instance/IInstance.sol +40 -24
  221. package/contracts/instance/IInstanceService.sol +30 -0
  222. package/contracts/instance/Instance.sol +423 -52
  223. package/contracts/instance/InstanceAccessManager.sol +288 -0
  224. package/contracts/instance/InstanceReader.sol +306 -0
  225. package/contracts/instance/InstanceService.sol +192 -0
  226. package/contracts/instance/InstanceServiceManager.sol +57 -0
  227. package/contracts/instance/base/ComponentServiceBase.sol +124 -0
  228. package/contracts/instance/base/IInstanceBase.sol +23 -0
  229. package/contracts/instance/base/IKeyValueStore.sol +49 -0
  230. package/contracts/instance/base/ILifecycle.sol +30 -0
  231. package/contracts/instance/base/KeyValueStore.sol +172 -0
  232. package/contracts/instance/base/Lifecycle.sol +100 -0
  233. package/contracts/instance/module/IAccess.sol +38 -0
  234. package/contracts/instance/module/IBundle.sol +20 -0
  235. package/contracts/instance/module/IDistribution.sol +39 -0
  236. package/contracts/instance/module/IPolicy.sol +45 -0
  237. package/contracts/instance/module/IRisk.sol +11 -0
  238. package/contracts/instance/module/ISetup.sol +44 -0
  239. package/contracts/instance/module/ITreasury.sol +23 -0
  240. package/contracts/instance/service/ComponentOwnerService.sol +317 -0
  241. package/contracts/instance/service/DistributionService.sol +88 -0
  242. package/contracts/instance/service/DistributionServiceManager.sol +54 -0
  243. package/contracts/instance/service/IComponentOwnerService.sol +20 -0
  244. package/contracts/instance/service/IDistributionService.sol +12 -0
  245. package/contracts/instance/service/IPoolService.sol +37 -0
  246. package/contracts/instance/service/IProductService.sol +107 -0
  247. package/contracts/instance/service/PoolService.sol +194 -0
  248. package/contracts/instance/service/PoolServiceManager.sol +54 -0
  249. package/contracts/instance/service/ProductService.sol +548 -0
  250. package/contracts/instance/service/ProductServiceManager.sol +54 -0
  251. package/contracts/registry/ChainNft.sol +129 -62
  252. package/contracts/registry/IRegistry.sol +55 -43
  253. package/contracts/registry/IRegistryService.sol +50 -0
  254. package/contracts/registry/ITransferInterceptor.sol +6 -0
  255. package/contracts/registry/Registry.sol +388 -126
  256. package/contracts/registry/RegistryService.sol +358 -0
  257. package/contracts/registry/RegistryServiceManager.sol +80 -0
  258. package/contracts/registry/TokenRegistry.sol +111 -0
  259. package/contracts/shared/ContractDeployerLib.sol +72 -0
  260. package/contracts/shared/ERC165.sol +25 -0
  261. package/contracts/shared/INftOwnable.sol +22 -0
  262. package/contracts/shared/IRegisterable.sol +17 -0
  263. package/contracts/shared/IService.sol +15 -0
  264. package/contracts/shared/IVersionable.sol +96 -0
  265. package/contracts/shared/NftOwnable.sol +134 -0
  266. package/contracts/shared/ProxyManager.sol +94 -0
  267. package/contracts/shared/Registerable.sol +90 -0
  268. package/contracts/shared/RegisterableUpgradable.sol +16 -0
  269. package/contracts/shared/Service.sol +55 -0
  270. package/contracts/shared/TokenHandler.sol +27 -0
  271. package/contracts/shared/UpgradableProxyWithAdmin.sol +16 -0
  272. package/contracts/shared/Versionable.sol +147 -0
  273. package/contracts/test/TestFee.sol +25 -0
  274. package/contracts/test/TestRegisterable.sol +18 -0
  275. package/contracts/test/TestRoleId.sol +14 -0
  276. package/contracts/test/TestService.sol +24 -0
  277. package/contracts/test/TestToken.sol +26 -0
  278. package/contracts/test/TestVersion.sol +44 -0
  279. package/contracts/test/TestVersionable.sol +17 -0
  280. package/contracts/test/Usdc.sol +26 -0
  281. package/contracts/types/AddressSet.sol +58 -0
  282. package/contracts/types/DistributorType.sol +55 -0
  283. package/contracts/types/Fee.sol +44 -20
  284. package/contracts/types/Key32.sol +50 -0
  285. package/contracts/types/NftId.sol +22 -1
  286. package/contracts/types/NftIdSet.sol +60 -0
  287. package/contracts/types/NumberId.sol +52 -0
  288. package/contracts/types/ObjectType.sol +60 -15
  289. package/contracts/types/Referral.sol +85 -0
  290. package/contracts/types/RiskId.sol +43 -0
  291. package/contracts/types/RoleId.sol +90 -0
  292. package/contracts/types/StateId.sol +18 -4
  293. package/contracts/types/Timestamp.sol +29 -4
  294. package/contracts/types/UFixed.sol +138 -23
  295. package/contracts/types/Version.sol +107 -0
  296. package/package.json +12 -5
  297. package/artifacts/contracts/components/Component.sol/Component.dbg.json +0 -4
  298. package/artifacts/contracts/components/Component.sol/InstanceLinked.dbg.json +0 -4
  299. package/artifacts/contracts/components/Component.sol/InstanceLinked.json +0 -35
  300. package/artifacts/contracts/components/IPool.sol/IPoolComponent.dbg.json +0 -4
  301. package/artifacts/contracts/components/IProduct.sol/IProductComponent.dbg.json +0 -4
  302. package/artifacts/contracts/components/IProduct.sol/IProductComponent.json +0 -74
  303. package/artifacts/contracts/instance/access/Access.sol/AccessModule.dbg.json +0 -4
  304. package/artifacts/contracts/instance/access/Access.sol/AccessModule.json +0 -400
  305. package/artifacts/contracts/instance/access/IAccess.sol/IAccess.dbg.json +0 -4
  306. package/artifacts/contracts/instance/access/IAccess.sol/IAccessCheckRole.dbg.json +0 -4
  307. package/artifacts/contracts/instance/access/IAccess.sol/IAccessCheckRole.json +0 -35
  308. package/artifacts/contracts/instance/access/IAccess.sol/IAccessComponentTypeRoles.dbg.json +0 -4
  309. package/artifacts/contracts/instance/access/IAccess.sol/IAccessComponentTypeRoles.json +0 -50
  310. package/artifacts/contracts/instance/access/IAccess.sol/IAccessModule.dbg.json +0 -4
  311. package/artifacts/contracts/instance/access/IAccess.sol/IAccessModule.json +0 -336
  312. package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentModule.dbg.json +0 -4
  313. package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentOwnerService.dbg.json +0 -4
  314. package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentOwnerService.json +0 -202
  315. package/artifacts/contracts/instance/component/IComponent.sol/IComponent.dbg.json +0 -4
  316. package/artifacts/contracts/instance/component/IComponent.sol/IComponentContract.dbg.json +0 -4
  317. package/artifacts/contracts/instance/component/IComponent.sol/IComponentContract.json +0 -205
  318. package/artifacts/contracts/instance/component/IComponent.sol/IComponentModule.dbg.json +0 -4
  319. package/artifacts/contracts/instance/component/IComponent.sol/IComponentModule.json +0 -217
  320. package/artifacts/contracts/instance/component/IComponent.sol/IComponentOwnerService.dbg.json +0 -4
  321. package/artifacts/contracts/instance/component/IComponent.sol/IComponentOwnerService.json +0 -141
  322. package/artifacts/contracts/instance/component/IComponent.sol/IInstanceLinked.dbg.json +0 -4
  323. package/artifacts/contracts/instance/component/IComponent.sol/IInstanceLinked.json +0 -24
  324. package/artifacts/contracts/instance/lifecycle/ILifecycle.sol/ILifecycle.dbg.json +0 -4
  325. package/artifacts/contracts/instance/lifecycle/ILifecycle.sol/ILifecycle.json +0 -134
  326. package/artifacts/contracts/instance/lifecycle/ILifecycle.sol/ILifecycleModule.dbg.json +0 -4
  327. package/artifacts/contracts/instance/lifecycle/LifecycleModule.sol/LifecycleModule.dbg.json +0 -4
  328. package/artifacts/contracts/instance/lifecycle/LifecycleModule.sol/LifecycleModule.json +0 -221
  329. package/artifacts/contracts/instance/policy/IPolicy.sol/IPolicy.dbg.json +0 -4
  330. package/artifacts/contracts/instance/policy/IPolicy.sol/IPolicyModule.dbg.json +0 -4
  331. package/artifacts/contracts/instance/policy/PolicyModule.sol/PolicyModule.dbg.json +0 -4
  332. package/artifacts/contracts/instance/policy/PolicyModule.sol/PolicyModule.json +0 -254
  333. package/artifacts/contracts/instance/pool/IPoolModule.sol/IPool.dbg.json +0 -4
  334. package/artifacts/contracts/instance/pool/IPoolModule.sol/IPoolModule.dbg.json +0 -4
  335. package/artifacts/contracts/instance/pool/IPoolModule.sol/IPoolModule.json +0 -129
  336. package/artifacts/contracts/instance/pool/PoolModule.sol/PoolModule.dbg.json +0 -4
  337. package/artifacts/contracts/instance/pool/PoolModule.sol/PoolModule.json +0 -155
  338. package/artifacts/contracts/instance/product/IProductService.sol/IProductModule.dbg.json +0 -4
  339. package/artifacts/contracts/instance/product/IProductService.sol/IProductModule.json +0 -75
  340. package/artifacts/contracts/instance/product/IProductService.sol/IProductService.dbg.json +0 -4
  341. package/artifacts/contracts/instance/product/IProductService.sol/IProductService.json +0 -127
  342. package/artifacts/contracts/instance/product/ProductService.sol/ProductModule.dbg.json +0 -4
  343. package/artifacts/contracts/instance/product/ProductService.sol/ProductModule.json +0 -75
  344. package/artifacts/contracts/instance/product/ProductService.sol/ProductService.dbg.json +0 -4
  345. package/artifacts/contracts/instance/product/ProductService.sol/ProductService.json +0 -196
  346. package/artifacts/contracts/instance/treasury/ITreasury.sol/ITreasury.dbg.json +0 -4
  347. package/artifacts/contracts/instance/treasury/ITreasury.sol/ITreasuryModule.dbg.json +0 -4
  348. package/artifacts/contracts/instance/treasury/ITreasury.sol/ITreasuryModule.json +0 -490
  349. package/artifacts/contracts/instance/treasury/TokenHandler.sol/TokenHandler.dbg.json +0 -4
  350. package/artifacts/contracts/instance/treasury/TokenHandler.sol/TokenHandler.json +0 -45
  351. package/artifacts/contracts/instance/treasury/TreasuryModule.sol/TreasuryModule.dbg.json +0 -4
  352. package/artifacts/contracts/instance/treasury/TreasuryModule.sol/TreasuryModule.json +0 -490
  353. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.dbg.json +0 -4
  354. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.json +0 -452
  355. package/artifacts/contracts/registry/IRegistry.sol/IOwnable.dbg.json +0 -4
  356. package/artifacts/contracts/registry/IRegistry.sol/IOwnable.json +0 -24
  357. package/artifacts/contracts/registry/IRegistry.sol/IRegisterable.dbg.json +0 -4
  358. package/artifacts/contracts/registry/IRegistry.sol/IRegisterable.json +0 -166
  359. package/artifacts/contracts/registry/IRegistry.sol/IRegistryLinked.dbg.json +0 -4
  360. package/artifacts/contracts/registry/IRegistry.sol/IRegistryLinked.json +0 -49
  361. package/artifacts/contracts/registry/Registry.sol/Registerable.dbg.json +0 -4
  362. package/artifacts/contracts/registry/Registry.sol/Registerable.json +0 -166
  363. package/artifacts/contracts/registry/Registry.sol/RegistryLinked.dbg.json +0 -4
  364. package/artifacts/contracts/registry/Registry.sol/RegistryLinked.json +0 -60
  365. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.dbg.json +0 -4
  366. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.json +0 -479
  367. package/contracts/components/Component.sol +0 -77
  368. package/contracts/components/IPool.sol +0 -15
  369. package/contracts/components/IProduct.sol +0 -16
  370. package/contracts/experiment/statemachine/README.md +0 -112
  371. package/contracts/instance/access/Access.sol +0 -165
  372. package/contracts/instance/access/IAccess.sol +0 -63
  373. package/contracts/instance/component/ComponentModule.sol +0 -274
  374. package/contracts/instance/component/IComponent.sol +0 -74
  375. package/contracts/instance/lifecycle/ILifecycle.sol +0 -47
  376. package/contracts/instance/lifecycle/LifecycleModule.sol +0 -88
  377. package/contracts/instance/policy/IPolicy.sol +0 -50
  378. package/contracts/instance/policy/PolicyModule.sol +0 -114
  379. package/contracts/instance/pool/IPoolModule.sol +0 -23
  380. package/contracts/instance/pool/PoolModule.sol +0 -81
  381. package/contracts/instance/product/IProductService.sol +0 -36
  382. package/contracts/instance/product/ProductService.sol +0 -136
  383. package/contracts/instance/treasury/ITreasury.sol +0 -91
  384. package/contracts/instance/treasury/TokenHandler.sol +0 -24
  385. package/contracts/instance/treasury/TreasuryModule.sol +0 -168
  386. package/contracts/registry/IChainNft.sol +0 -21
@@ -0,0 +1,25 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ import {UFixed, UFixedLib} from "../types/UFixed.sol";
5
+ import {Fee, FeeLib} from "../types/Fee.sol";
6
+
7
+ contract TestFee {
8
+
9
+ function createFee(
10
+ uint256 fractionalValue,
11
+ int8 exponent,
12
+ uint256 fixedValue
13
+ )
14
+ external
15
+ pure
16
+ returns(Fee memory fee)
17
+ {
18
+ return FeeLib.toFee(UFixedLib.toUFixed(fractionalValue, exponent), fixedValue);
19
+ }
20
+
21
+ function getZeroFee() external pure returns(Fee memory fee) {
22
+ return FeeLib.zeroFee();
23
+ }
24
+
25
+ }
@@ -0,0 +1,18 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ import {NftId} from "../../contracts/types/NftId.sol";
5
+ import {ObjectType, TOKEN} from "../../contracts/types/ObjectType.sol";
6
+ import {IRegistry} from "../../contracts/registry/IRegistry.sol";
7
+ import {Registerable} from "../../contracts/shared/Registerable.sol";
8
+
9
+ contract TestRegisterable is Registerable {
10
+
11
+ constructor(address registry, NftId registryNftId, ObjectType objectType, bool isInterceptor, address initialOwner)
12
+ //Registerable(registry, registryNftId)
13
+ // solhint-disable-next-line no-empty-blocks
14
+ {
15
+ bytes memory data = "";
16
+ _initializeRegisterable(registry, registryNftId, objectType, isInterceptor, initialOwner, data);
17
+ }
18
+ }
@@ -0,0 +1,14 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ import {RoleId, RoleIdLib, PRODUCT_OWNER_ROLE_NAME, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE_NAME, POOL_OWNER_ROLE} from "../../contracts/types/RoleId.sol";
5
+
6
+ contract TestRoleId {
7
+ function getRole(uint256 roleNum) external pure returns (RoleId) { return RoleIdLib.toRoleId(roleNum); }
8
+
9
+ function getProductOwnerRoleName() external pure returns (string memory) { return PRODUCT_OWNER_ROLE_NAME(); }
10
+ function getProductOwnerRole() external pure returns (RoleId) { return PRODUCT_OWNER_ROLE(); }
11
+
12
+ function getPoolOwnerRoleName() external pure returns (string memory) { return POOL_OWNER_ROLE_NAME(); }
13
+ function getPoolOwnerRole() external pure returns (RoleId) { return POOL_OWNER_ROLE(); }
14
+ }
@@ -0,0 +1,24 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ import {NftId} from "../../contracts/types/NftId.sol";
5
+ import {Version, VersionLib} from "../../contracts/types/Version.sol";
6
+ import {Service} from "../../contracts/shared/Service.sol";
7
+
8
+ import {IVersionable} from "../../contracts/shared/IVersionable.sol";
9
+ import {Versionable} from "../../contracts/shared/Versionable.sol";
10
+
11
+ contract TestService is Service {
12
+
13
+ string public constant NAME = "TestService";
14
+
15
+ constructor(address registry, NftId registryNftId, address initialOwner)
16
+ // solhint-disable-next-line no-empty-blocks
17
+ {
18
+ _initializeService(registry, initialOwner);
19
+ }
20
+
21
+ function getName() public pure override returns(string memory name) {
22
+ return NAME;
23
+ }
24
+ }
@@ -0,0 +1,26 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
5
+
6
+ contract TestUsdc is ERC20 {
7
+
8
+ // https://etherscan.io/token/0xc719d010b63e5bbf2c0551872cd5316ed26acd83#readContract
9
+ string public constant NAME = "USDC - Test";
10
+ string public constant SYMBOL = "USDC";
11
+ uint8 public constant DECIMALS = 6;
12
+ uint256 public constant INITIAL_SUPPLY = 10**9 * 10**DECIMALS; // 1 Billion 1'000'000'000
13
+ // decimals == 18 (openzeppelin erc20 default)
14
+ constructor()
15
+ ERC20(NAME, SYMBOL)
16
+ {
17
+ _mint(
18
+ _msgSender(),
19
+ INITIAL_SUPPLY
20
+ );
21
+ }
22
+
23
+ function decimals() public pure override returns(uint8) {
24
+ return DECIMALS;
25
+ }
26
+ }
@@ -0,0 +1,44 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ import {Version, VersionPart, VersionLib} from "../types/Version.sol";
5
+
6
+ contract TestVersion {
7
+
8
+ function createVersion(uint major, uint minor, uint patch) external pure returns(Version) {
9
+ return VersionLib.toVersion(major, minor, patch);
10
+ }
11
+
12
+ function createVersionPart(uint versionPart) external pure returns(VersionPart) {
13
+ return VersionLib.toVersionPart(uint8(versionPart));
14
+ }
15
+
16
+ function getVersionParts(Version version)
17
+ external
18
+ pure
19
+ returns(
20
+ VersionPart major,
21
+ VersionPart minor,
22
+ VersionPart patch
23
+ )
24
+ {
25
+ return version.toVersionParts();
26
+ }
27
+
28
+ function getMajorPart(Version version) external pure returns(VersionPart major) {
29
+ return version.toMajorPart();
30
+ }
31
+
32
+ function getZeroVersion() external pure returns(Version) {
33
+ return VersionLib.zeroVersion();
34
+ }
35
+
36
+ function isSameVersion(Version a, Version b) external pure returns(bool) {
37
+ return a == b;
38
+ }
39
+
40
+ function isLargerVersion(Version a, Version b) external pure returns(bool) {
41
+ return a > b;
42
+ }
43
+
44
+ }
@@ -0,0 +1,17 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ import {Version, VersionLib} from "../../contracts/types/Version.sol";
5
+ import {Versionable} from "../../contracts/shared/Versionable.sol";
6
+
7
+ contract TestVersionable is Versionable {
8
+
9
+ function getVersion()
10
+ public
11
+ pure
12
+ virtual override
13
+ returns(Version)
14
+ {
15
+ return VersionLib.toVersion(3,0,0);
16
+ }
17
+ }
@@ -0,0 +1,26 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
5
+
6
+ contract USDC is ERC20 {
7
+
8
+ // https://etherscan.io/token/0xc719d010b63e5bbf2c0551872cd5316ed26acd83#readContract
9
+ string public constant NAME = "USDC - DUMMY";
10
+ string public constant SYMBOL = "USDC";
11
+ uint8 public constant DECIMALS = 6;
12
+ uint256 public constant INITIAL_SUPPLY = 10**9 * 10**DECIMALS; // 1 Billion 1'000'000'000
13
+ // decimals == 18 (openzeppelin erc20 default)
14
+ constructor()
15
+ ERC20(NAME, SYMBOL)
16
+ {
17
+ _mint(
18
+ _msgSender(),
19
+ INITIAL_SUPPLY
20
+ );
21
+ }
22
+
23
+ function decimals() public pure override returns(uint8) {
24
+ return DECIMALS;
25
+ }
26
+ }
@@ -0,0 +1,58 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ // based on https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/structs/EnumerableSet.sol
5
+ library LibAddressSet {
6
+
7
+ struct Set {
8
+ address[] elements;
9
+ mapping(address element => uint256 index) at;
10
+ }
11
+
12
+ function add(Set storage set, address element) external returns(bool added) {
13
+ if (set.at[element] == 0) {
14
+ set.elements.push(element);
15
+ set.at[element] = set.elements.length;
16
+ return true;
17
+ } else {
18
+ return false;
19
+ }
20
+ }
21
+
22
+ function remove(Set storage set, address element) external returns(bool removed) {
23
+ uint256 elementIndex = set.at[element];
24
+
25
+ if (elementIndex > 0) {
26
+ uint256 toDeleteIndex = elementIndex - 1;
27
+ uint256 lastIndex = set.elements.length - 1;
28
+
29
+ if (lastIndex != toDeleteIndex) {
30
+ address lastElement = set.elements[lastIndex];
31
+ set.elements[toDeleteIndex] = lastElement;
32
+ set.at[lastElement] = elementIndex; // Replace lastValue's index to valueIndex
33
+ }
34
+
35
+ set.elements.pop();
36
+ delete set.at[element];
37
+ return true;
38
+ }
39
+
40
+ return false;
41
+ }
42
+
43
+ function isEmpty(Set storage set) external view returns(bool empty) {
44
+ return set.elements.length == 0;
45
+ }
46
+
47
+ function contains(Set storage set, address element) external view returns(bool inSet) {
48
+ return set.at[element] > 0;
49
+ }
50
+
51
+ function getLength(Set storage set) external view returns(uint256 length) {
52
+ return set.elements.length;
53
+ }
54
+
55
+ function getElementAt(Set storage set, uint256 index) external view returns(address element) {
56
+ return set.elements[index];
57
+ }
58
+ }
@@ -0,0 +1,55 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {Key32, KeyId, Key32Lib} from "./Key32.sol";
5
+ import {NftId} from "./NftId.sol";
6
+ import {DISTRIBUTION_TYPE} from "./ObjectType.sol";
7
+
8
+ type DistributorType is bytes8;
9
+
10
+ // type bindings
11
+ using {
12
+ eqDistributorType as ==,
13
+ neDistributorType as !=,
14
+ DistributorTypeLib.toKey32
15
+ } for DistributorType global;
16
+
17
+ // general pure free functions
18
+
19
+ // pure free functions for operators
20
+ function eqDistributorType(
21
+ DistributorType a,
22
+ DistributorType b
23
+ ) pure returns (bool isSame) {
24
+ return DistributorType.unwrap(a) == DistributorType.unwrap(b);
25
+ }
26
+
27
+ function neDistributorType(
28
+ DistributorType a,
29
+ DistributorType b
30
+ ) pure returns (bool isDifferent) {
31
+ return DistributorType.unwrap(a) != DistributorType.unwrap(b);
32
+ }
33
+
34
+ // library functions that operate on user defined type
35
+ library DistributorTypeLib {
36
+
37
+ function zero() public pure returns (DistributorType) {
38
+ return DistributorType.wrap(bytes8(0));
39
+ }
40
+
41
+ // @dev Converts a referral string into an id.
42
+ function toDistributorType(NftId distributionNftId, string memory name) public pure returns (DistributorType) {
43
+ return DistributorType.wrap(bytes8(keccak256(abi.encode(distributionNftId, name))));
44
+ }
45
+
46
+ /// @dev Returns the key32 value for the specified nft id and object type.
47
+ function toKey32(DistributorType id) public pure returns (Key32 key) {
48
+ return Key32Lib.toKey32(DISTRIBUTION_TYPE(), toKeyId(id));
49
+ }
50
+
51
+ /// @dev Returns the key id value for the specified nft id
52
+ function toKeyId(DistributorType id) public pure returns (KeyId keyId) {
53
+ return KeyId.wrap(bytes31(DistributorType.unwrap(id)));
54
+ }
55
+ }
@@ -1,32 +1,56 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
2
  pragma solidity ^0.8.19;
3
3
 
4
- import {UFixed} from "./UFixed.sol";
4
+ import {UFixed, UFixedLib} from "./UFixed.sol";
5
5
 
6
6
  struct Fee {
7
7
  UFixed fractionalFee;
8
8
  uint256 fixedFee;
9
9
  }
10
10
 
11
- // general pure free functions
12
- /// @dev Converts the uint256 to a NftId.
13
- function toFee(
14
- UFixed fractionalFee,
15
- uint256 fixedFee
16
- ) pure returns (Fee memory fee) {
17
- return Fee(fractionalFee, fixedFee);
18
- }
11
+ library FeeLib {
19
12
 
20
- /// @dev Return the NftId zero (0)
21
- function zeroFee() pure returns (Fee memory fee) {
22
- return Fee(UFixed.wrap(0), 0);
23
- }
13
+ function calculateFee(
14
+ Fee memory fee,
15
+ uint256 amount
16
+ )
17
+ public
18
+ pure
19
+ returns (
20
+ uint256 feeAmount,
21
+ uint256 netAmount
22
+ )
23
+ {
24
+ UFixed fractionalAmount = UFixedLib.toUFixed(amount) *
25
+ fee.fractionalFee;
26
+ feeAmount = fractionalAmount.toInt() + fee.fixedFee;
27
+ netAmount = amount - feeAmount;
28
+ }
24
29
 
25
- // pure free functions for operators
26
- function feeIsSame(Fee memory a, Fee memory b) pure returns (bool isSame) {
27
- return a.fixedFee == b.fixedFee && a.fractionalFee == b.fractionalFee;
28
- }
30
+ /// @dev Converts the uint256 to a fee struct.
31
+ function toFee(
32
+ UFixed fractionalFee,
33
+ uint256 fixedFee
34
+ ) public pure returns (Fee memory fee) {
35
+ return Fee(fractionalFee, fixedFee);
36
+ }
29
37
 
30
- function feeIsZero(Fee memory fee) pure returns (bool) {
31
- return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
32
- }
38
+ /// @dev Return the percent fee struct (x%, 0)
39
+ function percentageFee(uint8 percent) public pure returns (Fee memory fee) {
40
+ return Fee(UFixedLib.toUFixed(percent, -2), 0);
41
+ }
42
+
43
+ /// @dev Return a zero fee struct (0, 0)
44
+ function zeroFee() public pure returns (Fee memory fee) {
45
+ return Fee(UFixed.wrap(0), 0);
46
+ }
47
+
48
+ // pure free functions for operators
49
+ function feeIsSame(Fee memory a, Fee memory b) public pure returns (bool isSame) {
50
+ return a.fixedFee == b.fixedFee && a.fractionalFee == b.fractionalFee;
51
+ }
52
+
53
+ function feeIsZero(Fee memory fee) public pure returns (bool) {
54
+ return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
55
+ }
56
+ }
@@ -0,0 +1,50 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {ObjectType} from "./ObjectType.sol";
5
+
6
+ type Key32 is bytes32;
7
+ type KeyId is bytes31;
8
+
9
+ // type bindings
10
+ using {
11
+ eqKey32 as ==,
12
+ neKey32 as !=,
13
+ Key32Lib.toKeyId,
14
+ Key32Lib.toObjectType
15
+ } for Key32 global;
16
+
17
+ // @dev Returns true iff keys are identical
18
+ function eqKey32(Key32 a, Key32 b) pure returns (bool isSame) {
19
+ return Key32.unwrap(a) == Key32.unwrap(b);
20
+ }
21
+
22
+ // @dev Returns true iff keys are different
23
+ function neKey32(Key32 a, Key32 b) pure returns (bool isDifferent) {
24
+ return Key32.unwrap(a) != Key32.unwrap(b);
25
+ }
26
+
27
+ library Key32Lib {
28
+
29
+ uint8 public constant TYPE_SHIFT = 31 * 8;
30
+ uint8 public constant ID_SHIFT = uint8(32 * 8 - TYPE_SHIFT);
31
+ bytes32 public constant TYPE_MASK = bytes32(bytes1(type(uint8).max)); // first byte in bytes32
32
+ bytes32 public constant ID_MASK = bytes32(~TYPE_MASK); // remaining bytes in bytes32
33
+
34
+ function toKey32(ObjectType objectType, KeyId id) public pure returns (Key32) {
35
+ uint256 uintObjectType = ObjectType.unwrap(objectType);
36
+ uint256 uintId = uint248(KeyId.unwrap(id));
37
+ uint256 uintKey = (uintObjectType << TYPE_SHIFT) + uintId;
38
+ return Key32.wrap(bytes32(uintKey));
39
+ }
40
+
41
+ function toObjectType(Key32 key) public pure returns (ObjectType objectType) {
42
+ bytes32 key32 = Key32.unwrap(key);
43
+ objectType = ObjectType.wrap(uint8(uint256(key32 & TYPE_MASK) >> TYPE_SHIFT));
44
+ }
45
+
46
+ function toKeyId(Key32 key) public pure returns (KeyId id) {
47
+ bytes32 key32 = Key32.unwrap(key);
48
+ id = KeyId.wrap(bytes31((key32 & ID_MASK) << ID_SHIFT));
49
+ }
50
+ }
@@ -1,11 +1,22 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
2
  pragma solidity ^0.8.19;
3
3
 
4
+ import {Key32, KeyId, Key32Lib} from "./Key32.sol";
5
+ import {ObjectType} from "./ObjectType.sol";
6
+
4
7
  // uint96 allows for chain ids up to 13 digits
5
8
  type NftId is uint96;
6
9
 
7
10
  // type bindings
8
- using {eqNftId as ==, neNftId as !=, NftIdLib.toInt} for NftId global;
11
+ using {
12
+ eqNftId as ==,
13
+ neNftId as !=,
14
+ NftIdLib.toInt,
15
+ NftIdLib.gtz,
16
+ NftIdLib.eqz,
17
+ NftIdLib.toKeyId,
18
+ NftIdLib.toKey32
19
+ } for NftId global;
9
20
 
10
21
  // general pure free functions
11
22
  /// @dev Converts the uint256 to a NftId.
@@ -48,4 +59,14 @@ library NftIdLib {
48
59
  function eq(NftId a, NftId b) public pure returns (bool isSame) {
49
60
  return eqNftId(a, b);
50
61
  }
62
+
63
+ /// @dev Returns the key32 value for the specified nft id and object type.
64
+ function toKey32(NftId id, ObjectType objectType) public pure returns (Key32 key) {
65
+ return Key32Lib.toKey32(objectType, toKeyId(id));
66
+ }
67
+
68
+ /// @dev Returns the key id value for the specified nft id
69
+ function toKeyId(NftId id) public pure returns (KeyId keyId) {
70
+ return KeyId.wrap(bytes31(uint248(NftId.unwrap(id))));
71
+ }
51
72
  }
@@ -0,0 +1,60 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ import {NftId} from "../types/NftId.sol";
5
+
6
+ // based on https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/structs/EnumerableSet.sol
7
+ library LibNftIdSet {
8
+
9
+ struct Set {
10
+ NftId[] ids;
11
+ mapping(NftId nftid => uint256 index) at;
12
+ }
13
+
14
+ function add(Set storage set, NftId nftId) external returns(bool added) {
15
+ if (set.at[nftId] == 0) {
16
+ set.ids.push(nftId);
17
+ set.at[nftId] = set.ids.length;
18
+ return true;
19
+ } else {
20
+ return false;
21
+ }
22
+ }
23
+
24
+ function remove(Set storage set, NftId nftId) external returns(bool removed) {
25
+ uint256 nftIdIndex = set.at[nftId];
26
+
27
+ if (nftIdIndex > 0) {
28
+ uint256 toDeleteIndex = nftIdIndex - 1;
29
+ uint256 lastIndex = set.ids.length - 1;
30
+
31
+ if (lastIndex != toDeleteIndex) {
32
+ NftId lastId = set.ids[lastIndex];
33
+ set.ids[toDeleteIndex] = lastId;
34
+ set.at[lastId] = nftIdIndex; // Replace lastValue's index to valueIndex
35
+ }
36
+
37
+ set.ids.pop();
38
+ delete set.at[nftId];
39
+ return true;
40
+ } else {
41
+ return false;
42
+ }
43
+ }
44
+
45
+ function isEmpty(Set storage set) external view returns(bool empty) {
46
+ return set.ids.length == 0;
47
+ }
48
+
49
+ function contains(Set storage set, NftId nftId) external view returns(bool inSet) {
50
+ return set.at[nftId] > 0;
51
+ }
52
+
53
+ function getLength(Set storage set) external view returns(uint256 length) {
54
+ return set.ids.length;
55
+ }
56
+
57
+ function getElementAt(Set storage set, uint256 index) external view returns(NftId nftId) {
58
+ return set.ids[index];
59
+ }
60
+ }
@@ -0,0 +1,52 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ // uint32 allows for 4'294'967'296 individual items
5
+ type NumberId is uint32;
6
+
7
+ // type bindings
8
+ using {
9
+ eqNumberId as ==,
10
+ neNumberId as !=,
11
+ NumberIdLib.eqz,
12
+ NumberIdLib.gtz,
13
+ NumberIdLib.toInt
14
+ } for NumberId global;
15
+
16
+
17
+ // pure free functions for operators
18
+ function eqNumberId(NumberId a, NumberId b) pure returns (bool isSame) {
19
+ return NumberId.unwrap(a) == NumberId.unwrap(b);
20
+ }
21
+
22
+ function neNumberId(NumberId a, NumberId b) pure returns (bool isDifferent) {
23
+ return NumberId.unwrap(a) != NumberId.unwrap(b);
24
+ }
25
+
26
+ // library functions that operate on user defined type
27
+ library NumberIdLib {
28
+ /// @dev Converts the NumberId to a uint.
29
+ function zero() public pure returns (NumberId) {
30
+ return NumberId.wrap(0);
31
+ }
32
+
33
+ /// @dev Converts an uint into a NumberId.
34
+ function toNumberId(uint256 a) public pure returns (NumberId) {
35
+ return NumberId.wrap(uint32(a));
36
+ }
37
+
38
+ /// @dev Converts the NumberId to a uint.
39
+ function toInt(NumberId a) public pure returns (uint32) {
40
+ return uint32(NumberId.unwrap(a));
41
+ }
42
+
43
+ /// @dev Returns true if the value is non-zero (> 0).
44
+ function gtz(NumberId a) public pure returns (bool) {
45
+ return NumberId.unwrap(a) > 0;
46
+ }
47
+
48
+ /// @dev Returns true if the value is zero (== 0).
49
+ function eqz(NumberId a) public pure returns (bool) {
50
+ return NumberId.unwrap(a) == 0;
51
+ }
52
+ }