@etherisc/gif-next 0.0.2-7d7c399-079 → 0.0.2-7d91021-862

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
@@ -58,7 +69,7 @@ interface IDistributionService is IService {
 
     function changeDistributorType(
         NftId distributorNftId,
-        DistributorType distributorType,
+        DistributorType newDistributorType,
         bytes memory data
     ) external;
 
@@ -97,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

@@ -19,7 +19,6 @@ contract FirePool is
         address registry,
         NftId fireProductNftId,
         string memory componentName,
-        address token,
         IAuthorization authorization
     ) 
     {
@@ -28,7 +27,6 @@ contract FirePool is
             registry,
             fireProductNftId,
             componentName,
-            token,
             IComponents.PoolInfo({
                 maxBalanceAmount: AmountLib.max(),
                 isInterceptingBundleTransfers: false,
@@ -46,7 +44,6 @@ contract FirePool is
         address registry,
         NftId fireProductNftId,
         string memory componentName,
-        address token,
         IComponents.PoolInfo memory poolInfo,
         IAuthorization authorization,
         address initialOwner
@@ -58,7 +55,6 @@ contract FirePool is
             registry,
             fireProductNftId,
             componentName,
-            token,
             poolInfo,
             authorization,
             initialOwner);

package/contracts/examples/fire/FirePoolAuthorization.sol

@@ -25,7 +25,7 @@ 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

@@ -68,7 +68,6 @@ contract FireProduct is
         address registry,
         NftId instanceNftid,
         string memory componentName,
-        address token,
         IAuthorization authorization
     )
     {
@@ -78,7 +77,6 @@ contract FireProduct is
             registry,
             instanceNftid,
             componentName,
-            token,
             authorization,
             initialOwner);
     }
@@ -87,7 +85,6 @@ contract FireProduct is
         address registry,
         NftId instanceNftId,
         string memory componentName,
-        address token,
         IAuthorization authorization,
         address initialOwner
     )
@@ -98,7 +95,6 @@ contract FireProduct is
             registry,
             instanceNftId,
             componentName,
-            token,
             IComponents.ProductInfo({
                 isProcessingFundedClaims: false,
                 isInterceptingPolicyTransfers: false,
@@ -144,9 +140,9 @@ contract FireProduct is
             revert ErrorFireProductCityUnknown(cityName);
         }
 
-        _updateRiskState(
+        _setRiskLocked(
             _riskMapping[cityName],
-            PAUSED()
+            true
         );
     }
 
@@ -160,9 +156,9 @@ contract FireProduct is
             revert ErrorFireProductCityUnknown(cityName);
         }
 
-        _updateRiskState(
+        _setRiskLocked(
             _riskMapping[cityName],
-            ACTIVE()
+            false
         );
     }
 
@@ -252,8 +248,7 @@ contract FireProduct is
             return _riskMapping[cityName];
         }
         _cities.push(cityName);
-        risk = RiskIdLib.toRiskId(cityName);
-        _createRisk(risk, "");
+        risk = _createRisk(bytes32(abi.encodePacked(cityName)), "");
         _riskMapping[cityName] = risk;
     }
 
@@ -268,7 +263,7 @@ contract FireProduct is
         onlyOwner()
         onlyNftOfType(policyNftId, POLICY())
     {
-        _createPolicy(policyNftId, activateAt);
+        _createPolicy(policyNftId, activateAt, AmountLib.max());
         _collectPremium(policyNftId, activateAt);
     }
 
@@ -321,7 +316,7 @@ contract FireProduct is
             revert ErrorFireProductCityUnknown(cityName);
         }
 
-        if (reportedAt > TimestampLib.blockTimestamp()) {
+        if (reportedAt > TimestampLib.current()) {
             revert ErrorFireProductTimestampInFuture();
         }
 

package/contracts/examples/fire/FireProductAuthorization.sol

@@ -23,7 +23,7 @@ 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");

package/contracts/examples/unpermissioned/SimpleDistribution.sol

@@ -7,6 +7,9 @@ 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
@@ -17,8 +20,7 @@ contract SimpleDistribution is
         address registry,
         NftId productNftId,
         IAuthorization authorization,
-        address initialOwner,
-        address token
+        address initialOwner
     ) 
     {
         initialize(
@@ -26,8 +28,7 @@ contract SimpleDistribution is
             productNftId,
             authorization,
             initialOwner,
-            "SimpleDistribution",
-            token);
+            "SimpleDistribution");
     }
 
     function initialize(
@@ -35,8 +36,7 @@ contract SimpleDistribution is
         NftId productNftId,
         IAuthorization authorization,
         address initialOwner,
-        string memory name,
-        address token
+        string memory name
     )
         public
         virtual
@@ -47,11 +47,35 @@ contract SimpleDistribution is
             productNftId,
             authorization,
             initialOwner,
