@etherisc/gif-next 0.0.2-a105567-464 → 0.0.2-a221fa7-461

package/contracts/staking/StakingReader.sol

@@ -1,18 +1,15 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount} from "../type/Amount.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} from "../type/UFixed.sol";
@@ -28,17 +25,17 @@ contract StakingReader is
     IStaking private _staking;
     StakingStore private _store;
 
-    constructor() InitializableCustom() {}
+    constructor(IRegistry registry) InitializableCustom() {
+        _registry = registry;
+    }
 
     function initialize(
-        address registryAddress,
         address stakingAddress,
         address stakingStoreAddress
     )
         external
         initializer
     {
-        _registry = IRegistry(registryAddress);
         _staking = IStaking(stakingAddress);
         _store = StakingStore(stakingStoreAddress);
     }
@@ -53,34 +50,43 @@ contract StakingReader is
         return _staking;
     }
 
+    function getStakingRate(uint256 chainId, address token) external view returns (UFixed stakingRate) { 
+        return _store.getStakingRate(chainId, token); 
+    }
+
 
     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);
+    }
+
+
+    function getTargetNftId(NftId stakeNftId) public view returns (NftId targetNftId) {
+        return _registry.getObjectInfo(stakeNftId).parentNftId;
     }
 
 
@@ -100,47 +106,78 @@ contract StakingReader is
     }
 
 
+    /// @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); 
     }
 
-
     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); 
     }
 
+    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); 
+    }
+
+    function getRequiredStakeBalance(NftId nftId) external view returns (Amount requiredStakedAmount) {
+        return _store.getRequiredStakeBalance(nftId); 
+    }
+
+    function getTargetBalances(NftId stakeNftId) 
+        public
+        view
+        returns (
+            Amount balanceAmount,
+            Amount stakeAmount,
+            Amount rewardAmount,
+            Blocknumber lastUpdatedIn
+        )
+    {
+        (
+            balanceAmount,
+            stakeAmount,
+            rewardAmount,
+            lastUpdatedIn
+        ) = _store.getTargetBalances(stakeNftId);
+    }
 
-    function getRewardCalculationInput(NftId stakeNftId) 
+    function getStakeBalances(NftId stakeNftId) 
         external
         view
         returns (
-            UFixed rewardRate,
             Amount stakeAmount,
+            Amount rewardAmount,
             Timestamp lastUpdatedAt
         )
     {
-        NftId targetNftId = _registry.getObjectInfo(stakeNftId).parentNftId;
-        rewardRate = getTargetInfo(targetNftId).rewardRate;
-
         (
             stakeAmount,
+            rewardAmount,
             lastUpdatedAt
-        ) = _store.getBalanceAndLastUpdatedAt(stakeNftId);
+        ) = _store.getStakeBalances(stakeNftId);
     }
-
-    // function getTvlAmount(NftId targetNftId, address token) external view returns (Amount tvlAmount);
-    // function getStakedAmount(NftId targetNftId) external view returns (Amount stakeAmount);
-
-    // function getStakingRate(uint256 chainId, address token) external view returns (UFixed stakingRate);
-
-    // function calculateRewardIncrementAmount(
-    //     NftId targetNftId,
-    //     Timestamp rewardsLastUpdatedAt
-    // ) external view returns (Amount rewardIncrementAmount);
-
 }

package/contracts/staking/StakingService.sol

@@ -45,29 +45,6 @@ contract StakingService is
         _;
     }
 
-    function getDomain() public pure override returns(ObjectType) {
-        return STAKING();
-    }
-
-
-    function registerProtocolTarget()
-        external
-        virtual
-    {
-        uint256 protocolId = ChainNft(
-            getRegistry().getChainNftAddress()).PROTOCOL_NFT_ID();
-
-        NftId protocolNftId = NftIdLib.toNftId(protocolId);
-        _getStakingServiceStorage()._staking.registerTarget(
-            protocolNftId,
-            PROTOCOL(),
-            1, // protocol is registered on mainnet
-            TargetManagerLib.getDefaultLockingPeriod(),
-            TargetManagerLib.getDefaultRewardRate());
-
-        emit LogStakingServiceProtocolTargetRegistered(protocolNftId);
-    }
-
 
     function createInstanceTarget(
         NftId targetNftId,
@@ -76,7 +53,7 @@ contract StakingService is
     )
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
     {
         uint256 chainId = block.chainid;
         _getStakingServiceStorage()._staking.registerTarget(
@@ -89,23 +66,67 @@ contract StakingService is
         emit LogStakingServiceInstanceTargetRegistered(targetNftId, chainId);
     }
 
-    function setLockingPeriod(NftId targetNftId, Seconds lockingPeriod)
+
+    function setInstanceLockingPeriod(NftId instanceNftId, Seconds lockingPeriod)
         external
         virtual
-        onlyNftOwner(targetNftId)
+        restricted()
     {
         _getStakingServiceStorage()._staking.setLockingPeriod(
-            targetNftId, lockingPeriod);
+            instanceNftId, 
+            lockingPeriod);
     }
 
