@etherisc/gif-next 0.0.2-b8da656-306 → 0.0.2-b926d1d-788

package/contracts/staking/Staking.sol

@@ -1,18 +1,22 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
 import {IRegistry} from "../registry/IRegistry.sol";
-import {IRegistryService} from "../registry/IRegistryService.sol";
+import {IRelease} from "../registry/IRelease.sol";
 import {IStaking} from "./IStaking.sol";
 import {IVersionable} from "../upgradeability/IVersionable.sol";
 
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {Component} from "../shared/Component.sol";
 import {IComponent} from "../shared/IComponent.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, STAKING} from "../type/ObjectType.sol";
+import {ObjectType, STAKE, STAKING} from "../type/ObjectType.sol";
 import {Seconds} from "../type/Seconds.sol";
-import {StakeManagerLib} from "./StakeManagerLib.sol";
+import {Registerable} from "../shared/Registerable.sol";
+import {StakingLib} from "./StakingLib.sol";
 import {StakingReader} from "./StakingReader.sol";
 import {StakingStore} from "./StakingStore.sol";
 import {TargetManagerLib} from "./TargetManagerLib.sol";
@@ -21,7 +25,7 @@ import {TokenHandler} from "../shared/TokenHandler.sol";
 import {TokenHandlerDeployerLib} from "../shared/TokenHandlerDeployerLib.sol";
 import {TokenRegistry} from "../registry/TokenRegistry.sol";
 import {UFixed} from "../type/UFixed.sol";
-import {Version, VersionLib} from "../type/Version.sol";
+import {Version, VersionLib, VersionPart, VersionPartLib} from "../type/Version.sol";
 import {Versionable} from "../upgradeability/Versionable.sol";
 
 contract Staking is 
@@ -30,13 +34,11 @@ contract Staking is
     IStaking
 {
     string public constant CONTRACT_NAME = "Staking";
-    uint8 private constant GIF_MAJOR_VERSION = 3;
 
     // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.component.Staking.sol")) - 1)) & ~bytes32(uint256(0xff));
     bytes32 public constant STAKING_LOCATION_V1 = 0xafe8d4462b2ed26a47154f4b8f6d1497d2f772496965791d25bd456e342b7f00;
 
     struct StakingStorage {
-        IRegistryService _registryService;
         TokenRegistry _tokenRegistry;
         TokenHandler _tokenHandler;
         StakingStore _store;
@@ -60,6 +62,32 @@ contract Staking is
         _;
     }
 
+    function initializeTokenHandler()
+        external
+    {
+        if (msg.sender != address(getRegistry())) {
+            revert ErrorStakingNotRegistry(msg.sender);
+        }
+
+        StakingStorage storage $ = _getStakingStorage();
+        address dipToken = _getStakingStorage()._tokenRegistry.getDipTokenAddress();
+        $._tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(
+            address(getRegistry()),
+            address(this),
+            dipToken, 
+            getRegistry().getAuthority());
+    }
+
+
+    function approveTokenHandler(IERC20Metadata token, Amount amount)
+        public
+        restricted()
+        onlyOwner()
+    {
+        _approveTokenHandler(token, amount);
+    }
+
+
     // set/update staking reader
     function setStakingReader(StakingReader stakingReader)
         external
@@ -119,7 +147,8 @@ contract Staking is
                 objectType: expectedObjectType,
                 chainId: chainId,
                 lockingPeriod: initialLockingPeriod,
-                rewardRate: initialRewardRate}));
+                rewardRate: initialRewardRate,
+                maxStakedAmount: AmountLib.max()}));
     }
 
 
@@ -167,6 +196,21 @@ contract Staking is
         emit LogStakingRewardRateSet(targetNftId, oldRewardRate, rewardRate);
     }
 
+    function setMaxStakedAmount(NftId targetNftId, Amount maxStakedAmount)
+        external
+        virtual
+        restricted()
+        onlyTarget(targetNftId)
+    {
+        IStaking.TargetInfo memory targetInfo = getStakingReader().getTargetInfo(targetNftId);
+
+        targetInfo.maxStakedAmount = maxStakedAmount;
+        
+        _getStakingStorage()._store.updateTarget(targetNftId, targetInfo);
+
+        emit LogStakingMaxStakedAmountSet(targetNftId, maxStakedAmount);
+    }
+
 
     function refillRewardReserves(NftId targetNftId, Amount dipAmount)
         external
