@etherisc/gif-next 3.0.0-cf1abe2-268 → 3.0.0-cf20ffd-765

package/contracts/staking/StakingReader.sol

@@ -4,32 +4,36 @@ pragma solidity ^0.8.20;
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
 
 import {IRegistry} from "../registry/IRegistry.sol";
-import {RegistryLinked} from "../shared/RegistryLinked.sol";
+import {IRegistryLinked} from "../shared/IRegistryLinked.sol";
 import {IStaking} from "../staking/IStaking.sol";
 
-import {Amount} from "../type/Amount.sol";
+import {Amount, AmountLib} from "../type/Amount.sol";
+import {Blocknumber}  from "../type/Blocknumber.sol";
 import {ChainId}  from "../type/ChainId.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
-import {RegistryLinked} from "../shared/RegistryLinked.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {StakingStore} from "./StakingStore.sol";
+import {STAKE, TARGET} from "../type/ObjectType.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 import {UFixed} from "../type/UFixed.sol";
 
 
 contract StakingReader is
-    Initializable,
-    RegistryLinked
+    IRegistryLinked,
+    Initializable
 {
 
     error ErrorStakingReaderUnauthorizedCaler();
 
     address private _initializeOwner;
+    IRegistry private _registry;
     IStaking private _staking;
     StakingStore private _store;
 
-    constructor() {
+    constructor(IRegistry registry) {
         _initializeOwner = msg.sender;
+        _registry = registry;
     }
 
     function initialize(
@@ -47,14 +51,18 @@ contract StakingReader is
         _store = StakingStore(stakingStoreAddress);
     }
 
-    // view functions
+    // view and pure functions 
+
+    function getRegistry() external view returns (IRegistry registry) {
+        return _registry;
+    }
 
     function getStaking() external view returns (IStaking staking) {
         return _staking;
     }
 
     function getProtocolNftId() external view returns (NftId protocolNftId) {
-        return _getRegistry().getProtocolNftId();
+        return _registry.getProtocolNftId();
     }
 
 
@@ -74,7 +82,7 @@ contract StakingReader is
 
 
     function getTargetNftId(NftId stakeNftId) public view returns (NftId targetNftId) {
-        return _getRegistry().getParentNftId(stakeNftId);
+        return _registry.getParentNftId(stakeNftId);
     }
 
 

package/contracts/staking/StakingService.sol

@@ -3,6 +3,7 @@ pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
+import {IRegisterable} from "../shared/IRegisterable.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IStaking} from "./IStaking.sol";
 import {IStakingService} from "./IStakingService.sol";
@@ -58,7 +59,7 @@ contract StakingService is
             initialLockingPeriod,
             initialRewardRate);
 
-        emit LogStakingServiceInstanceTargetRegistered(targetNftId, chainId);
+        emit LogStakingServiceInstanceTargetRegistered(targetNftId, initialLockingPeriod, initialRewardRate);
     }
 
 
@@ -113,7 +114,7 @@ contract StakingService is
 
         // update reward reserve book keeping
         StakingServiceStorage storage $ = _getStakingServiceStorage();
-        address instanceOwner = _getRegistry().ownerOf(instanceNftId);
+        address instanceOwner = getRegistry().ownerOf(instanceNftId);
         newBalance = $._staking.refillRewardReservesByService(instanceNftId, dipAmount, instanceOwner);
 
         emit LogStakingServiceRewardReservesIncreased(instanceNftId, rewardProvider, dipAmount, newBalance);
@@ -130,7 +131,7 @@ contract StakingService is
         _checkNftType(instanceNftId, INSTANCE());
         // update reward reserve book keeping
         StakingServiceStorage storage $ = _getStakingServiceStorage();
-        address instanceOwner = _getRegistry().ownerOf(instanceNftId);
+        address instanceOwner = getRegistry().ownerOf(instanceNftId);
         newBalance = $._staking.withdrawRewardReservesByService(instanceNftId, dipAmount, instanceOwner);
 
         emit LogStakingServiceRewardReservesDecreased(instanceNftId, instanceOwner, dipAmount, newBalance);
@@ -157,14 +158,13 @@ contract StakingService is
                 nftId: NftIdLib.zero(),
                 parentNftId: targetNftId,
                 objectType: STAKE(),
