@etherisc/gif-next 0.0.2-858f0b8-208 → 0.0.2-85e1eb3-876

package/contracts/staking/StakingLib.sol

@@ -0,0 +1,168 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IStaking} from "./IStaking.sol";
+
+import {Amount, AmountLib} from "../type/Amount.sol";
+import {NftId} from "../type/NftId.sol";
+import {Seconds, SecondsLib} from "../type/Seconds.sol";
+import {StakingReader} from "./StakingReader.sol";
+import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
+import {UFixed, UFixedLib} from "../type/UFixed.sol";
+
+
+library StakingLib {
+
+    function checkCreateParameters(
+        StakingReader stakingReader,
+        NftId targetNftId, 
+        Amount dipAmount
+    )
+        external
+        view
+        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);
+
+        Timestamp currentTime = TimestampLib.current();
+        lockedUntil = currentTime.addSeconds(lockingPeriod);
+    }
+
+
+    function checkStakeParameters(
+        StakingReader stakingReader,
+        NftId stakeNftId
+    )
+        public
+        view
+        returns (
+            UFixed rewardRate,
+            Seconds lockingPeriod
+        )
+    {
+        NftId targetNftId = stakingReader.getTargetNftId(stakeNftId);
+
+        // 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
+    )
+        public
+        view
+        returns (
+            Seconds lockingPeriod
+        )
+    {
+        IStaking.StakeInfo memory stakeInfo = stakingReader.getStakeInfo(stakeNftId);
+        
+        if (stakeInfo.lockedUntil > TimestampLib.current()) {
+            revert IStaking.ErrorStakingStakeLocked(stakeNftId, stakeInfo.lockedUntil);
+        }
+    }
+
+
+    function checkTarget(
+        StakingReader stakingReader,
+        NftId targetNftId
+    )
+        public
+        view
+        returns (Seconds lockingPeriod)
+    {
+        // target nft id must be registered
+        if (!stakingReader.isTarget(targetNftId)) {
+            revert IStaking.ErrorStakingNotTarget(targetNftId);
+        }
+
+        lockingPeriod = stakingReader.getTargetInfo(targetNftId).lockingPeriod;
+    }
+
+
+    function checkDipAmount(
+        StakingReader stakingReader,
+        NftId targetNftId, 
+        Amount dipAmount
+    )
+        public 
+        view 
+    {
+        // check stake amount > 0
+        if (dipAmount.eqz()) {
+            revert IStaking.ErrorStakingStakeAmountZero(targetNftId);
+        }
+
+        Amount maxStakedAmount = stakingReader.getTargetMaxStakedAmount(targetNftId);
+        if (dipAmount > maxStakedAmount) {
+            revert IStaking.ErrorStakingTargetMaxStakedAmountExceeded(targetNftId, maxStakedAmount, dipAmount);
+        }
+    }
+
+    function calculateRewardIncrease(
+        StakingReader stakingReader,
+        NftId stakeNftId,
+        UFixed rewardRate
+    )
+        public
+        view
+        returns (
+            Amount rewardIncreaseAmount
+        )
+    {
+        IStaking.StakeInfo memory stakeInfo = stakingReader.getStakeInfo(stakeNftId);
+
+        Seconds duration = SecondsLib.toSeconds(
+            block.timestamp - stakeInfo.lastUpdateAt.toInt());
+        
+        rewardIncreaseAmount = calculateRewardAmount(
+            rewardRate,
+            duration,
+            stakeInfo.stakedAmount);
+    }
+
+    function calculateRewardAmount(
+        UFixed rewardRate,
+        Seconds duration, 
+        Amount stakeAmount
+    )
+        public 
+        pure 
+        returns(
+            Amount rewardAmount
+        )
+    {
+        UFixed rewardRateFraction = getYearFraction(duration) * rewardRate;
+        rewardAmount = stakeAmount.multiplyWith(rewardRateFraction);
+    }
+
+
+    function getYearFraction(Seconds duration) public pure returns (UFixed yearFraction) {
+        return UFixedLib.toUFixed(duration.toInt()) / UFixedLib.toUFixed(SecondsLib.oneYear().toInt());
+    }
+
+}

package/contracts/staking/StakingManager.sol

@@ -18,9 +18,9 @@ contract StakingManager is
         address registry,
         address tokenRegistry,
         address stakingStore,
-        address initialOwner
+        address initialOwner,
+        bytes32 salt
     )
-        ProxyManager(registry)
     {
         Staking stakingImplementation = new Staking();
 
@@ -28,12 +28,13 @@ contract StakingManager is
         _initializationData = abi.encode(
             registry,
             tokenRegistry,
-            stakingStore,
-            initialOwner);
-
-        IVersionable versionable = deploy(
-            _initialImplementation, 
-            _initializationData);
+            stakingStore);
+        
+        IVersionable versionable = initialize(
+            registry,
+            _initialImplementation,
+            _initializationData,
+            salt);
 
         _staking = Staking(address(versionable));
     }

package/contracts/staking/StakingReader.sol

@@ -1,31 +1,37 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
+
 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 {InitializableCustom} from "../shared/InitializableCustom.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,
-    InitializableCustom
+    Initializable
 {
 
-    error ErrorStakingReaderDependenciesAlreadySet();
+    error ErrorStakingReaderUnauthorizedCaler();
 
+    address private _initializeOwner;
     IRegistry private _registry;
     IStaking private _staking;
     StakingStore private _store;
 
-    constructor(IRegistry registry) InitializableCustom() {
+    constructor(IRegistry registry) {
+        _initializeOwner = msg.sender;
         _registry = registry;
     }
 
@@ -34,8 +40,12 @@ contract StakingReader is
         address stakingStoreAddress
     )
         external
-        initializer
+        initializer()
     {
+        if (msg.sender != _initializeOwner) {
+            revert ErrorStakingReaderUnauthorizedCaler();
+        }
+
         _staking = IStaking(stakingAddress);
         _store = StakingStore(stakingStoreAddress);
     }
@@ -50,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 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); 
+    /// @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;
     }
 
-    function getRewardBalance(NftId nftId) external view returns (Amount rewardAmount) {
-        return _store.getRewardBalance(nftId); 
-    }
 
-    function getBalanceUpdatedAt(NftId nftId) external view returns (Timestamp updatedAt) {
-        return _store.getBalanceUpdatedAt(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 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);
     }
 }