@etherisc/gif-next 0.0.2-7f39e38-904 → 0.0.2-7fbee0d-269

package/contracts/staking/StakingService.sol

@@ -3,22 +3,17 @@ pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
-import {Amount} from "../type/Amount.sol";
-import {ChainNft} from "../registry/ChainNft.sol";
-import {IPoolService} from "../pool/IPoolService.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
 import {IStaking} from "./IStaking.sol";
 import {IStakingService} from "./IStakingService.sol";
+
+import {Amount} from "../type/Amount.sol";
+import {RegistryService} from "../registry/RegistryService.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
-import {ObjectType, INSTANCE, PROTOCOL, REGISTRY, STAKE, STAKING} from "../type/ObjectType.sol";
+import {ObjectType, INSTANCE, 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";
 
@@ -38,37 +33,16 @@ contract StakingService is
         TokenHandler _tokenHandler;
     }
 
-    modifier onlyNftOwner(NftId nftId) {
-        if(msg.sender != getRegistry().ownerOf(nftId)) {
-            revert ErrorStakingServiceNotNftOwner(nftId, getRegistry().ownerOf(nftId), msg.sender);
+
+    modifier onlyStaking() {
+        if (msg.sender != address(_getStakingServiceStorage()._staking)) {
+            revert ErrorStakingServiceNotStaking(msg.sender);
         }
         _;
     }
 
-    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());
-
-        emit LogStakingServiceProtocolTargetRegistered(protocolNftId);
-    }
-
 
+    /// @inheritdoc IStakingService
     function createInstanceTarget(
         NftId targetNftId,
         Seconds initialLockingPeriod,
@@ -76,197 +50,156 @@ contract StakingService is
     )
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
+        restricted()
     {
         uint256 chainId = block.chainid;
         _getStakingServiceStorage()._staking.registerTarget(
             targetNftId,
             INSTANCE(),
-            chainId,
             initialLockingPeriod,
             initialRewardRate);
 
         emit LogStakingServiceInstanceTargetRegistered(targetNftId, chainId);
     }
 
-    function setLockingPeriod(NftId targetNftId, Seconds lockingPeriod)
+
+    /// @inheritdoc IStakingService
+    function setInstanceLockingPeriod(NftId instanceNftId, Seconds lockingPeriod)
         external
         virtual
-        onlyNftOwner(targetNftId)
+        restricted()
     {
+        _checkNftType(instanceNftId, INSTANCE());
         _getStakingServiceStorage()._staking.setLockingPeriod(
-            targetNftId, lockingPeriod);
+            instanceNftId, 
+            lockingPeriod);
     }
 
-    function setRewardRate(NftId targetNftId, UFixed rewardRate)
+
+    /// @inheritdoc IStakingService
+    function setInstanceRewardRate(NftId instanceNftId, UFixed rewardRate)
         external
         virtual
-        onlyNftOwner(targetNftId)
+        restricted()
     {
+        _checkNftType(instanceNftId, INSTANCE());
         _getStakingServiceStorage()._staking.setRewardRate(
-            targetNftId, rewardRate);
-
+            instanceNftId, 
+            rewardRate);
     }
 
 
-    /// @dev creates a new stake to the specified target nft id with the provided dip amount
-    /// the target nft id must have been registered as an active staking target prior to this call
-    /// the sender of this transaction becomes the stake owner via the minted nft.
-    /// to create the new stake balance and allowance of the staker need to cover the dip amount
-    /// the allowance needs to be on the token handler of the staking contract (getTokenHandler())
-    /// this is a permissionless function.
-    function create(
-        NftId targetNftId,
-        Amount dipAmount
-    )
+    /// @inheritdoc IStakingService
+    function setInstanceMaxStakedAmount(NftId instanceNftId, Amount maxStakingAmount)
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
-        returns (
-            NftId stakeNftId
-        )
+        restricted()
     {
-        StakingServiceStorage storage $ = _getStakingServiceStorage();
-        StakingReader stakingReader = $._staking.getStakingReader();
-        address stakeOwner = msg.sender;
-
-        StakeManagerLib.checkActiveTarget(
-            stakingReader,
-            targetNftId);
-
-        // register new stake object with registry
-        stakeNftId = $._registryService.registerStake(
-            IRegistry.ObjectInfo({
-                nftId: NftIdLib.zero(),
-                parentNftId: targetNftId,
-                objectType: STAKE(),
-                isInterceptor: false,
-                objectAddress: address(0),
-                initialOwner: stakeOwner,
-                data: ""
-            }));
-
-        // create stake info with staking
-        $._staking.registerStake(
-            stakeNftId, 
-            targetNftId,
-            dipAmount);
-
-        // collect staked dip by staking
-        $._staking.collectDipAmount(
-            stakeOwner,
-            dipAmount);
-
-        emit LogStakingServiceStakeCreated(stakeNftId, targetNftId, stakeOwner, dipAmount);
+        _checkNftType(instanceNftId, INSTANCE());
+        _getStakingServiceStorage()._staking.setMaxStakedAmount(
+            instanceNftId, 
+            maxStakingAmount);
     }
 
 