-                release: getRelease(),
                 isInterceptor: false,
-                objectAddress: address(0)}),
-            stakeOwner, // initialOwner
-            "" // data
-        );
+                objectAddress: address(0),
+                initialOwner: stakeOwner,
+                data: ""
+            }));
 
-        emit LogStakingServiceStakeObjectCreated(stakeNftId, targetNftId, stakeOwner);
+        emit LogStakingServiceStakeCreated(stakeNftId, targetNftId, stakeOwner);
     }
 
 
@@ -255,18 +255,18 @@ contract StakingService is
     )
         internal
         virtual override
-        onlyInitializing()
+        initializer()
     {
         (
             address authority,
+            address registry,
             address staking
-        ) = abi.decode(data, (address, address));
+        ) = abi.decode(data, (address, address, address));
 
-        __Service_init(authority, owner);
+        __Service_init(authority, registry, owner);
 
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         $._registryService = RegistryService(_getServiceAddress(REGISTRY()));
-        // TODO staking is registered in registry.initialize(), just check if address is registered staking
         $._staking = _registerStaking(staking);
         $._dip = $._staking.getToken();
         $._tokenHandler = $._staking.getTokenHandler();
@@ -283,7 +283,7 @@ contract StakingService is
     {
         // check if provided staking contract is already registred
         // staking contract may have been already registered by a previous major relase
-        IRegistry.ObjectInfo memory stakingInfo = _getRegistry().getObjectInfo(stakingAddress);
+        IRegistry.ObjectInfo memory stakingInfo = getRegistry().getObjectInfo(stakingAddress);
         if (stakingInfo.nftId.gtz()) {
             // registered object but wrong type
             if (stakingInfo.objectType != STAKING()) {
@@ -294,9 +294,6 @@ contract StakingService is
             return IStaking(stakingAddress);
         }
 
-        // TODO staking is registered in registry.initialize()
-        // consider deleting the rest of the function
-
         // check that contract implements IStaking
         if(!IStaking(stakingAddress).supportsInterface(type(IStaking).interfaceId)) {
             revert ErrorStakingServiceNotSupportingIStaking(stakingAddress);
@@ -304,7 +301,7 @@ contract StakingService is
 
         address owner = msg.sender;
         _getStakingServiceStorage()._registryService.registerStaking(
-            IStaking(stakingAddress),
+            IRegisterable(stakingAddress),
             owner);
 
         return IStaking(stakingAddress);

package/contracts/staking/StakingServiceManager.sol

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

package/contracts/staking/StakingStore.sol

@@ -18,7 +18,6 @@ import {PROTOCOL, INSTANCE} from "../type/ObjectType.sol";
 import {Seconds, SecondsLib} from "../type/Seconds.sol";
 import {StakingLib} from "./StakingLib.sol";
 import {StakingReader} from "./StakingReader.sol";
-import {RegistryLinked} from "../shared/RegistryLinked.sol";
 import {TargetManagerLib} from "./TargetManagerLib.sol";
 import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
 import {UFixed, UFixedLib} from "../type/UFixed.sol";
@@ -26,8 +25,7 @@ import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
 contract StakingStore is 
     Initializable,
-    AccessManaged,
-    RegistryLinked
+    AccessManaged
 {
 
     // token
@@ -55,6 +53,7 @@ contract StakingStore is
     error ErrorStakingStoreTvlBalanceAlreadyInitialized(NftId nftId, address token);
     error ErrorStakingStoreTvlBalanceNotInitialized(NftId nftId, address token);
 
+    IRegistry private _registry;
     ITargetLimitHandler private _targetLimitHandler;
     StakingReader private _reader;
     NftIdSet private _targetNftIdSet;
@@ -76,15 +75,16 @@ contract StakingStore is
 
 
     constructor(
+        IRegistry registry, 
         StakingReader reader
     )
         AccessManaged(msg.sender)
     {
-
         // set final authority
-        setAuthority(_getRegistry().getAuthority());
+        setAuthority(registry.getAuthority());
 
         // set internal variables
+        _registry = registry;
         _reader = reader;
         _targetNftIdSet = new NftIdSet();
 
@@ -151,7 +151,7 @@ contract StakingStore is
         address oldReader = address(_reader);
         _reader = StakingReader(reader);
 
-        emit IStaking.LogStakingStakingReaderSet(reader, oldReader);
+        emit IStaking.LogStakingStakingReaderSet(oldReader, reader);
     }
 
 
@@ -162,7 +162,7 @@ contract StakingStore is
         address oldTargetHandler = address(_targetLimitHandler);
         _targetLimitHandler = ITargetLimitHandler(targetLimitHandler );
 
-        emit IStaking.LogStakingTargetHandlerSet(targetLimitHandler , oldTargetHandler);
+        emit IStaking.LogStakingTargetHandlerSet(oldTargetHandler, targetLimitHandler);
     }
 
     //--- target support management -----------------------------------------//
@@ -387,7 +387,7 @@ contract StakingStore is
         targetInfo.lastUpdateIn = BlocknumberLib.current();
 
         // logging
-        emit IStaking.LogStakingTargetRewardRateSet(targetNftId, rewardRate, oldRewardRate, lastUpdateIn);
+        emit IStaking.LogStakingTargetRewardRateSet(targetNftId, oldRewardRate, rewardRate, lastUpdateIn);
     }
 
 
@@ -495,7 +495,7 @@ contract StakingStore is
         emit IStaking.LogStakingRewardReservesRefilled(
             targetNftId,
             dipAmount,
-            _getRegistry().ownerOf(targetNftId),
+            _registry.ownerOf(targetNftId),
             newReserveBalance,
             lastUpdateIn);
     }
@@ -520,7 +520,7 @@ contract StakingStore is
         emit IStaking.LogStakingRewardReservesWithdrawn(
             targetNftId,
             dipAmount,
-            _getRegistry().ownerOf(targetNftId),
+            _registry.ownerOf(targetNftId),
             newReserveBalance,
             lastUpdateIn);
     }
