@etherisc/gif-next 0.0.2-d39f345-355 → 0.0.2-d3a9310-013

package/contracts/instance/Instance.sol

@@ -1,310 +1,346 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
-
-import {Key32} from "../types/Key32.sol";
-import {NftId} from "../types/NftId.sol";
-import {ClaimId} from "../types/ClaimId.sol";
-import {DistributorType} from "../types/DistributorType.sol";
-import {PayoutId} from "../types/PayoutId.sol";
-import {ObjectType, BUNDLE, DISTRIBUTION, INSTANCE, POLICY, POOL, PRODUCT, DISTRIBUTOR} from "../types/ObjectType.sol";
-import {ReferralId} from "../types/Referral.sol";
-import {RiskId} from "../types/RiskId.sol";
-import {INSTANCE_OWNER_ROLE} from "../types/RoleId.sol";
-import {StateId} from "../types/StateId.sol";
-import {VersionPart, VersionPartLib} from "../types/Version.sol";
-
-import {Registerable} from "../shared/Registerable.sol";
-
+import {IAccess} from "../authorization/IAccess.sol";
+import {IInstance} from "./IInstance.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
+import {IInstanceService} from "./IInstanceService.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 
-import {IInstance} from "./IInstance.sol";
+import {Amount} from "../type/Amount.sol";
+import {BundleSet} from "./BundleSet.sol";
+import {RiskSet} from "./RiskSet.sol";
+import {COMPONENT, INSTANCE} from "../type/ObjectType.sol";
 import {InstanceReader} from "./InstanceReader.sol";
-import {InstanceAccessManager} from "./InstanceAccessManager.sol";
-import {BundleManager} from "./BundleManager.sol";
-
-import {KeyValueStore} from "./base/KeyValueStore.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 {VersionPart, VersionPartLib} from "../types/Version.sol";
+import {InstanceAdmin} from "./InstanceAdmin.sol";
+import {InstanceStore} from "./InstanceStore.sol";
+import {NftId} from "../type/NftId.sol";
+import {Registerable} from "../shared/Registerable.sol";
+import {RoleId} from "../type/RoleId.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {UFixed} from "../type/UFixed.sol";
+import {VersionPart} from "../type/Version.sol";
 
 contract Instance is
     IInstance,
-    AccessManagedUpgradeable,
-    Registerable,
-    KeyValueStore
+    Registerable
 {
+    bool private _initialized;
 
-    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;
+    IComponentService internal _componentService;
+    IInstanceService internal _instanceService;
 
-    uint32 public constant EXECUTION_DELAY = 0;
+    InstanceAdmin internal _instanceAdmin;
+    InstanceReader internal _instanceReader;
+    BundleSet internal _bundleSet;
+    RiskSet internal _riskSet;
+    InstanceStore internal _instanceStore;
+    NftId [] internal _products;
+    bool internal _tokenRegistryDisabled;
 
-    bool private _initialized;
 
-    InstanceAccessManager internal _accessManager;
-    InstanceReader internal _instanceReader;
-    BundleManager internal _bundleManager;
+    modifier onlyCustomRoleAdmin(RoleId roleId) {
+        if (!_instanceAdmin.isRoleCustom(roleId)) {
+            revert ErrorInstanceNotCustomRole(roleId);
+        }
 
-    modifier onlyChainNft() {
-        if(msg.sender != getRegistry().getChainNftAddress()) {
-            revert();
+        // instance owner can always act as role admin
+        address account = msg.sender;
+        if (account != getOwner()) {
+            if (!_instanceAdmin.isRoleAdmin(roleId, account)) {
+                revert ErrorInstanceNotRoleAdmin(roleId, account);
+            }
         }
         _;
     }
 
-    function initialize(address authority, address registryAddress, address initialOwner) 
-        public 
+
+    function initialize(
+        InstanceAdmin instanceAdmin, 
+        InstanceStore instanceStore,
+        BundleSet bundleSet,
+        RiskSet riskSet,
+        InstanceReader instanceReader,
+        IRegistry registry, 
+        VersionPart release,
+        address initialOwner,
+        bool tokenRegistryDisabled
+    ) 
+        external 
         initializer()
     {
-        __AccessManaged_init(authority);
-        
-        IRegistry registry = IRegistry(registryAddress);
-        initializeRegisterable(registryAddress, registry.getNftId(), INSTANCE(), true, initialOwner, "");
-        initializeLifecycle();
-
-        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);
-    }
+        if(address(instanceAdmin) == address(0)) {
+            revert ErrorInstanceInstanceAdminZero();
+        }
 
-    function updateProductSetupState(NftId productNftId, StateId newState) external restricted() {
-        updateState(_toNftKey32(productNftId, PRODUCT()), newState);
-    }
+        _instanceAdmin = instanceAdmin;
+
+        // setup instance object info
+        __Registerable_init({
+            authority: instanceAdmin.authority(),
+            registry: address(registry), 
+            parentNftId: registry.getNftId(), 
+            objectType: INSTANCE(), 
+            isInterceptor: false, 
+            initialOwner: initialOwner, 
+            data: ""});
+
+        // store instance supporting contracts
+        _instanceStore = instanceStore;
+        _bundleSet = bundleSet;
+        _riskSet = riskSet;
+        _instanceReader = instanceReader;
 
-    //--- DistributionSetup ------------------------------------------------------//
-    function createDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup) external restricted() {
-        create(_toNftKey32(distributionNftId, DISTRIBUTION()), abi.encode(setup));
-    }
+        // initialize instance supporting contracts
+        _instanceStore.initialize();
+        _bundleSet.initialize(instanceAdmin.authority(), address(registry));
+        _riskSet.initialize(instanceAdmin.authority(), address(registry));
+        _instanceReader.initialize();
 
-    function updateDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup, StateId newState) external restricted() {
-        update(_toNftKey32(distributionNftId, DISTRIBUTION()), abi.encode(setup), newState);
-    }
+        _componentService = IComponentService(
+            getRegistry().getServiceAddress(
+                COMPONENT(), 
+                release));
 
