@etherisc/gif-next 0.0.2-d7cec72-860 → 0.0.2-d8532da-980

package/contracts/staking/Staking.sol

@@ -1,29 +1,32 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount, AmountLib} from "../type/Amount.sol";
-import {ChainNft} from "../registry/ChainNft.sol";
-import {Component} from "../shared/Component.sol";
+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 "../shared/IVersionable.sol";
-import {Key32} from "../type/Key32.sol";
-import {LibNftIdSet} from "../type/NftIdSet.sol";
-import {NftId, NftIdLib} from "../type/NftId.sol";
-import {NftIdSetManager} from "../shared/NftIdSetManager.sol";
-import {ObjectType, INSTANCE, PROTOCOL, STAKE, STAKING, TARGET} from "../type/ObjectType.sol";
-import {Seconds, SecondsLib} from "../type/Seconds.sol";
-import {StakeManagerLib} from "./StakeManagerLib.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, STAKE, STAKING} from "../type/ObjectType.sol";
+import {Seconds} from "../type/Seconds.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";
-import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
+import {TokenHandlerDeployerLib} from "../shared/TokenHandlerDeployerLib.sol";
 import {TokenRegistry} from "../registry/TokenRegistry.sol";
-import {UFixed, UFixedLib} from "../type/UFixed.sol";
-import {Version, VersionLib} from "../type/Version.sol";
-import {Versionable} from "../shared/Versionable.sol";
+import {UFixed} from "../type/UFixed.sol";
+import {Version, VersionLib, VersionPart, VersionPartLib} from "../type/Version.sol";
+import {Versionable} from "../upgradeability/Versionable.sol";
 
 contract Staking is 
     Component,
@@ -31,14 +34,13 @@ 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;
         StakingReader _reader;
         NftId _protocolNftId;
@@ -54,30 +56,66 @@ contract Staking is
 
 
     modifier onlyTarget(NftId targetNftId) {
-        if (!_getStakingStorage()._store.getTargetManager().exists(targetNftId)) {
+        if (!_getStakingStorage()._store.getTargetNftIdSet().exists(targetNftId)) {
             revert ErrorStakingNotTarget(targetNftId);
         }
         _;
     }
 
-    // set/update staking reader
-    function setStakingReader(StakingReader stakingReader)
+    //--- contract intitialization -------------------------------------------
+
+    function initializeTokenHandler()
         external
         virtual
-        onlyOwner()
     {
-        if(stakingReader.getStaking() != IStaking(this)) {
-            revert ErrorStakingStakingReaderStakingMismatch(address(stakingReader.getStaking()));
+        if (msg.sender != address(getRegistry())) {
+            revert ErrorStakingNotRegistry(msg.sender);
         }
 
-        _getStakingStorage()._reader = stakingReader;
+        StakingStorage storage $ = _getStakingStorage();
+        address dipToken = _getStakingStorage()._tokenRegistry.getDipTokenAddress();
+        $._tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(
+            address(getRegistry()),
+            address(this),
+            dipToken, 
+            getRegistry().getAuthority());
+    }
+
+    //--- staking owner functions -------------------------------------------//
+
+    // TODO also make sure that protocol rewards can be refilled and withdrawn
+
+    /// @inheritdoc IStaking
+    function setProtocolRewardRate(UFixed rewardRate)
+        external
+        virtual
+        restricted()
+        onlyOwner()
+    {
+        NftId protocolNftId = getRegistry().getProtocolNftId();
+        UFixed oldRewardRate = _updateRewardRate(protocolNftId, rewardRate);
+        emit LogStakingProtocolRewardRateSet(protocolNftId, oldRewardRate, rewardRate);
     }
 
 
-    // rate management 
+    /// @inheritdoc IStaking
+    function setProtocolLockingPeriod(Seconds lockingPeriod)
+        external
+        virtual
+        restricted()
+        onlyOwner()
+    {
+        NftId protocolNftId = getRegistry().getProtocolNftId();
+        Seconds oldLockingPeriod = _updateLockingPeriod(protocolNftId, lockingPeriod);
+        emit LogStakingProtocolLockingPeriodSet(protocolNftId, oldLockingPeriod, lockingPeriod);
+    }
+
+
+    /// @inheritdoc IStaking
     function setStakingRate(uint256 chainId, address token, UFixed stakingRate)
         external
         virtual
+        restricted()
         onlyOwner()
     {
         StakingStorage storage $ = _getStakingStorage();
@@ -92,7 +130,31 @@ contract Staking is
         emit LogStakingStakingRateSet(chainId, token, oldStakingRate, stakingRate);
     }
 
-    // target management
+
+    /// @inheritdoc IStaking
+    function setStakingReader(StakingReader stakingReader)
+        external
+        virtual
+        onlyOwner()
+    {
+        if(stakingReader.getStaking() != IStaking(this)) {
+            revert ErrorStakingStakingReaderStakingMismatch(address(stakingReader.getStaking()));
+        }
+
+        _getStakingStorage()._reader = stakingReader;
+    }
+
+
+    /// @inheritdoc IStaking
+    function approveTokenHandler(IERC20Metadata token, Amount amount)
+        public
+        restricted()
+        onlyOwner()
+    {
+        _approveTokenHandler(token, amount);
+    }
+
+    //--- target management -------------------------------------------------//
 
     function registerTarget(
         NftId targetNftId,
@@ -119,7 +181,21 @@ contract Staking is
                 objectType: expectedObjectType,
                 chainId: chainId,
                 lockingPeriod: initialLockingPeriod,
-                rewardRate: initialRewardRate}));
+                rewardRate: initialRewardRate,
+                maxStakedAmount: AmountLib.max()}));
+
+        emit LogStakingTargetRegistered(targetNftId, expectedObjectType, initialLockingPeriod, initialRewardRate, AmountLib.max());
+    }
+
+
+    function setRewardRate(NftId targetNftId, UFixed rewardRate)
+        external
+        virtual
+        restricted()
+        onlyTarget(targetNftId)
+    {
+        UFixed oldRewardRate = _updateRewardRate(targetNftId, rewardRate);
+        emit LogStakingRewardRateSet(targetNftId, oldRewardRate, rewardRate);
     }
 
 
