@etherisc/gif-next 3.0.0-d7939fe-905 → 3.0.0-dd00d66-173

package/contracts/staking/StakingStore.sol

@@ -18,6 +18,7 @@ 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";
@@ -25,7 +26,8 @@ import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
 contract StakingStore is 
     Initializable,
-    AccessManaged
+    AccessManaged,
+    RegistryLinked
 {
 
     // token
@@ -53,7 +55,6 @@ 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;
@@ -75,16 +76,15 @@ contract StakingStore is
 
 
     constructor(
-        IRegistry registry, 
         StakingReader reader
     )
         AccessManaged(msg.sender)
     {
+
         // set final authority
-        setAuthority(registry.getAuthority());
+        setAuthority(_getRegistry().getAuthority());
 
         // set internal variables
-        _registry = registry;
         _reader = reader;
         _targetNftIdSet = new NftIdSet();
 
@@ -495,7 +495,7 @@ contract StakingStore is
         emit IStaking.LogStakingRewardReservesRefilled(
             targetNftId,
             dipAmount,
-            _registry.ownerOf(targetNftId),
+            _getRegistry().ownerOf(targetNftId),
             newReserveBalance,
             lastUpdateIn);
     }
@@ -520,7 +520,7 @@ contract StakingStore is
         emit IStaking.LogStakingRewardReservesWithdrawn(
             targetNftId,
             dipAmount,
-            _registry.ownerOf(targetNftId),
+            _getRegistry().ownerOf(targetNftId),
             newReserveBalance,
             lastUpdateIn);
     }
@@ -929,7 +929,7 @@ contract StakingStore is
         // checks
         if (checkParameters) {
             TargetManagerLib.checkTargetParameters(
-                _registry, 
+                _getRegistry(), 
                 _reader, 
                 targetNftId, 
                 objectType, 

package/contracts/staking/TargetHandler.sol

@@ -10,6 +10,7 @@ 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";
 
@@ -17,12 +18,12 @@ import {UFixed, UFixedLib} from "../type/UFixed.sol";
 contract TargetHandler is
     Initializable,
     AccessManaged,
-    ITargetLimitHandler
+    ITargetLimitHandler,
+    RegistryLinked
 {
 
     event LogTargetHandlerUpdateTriggersSet(uint16 tvlUpdatesTrigger, UFixed minTvlRatioTrigger, Blocknumber lastUpdateIn);
 
-    IRegistry private _registry;
     StakingStore private _store;
 
     /// @dev Update trigger value: Number of TVL updates below which limit updates are suppressed
@@ -33,14 +34,12 @@ contract TargetHandler is
 
 
     constructor (
-        IRegistry registry,
         StakingStore stakingStore
     )
         AccessManaged(msg.sender)
     {
         // set final authority and registry
-        setAuthority(registry.getAuthority());
-        _registry = registry;
+        setAuthority(_getRegistry().getAuthority());
         _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,6 +5,9 @@ type VersionPart is uint8;
 
 using {
     versionPartGt as >,
+    versionPartGte as >=,
+    versionPartLt as <,
+    versionPartLte as <=,
     versionPartEq as ==,
     versionPartNe as !=,
     VersionPartLib.eqz,
@@ -16,6 +19,9 @@ 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); }
 
@@ -27,8 +33,7 @@ library VersionPartLib {
     function releaseMax() public pure returns (VersionPart) { return toVersionPart(99); }
 
     function isValidRelease(VersionPart release) external pure returns(bool) { 
-        uint256 releaseInt = VersionPart.unwrap(release);
-        return 3 <= releaseInt && releaseInt <= 99; 
+        return releaseMin() <= release && release <= releaseMax(); 
     } 
 
     function toString(VersionPart a) external pure returns (string memory) {
@@ -66,8 +71,9 @@ 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(uint256) { return VersionPart.unwrap(a); }
-    function toVersionPart(uint256 a) public pure returns(VersionPart) { return VersionPart.wrap(uint8(a)); }
+    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); }
 }
 
 type Version is uint24; // contains major,minor,patch version parts
@@ -87,7 +93,7 @@ function versionEq(Version a, Version b) pure returns(bool isSame) { return Vers
 
 library VersionLib {
 
-    function toInt(Version version) external pure returns(uint) { return Version.unwrap(version); }
+    function toInt(Version version) external pure returns(uint24) { return Version.unwrap(version); }
 
     function toUint64(Version version) external pure returns(uint64) { return Version.unwrap(version); }
 
@@ -124,26 +130,19 @@ library VersionLib {
         );
     }
 
-    // function toVersionPart(uint256 versionPart) public pure returns(VersionPart) { 
-    //     return VersionPart.wrap(uint8(versionPart)); 
-    // }
-
     function toVersion(
-        uint256 major,
-        uint256 minor,
-        uint256 patch
+        uint8 major,
+        uint8 minor,
+        uint8 patch
     )
         external
         pure
         returns(Version)
     {
-        require(
-            major < 256 && minor < 256 && patch < 256,
-            "ERROR:VRS-010:VERSION_PART_TOO_BIG");
 
         return Version.wrap(
             uint24(
-                (major << 16) + (minor << 8) + patch));
+                (uint24(major) << 16) + (uint24(minor) << 8) + patch));
     }
 
     // TODO check for overflow?

package/contracts/upgradeability/{IVersionable.sol → IUpgradeable.sol}

@@ -1,21 +1,21 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Version} from "../type/Version.sol";
+import {IVersionable} from "../shared/IVersionable.sol";
 
 /// IMPORTANT
 // Upgradeable contract MUST:
