@etherisc/gif-next 0.0.2-8bdd2eb-413 → 0.0.2-8d9d4d6-542

package/contracts/staking/Staking.sol

@@ -9,7 +9,6 @@ import {IRegistryService} from "../registry/IRegistryService.sol";
 import {IStaking} from "./IStaking.sol";
 import {IVersionable} from "../shared/IVersionable.sol";
 import {Key32} from "../type/Key32.sol";
-import {KEEP_STATE} from "../type/StateId.sol";
 import {LibNftIdSet} from "../type/NftIdSet.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
 import {NftIdSetManager} from "../shared/NftIdSetManager.sol";
@@ -61,22 +60,11 @@ contract Staking is
         _;
     }
 
-
-    // from Versionable
-    function getVersion()
-        public 
-        pure 
-        virtual override (IVersionable, Versionable)
-        returns(Version)
-    {
-        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
-    }
-
     // set/update staking reader
     function setStakingReader(StakingReader stakingReader)
         external
         virtual
-        onlyOwner
+        onlyOwner()
     {
         if(stakingReader.getStaking() != IStaking(this)) {
             revert ErrorStakingStakingReaderStakingMismatch(address(stakingReader.getStaking()));
@@ -90,7 +78,7 @@ contract Staking is
     function setStakingRate(uint256 chainId, address token, UFixed stakingRate)
         external
         virtual
-        onlyOwner
+        onlyOwner()
     {
         StakingStorage storage $ = _getStakingStorage();
         
@@ -104,8 +92,6 @@ contract Staking is
         emit LogStakingStakingRateSet(chainId, token, oldStakingRate, stakingRate);
     }
 
-    // reward management 
-
     // target management
 
     function registerTarget(
@@ -117,7 +103,7 @@ contract Staking is
     )
         external
         virtual
-        // restricted // staking service access
+        restricted()
     {
         TargetManagerLib.checkTargetParameters(
             getRegistry(), 
@@ -143,7 +129,7 @@ contract Staking is
     )
         external
         virtual
-        // TODO add restricted // only staking service
+        restricted()
         onlyTarget(targetNftId)
     {
         (
@@ -165,7 +151,7 @@ contract Staking is
     function setRewardRate(NftId targetNftId, UFixed rewardRate)
         external
         virtual
-        // TODO add restricted // only staking service
+        restricted()
         onlyTarget(targetNftId)
     {
         (
@@ -185,7 +171,7 @@ contract Staking is
     function refillRewardReserves(NftId targetNftId, Amount dipAmount)
         external
         virtual
-        // TODO add restricted // only for target locking
+        restricted()
         returns (Amount newBalance)
     {
         // update book keeping of reward reserves
@@ -197,8 +183,7 @@ contract Staking is
     function withdrawRewardReserves(NftId targetNftId, Amount dipAmount)
         external
         virtual
-        // TODO add restricted // only staking service
-        // onlyNftOwner(targetNftId)
+        restricted()
         returns (Amount newBalance)
     {
         // update book keeping of reward reserves
@@ -210,7 +195,7 @@ contract Staking is
     function increaseTotalValueLocked(NftId targetNftId, address token, Amount amount)
         external
         virtual
-        // restricted() // only pool service
+        restricted() // only pool service
         returns (Amount newBalance)
     {
         StakingStorage storage $ = _getStakingStorage();
@@ -223,7 +208,7 @@ contract Staking is
     function decreaseTotalValueLocked(NftId targetNftId, address token, Amount amount)
         external
         virtual
-        // restricted() // only pool service
+        restricted() // only pool service
         returns (Amount newBalance)
     {
         StakingStorage storage $ = _getStakingStorage();
@@ -236,6 +221,7 @@ contract Staking is
     function registerRemoteTarget(NftId targetNftId, TargetInfo memory targetInfo)
         external
         virtual
+        restricted()
         onlyOwner // or CCIP
     {
         
@@ -244,6 +230,7 @@ contract Staking is
     function updateRemoteTvl(NftId targetNftId, address token, Amount amount)
         external
         virtual
+        restricted()
         onlyOwner // or CCIP
     {
         
@@ -258,7 +245,7 @@ contract Staking is
     )
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
     {
         StakingStorage storage $ = _getStakingStorage();
         Timestamp lockedUntil = StakeManagerLib.checkCreateParameters(
@@ -286,51 +273,17 @@ contract Staking is
     )
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
         onlyStake(stakeNftId)
         returns (Amount stakeBalance)
     {
         StakingStorage storage $ = _getStakingStorage();
-
-        // check that target is active for staking
-        (
-            UFixed rewardRate,
-            Seconds lockingPeriod
-        ) = StakeManagerLib.checkStakeParameters(
-            $._reader, 
-            stakeNftId);        
-
-        // calculate new rewards (if any)
-        (
-            Amount rewardIncrementAmount, 
-            Amount currentTotalDipAmount
-        ) = StakeManagerLib.calculateRewardIncrease(
-            $._reader, 
+        stakeBalance = StakeManagerLib.stake(
+            getRegistry(),
+            $._reader,
+            $._store,
             stakeNftId,
-            rewardRate);
-
-        stakeBalance = currentTotalDipAmount + stakeAmount;
-
-        // TODO check that additional dip, rewards and rewards increment 
-        // are still ok with max target staking amount
-        NftId targetNftId = getRegistry().getObjectInfo(stakeNftId).parentNftId;
-
-        $._store.restakeRewards(
-            stakeNftId, 
-            targetNftId, 
-            rewardIncrementAmount);
-
-        $._store.increaseStake(
-            stakeNftId, 
-            targetNftId, 
             stakeAmount);
-
-        // update locked until with target locking period
-        $._store.update(
-            stakeNftId, 
-            StakeInfo({
-                lockedUntil: TimestampLib.blockTimestamp().addSeconds(
-                    lockingPeriod)}));
     }
 
 
@@ -340,7 +293,7 @@ contract Staking is
     )
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
         onlyStake(stakeNftId)
         returns (NftId newStakeNftId)
     {
@@ -354,7 +307,7 @@ contract Staking is
     function updateRewards(NftId stakeNftId)
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
         onlyStake(stakeNftId)
     {
         StakingStorage storage $ = _getStakingStorage();
@@ -365,7 +318,7 @@ contract Staking is
     function claimRewards(NftId stakeNftId)
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
         onlyStake(stakeNftId)
         returns (
             Amount rewardsClaimedAmount
@@ -390,7 +343,7 @@ contract Staking is
     function unstake(NftId stakeNftId)
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
         onlyStake(stakeNftId)
         returns (
             Amount unstakedAmount,
@@ -419,35 +372,11 @@ contract Staking is
 
 
 
-    function _updateRewards(
-        StakingReader reader,
-        StakingStore store,
-        NftId stakeNftId
-    )
-        internal
-        virtual
-        returns (NftId targetNftId)
-    {
-        UFixed rewardRate;
-
-        (targetNftId, rewardRate) = reader.getTargetRewardRate(stakeNftId);
-        (Amount rewardIncrement, ) = StakeManagerLib.calculateRewardIncrease(
-            reader, 
-            stakeNftId,
-            rewardRate);
-
-        store.updateRewards(
-            stakeNftId, 
-            targetNftId,
-            rewardIncrement);
-    }
-
-
     //--- other functions ---------------------------------------------------//
 
     function collectDipAmount(address from, Amount dipAmount)
         external
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
     {
         TokenHandler tokenHandler = getTokenHandler();
         address stakingWallet = getWallet();
@@ -464,7 +393,7 @@ contract Staking is
 
     function transferDipAmount(address to, Amount dipAmount)
         external
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
     {
         TokenHandler tokenHandler = getTokenHandler();
         address stakingWallet = getWallet();
@@ -493,8 +422,43 @@ contract Staking is
         return address(_getStakingStorage()._tokenRegistry);
     }
 
+
+    // from Versionable
+    function getVersion()
+        public 
+        pure 
+        virtual override (IVersionable, Versionable)
+        returns(Version)
+    {
+        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
+    }
+
     //--- internal functions ------------------------------------------------//
 
+    function _updateRewards(
+        StakingReader reader,
+        StakingStore store,
+        NftId stakeNftId
+    )
+        internal
+        virtual
+        returns (NftId targetNftId)
+    {
+        UFixed rewardRate;
+
+        (targetNftId, rewardRate) = reader.getTargetRewardRate(stakeNftId);
+        (Amount rewardIncrement, ) = StakeManagerLib.calculateRewardIncrease(
+            reader, 
+            stakeNftId,
+            rewardRate);
+
+        store.updateRewards(
+            stakeNftId, 
+            targetNftId,
+            rewardIncrement);
+    }
+
+
     function _initialize(
         address owner, 
         bytes memory data
@@ -530,7 +494,6 @@ contract Staking is
 
         _createAndSetTokenHandler();
 
-
         // wiring to external contracts
         StakingStorage storage $ = _getStakingStorage();
         $._protocolNftId = getRegistry().getProtocolNftId();
@@ -547,5 +510,4 @@ contract Staking is
             $.slot := STAKING_LOCATION_V1
         }
     }
-
 }

package/contracts/staking/StakingService.sol

@@ -45,29 +45,6 @@ contract StakingService is
         _;
     }
 
-    function getDomain() public pure override returns(ObjectType) {
-        return STAKING();
-    }
-
-
-    function registerProtocolTarget()
-        external
-        virtual
-    {
-        uint256 protocolId = ChainNft(
-            getRegistry().getChainNftAddress()).PROTOCOL_NFT_ID();
-
-        NftId protocolNftId = NftIdLib.toNftId(protocolId);
-        _getStakingServiceStorage()._staking.registerTarget(
-            protocolNftId,
-            PROTOCOL(),
-            1, // protocol is registered on mainnet
-            TargetManagerLib.getDefaultLockingPeriod(),
-            TargetManagerLib.getDefaultRewardRate());
-
-        emit LogStakingServiceProtocolTargetRegistered(protocolNftId);
-    }
-
 
     function createInstanceTarget(
         NftId targetNftId,
@@ -76,7 +53,7 @@ contract StakingService is
     )
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
     {
         uint256 chainId = block.chainid;
         _getStakingServiceStorage()._staking.registerTarget(
@@ -90,66 +67,66 @@ contract StakingService is
     }
 
 
-    function setLockingPeriod(NftId targetNftId, Seconds lockingPeriod)
+    function setInstanceLockingPeriod(NftId instanceNftId, Seconds lockingPeriod)
         external
         virtual
-        onlyNftOwner(targetNftId)
+        restricted()
     {
         _getStakingServiceStorage()._staking.setLockingPeriod(
-            targetNftId, lockingPeriod);
+            instanceNftId, 
+            lockingPeriod);
     }
 
 
-    function setRewardRate(NftId targetNftId, UFixed rewardRate)
+    function setInstanceRewardRate(NftId instanceNftId, UFixed rewardRate)
         external
         virtual
-        onlyNftOwner(targetNftId)
+        restricted()
     {
         _getStakingServiceStorage()._staking.setRewardRate(
-            targetNftId, rewardRate);
-
+            instanceNftId, 
+            rewardRate);
     }
 
 
-    function refillRewardReserves(NftId targetNftId, Amount dipAmount)
+    function refillInstanceRewardReserves(NftId instanceNftId, address rewardProvider, Amount dipAmount)
         external
         virtual
+        restricted()
         returns (Amount newBalance)
     {
-        address rewardProvider = msg.sender;
+        return _refillRewardReserves(instanceNftId, rewardProvider, dipAmount);
+    }
 
-        // update reward reserve book keeping
-        StakingServiceStorage storage $ = _getStakingServiceStorage();
-        newBalance = $._staking.refillRewardReserves(targetNftId, dipAmount);
 
-        // collect reward dip from provider
-        $._staking.collectDipAmount(
-            rewardProvider,
-            dipAmount);
-
-        emit LogStakingServiceRewardReservesIncreased(targetNftId, rewardProvider, dipAmount, newBalance);
+    function refillRewardReservesBySender(NftId targetNftId, Amount dipAmount)
+        external
+        virtual
+        restricted()
+        returns (Amount newBalance)
+    {
+        address rewardProvider = msg.sender;
+        return _refillRewardReserves(targetNftId, rewardProvider, dipAmount);
     }
 
 
-    function withdrawRewardReserves(NftId targetNftId, Amount dipAmount)
+    function withdrawInstanceRewardReserves(NftId instanceNftId, Amount dipAmount)
         external
         virtual
-        onlyNftOwner(targetNftId)
+        restricted()
         returns (Amount newBalance)
     {
-        // modifyier checks that sender is owner
-        address targetOwner = msg.sender;
-
         // update reward reserve book keeping
         StakingServiceStorage storage $ = _getStakingServiceStorage();
-        newBalance = $._staking.withdrawRewardReserves(targetNftId, dipAmount);
+        newBalance = $._staking.withdrawRewardReserves(instanceNftId, dipAmount);
 
         // transfer withdrawal amount to target owner
+        address instanceOwner = getRegistry().ownerOf(instanceNftId);
         $._staking.transferDipAmount(
-            targetOwner,
+            instanceOwner,
             dipAmount);
 
-        emit LogStakingServiceRewardReservesDecreased(targetNftId, targetOwner, dipAmount, newBalance);
+        emit LogStakingServiceRewardReservesDecreased(instanceNftId, instanceOwner, dipAmount, newBalance);
     }
 
 
@@ -165,7 +142,7 @@ contract StakingService is
     )
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
         returns (
             NftId stakeNftId
         )
@@ -207,7 +184,7 @@ contract StakingService is
     )
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
         onlyNftOwner(stakeNftId)
     {
         StakingServiceStorage storage $ = _getStakingServiceStorage();
@@ -235,7 +212,7 @@ contract StakingService is
     )
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
         onlyNftOwner(stakeNftId)
         returns (
             NftId newStakeNftId
@@ -250,7 +227,8 @@ contract StakingService is
         NftId stakeNftId
     )
         external
-        // restricted // TODO re-enable once services have stable roles
+        virtual
+        restricted()
     {
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         $._staking.updateRewards(stakeNftId);
@@ -262,7 +240,7 @@ contract StakingService is
     function claimRewards(NftId stakeNftId)
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
         onlyNftOwner(stakeNftId)
     {
         StakingServiceStorage storage $ = _getStakingServiceStorage();
@@ -280,7 +258,7 @@ contract StakingService is
     function unstake(NftId stakeNftId)
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
         onlyNftOwner(stakeNftId)
     {
         StakingServiceStorage storage $ = _getStakingServiceStorage();
@@ -307,10 +285,13 @@ contract StakingService is
     )
         external
         virtual
+        restricted()
     {
+        // TODO implement
 
     }
 
+    //--- view functions ----------------------------------------------------//
 
     function getDipToken()
         external
@@ -338,6 +319,7 @@ contract StakingService is
         return _getStakingServiceStorage()._staking;
     }
 
+    //--- internal functions ------------------------------------------------//
 
     function _initialize(
         address owner, 
@@ -398,9 +380,32 @@ contract StakingService is
     }
 
 
+    function _refillRewardReserves(NftId targetNftId, address rewardProvider, Amount dipAmount)
+        internal
+        virtual
+        returns (Amount newBalance)
+    {
+        // update reward reserve book keeping
+        StakingServiceStorage storage $ = _getStakingServiceStorage();
+        newBalance = $._staking.refillRewardReserves(targetNftId, dipAmount);
+
+        // collect reward dip from provider
+        $._staking.collectDipAmount(
+            rewardProvider,
+            dipAmount);
+
+        emit LogStakingServiceRewardReservesIncreased(targetNftId, rewardProvider, dipAmount, newBalance);
+    }
+
+
     function _getStakingServiceStorage() private pure returns (StakingServiceStorage storage $) {
         assembly {
             $.slot := STAKING_SERVICE_LOCATION_V1
         }
     }
+
+
+    function _getDomain() internal pure override returns(ObjectType) {
+        return STAKING();
+    }
 }

package/contracts/staking/StakingServiceManager.sol

@@ -31,7 +31,6 @@ contract StakingServiceManager is
             salt);
 
         _stakingService = StakingService(address(versionable));
-        _stakingService.registerProtocolTarget();
     }
 
     //--- view functions ----------------------------------------------------//