@etherisc/gif-next 3.0.0-9db267a-850 → 3.0.0-9db9ac5-352

package/contracts/instance/InstanceAdmin.sol

@@ -13,7 +13,7 @@ import {ObjectType, INSTANCE} from "../type/ObjectType.sol";
 import {RoleId, ADMIN_ROLE} from "../type/RoleId.sol";
 import {Str} from "../type/String.sol";
 import {VersionPart} from "../type/Version.sol";
-import {INSTANCE_TARGET_NAME, INSTANCE_ADMIN_TARGET_NAME, INSTANCE_STORE_TARGET_NAME, PRODUCT_STORE_TARGET_NAME, BUNDLE_SET_TARGET_NAME, RISK_SET_TARGET_NAME} from "./TargetNames.sol";
+import {INSTANCE_TARGET_NAME, INSTANCE_ADMIN_TARGET_NAME, INSTANCE_STORE_TARGET_NAME, PRODUCT_STORE_TARGET_NAME, BUNDLE_SET_TARGET_NAME, RISK_SET_TARGET_NAME, REQUEST_SET_TARGET_NAME} from "./TargetNames.sol";
 
 
 contract InstanceAdmin is
@@ -123,6 +123,7 @@ contract InstanceAdmin is
         _createInstanceTarget(address(_instance.getProductStore()), PRODUCT_STORE_TARGET_NAME); 
         _createInstanceTarget(address(_instance.getBundleSet()), BUNDLE_SET_TARGET_NAME); 
         _createInstanceTarget(address(_instance.getRiskSet()), RISK_SET_TARGET_NAME); 
+        _createInstanceTarget(address(_instance.getRequestSet()), REQUEST_SET_TARGET_NAME); 
     }
 
 

package/contracts/instance/InstanceAuthorizationV3.sol

@@ -10,9 +10,10 @@ import {ACCOUNTING, ORACLE, POOL, INSTANCE, COMPONENT, DISTRIBUTION, APPLICATION
 import {BundleSet} from "../instance/BundleSet.sol";
 import {InstanceAdmin} from "../instance/InstanceAdmin.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
-import {INSTANCE_TARGET_NAME, INSTANCE_ADMIN_TARGET_NAME, INSTANCE_STORE_TARGET_NAME, PRODUCT_STORE_TARGET_NAME, BUNDLE_SET_TARGET_NAME, RISK_SET_TARGET_NAME} from "./TargetNames.sol";
+import {INSTANCE_TARGET_NAME, INSTANCE_ADMIN_TARGET_NAME, INSTANCE_STORE_TARGET_NAME, PRODUCT_STORE_TARGET_NAME, BUNDLE_SET_TARGET_NAME, RISK_SET_TARGET_NAME, REQUEST_SET_TARGET_NAME} from "./TargetNames.sol";
 import {ProductStore} from "../instance/ProductStore.sol";
 import {ADMIN_ROLE, INSTANCE_OWNER_ROLE, PUBLIC_ROLE} from "../type/RoleId.sol";
+import {RequestSet} from "../instance/RequestSet.sol";
 import {RiskSet} from "../instance/RiskSet.sol"; 
 
 
@@ -71,6 +72,7 @@ contract InstanceAuthorizationV3
           _addInstanceTarget(PRODUCT_STORE_TARGET_NAME);
           _addInstanceTarget(BUNDLE_SET_TARGET_NAME);
           _addInstanceTarget(RISK_SET_TARGET_NAME);
+          _addInstanceTarget(REQUEST_SET_TARGET_NAME);
      }
 
 
@@ -84,6 +86,18 @@ contract InstanceAuthorizationV3
           _setupProductStoreAuthorization();
           _setupBundleSetAuthorization();
           _setUpRiskSetAuthorization();
+          _setUpRequestIdSetAuthorization();
+     }
+
+     function _setUpRequestIdSetAuthorization()
+          internal
+     {
+          IAccess.FunctionInfo[] storage functions;
+
+          // authorize oracle service role
+          functions = _authorizeForTarget(REQUEST_SET_TARGET_NAME, getServiceRole(ORACLE()));
+          _authorize(functions, RequestSet.add.selector, "add");
+          _authorize(functions, RequestSet.remove.selector, "remove");
      }
 
 

package/contracts/instance/InstanceReader.sol

@@ -30,6 +30,7 @@ import {PolicyServiceLib} from "../product/PolicyServiceLib.sol";
 import {ProductStore} from "./ProductStore.sol";
 import {ReferralId, ReferralStatus, ReferralLib} from "../type/Referral.sol";
 import {RequestId} from "../type/RequestId.sol";
