@etherisc/gif-next 0.0.2-e026265-044 → 0.0.2-e04dbfc-031

package/contracts/staking/IStaking.sol

@@ -1,11 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
 import {Amount} from "../type/Amount.sol";
 import {IComponent} from "../shared/IComponent.sol";
-import {IVersionable} from "../shared/IVersionable.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
 import {NftId} from "../type/NftId.sol";
-import {NftIdSetManager} from "../shared/NftIdSetManager.sol";
 import {ObjectType} from "../type/ObjectType.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {StakingReader} from "./StakingReader.sol";
@@ -23,6 +24,7 @@ interface IStaking is
     // target parameters
     event LogStakingLockingPeriodSet(NftId targetNftId, Seconds oldLockingPeriod, Seconds lockingPeriod);
     event LogStakingRewardRateSet(NftId targetNftId, UFixed oldRewardRate, UFixed rewardRate);
+    event LogStakingMaxStakedAmountSet(NftId targetNftId, Amount maxStakedAmount);
 
     // modifiers
     error ErrorStakingNotStake(NftId stakeNftId);
@@ -31,6 +33,9 @@ interface IStaking is
     error ErrorStakingNotStakingOwner();
     error ErrorStakingNotNftOwner(NftId nftId);
 
+    // initializeTokenHandler
+    error ErrorStakingNotRegistry(address registry);
+
     // staking rate
     error ErrorStakingTokenNotRegistered(uint256 chainId, address token);
 
@@ -43,13 +48,14 @@ interface IStaking is
     error ErrorStakingTargetNftIdZero();
     error ErrorStakingTargetTypeNotSupported(NftId targetNftId, ObjectType objectType);
     error ErrorStakingTargetUnexpectedObjectType(NftId targetNftId, ObjectType expectedObjectType, ObjectType actualObjectType);
-    error ErrorStakingLockingPeriodZero(NftId targetNftId);
+    error ErrorStakingLockingPeriodTooShort(NftId targetNftId, Seconds minLockingPeriod, Seconds lockingPeriod);
     error ErrorStakingLockingPeriodTooLong(NftId targetNftId, Seconds maxLockingPeriod, Seconds lockingPeriod);
+    error ErrorStakingStakeLocked(NftId stakeNftId, Timestamp lockedUntil);
     error ErrorStakingRewardRateTooHigh(NftId targetNftId, UFixed maxRewardRate, UFixed rewardRate);
     error ErrorStakingTargetNotFound(NftId targetNftId);
     error ErrorStakingTargetTokenNotFound(NftId targetNftId, uint256 chainId, address token);
+    error ErrorStakingTargetMaxStakedAmountExceeded(NftId targetNftId, Amount maxStakedAmount, Amount stakedAmount);
 
-    error ErrorStakingTargetNotActive(NftId targetNftId);
     error ErrorStakingStakeAmountZero(NftId targetNftId);
 
     // info for individual stake
@@ -62,8 +68,13 @@ interface IStaking is
         uint256 chainId;
         Seconds lockingPeriod;
         UFixed rewardRate;
+        Amount maxStakedAmount;
     }
 
+    function initializeTokenHandler() external;
+
+    function approveTokenHandler(IERC20Metadata token, Amount amount) external;
+
     // staking rate management 
 
     /// @dev sets the rate that converts 1 token of total value locked into the
@@ -90,6 +101,10 @@ interface IStaking is
     /// permissioned: only the staking service may call this function
     function setRewardRate(NftId targetNftId, UFixed rewardRate) external;
 
+    /// @dev set the maximum staked amount for the specified target.
+    /// permissioned: only the staking service may call this function
+    function setMaxStakedAmount(NftId targetNftId, Amount maxStakedAmount) external;
+
     /// @dev (re)fills the staking reward reserves for the specified target
     /// unpermissioned: anybody may fill up staking reward reserves
     function refillRewardReserves(NftId targetNftId, Amount dipAmount) external returns (Amount newBalance);
