@etherisc/gif-next 0.0.2-ffa91a6-022 → 3.0.0-0fefe0d-162

package/contracts/instance/IInstance.sol

@@ -1,14 +1,17 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IAccess} from "../authorization/IAccess.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+
 import {Amount} from "../type/Amount.sol";
 import {BundleSet} from "./BundleSet.sol";
 import {RiskSet} from "./RiskSet.sol";
 import {InstanceAdmin} from "./InstanceAdmin.sol";
 import {InstanceReader} from "./InstanceReader.sol";
 import {InstanceStore} from "./InstanceStore.sol";
-import {IRegisterable} from "../shared/IRegisterable.sol";
 import {NftId} from "../type/NftId.sol";
+import {ProductStore} from "./ProductStore.sol";
 import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {UFixed} from "../type/UFixed.sol";
@@ -17,6 +20,21 @@ import {UFixed} from "../type/UFixed.sol";
 interface IInstance is 
     IRegisterable
 {
+    // role handling
+    event LogInstanceCustomRoleCreated(RoleId roleId, string roleName, RoleId adminRoleId, uint32 maxMemberCount);
+    event LogInstanceCustomRoleActiveSet(RoleId roleId, bool active, address caller);
+    event LogInstanceCustomRoleGranted(RoleId roleId, address account, address caller);
+    event LogInstanceCustomRoleRevoked(RoleId roleId, address account, address caller);
+
+    // target handling
+    event LogInstanceCustomTargetCreated(address target, RoleId targetRoleId, string name);
+    event LogInstanceTargetLocked(address target, bool locked);
+    event LogInstanceCustomTargetFunctionRoleSet(address target, bytes4[] selectors, RoleId roleId);
+
+    // modifier is onlyRoleAdmin
+    error ErrorInstanceNotCustomRole(RoleId roleId);
+    error ErrorInstanceNotRoleAdmin(RoleId roleId, address account);
+
     error ErrorInstanceInstanceAdminZero();
     error ErrorInstanceInstanceAdminAlreadySet(address instanceAdmin);
     error ErrorInstanceInstanceAdminAuthorityMismatch(address instanceAuthority);
@@ -34,6 +52,15 @@ interface IInstance is
     error ErrorInstanceInstanceStoreAlreadySet(address instanceStore);
     error ErrorInstanceInstanceStoreAuthorityMismatch(address instanceAuthority);
 
+    struct InstanceContracts {
+        InstanceAdmin instanceAdmin;
+        InstanceStore instanceStore;
+        ProductStore productStore;
+        BundleSet bundleSet;
+        RiskSet riskSet;
+        InstanceReader instanceReader;
+    }
+
     struct InstanceInfo {
         uint64 requestsCount;
     }
@@ -62,7 +89,7 @@ interface IInstance is
     function setStakingMaxAmount(Amount maxStakedAmount) external;
 
     /// @dev Refills the staking reward reserves for the specified target.
-    function refillStakingRewardReserves(Amount dipAmount) external;
+    function refillStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
 
     /// @dev Defunds the staking reward reserves for the specified target.
     function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
@@ -77,12 +104,34 @@ interface IInstance is
 
     ///--- authz ------------------------------------------------------------//
 
-    function createRole(string memory roleName, string memory adminName) external returns (RoleId roleId, RoleId admin);
+    /// @dev Creates a new custom role for the calling instance.
+    /// Custom roles are intended to be used for access control of custom components and its helper contracts.
+    /// Custom roles are not intended to be used as target roles for custom contracts.
+    function createRole(string memory roleName, RoleId adminRoleId, uint32 maxMemberCount) external returns (RoleId roleId);
+
+    /// @dev Activates/deactivates the specified role.
+    /// Only instance owner or account with role admin role can call this function.
+    function setRoleActive(RoleId roleId, bool active) external;
+
+    /// @dev Grants the specified role to the account.
+    /// Only active roles can be granted.
+    /// Only instance owner or account with role admin role can call this function.
     function grantRole(RoleId roleId, address account) external;
+
+    /// @dev Revokes the specified role from the account.
+    /// Only instance owner or account with role admin role can call this function.
     function revokeRole(RoleId roleId, address account) external;
 
-    function createTarget(address target, string memory name) external;
-    function setTargetFunctionRole(string memory targetName, bytes4[] calldata selectors, RoleId roleId) external;
+    /// @dev Creates a new custom target.
+    /// Custom targets are intended to be used for access control helper contracts of components.
+    /// Custom targets are not intended to be used for components.
+    function createTarget(address target, string memory name) external returns (RoleId contractRoleId);
+
+    /// @dev Authorizes the specified functions for the target and provided role.
+    function authorizeFunctions(address target, RoleId roleId, IAccess.FunctionInfo[] memory functions) external;
+
+    /// @dev Removes any role authorization for the specified functions.
+    function unauthorizeFunctions(address target, IAccess.FunctionInfo[] memory functions) external;
 
     //--- getters -----------------------------------------------------------//
 
@@ -94,7 +143,7 @@ interface IInstance is
 
     // get products
     function products() external view returns (uint256 productCount);
-    function getProductNftId(uint256 idx) external view returns (NftId productNftId);
+    function getProduct(uint256 idx) external view returns (NftId productNftId);
 
     // get supporting contracts
     function getInstanceReader() external view returns (InstanceReader);
@@ -102,4 +151,6 @@ interface IInstance is
     function getRiskSet() external view returns (RiskSet);
     function getInstanceAdmin() external view returns (InstanceAdmin);
     function getInstanceStore() external view returns (InstanceStore);
+    function getProductStore() external view returns (ProductStore);
+    function isTokenRegistryDisabled() external view returns (bool);
 }