-// 1) inherit from Versionable
-// 2) implement version() function
+// 1) inherit Upgradeable
+// 2) implement getVersion() function
 // 3) implement internal _initialize() function with onlyInitializing modifier 
 // 4) implement internal _upgrade() function with onlyInitializing modifier (1st version MUST revert)
-// 5) have onlyInitialising modifier for each function callable inside _initialize()/_upgrade() (MUST use different functions for initialization/upgrade and normal operations)
-// 6) use default empty constructor -> _disableInitializer() is called from Versionable contructor
-// 7) use namespace storage (should this be needed)
-// 8) since now inheritance is used for upgradability, contract MUST BE inherited ONLY by the next version 
+// 5) have onlyInitialising modifier for each function callable inside _initialize()/_upgrade() 
+// 6) use different functions for initialization, upgrade and normal operations
+// 7) use default empty constructor -> _disableInitializer() is called from Upgradeable contructor
+// 8) use namespace storage (should storage be needed)
 // Upgradeable contract SHOULD:
 // 9) define all non private methods as virtual (in order to be able to upgrade them latter)
-//    otherwise, it is still possible to upgrade contract, but everyone who is using it will have to switch to a new fucntions
+//    otherwise, it is still possible to upgrade contract, but everyone who is using it will have to switch to a new functions
 //    in some cases this ok but not in the others...
 //
 // IMPORTANT
@@ -26,31 +26,25 @@ import {Version} from "../type/Version.sol";
 // 2) ALWAYS define private getter if accessing storage
 //      - MUST use default implementation, CAN change ONLY return type
 
-interface IVersionable {
+interface IUpgradeable is IVersionable {
 
     error ErrorVersionableInitializeNotImplemented();
     error ErrorVersionableUpgradeNotImplemented();
 
     /**
      * @dev IMPORTANT
+     * top level initializer for each upgradeable
      * implementation MUST be guarded by initializer modifier
      * new version MUST inherit from previous version
      */
-    function initializeVersionable(address activatedBy, bytes memory activationData) external;
+    function initialize(address activatedBy, bytes memory activationData) external;
 
     /**
      * @dev
+     * top level reinitializer for each upgradeable
      * implementation MUST be guarded by reinitializer(version().toUint64()) modifier
      * new version MUST inherit from previous version
      * the first verion MUST revert 
      */
-    function upgradeVersionable(bytes memory upgradeData) external;
-
-    /**
-     * @dev returns version of this contract
-     * each new implementation MUST implement this function
-     * version number MUST increase 
-     */
-    function getVersion() external pure returns(Version);
-
+    function upgrade(bytes memory upgradeData) external;
 }