@etherisc/gif-next 0.0.2-ee01d06-525 → 0.0.2-ee54ca6-863

package/contracts/staking/StakeManagerLib.sol

@@ -114,6 +114,24 @@ library StakeManagerLib {
         lockingPeriod = info.lockingPeriod;
     }
 
+    function checkUnstakeParameters(
+        StakingReader stakingReader,
+        NftId stakeNftId
+    )
+        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);
+        }
+    }
+
 
     function checkTarget(
         StakingReader stakingReader,
@@ -153,31 +171,6 @@ library StakeManagerLib {
         // TODO add check for target specific max dip amount (min stake + tvl * stake rate + buffer)
     }
 
-
-    function checkDipBalanceAndAllowance(
-        IERC20Metadata dip, 
-        address owner, 
-        address tokenHandlerAddress, 
-        Amount dipAmount
-    )
-        public
-        view
-    {
-        // check balance
-        uint256 amount = dipAmount.toInt();
-        uint256 dipBalance = dip.balanceOf(owner);
-        if (dipBalance < amount) {
-            revert IStaking.ErrorStakingDipBalanceInsufficient(owner, amount, dipBalance);
-        }
-
-        // check allowance
-        uint256 dipAllowance = dip.allowance(owner, tokenHandlerAddress);
-        if (dipAllowance < amount) {
-            revert IStaking.ErrorStakingDipAllowanceInsufficient(owner, tokenHandlerAddress, amount, dipAllowance);
-        }
-    }
-
-
     function calculateRewardIncrease(
         StakingReader stakingReader,
         NftId stakeNftId,

package/contracts/staking/Staking.sol

@@ -1,29 +1,28 @@
 // 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 {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryService} from "../registry/IRegistryService.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 {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 {NftId} from "../type/NftId.sol";
+import {ObjectType, STAKING} from "../type/ObjectType.sol";
+import {Seconds} from "../type/Seconds.sol";
 import {StakeManagerLib} from "./StakeManagerLib.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 {UFixed} from "../type/UFixed.sol";
 import {Version, VersionLib} from "../type/Version.sol";
-import {Versionable} from "../shared/Versionable.sol";
+import {Versionable} from "../upgradeability/Versionable.sol";
 
 contract Staking is 
     Component,
@@ -39,6 +38,7 @@ contract Staking is
     struct StakingStorage {
         IRegistryService _registryService;
         TokenRegistry _tokenRegistry;
+        TokenHandler _tokenHandler;
         StakingStore _store;
         StakingReader _reader;
         NftId _protocolNftId;
@@ -54,7 +54,7 @@ contract Staking is
 
 
     modifier onlyTarget(NftId targetNftId) {
-        if (!_getStakingStorage()._store.getTargetManager().exists(targetNftId)) {
+        if (!_getStakingStorage()._store.getTargetNftIdSet().exists(targetNftId)) {
             revert ErrorStakingNotTarget(targetNftId);
         }
         _;
@@ -301,7 +301,7 @@ contract Staking is
         StakingStorage storage $ = _getStakingStorage();
 
         // TODO implement
-   }
+    }
 
 
     function updateRewards(NftId stakeNftId)
@@ -350,9 +350,10 @@ contract Staking is
             Amount rewardsClaimedAmount
         )
     {
-        // TODO add check that stake locking is in the past
         StakingStorage storage $ = _getStakingStorage();
-
+        
+        StakeManagerLib.checkUnstakeParameters($._reader, stakeNftId);
+        
         // update rewards since last update
         NftId targetNftId = _updateRewards($._reader, $._store, stakeNftId);
 
@@ -378,16 +379,7 @@ contract Staking is
         external
         restricted() // only staking service
     {
-        TokenHandler tokenHandler = getTokenHandler();
-        address stakingWallet = getWallet();
-
-        StakeManagerLib.checkDipBalanceAndAllowance(
-            getToken(), 
-            from, 
-            address(tokenHandler), 
-            dipAmount);
-
-        tokenHandler.transfer(from, stakingWallet, dipAmount);
+        getTokenHandler().collectTokens(from, getWallet(), dipAmount);
     }
 
 
@@ -395,16 +387,7 @@ contract Staking is
         external
         restricted() // only staking service
     {
-        TokenHandler tokenHandler = getTokenHandler();
-        address stakingWallet = getWallet();
-
-        StakeManagerLib.checkDipBalanceAndAllowance(
-            getToken(), 
-            stakingWallet, 
-            address(tokenHandler), 
-            dipAmount);
-
-        tokenHandler.transfer(stakingWallet, to, dipAmount);
+        getTokenHandler().distributeTokens(getWallet(), to, dipAmount);
     }
 
 
@@ -422,6 +405,9 @@ contract Staking is
         return address(_getStakingStorage()._tokenRegistry);
     }
 
+    function getTokenHandler() public virtual override(Component, IComponent) view returns (TokenHandler tokenHandler) {
+        return _getStakingStorage()._tokenHandler;
+    }
 
     // from Versionable
     function getVersion()
@@ -480,7 +466,7 @@ contract Staking is
         TokenRegistry tokenRegistry = TokenRegistry(tokenRegistryAddress);
         address dipTokenAddress = tokenRegistry.getDipTokenAddress();
 
-        initializeComponent(
+        _initializeComponent(
             authority,
             registryAddress, 
             registry.getNftId(), 
@@ -492,16 +478,15 @@ contract Staking is
             "", // 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);
+        $._tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(dipTokenAddress, authority);
 
-        registerInterface(type(IStaking).interfaceId);
+        _registerInterface(type(IStaking).interfaceId);
     }
 
 

package/contracts/staking/StakingManager.sol

@@ -1,14 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
-import {ReleaseManager} from "../registry/ReleaseManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {Staking} from "./Staking.sol";
-import {StakingReader} from "./StakingReader.sol";
-import {StakingStore} from "./StakingStore.sol";
 
-import {RegistryAdmin} from "../registry/RegistryAdmin.sol";
 
 contract StakingManager is
     ProxyManager

package/contracts/staking/StakingReader.sol

@@ -1,22 +1,18 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount} from "../type/Amount.sol";
-import {Blocknumber}  from "../type/Blocknumber.sol";
-import {IKeyValueStore} from "../shared/IKeyValueStore.sol";
-import {IComponent} from "../shared/IComponent.sol";
-import {InitializableCustom} from "../shared/InitializableCustom.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryLinked} from "../shared/IRegistryLinked.sol";
 import {IStaking} from "../staking/IStaking.sol";
-import {IVersionable} from "../shared/IVersionable.sol";
+
+import {Amount} from "../type/Amount.sol";
+import {Blocknumber}  from "../type/Blocknumber.sol";
+import {InitializableCustom} from "../shared/InitializableCustom.sol";
 import {NftId} from "../type/NftId.sol";
-import {NftIdSetManager} from "../shared/NftIdSetManager.sol";
-import {ObjectType, STAKE, TARGET} from "../type/ObjectType.sol";
-import {Seconds} from "../type/Seconds.sol";
+import {STAKE, TARGET} from "../type/ObjectType.sol";
 import {StakingStore} from "./StakingStore.sol";
 import {Timestamp} from "../type/Timestamp.sol";
-import {UFixed, UFixedLib} from "../type/UFixed.sol";
+import {UFixed} from "../type/UFixed.sol";
 
 contract StakingReader is
     IRegistryLinked,
@@ -60,32 +56,32 @@ contract StakingReader is
 
 
     function isTarget(NftId targetNftId) external view returns (bool) {
-        return _store.getTargetManager().exists(targetNftId);
+        return _store.getTargetNftIdSet().exists(targetNftId);
     }
 
 
     function targets() external view returns (uint256) {
-        return _store.getTargetManager().nftIds();
+        return _store.getTargetNftIdSet().nftIds();
     }
 
 
     function getTargetNftId(uint256 idx) external view returns (NftId) {
-        return _store.getTargetManager().getNftId(idx);
+        return _store.getTargetNftIdSet().getNftId(idx);
     }
 
 
     function isActive(NftId targetNftId) external view returns (bool) {
-        return _store.getTargetManager().isActive(targetNftId);
+        return _store.getTargetNftIdSet().isActive(targetNftId);
     }
 
 
     function activeTargets() external view returns (uint256) {
-        return _store.getTargetManager().activeNftIds();
+        return _store.getTargetNftIdSet().activeNftIds();
     }
 
 
     function getActiveTargetNftId(uint256 idx) external view returns (NftId) {
-        return _store.getTargetManager().getActiveNftId(idx);
+        return _store.getTargetNftIdSet().getActiveNftId(idx);
     }
 
 

package/contracts/staking/StakingService.sol

@@ -122,11 +122,10 @@ contract StakingService is
 
         // transfer withdrawal amount to target owner
         address instanceOwner = getRegistry().ownerOf(instanceNftId);
+        emit LogStakingServiceRewardReservesDecreased(instanceNftId, instanceOwner, dipAmount, newBalance);
         $._staking.transferDipAmount(
             instanceOwner,
             dipAmount);
-
-        emit LogStakingServiceRewardReservesDecreased(instanceNftId, instanceOwner, dipAmount, newBalance);
     }
 
 
@@ -169,12 +168,12 @@ contract StakingService is
             targetNftId,
             dipAmount);
 
