@etherisc/gif-next 0.0.2-e026265-044 → 0.0.2-e04dbfc-031

package/contracts/oracle/Oracle.sol

@@ -1,19 +1,17 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {COMPONENT, ORACLE} from "../type/ObjectType.sol";
+import {Amount} from "../type/Amount.sol";
+import {COMPONENT, PRODUCT, ORACLE} from "../type/ObjectType.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IComponentService} from "../shared/IComponentService.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 import {IOracleComponent} from "./IOracleComponent.sol";
 import {IOracleService} from "./IOracleService.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
-import {NftId, NftIdLib} from "../type/NftId.sol";
+import {NftId} from "../type/NftId.sol";
 import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
 import {RequestId} from "../type/RequestId.sol";
-import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
-import {UFixed} from "../type/UFixed.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 
 
 abstract contract Oracle is
@@ -29,15 +27,6 @@ abstract contract Oracle is
     }
 
 
-    function register()
-        external
-        virtual
-        onlyOwner()
-    {
-        _getOracleStorage()._componentService.registerOracle();
-    }
-
-
     function request(
         RequestId requestId,
         NftId requesterId,
@@ -73,15 +62,26 @@ abstract contract Oracle is
         return false;
     }
 
+    /// @dev Not relevant for oracle components
+    function withdrawFees(Amount amount)
+        external
+        virtual
+        override(IInstanceLinkedComponent, InstanceLinkedComponent)
+        onlyOwner()
+        restricted()
+        returns (Amount)
+    {
+        revert ErrorOracleNotImplemented("withdrawFees");
+    }
+
 
     function _initializeOracle(
         address registry,
-        NftId instanceNftId,
+        NftId productNftId,
         IAuthorization authorization,
         address initialOwner,
         string memory name,
         address token,
-        bytes memory registryData, // writeonly data that will saved in the object info record of the registry
         bytes memory componentData // component specifidc data 
     )
         internal
@@ -90,21 +90,20 @@ abstract contract Oracle is
     {
         _initializeInstanceLinkedComponent(
             registry, 
-            instanceNftId, 
+            productNftId, 
             name, 
             token, 
             ORACLE(), 
             authorization,
             true, 
             initialOwner, 
-            registryData, 
             componentData);
 
         OracleStorage storage $ = _getOracleStorage();
-        $._oracleService = IOracleService(_getServiceAddress(ORACLE())); 
         $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
+        $._oracleService = IOracleService(_getServiceAddress(ORACLE())); 
 
-        registerInterface(type(IOracleComponent).interfaceId);
+        _registerInterface(type(IOracleComponent).interfaceId);
     }
 
 

package/contracts/oracle/OracleService.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
+import {ContractLib} from "../shared/ContractLib.sol";
 import {IComponent} from "../shared/IComponent.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {IInstanceService} from "../instance/IInstanceService.sol";
@@ -11,14 +11,15 @@ import {IOracleComponent} from "./IOracleComponent.sol";
 import {IOracleService} from "./IOracleService.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, COMPONENT, ORACLE, INSTANCE} from "../type/ObjectType.sol";
+import {ObjectType, COMPONENT, ORACLE, PRODUCT} from "../type/ObjectType.sol";
 import {RequestId} from "../type/RequestId.sol";
+import {Service} from "../shared/Service.sol";
 import {StateId, ACTIVE, KEEP_STATE, FULFILLED, FAILED, CANCELLED} from "../type/StateId.sol";
 import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
 
 
 contract OracleService is
-    ComponentVerifyingService,
+    Service,
     IOracleService
 {
 
@@ -27,14 +28,16 @@ contract OracleService is
         bytes memory data
     )
         internal
-        initializer
         virtual override
+        initializer()
     {
-        address initialOwner;
-        address registryAddress;
-        (registryAddress, initialOwner) = abi.decode(data, (address, address));
-        initializeService(registryAddress, address(0), owner);
-        registerInterface(type(IOracleService).interfaceId);
+        (
+            address authority,
+            address registry
+        ) = abi.decode(data, (address, address));
+
+        __Service_init(authority, registry, owner);
+        _registerInterface(type(IOracleService).interfaceId);
     }
 
     function request(
@@ -45,63 +48,51 @@ contract OracleService is
     )
         external 
         virtual 
-        // restricted() // add authz
-        returns (
-            RequestId requestId
-        ) 
+        restricted()
+        onlyNftOfType(oracleNftId, ORACLE())
+        returns (RequestId requestId) 
     {
+        // checks
+        // get and check active caller
         (
-            NftId componentNftId,
-            IRegistry.ObjectInfo memory componentInfo, 
-            IInstance instance
-        ) = _getAndVerifyActiveComponent(COMPONENT());
+            IRegistry.ObjectInfo memory requesterInfo, 
+            address instance
+        ) = ContractLib.getAndVerifyAnyComponent(
+            getRegistry(), msg.sender, true);
 
