@etherisc/gif-next 0.0.2-ffa91a6-022 → 3.0.0-0fefe0d-162

package/contracts/distribution/DistributionService.sol

@@ -13,21 +13,24 @@ import {IComponents} from "../instance/module/IComponents.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 
 import {Amount, AmountLib} from "../type/Amount.sol";
-import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
+import {ContractLib} from "../shared/ContractLib.sol";
 import {DistributorType, DistributorTypeLib} from "../type/DistributorType.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
 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";
-import {ReferralId, ReferralLib} from "../type/Referral.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";
 import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
-import {UFixed} from "../type/UFixed.sol";
+import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
 
 contract DistributionService is
-    ComponentVerifyingService,
+    Service,
     IDistributionService
 {
     IAccountingService private _accountingService;
@@ -71,12 +74,14 @@ contract DistributionService is
         bytes memory data
     )
         external
+        virtual
+        restricted()
         returns (DistributorType distributorType)
     {
-        (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
+        (NftId distributionNftId, IInstance instance) = _getAndVerifyActiveDistribution();
 
         {
-            NftId productNftId = _getProductNftId(distributionNftId);
+            NftId productNftId = getRegistry().getParentNftId(distributionNftId);
             IComponents.FeeInfo memory feeInfo = instance.getInstanceReader().getFeeInfo(productNftId);
 
             UFixed variableDistributionFees = feeInfo.distributionFee.fractionalFee;
@@ -87,25 +92,27 @@ contract DistributionService is
             }
             UFixed maxDiscountPercentageLimit = variableDistributionFees - variableFeesPartsTotal;
 
-            if (maxDiscountPercentage.gt(maxDiscountPercentageLimit)) {
+            if (maxDiscountPercentage > maxDiscountPercentageLimit) {
                 revert ErrorDistributionServiceMaxDiscountTooHigh(maxDiscountPercentage.toInt1000(), maxDiscountPercentageLimit.toInt1000());
             }
         }
 
         distributorType = DistributorTypeLib.toDistributorType(distributionNftId, name);
-        IDistribution.DistributorTypeInfo memory info = IDistribution.DistributorTypeInfo(
-            name,
-            distributionNftId,
-            minDiscountPercentage,
-            maxDiscountPercentage,
-            commissionPercentage,
-            maxReferralCount,
-            maxReferralLifetime,
-            allowSelfReferrals,
-            allowRenewals,
-            data);
+        IDistribution.DistributorTypeInfo memory info = IDistribution.DistributorTypeInfo({
+            name: name,
+            distributionNftId: distributionNftId,
+            minDiscountPercentage: minDiscountPercentage,
+            maxDiscountPercentage: maxDiscountPercentage,
+            commissionPercentage: commissionPercentage,
+            maxReferralCount: maxReferralCount,
+            maxReferralLifetime: maxReferralLifetime,
+            allowSelfReferrals: allowSelfReferrals,
+            allowRenewals: allowRenewals,
+            data: data});
 
         instance.getInstanceStore().createDistributorType(distributorType, info);
+
+        emit LogDistributionServiceDistributorTypeCreated(distributionNftId, name);
     }
 
 
@@ -116,9 +123,10 @@ contract DistributionService is
     )
         external 
         virtual
+        restricted()
         returns (NftId distributorNftId)
     {
-        (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
+        (NftId distributionNftId, IInstance instance) = _getAndVerifyActiveDistribution();
         _checkDistributionType(instance.getInstanceReader(), distributorType, distributionNftId);
 
         distributorNftId = _registryService.registerDistributor(
@@ -132,13 +140,15 @@ contract DistributionService is
                 ""
             ));
 
-        IDistribution.DistributorInfo memory info = IDistribution.DistributorInfo(
-            distributorType,
-            true, // active
-            data,
-            0);
+        IDistribution.DistributorInfo memory info = IDistribution.DistributorInfo({
+            distributorType: distributorType,
+            active: true, 
+            numPoliciesSold: 0,
+            data: data});
 
         instance.getInstanceStore().createDistributor(distributorNftId, info);
+
+        emit LogDistributionServiceDistributorCreated(distributionNftId, distributorNftId, distributorType, distributor);
     }
 
     function changeDistributorType(
@@ -148,15 +158,19 @@ contract DistributionService is
     )
         external
         virtual
