@etherisc/gif-next 3.0.0-d6cf78d-199 → 3.0.0-d6ff88d-936

package/contracts/shared/InstanceLinkedComponent.sol

@@ -1,27 +1,25 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
-import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-
-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 {IInstanceService} from "../instance/IInstanceService.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 {VersionPart} from "../type/Version.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 {IAccess} from "../authorization/IAccess.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
@@ -38,8 +36,23 @@ abstract contract InstanceLinkedComponent is
         InstanceReader _instanceReader; // instance reader for this component
         IAuthorization _initialAuthorization;
         IComponentService _componentService;
+        IOracleService _oracleService;
+    }
+
+    //--- view functions ----------------------------------------------------//
+
+    /// @inheritdoc IInstanceLinkedComponent
+    function getInstance() public view virtual override returns (IInstance instance) {
+        return _getInstanceLinkedComponentStorage()._instance;
+    }
+
+
+    /// @inheritdoc IAuthorizedComponent
+    function getAuthorization() external view virtual returns (IAuthorization authorization) {
+        return _getInstanceLinkedComponentStorage()._initialAuthorization;
     }
 
+
     /// @inheritdoc IInstanceLinkedComponent
     function withdrawFees(Amount amount)
         external
@@ -51,22 +64,49 @@ abstract contract InstanceLinkedComponent is
         return _withdrawFees(amount);
     }
 
-    /// @inheritdoc IInstanceLinkedComponent
-    function getInstance() public view virtual override returns (IInstance instance) {
-        return _getInstanceLinkedComponentStorage()._instance;
+    //--- 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);
     }
 
-    /// @inheritdoc IInstanceLinkedComponent
-    function getAuthorization() external view virtual returns (IAuthorization authorization) {
-        return _getInstanceLinkedComponentStorage()._initialAuthorization;
+
+    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,
@@ -106,6 +146,7 @@ abstract contract InstanceLinkedComponent is
         $._instanceReader = $._instance.getInstanceReader();
         $._initialAuthorization = authorization;
         $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
+        $._oracleService = IOracleService(_getServiceAddress(ORACLE()));
 
         // register interfaces
         _registerInterface(type(IInstanceLinkedComponent).interfaceId);

package/contracts/type/ObjectType.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {StrLib} from "./String.sol";
 import {VersionPart} from "./Version.sol";
 
 type ObjectType is uint8;
@@ -247,7 +248,7 @@ library ObjectTypeLib {
         return string(
             abi.encodePacked(
                 "ObjectType",
-                toString(
+                StrLib.uintToString(
                     toInt(objectType))));
     }
 
@@ -274,34 +275,4 @@ library ObjectTypeLib {
                 versionName,
                 release.toString()));
     }
-
-    /// @dev returns the provied int as a string
-    function toString(uint256 value) public pure returns (string memory name) {
-
-        if (value == 0) {
-            return "0";
-        }
-
-        uint256 temp = value;
-        uint256 digits = 0;
-        while (temp != 0) {
-            digits++;
-            temp /= 10;
-        }
-
-        bytes memory buffer = new bytes(digits);
-        uint256 index = digits - 1;
-
-        temp = value;
-        while (temp != 0) {
-            buffer[index] = bytes1(uint8(48 + temp % 10));
-            temp /= 10;
-
-            if (index > 0) {
-                index--;
-            }
-        }
-
-        return string(buffer);
-    }
 }

package/contracts/type/Referral.sol

@@ -13,6 +13,7 @@ using {
     eqReferralId as ==, 
     neReferralId as !=,
     ReferralLib.eqz,
+    ReferralLib.toInt,
     ReferralLib.toKey32
 } for ReferralId global;
 
@@ -74,6 +75,11 @@ library ReferralLib {
         return ReferralStatus.wrap(status);
     }
 
