@etherisc/gif-next 0.0.2-d679de9-140 → 0.0.2-d8b116d-201

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 (397) hide show
  1. package/README.md +235 -7
  2. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.dbg.json +1 -1
  3. package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.json +176 -23
  4. package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json +4 -0
  5. package/artifacts/contracts/components/Distribution.sol/Distribution.json +618 -0
  6. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json +1 -1
  7. package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.json +129 -23
  8. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.dbg.json +4 -0
  9. package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.json +152 -0
  10. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.dbg.json +1 -1
  11. package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.json +74 -181
  12. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.dbg.json +1 -1
  13. package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.json +55 -177
  14. package/artifacts/contracts/components/Pool.sol/Pool.dbg.json +1 -1
  15. package/artifacts/contracts/components/Pool.sol/Pool.json +463 -63
  16. package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
  17. package/artifacts/contracts/components/Product.sol/Product.json +494 -70
  18. package/artifacts/contracts/experiment/cloning/Cloner.sol/Cloner.dbg.json +4 -0
  19. package/artifacts/contracts/experiment/cloning/Cloner.sol/Cloner.json +66 -0
  20. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock1.dbg.json +4 -0
  21. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock1.json +24 -0
  22. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock2.dbg.json +4 -0
  23. package/artifacts/contracts/experiment/cloning/Cloner.sol/Mock2.json +42 -0
  24. package/artifacts/contracts/experiment/errors/Require.sol/Require.dbg.json +1 -1
  25. package/artifacts/contracts/experiment/errors/Require.sol/Require.json +2 -2
  26. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.dbg.json +1 -1
  27. package/artifacts/contracts/experiment/errors/Revert.sol/Revert.json +2 -2
  28. package/artifacts/contracts/experiment/inheritance/A.sol/A.dbg.json +1 -1
  29. package/artifacts/contracts/experiment/inheritance/A.sol/A.json +2 -2
  30. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.dbg.json +1 -1
  31. package/artifacts/contracts/experiment/inheritance/A.sol/AShared.json +2 -2
  32. package/artifacts/contracts/experiment/inheritance/B.sol/B.dbg.json +1 -1
  33. package/artifacts/contracts/experiment/inheritance/C.sol/C.dbg.json +1 -1
  34. package/artifacts/contracts/experiment/inheritance/IA.sol/IA.dbg.json +1 -1
  35. package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.dbg.json +1 -1
  36. package/artifacts/contracts/experiment/inheritance/IB.sol/IB.dbg.json +1 -1
  37. package/artifacts/contracts/experiment/inheritance/IC.sol/IC.dbg.json +1 -1
  38. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.dbg.json +1 -1
  39. package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.json +2 -2
  40. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.dbg.json +1 -1
  41. package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.dbg.json +1 -1
  42. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.dbg.json +1 -1
  43. package/artifacts/contracts/experiment/statemachine/SM.sol/SM.json +2 -2
  44. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.dbg.json +1 -1
  45. package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.json +2 -2
  46. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.dbg.json +1 -1
  47. package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.json +2 -2
  48. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.dbg.json +1 -1
  49. package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.json +2 -2
  50. package/artifacts/contracts/instance/AccessManagedSimple.sol/AccessManagedSimple.dbg.json +4 -0
  51. package/artifacts/contracts/instance/AccessManagedSimple.sol/AccessManagedSimple.json +101 -0
  52. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.dbg.json +4 -0
  53. package/artifacts/contracts/instance/AccessManagerSimple.sol/AccessManagerSimple.json +1132 -0
  54. package/artifacts/contracts/instance/BundleManager.sol/BundleManager.dbg.json +4 -0
  55. package/artifacts/contracts/instance/BundleManager.sol/BundleManager.json +750 -0
  56. package/artifacts/contracts/instance/Cloneable.sol/Cloneable.dbg.json +4 -0
  57. package/artifacts/contracts/instance/Cloneable.sol/Cloneable.json +185 -0
  58. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.dbg.json +4 -0
  59. package/artifacts/contracts/instance/IAccessManagerSimple.sol/IAccessManagerSimple.json +1082 -0
  60. package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
  61. package/artifacts/contracts/instance/IInstance.sol/IInstance.json +915 -1096
  62. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.dbg.json +4 -0
  63. package/artifacts/contracts/instance/IInstanceService.sol/IInstanceService.json +480 -0
  64. package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
  65. package/artifacts/contracts/instance/Instance.sol/Instance.json +2518 -1092
  66. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.dbg.json +4 -0
  67. package/artifacts/contracts/instance/InstanceAccessManager.sol/InstanceAccessManager.json +917 -0
  68. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.dbg.json +4 -0
  69. package/artifacts/contracts/instance/InstanceReader.sol/InstanceReader.json +1422 -0
  70. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.dbg.json +4 -0
  71. package/artifacts/contracts/instance/InstanceService.sol/InstanceService.json +931 -0
  72. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.dbg.json +4 -0
  73. package/artifacts/contracts/instance/InstanceServiceManager.sol/InstanceServiceManager.json +508 -0
  74. package/artifacts/contracts/instance/ObjectManager.sol/ObjectManager.dbg.json +4 -0
  75. package/artifacts/contracts/instance/ObjectManager.sol/ObjectManager.json +272 -0
  76. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +1 -1
  77. package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.json +276 -36
  78. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.dbg.json +1 -1
  79. package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.json +51 -1
  80. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.dbg.json +1 -1
  81. package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.json +45 -127
  82. package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.dbg.json +1 -1
  83. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.dbg.json +1 -1
  84. package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.json +55 -245
  85. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.dbg.json +1 -1
  86. package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.json +6 -6
  87. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.dbg.json +4 -0
  88. package/artifacts/contracts/instance/module/IAccess.sol/IAccess.json +211 -0
  89. package/artifacts/contracts/instance/module/IBundle.sol/IBundle.dbg.json +4 -0
  90. package/artifacts/contracts/instance/module/{bundle/IBundle.sol → IBundle.sol}/IBundle.json +1 -1
  91. package/artifacts/contracts/instance/module/IDistribution.sol/IDistribution.dbg.json +4 -0
  92. package/artifacts/contracts/instance/module/{access/IAccess.sol/IAccess.json → IDistribution.sol/IDistribution.json} +2 -2
  93. package/artifacts/contracts/instance/module/IPolicy.sol/IPolicy.dbg.json +4 -0
  94. package/artifacts/contracts/instance/module/{policy/IPolicy.sol → IPolicy.sol}/IPolicy.json +1 -1
  95. package/artifacts/contracts/instance/module/IRisk.sol/IRisk.dbg.json +4 -0
  96. package/artifacts/contracts/instance/module/{risk/IRisk.sol → IRisk.sol}/IRisk.json +1 -1
  97. package/artifacts/contracts/instance/module/ISetup.sol/ISetup.dbg.json +4 -0
  98. package/artifacts/contracts/instance/{base/ModuleBase.sol/ModuleBase.json → module/ISetup.sol/ISetup.json} +2 -2
  99. package/artifacts/contracts/instance/module/ITreasury.sol/ITreasury.dbg.json +4 -0
  100. package/artifacts/contracts/instance/module/{treasury/ITreasury.sol → ITreasury.sol}/ITreasury.json +1 -1
  101. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.dbg.json +1 -1
  102. package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.json +401 -65
  103. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.dbg.json +4 -0
  104. package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.json +716 -0
  105. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.dbg.json +4 -0
  106. package/artifacts/contracts/instance/service/DistributionServiceManager.sol/DistributionServiceManager.json +444 -0
  107. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.dbg.json +1 -1
  108. package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.json +177 -75
  109. package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.dbg.json +4 -0
  110. package/artifacts/contracts/instance/{base/ServiceBase.sol/ServiceBase.json → service/IDistributionService.sol/IDistributionService.json} +204 -58
  111. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +1 -1
  112. package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +342 -49
  113. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +1 -1
  114. package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +334 -51
  115. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.dbg.json +1 -1
  116. package/artifacts/contracts/instance/service/PoolService.sol/PoolService.json +551 -51
  117. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.dbg.json +4 -0
  118. package/artifacts/contracts/instance/service/PoolServiceManager.sol/PoolServiceManager.json +460 -0
  119. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.dbg.json +1 -1
  120. package/artifacts/contracts/instance/service/ProductService.sol/ProductService.json +552 -78
  121. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.dbg.json +4 -0
  122. package/artifacts/contracts/instance/service/ProductServiceManager.sol/ProductServiceManager.json +488 -0
  123. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
  124. package/artifacts/contracts/registry/ChainNft.sol/ChainNft.json +186 -12
  125. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
  126. package/artifacts/contracts/registry/IRegistry.sol/IRegistry.json +377 -37
  127. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.dbg.json +4 -0
  128. package/artifacts/contracts/registry/IRegistryService.sol/IRegistryService.json +947 -0
  129. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.dbg.json +4 -0
  130. package/artifacts/contracts/registry/ITransferInterceptor.sol/ITransferInterceptor.json +34 -0
  131. package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
  132. package/artifacts/contracts/registry/Registry.sol/Registry.json +487 -123
  133. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.dbg.json +4 -0
  134. package/artifacts/contracts/registry/RegistryService.sol/RegistryService.json +1293 -0
  135. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.dbg.json +4 -0
  136. package/artifacts/contracts/registry/RegistryServiceManager.sol/RegistryServiceManager.json +517 -0
  137. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.dbg.json +4 -0
  138. package/artifacts/contracts/registry/TokenRegistry.sol/TokenRegistry.json +410 -0
  139. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.dbg.json +4 -0
  140. package/artifacts/contracts/shared/ContractDeployerLib.sol/ContractDeployerLib.json +107 -0
  141. package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json +1 -1
  142. package/artifacts/contracts/shared/ERC165.sol/ERC165.json +2 -2
  143. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.dbg.json +4 -0
  144. package/artifacts/contracts/shared/INftOwnable.sol/INftOwnable.json +127 -0
  145. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +1 -1
  146. package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.json +117 -37
  147. package/artifacts/contracts/shared/IService.sol/IService.dbg.json +4 -0
  148. package/artifacts/contracts/{instance/base → shared}/IService.sol/IService.json +175 -54
  149. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.dbg.json +1 -1
  150. package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json +55 -14
  151. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.dbg.json +4 -0
  152. package/artifacts/contracts/shared/NftOwnable.sol/NftOwnable.json +158 -0
  153. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.dbg.json +4 -0
  154. package/artifacts/contracts/shared/ProxyManager.sol/ProxyManager.json +349 -0
  155. package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +1 -1
  156. package/artifacts/contracts/shared/Registerable.sol/Registerable.json +190 -37
  157. package/artifacts/contracts/shared/RegisterableUpgradable.sol/RegisterableUpgradable.dbg.json +4 -0
  158. package/artifacts/contracts/{instance/base/InstanceBase.sol/InstanceBase.json → shared/RegisterableUpgradable.sol/RegisterableUpgradable.json} +199 -83
  159. package/artifacts/contracts/shared/Service.sol/Service.dbg.json +4 -0
  160. package/artifacts/contracts/shared/Service.sol/Service.json +468 -0
  161. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.dbg.json +4 -0
  162. package/artifacts/contracts/shared/TokenHandler.sol/TokenHandler.json +96 -0
  163. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.dbg.json +4 -0
  164. package/artifacts/contracts/shared/UpgradableProxyWithAdmin.sol/UpgradableProxyWithAdmin.json +129 -0
  165. package/artifacts/contracts/shared/Versionable.sol/Versionable.dbg.json +1 -1
  166. package/artifacts/contracts/shared/Versionable.sol/Versionable.json +78 -14
  167. package/artifacts/contracts/test/TestFee.sol/TestFee.dbg.json +1 -1
  168. package/artifacts/contracts/test/TestFee.sol/TestFee.json +10 -10
  169. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.dbg.json +1 -1
  170. package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.json +204 -36
  171. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.dbg.json +1 -1
  172. package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.json +44 -10
  173. package/artifacts/contracts/test/TestService.sol/TestService.dbg.json +1 -1
  174. package/artifacts/contracts/test/TestService.sol/TestService.json +283 -62
  175. package/artifacts/contracts/test/TestToken.sol/TestUsdc.dbg.json +1 -1
  176. package/artifacts/contracts/test/TestToken.sol/TestUsdc.json +91 -53
  177. package/artifacts/contracts/test/TestVersion.sol/TestVersion.dbg.json +1 -1
  178. package/artifacts/contracts/test/TestVersion.sol/TestVersion.json +12 -12
  179. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.dbg.json +1 -1
  180. package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.json +103 -23
  181. package/artifacts/contracts/test/Usdc.sol/USDC.dbg.json +4 -0
  182. package/artifacts/contracts/test/Usdc.sol/USDC.json +376 -0
  183. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.dbg.json +1 -1
  184. package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.json +2 -2
  185. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
  186. package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.json +2 -2
  187. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.dbg.json +1 -1
  188. package/artifacts/contracts/types/ChainId.sol/ChainIdLib.json +2 -2
  189. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.dbg.json +4 -0
  190. package/artifacts/contracts/types/DistributorType.sol/DistributorTypeLib.json +104 -0
  191. package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +1 -1
  192. package/artifacts/contracts/types/Fee.sol/FeeLib.json +52 -13
  193. package/artifacts/contracts/types/Key32.sol/Key32Lib.dbg.json +1 -1
  194. package/artifacts/contracts/types/Key32.sol/Key32Lib.json +31 -17
  195. package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
  196. package/artifacts/contracts/types/NftId.sol/NftIdLib.json +4 -4
  197. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +1 -1
  198. package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +26 -3
  199. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.dbg.json +4 -0
  200. package/artifacts/contracts/types/NumberId.sol/NumberIdLib.json +100 -0
  201. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +1 -1
  202. package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +2 -2
  203. package/artifacts/contracts/types/Referral.sol/ReferralLib.dbg.json +4 -0
  204. package/artifacts/contracts/types/Referral.sol/ReferralLib.json +123 -0
  205. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.dbg.json +4 -0
  206. package/artifacts/contracts/types/RiskId.sol/RiskIdLib.json +86 -0
  207. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.dbg.json +4 -0
  208. package/artifacts/contracts/types/RoleId.sol/RoleIdLib.json +156 -0
  209. package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +1 -1
  210. package/artifacts/contracts/types/StateId.sol/StateIdLib.json +2 -2
  211. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
  212. package/artifacts/contracts/types/Timestamp.sol/TimestampLib.json +15 -2
  213. package/artifacts/contracts/types/UFixed.sol/MathLib.dbg.json +4 -0
  214. package/artifacts/contracts/types/UFixed.sol/MathLib.json +10 -0
  215. package/artifacts/contracts/types/UFixed.sol/UFixedLib.dbg.json +4 -0
  216. package/artifacts/contracts/types/UFixed.sol/UFixedLib.json +479 -0
  217. package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +1 -1
  218. package/artifacts/contracts/types/Version.sol/VersionLib.json +40 -2
  219. package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +1 -1
  220. package/artifacts/contracts/types/Version.sol/VersionPartLib.json +22 -3
  221. package/contracts/components/BaseComponent.sol +26 -23
  222. package/contracts/components/Distribution.sol +163 -0
  223. package/contracts/components/IBaseComponent.sol +9 -3
  224. package/contracts/components/IDistributionComponent.sol +44 -0
  225. package/contracts/components/IPoolComponent.sol +15 -10
  226. package/contracts/components/IProductComponent.sol +25 -9
  227. package/contracts/components/Pool.sol +106 -33
  228. package/contracts/components/Product.sol +204 -32
  229. package/contracts/experiment/cloning/Cloner.sol +47 -0
  230. package/contracts/instance/AccessManagedSimple.sol +115 -0
  231. package/contracts/instance/AccessManagerSimple.sol +692 -0
  232. package/contracts/instance/BundleManager.sol +143 -0
  233. package/contracts/instance/Cloneable.sol +47 -0
  234. package/contracts/instance/IAccessManagerSimple.sol +391 -0
  235. package/contracts/instance/IInstance.sol +47 -45
  236. package/contracts/instance/IInstanceService.sol +30 -0
  237. package/contracts/instance/Instance.sol +426 -51
  238. package/contracts/instance/InstanceAccessManager.sol +288 -0
  239. package/contracts/instance/InstanceReader.sol +315 -0
  240. package/contracts/instance/InstanceService.sol +201 -0
  241. package/contracts/instance/InstanceServiceManager.sol +57 -0
  242. package/contracts/instance/ObjectManager.sol +95 -0
  243. package/contracts/instance/base/ComponentServiceBase.sol +102 -10
  244. package/contracts/instance/base/IInstanceBase.sol +11 -2
  245. package/contracts/instance/base/IKeyValueStore.sol +13 -13
  246. package/contracts/instance/base/ILifecycle.sol +3 -3
  247. package/contracts/instance/base/KeyValueStore.sol +53 -37
  248. package/contracts/instance/base/Lifecycle.sol +16 -11
  249. package/contracts/instance/module/IAccess.sol +38 -0
  250. package/contracts/instance/module/IBundle.sol +20 -0
  251. package/contracts/instance/module/IDistribution.sol +39 -0
  252. package/contracts/instance/module/IPolicy.sol +45 -0
  253. package/contracts/instance/module/IRisk.sol +11 -0
  254. package/contracts/instance/module/ISetup.sol +46 -0
  255. package/contracts/instance/module/ITreasury.sol +23 -0
  256. package/contracts/instance/service/ComponentOwnerService.sol +244 -97
  257. package/contracts/instance/service/DistributionService.sol +88 -0
  258. package/contracts/instance/service/DistributionServiceManager.sol +54 -0
  259. package/contracts/instance/service/IComponentOwnerService.sol +1 -3
  260. package/contracts/instance/service/IDistributionService.sol +12 -0
  261. package/contracts/instance/service/IPoolService.sol +14 -1
  262. package/contracts/instance/service/IProductService.sol +59 -7
  263. package/contracts/instance/service/PoolService.sol +123 -42
  264. package/contracts/instance/service/PoolServiceManager.sol +54 -0
  265. package/contracts/instance/service/ProductService.sol +340 -133
  266. package/contracts/instance/service/ProductServiceManager.sol +54 -0
  267. package/contracts/registry/ChainNft.sol +80 -37
  268. package/contracts/registry/IRegistry.sol +49 -25
  269. package/contracts/registry/IRegistryService.sol +50 -0
  270. package/contracts/registry/ITransferInterceptor.sol +6 -0
  271. package/contracts/registry/Registry.sol +337 -270
  272. package/contracts/registry/RegistryService.sol +358 -0
  273. package/contracts/registry/RegistryServiceManager.sol +80 -0
  274. package/contracts/registry/TokenRegistry.sol +111 -0
  275. package/contracts/shared/ContractDeployerLib.sol +72 -0
  276. package/contracts/shared/ERC165.sol +6 -2
  277. package/contracts/shared/INftOwnable.sol +22 -0
  278. package/contracts/shared/IRegisterable.sol +8 -15
  279. package/contracts/{instance/base → shared}/IService.sol +3 -3
  280. package/contracts/shared/IVersionable.sol +55 -11
  281. package/contracts/shared/NftOwnable.sol +134 -0
  282. package/contracts/shared/ProxyManager.sol +94 -0
  283. package/contracts/shared/Registerable.sol +63 -59
  284. package/contracts/shared/RegisterableUpgradable.sol +16 -0
  285. package/contracts/shared/Service.sol +55 -0
  286. package/contracts/shared/TokenHandler.sol +27 -0
  287. package/contracts/shared/UpgradableProxyWithAdmin.sol +16 -0
  288. package/contracts/shared/Versionable.sol +113 -55
  289. package/contracts/test/TestFee.sol +2 -2
  290. package/contracts/test/TestRegisterable.sol +5 -6
  291. package/contracts/test/TestRoleId.sol +2 -2
  292. package/contracts/test/TestService.sol +5 -13
  293. package/contracts/test/Usdc.sol +26 -0
  294. package/contracts/types/DistributorType.sol +55 -0
  295. package/contracts/types/Fee.sol +10 -5
  296. package/contracts/types/Key32.sol +8 -3
  297. package/contracts/types/NftIdSet.sol +26 -24
  298. package/contracts/types/NumberId.sol +52 -0
  299. package/contracts/types/ObjectType.sol +51 -14
  300. package/contracts/types/Referral.sol +85 -0
  301. package/contracts/types/RiskId.sol +43 -0
  302. package/contracts/types/RoleId.sol +65 -11
  303. package/contracts/types/StateId.sol +5 -1
  304. package/contracts/types/Timestamp.sol +7 -3
  305. package/contracts/types/UFixed.sol +139 -24
  306. package/contracts/types/Version.sol +13 -1
  307. package/package.json +7 -3
  308. package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.dbg.json +0 -4
  309. package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.json +0 -24
  310. package/artifacts/contracts/instance/base/IService.sol/IService.dbg.json +0 -4
  311. package/artifacts/contracts/instance/base/InstanceBase.sol/InstanceBase.dbg.json +0 -4
  312. package/artifacts/contracts/instance/base/ModuleBase.sol/ModuleBase.dbg.json +0 -4
  313. package/artifacts/contracts/instance/base/ServiceBase.sol/ServiceBase.dbg.json +0 -4
  314. package/artifacts/contracts/instance/module/access/Access.sol/AccessModule.dbg.json +0 -4
  315. package/artifacts/contracts/instance/module/access/Access.sol/AccessModule.json +0 -333
  316. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccess.dbg.json +0 -4
  317. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccessModule.dbg.json +0 -4
  318. package/artifacts/contracts/instance/module/access/IAccess.sol/IAccessModule.json +0 -333
  319. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.dbg.json +0 -4
  320. package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.json +0 -296
  321. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundle.dbg.json +0 -4
  322. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.dbg.json +0 -4
  323. package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.json +0 -296
  324. package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.dbg.json +0 -4
  325. package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.json +0 -10
  326. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensation.dbg.json +0 -4
  327. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensation.json +0 -10
  328. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensationModule.dbg.json +0 -4
  329. package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensationModule.json +0 -10
  330. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.dbg.json +0 -4
  331. package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.json +0 -188
  332. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.dbg.json +0 -4
  333. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.json +0 -10
  334. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.dbg.json +0 -4
  335. package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.json +0 -188
  336. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicy.dbg.json +0 -4
  337. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.dbg.json +0 -4
  338. package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.json +0 -261
  339. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.dbg.json +0 -4
  340. package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.json +0 -261
  341. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPool.dbg.json +0 -4
  342. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPool.json +0 -10
  343. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.dbg.json +0 -4
  344. package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.json +0 -149
  345. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.dbg.json +0 -4
  346. package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.json +0 -149
  347. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRisk.dbg.json +0 -4
  348. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.dbg.json +0 -4
  349. package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.json +0 -10
  350. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.dbg.json +0 -4
  351. package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.json +0 -10
  352. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasury.dbg.json +0 -4
  353. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.dbg.json +0 -4
  354. package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.json +0 -533
  355. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.dbg.json +0 -4
  356. package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.json +0 -76
  357. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.dbg.json +0 -4
  358. package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.json +0 -533
  359. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.dbg.json +0 -4
  360. package/artifacts/contracts/registry/IChainNft.sol/IChainNft.json +0 -452
  361. package/artifacts/contracts/registry/IRegistryLinked.sol/IRegistryLinked.dbg.json +0 -4
  362. package/artifacts/contracts/registry/IRegistryLinked.sol/IRegistryLinked.json +0 -24
  363. package/artifacts/contracts/shared/IOwnable.sol/IOwnable.dbg.json +0 -4
  364. package/artifacts/contracts/shared/IOwnable.sol/IOwnable.json +0 -24
  365. package/artifacts/contracts/test/TestPool.sol/TestPool.dbg.json +0 -4
  366. package/artifacts/contracts/test/TestPool.sol/TestPool.json +0 -387
  367. package/artifacts/contracts/test/TestProduct.sol/TestProduct.dbg.json +0 -4
  368. package/artifacts/contracts/test/TestProduct.sol/TestProduct.json +0 -393
  369. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.dbg.json +0 -4
  370. package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.json +0 -479
  371. package/contracts/experiment/statemachine/README.md +0 -112
  372. package/contracts/instance/IInstanceLinked.sol +0 -8
  373. package/contracts/instance/base/InstanceBase.sol +0 -80
  374. package/contracts/instance/base/ModuleBase.sol +0 -52
  375. package/contracts/instance/base/ServiceBase.sol +0 -37
  376. package/contracts/instance/module/access/Access.sol +0 -149
  377. package/contracts/instance/module/access/IAccess.sol +0 -53
  378. package/contracts/instance/module/bundle/BundleModule.sol +0 -136
  379. package/contracts/instance/module/bundle/IBundle.sol +0 -58
  380. package/contracts/instance/module/compensation/CompensationModule.sol +0 -8
  381. package/contracts/instance/module/compensation/ICompensation.sol +0 -10
  382. package/contracts/instance/module/component/ComponentModule.sol +0 -95
  383. package/contracts/instance/module/component/IComponent.sol +0 -53
  384. package/contracts/instance/module/policy/IPolicy.sol +0 -60
  385. package/contracts/instance/module/policy/PolicyModule.sol +0 -76
  386. package/contracts/instance/module/pool/IPoolModule.sol +0 -41
  387. package/contracts/instance/module/pool/PoolModule.sol +0 -87
  388. package/contracts/instance/module/risk/IRisk.sol +0 -10
  389. package/contracts/instance/module/risk/RiskModule.sol +0 -8
  390. package/contracts/instance/module/treasury/ITreasury.sol +0 -103
  391. package/contracts/instance/module/treasury/TokenHandler.sol +0 -48
  392. package/contracts/instance/module/treasury/TreasuryModule.sol +0 -152
  393. package/contracts/registry/IChainNft.sol +0 -21
  394. package/contracts/registry/IRegistryLinked.sol +0 -8
  395. package/contracts/shared/IOwnable.sol +0 -6
  396. package/contracts/test/TestPool.sol +0 -22
  397. package/contracts/test/TestProduct.sol +0 -44