+import {RequestSet} from "./RequestSet.sol";
 import {RiskId} from "../type/RiskId.sol";
 import {RiskSet} from "./RiskSet.sol";
 import {RoleId, INSTANCE_OWNER_ROLE} from "../type/RoleId.sol";
@@ -56,6 +57,7 @@ contract InstanceReader {
     ProductStore internal _productStore;
     BundleSet internal _bundleSet;
     RiskSet internal _riskSet;
+    RequestSet internal _requestSet;
     IDistributionService internal _distributionService;
 
     /// @dev This initializer needs to be called from the instance itself.
@@ -85,6 +87,7 @@ contract InstanceReader {
         _productStore = _instance.getProductStore();
         _bundleSet = _instance.getBundleSet();
         _riskSet = _instance.getRiskSet();
+        _requestSet = _instance.getRequestSet();
         _distributionService = IDistributionService(_registry.getServiceAddress(DISTRIBUTION(), _instance.getRelease()));
     }
 
@@ -366,6 +369,18 @@ contract InstanceReader {
         return getState(requestId.toKey32());
     }
 
+    function getActiveRequests(NftId oracleNftId) external view returns(uint256 numberOfRequests) {
+        return _requestSet.activeRequests(oracleNftId);
+    }
+
+    function getActiveRequestAt(NftId oracleNftId, uint256 idx) external view returns(RequestId requestId) {
+        return _requestSet.activeRequestAt(oracleNftId, idx);
+    }
+
+    function isRequestActive(NftId oracleNftId, RequestId requestId) external view returns(bool isActive) {
+        return _requestSet.contains(oracleNftId, requestId);
+    }
+
     //--- pool functions -----------------------------------------------------------//
 
     /// @dev Returns the pool info for the given pool NFT ID.

package/contracts/instance/InstanceService.sol

@@ -332,7 +332,7 @@ contract InstanceService is
             IInstance instance = IInstance(instanceAddress);
             address accessManagerAddress = instance.authority();
             InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
-                
+            
             {
                 address instanceAdminAddress = address(instanceAdmin);
                 InstanceReader instanceReader = instance.getInstanceReader();
@@ -364,8 +364,10 @@ contract InstanceService is
                 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;

package/contracts/instance/RequestSet.sol

@@ -9,7 +9,7 @@ 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} from "../type/RequestId.sol";
+import {RequestId, RequestIdLib} from "../type/RequestId.sol";
 
 contract RequestSet is 
     ObjectSet
@@ -44,4 +44,20 @@ contract RequestSet is
     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/oracle/Oracle.sol

@@ -2,17 +2,15 @@
 pragma solidity ^0.8.20;
 
 import {Amount} from "../type/Amount.sol";
-import {COMPONENT, PRODUCT, ORACLE} from "../type/ObjectType.sol";
+import {COMPONENT, 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 {LibRequestIdSet} from "../type/RequestIdSet.sol";
 import {NftId} from "../type/NftId.sol";
 import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.sol";
 import {RequestId} from "../type/RequestId.sol";
-import {FULFILLED} from "../type/StateId.sol";
 import {Timestamp} from "../type/Timestamp.sol";
 
 
@@ -23,10 +21,6 @@ abstract contract Oracle is
     // keccak256(abi.encode(uint256(keccak256("etherisc.storage.Oracle")) - 1)) & ~bytes32(uint256(0xff));
     bytes32 public constant ORACLE_STORAGE_LOCATION_V1 = 0xaab7c0ea03d290e56d6c060e0733d3ebcbe647f7694616a2ec52738a64b2f900;
 
-    // TODO decide if this variable should be moved to instance store
-    // if so it need to manage active requests by requestor nft id
-    LibRequestIdSet.Set internal _activeRequests;
-
     struct OracleStorage {
         IComponentService _componentService;
         IOracleService _oracleService;
@@ -80,34 +74,32 @@ abstract contract Oracle is
         revert ErrorOracleNotImplemented("withdrawFees");
     }
 
-    // TODO decide if the code below should be moved to GIF
     function activeRequests()
         external
         view
         returns(uint256 numberOfRequests)
     {
-        return LibRequestIdSet.size(_activeRequests);
+        return _getInstanceReader().getActiveRequests(getNftId());
     }
 
 
-    // TODO decide if the code below should be moved to GIF
     function getActiveRequest(uint256 idx)
         external
         view
         returns(RequestId requestId)
     {
-        return LibRequestIdSet.getElementAt(_activeRequests, idx);
+        return _getInstanceReader().getActiveRequestAt(getNftId(), idx);
     }
 
-    // TODO decide if the code below should be moved to GIF
     function isActiveRequest(RequestId requestId)
         external
         view
         returns(bool isActive)
     {
-        return LibRequestIdSet.contains(_activeRequests, requestId);
+        return _getInstanceReader().isRequestActive(getNftId(), requestId);
     }
 
+    // solhint-disable-next-line func-name-mixedcase
     function __Oracle_init(
         address registry,
         NftId productNftId,
@@ -148,23 +140,6 @@ abstract contract Oracle is
         _getOracleStorage()._oracleService.respond(requestId, responseData);
     }
 
-        // TODO decide if the code below should be moved to GIF
-    // check callback result
-    function _updateRequestState(
-        RequestId requestId
-    )
-        internal
-    {
-        bool requestFulfilled = _getInstanceReader().getRequestState(
-            requestId) == FULFILLED();
-
-        // remove from active requests when successful
-        if (requestFulfilled && LibRequestIdSet.contains(_activeRequests, requestId)) {
-            LibRequestIdSet.remove(_activeRequests, requestId);
-        } 
-    }
-
-
     /// @dev use case specific handling of oracle requests
     /// for now only log is emitted to verify that request has been received by oracle component 
     function _request(
@@ -176,8 +151,6 @@ abstract contract Oracle is
         internal
         virtual 
     {
-        // TODO decide if the line below should be moved to GIF
-        LibRequestIdSet.add(_activeRequests, requestId);
         emit LogOracleRequestReceived(requestId, requesterId);
     }
 
@@ -190,13 +163,12 @@ abstract contract Oracle is
         internal
         virtual 
     {
-        // TODO decide if the line below should be moved to GIF
-        LibRequestIdSet.remove(_activeRequests, requestId);
         emit LogOracleRequestCancelled(requestId);
     }
 
 
     function _getOracleStorage() private pure returns (OracleStorage storage $) {
+        // solhint-disable-next-line no-inline-assembly
         assembly {
             $.slot := ORACLE_STORAGE_LOCATION_V1
         }

package/contracts/oracle/OracleService.sol

@@ -2,16 +2,14 @@
 pragma solidity ^0.8.20;
 
 import {ContractLib} from "../shared/ContractLib.sol";
-import {IComponent} from "../shared/IComponent.sol";
 import {IInstance} from "../instance/IInstance.sol";
-import {IInstanceService} from "../instance/IInstanceService.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IOracle} from "./IOracle.sol";
 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, PRODUCT} from "../type/ObjectType.sol";
+import {ObjectType, 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";
@@ -56,7 +54,7 @@ contract OracleService is
         // get and check active caller
         (
             IRegistry.ObjectInfo memory requesterInfo, 
-            address instance
+            address instanceAddress
         ) = ContractLib.getAndVerifyAnyComponent(
             getRegistry(), msg.sender, true);
 
@@ -69,7 +67,7 @@ contract OracleService is
         // effects
         {
             // create request info
-            IOracle.RequestInfo memory request = IOracle.RequestInfo({
+            IOracle.RequestInfo memory requestInfo = IOracle.RequestInfo({
                 requesterNftId: requesterNftId,
                 callbackMethodName: callbackMethodName,
                 oracleNftId: oracleNftId,
@@ -80,8 +78,9 @@ contract OracleService is
                 isCancelled: false
             });
 
-            // store request with instance
-            requestId = IInstance(instance).getInstanceStore().createRequest(request);
+            // store request with instance 
+            requestId = IInstance(instanceAddress).getInstanceStore().createRequest(requestInfo);
+            IInstance(instanceAddress).getRequestSet().add(oracleNftId, requestId);
         }
 
         emit LogOracleServiceRequestCreated(requestId, requesterNftId, oracleNftId, expiryAt);
@@ -116,22 +115,23 @@ contract OracleService is
         NftId oracleNftId = info.nftId;
         IInstance instance = IInstance(instanceAddress);
         bool callerIsOracle = true;
-        IOracle.RequestInfo memory request = _checkAndGetRequestInfo(instance, requestId, oracleNftId, callerIsOracle);
-        request.responseData = responseData;
-        request.respondedAt = TimestampLib.current();
+        IOracle.RequestInfo memory requestInfo = _checkAndGetRequestInfo(instance, requestId, oracleNftId, callerIsOracle);
+        requestInfo.responseData = responseData;
+        requestInfo.respondedAt = TimestampLib.current();
 
         instance.getInstanceStore().updateRequest(
-            requestId, request, KEEP_STATE());
+            requestId, requestInfo, KEEP_STATE());
 
         IRegistry.ObjectInfo memory requesterInfo = getRegistry().getObjectInfo(
-            request.requesterNftId);
+            requestInfo.requesterNftId);
 
         string memory functionSignature = string(
             abi.encodePacked(
-                request.callbackMethodName,
+                requestInfo.callbackMethodName,
                 "(uint64,bytes)"
             ));
 
+        // solhint-disable-next-line avoid-low-level-calls
         (success, ) = requesterInfo.objectAddress.call(
             abi.encodeWithSignature(
                 functionSignature, 
@@ -141,6 +141,7 @@ contract OracleService is
         // check that calling requestor was successful
         if (success) {
             instance.getInstanceStore().updateRequestState(requestId, FULFILLED());
+            instance.getRequestSet().remove(oracleNftId, requestId);
         } else {
             instance.getInstanceStore().updateRequestState(requestId, FAILED());
             emit LogOracleServiceDeliveryFailed(requestId, requesterInfo.objectAddress, functionSignature);
@@ -164,24 +165,26 @@ contract OracleService is
         NftId requesterNftId = info.nftId;
         IInstance instance = IInstance(instanceAddress);
         bool callerIsOracle = false;
-        IOracle.RequestInfo memory request = _checkAndGetRequestInfo(instance, requestId, requesterNftId, callerIsOracle);
+        IOracle.RequestInfo memory requestInfo = _checkAndGetRequestInfo(instance, requestId, requesterNftId, callerIsOracle);
 
         // attempt to deliver response to requester
         string memory functionSignature = string(
             abi.encodePacked(
-                request.callbackMethodName,
+                requestInfo.callbackMethodName,
                 "(uint64,bytes)"
             ));
 
-        (bool success, bytes memory returnData) = info.objectAddress.call(
+        // solhint-disable-next-line avoid-low-level-calls
+        (bool success, ) = info.objectAddress.call(
             abi.encodeWithSignature(
                 functionSignature, 
                 requestId,
-                request.responseData));
+                requestInfo.responseData));
 
         // check that calling requestor was successful
         if (success) {
             instance.getInstanceStore().updateRequestState(requestId, FULFILLED());
+            instance.getRequestSet().remove(requestInfo.oracleNftId, requestId);
             emit LogOracleServiceResponseResent(requestId, requesterNftId);
         } else {
             emit LogOracleServiceDeliveryFailed(requestId, info.objectAddress, functionSignature);
@@ -204,20 +207,20 @@ contract OracleService is
         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);
-        request.isCancelled = true;
+        IOracle.RequestInfo memory requestInfo = _checkAndGetRequestInfo(instance, requestId, requesterNftId, callerIsOracle);
+        requestInfo.isCancelled = true;
 
-        instance.getInstanceStore().updateRequest(requestId, request, CANCELLED());
+        instance.getInstanceStore().updateRequest(requestId, requestInfo, CANCELLED());
+        instance.getRequestSet().remove(requestInfo.oracleNftId, requestId);
 
         // call oracle component
         // TODO add check that oracle is active?
-        address oracleAddress = getRegistry().getObjectAddress(request.oracleNftId);
+        address oracleAddress = getRegistry().getObjectAddress(requestInfo.oracleNftId);
         IOracleComponent(oracleAddress).cancel(requestId);
 
         emit LogOracleServiceRequestCancelled(requestId, requesterNftId);
     }
 
-
     function _checkRequestParams(
         IRegistry registry,
         NftId oracleNftId,

package/contracts/type/RequestId.sol

@@ -72,4 +72,10 @@ library RequestIdLib {
     function toKeyId(RequestId id) public pure returns (KeyId keyId) {
         return KeyId.wrap(bytes31(uint248(RequestId.unwrap(id))));
     }
+
+    function toRequestId(KeyId keyId) public pure returns (RequestId requestId) {
+        uint248 keyIdInt = uint248(bytes31(KeyId.unwrap(keyId)));
+        assert(keyIdInt < type(uint64).max);
+        return RequestId.wrap(uint64(keyIdInt));
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "3.0.0-9db267a-850",
+  "version": "3.0.0-9db9ac5-352",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {