@etherisc/gif-next 0.0.2-ffba655 → 3.0.0-1a7e54a-113

package/contracts/examples/flight/FlightProductAuthorization.sol

@@ -0,0 +1,44 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IAccess} from "../../../contracts/authorization/IAccess.sol";
+
+import {BasicProductAuthorization} from "../../product/BasicProductAuthorization.sol";
+import {FlightProduct} from "./FlightProduct.sol";
+import {ORACLE} from "../../../contracts/type/ObjectType.sol";
+import {PUBLIC_ROLE} from "../../../contracts/type/RoleId.sol";
+
+
+contract FlightProductAuthorization
+    is BasicProductAuthorization
+{
+
+    constructor(string memory poolName)
+        BasicProductAuthorization(poolName)
+    {}
+
+    function _setupTargetAuthorizations()
+        internal
+        virtual override
+    {
+        super._setupTargetAuthorizations();
+        IAccess.FunctionInfo[] storage functions;
+
+        // authorize oracle service
+        functions = _authorizeForTarget(getMainTargetName(), getServiceRole(ORACLE()));
+        _authorize(functions, FlightProduct.flightStatusCallback.selector, "flightStatusCallback");
+
+        // authorize public role (open access to any account, only allows to lock target)
+        functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
+        _authorize(functions, FlightProduct.createPolicy.selector, "createPolicy");
+
+        // only owner
+        _authorize(functions, FlightProduct.processFlightStatus.selector, "processFlightStatus");
+        _authorize(functions, FlightProduct.completeSetup.selector, "completeSetup");
+        _authorize(functions, FlightProduct.setDefaultBundle.selector, "setDefaultBundle");
+        _authorize(functions, FlightProduct.approveTokenHandler.selector, "approveTokenHandler");
+        _authorize(functions, FlightProduct.setLocked.selector, "setLocked");
+        _authorize(functions, FlightProduct.setWallet.selector, "setWallet");
+    }
+}
+

package/contracts/examples/flight/FlightUSD.sol

@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+
+/// @dev FireUSD is a stablecoin with 6 decimals and an initial supply of 1 Billion tokens. 
+contract FlightUSD is ERC20 {
+
+    string public constant NAME = "FlightUSD";
+    string public constant SYMBOL = "FLTD";
+    uint8 public constant DECIMALS = 6;
+    uint256 public constant INITIAL_SUPPLY = 10**12 * 10**DECIMALS; // 1'000'000'000'000
+    
+    constructor()
+        ERC20(NAME, SYMBOL)
+    {
+        _mint(
+            _msgSender(),
+            INITIAL_SUPPLY
+        );   
+    }
+
+    function decimals() public pure override returns(uint8) {
+        return DECIMALS;
+    }
+}

package/contracts/examples/flight/originalV1.sol

