@etherisc/gif-next 3.0.0-2c4b8cb-070 → 3.0.0-2e16ebd-614

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,7 +1,6 @@
 // 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;
@@ -248,7 +247,7 @@ library ObjectTypeLib {
         return string(
             abi.encodePacked(
                 "ObjectType",
-                StrLib.uintToString(
+                toString(
                     toInt(objectType))));
     }
 
@@ -275,4 +274,34 @@ 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,7 +13,6 @@ using {
     eqReferralId as ==, 
     neReferralId as !=,
     ReferralLib.eqz,
-    ReferralLib.toInt,
     ReferralLib.toKey32
 } for ReferralId global;
 
@@ -75,11 +74,6 @@ 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/Seconds.sol

@@ -47,10 +47,6 @@ 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,34 +62,4 @@ 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,7 +23,6 @@ using {
     TimestampLib.gtz,
     TimestampLib.eqz,
     TimestampLib.addSeconds,
-    TimestampLib.subtractSeconds,
     TimestampLib.toInt
 } for Timestamp global;
 
@@ -130,7 +129,7 @@ library TimestampLib {
         return Timestamp.unwrap(timestamp) > 0;
     }
 
-    /// @dev return a new timestamp that is duration seconds later than the provided timestamp.
+    /// @dev return true if Timestamp a is not equal to Timestamp b
     function addSeconds(
         Timestamp timestamp,
         Seconds duration
@@ -138,14 +137,6 @@ 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;
 }

package/contracts/upgradeability/ProxyManager.sol

@@ -5,14 +5,14 @@ import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.s
 import {ITransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
 
 import {Blocknumber, BlocknumberLib} from "../type/Blocknumber.sol";
-import {IVersionable} from "./IVersionable.sol";
+import {IUpgradeable} from "./IUpgradeable.sol";
 import {NftId} from "../type/NftId.sol";
 import {NftOwnable} from "../shared/NftOwnable.sol";
 import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
 import {UpgradableProxyWithAdmin} from "./UpgradableProxyWithAdmin.sol";
-import {Version, VersionLib} from "../type/Version.sol";
+import {Version, VersionPart, VersionLib} from "../type/Version.sol";
 
-/// @dev manages proxy deployments for upgradable contracs of type IVersionable
+/// @dev manages proxy deployments for upgradable contracs of type IUpgradeable
 contract ProxyManager is
     NftOwnable
 {
@@ -27,14 +27,15 @@ contract ProxyManager is
         address activatedBy;
     }
 
-    event LogProxyManagerVersionableDeployed(address indexed proxy, address initialImplementation);
-    event LogProxyManagerVersionableUpgraded(address indexed proxy, address upgradedImplementation);
+    event LogProxyManagerProxyDeployed(address indexed proxy, address initialImplementation);
+    event LogProxyManagerProxyUpgraded(address indexed proxy, address upgradedImplementation);
 
     error ErrorProxyManagerAlreadyDeployed();
     error ErrorProxyManagerNotYetDeployed();
 
     error ErrorProxyManagerZeroVersion();
     error ErrorProxyManagerNextVersionNotIncreasing(Version nextVersion);
+    error ErrorProxyManagerNextVersionReleaseInvalid(Version nextVersion);
 
     UpgradableProxyWithAdmin internal _proxy;
 
@@ -44,17 +45,19 @@ contract ProxyManager is
 
     /// @dev convencience initializer
     function initialize(
-        address registry,
         address implementation,
         bytes memory data,
         bytes32 salt
     )
         public
         initializer()
-        returns (IVersionable versionable)
+        returns (IUpgradeable upgradeable)
     {
-        versionable = deployDetermenistic(
-            registry,
+        address initialOwner = msg.sender;
+
+        __NftOwnable_init(initialOwner);
+
+        upgradeable = deployDetermenistic(
             implementation, 
             data,
             salt);
@@ -62,19 +65,20 @@ contract ProxyManager is
 
     /// @dev deploy initial contract
     function deploy(
-        address registry, 
         address initialImplementation, 
         bytes memory initializationData
     )
         public
         virtual
         onlyInitializing()
-        returns (IVersionable versionable)
+        returns (IUpgradeable upgradeable)
     {
-        (
-            address currentProxyOwner, 
-            address initialProxyAdminOwner
-        ) = _preDeployChecksAndSetup(registry);
+        if (_versions.length > 0) {
+            revert ErrorProxyManagerAlreadyDeployed();
+        }
+
+        address currentProxyOwner = getOwner(); // used by implementation
+        address initialProxyAdminOwner = address(this); // used by proxy
 
         _proxy = new UpgradableProxyWithAdmin(
             initialImplementation,
@@ -82,15 +86,14 @@ contract ProxyManager is
             getDeployData(currentProxyOwner, initializationData)
         );
 
-        versionable = _updateVersionHistory(
+        upgradeable = _updateVersionHistory(
             initialImplementation, 
             currentProxyOwner);
 
-        emit LogProxyManagerVersionableDeployed(address(versionable), initialImplementation);
+        emit LogProxyManagerProxyDeployed(address(upgradeable), initialImplementation);
     }
 
     function deployDetermenistic(
-        address registry, 
         address initialImplementation, 
         bytes memory initializationData, 
         bytes32 salt
@@ -98,12 +101,14 @@ contract ProxyManager is
         public
         virtual
         onlyInitializing()
-        returns (IVersionable versionable)
+        returns (IUpgradeable upgradeable)
     {
-        (
-            address currentProxyOwner, 
-            address initialProxyAdminOwner
-        ) = _preDeployChecksAndSetup(registry);
+        if (_versions.length > 0) {
+            revert ErrorProxyManagerAlreadyDeployed();
+        }
+
+        address currentProxyOwner = getOwner(); // used by implementation
+        address initialProxyAdminOwner = address(this); // used by proxy
 
         _proxy = new UpgradableProxyWithAdmin{salt: salt}(
             initialImplementation,
@@ -111,11 +116,11 @@ contract ProxyManager is
             getDeployData(currentProxyOwner, initializationData)
         );
 
-        versionable = _updateVersionHistory(
+        upgradeable = _updateVersionHistory(
             initialImplementation, 
             currentProxyOwner);
 
-        emit LogProxyManagerVersionableDeployed(address(versionable), initialImplementation);
+        emit LogProxyManagerProxyDeployed(address(upgradeable), initialImplementation);
     }
 
     /// @dev upgrade existing contract.
@@ -124,7 +129,7 @@ contract ProxyManager is
         public
         virtual
         onlyOwner()
-        returns (IVersionable versionable)
+        returns (IUpgradeable upgradeable)
     {
         bytes memory emptyUpgradeData;
         return upgrade(newImplementation, emptyUpgradeData);
@@ -135,7 +140,7 @@ contract ProxyManager is
         public
         virtual
         onlyOwner()
-        returns (IVersionable versionable)
+        returns (IUpgradeable upgradeable)
     {
         if (_versions.length == 0) { 
             revert ErrorProxyManagerNotYetDeployed();
@@ -150,11 +155,11 @@ contract ProxyManager is
             newImplementation, 
             getUpgradeData(upgradeData));
 
-        versionable = _updateVersionHistory(
+        upgradeable = _updateVersionHistory(
             newImplementation, 
             currentProxyOwner);
 
-        emit LogProxyManagerVersionableUpgraded(address(versionable), newImplementation);
+        emit LogProxyManagerProxyUpgraded(address(upgradeable), newImplementation);
 
     }
 
@@ -164,14 +169,14 @@ contract ProxyManager is
 
     function getDeployData(address proxyOwner, bytes memory deployData) public pure returns (bytes memory data) {
         return abi.encodeWithSelector(
-            IVersionable.initializeVersionable.selector, 
+            IUpgradeable.initialize.selector, 
             proxyOwner, 
             deployData);
     }
 
     function getUpgradeData(bytes memory upgradeData) public pure returns (bytes memory data) {
         return abi.encodeWithSelector(
-            IVersionable.upgradeVersionable.selector, 
+            IUpgradeable.upgrade.selector, 
             upgradeData);
     }
 
@@ -180,7 +185,7 @@ contract ProxyManager is
     }
 
     function getVersion() external view virtual returns(Version) {
-        return IVersionable(address(_proxy)).getVersion();
+        return _versionHistory[_versions[_versions.length]].version;
     }
 
     function getVersionCount() external view returns(uint256) {
@@ -195,42 +200,29 @@ contract ProxyManager is
         return _versionHistory[_version];
     }
 
-    function _preDeployChecksAndSetup(address registry)
-        private
-        returns (
-            address currentProxyOwner,
-            address initialProxyAdminOwner
-        )
-    {
-        if (_versions.length > 0) {
-            revert ErrorProxyManagerAlreadyDeployed();
-        }
-
-        address initialOwner = msg.sender;
-        __NftOwnable_init(registry, initialOwner);
-
-        currentProxyOwner = getOwner(); // used by implementation
-        initialProxyAdminOwner = address(this); // used by proxy
-    }
-
     function _updateVersionHistory(
         address implementation,
         address activatedBy
     )
         private
-        returns (IVersionable versionable)
+        returns (IUpgradeable upgradeable)
     {
-        versionable = IVersionable(address(_proxy));
-        Version newVersion = versionable.getVersion();
+        upgradeable = IUpgradeable(address(_proxy));
+        Version newVersion = upgradeable.getVersion();
 
         if(newVersion == VersionLib.zeroVersion()) {
             revert ErrorProxyManagerZeroVersion();
         }
 
         if(_versions.length > 0) {
-            if(newVersion.toInt() <= _versions[_versions.length-1].toInt()) {
+            Version version = _versions[_versions.length-1];
+            if(newVersion.toInt() <= version.toInt()) {
                 revert ErrorProxyManagerNextVersionNotIncreasing(newVersion);
             }
+
+            if(newVersion.toMajorPart() != version.toMajorPart()) {
+                revert ErrorProxyManagerNextVersionReleaseInvalid(newVersion);
+            }
         }
 
         // update version history