@etherisc/gif-next 3.0.0-f90c901-018 → 3.0.0-fbbe3fc-042

package/contracts/distribution/DistributionService.sol

@@ -20,6 +20,8 @@ import {KEEP_STATE} from "../type/StateId.sol";
 import {ObjectType, ACCOUNTING, COMPONENT, DISTRIBUTION, INSTANCE, DISTRIBUTION, DISTRIBUTOR, REGISTRY} from "../type/ObjectType.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
+// TODO PoolLib feels wrong, should likely go in a component type independent lib
+import {PoolLib} from "../pool/PoolLib.sol";
 import {ReferralId, ReferralStatus, ReferralLib, REFERRAL_OK, REFERRAL_ERROR_UNKNOWN, REFERRAL_ERROR_EXPIRED, REFERRAL_ERROR_EXHAUSTED} from "../type/Referral.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {Service} from "../shared/Service.sol";
@@ -42,13 +44,14 @@ contract DistributionService 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);
 
         _accountingService = IAccountingService(_getServiceAddress(ACCOUNTING()));
         _componentService = IComponentService(_getServiceAddress(COMPONENT()));
@@ -78,7 +81,7 @@ contract DistributionService is
         (NftId distributionNftId, IInstance instance) = _getAndVerifyActiveDistribution();
 
         {
-            NftId productNftId = _getRegistry().getParentNftId(distributionNftId);
+            NftId productNftId = getRegistry().getParentNftId(distributionNftId);
             IComponents.FeeInfo memory feeInfo = instance.getInstanceReader().getFeeInfo(productNftId);
 
             UFixed variableDistributionFees = feeInfo.distributionFee.fractionalFee;
@@ -131,12 +134,11 @@ contract DistributionService is
                 NftIdLib.zero(), 
                 distributionNftId,
                 DISTRIBUTOR(),
-                getRelease(),
                 true, // intercepting property for bundles is defined on pool
-                address(0)),
-            distributor,
-            ""
-        );
+                address(0),
+                distributor,
+                ""
+            ));
 
         IDistribution.DistributorInfo memory info = IDistribution.DistributorInfo({
             distributorType: distributorType,
@@ -195,11 +197,9 @@ contract DistributionService is
             revert ErrorDistributionServiceExpirationInvalid(expiryAt);
         }
 
-        {
-            NftId distributorDistributionNftId = _getRegistry().getParentNftId(distributorNftId);
-            if (distributorDistributionNftId != distributionNftId) {
-                revert ErrorDistributionServiceDistributorDistributionMismatch(distributorNftId, distributorDistributionNftId, distributionNftId);
-            }
+        NftId distributorDistributionNftId = getRegistry().getParentNftId(distributorNftId);
+        if (distributorDistributionNftId != distributionNftId) {
+            revert ErrorDistributionServiceDistributorDistributionMismatch(distributorNftId, distributorDistributionNftId, distributionNftId);
         }
 
         {
@@ -251,7 +251,7 @@ contract DistributionService is
         onlyNftOfType(distributionNftId, DISTRIBUTION())
     {
         if (referralIsValid(distributionNftId, referralId)) {
-            IInstance instance = IInstance(ContractLib.getInstanceForComponent(distributionNftId));
+            IInstance instance = IInstance(ContractLib.getInstanceForComponent(getRegistry(), distributionNftId));
 
             // update book keeping for referral info
             IDistribution.ReferralInfo memory referralInfo = instance.getInstanceReader().getReferralInfo(referralId);
@@ -272,7 +272,7 @@ contract DistributionService is
         restricted()
         onlyNftOfType(distributionNftId, DISTRIBUTION())
     {
-        IInstance instance = IInstance(ContractLib.getInstanceForComponent(distributionNftId));
+        IInstance instance = IInstance(ContractLib.getInstanceForComponent(getRegistry(), distributionNftId));
         InstanceReader reader = instance.getInstanceReader();
         InstanceStore store = instance.getInstanceStore();
 
@@ -340,7 +340,7 @@ contract DistributionService is
 
         // transfer amount to distributor
         {
-            address distributor = _getRegistry().ownerOf(distributorNftId);
+            address distributor = getRegistry().ownerOf(distributorNftId);
             emit LogDistributionServiceCommissionWithdrawn(distributorNftId, distributor, address(distributionInfo.tokenHandler.TOKEN()), withdrawnAmount);
             distributionInfo.tokenHandler.pushToken(distributor, withdrawnAmount);
         }
@@ -357,7 +357,7 @@ contract DistributionService is
             return false;
         }
 
-        IInstance instance = IInstance(ContractLib.getInstanceForComponent(distributionNftId));
+        IInstance instance = IInstance(ContractLib.getInstanceForComponent(getRegistry(), distributionNftId));
         IDistribution.ReferralInfo memory info = instance.getInstanceReader().getReferralInfo(referralId);
 
         if (info.distributorNftId.eqz()) {
@@ -438,11 +438,7 @@ contract DistributionService is
             IInstance instance
         )
     {
-        (poolNftId, instance) = ContractLib.getAndVerifyComponent(
-            msg.sender, 
-            DISTRIBUTION(), 
-            getRelease(), 
-            true);
+        return PoolLib.getAndVerifyActiveComponent(getRegistry(), msg.sender, DISTRIBUTION());
     }
 
 

package/contracts/distribution/DistributionServiceManager.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 {DistributionService} from "./DistributionService.sol";
 
@@ -12,17 +12,19 @@ contract DistributionServiceManager is ProxyManager {
     /// @dev initializes proxy manager with distribution service implementation and deploys instance
     constructor(
         address authority, 
+        address registry,
         bytes32 salt
     ) 
     {
         DistributionService svc = new DistributionService{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);
 
-        _distributionService = DistributionService(address(upgradeable));
+        _distributionService = DistributionService(address(versionable));
     }
 
     //--- view functions ----------------------------------------------------//

package/contracts/examples/fire/FirePool.sol

@@ -16,6 +16,7 @@ contract FirePool is
     BasicPool
 {   
     constructor(
+        address registry,
         NftId fireProductNftId,
         string memory componentName,
         IAuthorization authorization
@@ -23,6 +24,7 @@ contract FirePool is
     {
         address initialOwner = msg.sender;
         _intialize(
+            registry,
             fireProductNftId,
             componentName,
             IComponents.PoolInfo({
@@ -39,6 +41,7 @@ contract FirePool is
     }
 
     function _intialize(
+        address registry,
         NftId fireProductNftId,
         string memory componentName,
         IComponents.PoolInfo memory poolInfo,
@@ -49,6 +52,7 @@ contract FirePool is
         initializer
     {
         _initializeBasicPool(
+            registry,
             fireProductNftId,
             componentName,
             poolInfo,

package/contracts/examples/fire/FireProduct.sol

@@ -65,6 +65,7 @@ contract FireProduct is
     mapping(uint256 fireId => mapping (NftId policyId => bool claimed)) private _claimed;
 
     constructor(
+        address registry,
         NftId instanceNftid,
         string memory componentName,
         IAuthorization authorization
@@ -73,6 +74,7 @@ contract FireProduct is
         address initialOwner = msg.sender;
 
         _initialize(
+            registry,
             instanceNftid,
             componentName,
             authorization,
@@ -80,6 +82,7 @@ contract FireProduct is
     }
 
     function _initialize(
+        address registry,
         NftId instanceNftId,
         string memory componentName,
         IAuthorization authorization,
@@ -89,6 +92,7 @@ contract FireProduct is
         initializer
     {
         _initializeBasicProduct(
+            registry,
             instanceNftId,
             componentName,
             IComponents.ProductInfo({

package/contracts/examples/flight/FlightLib.sol

@@ -0,0 +1,300 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IPolicy} from "../../instance/module/IPolicy.sol";
+import {IPolicyService} from "../../product/IPolicyService.sol";
+
+import {Amount, AmountLib} from "../../type/Amount.sol";
+import {FlightMessageVerifier} from "./FlightMessageVerifier.sol";
+import {FlightProduct} from "./FlightProduct.sol";
+import {InstanceReader} from "../../instance/InstanceReader.sol";
+import {NftId} from "../../type/NftId.sol";
+import {RequestId} from "../../type/RequestId.sol";
+import {RiskId, RiskIdLib} from "../../type/RiskId.sol";
+import {StateId} from "../../type/StateId.sol";
+import {Str} from "../../type/String.sol";
+import {Timestamp, TimestampLib} from "../../type/Timestamp.sol";
+
+
+library FlightLib {
+
+    function checkApplicationData(
+        FlightProduct flightProduct,
+        Str flightData, 
+        Timestamp departureTime,
+        Timestamp arrivalTime,
+        Amount premiumAmount
+    )
+        public
+        view
+    {
+        _checkApplicationData(flightProduct, premiumAmount, arrivalTime, departureTime);
+    }
+
+
+    function _checkApplicationData(
+        FlightProduct flightProduct,
+        Amount premiumAmount,
+        Timestamp arrivalTime,
+        Timestamp departureTime
+    )
+        internal
+        view
+    {
+        bool testMode = flightProduct.isTestMode();
+
+        // solhint-disable
+        if (premiumAmount < flightProduct.MIN_PREMIUM()) {
+            revert FlightProduct.ErrorFlightProductPremiumAmountTooSmall(premiumAmount, flightProduct.MIN_PREMIUM());
+        }
+        if (premiumAmount > flightProduct.MAX_PREMIUM()) {
+            revert FlightProduct.ErrorFlightProductPremiumAmountTooLarge(premiumAmount, flightProduct.MAX_PREMIUM());
+        }
+        if (arrivalTime <= departureTime) {
+            revert FlightProduct.ErrorFlightProductArrivalBeforeDepartureTime(departureTime, arrivalTime);
+        }
+
+        // test mode allows the creation for policies that ore not time constrained
+        if (!testMode && arrivalTime > departureTime.addSeconds(flightProduct.MAX_FLIGHT_DURATION())) {
+            revert FlightProduct.ErrorFlightProductArrivalAfterMaxFlightDuration(arrivalTime, departureTime, flightProduct.MAX_FLIGHT_DURATION());
+        }
+        if (!testMode && departureTime < TimestampLib.current().addSeconds(flightProduct.MIN_TIME_BEFORE_DEPARTURE())) {
+            revert FlightProduct.ErrorFlightProductDepartureBeforeMinTimeBeforeDeparture(departureTime, TimestampLib.current(), flightProduct.MIN_TIME_BEFORE_DEPARTURE());
+        }
+        if (!testMode && departureTime > TimestampLib.current().addSeconds(flightProduct.MAX_TIME_BEFORE_DEPARTURE())) {
+            revert FlightProduct.ErrorFlightProductDepartureAfterMaxTimeBeforeDeparture(departureTime, TimestampLib.current(), flightProduct.MAX_TIME_BEFORE_DEPARTURE());
+        }
+        // solhint-enable
+    }
+
+
+    /// @dev calculates payout option based on flight status and delay minutes.
+    /// Is not a view function as it emits log evens in case of unexpected status.
+    // TODO decide if reverts instead of log events could work too (and convert the function into a view function)
+    function checkAndGetPayoutOption(
+        RequestId requestId,
+        RiskId riskId, 
+        bytes1 status, 
+        int256 delayMinutes
+    )
+        public
+        returns (uint8 payoutOption)
+    {
+        // default: no payout
+        payoutOption = type(uint8).max;
+
+        // check status
+        if (status != "L" && status != "A" && status != "C" && status != "D") {
+            emit FlightProduct.LogErrorUnprocessableStatus(requestId, riskId, status);
+            return payoutOption;
+        }
+
+        if (status == "A") {
+            // todo: active, reschedule oracle call + 45 min
+            emit FlightProduct.LogErrorUnexpectedStatus(requestId, riskId, status, delayMinutes);
+            return payoutOption;
+        }
+
+        // trigger payout if applicable
+        if (status == "C") { payoutOption = 3; } 
+        else if (status == "D") { payoutOption = 4; } 
+        else if (delayMinutes >= 15 && delayMinutes < 30) { payoutOption = 0; } 
+        else if (delayMinutes >= 30 && delayMinutes < 45) { payoutOption = 1; } 
+        else if (delayMinutes >= 45) { payoutOption = 2; }
+    }
+
+
+    function calculateWeight(
+        FlightProduct flightProduct,
+        uint256[6] memory statistics
+    )
+        public
+        view
+        returns (uint256 weight)
+    {
+        // check we have enough observations
+        if (statistics[0] < flightProduct.MIN_OBSERVATIONS()) {
+            revert FlightProduct.ErrorFlightProductNotEnoughObservations(statistics[0], flightProduct.MIN_OBSERVATIONS());
+        }
+
+        weight = 0;
+        for (uint256 i = 1; i < 6; i++) {
+            weight += flightProduct.WEIGHT_PATTERN(i) * statistics[i] * 10000 / statistics[0];
+        }
+
+        // To avoid div0 in the payout section, we have to make a minimal assumption on weight
+        if (weight == 0) {
+            weight = 100000 / statistics[0];
+        }
+
+        // TODO comment on intended effect
+        weight = (weight * (100 + flightProduct.MARGIN_PERCENT())) / 100;
+    }
+
+
+    // REMARK: each flight may get different payouts depending on the latest statics
+    function calculatePayoutAmounts(
+        FlightProduct flightProduct,
+        Amount premium, 
+        uint256[6] memory statistics
+    )
+        public
+        view
+        returns (
+            uint256 weight, 
+            Amount[5] memory payoutAmounts,
+            Amount sumInsuredAmount // simply the max of payoutAmounts 
+        )
+    {
+        if (premium < flightProduct.MIN_PREMIUM()) { 
+            revert FlightProduct.ErrorFlightProductPremiumAmountTooSmall(premium, flightProduct.MIN_PREMIUM()); 
+        }
+        if (premium > flightProduct.MAX_PREMIUM()) { 
+            revert FlightProduct.ErrorFlightProductPremiumAmountTooLarge(premium, flightProduct.MAX_PREMIUM()); 
+        }
+
+        sumInsuredAmount = AmountLib.zero();
+        weight = calculateWeight(flightProduct, statistics);
+
+        for (uint256 i = 0; i < 5; i++) {
+            Amount payoutAmount = AmountLib.toAmount(
+                premium.toInt() * flightProduct.WEIGHT_PATTERN(i + 1) * 10000 / weight);
+
+            // cap payout and update sum insured if applicable
+            if (payoutAmount > flightProduct.MAX_PAYOUT()) { payoutAmount = flightProduct.MAX_PAYOUT(); }
+            if (payoutAmount > sumInsuredAmount) { sumInsuredAmount = payoutAmount; }
+
+            payoutAmounts[i] = payoutAmount;
+        }
+    }
+
+
+    function getPayoutOption(
+        InstanceReader reader,
+        NftId productNftId,
+        RiskId riskId
+    )
+        public
+        view
+        returns (
+            bool exists,
+            bool statusAvailable,
+            uint8 payoutOption
+        )
+    {
+        FlightProduct.FlightRisk memory flightRisk;
+        (exists, flightRisk) = getFlightRisk(
+            reader, 
+            productNftId, 
+            riskId);
+        
+        statusAvailable = flightRisk.statusUpdatedAt.gtz();
+        payoutOption = flightRisk.payoutOption;
+    }
+
+
+    function getPayoutAmount(
+        bytes memory applicationData, 
+        uint8 payoutOption
+    )
+        public
+        pure
+        returns (Amount payoutAmount)
+    {
+        // retrieve payout amounts from application data
+        (, Amount[5] memory payoutAmounts) = abi.decode(
+            applicationData, (Amount, Amount[5]));
+
+        // get payout amount for selected option
+        payoutAmount = payoutAmounts[payoutOption];
+    }
+
+
+    function getFlightRisk(
+        InstanceReader reader,
+        NftId productNftId, 
+        Str flightData,
+        Timestamp departureTime, 
+        string memory departureTimeLocal,
+        Timestamp arrivalTime,
+        string memory arrivalTimeLocal
+    )
+        public
+        view
+        returns (
+            RiskId riskId,
+            bool exists,
+            FlightProduct.FlightRisk memory flightRisk
+        )
+    {
+        riskId = getRiskId(productNftId, flightData);
+        (exists, flightRisk) = getFlightRisk(reader, productNftId, riskId);
+
+        // create new risk if not existing
+        if (!exists) {
+            flightRisk = FlightProduct.FlightRisk({
+                flightData: flightData,
+                departureTime: departureTime,
+                departureTimeLocal: departureTimeLocal,
+                arrivalTime: arrivalTime,
+                arrivalTimeLocal: arrivalTimeLocal,
+                sumOfSumInsuredAmounts: AmountLib.toAmount(0),
+                status: bytes1(0),
+                delayMinutes: 0,
+                payoutOption: uint8(0),
+                statusUpdatedAt: TimestampLib.zero()});
+        }
+    }
+
+
+    function getFlightRisk(
+        InstanceReader reader,
+        NftId productNftId,
+        RiskId riskId
+    )
+        public
+        view
+        returns (
+            bool exists,
+            FlightProduct.FlightRisk memory flightRisk
+        )
+    {
+        // check if risk exists
+        exists = reader.isProductRisk(productNftId, riskId);
+
+        // get risk data if risk exists
+        if (exists) {
+            flightRisk = abi.decode(
+                reader.getRiskInfo(riskId).data, (FlightProduct.FlightRisk));
+        }
+    }
+
+
+    function getRiskId(
+        NftId productNftId,
+        Str flightData
+    )
+        public
+        view 
+        returns (RiskId riskId)
+    {
+        bytes32 riskKey = getRiskKey(flightData);
+        riskId = getRiskId(productNftId, riskKey);
+    }
+
+
+    function getRiskKey(
+        Str flightData
+    )
+        internal
+        pure
+        returns (bytes32 riskKey)
+    {
+        return keccak256(abi.encode(flightData));
+    }
+
+
+    function getRiskId(NftId productNftId, bytes32 riskKey) internal view returns (RiskId riskId) {
+        return RiskIdLib.toRiskId(productNftId, riskKey);
+    }
+}

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;
+    // }
+}