-    function setRewardRate(NftId targetNftId, UFixed rewardRate)
+
+    function setInstanceRewardRate(NftId instanceNftId, UFixed rewardRate)
         external
         virtual
-        onlyNftOwner(targetNftId)
+        restricted()
     {
         _getStakingServiceStorage()._staking.setRewardRate(
-            targetNftId, rewardRate);
+            instanceNftId, 
+            rewardRate);
+    }
+
+
+    function refillInstanceRewardReserves(NftId instanceNftId, address rewardProvider, Amount dipAmount)
+        external
+        virtual
+        restricted()
+        returns (Amount newBalance)
+    {
+        return _refillRewardReserves(instanceNftId, rewardProvider, dipAmount);
+    }
+
+
+    function refillRewardReservesBySender(NftId targetNftId, Amount dipAmount)
+        external
+        virtual
+        restricted()
+        returns (Amount newBalance)
+    {
+        address rewardProvider = msg.sender;
+        return _refillRewardReserves(targetNftId, rewardProvider, dipAmount);
+    }
 
+
+    function withdrawInstanceRewardReserves(NftId instanceNftId, Amount dipAmount)
+        external
+        virtual
+        restricted()
+        returns (Amount newBalance)
+    {
+        // update reward reserve book keeping
+        StakingServiceStorage storage $ = _getStakingServiceStorage();
+        newBalance = $._staking.withdrawRewardReserves(instanceNftId, dipAmount);
+
+        // transfer withdrawal amount to target owner
+        address instanceOwner = getRegistry().ownerOf(instanceNftId);
+        $._staking.transferDipAmount(
+            instanceOwner,
+            dipAmount);
+
+        emit LogStakingServiceRewardReservesDecreased(instanceNftId, instanceOwner, dipAmount, newBalance);
     }
 
 