@@ -132,39 +208,24 @@ contract Staking is
         restricted()
         onlyTarget(targetNftId)
     {
-        (
-            Seconds oldLockingPeriod,
-            TargetInfo memory targetInfo
-        ) = TargetManagerLib.updateLockingPeriod(
-            this,
-            targetNftId,
-            lockingPeriod);
-        
-        _getStakingStorage()._store.updateTarget(targetNftId, targetInfo);
-
+        Seconds oldLockingPeriod = _updateLockingPeriod(targetNftId, lockingPeriod);
         emit LogStakingLockingPeriodSet(targetNftId, oldLockingPeriod, lockingPeriod);
     }
 
-    // TODO add function to set protocol reward rate: onlyOwner
-    // get protocol nft id (from where)
 
-    function setRewardRate(NftId targetNftId, UFixed rewardRate)
+    function setMaxStakedAmount(NftId targetNftId, Amount maxStakedAmount)
         external
         virtual
         restricted()
         onlyTarget(targetNftId)
     {
-        (
-            UFixed oldRewardRate,
-            TargetInfo memory targetInfo
-        ) = TargetManagerLib.updateRewardRate(
-            this,
-            targetNftId,
-            rewardRate);
+        IStaking.TargetInfo memory targetInfo = getStakingReader().getTargetInfo(targetNftId);
+
+        targetInfo.maxStakedAmount = maxStakedAmount;
         
         _getStakingStorage()._store.updateTarget(targetNftId, targetInfo);
 
-        emit LogStakingRewardRateSet(targetNftId, oldRewardRate, rewardRate);
+        emit LogStakingMaxStakedAmountSet(targetNftId, maxStakedAmount);
     }
 
 
@@ -199,7 +260,7 @@ contract Staking is
         returns (Amount newBalance)
     {
         StakingStorage storage $ = _getStakingStorage();
-        uint chainId = $._reader.getTargetInfo(targetNftId).chainId;
+        uint256 chainId = $._reader.getTargetInfo(targetNftId).chainId;
         UFixed stakingRate = $._reader.getStakingRate(chainId, token);
         newBalance = $._store.increaseTotalValueLocked(targetNftId, stakingRate, token, amount);
     }
@@ -212,7 +273,7 @@ contract Staking is
         returns (Amount newBalance)
     {
         StakingStorage storage $ = _getStakingStorage();
-        uint chainId = $._reader.getTargetInfo(targetNftId).chainId;
+        uint256 chainId = $._reader.getTargetInfo(targetNftId).chainId;
         UFixed stakingRate = $._reader.getStakingRate(chainId, token);
         newBalance = $._store.decreaseTotalValueLocked(targetNftId, stakingRate, token, amount);
     }
