@etherisc/gif-next 0.0.2-b8e869c-076 → 0.0.2-b926d1d-788

package/contracts/staking/StakingService.sol

@@ -4,21 +4,15 @@ 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 {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,14 +32,28 @@ 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 approveTokenHandler(
+        IERC20Metadata token,
+        Amount amount
+    )
+        external
+        virtual
+        onlyStaking()
+    {
+        _getStakingServiceStorage()._tokenHandler.approve(
+            token, amount);
+    }
+
+
     function createInstanceTarget(
         NftId targetNftId,
         Seconds initialLockingPeriod,
@@ -72,6 +80,7 @@ contract StakingService is
         virtual
         restricted()
     {
+        _checkNftType(instanceNftId, INSTANCE());
         _getStakingServiceStorage()._staking.setLockingPeriod(
             instanceNftId, 
             lockingPeriod);
@@ -83,11 +92,23 @@ contract StakingService is
         virtual
         restricted()
     {
+        _checkNftType(instanceNftId, INSTANCE());
         _getStakingServiceStorage()._staking.setRewardRate(
             instanceNftId, 
             rewardRate);
     }
 
+    function setInstanceMaxStakedAmount(NftId instanceNftId, Amount maxStakingAmount)
+        external
+        virtual
+        restricted()
+    {
+        _checkNftType(instanceNftId, INSTANCE());
+        _getStakingServiceStorage()._staking.setMaxStakedAmount(
+            instanceNftId, 
+            maxStakingAmount);
+    }
+
 
     function refillInstanceRewardReserves(NftId instanceNftId, address rewardProvider, Amount dipAmount)
         external
@@ -95,6 +116,7 @@ contract StakingService is
         restricted()
         returns (Amount newBalance)
     {
+        _checkNftType(instanceNftId, INSTANCE());
         return _refillRewardReserves(instanceNftId, rewardProvider, dipAmount);
     }
 
@@ -116,6 +138,7 @@ contract StakingService is
         restricted()
         returns (Amount newBalance)
     {
+        _checkNftType(instanceNftId, INSTANCE());
         // update reward reserve book keeping
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         newBalance = $._staking.withdrawRewardReserves(instanceNftId, dipAmount);
@@ -123,7 +146,7 @@ contract StakingService is
         // transfer withdrawal amount to target owner
         address instanceOwner = getRegistry().ownerOf(instanceNftId);
         emit LogStakingServiceRewardReservesDecreased(instanceNftId, instanceOwner, dipAmount, newBalance);
-        $._staking.transferDipAmount(
+        $._tokenHandler.pushToken(
             instanceOwner,
             dipAmount);
     }
@@ -171,8 +194,8 @@ contract StakingService is
         emit LogStakingServiceStakeCreated(stakeNftId, targetNftId, stakeOwner, dipAmount);
 
         // collect staked dip by staking
-        $._staking.collectDipAmount(
-            stakeOwner,
+        $._tokenHandler.pullToken(
+            stakeOwner, 
             dipAmount);
     }
 
@@ -186,6 +209,8 @@ contract StakingService is
         restricted()
         onlyNftOwner(stakeNftId)
     {
+        _checkNftType(stakeNftId, STAKE());
+
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         address stakeOwner = msg.sender;
 
@@ -197,7 +222,7 @@ contract StakingService is
         // collect staked dip by staking
         if (dipAmount.gtz()) {
             emit LogStakingServiceStakeIncreased(stakeNftId, stakeOwner, dipAmount, stakeBalance);
-            $._staking.collectDipAmount(
+        $._tokenHandler.pullToken(
                 stakeOwner,
                 dipAmount);
         }
@@ -213,11 +238,36 @@ contract StakingService is
         restricted()
         onlyNftOwner(stakeNftId)
         returns (
-            NftId newStakeNftId
+            NftId newStakeNftId,
+            Amount newStakeBalance
         )
     {
+        _checkNftType(stakeNftId, STAKE());
+
         StakingServiceStorage storage $ = _getStakingServiceStorage();
-        // TODO implement
+        address stakeOwner = msg.sender;
+
+        if (! getRegistry().isRegistered(newTargetNftId)) {
+            revert ErrorStakingServiceTargetUnknown(newTargetNftId);
+        }
+
+        // register new stake object with registry
+        newStakeNftId = $._registryService.registerStake(
+            IRegistry.ObjectInfo({
+                nftId: NftIdLib.zero(),
+                parentNftId: newTargetNftId,
+                objectType: STAKE(),
+                isInterceptor: false,
+                objectAddress: address(0),
+                initialOwner: stakeOwner,
+                data: ""
+            }));
+
+        newStakeBalance = $._staking.restake(
+            stakeNftId, 
+            newStakeNftId);
+
+        emit LogStakingServiceStakeRestaked(stakeOwner, stakeNftId, newStakeNftId, newTargetNftId, newStakeBalance);
     } 
 
 
@@ -228,6 +278,8 @@ contract StakingService is
         virtual
         restricted()
     {
+        _checkNftType(stakeNftId, STAKE());
+
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         $._staking.updateRewards(stakeNftId);
 
@@ -241,12 +293,14 @@ contract StakingService is
         restricted()
         onlyNftOwner(stakeNftId)
     {
+        _checkNftType(stakeNftId, STAKE());
+
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         address stakeOwner = msg.sender;
 
         Amount rewardsClaimedAmount = $._staking.claimRewards(stakeNftId);
         emit LogStakingServiceRewardsClaimed(stakeNftId, stakeOwner, rewardsClaimedAmount);
-        $._staking.transferDipAmount(
+        $._tokenHandler.pushToken(
             stakeOwner,
             rewardsClaimedAmount);
     }
@@ -258,6 +312,8 @@ contract StakingService is
         restricted()
         onlyNftOwner(stakeNftId)
     {
+        _checkNftType(stakeNftId, STAKE());
+        
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         address stakeOwner = msg.sender;
 
@@ -268,8 +324,9 @@ contract StakingService is
 
         Amount totalAmount = unstakedAmount + rewardsClaimedAmount;
         emit LogStakingServiceUnstaked(stakeNftId, stakeOwner, totalAmount);
-        $._staking.transferDipAmount(
-            stakeOwner,
+
+        $._tokenHandler.pushToken(
+            stakeOwner, 
             totalAmount);
     }
 
@@ -327,19 +384,19 @@ contract StakingService is
     {
         (
             address authority,
-            address registryAddress,
-            address stakingAddress
+            address registry,
+            address staking
         ) = abi.decode(data, (address, address, address));
 
-        initializeService(registryAddress, authority, 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);
     }
 
 
@@ -388,7 +445,7 @@ contract StakingService is
         emit LogStakingServiceRewardReservesIncreased(targetNftId, rewardProvider, dipAmount, newBalance);
 
         // collect reward dip from provider
-        $._staking.collectDipAmount(
+        $._tokenHandler.pullToken(
             rewardProvider,
             dipAmount);
     }

package/contracts/staking/StakingServiceManager.sol

@@ -15,17 +15,18 @@ contract StakingServiceManager is
     /// @dev initializes proxy manager with service implementation 
     constructor(
         address authority,
-        address registryAddress,
+        address registry,
         bytes32 salt
     )
-        ProxyManager(registryAddress)
     {
         StakingService svc = new StakingService();
         bytes memory data = abi.encode(
             authority, 
-            registryAddress, 
-            IRegistry(registryAddress).getStakingAddress());
-        IVersionable versionable = deployDetermenistic(
+            registry, 
+            IRegistry(registry).getStakingAddress());
+
+        IVersionable versionable = initialize(
+            registry,
             address(svc), 
             data,
             salt);

package/contracts/staking/StakingStore.sol

@@ -91,7 +91,8 @@ contract StakingStore is
                 objectType: PROTOCOL(),
                 chainId: 1,
                 lockingPeriod: TargetManagerLib.getDefaultLockingPeriod(),
-                rewardRate: TargetManagerLib.getDefaultRewardRate()}));
+                rewardRate: TargetManagerLib.getDefaultRewardRate(),
+                maxStakedAmount: AmountLib.max()}));
     }
 
 

package/contracts/staking/TargetManagerLib.sol

@@ -132,9 +132,9 @@ library TargetManagerLib {
         public 
         pure
     {
-        // check locking period is > 0
-        if (lockingPeriod.eqz()) {
-            revert IStaking.ErrorStakingLockingPeriodZero(targetNftId);
+        // check locking period is >= min locking period
+        if (lockingPeriod.lt(getMinimumLockingPeriod())) {
+            revert IStaking.ErrorStakingLockingPeriodTooShort(targetNftId, getMinimumLockingPeriod(), lockingPeriod);
         }
 
         // check locking period <= max locking period
@@ -190,6 +190,10 @@ library TargetManagerLib {
         return SecondsLib.toSeconds(365 * 24 * 3600 / 2);
     }
 
+    /// @dev the minimum locking period is 24 hours
+    function getMinimumLockingPeriod() public pure returns (Seconds minLockingPeriod) {
+        return SecondsLib.toSeconds(24 * 3600);
+    }
 
     function getMaxRewardRate() public pure returns (UFixed maxRewardRate) {
         return UFixedLib.toUFixed(33, -2);

package/contracts/type/Amount.sol

@@ -11,7 +11,9 @@ using {
     eqAmount as ==,
     nqAmount as !=,
     ltAmount as <,
+    ltAmount as <=,
     gtAmount as >,
+    gteAmount as >=,
     AmountLib.add,
     AmountLib.eq,
     AmountLib.eqz,
@@ -43,10 +45,18 @@ function ltAmount(Amount a, Amount b) pure returns (bool) {
     return AmountLib.lt(a, b);
 }
 
+function lteAmount(Amount a, Amount b) pure returns (bool) {
+    return AmountLib.lte(a, b);
+}
+
 function gtAmount(Amount a, Amount b) pure returns (bool) {
     return AmountLib.gt(a, b);
 }
 
+function gteAmount(Amount a, Amount b) pure returns (bool) {
+    return AmountLib.gte(a, b);
+}
+
 library AmountLib {
 
     error ErrorAmountLibValueTooBig(uint256 amount);
@@ -84,6 +94,11 @@ library AmountLib {
         return Amount.unwrap(a1) < Amount.unwrap(a2);
     }
 
+    /// @dev return true if amount a1 is less or equal than a2
+    function lte(Amount a1, Amount a2) public pure returns (bool) {
+        return Amount.unwrap(a1) <= Amount.unwrap(a2);
+    }
+
     /// @dev return true if amount a1 is greater than a2
     function gt(Amount a1, Amount a2) public pure returns (bool) {
         return Amount.unwrap(a1) > Amount.unwrap(a2);

package/contracts/type/ClaimId.sol

@@ -12,6 +12,7 @@ import {NftId} from "./NftId.sol";
 using {
     eqClaimId as ==, 
     neClaimId as !=, 
+    ClaimIdLib.eq,
     ClaimIdLib.eqz,
     ClaimIdLib.gtz,
     ClaimIdLib.toInt,
@@ -21,7 +22,7 @@ using {
 
 // pure free functions for operators
 function eqClaimId(ClaimId a, ClaimId b) pure returns (bool isSame) {
-    return ClaimId.unwrap(a) == ClaimId.unwrap(b);
+    return ClaimIdLib.eq(a, b);
 }
 
 function neClaimId(ClaimId a, ClaimId b) pure returns (bool isDifferent) {
@@ -68,6 +69,10 @@ library ClaimIdLib {
         return ClaimId.unwrap(a) > 0;
     }
 
+    function eq(ClaimId a, ClaimId b) public pure returns (bool) {
+        return ClaimId.unwrap(a) == ClaimId.unwrap(b);
+    }
+
     /// @dev Returns true if the value is zero (== 0).
     function eqz(ClaimId a) public pure returns (bool) {
         return ClaimId.unwrap(a) == 0;

package/contracts/type/Fee.sol

@@ -6,15 +6,14 @@ import {UFixed, UFixedLib} from "./UFixed.sol";
 
 struct Fee {
     UFixed fractionalFee;
-    // TODO migrate fixed fee to Amount
-    uint256 fixedFee;
+    Amount fixedFee;
 }
 
 library FeeLib {
 
     /// @dev Return a zero fee struct (0, 0)
     function zero() public pure returns (Fee memory fee) {
-        return Fee(UFixed.wrap(0), 0);
+        return Fee(UFixed.wrap(0), AmountLib.zero());
     }
 
     /// @dev Converts the uint256 to a fee struct.
@@ -22,7 +21,7 @@ library FeeLib {
         UFixed fractionalFee,
         uint256 fixedFee
     ) public pure returns (Fee memory fee) {
-        return Fee(fractionalFee, fixedFee);
+        return Fee(fractionalFee, AmountLib.toAmount(fixedFee));
     }
 
     /// @dev Calculates fee and net amounts for the provided parameters
@@ -41,14 +40,14 @@ library FeeLib {
         if(gtz(fee)) {
             UFixed fractionalAmount = 
                 amount.toUFixed() * fee.fractionalFee;
-            feeAmount = AmountLib.toAmount(fractionalAmount.toInt() + fee.fixedFee);
+            feeAmount = AmountLib.toAmount(fractionalAmount.toInt()) + fee.fixedFee;
             netAmount = netAmount - feeAmount;
         }
     }
 
     /// @dev Return the percent fee struct (x%, 0)
     function percentageFee(uint8 percent) public pure returns (Fee memory fee) {
-        return Fee(UFixedLib.toUFixed(percent, -2), 0);
+        return Fee(UFixedLib.toUFixed(percent, -2), AmountLib.zero());
     }
 
     // pure free functions for operators
@@ -57,10 +56,10 @@ library FeeLib {
     }
 
     function gtz(Fee memory fee) public pure returns (bool) {
-        return UFixed.unwrap(fee.fractionalFee) > 0 || fee.fixedFee > 0;
+        return UFixed.unwrap(fee.fractionalFee) > 0 || fee.fixedFee.gtz();
     }
 
     function eqz(Fee memory fee) public pure returns (bool) {
-        return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
+        return fee.fixedFee.eqz() && UFixed.unwrap(fee.fractionalFee) == 0;
     }
 }

package/contracts/type/Key32.sol

@@ -28,8 +28,8 @@ library Key32Lib {
 
     uint8 public constant TYPE_SHIFT = 31 * 8;
     uint8 public constant ID_SHIFT = uint8(32 * 8 - TYPE_SHIFT);
-    bytes32 public constant TYPE_MASK = bytes32(bytes1(type(uint8).max)); // first byte in bytes32
-    bytes32 public constant ID_MASK = bytes32(~TYPE_MASK); // remaining bytes in bytes32
+    bytes32 public constant TYPE_MASK = bytes32(bytes1(type(uint8).max)); // [32] byte in bytes32
+    bytes32 public constant ID_MASK = bytes32(~TYPE_MASK); // [0..31] bytes in bytes32
 
     function toKey32(ObjectType objectType, KeyId id) public pure returns (Key32) {
         uint256 uintObjectType = ObjectType.unwrap(objectType);

package/contracts/type/Key32Set.sol

@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Key32} from "../type/Key32.sol";
+
+// based on https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/structs/EnumerableSet.sol
+library LibKey32Set {
+
+    struct Set {
+        Key32[] keys;
+        mapping(Key32 key => uint256 index) at;
+    }
+
+    error ErrorKey32SetAlreadyAdded(Key32 key);
+    error ErrorKey32SetNotInSet(Key32 key);
+
+
+    function add(Set storage set, Key32 key) external {
+        if (set.at[key] > 0) {
+            revert ErrorKey32SetAlreadyAdded(key);
+        }
+
+        set.keys.push(key);
+        set.at[key] = set.keys.length;
+    }
+
+    function remove(Set storage set, Key32 key) external {
+        uint256 nftIdIndex = set.at[key];
+
+        if (nftIdIndex == 0) {
+            revert ErrorKey32SetNotInSet(key);
+        }
+
+        uint256 toDeleteIndex = nftIdIndex - 1;
+        uint256 lastIndex = set.keys.length - 1;
+
+        if (lastIndex != toDeleteIndex) {
+            Key32 lastId = set.keys[lastIndex];
+            set.keys[toDeleteIndex] = lastId;
+            set.at[lastId] = nftIdIndex; // Replace lastValue's index to valueIndex
+        }
+
+        set.keys.pop();
+        delete set.at[key];
+    }
+
+    function isEmpty(Set storage set) external view returns(bool empty) {
+        return set.keys.length == 0;
+    }
+
+    function contains(Set storage set, Key32 key) external view returns(bool inSet) {
+        return set.at[key] > 0;
+    }
+
+    function size(Set storage set) external view returns(uint256 length) {
+        return set.keys.length;
+    }
+
+    function getElementAt(Set storage set, uint256 index) external view returns(Key32 key) {
+        return set.keys[index];
+    }
+}

package/contracts/type/NftId.sol

@@ -14,6 +14,7 @@ using {
     NftIdLib.toInt,
     NftIdLib.gtz,
     NftIdLib.eqz,
+    NftIdLib.eq,
     NftIdLib.toKeyId,
     NftIdLib.toKey32
 } for NftId global;
@@ -75,4 +76,10 @@ library NftIdLib {
     function toKeyId(NftId id) public pure returns (KeyId keyId) {
         return KeyId.wrap(bytes31(uint248(NftId.unwrap(id))));
     }
+
+    function toNftId(KeyId keyId) public pure returns (NftId nftId) {
+       uint248 keyIdInt = uint248(bytes31(KeyId.unwrap(keyId)));
+       assert(keyIdInt < type(uint96).max);
+       return NftId.wrap(uint96(keyIdInt));
+    }
 }