+        emit LogStakingServiceStakeCreated(stakeNftId, targetNftId, stakeOwner, dipAmount);
+
         // collect staked dip by staking
         $._staking.collectDipAmount(
             stakeOwner,
             dipAmount);
-
-        emit LogStakingServiceStakeCreated(stakeNftId, targetNftId, stakeOwner, dipAmount);
     }
 
 
@@ -197,12 +196,11 @@ contract StakingService is
 
         // collect staked dip by staking
         if (dipAmount.gtz()) {
+            emit LogStakingServiceStakeIncreased(stakeNftId, stakeOwner, dipAmount, stakeBalance);
             $._staking.collectDipAmount(
                 stakeOwner,
                 dipAmount);
         }
-
-        emit LogStakingServiceStakeIncreased(stakeNftId, stakeOwner, dipAmount, stakeBalance);
     }
 
 
@@ -247,11 +245,10 @@ contract StakingService is
         address stakeOwner = msg.sender;
 
         Amount rewardsClaimedAmount = $._staking.claimRewards(stakeNftId);
+        emit LogStakingServiceRewardsClaimed(stakeNftId, stakeOwner, rewardsClaimedAmount);
         $._staking.transferDipAmount(
             stakeOwner,
             rewardsClaimedAmount);
-
-        emit LogStakingServiceRewardsClaimed(stakeNftId, stakeOwner, rewardsClaimedAmount);
     }
 
 
@@ -270,11 +267,10 @@ contract StakingService is
         ) = $._staking.unstake(stakeNftId);
 
         Amount totalAmount = unstakedAmount + rewardsClaimedAmount;
+        emit LogStakingServiceUnstaked(stakeNftId, stakeOwner, totalAmount);
         $._staking.transferDipAmount(
             stakeOwner,
             totalAmount);
-
-        emit LogStakingServiceUnstaked(stakeNftId, stakeOwner, totalAmount);
     }
 
 
@@ -335,7 +331,7 @@ contract StakingService is
             address stakingAddress
         ) = abi.decode(data, (address, address, address));
 
-        initializeService(registryAddress, authority, owner);
+        _initializeService(registryAddress, authority, owner);
 
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         $._registryService = RegistryService(_getServiceAddress(REGISTRY()));
@@ -343,7 +339,7 @@ contract StakingService is
         $._dip = $._staking.getToken();
         $._tokenHandler = $._staking.getTokenHandler();
 
-        registerInterface(type(IStakingService).interfaceId);
+        _registerInterface(type(IStakingService).interfaceId);
     }
 
 
@@ -389,12 +385,12 @@ contract StakingService is
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         newBalance = $._staking.refillRewardReserves(targetNftId, dipAmount);
 
+        emit LogStakingServiceRewardReservesIncreased(targetNftId, rewardProvider, dipAmount, newBalance);
+
         // collect reward dip from provider
         $._staking.collectDipAmount(
             rewardProvider,
             dipAmount);