@@ -127,7 +142,7 @@ interface IStaking is
     /// @dev restakes the dips to a new target.
     /// the sum of the staked dips and the accumulated rewards will be restaked.
     /// permissioned: only staking service may call this function.
-    function restake(NftId stakeNftId, NftId newTargetNftId) external returns (NftId newStakeNftId);
+    function restake(NftId stakeNftId, NftId newStakeNftId) external returns (Amount newStakeBalance);
 
     /// @dev retuns the specified amount of dips to the holder of the specified stake nft.
     /// if dipAmount is set to Amount.max() all staked dips and all rewards are transferred to 
@@ -153,14 +168,6 @@ interface IStaking is
             Amount rewardsClaimedAmount
         );
 
-    //--- helper functions --------------------------------------------------//
-
-    /// @dev transfers the specified amount of dips from the from address to the staking wallet.
-    function collectDipAmount(address from, Amount dipAmount) external;
-
-    /// @dev transfers the specified amount of dips from the staking wallet to the to addess.
-    function transferDipAmount(address to, Amount dipAmount) external;
-
     //--- view and pure functions -------------------------------------------//
 
     function getStakingStore() external view returns (StakingStore stakingStore);

package/contracts/staking/IStakingService.sol

@@ -7,9 +7,7 @@ import {Amount} from "../type/Amount.sol";
 import {IService} from "../shared/IService.sol";
 import {IStaking} from "./IStaking.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType} from "../type/ObjectType.sol";
 import {Seconds} from "../type/Seconds.sol";
-import {Timestamp} from "../type/Timestamp.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 import {UFixed} from "../type/UFixed.sol";
 
@@ -28,22 +26,38 @@ interface IStakingService is IService
     event LogStakingServiceStakeCreated(NftId stakeNftId, NftId targetNftId, address owner, Amount stakedAmount);
     event LogStakingServiceStakeIncreased(NftId stakeNftId, address owner, Amount stakedAmount, Amount stakeBalance);
     event LogStakingServiceUnstaked(NftId stakeNftId, address stakeOwner, Amount totalAmount);
+    event LogStakingServiceStakeRestaked(address stakeOwner, NftId indexed stakeNftId, NftId newStakeNftId, NftId indexed newTargetNftId, Amount indexed newStakeBalance);
 
     event LogStakingServiceRewardsUpdated(NftId stakeNftId);
     event LogStakingServiceRewardsClaimed(NftId stakeNftId, address stakeOwner, Amount rewardsClaimedAmount);
 
     // modifiers
-    error ErrorStakingServiceNotNftOwner(NftId nftId, address expectedOwner, address owner);
+    error ErrorStakingServiceNotStakingOwner(address account);
     error ErrorStakingServiceNotStaking(address stakingAddress);
     error ErrorStakingServiceNotSupportingIStaking(address stakingAddress);
 
     // create
+    error ErrorStakingServiceTargetUnknown(NftId targetNftId);
     error ErrorStakingServiceZeroTargetNftId();
     error ErrorStakingServiceNotTargetNftId(NftId targetNftId);
     error ErrorStakingServiceNotActiveTargetNftId(NftId targetNftId);
     error ErrorStakingServiceDipBalanceInsufficient(NftId targetNftId, uint256 amount, uint256 balance);
     error ErrorStakingServiceDipAllowanceInsufficient(NftId targetNftId, address tokenHandler, uint256 amount, uint256 allowance);
 
+    /// @dev Set the protocol reward rate stake locking period to the specified duration.
+    /// Permissioned: only staking owner
+    // TODO implement
+    // function setProtocolRewardRate(UFixed rewardRate) external;
+    // function setProtocolLockingPeriod(Seconds lockingPeriod) external;
+    // TODO also make sure that protocol rewards can be refilled and withdrawn
+
+    /// @dev Approves the staking token handler.
+    /// Reverts if the staking token handler wallet is not the token handler itself.
+    function approveTokenHandler(
+        IERC20Metadata token,
+        Amount amount
+    ) external;
+
     /// @dev creates/registers an on-chain instance staking target.
     /// function granted to instance service
     function createInstanceTarget(
@@ -53,13 +67,17 @@ interface IStakingService is IService
     ) external;
 
     /// @dev Set the instance stake locking period to the specified duration.
