@etherisc/gif-next 0.0.2-8b116c2-371 → 0.0.2-8bc5066-981

package/contracts/oracle/Oracle.sol

@@ -1,18 +1,17 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {COMPONENT, ORACLE} from "../type/ObjectType.sol";
-import {IOracleService} from "./IOracleService.sol";
-import {NftId, NftIdLib} from "../type/NftId.sol";
-import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.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 {IRegistry} from "../registry/IRegistry.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
+import {IOracleService} from "./IOracleService.sol";
+import {NftId} from "../type/NftId.sol";
+import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.sol";
 import {RequestId} from "../type/RequestId.sol";
-import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
-import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
-import {UFixed} from "../type/UFixed.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 
 
 abstract contract Oracle is
@@ -28,38 +27,32 @@ abstract contract Oracle is
     }
 
 
-    function initializeOracle(
-        address registry,
-        NftId instanceNftId,
-        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 
+    function request(
+        RequestId requestId,
+        NftId requesterId,
+        bytes calldata requestData,
+        Timestamp expiryAt
     )
-        public
+        external
         virtual
-        onlyInitializing()
+        restricted()
     {
-        initializeInstanceLinkedComponent(registry, instanceNftId, name, token, ORACLE(), true, initialOwner, registryData, componentData);
-
-        OracleStorage storage $ = _getOracleStorage();
-        $._oracleService = IOracleService(_getServiceAddress(ORACLE())); 
-        $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
-
-        registerInterface(type(IOracleComponent).interfaceId);
+        _request(requestId, requesterId, requestData, expiryAt);
     }
 
 
-    function register()
+    function cancel(
+        RequestId requestId
+    )
         external
         virtual
-        onlyOwner()
+        restricted()
     {
-        _getOracleStorage()._componentService.registerOracle();
+        _cancel(requestId);
     }
 
 
+    /// @dev Not relevant for oracle components, always returns false.
     function isVerifying()
         external 
         virtual 
@@ -69,36 +62,54 @@ abstract contract Oracle is
         return false;
     }
 
-
-    function request(
-        RequestId requestId,
-        NftId requesterId,
-        bytes calldata requestData,
-        Timestamp expiryAt
-    )
+    /// @dev Not relevant for oracle components
+    function withdrawFees(Amount amount)
         external
         virtual
-        // restricted() // TODO enable: only oracle service
+        override(IInstanceLinkedComponent, InstanceLinkedComponent)
+        onlyOwner()
+        restricted()
+        returns (Amount withdrawnAmount)
     {
-        _request(requestId, requesterId, requestData, expiryAt);
+        revert ErrorOracleNotImplemented("withdrawFees");
     }
 
 
-    function cancel(
-        RequestId requestId
+    function _initializeOracle(
+        address registry,
+        NftId productNftId,
+        IAuthorization authorization,
+        address initialOwner,
+        string memory name,
+        address token,
+        bytes memory componentData // component specifidc data 
     )
-        external
+        internal
         virtual
-        // restricted() // TODO enable: only oracle service
+        onlyInitializing()
     {
-        _cancel(requestId);
+        _initializeInstanceLinkedComponent(
+            registry, 
+            productNftId, 
+            name, 
+            token, 
+            ORACLE(), 
+            authorization,
+            true, 
+            initialOwner, 
+            componentData);
+
+        OracleStorage storage $ = _getOracleStorage();
+        $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
+        $._oracleService = IOracleService(_getServiceAddress(ORACLE())); 
+
+        _registerInterface(type(IOracleComponent).interfaceId);
     }
 
 
-    /// @dev internal function for handling requests.
-    /// empty implementation.
-    /// overwrite this function to implement use case specific handling
-    /// for oracle calls.
+    /// @dev Internal function for handling requests.
+    /// Empty implementation.
+    /// Overwrite this function to implement use case specific handling for oracle calls.
     function _request(
         RequestId requestId,
         NftId requesterId,
@@ -111,9 +122,9 @@ abstract contract Oracle is
     }
 
 
-    /// @dev internal function for cancelling requests.
-    /// empty implementation.
-    /// overwrite this function to implement use case specific cancelling
+    /// @dev Internal function for cancelling requests.
+    /// Empty implementation.
+    /// Overwrite this function to implement use case specific cancelling.
     function _cancel(
         RequestId requestId
     )
@@ -123,9 +134,9 @@ abstract contract Oracle is
     }
 
 
