@etherisc/gif-next 3.0.0-2e16ebd-614 → 3.0.0-303db9f-884

package/contracts/instance/InstanceService.sol

@@ -22,6 +22,7 @@ import {InstanceStore} from "./InstanceStore.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType, INSTANCE, COMPONENT, INSTANCE, REGISTRY, STAKING} from "../type/ObjectType.sol";
 import {ProductStore} from "./ProductStore.sol";
+import {RequestSet} from "./RequestSet.sol";
 import {RiskSet} from "./RiskSet.sol";
 import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
@@ -49,6 +50,7 @@ contract InstanceService is
     address internal _masterInstanceReader;
     address internal _masterInstanceBundleSet;
     address internal _masterInstanceRiskSet;
+    address internal _masterInstanceRequestSet;
     address internal _masterInstanceStore;
     address internal _masterProductStore;
 
@@ -175,7 +177,7 @@ contract InstanceService is
         IInstance(instanceAddress).getInstanceAdmin().setInstanceLocked(locked);
 
         emit LogInstanceServiceInstanceLocked(
-            _getRegistry().getNftIdForAddress(instanceAddress),
+            getRegistry().getNftIdForAddress(instanceAddress),
             locked);
     }
 
@@ -204,11 +206,13 @@ contract InstanceService is
         // MUST be set after instance is set up and registered
         IAuthorization instanceAuthorization = InstanceAdmin(_masterInstanceAdmin).getInstanceAuthorization();
         instanceAdmin.completeSetup(
+            address(getRegistry()),
             address(instanceAuthorization),
+            getRelease(),
             address(instance));
 
         // hard checks for newly cloned instance
-        //assert(address(instance._getRegistry()) == address(_getRegistry()));// consider deleting this
+        assert(address(instance.getRegistry()) == address(getRegistry()));
         assert(instance.getRelease() == getRelease());
 
         // register cloned instance as staking target
