@etherisc/gif-next 0.0.2-fd4931b-974 → 0.0.2-fd9539f-062

package/contracts/staking/StakingReader.sol

@@ -1,70 +1,101 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
 
 import {Amount} from "../type/Amount.sol";
+import {Blocknumber}  from "../type/Blocknumber.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 {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 {IStaking} from "../staking/IStaking.sol";
+import {StakingStore} from "./StakingStore.sol";
 import {Timestamp} from "../type/Timestamp.sol";
-import {UFixed} from "../type/UFixed.sol";
+import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
-contract StakingReader {
+contract StakingReader is
+    IRegistryLinked,
+    InitializableCustom
+{
 
-    error ErrorStakingReaderStakingAlreadySet(address staking);
+    error ErrorStakingReaderDependenciesAlreadySet();
 
+    IRegistry private _registry;
     IStaking private _staking;
+    StakingStore private _store;
 
-    function setStaking(address stakingAddress) external {
-        if (address(_staking) != address(0)) {
-            revert ErrorStakingReaderStakingAlreadySet(address(_staking));
-        }
+    constructor(IRegistry registry) InitializableCustom() {
+        _registry = registry;
+    }
 
+    function initialize(
+        address stakingAddress,
+        address stakingStoreAddress
+    )
+        external
+        initializer
+    {
         _staking = IStaking(stakingAddress);
+        _store = StakingStore(stakingStoreAddress);
     }
 
-    // view and pure functions (staking reader?)
+    // view and pure functions 
+
+    function getRegistry() external view returns (IRegistry registry) {
+        return _registry;
+    }
 
     function getStaking() external view returns (IStaking staking) {
         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 _staking.getTargetManager().exists(targetNftId);
+        return _store.getTargetManager().exists(targetNftId);
     }
 
 
     function targets() external view returns (uint256) {
-        return _staking.getTargetManager().nftIds();
+        return _store.getTargetManager().nftIds();
     }
 
 
     function getTargetNftId(uint256 idx) external view returns (NftId) {
-        return _staking.getTargetManager().getNftId(idx);
+        return _store.getTargetManager().getNftId(idx);
     }
 
 
     function isActive(NftId targetNftId) external view returns (bool) {
-        return _staking.getTargetManager().isActive(targetNftId);
+        return _store.getTargetManager().isActive(targetNftId);
     }
 
 
     function activeTargets() external view returns (uint256) {
-        return _staking.getTargetManager().activeNftIds();
+        return _store.getTargetManager().activeNftIds();
     }
 
 
     function getActiveTargetNftId(uint256 idx) external view returns (NftId) {
-        return _staking.getTargetManager().getActiveNftId(idx);
+        return _store.getTargetManager().getActiveNftId(idx);
+    }
+
+
+    function getTargetNftId(NftId stakeNftId) public view returns (NftId targetNftId) {
+        return _registry.getObjectInfo(stakeNftId).parentNftId;
     }
 
 
     function getTargetInfo(NftId targetNftId) public view returns (IStaking.TargetInfo memory info) {
-        bytes memory data = _staking.getData(targetNftId.toKey32(TARGET()));
+        bytes memory data = _store.getData(targetNftId.toKey32(TARGET()));
         if (data.length > 0) {
             return abi.decode(data, (IStaking.TargetInfo));
         }
@@ -72,21 +103,85 @@ contract StakingReader {
 
 
     function getStakeInfo(NftId stakeNftId) external view returns (IStaking.StakeInfo memory stakeInfo) {
-        bytes memory data = _staking.getData(stakeNftId.toKey32(STAKE()));
+        bytes memory data = _store.getData(stakeNftId.toKey32(STAKE()));
         if (data.length > 0) {
             return abi.decode(data, (IStaking.StakeInfo));
         }
     }
 
 
-    // function getTvlAmount(NftId targetNftId, address token) external view returns (Amount tvlAmount);
-    // function getStakedAmount(NftId targetNftId) external view returns (Amount stakeAmount);
+    /// @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 getStakingRate(uint256 chainId, address token) external view returns (UFixed stakingRate);
+    function getBalanceUpdatedAt(NftId nftId) external view returns (Timestamp updatedAt) {
+        return _store.getBalanceUpdatedAt(nftId); 
+    }
 
-    // function calculateRewardIncrementAmount(
-    //     NftId targetNftId,
-    //     Timestamp rewardsLastUpdatedAt
-    // ) external view returns (Amount rewardIncrementAmount);
+    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 getStakeBalances(NftId stakeNftId) 
+        external
+        view
+        returns (
+            Amount stakeAmount,
+            Amount rewardAmount,
+            Timestamp lastUpdatedAt
+        )
+    {
+        (
+            stakeAmount,
+            rewardAmount,
+            lastUpdatedAt
+        ) = _store.getStakeBalances(stakeNftId);
+    }
 }

package/contracts/staking/StakingService.sol

@@ -1,5 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {Amount} from "../type/Amount.sol";
 import {ChainNft} from "../registry/ChainNft.sol";
@@ -13,9 +15,11 @@ import {NftId, NftIdLib} from "../type/NftId.sol";
 import {ObjectType, INSTANCE, PROTOCOL, REGISTRY, STAKE, STAKING} from "../type/ObjectType.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {Service} from "../shared/Service.sol";
+import {StakeManagerLib} from "./StakeManagerLib.sol";
 import {StakingReader} from "./StakingReader.sol";
 import {TargetManagerLib} from "./TargetManagerLib.sol";
 import {Timestamp} from "../type/Timestamp.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
 import {UFixed} from "../type/UFixed.sol";
 
 
@@ -30,31 +34,17 @@ contract StakingService is
     struct StakingServiceStorage {
         RegistryService _registryService;
         IStaking _staking;
+        IERC20Metadata _dip;
+        TokenHandler _tokenHandler;
     }
 
-    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());
+    modifier onlyNftOwner(NftId nftId) {
+        if(msg.sender != getRegistry().ownerOf(nftId)) {
+            revert ErrorStakingServiceNotNftOwner(nftId, getRegistry().ownerOf(nftId), msg.sender);
+        }
+        _;
     }
 
-    // TODO cleanup
-    event LogDebug(uint256 id, string message);
 
     function createInstanceTarget(
         NftId targetNftId,
@@ -63,10 +53,8 @@ contract StakingService is
     )
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
     {
-        emit LogDebug(1, "before chainid");
-
         uint256 chainId = block.chainid;
         _getStakingServiceStorage()._staking.registerTarget(
             targetNftId,
@@ -74,6 +62,71 @@ contract StakingService is
             chainId,
             initialLockingPeriod,
             initialRewardRate);
+
+        emit LogStakingServiceInstanceTargetRegistered(targetNftId, chainId);
+    }
+
+
+    function setInstanceLockingPeriod(NftId instanceNftId, Seconds lockingPeriod)
+        external
+        virtual
+        restricted()
+    {
+        _getStakingServiceStorage()._staking.setLockingPeriod(
+            instanceNftId, 
+            lockingPeriod);
+    }
+
+
+    function setInstanceRewardRate(NftId instanceNftId, UFixed rewardRate)
+        external
+        virtual
+        restricted()
+    {
+        _getStakingServiceStorage()._staking.setRewardRate(
+            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);
     }
 
 
@@ -89,33 +142,15 @@ contract StakingService is
     )
         external
         virtual
+        restricted()
         returns (
             NftId stakeNftId
         )
     {
         StakingServiceStorage storage $ = _getStakingServiceStorage();
-        StakingReader stakingReader = $._staking.getStakingReader();
         address stakeOwner = msg.sender;
 
-        // check target nft id
-        if (targetNftId.eqz()) {
-            revert ErrorStakingServiceZeroTargetNftId();
-        }
-
-        if (!stakingReader.isTarget(targetNftId)) {
-            revert ErrorStakingServiceNotTargetNftId(targetNftId);
-        }
-
-        if (!stakingReader.isActive(targetNftId)) {
-            revert ErrorStakingServiceNotActiveTargetNftId(targetNftId);
-        }
-
-        // check balance and allowance
-        //TODO implement
-
-        // collect staked dip amount
-        //TODO implement
-
+        // target nft id checks are performed in $._staking.createStake() below
         // register new stake object with registry
         stakeNftId = $._registryService.registerStake(
             IRegistry.ObjectInfo({
@@ -127,97 +162,152 @@ contract StakingService is
                 initialOwner: stakeOwner,
                 data: ""
             }));
-        
-        // create stake info in staking
-        $._staking.create(
+
+        // create stake info with staking
+        $._staking.createStake(
             stakeNftId, 
             targetNftId,
             dipAmount);
 
-        emit LogStakingServiceNewStakeCreated(stakeNftId, stakeOwner, targetNftId, dipAmount);
+        // collect staked dip by staking
+        $._staking.collectDipAmount(
+            stakeOwner,
+            dipAmount);
+
+        emit LogStakingServiceStakeCreated(stakeNftId, targetNftId, stakeOwner, dipAmount);
     }
 
 
     function stake(
         NftId stakeNftId,
-        Amount amount
+        Amount dipAmount
     )
         external
         virtual
+        restricted()
+        onlyNftOwner(stakeNftId)
     {
+        StakingServiceStorage storage $ = _getStakingServiceStorage();
+        address stakeOwner = msg.sender;
+
+        // add additional staked dips by staking 
+        Amount stakeBalance = $._staking.stake(
+            stakeNftId, 
+            dipAmount);
+
+        // collect staked dip by staking
+        if (dipAmount.gtz()) {
+            $._staking.collectDipAmount(
+                stakeOwner,
+                dipAmount);
+        }
 
+        emit LogStakingServiceStakeIncreased(stakeNftId, stakeOwner, dipAmount, stakeBalance);
     }
 
 
-    function unstake(
+    function restakeToNewTarget(
         NftId stakeNftId,
-        Amount amount
+        NftId newTargetNftId
     )
         external
         virtual
+        restricted()
+        onlyNftOwner(stakeNftId)
+        returns (
+            NftId newStakeNftId
+        )
     {
+        StakingServiceStorage storage $ = _getStakingServiceStorage();
+        // TODO implement
+    } 
 
-    }
 
-    function close(
+    function updateRewards(
         NftId stakeNftId
     )
         external
         virtual
+        restricted()
     {
+        StakingServiceStorage storage $ = _getStakingServiceStorage();
+        $._staking.updateRewards(stakeNftId);
 
+        emit LogStakingServiceRewardsUpdated(stakeNftId);
     }
 
-    function reStake(
-        NftId stakeNftId,
-        NftId newTargetNftId
-    )
+
+    function claimRewards(NftId stakeNftId)
         external
         virtual
-        returns (
-            NftId newStakeNftId,
-            Timestamp unlockedAt
-        )
+        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 increaseTotalValueLocked(
-        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);
     }
 
 
-    function decreaseTotalValueLocked(
+    function setTotalValueLocked(
         NftId targetNftId,
         address token,
         Amount amount
     )
         external
         virtual
-        returns (Amount totalValueLocked)
+        restricted()
     {
+        // TODO implement
 
     }
 
+    //--- view functions ----------------------------------------------------//
 
-    function setTotalValueLocked(
-        NftId targetNftId,
-        address token,
-        Amount amount
-    )
+    function getDipToken()
         external
         virtual
+        returns (IERC20Metadata dip)
     {
+        return _getStakingServiceStorage()._dip;
+    }
+
 
+    function getTokenHandler()
+        external
+        virtual
+        returns (TokenHandler tokenHandler)
+    {
+        return _getStakingServiceStorage()._tokenHandler;
     }
 
 
@@ -229,6 +319,7 @@ contract StakingService is
         return _getStakingServiceStorage()._staking;
     }
 
+    //--- internal functions ------------------------------------------------//
 
     function _initialize(
         address owner, 
@@ -239,15 +330,18 @@ contract StakingService is
         initializer()
     {
         (
+            address authority,
             address registryAddress,
             address stakingAddress
-        ) = abi.decode(data, (address, address));
+        ) = abi.decode(data, (address, address, address));
 
-        initializeService(registryAddress, address(0), owner);
+        initializeService(registryAddress, authority, owner);
 
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         $._registryService = RegistryService(_getServiceAddress(REGISTRY()));
         $._staking = _registerStaking(stakingAddress);
+        $._dip = $._staking.getToken();
+        $._tokenHandler = $._staking.getTokenHandler();
 
         registerInterface(type(IStakingService).interfaceId);
     }
@@ -286,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

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IVersionable} from "../shared/IVersionable.sol";
@@ -14,6 +14,7 @@ contract StakingServiceManager is
 
     /// @dev initializes proxy manager with service implementation 
     constructor(
+        address authority,
         address registryAddress,
         bytes32 salt
     )
@@ -21,16 +22,15 @@ contract StakingServiceManager is
     {
         StakingService svc = new StakingService();
         bytes memory data = abi.encode(
+            authority, 
             registryAddress, 
             IRegistry(registryAddress).getStakingAddress());
-
         IVersionable versionable = deployDetermenistic(
             address(svc), 
             data,
             salt);
 
         _stakingService = StakingService(address(versionable));
-        _stakingService.registerProtocolTarget();
     }
 
     //--- view functions ----------------------------------------------------//