package/contracts/instance/IInstanceService.sol

@@ -1,11 +1,14 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount} from "../type/Amount.sol";
+import {IAccess} from "../authorization/IAccess.sol";
 import {IInstance} from "./IInstance.sol";
 import {IService} from "../shared/IService.sol";
+
+import {Amount} from "../type/Amount.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.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";
@@ -36,6 +39,7 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceBundleSetZero();
     error ErrorInstanceServiceRiskSetZero();
     error ErrorInstanceServiceInstanceStoreZero();
+    error ErrorInstanceServiceProductStoreZero();
 
     error ErrorInstanceServiceInstanceAuthorityMismatch();
     error ErrorInstanceServiceBundleSetAuthorityMismatch();
@@ -44,6 +48,7 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceBundleSetInstanceMismatch();
     error ErrorInstanceServiceRiskSetInstanceMismatch();
     error ErrorInstanceServiceInstanceStoreAuthorityMismatch();
+    error ErrorInstanceServiceProductStoreAuthorityMismatch();
 
     error ErrorInstanceServiceRequestUnauhorized(address caller);
     error ErrorInstanceServiceNotInstanceNftId(NftId nftId);
@@ -51,20 +56,49 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceInstanceComponentMismatch(NftId instanceNftId, NftId componentNftId);
     error ErrorInstanceServiceInvalidComponentType(address componentAddress, ObjectType expectedType, ObjectType componentType);
     
-    event LogInstanceCloned(NftId instanceNftId, address instance);
+    event LogInstanceServiceInstanceLocked(NftId instanceNftId, bool locked);
+    event LogInstanceServiceInstanceCreated(NftId instanceNftId, address instance);
+    event LogInstanceServiceMasterInstanceReaderUpgraded(NftId instanceNfId, address newInstanceReader);
+    event LogInstanceServiceInstanceReaderUpgraded(NftId instanceNfId, address newInstanceReader);
 
-    /// @dev Locks the complete instance, including all its components.
-    function setInstanceLocked(bool locked) external;
+    /// @dev Creates a new custom role for the calling instance.
+    function createRole(string memory roleName, RoleId adminRoleId, uint32 maxMemberCount) external returns (RoleId roleId);
+
+    /// @dev Sets the specified custom role as active or inactive for the calling instance.
+    function setRoleActive(RoleId roleId, bool active) external;
+
+    /// @dev Grants the specified custom role to the specified account for the calling instance.
+    function grantRole(RoleId roleId, address account) external; 
+
+    /// @dev Revokes the specified custom role from the specified account for the calling instance.
+    function revokeRole(RoleId roleId, address account) external; 
+
+    /// @dev Creates a new custom target for the calling instance.
+    /// All custom trargets are created with a corresponding contract role.
+    function createTarget(address target, string memory name) external returns (RoleId contractRoleId);
+
+    /// @dev Authorizes the specified functions for the specified target.
+    function authorizeFunctions(address target, RoleId roleId, IAccess.FunctionInfo[] memory functions) external; 
+
+    /// @dev Removes any role authorization for the specified functions.
+    function unauthorizeFunctions(address target, IAccess.FunctionInfo[] memory functions) external;
 
     /// @dev Locks/unlocks the specified target constrolled by the corresponding instance admin.
     function setTargetLocked(address target, bool locked) external;
 
