@etherisc/gif-next 3.0.0-1b49bd6-565 → 3.0.0-1c2086e-623

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";
@@ -51,14 +52,13 @@ contract StakingService is
         virtual
         restricted()
     {
-        uint256 chainId = block.chainid;
         _getStakingServiceStorage()._staking.registerTarget(
             targetNftId,
             INSTANCE(),
             initialLockingPeriod,
             initialRewardRate);
 
-        emit LogStakingServiceInstanceTargetRegistered(targetNftId, chainId);
+        emit LogStakingServiceInstanceTargetRegistered(targetNftId, initialLockingPeriod, initialRewardRate);
     }
 
 
@@ -113,7 +113,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 +130,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 +157,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 +254,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 +282,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 +293,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 +300,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 tvlUpdatesTrigger, UFixed 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,17 +33,19 @@ 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
         _setUpdateTriggers(
-            10, // check after 2 TVL updates
+            10, // check after 10 TVL updates
             UFixedLib.toUFixed(1, -1)); // 10% deviation from baseline TVL
     }
 

package/contracts/type/RequestId.sol

@@ -72,4 +72,10 @@ library RequestIdLib {
     function toKeyId(RequestId id) public pure returns (KeyId keyId) {
         return KeyId.wrap(bytes31(uint248(RequestId.unwrap(id))));
     }
+
+    function toRequestId(KeyId keyId) public pure returns (RequestId requestId) {
+        uint248 keyIdInt = uint248(bytes31(KeyId.unwrap(keyId)));
+        assert(keyIdInt < type(uint64).max);
+        return RequestId.wrap(uint64(keyIdInt));
+    }
 }

package/contracts/type/RiskId.sol

@@ -2,10 +2,9 @@
 pragma solidity ^0.8.20;
 
 import {Key32, KeyId, Key32Lib} from "./Key32.sol";
-import {NftId} from "./NftId.sol";
 import {RISK} from "./ObjectType.sol";
 
-type RiskId is bytes8;
+type RiskId is uint64;
 
 // type bindings
 using {
@@ -33,7 +32,7 @@ function neRiskId(RiskId a, RiskId b) pure returns (bool isDifferent) {
 
 library RiskIdLib {
     function zero() public pure returns (RiskId) {
-        return RiskId.wrap(bytes8(0));
+        return RiskId.wrap(uint64(0));
     }
 
     // @dev Converts a risk id into a uint256.
@@ -42,8 +41,8 @@ library RiskIdLib {
     }
 
     // @dev Converts a risk id string with a product NftId into a risk id.
-    function toRiskId(NftId productNftId, bytes32 risk) public pure returns (RiskId) {
-        return RiskId.wrap(bytes8(keccak256(abi.encode(productNftId, risk))));
+    function toRiskId(uint256 id) public pure returns (RiskId) {
+        return RiskId.wrap(uint64(id));
     }
 
     /// @dev Returns the key32 value for the specified risk id.
@@ -53,12 +52,13 @@ library RiskIdLib {
 
     /// @dev Returns the key id value for the specified nft id
     function toKeyId(RiskId id) public pure returns (KeyId keyId) {
-        return KeyId.wrap(bytes31(RiskId.unwrap(id)));
+        return KeyId.wrap(bytes31(uint248(RiskId.unwrap(id))));
     }
 
     function toRiskId(KeyId keyId) public pure returns (RiskId riskId) {
-        riskId = RiskId.wrap(bytes8(KeyId.unwrap(keyId)));
-        assert(toInt(riskId) < 2**64);
+        uint248 keyIdInt = uint248(bytes31(KeyId.unwrap(keyId)));
+        assert(keyIdInt < type(uint64).max);
+        return RiskId.wrap(uint64(keyIdInt));
     }
 
     function eq(RiskId a, RiskId b) public pure returns (bool isSame) {

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?

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

@@ -1,21 +1,21 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../shared/IVersionable.sol";
+import {Version} from "../type/Version.sol";
 
 /// IMPORTANT
 // Upgradeable contract MUST:
-// 1) inherit Upgradeable
-// 2) implement getVersion() function
+// 1) inherit from Versionable
+// 2) implement version() 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() 
-// 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)
+// 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 
 // 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 functions
+//    otherwise, it is still possible to upgrade contract, but everyone who is using it will have to switch to a new fucntions
 //    in some cases this ok but not in the others...
 //
 // IMPORTANT
@@ -26,25 +26,31 @@ import {IVersionable} from "../shared/IVersionable.sol";
 // 2) ALWAYS define private getter if accessing storage
 //      - MUST use default implementation, CAN change ONLY return type
 
-interface IUpgradeable is IVersionable {
+interface 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 initialize(address activatedBy, bytes memory activationData) external;
+    function initializeVersionable(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 upgrade(bytes memory upgradeData) external;
+    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);
+
 }