@etherisc/gif-next 3.0.0-a511887-523 → 3.0.0-ab0fcb2-112

package/contracts/shared/IRegisterable.sol

@@ -6,6 +6,9 @@ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessMana
 import {INftOwnable} from "./INftOwnable.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IVersionable} from "./IVersionable.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {NftId} from "../type/NftId.sol";
+import {VersionPart} from "../type/Version.sol";
 
 /// @title IRegisterable
 /// @dev Marks contracts that are intended to be registered in the registry.
@@ -21,6 +24,9 @@ interface IRegisterable is
     // onlyActive()
     error ErrorRegisterableNotActive();
 
+    //_checkNftType()
+    error ErrorRegisterableInvalidType(NftId nftId, ObjectType expectedType, VersionPart expectedRelease);
+
     /// @dev Returns true iff this contract managed by its authority is active.
     /// Queries the IAccessManaged.authority().
     function isActive() external view returns (bool active);

package/contracts/shared/IRegistryLinked.sol

@@ -5,9 +5,5 @@ import {IRegistry} from "../registry/IRegistry.sol";
 
 interface IRegistryLinked {
 
-    error ErrorRegistryLinkedRegistryAlreadyInitialized(address target, address registry);
-    error ErrorRegistryLinkedNotRegistry(address target, address notRegistry);
-    error ErrorRegistryLinkedRegistryMismatch(address target, address givenRegistry, address pureRegistry);
-
-    function getRegistry() external view returns (IRegistry);
+    function getRegistry() external pure returns (IRegistry);
 }

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
@@ -26,20 +34,71 @@ abstract contract InstanceLinkedComponent is
     struct InstanceLinkedComponentStorage {
         IInstance _instance; // instance 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;
     }
 
+
+    //function setInstanceReader(address readerAddress);
+
+    //--- 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,
         string memory name,
         ObjectType componentType,
@@ -51,14 +110,11 @@ abstract contract InstanceLinkedComponent is
         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);
+        IInstance instance = _checkAndGetInstance(parentNftId, componentType);
 
         // set component specific parameters
         __Component_init(
             instance.authority(),
-            registry, 
             parentNftId, 
             name, 
             componentType,
@@ -70,13 +126,14 @@ abstract contract InstanceLinkedComponent is
         InstanceLinkedComponentStorage storage $ = _getInstanceLinkedComponentStorage();
         $._instance = instance;
         $._initialAuthorization = authorization;
+        $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
+        $._oracleService = IOracleService(_getServiceAddress(ORACLE()));
 
         // register interfaces
         _registerInterface(type(IInstanceLinkedComponent).interfaceId);
     }
 
     function _checkAndGetInstance(
-        address registryAddress,
         NftId parentNftId,
         ObjectType componentType
     )