-    /// permissioned: only the owner of the specified target may set the locking period
+    /// Permissioned: Only owner of the specified target.
     function setInstanceLockingPeriod(NftId instanceNftId, Seconds lockingPeriod) external;
 
-    /// @dev Set the instance reward rate to the specified value
-    /// permissioned: only the owner of the specified target may set the locking period
+    /// @dev Set the instance reward rate to the specified value.
+    /// Permissioned: Only owner of the specified target.
     function setInstanceRewardRate(NftId instanceNftId, UFixed rewardRate) external;
 
+    /// @dev Set the instance max staked amount to the specified value.
+    /// Permissioned: Only owner of the specified target.
+    function setInstanceMaxStakedAmount(NftId instanceNftId, Amount maxStakingAmount) external;
+
     /// @dev (Re)fills the staking reward reserves for the specified target using the dips provided by the reward provider.
     /// unpermissioned: anybody may fill up staking reward reserves
     function refillInstanceRewardReserves(NftId instanceNftId, address rewardProvider, Amount dipAmount) external returns (Amount newBalance);
@@ -68,8 +86,8 @@ interface IStakingService is IService
     /// unpermissioned: anybody may fill up staking reward reserves
     function refillRewardReservesBySender(NftId targetNftId, Amount dipAmount) external returns (Amount newBalance);
 
-    /// @dev defunds the staking reward reserves for the specified target
-    /// permissioned: only the target owner may call this function
+    /// @dev Defunds the staking reward reserves for the specified target
+    /// Permissioned: only the target owner may call this function
     function withdrawInstanceRewardReserves(NftId instanceNftId, Amount dipAmount) external returns (Amount newBalance);
 
     /// @dev create a new stake with amount DIP to the specified target
@@ -104,7 +122,8 @@ interface IStakingService is IService
     )
         external
         returns (
-            NftId newStakeNftId
+            NftId newStakeNftId,
+            Amount newStakeBalance
         );
 
 
@@ -141,13 +160,16 @@ interface IStakingService is IService
 
     function getDipToken()
         external
+        view
         returns (IERC20Metadata dip);
 
     function getTokenHandler()
         external
+        view
         returns (TokenHandler tokenHandler);
 
     function getStaking()
         external
+        view
         returns (IStaking staking);
 }

package/contracts/staking/Staking.sol

@@ -1,29 +1,32 @@
 // 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 {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
 import {IRegistry} from "../registry/IRegistry.sol";
-import {IRegistryService} from "../registry/IRegistryService.sol";
+import {IRelease} from "../registry/IRelease.sol";
 import {IStaking} from "./IStaking.sol";
-import {IVersionable} from "../shared/IVersionable.sol";
-import {Key32} from "../type/Key32.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 {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 {IComponentService} from "../shared/IComponentService.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType, STAKE, STAKING} from "../type/ObjectType.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {Registerable} from "../shared/Registerable.sol";
+import {StakingLib} from "./StakingLib.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 {Version, VersionLib} from "../type/Version.sol";
-import {Versionable} from "../shared/Versionable.sol";
+import {UFixed} from "../type/UFixed.sol";
+import {Version, VersionLib, VersionPart, VersionPartLib} from "../type/Version.sol";
+import {Versionable} from "../upgradeability/Versionable.sol";
 
 contract Staking is 
     Component,
