@etherisc/gif-next 0.0.2-7ca6cd9-950 → 0.0.2-7dc3cd3-858

package/contracts/shared/ComponentService.sol

@@ -11,7 +11,7 @@ import {IInstance} from "../instance/IInstance.sol";
 import {IAccess} from "../instance/module/IAccess.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType, REGISTRY, COMPONENT, DISTRIBUTION, INSTANCE, ORACLE, POOL, PRODUCT} from "../type/ObjectType.sol";
-import {RoleId, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE, POLICY_SERVICE_ROLE, PRODUCT_SERVICE_ROLE} from "../type/RoleId.sol";
+import {RoleId, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE} from "../type/RoleId.sol";
 import {KEEP_STATE} from "../type/StateId.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IComponentService} from "./IComponentService.sol";
@@ -64,11 +64,6 @@ contract ComponentService is
         registerInterface(type(IComponentService).interfaceId);
     }
 
-
-    function getDomain() public pure virtual override returns(ObjectType) {
-        return COMPONENT();
-    }
-
     //-------- component ----------------------------------------------------//
 
     function setWallet(address newWallet) external virtual {
@@ -107,12 +102,6 @@ contract ComponentService is
         virtual
     {
         address contractAddress = msg.sender;
-        RoleId[] memory roles = new RoleId[](1);
-        bytes4[][] memory selectors = new bytes4[][](1);
-
-        // authorizaion for distribution owner
-        roles[0] = PRODUCT_OWNER_ROLE();
-        selectors[0] = _createSelectors(IProductComponent.setFees.selector);
 
         // register/create component setup
         (
@@ -122,9 +111,7 @@ contract ComponentService is
         ) = _register(
             contractAddress,
             PRODUCT(),
-            PRODUCT_OWNER_ROLE(),
-            roles,
-            selectors);
+            PRODUCT_OWNER_ROLE());
 
         // create product info
         IComponents.ProductInfo memory productInfo = IProductComponent(contractAddress).getInitialProductInfo();
@@ -198,24 +185,12 @@ contract ComponentService is
         virtual
     {
         address contractAddress = msg.sender;
-        RoleId[] memory roles = new RoleId[](2);
-        bytes4[][] memory selectors = new bytes4[][](2);
-
-        // authorizaion for distribution owner
-        roles[0] = DISTRIBUTION_OWNER_ROLE();
-        selectors[0] = _createSelectors(IDistributionComponent.setFees.selector);
-
-        // authorizaion for product service
-        roles[1] = PRODUCT_SERVICE_ROLE();
-        selectors[1] = _createSelectors(IDistributionComponent.processRenewal.selector);
 
         // register/create component info
         _register(
             contractAddress,
             DISTRIBUTION(),
-            DISTRIBUTION_OWNER_ROLE(),
-            roles,
-            selectors);
+            DISTRIBUTION_OWNER_ROLE());
     }
 
 
@@ -287,8 +262,6 @@ contract ComponentService is
         virtual
     {
         address contractAddress = msg.sender;
-        RoleId[] memory roles = new RoleId[](0);
-        bytes4[][] memory selectors = new bytes4[][](0);
 
         // register/create component setup
         (
@@ -298,9 +271,7 @@ contract ComponentService is
         ) = _register(
             contractAddress,
             ORACLE(),
-            ORACLE_OWNER_ROLE(),
-            roles,
-            selectors);            
+            ORACLE_OWNER_ROLE());            
     }
 
     //-------- pool ---------------------------------------------------------//
@@ -310,16 +281,6 @@ contract ComponentService is
         virtual
     {
         address contractAddress = msg.sender;
-        RoleId[] memory roles = new RoleId[](2);
-        bytes4[][] memory selectors = new bytes4[][](2);
-
-        // authorizaion for pool owner
-        roles[0] = POOL_OWNER_ROLE();
-        selectors[0] = _createSelectors(IPoolComponent.setFees.selector);
-
-        // authorizaion for product service
-        roles[1] = POLICY_SERVICE_ROLE();
-        selectors[1] = _createSelectors(IPoolComponent.verifyApplication.selector);
 
         // register/create component setup
         (
@@ -329,14 +290,13 @@ contract ComponentService is
         ) = _register(
             contractAddress,
             POOL(),
-            POOL_OWNER_ROLE(),
-            roles,
-            selectors);            
+            POOL_OWNER_ROLE());            
 
         // create info
         instanceStore.createPool(
             componentNftId, 
-            IPoolComponent(contractAddress).getInitialPoolInfo());
+            IPoolComponent(
+                contractAddress).getInitialPoolInfo());
     }
 
 