@@ -0,0 +1,396 @@
+// SPDX-License-Identifier: Apache-2.0
+// pragma solidity ^0.8.20;
+pragma solidity ^0.8.20;
+
+// import "@etherisc/gif-interface/contracts/0.7/Product.sol";
+
+// contract FlightDelayChainlink is Product {
+contract FlightDelayChainlink {
+
+    bytes32 public constant NAME = "FlightDelayChainlink";
+    bytes32 public constant VERSION = "0.1.6";
+
+    event LogRequestFlightRatings(uint256 requestId, bytes32 carrierFlightNumber, uint256 departureTime, uint256 arrivalTime, bytes32 riskId);
+    event LogRequestFlightStatus(uint256 requestId, uint256 arrivalTime, bytes32 carrierFlightNumber, bytes32 departureYearMonthDay);
+    event LogPayoutTransferred(bytes32 bpKey, uint256 claimId, uint256 payoutId, uint256 amount);
+    event LogError(string error, uint256 index, uint256 stored, uint256 calculated);
+    event LogUnprocessableStatus(bytes32 bpKey, uint256 requestId);
+    event LogPolicyExpired(bytes32 bpKey);
+    event LogRequestPayment(bytes32 bpKey, uint256 requestId);
+    event LogUnexpectedStatus(bytes32 bpKey, uint256 requestId, bytes1 status, int256 delay, address customer);
+
+    event LogCallback(bytes32 _bytes, bytes _data);
+
+
+    bytes32 public constant POLICY_FLOW = "PolicyFlowDefault";
+
+    // Minimum observations for valid prediction
+    uint256 public constant MIN_OBSERVATIONS = 10;
+    // Minimum time before departure for applying
+    uint256 public constant MIN_TIME_BEFORE_DEPARTURE = 14 * 24 hours;
+    // Maximum time before departure for applying
+    uint256 public constant MAX_TIME_BEFORE_DEPARTURE = 90 * 24 hours;
+    // Maximum duration of flight
+    uint256 public constant MAX_FLIGHT_DURATION = 2 days;
+    // Check for delay after .. minutes after scheduled arrival
+    uint256 public constant CHECK_OFFSET = 1 hours;
+
+    // uint256 public constant MIN_PREMIUM = 15 * 10 ** 18; // production
+    // All amounts in cent = multiplier is 10 ** 16!
+    uint256 public constant MIN_PREMIUM = 1500 * 10 ** 16; // for testing purposes
+    uint256 public constant MAX_PREMIUM = 1500 * 10 ** 16; // in cent
+    uint256 public constant MAX_PAYOUT = 75000  * 10 ** 16; // in cent
+    uint256 public constant MARGIN_PERCENT = 30;
+    string public constant RATINGS_CALLBACK = "flightRatingsCallback";
+    string public constant STATUSES_CALLBACK = "flightStatusCallback";
+
+    // ['observations','late15','late30','late45','cancelled','diverted']
+    uint8[6] public weightPattern = [0, 0, 0, 30, 50, 50];
+    uint8 public constant maxWeight = 50;
+
+    // Maximum cumulated weighted premium per risk
+    uint256 public constant MAX_TOTAL_PAYOUT = 3 * MAX_PAYOUT; // Maximum risk per flight is 3x max payout.
+
+    struct Risk {
+        bytes32 carrierFlightNumber;
+        bytes32 departureYearMonthDay;
+        uint256 departureTime;
+        uint256 arrivalTime;
+        uint delayInMinutes;
+        uint8 delay;
+        uint256 estimatedMaxTotalPayout;
+        uint256 premiumMultiplier;
+        uint256 weight;
+    }
+
+    mapping(bytes32 => Risk) public risks;
+    mapping(bytes32 => address) public bpKeyToAddress;
+    mapping(address => bytes32[]) public addressToBpKeys;
+    mapping(address => uint256) public addressToPolicyCount;
+
+    uint256 public uniqueIndex;
+    bytes32 public ratingsOracleType;
+    uint256 public ratingsOracleId;
+    bytes32 public statusesOracleType;
+    uint256 public statusesOracleId;
+
+    address public owner;
+
+    uint256 public productId;
+
+    // empty modifier to support compiling without inheritance from V1 product
+    modifier onlyOwner() { _; }
+    modifier onlyOracle() { _; }
+
+    constructor(
+        address _productServiceAddress,
+        bytes32 _ratingsOracleType,
+        uint256 _ratingsOracleId,
+        bytes32 _statusesOracleType,
+        uint256 _statusesOracleId
+    )
+        // Product(_productServiceAddress, NAME, POLICY_FLOW)
+    {
+        setOracles(_ratingsOracleType, _ratingsOracleId, _statusesOracleType, _statusesOracleId);
+    }
+
+    function setOracles(
+        bytes32 _ratingsOracleType,
+        uint256 _ratingsOracleId,
+        bytes32 _statusesOracleType,
+        uint256 _statusesOracleId
+    )
+        public
+        onlyOwner
+    {
+        ratingsOracleType = _ratingsOracleType;
+        ratingsOracleId = _ratingsOracleId;
+        statusesOracleType = _statusesOracleType;
+        statusesOracleId = _statusesOracleId;
+    }
+
+    function uniqueId(address _addr)
+        internal
+        returns (bytes32 _uniqueId)
+    {
+        uniqueIndex += 1;
+        return keccak256(abi.encode(_addr, productId, uniqueIndex));
+    }
+
+    function getValue() internal returns(uint256) {
+        return msg.value;
+    }
+
+    function applyForPolicy(
+        // domain specific
+        bytes32 _carrierFlightNumber,
+        bytes32 _departureYearMonthDay,
+        uint256 _departureTime,
+        uint256 _arrivalTime,
+        uint256[5] memory _payouts
+    ) external payable {
+        // Validate input parameters
+
+        uint256 premium = getValue();
+        bytes32 bpKey = uniqueId(msg.sender);
+
+        require(premium >= MIN_PREMIUM, "ERROR:FDD-001:INVALID_PREMIUM");
+        require(premium <= MAX_PREMIUM, "ERROR:FDD-002:INVALID_PREMIUM");
+        require(_arrivalTime > _departureTime, "ERROR:FDD-003:ARRIVAL_BEFORE_DEPARTURE_TIME");
+        /* for demo uncommented ********************************************************/
+        require(
+            _arrivalTime <= _departureTime + MAX_FLIGHT_DURATION,
+            "ERROR:FDD-004:INVALID_ARRIVAL/DEPARTURE_TIME"
+        );
+        require(
+            _departureTime >= block.timestamp + MIN_TIME_BEFORE_DEPARTURE,
+            "ERROR:FDD-012:INVALID_ARRIVAL/DEPARTURE_TIME"
+        );
+        require(
+            _departureTime <= block.timestamp + MAX_TIME_BEFORE_DEPARTURE,
+            "ERROR:FDD-005:INVALID_ARRIVAL/DEPARTURE_TIME"
+        );
+
+        // Create risk if not exists
+        bytes32 riskId = keccak256(abi.encode(_carrierFlightNumber, _departureTime, _arrivalTime));
+        Risk storage risk = risks[riskId];
+
+        if (risk.carrierFlightNumber == "") {
+            risk.carrierFlightNumber = _carrierFlightNumber;
+            risk.departureYearMonthDay = _departureYearMonthDay;
+            risk.departureTime = _departureTime;
+            risk.arrivalTime = _arrivalTime;
+        }
+
+        require (
+            premium * risk.premiumMultiplier + risk.estimatedMaxTotalPayout < MAX_TOTAL_PAYOUT,
+            "ERROR:FDD-006:CLUSTER_RISK"
+        );
+
+        // if this is the first policy for this flight,
+        // we "block" this risk by setting risk.estimatedMaxTotalPayout to
+        // the maximum. Next flight for this risk can only be insured after this one has been underwritten.
+        if (risk.estimatedMaxTotalPayout == 0) {
+            risk.estimatedMaxTotalPayout = MAX_TOTAL_PAYOUT;
+        }
+
+        // Create new application
+        // _newApplication(bpKey, abi.encode(premium, _payouts, msg.sender, riskId));
+
+        // // Request flight ratings
+        uint256 requestId; // = _request(
+        //     bpKey,
+        //     abi.encode(_carrierFlightNumber),
+        //     RATINGS_CALLBACK,
+        //     ratingsOracleType,
+        //     ratingsOracleId
+        // );
+
+        emit LogRequestFlightRatings(
+            requestId,
+            _carrierFlightNumber,
+            _departureTime,
+            _arrivalTime,
+            riskId
+        );
+
+        /**
+         * Record bpKey to address relation for easier lookup.
+         */
+        bpKeyToAddress[bpKey] = msg.sender;
+        addressToBpKeys[msg.sender].push(bpKey);
+        addressToPolicyCount[msg.sender] += 1;
+
+    }
+
+    function checkApplication(
+        bytes32 _carrierFlightNumber,
+        uint256 _departureTime,
+        uint256 _arrivalTime,
+        uint256 _premium
+    )
+    external view
+    returns (uint256 errors)
+    {
+        // Validate input parameters
+        if (_premium < MIN_PREMIUM) errors = errors | (uint256(1) << 0);
+        if (_premium > MAX_PREMIUM) errors = errors | (uint256(1) << 1);
+        if (_arrivalTime < _departureTime) errors = errors | (uint256(1) << 2);
+        if (_arrivalTime > _departureTime + MAX_FLIGHT_DURATION) errors = errors | (uint256(1) << 3);
+        if (_departureTime < block.timestamp + MIN_TIME_BEFORE_DEPARTURE) errors = errors | (uint256(1) << 4);
+        if (_departureTime > block.timestamp + MAX_TIME_BEFORE_DEPARTURE) errors = errors | (uint256(1) << 5);
+        bytes32 riskId = keccak256(abi.encode(_carrierFlightNumber, _departureTime, _arrivalTime));
+        Risk storage risk = risks[riskId];
+        if (_premium * risk.premiumMultiplier + risk.estimatedMaxTotalPayout >= MAX_TOTAL_PAYOUT) errors = errors | (uint256(1) << 6);
+
+        return errors;
+    }
+
+    function declineAndPayback(bytes32 _bpKey, address payable _customer, uint256 _premium)
+        internal
+    {
+        // _decline(_bpKey);
+        // _customer.transfer(_premium);
+    }
+
+    function flightRatingsCallback(
+        uint256 _requestId,
+        bytes32 _bpKey,
+        bytes calldata _response
+    ) external onlyOracle {
+
+        // Statistics: ['observations','late15','late30','late45','cancelled','diverted']
+        uint256[6] memory _statistics = abi.decode(_response, (uint256[6]));
+        uint256 premium;
+        uint256[5] memory payouts;
+        address payable customer;
+        // (uint256 premium, uint256[5] memory payouts, address payable customer, bytes32 riskId) =
+        // abi.decode(_getApplicationData(_bpKey), (uint256,uint256[5],address,bytes32));
+        // if (_statistics[0] < MIN_OBSERVATIONS) {
+        //     declineAndPayback(_bpKey, customer, premium);
+        //     return;
+        // }
+
+        (uint256 weight, uint256[5] memory calculatedPayouts) = calculatePayouts(premium, _statistics);
+        Risk storage risk; // = risks[riskId];
+
+        for (uint256 i = 0; i < 5; i++) {
+            if (calculatedPayouts[i] > MAX_PAYOUT) {
+                emit LogError("ERROR:FDD-007:PAYOUT_GT_MAXPAYOUT", i, payouts[i], calculatedPayouts[i]);
+                declineAndPayback(_bpKey, customer, premium);
+                return;
+            }
+            if (calculatedPayouts[i] != payouts[i]) {
+                emit LogError("ERROR:FDD-008:INVALID_PAYOUT_OPTION", i, payouts[i], calculatedPayouts[i]);
+                declineAndPayback(_bpKey, customer, premium);
+                return;
+            }
+        }
+
+        // It's the first policy for this risk, we accept any premium
+        // REMARK: all policy holders for this flight will share the same max payout estimates
+        // trends during the onboarding of policies are not considered
+        // if (risk.premiumMultiplier == 0) {
+        //     risk.premiumMultiplier = maxWeight * 10000 / weight;
+        //     risk.estimatedMaxTotalPayout = 0;
+        // }
+        // uint256 estimatedMaxPayout = premium * risk.premiumMultiplier;
+        // if (estimatedMaxPayout > MAX_PAYOUT) { estimatedMaxPayout = MAX_PAYOUT; }
+        // risk.estimatedMaxTotalPayout = risk.estimatedMaxTotalPayout + estimatedMaxPayout;
+        // risk.weight = weight;
+
+        // _underwrite(_bpKey);
+
+        // uint256 requestId = _request(
+        //     _bpKey,
+        //     abi.encode(
+        //         risk.arrivalTime + CHECK_OFFSET,
+        //         risk.carrierFlightNumber,
+        //         risk.departureYearMonthDay
+        //     ),
+        //     STATUSES_CALLBACK,
+        //     statusesOracleType,
+        //     statusesOracleId
+        // );
+
+        // Now everything is prepared
+        // address(RiskPool).transfer(premium);
+
+        // emit LogRequestFlightStatus(
+        //     requestId,
+        //     risk.arrivalTime + CHECK_OFFSET,
+        //     risk.carrierFlightNumber,
+        //     risk.departureYearMonthDay
+        // );
+    }
+
+    function flightStatusCallback(uint256 _requestId, bytes32 _bpKey, bytes calldata _response)
+        external
+        onlyOracle
+    {
+        (bytes1 status, int256 delay) = abi.decode(_response, (bytes1, int256));
+        // (/* uint256 premium */, uint256[5] memory payouts, address payable customer, /* bytes32 riskId */) =
+        // abi.decode(_getApplicationData(_bpKey), (uint256,uint256[5],address,bytes32));
+
+        if (status != "L" && status != "A" && status != "C" && status != "D") {
+            emit LogUnprocessableStatus(_bpKey, _requestId);
+            return;
+        }
+
+        if (status == "A") {
+            // todo: active, reschedule oracle call + 45 min
+            // emit LogUnexpectedStatus(_bpKey, _requestId, status, delay, customer);
+            return;
+        }
+
+        // if (status == "C") {
+        //     resolvePayout(_bpKey, payouts[3], customer);
+        // } else if (status == "D") {
+        //     resolvePayout(_bpKey, payouts[4], customer);
+        // } else if (delay >= 15 && delay < 30) {
+        //     resolvePayout(_bpKey, payouts[0], customer);
+        // } else if (delay >= 30 && delay < 45) {
+        //     resolvePayout(_bpKey, payouts[1], customer);
+        // } else if (delay >= 45) {
+        //     resolvePayout(_bpKey, payouts[2], customer);
+        // } else {
+        //     resolvePayout(_bpKey, 0, customer);
+        // }
+    }
+
+    function resolvePayout(bytes32 _bpKey, uint256 _payoutAmount, address payable _customer) internal {
+        if (_payoutAmount == 0) {
+            // _expire(_bpKey);
+            emit LogPolicyExpired(_bpKey);
+        } else {
+            // uint256 claimId = _newClaim(_bpKey, abi.encode(_payoutAmount));
+            // uint256 payoutId = _confirmClaim(_bpKey, claimId, abi.encode(_payoutAmount));
+            // _payout(_bpKey, payoutId, true, abi.encode(_payoutAmount));
+            _customer.transfer(_payoutAmount);
+            // emit LogPayoutTransferred(_bpKey, claimId, payoutId, _payoutAmount);
+        }
+    }
+
+    function calculatePayouts(uint256 _premium, uint256[6] memory _statistics)
+        public
+        view
+        returns (uint256 _weight, uint256[5] memory _payoutOptions)
+    {
+        require(_premium >= MIN_PREMIUM, "ERROR:FDD-009:INVALID_PREMIUM");
+        require(_premium <= MAX_PREMIUM, "ERROR:FDD-010:INVALID_PREMIUM");
+        require(_statistics[0] >= MIN_OBSERVATIONS, "ERROR:FDD-011:LOW_OBSERVATIONS");
+
+        _weight = 0;
+        _payoutOptions = [uint256(0), 0, 0, 0, 0];
+
+        for (uint256 i = 1; i < 6; i++) {
+            _weight += weightPattern[i] * _statistics[i] * 10000 / _statistics[0];
+            // 1% = 100 / 100% = 10,000
+        }
+
+        // To avoid div0 in the payout section, we have to make a minimal assumption on weight
+        if (_weight == 0) {
+            _weight = 100000 / _statistics[0];
+        }
+
+        _weight = _weight * (100 + MARGIN_PERCENT) / 100;
+
+        for (uint256 i = 0; i < 5; i++) {
+            _payoutOptions[i] = _premium * weightPattern[i + 1] * 10000 / _weight;
+
+            if (_payoutOptions[i] > MAX_PAYOUT) {
+                _payoutOptions[i] = MAX_PAYOUT;
+            }
+        }
+    }
+
+    function faucet(uint256 _amount) // for testing only
+        public
+        onlyOwner
+    {
+        require(_amount <= address(this).balance);
+        address payable receiver;
+        receiver = payable(owner);
+        receiver.transfer(_amount);
+    }
+}