@@ -229,7 +233,7 @@ contract InstanceService is
         restricted()
         onlyInstance()
     {
-        NftId instanceNftId = _getRegistry().getNftIdForAddress(msg.sender);
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
         _stakingService.setInstanceLockingPeriod(
             instanceNftId,
             stakeLockingPeriod);
@@ -242,7 +246,7 @@ contract InstanceService is
         restricted()
         onlyInstance()
     {
-        NftId instanceNftId = _getRegistry().getNftIdForAddress(msg.sender);
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
         _stakingService.setInstanceRewardRate(
             instanceNftId,
             rewardRate);
@@ -254,7 +258,7 @@ contract InstanceService is
         restricted()
         onlyInstance()
     {
-        NftId instanceNftId = _getRegistry().getNftIdForAddress(msg.sender);
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
         _stakingService.setInstanceMaxStakedAmount(
             instanceNftId,
             maxStakedAmount);
@@ -268,7 +272,7 @@ contract InstanceService is
         onlyInstance()
         returns (Amount newBalance)
     {
-        NftId instanceNftId = _getRegistry().getNftIdForAddress(msg.sender);
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
         newBalance = _stakingService.refillInstanceRewardReserves(
             instanceNftId,
             rewardProvider,
@@ -283,7 +287,7 @@ contract InstanceService is
         onlyInstance()
         returns (Amount newBalance)
     {
-        NftId instanceNftId = _getRegistry().getNftIdForAddress(msg.sender);
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
         newBalance = _stakingService.withdrawInstanceRewardReserves(
             instanceNftId,
             dipAmount);
@@ -306,7 +310,7 @@ contract InstanceService is
         instance.setInstanceReader(upgradedInstanceReaderClone);
 
         emit LogInstanceServiceInstanceReaderUpgraded(
-            _getRegistry().getNftIdForAddress(instanceAddress),
+            getRegistry().getNftIdForAddress(instanceAddress),
             address(upgradedInstanceReaderClone));
     }
 
@@ -321,56 +325,80 @@ contract InstanceService is
         if(_masterInstanceAdmin != address(0)) { revert ErrorInstanceServiceMasterInstanceAdminAlreadySet(); }
         if(_masterInstanceBundleSet != address(0)) { revert ErrorInstanceServiceMasterBundleSetAlreadySet(); }
         if(_masterInstanceRiskSet != address(0)) { revert ErrorInstanceServiceMasterRiskSetAlreadySet(); }
+        if(_masterInstanceRequestSet != address(0)) { revert ErrorInstanceServiceMasterRequestSetAlreadySet(); }
         if(instanceAddress == address(0)) { revert ErrorInstanceServiceInstanceAddressZero(); }
 
         {
             IInstance instance = IInstance(instanceAddress);
             address accessManagerAddress = instance.authority();
             InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
-            address instanceAdminAddress = address(instanceAdmin);
-            InstanceReader instanceReader = instance.getInstanceReader();
-            address instanceReaderAddress = address(instanceReader);
-            BundleSet bundleSet = instance.getBundleSet();
-            address bundleSetAddress = address(bundleSet);
-            RiskSet riskSet = instance.getRiskSet();
-            address riskSetAddress = address(riskSet);
-            InstanceStore instanceStore = instance.getInstanceStore();
-            address instanceStoreAddress = address(instanceStore);
-            ProductStore productStore = instance.getProductStore();
-            address productStoreAddress = address(productStore);
-
-            if(accessManagerAddress == address(0)) { revert ErrorInstanceServiceAccessManagerZero(); }
-            if(instanceAdminAddress == address(0)) { revert ErrorInstanceServiceInstanceAdminZero(); }
-            if(instanceReaderAddress == address(0)) { revert ErrorInstanceServiceInstanceReaderZero(); }
-            if(bundleSetAddress == address(0)) { revert ErrorInstanceServiceBundleSetZero(); }
-            if(riskSetAddress == address(0)) { revert ErrorInstanceServiceRiskSetZero(); }
-            if(instanceStoreAddress == address(0)) { revert ErrorInstanceServiceInstanceStoreZero(); }
-            if(productStoreAddress == address(0)) { revert ErrorInstanceServiceProductStoreZero(); } // TODO: rename exception
             
-            // TODO check instance cluster release
-            if(instance.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceInstanceAuthorityMismatch(); }
-            if(bundleSet.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceBundleSetAuthorityMismatch(); }
-            if(riskSet.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceRiskSetAuthorityMismatch(); }
-            if(instanceStore.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceInstanceStoreAuthorityMismatch(); }
-            if(productStore.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceProductStoreAuthorityMismatch(); } 
-            if(bundleSet.getInstanceAddress() != address(instance)) { revert ErrorInstanceServiceBundleSetInstanceMismatch(); }
-            if(riskSet.getInstanceAddress() != address(instance)) { revert ErrorInstanceServiceRiskSetInstanceMismatch(); }
-            if(instanceReader.getInstance() != instance) { revert ErrorInstanceServiceInstanceReaderInstanceMismatch2(); }
-
-            _masterAccessManager = accessManagerAddress;
-            _masterInstanceAdmin = instanceAdminAddress;
-            _masterInstance = instanceAddress;
-            _masterInstanceReader = instanceReaderAddress;
-            _masterInstanceBundleSet = bundleSetAddress;
-            _masterInstanceRiskSet = riskSetAddress;
-            _masterInstanceStore = instanceStoreAddress;
-            _masterProductStore = productStoreAddress;
+            {
+                address instanceAdminAddress = address(instanceAdmin);
+                InstanceReader instanceReader = instance.getInstanceReader();
+                address instanceReaderAddress = address(instanceReader);
+
+                if(accessManagerAddress == address(0)) { revert ErrorInstanceServiceAccessManagerZero(); }
+                if(instanceAdminAddress == address(0)) { revert ErrorInstanceServiceInstanceAdminZero(); }
+                if(instanceReaderAddress == address(0)) { revert ErrorInstanceServiceInstanceReaderZero(); }
+
+                if(instance.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceInstanceAuthorityMismatch(); }
+                if(instanceReader.getInstance() != instance) { revert ErrorInstanceServiceInstanceReaderInstanceMismatch2(); }
+        
+                _masterAccessManager = accessManagerAddress;
+                _masterInstanceAdmin = instanceAdminAddress;
+                _masterInstance = instanceAddress;
+                _masterInstanceReader = instanceReaderAddress;
+            }
+
+            {
+                BundleSet bundleSet = instance.getBundleSet();
+                address bundleSetAddress = address(bundleSet);
+                RiskSet riskSet = instance.getRiskSet();
+                address riskSetAddress = address(riskSet);
+                RequestSet requestSet = instance.getRequestSet();
+                address requestSetAddress = address(requestSet);
+            
+                if(bundleSetAddress == address(0)) { revert ErrorInstanceServiceBundleSetZero(); }
+                if(riskSetAddress == address(0)) { revert ErrorInstanceServiceRiskSetZero(); }
+                if(requestSetAddress == address(0)) { revert ErrorInstanceServiceRequestSetZero(); }
+                if(bundleSet.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceBundleSetAuthorityMismatch(); }
+                if(riskSet.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceRiskSetAuthorityMismatch(); }
+                if(requestSet.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceRequestSetAuthorityMismatch(); }
+                if(bundleSet.getInstanceAddress() != address(instance)) { revert ErrorInstanceServiceBundleSetInstanceMismatch(); }
+                if(riskSet.getInstanceAddress() != address(instance)) { revert ErrorInstanceServiceRiskSetInstanceMismatch(); }
+                if(requestSet.getInstanceAddress() != address(instance)) { revert ErrorInstanceServiceRequestSetInstanceMismatch(); }
+
+                _masterInstanceBundleSet = bundleSetAddress;
+                _masterInstanceRiskSet = riskSetAddress;
+                _masterInstanceRequestSet = requestSetAddress;
+            }
+
+            {
+                InstanceStore instanceStore = instance.getInstanceStore();
+                address instanceStoreAddress = address(instanceStore);
+                ProductStore productStore = instance.getProductStore();
+                address productStoreAddress = address(productStore);
+
+                if(instanceStoreAddress == address(0)) { revert ErrorInstanceServiceInstanceStoreZero(); }
+                if(productStoreAddress == address(0)) { revert ErrorInstanceServiceProductStoreZero(); } // TODO: rename exception
+                
+                if(instanceStore.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceInstanceStoreAuthorityMismatch(); }
+                if(productStore.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceProductStoreAuthorityMismatch(); } 
+                
+                _masterInstanceStore = instanceStoreAddress;
+                _masterProductStore = productStoreAddress;
+            }
         }
         
         {
             IInstance masterInstance = IInstance(_masterInstance);
             IRegistry.ObjectInfo memory info = _registryService.registerInstance(masterInstance, getOwner());
             masterInstanceNftId = info.nftId;
+            
+            emit LogInstanceServiceMasterInstanceRegistered(
+                masterInstanceNftId, _masterInstance, _masterInstanceAdmin, _masterAccessManager, 
+                _masterInstanceReader, _masterInstanceBundleSet, _masterInstanceRiskSet, _masterInstanceRequestSet, _masterInstanceStore, _masterProductStore);
         }
     }
 
@@ -390,7 +418,7 @@ contract InstanceService is
         _masterInstanceReader = instanceReaderAddress;
 
         emit LogInstanceServiceMasterInstanceReaderUpgraded(
-            _getRegistry().getNftIdForAddress(_masterInstance),
+            getRegistry().getNftIdForAddress(_masterInstance),
             instanceReaderAddress);
     }
 
@@ -418,8 +446,7 @@ contract InstanceService is
 
         clonedAdmin.initialize(
             address(clonedAccessManager),
-            "InstanceAdmin",
-            getRelease());
+            "InstanceAdmin");
     }
 
 
@@ -443,8 +470,11 @@ contract InstanceService is
                 productStore: ProductStore(Clones.clone(address(_masterProductStore))),
                 bundleSet: BundleSet(Clones.clone(_masterInstanceBundleSet)),
                 riskSet: RiskSet(Clones.clone(_masterInstanceRiskSet)),
+                requestSet: RequestSet(Clones.clone(address(_masterInstanceRequestSet))),
                 instanceReader: InstanceReader(Clones.clone(address(_masterInstanceReader)))
             }),
