@etherisc/gif-next 0.0.2-95b223b-528 → 0.0.2-95f0eec-843

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

@@ -10,8 +10,9 @@ import {IStaking} from "../staking/IStaking.sol";
 import {Amount} from "../type/Amount.sol";
 import {Blocknumber}  from "../type/Blocknumber.sol";
 import {NftId} from "../type/NftId.sol";
-import {STAKE, TARGET} from "../type/ObjectType.sol";
+import {Seconds} from "../type/Seconds.sol";
 import {StakingStore} from "./StakingStore.sol";
+import {STAKE, TARGET} from "../type/ObjectType.sol";
 import {Timestamp} from "../type/Timestamp.sol";
 import {UFixed} from "../type/UFixed.sol";
 
@@ -57,6 +58,10 @@ contract StakingReader is
         return _staking;
     }
 
+    function getProtocolNftId() external view returns (NftId protocolNftId) {
+        return _registry.getProtocolNftId();
+    }
+
     function getStakingRate(uint256 chainId, address token) external view returns (UFixed stakingRate) { 
         return _store.getStakingRate(chainId, token); 
     }
@@ -77,23 +82,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);
     }
 
 
@@ -113,14 +103,33 @@ contract StakingReader is
     }
 
 
-    /// @dev get the reward rate that applies to the specified stake nft id.
+    /// @dev Get the locking period that applies to the specified stake NFT ID.
+    function getTargetLockingPeriod(NftId stakeNftId) external view returns (NftId targetNftId, Seconds lockingPeriod) {
+        targetNftId = getTargetNftId(stakeNftId);
+        lockingPeriod = getTargetInfo(targetNftId).lockingPeriod;
+    }
+
+
+    /// @dev Get the reward rate that applies to the specified stake NFT ID.
     function getTargetRewardRate(NftId stakeNftId) external view returns (NftId targetNftId, UFixed rewardRate) {
         targetNftId = getTargetNftId(stakeNftId);
         rewardRate = getTargetInfo(targetNftId).rewardRate;
     }
 
 
-    /// @dev get the reward rate for the specified target nft id.
+    /// @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 getLockingPeriod(NftId targetNftId) external view returns (Seconds lockingPeriod) {
+        return getTargetInfo(targetNftId).lockingPeriod;
+    }
+
+
+    /// @dev Get the reward rate for the specified target NFT ID.
     function getRewardRate(NftId targetNftId) external view returns (UFixed rewardRate) {
         return getTargetInfo(targetNftId).rewardRate;
     }

package/contracts/staking/StakingService.sol

@@ -3,12 +3,13 @@ pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
-import {Amount} from "../type/Amount.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
 import {IStaking} from "./IStaking.sol";
 import {IStakingService} from "./IStakingService.sol";
+
+import {Amount} from "../type/Amount.sol";
+import {RegistryService} from "../registry/RegistryService.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
 import {ObjectType, INSTANCE, REGISTRY, STAKE, STAKING} from "../type/ObjectType.sol";
 import {Seconds} from "../type/Seconds.sol";
@@ -32,6 +33,28 @@ contract StakingService is
         TokenHandler _tokenHandler;
     }
 
+
+    modifier onlyStaking() {
+        if (msg.sender != address(_getStakingServiceStorage()._staking)) {
+            revert ErrorStakingServiceNotStaking(msg.sender);
+        }
+        _;
+    }
+
+
+    function approveTokenHandler(
+        IERC20Metadata token,
+        Amount amount
+    )
+        external
+        virtual
+        onlyStaking()
+    {
+        _getStakingServiceStorage()._tokenHandler.approve(token, amount);
+    }
+
+
+    /// @inheritdoc IStakingService
     function createInstanceTarget(
         NftId targetNftId,
         Seconds initialLockingPeriod,
@@ -76,6 +99,17 @@ contract StakingService is
             rewardRate);
     }
 
+    function setInstanceMaxStakedAmount(NftId instanceNftId, Amount maxStakingAmount)
+        external
+        virtual
+        restricted()
+    {
+        _checkNftType(instanceNftId, INSTANCE());
+        _getStakingServiceStorage()._staking.setMaxStakedAmount(
+            instanceNftId, 
+            maxStakingAmount);
+    }
+
 
     function refillInstanceRewardReserves(NftId instanceNftId, address rewardProvider, Amount dipAmount)
         external
@@ -113,8 +147,7 @@ contract StakingService is
         // transfer withdrawal amount to target owner
         address instanceOwner = getRegistry().ownerOf(instanceNftId);
         emit LogStakingServiceRewardReservesDecreased(instanceNftId, instanceOwner, dipAmount, newBalance);