-    function stake(
-        NftId stakeNftId,
-        Amount dipAmount
-    )
+    /// @inheritdoc IStakingService
+    function refillInstanceRewardReserves(NftId instanceNftId, address rewardProvider, Amount dipAmount)
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
-        onlyNftOwner(stakeNftId)
+        restricted()
+        returns (Amount newBalance)
     {
-        StakingServiceStorage storage $ = _getStakingServiceStorage();
-        StakingReader stakingReader = $._staking.getStakingReader();
-        address stakeOwner = msg.sender;
+        // checks
+        _checkNftType(instanceNftId, INSTANCE());
 
-        // add additional staked dips by staking
-        $._staking.stake(
-            stakeNftId, 
-            dipAmount);
-
-        // collect staked dip by staking
-        $._staking.collectDipAmount(
-            stakeOwner,
-            dipAmount);
+        // update reward reserve book keeping
+        StakingServiceStorage storage $ = _getStakingServiceStorage();
+        address instanceOwner = getRegistry().ownerOf(instanceNftId);
+        newBalance = $._staking.refillRewardReservesByService(instanceNftId, dipAmount, instanceOwner);
 
-        emit LogStakingServiceStakeIncreased(stakeNftId, stakeOwner, dipAmount);
+        emit LogStakingServiceRewardReservesIncreased(instanceNftId, rewardProvider, dipAmount, newBalance);
     }
 
 
-    function restake(
-        NftId stakeNftId
-    )
+    /// @inheritdoc IStakingService
+    function withdrawInstanceRewardReserves(NftId instanceNftId, Amount dipAmount)
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
-        onlyNftOwner(stakeNftId)
+        restricted()
+        returns (Amount newBalance)
     {
-        // restake all rewards as additional stakes
+        _checkNftType(instanceNftId, INSTANCE());
+        // update reward reserve book keeping
         StakingServiceStorage storage $ = _getStakingServiceStorage();
-        $._staking.restake(stakeNftId);
+        address instanceOwner = getRegistry().ownerOf(instanceNftId);
+        newBalance = $._staking.withdrawRewardReservesByService(instanceNftId, dipAmount, instanceOwner);
+
+        emit LogStakingServiceRewardReservesDecreased(instanceNftId, instanceOwner, dipAmount, newBalance);
     }
 
 
