@etherisc/gif-next 3.0.0-fbbe3fc-042 → 3.0.0-fbc2b82-347

package/contracts/accounting/AccountingService.sol

@@ -9,7 +9,7 @@ import {InstanceStore} from "../instance/InstanceStore.sol";
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {Fee} from "../type/Fee.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, ACCOUNTING, BUNDLE, DISTRIBUTION, DISTRIBUTOR, POOL, PRODUCT} from "../type/ObjectType.sol";
+import {ObjectType, ACCOUNTING, BUNDLE, COMPONENT, DISTRIBUTION, DISTRIBUTOR, POOL, PRODUCT} from "../type/ObjectType.sol";
 import {Service} from "../shared/Service.sol";
 
 
@@ -46,7 +46,7 @@ contract AccountingService is
         virtual
         restricted()
     {
-        _changeTargetBalance(DECREASE, instanceStore, componentNftId, AmountLib.zero(), feeAmount);    
+        _changeTargetBalance(DECREASE, instanceStore, componentNftId, COMPONENT(), AmountLib.zero(), feeAmount);    
     }
 
 
@@ -60,7 +60,7 @@ contract AccountingService is
         restricted()
     {
         _checkNftType(productNftId, PRODUCT());
-        _changeTargetBalance(INCREASE, instanceStore, productNftId, AmountLib.zero(), feeAmount);
+        _changeTargetBalance(INCREASE, instanceStore, productNftId, PRODUCT(), AmountLib.zero(), feeAmount);
     }
 
     function increaseProductFeesForPool(
@@ -73,7 +73,7 @@ contract AccountingService is
         restricted()
     {
         _checkNftType(productNftId, PRODUCT());
-        _changeTargetBalance(INCREASE, instanceStore, productNftId, AmountLib.zero(), feeAmount);
+        _changeTargetBalance(INCREASE, instanceStore, productNftId, PRODUCT(), AmountLib.zero(), feeAmount);
     }
 
 
@@ -83,7 +83,7 @@ contract AccountingService is
         restricted()
     {
         _checkNftType(productNftId, PRODUCT());
-        _changeTargetBalance(DECREASE, instanceStore, productNftId, AmountLib.zero(), feeAmount);
+        _changeTargetBalance(DECREASE, instanceStore, productNftId, PRODUCT(), AmountLib.zero(), feeAmount);
     }
 
     function increaseDistributionBalance(
@@ -97,7 +97,7 @@ contract AccountingService is
         restricted()
     {
         _checkNftType(distributionNftId, DISTRIBUTION());
-        _changeTargetBalance(INCREASE, instanceStore, distributionNftId, amount, feeAmount);
+        _changeTargetBalance(INCREASE, instanceStore, distributionNftId, DISTRIBUTION(), amount, feeAmount);
     }
 
 
@@ -112,7 +112,7 @@ contract AccountingService is
         restricted()
     {
         _checkNftType(distributionNftId, DISTRIBUTION());
-        _changeTargetBalance(DECREASE, instanceStore, distributionNftId, amount, feeAmount);
+        _changeTargetBalance(DECREASE, instanceStore, distributionNftId, DISTRIBUTION(), amount, feeAmount);
     }
 
     function increaseDistributorBalance(
@@ -126,7 +126,7 @@ contract AccountingService is
         restricted()
     {
         _checkNftType(distributorNftId, DISTRIBUTOR());
-        _changeTargetBalance(INCREASE, instanceStore, distributorNftId, amount, feeAmount);
+        _changeTargetBalance(INCREASE, instanceStore, distributorNftId, DISTRIBUTOR(), amount, feeAmount);
     }
 
     function decreaseDistributorBalance(
@@ -140,7 +140,7 @@ contract AccountingService is
         restricted()
     {
         _checkNftType(distributorNftId, DISTRIBUTOR());
-        _changeTargetBalance(DECREASE, instanceStore, distributorNftId, amount, feeAmount);
+        _changeTargetBalance(DECREASE, instanceStore, distributorNftId, DISTRIBUTOR(), amount, feeAmount);
     }
 
     function increasePoolBalance(
@@ -154,7 +154,7 @@ contract AccountingService is
         restricted()
     {
         _checkNftType(poolNftId, POOL());
-        _changeTargetBalance(INCREASE, instanceStore, poolNftId, amount, feeAmount);
+        _changeTargetBalance(INCREASE, instanceStore, poolNftId, POOL(), amount, feeAmount);
     }
 
     function decreasePoolBalance(
@@ -168,7 +168,7 @@ contract AccountingService is
         restricted()
     {
         _checkNftType(poolNftId, POOL());
-        _changeTargetBalance(DECREASE, instanceStore, poolNftId, amount, feeAmount);
+        _changeTargetBalance(DECREASE, instanceStore, poolNftId, POOL(), amount, feeAmount);
     }
 
     function increaseBundleBalance(
@@ -182,7 +182,7 @@ contract AccountingService is
         restricted()
     {
         _checkNftType(bundleNftId, BUNDLE());
-        _changeTargetBalance(INCREASE, instanceStore, bundleNftId, amount, feeAmount);
+        _changeTargetBalance(INCREASE, instanceStore, bundleNftId, BUNDLE(), amount, feeAmount);
     }
 
     function decreaseBundleBalance(
@@ -196,7 +196,7 @@ contract AccountingService is
         restricted()
     {
         _checkNftType(bundleNftId, BUNDLE());
-        _changeTargetBalance(DECREASE, instanceStore, bundleNftId, amount, feeAmount);
+        _changeTargetBalance(DECREASE, instanceStore, bundleNftId, BUNDLE(), amount, feeAmount);
     }
 
     function increaseBundleBalanceForPool(
@@ -210,7 +210,7 @@ contract AccountingService is
         restricted()
     {
         _checkNftType(bundleNftId, BUNDLE());
-        _changeTargetBalance(INCREASE, instanceStore, bundleNftId, amount, feeAmount);
+        _changeTargetBalance(INCREASE, instanceStore, bundleNftId, BUNDLE(), amount, feeAmount);
     }
 
     function decreaseBundleBalanceForPool(
@@ -224,7 +224,7 @@ contract AccountingService is
         restricted()
     {
         _checkNftType(bundleNftId, BUNDLE());
-        _changeTargetBalance(DECREASE, instanceStore, bundleNftId, amount, feeAmount);
+        _changeTargetBalance(DECREASE, instanceStore, bundleNftId, BUNDLE(), amount, feeAmount);
     }
 
 
@@ -234,6 +234,7 @@ contract AccountingService is
         bool increase,
         InstanceStore instanceStore, 
         NftId targetNftId, 
+        ObjectType objectType,
         Amount amount, 
         Amount feeAmount
     )
@@ -249,21 +250,8 @@ contract AccountingService is
             if(totalAmount.gtz()) { instanceStore.decreaseBalance(targetNftId, totalAmount); }
             if(feeAmount.gtz()) { instanceStore.decreaseFees(targetNftId, feeAmount); }
         }
-    }
-
 
-    function _logUpdateFee(NftId productNftId, string memory name, Fee memory feeBefore, Fee memory feeAfter)
-        internal
-        virtual
-    {
-        emit LogComponentServiceUpdateFee(
-            productNftId, 
-            name,
-            feeBefore.fractionalFee,
-            feeBefore.fixedFee,
-            feeAfter.fractionalFee,
-            feeAfter.fixedFee
-        );
+        emit LogAccountingServiceBalanceChanged(targetNftId, amount, feeAmount, increase, objectType);
     }
 
     function _getDomain() internal pure virtual override returns(ObjectType) {

package/contracts/accounting/IAccountingService.sol

@@ -6,20 +6,19 @@ import {Amount} from "../type/Amount.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
 import {IService} from "../shared/IService.sol";
 import {NftId} from "../type/NftId.sol";
-import {UFixed} from "../type/UFixed.sol";
+import {ObjectType} from "../type/ObjectType.sol";
 
 /// @dev component base class
 /// component examples are staking, product, distribution, pool and oracle
 interface IAccountingService is 
     IService
 {
-    event LogComponentServiceUpdateFee(
-        NftId nftId, 
-        string feeName, 
-        UFixed previousFractionalFee, 
-        Amount previousFixedFee,
-        UFixed newFractionalFee, 
-        Amount newFixedFee
+    event LogAccountingServiceBalanceChanged(
+        NftId indexed nftId,
+        Amount indexed amount,
+        Amount indexed feeAmount,
+        bool increase,
+        ObjectType objectType
     );
 
     function decreaseComponentFees(InstanceStore instanceStore, NftId componentNftId, Amount feeAmount) external;

package/contracts/authorization/AccessAdmin.sol

@@ -657,25 +657,4 @@ contract AccessAdmin is
             AccessAdminLib.toFunctionGrantingString(this, func.name, roleId),
             lastUpdateIn);
     }
-
-
-    // TODO cleanup
-    // function _checkAuthorization( 
-    //     address authorization,
-    //     ObjectType expectedDomain, 
-    //     VersionPart expectedRelease,
-    //     bool expectServiceAuthorization,
-    //     bool checkAlreadyInitialized
-    // )
-    //     internal
-    //     view
-    // {
-    //     AccessAdminLib.checkAuthorization(
-    //         _authorization, 
-    //         authorization, 
-    //         expectedDomain, 
-    //         expectedRelease, 
-    //         expectServiceAuthorization,
-    //         checkAlreadyInitialized);
-    // }
 }

package/contracts/authorization/AccessManagerCloneable.sol

@@ -24,6 +24,8 @@ contract AccessManagerCloneable is
     error ErrorAccessManagerTargetAdminLocked(address target);
     error ErrorAccessManagerCallerAdminLocked(address caller);
 
+    event LogAccessManagerLocked(address indexed accessManager, bool indexed locked);
+
     VersionPart private _release;
     bool private _isLocked;
 
@@ -39,6 +41,7 @@ contract AccessManagerCloneable is
 
     function initialize(address admin)
         public
+        override
         initializer()
     {
         __ERC165_init();
@@ -94,6 +97,7 @@ contract AccessManagerCloneable is
         onlyAdminRole() 
     {
         _isLocked = locked;
+        emit LogAccessManagerLocked(address(this), locked);
     }
 
 

package/contracts/distribution/DistributionService.sol

@@ -112,7 +112,7 @@ contract DistributionService is
 
         instance.getInstanceStore().createDistributorType(distributorType, info);
 
-        emit LogDistributionServiceDistributorTypeCreated(distributionNftId, name);
+        emit LogDistributionServiceDistributorTypeCreated(distributionNftId, name, commissionPercentage);
     }
 
 
@@ -236,7 +236,7 @@ contract DistributionService is
 
             instance.getInstanceStore().createReferral(referralId, info);
 
-            emit LogDistributionServiceReferralCreated(distributionNftId, distributorNftId, referralId, code);
+            emit LogDistributionServiceReferralCreated(distributionNftId, distributorNftId, referralId, code, discountPercentage, maxReferrals, expiryAt);
         }
     }
 
@@ -295,12 +295,14 @@ contract DistributionService is
             IDistribution.DistributorInfo memory distributorInfo = reader.getDistributorInfo(referralInfo.distributorNftId);
             distributorInfo.numPoliciesSold += 1;
             store.updateDistributor(referralInfo.distributorNftId, distributorInfo, KEEP_STATE());
+            emit LogDistributionServiceSaleProcessedWithReferral(distributionNftId, referralInfo.distributorNftId, referralId, distributorInfo.numPoliciesSold, premium.premiumAmount, distributionOwnerFee, commissionAmount);
         } else {
             // increase distribution balance by distribution owner fee
             _accountingService.increaseDistributionBalance(store, distributionNftId, AmountLib.zero(), distributionOwnerFee);
+            emit LogDistributionServiceSaleProcessed(distributionNftId, referralId, premium.premiumAmount, distributionOwnerFee);
         }
 
-        emit LogDistributionServiceSaleProcessed(distributionNftId, referralId);
+        
     }
 
     /// @inheritdoc IDistributionService

package/contracts/distribution/IDistributionService.sol

@@ -40,12 +40,13 @@ interface IDistributionService is IService {
     error ErrorDistributionServiceReferralDistributionMismatch(ReferralId referralId, NftId referralDistributionNft, NftId distributionNftId);
 
     event LogDistributionServiceCommissionWithdrawn(NftId distributorNftId, address recipient, address tokenAddress, Amount amount);
-    event LogDistributionServiceDistributorTypeCreated(NftId distributionNftId, string name);
+    event LogDistributionServiceDistributorTypeCreated(NftId distributionNftId, string name, UFixed commissionPercentage);
     event LogDistributionServiceDistributorCreated(NftId distributionNftId, NftId distributorNftId, DistributorType distributorType, address distributor);
     event LogDistributionServiceDistributorTypeChanged(NftId distributorNftId, DistributorType oldDistributorType, DistributorType newDistributorType);
-    event LogDistributionServiceReferralCreated(NftId distributionNftId, NftId distributorNftId, ReferralId referralId, string code);
+    event LogDistributionServiceReferralCreated(NftId distributionNftId, NftId distributorNftId, ReferralId referralId, string code, UFixed discountPercentage, uint32 maxReferrals, Timestamp expiryAt);
     event LogDistributionServiceReferralProcessed(NftId distributionNftId, NftId distributorNftId, ReferralId referralId, uint32 usedReferrals);
-    event LogDistributionServiceSaleProcessed(NftId distributionNftId, ReferralId referralId);
+    event LogDistributionServiceSaleProcessed(NftId distributionNftId, ReferralId referralId, Amount premium, Amount distributionOwnerFee);
+    event LogDistributionServiceSaleProcessedWithReferral(NftId distributionNftId, NftId distributorNftId, ReferralId referralId, uint32 numPoliciesSold, Amount premium, Amount distributionOwnerFee, Amount commissionAmount);
 
     function createDistributorType(
         string memory name,

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,6 +19,19 @@ import {Timestamp, TimestampLib} from "../../type/Timestamp.sol";
 
 library FlightLib {
 
+    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, 
@@ -45,32 +59,45 @@ library FlightLib {
 
         // 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);
         }
-
-        // 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 (arrivalTime > departureTime.addSeconds(flightProduct.MAX_FLIGHT_DURATION())) {
+            revert ErrorFlightProductArrivalAfterMaxFlightDuration(arrivalTime, departureTime, flightProduct.MAX_FLIGHT_DURATION());
         }
+
+        // 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 FlightProduct.ErrorFlightProductDepartureBeforeMinTimeBeforeDeparture(departureTime, TimestampLib.current(), flightProduct.MIN_TIME_BEFORE_DEPARTURE());
+            revert 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());
+            revert ErrorFlightProductDepartureAfterMaxTimeBeforeDeparture(departureTime, TimestampLib.current(), flightProduct.MAX_TIME_BEFORE_DEPARTURE());
         }
         // solhint-enable
     }
 
 
+    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, 
@@ -85,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;
         }
 
@@ -114,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;
@@ -147,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();
@@ -186,7 +213,8 @@ library FlightLib {
         (exists, flightRisk) = getFlightRisk(
             reader, 
             productNftId, 
-            riskId);
+            riskId,
+            false);
         
         statusAvailable = flightRisk.statusUpdatedAt.gtz();
         payoutOption = flightRisk.payoutOption;
@@ -201,6 +229,10 @@ library FlightLib {
         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]));
@@ -228,7 +260,7 @@ 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) {
@@ -250,7 +282,8 @@ library FlightLib {
     function getFlightRisk(
         InstanceReader reader,
         NftId productNftId,
-        RiskId riskId
+        RiskId riskId,
+        bool requireRiskExists
     )
         public
         view
@@ -262,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(