@etherisc/gif-next 0.0.2-d911522 → 0.0.2-dc7e4cb-141

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 (332) hide show
  1. package/README.md +125 -0
  2. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.dbg.json +4 -0
  3. package/artifacts/contracts/components/{Component.sol/Component.json → BaseComponent.sol/BaseComponent.json} +48 -53
  4. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json +4 -0
  5. package/artifacts/contracts/components/{IPool.sol/IPoolComponent.json → IBaseComponent.sol/IBaseComponent.json} +48 -53
  6. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.dbg.json +4 -0
  7. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.json +356 -0
  8. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.dbg.json +4 -0
  9. package/artifacts/contracts/components/{IProduct.sol → IProductComponent.sol}/IProductComponent.json +139 -52
  10. package/artifacts/contracts/components/Pool.sol/Pool.dbg.json +1 -1
  11. package/artifacts/contracts/components/Pool.sol/Pool.json +218 -44
  12. package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
  13. package/artifacts/contracts/components/Product.sol/Product.json +144 -70
  14. package/artifacts/contracts/experiment/errors/Require.sol/Require.dbg.json +1 -1
  15. package/artifacts/contracts/experiment/errors/Require.sol/Require.json +2 -2
  16. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.dbg.json +1 -1
  17. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.json +2 -2
  18. package/artifacts/contracts/experiment/inheritance/A.sol/A.dbg.json +1 -1
  19. package/artifacts/contracts/experiment/inheritance/A.sol/A.json +2 -2
  20. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.dbg.json +1 -1
  21. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.json +2 -2
  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 +4 -0
  29. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.json +59 -0
  30. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.dbg.json +4 -0
  31. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.json +124 -0
  32. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.dbg.json +4 -0
  33. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.json +74 -0
  34. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.dbg.json +4 -0
  35. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.json +124 -0
  36. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.dbg.json +4 -0
  37. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.json +207 -0
  38. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.dbg.json +1 -1
  39. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.json +2 -2
  40. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.dbg.json +1 -1
  41. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.json +2 -2
  42. package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
  43. package/artifacts/contracts/instance/IInstance.sol/IInstance.json +1414 -289
  44. package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.dbg.json +4 -0
  45. package/artifacts/contracts/instance/{component/IComponent.sol → IInstanceLinked.sol}/IInstanceLinked.json +1 -1
  46. package/artifacts/contracts/instance/IServiceLinked.sol/IServiceLinked.dbg.json +4 -0
  47. package/artifacts/contracts/instance/{access/IAccess.sol/IAccessComponentTypeRoles.json → IServiceLinked.sol/IServiceLinked.json} +14 -14
  48. package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
  49. package/artifacts/contracts/instance/Instance.sol/Instance.json +1554 -348
  50. package/artifacts/contracts/instance/InstanceBase.sol/InstanceBase.dbg.json +4 -0
  51. package/artifacts/contracts/instance/{component/ComponentModule.sol/ComponentModule.json → InstanceBase.sol/InstanceBase.json} +128 -142
  52. package/artifacts/contracts/instance/module/access/Access.sol/AccessModule.dbg.json +4 -0
  53. package/artifacts/contracts/instance/{access → module/access}/Access.sol/AccessModule.json +85 -152
  54. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccess.dbg.json +4 -0
  55. package/artifacts/contracts/instance/{access → module/access}/IAccess.sol/IAccess.json +1 -1
  56. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccessModule.dbg.json +4 -0
  57. package/artifacts/contracts/instance/{access → module/access}/IAccess.sol/IAccessModule.json +96 -99
  58. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.dbg.json +4 -0
  59. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.json +276 -0
  60. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundle.dbg.json +4 -0
  61. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundle.json +10 -0
  62. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.dbg.json +4 -0
  63. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.json +276 -0
  64. package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.dbg.json +4 -0
  65. package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.json +10 -0
  66. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensation.dbg.json +4 -0
  67. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensation.json +10 -0
  68. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensationModule.dbg.json +4 -0
  69. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensationModule.json +10 -0
  70. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.dbg.json +4 -0
  71. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.json +188 -0
  72. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.dbg.json +4 -0
  73. package/artifacts/contracts/instance/{component → module/component}/IComponent.sol/IComponent.json +1 -1
  74. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.dbg.json +4 -0
  75. package/artifacts/contracts/instance/{component → module/component}/IComponent.sol/IComponentModule.json +40 -97
  76. package/artifacts/contracts/instance/module/lifecycle/ILifecycle.sol/ILifecycle.dbg.json +4 -0
  77. package/artifacts/contracts/instance/module/lifecycle/ILifecycle.sol/ILifecycle.json +134 -0
  78. package/artifacts/contracts/instance/module/lifecycle/ILifecycle.sol/ILifecycleModule.dbg.json +4 -0
  79. package/artifacts/contracts/instance/module/lifecycle/ILifecycle.sol/ILifecycleModule.json +182 -0
  80. package/artifacts/contracts/instance/module/lifecycle/LifecycleModule.sol/LifecycleModule.dbg.json +4 -0
  81. package/artifacts/contracts/instance/module/lifecycle/LifecycleModule.sol/LifecycleModule.json +221 -0
  82. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicy.dbg.json +4 -0
  83. package/artifacts/contracts/instance/{policy → module/policy}/IPolicy.sol/IPolicy.json +1 -1
  84. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.dbg.json +4 -0
  85. package/artifacts/contracts/instance/{policy → module/policy}/IPolicy.sol/IPolicyModule.json +142 -112
  86. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.dbg.json +4 -0
  87. package/artifacts/contracts/instance/{policy → module/policy}/PolicyModule.sol/PolicyModule.json +142 -112
  88. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPool.dbg.json +4 -0
  89. package/artifacts/contracts/instance/{pool → module/pool}/IPoolModule.sol/IPool.json +1 -1
  90. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.dbg.json +4 -0
  91. package/artifacts/contracts/instance/{pool → module/pool}/IPoolModule.sol/IPoolModule.json +57 -57
  92. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.dbg.json +4 -0
  93. package/artifacts/contracts/instance/{pool → module/pool}/PoolModule.sol/PoolModule.json +50 -63
  94. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRisk.dbg.json +4 -0
  95. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRisk.json +10 -0
  96. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.dbg.json +4 -0
  97. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.json +10 -0
  98. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.dbg.json +4 -0
  99. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.json +10 -0
  100. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasury.dbg.json +4 -0
  101. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasury.json +10 -0
  102. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.dbg.json +4 -0
  103. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.json +533 -0
  104. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.dbg.json +4 -0
  105. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.json +76 -0
  106. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.dbg.json +4 -0
  107. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.json +533 -0
  108. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.dbg.json +4 -0
  109. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.json +491 -0
  110. package/artifacts/contracts/instance/service/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +4 -0
  111. package/artifacts/contracts/instance/service/ComponentServiceBase.sol/ComponentServiceBase.json +300 -0
  112. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.dbg.json +4 -0
  113. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.json +364 -0
  114. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +4 -0
  115. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +376 -0
  116. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +4 -0
  117. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +477 -0
  118. package/artifacts/contracts/instance/service/IService.sol/IService.dbg.json +4 -0
  119. package/artifacts/contracts/instance/{component/IComponent.sol/IComponentContract.json → service/IService.sol/IService.json} +148 -27
  120. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.dbg.json +4 -0
  121. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.json +471 -0
  122. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.dbg.json +4 -0
  123. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.json +673 -0
  124. package/artifacts/contracts/instance/service/ServiceBase.sol/ServiceBase.dbg.json +4 -0
  125. package/artifacts/contracts/instance/service/ServiceBase.sol/ServiceBase.json +300 -0
  126. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
  127. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.json +65 -2
  128. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.dbg.json +1 -1
  129. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
  130. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.json +103 -77
  131. package/artifacts/contracts/registry/IRegistryLinked.sol/IRegistryLinked.dbg.json +4 -0
  132. package/artifacts/contracts/registry/IRegistryLinked.sol/IRegistryLinked.json +24 -0
  133. package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
  134. package/artifacts/contracts/registry/Registry.sol/Registry.json +194 -69
  135. package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json +4 -0
  136. package/artifacts/contracts/shared/ERC165.sol/ERC165.json +35 -0
  137. package/artifacts/contracts/shared/IOwnable.sol/IOwnable.dbg.json +4 -0
  138. package/artifacts/contracts/{registry/IRegistry.sol → shared/IOwnable.sol}/IOwnable.json +1 -1
  139. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +4 -0
  140. package/artifacts/contracts/{registry/IRegistry.sol → shared/IRegisterable.sol}/IRegisterable.json +18 -63
  141. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.dbg.json +4 -0
  142. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json +164 -0
  143. package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +4 -0
  144. package/artifacts/contracts/{registry/Registry.sol → shared/Registerable.sol}/Registerable.json +18 -63
  145. package/artifacts/contracts/shared/Versionable.sol/Versionable.dbg.json +4 -0
  146. package/artifacts/contracts/shared/Versionable.sol/Versionable.json +164 -0
  147. package/artifacts/contracts/test/TestFee.sol/TestFee.dbg.json +4 -0
  148. package/artifacts/contracts/test/TestFee.sol/TestFee.json +119 -0
  149. package/artifacts/contracts/test/TestPool.sol/TestPool.dbg.json +4 -0
  150. package/artifacts/contracts/test/TestPool.sol/TestPool.json +387 -0
  151. package/artifacts/contracts/test/TestProduct.sol/TestProduct.dbg.json +4 -0
  152. package/artifacts/contracts/test/TestProduct.sol/TestProduct.json +393 -0
  153. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.dbg.json +4 -0
  154. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.json +137 -0
  155. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.dbg.json +4 -0
  156. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.json +82 -0
  157. package/artifacts/contracts/test/TestService.sol/TestService.dbg.json +4 -0
  158. package/artifacts/contracts/test/TestService.sol/TestService.json +379 -0
  159. package/artifacts/contracts/test/TestToken.sol/TestUsdc.dbg.json +4 -0
  160. package/artifacts/contracts/test/TestToken.sol/TestUsdc.json +338 -0
  161. package/artifacts/contracts/test/TestVersion.sol/TestVersion.dbg.json +4 -0
  162. package/artifacts/contracts/test/TestVersion.sol/TestVersion.json +218 -0
  163. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.dbg.json +4 -0
  164. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.json +206 -0
  165. package/artifacts/contracts/test/Usdc.sol/USDC.dbg.json +4 -0
  166. package/artifacts/contracts/test/Usdc.sol/USDC.json +338 -0
  167. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.dbg.json +4 -0
  168. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.json +10 -0
  169. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
  170. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.json +2 -2
  171. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.dbg.json +1 -1
  172. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.json +2 -2
  173. package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +4 -0
  174. package/artifacts/contracts/types/Fee.sol/FeeLib.json +218 -0
  175. package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
  176. package/artifacts/contracts/types/NftId.sol/NftIdLib.json +2 -2
  177. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +4 -0
  178. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +10 -0
  179. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +4 -0
  180. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +92 -0
  181. package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +4 -0
  182. package/artifacts/contracts/types/StateId.sol/StateIdLib.json +92 -0
  183. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
  184. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.json +64 -2
  185. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.dbg.json +1 -1
  186. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.json +98 -59
  187. package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +4 -0
  188. package/artifacts/contracts/types/Version.sol/VersionLib.json +139 -0
  189. package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +4 -0
  190. package/artifacts/contracts/types/Version.sol/VersionPartLib.json +30 -0
  191. package/contracts/components/BaseComponent.sol +89 -0
  192. package/contracts/components/IBaseComponent.sol +19 -0
  193. package/contracts/components/IPoolComponent.sol +57 -0
  194. package/contracts/components/IProductComponent.sol +19 -0
  195. package/contracts/components/Pool.sol +161 -16
  196. package/contracts/components/Product.sol +77 -26
  197. package/contracts/experiment/errors/Require.sol +10 -5
  198. package/contracts/experiment/errors/Revert.sol +13 -8
  199. package/contracts/experiment/inheritance/A.sol +8 -11
  200. package/contracts/experiment/inheritance/B.sol +10 -5
  201. package/contracts/experiment/inheritance/C.sol +11 -5
  202. package/contracts/experiment/inheritance/IA.sol +2 -7
  203. package/contracts/experiment/inheritance/IB.sol +3 -2
  204. package/contracts/experiment/inheritance/IC.sol +4 -3
  205. package/contracts/experiment/statemachine/Dummy.sol +27 -0
  206. package/contracts/experiment/statemachine/ISM.sol +25 -0
  207. package/contracts/experiment/statemachine/README.md +112 -0
  208. package/contracts/experiment/statemachine/SM.sol +57 -0
  209. package/contracts/experiment/statemachine/SimpleStateMachine.sol +31 -0
  210. package/contracts/experiment/types/TypeA.sol +14 -9
  211. package/contracts/experiment/types/TypeB.sol +14 -9
  212. package/contracts/instance/IInstance.sol +41 -8
  213. package/contracts/instance/IInstanceLinked.sol +8 -0
  214. package/contracts/instance/IServiceLinked.sol +12 -0
  215. package/contracts/instance/Instance.sol +46 -44
  216. package/contracts/instance/InstanceBase.sol +71 -0
  217. package/contracts/instance/module/access/Access.sol +149 -0
  218. package/contracts/instance/module/access/IAccess.sol +53 -0
  219. package/contracts/instance/module/bundle/BundleModule.sol +228 -0
  220. package/contracts/instance/module/bundle/IBundle.sol +53 -0
  221. package/contracts/instance/module/compensation/CompensationModule.sol +8 -0
  222. package/contracts/instance/module/compensation/ICompensation.sol +10 -0
  223. package/contracts/instance/module/component/ComponentModule.sol +103 -0
  224. package/contracts/instance/module/component/IComponent.sol +53 -0
  225. package/contracts/instance/module/lifecycle/ILifecycle.sol +47 -0
  226. package/contracts/instance/module/lifecycle/LifecycleModule.sol +89 -0
  227. package/contracts/instance/module/policy/IPolicy.sol +60 -0
  228. package/contracts/instance/module/policy/PolicyModule.sol +84 -0
  229. package/contracts/instance/module/pool/IPoolModule.sol +41 -0
  230. package/contracts/instance/module/pool/PoolModule.sol +87 -0
  231. package/contracts/instance/module/risk/IRisk.sol +10 -0
  232. package/contracts/instance/module/risk/RiskModule.sol +8 -0
  233. package/contracts/instance/module/treasury/ITreasury.sol +103 -0
  234. package/contracts/instance/module/treasury/TokenHandler.sol +48 -0
  235. package/contracts/instance/module/treasury/TreasuryModule.sol +152 -0
  236. package/contracts/instance/service/ComponentOwnerService.sol +171 -0
  237. package/contracts/instance/service/ComponentServiceBase.sol +41 -0
  238. package/contracts/instance/service/IComponentOwnerService.sol +22 -0
  239. package/contracts/instance/service/IPoolService.sol +30 -0
  240. package/contracts/instance/service/IProductService.sol +58 -0
  241. package/contracts/instance/service/IService.sol +15 -0
  242. package/contracts/instance/service/PoolService.sol +123 -0
  243. package/contracts/instance/service/ProductService.sol +355 -0
  244. package/contracts/instance/service/ServiceBase.sol +39 -0
  245. package/contracts/registry/ChainNft.sol +80 -94
  246. package/contracts/registry/IChainNft.sol +10 -7
  247. package/contracts/registry/IRegistry.sol +38 -51
  248. package/contracts/registry/IRegistryLinked.sol +8 -0
  249. package/contracts/registry/Registry.sol +310 -111
  250. package/contracts/shared/ERC165.sol +21 -0
  251. package/contracts/shared/IOwnable.sol +6 -0
  252. package/contracts/shared/IRegisterable.sol +24 -0
  253. package/contracts/shared/IVersionable.sol +52 -0
  254. package/contracts/shared/Registerable.sol +86 -0
  255. package/contracts/shared/Versionable.sol +89 -0
  256. package/contracts/test/TestFee.sol +25 -0
  257. package/contracts/test/TestPool.sol +22 -0
  258. package/contracts/test/TestProduct.sol +44 -0
  259. package/contracts/test/TestRegisterable.sol +19 -0
  260. package/contracts/test/TestRoleId.sol +14 -0
  261. package/contracts/test/TestService.sol +32 -0
  262. package/contracts/test/TestToken.sol +26 -0
  263. package/contracts/test/TestVersion.sol +44 -0
  264. package/contracts/test/TestVersionable.sol +17 -0
  265. package/contracts/test/Usdc.sol +26 -0
  266. package/contracts/types/AddressSet.sol +58 -0
  267. package/contracts/types/Blocknumber.sol +76 -18
  268. package/contracts/types/ChainId.sol +18 -10
  269. package/contracts/types/Fee.sol +51 -0
  270. package/contracts/types/NftId.sol +33 -11
  271. package/contracts/types/NftIdSet.sol +60 -0
  272. package/contracts/types/ObjectType.sol +115 -0
  273. package/contracts/types/RoleId.sol +36 -0
  274. package/contracts/types/StateId.sol +95 -0
  275. package/contracts/types/Timestamp.sol +85 -17
  276. package/contracts/types/UFixed.sol +78 -76
  277. package/contracts/types/Version.sol +95 -0
  278. package/package.json +19 -5
  279. package/artifacts/contracts/components/Component.sol/Component.dbg.json +0 -4
  280. package/artifacts/contracts/components/Component.sol/InstanceLinked.dbg.json +0 -4
  281. package/artifacts/contracts/components/Component.sol/InstanceLinked.json +0 -35
  282. package/artifacts/contracts/components/IPool.sol/IPoolComponent.dbg.json +0 -4
  283. package/artifacts/contracts/components/IProduct.sol/IProductComponent.dbg.json +0 -4
  284. package/artifacts/contracts/instance/access/Access.sol/AccessModule.dbg.json +0 -4
  285. package/artifacts/contracts/instance/access/IAccess.sol/IAccess.dbg.json +0 -4
  286. package/artifacts/contracts/instance/access/IAccess.sol/IAccessCheckRole.dbg.json +0 -4
  287. package/artifacts/contracts/instance/access/IAccess.sol/IAccessCheckRole.json +0 -35
  288. package/artifacts/contracts/instance/access/IAccess.sol/IAccessComponentTypeRoles.dbg.json +0 -4
  289. package/artifacts/contracts/instance/access/IAccess.sol/IAccessModule.dbg.json +0 -4
  290. package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentModule.dbg.json +0 -4
  291. package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentOwnerService.dbg.json +0 -4
  292. package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentOwnerService.json +0 -147
  293. package/artifacts/contracts/instance/component/IComponent.sol/IComponent.dbg.json +0 -4
  294. package/artifacts/contracts/instance/component/IComponent.sol/IComponentContract.dbg.json +0 -4
  295. package/artifacts/contracts/instance/component/IComponent.sol/IComponentModule.dbg.json +0 -4
  296. package/artifacts/contracts/instance/component/IComponent.sol/IComponentOwnerService.dbg.json +0 -4
  297. package/artifacts/contracts/instance/component/IComponent.sol/IComponentOwnerService.json +0 -94
  298. package/artifacts/contracts/instance/component/IComponent.sol/IInstanceLinked.dbg.json +0 -4
  299. package/artifacts/contracts/instance/policy/IPolicy.sol/IPolicy.dbg.json +0 -4
  300. package/artifacts/contracts/instance/policy/IPolicy.sol/IPolicyModule.dbg.json +0 -4
  301. package/artifacts/contracts/instance/policy/PolicyModule.sol/PolicyModule.dbg.json +0 -4
  302. package/artifacts/contracts/instance/pool/IPoolModule.sol/IPool.dbg.json +0 -4
  303. package/artifacts/contracts/instance/pool/IPoolModule.sol/IPoolModule.dbg.json +0 -4
  304. package/artifacts/contracts/instance/pool/PoolModule.sol/PoolModule.dbg.json +0 -4
  305. package/artifacts/contracts/instance/product/IProductService.sol/IProductModule.dbg.json +0 -4
  306. package/artifacts/contracts/instance/product/IProductService.sol/IProductModule.json +0 -75
  307. package/artifacts/contracts/instance/product/IProductService.sol/IProductService.dbg.json +0 -4
  308. package/artifacts/contracts/instance/product/IProductService.sol/IProductService.json +0 -114
  309. package/artifacts/contracts/instance/product/ProductService.sol/ProductModule.dbg.json +0 -4
  310. package/artifacts/contracts/instance/product/ProductService.sol/ProductModule.json +0 -75
  311. package/artifacts/contracts/instance/product/ProductService.sol/ProductService.dbg.json +0 -4
  312. package/artifacts/contracts/instance/product/ProductService.sol/ProductService.json +0 -167
  313. package/artifacts/contracts/registry/IRegistry.sol/IOwnable.dbg.json +0 -4
  314. package/artifacts/contracts/registry/IRegistry.sol/IRegisterable.dbg.json +0 -4
  315. package/artifacts/contracts/registry/IRegistry.sol/IRegistryLinked.dbg.json +0 -4
  316. package/artifacts/contracts/registry/IRegistry.sol/IRegistryLinked.json +0 -49
  317. package/artifacts/contracts/registry/Registry.sol/Registerable.dbg.json +0 -4
  318. package/artifacts/contracts/registry/Registry.sol/RegistryLinked.dbg.json +0 -4
  319. package/artifacts/contracts/registry/Registry.sol/RegistryLinked.json +0 -60
  320. package/contracts/components/Component.sol +0 -62
  321. package/contracts/components/IPool.sol +0 -9
  322. package/contracts/components/IProduct.sol +0 -12
  323. package/contracts/instance/access/Access.sol +0 -218
  324. package/contracts/instance/access/IAccess.sol +0 -83
  325. package/contracts/instance/component/ComponentModule.sol +0 -248
  326. package/contracts/instance/component/IComponent.sol +0 -95
  327. package/contracts/instance/policy/IPolicy.sol +0 -66
  328. package/contracts/instance/policy/PolicyModule.sol +0 -107
  329. package/contracts/instance/pool/IPoolModule.sol +0 -41
  330. package/contracts/instance/pool/PoolModule.sol +0 -86
  331. package/contracts/instance/product/IProductService.sol +0 -46
  332. package/contracts/instance/product/ProductService.sol +0 -108