-    function restakeToNewTarget(
-        NftId stakeNftId,
-        NftId newTargetNftId
+    /// @inheritdoc IStakingService
+    function createStakeObject(
+        NftId targetNftId,
+        address stakeOwner
     )
         external
         virtual
-        // restricted // TODO re-enable once services have stable roles
-        onlyNftOwner(stakeNftId)
-        returns (
-            NftId newStakeNftId
-        )
+        restricted()
+        onlyStaking()
+        returns (NftId stakeNftId)
     {
-        // TODO implement
-    } 
-
+        StakingServiceStorage storage $ = _getStakingServiceStorage();
 
-    function unstake(
-        NftId stakeNftId,
-        Amount amount
-    )
-        external
-        virtual
-    {
+        // target nft id checks are performed in $._staking.createStake() below
+        // register new stake object with registry
+        stakeNftId = $._registryService.registerStake(
+            IRegistry.ObjectInfo({
+                nftId: NftIdLib.zero(),
+                parentNftId: targetNftId,
+                objectType: STAKE(),
+                isInterceptor: false,
+                objectAddress: address(0),
+                initialOwner: stakeOwner,
+                data: ""
+            }));
 
+        emit LogStakingServiceStakeObjectCreated(stakeNftId, targetNftId, stakeOwner);
     }
 
 
-    function updateRewards(
-        NftId stakeNftId
-    )
+    /// @inheritdoc IStakingService
+    function pullDipToken(Amount dipAmount, address stakeOwner)
         external
-        // unpermissioned, anybody may call this function
-        // TODO consider to add restricted (just to be able to disable function when target is disabled)
+        virtual
+        restricted()
+        onlyStaking()
     {
-        StakingServiceStorage storage $ = _getStakingServiceStorage();
-        $._staking.updateRewards(stakeNftId);
-
-        emit LogStakingServiceRewardsUpdated(stakeNftId);
+        _getStakingServiceStorage()._tokenHandler.pullToken(stakeOwner, dipAmount);
     }
 
 
-
-    function increaseTotalValueLocked(
-        NftId targetNftId,
-        address token,
-        Amount amount
-    )
+    /// @inheritdoc IStakingService
+    function pushDipToken(Amount dipAmount, address stakeOwner)
         external
         virtual
-        returns (Amount totalValueLocked)
+        restricted()
+        onlyStaking()
     {
-
+        _getStakingServiceStorage()._tokenHandler.pushToken(stakeOwner, dipAmount);
     }
 
 
-    function decreaseTotalValueLocked(
-        NftId targetNftId,
-        address token,
+    /// @inheritdoc IStakingService
+    function approveTokenHandler(
+        IERC20Metadata token,
         Amount amount
     )
         external
         virtual
-        returns (Amount totalValueLocked)
+        onlyStaking()
     {
-
+        _getStakingServiceStorage()._tokenHandler.approve(token, amount);
     }
 
 
@@ -277,13 +210,17 @@ contract StakingService is
     )
         external
         virtual
+        restricted()
     {
+        // TODO implement
 
     }
 
+    //--- view functions ----------------------------------------------------//
 
     function getDipToken()
         external
+        view
         virtual
         returns (IERC20Metadata dip)
     {
@@ -293,6 +230,7 @@ contract StakingService is
 
     function getTokenHandler()
         external
+        view
         virtual
         returns (TokenHandler tokenHandler)
     {
@@ -302,12 +240,14 @@ contract StakingService is
 
     function getStaking()
         external
+        view
         virtual
         returns (IStaking staking)
     {
         return _getStakingServiceStorage()._staking;
     }
 
+    //--- internal functions ------------------------------------------------//
 
     function _initialize(
         address owner, 
@@ -318,19 +258,20 @@ contract StakingService is
         initializer()
     {
         (
-            address registryAddress,
-            address stakingAddress
-        ) = abi.decode(data, (address, address));
+            address authority,
+            address registry,
+            address staking
+        ) = abi.decode(data, (address, address, address));
 
-        initializeService(registryAddress, address(0), owner);
+        __Service_init(authority, registry, owner);
 
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         $._registryService = RegistryService(_getServiceAddress(REGISTRY()));
-        $._staking = _registerStaking(stakingAddress);
+        $._staking = _registerStaking(staking);
         $._dip = $._staking.getToken();
         $._tokenHandler = $._staking.getTokenHandler();
 
-        registerInterface(type(IStakingService).interfaceId);
+        _registerInterface(type(IStakingService).interfaceId);
     }
 
 
@@ -372,4 +313,9 @@ contract StakingService is
             $.slot := STAKING_SERVICE_LOCATION_V1
         }
     }
+
+
+    function _getDomain() internal pure override returns(ObjectType) {
+        return STAKING();
+    }
 }

package/contracts/staking/StakingServiceManager.sol

@@ -2,8 +2,9 @@
 pragma solidity ^0.8.20;
 
 import {IRegistry} from "../registry/IRegistry.sol";
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {StakingService} from "./StakingService.sol";
 
 contract StakingServiceManager is
@@ -14,23 +15,24 @@ contract StakingServiceManager is
 
     /// @dev initializes proxy manager with service implementation 
     constructor(
-        address registryAddress,
+        address authority,
+        address registry,
         bytes32 salt
     )
-        ProxyManager(registryAddress)
     {
         StakingService svc = new StakingService();
         bytes memory data = abi.encode(
-            registryAddress, 
-            IRegistry(registryAddress).getStakingAddress());
+            authority, 
+            registry, 
+            IRegistry(registry).getStakingAddress());
 
-        IVersionable versionable = deployDetermenistic(
+        IVersionable versionable = initialize(
+            registry,
             address(svc), 
             data,
             salt);
 
         _stakingService = StakingService(address(versionable));
-        _stakingService.registerProtocolTarget();
     }
 
     //--- view functions ----------------------------------------------------//