+    /// @dev Converts a referral id into a uint256.
+    function toInt(ReferralId referralId) public pure returns (uint256) {
+        return uint64(ReferralId.unwrap(referralId));
+    }
+
     /// @dev Returns the key32 value for the specified nft id and object type.
     function toKey32(ReferralId id) public pure returns (Key32 key) {
         return Key32Lib.toKey32(REFERRAL(), toKeyId(id));

package/contracts/type/RequestIdSet.sol

@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {RequestId} from "../type/RequestId.sol";
+
+// based on https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/structs/EnumerableSet.sol
+library LibRequestIdSet {
+
+    struct Set {
+        RequestId[] ids;
+        mapping(RequestId requestId => uint256 index) at;
+    }
+
+    error ErrorRequestIdSetAlreadyAdded(RequestId requestId);
+    error ErrorRequestIdSetNotInSet(RequestId requestId);
+
+
+    function add(Set storage set, RequestId requestId) external {
+        if (set.at[requestId] > 0) {
+            revert ErrorRequestIdSetAlreadyAdded(requestId);
+        }
+
+        set.ids.push(requestId);
+        set.at[requestId] = set.ids.length;
+    }
+
+    function remove(Set storage set, RequestId requestId) external {
+        uint256 requestIdIndex = set.at[requestId];
+
+        if (requestIdIndex == 0) {
+            revert ErrorRequestIdSetNotInSet(requestId);
+        }
+
+        uint256 toDeleteIndex = requestIdIndex - 1;
+        uint256 lastIndex = set.ids.length - 1;
+
+        if (lastIndex != toDeleteIndex) {
+            RequestId lastId = set.ids[lastIndex];
+            set.ids[toDeleteIndex] = lastId;
+            set.at[lastId] = requestIdIndex; // Replace lastValue's index to valueIndex
+        }
+
+        set.ids.pop();
+        delete set.at[requestId];
+    }
+
+    function isEmpty(Set storage set) external view returns(bool empty) {
+        return set.ids.length == 0;
+    }
+
+    function contains(Set storage set, RequestId requestId) external view returns(bool inSet) {
+        return set.at[requestId] > 0;
+    }
+
+    function size(Set storage set) external view returns(uint256 length) {
+        return set.ids.length;
+    }
+
+    function getElementAt(Set storage set, uint256 index) external view returns(RequestId requestId) {
+        return set.ids[index];
+    }
+}

package/contracts/type/Seconds.sol

@@ -47,6 +47,10 @@ library SecondsLib {
         return Seconds.wrap(_max());
     }
 
+    function fromHours(uint32 numberOfHours) public pure returns (Seconds duration) {
+        return Seconds.wrap(numberOfHours * 3600);
+    }
+
     function oneDay() public pure returns (Seconds duration) {
         return Seconds.wrap(24 * 3600);
     }

package/contracts/type/String.sol

@@ -62,4 +62,34 @@ library StrLib {
     function length(Str str) public pure returns (uint256 byteLength) {
         return ShortStrings.byteLength(ShortString.wrap(Str.unwrap(str)));
     }
+
+    /// @dev Returns the provied int as a string
+    function uintToString(uint256 value) public pure returns (string memory name) {
+
+        if (value == 0) {
+            return "0";
+        }
+
+        uint256 temp = value;
+        uint256 digits = 0;
+        while (temp != 0) {
+            digits++;
+            temp /= 10;
+        }
+
+        bytes memory buffer = new bytes(digits);
+        uint256 index = digits - 1;
+
+        temp = value;
+        while (temp != 0) {
+            buffer[index] = bytes1(uint8(48 + temp % 10));
+            temp /= 10;
+
+            if (index > 0) {
+                index--;
+            }
+        }
+
+        return string(buffer);
+    }
 }

package/contracts/type/Timestamp.sol

@@ -23,6 +23,7 @@ using {
     TimestampLib.gtz,
     TimestampLib.eqz,
     TimestampLib.addSeconds,
+    TimestampLib.subtractSeconds,
     TimestampLib.toInt
 } for Timestamp global;
 
@@ -129,7 +130,7 @@ library TimestampLib {
         return Timestamp.unwrap(timestamp) > 0;
     }
 
-    /// @dev return true if Timestamp a is not equal to Timestamp b
+    /// @dev return a new timestamp that is duration seconds later than the provided timestamp.
     function addSeconds(
         Timestamp timestamp,
         Seconds duration
@@ -137,6 +138,14 @@ library TimestampLib {
         return toTimestamp(Timestamp.unwrap(timestamp) + duration.toInt());
     }
 
+    /// @dev return a new timestamp that is duration seconds earlier than the provided timestamp.
+    function subtractSeconds(
+        Timestamp timestamp,
+        Seconds duration
+    ) public pure returns (Timestamp) {
+        return toTimestamp(Timestamp.unwrap(timestamp) - duration.toInt());
+    }
+
     function toInt(Timestamp timestamp) public pure returns (uint256) {
         return uint256(uint40(Timestamp.unwrap(timestamp)));
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "3.0.0-d6cf78d-199",
+  "version": "3.0.0-d6ff88d-936",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {
@@ -50,6 +50,7 @@
     "antlr4ng": "^3.0.4",
     "ethers": "^6.7.1",
     "ethers-decode-error": "^2.1.3",
+    "simple-git": "^3.27.0",
     "solidity-docgen": "^0.6.0-beta.36",
     "winston": "^3.10.0"
   }