@@ -121,19 +142,15 @@ contract StakingService is
     )
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
         returns (
             NftId stakeNftId
         )
     {
         StakingServiceStorage storage $ = _getStakingServiceStorage();
-        StakingReader stakingReader = $._staking.getStakingReader();
         address stakeOwner = msg.sender;
 
-        StakeManagerLib.checkActiveTarget(
-            stakingReader,
-            targetNftId);
-
+        // target nft id checks are performed in $._staking.createStake() below
         // register new stake object with registry
         stakeNftId = $._registryService.registerStake(
             IRegistry.ObjectInfo({
@@ -147,7 +164,7 @@ contract StakingService is
             }));
 
         // create stake info with staking
-        $._staking.registerStake(
+        $._staking.createStake(
             stakeNftId, 
             targetNftId,
             dipAmount);
@@ -167,38 +184,25 @@ contract StakingService is
     )
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
         onlyNftOwner(stakeNftId)
     {
         StakingServiceStorage storage $ = _getStakingServiceStorage();
-        StakingReader stakingReader = $._staking.getStakingReader();
         address stakeOwner = msg.sender;
 
-        // add additional staked dips by staking
-        $._staking.stake(
+        // add additional staked dips by staking 
+        Amount stakeBalance = $._staking.stake(
             stakeNftId, 
             dipAmount);
 
         // collect staked dip by staking
-        $._staking.collectDipAmount(
-            stakeOwner,
-            dipAmount);
-
-        emit LogStakingServiceStakeIncreased(stakeNftId, stakeOwner, dipAmount);
-    }
-
+        if (dipAmount.gtz()) {
+            $._staking.collectDipAmount(
+                stakeOwner,
+                dipAmount);
+        }
 
-    function restake(
-        NftId stakeNftId
-    )
-        external
-        virtual
-        // restricted // TODO re-enable once services have stable roles
-        onlyNftOwner(stakeNftId)
-    {
-        // restake all rewards as additional stakes
-        StakingServiceStorage storage $ = _getStakingServiceStorage();
-        $._staking.restake(stakeNftId);
+        emit LogStakingServiceStakeIncreased(stakeNftId, stakeOwner, dipAmount, stakeBalance);
     }
 
 
@@ -208,33 +212,23 @@ contract StakingService is
     )
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
         onlyNftOwner(stakeNftId)
         returns (
             NftId newStakeNftId
         )
     {
+        StakingServiceStorage storage $ = _getStakingServiceStorage();
         // TODO implement
     } 
 
 
-    function unstake(
-        NftId stakeNftId,
-        Amount amount
-    )
-        external
-        virtual
-    {
-
-    }
-
-
     function updateRewards(
         NftId stakeNftId
     )
         external
-        // unpermissioned, anybody may call this function
-        // TODO consider to add restricted (just to be able to disable function when target is disabled)
+        virtual
+        restricted()
     {
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         $._staking.updateRewards(stakeNftId);
@@ -243,30 +237,44 @@ contract StakingService is
     }
 
 
-
-    function increaseTotalValueLocked(
-        NftId targetNftId,
-        address token,
-        Amount amount
-    )
+    function claimRewards(NftId stakeNftId)
         external
         virtual
-        returns (Amount totalValueLocked)
+        restricted()
+        onlyNftOwner(stakeNftId)
     {
+        StakingServiceStorage storage $ = _getStakingServiceStorage();
+        address stakeOwner = msg.sender;
+
+        Amount rewardsClaimedAmount = $._staking.claimRewards(stakeNftId);
+        $._staking.transferDipAmount(
+            stakeOwner,
+            rewardsClaimedAmount);
 
+        emit LogStakingServiceRewardsClaimed(stakeNftId, stakeOwner, rewardsClaimedAmount);
     }
 
 
-    function decreaseTotalValueLocked(
-        NftId targetNftId,
-        address token,
-        Amount amount
-    )
+    function unstake(NftId stakeNftId)
         external
         virtual
-        returns (Amount totalValueLocked)
+        restricted()
+        onlyNftOwner(stakeNftId)
     {
+        StakingServiceStorage storage $ = _getStakingServiceStorage();
+        address stakeOwner = msg.sender;
+
+        (
+            Amount unstakedAmount,
+            Amount rewardsClaimedAmount
+        ) = $._staking.unstake(stakeNftId);
 
+        Amount totalAmount = unstakedAmount + rewardsClaimedAmount;
+        $._staking.transferDipAmount(
+            stakeOwner,
+            totalAmount);
+
+        emit LogStakingServiceUnstaked(stakeNftId, stakeOwner, totalAmount);
     }
 
 
@@ -277,10 +285,13 @@ contract StakingService is
     )
         external
         virtual
+        restricted()
     {
+        // TODO implement
 
     }
 
+    //--- view functions ----------------------------------------------------//
 
     function getDipToken()
         external
@@ -308,6 +319,7 @@ contract StakingService is
         return _getStakingServiceStorage()._staking;
     }
 
+    //--- internal functions ------------------------------------------------//
 
     function _initialize(
         address owner, 
@@ -368,9 +380,32 @@ contract StakingService is
     }
 
 
+    function _refillRewardReserves(NftId targetNftId, address rewardProvider, Amount dipAmount)
+        internal
+        virtual
+        returns (Amount newBalance)
+    {
+        // update reward reserve book keeping
+        StakingServiceStorage storage $ = _getStakingServiceStorage();
+        newBalance = $._staking.refillRewardReserves(targetNftId, dipAmount);
+
+        // collect reward dip from provider
+        $._staking.collectDipAmount(
+            rewardProvider,
+            dipAmount);
+
+        emit LogStakingServiceRewardReservesIncreased(targetNftId, rewardProvider, dipAmount, newBalance);
+    }
+
+
     function _getStakingServiceStorage() private pure returns (StakingServiceStorage storage $) {
         assembly {
             $.slot := STAKING_SERVICE_LOCATION_V1
         }
     }
+
+
+    function _getDomain() internal pure override returns(ObjectType) {
+        return STAKING();
+    }
 }

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
@@ -31,7 +31,6 @@ contract StakingServiceManager is
             salt);
 
         _stakingService = StakingService(address(versionable));
-        _stakingService.registerProtocolTarget();
     }
 
     //--- view functions ----------------------------------------------------//