@etherisc/gif-next 0.0.2-e769e2e-077 → 0.0.2-e802d97-713

package/contracts/staking/Staking.sol

@@ -1,26 +1,32 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
-import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
-
-import {ObjectType, REGISTRY, STAKING} from "../type/ObjectType.sol";
-import {NftId} from "../type/NftId.sol";
-import {Version, VersionLib, VersionPartLib} from "../type/Version.sol";
-
-import {Amount} from "../type/Amount.sol";
+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 {KeyValueStore} from "../shared/KeyValueStore.sol";
-import {Timestamp} from "../type/Timestamp.sol";
-import {UFixed} from "../type/UFixed.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 {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 {TokenHandler} from "../shared/TokenHandler.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 {IRegistry} from "../registry/IRegistry.sol";
-
 contract Staking is 
-    KeyValueStore,
     Component,
     Versionable,
     IStaking
@@ -32,19 +38,30 @@ contract Staking is
     bytes32 public constant STAKING_LOCATION_V1 = 0xafe8d4462b2ed26a47154f4b8f6d1497d2f772496965791d25bd456e342b7f00;
 
     struct StakingStorage {
-        mapping(uint256 chainId => mapping(address token => UFixed stakingRate)) _stakingRate;
-        mapping(NftId targetNftId => UFixed rewardRate) _rewardRate;
-        mapping(NftId targetNftId => Amount reserveAmount) _rewardReserveAmount;
-        mapping(NftId targetNftId => Amount stakedAmount) _stakedAmount;
-        mapping(NftId targetNftId => mapping(address token => Amount tvlAmount)) _tvlAmount;
+        IRegistryService _registryService;
+        TokenRegistry _tokenRegistry;
+        StakingStore _store;
+        StakingReader _reader;
+        NftId _protocolNftId;
     }
 
