@etherisc/gif-next 0.0.2-e802d97-251 → 0.0.2-e81f152-917

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(
@@ -90,66 +67,65 @@ contract StakingService is
     }
 
 
-    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 refillRewardReserves(NftId targetNftId, Amount dipAmount)
+    function refillInstanceRewardReserves(NftId instanceNftId, address rewardProvider, Amount dipAmount)
         external
         virtual
+        restricted()
         returns (Amount newBalance)
     {
-        address rewardProvider = msg.sender;
-
-        // update reward reserve book keeping
-        StakingServiceStorage storage $ = _getStakingServiceStorage();
-        newBalance = $._staking.refillRewardReserves(targetNftId, dipAmount);
+        return _refillRewardReserves(instanceNftId, rewardProvider, dipAmount);
+    }
 
-        // collect reward dip from provider
-        $._staking.collectDipAmount(
-            rewardProvider,
-            dipAmount);
 
-        emit LogStakingServiceRewardReservesIncreased(targetNftId, rewardProvider, dipAmount, newBalance);
+    function refillRewardReservesBySender(NftId targetNftId, Amount dipAmount)
+        external
+        virtual
+        restricted()
+        returns (Amount newBalance)
+    {
+        address rewardProvider = msg.sender;
+        return _refillRewardReserves(targetNftId, rewardProvider, dipAmount);
     }
 
 
-    function withdrawRewardReserves(NftId targetNftId, Amount dipAmount)
+    function withdrawInstanceRewardReserves(NftId instanceNftId, Amount dipAmount)
         external
         virtual
-        onlyNftOwner(targetNftId)
+        restricted()
         returns (Amount newBalance)
     {
-        // modifyier checks that sender is owner
-        address targetOwner = msg.sender;
-
         // update reward reserve book keeping
         StakingServiceStorage storage $ = _getStakingServiceStorage();
-        newBalance = $._staking.withdrawRewardReserves(targetNftId, dipAmount);
+        newBalance = $._staking.withdrawRewardReserves(instanceNftId, dipAmount);
 
         // transfer withdrawal amount to target owner
+        address instanceOwner = getRegistry().ownerOf(instanceNftId);
+        emit LogStakingServiceRewardReservesDecreased(instanceNftId, instanceOwner, dipAmount, newBalance);
         $._staking.transferDipAmount(
-            targetOwner,
+            instanceOwner,
             dipAmount);
-
-        emit LogStakingServiceRewardReservesDecreased(targetNftId, targetOwner, dipAmount, newBalance);
     }
 
 
@@ -165,7 +141,7 @@ contract StakingService is
     )
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
         returns (
             NftId stakeNftId
         )
@@ -192,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);
     }
 
 
@@ -207,7 +183,7 @@ contract StakingService is
     )
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
         onlyNftOwner(stakeNftId)
     {
         StakingServiceStorage storage $ = _getStakingServiceStorage();
@@ -220,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);
     }
 
 
@@ -235,7 +210,7 @@ contract StakingService is
     )
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
         onlyNftOwner(stakeNftId)
         returns (
             NftId newStakeNftId
@@ -250,7 +225,8 @@ contract StakingService is
         NftId stakeNftId
     )
         external
-        // restricted // TODO re-enable once services have stable roles
+        virtual
+        restricted()
     {
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         $._staking.updateRewards(stakeNftId);
@@ -262,25 +238,24 @@ contract StakingService is
     function claimRewards(NftId stakeNftId)
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
         onlyNftOwner(stakeNftId)
     {
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         address stakeOwner = msg.sender;
 
         Amount rewardsClaimedAmount = $._staking.claimRewards(stakeNftId);
+        emit LogStakingServiceRewardsClaimed(stakeNftId, stakeOwner, rewardsClaimedAmount);
         $._staking.transferDipAmount(
             stakeOwner,
             rewardsClaimedAmount);
-
-        emit LogStakingServiceRewardsClaimed(stakeNftId, stakeOwner, rewardsClaimedAmount);
     }
 
 
     function unstake(NftId stakeNftId)
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
         onlyNftOwner(stakeNftId)
     {
         StakingServiceStorage storage $ = _getStakingServiceStorage();
@@ -292,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);
     }
 
 
@@ -307,10 +281,13 @@ contract StakingService is
     )
         external
         virtual
+        restricted()
     {
+        // TODO implement
 
     }
 
+    //--- view functions ----------------------------------------------------//
 
     function getDipToken()
         external
@@ -338,6 +315,7 @@ contract StakingService is
         return _getStakingServiceStorage()._staking;
     }
 
