@etherisc/gif-next 0.0.2-7ef1483-704 → 0.0.2-7f111bb-562

package/contracts/staking/Staking.sol

@@ -1,30 +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 {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 {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,
@@ -40,14 +38,9 @@ contract Staking is
     struct StakingStorage {
         IRegistryService _registryService;
         TokenRegistry _tokenRegistry;
+        TokenHandler _tokenHandler;
         StakingStore _store;
         StakingReader _reader;
-
-        mapping(uint256 chainId => mapping(address token => UFixed stakingRate)) _stakingRate;
-
-        mapping(NftId targetNftId => Amount stakedAmount) _stakedAmount;
-        mapping(NftId targetNftId => mapping(address token => Amount tvlAmount)) _tvlAmount;
-
         NftId _protocolNftId;
     }
 
@@ -61,28 +54,17 @@ contract Staking is
 
 
     modifier onlyTarget(NftId targetNftId) {
-        if (!_getStakingStorage()._store.getTargetManager().exists(targetNftId)) {
+        if (!_getStakingStorage()._store.getTargetNftIdSet().exists(targetNftId)) {
             revert ErrorStakingNotTarget(targetNftId);
         }
         _;
     }
 
-
-    // from Versionable
-    function getVersion()
-        public 
-        pure 
-        virtual override (IVersionable, Versionable)
-        returns(Version)
-    {
-        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
-    }
-
     // set/update staking reader
     function setStakingReader(StakingReader stakingReader)
         external
         virtual
-        onlyOwner
+        onlyOwner()
     {
         if(stakingReader.getStaking() != IStaking(this)) {
             revert ErrorStakingStakingReaderStakingMismatch(address(stakingReader.getStaking()));
@@ -96,12 +78,19 @@ contract Staking is
     function setStakingRate(uint256 chainId, address token, UFixed stakingRate)
         external
         virtual
-        onlyOwner
+        onlyOwner()
     {
+        StakingStorage storage $ = _getStakingStorage();
+        
+        if (!$._tokenRegistry.isRegistered(chainId, token)) {
+            revert ErrorStakingTokenNotRegistered(chainId, token);
+        }
 
-    }
+        UFixed oldStakingRate = $._store.getStakingRate(chainId, token);
+        $._store.setStakingRate(chainId, token, stakingRate);
 
-    // reward management 
+        emit LogStakingStakingRateSet(chainId, token, oldStakingRate, stakingRate);
+    }
 
     // target management
 
@@ -114,7 +103,7 @@ contract Staking is
     )
         external
         virtual
-        // restricted // staking service access
+        restricted()
     {
         TargetManagerLib.checkTargetParameters(
             getRegistry(), 
@@ -140,8 +129,8 @@ contract Staking is
     )
         external
         virtual
-        // TODO add restricted // only staking service
-        onlyTarget(targetNftId) // maybe duplicate check
+        restricted()
+        onlyTarget(targetNftId)
     {
         (
             Seconds oldLockingPeriod,
@@ -162,7 +151,8 @@ contract Staking is
     function setRewardRate(NftId targetNftId, UFixed rewardRate)
         external
         virtual
-        onlyTarget(targetNftId) // maybe duplicate check
+        restricted()
+        onlyTarget(targetNftId)
     {
         (
             UFixed oldRewardRate,
@@ -181,39 +171,57 @@ contract Staking is
     function refillRewardReserves(NftId targetNftId, Amount dipAmount)
         external
         virtual
+        restricted()
+        returns (Amount newBalance)
     {
-
+        // update book keeping of reward reserves
+        StakingStorage storage $ = _getStakingStorage();
+        newBalance = $._store.increaseReserves(targetNftId, dipAmount);
     }
 
+
     function withdrawRewardReserves(NftId targetNftId, Amount dipAmount)
         external
         virtual
-        // onlyNftOwner(targetNftId)
+        restricted()
+        returns (Amount newBalance)
     {
-        
+        // update book keeping of reward reserves
+        StakingStorage storage $ = _getStakingStorage();
+        newBalance = $._store.decreaseReserves(targetNftId, dipAmount);
     }
 
 
-    function increaseTvl(NftId targetNftId, address token, Amount amount)
+    function increaseTotalValueLocked(NftId targetNftId, address token, Amount amount)
         external
         virtual
-        // restricted // service to service access
+        restricted() // only pool service
+        returns (Amount newBalance)
     {
-
+        StakingStorage storage $ = _getStakingStorage();
+        uint chainId = $._reader.getTargetInfo(targetNftId).chainId;
+        UFixed stakingRate = $._reader.getStakingRate(chainId, token);
+        newBalance = $._store.increaseTotalValueLocked(targetNftId, stakingRate, token, amount);
     }
 
-    function decreaseTvl(NftId targetNftId, address token, Amount amount)
+
+    function decreaseTotalValueLocked(NftId targetNftId, address token, Amount amount)
         external
         virtual
-        // restricted // service to service access
+        restricted() // only pool service
+        returns (Amount newBalance)
     {
-
+        StakingStorage storage $ = _getStakingStorage();
+        uint chainId = $._reader.getTargetInfo(targetNftId).chainId;
+        UFixed stakingRate = $._reader.getStakingRate(chainId, token);
+        newBalance = $._store.decreaseTotalValueLocked(targetNftId, stakingRate, token, amount);
     }
 
 
     function registerRemoteTarget(NftId targetNftId, TargetInfo memory targetInfo)
         external
         virtual
+        restricted()
         onlyOwner // or CCIP
     {
         
@@ -222,6 +230,7 @@ contract Staking is
     function updateRemoteTvl(NftId targetNftId, address token, Amount amount)
         external
         virtual
+        restricted()
         onlyOwner // or CCIP
     {
         
@@ -229,68 +238,76 @@ contract Staking is
 
     //--- staking functions -------------------------------------------------//
 
-    function registerStake(
+    function createStake(
         NftId stakeNftId, 
         NftId targetNftId, 
-        Amount dipAmount
+        Amount stakeAmount
     )
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
     {
-        Timestamp lockedUntil = StakeManagerLib.checkStakeParameters(
-            _getStakingStorage()._reader,
+        StakingStorage storage $ = _getStakingStorage();
+        Timestamp lockedUntil = StakeManagerLib.checkCreateParameters(
+            $._reader,
             targetNftId,
-            dipAmount);
+            stakeAmount);
 
-        _getStakingStorage()._store.create(
+        // create new stake
+        $._store.create(
             stakeNftId, 
             StakeInfo({
-                lockedUntil: lockedUntil}),
-            dipAmount);
+                lockedUntil: lockedUntil}));
+        
+        // update target stake balance
+        $._store.increaseStake(
+            stakeNftId,
+            targetNftId, 
+            stakeAmount);
     }
 
 
-    function stake(NftId stakeNftId, Amount dipAmount)
+    function stake(
+        NftId stakeNftId, 
+        Amount stakeAmount
+    )
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
         onlyStake(stakeNftId)
+        returns (Amount stakeBalance)
     {
         StakingStorage storage $ = _getStakingStorage();
-        Amount rewardIncrement = StakeManagerLib.calculateRewardIncrease(
-            $._reader, 
-            stakeNftId);
-
-        $._store.increaseBalance(
-            stakeNftId, 
-            dipAmount,
-            rewardIncrement);
+        stakeBalance = StakeManagerLib.stake(
+            getRegistry(),
+            $._reader,
+            $._store,
+            stakeNftId,
+            stakeAmount);
     }
 
 
-    function restake(NftId stakeNftId)
+    function restake(
+        NftId stakeNftId, 
+        NftId newTargetNftId
+    )
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
         onlyStake(stakeNftId)
+        returns (NftId newStakeNftId)
     {
-        // TODO add check that target is active and allows additional staking amount
+        // TODO add check that allows additional staking amount
         StakingStorage storage $ = _getStakingStorage();
-        Amount rewardIncrement = StakeManagerLib.calculateRewardIncrease(
-            $._reader, 
-            stakeNftId);
 
-        $._store.restakeRewards(
-            stakeNftId, 
-            rewardIncrement);
+        // TODO implement
     }
 
 
     function updateRewards(NftId stakeNftId)
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
         onlyStake(stakeNftId)
     {
         StakingStorage storage $ = _getStakingStorage();
@@ -301,7 +318,7 @@ contract Staking is
     function claimRewards(NftId stakeNftId)
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
         onlyStake(stakeNftId)
         returns (
             Amount rewardsClaimedAmount
@@ -310,30 +327,35 @@ contract Staking is
         StakingStorage storage $ = _getStakingStorage();
 
         // update rewards since last update
-        _updateRewards($._reader, $._store, stakeNftId);
+        NftId targetNftId = _updateRewards($._reader, $._store, stakeNftId);
 
         // unstake all available rewards
         rewardsClaimedAmount = $._store.claimUpTo(
             stakeNftId,
+            targetNftId, 
             AmountLib.max());
+
+        // update reward reserves
+        $._store.decreaseReserves(targetNftId, rewardsClaimedAmount);
     }
 
 
     function unstake(NftId stakeNftId)
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
         onlyStake(stakeNftId)
         returns (
             Amount unstakedAmount,
             Amount rewardsClaimedAmount
         )
     {
-        // TODO add check that stake locking is in the past
         StakingStorage storage $ = _getStakingStorage();
-
+        
+        StakeManagerLib.checkUnstakeParameters($._reader, stakeNftId);
+        
         // update rewards since last update
-        _updateRewards($._reader, $._store, stakeNftId);
+        NftId targetNftId = _updateRewards($._reader, $._store, stakeNftId);
 
         // unstake all available dips
         (
@@ -341,63 +363,31 @@ contract Staking is
             rewardsClaimedAmount
         ) = $._store.unstakeUpTo(
             stakeNftId,
+            targetNftId,
             AmountLib.max(), // unstake all stakes
             AmountLib.max()); // claim all rewards
-    }
-
-
-
-    function _updateRewards(
-        StakingReader reader,
-        StakingStore store,
-        NftId stakeNftId
-    )
-        internal
-        virtual
-    {
-        Amount rewardIncrement = StakeManagerLib.calculateRewardIncrease(
-            reader, 
-            stakeNftId);
 
-        store.updateRewards(
-            stakeNftId, 
-            rewardIncrement);
+        // update reward reserves
+        $._store.decreaseReserves(targetNftId, rewardsClaimedAmount);
     }
 
 
+
     //--- other functions ---------------------------------------------------//
 
     function collectDipAmount(address from, Amount dipAmount)
         external
-        // TODO add restricted() // only staking service
+        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);
     }
 
 
     function transferDipAmount(address to, Amount dipAmount)
         external
-        // TODO add restricted() // only staking service
+        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);
     }
 
 
@@ -411,35 +401,49 @@ contract Staking is
         return _getStakingStorage()._store;
     }
 
-    function getStakingRate(uint256 chainId, address token) external view returns (UFixed stakingRate) {
-        return _getStakingStorage()._stakingRate[chainId][token];
+    function getTokenRegistryAddress() external view returns (address tokenRegistry) {
+        return address(_getStakingStorage()._tokenRegistry);
     }
 
-    function getTvlAmount(NftId targetNftId, address token) external view returns (Amount tvlAmount) {
-        return _getStakingStorage()._tvlAmount[targetNftId][token];
+    function getTokenHandler() public virtual override(Component, IComponent) view returns (TokenHandler tokenHandler) {
+        return _getStakingStorage()._tokenHandler;
     }
 
-    function getStakedAmount(NftId targetNftId) external view returns (Amount stakeAmount) {
-        return _getStakingStorage()._stakedAmount[targetNftId];
+    // from Versionable
+    function getVersion()
+        public 
+        pure 
+        virtual override (IVersionable, Versionable)
+        returns(Version)
+    {
+        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
     }
 
-    function getTokenRegistryAddress() external view returns (address tokenRegistry) {
-        return address(_getStakingStorage()._tokenRegistry);
-    }
+    //--- internal functions ------------------------------------------------//
 
-    function calculateRewardIncrementAmount(
-        NftId targetNftId,
-        Timestamp rewardsLastUpdatedAt
+    function _updateRewards(
+        StakingReader reader,
+        StakingStore store,
+        NftId stakeNftId
     )
-        public 
+        internal
         virtual
-        view 
-        returns (Amount rewardIncrementAmount)
+        returns (NftId targetNftId)
     {
+        UFixed rewardRate;
 
+        (targetNftId, rewardRate) = reader.getTargetRewardRate(stakeNftId);
+        (Amount rewardIncrement, ) = StakeManagerLib.calculateRewardIncrease(
+            reader, 
+            stakeNftId,
+            rewardRate);
+
+        store.updateRewards(
+            stakeNftId, 
+            targetNftId,
+            rewardIncrement);
     }
 
-    //--- internal functions ------------------------------------------------//
 
     function _initialize(
         address owner, 
@@ -462,7 +466,7 @@ contract Staking is
         TokenRegistry tokenRegistry = TokenRegistry(tokenRegistryAddress);
         address dipTokenAddress = tokenRegistry.getDipTokenAddress();
 
-        initializeComponent(
+        _initializeComponent(
             authority,
             registryAddress, 
             registry.getNftId(), 
@@ -474,17 +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);
     }
 
 
@@ -493,5 +495,4 @@ contract Staking is
             $.slot := STAKING_LOCATION_V1
         }
     }
-
 }

package/contracts/staking/StakingLifecycle.sol

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {TARGET, COMPONENT, STAKE} from "../type/ObjectType.sol";
+import {INITIAL} from "../type/StateId.sol";
+import {Lifecycle} from "../shared/Lifecycle.sol";
+
+contract StakingLifecycle is
+    Lifecycle
+{
+    constructor() {
+        _setupLifecycle();
+    }
+
+    function _setupLifecycle()
+        internal
+        override
+    {
+        setInitialState(TARGET(), INITIAL());
+        setInitialState(COMPONENT(), INITIAL());
+        setInitialState(STAKE(), INITIAL());
+    }
+}

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