-    function _getStakingStorage() private pure returns (StakingStorage storage $) {
-        assembly {
-            $.slot := STAKING_LOCATION_V1
+
+    modifier onlyStake(NftId stakeNftId) {
+        if (!_getStakingStorage()._store.exists(stakeNftId)) {
+            revert ErrorStakingNotStake(stakeNftId);
         }
+        _;
     }
 
+
+    modifier onlyTarget(NftId targetNftId) {
+        if (!_getStakingStorage()._store.getTargetManager().exists(targetNftId)) {
+            revert ErrorStakingNotTarget(targetNftId);
+        }
+        _;
+    }
+
+
     // from Versionable
     function getVersion()
         public 
@@ -55,95 +72,164 @@ contract Staking is
         return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
     }
 
-    function _initialize(
-        address owner, 
-        bytes memory data
-    )
-        internal
-        virtual override
-        initializer
+    // set/update staking reader
+    function setStakingReader(StakingReader stakingReader)
+        external
+        virtual
+        onlyOwner
     {
-        (
-            address initialAuthority,
-            address registryAddress,
-            address dipTokenAddress,
-            address initialOwner
-        ) = abi.decode(data, (address, address, address, address));
-
-        initializeComponent(
-            initialAuthority,
-            registryAddress, 
-            IRegistry(registryAddress).getNftId(), 
-            CONTRACT_NAME,
-            dipTokenAddress,
-            STAKING(), 
-            false, // is interceptor
-            initialOwner, 
-            "", // registry data
-            ""); // component data
-
-        // create the staking token handler
-        _createAndSetTokenHandler();
+        if(stakingReader.getStaking() != IStaking(this)) {
+            revert ErrorStakingStakingReaderStakingMismatch(address(stakingReader.getStaking()));
+        }
 
-        registerInterface(type(IStaking).interfaceId);
+        _getStakingStorage()._reader = stakingReader;
     }
 
+
     // rate management 
     function setStakingRate(uint256 chainId, address token, UFixed stakingRate)
         external
         virtual
         onlyOwner
     {
+        StakingStorage storage $ = _getStakingStorage();
+        
+        if (!$._tokenRegistry.isRegistered(chainId, token)) {
+            revert ErrorStakingTokenNotRegistered(chainId, token);
+        }
 
+        UFixed oldStakingRate = $._store.getStakingRate(chainId, token);
+        $._store.setStakingRate(chainId, token, stakingRate);
+
+        emit LogStakingStakingRateSet(chainId, token, oldStakingRate, stakingRate);
     }
 
     // reward management 
-    function setRewardRate(NftId targetNftId, UFixed rewardRate)
+
+    // target management
+
+    function registerTarget(
+        NftId targetNftId,
+        ObjectType expectedObjectType,
+        uint256 chainId,
+        Seconds initialLockingPeriod,
+        UFixed initialRewardRate
+    )
         external
         virtual
-        // onlyNftOwner(targetNftId)
+        // restricted // staking service access
     {
-        
+        TargetManagerLib.checkTargetParameters(
+            getRegistry(), 
+            _getStakingStorage()._reader,
+            targetNftId, 
+            expectedObjectType, 
+            initialLockingPeriod, 
+            initialRewardRate);
+
+        _getStakingStorage()._store.createTarget(
+            targetNftId,
+            TargetInfo({
+                objectType: expectedObjectType,
+                chainId: chainId,
+                lockingPeriod: initialLockingPeriod,
+                rewardRate: initialRewardRate}));
     }
 
-    function refillRewardReserves(NftId targetNftId, Amount dipAmount)
+
+    function setLockingPeriod(
+        NftId targetNftId, 
+        Seconds lockingPeriod
+    )
         external
         virtual
+        // TODO add restricted // only staking service
+        onlyTarget(targetNftId)
     {
+        (
+            Seconds oldLockingPeriod,
+            TargetInfo memory targetInfo
+        ) = TargetManagerLib.updateLockingPeriod(
+            this,
+            targetNftId,
+            lockingPeriod);
+        
+        _getStakingStorage()._store.updateTarget(targetNftId, targetInfo);
 
+        emit LogStakingLockingPeriodSet(targetNftId, oldLockingPeriod, lockingPeriod);
     }
 
-    function withdrawRewardReserves(NftId targetNftId, Amount dipAmount)
+    // TODO add function to set protocol reward rate: onlyOwner
+    // get protocol nft id (from where)
+
+    function setRewardRate(NftId targetNftId, UFixed rewardRate)
         external
         virtual
-        // onlyNftOwner(targetNftId)
+        // TODO add restricted // only staking service
+        onlyTarget(targetNftId)
     {
+        (
+            UFixed oldRewardRate,
+            TargetInfo memory targetInfo
+        ) = TargetManagerLib.updateRewardRate(
+            this,
+            targetNftId,
+            rewardRate);
         
+        _getStakingStorage()._store.updateTarget(targetNftId, targetInfo);
+
+        emit LogStakingRewardRateSet(targetNftId, oldRewardRate, rewardRate);
     }
 
-    // target management
-    function registerTarget(NftId targetNftId)
+
+    function refillRewardReserves(NftId targetNftId, Amount dipAmount)
         external
         virtual
-        // restricted // service to service access
+        // TODO add restricted // only for target locking
+        returns (Amount newBalance)
     {
-
+        // update book keeping of reward reserves
+        StakingStorage storage $ = _getStakingStorage();
+        newBalance = $._store.increaseReserves(targetNftId, dipAmount);
     }
 
-    function increaseTvl(NftId targetNftId, address token, Amount amount)
+
+    function withdrawRewardReserves(NftId targetNftId, Amount dipAmount)
         external
         virtual
-        // restricted // service to service access
+        // TODO add restricted // only staking service
+        // onlyNftOwner(targetNftId)
+        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);
     }
 
 
@@ -163,50 +249,303 @@ contract Staking is
         
     }
 
-    // staking functions
-    function createStake(NftId targetNftId, Amount dipAmount) external returns(NftId stakeNftId) {}
-    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 {}
+    //--- staking functions -------------------------------------------------//
 
