@etherisc/gif-next 0.0.2-f761c0d-394 → 0.0.2-f78c672-338

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,6 +92,7 @@ contract StakingService is
         virtual
         restricted()
     {
+        _checkNftType(instanceNftId, INSTANCE());
         _getStakingServiceStorage()._staking.setRewardRate(
             instanceNftId, 
             rewardRate);
@@ -95,6 +105,7 @@ contract StakingService is
         restricted()
         returns (Amount newBalance)
     {
+        _checkNftType(instanceNftId, INSTANCE());
         return _refillRewardReserves(instanceNftId, rewardProvider, dipAmount);
     }
 
@@ -116,17 +127,17 @@ contract StakingService is
         restricted()
         returns (Amount newBalance)
     {
+        _checkNftType(instanceNftId, INSTANCE());
         // 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(
+        emit LogStakingServiceRewardReservesDecreased(instanceNftId, instanceOwner, dipAmount, newBalance);
+        $._tokenHandler.pushToken(
             instanceOwner,
             dipAmount);
-
-        emit LogStakingServiceRewardReservesDecreased(instanceNftId, instanceOwner, dipAmount, newBalance);
     }
 
 
@@ -169,12 +180,12 @@ contract StakingService is
             targetNftId,
             dipAmount);
 
+        emit LogStakingServiceStakeCreated(stakeNftId, targetNftId, stakeOwner, dipAmount);
+
         // collect staked dip by staking
-        $._staking.collectDipAmount(
-            stakeOwner,
+        $._tokenHandler.pullToken(
+            stakeOwner, 
             dipAmount);
-
-        emit LogStakingServiceStakeCreated(stakeNftId, targetNftId, stakeOwner, dipAmount);
     }
 
 
@@ -187,6 +198,8 @@ contract StakingService is
         restricted()
         onlyNftOwner(stakeNftId)
     {
+        _checkNftType(stakeNftId, STAKE());
+
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         address stakeOwner = msg.sender;
 
@@ -197,12 +210,11 @@ contract StakingService is
 
         // collect staked dip by staking
         if (dipAmount.gtz()) {
-            $._staking.collectDipAmount(
+            emit LogStakingServiceStakeIncreased(stakeNftId, stakeOwner, dipAmount, stakeBalance);
+        $._tokenHandler.pullToken(
                 stakeOwner,
                 dipAmount);
         }
-
-        emit LogStakingServiceStakeIncreased(stakeNftId, stakeOwner, dipAmount, stakeBalance);
     }
 
 
@@ -218,6 +230,8 @@ contract StakingService is
             NftId newStakeNftId
         )
     {
+        _checkNftType(stakeNftId, STAKE());
+
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         // TODO implement
     } 
@@ -230,6 +244,8 @@ contract StakingService is
         virtual
         restricted()
     {
+        _checkNftType(stakeNftId, STAKE());
+
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         $._staking.updateRewards(stakeNftId);
 
@@ -243,15 +259,16 @@ contract StakingService is
         restricted()
         onlyNftOwner(stakeNftId)
     {
+        _checkNftType(stakeNftId, STAKE());
+
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         address stakeOwner = msg.sender;
 
         Amount rewardsClaimedAmount = $._staking.claimRewards(stakeNftId);
-        $._staking.transferDipAmount(
+        emit LogStakingServiceRewardsClaimed(stakeNftId, stakeOwner, rewardsClaimedAmount);
+        $._tokenHandler.pushToken(
             stakeOwner,
             rewardsClaimedAmount);
-
-        emit LogStakingServiceRewardsClaimed(stakeNftId, stakeOwner, rewardsClaimedAmount);
     }
 
 
@@ -261,6 +278,8 @@ contract StakingService is
         restricted()
         onlyNftOwner(stakeNftId)
     {
+        _checkNftType(stakeNftId, STAKE());
+        
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         address stakeOwner = msg.sender;
 
@@ -270,11 +289,11 @@ contract StakingService is
         ) = $._staking.unstake(stakeNftId);
 
         Amount totalAmount = unstakedAmount + rewardsClaimedAmount;
-        $._staking.transferDipAmount(
-            stakeOwner,
-            totalAmount);
-
         emit LogStakingServiceUnstaked(stakeNftId, stakeOwner, totalAmount);
+
+        $._tokenHandler.pushToken(
+            stakeOwner, 
+            totalAmount);
     }
 
 
@@ -331,19 +350,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);
     }
 
 
@@ -389,12 +408,12 @@ contract StakingService is
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         newBalance = $._staking.refillRewardReserves(targetNftId, dipAmount);
 
+        emit LogStakingServiceRewardReservesIncreased(targetNftId, rewardProvider, dipAmount, newBalance);
+
         // collect reward dip from provider
-        $._staking.collectDipAmount(
+        $._tokenHandler.pullToken(
             rewardProvider,
             dipAmount);
-
-        emit LogStakingServiceRewardReservesIncreased(targetNftId, rewardProvider, dipAmount, newBalance);
     }
 
 

package/contracts/staking/StakingServiceManager.sol

