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

package/contracts/shared/Service.sol

@@ -5,25 +5,25 @@ import {ReentrancyGuardUpgradeable} from "@openzeppelin/contracts-upgradeable/ut
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IService} from "./IService.sol";
-import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {IVersionable} from "../shared/IVersionable.sol";
 import {ObjectType, SERVICE} from "../type/ObjectType.sol";
 import {Registerable} from "./Registerable.sol";
 import {RoleId, RoleIdLib} from "../type/RoleId.sol";
-import {Version, VersionLib} from "../type/Version.sol";
-import {Versionable} from "../upgradeability/Versionable.sol";
+import {Version, VersionLib, VersionPartLib} from "../type/Version.sol";
+import {Versionable} from "../shared/Versionable.sol";
+import {Upgradeable} from "../upgradeability/Upgradeable.sol";
 
 
 /// @dev service base contract
 abstract contract Service is 
-    Registerable,
-    Versionable,
+    Registerable, 
+    Upgradeable,
     ReentrancyGuardUpgradeable,
     IService
 {
 
     function __Service_init(
         address authority, // real authority for registry service adress(0) for other services
-        address registry, 
         address initialOwner
     )
         internal
@@ -34,8 +34,7 @@ abstract contract Service is
 
         __Registerable_init(
             authority,
-            registry, 
-            IRegistry(registry).getNftId(), 
+            _getRegistry().getNftId(), 
             SERVICE(), 
             false, // is interceptor
             initialOwner, 
@@ -62,6 +61,6 @@ abstract contract Service is
 
 
     function _getServiceAddress(ObjectType domain) internal view returns (address) {
-        return getRegistry().getServiceAddress(domain, getRelease());
+        return _getRegistry().getServiceAddress(domain, getRelease());
     }
 }

package/contracts/shared/TokenHandler.sol

@@ -10,6 +10,7 @@ import {ContractLib} from "../shared/ContractLib.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId} from "../type/NftId.sol";
 import {SERVICE} from "../type/ObjectType.sol";
+import {VersionPart} from "../type/Version.sol";
 
 
 /// @dev Token specific transfer helper base contract.
@@ -49,6 +50,7 @@ contract TokenHandlerBase {
     IERC20Metadata public immutable TOKEN;
     address public immutable COMPONENT;
     NftId public immutable NFT_ID;
+    VersionPart public immutable RELEASE;
 
     address internal _wallet;
 
@@ -69,6 +71,7 @@ contract TokenHandlerBase {
         REGISTRY = IRegistry(registry);
         COMPONENT = component;
         NFT_ID = REGISTRY.getNftIdForAddress(component);
+        RELEASE = REGISTRY.getObjectRelease(NFT_ID);
 
         if (NFT_ID.eqz()) {
             revert ErrorTokenHandlerComponentNotRegistered(component);
@@ -254,7 +257,7 @@ contract TokenHandler is
     error ErrorTokenHandlerNotService(address service);
 
     modifier onlyService() {
-        if (!REGISTRY.isObjectType(msg.sender, SERVICE())) {
+        if (!REGISTRY.isObjectType(msg.sender, SERVICE(), RELEASE)) {
             revert ErrorTokenHandlerNotService(msg.sender);
         }
         _;

package/contracts/shared/Versionable.sol

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IVersionable} from "./IVersionable.sol";
+import {GIF_INITIAL_RELEASE} from "../registry/Registry.sol";
+import {Version, VersionPart, VersionLib, VersionPartLib} from "../type/Version.sol";
+
+
+abstract contract Versionable is
+    IVersionable 
+{
+    // TODO use arg of type Version
+    function __Versionable_init(
+        VersionPart release // wants to initialize to this release version
+    )
+        internal
+        view
+        virtual
+    {
+        VersionPart currentRelease = getRelease();
+        if (!currentRelease.isValidRelease()) {
+            revert ErrorVersionableReleaseInvalid(address(this), currentRelease);
+        }
+
+        //Version initializedVersion = VersionLib.toVersion(_getInitializedVersion());
+        //if(initializedVersion != getVersion()) {}
+
+        _checkRelease(release);
+    }
+
+    function getVersion() public pure virtual returns(Version)
+    {
+        return VersionLib.toVersion(GIF_INITIAL_RELEASE().toInt(), 0, 0);
+    }
+
+    function getRelease() public pure returns(VersionPart)
+    {
+        return getVersion().toMajorPart();
+    }
+
+    function _checkRelease(VersionPart release) internal view {
+        VersionPart currentRelease = getRelease();
+        if(currentRelease != release) {
+            revert ErrorVersionableReleaseMismatch(address(this), release, currentRelease);
+        }
+    }
+}

package/contracts/staking/IStaking.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.20;
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {IComponent} from "../shared/IComponent.sol";
-import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {IUpgradeable} from "../upgradeability/IUpgradeable.sol";
 
 import {Amount} from "../type/Amount.sol";
 import {Blocknumber} from "../type/Blocknumber.sol";
@@ -22,7 +22,7 @@ import {VersionPart} from "../type/Version.sol";
 
 interface IStaking is 
     IComponent,
-    IVersionable
+    IUpgradeable
 {
 
     // owner functions

package/contracts/staking/Staking.sol

@@ -4,11 +4,10 @@ pragma solidity ^0.8.20;
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
-import {IRelease} from "../registry/IRelease.sol";
 import {IStaking} from "./IStaking.sol";
 import {IStakingService} from "./IStakingService.sol";
 import {ITargetLimitHandler} from "./ITargetLimitHandler.sol";
-import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {IVersionable} from "../shared/IVersionable.sol";
 
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {Blocknumber} from "../type/Blocknumber.sol";
@@ -16,7 +15,7 @@ import {ChainId, ChainIdLib} from "../type/ChainId.sol";
 import {Component} from "../shared/Component.sol";
 import {IComponent} from "../shared/IComponent.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, PROTOCOL, INSTANCE, STAKE, STAKING, TARGET} from "../type/ObjectType.sol";
+import {ObjectType, PROTOCOL, STAKE, STAKING, TARGET} from "../type/ObjectType.sol";
 import {Seconds, SecondsLib} from "../type/Seconds.sol";
 import {Registerable} from "../shared/Registerable.sol";
 import {StakingLib} from "./StakingLib.sol";
@@ -28,12 +27,13 @@ import {TokenHandlerDeployerLib} from "../shared/TokenHandlerDeployerLib.sol";
 import {TokenRegistry} from "../registry/TokenRegistry.sol";
 import {UFixed, UFixedLib} from "../type/UFixed.sol";
 import {Version, VersionLib, VersionPart, VersionPartLib} from "../type/Version.sol";
-import {Versionable} from "../upgradeability/Versionable.sol";
+import {Versionable} from "../shared/Versionable.sol";
+import {Upgradeable} from "../upgradeability/Upgradeable.sol";
 
 
 contract Staking is 
     Component,
-    Versionable,
+    Upgradeable,
     IStaking
 {
     string public constant CONTRACT_NAME = "Staking";
@@ -75,17 +75,18 @@ contract Staking is
         external
         virtual
     {
-        if (msg.sender != address(getRegistry())) {
+        IRegistry registry = _getRegistry();
+        if (msg.sender != address(registry)) {
             revert ErrorStakingNotRegistry(msg.sender);
         }
 
         StakingStorage storage $ = _getStakingStorage();
         address dipToken = _getStakingStorage()._tokenRegistry.getDipTokenAddress();
         $._tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(
-            address(getRegistry()),
+            address(registry),
             address(this),
             dipToken, 
-            getRegistry().getAuthority());
+            registry.getAuthority());
     }
 
 
@@ -190,7 +191,7 @@ contract Staking is
         // effects
         StakingStorage storage $ = _getStakingStorage();
         address oldStakingService = address($._stakingService);
-        $._stakingService = StakingLib.checkAndGetStakingService(getRegistry(), release);
+        $._stakingService = StakingLib.checkAndGetStakingService(release);
 
         emit LogStakingStakingServiceSet(address($._stakingService), release, oldStakingService);
     }
@@ -277,9 +278,10 @@ contract Staking is
         returns (Amount newBalance)
     {
         address transferTo;
+        IRegistry registry = _getRegistry();
     
         // case 1: protocol target: staking owner is recipient
-        if (targetNftId == getRegistry().getProtocolNftId()) {
+        if (targetNftId == registry.getProtocolNftId()) {
             // verify that the caller is the staking owner
             transferTo = getOwner();
             if (msg.sender != transferTo) {
@@ -289,7 +291,7 @@ contract Staking is
         // case 2: same chain target: target owner is recipient
         } else if (ChainIdLib.isCurrentChain(targetNftId)) {
             // verify that the caller is the target owner
-            transferTo = getRegistry().ownerOf(targetNftId);
+            transferTo = registry.ownerOf(targetNftId);
             if (msg.sender != transferTo) {
                 revert ErrorStakingNotNftOwner(targetNftId);
             }
@@ -323,13 +325,15 @@ contract Staking is
         onlyTarget(targetNftId)
         returns (Amount newBalance)
     {
+        IRegistry registry = _getRegistry();
+
         // check that service does not withdraw from protocol target 
-        if (targetNftId == getRegistry().getProtocolNftId()) {
+        if (targetNftId == registry.getProtocolNftId()) {
             revert ErrorStakingTargetTypeNotSupported(targetNftId, PROTOCOL());
         }
 
         // default: on-chain target owner is recipient
-        address targetOwner = getRegistry().ownerOf(targetNftId);
+        address targetOwner = registry.ownerOf(targetNftId);
         return _withdrawRewardReserves(targetNftId, dipAmount, targetOwner);
     }
 
@@ -431,7 +435,9 @@ contract Staking is
         virtual
         restricted() // only pool service
     {
+        // !!! TODO amount can be 0
         StakingStorage storage $ = _getStakingStorage();
+        // why not StakingBalanceStore instead of StakingStore?
         $._store.increaseTotalValueLocked(targetNftId, token, amount);
     }
 
@@ -528,7 +534,7 @@ contract Staking is
 
         // collect staked DIP token via staking service
         if (stakeAmount.gtz()) {
-            address stakeOwner = getRegistry().ownerOf(stakeNftId);
+            address stakeOwner = _getRegistry().ownerOf(stakeNftId);
             $._stakingService.pullDipToken(stakeAmount, stakeOwner);
         }
     }
@@ -551,7 +557,7 @@ contract Staking is
 
         // transfer unstaked DIP token via staking service
         if (unstakedAmount.gtz()) {
-            address stakeOwner = getRegistry().ownerOf(stakeNftId);
+            address stakeOwner = _getRegistry().ownerOf(stakeNftId);
             $._stakingService.pushDipToken(unstakedAmount, stakeOwner);
         }
     }
@@ -582,7 +588,7 @@ contract Staking is
             AmountLib.max()); // unstake up to this amount
 
         // step 2: create new stake with full unstaked amount
-        address stakeOwner = getRegistry().ownerOf(stakeNftId);
+        address stakeOwner = _getRegistry().ownerOf(stakeNftId);
         newStakeNftId = $._stakingService.createStakeObject(newTargetNftId, stakeOwner);
         $._store.createStake(newStakeNftId, newTargetNftId, stakeOwner, newStakedAmount);
 
@@ -621,7 +627,7 @@ contract Staking is
         // collect staked DIP token by staking service
         if (claimedAmount.gtz()) {
             // interactions
-            address stakeOwner = getRegistry().ownerOf(stakeNftId);
+            address stakeOwner = _getRegistry().ownerOf(stakeNftId);
             $._stakingService.pushDipToken(claimedAmount, stakeOwner);
         }
     }
@@ -649,21 +655,11 @@ contract Staking is
         return _getStakingStorage()._tokenHandler;
     }
 
-    // from IRegisterable
-    function getRelease()
-        public 
-        pure 
-        virtual override (IRelease, Registerable)
-        returns(VersionPart)
-    {
-        return VersionPartLib.toVersionPart(3);
-    }
-
     // from IVersionable
     function getVersion()
         public 
         pure 
-        virtual override (Component, IVersionable, Versionable)
+        virtual override (IVersionable, Versionable)
         returns(Version)
     {
         return VersionLib.toVersion(3,0,0);
@@ -728,14 +724,13 @@ contract Staking is
         onlyInitializing()
     {
         (
-            address registryAddress,
             address targetHandlerAddress,
             address stakingStoreAddress,
             address tokenRegistryAddress
-        ) = abi.decode(data, (address, address, address, address));
+        ) = abi.decode(data, (address, address, address));
 
         // wiring to external contracts
-        IRegistry registry = IRegistry(registryAddress);
+        IRegistry registry = _getRegistry();
         StakingStorage storage $ = _getStakingStorage();
         $._protocolNftId = registry.getProtocolNftId();
         $._targetHandler = TargetHandler(targetHandlerAddress);
@@ -745,9 +740,9 @@ contract Staking is
         // staking service has to be set via setStakingService after deploying the first GIF release
 
         // initialize component
+        // TODO Will read 0 component service address from registry
         __Component_init(
             registry.getAuthority(),
-            address(registry), 
             registry.getNftId(), // parent nft id
             CONTRACT_NAME,
             STAKING(), 
@@ -781,7 +776,7 @@ contract Staking is
         }
 
         if (checkOwner) {
-            address nftOwner = getRegistry().ownerOf(nftId);
+            address nftOwner = _getRegistry().ownerOf(nftId);
             if (msg.sender != nftOwner) {
                 revert ErrorStakingNotOwner(nftId, nftOwner, msg.sender);
             }

package/contracts/staking/StakingLib.sol

@@ -6,6 +6,7 @@ import {IStaking} from "./IStaking.sol";
 import {IStakingService} from "./IStakingService.sol";
 
 import {Amount} from "../type/Amount.sol";
+import {ContractLib} from "../shared/ContractLib.sol";
 import {NftId} from "../type/NftId.sol";
 import {ReleaseRegistry} from "../registry/ReleaseRegistry.sol";
 import {Seconds, SecondsLib} from "../type/Seconds.sol";
@@ -111,13 +112,14 @@ library StakingLib {
 
 
     function checkAndGetStakingService(
-        IRegistry registry,
         VersionPart release
     )
         public
         view
         returns (IStakingService stakingService)
     {
+        IRegistry registry = ContractLib.getRegistry();
+
         if (!ReleaseRegistry(registry.getReleaseRegistryAddress()).isActiveRelease(release)) {
             revert IStaking.ErrorStakingReleaseNotActive(release);
         }

package/contracts/staking/StakingManager.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {IUpgradeable} from "../upgradeability/IUpgradeable.sol";
 import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {Staking} from "./Staking.sol";
 
@@ -15,7 +15,6 @@ contract StakingManager is
 
     /// @dev initializes proxy manager with service implementation 
     constructor(
-        address registry,
         address targetHandler,
         address stakingStore,
         address tokenRegistry,
@@ -27,18 +26,16 @@ contract StakingManager is
 
         _initialImplementation = address(stakingImplementation);
         _initializationData = abi.encode(
-            registry,
             targetHandler,
             stakingStore,
             tokenRegistry);
         
-        IVersionable versionable = initialize(
-            registry,
+        IUpgradeable upgradeable = initialize(
             _initialImplementation,
             _initializationData,
             salt);
 
-        _staking = Staking(address(versionable));
+        _staking = Staking(address(upgradeable));
     }
 
     //--- view functions ----------------------------------------------------//

package/contracts/staking/StakingReader.sol

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

package/contracts/staking/StakingService.sol

@@ -3,7 +3,6 @@ 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";
@@ -114,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);
@@ -131,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);
@@ -158,11 +157,12 @@ contract StakingService is
                 nftId: NftIdLib.zero(),
                 parentNftId: targetNftId,
                 objectType: STAKE(),
+                release: getRelease(),
                 isInterceptor: false,
-                objectAddress: address(0),
-                initialOwner: stakeOwner,
-                data: ""
-            }));
+                objectAddress: address(0)}),
+            stakeOwner, // initialOwner
+            "" // data
+        );
 
         emit LogStakingServiceStakeObjectCreated(stakeNftId, targetNftId, stakeOwner);
     }
@@ -255,18 +255,18 @@ contract StakingService is
     )
         internal
         virtual override
-        initializer()
+        onlyInitializing()
     {
         (
             address authority,
-            address registry,
             address staking
-        ) = abi.decode(data, (address, address, address));
+        ) = abi.decode(data, (address, address));
 
-        __Service_init(authority, registry, owner);
+        __Service_init(authority, 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,6 +294,9 @@ 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);
@@ -301,7 +304,7 @@ contract StakingService is
 
         address owner = msg.sender;
         _getStakingServiceStorage()._registryService.registerStaking(
-            IRegisterable(stakingAddress),
+            IStaking(stakingAddress),
             owner);
 
         return IStaking(stakingAddress);

package/contracts/staking/StakingServiceManager.sol

@@ -2,8 +2,7 @@
 pragma solidity ^0.8.20;
 
 import {IRegistry} from "../registry/IRegistry.sol";
-import {IVersionable} from "../upgradeability/IVersionable.sol";
-
+import {IUpgradeable} from "../upgradeability/IUpgradeable.sol";
 import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {StakingService} from "./StakingService.sol";
 
@@ -16,23 +15,20 @@ 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, 
-            registry, 
-            IRegistry(registry).getStakingAddress());
+            _getRegistry().getStakingAddress());
 
-        IVersionable versionable = initialize(
-            registry,
+        IUpgradeable upgradeable = initialize(
             address(svc), 
             data,
             salt);
 
-        _stakingService = StakingService(address(versionable));
+        _stakingService = StakingService(address(upgradeable));
     }
 
     //--- view functions ----------------------------------------------------//