-        // oracleNftId exists and is active oracle
         (
-            IRegistry.ObjectInfo memory oracleInfo, 
-        ) = _getAndVerifyComponentInfo(
-            oracleNftId, 
-            ORACLE(), 
-            true); // only active
-
-        // check that requester and oracle share same instance
-        if (componentInfo.parentNftId != oracleInfo.parentNftId) {
-            revert ErrorOracleServiceInstanceMismatch(componentInfo.parentNftId, oracleInfo.parentNftId);
-        }
-
-        // check expiriyAt >= now
-        if (expiryAt < TimestampLib.blockTimestamp()) {
-            revert ErrorOracleServiceExpiryInThePast(TimestampLib.blockTimestamp(), expiryAt);
-        }
-
-        // check callbackMethodName.length > 0
-        if (bytes(callbackMethodName).length == 0) {
-            revert ErrorOracleServiceCallbackMethodNameEmpty();
+            NftId requesterNftId,
+            IOracleComponent oracle
+        ) = _checkRequestParams(
+            getRegistry(), oracleNftId, requesterInfo, expiryAt, callbackMethodName);
+
+        // effects
+        {
+            // create request info
+            IOracle.RequestInfo memory request = IOracle.RequestInfo({
+                requesterNftId: requesterNftId,
+                callbackMethodName: callbackMethodName,
+                oracleNftId: oracleNftId,
+                requestData: requestData,
+                responseData: "",
+                respondedAt: TimestampLib.zero(),
+                expiredAt: expiryAt,
+                isCancelled: false
+            });
+
+            // store request with instance
+            requestId = IInstance(instance).getInstanceStore().createRequest(request);
         }
 
-        // create request info
-        IOracle.RequestInfo memory request = IOracle.RequestInfo({
-            requesterNftId: componentNftId,
-            callbackMethodName: callbackMethodName,
-            oracleNftId: oracleNftId,
-            requestData: requestData,
-            responseData: "",
-            respondedAt: TimestampLib.zero(),
-            expiredAt: expiryAt,
-            isCancelled: false
-        });
-
-        // store request with instance
-        requestId = instance.getInstanceStore().createRequest(request);
+        emit LogOracleServiceRequestCreated(requestId, requesterNftId, oracleNftId, expiryAt);
 
-        // call oracle component
-        IOracleComponent(oracleInfo.objectAddress).request(
+        // interactions
+        // callback to oracle component
+        oracle.request(
             requestId, 
-            componentNftId, 
+            requesterNftId, 
             requestData, 
             expiryAt);
-
-        emit LogOracleServiceRequestCreated(requestId, componentNftId, oracleNftId, expiryAt);
     }
 
 
@@ -113,15 +104,17 @@ contract OracleService is
     )
         external
         virtual
-        // restricted() // add authz
+        restricted()
         returns (bool success)
     {
         (
-            NftId oracleNftId,
-            IRegistry.ObjectInfo memory componentInfo, 
-            IInstance instance
-        ) = _getAndVerifyActiveComponent(ORACLE());
+            IRegistry.ObjectInfo memory info, 
+            address instanceAddress
+        ) = ContractLib.getAndVerifyComponent(
+            getRegistry(), msg.sender, ORACLE(), true);
 
+        NftId oracleNftId = info.nftId;
+        IInstance instance = IInstance(instanceAddress);
         bool callerIsOracle = true;
         IOracle.RequestInfo memory request = _checkAndGetRequestInfo(instance, requestId, oracleNftId, callerIsOracle);
         request.responseData = responseData;
@@ -160,14 +153,16 @@ contract OracleService is
     function resend(RequestId requestId)
         external 
         virtual 
-        // restricted() // add authz
+        restricted()
     {
         (
-            NftId requesterNftId,
-            IRegistry.ObjectInfo memory requesterInfo, 
-            IInstance instance
-        ) = _getAndVerifyActiveComponent(COMPONENT());
+            IRegistry.ObjectInfo memory info, 
+            address instanceAddress
+        ) = ContractLib.getAndVerifyAnyComponent(
+            getRegistry(), msg.sender, true);
 
+        NftId requesterNftId = info.nftId;
+        IInstance instance = IInstance(instanceAddress);
         bool callerIsOracle = false;
         IOracle.RequestInfo memory request = _checkAndGetRequestInfo(instance, requestId, requesterNftId, callerIsOracle);
 
@@ -178,7 +173,7 @@ contract OracleService is
                 "(uint64,bytes)"
             ));
 