+        restricted()
     {
         _checkNftType(distributorNftId, DISTRIBUTOR());
-        (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
+        (NftId distributionNftId, IInstance instance) = _getAndVerifyActiveDistribution();
         _checkDistributionType(instance.getInstanceReader(), newDistributorType, distributionNftId);
         
         IDistribution.DistributorInfo memory distributorInfo = instance.getInstanceReader().getDistributorInfo(distributorNftId);
+        DistributorType oldDistributorType = distributorInfo.distributorType;
         distributorInfo.distributorType = newDistributorType;
         distributorInfo.data = data;
         instance.getInstanceStore().updateDistributor(distributorNftId, distributorInfo, KEEP_STATE());
+
+        emit LogDistributionServiceDistributorTypeChanged(distributorNftId, oldDistributorType, newDistributorType);
     }
 
 
@@ -170,15 +184,16 @@ contract DistributionService is
     )
         external
         virtual
+        restricted()
         onlyNftOfType(distributorNftId, DISTRIBUTOR())
         returns (ReferralId referralId)
     {
-        (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
+        (NftId distributionNftId, IInstance instance) = _getAndVerifyActiveDistribution();
 
         if (bytes(code).length == 0) {
-            revert ErrorDistributionServiceInvalidReferral(code);
+            revert ErrorDistributionServiceInvalidReferral();
         }
-        if (expiryAt.eqz() || expiryAt.lte(TimestampLib.blockTimestamp())) {
+        if (expiryAt.eqz() || expiryAt < TimestampLib.current()) {
             revert ErrorDistributionServiceExpirationInvalid(expiryAt);
         }
 
@@ -193,33 +208,35 @@ contract DistributionService is
             IDistribution.DistributorTypeInfo memory distributorTypeData = instanceReader.getDistributorTypeInfo(distributorType);
 
             if (distributorTypeData.maxReferralCount < maxReferrals) {
-                revert ErrorDistributionServiceMaxReferralsExceeded(distributorTypeData.maxReferralCount);
+                revert ErrorDistributionServiceMaxReferralsExceeded(distributorTypeData.maxReferralCount, maxReferrals);
             }
             if (distributorTypeData.minDiscountPercentage > discountPercentage) {
-                revert ErrorDistributionServiceDiscountTooLow(distributorTypeData.minDiscountPercentage.toInt(), discountPercentage.toInt());
+                revert ErrorDistributionServiceDiscountTooLow(distributorTypeData.minDiscountPercentage, discountPercentage);
             }
             if (distributorTypeData.maxDiscountPercentage < discountPercentage) {
-                revert ErrorDistributionServiceDiscountTooHigh(distributorTypeData.maxDiscountPercentage.toInt(), discountPercentage.toInt());
+                revert ErrorDistributionServiceDiscountTooHigh(distributorTypeData.maxDiscountPercentage, discountPercentage);
             }
-            if (expiryAt.toInt() - TimestampLib.blockTimestamp().toInt() > distributorTypeData.maxReferralLifetime.toInt()) {
+            if (expiryAt.toInt() - TimestampLib.current().toInt() > distributorTypeData.maxReferralLifetime.toInt()) {
                 revert ErrorDistributionServiceExpiryTooLong(distributorTypeData.maxReferralLifetime, expiryAt);
             }
         }
 
         {
             referralId = ReferralLib.toReferralId(distributionNftId, code);
-            IDistribution.ReferralInfo memory info = IDistribution.ReferralInfo(
-                distributionNftId,
-                distributorNftId,
-                code,
-                discountPercentage,
-                maxReferrals,
-                0, // used referrals
-                expiryAt,
-                data
-            );
+            IDistribution.ReferralInfo memory info = IDistribution.ReferralInfo({
+                distributionNftId: distributionNftId,
+                distributorNftId: distributorNftId,
+                referralCode: code,
+                discountPercentage: discountPercentage,
+                maxReferrals: maxReferrals,
+                usedReferrals: 0, 
+                expiryAt: expiryAt,
+                data: data
+            });
 
             instance.getInstanceStore().createReferral(referralId, info);
+
+            emit LogDistributionServiceReferralCreated(distributionNftId, distributorNftId, referralId, code);
         }
     }
 
@@ -234,14 +251,14 @@ contract DistributionService is
         onlyNftOfType(distributionNftId, DISTRIBUTION())
     {
         if (referralIsValid(distributionNftId, referralId)) {
-            IRegistry registry = getRegistry();
-            IRegistry.ObjectInfo memory distributionInfo = registry.getObjectInfo(distributionNftId);
-            IInstance instance = _getInstanceForComponent(registry, distributionInfo.parentNftId);
+            IInstance instance = IInstance(ContractLib.getInstanceForComponent(getRegistry(), distributionNftId));
 
             // update book keeping for referral info
             IDistribution.ReferralInfo memory referralInfo = instance.getInstanceReader().getReferralInfo(referralId);
             referralInfo.usedReferrals += 1;
             instance.getInstanceStore().updateReferral(referralId, referralInfo, KEEP_STATE());
+
+            emit LogDistributionServiceReferralProcessed(distributionNftId, referralInfo.distributorNftId, referralId, referralInfo.usedReferrals);
         }
     }
 
@@ -255,9 +272,7 @@ contract DistributionService is
         restricted()
         onlyNftOfType(distributionNftId, DISTRIBUTION())
     {
-        IRegistry registry = getRegistry();
-        IRegistry.ObjectInfo memory distributionInfo = registry.getObjectInfo(distributionNftId);
-        IInstance instance = _getInstanceForComponent(registry, distributionInfo.parentNftId);
+        IInstance instance = IInstance(ContractLib.getInstanceForComponent(getRegistry(), distributionNftId));
         InstanceReader reader = instance.getInstanceReader();
         InstanceStore store = instance.getInstanceStore();
 
@@ -284,30 +299,32 @@ contract DistributionService is
             // increase distribution balance by distribution owner fee
             _accountingService.increaseDistributionBalance(store, distributionNftId, AmountLib.zero(), distributionOwnerFee);
         }
+
+        emit LogDistributionServiceSaleProcessed(distributionNftId, referralId);
     }
 
     /// @inheritdoc IDistributionService
     function withdrawCommission(NftId distributorNftId, Amount amount) 
         public 
         virtual
-        // TODO: restricted() (once #462 is done)
+        restricted()
         onlyNftOfType(distributorNftId, DISTRIBUTOR())
         returns (Amount withdrawnAmount) 
     {
-        (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
+        (NftId distributionNftId, IInstance instance) = _getAndVerifyActiveDistribution();
         InstanceReader reader = instance.getInstanceReader();
         
         IComponents.ComponentInfo memory distributionInfo = reader.getComponentInfo(distributionNftId);
-        address distributionWallet = distributionInfo.tokenHandler.getWallet();
+        // address distributionWallet = distributionInfo.tokenHandler.getWallet();
         
         Amount commissionAmount = reader.getFeeAmount(distributorNftId);
         
         // determine withdrawn amount
         withdrawnAmount = amount;
-        if (withdrawnAmount.gte(AmountLib.max())) {
+        if (withdrawnAmount >= AmountLib.max()) {
             withdrawnAmount = commissionAmount;
         } else {
-            if (withdrawnAmount.gt(commissionAmount)) {
+            if (withdrawnAmount > commissionAmount) {
                 revert ErrorDistributionServiceCommissionWithdrawAmountExceedsLimit(withdrawnAmount, commissionAmount);
             }
         }
@@ -331,6 +348,7 @@ contract DistributionService is
 
     function referralIsValid(NftId distributionNftId, ReferralId referralId) 
         public 
+        virtual
         view 
         onlyNftOfType(distributionNftId, DISTRIBUTION())
         returns (bool isValid) 
@@ -339,9 +357,7 @@ contract DistributionService is
             return false;
         }
 
-        IRegistry registry = getRegistry();
-        IRegistry.ObjectInfo memory distributionInfo = registry.getObjectInfo(distributionNftId);
-        IInstance instance = _getInstanceForComponent(registry, distributionInfo.parentNftId);
+        IInstance instance = IInstance(ContractLib.getInstanceForComponent(getRegistry(), distributionNftId));
         IDistribution.ReferralInfo memory info = instance.getInstanceReader().getReferralInfo(referralId);
 
         if (info.distributorNftId.eqz()) {
@@ -353,10 +369,52 @@ contract DistributionService is
             revert ErrorDistributionServiceReferralDistributionMismatch(referralId, info.distributionNftId, distributionNftId);
         }
 
-        isValid = info.expiryAt.eqz() || (info.expiryAt.gtz() && TimestampLib.blockTimestamp() <= info.expiryAt);
+        isValid = info.expiryAt.eqz() || (info.expiryAt.gtz() && TimestampLib.current() <= info.expiryAt);
         isValid = isValid && info.usedReferrals < info.maxReferrals;
     }
 
+
+    function getDiscountPercentage(
+        InstanceReader instanceReader,
+        ReferralId referralId
+    )
+        external
+        virtual
+        view 
+        returns (
+            UFixed discountPercentage, 
+            ReferralStatus status
+        )
+    { 
+        IDistribution.ReferralInfo memory info = instanceReader.getReferralInfo(
+            referralId);        
+
+        if (info.expiryAt.eqz()) {
+            return (
+                UFixedLib.zero(),
+                REFERRAL_ERROR_UNKNOWN());
+        }
+
+        if (info.expiryAt < TimestampLib.current()) {
+            return (
+                UFixedLib.zero(),
+                REFERRAL_ERROR_EXPIRED());
+        }
+
+        if (info.usedReferrals >= info.maxReferrals) {
+            return (
+                UFixedLib.zero(),
+                REFERRAL_ERROR_EXHAUSTED());
+        }
+
+        return (
+            info.discountPercentage,
+            REFERRAL_OK()
+        );
+
+    }
+
+
     function _checkDistributionType(InstanceReader instanceReader, DistributorType distributorType, NftId expectedDistributionNftId) 
         internal
         view 
@@ -369,16 +427,21 @@ contract DistributionService is
         }
     }
 
-    function _getInstanceForDistribution(NftId distributionNftId)
+
+
+    function _getAndVerifyActiveDistribution()
         internal
+        virtual
         view
-        returns(IInstance instance)
+        returns (
+            NftId poolNftId,
+            IInstance instance
+        )
     {
-        NftId instanceNftId = getRegistry().getParentNftId(distributionNftId);
-        address instanceAddress = getRegistry().getObjectAddress(instanceNftId);
-        return IInstance(instanceAddress);
+        return PoolLib.getAndVerifyActiveComponent(getRegistry(), msg.sender, DISTRIBUTION());
     }
 
+
     function _getDomain() internal pure override returns(ObjectType) {
         return DISTRIBUTION();
     }

package/contracts/distribution/IDistributionComponent.sol

@@ -1,12 +1,14 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount} from "../type/Amount.sol";
 import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+