@@ -248,7 +309,7 @@ contract Staking is
         restricted() // only staking service
     {
         StakingStorage storage $ = _getStakingStorage();
-        Timestamp lockedUntil = StakeManagerLib.checkCreateParameters(
+        Timestamp lockedUntil = StakingLib.checkCreateParameters(
             $._reader,
             targetNftId,
             stakeAmount);
@@ -278,7 +339,7 @@ contract Staking is
         returns (Amount stakeBalance)
     {
         StakingStorage storage $ = _getStakingStorage();
-        stakeBalance = StakeManagerLib.stake(
+        stakeBalance = StakingLib.stake(
             getRegistry(),
             $._reader,
             $._store,
@@ -289,20 +350,25 @@ 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
@@ -350,9 +416,10 @@ contract Staking is
             Amount rewardsClaimedAmount
         )
     {
-        // TODO add check that stake locking is in the past
         StakingStorage storage $ = _getStakingStorage();
-
+        
+        StakingLib.checkUnstakeParameters($._reader, stakeNftId);
+        
         // update rewards since last update
         NftId targetNftId = _updateRewards($._reader, $._store, stakeNftId);
 
@@ -371,70 +438,83 @@ contract Staking is
     }
 
 
-
-    //--- other functions ---------------------------------------------------//
-
-    function collectDipAmount(address from, Amount dipAmount)
-        external
-        restricted() // only staking service
-    {
-        TokenHandler tokenHandler = getTokenHandler();
-        address stakingWallet = getWallet();
-
-        StakeManagerLib.checkDipBalanceAndAllowance(
-            getToken(), 
-            from, 
-            address(tokenHandler), 
-            dipAmount);
-
-        tokenHandler.transfer(from, stakingWallet, dipAmount);
-    }
-
-
-    function transferDipAmount(address to, Amount dipAmount)
-        external
-        restricted() // only staking service
-    {
-        TokenHandler tokenHandler = getTokenHandler();
-        address stakingWallet = getWallet();
-
-        StakeManagerLib.checkDipBalanceAndAllowance(
-            getToken(), 
-            stakingWallet, 
-            address(tokenHandler), 
-            dipAmount);
-
-        tokenHandler.transfer(stakingWallet, to, dipAmount);
-    }
-
-
     //--- view functions ----------------------------------------------------//
 
-    function getStakingReader() public view returns (StakingReader reader) {
+    function getStakingReader() public virtual view returns (StakingReader reader) {
         return _getStakingStorage()._reader;
     }
 
-    function getStakingStore() external view returns (StakingStore stakingStore) {
+    function getStakingStore() external virtual view returns (StakingStore stakingStore) {
         return _getStakingStorage()._store;
     }
 
-    function getTokenRegistryAddress() external view returns (address tokenRegistry) {
+    function getTokenRegistryAddress() external virtual view returns (address tokenRegistry) {
         return address(_getStakingStorage()._tokenRegistry);
     }
 
+    function getTokenHandler() public virtual override(Component, IComponent) view returns (TokenHandler tokenHandler) {
+        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 ------------------------------------------------//
 
+    function _updateRewardRate(
+        NftId targetNftId, 
+        UFixed rewardRate
+    )
+        internal 
+        virtual 
+        returns (UFixed oldRewardRate) 
+    {
+
+        TargetInfo memory targetInfo;
+        (oldRewardRate, targetInfo) = TargetManagerLib.updateRewardRate(
+            this,
+            targetNftId,
+            rewardRate);
+        
+        _getStakingStorage()._store.updateTarget(targetNftId, targetInfo);
+    }
+
+
+    function _updateLockingPeriod(
+        NftId targetNftId, 
+        Seconds lockingPeriod
+    )
+        internal 
+        virtual 
+        returns (Seconds oldLockingPeriod) 
+    {
+        TargetInfo memory targetInfo;
+        (oldLockingPeriod, targetInfo) = TargetManagerLib.updateLockingPeriod(
+            this,
+            targetNftId,
+            lockingPeriod);
+        
+        _getStakingStorage()._store.updateTarget(targetNftId, targetInfo);
+    }
+
+
     function _updateRewards(
         StakingReader reader,
         StakingStore store,
@@ -447,7 +527,7 @@ contract Staking is
         UFixed rewardRate;
 
         (targetNftId, rewardRate) = reader.getTargetRewardRate(stakeNftId);
-        (Amount rewardIncrement, ) = StakeManagerLib.calculateRewardIncrease(
+        (Amount rewardIncrement, ) = StakingLib.calculateRewardIncrease(
             reader, 
             stakeNftId,
             rewardRate);
@@ -459,13 +539,26 @@ contract Staking is
     }
 
 
+    function _approveTokenHandler(
+        IERC20Metadata token, 
+        Amount amount)
+        internal
+        virtual override
+    {
+        IComponentService(_getServiceAddress(STAKING())).approveTokenHandler(
+            token, 
+            amount);
+    }
+
+
+    /// @dev top level initializer (upgradable contract)
     function _initialize(
-        address owner, 
+        address, 
         bytes memory data
     )
         internal
         virtual override
-        initializer
+        initializer()
     {
         (
             address registryAddress,
@@ -477,31 +570,30 @@ contract Staking is
         // only admin(authority) and dip token address are set in registry at this point
         IRegistry registry = IRegistry(registryAddress);
         address authority = registry.getAuthority();
-        TokenRegistry tokenRegistry = TokenRegistry(tokenRegistryAddress);
-        address dipTokenAddress = tokenRegistry.getDipTokenAddress();
 
-        initializeComponent(
+        // 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
 
-        _createAndSetTokenHandler();
-
-        // wiring to external contracts
-        StakingStorage storage $ = _getStakingStorage();
-        $._protocolNftId = getRegistry().getProtocolNftId();
-        $._store = StakingStore(stakingStoreAddress);
-        $._reader = StakingStore(stakingStoreAddress).getStakingReader();
-        $._tokenRegistry = TokenRegistry(tokenRegistryAddress);
+        // HINT: protocol target is created in the StakingStore constructor.
+        // This allows setting up the protocol target before the full 
+        // staking authorization setup is in place.
 
-        registerInterface(type(IStaking).interfaceId);
+        _registerInterface(type(IStaking).interfaceId);
     }