-        (bool success, bytes memory returnData) = requesterInfo.objectAddress.call(
+        (bool success, bytes memory returnData) = info.objectAddress.call(
             abi.encodeWithSignature(
                 functionSignature, 
                 requestId,
@@ -189,7 +184,7 @@ contract OracleService is
             instance.getInstanceStore().updateRequestState(requestId, FULFILLED());
             emit LogOracleServiceResponseResent(requestId, requesterNftId);
         } else {
-            emit LogOracleServiceDeliveryFailed(requestId, requesterInfo.objectAddress, functionSignature);
+            emit LogOracleServiceDeliveryFailed(requestId, info.objectAddress, functionSignature);
         }
     }
 
@@ -197,14 +192,16 @@ contract OracleService is
     function cancel(RequestId requestId)
         external 
         virtual 
-        // restricted() // add authz
+        restricted()
     {
         (
-            NftId requesterNftId,
-            IRegistry.ObjectInfo memory componentInfo, 
-            IInstance instance
-        ) = _getAndVerifyActiveComponent(COMPONENT());
+            IRegistry.ObjectInfo memory info, 
+            address instanceAddress
+        ) = ContractLib.getAndVerifyAnyComponent(
+            getRegistry(), msg.sender, true);
 
+        NftId requesterNftId = info.nftId;
+        IInstance instance = IInstance(instanceAddress);
         bool callerIsOracle = false;
         // TODO property isCancelled and state update to CANCELLED are redundant, get rid of isCancelled
         IOracle.RequestInfo memory request = _checkAndGetRequestInfo(instance, requestId, requesterNftId, callerIsOracle);
@@ -214,13 +211,59 @@ contract OracleService is
 
         // call oracle component
         // TODO add check that oracle is active?
-        address oracleAddress = getRegistry().getObjectInfo(request.oracleNftId).objectAddress;
+        address oracleAddress = getRegistry().getObjectAddress(request.oracleNftId);
         IOracleComponent(oracleAddress).cancel(requestId);
 
         emit LogOracleServiceRequestCancelled(requestId, requesterNftId);
     }
 
 
+    function _checkRequestParams(
+        IRegistry registry,
+        NftId oracleNftId,
+        IRegistry.ObjectInfo memory requesterInfo,
+        Timestamp expiryAt,
+        string memory callbackMethodName
+    )
+        internal
+        virtual
+        view
+        returns (
+            NftId requesterNftId,
+            IOracleComponent oracle
+        )
+    {
+        // get oracle info
+        (IRegistry.ObjectInfo memory oracleInfo,) = ContractLib.getInfoAndInstance(
+            registry, oracleNftId, true);
+
+        // obtain return values
+        requesterNftId = requesterInfo.nftId;
+        oracle = IOracleComponent(oracleInfo.objectAddress);
+
+        // check that requester and oracle share same product cluster
+        if (requesterInfo.objectType == PRODUCT()) {
+            if (oracleInfo.parentNftId != requesterNftId) {
+                revert ErrorOracleServiceProductMismatch(requesterInfo.objectType, requesterNftId, oracleInfo.parentNftId);
+            }
+        } else {
+            if (oracleInfo.parentNftId != requesterInfo.parentNftId) {
+                revert ErrorOracleServiceProductMismatch(requesterInfo.objectType, requesterInfo.parentNftId, oracleInfo.parentNftId);
+            }
+        }
+
+        // check expiriyAt >= now
+        if (expiryAt < TimestampLib.blockTimestamp()) {
+            revert ErrorOracleServiceExpiryInThePast(TimestampLib.blockTimestamp(), expiryAt);
+        }
+
+        // check callbackMethodName.length > 0
+        if (bytes(callbackMethodName).length == 0) {
+            revert ErrorOracleServiceCallbackMethodNameEmpty();
+        }
+    }
+
+
     function _checkAndGetRequestInfo(
         IInstance instance,
         RequestId requestId,
@@ -261,17 +304,6 @@ contract OracleService is
     }
 
 
-    function _getInstanceForComponent(NftId componentNftId)
-        internal
-        view
-        returns(IInstance instance)
-    {
-        NftId instanceNftId = getRegistry().getObjectInfo(componentNftId).parentNftId;
-        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
-        return IInstance(instanceAddress);
-    }
-
-
     function _getDomain() internal pure override returns(ObjectType) {
         return ORACLE();
     }

package/contracts/oracle/OracleServiceManager.sol