@@ -929,7 +929,7 @@ contract StakingStore is
         // checks
         if (checkParameters) {
             TargetManagerLib.checkTargetParameters(
-                _getRegistry(), 
+                _registry, 
                 _reader, 
                 targetNftId, 
                 objectType, 

package/contracts/staking/TargetHandler.sol

@@ -10,7 +10,6 @@ import {ITargetLimitHandler} from "./ITargetLimitHandler.sol";
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {Blocknumber, BlocknumberLib} from "../type/Blocknumber.sol";
 import {NftId} from "../type/NftId.sol";
-import {RegistryLinked} from "../shared/RegistryLinked.sol";
 import {StakingStore} from "./StakingStore.sol";
 import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
@@ -18,12 +17,12 @@ import {UFixed, UFixedLib} from "../type/UFixed.sol";
 contract TargetHandler is
     Initializable,
     AccessManaged,
-    ITargetLimitHandler,
-    RegistryLinked
+    ITargetLimitHandler
 {
 
-    event LogTargetHandlerUpdateTriggersSet(uint16 tvlUpdatesTrigger, UFixed minTvlRatioTrigger, Blocknumber lastUpdateIn);
+    event LogTargetHandlerUpdateTriggersSet(uint16 indexed tvlUpdatesTrigger, UFixed indexed minTvlRatioTrigger, Blocknumber indexed lastUpdateIn);
 
+    IRegistry private _registry;
     StakingStore private _store;
 
     /// @dev Update trigger value: Number of TVL updates below which limit updates are suppressed
@@ -34,12 +33,14 @@ contract TargetHandler is
 
 
     constructor (
+        IRegistry registry,
         StakingStore stakingStore
     )
         AccessManaged(msg.sender)
     {
         // set final authority and registry
-        setAuthority(_getRegistry().getAuthority());
+        setAuthority(registry.getAuthority());
+        _registry = registry;
         _store = stakingStore;
 
         // set default trigger values

package/contracts/type/ObjectType.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {StrLib} from "./String.sol";
 import {VersionPart} from "./Version.sol";
 
 type ObjectType is uint8;
@@ -247,7 +248,7 @@ library ObjectTypeLib {
         return string(
             abi.encodePacked(
                 "ObjectType",
-                toString(
+                StrLib.uintToString(
                     toInt(objectType))));
     }
 
@@ -274,34 +275,4 @@ library ObjectTypeLib {
                 versionName,
                 release.toString()));
     }
-
-    /// @dev returns the provied int as a string
-    function toString(uint256 value) public pure returns (string memory name) {
-
-        if (value == 0) {
-            return "0";
-        }
-
-        uint256 temp = value;
-        uint256 digits = 0;
-        while (temp != 0) {
-            digits++;
-            temp /= 10;
-        }
-
-        bytes memory buffer = new bytes(digits);
-        uint256 index = digits - 1;
-
-        temp = value;
-        while (temp != 0) {
-            buffer[index] = bytes1(uint8(48 + temp % 10));
-            temp /= 10;
-
-            if (index > 0) {
-                index--;
-            }
-        }
-
-        return string(buffer);
-    }
 }

package/contracts/type/Referral.sol

@@ -13,6 +13,7 @@ using {
     eqReferralId as ==, 
     neReferralId as !=,
     ReferralLib.eqz,
+    ReferralLib.toInt,
     ReferralLib.toKey32
 } for ReferralId global;
 
@@ -74,6 +75,11 @@ library ReferralLib {
         return ReferralStatus.wrap(status);
     }
 
+    /// @dev Converts a referral id into a uint256.
+    function toInt(ReferralId referralId) public pure returns (uint256) {
+        return uint64(ReferralId.unwrap(referralId));
+    }
+
     /// @dev Returns the key32 value for the specified nft id and object type.
     function toKey32(ReferralId id) public pure returns (Key32 key) {
         return Key32Lib.toKey32(REFERRAL(), toKeyId(id));

package/contracts/type/RequestIdSet.sol

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

package/contracts/type/Seconds.sol

@@ -47,6 +47,10 @@ library SecondsLib {
         return Seconds.wrap(_max());
     }
 
+    function fromHours(uint32 numberOfHours) public pure returns (Seconds duration) {
+        return Seconds.wrap(numberOfHours * 3600);
+    }
+
     function oneDay() public pure returns (Seconds duration) {
         return Seconds.wrap(24 * 3600);
     }

package/contracts/type/String.sol

@@ -62,4 +62,34 @@ library StrLib {
     function length(Str str) public pure returns (uint256 byteLength) {
         return ShortStrings.byteLength(ShortString.wrap(Str.unwrap(str)));
     }
+
+    /// @dev Returns the provied int as a string
+    function uintToString(uint256 value) public pure returns (string memory name) {
+
+        if (value == 0) {
+            return "0";
+        }
+
+        uint256 temp = value;
+        uint256 digits = 0;
+        while (temp != 0) {
+            digits++;
+            temp /= 10;
+        }
+
+        bytes memory buffer = new bytes(digits);
+        uint256 index = digits - 1;
+
+        temp = value;
+        while (temp != 0) {
+            buffer[index] = bytes1(uint8(48 + temp % 10));
+            temp /= 10;
+
+            if (index > 0) {
+                index--;
+            }
+        }
+
+        return string(buffer);
+    }
 }

package/contracts/type/Timestamp.sol

@@ -23,6 +23,7 @@ using {
     TimestampLib.gtz,
     TimestampLib.eqz,
     TimestampLib.addSeconds,
+    TimestampLib.subtractSeconds,
     TimestampLib.toInt
 } for Timestamp global;
 
@@ -129,7 +130,7 @@ library TimestampLib {
         return Timestamp.unwrap(timestamp) > 0;
     }
 
-    /// @dev return true if Timestamp a is not equal to Timestamp b
+    /// @dev return a new timestamp that is duration seconds later than the provided timestamp.
     function addSeconds(
         Timestamp timestamp,
         Seconds duration
@@ -137,6 +138,14 @@ library TimestampLib {
         return toTimestamp(Timestamp.unwrap(timestamp) + duration.toInt());
     }
 
+    /// @dev return a new timestamp that is duration seconds earlier than the provided timestamp.
+    function subtractSeconds(
+        Timestamp timestamp,
+        Seconds duration
+    ) public pure returns (Timestamp) {
+        return toTimestamp(Timestamp.unwrap(timestamp) - duration.toInt());
+    }
+
     function toInt(Timestamp timestamp) public pure returns (uint256) {
         return uint256(uint40(Timestamp.unwrap(timestamp)));
     }

package/contracts/type/Version.sol

@@ -5,9 +5,6 @@ type VersionPart is uint8;
 
 using {
     versionPartGt as >,
-    versionPartGte as >=,
-    versionPartLt as <,
-    versionPartLte as <=,
     versionPartEq as ==,
     versionPartNe as !=,
     VersionPartLib.eqz,
@@ -19,9 +16,6 @@ using {
     for VersionPart global;
 
 function versionPartGt(VersionPart a, VersionPart b) pure returns(bool isGreaterThan) { return VersionPart.unwrap(a) > VersionPart.unwrap(b); }
-function versionPartGte(VersionPart a, VersionPart b) pure returns(bool isGreaterThan) { return VersionPart.unwrap(a) >= VersionPart.unwrap(b); }
-function versionPartLt(VersionPart a, VersionPart b) pure returns(bool isLessThan) { return VersionPart.unwrap(a) < VersionPart.unwrap(b); }
-function versionPartLte(VersionPart a, VersionPart b) pure returns(bool isLessThan) { return VersionPart.unwrap(a) <= VersionPart.unwrap(b); }
 function versionPartEq(VersionPart a, VersionPart b) pure returns(bool isSame) { return VersionPart.unwrap(a) == VersionPart.unwrap(b); }
 function versionPartNe(VersionPart a, VersionPart b) pure returns(bool isSame) { return VersionPart.unwrap(a) != VersionPart.unwrap(b); }
 
@@ -33,7 +27,8 @@ library VersionPartLib {
     function releaseMax() public pure returns (VersionPart) { return toVersionPart(99); }
 
     function isValidRelease(VersionPart release) external pure returns(bool) { 
-        return releaseMin() <= release && release <= releaseMax(); 
+        uint256 releaseInt = VersionPart.unwrap(release);
+        return 3 <= releaseInt && releaseInt <= 99; 
     } 
 
     function toString(VersionPart a) external pure returns (string memory) {
@@ -71,9 +66,8 @@ library VersionPartLib {
 
     function eqz(VersionPart a) external pure returns(bool) { return VersionPart.unwrap(a) == 0; }
     function gtz(VersionPart a) external pure returns(bool) { return VersionPart.unwrap(a) > 0; }
-    function toInt(VersionPart a) external pure returns(uint8) { return VersionPart.unwrap(a); }
-    function toVersionPart(uint8 a) public pure returns(VersionPart) { return VersionPart.wrap(uint8(a)); }
-    function zero() external pure returns(VersionPart) { return VersionPart.wrap(0); }
+    function toInt(VersionPart a) external pure returns(uint256) { return VersionPart.unwrap(a); }
+    function toVersionPart(uint256 a) public pure returns(VersionPart) { return VersionPart.wrap(uint8(a)); }
 }
 
 type Version is uint24; // contains major,minor,patch version parts
@@ -93,7 +87,7 @@ function versionEq(Version a, Version b) pure returns(bool isSame) { return Vers
 
 library VersionLib {
 
-    function toInt(Version version) external pure returns(uint24) { return Version.unwrap(version); }
+    function toInt(Version version) external pure returns(uint) { return Version.unwrap(version); }
 
     function toUint64(Version version) external pure returns(uint64) { return Version.unwrap(version); }
 
@@ -130,19 +124,26 @@ library VersionLib {
         );
     }
 
+    // function toVersionPart(uint256 versionPart) public pure returns(VersionPart) { 
+    //     return VersionPart.wrap(uint8(versionPart)); 
+    // }
+
     function toVersion(
-        uint8 major,
-        uint8 minor,
-        uint8 patch
+        uint256 major,
+        uint256 minor,
+        uint256 patch
     )
         external
         pure
         returns(Version)
     {
+        require(
+            major < 256 && minor < 256 && patch < 256,
+            "ERROR:VRS-010:VERSION_PART_TOO_BIG");
 
         return Version.wrap(
             uint24(
-                (uint24(major) << 16) + (uint24(minor) << 8) + patch));
+                (major << 16) + (minor << 8) + patch));
     }
 
     // TODO check for overflow?