-
-        emit LogStakingServiceRewardReservesIncreased(targetNftId, rewardProvider, dipAmount, newBalance);
     }
 
 

package/contracts/staking/StakingServiceManager.sol

@@ -2,8 +2,8 @@
 pragma solidity ^0.8.20;
 
 import {IRegistry} from "../registry/IRegistry.sol";
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {StakingService} from "./StakingService.sol";
 
 contract StakingServiceManager is

package/contracts/staking/StakingStore.sol

@@ -3,32 +3,21 @@ pragma solidity ^0.8.20;
 
 import {AccessManaged} from "@openzeppelin/contracts/access/manager/AccessManaged.sol";
 
-import {Amount, AmountLib} from "../type/Amount.sol";
-import {Blocknumber, BlocknumberLib} from "../type/Blocknumber.sol";
-import {ChainNft} from "../registry/ChainNft.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 {IVersionable} from "../shared/IVersionable.sol";
-import {Key32} from "../type/Key32.sol";
+
+import {Amount, AmountLib} from "../type/Amount.sol";
+import {Blocknumber, BlocknumberLib} from "../type/Blocknumber.sol";
 import {KeyValueStore} from "../shared/KeyValueStore.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";
-import {ObjectType, INSTANCE, PROTOCOL, STAKE, STAKING, TARGET} from "../type/ObjectType.sol";
-import {Seconds, SecondsLib} from "../type/Seconds.sol";
+import {NftIdSet} from "../shared/NftIdSet.sol";
+import {PROTOCOL, STAKE, TARGET} from "../type/ObjectType.sol";
 import {StakingReader} from "./StakingReader.sol";
 import {TargetManagerLib} from "./TargetManagerLib.sol";
 import {Timestamp, TimestampLib} from "../type/Timestamp.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 {RegistryAdmin} from "../registry/RegistryAdmin.sol";
 import {StakingLifecycle} from "./StakingLifecycle.sol";
+import {UFixed} from "../type/UFixed.sol";
 
 
 contract StakingStore is 
@@ -63,7 +52,7 @@ contract StakingStore is
     error ErrorStakingStoreTvlBalanceNotInitialized(NftId nftId);
 
     IRegistry private _registry;
-    NftIdSetManager private _targetManager;
+    NftIdSet private _targetNftIdSet;
     StakingReader private _reader;
 
     // staking rate
@@ -93,7 +82,7 @@ contract StakingStore is
         // set internal variables
         _registry = registry; //TODO if keeps registry -> RegistryLinked and checks registry address
         _reader = reader;
-        _targetManager = new NftIdSetManager();
+        _targetNftIdSet = new NftIdSet();
 
         // register protocol target
         _createTarget(
@@ -428,8 +417,9 @@ contract StakingStore is
         return _reader;
     }
 