-            name,
-            token);
+            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

@@ -21,7 +21,7 @@ contract SimpleDistributionAuthorization
 
         // authorize public role (open access to any account, only allows to lock target)
         IAccess.FunctionInfo[] storage functions;
-        functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
+        functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
         _authorize(functions, SimpleDistribution.approveTokenHandler.selector, "approveTokenHandler");
         _authorize(functions, SimpleDistribution.setWallet.selector, "setWallet");
     }

package/contracts/examples/unpermissioned/SimpleOracle.sol

@@ -34,8 +34,7 @@ contract SimpleOracle is
         address registry,
         NftId productNftId,
         IAuthorization authorization,
-        address initialOwner,
-        address token
+        address initialOwner
     ) 
     {
         initialize(
@@ -43,8 +42,7 @@ contract SimpleOracle is
             productNftId,
             authorization,
             initialOwner,
-            "SimpleOracle",
-            token
+            "SimpleOracle"
         );
     }
 
@@ -53,8 +51,7 @@ contract SimpleOracle is
         NftId productNftId,
         IAuthorization authorization,
         address initialOwner,
-        string memory name,
-        address token
+        string memory name
     )
         public
         virtual
@@ -65,8 +62,7 @@ contract SimpleOracle is
             productNftId,
             authorization,
             initialOwner,
-            name,
-            token);
+            name);
     }
 
     /// @dev use case specific handling of oracle requests

package/contracts/examples/unpermissioned/SimplePool.sol

@@ -5,7 +5,6 @@ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IER
 
 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";
@@ -20,7 +19,6 @@ contract SimplePool is
     constructor(
         address registry,
         NftId productNftId,
-        address token,
         IComponents.PoolInfo memory poolInfo,
         IAuthorization authorization,
         address initialOwner
@@ -29,7 +27,6 @@ contract SimplePool is
         initialize(
             registry,
             productNftId,
-            token,
             poolInfo,
             authorization,
             initialOwner
@@ -40,7 +37,6 @@ contract SimplePool is
     function initialize(
         address registry,
         NftId productNftId,
-        address token,
         IComponents.PoolInfo memory poolInfo,
         IAuthorization authorization,
         address initialOwner
@@ -53,7 +49,6 @@ contract SimplePool is
             registry,
             productNftId,
             "SimplePool",
-            token,
             poolInfo,
             authorization,
             initialOwner);

package/contracts/examples/unpermissioned/SimplePoolAuthorization.sol

@@ -21,7 +21,7 @@ contract SimplePoolAuthorization
 
         // authorize public role (open access to any account, only allows to lock target)
         IAccess.FunctionInfo[] storage functions;
-        functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
+        functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
         _authorize(functions, SimplePool.approveTokenHandler.selector, "approveTokenHandler");
         _authorize(functions, SimplePool.setWallet.selector, "setWallet");
     }

package/contracts/examples/unpermissioned/SimpleProduct.sol

@@ -37,7 +37,6 @@ contract SimpleProduct is
         address registry,
         NftId instanceNftId,
         string memory name,
-        address token,
         IComponents.ProductInfo memory productInfo,
         IComponents.FeeInfo memory feeInfo,
         IAuthorization authorization,
@@ -48,7 +47,6 @@ contract SimpleProduct is
             registry,
             instanceNftId,
             name,
-            token,
             productInfo,
             feeInfo,
             authorization,
@@ -60,7 +58,6 @@ contract SimpleProduct is
         address registry,
         NftId instanceNftid,
         string memory name,
-        address token,
         IComponents.ProductInfo memory productInfo,
         IComponents.FeeInfo memory feeInfo,
         IAuthorization authorization,
@@ -74,7 +71,6 @@ contract SimpleProduct is
             registry,
             instanceNftid,
             name,
-            token,
             productInfo,
             feeInfo,
             authorization,
@@ -85,11 +81,11 @@ contract SimpleProduct is
 
 
     function createRisk(
-        RiskId id,
+        string memory id,
         bytes memory data
-    ) public {
-        _createRisk(
-            id,
+    ) public returns (RiskId) {
+        return _createRisk(
+            bytes32(abi.encodePacked(id)),
             data
         );
     }
@@ -104,16 +100,22 @@ contract SimpleProduct is
         );
     }
 