@@ -31,14 +34,13 @@ contract Staking is
     IStaking
 {
     string public constant CONTRACT_NAME = "Staking";
-    uint8 private constant GIF_MAJOR_VERSION = 3;
 
     // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.component.Staking.sol")) - 1)) & ~bytes32(uint256(0xff));
     bytes32 public constant STAKING_LOCATION_V1 = 0xafe8d4462b2ed26a47154f4b8f6d1497d2f772496965791d25bd456e342b7f00;
 
     struct StakingStorage {
-        IRegistryService _registryService;
         TokenRegistry _tokenRegistry;
+        TokenHandler _tokenHandler;
         StakingStore _store;
         StakingReader _reader;
         NftId _protocolNftId;
@@ -54,12 +56,37 @@ contract Staking is
 
 
     modifier onlyTarget(NftId targetNftId) {
-        if (!_getStakingStorage()._store.getTargetManager().exists(targetNftId)) {
+        if (!_getStakingStorage()._store.getTargetNftIdSet().exists(targetNftId)) {
             revert ErrorStakingNotTarget(targetNftId);
         }
         _;
     }
 
+    function initializeTokenHandler()
+        external
+    {
+        if (msg.sender != address(getRegistry())) {
+            revert ErrorStakingNotRegistry(msg.sender);
+        }
+
+        StakingStorage storage $ = _getStakingStorage();
+        $._tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(
+            address(getRegistry()),
+            address(this),
+            address(getToken()), 
+            getRegistry().getAuthority());
+    }
+
+
+    function approveTokenHandler(IERC20Metadata token, Amount amount)
+        public
+        restricted()
+        onlyOwner()
+    {
+        _approveTokenHandler(token, amount);
+    }
+
+
     // set/update staking reader
     function setStakingReader(StakingReader stakingReader)
         external
@@ -119,7 +146,8 @@ contract Staking is
                 objectType: expectedObjectType,
                 chainId: chainId,
                 lockingPeriod: initialLockingPeriod,
-                rewardRate: initialRewardRate}));
+                rewardRate: initialRewardRate,
+                maxStakedAmount: AmountLib.max()}));
     }
 
 
@@ -167,6 +195,21 @@ contract Staking is
         emit LogStakingRewardRateSet(targetNftId, oldRewardRate, rewardRate);
     }
 
+    function setMaxStakedAmount(NftId targetNftId, Amount maxStakedAmount)
+        external
+        virtual
+        restricted()
+        onlyTarget(targetNftId)
+    {
+        IStaking.TargetInfo memory targetInfo = getStakingReader().getTargetInfo(targetNftId);
+
+        targetInfo.maxStakedAmount = maxStakedAmount;
+        
+        _getStakingStorage()._store.updateTarget(targetNftId, targetInfo);
+
+        emit LogStakingMaxStakedAmountSet(targetNftId, maxStakedAmount);
+    }
+
 
     function refillRewardReserves(NftId targetNftId, Amount dipAmount)
         external