@@ -466,9 +426,7 @@ contract ComponentService is
     function _register(
         address componentAddress, // address of component to register
         ObjectType requiredType, // required type for component for registration
-        RoleId requiredRole, // role required for comonent owner for registration
-        RoleId[] memory roles, // roles with write access to component
-        bytes4[][] memory selectors // authorized functions per role with write access
+        RoleId requiredRole // role required for comonent owner for registration
     )
         internal
         virtual
@@ -495,21 +453,21 @@ contract ComponentService is
 
         component.linkToRegisteredNftId();
 
+        // setup initial component authorization
+        _instanceService.initializeAuthorization(
+            instance.getNftId(),
+            component);
+
         // save amended component info with instance
         instanceReader = instance.getInstanceReader();
         instanceStore = instance.getInstanceStore();
 
         IComponents.ComponentInfo memory componentInfo = component.getComponentInfo();
         componentInfo.tokenHandler = new TokenHandler(address(componentInfo.token));
-        instanceStore.createComponent(component.getNftId(), componentInfo);
-
-        // configure instance authorization
-        _instanceService.createComponentTarget(
-            instance.getNftId(), 
-            componentAddress, 
-            component.getName(), 
-            selectors, 
-            roles);
+        instanceStore.createComponent(
+            component.getNftId(), 
+            componentInfo);
+
     }
 
 
@@ -610,9 +568,12 @@ contract ComponentService is
         instance = _getInstance(info.parentNftId);
         owner = info.initialOwner;
 
-        (bool hasRole,) = instance.getInstanceAccessManager().hasRole(requiredRole.toInt(), owner);
-        if(!hasRole) {
+        if(!instance.getInstanceAdmin().hasRole(owner, requiredRole)) {
             revert ErrorComponentServiceExpectedRoleMissing(info.parentNftId, requiredRole, owner);
         }
     }
+
+    function _getDomain() internal pure virtual override returns(ObjectType) {
+        return COMPONENT();
+    }
 }

package/contracts/shared/ComponentVerifyingService.sol

@@ -87,7 +87,7 @@ abstract contract ComponentVerifyingService is
 
         // ensure component is not locked
         if (onlyActive) {
-            if (instance.getInstanceAccessManager().isTargetClosed(info.objectAddress)) {
+            if (instance.getInstanceAdmin().isTargetLocked(info.objectAddress)) {
                 revert ErrorComponentVerifyingServiceComponentIsLocked(componentNftId);
             }
         }

package/contracts/shared/IInstanceLinkedComponent.sol

@@ -5,6 +5,7 @@ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessMana
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {IComponent} from "../shared/IComponent.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {IInstanceService} from "../instance/IInstanceService.sol";
@@ -43,4 +44,7 @@ interface IInstanceLinkedComponent is
     /// this is only relevant for pool and distribution components
     function getProductNftId() external view returns (NftId productNftId);
 
+    /// @dev returns the initial component authorization specification.
+    function getAuthorization() external view returns (IAuthorization authorization);
+
 }

package/contracts/shared/IService.sol

@@ -6,6 +6,7 @@ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessMana
 import {IRegisterable} from "./IRegisterable.sol";
 import {IVersionable} from "./IVersionable.sol";
 import {ObjectType} from "../type/ObjectType.sol";
+import {RoleId} from "../type/RoleId.sol";
 
 interface IService is 
     IRegisterable,
@@ -14,5 +15,11 @@ interface IService is
 {
     error ErrorServiceNotImplemented();
 
+    /// @dev returns the domain for this service.
+    /// In any GIF release only one service for any given domain may be deployed.
     function getDomain() external pure returns(ObjectType serviceDomain);
+
+    /// @dev returns the GIF release specific role id.
+    /// These role ids are used to authorize service to service communication.
+    function getRoleId() external pure returns(RoleId serviceRoleId);
 }

package/contracts/shared/InstanceLinkedComponent.sol

@@ -9,10 +9,10 @@ import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol
 import {Component} from "./Component.sol";
 import {IComponentService} from "./IComponentService.sol";
 import {IInstanceLinkedComponent} from "./IInstanceLinkedComponent.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IInstanceService} from "../instance/IInstanceService.sol";
 import {IInstance} from "../instance/IInstance.sol";
