@etherisc/gif-next 0.0.2-f13c010-035 → 0.0.2-f13d67f-541

package/contracts/distribution/DistributionService.sol

@@ -1,33 +1,39 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IRegistry} from "../registry/IRegistry.sol";
-import {IInstance} from "../instance/IInstance.sol";
+import {IAccountingService} from "../accounting/IAccountingService.sol";
 import {IComponentService} from "../shared/IComponentService.sol";
+import {IDistribution} from "../instance/module/IDistribution.sol";
+import {IDistributionService} from "./IDistributionService.sol";
+import {IInstance} from "../instance/IInstance.sol";
 import {IInstanceService} from "../instance/IInstanceService.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryService} from "../registry/IRegistryService.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 
 import {Amount, AmountLib} from "../type/Amount.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, COMPONENT, DISTRIBUTION, INSTANCE, DISTRIBUTION, DISTRIBUTOR, REGISTRY} from "../type/ObjectType.sol";
-import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
-import {IDistributionService} from "./IDistributionService.sol";
-import {UFixed} from "../type/UFixed.sol";
-import {DistributorType, DistributorTypeLib} from "../type/DistributorType.sol";
-import {ReferralId, ReferralLib} from "../type/Referral.sol";
-import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
-import {IDistribution} from "../instance/module/IDistribution.sol";
+import {ObjectType, ACCOUNTING, COMPONENT, DISTRIBUTION, INSTANCE, DISTRIBUTION, DISTRIBUTOR, REGISTRY} from "../type/ObjectType.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
+// TODO PoolLib feels wrong, should likely go in a component type independent lib
+import {PoolLib} from "../pool/PoolLib.sol";
+import {ReferralId, ReferralStatus, ReferralLib, REFERRAL_OK, REFERRAL_ERROR_UNKNOWN, REFERRAL_ERROR_EXPIRED, REFERRAL_ERROR_EXHAUSTED} from "../type/Referral.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {Service} from "../shared/Service.sol";
+import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
+import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
 
 contract DistributionService is