+            getRegistry(),
+            getRelease(),
             instanceOwner,
             allowAnyToken);
 
@@ -459,13 +489,14 @@ contract InstanceService is
     )
         internal
         virtual override
-        onlyInitializing()
+        initializer()
     {
         (
-            address authority
-        ) = abi.decode(data, (address));
+            address authority,
+            address registry
+        ) = abi.decode(data, (address, address));
 
-        __Service_init(authority, owner);
+        __Service_init(authority, registry, owner);
 
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
         _stakingService = IStakingService(_getServiceAddress(STAKING()));
@@ -483,8 +514,7 @@ contract InstanceService is
         virtual
         view
     {
-        // TODO use ContractLib to verify registration, type and release
-        IRegistry registry = _getRegistry();
+        IRegistry registry = getRegistry();
 
         NftId instanceNftId = registry.getNftIdForAddress(instanceAddress);
         if (instanceNftId.eqz()) {

package/contracts/instance/InstanceServiceManager.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 {InstanceService} from "./InstanceService.sol";
 
@@ -12,17 +12,19 @@ contract InstanceServiceManager is ProxyManager {
     /// @dev initializes proxy manager with instance service implementation
     constructor(
         address authority, 
+        address registry,
         bytes32 salt
     ) 
     {
         InstanceService svc = new InstanceService{salt: salt}();
-        bytes memory data = abi.encode(authority);
-        IUpgradeable upgradeable = initialize(
+        bytes memory data = abi.encode(authority, registry);
+        IVersionable versionable = initialize(
+            registry,
             address(svc), 
             data,
             salt);
 
-        _instanceService = InstanceService(address(upgradeable));
+        _instanceService = InstanceService(address(versionable));
     }
 
     //--- view functions ----------------------------------------------------//

package/contracts/instance/RequestSet.sol

@@ -0,0 +1,63 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IComponents} from "./module/IComponents.sol";
+
+import {Key32} from "../type/Key32.sol";
+import {LibNftIdSet} from "../type/NftIdSet.sol";
+import {LibRequestIdSet} from "../type/RequestIdSet.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectSet} from "./base/ObjectSet.sol";
+import {ObjectSetHelperLib} from "./base/ObjectSetHelperLib.sol";
+import {RequestId, RequestIdLib} from "../type/RequestId.sol";
+
+contract RequestSet is 
+    ObjectSet
+{
+    using LibNftIdSet for LibNftIdSet.Set;
+    using LibRequestIdSet for LibRequestIdSet.Set;
+
+    event LogRequestSetRequestAdded(NftId indexed oracleNftId, RequestId indexed requestId);
+    event LogRequestSetRequestRemoved(NftId indexed oracleNftId, RequestId indexed requestId);
+
+    error ErrorRequestSetOracleNotRegistered(NftId oracleNftId);
+
+    /// @dev add a new request to a oracle registerd with this instance
+    // the corresponding oracles existence is checked via instance reader
+    function add(NftId oracleNftId, RequestId requestId) external restricted() {
+        IComponents.ComponentInfo memory componentInfo = ObjectSetHelperLib.getComponentInfo(_instanceAddress, oracleNftId);
+
+        // ensure pool is registered with instance
+        if (bytes(componentInfo.name).length == 0) {
+            revert ErrorRequestSetOracleNotRegistered(oracleNftId);
+        }
+
+        _add(oracleNftId, _toRequestKey32(requestId));
+        emit LogRequestSetRequestAdded(oracleNftId, requestId);
+    }
+
+    function remove(NftId oracleNftId, RequestId requestId) external restricted() {
+        _remove(oracleNftId, _toRequestKey32(requestId));
+        emit LogRequestSetRequestRemoved(oracleNftId, requestId);
+    }
+
+    function _toRequestKey32(RequestId requestId) private pure returns (Key32) {
+        return requestId.toKey32();
+    }
+
+    function activeRequests(NftId oracleNftId) external view returns (uint256 numberOfRequests) {
+        return _objects(oracleNftId);
+    }
+
+    function activeRequestAt(NftId oracleNftId, uint256 idx) external view returns (RequestId requestId) {
+        return _toRequestId(_getActiveObject(oracleNftId, idx));
+    }
+
+    function contains(NftId oracleNftId, RequestId requestId) external view returns (bool) {
+        return _contains(oracleNftId, _toRequestKey32(requestId));
+    }
+
+    function _toRequestId(Key32 key) private pure returns (RequestId) {
+        return RequestIdLib.toRequestId(key.toKeyId());
+    }
+}

package/contracts/instance/TargetNames.sol

@@ -7,4 +7,5 @@ string constant INSTANCE_STORE_TARGET_NAME = "InstanceStore";
 string constant PRODUCT_STORE_TARGET_NAME = "ProductStore";
 string constant BUNDLE_SET_TARGET_NAME = "BundleSet";
 string constant RISK_SET_TARGET_NAME = "RiskSet";
+string constant REQUEST_SET_TARGET_NAME = "RequestSet";
 

package/contracts/instance/base/Cloneable.sol

@@ -4,19 +4,25 @@ pragma solidity ^0.8.20;
 import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 
 import {IRegistry} from "../../registry/IRegistry.sol";
-import {RegistryLinked} from "../../shared/RegistryLinked.sol";
 
 abstract contract Cloneable is 
-    AccessManagedUpgradeable,
-    RegistryLinked
+    AccessManagedUpgradeable
 {
+    IRegistry internal _registry;
+
     /// @dev call to initialize MUST be made in the same transaction as cloning of the contract
     function __Cloneable_init(
-        address authority
+        address authority,
+        address registry
     )
         internal 
         onlyInitializing
     {
         __AccessManaged_init(authority);
+        _registry = IRegistry(registry);
+    }
+
+    function getRegistry() external view returns (IRegistry) {
+        return _registry;
     }
 }

package/contracts/instance/base/ObjectSet.sol

@@ -21,12 +21,12 @@ contract ObjectSet is
     address internal _instanceAddress;
 
     /// @dev This initializer needs to be called from the instance itself.
-    function initialize(address authority) 
+    function initialize(address authority, address registry) 
         external
         initializer()
     {
         _instanceAddress = msg.sender;
-        __Cloneable_init(authority);
+        __Cloneable_init(authority, registry);
         
         emit LogObjectSetInitialized(address(_instanceAddress));
     }
@@ -43,6 +43,14 @@ contract ObjectSet is
         activeSet.add(key);
     }
 
+    function _remove(NftId componentNftId, Key32 key) internal {
+        LibKey32Set.Set storage allSet = _allObjects[componentNftId];
+        LibKey32Set.Set storage activeSet = _activeObjects[componentNftId];
+
+        allSet.remove(key);
+        activeSet.remove(key);
+    }
+
     function _activate(NftId componentNftId, Key32 key) internal {
         _activeObjects[componentNftId].add(key);
     }

package/contracts/instance/base/ObjectSetHelperLib.sol

@@ -2,6 +2,7 @@
 pragma solidity ^0.8.20;
 
 import {IBundle} from "../module/IBundle.sol";
+import {IComponents} from "../module/IComponents.sol";
 import {IInstance} from "../IInstance.sol";
 import {IRisk} from "../module/IRisk.sol";
 import {NftId} from "../../type/NftId.sol";
@@ -11,7 +12,6 @@ import {RiskId} from "../../type/RiskId.sol";
 library ObjectSetHelperLib {
 
     function getRiskInfo(address instanceAddress, RiskId riskId) public view returns (IRisk.RiskInfo memory) {
-
         return IInstance(instanceAddress).getInstanceReader().getRiskInfo(riskId);
     }
 
@@ -27,4 +27,8 @@ library ObjectSetHelperLib {
         return getBundleInfo(instanceAddress, bundleNftId).poolNftId;
     }
 
+    function getComponentInfo(address instanceAddress, NftId componentNftId) public view returns (IComponents.ComponentInfo memory) {
+        return IInstance(instanceAddress).getInstanceReader().getComponentInfo(componentNftId);
+    }
+
 }

package/contracts/oracle/BasicOracle.sol

@@ -22,7 +22,9 @@ contract BasicOracle is
         _respond(requestId, responseData);
     }
 
+
     function _initializeBasicOracle(
+        address registry,
         NftId instanceNftId,
         IAuthorization authorization,
         address initialOwner,
@@ -34,6 +36,7 @@ contract BasicOracle is
     {
 
         __Oracle_init(
+            registry,
             instanceNftId,
             authorization,
             initialOwner,

package/contracts/oracle/BasicOracleAuthorization.sol

@@ -8,8 +8,6 @@ import {IAccess} from "../authorization/IAccess.sol";
 import {IOracle} from "./IOracle.sol"; 
 import {PUBLIC_ROLE} from "../../contracts/type/RoleId.sol";
 import {RoleId} from "../type/RoleId.sol";
-import {GIF_INITIAL_RELEASE} from "../registry/Registry.sol";
-import {VersionPartLib} from "../type/Version.sol";
 
 
 contract BasicOracleAuthorization
@@ -23,7 +21,7 @@ contract BasicOracleAuthorization
           Authorization(
                componentName, 
                ORACLE(), 
-               GIF_INITIAL_RELEASE(),
+               3, 
                commitHash, 
                TargetType.Component, 
                false)

package/contracts/oracle/IOracleComponent.sol

@@ -13,6 +13,10 @@ import {Timestamp} from "../type/Timestamp.sol";
 interface IOracleComponent is IInstanceLinkedComponent {
     error ErrorOracleNotImplemented(string methodName);
     
+    event LogOracleRequestReceived(RequestId indexed requestId, NftId indexed requesterId);
+    event LogOracleRequestCancelled(RequestId indexed requestId);
+
+
     /// @dev callback method for requesting some data from the oracle
     function request(
         RequestId requestId,
@@ -30,4 +34,10 @@ interface IOracleComponent is IInstanceLinkedComponent {
 
     /// @dev returns true iff the component needs to be called when selling/renewing policis
     function isVerifying() external view returns (bool verifying);
+
+    function activeRequests() external view returns(uint256 numberOfRequests);
+    
+    function getActiveRequest(uint256 idx) external view returns(RequestId requestId);
+
+    function isActiveRequest(RequestId requestId) external view returns(bool isActive);
 }

package/contracts/oracle/IOracleService.sol

@@ -18,9 +18,13 @@ interface IOracleService is IService {
     event LogOracleServiceRequestCancelled(RequestId requestId, NftId requesterNftId);
 
     // create request
+    error ErrorOracleServiceProductMismatch(ObjectType callerObjectType, NftId productNft, NftId oracleParentNftId);
     error ErrorOracleServiceExpiryInThePast(Timestamp blockTimestamp, Timestamp expiryAt);
     error ErrorOracleServiceCallbackMethodNameEmpty();
 
+    // respond
+    error ErrorOracleServiceNotResponsibleOracle(RequestId requestId, NftId expectedOracleNftId, NftId oracleNftId);
+
     // get request info
     error ErrorOracleServiceRequestStateNotActive(RequestId requestId, StateId state);
     error ErrorOracleServiceCallerNotResponsibleOracle(RequestId requestId, NftId oracleNftId, NftId callerNftId);
@@ -37,26 +41,26 @@ interface IOracleService is IService {
         string calldata callbackMethodName
     ) external returns (RequestId requestId);
 
-    /// @dev respond to oracle request by oracle compnent.
-    /// the response data is amende in the request info stored with the instance.
-    /// the request state changes to FULFILLED (when calling the callback method of the requester is successful)
+    /// @dev Respond to oracle request by oracle compnent.
+    /// The response data is amended in the request info stored with the instance.
+    /// The request state changes to FULFILLED (when calling the callback method of the requester is successful)
     /// or to FAILED when calling the requester is not succesful.
-    /// the function returns true iff the state changes to FULFILLED.
-    /// permissioned: only the oracle component linked to the request id may call this method
+    /// The function returns true iff the state changes to FULFILLED.
+    /// Permissioned: only the receiving oracle component may call this method
     function respond(
         RequestId requestId,
         bytes calldata responseData
     ) external returns (bool success);
 
-    /// @dev re send a failed response to the requester.
-    /// only requests in state FAILED may be re sent.
-    /// the request state changes to FULFILLED when calling the callback method of the requester is successful.
-    /// permissioned: only the requester may resend a request
+    /// @dev Resend a failed response to the requester.
+    /// Only requests in state FAILED may be resent.
+    /// The request state changes to FULFILLED when calling the callback method of the requester is successful.
+    /// Permissioned: only the receiving oracle may resend a request
     function resend(RequestId requestId) external;
 
-    /// @dev notify the oracle component that the specified request has become invalid.
-    /// only requests in state ACTIVE may be cancelled.
-    /// permissioned: only the requester may cancel a request
+    /// @dev Notify the oracle component that the specified request has become invalid.
+    /// Only requests in state ACTIVE may be cancelled.
+    /// Permissioned: only the requester may cancel a request
     function cancel(RequestId requestId) external;
 
 }