@etherisc/gif-next 3.0.0-24be7ed-702 → 3.0.0-46119ac-539

package/contracts/examples/flight/FlightMessageVerifier.sol

@@ -0,0 +1,128 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
+import {MessageHashUtils} from "@openzeppelin/contracts/utils/cryptography/MessageHashUtils.sol";
+import {ECDSA} from "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
+
+
+import {Amount} from "../../type/Amount.sol";
+import {Str} from "../../type/String.sol";
+import {Timestamp} from "../../type/Timestamp.sol";
+
+contract FlightMessageVerifier is 
+    Ownable
+{
+
+    error ErrorFlightMessageVerifierSignerZero();
+    error ErrorFlightMessageVerifierContractSignerNotSupported();
+
+    address private _expectedSigner;
+
+
+    constructor() Ownable(msg.sender) { }
+
+
+    function setExpectedSigner(address signer) external onlyOwner {
+        if (signer == address(0)) { revert ErrorFlightMessageVerifierSignerZero(); }
+        if (signer.code.length > 0) { revert ErrorFlightMessageVerifierContractSignerNotSupported(); }
+        _expectedSigner = signer;
+    }
+
+
+    function getExpectedSigner() external view returns(address) {
+        return _expectedSigner;
+    }
+
+    /// @dev creates digest hash based on application parameters
+    /// proposal:
+    /// use "LX 180 ZRH BKK 20241104" (23 chars, should be enough for all flights)
+    /// carriers, airports: https://www.iata.org/en/publications/directories/code-search/
+    /// flight numbers: https://en.wikipedia.org/wiki/Flight_number
+    /// instead of separate strings, coding/decoding done anyway off-chain
+    function getRatingsHash(
+        Str flightData,
+        Timestamp departureTime,
+        Timestamp arrivalTime,
+        Amount premiumAmount,
+        uint256[6] memory statistics
+    )
+        public
+        view
+        returns(bytes32)
+    {
+        return MessageHashUtils.toEthSignedMessageHash(
+            abi.encode(
+                flightData,
+                departureTime,
+                arrivalTime,
+                premiumAmount,
+                statistics));
+    }
+
+
+    function verifyRatingsHash(
+        Str flightData,
+        Timestamp departureTime,
+        Timestamp arrivalTime,
+        Amount premiumAmount,
+        uint256[6] memory statistics,
+        // bytes memory signature,
+        uint8 v, 
+        bytes32 r, 
+        bytes32 s
+    )
+        public
+        view
+        returns (
+            address actualSigner,
+            ECDSA.RecoverError errorStatus,
+            bool success
+        )
+    {
+        bytes32 messageHash = getRatingsHash(
+            flightData,
+            departureTime,
+            arrivalTime,
+            premiumAmount,
+            statistics);
+
+        (
+            actualSigner, 
+            errorStatus, 
+        ) = ECDSA.tryRecover(messageHash, v, r, s);
+
+        success = (
+            errorStatus == ECDSA.RecoverError.NoError 
+            && actualSigner == _expectedSigner);
+    }
+
+
+    // TODO re-enable or cleanup
+    // function checkAndRegisterSignature (
+    //     address policyHolder,
+    //     address protectedWallet,
+    //     uint256 protectedBalance,
+    //     uint256 duration,
+    //     uint256 bundleId,
+    //     bytes32 signatureId,
+    //     bytes calldata signature
+    // )
+    //     external 
+    // {
+    //     bytes32 signatureHash = keccak256(abi.encode(signature));
+    //     require(!_signatureIsUsed[signatureHash], "ERROR:DMH-001:SIGNATURE_USED");
+
+    //     address signer = getSignerFromDigestAndSignature(
+    //         protectedWallet,
+    //         protectedBalance,
+    //         duration,
+    //         bundleId,
+    //         signatureId,
+    //         signature);
+
+    //     require(policyHolder == signer, "ERROR:DMH-002:SIGNATURE_INVALID");
+
+    //     _signatureIsUsed[signatureHash] = true;
+    // }
+}

package/contracts/examples/flight/FlightOracle.sol

@@ -0,0 +1,167 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IAuthorization} from "../../authorization/IAuthorization.sol";
+
+import {FULFILLED} from "../../type/StateId.sol";
+import {NftId} from "../../type/NftId.sol";
+import {BasicOracle} from "../../oracle/BasicOracle.sol";
+import {RequestId} from "../../type/RequestId.sol";
+import {LibRequestIdSet} from "../../type/RequestIdSet.sol";
+import {RiskId} from "../../type/RiskId.sol";
+import {Str} from "../../type/String.sol";
+import {Timestamp} from "../../type/Timestamp.sol";
+
+contract FlightOracle is
+    BasicOracle
+{
+
+    struct FlightStatusRequest {
+        RiskId riskId;
+        Str flightData; // "LX 180 ZRH BKK 20241104"
+        Timestamp departureTime; // is this needed or is flight number and date unique aready?
+    }
+
+    struct FlightStatusResponse {
+        RiskId riskId;
+        bytes1 status;
+        int256 delayMinutes;
+    }
+
+    event LogFlightOracleRequestReceived(RequestId requestId, NftId requesterId);
+    event LogFlightOracleResponseSent(RequestId requestId, bytes1 status, int256 delay);
+    event LogFlightOracleRequestCancelled(RequestId requestId);
+
+    // 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;
+
+
+    constructor(
+        address registry,
+        NftId productNftId,
+        string memory componentName,
+        IAuthorization authorization
+    ) 
+    {
+        address initialOwner = msg.sender;
+        initialize(
+            registry,
+            productNftId,
+            authorization,
+            initialOwner,
+            componentName
+        );
+    }
+
+
+    function initialize(
+        address registry,
+        NftId productNftId,
+        IAuthorization authorization,
+        address initialOwner,
+        string memory name
+    )
+        public
+        virtual
+        initializer()
+    {
+        _initializeBasicOracle(
+            registry,
+            productNftId,
+            authorization,
+            initialOwner,
+            name);
+    }
+
+
+    function respondWithFlightStatus(
+        RequestId requestId,
+        bytes1 status,
+        int256 delayMinutes
+    )
+        external
+        restricted()
+    {
+        // obtain riskId for request
+        bytes memory requestData = _getInstanceReader().getRequestInfo(requestId).requestData;
+        (RiskId riskId,,) = abi.decode(requestData, (RiskId, Str, Timestamp));
+        // assemble response data
+        bytes memory responseData = abi.encode(
+            FlightStatusResponse ({
+                riskId: riskId,
+                status: status,
+                delayMinutes: delayMinutes}));
+
+        // logging
+        emit LogFlightOracleResponseSent(requestId, status, delayMinutes);
+
+        // effects + interaction (via framework to receiving component)
+        _respond(requestId, responseData);
+
+        // TODO decide if the code below should be moved to GIF
+        // check callback result
+        bool requestFulfilled = _getInstanceReader().getRequestState(
+            requestId) == FULFILLED();
+
+        // remove from active requests when successful
+        if (requestFulfilled) {
+            LibRequestIdSet.remove(_activeRequests, requestId);
+        }
+    }
+
+    //--- view functions ----------------------------------------------------//
+
+    // TODO decide if the code below should be moved to GIF
+    function activeRequests()
+        external
+        view
+        returns(uint256 numberOfRequests)
+    {
+        return LibRequestIdSet.size(_activeRequests);
+    }
+
+
+    // 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);
+    }
+
+    //--- internal functions ------------------------------------------------//
+
+    /// @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(
+        RequestId requestId,
+        NftId requesterId,
+        bytes calldata requestData,
+        Timestamp expiryAt
+    )
+        internal
+        virtual override
+    {
+        FlightStatusRequest memory request = abi.decode(requestData, (FlightStatusRequest));
+
+        // TODO decide if the line below should be moved to GIF
+        LibRequestIdSet.add(_activeRequests, requestId);
+        emit LogFlightOracleRequestReceived(requestId, requesterId);
+    }
+
+
+    /// @dev use case specific handling of oracle requests
+    /// for now only log is emitted to verify that cancelling has been received by oracle component 
+    function _cancel(
+        RequestId requestId
+    )
+        internal
+        virtual override
+    {
+        // TODO decide if the line below should be moved to GIF
+        LibRequestIdSet.remove(_activeRequests, requestId);
+        emit LogFlightOracleRequestCancelled(requestId);
+    }
+}

package/contracts/examples/flight/FlightOracleAuthorization.sol

