@etherisc/gif-next 0.0.2-ce87da3-250 → 0.0.2-ceed5e3-261

package/contracts/instance/Instance.sol

@@ -3,289 +3,261 @@ pragma solidity ^0.8.20;
 
 import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 
-import {Key32, KeyId, Key32Lib} from "../types/Key32.sol";
-import {NftId} from "../types/NftId.sol";
-import {ClaimId} from "../types/ClaimId.sol";
-import {NumberId} from "../types/NumberId.sol";
-import {ObjectType, BUNDLE, DISTRIBUTION, INSTANCE, POLICY, POOL, ROLE, PRODUCT, TARGET, COMPONENT, DISTRIBUTOR, DISTRIBUTOR_TYPE} from "../types/ObjectType.sol";
-import {RiskId, RiskIdLib} from "../types/RiskId.sol";
-import {RoleId, RoleIdLib} from "../types/RoleId.sol";
-import {StateId, ACTIVE} from "../types/StateId.sol";
-import {TimestampLib} from "../types/Timestamp.sol";
-import {VersionPart} from "../types/Version.sol";
-
-import {ERC165} from "../shared/ERC165.sol";
+import {Amount} from "../type/Amount.sol";
+import {Key32} from "../type/Key32.sol";
+import {NftId} from "../type/NftId.sol";
+import {RiskId} from "../type/RiskId.sol";
+import {ObjectType, BUNDLE, DISTRIBUTION, INSTANCE, POLICY, POOL, ROLE, PRODUCT, TARGET, COMPONENT, DISTRIBUTOR, DISTRIBUTOR_TYPE} from "../type/ObjectType.sol";
+import {RoleId, RoleIdLib, eqRoleId, ADMIN_ROLE, INSTANCE_ROLE, INSTANCE_OWNER_ROLE} from "../type/RoleId.sol";
+import {ClaimId} from "../type/ClaimId.sol";
+import {ReferralId} from "../type/Referral.sol";
+import {PayoutId} from "../type/PayoutId.sol";
+import {DistributorType} from "../type/DistributorType.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {UFixed} from "../type/UFixed.sol";
+import {VersionPart, VersionPartLib} from "../type/Version.sol";
+
 import {Registerable} from "../shared/Registerable.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
+import {AccessManagerExtendedInitializeable} from "../shared/AccessManagerExtendedInitializeable.sol";
+
+import {IRegistry} from "../registry/IRegistry.sol";
 
 import {IInstance} from "./IInstance.sol";
+import {IInstanceService} from "./IInstanceService.sol";
 import {InstanceReader} from "./InstanceReader.sol";
-import {InstanceAccessManager} from "./InstanceAccessManager.sol";
+import {InstanceAdmin} from "./InstanceAdmin.sol";
 import {BundleManager} from "./BundleManager.sol";
+import {InstanceStore} from "./InstanceStore.sol";
 
-import {KeyValueStore} from "./base/KeyValueStore.sol";
+import {KeyValueStore} from "../shared/KeyValueStore.sol";
 
-import {IAccess} from "./module/IAccess.sol";
 import {IBundle} from "./module/IBundle.sol";
+import {IComponents} from "./module/IComponents.sol";
 import {IDistribution} from "./module/IDistribution.sol";
 import {IPolicy} from "./module/IPolicy.sol";
 import {IRisk} from "./module/IRisk.sol";
-import {ISetup} from "./module/ISetup.sol";
 
-import {IDistributionService} from "./service/IDistributionService.sol";
-import {IPoolService} from "./service/IPoolService.sol";
-import {IProductService} from "./service/IProductService.sol";
-import {IPolicyService} from "./service/IPolicyService.sol";
-import {IBundleService} from "./service/IBundleService.sol";
-import {VersionPart, VersionPartLib} from "../types/Version.sol";
+import {IDistributionService} from "../distribution/IDistributionService.sol";
+import {IPoolService} from "../pool/IPoolService.sol";
+import {IProductService} from "../product/IProductService.sol";
+import {IPolicyService} from "../product/IPolicyService.sol";
+import {IBundleService} from "../pool/IBundleService.sol";
 
 contract Instance is
     IInstance,
     AccessManagedUpgradeable,
