@etherisc/gif-next 0.0.2-7f39e38-904 → 0.0.2-7fe9ae1-227

package/contracts/instance/Instance.sol

@@ -1,170 +1,301 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.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 {VersionPart, VersionPartLib} from "../type/Version.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 {Registerable} from "../shared/Registerable.sol";
-import {TokenHandler} from "../shared/TokenHandler.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 {InstanceAdmin} from "./InstanceAdmin.sol";
 import {InstanceStore} from "./InstanceStore.sol";
-
-import {KeyValueStore} from "../shared/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 {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";
+import {NftId} from "../type/NftId.sol";
+import {ProductStore} from "./ProductStore.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
 {
-    uint256 public constant GIF_MAJOR_VERSION = 3;
-
     bool private _initialized;
 
-    InstanceAccessManager internal _accessManager;
+    IComponentService internal _componentService;
+    IInstanceService internal _instanceService;
+
+    InstanceAdmin internal _instanceAdmin;
     InstanceReader internal _instanceReader;
-    BundleManager internal _bundleManager;
+    BundleSet internal _bundleSet;
+    RiskSet internal _riskSet;
     InstanceStore internal _instanceStore;
+    ProductStore internal _productStore;
+    NftId [] internal _products;
+    bool internal _tokenRegistryDisabled;
+
 
-    modifier onlyChainNft() {
-        if(msg.sender != getRegistry().getChainNftAddress()) {
-            revert();
+    modifier onlyCustomRoleAdmin(RoleId roleId) {
+        if (!_instanceAdmin.isRoleCustom(roleId)) {
+            revert ErrorInstanceNotCustomRole(roleId);
+        }
+
+        // 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) 
+
+    function initialize(
+        InstanceContracts memory instanceContracts,
+        IRegistry registry, 
+        VersionPart release,
+        address initialOwner,
+        bool tokenRegistryDisabled // only disable for testing
+    ) 
         external 
         initializer()
     {
-        if(authority == address(0)) {
-            revert ErrorInstanceInstanceAccessManagerZero();
+        if(address(instanceContracts.instanceAdmin) == address(0)) {
+            revert ErrorInstanceInstanceAdminZero();
         }
 
-        __AccessManaged_init(authority);
-        
-        IRegistry registry = IRegistry(registryAddress);
-        initializeRegisterable(registryAddress, registry.getNftId(), INSTANCE(), true, initialOwner, "");
+        _instanceAdmin = instanceContracts.instanceAdmin;
+
+        // setup instance object info
+        __Registerable_init({
+            authority: instanceContracts.instanceAdmin.authority(),
+            registry: address(registry), 
+            parentNftId: registry.getNftId(), 
+            objectType: INSTANCE(), 
+            isInterceptor: false, 
+            initialOwner: initialOwner, 
+            data: ""});
+
+        // store instance supporting contracts
+        _instanceStore = instanceContracts.instanceStore;
+        _productStore = instanceContracts.productStore;
+        _bundleSet = instanceContracts.bundleSet;
+        _riskSet = instanceContracts.riskSet;
+        _instanceReader = instanceContracts.instanceReader;
+
+        // initialize instance supporting contracts
+        _instanceStore.initialize();
+        _productStore.initialize();
+        _bundleSet.initialize(instanceContracts.instanceAdmin.authority(), address(registry));
+        _riskSet.initialize(instanceContracts.instanceAdmin.authority(), address(registry));
+        _instanceReader.initialize();
+
+        _componentService = IComponentService(
+            getRegistry().getServiceAddress(
+                COMPONENT(), 
+                release));
+
+        _instanceService = IInstanceService(
+            getRegistry().getServiceAddress(
+                INSTANCE(), 
+                release));
+
+        _tokenRegistryDisabled = tokenRegistryDisabled;
+
+        _registerInterface(type(IInstance).interfaceId);    
+    }
+
+
+    function setInstanceLocked(bool locked)
+        external 
+        // not restricted(): need to be able to unlock a locked instance
+        onlyOwner()
+    {
+        _instanceService.setInstanceLocked(locked);
+    }
+
+
+    function upgradeInstanceReader()
+        external
+        restricted()
+        onlyOwner()
+    {
+        _instanceService.upgradeInstanceReader();
+    }
+
+
+    //--- ProductRegistration ----------------------------------------------//
 
-        registerInterface(type(IInstance).interfaceId);    
+    function registerProduct(address product, address token)
+        external
+        restricted()
+        onlyOwner()
+        returns (NftId productNftId)
+    {
+        productNftId = _componentService.registerProduct(product, token);
+        _products.push(productNftId);
+    }
+
+    //--- Staking ----------------------------------------------------------//
+
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod)
+        external
+        restricted()
+        onlyOwner()
+    {
+        _instanceService.setStakingLockingPeriod(stakeLockingPeriod);
+    }
+
+    function setStakingRewardRate(UFixed rewardRate)
+        external
+        restricted()
+        onlyOwner()
+    {
+        _instanceService.setStakingRewardRate(rewardRate);
+    }
+
+    function setStakingMaxAmount(Amount maxStakedAmount)
+        external
+        restricted()
+        onlyOwner()
+    {
+        _instanceService.setStakingMaxAmount(maxStakedAmount);
+    }
+
+    function refillStakingRewardReserves(Amount dipAmount)
+        external
+        restricted()
+        onlyOwner()
+        returns (Amount newRewardReserveBalance)
+    {
+        address instanceOwner = msg.sender;
+        return _instanceService.refillInstanceRewardReserves(instanceOwner, dipAmount);
+    }
+
+    function withdrawStakingRewardReserves(Amount dipAmount)
+        external
+        restricted()
+        onlyOwner()
+        returns (Amount newRewardReserveBalance)
+    {
+        return _instanceService.withdrawInstanceRewardReserves(dipAmount);
     }
 
     //--- Roles ------------------------------------------------------------//
 
-    function createRole(string memory roleName, string memory adminName)
+    /// @inheritdoc IInstance
+    function createRole(
+        string memory roleName, 
+        RoleId adminRoleId,
+        uint32 maxMemberCount
+    )
         external
-        restricted // INSTANCE_OWNER_ROLE
-        returns (RoleId roleId, RoleId admin)
+        restricted()
+        onlyOwner()
+        returns (RoleId roleId)
     {
-        (roleId, admin) = _accessManager.createRole(roleName, adminName);
+        roleId = _instanceService.createRole(roleName, adminRoleId, maxMemberCount);
+        emit LogInstanceCustomRoleCreated(roleId, roleName, adminRoleId, maxMemberCount);
     }
 
+
+    /// @inheritdoc IInstance
+    function setRoleActive(RoleId roleId, bool active)
+        external 
+        restricted()
+        onlyCustomRoleAdmin(roleId)
+    {
+        _instanceService.setRoleActive(roleId, active);
+        emit LogInstanceCustomRoleActiveSet(roleId, active, msg.sender);
+    }
+
+
+    /// @inheritdoc IInstance
     function grantRole(RoleId roleId, address account) 
         external 
-        restricted // INSTANCE_OWNER_ROLE
+        restricted()
+        onlyCustomRoleAdmin(roleId)
     {
-        _accessManager.grantRole(roleId, account);
+        _instanceService.grantRole(roleId, account);
+        emit LogInstanceCustomRoleGranted(roleId, account, msg.sender);
     }
 
+
+    /// @inheritdoc IInstance
     function revokeRole(RoleId roleId, address account) 
         external 
-        restricted // INSTANCE_OWNER_ROLE
+        restricted()
+        onlyCustomRoleAdmin(roleId)
     {
-        _accessManager.revokeRole(roleId, account);
+        _instanceService.revokeRole(roleId, account);
+        emit LogInstanceCustomRoleRevoked(roleId, account, msg.sender);
     }
 
     //--- Targets ------------------------------------------------------------//
 
+    /// @inheritdoc IInstance
     function createTarget(address target, string memory name) 
         external 
-        restricted // INSTANCE_OWNER_ROLE
+        restricted()
+        onlyOwner()
+        returns (RoleId targetRoleId)
     {
-        _accessManager.createTarget(target, name);
+        targetRoleId = _instanceService.createTarget(target, name);
+        emit LogInstanceCustomTargetCreated(target, targetRoleId, name);
     }
 
-    function setTargetFunctionRole(
-        string memory targetName,
-        bytes4[] calldata selectors,
-        RoleId roleId
-    ) 
-        external 
-        restricted // INSTANCE_OWNER_ROLE
-    {
-        _accessManager.setTargetFunctionRole(targetName, selectors, roleId);
-    }
 
+    /// @inheritdoc IInstance
     function setTargetLocked(address target, bool locked)
         external 
-        restricted // INSTANCE_OWNER_ROLE
+        // not restricted(): instance owner may need to be able to unlock targets on an locked instance
+        onlyOwner()
     {
-        _accessManager.setTargetLockedByInstance(target, locked);
+        _instanceService.setTargetLocked(target, locked);
+        emit LogInstanceTargetLocked(target, locked);
     }
 
-    //--- 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);
+    /// @inheritdoc IInstance
+    function authorizeFunctions(
+        address target, 
+        RoleId roleId, 
+        IAccess.FunctionInfo[] memory functions
+    )
+        external 
+        restricted()
+        onlyOwner()
+    {
+        _instanceService.authorizeFunctions(target, roleId, functions);
     }
 
-    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());
-        }
-        _accessManager = accessManager;      
-    }
-    
-    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 setInstanceReader(InstanceReader instanceReader) external restricted() {
+    function setInstanceReader(InstanceReader instanceReader)
+        external
+        restricted()
+    {
         if(instanceReader.getInstance() != Instance(this)) {
             revert ErrorInstanceInstanceReaderInstanceMismatch(address(this));
         }
@@ -174,55 +305,47 @@ contract Instance is
 
     //--- external view functions -------------------------------------------//
 
-    function getInstanceReader() external view returns (InstanceReader) {
-        return _instanceReader;
+    function isInstanceLocked() external view returns (bool) {
+        return _instanceAdmin.isLocked();
     }
 
-    function getBundleManager() external view returns (BundleManager) {
-        return _bundleManager;
+    function isTargetLocked(address target) external view returns (bool) {
+        return _instanceAdmin.isTargetLocked(target);
     }
 
-    function getInstanceAccessManager() external view returns (InstanceAccessManager) {
-        return _accessManager;
+    function products() external view returns (uint256 productCount) {
+        return _products.length;
     }
 
-    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 getProductNftId(uint256 idx) external view returns (NftId productNftId) {
+        return _products[idx];
     }
 
-    function getInstanceStore() external view returns (InstanceStore) {
-        return _instanceStore;
+    function getInstanceReader() external view returns (InstanceReader) {
+        return _instanceReader;
     }
 
-    function getMajorVersion() external pure returns (VersionPart majorVersion) {
-        return VersionPartLib.toVersionPart(GIF_MAJOR_VERSION);
+    function getBundleSet() external view returns (BundleSet) {
+        return _bundleSet;
     }
 
-    function getDistributionService() external view returns (IDistributionService) {
-        return IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), VersionPart.wrap(3)));
+    function getRiskSet() external view returns (RiskSet) {
+        return _riskSet;
     }
 
-    function getProductService() external view returns (IProductService) {
-        return IProductService(getRegistry().getServiceAddress(PRODUCT(), VersionPart.wrap(3)));
+    function getInstanceAdmin() external view returns (InstanceAdmin) {
+        return _instanceAdmin;
     }
 
-    function getPoolService() external view returns (IPoolService) {
-        return IPoolService(getRegistry().getServiceAddress(POOL(), VersionPart.wrap(3)));
+    function getInstanceStore() external view returns (InstanceStore) {
+        return _instanceStore;
     }
 
-    function getPolicyService() external view returns (IPolicyService) {
-        return IPolicyService(getRegistry().getServiceAddress(POLICY(), VersionPart.wrap(3)));
+    function getProductStore() external view returns (ProductStore) {
+        return _productStore;
     }
 
-    function getBundleService() external view returns (IBundleService) {
-        return IBundleService(getRegistry().getServiceAddress(BUNDLE(), VersionPart.wrap(3)));
+    function isTokenRegistryDisabled() external view returns (bool) {
+        return _tokenRegistryDisabled;
     }
-
-    //--- internal view/pure functions --------------------------------------//
 }