@@ -85,7 +142,7 @@ abstract contract InstanceLinkedComponent is
         returns (IInstance instance)
     {
         NftId instanceNftId;
-        IRegistry registry = IRegistry(registryAddress);
+        IRegistry registry = _getRegistry();
 
         if(componentType == PRODUCT()) {
             instanceNftId = parentNftId;
@@ -116,7 +173,7 @@ abstract contract InstanceLinkedComponent is
 
 
     function _getComponentInfo() internal virtual override view returns (IComponents.ComponentInfo memory info) {
-        NftId componentNftId = getRegistry().getNftIdForAddress(address(this));
+        NftId componentNftId = _getRegistry().getNftIdForAddress(address(this));
 
         // if registered, attempt to return component info via instance reader
         if (componentNftId.gtz()) {
@@ -138,10 +195,4 @@ abstract contract InstanceLinkedComponent is
     function _getInstanceReader() internal view returns (InstanceReader reader) {
         return _getInstanceLinkedComponentStorage()._instance.getInstanceReader();
     }
-
-    function _getInstanceLinkedComponentStorage() private pure returns (InstanceLinkedComponentStorage storage $) {
-        assembly {
-            $.slot := INSTANCE_LINKED_COMPONENT_LOCATION_V1
-        }
-    }
 }

package/contracts/shared/NftOwnable.sol

@@ -28,7 +28,7 @@ contract NftOwnable is
     }
 
     modifier onlyNftOwner(NftId nftId) {
-        if(!getRegistry().isOwnerOf(nftId, msg.sender)) {
+        if(!_getRegistry().isOwnerOf(nftId, msg.sender)) {
             revert ErrorNftOwnableNotOwner(msg.sender);
         }
         _;
@@ -37,7 +37,6 @@ contract NftOwnable is
     /// @dev Initialization for upgradable contracts.
     // used in __Registerable_init, ProxyManager.initialize
     function __NftOwnable_init(
-        address registry,
         address initialOwner
     )
         internal
@@ -45,7 +44,6 @@ contract NftOwnable is
         onlyInitializing()
     {
         __ERC165_init();
-        __RegistryLinked_init(registry);
 
         if(initialOwner == address(0)) {
             revert ErrorNftOwnableInitialOwnerZero();
@@ -75,7 +73,7 @@ contract NftOwnable is
         NftOwnableStorage storage $ = _getNftOwnableStorage();
 
         if ($._nftId.gtz()) {
-            return getRegistry().ownerOf($._nftId);
+            return _getRegistry().ownerOf($._nftId);
         }
 
         return $._initialOwner;
@@ -95,15 +93,17 @@ contract NftOwnable is
             revert ErrorNftOwnableAlreadyLinked($._nftId);
         }
 
-        if (!getRegistry().isRegistered(nftOwnableAddress)) {
+        NftId nftId = _getRegistry().getNftIdForAddress(nftOwnableAddress);
+
+        if (nftId.eqz()) {
             revert ErrorNftOwnableContractNotRegistered(nftOwnableAddress);
         }
 
-        $._nftId = getRegistry().getNftIdForAddress(nftOwnableAddress);
+        $._nftId = nftId;
 
-        emit LogNftOwnableNftLinkedToAddress($._nftId, getOwner());
+        emit LogNftOwnableNftLinkedToAddress(nftId, getOwner());
 
-        return $._nftId;
+        return nftId;
     }
 
 

package/contracts/shared/PolicyHolder.sol

@@ -24,13 +24,11 @@ contract PolicyHolder is
     // will need a release parameter to fetch the right service addresses for the modifiers
 
     function __PolicyHolder_init(
-        address registryAddress
     )
         internal
         virtual
         onlyInitializing()
     {
-        __RegistryLinked_init(registryAddress);
         _initializeERC165();
         _registerInterface(type(IPolicyHolder).interfaceId);
     }

package/contracts/shared/Registerable.sol

@@ -38,22 +38,22 @@ 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
+    // TODO and check the owner here?
     function _checkNftType(NftId nftId, ObjectType expectedObjectType) internal view {
-        if(expectedObjectType.eqz() || !getRegistry().isObjectType(nftId, expectedObjectType, getRelease())) {
-            revert ErrorNftOwnableInvalidType(nftId, expectedObjectType);
+        VersionPart expectedRelease = getRelease();
+        if(expectedObjectType.eqz() || !_getRegistry().isObjectType(nftId, expectedObjectType, expectedRelease)) {
+            revert ErrorRegisterableInvalidType(nftId, expectedObjectType, expectedRelease);
         }
     }
 
     function __Registerable_init(
         address authority,
-        address registry,
         NftId parentNftId,
         ObjectType objectType,
         bool isInterceptor,
@@ -68,11 +68,10 @@ 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);
+        __NftOwnable_init(initialOwner);
         __Versionable_init(release);
 
         RegisterableStorage storage $ = _getRegisterableStorage();

package/contracts/shared/RegistryLinked.sol

@@ -1,45 +1,19 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
 
 import {ContractLib} from "../shared/ContractLib.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryLinked} from "./IRegistryLinked.sol";
 
 contract RegistryLinked is
-    Initializable,
     IRegistryLinked
 {
-
-    // priorize simplicity and size over using standard upgradeability structs 
-    // registry address MUST NOT be upgraded
-    IRegistry private _registry;
-
-    /// @dev initialization for upgradable contracts
-    // used in RegistryAdmin / InstanceAdmin / ReleaseAdmin.completeSetup()
-    function __RegistryLinked_init(
-        address registry
-    )
-        internal
-        virtual
-    {
-        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);
-        }
-
-        _registry = IRegistry(registry);
+    function getRegistry() external pure returns (IRegistry) {
+        return ContractLib.getRegistry();
     }
 
-
-    function getRegistry() public view returns (IRegistry) {
-        return _registry;
+    function _getRegistry() internal pure returns (IRegistry) {
+        return ContractLib.getRegistry();
     }
 }

package/contracts/shared/Service.sol

@@ -24,7 +24,6 @@ abstract contract Service is
 
     function __Service_init(
         address authority, // real authority for registry service adress(0) for other services
-        address registry, 
         address initialOwner
     )
         internal
@@ -35,8 +34,7 @@ abstract contract Service is
 
         __Registerable_init(
             authority,
-            registry, 
-            IRegistry(registry).getNftId(), 
+            _getRegistry().getNftId(), 
             SERVICE(), 
             false, // is interceptor
             initialOwner, 
@@ -63,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/staking/Staking.sol

@@ -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);
         }
     }
@@ -718,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);
@@ -735,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(),
-            registryAddress, 
             registry.getNftId(), // parent nft id
             CONTRACT_NAME,
             STAKING(), 
@@ -771,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

@@ -15,7 +15,6 @@ contract StakingManager is
 
     /// @dev initializes proxy manager with service implementation 
     constructor(
-        address registry,
         address targetHandler,
         address stakingStore,
         address tokenRegistry,
@@ -27,13 +26,11 @@ contract StakingManager is
 
         _initialImplementation = address(stakingImplementation);
         _initializationData = abi.encode(
-            registry,
             targetHandler,
             stakingStore,
             tokenRegistry);
         
         IUpgradeable upgradeable = initialize(
-            registry,
             _initialImplementation,
             _initializationData,
             salt);

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);
     }