@etherisc/gif-next 0.0.2-e9a637d-547 → 0.0.2-ea09fbf-195

package/contracts/instance/Instance.sol

@@ -1,53 +1,35 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
-
-import {NftId} from "../types/NftId.sol";
-import {ObjectType, BUNDLE, DISTRIBUTION, INSTANCE, POLICY, POOL, ROLE, PRODUCT, TARGET, COMPONENT, DISTRIBUTOR, DISTRIBUTOR_TYPE} from "../types/ObjectType.sol";
-import {RoleId, RoleIdLib, eqRoleId, ADMIN_ROLE, INSTANCE_ROLE, INSTANCE_OWNER_ROLE} from "../types/RoleId.sol";
-import {VersionPart, VersionPartLib} from "../types/Version.sol";
-
-import {ERC165} from "../shared/ERC165.sol";
-import {Registerable} from "../shared/Registerable.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
-
-import {IRegistry} from "../registry/IRegistry.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 {IInstance} from "./IInstance.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
+import {IInstanceService} from "./IInstanceService.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 "./base/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 {IRegistry} from "../registry/IRegistry.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";
 
 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;
 
     modifier onlyChainNft() {
@@ -57,49 +39,134 @@ contract Instance is
         _;
     }
 
-    function initialize(address authority, address registryAddress, address initialOwner) 
+    function initialize(
+        InstanceAdmin instanceAdmin, 
+        InstanceStore instanceStore,
+        BundleSet bundleSet,
+        RiskSet riskSet,
+        InstanceReader instanceReader,
+        IRegistry registry, 
+        address initialOwner
+    ) 
         external 
         initializer()
     {
-        __AccessManaged_init(authority);
-        
-        IRegistry registry = IRegistry(registryAddress);
-        initializeRegisterable(registryAddress, registry.getNftId(), INSTANCE(), true, initialOwner, "");
+        if(address(instanceAdmin) == address(0)) {
+            revert ErrorInstanceInstanceAdminZero();
+        }
+
+        _instanceAdmin = instanceAdmin;
 
-        registerInterface(type(IInstance).interfaceId);    
+        // setup instance object info
+        __Registerable_init(
+            instanceAdmin.authority(),
+            address(registry), 
+            registry.getNftId(), 
+            INSTANCE(), 
+            true, 
+            initialOwner, 
+            "");
+
+        // store instance supporting contracts
+        _instanceStore = instanceStore;
+        _bundleSet = bundleSet;
+        _riskSet = riskSet;
+        _instanceReader = instanceReader;
+
+        // initialize instance supporting contracts
+        _instanceStore.initialize();
+        _bundleSet.initialize(instanceAdmin.authority(), address(registry));
+        _riskSet.initialize(instanceAdmin.authority(), address(registry));
+        _instanceReader.initialize();
+
+        _componentService = IComponentService(
+            getRegistry().getServiceAddress(
+                COMPONENT(), 
+                getRelease()));
+
+        _instanceService = IInstanceService(
+            getRegistry().getServiceAddress(
+                INSTANCE(), 
+                getRelease()));
+
+        _registerInterface(type(IInstance).interfaceId);    
+    }
+
+    //--- ProductRegistration ----------------------------------------------//
+    function registerProduct(address product)
+        external
+        onlyOwner()
+        returns (NftId productNftId)
+    {
+        return _componentService.registerProduct(product);
+    }
+
+    //--- Staking ----------------------------------------------------------//
+
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod)
+        external
+        onlyOwner()
+    {
+        _instanceService.setStakingLockingPeriod(stakeLockingPeriod);
+    }
+
+    function setStakingRewardRate(UFixed rewardRate)
+        external
+        onlyOwner()
+    {
+        _instanceService.setStakingRewardRate(rewardRate);
+    }
+
+    function refillStakingRewardReserves(Amount dipAmount)
+        external
+        onlyOwner()
+    {
+        address instanceOwner = msg.sender;
+        _instanceService.refillStakingRewardReserves(instanceOwner, dipAmount);
+    }
+
+    function withdrawStakingRewardReserves(Amount dipAmount)
+        external
+        onlyOwner()
+        returns (Amount newBalance)
+    {
+        return _instanceService.withdrawStakingRewardReserves(dipAmount);
     }
 
     //--- Roles ------------------------------------------------------------//
 
     function createRole(string memory roleName, string memory adminName)
         external
