@etherisc/gif-next 3.0.0-dd00d66-173 → 3.0.0-eb61cc5-192

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

@@ -11,6 +11,7 @@ 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 {Seconds} from "../../type/Seconds.sol";
 import {StateId} from "../../type/StateId.sol";
 import {Str} from "../../type/String.sol";
 import {Timestamp, TimestampLib} from "../../type/Timestamp.sol";
@@ -18,39 +19,30 @@ import {Timestamp, TimestampLib} from "../../type/Timestamp.sol";
 
 library FlightLib {
 
-    function checkApplicationDataAndSignature(
+    event LogFlightProductErrorUnprocessableStatus(RequestId requestId, RiskId riskId, bytes1 status);
+    event LogFlightProductErrorUnexpectedStatus(RequestId requestId, RiskId riskId, bytes1 status, int256 delayMinutes);
+
+    error ErrorFlightProductRiskInvalid(RiskId riskId);
+    error ErrorFlightProductPremiumAmountTooSmall(Amount premiumAmount, Amount minPremium);
+    error ErrorFlightProductPremiumAmountTooLarge(Amount premiumAmount, Amount maxPremium);
+    error ErrorFlightProductArrivalBeforeDepartureTime(Timestamp departureTime, Timestamp arrivalTime);
+    error ErrorFlightProductArrivalAfterMaxFlightDuration(Timestamp arrivalTime, Timestamp maxArrivalTime, Seconds maxDuration);
+    error ErrorFlightProductDepartureBeforeMinTimeBeforeDeparture(Timestamp departureTime, Timestamp now, Seconds minTimeBeforeDeparture);
+    error ErrorFlightProductDepartureAfterMaxTimeBeforeDeparture(Timestamp departureTime, Timestamp now, Seconds maxTimeBeforeDeparture);
+    error ErrorFlightProductNotEnoughObservations(uint256 observations, uint256 minObservations);
+    error ErrorFlightProductClusterRisk(Amount totalSumInsured, Amount maxTotalPayout);
+
+    function checkApplicationData(
         FlightProduct flightProduct,
         Str flightData, 
         Timestamp departureTime,
         Timestamp arrivalTime,
-        Amount premiumAmount,
-        uint256[6] memory statistics
-        // signature fields
-        // uint8 v, 
-        // bytes32 r, 
-        // bytes32 s
+        Amount premiumAmount
     )
         public
         view
     {
         _checkApplicationData(flightProduct, premiumAmount, arrivalTime, departureTime);
-
-        // (
-        //     address actualSigner,,
-        //     bool success
-        // ) = flightProduct.getFlightMessageVerifier().verifyRatingsHash(
-        //     flightData,
-        //     departureTime,
-        //     arrivalTime,
-        //     premiumAmount,
-        //     statistics,
-        //     v, r, s);
-
-        // if (!success) {
-        //     revert FlightProduct.ErrorApplicationDataSignatureMismatch(
-        //         flightProduct.getFlightMessageVerifier().getExpectedSigner(),
-        //         actualSigner);
-        // }
     }
 
 
@@ -63,67 +55,49 @@ library FlightLib {
         internal
         view
     {
+        bool testMode = flightProduct.isTestMode();
+
         // solhint-disable
         if (premiumAmount < flightProduct.MIN_PREMIUM()) {
-            revert FlightProduct.ErrorFlightProductPremiumAmountTooSmall(premiumAmount, flightProduct.MIN_PREMIUM());
+            revert ErrorFlightProductPremiumAmountTooSmall(premiumAmount, flightProduct.MIN_PREMIUM());
         }
         if (premiumAmount > flightProduct.MAX_PREMIUM()) {
-            revert FlightProduct.ErrorFlightProductPremiumAmountTooLarge(premiumAmount, flightProduct.MAX_PREMIUM());
+            revert ErrorFlightProductPremiumAmountTooLarge(premiumAmount, flightProduct.MAX_PREMIUM());
         }
         if (arrivalTime <= departureTime) {
-            revert FlightProduct.ErrorFlightProductArrivalBeforeDepartureTime(departureTime, arrivalTime);
+            revert ErrorFlightProductArrivalBeforeDepartureTime(departureTime, arrivalTime);
         }
-
         if (arrivalTime > departureTime.addSeconds(flightProduct.MAX_FLIGHT_DURATION())) {
-            revert FlightProduct.ErrorFlightProductArrivalAfterMaxFlightDuration(arrivalTime, departureTime, flightProduct.MAX_FLIGHT_DURATION());
+            revert ErrorFlightProductArrivalAfterMaxFlightDuration(arrivalTime, departureTime, flightProduct.MAX_FLIGHT_DURATION());
         }
-        if (departureTime < TimestampLib.current().addSeconds(flightProduct.MIN_TIME_BEFORE_DEPARTURE())) {
-            revert FlightProduct.ErrorFlightProductDepartureBeforeMinTimeBeforeDeparture(departureTime, TimestampLib.current(), flightProduct.MIN_TIME_BEFORE_DEPARTURE());
+
+        // test mode allows the creation for policies that are outside restricted policy creation times
+        if (!testMode && departureTime < TimestampLib.current().addSeconds(flightProduct.MIN_TIME_BEFORE_DEPARTURE())) {
+            revert ErrorFlightProductDepartureBeforeMinTimeBeforeDeparture(departureTime, TimestampLib.current(), flightProduct.MIN_TIME_BEFORE_DEPARTURE());
         }
-        if (departureTime > TimestampLib.current().addSeconds(flightProduct.MAX_TIME_BEFORE_DEPARTURE())) {
-            revert FlightProduct.ErrorFlightProductDepartureAfterMaxTimeBeforeDeparture(departureTime, TimestampLib.current(), flightProduct.MAX_TIME_BEFORE_DEPARTURE());
+        if (!testMode && departureTime > TimestampLib.current().addSeconds(flightProduct.MAX_TIME_BEFORE_DEPARTURE())) {
+            revert ErrorFlightProductDepartureAfterMaxTimeBeforeDeparture(departureTime, TimestampLib.current(), flightProduct.MAX_TIME_BEFORE_DEPARTURE());
         }
         // solhint-enable
     }
 
 
-    // TODO fix or cleanup
-    // function checkApplication(
-    //     FlightProduct flightProduct,
-    //     Str carrierFlightNumber,
-    //     Timestamp departureTime,
-    //     Timestamp arrivalTime,
-    //     Amount premium
-    // )
-    //     external
-    //     view
-    //     returns (uint256 errors)
-    // {
-    //     // Validate input parameters
-    //     if (premium < flightProduct.MIN_PREMIUM()) { errors = errors | (uint256(1) << 0); }
-    //     if (premium > flightProduct.MAX_PREMIUM()) { errors = errors | (uint256(1) << 1); }
-    //     if (arrivalTime < departureTime) { errors = errors | (uint256(1) << 2); }
-    //     if (arrivalTime > departureTime.addSeconds(flightProduct.MAX_FLIGHT_DURATION())) { errors = errors | (uint256(1) << 3); }
-    //     if (departureTime < TimestampLib.current().addSeconds(flightProduct.MIN_TIME_BEFORE_DEPARTURE())) { errors = errors | (uint256(1) << 4); }
-    //     if (departureTime > TimestampLib.current().addSeconds(flightProduct.MAX_TIME_BEFORE_DEPARTURE())) { errors = errors | (uint256(1) << 5); }
-
-    //     (, bool exists, FlightProduct.FlightRisk memory flightRisk) = getFlightRisk(
-    //         flightProduct.getInstanceReader(), flightProduct.getNftId(), carrierFlightNumber, departureTime, arrivalTime);
-
-    //     if (exists) {
-    //         Amount sumInsured = AmountLib.toAmount(premium.toInt() * flightRisk.premiumMultiplier);
-    //         if (flightRisk.sumOfSumInsuredAmounts + sumInsured > flightProduct.MAX_TOTAL_PAYOUT()) {
-    //             errors = errors | (uint256(1) << 6);
-    //         }
-    //     }
-
-    //     return errors;
-    // }
+    function checkClusterRisk(
+        Amount sumOfSumInsuredAmounts,
+        Amount sumInsuredAmount,
+        Amount maxTotalPayout
+    )
+        public
+        pure
+    {
+        if (sumOfSumInsuredAmounts + sumInsuredAmount > maxTotalPayout) {
+            revert ErrorFlightProductClusterRisk(sumOfSumInsuredAmounts + sumInsuredAmount, maxTotalPayout);
+        }
+    }
 
 
     /// @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, 
@@ -138,13 +112,13 @@ library FlightLib {
 
         // check status
         if (status != "L" && status != "A" && status != "C" && status != "D") {
-            emit FlightProduct.LogErrorUnprocessableStatus(requestId, riskId, status);
+            emit LogFlightProductErrorUnprocessableStatus(requestId, riskId, status);
             return payoutOption;
         }
 
         if (status == "A") {
             // todo: active, reschedule oracle call + 45 min
-            emit FlightProduct.LogErrorUnexpectedStatus(requestId, riskId, status, delayMinutes);
+            emit LogFlightProductErrorUnexpectedStatus(requestId, riskId, status, delayMinutes);
             return payoutOption;
         }
 
@@ -167,7 +141,7 @@ library FlightLib {
     {
         // check we have enough observations
         if (statistics[0] < flightProduct.MIN_OBSERVATIONS()) {
-            revert FlightProduct.ErrorFlightProductNotEnoughObservations(statistics[0], flightProduct.MIN_OBSERVATIONS());
+            revert ErrorFlightProductNotEnoughObservations(statistics[0], flightProduct.MIN_OBSERVATIONS());
         }
 
         weight = 0;
@@ -200,10 +174,10 @@ library FlightLib {
         )
     {
         if (premium < flightProduct.MIN_PREMIUM()) { 
-            revert FlightProduct.ErrorFlightProductPremiumAmountTooSmall(premium, flightProduct.MIN_PREMIUM()); 
+            revert ErrorFlightProductPremiumAmountTooSmall(premium, flightProduct.MIN_PREMIUM()); 
         }
         if (premium > flightProduct.MAX_PREMIUM()) { 
-            revert FlightProduct.ErrorFlightProductPremiumAmountTooLarge(premium, flightProduct.MAX_PREMIUM()); 
+            revert ErrorFlightProductPremiumAmountTooLarge(premium, flightProduct.MAX_PREMIUM()); 
         }
 
         sumInsuredAmount = AmountLib.zero();
@@ -222,13 +196,43 @@ library FlightLib {
     }
 
 
+    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,
+            false);
+        
+        statusAvailable = flightRisk.statusUpdatedAt.gtz();
+        payoutOption = flightRisk.payoutOption;
+    }
+
+
     function getPayoutAmount(
         bytes memory applicationData, 
         uint8 payoutOption
     )
         public
+        pure
         returns (Amount payoutAmount)
     {
+        if (payoutOption == type(uint8).max) {
+            return AmountLib.zero();
+        }
+
         // retrieve payout amounts from application data
         (, Amount[5] memory payoutAmounts) = abi.decode(
             applicationData, (Amount, Amount[5]));
@@ -243,7 +247,9 @@ library FlightLib {
         NftId productNftId, 
         Str flightData,
         Timestamp departureTime, 
-        Timestamp arrivalTime
+        string memory departureTimeLocal,
+        Timestamp arrivalTime,
+        string memory arrivalTimeLocal
     )
         public
         view
@@ -254,17 +260,21 @@ library FlightLib {
         )
     {
         riskId = getRiskId(productNftId, flightData);
-        (exists, flightRisk) = getFlightRisk(reader, productNftId, riskId);
+        (exists, flightRisk) = getFlightRisk(reader, productNftId, riskId, false);
 
         // 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});
+                delayMinutes: 0,
+                payoutOption: uint8(0),
+                statusUpdatedAt: TimestampLib.zero()});
         }
     }
 
@@ -272,7 +282,8 @@ library FlightLib {
     function getFlightRisk(
         InstanceReader reader,
         NftId productNftId,
-        RiskId riskId
+        RiskId riskId,
+        bool requireRiskExists
     )
         public
         view
@@ -284,6 +295,10 @@ library FlightLib {
         // check if risk exists
         exists = reader.isProductRisk(productNftId, riskId);
 
+        if (!exists && requireRiskExists) {
+            revert ErrorFlightProductRiskInvalid(riskId);
+        }
+
         // get risk data if risk exists
         if (exists) {
             flightRisk = abi.decode(