package/contracts/examples/unpermissioned/SimpleDistribution.sol

@@ -0,0 +1,81 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {Amount} from "../../type/Amount.sol";
+import {BasicDistribution} from "../../distribution/BasicDistribution.sol";
+import {IAuthorization} from "../../authorization/IAuthorization.sol";
+import {NftId} from "../../type/NftId.sol";
+import {ReferralId} from "../../type/Referral.sol";
+import {Timestamp, TimestampLib} from "../../type/Timestamp.sol";
+import {UFixed, UFixedLib} from "../../type/UFixed.sol";
+
+
+contract SimpleDistribution is
+    BasicDistribution
+{
+    
+    constructor(
+        address registry,
+        NftId productNftId,
+        IAuthorization authorization,
+        address initialOwner
+    ) 
+    {
+        initialize(
+            registry,
+            productNftId,
+            authorization,
+            initialOwner,
+            "SimpleDistribution");
+    }
+
+    function initialize(
+        address registry,
+        NftId productNftId,
+        IAuthorization authorization,
+        address initialOwner,
+        string memory name
+    )
+        public
+        virtual
+        initializer()
+    {
+        _initializeBasicDistribution(
+            registry,
+            productNftId,
+            authorization,
+            initialOwner,
+            name);
+    }
+
+    function approveTokenHandler(IERC20Metadata token, Amount amount) external restricted() onlyOwner() { _approveTokenHandler(token, amount); }
+    function setLocked(bool locked) external onlyOwner() { _setLocked(locked); }
+    function setWallet(address newWallet) external restricted() onlyOwner() { _setWallet(newWallet); }
+
+    /**
+     * @dev create referral codes. This is required for testing only to provide a distributor that is not the message sender. 
+     */
+    function createReferral2(
+        NftId distributorNftId,
+        string memory code,
+        UFixed discountPercentage,
+        uint32 maxReferrals,
+        Timestamp expiryAt,
+        bytes memory data
+    )
+        external
+        virtual
+        returns (ReferralId referralId)
+    {
+        return _createReferral(
+            distributorNftId,
+            code,
+            discountPercentage,
+            maxReferrals,
+            expiryAt,
+            data); // data
+    }
+
+}

package/contracts/examples/unpermissioned/SimpleDistributionAuthorization.sol

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {BasicDistributionAuthorization} from "../../distribution/BasicDistributionAuthorization.sol";
+import {IAccess} from "../../authorization/IAccess.sol";
+import {PUBLIC_ROLE} from "../../type/RoleId.sol";
+import {SimpleDistribution} from "./SimpleDistribution.sol";
+
+contract SimpleDistributionAuthorization
+    is BasicDistributionAuthorization
+{
+    constructor(string memory componentName)
+        BasicDistributionAuthorization(componentName)
+    {}
+
+    function _setupTargetAuthorizations()
+        internal
+        virtual override
+    {
+        super._setupTargetAuthorizations();
+
+        // authorize public role (open access to any account, only allows to lock target)
+        IAccess.FunctionInfo[] storage functions;
+        functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
+        _authorize(functions, SimpleDistribution.approveTokenHandler.selector, "approveTokenHandler");
+        _authorize(functions, SimpleDistribution.setWallet.selector, "setWallet");
+    }
+}