@etherisc/gif-next 0.0.2-de7c770-422 → 0.0.2-deb924b-641

package/contracts/instance/Instance.sol

@@ -1,37 +1,38 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.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 {InstanceAdmin} from "./InstanceAdmin.sol";
 import {InstanceStore} from "./InstanceStore.sol";
-import {INSTANCE} from "../type/ObjectType.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";
-import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
 contract Instance is
     IInstance,
-    AccessManagedUpgradeable,
     Registerable
 {
-    uint256 public constant GIF_MAJOR_VERSION = 3;
-
     bool private _initialized;
 
+    IComponentService internal _componentService;
     IInstanceService internal _instanceService;
+
     InstanceAdmin internal _instanceAdmin;
     InstanceReader internal _instanceReader;
-    BundleSet internal _bundleManager;
+    BundleSet internal _bundleSet;
+    RiskSet internal _riskSet;
     InstanceStore internal _instanceStore;
+    NftId [] internal _products;
 
     modifier onlyChainNft() {
         if(msg.sender != getRegistry().getChainNftAddress()) {
@@ -43,7 +44,8 @@ contract Instance is
     function initialize(
         InstanceAdmin instanceAdmin, 
         InstanceStore instanceStore,
-        BundleSet bundleManager,
+        BundleSet bundleSet,
+        RiskSet riskSet,
         InstanceReader instanceReader,
         IRegistry registry, 
         address initialOwner
@@ -51,17 +53,15 @@ contract Instance is
         external 
         initializer()
     {
-        _instanceAdmin = instanceAdmin;
-        if(_instanceAdmin.authority() == address(0)) {
-            // TODO rename error
+        if(address(instanceAdmin) == address(0)) {
             revert ErrorInstanceInstanceAdminZero();
         }
 
-        // set authority to instance admin authority
-        __AccessManaged_init(_instanceAdmin.authority());
+        _instanceAdmin = instanceAdmin;
 
         // setup instance object info
-        _initializeRegisterable(
+        __Registerable_init(
+            instanceAdmin.authority(),
             address(registry), 
             registry.getNftId(), 
             INSTANCE(), 
@@ -71,27 +71,44 @@ contract Instance is
 
         // store instance supporting contracts
         _instanceStore = instanceStore;
-        _bundleManager = bundleManager;
+        _bundleSet = bundleSet;
+        _riskSet = riskSet;
         _instanceReader = instanceReader;
 
         // initialize instance supporting contracts
         _instanceStore.initialize();
-        _bundleManager.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(), 
-                getMajorVersion()));
+                getRelease()));
 
         _registerInterface(type(IInstance).interfaceId);    
     }
 
+    //--- ProductRegistration ----------------------------------------------//
+
+    function registerProduct(address product)
+        external
+        onlyOwner()
+        returns (NftId productNftId)
+    {
+        productNftId = _componentService.registerProduct(product);
+        _products.push(productNftId);
+    }
+
     //--- Staking ----------------------------------------------------------//
 
     function setStakingLockingPeriod(Seconds stakeLockingPeriod)
         external
-        // TODO decide if onlyOwner or restricted to instance owner role is better
         onlyOwner()
     {
         _instanceService.setStakingLockingPeriod(stakeLockingPeriod);
@@ -168,23 +185,16 @@ contract Instance is
         // _instanceAdmin.setTargetFunctionRoleByInstance(targetName, selectors, roleId);
     }
 
-    function setTargetLocked(address target, bool locked)
+    function setLocked(address target, bool locked)
         external 
         onlyOwner()
     {
-        // TODO refactor
-        // _instanceAdmin.setTargetLockedByInstance(target, locked);
+        _componentService.setLockedFromInstance(target, locked);
     }
 
     //--- ITransferInterceptor ----------------------------------------------//
 
-    // TODO interception of child components nfts
-    function nftMint(address to, uint256 tokenId) external onlyChainNft {
-        // TODO refactor
-        // _instanceAdmin.transferInstanceOwnerRole(address(0), to);
-    }
-
-    function nftTransferFrom(address from, address to, uint256 tokenId) external onlyChainNft {
+    function nftTransferFrom(address from, address to, uint256 tokenId, address operator) external onlyChainNft {
         // TODO refactor
         // _instanceAdmin.transferInstanceOwnerRole(from, to);
     }
@@ -205,12 +215,24 @@ contract Instance is
 
     //--- external view functions -------------------------------------------//
 
+    function products() external view returns (uint256 productCount) {
+        return _products.length;
+    }
+
+    function getProductNftId(uint256 idx) external view returns (NftId productNftId) {
+        return _products[idx];
+    }
+
     function getInstanceReader() external view returns (InstanceReader) {
         return _instanceReader;
     }
 
     function getBundleSet() external view returns (BundleSet) {
-        return _bundleManager;
+        return _bundleSet;
+    }
+
+    function getRiskSet() external view returns (RiskSet) {
+        return _riskSet;
     }
 
     function getInstanceAdmin() external view returns (InstanceAdmin) {
@@ -221,9 +243,5 @@ contract Instance is
         return _instanceStore;
     }
 
-    function getMajorVersion() public pure returns (VersionPart majorVersion) {
-        return VersionPartLib.toVersionPart(GIF_MAJOR_VERSION);
-    }
-
     //--- internal view/pure functions --------------------------------------//
 }

package/contracts/instance/InstanceAdmin.sol

@@ -1,22 +1,20 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.20;
 
-import {AccessManager} from "@openzeppelin/contracts/access/manager/AccessManager.sol";
-
-import {AccessAdmin} from "../authorization/AccessAdmin.sol";
-import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
-import {IAccessAdmin} from "../authorization/IAccessAdmin.sol";
+import {IAccess} from "../authorization/IAccess.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
-import {IComponent} from "../shared/IComponent.sol";
-import {IModuleAuthorization} from "../authorization/IModuleAuthorization.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IInstance} from "./IInstance.sol";
-import {IService} from "../shared/IService.sol";
-import {ObjectType, ObjectTypeLib, ALL, POOL, RELEASE} from "../type/ObjectType.sol";
-import {RoleId, RoleIdLib, ADMIN_ROLE, PUBLIC_ROLE, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE} from "../type/RoleId.sol";
+
+import {AccessAdmin} from "../authorization/AccessAdmin.sol";
+import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
+import {NftId} from "../type/NftId.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} from "../type/Version.sol";
+import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
 
 contract InstanceAdmin is
@@ -26,143 +24,144 @@ contract InstanceAdmin is
     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 ErrorInstanceAdminNotComponentRole(RoleId roleId);
+    error ErrorInstanceAdminRoleAlreadyExists(RoleId roleId);
+    error ErrorInstanceAdminRoleTypeNotContract(RoleId roleId, IAccess.RoleType roleType);
+
     error ErrorInstanceAdminReleaseMismatch();
     error ErrorInstanceAdminExpectedTargetMissing(string targetName);
 
-    IInstance _instance;
+    IInstance internal _instance;
     IRegistry internal _registry;
-    uint64 _idNext;
+    uint64 internal _customIdNext;
+
+    mapping(address target => RoleId roleId) internal _targetRoleId;
+    uint64 internal _components;
 
-    IModuleAuthorization _instanceAuthorization;
+    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(
-        IModuleAuthorization instanceAuthorization
-    )
-        AccessAdmin()
-    {
-        _instanceAuthorization = instanceAuthorization;
+        address instanceAuthorization
+    ) {
+        initialize(new AccessManagerCloneable());
+
+        _instanceAuthorization = IAuthorization(instanceAuthorization);
+
+        _disableInitializers();
     }
 
-    /// @dev Initializes this instance admin with the provided instances authorization specification.
-    /// Internally the function creates an instance specific OpenZeppelin AccessManager that is used as the authority
-    /// for the inststance authorizatios.
-    /// Important: Initialization of this instance admin is only complete after calling function initializeInstance. 
+
     function initialize(
-        AccessManagerCloneable accessManager,
-        IModuleAuthorization instanceAuthorization
+        AccessManagerCloneable clonedAccessManager,
+        IRegistry registry,
+        VersionPart release
     )
         external
-        initializer() 
+        initializer()
     {
-        // create new access manager for this instance admin
-        _initializeAuthority(address(accessManager));
-
-        // create basic instance independent setup
-        _createAdminAndPublicRoles();
-
-        // store instance authorization specification
-        _instanceAuthorization = IModuleAuthorization(instanceAuthorization);
-    }
+        __AccessAdmin_init(clonedAccessManager);
 
-    function _checkTargetIsReadyForAuthorization(address target)
-        internal
-        view
-    {
-        if (address(_registry) != address(0) && !_registry.isRegistered(target)) {
-            revert ErrorInstanceAdminNotRegistered(target);
-        }
+        clonedAccessManager.completeSetup(
+            address(registry), 
+            release); 
 
-        if (targetExists(target)) {
-            revert ErrorInstanceAdminAlreadyAuthorized(target);
-        }
+        _registry = registry;
     }
 
-    /// @dev Completes the initialization of this instance admin using the provided instance.
+    /// @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 initializeInstanceAuthorization(address instanceAddress)
+    function completeSetup(
+        address instance,
+        address authorization
+    )
         external
+        reinitializer(uint64(getRelease().toInt()))
+        onlyDeployer()
     {
-        _checkTargetIsReadyForAuthorization(instanceAddress);
+        _components = 0;
+        _customIdNext = CUSTOM_ROLE_ID_MIN;
+        _instance = IInstance(instance);
+        _instanceAuthorization = IAuthorization(authorization);
 
-        _idNext = CUSTOM_ROLE_ID_MIN;
-        _instance = IInstance(instanceAddress);
-        _registry = _instance.getRegistry();
+        _checkTargetIsReadyForAuthorization(instance);
 
         // check matching releases
-        if (_instanceAuthorization.getRelease() != _instance.getMajorVersion()) {
+        if (_instanceAuthorization.getRelease() != getRelease()) {
             revert ErrorInstanceAdminReleaseMismatch();
         }
 
+        // create instance role and target
+        _setupInstance(instance);
+
         // add instance authorization
         _createRoles(_instanceAuthorization);
-        _createModuleTargetsWithRoles();
-        _createTargetAuthorizations(_instanceAuthorization);
 
-        // grant component owner roles to instance owner
-        _grantComponentOwnerRoles();
+        _setupInstanceHelperTargetsWithRoles();
+        _createTargetAuthorizations(_instanceAuthorization);
     }
 
 
     /// @dev Initializes the authorization for the specified component.
     /// Important: The component MUST be registered.
     function initializeComponentAuthorization(
-        IComponent component,
-        IAuthorization authorization
+        IInstanceLinkedComponent component
     )
         external
+        restricted()
     {
+        // checks
         _checkTargetIsReadyForAuthorization(address(component));
 
-        _createRoles(authorization);
+        // setup target and role for component (including token handler)
+        _setupComponentAndTokenHandler(component);
+
+        // create other roles
+        IAuthorization authorization = component.getAuthorization();
+        _createRoles(authorization);        
+        _createTargetAuthorizations(authorization);
+    }
+
+    // create instance role and target
+    function _setupInstance(address instance) internal {
+        // create instance role
+        RoleId instanceRoleId = _instanceAuthorization.getTargetRole(
+            _instanceAuthorization.getMainTarget());
+
+        _createRole(
+            instanceRoleId,
+            _instanceAuthorization.getRoleInfo(instanceRoleId));
 
-        // create component target
+        // create instance target
         _createTarget(
-            address(component), 
-            authorization.getTargetName(), 
+            instance, 
+            _instanceAuthorization.getMainTargetName(), 
             true, // checkAuthority
             false); // custom
 
-        _createTarget(
-            address(component.getTokenHandler()), 
-            string(abi.encodePacked(authorization.getTargetName(), "TH")), 
-            true, 
-            false);
-        
-        // FIXME: make this a bit nicer and work with IAuthorization. Use a specific role, not public - access to TokenHandler must be restricted
-        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");
-
-        _authorizeTargetFunctions(
-            address(component.getTokenHandler()),
-            getPublicRole(),
-            functions);
-
+        // assign instance role to instance
         _grantRoleToAccount(
-            authorization.getTargetRole(
-                authorization.getTarget()), 
-            address(component));
-        
-        _createTargetAuthorizations(authorization);
-    }
-
-
-    function _grantComponentOwnerRoles()
-        internal
-    {
-        address instanceOwner = _registry.ownerOf(_instance.getNftId());
-        _grantRoleToAccount(DISTRIBUTION_OWNER_ROLE(), instanceOwner);
-        _grantRoleToAccount(ORACLE_OWNER_ROLE(), instanceOwner);
-        _grantRoleToAccount(POOL_OWNER_ROLE(), instanceOwner);
-        _grantRoleToAccount(PRODUCT_OWNER_ROLE(), instanceOwner);
+            instanceRoleId, 
+            instance);
     }
 
     /// @dev Creates a custom role
@@ -184,32 +183,183 @@ contract InstanceAdmin is
         _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 number of components that have been registered with this instance.   
+    function components() 
+        external 
+        view 
+        returns (uint64)
+    {
+        return _components;
+    }
+
     /// @dev Returns the instance authorization specification used to set up this instance admin.
     function getInstanceAuthorization()
         external
         view
-        returns (IModuleAuthorization instanceAuthorizaion)
+        returns (IAuthorization instanceAuthorizaion)
     {
         return _instanceAuthorization;
     }
 
+    // ------------------- Internal functions ------------------- //
+
+    function _setupComponentAndTokenHandler(IInstanceLinkedComponent component)
+        internal
+    {
+
+        IAuthorization authorization = component.getAuthorization();
+        string memory targetName = authorization.getMainTargetName();
+
+        // create component role and target
+        RoleId componentRoleId = _createComponentRoleId(component, authorization);
+
+        // create component's target
+        _createTarget(
+            address(component), 
+            targetName, 
+            true, // checkAuthority
+            false); // custom
+
+        // create component's token handler target
+        NftId componentNftId = _registry.getNftIdForAddress(address(component));
+        address tokenHandler = address(
+            _instance.getInstanceReader().getComponentInfo(
+                componentNftId).tokenHandler);
+
+        _createTarget(
+            tokenHandler, 
+            authorization.getTokenHandlerName(), 
+            true, 
+            false);
+
+        // assign component role to component
+        _grantRoleToAccount(
+            componentRoleId, 
+            address(component));
+
+        // token handler does not require its own role
+        // token handler is not calling other components
+    }
+
+
+    function _createComponentRoleId(
+        IInstanceLinkedComponent component,
+        IAuthorization authorization
+    )
+        internal 
+        returns (RoleId componentRoleId)
+    {
+        // checks
+        // check component is not yet authorized
+        if (_targetRoleId[address(component)].gtz()) {
+            revert ErrorInstanceAdminAlreadyAuthorized(address(component));
+        }
+
+        // check generic component role
+        RoleId genericComponentRoleId = authorization.getTargetRole(
+            authorization.getMainTarget());
+
+        if (!genericComponentRoleId.isComponentRole()) {
+            revert ErrorInstanceAdminNotComponentRole(genericComponentRoleId);
+        }
+
+        // check component role does not exist
+        componentRoleId = toComponentRole(
+            genericComponentRoleId, 
+            _components);
+
+        if (roleExists(componentRoleId)) {
+            revert ErrorInstanceAdminRoleAlreadyExists(componentRoleId);
+        }
+
+        // check role info
+        IAccess.RoleInfo memory roleInfo = authorization.getRoleInfo(
+            genericComponentRoleId);
+
+        if (roleInfo.roleType != IAccess.RoleType.Contract) {
+            revert ErrorInstanceAdminRoleTypeNotContract(
+                componentRoleId,
+                roleInfo.roleType);
+        }
+
+        // effects
+        _targetRoleId[address(component)] = componentRoleId;
+        _components++;
+
+        _createRole(
+            componentRoleId,
+            roleInfo);
+    }
+
+
+    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 mainTargetRoleId = authorization.getTargetRole(
+            authorization.getMainTarget());
+
         RoleId roleId;
         RoleInfo memory roleInfo;
 
         for(uint256 i = 0; i < roles.length; i++) {
+
             roleId = roles[i];
-            _createRole(
-                roleId,
-                authorization.getRoleInfo(roleId));
+
+            // skip main target role, create role if not exists
+            if (roleId != mainTargetRoleId && !roleExists(roleId)) {
+                _createRole(
+                    roleId,
+                    authorization.getRoleInfo(roleId));
+            }
         }
     }
 
 
+    function toComponentRole(RoleId roleId, uint64 componentIdx)
+        internal
+        pure
+        returns (RoleId)
+    {
+        return RoleIdLib.toRoleId(
+            RoleIdLib.toInt(roleId) + componentIdx);
+    }
+
+
     function _createTargetAuthorizations(IAuthorization authorization)
         internal
     {
@@ -250,7 +400,7 @@ contract InstanceAdmin is
         _createTarget(
             target, 
             targetName, 
-            false, // check authority TODO check normal targets, don't check service targets (they share authority with registry admin)
+            false, // check authority TODO check normal targets, don't check service targets (they share authority with release admin)
             false);
 
         // assign target role if defined
@@ -260,14 +410,16 @@ contract InstanceAdmin is
         }
     }
 
-    function _createModuleTargetsWithRoles()
+    function _setupInstanceHelperTargetsWithRoles()
         internal
     {
+        // _checkAndCreateTargetWithRole(address(_instance), INSTANCE_TARGET_NAME);
+
         // 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();