-        restricted // INSTANCE_OWNER_ROLE
+        onlyOwner()
         returns (RoleId roleId, RoleId admin)
     {
-        (roleId, admin) = _accessManager.createRole(roleName, adminName);
+        // TODO refactor
+        // (roleId, admin) = _instanceAdmin.createRole(roleName, adminName);
     }
 
     function grantRole(RoleId roleId, address account) 
         external 
-        restricted // INSTANCE_OWNER_ROLE
+        onlyOwner()
     {
-        _accessManager.grantRole(roleId, account);
+        _instanceAdmin.grantRole(roleId, account);
     }
 
     function revokeRole(RoleId roleId, address account) 
         external 
-        restricted // INSTANCE_OWNER_ROLE
+        onlyOwner()
     {
-        _accessManager.revokeRole(roleId, account);
+        // TODO refactor
+        // AccessManagerExtendedInitializeable(authority()).revokeRole(roleId.toInt(), account);
     }
 
     //--- Targets ------------------------------------------------------------//
 
     function createTarget(address target, string memory name) 
         external 
-        restricted // INSTANCE_OWNER_ROLE
+        onlyOwner()
     {
-        _accessManager.createTarget(target, name);
+        // TODO refactor
+        // _instanceAdmin.createTarget(target, name);
     }
 
     function setTargetFunctionRole(
@@ -108,87 +175,56 @@ contract Instance is
         RoleId roleId
     ) 
         external 
-        restricted // INSTANCE_OWNER_ROLE
+        onlyOwner()
     {
-        _accessManager.setTargetFunctionRole(targetName, selectors, roleId);
+        // TODO refactor
+        // _instanceAdmin.setTargetFunctionRoleByInstance(targetName, selectors, roleId);
     }
 
-    function setTargetLocked(address target, bool locked)
+    function setLocked(address target, bool locked)
         external 
-        restricted // INSTANCE_OWNER_ROLE
+        onlyOwner()
     {
-        _accessManager.setTargetLockedByInstance(target, locked);
+        _componentService.setLockedFromInstance(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);
-    }
+    //--- ITransferInterceptor ----------------------------------------------//
 
-    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);
+    function nftTransferFrom(address from, address to, uint256 tokenId, address operator) external onlyChainNft {
+        // TODO refactor
+        // _instanceAdmin.transferInstanceOwnerRole(from, to);
     }
 
-    function getDistributionService() external view returns (IDistributionService) {
-        return IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), VersionPart.wrap(3)));
-    }
+    //--- initial setup functions -------------------------------------------//
 
-    function getProductService() external view returns (IProductService) {
-        return IProductService(getRegistry().getServiceAddress(PRODUCT(), VersionPart.wrap(3)));
-    }
-
-    function getPoolService() external view returns (IPoolService) {
-        return IPoolService(getRegistry().getServiceAddress(POOL(), VersionPart.wrap(3)));
-    }
 
-    function getPolicyService() external view returns (IPolicyService) {
-        return IPolicyService(getRegistry().getServiceAddress(POLICY(), VersionPart.wrap(3)));
-    }
-
-    function getBundleService() external view returns (IBundleService) {
-        return IBundleService(getRegistry().getServiceAddress(BUNDLE(), VersionPart.wrap(3)));
-    }
+    function setInstanceReader(InstanceReader instanceReader)
+        external
+        restricted()
+    {
+        if(instanceReader.getInstance() != Instance(this)) {
+            revert ErrorInstanceInstanceReaderInstanceMismatch(address(this));
+        }
 
-    function setInstanceReader(InstanceReader instanceReader) external restricted() {
-        require(instanceReader.getInstance() == Instance(this), "InstanceReader instance mismatch");
         _instanceReader = instanceReader;
     }
 
-    function getMajorVersion() external pure returns (VersionPart majorVersion) {
-        return VersionPartLib.toVersionPart(GIF_MAJOR_VERSION);
-    }
+    //--- external view functions -------------------------------------------//
 
     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");
-        require(bundleManager.authority() == authority(), "BundleManager authority mismatch");
-        _bundleManager = bundleManager;
-    }
 