-    // view and pure functions (staking reader?)
-    function getStakingRate(uint256 chainId, address token) external view returns (UFixed stakingRate) {
-        return _getStakingStorage()._stakingRate[chainId][token];
+    function createStake(
+        NftId stakeNftId, 
+        NftId targetNftId, 
+        Amount stakeAmount
+    )
+        external
+        virtual
+        // TODO add 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 getRewardRate(NftId targetNftId) external view returns (UFixed rewardRate) {
-        return _getStakingStorage()._rewardRate[targetNftId];
+
+    function stake(
+        NftId stakeNftId, 
+        Amount stakeAmount
+    )
+        external
+        virtual
+        // TODO add restricted() // only staking service
+        onlyStake(stakeNftId)
+        returns (Amount stakeBalance)
+    {
+        StakingStorage storage $ = _getStakingStorage();
+
+        // check that target is active for staking
+        (
+            UFixed rewardRate,
+            Seconds lockingPeriod
+        ) = StakeManagerLib.checkStakeParameters(
+            $._reader, 
+            stakeNftId);        
+
+        // calculate new rewards (if any)
+        (
+            Amount rewardIncrementAmount, 
+            Amount currentTotalDipAmount
+        ) = StakeManagerLib.calculateRewardIncrease(
+            $._reader, 
+            stakeNftId,
+            rewardRate);
+
+        stakeBalance = currentTotalDipAmount + stakeAmount;
+
+        // TODO check that additional dip, rewards and rewards increment 
+        // are still ok with max target staking amount
+        NftId targetNftId = getRegistry().getObjectInfo(stakeNftId).parentNftId;
+
+        $._store.restakeRewards(
+            stakeNftId, 
+            targetNftId, 
+            rewardIncrementAmount);
+
+        $._store.increaseStake(
+            stakeNftId, 
+            targetNftId, 
+            stakeAmount);
+
+        // update locked until with target locking period
+        $._store.update(
+            stakeNftId, 
+            StakeInfo({
+                lockedUntil: TimestampLib.blockTimestamp().addSeconds(
+                    lockingPeriod)}));
     }
 
-    function getRewardReserves(NftId targetNftId) external view returns (Amount rewardReserveAmount)  {
-        return _getStakingStorage()._rewardReserveAmount[targetNftId];
+
+    function restake(
+        NftId stakeNftId, 
+        NftId newTargetNftId
+    )
+        external
+        virtual
+        // TODO add restricted() // only staking service
+        onlyStake(stakeNftId)
+        returns (NftId newStakeNftId)
+    {
+        // TODO add check that allows additional staking amount
+        StakingStorage storage $ = _getStakingStorage();
+
+        // TODO implement
+   }
+
+
+    function updateRewards(NftId stakeNftId)
+        external
+        virtual
+        // TODO add restricted() // only staking service
+        onlyStake(stakeNftId)
+    {
+        StakingStorage storage $ = _getStakingStorage();
+        _updateRewards($._reader, $._store, stakeNftId);
     }
 
 
-    function getStakeInfo() external view returns (NftId stakeNftId) {}
-    function getTargetInfo() external view returns (NftId stakeNftId) {}
+    function claimRewards(NftId stakeNftId)
+        external
+        virtual
+        // TODO add 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());
 
-    function getTvlAmount(NftId targetNftId, address token) external view returns (Amount tvlAmount) {
-        return _getStakingStorage()._tvlAmount[targetNftId][token];
+        // update reward reserves
+        $._store.decreaseReserves(targetNftId, rewardsClaimedAmount);
     }
 
-    function getStakedAmount(NftId targetNftId) external view returns (Amount stakeAmount) {
-        return _getStakingStorage()._stakedAmount[targetNftId];
+
+    function unstake(NftId stakeNftId)
+        external
+        virtual
+        // TODO add restricted() // only staking service
+        onlyStake(stakeNftId)
+        returns (
+            Amount unstakedAmount,
+            Amount rewardsClaimedAmount
+        )
+    {
+        // TODO add check that stake locking is in the past
+        StakingStorage storage $ = _getStakingStorage();
+
+        // 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 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);
+    }
+
+
+    //--- other functions ---------------------------------------------------//
+
+    function collectDipAmount(address from, Amount dipAmount)
+        external
+        // TODO add restricted() // only staking service
     {
+        TokenHandler tokenHandler = getTokenHandler();
+        address stakingWallet = getWallet();
+
+        StakeManagerLib.checkDipBalanceAndAllowance(
+            getToken(), 
+            from, 
+            address(tokenHandler), 
+            dipAmount);
+
+        tokenHandler.transfer(from, stakingWallet, dipAmount);
+    }
+
 
+    function transferDipAmount(address to, Amount dipAmount)
+        external
+        // TODO add restricted() // only staking service
+    {
+        TokenHandler tokenHandler = getTokenHandler();
+        address stakingWallet = getWallet();
+
+        StakeManagerLib.checkDipBalanceAndAllowance(
+            getToken(), 
+            stakingWallet, 
+            address(tokenHandler), 
+            dipAmount);
+
+        tokenHandler.transfer(stakingWallet, to, dipAmount);
+    }
+
+
+    //--- view functions ----------------------------------------------------//
+
+    function getStakingReader() public view returns (StakingReader reader) {
+        return _getStakingStorage()._reader;
+    }
+
+    function getStakingStore() external view returns (StakingStore stakingStore) {
+        return _getStakingStorage()._store;
+    }
+
+    function getTokenRegistryAddress() external view returns (address tokenRegistry) {
+        return address(_getStakingStorage()._tokenRegistry);
+    }
+
+    //--- internal functions ------------------------------------------------//
+
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        virtual override
+        initializer
+    {
+        (
+            address registryAddress,
+            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);
+        address authority = registry.getAuthority();
+        TokenRegistry tokenRegistry = TokenRegistry(tokenRegistryAddress);
+        address dipTokenAddress = tokenRegistry.getDipTokenAddress();
+
+        initializeComponent(
+            authority,
+            registryAddress, 
+            registry.getNftId(), 
+            CONTRACT_NAME,
+            dipTokenAddress,
+            STAKING(), 
+            false, // is interceptor
+            stakingOwner, 
+            "", // 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);
+
+        registerInterface(type(IStaking).interfaceId);
+    }
+
+
+    function _getStakingStorage() private pure returns (StakingStorage storage $) {
+        assembly {
+            $.slot := STAKING_LOCATION_V1
+        }
     }
 
 }

package/contracts/staking/StakingManager.sol

@@ -3,39 +3,47 @@ pragma solidity ^0.8.20;
 
 import {IVersionable} from "../shared/IVersionable.sol";
 import {ProxyManager} from "../shared/ProxyManager.sol";
+import {ReleaseManager} from "../registry/ReleaseManager.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
 {
-
     Staking private _staking;
+    address private _initialImplementation;
+    bytes private _initializationData;
 
     /// @dev initializes proxy manager with service implementation 
     constructor(
-        address initialAuthority,
-        address registryAddress,
-        address dipTokenAddress
+        address registry,
+        address tokenRegistry,
+        address stakingStore,
+        address initialOwner
     )
-        ProxyManager(registryAddress)
+        ProxyManager(registry)
     {
-        Staking stk = new Staking();
-        address initialOwner = msg.sender;
+        Staking stakingImplementation = new Staking();
 
-        bytes memory data = abi.encode(
-            initialAuthority, 
-            registryAddress, 
-            dipTokenAddress, 
+        _initialImplementation = address(stakingImplementation);
+        _initializationData = abi.encode(
+            registry,
+            tokenRegistry,
+            stakingStore,
             initialOwner);
 
         IVersionable versionable = deploy(
-            address(stk), 
-            data);
+            _initialImplementation, 
+            _initializationData);
 
         _staking = Staking(address(versionable));
     }
 
     //--- view functions ----------------------------------------------------//
+
     function getStaking()
         external
         view
@@ -43,4 +51,4 @@ contract StakingManager is
     {
         return _staking;
     }
-}
+}