@etherisc/gif-next 0.0.2-f752d2a-551 → 0.0.2-f7b8c9f-436

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