-    function getBundleManager() external view returns (BundleManager) {
-        return _bundleManager;
+    function getBundleSet() external view returns (BundleSet) {
+        return _bundleSet;
     }
 
-    function setInstanceAccessManager(InstanceAccessManager accessManager) external restricted {
-        require(address(_accessManager) == address(0), "InstanceAccessManager is set");
-        require(accessManager.authority() == authority(), "InstanceAccessManager authority mismatch");  
-        _accessManager = accessManager;      
+    function getRiskSet() external view returns (RiskSet) {
+        return _riskSet;
     }
 
-    function getInstanceAccessManager() external view returns (InstanceAccessManager) {
-        return _accessManager;
-    }
-
-    function setInstanceStore(InstanceStore instanceStore) external restricted {
-        require(address(_instanceStore) == address(0), "InstanceStore is set");
-        require(instanceStore.authority() == authority(), "InstanceStore authority mismatch");  
-        _instanceStore = instanceStore;
+    function getInstanceAdmin() external view returns (InstanceAdmin) {
+        return _instanceAdmin;
     }
 
     function getInstanceStore() external view returns (InstanceStore) {

package/contracts/instance/InstanceAdmin.sol

@@ -0,0 +1,326 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+
+import {AccessAdmin} from "../authorization/AccessAdmin.sol";
+import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IInstance} from "./IInstance.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {RoleId, RoleIdLib} from "../type/RoleId.sol";
+import {Str, StrLib} from "../type/String.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
+import {VersionPart, VersionPartLib} from "../type/Version.sol";
+
+
+contract InstanceAdmin is
+    AccessAdmin
+{
+    string public constant INSTANCE_TARGET_NAME = "Instance";
+    string public constant INSTANCE_STORE_TARGET_NAME = "InstanceStore";
+    string public constant INSTANCE_ADMIN_TARGET_NAME = "InstanceAdmin";
+    string public constant BUNDLE_SET_TARGET_NAME = "BundleSet";
+    string public constant RISK_SET_TAGET_NAME = "RiskSet";
+
+    uint64 public constant CUSTOM_ROLE_ID_MIN = 10000; // MUST be even
+
+    error ErrorInstanceAdminCallerNotInstanceOwner(address caller);
+    error ErrorInstanceAdminInstanceAlreadyLocked();
+    error ErrorInstanceAdminNotRegistered(address target);
+    error ErrorInstanceAdminAlreadyAuthorized(address target);
+    error ErrorInstanceAdminReleaseMismatch();
+    error ErrorInstanceAdminExpectedTargetMissing(string targetName);
+
+    IInstance internal _instance;
+    IRegistry internal _registry;
+    uint64 internal _idNext;
+
+    IAuthorization internal _instanceAuthorization;
+
+
+    modifier onlyInstanceOwner() {        
+        if(msg.sender != _registry.ownerOf(address(_instance))) {
+            revert ErrorInstanceAdminCallerNotInstanceOwner(msg.sender);
+        }
+        _;
+    }
+
+    /// @dev Only used for master instance admin.
+    /// Contracts created via constructor come with disabled initializers.
+    constructor(
+        address instanceAuthorization
+    ) {
+        initialize(new AccessManagerCloneable());
+
+        _instanceAuthorization = IAuthorization(instanceAuthorization);
+
+        _disableInitializers();
+    }
+
+
+    function initialize(
+        AccessManagerCloneable clonedAccessManager,
+        IRegistry registry,
+        VersionPart release
+    )
+        external
+        initializer()
+    {
+        __AccessAdmin_init(clonedAccessManager);
+
+        clonedAccessManager.completeSetup(
+            address(registry), 
+            release); 
+
+        _registry = registry;
+    }
+
+
+    /// @dev Completes the initialization of this instance admin using the provided instance, registry and version.
+    /// Important: Initialization of instance admin is only complete after calling this function. 
+    /// Important: The instance MUST be registered and all instance supporting contracts must be wired to this instance.
+    function completeSetup(
+        address instance,
+        address authorization
+    )
+        external
+        reinitializer(uint64(getRelease().toInt()))
+        onlyDeployer()
+    {
+        _idNext = CUSTOM_ROLE_ID_MIN;
+        _instance = IInstance(instance);
+        _instanceAuthorization = IAuthorization(authorization);
+
+        // AccessManagerCloneable accessManager = AccessManagerCloneable(authority());
+        // accessManager.completeSetup(
+        //     address(_registry), 
+        //     release); 
+
+        _checkTargetIsReadyForAuthorization(instance);
+
+        // check matching releases
+        if (_instanceAuthorization.getRelease() != getRelease()) {
+            revert ErrorInstanceAdminReleaseMismatch();
+        }
+
+        // add instance authorization
+        _createRoles(_instanceAuthorization);
+        _createModuleTargetsWithRoles();
+        _createTargetAuthorizations(_instanceAuthorization);
+    }
+
+
+    /// @dev Initializes the authorization for the specified component.
+    /// Important: The component MUST be registered.
+    function initializeComponentAuthorization(
+        IInstanceLinkedComponent component
+    )
+        external
+    {
+        // !!! TODO add caller restrictions?
+
+        _checkTargetIsReadyForAuthorization(address(component));
+
+        // get authorization specification
+        IAuthorization authorization = component.getAuthorization();
+        string memory targetName = authorization.getTargetName();
+        _checkTargetIsReadyForAuthorization(address(component));
+
+
+        // create roles
+        _createRoles(authorization);
+
+        // create component target
+        _createTarget(
+            address(component), 
+            targetName, 
+            true, // checkAuthority
+            false); // custom
+
+        _createTarget(
+            address(component.getTokenHandler()), 
+            string(abi.encodePacked(targetName, "TH")), 
+            true, 
+            false);
+        
+        FunctionInfo[] memory functions = new FunctionInfo[](3);
+        functions[0] = toFunction(TokenHandler.collectTokens.selector, "collectTokens");
+        functions[1] = toFunction(TokenHandler.collectTokensToThreeRecipients.selector, "collectTokensToThreeRecipients");
+        functions[2] = toFunction(TokenHandler.distributeTokens.selector, "distributeTokens");
+
+        // FIXME: make this a bit nicer and work with IAuthorization. Use a specific role, not public - access to TokenHandler must be restricted
+        _authorizeTargetFunctions(
+            address(component.getTokenHandler()),
+            getPublicRole(),
+            functions);
+
+        _grantRoleToAccount(
+            authorization.getTargetRole(
+                authorization.getMainTarget()), 
+            address(component));
+        
+        _createTargetAuthorizations(authorization);
+    }
+
+    /// @dev Creates a custom role
+    // TODO implement
+    // function createRole()
+    //     external
+    //     restricted()
+    // {
+
+    // }
+
+    /// @dev Grants the provided role to the specified account
+    function grantRole(
+        RoleId roleId, 
+        address account)
+        external
+        restricted()
+    {
+        _grantRoleToAccount(roleId, account);
+    }
+
+
+    function setInstanceLocked(bool locked)
+        external
+        onlyInstanceOwner()
+    {
+        AccessManagerCloneable accessManager = AccessManagerCloneable(authority());
+
+        if(accessManager.isLocked() == locked) {
+            revert ErrorInstanceAdminInstanceAlreadyLocked();
+        }
+        accessManager.setLocked(locked);
+    }
+
+    function setTargetLocked(address target, bool locked) 
+        external 
+        restricted()
+    {
+        _setTargetClosed(target, locked);
+    }
+
+
+
+    /// @dev Returns the instance authorization specification used to set up this instance admin.
+    function getInstanceAuthorization()
+        external
+        view
+        returns (IAuthorization instanceAuthorizaion)
+    {
+        return _instanceAuthorization;
+    }
+
+    // ------------------- Internal functions ------------------- //
+
+    function _checkTargetIsReadyForAuthorization(address target)
+        internal
+        view
+    {
+        if (!_registry.isRegistered(target)) {
+            revert ErrorInstanceAdminNotRegistered(target);
+        }
+
+        if (targetExists(target)) {
+            revert ErrorInstanceAdminAlreadyAuthorized(target);
+        }
+    }
+
+
+    function _createRoles(IAuthorization authorization)
+        internal
+    {
+        RoleId[] memory roles = authorization.getRoles();
+        RoleId roleId;
+        RoleInfo memory roleInfo;
+
+        for(uint256 i = 0; i < roles.length; i++) {
+            roleId = roles[i];
+
+            if (!roleExists(roleId)) {
+                _createRole(
+                    roleId,
+                    authorization.getRoleInfo(roleId));
+            }
+        }
+    }
+
+
+    function _createTargetAuthorizations(IAuthorization authorization)
+        internal
+    {
+        Str[] memory targets = authorization.getTargets();
+        Str target;
+
+        for(uint256 i = 0; i < targets.length; i++) {
+            target = targets[i];
+            RoleId[] memory authorizedRoles = authorization.getAuthorizedRoles(target);
+            RoleId authorizedRole;
+
+            for(uint256 j = 0; j < authorizedRoles.length; j++) {
+                authorizedRole = authorizedRoles[j];
+
+                _authorizeTargetFunctions(
+                    getTargetForName(target),
+                    authorizedRole,
+                    authorization.getAuthorizedFunctions(
+                        target, 
+                        authorizedRole));
+            }
+        }
+    }
+
+    function _checkAndCreateTargetWithRole(
+        address target,
+        string memory targetName
+    )
+        internal
+    {
+        // check that target name is defined in authorization specification
+        Str name = StrLib.toStr(targetName);
+        if (!_instanceAuthorization.targetExists(name)) {
+            revert ErrorInstanceAdminExpectedTargetMissing(targetName);
+        }
+
+        // create named target
+        _createTarget(
+            target, 
+            targetName, 
+            false, // check authority TODO check normal targets, don't check service targets (they share authority with release admin)
+            false);
+
+        // assign target role if defined
+        RoleId targetRoleId = _instanceAuthorization.getTargetRole(name);
+        if (targetRoleId != RoleIdLib.zero()) {
+            _grantRoleToAccount(targetRoleId, target);
+        }
+    }
+
+    function _createModuleTargetsWithRoles()
+        internal
+    {
+        // create module targets
+        _checkAndCreateTargetWithRole(address(_instance), INSTANCE_TARGET_NAME);
+        _checkAndCreateTargetWithRole(address(_instance.getInstanceStore()), INSTANCE_STORE_TARGET_NAME);
+        _checkAndCreateTargetWithRole(address(_instance.getInstanceAdmin()), INSTANCE_ADMIN_TARGET_NAME);
+        _checkAndCreateTargetWithRole(address(_instance.getBundleSet()), BUNDLE_SET_TARGET_NAME);
+        _checkAndCreateTargetWithRole(address(_instance.getRiskSet()), RISK_SET_TAGET_NAME);
+
+        // create targets for services that need to access the module targets
+        ObjectType[] memory serviceDomains = _instanceAuthorization.getServiceDomains();
+        VersionPart release = _instanceAuthorization.getRelease();
+        ObjectType serviceDomain;
+
+        for (uint256 i = 0; i < serviceDomains.length; i++) {
+            serviceDomain = serviceDomains[i];
+
+            _checkAndCreateTargetWithRole(
+                _registry.getServiceAddress(serviceDomain, release),
+                _instanceAuthorization.getServiceTarget(serviceDomain).toString());
+        }
+    }
+}