@etherisc/gif-next 0.0.2-fd4931b-974 → 0.0.2-fd5f17a-625

package/contracts/staking/Staking.sol

@@ -1,37 +1,30 @@
 // 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 {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 {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";
-
-// TODO split staking
-// candidate clusters
-// - strake management
-// - target management
-// - reward calculation
-// - read access
+import {Versionable} from "../upgradeability/Versionable.sol";
+
 contract Staking is 
-    KeyValueStore,
     Component,
     Versionable,
     IStaking
@@ -45,42 +38,33 @@ contract Staking is
     struct StakingStorage {
         IRegistryService _registryService;
         TokenRegistry _tokenRegistry;
+        TokenHandler _tokenHandler;
+        StakingStore _store;
         StakingReader _reader;
-
-        NftIdSetManager _targetManager;
-
-        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;
     }
 
 
-    modifier onlyNftOwner(NftId nftId) {
-        // TODO deal with special case protocol target (=owner = registry service owner)
-        if(msg.sender != getRegistry().ownerOf(nftId)) {
-            revert ErrorStakingNotNftOwner(nftId);
+    modifier onlyStake(NftId stakeNftId) {
+        if (!_getStakingStorage()._store.exists(stakeNftId)) {
+            revert ErrorStakingNotStake(stakeNftId);
         }
         _;
     }
 
 
-    // from Versionable
-    function getVersion()
-        public 
-        pure 
-        virtual override (IVersionable, Versionable)
-        returns(Version)
-    {
-        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
+    modifier onlyTarget(NftId targetNftId) {
+        if (!_getStakingStorage()._store.getTargetNftIdSet().exists(targetNftId)) {
+            revert ErrorStakingNotTarget(targetNftId);
+        }
+        _;
     }
 
-
     // set/update staking reader
     function setStakingReader(StakingReader stakingReader)
         external
         virtual
-        onlyOwner
+        onlyOwner()
     {
         if(stakingReader.getStaking() != IStaking(this)) {
             revert ErrorStakingStakingReaderStakingMismatch(address(stakingReader.getStaking()));
@@ -94,33 +78,18 @@ contract Staking is
     function setStakingRate(uint256 chainId, address token, UFixed stakingRate)
         external
         virtual
-        onlyOwner
-    {
-
-    }
-
-    // reward management 
-    function setRewardRate(NftId targetNftId, UFixed rewardRate)
-        external
-        virtual
-        // onlyNftOwner(targetNftId)
+        onlyOwner()
     {
+        StakingStorage storage $ = _getStakingStorage();
         
-    }
-
-    function refillRewardReserves(NftId targetNftId, Amount dipAmount)
-        external
-        virtual
-    {
+        if (!$._tokenRegistry.isRegistered(chainId, token)) {
+            revert ErrorStakingTokenNotRegistered(chainId, token);
+        }
 
-    }
+        UFixed oldStakingRate = $._store.getStakingRate(chainId, token);
+        $._store.setStakingRate(chainId, token, stakingRate);
 
-    function withdrawRewardReserves(NftId targetNftId, Amount dipAmount)
-        external
-        virtual
-        // onlyNftOwner(targetNftId)
-    {
-        
+        emit LogStakingStakingRateSet(chainId, token, oldStakingRate, stakingRate);
     }
 
     // target management
@@ -134,32 +103,23 @@ contract Staking is
     )
         external
         virtual
-        // restricted // staking service access
+        restricted()
     {
         TargetManagerLib.checkTargetParameters(
             getRegistry(), 
-            getStakingReader(),
+            _getStakingStorage()._reader,
             targetNftId, 
             expectedObjectType, 
             initialLockingPeriod, 
             initialRewardRate);
 
-        // record target info
-        _create(
-            targetNftId.toKey32(TARGET()),
-            abi.encode(
-                TargetInfo({
-                    objectType: expectedObjectType,
-                    chainId: chainId,
-                    lockingPeriod: initialLockingPeriod,
-                    rewardRate: initialRewardRate,
-                    rewardReserveAmount: AmountLib.zero()
-                })));
-
-        // add target nft id to all/active sets
-        _getStakingStorage()._targetManager.add(targetNftId);
-
-        emit LogStakingTargetAdded(targetNftId, expectedObjectType, chainId);
+        _getStakingStorage()._store.createTarget(
+            targetNftId,
+            TargetInfo({
+                objectType: expectedObjectType,
+                chainId: chainId,
+                lockingPeriod: initialLockingPeriod,
+                rewardRate: initialRewardRate}));
     }
 
 
@@ -169,42 +129,99 @@ contract Staking is
     )
         external
         virtual
-        onlyNftOwner(targetNftId)
+        restricted()
+        onlyTarget(targetNftId)
     {
         (
-            Key32 targetKey,
-            bytes memory targetData
+            Seconds oldLockingPeriod,
+            TargetInfo memory targetInfo
         ) = TargetManagerLib.updateLockingPeriod(
             this,
             targetNftId,
             lockingPeriod);
+        
+        _getStakingStorage()._store.updateTarget(targetNftId, targetInfo);
+
+        emit LogStakingLockingPeriodSet(targetNftId, oldLockingPeriod, lockingPeriod);
+    }
+
+    // TODO add function to set protocol reward rate: onlyOwner
+    // get protocol nft id (from where)
 
-        _update(targetKey, targetData, KEEP_STATE());
+    function setRewardRate(NftId targetNftId, UFixed rewardRate)
+        external
+        virtual
+        restricted()
+        onlyTarget(targetNftId)
+    {
+        (
+            UFixed oldRewardRate,
+            TargetInfo memory targetInfo
+        ) = TargetManagerLib.updateRewardRate(
+            this,
+            targetNftId,
+            rewardRate);
+        
+        _getStakingStorage()._store.updateTarget(targetNftId, targetInfo);
 
-        emit LogStakingLockingPeriodSet(targetNftId, lockingPeriod);
+        emit LogStakingRewardRateSet(targetNftId, oldRewardRate, rewardRate);
     }
 
 
-    function increaseTvl(NftId targetNftId, address token, Amount amount)
+    function refillRewardReserves(NftId targetNftId, Amount dipAmount)
         external
         virtual
-        // restricted // service to service access
+        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
+        restricted()
+        returns (Amount newBalance)
+    {
+        // update book keeping of reward reserves
+        StakingStorage storage $ = _getStakingStorage();
+        newBalance = $._store.decreaseReserves(targetNftId, dipAmount);
     }
 
-    function decreaseTvl(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 decreaseTotalValueLocked(NftId targetNftId, address token, Amount amount)
+        external
+        virtual
+        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
     {
         
@@ -213,80 +230,218 @@ contract Staking is
     function updateRemoteTvl(NftId targetNftId, address token, Amount amount)
         external
         virtual
+        restricted()
         onlyOwner // or CCIP
     {
         
     }
 
-    // staking functions
-    function create(
+    //--- staking functions -------------------------------------------------//
+
+    function createStake(
         NftId stakeNftId, 
         NftId targetNftId, 
-        Amount dipAmount
+        Amount stakeAmount
+    )
+        external
+        virtual
+        restricted() // only staking service
+    {
+        StakingStorage storage $ = _getStakingStorage();
+        Timestamp lockedUntil = StakeManagerLib.checkCreateParameters(
+            $._reader,
+            targetNftId,
+            stakeAmount);
+
+        // create new stake
+        $._store.create(
+            stakeNftId, 
+            StakeInfo({
+                lockedUntil: lockedUntil}));
+        
+        // update target stake balance
+        $._store.increaseStake(
+            stakeNftId,
+            targetNftId, 
+            stakeAmount);
+    }
+
+
+    function stake(
+        NftId stakeNftId, 
+        Amount stakeAmount
     )
         external
         virtual
+        restricted() // only staking service
+        onlyStake(stakeNftId)
+        returns (Amount stakeBalance)
     {
-        Timestamp currentTime = TimestampLib.blockTimestamp();
-        Timestamp lockedUntil = currentTime.addSeconds(
-            _getStakingStorage()._reader.getTargetInfo(targetNftId).lockingPeriod);
-
-        _create(
-            stakeNftId.toKey32(STAKE()),
-            abi.encode(
-                StakeInfo({
-                    stakeAmount: dipAmount,
-                    rewardAmount: AmountLib.zero(),
-                    lockedUntil: lockedUntil,
-                    rewardsUpdatedAt: currentTime
-                })));
+        StakingStorage storage $ = _getStakingStorage();
+        stakeBalance = StakeManagerLib.stake(
+            getRegistry(),
+            $._reader,
+            $._store,
+            stakeNftId,
+            stakeAmount);
     }
 
 
-    function stake(NftId stakeNftId, Amount dipAmount) external {}
-    function restakeRewards(NftId stakeNftId) external {}
-    function restakeToNewTarget(NftId stakeNftId, NftId newTarget) external {}
-    function unstake(NftId stakeNftId) external {}
-    function unstake(NftId stakeNftId, Amount dipAmount) external {}
-    function claimRewards(NftId stakeNftId) external {}
+    function restake(
+        NftId stakeNftId, 
+        NftId newTargetNftId
+    )
+        external
+        virtual
+        restricted() // only staking service
+        onlyStake(stakeNftId)
+        returns (NftId newStakeNftId)
+    {
+        // TODO add check that allows additional staking amount
+        StakingStorage storage $ = _getStakingStorage();
 
+        // TODO implement
+    }
 
-    // view functions
 
-    function getStakingReader() public view returns (StakingReader reader) {
-        return _getStakingStorage()._reader;
+    function updateRewards(NftId stakeNftId)
+        external
+        virtual
+        restricted() // only staking service
+        onlyStake(stakeNftId)
+    {
+        StakingStorage storage $ = _getStakingStorage();
+        _updateRewards($._reader, $._store, stakeNftId);
+    }
+
+
+    function claimRewards(NftId stakeNftId)
+        external
+        virtual
+        restricted() // only staking service
+        onlyStake(stakeNftId)
+        returns (
+            Amount rewardsClaimedAmount
+        )
+    {
+        StakingStorage storage $ = _getStakingStorage();
+
+        // update rewards since last update
+        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
+        restricted() // only staking service
+        onlyStake(stakeNftId)
+        returns (
+            Amount unstakedAmount,
+            Amount rewardsClaimedAmount
+        )
+    {
+        StakingStorage storage $ = _getStakingStorage();
+        
+        StakeManagerLib.checkUnstakeParameters($._reader, stakeNftId);
+        
+        // update rewards since last update
+        NftId targetNftId = _updateRewards($._reader, $._store, stakeNftId);
+
+        // unstake all available dips
+        (
+            unstakedAmount, 
+            rewardsClaimedAmount
+        ) = $._store.unstakeUpTo(
+            stakeNftId,
+            targetNftId,
+            AmountLib.max(), // unstake all stakes
+            AmountLib.max()); // claim all rewards
+
+        // update reward reserves
+        $._store.decreaseReserves(targetNftId, rewardsClaimedAmount);
     }
 
-    function getStakingRate(uint256 chainId, address token) external view returns (UFixed stakingRate) {
-        return _getStakingStorage()._stakingRate[chainId][token];
+
+
+    //--- other functions ---------------------------------------------------//
+
+    function collectDipAmount(address from, Amount dipAmount)
+        external
+        restricted() // only staking service
+    {
+        getTokenHandler().collectTokens(from, getWallet(), dipAmount);
     }
 
-    function getTargetManager() external view returns (NftIdSetManager targetManager) {
-        return _getStakingStorage()._targetManager;
+
+    function transferDipAmount(address to, Amount dipAmount)
+        external
+        restricted() // only staking service
+    {
+        getTokenHandler().distributeTokens(getWallet(), to, dipAmount);
     }
 
-    function getTvlAmount(NftId targetNftId, address token) external view returns (Amount tvlAmount) {
-        return _getStakingStorage()._tvlAmount[targetNftId][token];
+
+    //--- view functions ----------------------------------------------------//
+
+    function getStakingReader() public view returns (StakingReader reader) {
+        return _getStakingStorage()._reader;
     }
 
-    function getStakedAmount(NftId targetNftId) external view returns (Amount stakeAmount) {
-        return _getStakingStorage()._stakedAmount[targetNftId];
+    function getStakingStore() external view returns (StakingStore stakingStore) {
+        return _getStakingStorage()._store;
     }
 
     function getTokenRegistryAddress() external view returns (address tokenRegistry) {
         return address(_getStakingStorage()._tokenRegistry);
     }
 
-    function calculateRewardIncrementAmount(
-        NftId targetNftId,
-        Timestamp rewardsLastUpdatedAt
-    )
+    function getTokenHandler() public virtual override(Component, IComponent) view returns (TokenHandler tokenHandler) {
+        return _getStakingStorage()._tokenHandler;
+    }
+
+    // from Versionable
+    function getVersion()
         public 
+        pure 
+        virtual override (IVersionable, Versionable)
+        returns(Version)
+    {
+        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
+    }
+
+    //--- internal functions ------------------------------------------------//
+
+    function _updateRewards(
+        StakingReader reader,
+        StakingStore store,
+        NftId stakeNftId
+    )
+        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);
     }
 
 
@@ -299,43 +454,39 @@ contract Staking is
         initializer
     {
         (
-            address initialAuthority,
             address registryAddress,
-            address targetManagerAddress,
-            address stakingReaderAddress,
-            address initialOwner
-        ) = abi.decode(data, (address, address, address, address, address));
+            address tokenRegistryAddress,
+            address stakingStoreAddress,
+            address stakingOwner
+        ) = abi.decode(data, (address, address, address, address));
 
+        // only admin(authority) and dip token address are set in registry at this point
         IRegistry registry = IRegistry(registryAddress);
-        TokenRegistry tokenRegistry = TokenRegistry(registry.getTokenRegistryAddress());
-        address dipTokenAddress = address(tokenRegistry.getDipToken());
+        address authority = registry.getAuthority();
+        TokenRegistry tokenRegistry = TokenRegistry(tokenRegistryAddress);
+        address dipTokenAddress = tokenRegistry.getDipTokenAddress();
 
-        initializeComponent(
-            initialAuthority,
+        _initializeComponent(
+            authority,
             registryAddress, 
             registry.getNftId(), 
             CONTRACT_NAME,
             dipTokenAddress,
             STAKING(), 
             false, // is interceptor
-            initialOwner, 
+            stakingOwner, 
             "", // registry data
             ""); // component data
 
-        _createAndSetTokenHandler();
-
         // wiring to external contracts
         StakingStorage storage $ = _getStakingStorage();
-        $._targetManager = NftIdSetManager(targetManagerAddress);
-        $._reader = StakingReader(stakingReaderAddress);
-        $._tokenRegistry = TokenRegistry(
-            address(tokenRegistry));
+        $._protocolNftId = getRegistry().getProtocolNftId();
+        $._store = StakingStore(stakingStoreAddress);
+        $._reader = StakingStore(stakingStoreAddress).getStakingReader();
+        $._tokenRegistry = TokenRegistry(tokenRegistryAddress);
+        $._tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(dipTokenAddress, authority);
 
-        // wiring to staking
-        $._targetManager.setOwner(address(this));
-        $._reader.setStaking(address(this));
-
-        registerInterface(type(IStaking).interfaceId);
+        _registerInterface(type(IStaking).interfaceId);
     }
 
 
@@ -344,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());
+    }
+}