+import {Amount} from "../type/Amount.sol";
 import {NftId} from "../type/NftId.sol";
 import {ReferralId, ReferralStatus} from "../type/Referral.sol";
 import {UFixed} from "../type/UFixed.sol";
 
+
 interface IDistributionComponent is IInstanceLinkedComponent {
 
     event LogDistributorUpdated(address to, address operator);

package/contracts/distribution/IDistributionService.sol

@@ -1,15 +1,17 @@
 // 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 {
@@ -17,11 +19,11 @@ interface IDistributionService is IService {
     error ErrorDistributionServiceParentNftIdNotInstance(NftId nftId, NftId parentNftId);
     error ErrorDistributionServiceCallerNotDistributor(address caller);
     error ErrorDistributionServiceInvalidReferralId(ReferralId referralId);
-    error ErrorDistributionServiceMaxReferralsExceeded(uint256 maxReferrals);
-    error ErrorDistributionServiceDiscountTooLow(uint256 minDiscountPercentage, uint256 discountPercentage);
-    error ErrorDistributionServiceDiscountTooHigh(uint256 maxDiscountPercentage, uint256 discountPercentage);
+    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(string code);
+    error ErrorDistributionServiceInvalidReferral();
     error ErrorDistributionServiceExpirationInvalid(Timestamp expiryAt);
     error ErrorDistributionServiceCommissionTooHigh(uint256 commissionPercentage, uint256 maxCommissionPercentage);
     error ErrorDistributionServiceMinFeeTooHigh(uint256 minFee, uint256 limit);
@@ -38,6 +40,12 @@ 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 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,
@@ -100,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/FireProduct.sol

@@ -140,9 +140,9 @@ contract FireProduct is
             revert ErrorFireProductCityUnknown(cityName);
         }
 
-        _updateRiskState(
+        _setRiskLocked(
             _riskMapping[cityName],
-            PAUSED()
+            true
         );
     }
 
@@ -156,9 +156,9 @@ contract FireProduct is
             revert ErrorFireProductCityUnknown(cityName);
         }
 
-        _updateRiskState(
+        _setRiskLocked(
             _riskMapping[cityName],
-            ACTIVE()
+            false
         );
     }
 
@@ -263,7 +263,7 @@ contract FireProduct is
         onlyOwner()
         onlyNftOfType(policyNftId, POLICY())
     {
-        _createPolicy(policyNftId, activateAt);
+        _createPolicy(policyNftId, activateAt, AmountLib.max());
         _collectPremium(policyNftId, activateAt);
     }
 
@@ -316,7 +316,7 @@ contract FireProduct is
             revert ErrorFireProductCityUnknown(cityName);
         }
 
-        if (reportedAt > TimestampLib.blockTimestamp()) {
+        if (reportedAt > TimestampLib.current()) {
             revert ErrorFireProductTimestampInFuture();
         }