-        _distributeToken(
-            $._staking.getTokenHandler(),
+        $._tokenHandler.pushToken(
             instanceOwner,
             dipAmount);
     }
@@ -162,39 +195,11 @@ contract StakingService is
         emit LogStakingServiceStakeCreated(stakeNftId, targetNftId, stakeOwner, dipAmount);
 
         // collect staked dip by staking
-        _collectToken(
-            $._staking.getTokenHandler(),
+        $._tokenHandler.pullToken(
             stakeOwner, 
             dipAmount);
     }
 
-    function _collectToken(
-        TokenHandler tokenHandler,
-        address from,
-        Amount amount
-    )
-        internal
-        virtual
-    {
-        tokenHandler.collectTokens(
-            from, 
-            amount);
-    }
-
-    function _distributeToken(
-        TokenHandler tokenHandler,
-        address to,
-        Amount amount
-    )
-        internal
-        virtual
-    {
-        tokenHandler.distributeTokens(
-            tokenHandler.getWallet(), 
-            to, 
-            amount);
-    }
-
 
     function stake(
         NftId stakeNftId,
@@ -218,8 +223,7 @@ contract StakingService is
         // collect staked dip by staking
         if (dipAmount.gtz()) {
             emit LogStakingServiceStakeIncreased(stakeNftId, stakeOwner, dipAmount, stakeBalance);
-            _collectToken(
-                $._staking.getTokenHandler(),
+        $._tokenHandler.pullToken(
                 stakeOwner,
                 dipAmount);
         }
@@ -235,13 +239,36 @@ contract StakingService is
         restricted()
         onlyNftOwner(stakeNftId)
         returns (
-            NftId newStakeNftId
+            NftId newStakeNftId,
+            Amount newStakeBalance
         )
     {
         _checkNftType(stakeNftId, STAKE());
 
         StakingServiceStorage storage $ = _getStakingServiceStorage();
-        // TODO implement
+        address stakeOwner = msg.sender;
+
+        if (! getRegistry().isRegistered(newTargetNftId)) {
+            revert ErrorStakingServiceTargetUnknown(newTargetNftId);
+        }
+
+        // register new stake object with registry
+        newStakeNftId = $._registryService.registerStake(
+            IRegistry.ObjectInfo({
+                nftId: NftIdLib.zero(),
+                parentNftId: newTargetNftId,
+                objectType: STAKE(),
+                isInterceptor: false,
+                objectAddress: address(0),
+                initialOwner: stakeOwner,
+                data: ""
+            }));
+
+        newStakeBalance = $._staking.restake(
+            stakeNftId, 
+            newStakeNftId);
+
+        emit LogStakingServiceStakeRestaked(stakeOwner, stakeNftId, newStakeNftId, newTargetNftId, newStakeBalance);
     } 
 
 
@@ -274,8 +301,7 @@ contract StakingService is
 
         Amount rewardsClaimedAmount = $._staking.claimRewards(stakeNftId);
         emit LogStakingServiceRewardsClaimed(stakeNftId, stakeOwner, rewardsClaimedAmount);
-        _distributeToken(
-            $._staking.getTokenHandler(),
+        $._tokenHandler.pushToken(
             stakeOwner,
             rewardsClaimedAmount);
     }
@@ -300,7 +326,7 @@ contract StakingService is
         Amount totalAmount = unstakedAmount + rewardsClaimedAmount;
         emit LogStakingServiceUnstaked(stakeNftId, stakeOwner, totalAmount);
 
-        $._staking.getTokenHandler().pushToken(
+        $._tokenHandler.pushToken(
             stakeOwner, 
             totalAmount);
     }
@@ -323,6 +349,7 @@ contract StakingService is
 
     function getDipToken()
         external
+        view
         virtual
         returns (IERC20Metadata dip)
     {
@@ -332,6 +359,7 @@ contract StakingService is
 
     function getTokenHandler()
         external
+        view
         virtual
         returns (TokenHandler tokenHandler)
     {
@@ -341,6 +369,7 @@ contract StakingService is
 
     function getStaking()
         external
+        view
         virtual
         returns (IStaking staking)
     {
@@ -359,15 +388,15 @@ contract StakingService is
     {
         (
             address authority,
-            address registryAddress,
-            address stakingAddress
+            address registry,
+            address staking
         ) = abi.decode(data, (address, address, address));
 
-        _initializeService(registryAddress, authority, owner);
+        __Service_init(authority, registry, owner);
 
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         $._registryService = RegistryService(_getServiceAddress(REGISTRY()));
-        $._staking = _registerStaking(stakingAddress);
+        $._staking = _registerStaking(staking);
         $._dip = $._staking.getToken();
         $._tokenHandler = $._staking.getTokenHandler();
 
@@ -420,8 +449,7 @@ contract StakingService is
         emit LogStakingServiceRewardReservesIncreased(targetNftId, rewardProvider, dipAmount, newBalance);
 
         // collect reward dip from provider
-        _collectToken(
-            $._staking.getTokenHandler(),
+        $._tokenHandler.pullToken(
             rewardProvider,
             dipAmount);
     }

package/contracts/staking/StakingServiceManager.sol

@@ -15,17 +15,18 @@ contract StakingServiceManager is
     /// @dev initializes proxy manager with service implementation 
     constructor(
         address authority,
-        address registryAddress,
+        address registry,
         bytes32 salt
     )
     {
         StakingService svc = new StakingService();
         bytes memory data = abi.encode(
             authority, 
-            registryAddress, 
-            IRegistry(registryAddress).getStakingAddress());
+            registry, 
+            IRegistry(registry).getStakingAddress());
+
         IVersionable versionable = initialize(
-            registryAddress,
+            registry,
             address(svc), 
             data,
             salt);

package/contracts/staking/StakingStore.sol

@@ -80,7 +80,7 @@ contract StakingStore is
         setAuthority(registry.getAuthority());
 
         // set internal variables
-        _registry = registry; //TODO if keeps registry -> RegistryLinked and checks registry address
+        _registry = registry;
         _reader = reader;
         _targetNftIdSet = new NftIdSet();
 
@@ -91,7 +91,8 @@ contract StakingStore is
                 objectType: PROTOCOL(),
                 chainId: 1,
                 lockingPeriod: TargetManagerLib.getDefaultLockingPeriod(),
-                rewardRate: TargetManagerLib.getDefaultRewardRate()}));
+                rewardRate: TargetManagerLib.getDefaultRewardRate(),
+                maxStakedAmount: AmountLib.max()}));
     }
 
 