-    function getTargetManager() external view returns (NftIdSetManager targetManager){
-        return _targetManager;
+    // TODO rename
+    function getTargetNftIdSet() external view returns (NftIdSet targetNftIdSet){
+        return _targetNftIdSet;
     }
 
     function getStakingRate(uint256 chainId, address token) external view returns (UFixed stakingRate) { return _stakingRate[chainId][token]; }
@@ -493,7 +483,7 @@ contract StakingStore is
         _tvlLastUpdatedIn[targetNftId]= BlocknumberLib.currentBlocknumber();
         _createTargetBalance(targetNftId);
 
-        _targetManager.add(targetNftId);
+        _targetNftIdSet.add(targetNftId);
     }
 
     function _updateReserves(

package/contracts/staking/TargetManagerLib.sol

@@ -132,9 +132,9 @@ library TargetManagerLib {
         public 
         pure
     {
-        // check locking period is > 0
-        if (lockingPeriod.eqz()) {
-            revert IStaking.ErrorStakingLockingPeriodZero(targetNftId);
+        // check locking period is >= min locking period
+        if (lockingPeriod.lt(getMinimumLockingPeriod())) {
+            revert IStaking.ErrorStakingLockingPeriodTooShort(targetNftId, getMinimumLockingPeriod(), lockingPeriod);
         }
 
         // check locking period <= max locking period
@@ -190,6 +190,10 @@ library TargetManagerLib {
         return SecondsLib.toSeconds(365 * 24 * 3600 / 2);
     }
 
+    /// @dev the minimum locking period is 24 hours
+    function getMinimumLockingPeriod() public pure returns (Seconds minLockingPeriod) {
+        return SecondsLib.toSeconds(24 * 3600);
+    }
 
     function getMaxRewardRate() public pure returns (UFixed maxRewardRate) {
         return UFixedLib.toUFixed(33, -2);

package/contracts/type/Amount.sol

@@ -12,13 +12,15 @@ using {
     nqAmount as !=,
     ltAmount as <,
     gtAmount as >,
+    AmountLib.add,
     AmountLib.eq,
     AmountLib.eqz,
     AmountLib.gtz,
+    AmountLib.gt,
+    AmountLib.gte,
+    AmountLib.multiplyWith,
     AmountLib.toInt,
-    AmountLib.add,
-    AmountLib.toUFixed,
-    AmountLib.multiplyWith
+    AmountLib.toUFixed
 } for Amount global;
 
 function addAmount(Amount a, Amount b) pure returns (Amount) {
@@ -77,16 +79,21 @@ library AmountLib {
         return Amount.unwrap(amount1) == Amount.unwrap(amount2);
     }
 
-    /// @dev return true if amount a1 is smaller than a2
+    /// @dev return true if amount a1 is less than a2
     function lt(Amount a1, Amount a2) public pure returns (bool) {
         return Amount.unwrap(a1) < Amount.unwrap(a2);
     }
 
-    /// @dev return true if amount a1 is larger than a2
+    /// @dev return true if amount a1 is greater than a2
     function gt(Amount a1, Amount a2) public pure returns (bool) {
         return Amount.unwrap(a1) > Amount.unwrap(a2);
     }
 
+    /// @dev return true if amount a1 is greater or equal than a2
+    function gte(Amount a1, Amount a2) public pure returns (bool) {
+        return Amount.unwrap(a1) >= Amount.unwrap(a2);
+    }
+
     /// @dev return minimum of a1 and a2.
     function min(Amount a1, Amount a2) public pure returns (Amount) {
         if (Amount.unwrap(a1) < Amount.unwrap(a2)) {

package/contracts/type/Blocknumber.sol

@@ -11,8 +11,14 @@ using {
     eqBlocknumber as ==,
     neBlocknumber as !=,
     BlocknumberLib.toInt,
+    BlocknumberLib.eq,
+    BlocknumberLib.ne,
     BlocknumberLib.eqz,
-    BlocknumberLib.gtz
+    BlocknumberLib.gtz,
+    BlocknumberLib.gt,
+    BlocknumberLib.gte,
+    BlocknumberLib.lt,
+    BlocknumberLib.lte
 } for Blocknumber global;
 
 /// @dev return true if Blocknumber a is greater than Blocknumber b