@etherisc/gif-next 3.0.0-a511887-523 → 3.0.0-ab05e7d-681

package/contracts/shared/InstanceLinkedComponent.sol

@@ -1,18 +1,26 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-
-import {Amount} from "../type/Amount.sol";
-import {Component} from "./Component.sol";
-import {IComponentService} from "./IComponentService.sol";
-import {IInstanceLinkedComponent} from "./IInstanceLinkedComponent.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
+import {IAuthorizedComponent} from "../shared/IAuthorizedComponent.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
+import {IComponentService} from "./IComponentService.sol";
 import {IInstance} from "../instance/IInstance.sol";
+import {IInstanceLinkedComponent} from "./IInstanceLinkedComponent.sol";
+import {IInstanceService} from "../instance/IInstanceService.sol";
+import {IOracleService} from "../oracle/IOracleService.sol";
+
+import {Amount} from "../type/Amount.sol";
+import {Component} from "./Component.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, COMPONENT, INSTANCE, PRODUCT} from "../type/ObjectType.sol";
+import {ObjectType, COMPONENT, INSTANCE, ORACLE, PRODUCT} from "../type/ObjectType.sol";
+import {RequestId} from "../type/RequestId.sol";
+import {RoleId, RoleIdLib} from "../type/RoleId.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
+import {Timestamp} from "../type/Timestamp.sol";
+import {VersionPart} from "../type/Version.sol";
 
 // then add (Distribution|Pool|Product)Upradeable that also intherit from Versionable
 // same pattern as for Service which is also upgradeable
@@ -25,19 +33,80 @@ abstract contract InstanceLinkedComponent is
 
     struct InstanceLinkedComponentStorage {
         IInstance _instance; // instance for this component
+        InstanceReader _instanceReader; // instance reader for this component
         IAuthorization _initialAuthorization;
+        IComponentService _componentService;
+        IOracleService _oracleService;
     }
 
+    //--- view functions ----------------------------------------------------//
+
     /// @inheritdoc IInstanceLinkedComponent