@@ -2,8 +2,8 @@
 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
@@ -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

@@ -3,32 +3,21 @@ pragma solidity ^0.8.20;
 
 import {AccessManaged} from "@openzeppelin/contracts/access/manager/AccessManaged.sol";
 
-import {Amount, AmountLib} from "../type/Amount.sol";
-import {Blocknumber, BlocknumberLib} from "../type/Blocknumber.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 {Key32} from "../type/Key32.sol";
+
+import {Amount, AmountLib} from "../type/Amount.sol";
+import {Blocknumber, BlocknumberLib} from "../type/Blocknumber.sol";
 import {KeyValueStore} from "../shared/KeyValueStore.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 {NftIdSet} from "../shared/NftIdSet.sol";
+import {PROTOCOL, STAKE, TARGET} from "../type/ObjectType.sol";
 import {StakingReader} from "./StakingReader.sol";
 import {TargetManagerLib} from "./TargetManagerLib.sol";
 import {Timestamp, TimestampLib} from "../type/Timestamp.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 {RegistryAdmin} from "../registry/RegistryAdmin.sol";
 import {StakingLifecycle} from "./StakingLifecycle.sol";
+import {UFixed} from "../type/UFixed.sol";
 
 
 contract StakingStore is 
@@ -63,7 +52,7 @@ contract StakingStore is
     error ErrorStakingStoreTvlBalanceNotInitialized(NftId nftId);
 
     IRegistry private _registry;
-    NftIdSetManager private _targetManager;
+    NftIdSet private _targetNftIdSet;
     StakingReader private _reader;
 
     // staking rate
@@ -93,7 +82,7 @@ contract StakingStore is
         // set internal variables
         _registry = registry; //TODO if keeps registry -> RegistryLinked and checks registry address
         _reader = reader;
-        _targetManager = new NftIdSetManager();
+        _targetNftIdSet = new NftIdSet();
 
         // register protocol target
         _createTarget(
@@ -428,8 +417,9 @@ contract StakingStore is
         return _reader;
     }
 
-    function getTargetManager() external view returns (NftIdSetManager targetManager){
-        return _targetManager;
+    // TODO rename
+    function getTargetNftIdSet() external view returns (NftIdSet targetNftIdSet){
+        return _targetNftIdSet;
     }
 
     function getStakingRate(uint256 chainId, address token) external view returns (UFixed stakingRate) { return _stakingRate[chainId][token]; }
@@ -493,7 +483,7 @@ contract StakingStore is
         _tvlLastUpdatedIn[targetNftId]= BlocknumberLib.currentBlocknumber();
         _createTargetBalance(targetNftId);
 
-        _targetManager.add(targetNftId);
+        _targetNftIdSet.add(targetNftId);
     }
 
     function _updateReserves(

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,14 +11,18 @@ using {
     eqAmount as ==,
     nqAmount as !=,
     ltAmount as <,
+    ltAmount as <=,
     gtAmount as >,
+    gteAmount as >=,
+    AmountLib.add,
     AmountLib.eq,
     AmountLib.eqz,
     AmountLib.gtz,
+    AmountLib.gt,
+    AmountLib.gte,
+    AmountLib.multiplyWith,
     AmountLib.toInt,
-    AmountLib.add,
-    AmountLib.toUFixed,
-    AmountLib.multiplyWith
+    AmountLib.toUFixed
 } for Amount global;
 
 function addAmount(Amount a, Amount b) pure returns (Amount) {
@@ -41,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);
@@ -77,16 +89,26 @@ library AmountLib {
         return Amount.unwrap(amount1) == Amount.unwrap(amount2);
     }
 
-    /// @dev return true if amount a1 is smaller than a2
+    /// @dev return true if amount a1 is less than a2
     function lt(Amount a1, Amount a2) public pure returns (bool) {
         return Amount.unwrap(a1) < Amount.unwrap(a2);
     }
 
-    /// @dev return true if amount a1 is larger than 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);
     }
 
+    /// @dev return true if amount a1 is greater or equal than a2
+    function gte(Amount a1, Amount a2) public pure returns (bool) {
+        return Amount.unwrap(a1) >= Amount.unwrap(a2);
+    }
+
     /// @dev return minimum of a1 and a2.
     function min(Amount a1, Amount a2) public pure returns (Amount) {
         if (Amount.unwrap(a1) < Amount.unwrap(a2)) {

package/contracts/type/Blocknumber.sol

@@ -11,8 +11,14 @@ using {
     eqBlocknumber as ==,
     neBlocknumber as !=,
     BlocknumberLib.toInt,
+    BlocknumberLib.eq,
+    BlocknumberLib.ne,
     BlocknumberLib.eqz,
-    BlocknumberLib.gtz
+    BlocknumberLib.gtz,
+    BlocknumberLib.gt,
+    BlocknumberLib.gte,
+    BlocknumberLib.lt,
+    BlocknumberLib.lte
 } for Blocknumber global;
 
 /// @dev return true if Blocknumber a is greater than Blocknumber b

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/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));
+    }
 }