-    /// @dev internal function for handling oracle responses.
-    /// use this function in use case specific external/public functions
-    /// to handle use case specific response handling.
+    /// @dev Internal function for handling oracle responses.
+    /// Default implementation sends response back to oracle service.
+    /// Use this function in use case specific external/public functions to handle use case specific response handling.
     function _respond(
         RequestId requestId,
         bytes memory responseData

package/contracts/oracle/OracleService.sol

@@ -11,7 +11,7 @@ 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 {StateId, ACTIVE, KEEP_STATE, FULFILLED, FAILED, CANCELLED} from "../type/StateId.sol";
 import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
@@ -27,18 +27,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 registryAddress,
+            address authority
+        ) = abi.decode(data, (address, address));
 
-    function getDomain() public pure override returns(ObjectType) {
-        return ORACLE();
+        _initializeService(registryAddress, authority, owner);
+        _registerInterface(type(IOracleService).interfaceId);
     }
 
     function request(
@@ -50,6 +48,7 @@ contract OracleService is
         external 
         virtual 
         // restricted() // add authz
+        onlyNftOfType(oracleNftId, ORACLE())
         returns (
             RequestId requestId
         ) 
@@ -68,35 +67,45 @@ contract OracleService is
             ORACLE(), 
             true); // only active
 
