@etherisc/gif-next 0.0.2-efdb520-159 → 0.0.2-efef0ea-320
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +58 -11
- package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.dbg.json +1 -1
- package/artifacts/contracts/components/Distribution.sol/Distribution.dbg.json +4 -0
- package/artifacts/contracts/components/Distribution.sol/Distribution.json +405 -0
- package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json +1 -1
- package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.dbg.json +4 -0
- package/artifacts/contracts/components/IDistributionComponent.sol/IDistributionComponent.json +340 -0
- package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.dbg.json +1 -1
- package/artifacts/contracts/components/IPoolComponent.sol/IPoolComponent.json +131 -0
- package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.dbg.json +1 -1
- package/artifacts/contracts/components/IProductComponent.sol/IProductComponent.json +109 -18
- package/artifacts/contracts/components/Pool.sol/Pool.dbg.json +1 -1
- package/artifacts/contracts/components/Pool.sol/Pool.json +194 -3
- package/artifacts/contracts/components/Product.sol/Product.dbg.json +1 -1
- package/artifacts/contracts/components/Product.sol/Product.json +160 -21
- package/artifacts/contracts/experiment/errors/Require.sol/Require.dbg.json +1 -1
- package/artifacts/contracts/experiment/errors/Revert.sol/Revert.dbg.json +1 -1
- package/artifacts/contracts/experiment/inheritance/A.sol/A.dbg.json +1 -1
- package/artifacts/contracts/experiment/inheritance/A.sol/AShared.dbg.json +1 -1
- package/artifacts/contracts/experiment/inheritance/B.sol/B.dbg.json +1 -1
- package/artifacts/contracts/experiment/inheritance/C.sol/C.dbg.json +1 -1
- package/artifacts/contracts/experiment/inheritance/IA.sol/IA.dbg.json +1 -1
- package/artifacts/contracts/experiment/inheritance/IA.sol/ISharedA.dbg.json +1 -1
- package/artifacts/contracts/experiment/inheritance/IB.sol/IB.dbg.json +1 -1
- package/artifacts/contracts/experiment/inheritance/IC.sol/IC.dbg.json +1 -1
- package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.dbg.json +1 -1
- package/artifacts/contracts/experiment/statemachine/Dummy.sol/LifeCycleModule.json +2 -2
- package/artifacts/contracts/experiment/statemachine/ISM.sol/ISM.dbg.json +1 -1
- package/artifacts/contracts/experiment/statemachine/ISM.sol/ISMEE.dbg.json +1 -1
- package/artifacts/contracts/experiment/statemachine/SM.sol/SM.dbg.json +1 -1
- package/artifacts/contracts/experiment/statemachine/SM.sol/SM.json +2 -2
- package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.dbg.json +1 -1
- package/artifacts/contracts/experiment/statemachine/SimpleStateMachine.sol/SimpleStateMachine.json +2 -2
- package/artifacts/contracts/experiment/types/TypeA.sol/TypeALib.dbg.json +1 -1
- package/artifacts/contracts/experiment/types/TypeB.sol/TypeBLib.dbg.json +1 -1
- package/artifacts/contracts/instance/IInstance.sol/IInstance.dbg.json +1 -1
- package/artifacts/contracts/instance/IInstance.sol/IInstance.json +697 -671
- package/artifacts/contracts/instance/IInstanceLinked.sol/IInstanceLinked.dbg.json +1 -1
- package/artifacts/contracts/instance/Instance.sol/Instance.dbg.json +1 -1
- package/artifacts/contracts/instance/Instance.sol/Instance.json +928 -744
- package/artifacts/contracts/instance/base/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +4 -0
- package/artifacts/contracts/instance/{InstanceBase.sol/InstanceBase.json → base/ComponentServiceBase.sol/ComponentServiceBase.json} +107 -33
- package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.dbg.json +4 -0
- package/artifacts/contracts/instance/base/IInstanceBase.sol/IInstanceBase.json +113 -0
- package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.dbg.json +4 -0
- package/artifacts/contracts/instance/base/IKeyValueStore.sol/IKeyValueStore.json +560 -0
- package/artifacts/contracts/instance/base/ILifecycle.sol/ILifecycle.dbg.json +4 -0
- package/artifacts/contracts/instance/{module/lifecycle/ILifecycle.sol/ILifecycleModule.json → base/ILifecycle.sol/ILifecycle.json} +10 -77
- package/artifacts/contracts/instance/base/IService.sol/IService.dbg.json +4 -0
- package/artifacts/contracts/instance/{service → base}/IService.sol/IService.json +63 -22
- package/artifacts/contracts/instance/base/InstanceBase.sol/InstanceBase.dbg.json +4 -0
- package/artifacts/contracts/instance/base/InstanceBase.sol/InstanceBase.json +463 -0
- package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.dbg.json +4 -0
- package/artifacts/contracts/instance/base/KeyValueStore.sol/KeyValueStore.json +710 -0
- package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.dbg.json +4 -0
- package/artifacts/contracts/instance/base/Lifecycle.sol/Lifecycle.json +169 -0
- package/artifacts/contracts/instance/base/ModuleBase.sol/ModuleBase.dbg.json +4 -0
- package/artifacts/contracts/instance/{module/product/ProductModule.sol/ProductModule.json → base/ModuleBase.sol/ModuleBase.json} +2 -2
- package/artifacts/contracts/instance/base/ServiceBase.sol/ServiceBase.dbg.json +4 -0
- package/artifacts/contracts/instance/{service → base}/ServiceBase.sol/ServiceBase.json +93 -6
- package/artifacts/contracts/instance/module/access/Access.sol/AccessModule.dbg.json +1 -1
- package/artifacts/contracts/instance/module/access/IAccess.sol/IAccess.dbg.json +1 -1
- package/artifacts/contracts/instance/module/access/IAccess.sol/IAccessModule.dbg.json +1 -1
- package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.dbg.json +1 -1
- package/artifacts/contracts/instance/module/bundle/BundleModule.sol/BundleModule.json +71 -50
- package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundle.dbg.json +1 -1
- package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.dbg.json +1 -1
- package/artifacts/contracts/instance/module/bundle/IBundle.sol/IBundleModule.json +71 -50
- package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.dbg.json +1 -1
- package/artifacts/contracts/instance/module/component/ComponentModule.sol/ComponentModule.json +22 -93
- package/artifacts/contracts/instance/module/component/IComponent.sol/IComponent.dbg.json +1 -1
- package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.dbg.json +1 -1
- package/artifacts/contracts/instance/module/component/IComponent.sol/IComponentModule.json +22 -93
- package/artifacts/contracts/instance/module/distribution/DistributionModule.sol/DistributionModule.dbg.json +4 -0
- package/artifacts/contracts/instance/module/distribution/DistributionModule.sol/DistributionModule.json +10 -0
- package/artifacts/contracts/instance/module/distribution/IDistribution.sol/IDistribution.dbg.json +4 -0
- package/artifacts/contracts/instance/module/distribution/IDistribution.sol/IDistribution.json +10 -0
- package/artifacts/contracts/instance/module/distribution/IDistribution.sol/IDistributionModule.dbg.json +4 -0
- package/artifacts/contracts/instance/module/distribution/IDistribution.sol/IDistributionModule.json +10 -0
- package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicy.dbg.json +1 -1
- package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.dbg.json +1 -1
- package/artifacts/contracts/instance/module/policy/IPolicy.sol/IPolicyModule.json +61 -38
- package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.dbg.json +1 -1
- package/artifacts/contracts/instance/module/policy/PolicyModule.sol/PolicyModule.json +61 -38
- package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPool.dbg.json +1 -1
- package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.dbg.json +1 -1
- package/artifacts/contracts/instance/module/pool/IPoolModule.sol/IPoolModule.json +0 -5
- package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.dbg.json +1 -1
- package/artifacts/contracts/instance/module/pool/PoolModule.sol/PoolModule.json +0 -5
- package/artifacts/contracts/instance/module/risk/IRisk.sol/IRisk.dbg.json +4 -0
- package/artifacts/contracts/instance/module/{product/IProductModule.sol/IProductModule.json → risk/IRisk.sol/IRisk.json} +2 -2
- package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.dbg.json +4 -0
- package/artifacts/contracts/instance/module/risk/IRisk.sol/IRiskModule.json +113 -0
- package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.dbg.json +4 -0
- package/artifacts/contracts/instance/module/risk/RiskModule.sol/RiskModule.json +131 -0
- package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasury.dbg.json +1 -1
- package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.dbg.json +1 -1
- package/artifacts/contracts/instance/module/treasury/ITreasury.sol/ITreasuryModule.json +209 -236
- package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.dbg.json +1 -1
- package/artifacts/contracts/instance/module/treasury/TokenHandler.sol/TokenHandler.json +2 -2
- package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.dbg.json +1 -1
- package/artifacts/contracts/instance/module/treasury/TreasuryModule.sol/TreasuryModule.json +209 -236
- package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.dbg.json +1 -1
- package/artifacts/contracts/instance/service/ComponentOwnerService.sol/ComponentOwnerService.json +141 -42
- package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.dbg.json +4 -0
- package/artifacts/contracts/instance/service/DistributionService.sol/DistributionService.json +507 -0
- package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.dbg.json +1 -1
- package/artifacts/contracts/instance/service/IComponentOwnerService.sol/IComponentOwnerService.json +62 -21
- package/artifacts/contracts/instance/service/IDistributionService.sol/IDistributionService.dbg.json +4 -0
- package/artifacts/contracts/instance/service/{ComponentServiceBase.sol/ComponentServiceBase.json → IDistributionService.sol/IDistributionService.json} +96 -30
- package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.dbg.json +1 -1
- package/artifacts/contracts/instance/service/IPoolService.sol/IPoolService.json +127 -22
- package/artifacts/contracts/instance/service/IProductService.sol/IProductService.dbg.json +1 -1
- package/artifacts/contracts/instance/service/IProductService.sol/IProductService.json +215 -21
- package/artifacts/contracts/instance/service/PoolService.sol/PoolService.dbg.json +1 -1
- package/artifacts/contracts/instance/service/PoolService.sol/PoolService.json +177 -46
- package/artifacts/contracts/instance/service/ProductService.sol/ProductService.dbg.json +1 -1
- package/artifacts/contracts/instance/service/ProductService.sol/ProductService.json +322 -62
- package/artifacts/contracts/registry/ChainNft.sol/ChainNft.dbg.json +1 -1
- package/artifacts/contracts/registry/IChainNft.sol/IChainNft.dbg.json +1 -1
- package/artifacts/contracts/registry/IRegistry.sol/IRegistry.dbg.json +1 -1
- package/artifacts/contracts/registry/IRegistryLinked.sol/IRegistryLinked.dbg.json +1 -1
- package/artifacts/contracts/registry/Registry.sol/Registry.dbg.json +1 -1
- package/artifacts/contracts/registry/Registry.sol/Registry.json +2 -2
- package/artifacts/contracts/registry/RegistryUpgradeable.sol/RegistryUpgradeable.dbg.json +4 -0
- package/artifacts/contracts/registry/RegistryUpgradeable.sol/RegistryUpgradeable.json +724 -0
- package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json +1 -1
- package/artifacts/contracts/shared/IOwnable.sol/IOwnable.dbg.json +1 -1
- package/artifacts/contracts/shared/IRegisterable.sol/IRegisterable.dbg.json +1 -1
- package/artifacts/contracts/shared/IVersionable.sol/IVersionable.dbg.json +1 -1
- package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json +58 -17
- package/artifacts/contracts/shared/Proxy.sol/ProxyDeployer.dbg.json +4 -0
- package/artifacts/contracts/shared/Proxy.sol/ProxyDeployer.json +248 -0
- package/artifacts/contracts/shared/Proxy.sol/ProxyWithProxyAdminGetter.dbg.json +4 -0
- package/artifacts/contracts/shared/Proxy.sol/ProxyWithProxyAdminGetter.json +129 -0
- package/artifacts/contracts/shared/Registerable.sol/Registerable.dbg.json +1 -1
- package/artifacts/contracts/shared/Versionable.sol/Versionable.dbg.json +1 -1
- package/artifacts/contracts/shared/Versionable.sol/Versionable.json +92 -5
- package/artifacts/contracts/shared/VersionableUpgradeable.sol/VersionableUpgradeable.dbg.json +4 -0
- package/artifacts/contracts/shared/VersionableUpgradeable.sol/VersionableUpgradeable.json +228 -0
- package/artifacts/contracts/test/TestDistribution.sol/TestDistribution.dbg.json +4 -0
- package/artifacts/contracts/test/TestDistribution.sol/TestDistribution.json +405 -0
- package/artifacts/contracts/test/TestFee.sol/TestFee.dbg.json +1 -1
- package/artifacts/contracts/test/TestFee.sol/TestFee.json +28 -4
- package/artifacts/contracts/test/TestPool.sol/TestPool.dbg.json +1 -1
- package/artifacts/contracts/test/TestPool.sol/TestPool.json +194 -3
- package/artifacts/contracts/test/TestProduct.sol/TestProduct.dbg.json +1 -1
- package/artifacts/contracts/test/TestProduct.sol/TestProduct.json +209 -27
- package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.dbg.json +1 -1
- package/artifacts/contracts/test/TestRegisterable.sol/TestRegisterable.json +2 -2
- package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.dbg.json +1 -1
- package/artifacts/contracts/test/TestRoleId.sol/TestRoleId.json +38 -4
- package/artifacts/contracts/test/TestService.sol/TestService.dbg.json +1 -1
- package/artifacts/contracts/test/TestService.sol/TestService.json +102 -43
- package/artifacts/contracts/test/TestToken.sol/TestUsdc.dbg.json +1 -1
- package/artifacts/contracts/test/TestVersion.sol/TestVersion.dbg.json +1 -1
- package/artifacts/contracts/test/TestVersion.sol/TestVersion.json +14 -18
- package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.dbg.json +1 -1
- package/artifacts/contracts/test/TestVersionable.sol/TestVersionable.json +102 -39
- package/artifacts/contracts/test/Usdc.sol/USDC.dbg.json +4 -0
- package/artifacts/contracts/test/Usdc.sol/USDC.json +338 -0
- package/artifacts/contracts/types/AddressSet.sol/LibAddressSet.dbg.json +1 -1
- package/artifacts/contracts/types/Blocknumber.sol/BlocknumberLib.dbg.json +1 -1
- package/artifacts/contracts/types/ChainId.sol/ChainIdLib.dbg.json +1 -1
- package/artifacts/contracts/types/Fee.sol/FeeLib.dbg.json +4 -0
- package/artifacts/contracts/types/Fee.sol/FeeLib.json +257 -0
- package/artifacts/contracts/types/Key32.sol/Key32Lib.dbg.json +4 -0
- package/artifacts/contracts/types/Key32.sol/Key32Lib.json +111 -0
- package/artifacts/contracts/types/NftId.sol/NftIdLib.dbg.json +1 -1
- package/artifacts/contracts/types/NftId.sol/NftIdLib.json +65 -4
- package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.dbg.json +1 -1
- package/artifacts/contracts/types/NftIdSet.sol/LibNftIdSet.json +2 -2
- package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.dbg.json +1 -1
- package/artifacts/contracts/types/ObjectType.sol/ObjectTypeLib.json +2 -2
- package/artifacts/contracts/types/ReferralId.sol/ReferralIdLib.dbg.json +4 -0
- package/artifacts/contracts/types/ReferralId.sol/ReferralIdLib.json +99 -0
- package/artifacts/contracts/types/RiskId.sol/RiskIdLib.dbg.json +4 -0
- package/artifacts/contracts/types/RiskId.sol/RiskIdLib.json +86 -0
- package/artifacts/contracts/types/RoleId.sol/RoleIdLib.dbg.json +4 -0
- package/artifacts/contracts/types/RoleId.sol/RoleIdLib.json +30 -0
- package/artifacts/contracts/types/StateId.sol/StateIdLib.dbg.json +1 -1
- package/artifacts/contracts/types/StateId.sol/StateIdLib.json +2 -2
- package/artifacts/contracts/types/Timestamp.sol/TimestampLib.dbg.json +1 -1
- package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.dbg.json +1 -1
- package/artifacts/contracts/types/UFixed.sol/UFixedMathLib.json +34 -8
- package/artifacts/contracts/types/Version.sol/VersionLib.dbg.json +1 -1
- package/artifacts/contracts/types/Version.sol/VersionLib.json +101 -2
- package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json +1 -1
- package/artifacts/contracts/types/Version.sol/VersionPartLib.json +2 -2
- package/contracts/components/BaseComponent.sol +7 -2
- package/contracts/components/Distribution.sol +132 -0
- package/contracts/components/IDistributionComponent.sol +47 -0
- package/contracts/components/IPoolComponent.sol +14 -0
- package/contracts/components/IProductComponent.sol +24 -5
- package/contracts/components/Pool.sol +64 -3
- package/contracts/components/Product.sol +123 -13
- package/contracts/instance/IInstance.sol +16 -13
- package/contracts/instance/Instance.sol +22 -10
- package/contracts/instance/{service → base}/ComponentServiceBase.sol +1 -0
- package/contracts/instance/base/IInstanceBase.sol +22 -0
- package/contracts/instance/base/IKeyValueStore.sol +50 -0
- package/contracts/instance/base/ILifecycle.sol +30 -0
- package/contracts/instance/{InstanceBase.sol → base/InstanceBase.sol} +34 -17
- package/contracts/instance/base/KeyValueStore.sol +161 -0
- package/contracts/instance/{module/lifecycle/LifecycleModule.sol → base/Lifecycle.sol} +50 -39
- package/contracts/instance/base/ModuleBase.sol +57 -0
- package/contracts/instance/{service → base}/ServiceBase.sol +1 -3
- package/contracts/instance/module/access/Access.sol +6 -6
- package/contracts/instance/module/bundle/BundleModule.sol +24 -118
- package/contracts/instance/module/bundle/IBundle.sol +9 -9
- package/contracts/instance/module/component/ComponentModule.sol +27 -61
- package/contracts/instance/module/component/IComponent.sol +5 -30
- package/contracts/instance/module/distribution/DistributionModule.sol +17 -0
- package/contracts/instance/module/distribution/IDistribution.sol +10 -0
- package/contracts/instance/module/policy/IPolicy.sol +12 -9
- package/contracts/instance/module/policy/PolicyModule.sol +33 -26
- package/contracts/instance/module/pool/IPoolModule.sol +0 -1
- package/contracts/instance/module/pool/PoolModule.sol +12 -9
- package/contracts/instance/module/risk/IRisk.sol +26 -0
- package/contracts/instance/module/risk/RiskModule.sol +62 -0
- package/contracts/instance/module/treasury/ITreasury.sol +30 -52
- package/contracts/instance/module/treasury/TreasuryModule.sol +74 -84
- package/contracts/instance/service/ComponentOwnerService.sol +33 -50
- package/contracts/instance/service/DistributionService.sol +59 -0
- package/contracts/instance/service/IComponentOwnerService.sol +1 -1
- package/contracts/instance/service/IDistributionService.sol +12 -0
- package/contracts/instance/service/IPoolService.sol +8 -1
- package/contracts/instance/service/IProductService.sol +56 -7
- package/contracts/instance/service/PoolService.sol +64 -13
- package/contracts/instance/service/ProductService.sol +234 -83
- package/contracts/registry/Registry.sol +4 -4
- package/contracts/registry/RegistryUpgradeable.sol +488 -0
- package/contracts/shared/IVersionable.sol +19 -6
- package/contracts/shared/Proxy.sol +94 -0
- package/contracts/shared/Versionable.sol +16 -9
- package/contracts/shared/VersionableUpgradeable.sol +136 -0
- package/contracts/test/TestDistribution.sol +21 -0
- package/contracts/test/TestFee.sol +3 -3
- package/contracts/test/TestPool.sol +6 -3
- package/contracts/test/TestProduct.sol +36 -8
- package/contracts/test/TestRoleId.sol +2 -2
- package/contracts/test/TestService.sol +3 -6
- package/contracts/test/TestVersion.sol +4 -7
- package/contracts/test/TestVersionable.sol +2 -5
- package/contracts/test/Usdc.sol +26 -0
- package/contracts/types/Fee.sol +44 -20
- package/contracts/types/Key32.sol +45 -0
- package/contracts/types/NftId.sol +16 -1
- package/contracts/types/ObjectType.sol +24 -8
- package/contracts/types/ReferralId.sol +48 -0
- package/contracts/types/RiskId.sol +43 -0
- package/contracts/types/RoleId.sol +12 -10
- package/contracts/types/StateId.sol +7 -1
- package/contracts/types/UFixed.sol +19 -16
- package/contracts/types/Version.sol +37 -25
- package/package.json +1 -1
- package/artifacts/contracts/instance/IServiceLinked.sol/IServiceLinked.dbg.json +0 -4
- package/artifacts/contracts/instance/IServiceLinked.sol/IServiceLinked.json +0 -50
- package/artifacts/contracts/instance/InstanceBase.sol/InstanceBase.dbg.json +0 -4
- package/artifacts/contracts/instance/module/lifecycle/ILifecycle.sol/ILifecycle.dbg.json +0 -4
- package/artifacts/contracts/instance/module/lifecycle/ILifecycle.sol/ILifecycle.json +0 -134
- package/artifacts/contracts/instance/module/lifecycle/ILifecycle.sol/ILifecycleModule.dbg.json +0 -4
- package/artifacts/contracts/instance/module/lifecycle/LifecycleModule.sol/LifecycleModule.dbg.json +0 -4
- package/artifacts/contracts/instance/module/lifecycle/LifecycleModule.sol/LifecycleModule.json +0 -221
- package/artifacts/contracts/instance/module/product/IProductModule.sol/IProductModule.dbg.json +0 -4
- package/artifacts/contracts/instance/module/product/ProductModule.sol/ProductModule.dbg.json +0 -4
- package/artifacts/contracts/instance/service/ComponentServiceBase.sol/ComponentServiceBase.dbg.json +0 -4
- package/artifacts/contracts/instance/service/IService.sol/IService.dbg.json +0 -4
- package/artifacts/contracts/instance/service/ServiceBase.sol/ServiceBase.dbg.json +0 -4
- package/contracts/instance/IServiceLinked.sol +0 -12
- package/contracts/instance/module/lifecycle/ILifecycle.sol +0 -47
- package/contracts/instance/module/product/IProductModule.sol +0 -6
- package/contracts/instance/module/product/ProductModule.sol +0 -8
- /package/contracts/instance/{service → base}/IService.sol +0 -0
@@ -0,0 +1,488 @@
|
|
1
|
+
// SPDX-License-Identifier: Apache-2.0
|
2
|
+
pragma solidity ^0.8.20;
|
3
|
+
|
4
|
+
import {Initializable} from "@openzeppelin5/contracts/proxy/utils/Initializable.sol";
|
5
|
+
|
6
|
+
import {IRegisterable} from "../shared/IRegisterable.sol";
|
7
|
+
import {IService} from "../instance/base/IService.sol";
|
8
|
+
|
9
|
+
import {IChainNft} from "./IChainNft.sol";
|
10
|
+
import {ChainNft} from "./ChainNft.sol";
|
11
|
+
import {IRegistry} from "./IRegistry.sol";
|
12
|
+
import {NftId, toNftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
|
13
|
+
import {Version, VersionPart, VersionLib} from "../types/Version.sol";
|
14
|
+
import {ObjectType, PROTOCOL, REGISTRY, TOKEN, SERVICE, INSTANCE, STAKE, PRODUCT, DISTRIBUTION, ORACLE, POOL, POLICY, BUNDLE} from "../types/ObjectType.sol";
|
15
|
+
|
16
|
+
import {VersionableUpgradeable} from "../shared/VersionableUpgradeable.sol";
|
17
|
+
|
18
|
+
|
19
|
+
/// IMPORTANT
|
20
|
+
// Upgradeable contract MUST:
|
21
|
+
// 1) inherit from Versionable
|
22
|
+
// 2) implement version() function
|
23
|
+
// 3) implement initialize() function with initializer modifier
|
24
|
+
// 4) implement upgrade() function with reinitializer(version().toInt()) modifier
|
25
|
+
// 5) have onlyInitialising modifier for each function callable during deployment and/or upgrade
|
26
|
+
// 6) use default empty constructor -> _disableInitializer() called from Versionable contructor
|
27
|
+
// 7) use namespace storage
|
28
|
+
//
|
29
|
+
// IMPORTANT
|
30
|
+
// Each version MUST:
|
31
|
+
// 1) define its own storage struct (MUST NOT use struct type inside)
|
32
|
+
// 2) define private getter for its storage struct (MUST use default implementation, change ONLY return type)
|
33
|
+
// 3) use the same "locationV1" var in each getter
|
34
|
+
// 4) define _initialize()/_upgrade()
|
35
|
+
|
36
|
+
|
37
|
+
contract RegistryUpgradeable is
|
38
|
+
VersionableUpgradeable,
|
39
|
+
IRegisterable,
|
40
|
+
IRegistry
|
41
|
+
{
|
42
|
+
using NftIdLib for NftId;
|
43
|
+
|
44
|
+
string public constant EMPTY_URI = "";
|
45
|
+
|
46
|
+
// @custom:storage-location erc7201:gif-next.contracts.registry.Registry.sol
|
47
|
+
struct StorageV1 {
|
48
|
+
|
49
|
+
mapping(NftId nftId => ObjectInfo info) _info;
|
50
|
+
mapping(address object => NftId nftId) _nftIdByAddress;
|
51
|
+
mapping(ObjectType objectType => bool) _isValidType;
|
52
|
+
mapping(ObjectType objectType => mapping(ObjectType objectParentType => bool)) _isValidParentType;
|
53
|
+
|
54
|
+
mapping(NftId nftId => string stringValue) _string;
|
55
|
+
mapping(bytes32 serviceNameHash => mapping(VersionPart majorVersion => address service)) _service;
|
56
|
+
|
57
|
+
NftId _nftId;
|
58
|
+
IChainNft _chainNft;
|
59
|
+
ChainNft _chainNftInternal;
|
60
|
+
address _initialOwner;
|
61
|
+
|
62
|
+
/// @dev will own protocol nft and registry nft(s) minted during initialize
|
63
|
+
address _protocolOwner;
|
64
|
+
}
|
65
|
+
|
66
|
+
// keccak256(abi.encode(uint256(keccak256("gif-next.contracts.registry.Registry.sol")) - 1)) & ~bytes32(uint256(0xff));
|
67
|
+
bytes32 public constant locationV1 = 0x6548007c3f4340f82f348c576c0ff69f4f529cadd5ad41f96aae61abceeaa300;
|
68
|
+
|
69
|
+
// IMPORTANT Every new version must implement this function
|
70
|
+
// keep it private -> if unreachable from the next version then not included in its byte code
|
71
|
+
// each version MUST use the same locationV1
|
72
|
+
function _getStorage() private pure returns (StorageV1 storage $) {
|
73
|
+
assembly {
|
74
|
+
$.slot := locationV1
|
75
|
+
}
|
76
|
+
}
|
77
|
+
|
78
|
+
/// @dev the protocol owner will get ownership of the
|
79
|
+
// protocol nft and the global registry nft minted in this
|
80
|
+
// initializer function
|
81
|
+
function _initialize(bytes memory data)
|
82
|
+
internal
|
83
|
+
virtual override
|
84
|
+
onlyInitializing
|
85
|
+
{
|
86
|
+
address protocolOwner = abi.decode(data, (address));
|
87
|
+
StorageV1 storage $ = _getStorage();
|
88
|
+
|
89
|
+
$._initialOwner = msg.sender; // TODO here delegate call from proxy constructor, msg.sender is proxy deployer -> Proxy.sol
|
90
|
+
$._protocolOwner = protocolOwner;
|
91
|
+
|
92
|
+
// deploy NFT
|
93
|
+
$._chainNftInternal = new ChainNft(address(this));// adds 10kb to deployment size
|
94
|
+
$._chainNft = IChainNft($._chainNftInternal);
|
95
|
+
|
96
|
+
// initial registry setup
|
97
|
+
_registerProtocol();
|
98
|
+
$._nftId = _registerRegistry();
|
99
|
+
|
100
|
+
// setup rules for further registrations
|
101
|
+
_setupValidTypes();
|
102
|
+
_setupValidParentTypes();
|
103
|
+
}
|
104
|
+
|
105
|
+
function register(
|
106
|
+
address objectAddress
|
107
|
+
)
|
108
|
+
// TODO add authz (only services may register components etc)
|
109
|
+
// we have to check how we do authz for registring services (just restrict to protocol owner/registry owner)
|
110
|
+
external override returns (NftId nftId) {
|
111
|
+
StorageV1 storage $ = _getStorage();
|
112
|
+
|
113
|
+
require(
|
114
|
+
$._nftIdByAddress[objectAddress].eqz(),
|
115
|
+
"ERROR:REG-002:ALREADY_REGISTERED"
|
116
|
+
);
|
117
|
+
|
118
|
+
IRegisterable registerable = IRegisterable(objectAddress);
|
119
|
+
require(
|
120
|
+
registerable.supportsInterface(type(IRegisterable).interfaceId),
|
121
|
+
"ERROR:REG-003:NOT_REGISTERABLE"
|
122
|
+
);
|
123
|
+
|
124
|
+
ObjectType objectType = registerable.getType();
|
125
|
+
require(
|
126
|
+
$._isValidType[objectType],
|
127
|
+
"ERROR:REG-004:TYPE_INVALID"
|
128
|
+
);
|
129
|
+
|
130
|
+
NftId parentNftId = registerable.getParentNftId();
|
131
|
+
require(
|
132
|
+
isRegistered(parentNftId),
|
133
|
+
"ERROR:REG-005:PARENT_NOT_REGISTERED"
|
134
|
+
);
|
135
|
+
|
136
|
+
require(
|
137
|
+
$._isValidParentType[objectType][$._info[parentNftId].objectType],
|
138
|
+
"ERROR:REG-006:PARENT_TYPE_INVALID"
|
139
|
+
);
|
140
|
+
|
141
|
+
// also check that nftId and parentNFtId are on the same chain if applicable
|
142
|
+
|
143
|
+
// nft minting
|
144
|
+
uint256 mintedTokenId = $._chainNft.mint(
|
145
|
+
registerable.getOwner(),
|
146
|
+
EMPTY_URI
|
147
|
+
);
|
148
|
+
|
149
|
+
nftId = toNftId(mintedTokenId);
|
150
|
+
|
151
|
+
// special case services
|
152
|
+
if(registerable.getType() == SERVICE()) {
|
153
|
+
IService service = IService(objectAddress);
|
154
|
+
require(
|
155
|
+
service.supportsInterface(type(IService).interfaceId),
|
156
|
+
"ERROR:REG-007:NOT_SERVICE"
|
157
|
+
);
|
158
|
+
|
159
|
+
string memory serviceName = service.getName();
|
160
|
+
VersionPart majorVersion = service.getMajorVersion();
|
161
|
+
bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
|
162
|
+
|
163
|
+
// service specific state
|
164
|
+
$._string[nftId] = serviceName;
|
165
|
+
|
166
|
+
require(
|
167
|
+
$._service[serviceNameHash][majorVersion] == address(0),
|
168
|
+
"ERROR:REG-008:ALREADY_REGISTERED"
|
169
|
+
);
|
170
|
+
$._service[serviceNameHash][majorVersion] = objectAddress;
|
171
|
+
}
|
172
|
+
|
173
|
+
// create object info and link nft id with it
|
174
|
+
_registerObjectInfo(registerable, nftId);
|
175
|
+
}
|
176
|
+
|
177
|
+
|
178
|
+
function registerObjectForInstance(
|
179
|
+
NftId parentNftId,
|
180
|
+
ObjectType objectType,
|
181
|
+
address initialOwner,
|
182
|
+
bytes memory data
|
183
|
+
)
|
184
|
+
external
|
185
|
+
override
|
186
|
+
returns (
|
187
|
+
// TODO add onlyRegisteredInstance
|
188
|
+
NftId nftId
|
189
|
+
)
|
190
|
+
{
|
191
|
+
StorageV1 storage $ = _getStorage();
|
192
|
+
|
193
|
+
// TODO add more validation
|
194
|
+
require(
|
195
|
+
objectType == POLICY() || objectType == BUNDLE(),
|
196
|
+
"ERROR:REG-010:TYPE_INVALID"
|
197
|
+
);
|
198
|
+
|
199
|
+
uint256 mintedTokenId = $._chainNft.mint(initialOwner, EMPTY_URI);
|
200
|
+
nftId = toNftId(mintedTokenId);
|
201
|
+
|
202
|
+
ObjectInfo memory info = ObjectInfo(
|
203
|
+
nftId,
|
204
|
+
parentNftId,
|
205
|
+
objectType,
|
206
|
+
address(0),
|
207
|
+
initialOwner,
|
208
|
+
data
|
209
|
+
);
|
210
|
+
|
211
|
+
$._info[nftId] = info;
|
212
|
+
|
213
|
+
// add logging
|
214
|
+
}
|
215
|
+
|
216
|
+
function getObjectCount() external view override returns (uint256) {
|
217
|
+
return _getStorage()._chainNft.totalSupply();
|
218
|
+
}
|
219
|
+
|
220
|
+
function getNftId(
|
221
|
+
address object
|
222
|
+
) external view override returns (NftId id) {
|
223
|
+
return _getStorage()._nftIdByAddress[object];
|
224
|
+
}
|
225
|
+
|
226
|
+
function isRegistered(
|
227
|
+
NftId nftId
|
228
|
+
) public view override returns (bool) {
|
229
|
+
return _getStorage()._info[nftId].objectType.gtz();
|
230
|
+
}
|
231
|
+
|
232
|
+
function isRegistered(
|
233
|
+
address object
|
234
|
+
) external view override returns (bool) {
|
235
|
+
return _getStorage()._nftIdByAddress[object].gtz();
|
236
|
+
}
|
237
|
+
|
238
|
+
function getObjectInfo(
|
239
|
+
NftId nftId
|
240
|
+
) external view override returns (ObjectInfo memory info) {
|
241
|
+
return _getStorage()._info[nftId];
|
242
|
+
}
|
243
|
+
|
244
|
+
function getName(
|
245
|
+
NftId nftId
|
246
|
+
) external view returns (string memory name) {
|
247
|
+
return _getStorage()._string[nftId];
|
248
|
+
}
|
249
|
+
|
250
|
+
function getOwner(NftId nftId) external view override returns (address) {
|
251
|
+
return _getStorage()._chainNft.ownerOf(nftId.toInt());
|
252
|
+
}
|
253
|
+
|
254
|
+
function getChainNft() external view override returns (IChainNft) {
|
255
|
+
return _getStorage()._chainNft;
|
256
|
+
}
|
257
|
+
|
258
|
+
// special case to retrive a gif service
|
259
|
+
function getServiceAddress(string memory serviceName, VersionPart majorVersion) external view override returns (address serviceAddress) {
|
260
|
+
bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
|
261
|
+
return _getStorage()._service[serviceNameHash][majorVersion];
|
262
|
+
}
|
263
|
+
|
264
|
+
// from IERC165
|
265
|
+
function supportsInterface(bytes4 interfaceId) external pure override returns (bool) {
|
266
|
+
return interfaceId == type(IRegistry).interfaceId;
|
267
|
+
}
|
268
|
+
|
269
|
+
// from IRegistryLinked
|
270
|
+
function getRegistry() external view override returns (IRegistry registry) {
|
271
|
+
return this;
|
272
|
+
}
|
273
|
+
|
274
|
+
// from IVersionable
|
275
|
+
function getVersion() public pure virtual override returns (Version) {
|
276
|
+
return VersionLib.toVersion(1, 0, 0);
|
277
|
+
}
|
278
|
+
|
279
|
+
// from IRegisterable
|
280
|
+
// TODO
|
281
|
+
// 1) Registerable can not register itself -> otherwise register have to trust owner address provided by registerable
|
282
|
+
// registerable owner MUST call register and provide registerable address
|
283
|
+
// it will work if component was delegate called ??? NO
|
284
|
+
// owner-DELEGATE_CALL->component.register()-CALL->registryService->register()
|
285
|
+
// owner-CALL->proxy-DELEGATE_CALL->compoment.register()-CALL->registryService->register()
|
286
|
+
// 2) Who is msg.sender here???
|
287
|
+
// Registration of Instance or Service (any deployed by GIF contract) msg.sender is done in proxe contructor
|
288
|
+
function register() external pure override returns (NftId nftId) {
|
289
|
+
return zeroNftId();
|
290
|
+
}
|
291
|
+
|
292
|
+
function getType() external pure override returns (ObjectType objectType) {
|
293
|
+
return REGISTRY();
|
294
|
+
}
|
295
|
+
|
296
|
+
function getOwner() public view override returns (address owner) {
|
297
|
+
StorageV1 storage $ = _getStorage();
|
298
|
+
return $._nftId.gtz() ? this.getOwner($._nftId) : $._initialOwner;
|
299
|
+
}
|
300
|
+
|
301
|
+
function getNftId() public view override (IRegisterable, IRegistry) returns (NftId nftId) {
|
302
|
+
return _getStorage()._nftId;
|
303
|
+
}
|
304
|
+
|
305
|
+
function getParentNftId() public view returns (NftId nftId) {
|
306
|
+
StorageV1 storage $ = _getStorage();
|
307
|
+
// we're the global registry
|
308
|
+
/*if(block.chainid == 1) {
|
309
|
+
return toNftId($._chainNftInternal.PROTOCOL_NFT_ID());
|
310
|
+
}
|
311
|
+
else {
|
312
|
+
return toNftId($._chainNftInternal.GLOBAL_REGISTRY_ID());
|
313
|
+
}*/
|
314
|
+
nftId = $._info[$._nftId].parentNftId;
|
315
|
+
}
|
316
|
+
|
317
|
+
function getData() public pure returns (bytes memory data) {
|
318
|
+
return "";
|
319
|
+
}
|
320
|
+
|
321
|
+
// registry specific functions
|
322
|
+
function getProtocolOwner() external view override returns (address) {
|
323
|
+
return _getStorage()._protocolOwner;
|
324
|
+
}
|
325
|
+
|
326
|
+
/// @dev defines which types are allowed to register
|
327
|
+
function _setupValidTypes() internal onlyInitializing {
|
328
|
+
StorageV1 storage $ = _getStorage();
|
329
|
+
$._isValidType[REGISTRY()] = true; // only for global registry
|
330
|
+
$._isValidType[TOKEN()] = true;
|
331
|
+
$._isValidType[SERVICE()] = true;
|
332
|
+
$._isValidType[INSTANCE()] = true;
|
333
|
+
$._isValidType[STAKE()] = true;
|
334
|
+
$._isValidType[PRODUCT()] = true;
|
335
|
+
$._isValidType[ORACLE()] = true;
|
336
|
+
$._isValidType[POOL()] = true;
|
337
|
+
$._isValidType[DISTRIBUTION()] = true;
|
338
|
+
$._isValidType[POLICY()] = true;
|
339
|
+
$._isValidType[BUNDLE()] = true;
|
340
|
+
}
|
341
|
+
|
342
|
+
/// @dev defines which types - parent type relations are allowed to register
|
343
|
+
function _setupValidParentTypes() internal onlyInitializing {
|
344
|
+
StorageV1 storage $ = _getStorage();
|
345
|
+
// registry as parent
|
346
|
+
$._isValidParentType[TOKEN()][REGISTRY()] = true;
|
347
|
+
$._isValidParentType[SERVICE()][REGISTRY()] = true;
|
348
|
+
$._isValidParentType[INSTANCE()][REGISTRY()] = true;
|
349
|
+
|
350
|
+
// instance as parent
|
351
|
+
$._isValidParentType[PRODUCT()][INSTANCE()] = true;
|
352
|
+
$._isValidParentType[DISTRIBUTION()][INSTANCE()] = true;
|
353
|
+
$._isValidParentType[ORACLE()][INSTANCE()] = true;
|
354
|
+
$._isValidParentType[POOL()][INSTANCE()] = true;
|
355
|
+
|
356
|
+
// product as parent
|
357
|
+
$._isValidParentType[POLICY()][PRODUCT()] = true;
|
358
|
+
|
359
|
+
// pool as parent
|
360
|
+
$._isValidParentType[BUNDLE()][POOL()] = true;
|
361
|
+
$._isValidParentType[STAKE()][POOL()] = true;
|
362
|
+
}
|
363
|
+
|
364
|
+
/// @dev protocol registration used to anchor the dip ecosystem relations
|
365
|
+
function _registerProtocol()
|
366
|
+
virtual
|
367
|
+
internal
|
368
|
+
onlyInitializing
|
369
|
+
{
|
370
|
+
StorageV1 storage $ = _getStorage();
|
371
|
+
|
372
|
+
uint256 protocolId = $._chainNftInternal.PROTOCOL_NFT_ID();
|
373
|
+
$._chainNftInternal.mint($._protocolOwner, protocolId);
|
374
|
+
|
375
|
+
NftId protocolNftid = toNftId(protocolId);
|
376
|
+
ObjectInfo memory protocolInfo = ObjectInfo(
|
377
|
+
protocolNftid,
|
378
|
+
zeroNftId(), // parent nft id
|
379
|
+
PROTOCOL(),
|
380
|
+
address(0), // contract address
|
381
|
+
$._protocolOwner,
|
382
|
+
"" // data
|
383
|
+
);
|
384
|
+
|
385
|
+
$._info[protocolNftid] = protocolInfo;
|
386
|
+
}
|
387
|
+
|
388
|
+
/// @dev registry registration
|
389
|
+
/// might also register the global registry when not on mainnet
|
390
|
+
function _registerRegistry()
|
391
|
+
virtual
|
392
|
+
internal
|
393
|
+
onlyInitializing
|
394
|
+
returns (NftId registryNftId)
|
395
|
+
{
|
396
|
+
StorageV1 storage $ = _getStorage();
|
397
|
+
|
398
|
+
uint256 registryId = $._chainNftInternal.calculateTokenId(2);
|
399
|
+
registryNftId = toNftId(registryId);
|
400
|
+
|
401
|
+
// we're not the global registry
|
402
|
+
if(registryId != $._chainNftInternal.GLOBAL_REGISTRY_ID()) {
|
403
|
+
_registerGlobalRegistry();
|
404
|
+
}
|
405
|
+
|
406
|
+
$._chainNftInternal.mint($._protocolOwner, registryId);
|
407
|
+
|
408
|
+
// TODO error when deploying registry proxy
|
409
|
+
// in that case "this" is proxy address, "msg.sender" is proxy deployer, here in delegate call
|
410
|
+
// _registerObjectInfo() treats "this" as "IRegisterable"
|
411
|
+
// thus registerable.anyFunction() calls proxy...
|
412
|
+
// + all functions callable inside initializer/reinitializer modifiers MUST have onlyInitialising modifier
|
413
|
+
// now _registerObjectInfo() is used only outside of initializer/reinitializer modifiers
|
414
|
+
/*_registerObjectInfo(this, registryNftId);*/
|
415
|
+
|
416
|
+
NftId parentNftId;
|
417
|
+
// we're the global registry
|
418
|
+
if(block.chainid == 1) {
|
419
|
+
parentNftId = toNftId($._chainNftInternal.PROTOCOL_NFT_ID());
|
420
|
+
}
|
421
|
+
else {
|
422
|
+
parentNftId = toNftId($._chainNftInternal.GLOBAL_REGISTRY_ID());
|
423
|
+
}
|
424
|
+
ObjectInfo memory registryInfo = ObjectInfo(
|
425
|
+
registryNftId,
|
426
|
+
parentNftId,
|
427
|
+
REGISTRY(),
|
428
|
+
address(this), // proxy address
|
429
|
+
$._protocolOwner, // registry owner is different from proxy owner
|
430
|
+
""
|
431
|
+
);
|
432
|
+
|
433
|
+
$._info[registryNftId] = registryInfo;
|
434
|
+
$._nftIdByAddress[address(this)] = registryNftId;
|
435
|
+
|
436
|
+
// add logging
|
437
|
+
}
|
438
|
+
|
439
|
+
|
440
|
+
/// @dev global registry registration for non mainnet registries
|
441
|
+
function _registerGlobalRegistry()
|
442
|
+
virtual
|
443
|
+
internal
|
444
|
+
onlyInitializing
|
445
|
+
{
|
446
|
+
StorageV1 storage $ = _getStorage();
|
447
|
+
|
448
|
+
uint256 globalRegistryId = $._chainNftInternal.GLOBAL_REGISTRY_ID();
|
449
|
+
$._chainNftInternal.mint($._protocolOwner, globalRegistryId);
|
450
|
+
|
451
|
+
NftId globalRegistryNftId = toNftId(globalRegistryId);
|
452
|
+
ObjectInfo memory globalRegistryInfo = ObjectInfo(
|
453
|
+
globalRegistryNftId,
|
454
|
+
toNftId($._chainNftInternal.PROTOCOL_NFT_ID()),
|
455
|
+
REGISTRY(),
|
456
|
+
address(0), // contract address
|
457
|
+
$._protocolOwner,
|
458
|
+
"" // data
|
459
|
+
);
|
460
|
+
|
461
|
+
$._info[globalRegistryNftId] = globalRegistryInfo;
|
462
|
+
}
|
463
|
+
|
464
|
+
function _registerObjectInfo(
|
465
|
+
IRegisterable registerable,
|
466
|
+
NftId nftId
|
467
|
+
)
|
468
|
+
internal
|
469
|
+
virtual
|
470
|
+
{
|
471
|
+
address objectAddress = address(registerable);
|
472
|
+
ObjectInfo memory info = ObjectInfo(
|
473
|
+
nftId,
|
474
|
+
registerable.getParentNftId(),
|
475
|
+
registerable.getType(),
|
476
|
+
objectAddress,
|
477
|
+
registerable.getOwner(),
|
478
|
+
registerable.getData()
|
479
|
+
);
|
480
|
+
|
481
|
+
StorageV1 storage $ = _getStorage();
|
482
|
+
$._info[nftId] = info;
|
483
|
+
$._nftIdByAddress[objectAddress] = nftId;
|
484
|
+
|
485
|
+
// add logging
|
486
|
+
}
|
487
|
+
|
488
|
+
}
|
@@ -3,7 +3,7 @@ pragma solidity ^0.8.19;
|
|
3
3
|
|
4
4
|
import {Blocknumber, blockNumber} from "../types/Blocknumber.sol";
|
5
5
|
import {Timestamp, blockTimestamp} from "../types/Timestamp.sol";
|
6
|
-
import {Version, VersionPart
|
6
|
+
import {Version, VersionPart} from "../types/Version.sol";
|
7
7
|
|
8
8
|
interface IVersionable {
|
9
9
|
|
@@ -11,18 +11,29 @@ interface IVersionable {
|
|
11
11
|
Version version;
|
12
12
|
address implementation;
|
13
13
|
address activatedBy;
|
14
|
-
Blocknumber activatedIn;
|
15
14
|
Timestamp activatedAt;
|
15
|
+
Blocknumber activatedIn;
|
16
16
|
}
|
17
17
|
|
18
18
|
event LogVersionableActivated(Version version, address implementation, address activatedBy);
|
19
19
|
|
20
|
+
// TODO uncomment when all implementations are ready
|
21
|
+
/**
|
22
|
+
* @dev IMPORTANT this function MUST be implemented by each new version
|
23
|
+
* any such implementation MUST be guarded by initializer modifier
|
24
|
+
* any such implementation MUST call internal function _activate()
|
25
|
+
* any new version MUST inherit from previous version
|
26
|
+
*/
|
27
|
+
function initialize(address implementation, address activatedBy, bytes memory activationData) external;
|
28
|
+
|
20
29
|
/**
|
21
|
-
* @dev IMPORTANT this function
|
22
|
-
* any such
|
23
|
-
* any
|
30
|
+
* @dev IMPORTANT this function MUST be implemented by each new version
|
31
|
+
* any such implementation MUST be guarded by reinitializer(version().toUint64()) modifier
|
32
|
+
* any such implementation MUST call internal function _activate()
|
33
|
+
* any new version MUST inherit from previous version
|
34
|
+
* the first verion MUST revert
|
24
35
|
*/
|
25
|
-
function
|
36
|
+
function upgrade(address implementation, address activatedBy, bytes memory upgradeData) external;
|
26
37
|
|
27
38
|
/**
|
28
39
|
* @dev returns true if the specified version has been activated for the current contract
|
@@ -49,4 +60,6 @@ interface IVersionable {
|
|
49
60
|
*/
|
50
61
|
function getVersionInfo(Version version) external view returns(VersionInfo memory versionInfo);
|
51
62
|
|
63
|
+
function getInitializedVersion() external view returns(uint64);
|
64
|
+
|
52
65
|
}
|
@@ -0,0 +1,94 @@
|
|
1
|
+
// SPDX-License-Identifier: Apache-2.0
|
2
|
+
pragma solidity ^0.8.20;
|
3
|
+
|
4
|
+
import {Ownable} from "@openzeppelin5/contracts/access/Ownable.sol";
|
5
|
+
import {ProxyAdmin} from "@openzeppelin5/contracts/proxy/transparent/ProxyAdmin.sol";
|
6
|
+
import {TransparentUpgradeableProxy, ITransparentUpgradeableProxy} from "@openzeppelin5/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
|
7
|
+
|
8
|
+
import {IVersionable} from "./IVersionable.sol";
|
9
|
+
|
10
|
+
contract ProxyWithProxyAdminGetter is TransparentUpgradeableProxy {
|
11
|
+
|
12
|
+
constructor(address implementation, address initialProxyAdminOwner, bytes memory data)
|
13
|
+
TransparentUpgradeableProxy(implementation, initialProxyAdminOwner, data)
|
14
|
+
{}
|
15
|
+
|
16
|
+
function getProxyAdmin() external returns (ProxyAdmin) { return ProxyAdmin(_proxyAdmin()); }
|
17
|
+
}
|
18
|
+
|
19
|
+
// renamed because of name collision with OZ Proxy -> local proxy type was missing in typechain-types
|
20
|
+
contract ProxyDeployer is Ownable {
|
21
|
+
|
22
|
+
event ProxyDeployed(address indexed proxy);
|
23
|
+
|
24
|
+
// TODO use contract functions selectors ???
|
25
|
+
string public constant INITIALIZE_SIGNATURE = "initialize(address,address,bytes)";
|
26
|
+
string public constant UPGRADE_SIGNATURE = "upgrade(address,address,bytes)";
|
27
|
+
|
28
|
+
ProxyWithProxyAdminGetter private _proxy;
|
29
|
+
bool private _isDeployed;
|
30
|
+
|
31
|
+
/// @dev only used to capture proxy owner
|
32
|
+
constructor()
|
33
|
+
Ownable(msg.sender)
|
34
|
+
{
|
35
|
+
}
|
36
|
+
|
37
|
+
function getDeployData(address implementation, address proxyOwner, bytes memory deployData) public pure returns (bytes memory data) {
|
38
|
+
return abi.encodeWithSignature(INITIALIZE_SIGNATURE, implementation, proxyOwner, deployData);
|
39
|
+
}
|
40
|
+
|
41
|
+
function getUpgradeData(address implementation, address proxyOwner, bytes memory upgradeData) public pure returns (bytes memory data) {
|
42
|
+
return abi.encodeWithSignature(UPGRADE_SIGNATURE, implementation, proxyOwner, upgradeData);
|
43
|
+
}
|
44
|
+
|
45
|
+
/// @dev deploy initial contract
|
46
|
+
function deploy(address initialImplementation, bytes memory deployData)
|
47
|
+
external
|
48
|
+
onlyOwner()
|
49
|
+
returns (IVersionable versionable)
|
50
|
+
{
|
51
|
+
require(!_isDeployed, "ERROR:PRX-010:ALREADY_DEPLOYED");
|
52
|
+
|
53
|
+
address currentProxyOwner = owner();
|
54
|
+
address initialProxyAdminOwner = address(this);
|
55
|
+
bytes memory data = getDeployData(initialImplementation, currentProxyOwner, deployData);
|
56
|
+
|
57
|
+
_proxy = new ProxyWithProxyAdminGetter(
|
58
|
+
initialImplementation,
|
59
|
+
initialProxyAdminOwner,
|
60
|
+
data
|
61
|
+
);
|
62
|
+
|
63
|
+
_isDeployed = true;
|
64
|
+
versionable = IVersionable(address(_proxy));
|
65
|
+
|
66
|
+
emit ProxyDeployed(address(_proxy));
|
67
|
+
}
|
68
|
+
|
69
|
+
/// @dev upgrade existing contract
|
70
|
+
function upgrade(address newImplementation, bytes memory upgradeData)
|
71
|
+
external
|
72
|
+
onlyOwner
|
73
|
+
returns (IVersionable versionable)
|
74
|
+
{
|
75
|
+
require(_isDeployed, "ERROR:PRX-020:NOT_YET_DEPLOYED");
|
76
|
+
|
77
|
+
address currentProxyOwner = owner();
|
78
|
+
// ProxyAdmin proxyAdmin = _proxy.getProxyAdmin();
|
79
|
+
ProxyAdmin proxyAdmin = getProxyAdmin();
|
80
|
+
ITransparentUpgradeableProxy proxy = ITransparentUpgradeableProxy(address(_proxy));
|
81
|
+
bytes memory data = getUpgradeData(newImplementation, currentProxyOwner, upgradeData);
|
82
|
+
|
83
|
+
proxyAdmin.upgradeAndCall(
|
84
|
+
proxy,
|
85
|
+
newImplementation,
|
86
|
+
data);
|
87
|
+
|
88
|
+
versionable = IVersionable(address(_proxy));
|
89
|
+
}
|
90
|
+
|
91
|
+
function getProxyAdmin() public returns (ProxyAdmin) {
|
92
|
+
return _proxy.getProxyAdmin();
|
93
|
+
}
|
94
|
+
}
|
@@ -1,14 +1,15 @@
|
|
1
1
|
// SPDX-License-Identifier: Apache-2.0
|
2
2
|
pragma solidity ^0.8.19;
|
3
3
|
|
4
|
+
import {Initializable} from "@openzeppelin5/contracts/proxy/utils/Initializable.sol";
|
5
|
+
|
4
6
|
import {Blocknumber, blockNumber} from "../types/Blocknumber.sol";
|
5
7
|
import {Timestamp, blockTimestamp} from "../types/Timestamp.sol";
|
6
|
-
import {Version, VersionPart
|
8
|
+
import {Version, VersionPart} from "../types/Version.sol";
|
7
9
|
|
8
10
|
import {IVersionable} from "./IVersionable.sol";
|
9
11
|
|
10
|
-
abstract contract Versionable is IVersionable {
|
11
|
-
|
12
|
+
abstract contract Versionable is Initializable, IVersionable {
|
12
13
|
|
13
14
|
mapping(Version version => VersionInfo info) private _versionHistory;
|
14
15
|
Version [] private _versions;
|
@@ -21,12 +22,15 @@ abstract contract Versionable is IVersionable {
|
|
21
22
|
|
22
23
|
// IMPORTANT this function needs to be implemented by each new version
|
23
24
|
// and needs to call internal function call _activate()
|
24
|
-
function
|
25
|
+
function initialize(address implementation, address activatedBy, bytes memory initializationData)
|
25
26
|
external
|
26
|
-
|
27
|
+
virtual
|
27
28
|
{
|
28
29
|
_activate(implementation, activatedBy);
|
29
30
|
}
|
31
|
+
// TODO mock, delete when implementations are ready
|
32
|
+
function activate(address implementation, address activatedBy, bytes memory activatinData) public {}
|
33
|
+
function upgrade(address implementation, address activatedBy, bytes memory upgradeData) external {}
|
30
34
|
|
31
35
|
|
32
36
|
// can only be called once per contract
|
@@ -58,8 +62,8 @@ abstract contract Versionable is IVersionable {
|
|
58
62
|
thisVersion,
|
59
63
|
implementation,
|
60
64
|
activatedBy,
|
61
|
-
|
62
|
-
|
65
|
+
blockTimestamp(),
|
66
|
+
blockNumber()
|
63
67
|
);
|
64
68
|
|
65
69
|
emit LogVersionableActivated(thisVersion, implementation, activatedBy);
|
@@ -80,13 +84,16 @@ abstract contract Versionable is IVersionable {
|
|
80
84
|
|
81
85
|
|
82
86
|
function getVersion(uint256 idx) external view override returns(Version) {
|
83
|
-
require(idx < _versions.length, "ERROR:VRN-010:INDEX_TOO_LARGE");
|
84
87
|
return _versions[idx];
|
85
88
|
}
|
86
89
|
|
87
90
|
|
88
91
|
function getVersionInfo(Version _version) external override view returns(VersionInfo memory) {
|
89
|
-
require(isActivated(_version), "ERROR:VRN-020:VERSION_UNKNOWN");
|
90
92
|
return _versionHistory[_version];
|
91
93
|
}
|
94
|
+
|
95
|
+
function getInitializedVersion() external view returns(uint64)
|
96
|
+
{
|
97
|
+
return _getInitializedVersion();
|
98
|
+
}
|
92
99
|
}
|