@etherisc/gif-next 0.0.2-d13bb9e-069 → 0.0.2-d18e1c5-511

package/contracts/distribution/IDistributionService.sol

@@ -1,40 +1,51 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount} from "../type/Amount.sol";
-import {NftId} from "../type/NftId.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 import {IService} from "../shared/IService.sol";
-import {UFixed} from "../type/UFixed.sol";
+
+import {Amount} from "../type/Amount.sol";
 import {DistributorType} from "../type/DistributorType.sol";
-import {ReferralId} from "../type/Referral.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
+import {NftId} from "../type/NftId.sol";
+import {ReferralId, ReferralStatus} from "../type/Referral.sol";
+import {Seconds} from "../type/Seconds.sol";
 import {Timestamp} from "../type/Timestamp.sol";
+import {UFixed} from "../type/UFixed.sol";
 
 
 interface IDistributionService is IService {
-
     error ErrorDistributionServiceCallerNotRegistered(address caller);
-    error ErrorIDistributionServiceParentNftIdNotInstance(NftId nftId, NftId parentNftId);
-    error ErrorIDistributionServiceCallerNotDistributor(address caller);
-    error ErrorIDistributionServiceInvalidReferralId(ReferralId referralId);
-    error ErrorIDistributionServiceMaxReferralsExceeded(uint256 maxReferrals);
-    error ErrorIDistributionServiceDiscountTooLow(uint256 minDiscountPercentage, uint256 discountPercentage);
-    error ErrorIDistributionServiceDiscountTooHigh(uint256 maxDiscountPercentage, uint256 discountPercentage);
-    error ErrorIDistributionServiceExpiryTooLong(uint256 maxReferralLifetime, uint256 expiryAt);
-    error ErrorIDistributionServiceInvalidReferral(string code);
-    error ErrorIDistributionServiceExpirationInvalid(Timestamp expiryAt);
-    error ErrorIDistributionServiceCommissionTooHigh(uint256 commissionPercentage, uint256 maxCommissionPercentage);
-    error ErrorIDistributionServiceMinFeeTooHigh(uint256 minFee, uint256 limit);
+    error ErrorDistributionServiceParentNftIdNotInstance(NftId nftId, NftId parentNftId);
+    error ErrorDistributionServiceCallerNotDistributor(address caller);
+    error ErrorDistributionServiceInvalidReferralId(ReferralId referralId);
+    error ErrorDistributionServiceMaxReferralsExceeded(uint256 limit, uint256 maxReferrals);
+    error ErrorDistributionServiceDiscountTooLow(UFixed minDiscountPercentage, UFixed discountPercentage);
+    error ErrorDistributionServiceDiscountTooHigh(UFixed maxDiscountPercentage, UFixed discountPercentage);
+    error ErrorDistributionServiceExpiryTooLong(Seconds maxReferralLifetime, Timestamp expiryAt);
+    error ErrorDistributionServiceInvalidReferral();
+    error ErrorDistributionServiceExpirationInvalid(Timestamp expiryAt);
+    error ErrorDistributionServiceCommissionTooHigh(uint256 commissionPercentage, uint256 maxCommissionPercentage);
+    error ErrorDistributionServiceMinFeeTooHigh(uint256 minFee, uint256 limit);
+    error ErrorDistributionServiceDistributorTypeDistributionMismatch(DistributorType distributorType, NftId distributorTypeDistributionNftId, NftId distributionNftId);
+    error ErrorDistributionServiceDistributorDistributionMismatch(NftId distributorNftId, NftId distributorDistributionNftId, NftId distributionNftId);
 
     error ErrorDistributionServiceCommissionWithdrawAmountExceedsLimit(Amount amount, Amount limit);
     
     error ErrorDistributionServiceVariableFeesTooHight(uint256 maxDiscountPercentage, uint256 limit);
     error ErrorDistributionServiceMaxDiscountTooHigh(uint256 maxDiscountPercentage, uint256 limit);
 
-    error ErrorIDistributionServiceReferralInvalid(NftId distributionNftId, ReferralId referralId);
+    error ErrorDistributionServiceReferralInvalid(NftId distributionNftId, ReferralId referralId);
     error ErrorDistributionServiceInvalidFeeTransferred(Amount transferredDistributionFeeAmount, Amount expectedDistributionFeeAmount);
+    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 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 LogDistributionServiceReferralProcessed(NftId distributionNftId, NftId distributorNftId, ReferralId referralId, uint32 usedReferrals);
+    event LogDistributionServiceSaleProcessed(NftId distributionNftId, ReferralId referralId);
 
     function createDistributorType(
         string memory name,
@@ -42,7 +53,7 @@ interface IDistributionService is IService {
         UFixed maxDiscountPercentage,
         UFixed commissionPercentage,
         uint32 maxReferralCount,
-        uint32 maxReferralLifetime,
+        Seconds maxReferralLifetime,
         bool allowSelfReferrals,
         bool allowRenewals,
         bytes memory data
@@ -56,12 +67,11 @@ interface IDistributionService is IService {
         bytes memory data
     ) external returns (NftId distributorNftId);
 
-    // TODO re-enable and reorganize (service contract too large)
-    // function updateDistributorType(
-    //     NftId distributorNftId,
-    //     DistributorType distributorType,
-    //     bytes memory data
-    // ) external;
+    function changeDistributorType(
+        NftId distributorNftId,
+        DistributorType newDistributorType,
+        bytes memory data
+    ) external;
 
     function createReferral(
         NftId distributorNftId,
@@ -98,4 +108,8 @@ interface IDistributionService is IService {
     /// @param amount the amount to withdraw. If set to AMOUNT_MAX, the full commission available is withdrawn
     /// @return withdrawnAmount the effective withdrawn amount
     function withdrawCommission(NftId distributorNftId, Amount amount) external returns (Amount withdrawnAmount);
+
+    /// @dev Returns the discount percentage for the provided referral code.
+    /// The function retuns both the percentage and the status of the referral code.
+    function getDiscountPercentage(InstanceReader instanceReader, ReferralId referralId) external view returns (UFixed discountPercentage, ReferralStatus status);
 }

package/contracts/examples/fire/FirePool.sol

@@ -1,42 +1,50 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
 import {Amount, AmountLib} from "../../type/Amount.sol";
 import {BasicPool} from "../../pool/BasicPool.sol";
-import {BasicPoolAuthorization} from "../../pool/BasicPoolAuthorization.sol";
 import {Fee} from "../../type/Fee.sol";
 import {IAuthorization} from "../../authorization/IAuthorization.sol";
+import {IComponents} from "../../instance/module/IComponents.sol";
 import {NftId} from "../../type/NftId.sol";
 import {Seconds} from "../../type/Timestamp.sol";
-import {UFixed} from "../../type/UFixed.sol";
+import {UFixed, UFixedLib} from "../../type/UFixed.sol";
 
 contract FirePool is
     BasicPool
-{
-    
+{   
     constructor(
         address registry,
-        NftId instanceNftId,
+        NftId fireProductNftId,
         string memory componentName,
-        address token,
         IAuthorization authorization
     ) 
     {
         address initialOwner = msg.sender;
         _intialize(
             registry,
-            instanceNftId,
+            fireProductNftId,
             componentName,
-            token,
+            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 instanceNftId,
+        NftId fireProductNftId,
         string memory componentName,
-        address token,
+        IComponents.PoolInfo memory poolInfo,
         IAuthorization authorization,
         address initialOwner
     )
@@ -45,10 +53,10 @@ contract FirePool is
     {
         _initializeBasicPool(
             registry,
-            instanceNftId,
-            authorization,
-            token,
+            fireProductNftId,
             componentName,
+            poolInfo,
+            authorization,
             initialOwner);
     }
 
@@ -72,4 +80,7 @@ contract FirePool is
         netStakedAmount = _stake(bundleNftId, initialAmount);
     }
 
+    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); }
 }

package/contracts/examples/fire/FirePoolAuthorization.sol

@@ -25,8 +25,9 @@ contract FirePoolAuthorization
         IAccess.FunctionInfo[] storage functions;
 
         // authorize public role (open access to any account, only allows to lock target)
-        functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
+        functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
         // TODO: FirePool.createBundle must require a custom role (e.g. INVESTOR) instead of PUBLIC_ROLE
+        _authorize(functions, FirePool.approveTokenHandler.selector, "approveTokenHandler");
         _authorize(functions, FirePool.createBundle.selector, "createBundle");
     }
 

package/contracts/examples/fire/FireProduct.sol

@@ -1,24 +1,26 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {ACTIVE, COLLATERALIZED, PAUSED} from "../../type/StateId.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {ACTIVE, PAUSED} from "../../type/StateId.sol";
 import {Amount, AmountLib} from "../../type/Amount.sol";
 import {BasicProduct} from "../../product/BasicProduct.sol";
 import {ClaimId} from "../../type/ClaimId.sol";
 import {DamageLevel, DAMAGE_SMALL, DAMAGE_MEDIUM, DAMAGE_LARGE} from "./DamageLevel.sol";
+import {FeeLib} from "../../type/Fee.sol";
 import {IAuthorization} from "../../authorization/IAuthorization.sol";
+import {IComponents} from "../../instance/module/IComponents.sol";
 import {IPolicy} from "../../instance/module/IPolicy.sol";
-import {NftId} from "../../type/NftId.sol";
+import {NftId, NftIdLib} from "../../type/NftId.sol";
 import {PayoutId} from "../../type/PayoutId.sol";
+import {POLICY, BUNDLE} from "../../type/ObjectType.sol";
 import {ReferralLib} from "../../type/Referral.sol";
 import {RiskId, RiskIdLib} from "../../type/RiskId.sol";
 import {Seconds} from "../../type/Seconds.sol";
-import {StateId} from "../../type/StateId.sol";
 import {Timestamp, TimestampLib} from "../../type/Timestamp.sol";
 import {UFixed, UFixedLib} from "../../type/UFixed.sol";
 
-uint64 constant SPECIAL_ROLE_INT = 11111;
-
 // solhint-disable-next-line func-name-mixedcase
 function HALF_YEAR() pure returns (Seconds) {
     return Seconds.wrap(180 * 86400);
@@ -43,15 +45,16 @@ contract FireProduct is
     }
 
     error ErrorFireProductCityUnknown(string cityName);
-    error ErrorFireProductTimestampTooEarly();
+    error ErrorFireProductTimestampInFuture();
     error ErrorFireProductFireAlreadyReported();
     error ErrorFireProductAlreadyClaimed();
-    error ErrorFireProductPolicyNotActive();
-    error ErrorFireProductPolicyNotYetActive(Timestamp activateAt);
-    error ErrorFireProductPolicyExpired(Timestamp expiredAt);
+    error ErrorFireProductPolicyNotActive(NftId policyNftId);
+    error ErrorFireProductPolicyNotYetActive(NftId policyNftId, Timestamp activateAt);
+    error ErrorFireProductPolicyExpired(NftId policyNftId, Timestamp expiredAt);
     error ErrorFireProductUnknownDamageLevel(DamageLevel damageLevel);
     error ErrorFireProductFireUnknown(uint256 fireId);
     error ErrorFireProductNotPolicyOwner(NftId nftId, address owner);
+    error ErrorFireProductFireNotInCoveredCity(uint256 fireId, string cityName);
 
     string[] private _cities;
     // map from city name to the RiskId
@@ -65,28 +68,23 @@ contract FireProduct is
         address registry,
         NftId instanceNftid,
         string memory componentName,
-        address token,
-        address pool,
         IAuthorization authorization
     )
     {
         address initialOwner = msg.sender;
+
         _initialize(
             registry,
             instanceNftid,
             componentName,
-            token,
-            pool,
             authorization,
             initialOwner);
     }
 
     function _initialize(
         address registry,
-        NftId instanceNftid,
+        NftId instanceNftId,
         string memory componentName,
-        address token,
-        address pool,
         IAuthorization authorization,
         address initialOwner
     )
@@ -95,14 +93,29 @@ contract FireProduct is
     {
         _initializeBasicProduct(
             registry,
-            instanceNftid,
-            authorization,
-            initialOwner,
+            instanceNftId,
             componentName,
-            token,
-            false,
-            pool,
-            address(0));  // no distribution
+            IComponents.ProductInfo({
+                isProcessingFundedClaims: false,
+                isInterceptingPolicyTransfers: false,
+                hasDistribution: false,
+                expectedNumberOfOracles: 0,
+                numberOfOracles: 0,
+                poolNftId: NftIdLib.zero(),
+                distributionNftId: NftIdLib.zero(),
+                oracleNftId: new NftId[](0)
+            }), 
+            IComponents.FeeInfo({
+                productFee: FeeLib.zero(),
+                processingFee: FeeLib.zero(),
+                distributionFee: FeeLib.zero(),
+                minDistributionOwnerFee: FeeLib.zero(),
+                poolFee: FeeLib.zero(),
+                stakingFee: FeeLib.zero(),
+                performanceFee: FeeLib.zero()
+            }),
+            authorization,
+            initialOwner);  // number of oracles
     }
     
     function cities() public view returns (uint256) {
@@ -127,9 +140,9 @@ contract FireProduct is
             revert ErrorFireProductCityUnknown(cityName);
         }
 