-        // check that requester and oracle share same instance
-        if (componentInfo.parentNftId != oracleInfo.parentNftId) {
-            revert ErrorOracleServiceInstanceMismatch(componentInfo.parentNftId, oracleInfo.parentNftId);
-        }
+        {
+            // check that requester and oracle share same product cluster
+            if (componentInfo.objectType == PRODUCT()) {
+                if (oracleInfo.parentNftId != componentInfo.nftId) {
+                    revert ErrorOracleServiceProductMismatch(componentInfo.objectType, componentInfo.nftId, oracleInfo.parentNftId);
+                }
+            } else {
+                if (oracleInfo.parentNftId != componentInfo.parentNftId) {
+                    revert ErrorOracleServiceProductMismatch(componentInfo.objectType, componentInfo.parentNftId, oracleInfo.parentNftId);
+                }
+            }
 
-        // check expiriyAt >= now
-        if (expiryAt < TimestampLib.blockTimestamp()) {
-            revert ErrorOracleServiceExpiryInThePast(TimestampLib.blockTimestamp(), expiryAt);
-        }
+            // check expiriyAt >= now
+            if (expiryAt < TimestampLib.blockTimestamp()) {
+                revert ErrorOracleServiceExpiryInThePast(TimestampLib.blockTimestamp(), expiryAt);
+            }
 
-        // check callbackMethodName.length > 0
-        if (bytes(callbackMethodName).length == 0) {
-            revert ErrorOracleServiceCallbackMethodNameEmpty();
+            // check callbackMethodName.length > 0
+            if (bytes(callbackMethodName).length == 0) {
+                revert ErrorOracleServiceCallbackMethodNameEmpty();
+            }
         }
 
-        // 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);
+        {
+            // 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);
+        }
 
         // call oracle component
         IOracleComponent(oracleInfo.objectAddress).request(
@@ -218,7 +227,7 @@ 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);
@@ -271,7 +280,12 @@ contract OracleService is
         returns(IInstance instance)
     {
         NftId instanceNftId = getRegistry().getObjectInfo(componentNftId).parentNftId;
-        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
+        address instanceAddress = getRegistry().getObjectAddress(instanceNftId);
         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(registry, authority);
+        IVersionable versionable = initialize(
+            registry,
+            address(svc), 
             data,
             salt);
 

package/contracts/pool/BasicPool.sol

@@ -0,0 +1,154 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Amount} from "../type/Amount.sol";
+import {Fee} from "../type/Fee.sol";
+import {IAuthorization} from "../authorization/IAuthorization.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 {Timestamp} from "../type/Timestamp.sol";
+
+import {Pool} from "./Pool.sol";
+
+abstract contract BasicPool is
+    Pool
+{
+
+    function _initializeBasicPool(
+        address registry,
+        NftId productNftId,
+        IAuthorization authorization,
+        address token,
+        string memory name,
+        address initialOwner
+    )
+        internal
+        virtual
+        onlyInitializing()
+    {
+        _initializePool(
+            registry, 
+            productNftId, 
+            name, 
+            token, 
+            authorization,
+            false, // isInterceptingNftTransfers, 
+            initialOwner, 
+            ""); // componentData
+    }
+
+    function stake(
+        NftId bundleNftId, 
+        Amount amount
+    )
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
+    {
+        _stake(bundleNftId, amount);
+    }
+
+
+    function unstake(
+        NftId bundleNftId, 
+        Amount amount
+    )
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
+    {
+        _unstake(bundleNftId, amount);
+    }
+
+
+    function extend(
+        NftId bundleNftId, 
+        Seconds lifetimeExtension
+    )
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
+        returns(Timestamp newExpiredAt)
+    {
+        return _extend(bundleNftId, lifetimeExtension);
+    }
+
+
+    function lockBundle(NftId bundleNftId)
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
+    {
+        _lockBundle(bundleNftId);
+    }
+
+
+    function unlockBundle(NftId bundleNftId)
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
+    {
+        _unlockBundle(bundleNftId);
+    }
+
+
+    function closeBundle(NftId bundleNftId)
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
+    {
+        _closeBundle(bundleNftId);
+    }
+
+
+    function setBundleFee(
+        NftId bundleNftId, 
+        Fee memory fee
+    )
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
+    {
+        _setBundleFee(bundleNftId, fee);
+    }
+
+
+    function setMaxBalanceAmount(Amount maxBalanceAmount)
+        public
+        virtual
+        restricted()
+        onlyOwner()
+    {
+        _setMaxBalanceAmount(maxBalanceAmount);
+    }
+
+
+    function setFees(
+        Fee memory poolFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    )
+        public
+        virtual
+        restricted()
+        onlyOwner()
+    {
+        _setPoolFees(poolFee, stakingFee, performanceFee);
+    }
+}

package/contracts/pool/BasicPoolAuthorization.sol

@@ -0,0 +1,57 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Authorization} from "../authorization/Authorization.sol";
+import {BasicPool} from "./BasicPool.sol"; 
+import {IAccess} from "../authorization/IAccess.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+import {IPoolComponent} from "./IPoolComponent.sol";
+import {POOL} from "../type/ObjectType.sol";
+import {PUBLIC_ROLE} from "../../contracts/type/RoleId.sol";
+import {RoleId} from "../type/RoleId.sol";
+
+
+contract BasicPoolAuthorization
+     is Authorization
+{
+
+     constructor(string memory poolName)
+          Authorization(poolName)
+     {}
+
+     function _setupTargets()
+          internal
+          virtual override
+     {
+          _addComponentTargetWithRole(POOL()); // basic pool target
+     }
+
+
+     function _setupTargetAuthorizations()
+          internal
+          virtual override
+     {
+          IAccess.FunctionInfo[] storage functions;
+
+          // authorize public role (open access to any account, only allows to lock target)
+          functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
+          _authorize(functions, BasicPool.stake.selector, "stake");
+          _authorize(functions, BasicPool.unstake.selector, "unstake");
+          _authorize(functions, BasicPool.extend.selector, "extend");
+          _authorize(functions, BasicPool.lockBundle.selector, "lockBundle");
+          _authorize(functions, BasicPool.unlockBundle.selector, "unlockBundle");
+          _authorize(functions, BasicPool.closeBundle.selector, "closeBundle");
+          _authorize(functions, BasicPool.setBundleFee.selector, "setBundleFee");
+
+          _authorize(functions, BasicPool.setMaxBalanceAmount.selector, "setMaxBalanceAmount");
+          _authorize(functions, BasicPool.setFees.selector, "setFees");
+          _authorize(functions, BasicPool.stake.selector, "stake");
+          _authorize(functions, BasicPool.unstake.selector, "unstake");
+          _authorize(functions, BasicPool.extend.selector, "extend");
+
+          _authorize(functions, IInstanceLinkedComponent.withdrawFees.selector, "withdrawFees");
+
+          _authorize(functions, IPoolComponent.withdrawBundleFees.selector, "withdrawBundleFees");
+     }
+}
+