-    Registerable,
-    KeyValueStore
+    Registerable
 {
-
     uint256 public constant GIF_MAJOR_VERSION = 3;
 
-    uint64 public constant ADMIN_ROLE = type(uint64).min;
-    uint64 public constant PUBLIC_ROLE = type(uint64).max;
-    uint64 public constant CUSTOM_ROLE_ID_MIN = 10000;
-
-    uint32 public constant EXECUTION_DELAY = 0;
-
     bool private _initialized;
 
-    InstanceAccessManager internal _accessManager;
+    IInstanceService internal _instanceService;
+    InstanceAdmin internal _instanceAdmin;
     InstanceReader internal _instanceReader;
     BundleManager internal _bundleManager;
+    InstanceStore internal _instanceStore;
 
-    function initialize(address accessManagerAddress, address registryAddress, NftId registryNftId, address initialOwner) 
-        public 
-        initializer()
-    {
-        __AccessManaged_init(accessManagerAddress);
-        
-        initializeRegisterable(registryAddress, registryNftId, INSTANCE(), false, initialOwner, "");
-        registerInterface(type(IInstance).interfaceId);    
-    }
-
-    //--- ProductSetup ------------------------------------------------------//
-    function createProductSetup(NftId productNftId, ISetup.ProductSetupInfo memory setup) external restricted() {
-        create(_toNftKey32(productNftId, PRODUCT()), abi.encode(setup));
-    }
-
-    function updateProductSetup(NftId productNftId, ISetup.ProductSetupInfo memory setup, StateId newState) external restricted() {
-        update(_toNftKey32(productNftId, PRODUCT()), abi.encode(setup), newState);
-    }
-
-    function updateProductSetupState(NftId productNftId, StateId newState) external restricted() {
-        updateState(_toNftKey32(productNftId, PRODUCT()), newState);
-    }
-
-    //--- DistributionSetup ------------------------------------------------------//
-    function createDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup) external restricted() {
-        create(_toNftKey32(distributionNftId, DISTRIBUTION()), abi.encode(setup));
-    }
-
-    function updateDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup, StateId newState) external restricted() {
-        update(_toNftKey32(distributionNftId, DISTRIBUTION()), abi.encode(setup), newState);
-    }
-
-    function updateDistributionSetupState(NftId distributionNftId, StateId newState) external restricted() {
-        updateState(_toNftKey32(distributionNftId, DISTRIBUTION()), newState);
-    }
-
-    //--- PoolSetup ------------------------------------------------------//
-    function createPoolSetup(NftId poolNftId, ISetup.PoolSetupInfo memory setup) external restricted() {
-        create(_toNftKey32(poolNftId, POOL()), abi.encode(setup));
-    }
-
-    function updatePoolSetup(NftId poolNftId, ISetup.PoolSetupInfo memory setup, StateId newState) external restricted() {
-        update(_toNftKey32(poolNftId, POOL()), abi.encode(setup), newState);
-    }
-
-    function updatePoolSetupState(NftId poolNftId, StateId newState) external restricted() {
-        updateState(_toNftKey32(poolNftId, POOL()), newState);
-    }
-
-    //--- DistributorType -------------------------------------------------------//
-    function createDistributorType(Key32 distributorKey, IDistribution.DistributorTypeInfo memory info) external restricted() {
-        create(distributorKey, abi.encode(info));
-    }
-
-    function updateDistributorType(Key32 distributorKey, IDistribution.DistributorTypeInfo memory info, StateId newState) external restricted() {
-        update(distributorKey, abi.encode(info), newState);
-    }
-
-    function updateDistributorTypeState(Key32 distributorKey, StateId newState) external restricted() {
-        updateState(distributorKey, newState);
+    modifier onlyChainNft() {
+        if(msg.sender != getRegistry().getChainNftAddress()) {
+            revert();
+        }
+        _;
     }
 
-    //--- Distributor -------------------------------------------------------//
-    function createDistributor(NftId nftId, IDistribution.DistributorInfo memory info) external restricted() {
-        create(toDistributorKey32(nftId), abi.encode(info));
-    }
-
-    function updateDistributor(NftId nftId, IDistribution.DistributorInfo memory info, StateId newState) external restricted() {
-        update(toDistributorKey32(nftId), abi.encode(info), newState);
-    }
+    function initialize(address authority, address registryAddress, address initialOwner) 
+        external 
+        initializer()
+    {
+        if(authority == address(0)) {
+            revert ErrorInstanceInstanceAdminZero();
+        }
 
-    function updateDistributorState(NftId nftId, StateId newState) external restricted() {
-        updateState(toDistributorKey32(nftId), newState);
-    }
+        __AccessManaged_init(authority);
+        
+        IRegistry registry = IRegistry(registryAddress);
+        initializeRegisterable(registryAddress, registry.getNftId(), INSTANCE(), true, initialOwner, "");
 
-    //--- Referral ----------------------------------------------------------//
-    function createReferral(Key32 referralKey, IDistribution.ReferralInfo memory referralInfo) external restricted() {
-        create(referralKey, abi.encode(referralInfo));
-    }
+        _instanceService = IInstanceService(
+            getRegistry().getServiceAddress(
+                INSTANCE(), 
+                getMajorVersion()));
 
-    function updateReferral(Key32 referralKey, IDistribution.ReferralInfo memory referralInfo, StateId newState) external restricted() {
-        update(referralKey, abi.encode(referralInfo), newState);
+        registerInterface(type(IInstance).interfaceId);    
     }
 
-    function updateReferralState(Key32 referralKey, StateId newState) external restricted() {
-        updateState(referralKey, newState);
-    }
+    //--- Staking ----------------------------------------------------------//
 
-    //--- Bundle ------------------------------------------------------------//
-    function createBundle(NftId bundleNftId, IBundle.BundleInfo memory bundle) external restricted() {
-        create(toBundleKey32(bundleNftId), abi.encode(bundle));
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod)
+        external
+        // TODO decide if onlyOwner or restricted to instance owner role is better
+        onlyOwner()
+    {
+        _instanceService.setStakingLockingPeriod(stakeLockingPeriod);
     }
 
-    function updateBundle(NftId bundleNftId, IBundle.BundleInfo memory bundle, StateId newState) external restricted() {
-        update(toBundleKey32(bundleNftId), abi.encode(bundle), newState);
+    function setStakingRewardRate(UFixed rewardRate)
+        external
+        onlyOwner()
+    {
+        _instanceService.setStakingRewardRate(rewardRate);
     }
 
-    function updateBundleState(NftId bundleNftId, StateId newState) external restricted() {
-        updateState(toBundleKey32(bundleNftId), newState);
+    function refillStakingRewardReserves(Amount dipAmount)
+        external
+        onlyOwner()
+    {
+        address instanceOwner = msg.sender;
+        _instanceService.refillStakingRewardReserves(instanceOwner, dipAmount);
     }
 
-    //--- Risk --------------------------------------------------------------//
-    function createRisk(RiskId riskId, IRisk.RiskInfo memory risk) external restricted() {
-        create(riskId.toKey32(), abi.encode(risk));
+    function withdrawStakingRewardReserves(Amount dipAmount)
+        external
+        onlyOwner()
+        returns (Amount newBalance)
+    {
+        return _instanceService.withdrawStakingRewardReserves(dipAmount);
     }
 
-    function updateRisk(RiskId riskId, IRisk.RiskInfo memory risk, StateId newState) external restricted() {
-        update(riskId.toKey32(), abi.encode(risk), newState);
-    }
+    //--- Roles ------------------------------------------------------------//
 
-    function updateRiskState(RiskId riskId, StateId newState) external restricted() {
-        updateState(riskId.toKey32(), newState);
+    function createRole(string memory roleName, string memory adminName)
+        external
+        // TODO decide if onlyOwner or restricted to instance owner role is better
+        restricted // INSTANCE_OWNER_ROLE
+        returns (RoleId roleId, RoleId admin)
+    {
+        (roleId, admin) = _instanceAdmin.createRole(roleName, adminName);
     }
 
-    //--- Application (Policy) ----------------------------------------------//
-    function createApplication(NftId applicationNftId, IPolicy.PolicyInfo memory policy) external restricted() {
-        create(toPolicyKey32(applicationNftId), abi.encode(policy));
+    function grantRole(RoleId roleId, address account) 
+        external 
+        // TODO decide if onlyOwner or restricted to instance owner role is better
+        restricted // INSTANCE_OWNER_ROLE
+    {
+        AccessManagerExtendedInitializeable(authority()).grantRole(roleId.toInt(), account, 0);
     }
 
-    function updateApplication(NftId applicationNftId, IPolicy.PolicyInfo memory policy, StateId newState) external restricted() {
-        update(toPolicyKey32(applicationNftId), abi.encode(policy), newState);
+    function revokeRole(RoleId roleId, address account) 
+        external 
+        // TODO decide if onlyOwner or restricted to instance owner role is better
+        restricted // INSTANCE_OWNER_ROLE
+    {
+        AccessManagerExtendedInitializeable(authority()).revokeRole(roleId.toInt(), account);
     }
 
-    function updateApplicationState(NftId applicationNftId, StateId newState) external restricted() {
-        updateState(toPolicyKey32(applicationNftId), newState);
-    }
+    //--- Targets ------------------------------------------------------------//
 
-    //--- Policy ------------------------------------------------------------//
-    function updatePolicy(NftId policyNftId, IPolicy.PolicyInfo memory policy, StateId newState) external restricted() {
-        update(toPolicyKey32(policyNftId), abi.encode(policy), newState);
+    function createTarget(address target, string memory name) 
+        external 
+        // TODO decide if onlyOwner or restricted to instance owner role is better
+        restricted // INSTANCE_OWNER_ROLE
+    {
+        _instanceAdmin.createTarget(target, name);
     }
 
-    function updatePolicyState(NftId policyNftId, StateId newState) external restricted() {
-        updateState(toPolicyKey32(policyNftId), newState);
+    function setTargetFunctionRole(
+        string memory targetName,
+        bytes4[] calldata selectors,
+        RoleId roleId
+    ) 
+        external 
+        restricted // INSTANCE_OWNER_ROLE
+    {
+        _instanceAdmin.setTargetFunctionRoleByInstance(targetName, selectors, roleId);
     }
 
-    //--- Claim -------------------------------------------------------------//
-    function createClaim(NftId policyNftId, ClaimId claimId, IPolicy.ClaimInfo memory claim) external restricted() {
-        create(toPolicyKey32(policyNftId), abi.encode(claim));
+    function setTargetLocked(address target, bool locked)
+        external 
+        restricted // INSTANCE_OWNER_ROLE
+    {
+        _instanceAdmin.setTargetLockedByInstance(target, locked);
     }
 
-    function updateClaim(NftId policyNftId, ClaimId claimId, IPolicy.ClaimInfo memory claim, StateId newState) external restricted() {
-        update(toPolicyKey32(policyNftId), abi.encode(claim), newState);
-    }
+    //--- ITransferInterceptor ----------------------------------------------//
 
-    function updateClaimState(NftId policyNftId, ClaimId claimId, StateId newState) external restricted() {
-        updateState(toPolicyKey32(policyNftId), newState);
+    // TODO interception of child components nfts
+    function nftMint(address to, uint256 tokenId) external onlyChainNft {
+        _instanceAdmin.transferInstanceOwnerRole(address(0), to);
     }
 
-    //--- Payout ------------------------------------------------------------//
-    function createPayout(NftId policyNftId, NumberId payoutId, IPolicy.PayoutInfo memory payout) external restricted() {
-        create(toPolicyKey32(policyNftId), abi.encode(payout));
+    function nftTransferFrom(address from, address to, uint256 tokenId) external onlyChainNft {
+        _instanceAdmin.transferInstanceOwnerRole(from, to);
     }
 
-    function updatePayout(NftId policyNftId, NumberId payoutId, IPolicy.PayoutInfo memory payout, StateId newState) external restricted() {
-        update(toPolicyKey32(policyNftId), abi.encode(payout), newState);
-    }
+    //function nftBurn(address from, uint256 tokenId) external onlyChainNft {
+        //_instanceAdmin.transferInstanceOwnerRole(from, address(0));
+    //}
 
-    function updatePayoutState(NftId policyNftId, StateId newState) external restricted() {
-        updateState(toPolicyKey32(policyNftId), newState);
-    }
+    //--- initial setup functions -------------------------------------------//
 
-    //--- internal view/pure functions --------------------------------------//
-    function _toNftKey32(NftId nftId, ObjectType objectType) internal pure returns (Key32) {
-        return nftId.toKey32(objectType);
+    function setInstanceAdmin(InstanceAdmin accessManager) external restricted {
+        if(address(_instanceAdmin) != address(0)) {
+            revert ErrorInstanceInstanceAdminAlreadySet(address(_instanceAdmin));
+        }
+        if(accessManager.authority() != authority()) {
+            revert ErrorInstanceInstanceAdminAuthorityMismatch(authority());
+        }
+        _instanceAdmin = accessManager;      
     }
-
-    function toBundleKey32(NftId bundleNftId) public pure returns (Key32) {
-        return bundleNftId.toKey32(BUNDLE());
+    
+    function setBundleManager(BundleManager bundleManager) external restricted() {
+        if(address(_bundleManager) != address(0)) {
+            revert ErrorInstanceBundleManagerAlreadySet(address(_bundleManager));
+        }
+        if(bundleManager.getInstance() != Instance(this)) {
+            revert ErrorInstanceBundleManagerInstanceMismatch(address(this));
+        }
+        if(bundleManager.authority() != authority()) {
+            revert ErrorInstanceBundleManagerAuthorityMismatch(authority());
+        }
+        _bundleManager = bundleManager;
     }
 
-    function toPolicyKey32(NftId policyNftId) public pure returns (Key32) {
-        return policyNftId.toKey32(POLICY());
-    }
+    function setInstanceReader(InstanceReader instanceReader) external restricted() {
+        if(instanceReader.getInstance() != Instance(this)) {
+            revert ErrorInstanceInstanceReaderInstanceMismatch(address(this));
+        }
 
-    function toDistributionKey32(NftId distNftId) public pure returns (Key32) {
-        return distNftId.toKey32(DISTRIBUTION());
+        _instanceReader = instanceReader;
     }
 
-    function toDistributorTypeKey32(NftId distNftId) public pure returns (Key32) {
-        return distNftId.toKey32(DISTRIBUTOR_TYPE());
+    function setInstanceStore(InstanceStore instanceStore) external restricted {
+        if(address(_instanceStore) != address(0)) {
+            revert ErrorInstanceInstanceStoreAlreadySet(address(_instanceStore));
+        }
+        if(instanceStore.authority() != authority()) {
+            revert ErrorInstanceInstanceStoreAuthorityMismatch(authority());
+        }
+        _instanceStore = instanceStore;
     }
 
-    function toDistributorKey32(NftId distNftId) public pure returns (Key32) {
-        return distNftId.toKey32(DISTRIBUTOR());
-    }
-    
-    function getDistributionService() external view returns (IDistributionService) {
-        return IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), VersionPart.wrap(3)));
-    }
+    //--- external view functions -------------------------------------------//
 
-    function getProductService() external view returns (IProductService) {
-        return IProductService(getRegistry().getServiceAddress(PRODUCT(), VersionPart.wrap(3)));
+    function getInstanceReader() external view returns (InstanceReader) {
+        return _instanceReader;
     }
 
-    function getPoolService() external view returns (IPoolService) {
-        return IPoolService(getRegistry().getServiceAddress(POOL(), VersionPart.wrap(3)));
+    function getBundleManager() external view returns (BundleManager) {
+        return _bundleManager;
     }
 
-    function getPolicyService() external view returns (IPolicyService) {
-        return IPolicyService(getRegistry().getServiceAddress(POLICY(), VersionPart.wrap(3)));
+    function getInstanceAdmin() external view returns (InstanceAdmin) {
+        return _instanceAdmin;
     }
 
-    function getBundleService() external view returns (IBundleService) {
-        return IBundleService(getRegistry().getServiceAddress(BUNDLE(), VersionPart.wrap(3)));
+    function getInstanceAccessManager() external view returns (AccessManagerExtendedInitializeable) {
+        return AccessManagerExtendedInitializeable(authority());
     }
 
-    function setInstanceReader(InstanceReader instanceReader) external restricted() {
-        require(instanceReader.getInstance() == Instance(this), "InstanceReader instance mismatch");
-        _instanceReader = instanceReader;
+    function getInstanceStore() external view returns (InstanceStore) {
+        return _instanceStore;
     }
 
-    function getMajorVersion() external pure returns (VersionPart majorVersion) {
+    function getMajorVersion() public pure returns (VersionPart majorVersion) {
         return VersionPartLib.toVersionPart(GIF_MAJOR_VERSION);
     }
 
-    function getInstanceReader() external view returns (InstanceReader) {
-        return _instanceReader;
-    }
-    
-    function setBundleManager(BundleManager bundleManager) external restricted() {
-        require(address(_bundleManager) == address(0), "BundleManager is set");
-        require(bundleManager.getInstance() == Instance(this), "BundleManager instance mismatch");
-        _bundleManager = bundleManager;
-    }
-
-    function getBundleManager() external view returns (BundleManager) {
-        return _bundleManager;
-    }
-}
+    //--- internal view/pure functions --------------------------------------//
+}