-    function updateDistributionSetupState(NftId distributionNftId, StateId newState) external restricted() {
-        updateState(_toNftKey32(distributionNftId, DISTRIBUTION()), newState);
-    }
+        _instanceService = IInstanceService(
+            getRegistry().getServiceAddress(
+                INSTANCE(), 
+                release));
 
-    //--- PoolSetup ------------------------------------------------------//
-    function createPoolSetup(NftId poolNftId, IComponents.ComponentInfo memory info) external restricted() {
-        create(_toNftKey32(poolNftId, POOL()), abi.encode(info));
-    }
+        _tokenRegistryDisabled = tokenRegistryDisabled;
 
-    function updatePoolSetup(NftId poolNftId, IComponents.ComponentInfo memory info, StateId newState) external restricted() {
-        update(_toNftKey32(poolNftId, POOL()), abi.encode(info), newState);
+        _registerInterface(type(IInstance).interfaceId);    
     }
 
-    function updatePoolSetupState(NftId poolNftId, StateId newState) external restricted() {
-        updateState(_toNftKey32(poolNftId, POOL()), newState);
-    }
 
-    //--- DistributorType -------------------------------------------------------//
-    function createDistributorType(DistributorType distributorType, IDistribution.DistributorTypeInfo memory info) external restricted() {
-        create(distributorType.toKey32(), abi.encode(info));
+    function setInstanceLocked(bool locked)
+        external 
+        // not restricted(): need to be able to unlock a locked instance
+        onlyOwner()
+    {
+        _instanceService.setInstanceLocked(locked);
     }
 
-    function updateDistributorType(DistributorType distributorType, IDistribution.DistributorTypeInfo memory info, StateId newState) external restricted() {
-        update(distributorType.toKey32(), abi.encode(info), newState);
-    }
 
-    function updateDistributorTypeState(DistributorType distributorType, StateId newState) external restricted() {
-        updateState(distributorType.toKey32(), newState);
+    function upgradeInstanceReader()
+        external
+        restricted()
+        onlyOwner()
+    {
+        _instanceService.upgradeInstanceReader();
     }
 
-    //--- Distributor -------------------------------------------------------//
-    function createDistributor(NftId distributorNftId, IDistribution.DistributorInfo memory info) external restricted() {
-        create(_toNftKey32(distributorNftId, DISTRIBUTOR()), abi.encode(info));
-    }
 
-    function updateDistributor(NftId distributorNftId, IDistribution.DistributorInfo memory info, StateId newState) external restricted() {
-        update(_toNftKey32(distributorNftId, DISTRIBUTOR()), abi.encode(info), newState);
-    }
+    //--- ProductRegistration ----------------------------------------------//
 
-    function updateDistributorState(NftId distributorNftId, StateId newState) external restricted() {
-        updateState(_toNftKey32(distributorNftId, DISTRIBUTOR()), newState);
+    function registerProduct(address product, address token)
+        external
+        restricted()
+        onlyOwner()
+        returns (NftId productNftId)
+    {
+        productNftId = _componentService.registerProduct(product, token);
+        _products.push(productNftId);
     }
 
-    //--- Referral ----------------------------------------------------------//
-    function createReferral(ReferralId referralId, IDistribution.ReferralInfo memory referralInfo) external restricted() {
-        create(referralId.toKey32(), abi.encode(referralInfo));
-    }
+    //--- Staking ----------------------------------------------------------//
 
-    function updateReferral(ReferralId referralId, IDistribution.ReferralInfo memory referralInfo, StateId newState) external restricted() {
-        update(referralId.toKey32(), abi.encode(referralInfo), newState);
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod)
+        external
+        restricted()
+        onlyOwner()
+    {
+        _instanceService.setStakingLockingPeriod(stakeLockingPeriod);
     }
 
-    function updateReferralState(ReferralId referralId, StateId newState) external restricted() {
-        updateState(referralId.toKey32(), newState);
+    function setStakingRewardRate(UFixed rewardRate)
+        external
+        restricted()
+        onlyOwner()
+    {
+        _instanceService.setStakingRewardRate(rewardRate);
     }
 
-    //--- Bundle ------------------------------------------------------------//
-    function createBundle(NftId bundleNftId, IBundle.BundleInfo memory bundle) external restricted() {
-        create(_toNftKey32(bundleNftId, BUNDLE()), abi.encode(bundle));
+    function setStakingMaxAmount(Amount maxStakedAmount)
+        external
+        restricted()
+        onlyOwner()
+    {
+        _instanceService.setStakingMaxAmount(maxStakedAmount);
     }
 
-    function updateBundle(NftId bundleNftId, IBundle.BundleInfo memory bundle, StateId newState) external restricted() {
-        update(_toNftKey32(bundleNftId, BUNDLE()), abi.encode(bundle), newState);
+    function refillStakingRewardReserves(Amount dipAmount)
+        external
+        restricted()
+        onlyOwner()
+    {
+        address instanceOwner = msg.sender;
+        _instanceService.refillStakingRewardReserves(instanceOwner, dipAmount);
     }
 
-    function updateBundleState(NftId bundleNftId, StateId newState) external restricted() {
-        updateState(_toNftKey32(bundleNftId, BUNDLE()), newState);
+    function withdrawStakingRewardReserves(Amount dipAmount)
+        external
+        restricted()
+        onlyOwner()
+        returns (Amount newBalance)
+    {
+        return _instanceService.withdrawStakingRewardReserves(dipAmount);
     }
 
-    //--- Risk --------------------------------------------------------------//
-    function createRisk(RiskId riskId, IRisk.RiskInfo memory risk) external restricted() {
-        create(riskId.toKey32(), abi.encode(risk));
-    }
+    //--- Roles ------------------------------------------------------------//
 
-    function updateRisk(RiskId riskId, IRisk.RiskInfo memory risk, StateId newState) external restricted() {
-        update(riskId.toKey32(), abi.encode(risk), newState);
+    /// @inheritdoc IInstance
+    function createRole(
+        string memory roleName, 
+        RoleId adminRoleId,
+        uint32 maxMemberCount
+    )
+        external
+        restricted()
+        onlyOwner()
+        returns (RoleId roleId)
+    {
+        roleId = _instanceService.createRole(roleName, adminRoleId, maxMemberCount);
+        emit LogInstanceCustomRoleCreated(roleId, roleName, adminRoleId, maxMemberCount);
     }
 
-    function updateRiskState(RiskId riskId, StateId newState) external restricted() {
-        updateState(riskId.toKey32(), newState);
-    }
 
-    //--- Application (Policy) ----------------------------------------------//
-    function createApplication(NftId applicationNftId, IPolicy.PolicyInfo memory policy) external restricted() {
-        create(_toNftKey32(applicationNftId, POLICY()), abi.encode(policy));
+    /// @inheritdoc IInstance
+    function setRoleActive(RoleId roleId, bool active)
+        external 
+        restricted()
+        onlyCustomRoleAdmin(roleId)
+    {
+        _instanceService.setRoleActive(roleId, active);
+        emit LogInstanceCustomRoleActiveSet(roleId, active, msg.sender);
     }
 
-    function updateApplication(NftId applicationNftId, IPolicy.PolicyInfo memory policy, StateId newState) external restricted() {
-        update(_toNftKey32(applicationNftId, POLICY()), abi.encode(policy), newState);
-    }
 
-    function updateApplicationState(NftId applicationNftId, StateId newState) external restricted() {
-        updateState(_toNftKey32(applicationNftId, POLICY()), newState);
+    /// @inheritdoc IInstance
+    function grantRole(RoleId roleId, address account) 
+        external 
+        restricted()
+        onlyCustomRoleAdmin(roleId)
+    {
+        _instanceService.grantRole(roleId, account);
+        emit LogInstanceCustomRoleGranted(roleId, account, msg.sender);
     }
 
-    //--- Policy ------------------------------------------------------------//
-    function updatePolicy(NftId policyNftId, IPolicy.PolicyInfo memory policy, StateId newState) external restricted() {
-        update(_toNftKey32(policyNftId, POLICY()), abi.encode(policy), newState);
-    }
 
-    function updatePolicyState(NftId policyNftId, StateId newState) external restricted() {
-        updateState(_toNftKey32(policyNftId, POLICY()), newState);
+    /// @inheritdoc IInstance
+    function revokeRole(RoleId roleId, address account) 
+        external 
+        restricted()
+        onlyCustomRoleAdmin(roleId)
+    {
+        _instanceService.revokeRole(roleId, account);
+        emit LogInstanceCustomRoleRevoked(roleId, account, msg.sender);
     }
 
-    //--- Claim -------------------------------------------------------------//
-    function createClaim(NftId policyNftId, ClaimId claimId, IPolicy.ClaimInfo memory claim) external restricted() {
-        create(_toClaimKey32(policyNftId, claimId), abi.encode(claim));
-    }
+    //--- Targets ------------------------------------------------------------//
 
-    function updateClaim(NftId policyNftId, ClaimId claimId, IPolicy.ClaimInfo memory claim, StateId newState) external restricted() {
-        update(_toClaimKey32(policyNftId, claimId), abi.encode(claim), newState);
+    /// @inheritdoc IInstance
+    function createTarget(address target, string memory name) 
+        external 
+        restricted()
+        onlyOwner()
+        returns (RoleId targetRoleId)
+    {
+        targetRoleId = _instanceService.createTarget(target, name);
+        emit LogInstanceCustomTargetCreated(target, targetRoleId, name);
     }
 
-    function updateClaimState(NftId policyNftId, ClaimId claimId, StateId newState) external restricted() {
-        updateState(_toClaimKey32(policyNftId, claimId), newState);
-    }
 
-    //--- Payout ------------------------------------------------------------//
-    function createPayout(NftId policyNftId, PayoutId payoutId, IPolicy.PayoutInfo memory payout) external restricted() {
-        create(_toPayoutKey32(policyNftId, payoutId), abi.encode(payout));
+    /// @inheritdoc IInstance
+    function setTargetLocked(address target, bool locked)
+        external 
+        // not restricted(): instance owner may need to be able to unlock targets on an locked instance
+        onlyOwner()
+    {
+        _instanceService.setTargetLocked(target, locked);
+        emit LogInstanceTargetLocked(target, locked);
     }
 
-    function updatePayout(NftId policyNftId, PayoutId payoutId, IPolicy.PayoutInfo memory payout, StateId newState) external restricted() {
-        update(_toPayoutKey32(policyNftId, payoutId), abi.encode(payout), newState);
-    }
 
-    function updatePayoutState(NftId policyNftId, PayoutId payoutId, StateId newState) external restricted() {
-        updateState(_toPayoutKey32(policyNftId, payoutId), newState);
+    /// @inheritdoc IInstance
+    function authorizeFunctions(
+        address target, 
+        RoleId roleId, 
+        IAccess.FunctionInfo[] memory functions
+    )
+        external 
+        restricted()
+        onlyOwner()
+    {
+        _instanceService.authorizeFunctions(target, roleId, functions);
     }
 
-    //--- ITransferInterceptor ------------------------------------------------------------//
-    function nftMint(address to, uint256 tokenId) external onlyChainNft {
-        assert(_accessManager.roleMembers(INSTANCE_OWNER_ROLE()) == 0);// temp
-        assert(_accessManager.grantRole(INSTANCE_OWNER_ROLE(), to) == true);
-    }
 
-    function nftTransferFrom(address from, address to, uint256 tokenId) external onlyChainNft {
-        assert(_accessManager.revokeRole(INSTANCE_OWNER_ROLE(), from) == true);
-        assert(_accessManager.grantRole(INSTANCE_OWNER_ROLE(), to) == true);
+    /// @inheritdoc IInstance
+    function unauthorizeFunctions(
+        address target, 
+        IAccess.FunctionInfo[] memory functions
+    )
+        external 
+        restricted()
+        onlyOwner()
+    {
+        _instanceService.unauthorizeFunctions(target, functions);
     }
 
     //--- initial setup functions -------------------------------------------//
 
-    function setInstanceAccessManager(InstanceAccessManager accessManager) external restricted {
-        if(address(_accessManager) != address(0)) {
-            revert ErrorInstanceInstanceAccessManagerAlreadySet(address(_accessManager));
-        }
 
-        if(accessManager.authority() != authority()) {
-            revert ErrorInstanceInstanceAccessManagerAuthorityMismatch(authority());
+    function setInstanceReader(InstanceReader instanceReader)
+        external
+        restricted()
+    {
+        if(instanceReader.getInstance() != Instance(this)) {
+            revert ErrorInstanceInstanceReaderInstanceMismatch(address(this));
         }
 
-        _accessManager = accessManager;      
+        _instanceReader = instanceReader;
     }
 
-    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());
-        }
+    //--- external view functions -------------------------------------------//
 
-        _bundleManager = bundleManager;
+    function isInstanceLocked() external view returns (bool) {
+        return _instanceAdmin.isLocked();
     }
 
-    function setInstanceReader(InstanceReader instanceReader) external restricted() {
-        if(instanceReader.getInstance() != Instance(this)) {
-            revert ErrorInstanceInstanceReaderInstanceMismatch(address(this));
-        }
+    function isTargetLocked(address target) external view returns (bool) {
+        return _instanceAdmin.isTargetLocked(target);
+    }
 
-        _instanceReader = instanceReader;
+    function products() external view returns (uint256 productCount) {
+        return _products.length;
     }
 
-    //--- external view functions -------------------------------------------//
+    function getProductNftId(uint256 idx) external view returns (NftId productNftId) {
+        return _products[idx];
+    }
 
     function getInstanceReader() external view returns (InstanceReader) {
         return _instanceReader;
     }
 
-    function getBundleManager() external view returns (BundleManager) {
-        return _bundleManager;
-    }
-
-    function getInstanceAccessManager() external view returns (InstanceAccessManager) {
-        return _accessManager;
+    function getBundleSet() external view returns (BundleSet) {
+        return _bundleSet;
     }
 
-    function getMajorVersion() external pure returns (VersionPart majorVersion) {
-        return VersionPartLib.toVersionPart(GIF_MAJOR_VERSION);
+    function getRiskSet() external view returns (RiskSet) {
+        return _riskSet;
     }
 
-    //--- internal view/pure functions --------------------------------------//
-    function _toNftKey32(NftId nftId, ObjectType objectType) private pure returns (Key32) {
-        return nftId.toKey32(objectType);
+    function getInstanceAdmin() external view returns (InstanceAdmin) {
+        return _instanceAdmin;
     }
 
-    function _toClaimKey32(NftId policyNftId, ClaimId claimId) private pure returns (Key32) {
-        return claimId.toKey32(policyNftId);
+    function getInstanceStore() external view returns (InstanceStore) {
+        return _instanceStore;
     }
 
-    function _toPayoutKey32(NftId policyNftId, PayoutId payoutId) private pure returns (Key32) {
-        return payoutId.toKey32(policyNftId);
+    function isTokenRegistryDisabled() external view returns (bool) {
+        return _tokenRegistryDisabled;
     }
-}
+}