package/contracts/staking/TargetManagerLib.sol

@@ -160,7 +160,7 @@ library TargetManagerLib {
         UFixed stakingRate
     )
         public
-        view
+        pure
         returns (Amount dipAmount)
     {
         dipAmount = tokenAmount.multiplyWith(stakingRate);

package/contracts/type/Fee.sol

@@ -5,16 +5,16 @@ import {Amount, AmountLib} from "./Amount.sol";
 import {UFixed, UFixedLib} from "./UFixed.sol";
 
 struct Fee {
+    // slot 0
     UFixed fractionalFee;
-    // TODO migrate fixed fee to Amount
-    uint256 fixedFee;
+    Amount fixedFee;
 }
 
 library FeeLib {
 
     /// @dev Return a zero fee struct (0, 0)
     function zero() public pure returns (Fee memory fee) {
-        return Fee(UFixed.wrap(0), 0);
+        return Fee(UFixed.wrap(0), AmountLib.zero());
     }
 
     /// @dev Converts the uint256 to a fee struct.
@@ -22,7 +22,7 @@ library FeeLib {
         UFixed fractionalFee,
         uint256 fixedFee
     ) public pure returns (Fee memory fee) {
-        return Fee(fractionalFee, fixedFee);
+        return Fee(fractionalFee, AmountLib.toAmount(fixedFee));
     }
 
     /// @dev Calculates fee and net amounts for the provided parameters
@@ -41,14 +41,14 @@ library FeeLib {
         if(gtz(fee)) {
             UFixed fractionalAmount = 
                 amount.toUFixed() * fee.fractionalFee;
-            feeAmount = AmountLib.toAmount(fractionalAmount.toInt() + fee.fixedFee);
+            feeAmount = AmountLib.toAmount(fractionalAmount.toInt()) + fee.fixedFee;
             netAmount = netAmount - feeAmount;
         }
     }
 
     /// @dev Return the percent fee struct (x%, 0)
     function percentageFee(uint8 percent) public pure returns (Fee memory fee) {
-        return Fee(UFixedLib.toUFixed(percent, -2), 0);
+        return Fee(UFixedLib.toUFixed(percent, -2), AmountLib.zero());
     }
 
     // pure free functions for operators
@@ -57,10 +57,10 @@ library FeeLib {
     }
 
     function gtz(Fee memory fee) public pure returns (bool) {
-        return UFixed.unwrap(fee.fractionalFee) > 0 || fee.fixedFee > 0;
+        return UFixed.unwrap(fee.fractionalFee) > 0 || fee.fixedFee.gtz();
     }
 
     function eqz(Fee memory fee) public pure returns (bool) {
-        return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
+        return fee.fixedFee.eqz() && UFixed.unwrap(fee.fractionalFee) == 0;
     }
 }