@@ -248,7 +292,7 @@ contract Staking is
         restricted() // only staking service
     {
         StakingStorage storage $ = _getStakingStorage();
-        Timestamp lockedUntil = StakeManagerLib.checkCreateParameters(
+        Timestamp lockedUntil = StakingLib.checkCreateParameters(
             $._reader,
             targetNftId,
             stakeAmount);
@@ -278,7 +322,7 @@ contract Staking is
         returns (Amount stakeBalance)
     {
         StakingStorage storage $ = _getStakingStorage();
-        stakeBalance = StakeManagerLib.stake(
+        stakeBalance = StakingLib.stake(
             getRegistry(),
             $._reader,
             $._store,
@@ -289,21 +333,26 @@ contract Staking is
 
     function restake(
         NftId stakeNftId, 
-        NftId newTargetNftId
+        NftId newStakeNftId
     )
         external
         virtual
         restricted() // only staking service
         onlyStake(stakeNftId)
-        returns (NftId newStakeNftId)
+        returns (Amount newStakeBalance)
     {
+        _checkNftType(stakeNftId, STAKE());
+        _checkNftType(newStakeNftId, STAKE());
+
         // TODO add check that allows additional staking amount
         StakingStorage storage $ = _getStakingStorage();
-
-        // TODO implement
+        newStakeBalance = StakingLib.restake(
+            $._reader,
+            $._store,
+            stakeNftId,
+            newStakeNftId);    
     }
 
-
     function updateRewards(NftId stakeNftId)
         external
         virtual
@@ -352,7 +401,7 @@ contract Staking is
     {
         StakingStorage storage $ = _getStakingStorage();
         
-        StakeManagerLib.checkUnstakeParameters($._reader, stakeNftId);
+        StakingLib.checkUnstakeParameters($._reader, stakeNftId);
         
         // update rewards since last update
         NftId targetNftId = _updateRewards($._reader, $._store, stakeNftId);
@@ -372,25 +421,6 @@ contract Staking is
     }
 
 
-
-    //--- other functions ---------------------------------------------------//
-
-    function collectDipAmount(address from, Amount dipAmount)
-        external
-        restricted() // only staking service
-    {
-        getTokenHandler().collectTokens(from, getWallet(), dipAmount);
-    }
-
-
-    function transferDipAmount(address to, Amount dipAmount)
-        external
-        restricted() // only staking service
-    {
-        getTokenHandler().distributeTokens(getWallet(), to, dipAmount);
-    }
-
-
     //--- view functions ----------------------------------------------------//
 
     function getStakingReader() public view returns (StakingReader reader) {
@@ -409,14 +439,24 @@ contract Staking is
         return _getStakingStorage()._tokenHandler;
     }
 
-    // from Versionable
+    // from IRegisterable
+    function getRelease()
+        public 
+        pure 
+        virtual override (IRelease, Registerable)
+        returns(VersionPart)
+    {
+        return VersionPartLib.toVersionPart(3);
+    }
+
+    // from IVersionable
     function getVersion()
         public 
         pure 
-        virtual override (IVersionable, Versionable)
+        virtual override (Component, IVersionable, Versionable)
         returns(Version)
     {
-        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
+        return VersionLib.toVersion(3,0,0);
     }
 
     //--- internal functions ------------------------------------------------//
@@ -433,7 +473,7 @@ contract Staking is
         UFixed rewardRate;
 
         (targetNftId, rewardRate) = reader.getTargetRewardRate(stakeNftId);
-        (Amount rewardIncrement, ) = StakeManagerLib.calculateRewardIncrease(
+        (Amount rewardIncrement, ) = StakingLib.calculateRewardIncrease(
             reader, 
             stakeNftId,
             rewardRate);
@@ -445,6 +485,16 @@ contract Staking is
     }
 
 
+    function _approveTokenHandler(IERC20Metadata token, Amount amount)
+        internal
+        virtual override
+    {
+        IComponentService(_getServiceAddress(STAKING())).approveTokenHandler(
+            token, 
+            amount);
+    }
+
+
     function _initialize(
         address owner, 
         bytes memory data
@@ -466,26 +516,24 @@ contract Staking is
         TokenRegistry tokenRegistry = TokenRegistry(tokenRegistryAddress);
         address dipTokenAddress = tokenRegistry.getDipTokenAddress();
 
+        // wiring to external contracts
+        StakingStorage storage $ = _getStakingStorage();
+        $._protocolNftId = registry.getProtocolNftId();
+        $._store = StakingStore(stakingStoreAddress);
+        $._reader = StakingStore(stakingStoreAddress).getStakingReader();
+        $._tokenRegistry = TokenRegistry(tokenRegistryAddress);
+
         _initializeComponent(
             authority,
             registryAddress, 
-            registry.getNftId(), 
+            registry.getNftId(), // parent nft id
             CONTRACT_NAME,
-            dipTokenAddress,
             STAKING(), 
             false, // is interceptor
             stakingOwner, 
             "", // registry data
             ""); // component data
 
-        // wiring to external contracts
-        StakingStorage storage $ = _getStakingStorage();
-        $._protocolNftId = getRegistry().getProtocolNftId();
-        $._store = StakingStore(stakingStoreAddress);
-        $._reader = StakingStore(stakingStoreAddress).getStakingReader();
-        $._tokenRegistry = TokenRegistry(tokenRegistryAddress);
-        $._tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(dipTokenAddress, authority);
-
         _registerInterface(type(IStaking).interfaceId);
     }
 

package/contracts/staking/{StakeManagerLib.sol → StakingLib.sol}

@@ -1,16 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
 import {Amount, AmountLib} from "../type/Amount.sol";
-import {Component} from "../shared/Component.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
-import {IRegistryService} from "../registry/IRegistryService.sol";
 import {IStaking} from "./IStaking.sol";
-import {Key32} from "../type/Key32.sol";
 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";
@@ -18,7 +12,7 @@ import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
 import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
 
-library StakeManagerLib {
+library StakingLib {
 
     function stake(
         IRegistry registry,
@@ -51,7 +45,12 @@ library StakeManagerLib {
 
         // TODO check that additional dip, rewards and rewards increment 
         // are still ok with max target staking amount
-        NftId targetNftId = registry.getObjectInfo(stakeNftId).parentNftId;
+        NftId targetNftId = registry.getParentNftId(stakeNftId);
+        Amount maxStakedAmount = stakingReader.getTargetMaxStakedAmount(targetNftId);
+
+        if (stakeBalance > maxStakedAmount) {
+            revert IStaking.ErrorStakingTargetMaxStakedAmountExceeded(targetNftId, maxStakedAmount, stakeBalance);
+        }
 
         stakingStore.restakeRewards(
             stakeNftId, 
@@ -72,6 +71,55 @@ library StakeManagerLib {
 
     }
 
+    function restake(
+        StakingReader stakingReader,
+        StakingStore stakingStore,
+        NftId oldStakeNftId,
+        NftId newStakeNftId
+    )
+        external
+        returns (Amount newStakeBalance)
+    {
+        checkUnstakeParameters(stakingReader, oldStakeNftId);
+        (NftId oldTargetNftId, UFixed oldRewardRate) = stakingReader.getTargetRewardRate(oldStakeNftId);
+        
+        // calculate new rewards update and unstake full amount
+        (
+            Amount rewardIncrementAmount,
+        ) = calculateRewardIncrease(
+            stakingReader, 
+            oldStakeNftId,
+            oldRewardRate);
+        stakingStore.updateRewards(
+            oldStakeNftId, 
+            oldTargetNftId, 
+            rewardIncrementAmount);
+        (
+            Amount unstakedAmount, 
+            Amount rewardsAmount
+        ) = stakingStore.unstakeUpTo(
+            oldStakeNftId,
+            oldTargetNftId,
+            AmountLib.max(), // unstake all stakes
+            AmountLib.max()); // claim all rewards
+
+        // calculate full restake amount
+        newStakeBalance = unstakedAmount + rewardsAmount;
+        NftId newTargetNftId = stakingReader.getTargetNftId(newStakeNftId);
+        
+        // create new staking target and increase stake
+        Timestamp newLockedUntil = _checkCreateParameters(stakingReader, newTargetNftId, newStakeBalance);
+        stakingStore.create(
+            newStakeNftId, 
+            IStaking.StakeInfo({
+                    lockedUntil: newLockedUntil
+                }));
+        stakingStore.increaseStake(
+            newStakeNftId, 
+            newTargetNftId, 
+            newStakeBalance);
+    }
+
     function checkCreateParameters(
         StakingReader stakingReader,
         NftId targetNftId, 
@@ -82,6 +130,19 @@ library StakeManagerLib {
         returns (
             Timestamp lockedUntil
         )
+    {
+        return _checkCreateParameters(stakingReader, targetNftId, dipAmount);
+    }
+
+    function _checkCreateParameters(
+        StakingReader stakingReader,
+        NftId targetNftId, 
+        Amount dipAmount
+    )
+        internal view
+        returns (
+            Timestamp lockedUntil
+        )
     {
         Seconds lockingPeriod = checkTarget(stakingReader, targetNftId);
         checkDipAmount(stakingReader, targetNftId, dipAmount);
@@ -104,11 +165,11 @@ library StakeManagerLib {
     {
         NftId targetNftId = stakingReader.getTargetNftId(stakeNftId);
 
-        // only accept stakes for active targets
-        if (!stakingReader.isActive(targetNftId)) {
-            revert IStaking.ErrorStakingTargetNotActive(targetNftId);
+        // target nft id must be registered
+        if (!stakingReader.isTarget(targetNftId)) {
+            revert IStaking.ErrorStakingNotTarget(targetNftId);
         }
-
+        
         IStaking.TargetInfo memory info = stakingReader.getTargetInfo(targetNftId);
         rewardRate = info.rewardRate;
         lockingPeriod = info.lockingPeriod;
@@ -121,12 +182,11 @@ library StakeManagerLib {
         public
         view
         returns (
-            UFixed rewardRate,
             Seconds lockingPeriod
         )
     {
         IStaking.StakeInfo memory stakeInfo = stakingReader.getStakeInfo(stakeNftId);
-
+        
         if (stakeInfo.lockedUntil > TimestampLib.blockTimestamp()) {
             revert IStaking.ErrorStakingStakeLocked(stakeNftId, stakeInfo.lockedUntil);
         }
@@ -146,11 +206,6 @@ library StakeManagerLib {
             revert IStaking.ErrorStakingNotTarget(targetNftId);
         }
 
-        // only accept stakes for active targets
-        if (!stakingReader.isActive(targetNftId)) {
-            revert IStaking.ErrorStakingTargetNotActive(targetNftId);
-        }
-
         lockingPeriod = stakingReader.getTargetInfo(targetNftId).lockingPeriod;
     }
 
@@ -161,14 +216,17 @@ library StakeManagerLib {
         Amount dipAmount
     )
         public 
-        pure 
+        view 
     {
         // check stake amount > 0
         if (dipAmount.eqz()) {
             revert IStaking.ErrorStakingStakeAmountZero(targetNftId);
         }
 
-        // TODO add check for target specific max dip amount (min stake + tvl * stake rate + buffer)
+        Amount maxStakedAmount = stakingReader.getTargetMaxStakedAmount(targetNftId);
+        if (dipAmount > maxStakedAmount) {
+            revert IStaking.ErrorStakingTargetMaxStakedAmountExceeded(targetNftId, maxStakedAmount, dipAmount);
+        }
     }
 
     function calculateRewardIncrease(
@@ -196,11 +254,10 @@ library StakeManagerLib {
             rewardRate,
             duration,
             stakeAmount);
-
+        
         totalDipAmount = stakeAmount + rewardAmount + rewardIncreaseAmount;
     }
 
-
     function calculateRewardAmount(
         UFixed rewardRate,
         Seconds duration, 

package/contracts/staking/StakingReader.sol

@@ -77,23 +77,8 @@ contract StakingReader is
     }
 
 
-    function isActive(NftId targetNftId) external view returns (bool) {
-        return _store.getTargetNftIdSet().isActive(targetNftId);
-    }
-
-
-    function activeTargets() external view returns (uint256) {
-        return _store.getTargetNftIdSet().activeNftIds();
-    }
-
-
-    function getActiveTargetNftId(uint256 idx) external view returns (NftId) {
-        return _store.getTargetNftIdSet().getActiveNftId(idx);
-    }
-
-
     function getTargetNftId(NftId stakeNftId) public view returns (NftId targetNftId) {
-        return _registry.getObjectInfo(stakeNftId).parentNftId;
+        return _registry.getParentNftId(stakeNftId);
     }
 
 
@@ -119,6 +104,11 @@ contract StakingReader is
         rewardRate = getTargetInfo(targetNftId).rewardRate;
     }
 
+    /// @dev get the max staked amount allowed for the specified target nft id.
+    function getTargetMaxStakedAmount(NftId targetNftId) external view returns (Amount maxStakedAmount) {
+        return getTargetInfo(targetNftId).maxStakedAmount;
+    }
+
 
     /// @dev get the reward rate for the specified target nft id.
     function getRewardRate(NftId targetNftId) external view returns (UFixed rewardRate) {