@@ -248,7 +291,7 @@ contract Staking is
         restricted() // only staking service
     {
         StakingStorage storage $ = _getStakingStorage();
-        Timestamp lockedUntil = StakeManagerLib.checkCreateParameters(
+        Timestamp lockedUntil = StakingLib.checkCreateParameters(
             $._reader,
             targetNftId,
             stakeAmount);
@@ -278,7 +321,7 @@ contract Staking is
         returns (Amount stakeBalance)
     {
         StakingStorage storage $ = _getStakingStorage();
-        stakeBalance = StakeManagerLib.stake(
+        stakeBalance = StakingLib.stake(
             getRegistry(),
             $._reader,
             $._store,
@@ -289,20 +332,25 @@ contract Staking is
 
     function restake(
         NftId stakeNftId, 
-        NftId newTargetNftId
+        NftId newStakeNftId
     )
         external
         virtual
         restricted() // only staking service
         onlyStake(stakeNftId)
-        returns (NftId newStakeNftId)
+        returns (Amount newStakeBalance)
     {
+        _checkNftType(stakeNftId, STAKE());
+        _checkNftType(newStakeNftId, STAKE());
+
         // TODO add check that allows additional staking amount
         StakingStorage storage $ = _getStakingStorage();
-
-        // TODO implement
-   }
-
+        newStakeBalance = StakingLib.restake(
+            $._reader,
+            $._store,
+            stakeNftId,
+            newStakeNftId);    
+    }
 
     function updateRewards(NftId stakeNftId)
         external
@@ -350,9 +398,10 @@ contract Staking is
             Amount rewardsClaimedAmount
         )
     {
-        // TODO add check that stake locking is in the past
         StakingStorage storage $ = _getStakingStorage();
-
+        
+        StakingLib.checkUnstakeParameters($._reader, stakeNftId);
+        
         // update rewards since last update
         NftId targetNftId = _updateRewards($._reader, $._store, stakeNftId);
 
@@ -371,43 +420,6 @@ contract Staking is
     }
 
 
-
-    //--- other functions ---------------------------------------------------//
-
-    function collectDipAmount(address from, Amount dipAmount)
-        external
-        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
-        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) {
@@ -422,15 +434,28 @@ contract Staking is
         return address(_getStakingStorage()._tokenRegistry);
     }
 
+    function getTokenHandler() public virtual override(Component, IComponent) view returns (TokenHandler tokenHandler) {
+        return _getStakingStorage()._tokenHandler;
+    }
+
+    // from IRegisterable
+    function getRelease()
+        public 
+        pure 
+        virtual override (IRelease, Registerable)
+        returns(VersionPart)
+    {
+        return VersionPartLib.toVersionPart(3);
+    }
 
-    // from Versionable
+    // from IVersionable
     function getVersion()
         public 
         pure 
-        virtual override (IVersionable, Versionable)
+        virtual override (Component, IVersionable, Versionable)
         returns(Version)
     {
-        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
+        return VersionLib.toVersion(3,0,0);
     }
 
     //--- internal functions ------------------------------------------------//
@@ -447,7 +472,7 @@ contract Staking is
         UFixed rewardRate;
 
         (targetNftId, rewardRate) = reader.getTargetRewardRate(stakeNftId);
-        (Amount rewardIncrement, ) = StakeManagerLib.calculateRewardIncrease(
+        (Amount rewardIncrement, ) = StakingLib.calculateRewardIncrease(
             reader, 
             stakeNftId,
             rewardRate);
@@ -459,13 +484,23 @@ contract Staking is
     }
 
 
+    function _approveTokenHandler(IERC20Metadata token, Amount amount)
+        internal
+        virtual override
+    {
+        IComponentService(_getServiceAddress(STAKING())).approveTokenHandler(
+            token, 
+            amount);
+    }
+
+
     function _initialize(
         address owner, 
         bytes memory data
     )
         internal
         virtual override
-        initializer
+        initializer()
     {
         (
             address registryAddress,
@@ -480,10 +515,17 @@ contract Staking is
         TokenRegistry tokenRegistry = TokenRegistry(tokenRegistryAddress);
         address dipTokenAddress = tokenRegistry.getDipTokenAddress();
 
-        initializeComponent(
+        // wiring to external contracts
+        StakingStorage storage $ = _getStakingStorage();
+        $._protocolNftId = registry.getProtocolNftId();
+        $._store = StakingStore(stakingStoreAddress);
+        $._reader = StakingStore(stakingStoreAddress).getStakingReader();
+        $._tokenRegistry = TokenRegistry(tokenRegistryAddress);
+
+        _initializeComponent(
             authority,
             registryAddress, 
-            registry.getNftId(), 
+            registry.getNftId(), // parent nft id
             CONTRACT_NAME,
             dipTokenAddress,
             STAKING(), 
@@ -492,16 +534,7 @@ 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);
-
-        registerInterface(type(IStaking).interfaceId);
+        _registerInterface(type(IStaking).interfaceId);
     }