@@ -1,42 +1,167 @@
1
1
  // SPDX-License-Identifier: Apache-2.0
2
2
  pragma solidity ^0.8.19;
3
3
 
4
+ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
5
+
6
+ import {IRisk} from "../instance/module/IRisk.sol";
7
+ import {ITreasury} from "../instance/module/ITreasury.sol";
4
8
  import {IProductService} from "../instance/service/IProductService.sol";
5
9
  import {IProductComponent} from "./IProductComponent.sol";
6
- import {NftId} from "../types/NftId.sol";
10
+ import {NftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
7
11
  import {ObjectType, PRODUCT} from "../types/ObjectType.sol";
12
+ import {ReferralId} from "../types/Referral.sol";
13
+ import {RiskId, RiskIdLib} from "../types/RiskId.sol";
14
+ import {StateId} from "../types/StateId.sol";
8
15
  import {Timestamp} from "../types/Timestamp.sol";
9
- import {Fee} from "../types/Fee.sol";
16
+ import {Fee, FeeLib} from "../types/Fee.sol";
10
17
  import {BaseComponent} from "./BaseComponent.sol";
11
18
 
19
+ import {IRegistry} from "../registry/IRegistry.sol";
20
+ import {IRegisterable} from "../shared/IRegisterable.sol";
21
+ import {Registerable} from "../shared/Registerable.sol";
22
+ import {TokenHandler} from "../shared/TokenHandler.sol";
23
+
24
+ import {InstanceReader} from "../instance/InstanceReader.sol";
25
+ import {ISetup} from "../instance/module/ISetup.sol";
26
+ import {Pool} from "../components/Pool.sol";
27
+ import {Distribution} from "../components/Distribution.sol";
28
+
29
+ import {zeroNftId} from "../types/NftId.sol";
30
+
12
31
  contract Product is BaseComponent, IProductComponent {
13
- IProductService private _productService;
14
- address private _pool;
32
+ using NftIdLib for NftId;
33
+
34
+ IProductService internal _productService;
35
+ Pool internal _pool;
36
+ Distribution internal _distribution;
37
+ Fee internal _initialProductFee;
38
+ Fee internal _initialProcessingFee;
39
+ TokenHandler internal _tokenHandler;
40
+
41
+ NftId internal _poolNftId;
42
+ NftId internal _distributionNftId;
15
43
 
16
44
  constructor(
17
45
  address registry,
18
46
  NftId instanceNftid,
19
47
  address token,
20
- address pool
21
- ) BaseComponent(registry, instanceNftid, token) {
48
+ bool isInterceptor,
49
+ address pool,
50
+ address distribution,
51
+ Fee memory productFee,
52
+ Fee memory processingFee,
53
+ address initialOwner
54
+ ) BaseComponent(registry, instanceNftid, token, PRODUCT(), isInterceptor, initialOwner) {
22
55
  // TODO add validation
23
56
  _productService = _instance.getProductService();
24
- _pool = pool;
57
+ _pool = Pool(pool);
58
+ _distribution = Distribution(distribution);
59
+ _initialProductFee = productFee;
60
+ _initialProcessingFee = processingFee;
61
+
62
+ _tokenHandler = new TokenHandler(token);
63
+
64
+ _poolNftId = getRegistry().getNftId(address(_pool));
65
+ _distributionNftId = getRegistry().getNftId(address(_distribution));
66
+
67
+ _registerInterface(type(IProductComponent).interfaceId);
68
+ }
69
+
70
+
71
+ function calculatePremium(
72
+ uint256 sumInsuredAmount,
73
+ RiskId riskId,
74
+ uint256 lifetime,
75
+ bytes memory applicationData,
76
+ ReferralId referralId,
77
+ NftId bundleNftId
78
+ )
79
+ external
80
+ view
81
+ override
82
+ returns (uint256 premiumAmount)
83
+ {
84
+ (premiumAmount,,,,) = _productService.calculatePremium(
85
+ riskId,
86
+ sumInsuredAmount,
87
+ lifetime,
88
+ applicationData,
89
+ bundleNftId,
90
+ referralId
91
+ );
92
+ }
93
+
94
+
95
+ function calculateNetPremium(
96
+ uint256 sumInsuredAmount,
97
+ RiskId riskId,
98
+ uint256 lifetime,
99
+ bytes memory applicationData
100
+ )
101
+ external
102
+ view
103
+ virtual override
104
+ returns (uint256 netPremiumAmount)
105
+ {
106
+ // default 10% of sum insured
107
+ return sumInsuredAmount / 10;
108
+ }
109
+
110
+ function _toRiskId(string memory riskName) internal pure returns (RiskId riskId) {
111
+ return RiskIdLib.toRiskId(riskName);
112
+ }
113
+
114
+ function _createRisk(
115
+ RiskId id,
116
+ bytes memory data
117
+ ) internal {
118
+ _productService.createRisk(
119
+ id,
120
+ data
121
+ );
122
+ }
123
+
124
+ function _updateRisk(
125
+ RiskId id,
126
+ bytes memory data
127
+ ) internal {
128
+ _productService.updateRisk(
129
+ id,
130
+ data
131
+ );
132
+ }
133
+
134
+ function _updateRiskState(
135
+ RiskId id,
136
+ StateId state
137
+ ) internal {
138
+ _productService.updateRiskState(
139
+ id,
140
+ state
141
+ );
142
+ }
143
+
144
+ function _getRiskInfo(RiskId id) internal view returns (IRisk.RiskInfo memory info) {
145
+ return _instance.getInstanceReader().getRiskInfo(id);
25
146
  }
26
147
 
27
148
  function _createApplication(
28
149
  address applicationOwner,
150
+ RiskId riskId,
29
151
  uint256 sumInsuredAmount,
30
- uint256 premiumAmount,
31
152
  uint256 lifetime,
32
- NftId bundleNftId
153
+ bytes memory applicationData,
154
+ NftId bundleNftId,
155
+ ReferralId referralId
33
156
  ) internal returns (NftId nftId) {
34
157
  nftId = _productService.createApplication(
35
158
  applicationOwner,
159
+ riskId,
36
160
  sumInsuredAmount,
37
- premiumAmount,
38
161
  lifetime,
39
- bundleNftId
162
+ applicationData,
163
+ bundleNftId,
164
+ referralId
40
165
  );
41
166
  }
42
167
 
@@ -76,42 +201,89 @@ contract Product is BaseComponent, IProductComponent {
76
201
  }
77
202
 
78
203
  function getPoolNftId() external view override returns (NftId poolNftId) {
79
- return _registry.getNftId(_pool);
204
+ return getRegistry().getNftId(address(_pool));
205
+ }
206
+
207
+ function getDistributionNftId() external view override returns (NftId distributionNftId) {
208
+ return getRegistry().getNftId(address(_distribution));
80
209
  }
81
210
 
82
211
  // from product component
83
212
  function setFees(
84
- Fee memory policyFee,
213
+ Fee memory productFee,
85
214
  Fee memory processingFee
86
215
  )
87
216
  external
88
217
  onlyOwner
89
218
  override
90
219
  {
91
- _productService.setFees(policyFee, processingFee);
220
+ _productService.setFees(productFee, processingFee);
92
221
  }
93
222
 
94
-
95
- function getPolicyFee()
96
- external
97
- view
98
- override
99
- returns (Fee memory policyFee)
100
- {
101
- return _instance.getProductSetup(getNftId()).policyFee;
223
+ function getSetupInfo() public view returns (ISetup.ProductSetupInfo memory setupInfo) {
224
+ InstanceReader reader = _instance.getInstanceReader();
225
+ return reader.getProductSetupInfo(getNftId());
102
226
  }
103
227
 
104
- function getProcessingFee()
105
- external
106
- view
107
- override
108
- returns (Fee memory processingFee)
228
+ // from IRegisterable
229
+
230
+ function getInitialInfo()
231
+ public
232
+ view
233
+ override (IRegisterable, Registerable)
234
+ returns (IRegistry.ObjectInfo memory, bytes memory)
109
235
  {
110
- return _instance.getProductSetup(getNftId()).processingFee;
111
- }
236
+ // from Registerable
237
+ (
238
+ IRegistry.ObjectInfo memory productInfo,
239
+ bytes memory data
240
+ ) = super.getInitialInfo();
241
+
242
+ // TODO read pool & distribution fees
243
+ // 1) from pool -> the only option -> pool must be registered first?
244
+ // 2) from instance -> all fees are set into instance at product registration which is ongoing here
245
+ // checks are done in registryProduct() where THIS function is called
246
+ //require(getRegistry().getObjectInfo(_poolNftId).objectType == POOL(), "POOL_NOT_REGISTERED");
247
+ //require(getRegistry().getObjectInfo(_distributionNftId).objectType == DISTRIBUTION(), "DISTRIBUTION_NOT_REGISTERED");
248
+
249
+ // from PoolComponent
250
+ (
251
+ ,
252
+ bytes memory poolData
253
+ ) = _pool.getInitialInfo();
254
+
255
+ (
256
+ ISetup.PoolSetupInfo memory poolSetupInfo
257
+ ) = abi.decode(poolData, (ISetup.PoolSetupInfo));
112
258
 
113
- // from registerable
114
- function getType() public pure override returns (ObjectType) {
115
- return PRODUCT();
259
+ // from DistributionComponent
260
+ (
261
+ ,
262
+ bytes memory distributionData
263
+ ) = _distribution.getInitialInfo();
264
+
265
+ (
266
+ ISetup.DistributionSetupInfo memory distributionSetupInfo
267
+ ) = abi.decode(distributionData, (ISetup.DistributionSetupInfo));
268
+
269
+ return (
270
+ productInfo,
271
+ abi.encode(
272
+ ISetup.ProductSetupInfo(
273
+ _token,
274
+ _tokenHandler,
275
+ _distributionNftId,
276
+ _poolNftId,
277
+ distributionSetupInfo.distributionFee,
278
+ _initialProductFee,
279
+ _initialProcessingFee,
280
+ poolSetupInfo.poolFee,
281
+ poolSetupInfo.stakingFee,
282
+ poolSetupInfo.performanceFee,
283
+ false,
284
+ _wallet
285
+ )
286
+ )
287
+ );
116
288
  }
117
289
  }
@@ -0,0 +1,47 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ pragma solidity ^0.8.20;
3
+
4
+ import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
5
+
6
+
7
+ contract Cloner {
8
+
9
+ Mock1 public mock1;
10
+ Mock2 public mock2;
11
+
12
+ constructor() {
13
+ mock1 = new Mock1();
14
+ mock2 = new Mock2();
15
+ }
16
+
17
+ function createClone(address master)
18
+ external
19
+ returns (address cloned)
20
+ {
21
+ cloned = Clones.clone(master);
22
+ }
23
+ }
24
+
25
+
26
+ contract Mock1 {
27
+ function getValue() external virtual view returns (uint256) {
28
+ return 42;
29
+ }
30
+ }
31
+
32
+ contract Mock2 is Mock1 {
33
+ uint256 internal _value;
34
+
35
+ constructor() {
36
+ _value = 42;
37
+ }
38
+
39
+ function setValue(uint256 value) external virtual {
40
+ _value = value;
41
+ }
42
+
43
+ function getValue() external virtual override view returns (uint256) {
44
+ return _value;
45
+ }
46
+ }
47
+
@@ -0,0 +1,115 @@
1
+ // SPDX-License-Identifier: MIT
2
+ // OpenZeppelin Contracts (last updated v5.0.0) (access/manager/AccessManaged.sol)
3
+
4
+ pragma solidity ^0.8.20;
5
+
6
+ import {AuthorityUtils} from "@openzeppelin/contracts/access/manager/AuthorityUtils.sol";
7
+ import {Context} from "@openzeppelin/contracts/utils/Context.sol";
8
+ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
9
+ import {IAuthority} from "@openzeppelin/contracts/access/manager/IAuthority.sol";
10
+
11
+ import {IAccessManagerSimple} from "./IAccessManagerSimple.sol";
12
+
13
+ /**
14
+ * @dev This contract module makes available a {restricted} modifier. Functions decorated with this modifier will be
15
+ * permissioned according to an "authority": a contract like {AccessManager} that follows the {IAuthority} interface,
16
+ * implementing a policy that allows certain callers to access certain functions.
17
+ *
18
+ * IMPORTANT: The `restricted` modifier should never be used on `internal` functions, judiciously used in `public`
19
+ * functions, and ideally only used in `external` functions. See {restricted}.
20
+ */
21
+ abstract contract AccessManagedSimple is Context, IAccessManaged {
22
+ bool private _initialized;
23
+ address private _authority;
24
+
25
+ bool private _consumingSchedule;
26
+
27
+ function initializeAccessManagedSimple(address initialAuthority) internal {
28
+ require(!_initialized, "AccessManaged: already initialized");
29
+ _setAuthority(initialAuthority);
30
+ _initialized = true;
31
+ }
32
+
33
+
34
+ /**
35
+ * @dev Restricts access to a function as defined by the connected Authority for this contract and the
36
+ * caller and selector of the function that entered the contract.
37
+ *
38
+ * [IMPORTANT]
39
+ * ====
40
+ * In general, this modifier should only be used on `external` functions. It is okay to use it on `public`
41
+ * functions that are used as external entry points and are not called internally. Unless you know what you're
42
+ * doing, it should never be used on `internal` functions. Failure to follow these rules can have critical security
43
+ * implications! This is because the permissions are determined by the function that entered the contract, i.e. the
44
+ * function at the bottom of the call stack, and not the function where the modifier is visible in the source code.
45
+ * ====
46
+ *
47
+ * [WARNING]
48
+ * ====
49
+ * Avoid adding this modifier to the https://docs.soliditylang.org/en/v0.8.20/contracts.html#receive-ether-function[`receive()`]
50
+ * function or the https://docs.soliditylang.org/en/v0.8.20/contracts.html#fallback-function[`fallback()`]. These
51
+ * functions are the only execution paths where a function selector cannot be unambiguosly determined from the calldata
52
+ * since the selector defaults to `0x00000000` in the `receive()` function and similarly in the `fallback()` function
53
+ * if no calldata is provided. (See {_checkCanCall}).
54
+ *
55
+ * The `receive()` function will always panic whereas the `fallback()` may panic depending on the calldata length.
56
+ * ====
57
+ */
58
+ modifier restricted() {
59
+ _checkCanCall(_msgSender(), _msgData());
60
+ _;
61
+ }
62
+
63
+ /// @inheritdoc IAccessManaged
64
+ function authority() public view virtual returns (address) {
65
+ return _authority;
66
+ }
67
+
68
+ /// @inheritdoc IAccessManaged
69
+ function setAuthority(address newAuthority) public virtual {
70
+ address caller = _msgSender();
71
+ if (caller != authority()) {
72
+ revert AccessManagedUnauthorized(caller);
73
+ }
74
+ if (newAuthority.code.length == 0) {
75
+ revert AccessManagedInvalidAuthority(newAuthority);
76
+ }
77
+ _setAuthority(newAuthority);
78
+ }
79
+
80
+ /// @inheritdoc IAccessManaged
81
+ function isConsumingScheduledOp() public view returns (bytes4) {
82
+ return _consumingSchedule ? this.isConsumingScheduledOp.selector : bytes4(0);
83
+ }
84
+
85
+ /**
86
+ * @dev Transfers control to a new authority. Internal function with no access restriction. Allows bypassing the
87
+ * permissions set by the current authority.
88
+ */
89
+ function _setAuthority(address newAuthority) internal virtual {
90
+ _authority = newAuthority;
91
+ emit AuthorityUpdated(newAuthority);
92
+ }
93
+
94
+ /**
95
+ * @dev Reverts if the caller is not allowed to call the function identified by a selector. Panics if the calldata
96
+ * is less than 4 bytes long.
97
+ */
98
+ function _checkCanCall(address caller, bytes calldata data) internal virtual {
99
+ (bool immediate, uint32 delay) = AuthorityUtils.canCallWithDelay(
100
+ authority(),
101
+ caller,
102
+ address(this),
103
+ bytes4(data[0:4])
104
+ );
105
+ if (!immediate) {
106
+ if (delay > 0) {
107
+ _consumingSchedule = true;
108
+ IAccessManagerSimple(authority()).consumeScheduledOp(caller, data);
109
+ _consumingSchedule = false;
110
+ } else {
111
+ revert AccessManagedUnauthorized(caller);
112
+ }
113
+ }
114
+ }
115
+ }