+    /// @dev Locks the complete instance, including all its components.
+    function setInstanceLocked(bool locked) external;
+
     /// @dev Creates a new instance.
     /// The caller becomes the owner of the new instance.
     /// Creation of a new instance is achieved by this service through the creation and registration 
     /// of a new clone of the master instance and then setting up the initial wiring and authorization 
     /// of the necessary components.
-    function createInstance()
+    /// @param allowAnyToken specifies whether the new instance is allowed to use any token or 
+    /// only tokens that are registered in the `TokenRegistry`. Use of tokens **not** registered in the
+    /// `TokenRegistry` may result in problems with token handline and is therefor not recommended. The 
+    /// use of such instances **is not supported** by Etherisc. 
+    function createInstance(bool allowAnyToken)
         external 
         returns (
             IInstance instance,
@@ -77,8 +111,9 @@ interface IInstanceService is IService {
     function setStakingLockingPeriod(Seconds stakeLockingPeriod) external;
     function setStakingRewardRate(UFixed rewardRate) external;
     function setStakingMaxAmount(Amount maxStakedAmount) external;
-    function refillStakingRewardReserves(address rewardProvider, Amount dipAmount) external;
+
+    function refillInstanceRewardReserves(address rewardProvider, Amount dipAmount) external returns (Amount newBalance);
 
     /// @dev Defunds the staking reward reserves for the specified target.
-    function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
+    function withdrawInstanceRewardReserves(Amount dipAmount) external returns (Amount newBalance);
 }

package/contracts/instance/Instance.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IAccess} from "../authorization/IAccess.sol";
 import {IInstance} from "./IInstance.sol";
 import {IComponentService} from "../shared/IComponentService.sol";
 import {IInstanceService} from "./IInstanceService.sol";
@@ -14,6 +15,7 @@ import {InstanceReader} from "./InstanceReader.sol";
 import {InstanceAdmin} from "./InstanceAdmin.sol";
 import {InstanceStore} from "./InstanceStore.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";
