@etherisc/gif-next 0.0.2-de220d6-949 → 0.0.2-e37834a-021

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 (286) hide show
  1. package/README.md +71 -0
  2. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.dbg.json +1 -1
  3. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.json +80 -41
  4. package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json +4 -0
  5. package/artifacts/contracts/components/Distribution.sol/Distribution.json +445 -0
  6. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json +1 -1
  7. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.json +43 -40
  8. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.dbg.json +4 -0
  9. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.json +177 -0
  10. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.dbg.json +1 -1
  11. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.json +108 -156
  12. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.dbg.json +1 -1
  13. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.json +67 -139
  14. package/artifacts/contracts/components/Pool.sol/Pool.dbg.json +1 -1
  15. package/artifacts/contracts/components/Pool.sol/Pool.json +299 -84
  16. package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
  17. package/artifacts/contracts/components/Product.sol/Product.json +250 -53
  18. package/artifacts/contracts/experiment/errors/Require.sol/Require.dbg.json +1 -1
  19. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.dbg.json +1 -1
  20. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.json +2 -34
  21. package/artifacts/contracts/experiment/inheritance/A.sol/A.dbg.json +1 -1
  22. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.dbg.json +1 -1
  23. package/artifacts/contracts/experiment/inheritance/B.sol/B.dbg.json +1 -1
  24. package/artifacts/contracts/experiment/inheritance/C.sol/C.dbg.json +1 -1
  25. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.dbg.json +1 -1
  26. package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.dbg.json +1 -1
  27. package/artifacts/contracts/experiment/inheritance/IB.sol/IB.dbg.json +1 -1
  28. package/artifacts/contracts/experiment/inheritance/IC.sol/IC.dbg.json +1 -1
  29. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.dbg.json +1 -1
  30. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.json +2 -2
  31. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.dbg.json +1 -1
  32. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.dbg.json +1 -1
  33. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.dbg.json +1 -1
  34. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.dbg.json +1 -1
  35. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.dbg.json +1 -1
  36. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.dbg.json +1 -1
  37. package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
  38. package/artifacts/contracts/instance/IInstance.sol/IInstance.json +882 -586
  39. package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.dbg.json +1 -1
  40. package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
  41. package/artifacts/contracts/instance/Instance.sol/Instance.json +1011 -638
  42. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +1 -1
  43. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.json +139 -46
  44. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.dbg.json +1 -1
  45. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.json +51 -1
  46. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.dbg.json +1 -1
  47. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.json +49 -0
  48. package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.dbg.json +1 -1
  49. package/artifacts/contracts/instance/base/IService.sol/IService.dbg.json +1 -1
  50. package/artifacts/contracts/instance/base/IService.sol/IService.json +99 -55
  51. package/artifacts/contracts/instance/base/InstanceBase.sol/InstanceBase.dbg.json +1 -1
  52. package/artifacts/contracts/instance/base/InstanceBase.sol/InstanceBase.json +178 -48
  53. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.dbg.json +1 -1
  54. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.json +41 -23
  55. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.dbg.json +1 -1
  56. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.json +4 -4
  57. package/artifacts/contracts/instance/base/ModuleBase.sol/ModuleBase.dbg.json +1 -1
  58. package/artifacts/contracts/instance/base/ServiceBase.sol/ServiceBase.dbg.json +1 -1
  59. package/artifacts/contracts/instance/base/ServiceBase.sol/ServiceBase.json +135 -55
  60. package/artifacts/contracts/instance/module/access/Access.sol/AccessModule.dbg.json +1 -1
  61. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccess.dbg.json +1 -1
  62. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccessModule.dbg.json +1 -1
  63. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.dbg.json +1 -1
  64. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.json +55 -54
  65. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundle.dbg.json +1 -1
  66. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.dbg.json +1 -1
  67. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.json +56 -55
  68. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.dbg.json +1 -1
  69. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.json +22 -93
  70. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.dbg.json +1 -1
  71. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.dbg.json +1 -1
  72. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.json +22 -93
  73. package/artifacts/contracts/instance/module/distribution/DistributionModule.sol/DistributionModule.dbg.json +4 -0
  74. package/artifacts/contracts/instance/module/distribution/DistributionModule.sol/DistributionModule.json +10 -0
  75. package/artifacts/contracts/instance/module/distribution/IDistribution.sol/IDistribution.dbg.json +4 -0
  76. package/artifacts/contracts/instance/module/{compensation/ICompensation.sol/ICompensation.json → distribution/IDistribution.sol/IDistribution.json} +2 -2
  77. package/artifacts/contracts/instance/module/distribution/IDistribution.sol/IDistributionModule.dbg.json +4 -0
  78. package/artifacts/contracts/instance/module/{compensation/ICompensation.sol/ICompensationModule.json → distribution/IDistribution.sol/IDistributionModule.json} +2 -2
  79. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicy.dbg.json +1 -1
  80. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.dbg.json +1 -1
  81. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.json +53 -40
  82. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.dbg.json +1 -1
  83. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.json +53 -40
  84. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPool.dbg.json +1 -1
  85. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.dbg.json +1 -1
  86. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.json +29 -14
  87. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.dbg.json +1 -1
  88. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.json +28 -13
  89. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRisk.dbg.json +1 -1
  90. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.dbg.json +1 -1
  91. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.json +104 -1
  92. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.dbg.json +1 -1
  93. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.json +126 -5
  94. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasury.dbg.json +1 -1
  95. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.dbg.json +1 -1
  96. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.json +326 -221
  97. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.dbg.json +1 -1
  98. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.json +2 -2
  99. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.dbg.json +1 -1
  100. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.json +326 -221
  101. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.dbg.json +1 -1
  102. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.json +251 -84
  103. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.dbg.json +4 -0
  104. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.json +526 -0
  105. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.dbg.json +1 -1
  106. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.json +99 -74
  107. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.dbg.json +4 -0
  108. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.json +369 -0
  109. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +1 -1
  110. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +158 -50
  111. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +1 -1
  112. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +246 -49
  113. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.dbg.json +1 -1
  114. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.json +230 -52
  115. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.dbg.json +1 -1
  116. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.json +361 -70
  117. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
  118. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.json +141 -12
  119. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.dbg.json +1 -1
  120. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.json +5 -0
  121. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
  122. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.json +293 -40
  123. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.dbg.json +4 -0
  124. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.json +668 -0
  125. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.dbg.json +4 -0
  126. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.json +34 -0
  127. package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
  128. package/artifacts/contracts/registry/Registry.sol/Registry.json +483 -120
  129. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.dbg.json +4 -0
  130. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.json +885 -0
  131. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.dbg.json +4 -0
  132. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.json +460 -0
  133. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.dbg.json +4 -0
  134. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.json +107 -0
  135. package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json +1 -1
  136. package/artifacts/contracts/shared/ERC165.sol/ERC165.json +2 -2
  137. package/artifacts/contracts/shared/IOwnable.sol/IOwnable.dbg.json +1 -1
  138. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +1 -1
  139. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.json +43 -40
  140. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.dbg.json +1 -1
  141. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json +55 -14
  142. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.dbg.json +4 -0
  143. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.json +132 -0
  144. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.dbg.json +4 -0
  145. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.json +344 -0
  146. package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +1 -1
  147. package/artifacts/contracts/shared/Registerable.sol/Registerable.json +76 -37
  148. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.dbg.json +4 -0
  149. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.json +129 -0
  150. package/artifacts/contracts/shared/Versionable.sol/Versionable.dbg.json +1 -1
  151. package/artifacts/contracts/shared/Versionable.sol/Versionable.json +78 -14
  152. package/artifacts/contracts/test/TestDistribution.sol/TestDistribution.dbg.json +4 -0
  153. package/artifacts/contracts/test/TestDistribution.sol/TestDistribution.json +445 -0
  154. package/artifacts/contracts/test/TestFee.sol/TestFee.dbg.json +1 -1
  155. package/artifacts/contracts/test/TestFee.sol/TestFee.json +2 -2
  156. package/artifacts/contracts/test/TestPool.sol/TestPool.dbg.json +1 -1
  157. package/artifacts/contracts/test/TestPool.sol/TestPool.json +299 -84
  158. package/artifacts/contracts/test/TestProduct.sol/TestProduct.dbg.json +1 -1
  159. package/artifacts/contracts/test/TestProduct.sol/TestProduct.json +297 -58
  160. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.dbg.json +1 -1
  161. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.json +93 -39
  162. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.dbg.json +1 -1
  163. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.json +2 -2
  164. package/artifacts/contracts/test/TestService.sol/TestService.dbg.json +1 -1
  165. package/artifacts/contracts/test/TestService.sol/TestService.json +161 -68
  166. package/artifacts/contracts/test/TestToken.sol/TestUsdc.dbg.json +1 -1
  167. package/artifacts/contracts/test/TestVersion.sol/TestVersion.dbg.json +1 -1
  168. package/artifacts/contracts/test/TestVersion.sol/TestVersion.json +2 -2
  169. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.dbg.json +1 -1
  170. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.json +89 -25
  171. package/artifacts/contracts/test/Usdc.sol/USDC.dbg.json +1 -1
  172. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.dbg.json +1 -1
  173. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
  174. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.dbg.json +1 -1
  175. package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +1 -1
  176. package/artifacts/contracts/types/Fee.sol/FeeLib.json +50 -11
  177. package/artifacts/contracts/types/Key32.sol/Key32Lib.dbg.json +1 -1
  178. package/artifacts/contracts/types/Key32.sol/Key32Lib.json +2 -2
  179. package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
  180. package/artifacts/contracts/types/NftId.sol/NftIdLib.json +2 -2
  181. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +1 -1
  182. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +2 -2
  183. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +1 -1
  184. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +2 -2
  185. package/artifacts/contracts/types/ReferralId.sol/ReferralIdLib.dbg.json +4 -0
  186. package/artifacts/contracts/types/ReferralId.sol/ReferralIdLib.json +99 -0
  187. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.dbg.json +4 -0
  188. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.json +86 -0
  189. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.dbg.json +1 -1
  190. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.json +2 -2
  191. package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +1 -1
  192. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
  193. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.dbg.json +1 -1
  194. package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +1 -1
  195. package/artifacts/contracts/types/Version.sol/VersionLib.json +40 -2
  196. package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +1 -1
  197. package/artifacts/contracts/types/Version.sol/VersionPartLib.json +2 -2
  198. package/contracts/components/BaseComponent.sol +12 -21
  199. package/contracts/components/Distribution.sol +155 -0
  200. package/contracts/components/IBaseComponent.sol +2 -2
  201. package/contracts/components/IDistributionComponent.sol +46 -0
  202. package/contracts/components/IPoolComponent.sol +15 -8
  203. package/contracts/components/IProductComponent.sol +26 -8
  204. package/contracts/components/Pool.sol +99 -27
  205. package/contracts/components/Product.sol +204 -22
  206. package/contracts/experiment/errors/Revert.sol +4 -13
  207. package/contracts/instance/IInstance.sol +10 -8
  208. package/contracts/instance/Instance.sol +25 -8
  209. package/contracts/instance/base/ComponentServiceBase.sol +13 -6
  210. package/contracts/instance/base/IInstanceBase.sol +11 -2
  211. package/contracts/instance/base/IKeyValueStore.sol +4 -3
  212. package/contracts/instance/base/InstanceBase.sol +19 -10
  213. package/contracts/instance/base/KeyValueStore.sol +12 -7
  214. package/contracts/instance/base/Lifecycle.sol +15 -10
  215. package/contracts/instance/base/ModuleBase.sol +22 -17
  216. package/contracts/instance/base/ServiceBase.sol +19 -13
  217. package/contracts/instance/module/access/Access.sol +3 -3
  218. package/contracts/instance/module/bundle/BundleModule.sol +10 -12
  219. package/contracts/instance/module/bundle/IBundle.sol +6 -11
  220. package/contracts/instance/module/component/ComponentModule.sol +34 -58
  221. package/contracts/instance/module/component/IComponent.sol +7 -32
  222. package/contracts/instance/module/distribution/DistributionModule.sol +17 -0
  223. package/contracts/instance/module/distribution/IDistribution.sol +10 -0
  224. package/contracts/instance/module/policy/IPolicy.sol +10 -8
  225. package/contracts/instance/module/policy/PolicyModule.sol +33 -19
  226. package/contracts/instance/module/pool/IPoolModule.sol +4 -4
  227. package/contracts/instance/module/pool/PoolModule.sol +23 -15
  228. package/contracts/instance/module/risk/IRisk.sol +18 -2
  229. package/contracts/instance/module/risk/RiskModule.sol +56 -2
  230. package/contracts/instance/module/treasury/ITreasury.sol +32 -51
  231. package/contracts/instance/module/treasury/TokenHandler.sol +2 -2
  232. package/contracts/instance/module/treasury/TreasuryModule.sol +68 -89
  233. package/contracts/instance/service/ComponentOwnerService.sol +197 -95
  234. package/contracts/instance/service/DistributionService.sol +54 -0
  235. package/contracts/instance/service/IComponentOwnerService.sol +0 -2
  236. package/contracts/instance/service/IDistributionService.sol +12 -0
  237. package/contracts/instance/service/IPoolService.sol +7 -0
  238. package/contracts/instance/service/IProductService.sol +56 -7
  239. package/contracts/instance/service/PoolService.sol +49 -23
  240. package/contracts/instance/service/ProductService.sol +247 -91
  241. package/contracts/registry/ChainNft.sol +43 -15
  242. package/contracts/registry/IChainNft.sol +3 -2
  243. package/contracts/registry/IRegistry.sol +44 -28
  244. package/contracts/registry/IRegistryService.sol +29 -0
  245. package/contracts/registry/ITransferInterceptor.sol +6 -0
  246. package/contracts/registry/Registry.sol +383 -274
  247. package/contracts/registry/RegistryService.sol +375 -0
  248. package/contracts/registry/RegistryServiceManager.sol +52 -0
  249. package/contracts/shared/ContractDeployerLib.sol +72 -0
  250. package/contracts/shared/ERC165.sol +1 -1
  251. package/contracts/shared/IRegisterable.sol +7 -9
  252. package/contracts/shared/IVersionable.sol +55 -11
  253. package/contracts/shared/NftOwnable.sol +87 -0
  254. package/contracts/shared/ProxyManager.sol +103 -0
  255. package/contracts/shared/Registerable.sol +74 -43
  256. package/contracts/shared/UpgradableProxyWithAdmin.sol +16 -0
  257. package/contracts/shared/Versionable.sol +112 -54
  258. package/contracts/test/TestDistribution.sol +22 -0
  259. package/contracts/test/TestPool.sol +7 -2
  260. package/contracts/test/TestProduct.sol +37 -7
  261. package/contracts/test/TestRegisterable.sol +5 -6
  262. package/contracts/test/TestService.sol +5 -11
  263. package/contracts/types/Fee.sol +8 -3
  264. package/contracts/types/ObjectType.sol +24 -8
  265. package/contracts/types/ReferralId.sol +48 -0
  266. package/contracts/types/RiskId.sol +43 -0
  267. package/contracts/types/RoleId.sol +2 -2
  268. package/contracts/types/Version.sol +9 -0
  269. package/package.json +1 -1
  270. package/artifacts/contracts/experiment/errors/IncrementRevert.sol/IIncrementRevert.dbg.json +0 -4
  271. package/artifacts/contracts/experiment/errors/IncrementRevert.sol/IIncrementRevert.json +0 -27
  272. package/artifacts/contracts/experiment/errors/IncrementRevert.sol/IncrementRevert.dbg.json +0 -4
  273. package/artifacts/contracts/experiment/errors/IncrementRevert.sol/IncrementRevert.json +0 -83
  274. package/artifacts/contracts/experiment/errors/Revert.sol/IRevert.dbg.json +0 -4
  275. package/artifacts/contracts/experiment/errors/Revert.sol/IRevert.json +0 -75
  276. package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.dbg.json +0 -4
  277. package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.json +0 -10
  278. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensation.dbg.json +0 -4
  279. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensationModule.dbg.json +0 -4
  280. package/artifacts/contracts/registry/IRegistryLinked.sol/IRegistryLinked.dbg.json +0 -4
  281. package/artifacts/contracts/registry/IRegistryLinked.sol/IRegistryLinked.json +0 -24
  282. package/contracts/experiment/errors/IncrementRevert.sol +0 -43
  283. package/contracts/experiment/statemachine/README.md +0 -112
  284. package/contracts/instance/module/compensation/CompensationModule.sol +0 -8
  285. package/contracts/instance/module/compensation/ICompensation.sol +0 -10
  286. package/contracts/registry/IRegistryLinked.sol +0 -8