-        _updateRiskState(
+        _setRiskLocked(
             _riskMapping[cityName],
-            PAUSED()
+            true
         );
     }
 
@@ -143,9 +156,9 @@ contract FireProduct is
             revert ErrorFireProductCityUnknown(cityName);
         }
 
-        _updateRiskState(
+        _setRiskLocked(
             _riskMapping[cityName],
-            ACTIVE()
+            false
         );
     }
 
@@ -157,15 +170,16 @@ contract FireProduct is
     ) 
         public
         view
+        onlyNftOfType(bundleNftId, BUNDLE())
         returns (Amount premiumAmount)
     {
-        RiskId riskId = _riskMapping[cityName];
-        if (riskId.eqz()) {
+        RiskId risk = _riskMapping[cityName];
+        if (risk.eqz()) {
             revert ErrorFireProductCityUnknown(cityName);
         }
         premiumAmount = calculatePremium( 
             sumInsured,
-            riskId,
+            risk,
             lifetime,
             "",
             bundleNftId,
@@ -198,14 +212,15 @@ contract FireProduct is
     )
         public
         restricted()
+        onlyNftOfType(bundleNftId, BUNDLE())
         returns (NftId policyNftId)
     {
         address applicationOwner = msg.sender;
-        RiskId riskId = initializeCity(cityName);
+        RiskId risk = initializeCity(cityName);
 
         Amount premiumAmount = calculatePremium(
             sumInsured,
-            riskId,
+            risk,
             lifetime,
             "",
             bundleNftId,
@@ -213,7 +228,7 @@ contract FireProduct is
 
         return _createApplication(
             applicationOwner,
-            riskId,
+            risk,
             sumInsured,
             premiumAmount,
             lifetime,
@@ -227,15 +242,14 @@ contract FireProduct is
         string memory cityName
     ) 
         public
-        returns (RiskId riskId) 
+        returns (RiskId risk) 
     {
         if (! _riskMapping[cityName].eqz()) {
             return _riskMapping[cityName];
         }
         _cities.push(cityName);
-        riskId = RiskIdLib.toRiskId(cityName);
-        _createRisk(riskId, "");
-        _riskMapping[cityName] = riskId;
+        risk = _createRisk(bytes32(abi.encodePacked(cityName)), "");
+        _riskMapping[cityName] = risk;
     }
 
     /// @dev Calling this method will lock the sum insured amount in the pool and activate the policy at the given time. 
@@ -247,8 +261,9 @@ contract FireProduct is
         public 
         restricted()
         onlyOwner()
+        onlyNftOfType(policyNftId, POLICY())
     {
-        _createPolicy(policyNftId, activateAt);
+        _createPolicy(policyNftId, activateAt, AmountLib.max());
         _collectPremium(policyNftId, activateAt);
     }
 
@@ -259,6 +274,7 @@ contract FireProduct is
         public 
         restricted()
         onlyOwner()
+        onlyNftOfType(policyNftId, POLICY())
     {
         _decline(policyNftId);
     }
@@ -270,6 +286,7 @@ contract FireProduct is
         public 
         restricted()
         onlyOwner()
+        onlyNftOfType(policyNftId, POLICY())
         returns (Timestamp)
     {
         return _expire(policyNftId, expireAt);
@@ -281,6 +298,7 @@ contract FireProduct is
         public 
         restricted()
         onlyOwner()
+        onlyNftOfType(policyNftId, POLICY())
     {
         _close(policyNftId);
     }
@@ -298,8 +316,8 @@ contract FireProduct is
             revert ErrorFireProductCityUnknown(cityName);
         }
 
-        if (reportedAt < TimestampLib.blockTimestamp()) {
-            revert ErrorFireProductTimestampTooEarly();
+        if (reportedAt > TimestampLib.current()) {
+            revert ErrorFireProductTimestampInFuture();
         }
 
         if (! _fires[fireId].reportedAt.eqz()) {
@@ -324,15 +342,16 @@ contract FireProduct is
         public 
         restricted()
         onlyNftOwner(policyNftId)
+        onlyNftOfType(policyNftId, POLICY())
         returns (ClaimId claimId, PayoutId payoutId) 
     {
         IPolicy.PolicyInfo memory policyInfo = _getInstanceReader().getPolicyInfo(policyNftId);
-        _checkClaimConditions(policyNftId, fireId, policyInfo);
+        _checkClaimConditions(policyNftId, policyInfo, fireId);
         
-        Fire memory fire = _fires[fireId];
+        Fire memory theFire = _fires[fireId];
         _claimed[fireId][policyNftId] = true;
 
-        Amount claimAmount = _getClaimAmount(policyNftId, policyInfo.sumInsuredAmount, fire.damageLevel);
+        Amount claimAmount = _getClaimAmount(policyNftId, policyInfo.sumInsuredAmount, theFire.damageLevel);
         
         claimId = _submitClaim(policyNftId, claimAmount, abi.encodePacked(fireId));
         _confirmClaim(policyNftId, claimId, claimAmount, "");
@@ -343,35 +362,36 @@ contract FireProduct is
 
     function _checkClaimConditions(
         NftId policyNftId,
-        uint256 fireId,
-        IPolicy.PolicyInfo memory policyInfo
+        IPolicy.PolicyInfo memory policyInfo,
+        uint256 fireId
     ) 
         internal
+        view
     {
         // check fire exists
         if (_fires[fireId].reportedAt.eqz()) {
             revert ErrorFireProductFireUnknown(fireId);
         }
 
+        // check fire is in same city as policy coverage
+        if (_riskMapping[_fires[fireId].cityName] != policyInfo.riskId) {
+            revert ErrorFireProductFireNotInCoveredCity(fireId, _fires[fireId].cityName);
+        }
+
         // check policy has not been claimed yet for this fire
         if (_claimed[fireId][policyNftId]) {
             revert ErrorFireProductAlreadyClaimed();
         }
 
-        StateId policyState = _getInstanceReader().getPolicyState(policyNftId);
-        
-        if (! policyState.eq(COLLATERALIZED())) {
-            revert ErrorFireProductPolicyNotActive();
-        }
-
-        Fire memory fire = _fires[fireId];
+        Fire memory theFire = _fires[fireId];
 
-        if (fire.reportedAt < policyInfo.activatedAt) {
-            revert ErrorFireProductPolicyNotYetActive(policyInfo.activatedAt);
+        // check fire is during policy lifetime
+        if (theFire.reportedAt < policyInfo.activatedAt) {
+            revert ErrorFireProductPolicyNotYetActive(policyNftId, policyInfo.activatedAt);
         }
 
-        if (fire.reportedAt > policyInfo.expiredAt) {
-            revert ErrorFireProductPolicyExpired(policyInfo.expiredAt);
+        if (theFire.reportedAt >= policyInfo.expiredAt) {
+            revert ErrorFireProductPolicyExpired(policyNftId, policyInfo.expiredAt);
         }
     }
 
@@ -407,4 +427,7 @@ contract FireProduct is
         }
     }
 
+    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); }
 }

package/contracts/examples/fire/FireProductAuthorization.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.20;
 import {BasicProductAuthorization} from "../../product/BasicProductAuthorization.sol";
 import {FireProduct} from "./FireProduct.sol";
 import {IAccess} from "../../../contracts/authorization/IAccess.sol";
-import {PRODUCT_OWNER_ROLE, PUBLIC_ROLE} from "../../../contracts/type/RoleId.sol";
+import {PUBLIC_ROLE} from "../../../contracts/type/RoleId.sol";
 
 
 contract FireProductAuthorization
@@ -23,8 +23,9 @@ contract FireProductAuthorization
         IAccess.FunctionInfo[] storage functions;
 
         // authorize public role (open access to any account, only allows to lock target)
-        functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
+        functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
         // fully public functions
+        _authorize(functions, FireProduct.approveTokenHandler.selector, "approveTokenHandler");
         _authorize(functions, FireProduct.createApplication.selector, "createApplication");
         
         // only owner
@@ -36,7 +37,6 @@ contract FireProductAuthorization
         // only policy nft owner
         _authorize(functions, FireProduct.submitClaim.selector, "submitClaim"); 
 
-        functions = _authorizeForTarget(getTargetName(), PRODUCT_OWNER_ROLE());
         // TODO: add custom role for fire reporter
         _authorize(functions, FireProduct.reportFire.selector, "reportFire");
     }