-    ComponentVerifyingService,
+    Service,
     IDistributionService
 {
+    IAccountingService private _accountingService;
     IComponentService private _componentService;
     IInstanceService private _instanceService;
     IRegistryService private _registryService;
@@ -41,12 +47,13 @@ contract DistributionService is
         initializer()
     {
         (
-            address registryAddress,
-            address authority
+            address authority,
+            address registry
         ) = abi.decode(data, (address, address));
 
-        _initializeService(registryAddress, authority, owner);
+        __Service_init(authority, registry, owner);
 
+        _accountingService = IAccountingService(_getServiceAddress(ACCOUNTING()));
         _componentService = IComponentService(_getServiceAddress(COMPONENT()));
         _instanceService = IInstanceService(_getServiceAddress(INSTANCE()));
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
@@ -61,47 +68,51 @@ contract DistributionService is
         UFixed maxDiscountPercentage,
         UFixed commissionPercentage,
         uint32 maxReferralCount,
-        uint32 maxReferralLifetime,
+        Seconds maxReferralLifetime,
         bool allowSelfReferrals,
         bool allowRenewals,
         bytes memory data
     )
         external
+        virtual
+        restricted()
         returns (DistributorType distributorType)
     {
-        (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
-        InstanceReader instanceReader = instance.getInstanceReader();
+        (NftId distributionNftId, IInstance instance) = _getAndVerifyActiveDistribution();
 
         {
-            NftId productNftId = _getProductNftId(distributionNftId);
-            IComponents.ProductInfo memory productInfo = instance.getInstanceReader().getProductInfo(productNftId);
+            NftId productNftId = getRegistry().getParentNftId(distributionNftId);
+            IComponents.FeeInfo memory feeInfo = instance.getInstanceReader().getFeeInfo(productNftId);
 
-            UFixed variableDistributionFees = productInfo.distributionFee.fractionalFee;
-            UFixed variableFeesPartsTotal = productInfo.minDistributionOwnerFee.fractionalFee + commissionPercentage;
+            UFixed variableDistributionFees = feeInfo.distributionFee.fractionalFee;
+            UFixed variableFeesPartsTotal = feeInfo.minDistributionOwnerFee.fractionalFee + commissionPercentage;
 
             if (variableFeesPartsTotal > variableDistributionFees) {
                 revert ErrorDistributionServiceVariableFeesTooHight(variableDistributionFees.toInt1000(), variableFeesPartsTotal.toInt1000());
             }
             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,
-            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);
     }
 
 
@@ -112,9 +123,11 @@ 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(
             IRegistry.ObjectInfo(
@@ -127,30 +140,38 @@ 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 updateDistributorType(
-    //     NftId distributorNftId,
-    //     DistributorType distributorType,
-    //     bytes memory data
-    // )
-    //     external
-    //     virtual
-    // {
-    //     (, IInstance instance) = _getAndVerifyCallingDistribution();
-    //     InstanceReader instanceReader = instance.getInstanceReader();
-    //     IDistribution.DistributorInfo memory distributorInfo = instanceReader.getDistributorInfo(distributorNftId);
-    //     distributorInfo.distributorType = distributorType;
-    //     distributorInfo.data = data;
-    //     instance.updateDistributor(distributorNftId, distributorInfo, KEEP_STATE());
-    // }
+    function changeDistributorType(
+        NftId distributorNftId,
+        DistributorType newDistributorType,
+        bytes memory data
+    )
+        external
+        virtual
+        restricted()
+    {
+        _checkNftType(distributorNftId, DISTRIBUTOR());
+        (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);
+    }
 
 
     function createReferral(
@@ -163,16 +184,22 @@ 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 ErrorIDistributionServiceInvalidReferral(code);
+            revert ErrorDistributionServiceInvalidReferral();
+        }
+        if (expiryAt.eqz() || expiryAt < TimestampLib.current()) {
+            revert ErrorDistributionServiceExpirationInvalid(expiryAt);
         }
-        if (expiryAt.eqz() || expiryAt.lte(TimestampLib.blockTimestamp())) {
-            revert ErrorIDistributionServiceExpirationInvalid(expiryAt);
+
+        NftId distributorDistributionNftId = getRegistry().getParentNftId(distributorNftId);
+        if (distributorDistributionNftId != distributionNftId) {
+            revert ErrorDistributionServiceDistributorDistributionMismatch(distributorNftId, distributorDistributionNftId, distributionNftId);
         }
 
         {
@@ -181,32 +208,35 @@ contract DistributionService is
             IDistribution.DistributorTypeInfo memory distributorTypeData = instanceReader.getDistributorTypeInfo(distributorType);
 
             if (distributorTypeData.maxReferralCount < maxReferrals) {
-                revert ErrorIDistributionServiceMaxReferralsExceeded(distributorTypeData.maxReferralCount);
+                revert ErrorDistributionServiceMaxReferralsExceeded(distributorTypeData.maxReferralCount, maxReferrals);
             }
             if (distributorTypeData.minDiscountPercentage > discountPercentage) {
-                revert ErrorIDistributionServiceDiscountTooLow(distributorTypeData.minDiscountPercentage.toInt(), discountPercentage.toInt());
+                revert ErrorDistributionServiceDiscountTooLow(distributorTypeData.minDiscountPercentage, discountPercentage);
             }
             if (distributorTypeData.maxDiscountPercentage < discountPercentage) {
-                revert ErrorIDistributionServiceDiscountTooHigh(distributorTypeData.maxDiscountPercentage.toInt(), discountPercentage.toInt());
+                revert ErrorDistributionServiceDiscountTooHigh(distributorTypeData.maxDiscountPercentage, discountPercentage);
             }
-            if (expiryAt.toInt() - TimestampLib.blockTimestamp().toInt() > distributorTypeData.maxReferralLifetime) {
-                revert ErrorIDistributionServiceExpiryTooLong(distributorTypeData.maxReferralLifetime, expiryAt.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(
-                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);
         }
     }
 
@@ -221,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);
+            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);
         }
     }
 
@@ -242,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);
+        IInstance instance = IInstance(ContractLib.getInstanceForComponent(getRegistry(), distributionNftId));
         InstanceReader reader = instance.getInstanceReader();
         InstanceStore store = instance.getInstanceStore();
 
@@ -256,12 +284,12 @@ contract DistributionService is
 
             // increase distribution balance by commission amount and distribution owner fee
             Amount commissionAmount = premium.commissionAmount;
-            _componentService.increaseDistributionBalance(store, distributionNftId, commissionAmount, distributionOwnerFee);
+            _accountingService.increaseDistributionBalance(store, distributionNftId, commissionAmount, distributionOwnerFee);
 
             // update book keeping for referral info
             IDistribution.ReferralInfo memory referralInfo = reader.getReferralInfo(referralId);
 
-            _componentService.increaseDistributorBalance(store, referralInfo.distributorNftId, AmountLib.zero(), commissionAmount);
+            _accountingService.increaseDistributorBalance(store, referralInfo.distributorNftId, AmountLib.zero(), commissionAmount);
 
             // update book keeping for distributor info
             IDistribution.DistributorInfo memory distributorInfo = reader.getDistributorInfo(referralInfo.distributorNftId);
@@ -269,32 +297,34 @@ contract DistributionService is
             store.updateDistributor(referralInfo.distributorNftId, distributorInfo, KEEP_STATE());
         } else {
             // increase distribution balance by distribution owner fee
-            _componentService.increaseDistributionBalance(store, distributionNftId, AmountLib.zero(), distributionOwnerFee);
+            _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.wallet;
+        // 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);
             }
         }