@@ -1,5 +1,5 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
- pragma solidity ^0.8.19;
2
+ pragma solidity ^0.8.20;
3
3
 
4
4
  import {IRegisterable} from "../shared/IRegisterable.sol";
5
5
  import {IService} from "../instance/base/IService.sol";
@@ -8,374 +8,483 @@ import {IChainNft} from "./IChainNft.sol";
8
8
  import {ChainNft} from "./ChainNft.sol";
9
9
  import {IRegistry} from "./IRegistry.sol";
10
10
  import {NftId, toNftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
11
- import {VersionPart} from "../types/Version.sol";
12
- import {ObjectType, PROTOCOL, REGISTRY, TOKEN, SERVICE, INSTANCE, STAKE, PRODUCT, DISTRIBUTOR, ORACLE, POOL, POLICY, BUNDLE} from "../types/ObjectType.sol";
11
+ import {Version, VersionPart, VersionLib} from "../types/Version.sol";
12
+ import {ObjectType, PROTOCOL, REGISTRY, TOKEN, SERVICE, INSTANCE, STAKE, PRODUCT, DISTRIBUTION, ORACLE, POOL, POLICY, BUNDLE} from "../types/ObjectType.sol";
13
+ import {ITransferInterceptor} from "./ITransferInterceptor.sol";
14
+
15
+ import {IOwnable} from "../shared/IOwnable.sol";
16
+ import {ERC165} from "../shared/ERC165.sol";
17
+
18
+
19
+ // IMPORTANT
20
+ // Each NFT minted by registry is accosiated with:
21
+ // 1) NFT owner
22
+ // 2) registred contract OR object stored in registered (parent) contract
23
+ // Four registration flows:
24
+ // 1) non IRegisterable address by registryOwner (TOKEN)
25
+ // 2) IRegisterable address by registryOwner (SERVICE)
26
+ // 3) IRegisterable address by approved service (INSTANCE, COMPONENT)
27
+ // 4) state object by approved service (POLICY, BUNDLE, STAKE)
13
28
 
14
- // TODO make registry upgradable
15
29
  contract Registry is
16
- IRegisterable,
30
+ ERC165,
17
31
  IRegistry
18
32
  {
19
- using NftIdLib for NftId;
20
-
33
+ // register
34
+ error NotRegistryService();
35
+ error ZeroParentAddress();
36
+ error ContractAlreadyRegistered(address objectAddress);
37
+ error InvalidServiceVersion(VersionPart majorVersion);
38
+ error ServiceNameAlreadyRegistered(string name, VersionPart majorVersion);
39
+
40
+ // approve
41
+ error NotOwner();
42
+ error NotRegisteredContract(NftId registrarNftId);
43
+ error NotService(NftId registrarNftId);
44
+ error InvalidTypesCombination(ObjectType objectType, ObjectType parentType);
45
+
46
+ uint256 public constant MAJOR_VERSION_MIN = 3;
47
+ address public constant NFT_LOCK_ADDRESS = address(0x1);
48
+ uint256 public constant REGISTRY_SERVICE_TOKEN_SEQUENCE_ID = 3;
21
49
  string public constant EMPTY_URI = "";
22
50
 
23
- mapping(NftId nftId => ObjectInfo info) private _info;
24
- mapping(NftId nftId => address owner) private _owner;
25
- mapping(address object => NftId nftId) private _nftIdByAddress;
26
- mapping(ObjectType objectType => bool) private _isValidType;
27
- mapping(ObjectType objectType => mapping(ObjectType objectParentType => bool)) private _isValidParentType;
28
-
29
- mapping(NftId nftId => string stringValue) private _string;
30
- mapping(bytes32 serviceNameHash => mapping(VersionPart majorVersion => address service)) _service;
31
-
32
- NftId private _nftId;
33
- IChainNft private _chainNft;
34
- ChainNft private _chainNftInternal;
35
- address private _initialOwner;
36
-
37
- // @dev will own protocol nft and registry nft(s) minted during initialize
38
- address private _protocolOwner;
39
-
40
- // TODO refactor once registry becomes upgradable
41
- // @Dev the protocol owner will get ownership of the
42
- // protocol nft and the global registry nft minted in this
43
- // initializer function
44
- function initialize(
45
- address chainNft,
46
- address protocolOwner
47
- )
48
- public
49
- {
50
- require(
51
- address(_chainNft) == address(0),
52
- "ERROR:REG-001:ALREADY_INITIALIZED"
53
- );
51
+ mapping(NftId nftId => ObjectInfo info) _info;
52
+ mapping(address object => NftId nftId) _nftIdByAddress;
54
53
 
55
- _initialOwner = msg.sender;
56
- _protocolOwner = protocolOwner;
54
+ mapping(NftId registrator => mapping(
55
+ ObjectType objectType => bool)) _isApproved;
57
56
 
58
- _chainNft = IChainNft(chainNft);
59
- _chainNftInternal = ChainNft(chainNft);
57
+ mapping(ObjectType objectType => mapping(
58
+ ObjectType parentType => bool)) _isValidContractCombination;
60
59
 
61
- // initial registry setup
62
- _registerProtocol();
63
- _nftId = _registerRegistry();
64
-
65
- // setup rules for further registrations
66
- _setupValidTypes();
67
- _setupValidParentTypes();
68
- }
60
+ mapping(ObjectType objectType => mapping(
61
+ ObjectType parentType => bool)) _isValidObjectCombination;
69
62
 
63
+ mapping(NftId nftId => string name) _string;
64
+ mapping(bytes32 serviceNameHash => mapping(
65
+ VersionPart majorVersion => address service)) _service;
70
66
 
71
- function register(
72
- address objectAddress
73
- )
74
- // TODO add authz (only services may register components etc)
75
- // we have to check how we do authz for registring services (just restrict to protocol owner/registry owner)
76
- external override returns (NftId nftId) {
77
- require(
78
- _nftIdByAddress[objectAddress].eqz(),
79
- "ERROR:REG-002:ALREADY_REGISTERED"
80
- );
81
-
82
- IRegisterable registerable = IRegisterable(objectAddress);
83
- require(
84
- registerable.supportsInterface(type(IRegisterable).interfaceId),
85
- "ERROR:REG-003:NOT_REGISTERABLE"
86
- );
67
+ NftId _registryNftId;
68
+ NftId _serviceNftId; // set in stone upon registry creation
69
+ IChainNft _chainNft;
70
+ ChainNft _chainNftInternal;
87
71
 
88
- ObjectType objectType = registerable.getType();
89
- require(
90
- _isValidType[objectType],
91
- "ERROR:REG-004:TYPE_INVALID"
92
- );
72
+ /*
73
+ modifier onlyInitialOwner() {
74
+ if(
75
+ msg.sender != getOwner() ||
76
+ msg.sender != _info[_registryNftId].initialOwner) {
77
+ revert NotInitialOwner();
78
+ }
79
+ }*/
93
80
 
94
- NftId parentNftId = registerable.getParentNftId();
95
- require(
96
- isRegistered(parentNftId),
97
- "ERROR:REG-005:PARENT_NOT_REGISTERED"
98
- );
81
+ modifier onlyOwner() {
82
+ if(msg.sender != getOwner()) {
83
+ revert NotOwner();
84
+ }
85
+ _;
86
+ }
99
87
 
100
- require(
101
- _isValidParentType[objectType][_info[parentNftId].objectType],
102
- "ERROR:REG-006:PARENT_TYPE_INVALID"
103
- );
88
+ modifier onlyRegistryService() {
89
+
90
+ if(msg.sender != _info[_serviceNftId].objectAddress) {
91
+ revert NotRegistryService();
92
+ }
93
+ _;
94
+ }
104
95
 
105
- // also check that nftId and parentNFtId are on the same chain if applicable
96
+ constructor(address registryOwner, VersionPart majorVersion)
97
+ {
98
+ require(registryOwner > address(0), "Registry: protocol owner is 0");
99
+ require(majorVersion.toInt() == MAJOR_VERSION_MIN, "Registry: initial major version of registry service is not MAJOR_VERSION_MIN");
106
100
 
107
- // nft minting
108
- uint256 mintedTokenId = _chainNft.mint(
109
- registerable.getOwner(),
110
- EMPTY_URI
111
- );
101
+ // deploy NFT
102
+ _chainNftInternal = new ChainNft(address(this));// adds 10kb to deployment size
103
+ _chainNft = IChainNft(_chainNftInternal);
112
104
 
113
- nftId = toNftId(mintedTokenId);
105
+ // initial registry setup
106
+ _registerProtocol();
107
+ _registerRegistry(registryOwner);
108
+ _registerRegistryService(registryOwner);
114
109
 
115
- // special case services
116
- if(registerable.getType() == SERVICE()) {
117
- IService service = IService(objectAddress);
118
- require(
119
- service.supportsInterface(type(IService).interfaceId),
120
- "ERROR:REG-007:NOT_SERVICE"
121
- );
122
-
123
- string memory serviceName = service.getName();
124
- VersionPart majorVersion = service.getMajorVersion();
125
- bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
126
-
127
- // service specific state
128
- _string[nftId] = serviceName;
129
-
130
- require(
131
- _service[serviceNameHash][majorVersion] == address(0),
132
- "ERROR:REG-008:ALREADY_REGISTERED"
133
- );
134
- _service[serviceNameHash][majorVersion] = objectAddress;
135
- }
110
+ // set object parent relations
111
+ _setupValidObjectParentCombinations();
136
112
 
137
- // create object info and link nft id with it
138
- _registerObjectInfo(registerable, nftId);
113
+ _registerInterface(type(IRegistry).interfaceId);
114
+ _registerInterface(type(IOwnable).interfaceId);
139
115
  }
140
116
 
141
-
142
- function registerObjectForInstance(
143
- NftId parentNftId,
144
- ObjectType objectType,
145
- address initialOwner,
146
- bytes memory data
147
- )
117
+ /// @dev registry protects only from tampering existing records and invalid types pairs
118
+ // IMPORTANT: rare case when parentNftId is not registered and == next nftId -> technincally this is ZeroParentAddress error
119
+ // to catch this check parent address before minting !!!!
120
+ // TODO service registration means its approval for some type?
121
+ function register(ObjectInfo memory info)
148
122
  external
149
- override
150
- returns (
151
- // TODO add onlyRegisteredInstance
152
- NftId nftId
153
- )
123
+ onlyRegistryService
124
+ returns(NftId nftId)
154
125
  {
155
- // TODO add more validation
156
- require(
157
- objectType == POLICY() || objectType == BUNDLE(),
158
- "ERROR:REG-010:TYPE_INVALID"
159
- );
126
+ ObjectType objectType = info.objectType;
127
+ NftId parentNftId = info.parentNftId;
128
+ ObjectInfo memory parentInfo = _info[parentNftId];
129
+ ObjectType parentType = parentInfo.objectType; // see function header
130
+ address parentAddress = parentInfo.objectAddress;
131
+
132
+ // parent is contract -> need to check? -> check before minting
133
+ // special case: global registry nft as parent when not on mainnet -> global registry address is 0
134
+ // special case: when parentNftId == _chainNft.mint(), check for zero parent address before mint
135
+ // special case: when parentNftId == _chainNft.mint() && objectAddress == initialOwner
136
+ if(parentAddress == address(0)) {
137
+ revert ZeroParentAddress();
138
+ }
160
139
 
161
- uint256 mintedTokenId = _chainNft.mint(initialOwner, EMPTY_URI);
162
- nftId = toNftId(mintedTokenId);
140
+ address interceptor = _getInterceptor(info.isInterceptor, info.objectAddress, parentInfo.isInterceptor, parentAddress);
163
141
 
164
- ObjectInfo memory info = ObjectInfo(
165
- nftId,
166
- parentNftId,
167
- objectType,
168
- address(0),
169
- initialOwner,
170
- data
171
- );
142
+ uint256 mintedTokenId = _chainNft.mint(
143
+ info.initialOwner,
144
+ interceptor,
145
+ EMPTY_URI);
146
+ nftId = toNftId(mintedTokenId);
172
147
 
148
+ // TODO move nftId out of info struct
149
+ // getters by nftId -> return struct without nftId
150
+ // getters by address -> return nftId AND struct
151
+ info.nftId = nftId;
173
152
  _info[nftId] = info;
174
153
 
175
- // add logging
176
- }
154
+ if(info.objectAddress > address(0))
155
+ {
156
+ // TODO if need to add types latter -> at least call this check from registry service
157
+ // parent is registered + object-parent types are valid
158
+ if(_isValidContractCombination[objectType][parentType] == false) {
159
+ revert InvalidTypesCombination(objectType, parentType);
160
+ }
161
+
162
+ address contractAddress = info.objectAddress;
163
+
164
+ if(_nftIdByAddress[contractAddress].gtz()) {
165
+ revert ContractAlreadyRegistered(contractAddress);
166
+ }
167
+
168
+ _nftIdByAddress[contractAddress] = nftId;
169
+
170
+ // special case
171
+ if(objectType == SERVICE())
172
+ {
173
+ (
174
+ string memory serviceName,
175
+ VersionPart majorVersion
176
+ ) = abi.decode(info.data, (string, VersionPart));
177
+ bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
178
+
179
+ // TODO MUST guarantee consistency of registerable.getVersion() and majorVersion here
180
+ // TODO update _serviceNftId when registryService with new major version is registered? -> it is fixed in current setup
181
+ // TODO do not use names -> each object type is registered by corresponding service -> conflicting with approve()
182
+ if(
183
+ majorVersion.toInt() < MAJOR_VERSION_MIN ||
184
+ (majorVersion.toInt() > MAJOR_VERSION_MIN &&
185
+ _service[serviceNameHash][VersionLib.toVersionPart(majorVersion.toInt() - 1)] == address(0) )
186
+ ) {
187
+ revert InvalidServiceVersion(majorVersion);
188
+ }
189
+
190
+ if(_service[serviceNameHash][majorVersion] != address(0)) {
191
+ revert ServiceNameAlreadyRegistered(serviceName, majorVersion);
192
+ }
193
+
194
+ _string[nftId] = serviceName;
195
+ _service[serviceNameHash][majorVersion] = contractAddress;
196
+
197
+ emit LogServiceNameRegistration(serviceName, majorVersion);
198
+ }
199
+ }
200
+ else
201
+ {
202
+ if(_isValidObjectCombination[objectType][parentType] == false) {
203
+ revert InvalidTypesCombination(objectType, parentType);
204
+ }
205
+ }
177
206
 
178
- function getObjectCount() external view override returns (uint256) {
179
- return _chainNft.totalSupply();
207
+ emit LogRegistration(nftId, info.parentNftId, info.objectType, info.objectAddress, info.initialOwner);
180
208
  }
181
209
 
182
- function getNftId(
183
- address object
184
- ) external view override returns (NftId id) {
185
- return _nftIdByAddress[object];
210
+ function registerFrom(
211
+ address from,
212
+ ObjectInfo memory info
213
+ ) external returns (NftId nftId)
214
+ {
215
+ revert();
186
216
  }
217
+
218
+
219
+ /// @dev
220
+ // msg.sender - registry owner
221
+ // CAN approve only registered service contract
222
+ // CAN approve any combination specified in _isValidCombination
223
+ // CAN NOT approve itself
224
+ // TODO in case where exists exactly one registered service per objectType (and major version):
225
+ // - registration and approve is a single operation, no need for separate approve() function
226
+ // - then approve can be used to adding new valid object-parent combinations???
227
+ function approve(
228
+ NftId serviceNftId,
229
+ ObjectType objectType,
230
+ ObjectType parentType
231
+ )
232
+ public
233
+ onlyOwner()
234
+ {
235
+ address serviceAddress = _info[serviceNftId].objectAddress;
236
+
237
+ if(_nftIdByAddress[serviceAddress].eqz()) {
238
+ revert NotRegisteredContract(serviceNftId);
239
+ }
187
240
 
188
- function isRegistered(
189
- NftId nftId
190
- ) public view override returns (bool) {
191
- return _info[nftId].objectType.gtz();
192
- }
241
+ if(_info[serviceNftId].objectType != SERVICE()) {
242
+ revert NotService(serviceNftId);
243
+ }
193
244
 
194
- function isRegistered(
195
- address object
196
- ) external view override returns (bool) {
197
- return _nftIdByAddress[object].gtz();
198
- }
245
+ if(
246
+ _isValidContractCombination[objectType][parentType] == false &&
247
+ _isValidObjectCombination[objectType][parentType] == false) {
248
+ revert InvalidTypesCombination(objectType, parentType);
249
+ }
199
250
 
200
- function getObjectInfo(
201
- NftId nftId
202
- ) external view override returns (ObjectInfo memory info) {
203
- return _info[nftId];
204
- }
251
+ _isApproved[serviceNftId][objectType] = true;
205
252
 
206
- function getName(
207
- NftId nftId
208
- ) external view returns (string memory name) {
209
- return _string[nftId];
253
+ emit LogApproval(serviceNftId, objectType);
210
254
  }
211
255
 
212
- function getOwner(NftId nftId) external view override returns (address) {
213
- return _chainNft.ownerOf(nftId.toInt());
256
+ /// @dev returns false for registry owner nft
257
+ // TODO allowance by address?
258
+ // TODO checked by registry service -> but registry owner can upgrade registry service not to check allowance....
259
+ function allowance(
260
+ NftId nftId,
261
+ ObjectType object
262
+ )
263
+ public
264
+ view
265
+ returns (bool)
266
+ {
267
+ return _isApproved[nftId][object];
214
268
  }
215
269
 
216
- function getChainNft() external view override returns (IChainNft) {
217
- return _chainNft;
270
+ // from IRegistry
271
+ function getObjectCount() external view override returns (uint256) {
272
+
273
+ return _chainNft.totalSupply();
218
274
  }
219
275
 
220
- // special case to retrive a gif service
221
- function getServiceAddress(string memory serviceName, VersionPart majorVersion) external view override returns (address serviceAddress) {
222
- bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
223
- return _service[serviceNameHash][majorVersion];
276
+ function getNftId(address object) external view override returns (NftId id) {
277
+ return _nftIdByAddress[object];
224
278
  }
225
279
 
226
- // from IERC165
227
- function supportsInterface(bytes4 interfaceId) external pure override returns (bool) {
228
- return interfaceId == type(IRegistry).interfaceId;
280
+ function ownerOf(NftId nftId) public view override returns (address) {
281
+ return _chainNft.ownerOf(nftId.toInt());
229
282
  }
230
283
 
231
- // from IRegistryLinked
232
- function getRegistry() external view override returns (IRegistry registry) {
233
- return this;
284
+ function ownerOf(address contractAddress) public view returns (address) {
285
+
286
+ return _chainNft.ownerOf(_nftIdByAddress[contractAddress].toInt());
234
287
  }
235
288
 
236
- // from IRegisterable
237
- function register() external pure override returns (NftId nftId) {
238
- return zeroNftId();
289
+ function getObjectInfo(NftId nftId) external view override returns (ObjectInfo memory) {
290
+ return _info[nftId];
239
291
  }
240
292
 
241
- function getType() external pure override returns (ObjectType objectType) {
242
- return REGISTRY();
293
+ function getObjectInfo(address object) external view override returns (ObjectInfo memory) {
294
+
295
+ return _info[_nftIdByAddress[object]];
243
296
  }
244
297
 
245
-
246
- function getOwner() public view override returns (address owner) {
247
- return _nftId.gtz() ? this.getOwner(_nftId) : _initialOwner;
298
+ function isRegistered(NftId nftId) public view override returns (bool) {
299
+ return _info[nftId].objectType.gtz();
248
300
  }
249
301
 
250
- function getNftId() external view override (IRegisterable, IRegistry) returns (NftId nftId) {
251
- return _nftId;
302
+ function isRegistered(address object) external view override returns (bool) {
303
+ return _nftIdByAddress[object].gtz();
252
304
  }
253
305
 
254
- function getParentNftId() external view returns (NftId nftId) {
255
- // we're the global registry
256
- if(block.chainid == 1) {
257
- return toNftId(_chainNftInternal.PROTOCOL_NFT_ID());
258
- }
259
- else {
260
- return toNftId(_chainNftInternal.GLOBAL_REGISTRY_ID());
261
- }
306
+ function getServiceName(NftId nftId) external view returns (string memory) {
307
+ return _string[nftId];
262
308
  }
263
309
 
264
- function getData() external pure returns (bytes memory data) {
265
- return "";
310
+ // special case to retrive a gif service
311
+ function getServiceAddress(
312
+ string memory serviceName,
313
+ VersionPart majorVersion
314
+ ) external view returns (address)
315
+ {
316
+ bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
317
+ return _service[serviceNameHash][majorVersion];
266
318
  }
267
319
 
268
- // registry specific functions
269
- function getProtocolOwner() external view override returns (address) {
270
- return _protocolOwner;
320
+ function getChainNft() external view override returns (IChainNft) {
321
+ return _chainNft;
271
322
  }
272
323
 
273
- /// @dev defines which types are allowed to register
274
- function _setupValidTypes() internal {
275
- _isValidType[REGISTRY()] = true; // only for global registry
276
- _isValidType[TOKEN()] = true;
277
- _isValidType[SERVICE()] = true;
278
- _isValidType[INSTANCE()] = true;
279
- _isValidType[STAKE()] = true;
280
- _isValidType[PRODUCT()] = true;
281
- _isValidType[ORACLE()] = true;
282
- _isValidType[POOL()] = true;
283
- _isValidType[POLICY()] = true;
284
- _isValidType[BUNDLE()] = true;
324
+ // from IOwnable
325
+ function getOwner() public view returns (address owner) {
326
+ return ownerOf(address(this));
285
327
  }
286
328
 
287
- /// @dev defines which types - parent type relations are allowed to register
288
- function _setupValidParentTypes() internal {
289
- // registry as parent
290
- _isValidParentType[TOKEN()][REGISTRY()] = true;
291
- _isValidParentType[SERVICE()][REGISTRY()] = true;
292
- _isValidParentType[INSTANCE()][REGISTRY()] = true;
293
-
294
- // instance as parent
295
- _isValidParentType[PRODUCT()][INSTANCE()] = true;
296
- _isValidParentType[DISTRIBUTOR()][INSTANCE()] = true;
297
- _isValidParentType[ORACLE()][INSTANCE()] = true;
298
- _isValidParentType[POOL()][INSTANCE()] = true;
299
-
300
- // product as parent
301
- _isValidParentType[POLICY()][PRODUCT()] = true;
302
-
303
- // pool as parent
304
- _isValidParentType[BUNDLE()][POOL()] = true;
305
- _isValidParentType[STAKE()][POOL()] = true;
306
- }
329
+ // Internals, called only in constructor
307
330
 
308
331
  /// @dev protocol registration used to anchor the dip ecosystem relations
309
- function _registerProtocol() virtual internal {
332
+ function _registerProtocol()
333
+ internal
334
+ {
310
335
  uint256 protocolId = _chainNftInternal.PROTOCOL_NFT_ID();
311
- _chainNftInternal.mint(_protocolOwner, protocolId);
336
+ NftId protocolNftId = toNftId(protocolId);
312
337
 
313
- NftId protocolNftid = toNftId(protocolId);
314
- ObjectInfo memory protocolInfo = ObjectInfo(
315
- protocolNftid,
316
- zeroNftId(), // parent nft id
338
+ _chainNftInternal.mint(NFT_LOCK_ADDRESS, protocolId);
339
+
340
+ _info[protocolNftId] = ObjectInfo(
341
+ protocolNftId,
342
+ zeroNftId(), // parent
317
343
  PROTOCOL(),
318
- address(0), // contract address
319
- _protocolOwner,
320
- "" // data
344
+ false, // isInterceptor
345
+ address(0), // objectAddress
346
+ NFT_LOCK_ADDRESS,// initialOwner
347
+ ""
321
348
  );
322
-
323
- _info[protocolNftid] = protocolInfo;
324
349
  }
325
350
 
326
351
  /// @dev registry registration
327
352
  /// might also register the global registry when not on mainnet
328
- function _registerRegistry() virtual internal returns (NftId registryNftId) {
353
+ function _registerRegistry(address registryOwner)
354
+ internal
355
+ {
329
356
  uint256 registryId = _chainNftInternal.calculateTokenId(2);
330
- registryNftId = toNftId(registryId);
357
+ NftId registryNftId = toNftId(registryId);
358
+
359
+ NftId parentNftId;
331
360
 
332
- // we're not the global registry
333
- if(registryId != _chainNftInternal.GLOBAL_REGISTRY_ID()) {
361
+ if(registryId != _chainNftInternal.GLOBAL_REGISTRY_ID())
362
+ {// we're not the global registry
334
363
  _registerGlobalRegistry();
364
+ parentNftId = toNftId(_chainNftInternal.GLOBAL_REGISTRY_ID());
335
365
  }
366
+ else
367
+ {// we are global registry
368
+ parentNftId = toNftId(_chainNftInternal.PROTOCOL_NFT_ID());
369
+ }
370
+
371
+ _chainNftInternal.mint(registryOwner, registryId);
336
372
 
337
- _chainNftInternal.mint(_protocolOwner, registryId);
338
- _registerObjectInfo(this, registryNftId);
373
+ _info[registryNftId] = ObjectInfo(
374
+ registryNftId,
375
+ parentNftId,
376
+ REGISTRY(),
377
+ false, // isInterceptor
378
+ address(this),
379
+ registryOwner,
380
+ ""
381
+ );
382
+ _nftIdByAddress[address(this)] = registryNftId;
383
+ _registryNftId = registryNftId;
339
384
  }
340
385
 
341
386
 
342
387
  /// @dev global registry registration for non mainnet registries
343
- function _registerGlobalRegistry() virtual internal {
388
+ function _registerGlobalRegistry()
389
+ internal
390
+ {
344
391
  uint256 globalRegistryId = _chainNftInternal.GLOBAL_REGISTRY_ID();
345
- _chainNftInternal.mint(_protocolOwner, globalRegistryId);
392
+
393
+ _chainNftInternal.mint(NFT_LOCK_ADDRESS, globalRegistryId);
346
394
 
347
395
  NftId globalRegistryNftId = toNftId(globalRegistryId);
348
- ObjectInfo memory globalRegistryInfo = ObjectInfo(
396
+
397
+ _info[globalRegistryNftId] = ObjectInfo(
349
398
  globalRegistryNftId,
350
- toNftId(_chainNftInternal.PROTOCOL_NFT_ID()),
399
+ toNftId(_chainNftInternal.PROTOCOL_NFT_ID()), // parent
351
400
  REGISTRY(),
352
- address(0), // contract address
353
- _protocolOwner,
401
+ false, // isInterceptor
402
+ address(0), // objectAddress
403
+ NFT_LOCK_ADDRESS, // initialOwner
354
404
  "" // data
355
405
  );
356
-
357
- _info[globalRegistryNftId] = globalRegistryInfo;
358
406
  }
359
407
 
360
-
361
- function _registerObjectInfo(
362
- IRegisterable registerable,
363
- NftId nftId
364
- ) internal virtual {
365
- address objectAddress = address(registerable);
366
- ObjectInfo memory info = ObjectInfo(
367
- nftId,
368
- registerable.getParentNftId(),
369
- registerable.getType(),
370
- objectAddress,
371
- registerable.getOwner(),
372
- registerable.getData()
408
+ function _registerRegistryService(address registryOwner)
409
+ internal
410
+ {
411
+ uint256 serviceId = _chainNftInternal.calculateTokenId(REGISTRY_SERVICE_TOKEN_SEQUENCE_ID);
412
+ NftId serviceNftId = toNftId(serviceId);
413
+
414
+ _chainNftInternal.mint(registryOwner, serviceId);
415
+
416
+ _info[serviceNftId] = ObjectInfo(
417
+ serviceNftId,
418
+ _registryNftId,
419
+ SERVICE(),
420
+ false, // isInterceptor
421
+ msg.sender, // service deploys registry
422
+ registryOwner, // initialOwner,
423
+ ""
373
424
  );
374
425
 
375
- _info[nftId] = info;
376
- _nftIdByAddress[objectAddress] = nftId;
426
+ _nftIdByAddress[msg.sender] = serviceNftId;
377
427
 
378
- // add logging
428
+ string memory serviceName = "RegistryService";
429
+ bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
430
+ _service[serviceNameHash][VersionLib.toVersionPart(MAJOR_VERSION_MIN)] = msg.sender;
431
+ _string[serviceNftId] = serviceName;
432
+ _serviceNftId = serviceNftId;
379
433
  }
380
434
 
435
+ /// @dev obtain interceptor address for this nft if applicable, address(0) otherwise
436
+ function _getInterceptor(
437
+ bool isInterceptor,
438
+ address objectAddress,
439
+ bool parentIsInterceptor,
440
+ address parentObjectAddress
441
+ )
442
+ internal
443
+ view
444
+ returns (address interceptor)
445
+ {
446
+ if (objectAddress == address(0)) {
447
+ if (parentIsInterceptor) {
448
+ return parentObjectAddress;
449
+ } else {
450
+ return address(0);
451
+ }
452
+ }
453
+
454
+ if (isInterceptor) {
455
+ return objectAddress;
456
+ }
457
+
458
+ return address(0);
459
+ }
460
+
461
+ /// @dev defines which object - parent types relations are allowed to register
462
+ // IMPORTANT:
463
+ // 1) EACH object type MUST have only one parent type across ALL mappings
464
+ // 2) DO NOT use object type (e.g. POLCY, BUNDLE, STAKE) as parent type
465
+ // 3) DO NOT use REGISTRY as object type
466
+ // 2) DO NOT use PROTOCOL and "zeroObjectType"
467
+ function _setupValidObjectParentCombinations()
468
+ internal
469
+ {
470
+ // registry as parent, ONLY registry owner
471
+ _isValidContractCombination[TOKEN()][REGISTRY()] = true;
472
+ _isValidContractCombination[SERVICE()][REGISTRY()] = true;
473
+
474
+ // registry as parent, ONLY approved
475
+ _isValidContractCombination[INSTANCE()][REGISTRY()] = true;
476
+
477
+ // instance as parent, ONLY approved
478
+ _isValidContractCombination[PRODUCT()][INSTANCE()] = true;
479
+ _isValidContractCombination[DISTRIBUTION()][INSTANCE()] = true;
480
+ _isValidContractCombination[ORACLE()][INSTANCE()] = true;
481
+ _isValidContractCombination[POOL()][INSTANCE()] = true;
482
+
483
+ // product as parent, ONLY approved
484
+ _isValidObjectCombination[POLICY()][PRODUCT()] = true;
485
+
486
+ // pool as parent, ONLY approved
487
+ _isValidObjectCombination[BUNDLE()][POOL()] = true;
488
+ _isValidObjectCombination[STAKE()][POOL()] = true;
489
+ }
381
490
  }