+    //--- internal functions ------------------------------------------------//
 
     function _initialize(
         address owner, 
@@ -398,9 +376,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);
+
+        emit LogStakingServiceRewardReservesIncreased(targetNftId, rewardProvider, dipAmount, newBalance);
+
+        // collect reward dip from provider
+        $._staking.collectDipAmount(
+            rewardProvider,
+            dipAmount);
+    }
+
+
     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 ----------------------------------------------------//

package/contracts/staking/StakingStore.sol

@@ -3,36 +3,27 @@ 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 
     AccessManaged,
-    KeyValueStore
+    KeyValueStore,
+    StakingLifecycle
 {
 
     event LogStakingStoreReserveBalanceIncreased(NftId targetNftId, Amount dipAmount, Amount reserveBalance, Blocknumber lastUpdatedIn);
@@ -61,7 +52,7 @@ contract StakingStore is
     error ErrorStakingStoreTvlBalanceNotInitialized(NftId nftId);
 
     IRegistry private _registry;
-    NftIdSetManager private _targetManager;
+    NftIdSet private _targetNftIdSet;
     StakingReader private _reader;
 
     // staking rate
@@ -85,19 +76,34 @@ contract StakingStore is
     constructor(IRegistry registry, StakingReader reader)
         AccessManaged(msg.sender)
     {
+        // set final authority
+        setAuthority(registry.getAuthority());
+
+        // set internal variables
         _registry = registry; //TODO if keeps registry -> RegistryLinked and checks registry address
-        address authority = _registry.getAuthority();
-        setAuthority(authority);
-        
         _reader = reader;
-        _targetManager = new NftIdSetManager();
+        _targetNftIdSet = new NftIdSet();
+
+        // register protocol target
+        _createTarget(
+            NftIdLib.toNftId(1101), 
+            IStaking.TargetInfo({
+                objectType: PROTOCOL(),
+                chainId: 1,
+                lockingPeriod: TargetManagerLib.getDefaultLockingPeriod(),
+                rewardRate: TargetManagerLib.getDefaultRewardRate()}));
     }
 
 
     //--- staking rate specific functions -----------------------------------//
 
-    function setStakingRate(uint256 chainId, address token, UFixed stakingRate)
+    function setStakingRate(
+        uint256 chainId, 
+        address token, 
+        UFixed stakingRate
+    )
         external
+        restricted()
     {
         _stakingRate[chainId][token] = stakingRate;
     }
@@ -109,16 +115,9 @@ contract StakingStore is
         IStaking.TargetInfo memory targetInfo
     )
         external
+        restricted()
     {
-        _create(
-            targetNftId.toKey32(TARGET()),
-            abi.encode(targetInfo));
-
-        // initialize tvl and stake balance
-        _tvlLastUpdatedIn[targetNftId]= BlocknumberLib.currentBlocknumber();
-        _createTargetBalance(targetNftId);
-
-        _targetManager.add(targetNftId);
+        _createTarget(targetNftId, targetInfo);
     }
 
 
@@ -127,6 +126,7 @@ contract StakingStore is
         IStaking.TargetInfo memory targetInfo
     )
         external