-    function getInstance() public view virtual returns (IInstance instance) {
+    function getInstance() public view virtual override returns (IInstance instance) {
         return _getInstanceLinkedComponentStorage()._instance;
     }
 
-    /// @inheritdoc IInstanceLinkedComponent
+
+    /// @inheritdoc IAuthorizedComponent
     function getAuthorization() external view virtual returns (IAuthorization authorization) {
         return _getInstanceLinkedComponentStorage()._initialAuthorization;
     }
 
+
+    /// @inheritdoc IInstanceLinkedComponent
+    function withdrawFees(Amount amount)
+        external
+        virtual
+        restricted()
+        onlyOwner()
+        returns (Amount withdrawnAmount)
+    {
+        return _withdrawFees(amount);
+    }
+
+    //--- internal functions ------------------------------------------------//
+
+    function _sendRequest(
+        NftId oracleNftId,
+        bytes memory requestData,
+        Timestamp expiryAt,
+        string memory callbackMethod
+    )
+        internal
+        virtual
+        returns (RequestId requestId)
+    {
+        return _getInstanceLinkedComponentStorage()._oracleService.request(
+            oracleNftId,
+            requestData,
+            expiryAt,
+            callbackMethod);
+    }
+
+
+    function _cancelRequest(RequestId requestId)
+        internal
+        virtual
+    {
+        _getInstanceLinkedComponentStorage()._oracleService.cancel(requestId);
+    }
+
+
+    function _resendRequest(RequestId requestId)
+        internal
+        virtual
+    {
+        _getInstanceLinkedComponentStorage()._oracleService.resend(requestId);
+    }
+
+
+    function _getInstanceLinkedComponentStorage() private pure returns (InstanceLinkedComponentStorage storage $) {
+        assembly {
+            $.slot := INSTANCE_LINKED_COMPONENT_LOCATION_V1
+        }
+    }
+
+
     function __InstanceLinkedComponent_init(
         address registry,
         NftId parentNftId,
@@ -47,64 +116,80 @@ abstract contract InstanceLinkedComponent is
         bool isInterceptor,
         address initialOwner
     )
-        internal 
+        internal
         virtual
         onlyInitializing()
     {
-        // TODO calling registry and checking release before component is initialized
-        //      at least breaks order of checks -> e.g. if registry is not contract no meaningfull error will be given
-        IInstance instance = _checkAndGetInstance(registry, parentNftId, componentType);
+        // validate registry, nft ids and get parent nft id
+        NftId instanceNftId = _checkAndGetInstanceNftId(
+            registry, 
+            parentNftId, 
+            componentType);
+
+        // set and check linked instance
+        InstanceLinkedComponentStorage storage $ = _getInstanceLinkedComponentStorage();
+        $._instance = IInstance(
+            IRegistry(registry).getObjectAddress(instanceNftId));
 
         // set component specific parameters
         __Component_init(
-            instance.authority(),
+            $._instance.authority(), // instance linked components need to point to instance admin
             registry, 
             parentNftId, 
             name, 
-            componentType,
+            componentType, 
             isInterceptor, 
             initialOwner, 
             ""); // registry data
 
         // set instance linked specific parameters
-        InstanceLinkedComponentStorage storage $ = _getInstanceLinkedComponentStorage();
-        $._instance = instance;
+        $._instanceReader = $._instance.getInstanceReader();
         $._initialAuthorization = authorization;
+        $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
+        $._oracleService = IOracleService(_getServiceAddress(ORACLE()));
 
         // register interfaces
         _registerInterface(type(IInstanceLinkedComponent).interfaceId);
     }
 
-    function _checkAndGetInstance(
+
+    function _checkAndGetInstanceNftId(
         address registryAddress,
         NftId parentNftId,
         ObjectType componentType
     )
-        private
+        internal
         view
-        returns (IInstance instance)
+        returns (NftId instanceNftId)
     {
-        NftId instanceNftId;
-        IRegistry registry = IRegistry(registryAddress);
-
-        if(componentType == PRODUCT()) {
-            instanceNftId = parentNftId;
-        } else {
-            NftId productNftId = parentNftId;
-            instanceNftId = registry.getParentNftId(productNftId);
+        // if product, then parent is already instance
+        if (componentType == PRODUCT()) {
+            _checkAndGetRegistry(registryAddress, parentNftId, INSTANCE());
+            return parentNftId;
         }
 
-        IRegistry.ObjectInfo memory info = registry.getObjectInfo(instanceNftId);
+        // if not product parent is product, and parent of product is instance
+        IRegistry registry = _checkAndGetRegistry(registryAddress, parentNftId, PRODUCT());
+        return registry.getParentNftId(parentNftId);
+    }
 
-        if (info.objectType != INSTANCE()) {
-            revert ErrorInstanceLinkedComponentInstanceInvalid();
-        }
+    /// @dev checks the and gets registry.
+    /// validates registry using a provided nft id and expected object type.
+    function _checkAndGetRegistry(
+        address registryAddress,
+        NftId objectNftId,
+        ObjectType requiredType
+    )
+        internal
+        view
+        returns (IRegistry registry)
+    {
+        registry = IRegistry(registryAddress);
+        IRegistry.ObjectInfo memory info = registry.getObjectInfo(objectNftId);
 
-        if(info.release != getRelease()) {
-            revert ErrorInstanceLinkedComponentInstanceMismatch(info.release, getRelease());
+        if (info.objectType != requiredType) {
+            revert ErrorInstanceLinkedComponentTypeMismatch(requiredType, info.objectType);
         }
-
-        instance = IInstance(info.objectAddress); 
     }
 
 
@@ -136,12 +221,13 @@ abstract contract InstanceLinkedComponent is
 
     /// @dev returns reader for linked instance
     function _getInstanceReader() internal view returns (InstanceReader reader) {
-        return _getInstanceLinkedComponentStorage()._instance.getInstanceReader();
+        return _getInstanceLinkedComponentStorage()._instanceReader;
     }
 
-    function _getInstanceLinkedComponentStorage() private pure returns (InstanceLinkedComponentStorage storage $) {
-        assembly {
-            $.slot := INSTANCE_LINKED_COMPONENT_LOCATION_V1
-        }
+    function _withdrawFees(Amount amount)
+        internal
+        returns (Amount withdrawnAmount)
+    {
+        return _getInstanceLinkedComponentStorage()._componentService.withdrawFees(amount);
     }
 }

package/contracts/shared/NftOwnable.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.20;
 import {InitializableERC165} from "./InitializableERC165.sol";
 import {INftOwnable} from "./INftOwnable.sol";
 import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
 import {RegistryLinked} from "./RegistryLinked.sol";
 
 contract NftOwnable is
@@ -34,8 +35,20 @@ contract NftOwnable is
         _;
     }
 
+    modifier onlyNftOfType(NftId nftId, ObjectType expectedObjectType) {
+        _checkNftType(nftId, expectedObjectType);
+        _;
+    }
+
+    function _checkNftType(NftId nftId, ObjectType expectedObjectType) internal view {
+        if(expectedObjectType.eqz() || !getRegistry().isObjectType(nftId, expectedObjectType)) {
+            revert ErrorNftOwnableInvalidType(nftId, expectedObjectType);
+        }
+    }
+
+
     /// @dev Initialization for upgradable contracts.
-    // used in __Registerable_init, ProxyManager.initialize
+    // used in __Registerable_init, ProxyManager._preDeployChecksAndSetup
     function __NftOwnable_init(
         address registry,
         address initialOwner

package/contracts/shared/PolicyHolder.sol

@@ -23,7 +23,7 @@ contract PolicyHolder is
     // callbacks must only be allowed from the policy and claim services
     // will need a release parameter to fetch the right service addresses for the modifiers
 
-    function __PolicyHolder_init(
+    function _initializePolicyHolder(
         address registryAddress
     )
         internal
@@ -47,7 +47,7 @@ contract PolicyHolder is
     /// @dev empty default implementation
     function payoutExecuted(NftId policyNftId, PayoutId payoutId, Amount amount, address beneficiary) external virtual {}
 
-    //--- IERC721 functions ---------------// 
+    //--- IERC165 functions ---------------// 
     function onERC721Received(
         address, // operator
         address, // from

package/contracts/shared/Registerable.sol

@@ -9,16 +9,15 @@ import {ContractLib} from "../shared/ContractLib.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
 import {NftOwnable} from "../shared/NftOwnable.sol";
 import {ObjectType} from "../type/ObjectType.sol";
-import {Versionable} from "../shared/Versionable.sol";
 import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegisterable} from "./IRegisterable.sol";
+import {IRelease} from "../registry/IRelease.sol";
 
 abstract contract Registerable is
     AccessManagedUpgradeable,
     NftOwnable,
-    Versionable,
     IRegisterable
 {
     // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.shared.Registerable.sol")) - 1)) & ~bytes32(uint256(0xff));
@@ -38,19 +37,6 @@ abstract contract Registerable is
         _;
     }
 
-    // TODO move to registerables verification library
-    modifier onlyNftOfType(NftId nftId, ObjectType expectedObjectType) {
-        _checkNftType(nftId, expectedObjectType);
-        _;
-    }
-
-    // TODO move to registerables verification library
-    function _checkNftType(NftId nftId, ObjectType expectedObjectType) internal view {
-        if(expectedObjectType.eqz() || !getRegistry().isObjectType(nftId, expectedObjectType, getRelease())) {
-            revert ErrorNftOwnableInvalidType(nftId, expectedObjectType);
-        }
-    }
-
     function __Registerable_init(
         address authority,
         address registry,
@@ -58,7 +44,7 @@ abstract contract Registerable is
         ObjectType objectType,
         bool isInterceptor,
         address initialOwner,
-        bytes memory data
+        bytes memory data // writeonly data that will saved in the object info record of the registry
     )
         internal
         virtual
@@ -68,20 +54,14 @@ abstract contract Registerable is
             revert ErrorAuthorityInvalid(authority);
         }
 
-        // release must allign with authority -> not a release check of third contract...
-        VersionPart release = AccessManagerCloneable(authority).getRelease();
-
         __AccessManaged_init(authority);
         __NftOwnable_init(registry, initialOwner);
-        __Versionable_init(release);
 
         RegisterableStorage storage $ = _getRegisterableStorage();
         $._parentNftId = parentNftId;
         $._objectType = objectType;
         $._isInterceptor = isInterceptor;
-        if(data.length > 0) { 
-            $._data = data;
-        }
+        $._data = data;
 
         _registerInterface(type(IAccessManaged).interfaceId);
     }
@@ -92,6 +72,13 @@ abstract contract Registerable is
         return !AccessManagerCloneable(authority()).isTargetClosed(address(this));
     }
 
+
+    /// @inheritdoc IRelease
+    function getRelease() public virtual view returns (VersionPart release) {
+        return AccessManagerCloneable(authority()).getRelease();
+    }
+
+
     /// @inheritdoc IRegisterable
     function getInitialInfo() 
         public 
@@ -100,19 +87,14 @@ abstract contract Registerable is
         returns (IRegistry.ObjectInfo memory info) 
     {
         RegisterableStorage storage $ = _getRegisterableStorage();
-        return (
-            IRegistry.ObjectInfo(
-                NftIdLib.zero(),
-                $._parentNftId,
-                $._objectType,
-                getRelease(),
-                $._isInterceptor,
-                address(this))
-        );
-    }
-
-    function getInitialData() public view virtual returns (bytes memory data) {
-        return _getRegisterableStorage()._data;
+        return IRegistry.ObjectInfo(
+            NftIdLib.zero(),
+            $._parentNftId,
+            $._objectType,
+            $._isInterceptor,
+            address(this), 
+            getOwner(),
+            $._data);
     }
 
 

package/contracts/shared/RegistryLinked.sol

@@ -12,27 +12,20 @@ contract RegistryLinked is
     IRegistryLinked
 {
 
-    // priorize simplicity and size over using standard upgradeability structs 
-    // registry address MUST NOT be upgraded
+    // priorize simplicity and size over using standard upgradeability structs
     IRegistry private _registry;
 
     /// @dev initialization for upgradable contracts
-    // used in RegistryAdmin / InstanceAdmin / ReleaseAdmin.completeSetup()
+    // used in _initializeRegisterable
     function __RegistryLinked_init(
         address registry
     )
         internal
         virtual
+        onlyInitializing()
     {
-        if(address(_registry) != address(0) ) {
-            if(_registry != IRegistry(registry)) {
-                revert ErrorRegistryLinkedRegistryAlreadyInitialized(address(this), address(_registry));
-            }
-            return;
-        }
-
         if (!ContractLib.isRegistry(registry)) {
-            revert ErrorRegistryLinkedNotRegistry(address(this), registry);
+            revert ErrorNotRegistry(registry);
         }
 
         _registry = IRegistry(registry);

package/contracts/shared/Service.sol

@@ -5,19 +5,18 @@ import {ReentrancyGuardUpgradeable} from "@openzeppelin/contracts-upgradeable/ut
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IService} from "./IService.sol";
-import {IVersionable} from "../shared/IVersionable.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
 import {ObjectType, SERVICE} from "../type/ObjectType.sol";
 import {Registerable} from "./Registerable.sol";
 import {RoleId, RoleIdLib} from "../type/RoleId.sol";
-import {Version, VersionLib, VersionPartLib} from "../type/Version.sol";
-import {Versionable} from "../shared/Versionable.sol";
-import {Upgradeable} from "../upgradeability/Upgradeable.sol";
+import {Version, VersionLib} from "../type/Version.sol";
+import {Versionable} from "../upgradeability/Versionable.sol";
 
 
 /// @dev service base contract
 abstract contract Service is 
-    Registerable, 
-    Upgradeable,
+    Registerable,
+    Versionable,
     ReentrancyGuardUpgradeable,
     IService
 {

package/contracts/shared/TokenHandler.sol

@@ -10,7 +10,6 @@ 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.
@@ -50,7 +49,6 @@ contract TokenHandlerBase {
     IERC20Metadata public immutable TOKEN;
     address public immutable COMPONENT;
     NftId public immutable NFT_ID;
-    VersionPart public immutable RELEASE;
 
     address internal _wallet;
 
@@ -71,7 +69,6 @@ contract TokenHandlerBase {
         REGISTRY = IRegistry(registry);
         COMPONENT = component;
         NFT_ID = REGISTRY.getNftIdForAddress(component);
-        RELEASE = REGISTRY.getObjectRelease(NFT_ID);
 
         if (NFT_ID.eqz()) {
             revert ErrorTokenHandlerComponentNotRegistered(component);
@@ -257,7 +254,7 @@ contract TokenHandler is
     error ErrorTokenHandlerNotService(address service);
 
     modifier onlyService() {
-        if (!REGISTRY.isObjectType(msg.sender, SERVICE(), RELEASE)) {
+        if (!REGISTRY.isObjectType(msg.sender, SERVICE())) {
             revert ErrorTokenHandlerNotService(msg.sender);
         }
         _;

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 {IUpgradeable} from "../upgradeability/IUpgradeable.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
 
 import {Amount} from "../type/Amount.sol";
 import {Blocknumber} from "../type/Blocknumber.sol";
@@ -22,9 +22,11 @@ import {VersionPart} from "../type/Version.sol";
 
 interface IStaking is 
     IComponent,
-    IUpgradeable
+    IVersionable
 {
 
+    event LogStakingTokenHandlerDeployed(NftId componentNftId, address tokenHandler, address token);
+    
     // owner functions
     event LogStakingStakingRateSet(ChainId chainId, address token, UFixed newStakingRate, UFixed oldStakingRate, Blocknumber lastUpdateIn);
     event LogStakingStakingServiceSet(address stakingService, VersionPart release, address oldStakingService);

package/contracts/staking/IStakingService.sol

@@ -17,7 +17,7 @@ interface IStakingService is IService
 {
 
     event LogStakingServiceProtocolTargetRegistered(NftId protocolNftId);
-    event LogStakingServiceInstanceTargetRegistered(NftId instanceNftId, uint256 chainId);
+    event LogStakingServiceInstanceTargetRegistered(NftId instanceNftId, uint256 chainId, Seconds initialLockingPeriod, UFixed initialRewardRate);
     event LogStakingServiceLockingPeriodSet(NftId targetNftId, Seconds oldLockingDuration, Seconds lockingDuration);
     event LogStakingServiceRewardRateSet(NftId targetNftId, UFixed oldRewardRate, UFixed rewardRate);
 

package/contracts/staking/Staking.sol

@@ -4,10 +4,11 @@ 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 "../shared/IVersionable.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
 
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {Blocknumber} from "../type/Blocknumber.sol";
@@ -15,7 +16,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, STAKE, STAKING, TARGET} from "../type/ObjectType.sol";
+import {ObjectType, PROTOCOL, INSTANCE, 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";
@@ -27,13 +28,12 @@ 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 "../shared/Versionable.sol";
-import {Upgradeable} from "../upgradeability/Upgradeable.sol";
+import {Versionable} from "../upgradeability/Versionable.sol";
 
 
 contract Staking is 
     Component,
-    Upgradeable,
+    Versionable,
     IStaking
 {
     string public constant CONTRACT_NAME = "Staking";
@@ -86,6 +86,7 @@ contract Staking is
             address(this),
             dipToken, 
             getRegistry().getAuthority());
+        emit LogStakingTokenHandlerDeployed(getNftId(), address($._tokenHandler), dipToken);
     }
 
 
@@ -649,11 +650,21 @@ 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 (IVersionable, Versionable)
+        virtual override (Component, IVersionable, Versionable)
         returns(Version)
     {
         return VersionLib.toVersion(3,0,0);
@@ -737,7 +748,7 @@ contract Staking is
         // initialize component
         __Component_init(
             registry.getAuthority(),
-            registryAddress, 
+            address(registry), 
             registry.getNftId(), // parent nft id
             CONTRACT_NAME,
             STAKING(), 

package/contracts/staking/StakingManager.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IUpgradeable} from "../upgradeability/IUpgradeable.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
 import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {Staking} from "./Staking.sol";
 
@@ -32,13 +32,13 @@ contract StakingManager is
             stakingStore,
             tokenRegistry);
         
-        IUpgradeable upgradeable = initialize(
+        IVersionable versionable = initialize(
             registry,
             _initialImplementation,
             _initializationData,
             salt);
 
-        _staking = Staking(address(upgradeable));
+        _staking = Staking(address(versionable));
     }
 
     //--- view functions ----------------------------------------------------//