@etherisc/gif-next 0.0.2-e79d227-681 → 0.0.2-e7a5428-226

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

@@ -1,84 +1,44 @@
 // 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 {IStakingService} from "./IStakingService.sol";
+
+import {Amount} from "../type/Amount.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, INSTANCE, PROTOCOL, TARGET} from "../type/ObjectType.sol";
+import {ReleaseRegistry} from "../registry/ReleaseRegistry.sol";
 import {Seconds, SecondsLib} from "../type/Seconds.sol";
 import {StakingReader} from "./StakingReader.sol";
-import {StakingStore} from "./StakingStore.sol";
+import {STAKING} from "../type/ObjectType.sol";
 import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
 import {UFixed, UFixedLib} from "../type/UFixed.sol";
+import {VersionPart} from "../type/Version.sol";
 
 
-library StakeManagerLib {
+library StakingLib {
 
-    function stake(
-        IRegistry registry,
+    function checkCreateParameters(
         StakingReader stakingReader,
-        StakingStore stakingStore,
-        NftId stakeNftId,
-        Amount stakeAmount
+        NftId targetNftId, 
+        Amount dipAmount
     )
         external
-        returns (Amount stakeBalance)
+        view
+        returns (
+            Timestamp lockedUntil
+        )
     {
-        // check that target is active for staking
-        (
-            UFixed rewardRate,
-            Seconds lockingPeriod
-        ) = checkStakeParameters(
-            stakingReader, 
-            stakeNftId);        
-
-        // calculate new rewards (if any)
-        (
-            Amount rewardIncrementAmount, 
-            Amount currentTotalDipAmount
-        ) = calculateRewardIncrease(
-            stakingReader, 
-            stakeNftId,
-            rewardRate);
-
-        stakeBalance = currentTotalDipAmount + stakeAmount;
-
-        // TODO check that additional dip, rewards and rewards increment 
-        // are still ok with max target staking amount
-        NftId targetNftId = registry.getObjectInfo(stakeNftId).parentNftId;
-
-        stakingStore.restakeRewards(
-            stakeNftId, 
-            targetNftId, 
-            rewardIncrementAmount);
-
-        stakingStore.increaseStake(
-            stakeNftId, 
-            targetNftId, 
-            stakeAmount);
-
-        // update locked until with target locking period
-        stakingStore.update(
-            stakeNftId, 
-            IStaking.StakeInfo({
-                lockedUntil: TimestampLib.blockTimestamp().addSeconds(
-                    lockingPeriod)}));
-
+        return _checkCreateParameters(stakingReader, targetNftId, dipAmount);
     }
 
-    function checkCreateParameters(
+
+    function _checkCreateParameters(
         StakingReader stakingReader,
         NftId targetNftId, 
         Amount dipAmount
     )
-        external
-        view
+        internal view
         returns (
             Timestamp lockedUntil
         )
@@ -86,7 +46,7 @@ library StakeManagerLib {
         Seconds lockingPeriod = checkTarget(stakingReader, targetNftId);
         checkDipAmount(stakingReader, targetNftId, dipAmount);
 
-        Timestamp currentTime = TimestampLib.blockTimestamp();
+        Timestamp currentTime = TimestampLib.current();
         lockedUntil = currentTime.addSeconds(lockingPeriod);
     }
 
@@ -104,16 +64,17 @@ 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;
     }
 
+
     function checkUnstakeParameters(
         StakingReader stakingReader,
         NftId stakeNftId
@@ -121,13 +82,12 @@ library StakeManagerLib {
         public
         view
         returns (
-            UFixed rewardRate,
             Seconds lockingPeriod
         )
     {
         IStaking.StakeInfo memory stakeInfo = stakingReader.getStakeInfo(stakeNftId);
-
-        if (stakeInfo.lockedUntil > TimestampLib.blockTimestamp()) {
+        
+        if (stakeInfo.lockedUntil > TimestampLib.current()) {
             revert IStaking.ErrorStakingStakeLocked(stakeNftId, stakeInfo.lockedUntil);
         }
     }
@@ -146,12 +106,28 @@ 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;
+    }
+
+
+    function checkAndGetStakingService(
+        IRegistry registry,
+        VersionPart release
+    )
+        public
+        view
+        returns (IStakingService stakingService)
+    {
+        if (!ReleaseRegistry(registry.getReleaseRegistryAddress()).isActiveRelease(release)) {
+            revert IStaking.ErrorStakingReleaseNotActive(release);
+        }
+
+        address stakingServiceAddress = registry.getServiceAddress(STAKING(), release);
+        if (stakingServiceAddress == address(0)) {
+            revert IStaking.ErrorStakingServiceNotFound(release);
         }
 
-        lockingPeriod = stakingReader.getTargetInfo(targetNftId).lockingPeriod;
+        return IStakingService(stakingServiceAddress);
     }
 
 
@@ -161,14 +137,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(
@@ -179,28 +158,20 @@ library StakeManagerLib {
         public
         view
         returns (
-            Amount rewardIncreaseAmount,
-            Amount totalDipAmount
+            Amount rewardIncreaseAmount
         )
     {
-        (
-            Amount stakeAmount,
-            Amount rewardAmount,
-            Timestamp lastUpdatedAt
-        ) = stakingReader.getStakeBalances(stakeNftId);
+        IStaking.StakeInfo memory stakeInfo = stakingReader.getStakeInfo(stakeNftId);
 
         Seconds duration = SecondsLib.toSeconds(
-            block.timestamp - lastUpdatedAt.toInt());
+            block.timestamp - stakeInfo.lastUpdateAt.toInt());
         
         rewardIncreaseAmount = calculateRewardAmount(
             rewardRate,
             duration,
-            stakeAmount);
-
-        totalDipAmount = stakeAmount + rewardAmount + rewardIncreaseAmount;
+            stakeInfo.stakedAmount);
     }
 
-
     function calculateRewardAmount(
         UFixed rewardRate,
         Seconds duration, 

package/contracts/staking/StakingManager.sol

@@ -28,8 +28,7 @@ contract StakingManager is
         _initializationData = abi.encode(
             registry,
             tokenRegistry,
-            stakingStore,
-            initialOwner);
+            stakingStore);
         
         IVersionable versionable = initialize(
             registry,

package/contracts/staking/StakingReader.sol

@@ -7,14 +7,17 @@ import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryLinked} from "../shared/IRegistryLinked.sol";
 import {IStaking} from "../staking/IStaking.sol";
 
-import {Amount} from "../type/Amount.sol";
+import {Amount, AmountLib} from "../type/Amount.sol";
 import {Blocknumber}  from "../type/Blocknumber.sol";
+import {ChainId}  from "../type/ChainId.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";
 
+
 contract StakingReader is
     IRegistryLinked,
     Initializable
@@ -57,134 +60,92 @@ contract StakingReader is
         return _staking;
     }
 
-    function getStakingRate(uint256 chainId, address token) external view returns (UFixed stakingRate) { 
-        return _store.getStakingRate(chainId, token); 
+    function getProtocolNftId() external view returns (NftId protocolNftId) {
+        return _registry.getProtocolNftId();
     }
 
 
     function isTarget(NftId targetNftId) external view returns (bool) {
-        return _store.getTargetNftIdSet().exists(targetNftId);
+        return _store.getTargetSet().exists(targetNftId);
     }
 
 
     function targets() external view returns (uint256) {
-        return _store.getTargetNftIdSet().nftIds();
+        return _store.getTargetSet().nftIds();
     }
 
 
     function getTargetNftId(uint256 idx) external view returns (NftId) {
-        return _store.getTargetNftIdSet().getNftId(idx);
+        return _store.getTargetSet().getNftId(idx);
     }
 
 
-    function isActive(NftId targetNftId) external view returns (bool) {
-        return _store.getTargetNftIdSet().isActive(targetNftId);
+    function getTargetNftId(NftId stakeNftId) public view returns (NftId targetNftId) {
+        return _registry.getParentNftId(stakeNftId);
     }
 
 
-    function activeTargets() external view returns (uint256) {
-        return _store.getTargetNftIdSet().activeNftIds();
+    function getStakeInfo(NftId stakeNftId) external view returns (IStaking.StakeInfo memory stakeInfo) {
+        return _store.getStakeInfo(stakeNftId);
     }
 
 
-    function getActiveTargetNftId(uint256 idx) external view returns (NftId) {
-        return _store.getTargetNftIdSet().getActiveNftId(idx);
+    function getTargetInfo(NftId targetNftId) public view returns (IStaking.TargetInfo memory info) {
+        return _store.getTargetInfo(targetNftId);
     }
 
 
-    function getTargetNftId(NftId stakeNftId) public view returns (NftId targetNftId) {
-        return _registry.getObjectInfo(stakeNftId).parentNftId;
+    function getTvlInfo(NftId targetNftId, address token) public view returns (IStaking.TvlInfo memory info) {
+        return _store.getTvlInfo(targetNftId, token);
     }
 
 
-    function getTargetInfo(NftId targetNftId) public view returns (IStaking.TargetInfo memory info) {
-        bytes memory data = _store.getData(targetNftId.toKey32(TARGET()));
-        if (data.length > 0) {
-            return abi.decode(data, (IStaking.TargetInfo));
-        }
+    function getTokenInfo(ChainId chainId, address token) public view returns (IStaking.TokenInfo memory info) {
+        return _store.getTokenInfo(chainId, token);
     }
 
 
-    function getStakeInfo(NftId stakeNftId) external view returns (IStaking.StakeInfo memory stakeInfo) {
-        bytes memory data = _store.getData(stakeNftId.toKey32(STAKE()));
-        if (data.length > 0) {
-            return abi.decode(data, (IStaking.StakeInfo));
-        }
+    /// @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.
+    /// @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.
-    function getRewardRate(NftId targetNftId) external view returns (UFixed rewardRate) {
-        return 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 returns the current reward reserve balance for the specified target.
-    function getReserveBalance(NftId targetNftId) external view returns (Amount rewardReserveBalance) {
-        return _store.getReserveBalance(targetNftId); 
-    }
-
-    function getStakeBalance(NftId nftId) external view returns (Amount balanceAmount) { 
-        return _store.getStakeBalance(nftId); 
-    }
 
-    function getRewardBalance(NftId nftId) external view returns (Amount rewardAmount) {
-        return _store.getRewardBalance(nftId); 
+    /// @dev Get the reward rate for the specified target NFT ID.
+    function getLockingPeriod(NftId targetNftId) external view returns (Seconds lockingPeriod) {
+        return getTargetInfo(targetNftId).lockingPeriod;
     }
 
-    function getBalanceUpdatedAt(NftId nftId) external view returns (Timestamp updatedAt) {
-        return _store.getBalanceUpdatedAt(nftId); 
-    }
-
-    function getBalanceUpdatedIn(NftId nftId) external view returns (Blocknumber blocknumber) {
-        return _store.getBalanceUpdatedIn(nftId); 
-    }
 
-    function getTotalValueLocked(NftId nftId, address token) external view returns (Amount totalValueLocked) {
-        return _store.getTotalValueLocked(nftId, token); 
+    /// @dev Get the reward rate for the specified target NFT ID.
+    function getRewardRate(NftId targetNftId) external view returns (UFixed rewardRate) {
+        return getTargetInfo(targetNftId).rewardRate;
     }
 
-    function getRequiredStakeBalance(NftId nftId) external view returns (Amount requiredStakedAmount) {
-        return _store.getRequiredStakeBalance(nftId); 
+    /// @dev returns the current reward reserve balance for the specified target.
+    function getReserveBalance(NftId targetNftId) external view returns (Amount rewardReserveBalance) {
+        return getTargetInfo(targetNftId).reserveAmount;
     }
 
-    function getTargetBalances(NftId stakeNftId) 
-        public
-        view
-        returns (
-            Amount balanceAmount,
-            Amount stakeAmount,
-            Amount rewardAmount,
-            Blocknumber lastUpdatedIn
-        )
-    {
-        (
-            balanceAmount,
-            stakeAmount,
-            rewardAmount,
-            lastUpdatedIn
-        ) = _store.getTargetBalances(stakeNftId);
+    function getTotalValueLocked(NftId targetNftId, address token) external view returns (Amount totalValueLocked) {
+        return getTvlInfo(targetNftId, token).tvlAmount;
     }
 
-    function getStakeBalances(NftId stakeNftId) 
-        external
-        view
-        returns (
-            Amount stakeAmount,
-            Amount rewardAmount,
-            Timestamp lastUpdatedAt
-        )
-    {
-        (
-            stakeAmount,
-            rewardAmount,
-            lastUpdatedAt
-        ) = _store.getStakeBalances(stakeNftId);
+    function getRequiredStakeBalance(NftId targetNftId) external view returns (Amount requiredStakedAmount) {
+        return _store.getRequiredStakeBalance(targetNftId);
     }
 }