@@ -1,12 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {OracleService} from "./OracleService.sol";
-import {Registry} from "../registry/Registry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
-import {REGISTRY} from "../type/ObjectType.sol";
 
 contract OracleServiceManager is ProxyManager {
 
@@ -15,15 +12,15 @@ contract OracleServiceManager is ProxyManager {
     /// @dev initializes proxy manager with service implementation and deploys instance
     constructor(
         address authority, 
-        address registryAddress,
+        address registry,
         bytes32 salt
     ) 
-        ProxyManager(registryAddress)
     {
-        OracleService orclSrv = new OracleService{salt: salt}();
-        bytes memory data = abi.encode(registryAddress, address(this), authority);
-        IVersionable versionable = deployDetermenistic(
-            address(orclSrv), 
+        OracleService svc = new OracleService{salt: salt}();
+        bytes memory data = abi.encode(authority, registry);
+        IVersionable versionable = initialize(
+            registry,
+            address(svc), 
             data,
             salt);
 

package/contracts/pool/BasicPool.sol

@@ -1,21 +1,15 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount, AmountLib} from "../type/Amount.sol";
-import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.sol";
-import {Fee, FeeLib} from "../type/Fee.sol";
+import {Amount} from "../type/Amount.sol";
+import {Fee} from "../type/Fee.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
-import {IBundleService} from "./IBundleService.sol";
-import {IPoolComponent} from "./IPoolComponent.sol";
-import {IPoolService} from "./IPoolService.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
-import {IComponentService} from "../shared/IComponentService.sol";
-import {NftId, NftIdLib} from "../type/NftId.sol";
-import {BUNDLE, COMPONENT, POOL} from "../type/ObjectType.sol";
-import {RoleId, PUBLIC_ROLE} from "../type/RoleId.sol";
+import {NftId} from "../type/NftId.sol";
+import {BUNDLE} from "../type/ObjectType.sol";
+import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
-import {UFixed, UFixedLib} from "../type/UFixed.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 
 import {Pool} from "./Pool.sol";
 
@@ -25,10 +19,11 @@ abstract contract BasicPool is
 
     function _initializeBasicPool(
         address registry,
-        NftId instanceNftId,
-        IAuthorization authorization,
-        address token,
+        NftId productNftId,
         string memory name,
+        address token,
+        IComponents.PoolInfo memory poolInfo,
+        IAuthorization authorization,
         address initialOwner
     )
         internal
@@ -37,13 +32,12 @@ abstract contract BasicPool is
     {
         _initializePool(
             registry, 
-            instanceNftId, 
+            productNftId, 
             name, 
             token, 
+            poolInfo, 
             authorization,
-            false, // isInterceptingNftTransfers, 
             initialOwner, 
-            "", // registryData
             ""); // componentData
     }
 
@@ -55,6 +49,7 @@ abstract contract BasicPool is
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
     {
         _stake(bundleNftId, amount);
     }
@@ -68,6 +63,7 @@ abstract contract BasicPool is
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
     {
         _unstake(bundleNftId, amount);
     }
@@ -81,8 +77,10 @@ abstract contract BasicPool is
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
+        returns(Timestamp newExpiredAt)
     {
-        _extend(bundleNftId, lifetimeExtension);
+        return _extend(bundleNftId, lifetimeExtension);
     }
 
 
@@ -91,6 +89,7 @@ abstract contract BasicPool is
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
     {
         _lockBundle(bundleNftId);
     }
@@ -101,21 +100,26 @@ abstract contract BasicPool is
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
     {
         _unlockBundle(bundleNftId);
     }
 
 
-    function close(NftId bundleNftId)
+    function closeBundle(NftId bundleNftId)
         public
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
     {
-        _close(bundleNftId);
+        _closeBundle(bundleNftId);
     }
 
 
+    /// @dev Updates the bundle feeds to the specified values.
+    /// @param bundleNftId the bundle Nft Id
+    /// @param fee the new fee values
     function setBundleFee(
         NftId bundleNftId, 
         Fee memory fee
@@ -124,28 +128,35 @@ abstract contract BasicPool is
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
     {
         _setBundleFee(bundleNftId, fee);
     }
 
 
-    function setMaxCapitalAmount(Amount maxCapitalAmount)
-        public
+    /// @dev Withdraw bundle feeds for the given bundle.
+    /// @param bundleNftId the bundle Nft Id
+    /// @param amount the amount to withdraw. If set to AMOUNT_MAX, the full commission available is withdrawn
+    /// @return withdrawnAmount the effective withdrawn amount
+    function withdrawBundleFees(NftId bundleNftId, Amount amount) 
+        external 
         virtual
         restricted()
-        onlyOwner()
+        onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
+        returns (Amount withdrawnAmount) 
     {
-        _setMaxCapitalAmount(maxCapitalAmount);
+        return _withdrawBundleFees(bundleNftId, amount);
     }
 
 
-    function setBundleOwnerRole(RoleId bundleOwnerRole)
+    function setMaxBalanceAmount(Amount maxBalanceAmount)
         public
         virtual
         restricted()
         onlyOwner()
     {
-        _setBundleOwnerRole(bundleOwnerRole);
+        _setMaxBalanceAmount(maxBalanceAmount);
     }