+        restricted()
     {
         _update(
             targetNftId.toKey32(TARGET()), 
@@ -139,6 +139,7 @@ contract StakingStore is
         Amount dipAmount
     )
         external
+        restricted()
         returns (Amount newReserveBalance)
     {
         newReserveBalance = _reserveBalance[targetNftId] + dipAmount;
@@ -153,6 +154,7 @@ contract StakingStore is
         Amount dipAmount
     )
         external
+        restricted()
         returns (Amount newReserveBalance)
     {
         Amount reserveAmount = _reserveBalance[targetNftId];
@@ -170,24 +172,6 @@ contract StakingStore is
     }
 
 
-    function _updateReserves(
-        NftId targetNftId, 
-        Amount newRewardBalance
-    )
-        internal
-        returns (Blocknumber lastUpdatedIn)
-    {
-        if (_lastUpdatedIn[targetNftId].eqz()) {
-            revert ErrorStakingStoreNotTarget(targetNftId);
-        }
-
-        lastUpdatedIn = _lastUpdatedIn[targetNftId];
-
-        _reserveBalance[targetNftId] = newRewardBalance;
-        _lastUpdatedIn[targetNftId] = BlocknumberLib.currentBlocknumber();
-    }
-
-
     //--- tvl specific functions -------------------------------------//
 
     function increaseTotalValueLocked(
@@ -197,6 +181,7 @@ contract StakingStore is
         Amount amount
     )
         external
+        restricted()
         returns (Amount newBalance)
     {
         (
@@ -229,6 +214,7 @@ contract StakingStore is
         Amount amount
     )
         external
+        restricted()
         returns (Amount newBalance)
     {
         (
@@ -261,6 +247,7 @@ contract StakingStore is
         IStaking.StakeInfo memory stakeInfo
     )
         external
+        restricted()
     {
         _create(
             stakeNftId.toKey32(STAKE()),
@@ -274,6 +261,7 @@ contract StakingStore is
         IStaking.StakeInfo memory stakeInfo
     )
         external
+        restricted()
     {
         _update(
             stakeNftId.toKey32(STAKE()),
@@ -289,7 +277,8 @@ contract StakingStore is
         NftId targetNftId,
         Amount amount
     )
-        public
+        external
+        restricted()
     {
         Blocknumber lastUpdatedIn = _checkBalanceExists(nftId);
 
@@ -313,6 +302,7 @@ contract StakingStore is
         Amount rewardIncrementAmount
     )
         external
+        restricted()
     {
         Blocknumber lastUpdatedIn = _checkBalanceExists(nftId);
         Amount stakeAmount = _stakeBalance[nftId];
@@ -339,6 +329,7 @@ contract StakingStore is
         Amount rewardIncrementAmount
     )
         external
+        restricted()
     {
         Blocknumber lastUpdatedIn = _checkBalanceExists(nftId);
 
@@ -363,6 +354,7 @@ contract StakingStore is
         Amount maxClaimAmount
     )
         external
+        restricted()
         returns (Amount claimedAmount)
     {
         Blocknumber lastUpdatedIn = _checkBalanceExists(nftId);
@@ -392,6 +384,7 @@ contract StakingStore is
         Amount maxClaimAmount
     )
         external
+        restricted()
         returns (
             Amount unstakedAmount,
             Amount claimedAmount
@@ -424,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]; }
@@ -475,8 +469,44 @@ contract StakingStore is
 
     //--- private functions -------------------------------------------//
 
+    function _createTarget(
+        NftId targetNftId,
+        IStaking.TargetInfo memory targetInfo
+    )
+        private
+    {
+        _create(
+            targetNftId.toKey32(TARGET()),
+            abi.encode(targetInfo));
 
-    function _createTargetBalance(NftId nftId) private {
+        // initialize tvl and stake balance
+        _tvlLastUpdatedIn[targetNftId]= BlocknumberLib.currentBlocknumber();
+        _createTargetBalance(targetNftId);
+
+        _targetNftIdSet.add(targetNftId);
+    }
+
+    function _updateReserves(
+        NftId targetNftId, 
+        Amount newRewardBalance
+    )
+        private
+        returns (Blocknumber lastUpdatedIn)
+    {
+        if (_lastUpdatedIn[targetNftId].eqz()) {
+            revert ErrorStakingStoreNotTarget(targetNftId);
+        }
+
+        lastUpdatedIn = _lastUpdatedIn[targetNftId];
+
+        _reserveBalance[targetNftId] = newRewardBalance;
+        _lastUpdatedIn[targetNftId] = BlocknumberLib.currentBlocknumber();
+    }
+
+
+    function _createTargetBalance(NftId nftId)
+        private
+    {
         if (_lastUpdatedIn[nftId].gtz()) {
             revert ErrorStakingStoreBalanceAlreadyInitialized(nftId);
         }
@@ -492,7 +522,9 @@ contract StakingStore is
     }
 
 
-    function _createStakeBalance(NftId nftId) private {
+    function _createStakeBalance(NftId nftId)
+        private
+    {
         if (_lastUpdatedIn[nftId].gtz()) {
             revert ErrorStakingStoreBalanceAlreadyInitialized(nftId);
         }
@@ -512,7 +544,7 @@ contract StakingStore is
         Amount newStakeAmount,
         Amount newRewardAmount
     )
-        internal
+        private
     {
         _stakeBalance[stakeNftId] = newStakeAmount;
         _rewardBalance[stakeNftId] = newRewardAmount;
@@ -527,7 +559,7 @@ contract StakingStore is
         Amount newStakeAmount,
         Amount newRewardAmount
     )
-        internal
+        private
     {
         _stakeBalance[targetNftId] = newStakeAmount;
         _rewardBalance[targetNftId] = newRewardAmount;
@@ -537,7 +569,8 @@ contract StakingStore is
     }
 
     function _checkBalanceExists(NftId nftId)
-        internal
+        private
+        view
         returns (Blocknumber lastUpdatedIn)
     {
         lastUpdatedIn = _lastUpdatedIn[nftId];
@@ -552,7 +585,7 @@ contract StakingStore is
         NftId targetNftId,
         address token
     )
-        internal
+        private
         view
         returns (
             Blocknumber tvlLastUpdatedIn,

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