-import {InstanceAdmin} from "../instance/InstanceAdmin.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId} from "../type/NftId.sol";
@@ -35,6 +35,27 @@ abstract contract InstanceLinkedComponent is
     struct InstanceLinkedComponentStorage {
         IInstance _instance; // instance for this component
         InstanceReader _instanceReader; // instance reader for this component
+        IAuthorization _initialAuthorization;
+    }
+
+    function lock() external onlyOwner {
+        IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(true);
+    }
+    
+    function unlock() external onlyOwner {
+        IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(false);
+    }
+
+    function getInstance() public view override returns (IInstance instance) {
+        return _getInstanceLinkedComponentStorage()._instance;
+    }
+
+    function getProductNftId() public view override returns (NftId productNftId) {
+        return getComponentInfo().productNftId;
+    }
+
+    function getAuthorization() external view returns (IAuthorization authorization) {
+        return _getInstanceLinkedComponentStorage()._initialAuthorization;
     }
 
     function _getInstanceLinkedComponentStorage() private pure returns (InstanceLinkedComponentStorage storage $) {
@@ -43,18 +64,19 @@ abstract contract InstanceLinkedComponent is
         }
     }
 
-    function initializeInstanceLinkedComponent(
+    function _initializeInstanceLinkedComponent(
         address registry,
         NftId instanceNftId,
         string memory name,
         address token,
         ObjectType componentType,
+        IAuthorization authorization,
         bool isInterceptor,
         address initialOwner,
         bytes memory registryData, // writeonly data that will saved in the object info record of the registry
         bytes memory componentData // data that will saved with the component info in the instance store
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
@@ -82,6 +104,7 @@ abstract contract InstanceLinkedComponent is
 
         // set component state
         $._instanceReader = $._instance.getInstanceReader();
+        $._initialAuthorization = authorization;
 
         registerInterface(type(IAccessManaged).interfaceId);
         registerInterface(type(IInstanceLinkedComponent).interfaceId);
@@ -93,22 +116,6 @@ abstract contract InstanceLinkedComponent is
         IComponentService(_getServiceAddress(COMPONENT())).setWallet(newWallet);
     }
 
-    function lock() external onlyOwner {
-        IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(true);
-    }
-    
-    function unlock() external onlyOwner {
-        IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(false);
-    }
-
-    function getInstance() public view override returns (IInstance instance) {
-        return _getInstanceLinkedComponentStorage()._instance;
-    }
-
-    function getProductNftId() public view override returns (NftId productNftId) {
-        return getComponentInfo().productNftId;
-    }
-
 
     function _getComponentInfo() internal virtual override view returns (IComponents.ComponentInfo memory info) {
         NftId componentNftId = getRegistry().getNftId(address(this));

package/contracts/shared/Service.sol

@@ -4,17 +4,15 @@ pragma solidity ^0.8.20;
 import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
-import {ObjectType, REGISTRY, SERVICE} from "../type/ObjectType.sol";
-import {NftId} from "../type/NftId.sol";
-import {Version, VersionPart, VersionLib, VersionPartLib} from "../type/Version.sol";
-
-import {Versionable} from "./Versionable.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
 import {IService} from "./IService.sol";
 import {IVersionable} from "./IVersionable.sol";
-import {Versionable} from "./Versionable.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType, REGISTRY, SERVICE} from "../type/ObjectType.sol";
 import {Registerable} from "./Registerable.sol";
-
-import {IRegistry} from "../registry/IRegistry.sol";
+import {RoleId, RoleIdLib} from "../type/RoleId.sol";
+import {Version, VersionPart, VersionLib, VersionPartLib} from "../type/Version.sol";
+import {Versionable} from "./Versionable.sol";
 
 
 /// @dev service base contract
@@ -27,15 +25,6 @@ abstract contract Service is
 
     uint8 private constant GIF_MAJOR_VERSION = 3;
 
-    // from Versionable
-    function getVersion()
-        public 
-        pure 
-        virtual override (IVersionable, Versionable)
-        returns(Version)
-    {
-        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
-    }
 
     function initializeService(
         address registry, 
@@ -58,9 +47,7 @@ abstract contract Service is
         if(authority != address(0)) {
             __AccessManaged_init(authority);
         } else {
-            address registryServiceAddress = getRegistry().getServiceAddress(
-                REGISTRY(), 
-                VersionPartLib.toVersionPart(GIF_MAJOR_VERSION));
+            address registryServiceAddress = _getServiceAddress(REGISTRY());
 
             // copy authority from already registered registry services
             __AccessManaged_init(IAccessManaged(registryServiceAddress).authority());
@@ -70,8 +57,27 @@ abstract contract Service is
         registerInterface(type(IService).interfaceId);
     }
 
+    function getDomain() external virtual pure returns(ObjectType serviceDomain) {
+        return _getDomain();
+    }
+
+    function getRoleId() external virtual pure returns(RoleId serviceRoleId) {
+        return RoleIdLib.roleForTypeAndVersion(_getDomain(), VersionPartLib.toVersionPart(GIF_MAJOR_VERSION));
+    }
+
+    // from Versionable
+    function getVersion()
+        public 
+        pure 
+        virtual override (IVersionable, Versionable)
+        returns(Version)
+    {
+        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
+    }
+
+    function _getDomain() internal virtual pure returns (ObjectType);
 
     function _getServiceAddress(ObjectType domain) internal view returns (address) {
-        return getRegistry().getServiceAddress(domain, getVersion().toMajorPart());
+        return getRegistry().getServiceAddress(domain, VersionPartLib.toVersionPart(GIF_MAJOR_VERSION));
     }
 }

package/contracts/staking/IStakingService.sol

@@ -52,21 +52,25 @@ interface IStakingService is IService
         UFixed initialRewardRate
     ) external;
 
-    /// @dev set the stake locking period to the specified duration.
+    /// @dev Set the instance stake locking period to the specified duration.
     /// permissioned: only the owner of the specified target may set the locking period
-    function setLockingPeriod(NftId targetNftId, Seconds lockingPeriod) external;
+    function setInstanceLockingPeriod(NftId instanceNftId, Seconds lockingPeriod) external;
 
-    /// @dev set the reward rate to the specified value
+    /// @dev Set the instance reward rate to the specified value
     /// permissioned: only the owner of the specified target may set the locking period
-    function setRewardRate(NftId targetNftId, UFixed rewardRate) external;
+    function setInstanceRewardRate(NftId instanceNftId, UFixed rewardRate) external;
 
-    /// @dev (re)fills the staking reward reserves for the specified target
+    /// @dev (Re)fills the staking reward reserves for the specified target using the dips provided by the reward provider.
     /// unpermissioned: anybody may fill up staking reward reserves
-    function refillRewardReserves(NftId targetNftId, Amount dipAmount) external returns (Amount newBalance);
+    function refillInstanceRewardReserves(NftId instanceNftId, address rewardProvider, Amount dipAmount) external returns (Amount newBalance);
+
+    /// @dev (Re)fills the staking reward reserves for the specified target using the dips provided by the sender
+    /// unpermissioned: anybody may fill up staking reward reserves
+    function refillRewardReservesBySender(NftId targetNftId, Amount dipAmount) external returns (Amount newBalance);
 
     /// @dev defunds the staking reward reserves for the specified target
     /// permissioned: only the target owner may call this function
-    function withdrawRewardReserves(NftId targetNftId, Amount dipAmount) external returns (Amount newBalance);
+    function withdrawInstanceRewardReserves(NftId instanceNftId, Amount dipAmount) external returns (Amount newBalance);
 
     /// @dev create a new stake with amount DIP to the specified target
     /// returns the id of the newly minted stake nft

package/contracts/staking/StakeManagerLib.sol

@@ -13,12 +13,64 @@ import {NftId} from "../type/NftId.sol";
 import {ObjectType, INSTANCE, PROTOCOL, TARGET} from "../type/ObjectType.sol";
 import {Seconds, SecondsLib} from "../type/Seconds.sol";
 import {StakingReader} from "./StakingReader.sol";
+import {StakingStore} from "./StakingStore.sol";
 import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
 import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
 
 library StakeManagerLib {
 
+    function stake(
+        IRegistry registry,
+        StakingReader stakingReader,
+        StakingStore stakingStore,
+        NftId stakeNftId,
+        Amount stakeAmount
+    )
+        external
+        returns (Amount stakeBalance)
+    {
+        // check that target is active for staking
+        (
+            UFixed rewardRate,
+            Seconds lockingPeriod
+        ) = checkStakeParameters(
+            stakingReader, 
+            stakeNftId);        
+
+        // calculate new rewards (if any)
+        (
+            Amount rewardIncrementAmount, 
+            Amount currentTotalDipAmount
+        ) = calculateRewardIncrease(
+            stakingReader, 
+            stakeNftId,
+            rewardRate);
+
+        stakeBalance = currentTotalDipAmount + stakeAmount;
+
+        // TODO check that additional dip, rewards and rewards increment 
+        // are still ok with max target staking amount
+        NftId targetNftId = registry.getObjectInfo(stakeNftId).parentNftId;
+
+        stakingStore.restakeRewards(
+            stakeNftId, 
+            targetNftId, 
+            rewardIncrementAmount);
+
+        stakingStore.increaseStake(
+            stakeNftId, 
+            targetNftId, 
+            stakeAmount);
+
+        // update locked until with target locking period
+        stakingStore.update(
+            stakeNftId, 
+            IStaking.StakeInfo({
+                lockedUntil: TimestampLib.blockTimestamp().addSeconds(
+                    lockingPeriod)}));
+
+    }
 
     function checkCreateParameters(
         StakingReader stakingReader,