@@ -0,0 +1,34 @@
+
+
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IAccess} from "../../../contracts/authorization/IAccess.sol";
+
+import {BasicOracleAuthorization} from "../../oracle/BasicOracleAuthorization.sol";
+import {FlightOracle} from "./FlightOracle.sol";
+import {PUBLIC_ROLE} from "../../../contracts/type/RoleId.sol";
+
+contract FlightOracleAuthorization
+    is BasicOracleAuthorization
+{
+
+    constructor(string memory oracleName, string memory commitHash)
+        BasicOracleAuthorization(oracleName, commitHash)
+    {}
+
+
+    function _setupTargetAuthorizations()
+        internal
+        virtual override
+    {
+        super._setupTargetAuthorizations();
+        IAccess.FunctionInfo[] storage functions;
+
+        // TODO IMPORTANT must not be public role for prod!!!
+        // authorize public role (also protected by onlyOwner)
+        functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
+        _authorize(functions, FlightOracle.respondWithFlightStatus.selector, "respondWithFlightStatus");
+    }
+}
+

package/contracts/examples/flight/FlightPool.sol

@@ -0,0 +1,89 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IAuthorization} from "../../authorization/IAuthorization.sol";
+import {IComponents} from "../../instance/module/IComponents.sol";
+
+import {Amount, AmountLib} from "../../type/Amount.sol";
+import {BasicPool} from "../../pool/BasicPool.sol";
+import {FeeLib} from "../../type/Fee.sol";
+import {NftId} from "../../type/NftId.sol";
+import {Seconds, SecondsLib} from "../../type/Seconds.sol";
+import {UFixedLib} from "../../type/UFixed.sol";
+
+
+/// @dev FlightPool implements the pool for the flight delay product.
+/// Only the pool owner is allowed to create and manage bundles.
+contract FlightPool is
+    BasicPool
+{   
+    constructor(
+        address registry,
+        NftId productNftId,
+        string memory componentName,
+        IAuthorization authorization
+    ) 
+    {
+        address initialOwner = msg.sender;
+        _intialize(
+            registry,
+            productNftId,
+            componentName,
+            IComponents.PoolInfo({
+                maxBalanceAmount: AmountLib.max(),
+                isInterceptingBundleTransfers: false,
+                isProcessingConfirmedClaims: false,
+                isExternallyManaged: false,
+                isVerifyingApplications: false,
+                collateralizationLevel: UFixedLib.one(),
+                retentionLevel: UFixedLib.one()
+            }),
+            authorization,
+            initialOwner);
+    }
+
+    function _intialize(
+        address registry,
+        NftId productNftId,
+        string memory componentName,
+        IComponents.PoolInfo memory poolInfo,
+        IAuthorization authorization,
+        address initialOwner
+    )
+        internal
+        initializer
+    {
+        _initializeBasicPool(
+            registry,
+            productNftId,
+            componentName,
+            poolInfo,
+            authorization,
+            initialOwner);
+    }
+
+    function createBundle(
+        Amount initialAmount
+    )
+        external
+        virtual 
+        restricted()
+        onlyOwner()
+        returns(NftId bundleNftId)
+    {
+        address owner = msg.sender;
+        bundleNftId = _createBundle(
+            owner,
+            FeeLib.zero(),
+            SecondsLib.fromDays(90),
+            "" // filter
+        );
+
+        _stake(bundleNftId, initialAmount);
+    }
+
+    function approveTokenHandler(IERC20Metadata token, Amount amount) external restricted() onlyOwner() { _approveTokenHandler(token, amount); }
+    function setWallet(address newWallet) external restricted() onlyOwner() { _setWallet(newWallet); }
+}

package/contracts/examples/flight/FlightPoolAuthorization.sol

@@ -0,0 +1,37 @@
+
+
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IAccess} from "../../../contracts/authorization/IAccess.sol";
+
+import {BasicPoolAuthorization} from "../../pool/BasicPoolAuthorization.sol";
+import {FlightPool} from "./FlightPool.sol";
+import {PUBLIC_ROLE} from "../../../contracts/type/RoleId.sol";
+
+contract FlightPoolAuthorization
+    is BasicPoolAuthorization
+{
+
+    constructor(string memory poolName)
+        BasicPoolAuthorization(poolName)
+    {}
+
+
+    function _setupTargetAuthorizations()
+        internal
+        virtual override
+    {
+        super._setupTargetAuthorizations();
+        IAccess.FunctionInfo[] storage functions;
+
+        // authorize public role (also protected by onlyOwner)
+        functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
+
+        // only owner
+        _authorize(functions, FlightPool.createBundle.selector, "createBundle");
+        _authorize(functions, FlightPool.approveTokenHandler.selector, "approveTokenHandler");
+        _authorize(functions, FlightPool.setWallet.selector, "setWallet");
+    }
+}
+