@@ -34,54 +36,65 @@ contract Instance is
     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(
-        InstanceAdmin instanceAdmin, 
-        InstanceStore instanceStore,
-        BundleSet bundleSet,
-        RiskSet riskSet,
-        InstanceReader instanceReader,
+        InstanceContracts memory instanceContracts,
         IRegistry registry, 
         VersionPart release,
-        address initialOwner
+        address initialOwner,
+        bool tokenRegistryDisabled // only disable for testing
     ) 
         external 
         initializer()
     {
-        if(address(instanceAdmin) == address(0)) {
+        if(address(instanceContracts.instanceAdmin) == address(0)) {
             revert ErrorInstanceInstanceAdminZero();
         }
 
-        _instanceAdmin = instanceAdmin;
+        _instanceAdmin = instanceContracts.instanceAdmin;
 
         // setup instance object info
-        __Registerable_init(
-            instanceAdmin.authority(),
-            address(registry), 
-            registry.getNftId(), 
-            INSTANCE(), 
-            true, 
-            initialOwner, 
-            "");
+        __Registerable_init({
+            authority: instanceContracts.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;
+        _instanceStore = instanceContracts.instanceStore;
+        _productStore = instanceContracts.productStore;
+        _bundleSet = instanceContracts.bundleSet;
+        _riskSet = instanceContracts.riskSet;
+        _instanceReader = instanceContracts.instanceReader;
 
         // initialize instance supporting contracts
         _instanceStore.initialize();
-        _bundleSet.initialize(instanceAdmin.authority(), address(registry));
-        _riskSet.initialize(instanceAdmin.authority(), address(registry));
+        _productStore.initialize();
+        _bundleSet.initialize(instanceContracts.instanceAdmin.authority(), address(registry));
+        _riskSet.initialize(instanceContracts.instanceAdmin.authority(), address(registry));
         _instanceReader.initialize();
 
         _componentService = IComponentService(
@@ -94,6 +107,8 @@ contract Instance is
                 INSTANCE(), 
                 release));
 
+        _tokenRegistryDisabled = tokenRegistryDisabled;
+
         _registerInterface(type(IInstance).interfaceId);    
     }
 
@@ -148,6 +163,7 @@ contract Instance is
 
     function setStakingMaxAmount(Amount maxStakedAmount)
         external
+        restricted()
         onlyOwner()
     {
         _instanceService.setStakingMaxAmount(maxStakedAmount);
@@ -157,87 +173,120 @@ contract Instance is
         external
         restricted()
         onlyOwner()
+        returns (Amount newRewardReserveBalance)
     {
         address instanceOwner = msg.sender;
-        _instanceService.refillStakingRewardReserves(instanceOwner, dipAmount);
+        return _instanceService.refillInstanceRewardReserves(instanceOwner, dipAmount);
     }
 
     function withdrawStakingRewardReserves(Amount dipAmount)
         external
         restricted()
         onlyOwner()
-        returns (Amount newBalance)
+        returns (Amount newRewardReserveBalance)
     {
-        return _instanceService.withdrawStakingRewardReserves(dipAmount);
+        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()
         onlyOwner()
-        returns (RoleId roleId, RoleId admin)
+        returns (RoleId roleId)
     {
-        // TODO refactor
-        // (roleId, admin) = _instanceAdmin.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()
-        onlyOwner()
+        onlyCustomRoleAdmin(roleId)
     {
-        _instanceAdmin.grantRole(roleId, account);
+        _instanceService.grantRole(roleId, account);
+        emit LogInstanceCustomRoleGranted(roleId, account, msg.sender);
     }
 
+
+    /// @inheritdoc IInstance
     function revokeRole(RoleId roleId, address account) 
         external 
         restricted()
-        onlyOwner()
+        onlyCustomRoleAdmin(roleId)
     {
-        // TODO refactor
-        // AccessManagerExtendedInitializeable(authority()).revokeRole(roleId.toInt(), account);
+        _instanceService.revokeRole(roleId, account);
+        emit LogInstanceCustomRoleRevoked(roleId, account, msg.sender);
     }
 
     //--- Targets ------------------------------------------------------------//
 
+    /// @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);
+    }
+
 
+    /// @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 createTarget(address target, string memory name) 
+
+    /// @inheritdoc IInstance
+    function authorizeFunctions(
+        address target, 
+        RoleId roleId, 
+        IAccess.FunctionInfo[] memory functions
+    )
         external 
         restricted()
         onlyOwner()
     {
-        // TODO refactor
-        // _instanceAdmin.createTarget(target, name);
+        _instanceService.authorizeFunctions(target, roleId, functions);
     }
 
-    function setTargetFunctionRole(
-        string memory targetName,
-        bytes4[] calldata selectors,
-        RoleId roleId
-    ) 
+
+    /// @inheritdoc IInstance
+    function unauthorizeFunctions(
+        address target, 
+        IAccess.FunctionInfo[] memory functions
+    )
         external 
         restricted()
         onlyOwner()
     {
-        // TODO refactor
-        // _instanceAdmin.setTargetFunctionRoleByInstance(targetName, selectors, roleId);
-    }
-
-    //--- ITransferInterceptor ----------------------------------------------//
-
-    function nftTransferFrom(address from, address to, uint256 tokenId, address operator) external onlyChainNft {
-        // TODO refactor
-        // _instanceAdmin.transferInstanceOwnerRole(from, to);
+        _instanceService.unauthorizeFunctions(target, functions);
     }
 
     //--- initial setup functions -------------------------------------------//
@@ -268,7 +317,7 @@ contract Instance is
         return _products.length;
     }
 
-    function getProductNftId(uint256 idx) external view returns (NftId productNftId) {
+    function getProduct(uint256 idx) external view returns (NftId productNftId) {
         return _products[idx];
     }
 
@@ -292,5 +341,11 @@ contract Instance is
         return _instanceStore;
     }
 
-    //--- internal view/pure functions --------------------------------------//
+    function getProductStore() external view returns (ProductStore) {
+        return _productStore;
+    }
+
+    function isTokenRegistryDisabled() external view returns (bool) {
+        return _tokenRegistryDisabled;
+    }
 }