@@ -303,21 +333,22 @@ contract DistributionService is
         {
             InstanceStore store = instance.getInstanceStore();
             // decrease fee counter for distribution balance
-            _componentService.decreaseDistributionBalance(store, distributionNftId, withdrawnAmount, AmountLib.zero());
+            _accountingService.decreaseDistributionBalance(store, distributionNftId, withdrawnAmount, AmountLib.zero());
             // decrease fee counter for distributor fee
-            _componentService.decreaseDistributorBalance(store, distributorNftId, AmountLib.zero(), withdrawnAmount);
+            _accountingService.decreaseDistributorBalance(store, distributorNftId, AmountLib.zero(), withdrawnAmount);
         }
 
         // transfer amount to distributor
         {
             address distributor = getRegistry().ownerOf(distributorNftId);
-            emit LogDistributionServiceCommissionWithdrawn(distributorNftId, distributor, address(distributionInfo.token), withdrawnAmount);
-            distributionInfo.tokenHandler.distributeTokens(distributionWallet, distributor, withdrawnAmount);
+            emit LogDistributionServiceCommissionWithdrawn(distributorNftId, distributor, address(distributionInfo.tokenHandler.TOKEN()), withdrawnAmount);
+            distributionInfo.tokenHandler.pushToken(distributor, withdrawnAmount);
         }
     }
 
     function referralIsValid(NftId distributionNftId, ReferralId referralId) 
         public 
+        virtual
         view 
         onlyNftOfType(distributionNftId, DISTRIBUTION())
         returns (bool isValid) 
@@ -326,29 +357,91 @@ contract DistributionService is
             return false;
         }
 
-        IRegistry registry = getRegistry();
-        IRegistry.ObjectInfo memory distributionInfo = registry.getObjectInfo(distributionNftId);
-        IInstance instance = _getInstanceForComponent(registry, distributionInfo);
+        IInstance instance = IInstance(ContractLib.getInstanceForComponent(getRegistry(), distributionNftId));
         IDistribution.ReferralInfo memory info = instance.getInstanceReader().getReferralInfo(referralId);
 
         if (info.distributorNftId.eqz()) {
             return false;
         }
 
-        isValid = info.expiryAt.eqz() || (info.expiryAt.gtz() && TimestampLib.blockTimestamp() <= info.expiryAt);
+        // ensure the referral was created on the same distribution
+        if(info.distributionNftId != distributionNftId) {
+            revert ErrorDistributionServiceReferralDistributionMismatch(referralId, info.distributionNftId, distributionNftId);
+        }
+
+        isValid = info.expiryAt.eqz() || (info.expiryAt.gtz() && TimestampLib.current() <= info.expiryAt);
         isValid = isValid && info.usedReferrals < info.maxReferrals;
     }
 
-    function _getInstanceForDistribution(NftId distributionNftId)
+
+    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 
+    {
+        // enfore distributor type belongs to the calling distribution
+        NftId distributorTypeDistributionNftId = instanceReader.getDistributorTypeInfo(distributorType).distributionNftId;
+
+        if (distributorTypeDistributionNftId != expectedDistributionNftId) {
+            revert ErrorDistributionServiceDistributorTypeDistributionMismatch(distributorType, distributorTypeDistributionNftId, expectedDistributionNftId);
+        }
+    }
+
+
+
+    function _getAndVerifyActiveDistribution()
         internal
+        virtual
         view
-        returns(IInstance instance)
+        returns (
+            NftId poolNftId,
+            IInstance instance
+        )
     {
-        NftId instanceNftId = getRegistry().getObjectInfo(distributionNftId).parentNftId;
-        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/DistributionServiceManager.sol

@@ -17,7 +17,7 @@ contract DistributionServiceManager is ProxyManager {
     ) 
     {
         DistributionService svc = new DistributionService{salt: salt}();
-        bytes memory data = abi.encode(registry, authority);
+        bytes memory data = abi.encode(authority, registry);
         IVersionable versionable = initialize(
             registry,
             address(svc), 

package/contracts/distribution/IDistributionComponent.sol

@@ -1,25 +1,18 @@
 // 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 {
 
-    error ErrorDistributionNotDistributor(address distributor);
-    error ErrorDistributionAlreadyDistributor(address distributor, NftId distributorNftId);
+interface IDistributionComponent is IInstanceLinkedComponent {
 
     event LogDistributorUpdated(address to, address operator);
 
-    /// @dev Returns true iff the provided address is registered as a distributor with this distribution component.
-    function isDistributor(address candidate) external view returns (bool);
-
-    /// @dev Returns the distributor Nft Id for the provided address
-    function getDistributorNftId(address distributor) external view returns (NftId distributorNftId);
-
     function getDiscountPercentage(
         string memory referralCode
     ) external view returns (UFixed discountPercentage, ReferralStatus status);

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);
 }