@@ -0,0 +1,355 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ import {IRegistry} from "../../registry/IRegistry.sol";
5
+ import {IPoolComponent} from "../../components/IPoolComponent.sol";
6
+ import {IInstance} from "../../instance/IInstance.sol";
7
+ import {IPolicy, IPolicyModule} from "../module/policy/IPolicy.sol";
8
+ import {IPool} from "../module/pool/IPoolModule.sol";
9
+ import {IBundle} from "../module/bundle/IBundle.sol";
10
+ import {IProductService} from "./IProductService.sol";
11
+ import {ITreasury, ITreasuryModule, TokenHandler} from "../../instance/module/treasury/ITreasury.sol";
12
+
13
+ import {IVersionable} from "../../shared/IVersionable.sol";
14
+ import {Versionable} from "../../shared/Versionable.sol";
15
+
16
+ import {Timestamp, zeroTimestamp} from "../../types/Timestamp.sol";
17
+ import {UFixed, UFixedMathLib} from "../../types/UFixed.sol";
18
+ import {ObjectType, INSTANCE, PRODUCT, POLICY} from "../../types/ObjectType.sol";
19
+ import {APPLIED, UNDERWRITTEN, ACTIVE} from "../../types/StateId.sol";
20
+ import {NftId, NftIdLib} from "../../types/NftId.sol";
21
+ import {Blocknumber, blockNumber} from "../../types/Blocknumber.sol";
22
+ import {Fee, FeeLib} from "../../types/Fee.sol";
23
+ import {Version, VersionLib} from "../../types/Version.sol";
24
+
25
+ import {ComponentServiceBase} from "./ComponentServiceBase.sol";
26
+ import {IProductService} from "./IProductService.sol";
27
+
28
+ // TODO or name this ProtectionService to have Product be something more generic (loan, savings account, ...)
29
+ contract ProductService is ComponentServiceBase, IProductService {
30
+ using NftIdLib for NftId;
31
+
32
+ string public constant NAME = "ProductService";
33
+
34
+ event LogProductServiceSender(address sender);
35
+
36
+ constructor(
37
+ address registry,
38
+ NftId registryNftId
39
+ ) ComponentServiceBase(registry, registryNftId) // solhint-disable-next-line no-empty-blocks
40
+ {
41
+ _registerInterface(type(IProductService).interfaceId);
42
+ }
43
+
44
+ function getVersion()
45
+ public
46
+ pure
47
+ virtual override (IVersionable, Versionable)
48
+ returns(Version)
49
+ {
50
+ return VersionLib.toVersion(3,0,0);
51
+ }
52
+
53
+ function getName() external pure override returns(string memory name) {
54
+ return NAME;
55
+ }
56
+
57
+ function setFees(
58
+ Fee memory policyFee,
59
+ Fee memory processingFee
60
+ )
61
+ external
62
+ override
63
+ {
64
+ (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
65
+ instance.setProductFees(productInfo.nftId, policyFee, processingFee);
66
+ }
67
+
68
+ function createApplication(
69
+ address applicationOwner,
70
+ uint256 sumInsuredAmount,
71
+ uint256 premiumAmount,
72
+ uint256 lifetime,
73
+ NftId bundleNftId
74
+ ) external override returns (NftId policyNftId) {
75
+ (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
76
+ NftId productNftId = productInfo.nftId;
77
+ // TODO add validations (see create bundle in pool service)
78
+
79
+ policyNftId = this.getRegistry().registerObjectForInstance(
80
+ productNftId,
81
+ POLICY(),
82
+ applicationOwner,
83
+ ""
84
+ );
85
+
86
+ instance.createApplication(
87
+ productNftId,
88
+ policyNftId,
89
+ sumInsuredAmount,
90
+ premiumAmount,
91
+ lifetime,
92
+ bundleNftId
93
+ );
94
+
95
+ // TODO add logging
96
+ }
97
+
98
+ function _getAndVerifyUnderwritingSetup(
99
+ IInstance instance,
100
+ IPolicy.PolicyInfo memory policyInfo
101
+ )
102
+ internal
103
+ view
104
+ returns (
105
+ ITreasury.ProductSetup memory productSetup,
106
+ IBundle.BundleInfo memory bundleInfo,
107
+ uint256 collateralAmount,
108
+ bool poolIsVerifying,
109
+ bytes memory bundleFilter
110
+ )
111
+ {
112
+ // check match between policy and bundle (via pool)
113
+ productSetup = instance.getProductSetup(policyInfo.productNftId);
114
+ bundleInfo = instance.getBundleInfo(policyInfo.bundleNftId);
115
+ require(bundleInfo.poolNftId == productSetup.poolNftId, "POLICY_BUNDLE_MISMATCH");
116
+
117
+ // calculate required collateral
118
+ NftId poolNftId = productSetup.poolNftId;
119
+ IPool.PoolInfo memory poolInfo = instance.getPoolInfo(poolNftId);
120
+
121
+ // obtain remaining return values
122
+ poolIsVerifying = poolInfo.isVerifying;
123
+ collateralAmount = calculateRequiredCollateral(poolInfo.collateralizationLevel, policyInfo.sumInsuredAmount);
124
+ bundleFilter = bundleInfo.filter;
125
+ }
126
+
127
+ function _lockCollateralInBundle(
128
+ IInstance instance,
129
+ IBundle.BundleInfo memory bundleInfo,
130
+ NftId policyNftId,
131
+ uint256 collateralAmount
132
+ )
133
+ internal
134
+ returns (IBundle.BundleInfo memory)
135
+ {
136
+ bundleInfo.lockedAmount += collateralAmount;
137
+ bundleInfo.updatedIn = blockNumber();
138
+ instance.collateralizePolicy(bundleInfo.nftId, policyNftId, collateralAmount);
139
+ return bundleInfo;
140
+ }
141
+
142
+ function _underwriteByPool(
143
+ ITreasury.ProductSetup memory productSetup,
144
+ IPolicy.PolicyInfo memory policyInfo,
145
+ bytes memory bundleFilter,
146
+ uint256 collateralAmount
147
+ )
148
+ internal
149
+ {
150
+ address poolAddress = _registry.getObjectInfo(productSetup.poolNftId).objectAddress;
151
+ IPoolComponent pool = IPoolComponent(poolAddress);
152
+ pool.underwrite(
153
+ policyInfo.nftId,
154
+ policyInfo.data,
155
+ bundleFilter,
156
+ collateralAmount);
157
+ }
158
+
159
+
160
+ function underwrite(
161
+ NftId policyNftId,
162
+ bool requirePremiumPayment,
163
+ Timestamp activateAt
164
+ )
165
+ external
166
+ override
167
+ {
168
+ // check caller is registered product
169
+ (
170
+ IRegistry.ObjectInfo memory productInfo,
171
+ IInstance instance
172
+ ) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
173
+
174
+ // check match between policy and calling product
175
+ NftId productNftId = productInfo.nftId;
176
+ IPolicy.PolicyInfo memory policyInfo = instance.getPolicyInfo(policyNftId);
177
+ require(policyInfo.productNftId == productNftId, "POLICY_PRODUCT_MISMATCH");
178
+ require(policyInfo.state == APPLIED(), "ERROR:PRS-021:STATE_NOT_APPLIED");
179
+
180
+ (
181
+ ITreasury.ProductSetup memory productSetup,
182
+ IBundle.BundleInfo memory bundleInfo,
183
+ uint256 collateralAmount,
184
+ bool poolIsVerifying,
185
+ bytes memory bundleFilter
186
+ ) = _getAndVerifyUnderwritingSetup(
187
+ instance,
188
+ policyInfo
189
+ );
190
+
191
+ // lock bundle collateral
192
+ bundleInfo = _lockCollateralInBundle(
193
+ instance,
194
+ bundleInfo,
195
+ policyNftId,
196
+ collateralAmount);
197
+
198
+ // collect premium
199
+ if(requirePremiumPayment) {
200
+ uint256 netPremiumAmount = _processPremiumByTreasury(
201
+ instance,
202
+ productSetup,
203
+ policyNftId,
204
+ policyInfo.premiumAmount);
205
+
206
+ policyInfo.premiumPaidAmount += policyInfo.premiumAmount;
207
+ bundleInfo.balanceAmount += netPremiumAmount;
208
+ }
209
+
210
+ // set policy state to underwritten
211
+ // TODO add require for state change
212
+ policyInfo.state = UNDERWRITTEN();
213
+ policyInfo.updatedIn = blockNumber();
214
+
215
+ // optional activation of policy
216
+ if(activateAt > zeroTimestamp()) {
217
+ policyInfo.activatedAt = activateAt;
218
+ policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
219
+
220
+ // TODO add require for state change
221
+ policyInfo.state = ACTIVE();
222
+ }
223
+
224
+ instance.setPolicyInfo(policyInfo);
225
+ instance.setBundleInfo(bundleInfo);
226
+
227
+ // integrate pool component
228
+ if(poolIsVerifying) {
229
+ _underwriteByPool(
230
+ productSetup,
231
+ policyInfo,
232
+ bundleFilter,
233
+ collateralAmount
234
+ );
235
+ }
236
+
237
+ // TODO add logging
238
+ }
239
+
240
+ function calculateRequiredCollateral(UFixed collateralizationLevel, uint256 sumInsuredAmount) public pure override returns(uint256 collateralAmount) {
241
+ UFixed sumInsuredUFixed = UFixedMathLib.toUFixed(sumInsuredAmount);
242
+ UFixed collateralUFixed = collateralizationLevel * sumInsuredUFixed;
243
+ return collateralUFixed.toInt();
244
+ }
245
+
246
+ function collectPremium(NftId policyNftId, Timestamp activateAt) external override {
247
+ // check caller is registered product
248
+ (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
249
+
250
+ // perform actual token transfers
251
+ IPolicy.PolicyInfo memory policyInfo = instance.getPolicyInfo(policyNftId);
252
+ ITreasury.ProductSetup memory product = instance.getProductSetup(productInfo.nftId);
253
+
254
+ uint256 premiumAmount = policyInfo.premiumAmount;
255
+ _processPremiumByTreasury(instance, product, policyNftId, premiumAmount);
256
+
257
+ // policy level book keeping for premium paid
258
+ policyInfo.premiumPaidAmount += premiumAmount;
259
+ policyInfo.updatedIn = blockNumber();
260
+
261
+ // optional activation of policy
262
+ if(activateAt > zeroTimestamp()) {
263
+ require(
264
+ policyInfo.activatedAt.eqz(),
265
+ "ERROR:PRS-030:ALREADY_ACTIVATED");
266
+
267
+ policyInfo.activatedAt = activateAt;
268
+ policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
269
+
270
+ // TODO add require for state change
271
+ policyInfo.state = ACTIVE();
272
+ }
273
+
274
+ instance.setPolicyInfo(policyInfo);
275
+
276
+ // TODO add logging
277
+ }
278
+
279
+ function activate(NftId policyNftId, Timestamp activateAt) external override {
280
+ // check caller is registered product
281
+ (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
282
+
283
+ IPolicy.PolicyInfo memory policyInfo = instance.getPolicyInfo(policyNftId);
284
+
285
+ require(
286
+ policyInfo.activatedAt.eqz(),
287
+ "ERROR:PRS-020:ALREADY_ACTIVATED");
288
+
289
+ policyInfo.activatedAt = activateAt;
290
+ policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
291
+
292
+ // TODO add require for state change
293
+ policyInfo.state = ACTIVE();
294
+
295
+ instance.setPolicyInfo(policyInfo);
296
+
297
+ // TODO add logging
298
+ }
299
+
300
+ function close(
301
+ NftId policyNftId
302
+ ) external override // solhint-disable-next-line no-empty-blocks
303
+ {
304
+
305
+ }
306
+
307
+ function _getPoolNftId(
308
+ IInstance instance,
309
+ NftId productNftId
310
+ )
311
+ internal
312
+ view
313
+ returns (NftId poolNftid)
314
+ {
315
+ return instance.getProductSetup(productNftId).poolNftId;
316
+ }
317
+
318
+ function _processPremiumByTreasury(
319
+ IInstance instance,
320
+ ITreasury.ProductSetup memory product,
321
+ NftId policyNftId,
322
+ uint256 premiumAmount
323
+ )
324
+ internal
325
+ returns (uint256 netPremiumAmount)
326
+ {
327
+ // process token transfer(s)
328
+ if(premiumAmount > 0) {
329
+ TokenHandler tokenHandler = instance.getTokenHandler(product.productNftId);
330
+ address policyOwner = _registry.getOwner(policyNftId);
331
+ address poolWallet = instance.getPoolSetup(product.poolNftId).wallet;
332
+ netPremiumAmount = premiumAmount;
333
+ Fee memory policyFee = product.policyFee;
334
+
335
+ if (FeeLib.feeIsZero(policyFee)) {
336
+ tokenHandler.transfer(
337
+ policyOwner,
338
+ poolWallet,
339
+ premiumAmount
340
+ );
341
+ } else {
342
+ (uint256 feeAmount, uint256 netAmount) = instance.calculateFeeAmount(
343
+ premiumAmount,
344
+ policyFee
345
+ );
346
+
347
+ tokenHandler.transfer(policyOwner, product.wallet, feeAmount);
348
+ tokenHandler.transfer(policyOwner, poolWallet, netAmount);
349
+ netPremiumAmount = netAmount;
350
+ }
351
+ }
352
+
353
+ // TODO add logging
354
+ }
355
+ }
@@ -0,0 +1,39 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.19;
3
+
4
+ // import {IRegistry} from "../../registry/IRegistry.sol";
5
+ // import {ITreasury, ITreasuryModule, TokenHandler} from "../../instance/module/treasury/ITreasury.sol";
6
+ import {NftId, zeroNftId} from "../../types/NftId.sol";
7
+ import {ObjectType, SERVICE} from "../../types/ObjectType.sol";
8
+ import {Version, VersionPart} from "../../types/Version.sol";
9
+
10
+ import {Registerable} from "../../shared/Registerable.sol";
11
+ import {IVersionable} from "../../shared/IVersionable.sol";
12
+ import {Versionable} from "../../shared/Versionable.sol";
13
+
14
+ import {IService} from "./IService.sol";
15
+
16
+ abstract contract ServiceBase is
17
+ Registerable,
18
+ Versionable,
19
+ IService
20
+ {
21
+
22
+ constructor(
23
+ address registry,
24
+ NftId registryNftId
25
+ )
26
+ Registerable(registry, registryNftId)
27
+ Versionable()
28
+ {
29
+ _registerInterface(type(IService).interfaceId);
30
+ }
31
+
32
+ function getMajorVersion() external view override returns(VersionPart majorVersion) {
33
+ return this.getVersion().toMajorPart();
34
+ }
35
+
36
+ function getType() external pure override returns (ObjectType) {
37
+ return SERVICE();
38
+ }
39
+ }
@@ -4,13 +4,13 @@ pragma solidity ^0.8.19;
4
4
  import {ERC721, ERC721Enumerable} from "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
5
5
  import {IChainNft} from "./IChainNft.sol";
6
6
 
7
- contract ChainNft is
8
- ERC721Enumerable,
9
- IChainNft
10
- {
7
+ contract ChainNft is ERC721Enumerable, IChainNft {
11
8
  string public constant NAME = "Dezentralized Insurance Protocol Registry";
12
9
  string public constant SYMBOL = "DIPR";
13
10
 
11
+ uint256 public constant PROTOCOL_NFT_ID = 1101;
12
+ uint256 public constant GLOBAL_REGISTRY_ID = 2101;
13
+
14
14
  // remember token uri
15
15
  mapping(uint256 tokenId => string uri) private _uri;
16
16
 
@@ -18,22 +18,18 @@ contract ChainNft is
18
18
  address private _registry;
19
19
 
20
20
  // only used for _getNextTokenId
21
- uint256 internal _chainIdInt;
21
+ uint256 internal _chainIdInt;
22
22
  uint256 internal _chainIdDigits;
23
23
  uint256 internal _chainIdMultiplier;
24
24
  uint256 internal _idNext;
25
25
  uint256 internal _totalMinted;
26
26
 
27
-
28
27
  modifier onlyRegistry() {
29
28
  require(msg.sender == _registry, "ERROR:NFT-001:CALLER_NOT_REGISTRY");
30
29
  _;
31
30
  }
32
31
 
33
-
34
- constructor(address registry)
35
- ERC721(NAME, SYMBOL)
36
- {
32
+ constructor(address registry) ERC721(NAME, SYMBOL) {
37
33
  require(registry != address(0), "ERROR:NFT-010:REGISTRY_ZERO");
38
34
 
39
35
  _registry = registry;
@@ -41,129 +37,119 @@ contract ChainNft is
41
37
  _chainIdInt = block.chainid;
42
38
  _chainIdDigits = _countDigits(_chainIdInt);
43
39
  _chainIdMultiplier = 10 ** _chainIdDigits;
44
-
45
- // on mainnet/goerli start /1 (reserved for protocol nft) on other chains with 2
46
- if(block.chainid == 1 || block.chainid == 5) {
47
- _idNext = 1;
48
- } else {
49
- _idNext = 2;
50
- }
40
+ _idNext = 3;
51
41
  }
52
42
 
53
-
43
+ /**
44
+ * @dev mints the next token to register new objects
45
+ */
54
46
  function mint(
55
47
  address to,
56
48
  string memory uri
57
- )
58
- external
59
- override
60
- onlyRegistry
61
- returns(uint256 tokenId)
62
- {
49
+ ) external override onlyRegistry returns (uint256 tokenId) {
63
50
  tokenId = _getNextTokenId();
64
- _totalMinted++;
65
-
66
- _safeMint(to, tokenId);
67
51
 
68
- if(bytes(uri).length > 0) {
52
+ if (bytes(uri).length > 0) {
69
53
  _uri[tokenId] = uri;
70
54
  }
55
+
56
+ _safeMint(to, tokenId);
57
+ _totalMinted++;
71
58
  }
72
59
 
60
+ /**
61
+ * @dev mints a token for a specified token id
62
+ * not part of the IRegistry interface only needed for
63
+ * initial registry setup (protocol and global registry objects)
64
+ */
65
+ function mint(address to, uint256 tokenId) external onlyRegistry {
66
+ _totalMinted++;
67
+ _safeMint(to, tokenId);
68
+ }
73
69
 
74
- function burn(uint256 tokenId)
75
- external
76
- override
77
- onlyRegistry
78
- {
70
+ function burn(uint256 tokenId) external override onlyRegistry {
79
71
  _requireMinted(tokenId);
80
72
  _burn(tokenId);
81
73
  delete _uri[tokenId];
82
74
  }
83
75
 
84
-
85
- function setURI(uint256 tokenId, string memory uri)
86
- external
87
- override
88
- onlyRegistry
89
- {
76
+ function setURI(
77
+ uint256 tokenId,
78
+ string memory uri
79
+ ) external override onlyRegistry {
90
80
  require(bytes(uri).length > 0, "ERROR:CRG-011:URI_EMPTY");
91
81
 
92
82
  _requireMinted(tokenId);
93
83
  _uri[tokenId] = uri;
94
84
  }
95
85
 
96
-
97
- function exists(uint256 tokenId)
98
- external
99
- view
100
- override
101
- returns(bool)
102
- {
86
+ function exists(uint256 tokenId) external view override returns (bool) {
103
87
  return _exists(tokenId);
104
88
  }
105
89
 
106
-
107
- function tokenURI(uint256 tokenId)
108
- public
109
- view
110
- override
111
- returns(string memory)
112
- {
90
+ function tokenURI(
91
+ uint256 tokenId
92
+ ) public view override returns (string memory) {
113
93
  _requireMinted(tokenId);
114
94
  return _uri[tokenId];
115
95
  }
116
96
 
117
-
118
- function getRegistryAddress()
119
- external
120
- view
121
- override
122
- returns(address)
123
- {
97
+ function getRegistryAddress() external view override returns (address) {
124
98
  return _registry;
125
99
  }
126
100
 
127
- function totalMinted() external override view returns(uint256) {
101
+ function totalMinted() external view override returns (uint256) {
128
102
  return _totalMinted;
129
103
  }
130
104
 
131
- // requirement: each chain registry produces token ids that
132
- // are guaranteed to not collide with any token id genereated
133
- // on a different chain
134
- //
135
- // format concat(counter,chainid,2 digits for len-of-chain-id)
136
- // restriction chainid up to 99 digits
137
- // decode: from right to left:
138
- // - 2 right most digits encode length of chainid
139
- // - move number of digits to left as determined above (-> chainid)
140
- // - the reminder to the left is the counter
141
- // examples
142
- // 1101
143
- // ^^ ^
144
- // || +- 1-digit chain id
145
- // |+-- chain id = 1 (mainnet)
146
- // +-- 1st token id on mainnet
147
- // (1 * 10 ** 1 + 1) * 100 + 1
148
- // 42987654321010
149
- // ^ ^ ^
150
- // | | +- 10-digit chain id
151
- // | +-- chain id = 9876543210 (hypothetical chainid)
152
- // +-- 42nd token id on this chain
153
- // (42 * 10 ** 10 + 9876543210) * 100 + 10
154
- // (index * 10 ** digits + chainid) * 100 + digits (1 < digits < 100)
155
-
156
- function _getNextTokenId() private returns(uint256 id) {
157
- id = (_idNext * _chainIdMultiplier + _chainIdInt) * 100 + _chainIdDigits;
158
- _idNext++;
105
+ /**
106
+ * @dev token id calculation based on an index value that is supposed
107
+ * to increase with every minted token
108
+ *
109
+ * requirement: each chain registry produces token ids that
110
+ * are guaranteed to not collide with any token id genereated
111
+ * on a different chain
112
+ *
113
+ * format concat(counter,chainid,2 digits for len-of-chain-id)
114
+ * restriction chainid up to 99 digits
115
+ * decode: from right to left:
116
+ * - 2 right most digits encode length of chainid
117
+ * - move number of digits to left as determined above (-> chainid)
118
+ * - the reminder to the left is the counter
119
+ *
120
+ * special cases
121
+ * 1101 -> decentralized insurance protocol
122
+ * 2102 -> global registry
123
+ * 2xxxxx -> chain registry, where xxxxx = <chain-part>
124
+ *
125
+ * examples
126
+ * 1101
127
+ * ^^ ^
128
+ * || +- 1-digit chain id
129
+ * |+-- chain id = 1 (mainnet)
130
+ * +-- 1st token id on mainnet
131
+ * (1 * 10 ** 1 + 1) * 100 + 1
132
+ * 42987654321010
133
+ * ^ ^ ^
134
+ * | | +- 10-digit chain id
135
+ * | +-- chain id = 9876543210 (hypothetical chainid)
136
+ * +-- 42nd token id on this chain
137
+ * (42 * 10 ** 10 + 9876543210) * 100 + 10
138
+ * (index * 10 ** digits + chainid) * 100 + digits (1 < digits < 100)
139
+ */
140
+ function calculateTokenId(uint256 idIndex) public view returns (uint256 id) {
141
+ id =
142
+ (idIndex * _chainIdMultiplier + _chainIdInt) *
143
+ 100 +
144
+ _chainIdDigits;
159
145
  }
160
146
 
147
+ function _getNextTokenId() private returns (uint256 id) {
148
+ id = calculateTokenId(_idNext);
149
+ _idNext++;
150
+ }
161
151
 
162
- function _countDigits(uint256 num)
163
- private
164
- pure
165
- returns (uint256 count)
166
- {
152
+ function _countDigits(uint256 num) private pure returns (uint256 count) {
167
153
  count = 0;
168
154
  while (num != 0) {
169
155
  count++;
@@ -3,16 +3,19 @@ pragma solidity ^0.8.19;
3
3
 
4
4
  import {IERC721Enumerable} from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Enumerable.sol";
5
5
 
6
- interface IChainNft is
7
- IERC721Enumerable
8
- {
6
+ interface IChainNft is IERC721Enumerable {
7
+ function mint(
8
+ address to,
9
+ string memory uri
10
+ ) external returns (uint256 tokenId);
9
11
 
10
- function mint(address to, string memory uri) external returns(uint256 tokenId);
11
12
  function burn(uint256 tokenId) external;
13
+
12
14
  function setURI(uint256 tokenId, string memory uri) external;
13
15
 
14
- function exists(uint256 tokenId) external view returns(bool);
15
- function totalMinted() external view returns(uint256);
16
+ function exists(uint256 tokenId) external view returns (bool);
17
+
18
+ function totalMinted() external view returns (uint256);
16
19
 
17
- function getRegistryAddress() external view returns(address registry);
20
+ function getRegistryAddress() external view returns (address registry);
18
21
  }