-    function updateRiskState(
+    function setRiskLocked(
         RiskId id,
-        StateId state
+        bool locked
     ) public {
-        _updateRiskState(
+        _setRiskLocked(
             id,
-            state
+            locked
         );
     }
 
+    function closeRisk(
+        RiskId id
+    ) public {
+        _closeRisk(id);
+    }
+
     function createApplication(
         address applicationOwner,
         RiskId riskId,
@@ -147,12 +149,55 @@ contract SimpleProduct is
         );
     }
 
+    function createApplication2(
+        address applicationOwner,
+        RiskId riskId,
+        Amount sumInsuredAmount,
+        Amount premiumAmount,
+        Seconds lifetime,
+        bytes memory applicationData,
+        NftId bundleNftId,
+        ReferralId referralId
+    )
+        public
+        returns (NftId nftId)
+    {
+        return _createApplication(
+            applicationOwner,
+            riskId,
+            sumInsuredAmount,
+            premiumAmount,
+            lifetime,
+            bundleNftId,
+            referralId,
+            applicationData
+        );
+    }
+    
+    function revoke(
+        NftId applicationNftId
+    ) public {
+        _revoke(applicationNftId);
+    }
+
     function createPolicy(
         NftId applicationNftId,
         bool requirePremiumPayment,
         Timestamp activateAt
     ) public {
-        _createPolicy(applicationNftId, activateAt);
+        _createPolicy(applicationNftId, activateAt, AmountLib.max());
+        if (requirePremiumPayment == true) {
+            _collectPremium(applicationNftId, activateAt);
+        }
+    }
+
+    function createPolicy2(
+        NftId applicationNftId,
+        bool requirePremiumPayment,
+        Timestamp activateAt,
+        Amount maxPremiumAmount
+    ) public {
+        _createPolicy(applicationNftId, activateAt, maxPremiumAmount);
         if (requirePremiumPayment == true) {
             _collectPremium(applicationNftId, activateAt);
         }
@@ -188,6 +233,13 @@ contract SimpleProduct is
         _activate(policyNftId, activateAt);
     }
 
+    function adjustActivation(
+        NftId policyNftId,
+        Timestamp activateAt
+    ) public {
+        _adjustActivation(policyNftId, activateAt);
+    }
+
     function close(
         NftId policyNftId
     ) public {
@@ -226,11 +278,11 @@ contract SimpleProduct is
         _declineClaim(policyNftId, claimId, processData);
     }
 
-    function closeClaim(
+    function cancelConfirmedClaim(
         NftId policyNftId,
         ClaimId claimId
     ) public {
-        _closeClaim(policyNftId, claimId);
+        _cancelConfirmedClaim(policyNftId, claimId);
     }
 
     function createPayout(
@@ -263,8 +315,8 @@ contract SimpleProduct is
     function processPayout(
         NftId policyNftId,
         PayoutId payoutId
-    ) public {
-        _processPayout(policyNftId, payoutId);
+    ) public returns (Amount netPayoutAmount, Amount processingFeeAmount) {
+        (netPayoutAmount, processingFeeAmount) = _processPayout(policyNftId, payoutId);
     }
 
     function createOracleRequest(
@@ -296,6 +348,28 @@ contract SimpleProduct is
         }
     }
 
+    function createOracleRequest2(
+        NftId oracleNftId,
+        string memory requestText,
+        Timestamp expiryAt,
+        bool synchronous,
+        string memory callbackMethod
+    )
+        public
+        // restricted()
+        returns (RequestId)
+    {
+        bytes memory requestData = abi.encode(SimpleOracle.SimpleRequest(
+            synchronous,
+            requestText));
+
+        return _oracleService.request(
+            oracleNftId, 
+            requestData, 
+            expiryAt, 
+            callbackMethod);
+    }
+
     function cancelOracleRequest(
         RequestId requestId
     )
@@ -326,7 +400,7 @@ contract SimpleProduct is
         SimpleOracle.SimpleResponse memory response = abi.decode(
             responseData, (SimpleOracle.SimpleResponse));
 
-        if (response.revertInCall && response.revertUntil >= TimestampLib.blockTimestamp()) {
+        if (response.revertInCall && response.revertUntil >= TimestampLib.current()) {
             revert ErrorSimpleProductRevertedWhileProcessingResponse(requestId);
         }
 
@@ -344,21 +418,14 @@ contract SimpleProduct is
     }
 
 
-    function doSomethingSpecial() 
+    function doSomethingOnlyWhenActive() 
         public 
-        restricted()
+        onlyActive()
         returns (bool) 
     {
         return true;
     }
 
-    function doWhenNotLocked() 
-        public 
-        restricted()
-        returns (bool) 
-    {
-        return true;
-    }
 
     function getOracleService() public view returns (IOracleService) {
         return _oracleService;

package/contracts/examples/unpermissioned/SimpleProductAuthorization.sol

@@ -21,7 +21,7 @@ contract SimpleProductAuthorization
 
         // authorize public role (open access to any account, only allows to lock target)
         IAccess.FunctionInfo[] storage functions;
-        functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
+        functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
         _authorize(functions, SimpleProduct.approveTokenHandler.selector, "approveTokenHandler");
         _authorize(functions, SimpleProduct.setWallet.selector, "setWallet");
     }