@etherisc/gif-next 0.0.2-eadf4ad-726 → 0.0.2-eae5e95-691

package/contracts/distribution/DistributionService.sol

@@ -1,138 +1,59 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IInstance} from "../instance/IInstance.sol";
-import {InstanceAccessManager} from "../instance/InstanceAccessManager.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
+import {IInstanceService} from "../instance/IInstanceService.sol";
+import {IRegistryService} from "../registry/IRegistryService.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
+import {IComponents} from "../instance/module/IComponents.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 
 import {Amount, AmountLib} from "../type/Amount.sol";
-import {NftId, NftIdLib, zeroNftId} from "../type/NftId.sol";
-import {Fee, FeeLib} from "../type/Fee.sol";
-import {PRODUCT_SERVICE_ROLE, DISTRIBUTION_OWNER_ROLE} from "../type/RoleId.sol";
+import {NftId, NftIdLib} from "../type/NftId.sol";
 import {KEEP_STATE} from "../type/StateId.sol";
-import {ObjectType, DISTRIBUTION, INSTANCE, DISTRIBUTION, DISTRIBUTOR, PRICE} from "../type/ObjectType.sol";
-import {Version, VersionLib} from "../type/Version.sol";
-import {RoleId} from "../type/RoleId.sol";
-
-import {IVersionable} from "../shared/IVersionable.sol";
-import {Versionable} from "../shared/Versionable.sol";
-
-import {IService} from "../shared/IService.sol";
-import {Service} from "../shared/Service.sol";
-import {ComponentService} from "../shared/ComponentService.sol";
-import {InstanceService} from "../instance/InstanceService.sol";
-import {IComponent} from "../shared/IComponent.sol";
-import {IDistributionComponent} from "../distribution/IDistributionComponent.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 {IPricingService} from "../product/IPricingService.sol";
-
-import {UFixed, UFixedLib} from "../type/UFixed.sol";
+import {UFixed} from "../type/UFixed.sol";
 import {DistributorType, DistributorTypeLib} from "../type/DistributorType.sol";
-import {ReferralId, ReferralStatus, ReferralLib} from "../type/Referral.sol";
-import {Timestamp, TimestampLib, zeroTimestamp} from "../type/Timestamp.sol";
-import {Key32} from "../type/Key32.sol";
+import {ReferralId, ReferralLib} from "../type/Referral.sol";
+import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
 import {IDistribution} from "../instance/module/IDistribution.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
 
 
 contract DistributionService is
-    ComponentService,
+    ComponentVerifyingService,
     IDistributionService
 {
-    using NftIdLib for NftId;
-    using TimestampLib for Timestamp;
-    using UFixedLib for UFixed;
-    using FeeLib for Fee;
-    using ReferralLib for ReferralId;
-
-    address internal _registryAddress;
+    IComponentService private _componentService;
+    IInstanceService private _instanceService;
+    IRegistryService private _registryService;
     
     function _initialize(
         address owner, 
         bytes memory data
     )
         internal
-        initializer
         virtual override
+        initializer()
     {
         (
-            address registryAddress,, 
-            //address managerAddress
+            address registryAddress,
             address authority
-        ) = abi.decode(data, (address, address, address));
+        ) = abi.decode(data, (address, address));
 
-        initializeService(registryAddress, authority, owner);
-        registerInterface(type(IDistributionService).interfaceId);
-    }
+        _initializeService(registryAddress, authority, owner);
 
-    function getDomain() public pure override returns(ObjectType) {
-        return DISTRIBUTION();
-    }
+        _componentService = IComponentService(_getServiceAddress(COMPONENT()));
+        _instanceService = IInstanceService(_getServiceAddress(INSTANCE()));
+        _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
 
-    function register(address distributionAddress) 
-        external
-        returns(NftId distributionNftId)
-    {
-        (
-            IComponent component,
-            address owner,
-            IInstance instance,
-            NftId instanceNftId
-        ) = _checkComponentForRegistration(
-            distributionAddress,
-            DISTRIBUTION(),
-            DISTRIBUTION_OWNER_ROLE());
-
-        IRegistry.ObjectInfo memory distributionInfo = getRegistryService().registerDistribution(component, owner);
-        IDistributionComponent distribution = IDistributionComponent(distributionAddress);
-        distribution.linkToRegisteredNftId();
-        distributionNftId = distributionInfo.nftId;
-
-        instance.getInstanceStore().createDistributionSetup(distributionNftId, distribution.getSetupInfo());
-        // TODO move to distribution?
-        bytes4[][] memory selectors = new bytes4[][](2);
-        selectors[0] = new bytes4[](1);
-        // TODO check if array size should be 1 instead of 2
-        selectors[1] = new bytes4[](2);
-
-        selectors[0][0] = IDistributionComponent.setFees.selector;
-        selectors[1][0] = IDistributionComponent.processRenewal.selector;
-
-        RoleId[] memory roles = new RoleId[](2);
-        roles[0] = DISTRIBUTION_OWNER_ROLE();
-        roles[1] = PRODUCT_SERVICE_ROLE();
-
-        getInstanceService().createGifTarget(
-            instanceNftId, 
-            distributionAddress, 
-            distribution.getName(), 
-            selectors, 
-            roles);
+        _registerInterface(type(IDistributionService).interfaceId);
     }
 
-    function setFees(
-        Fee memory minDistributionOwnerFee,
-        Fee memory distributionFee
-    )
-        external
-        override
-    {
-        if (minDistributionOwnerFee.fractionalFee > distributionFee.fractionalFee) {
-            revert ErrorIDistributionServiceMinFeeTooHigh(minDistributionOwnerFee.fractionalFee.toInt(), distributionFee.fractionalFee.toInt());
-        }
-
-        (NftId distributionNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(DISTRIBUTION());
-        InstanceReader instanceReader = instance.getInstanceReader();
-
-        ISetup.DistributionSetupInfo memory distSetupInfo = instanceReader.getDistributionSetupInfo(distributionNftId);
-        distSetupInfo.minDistributionOwnerFee = minDistributionOwnerFee;
-        distSetupInfo.distributionFee = distributionFee;
-        
-        instance.getInstanceStore().updateDistributionSetup(distributionNftId, distSetupInfo, KEEP_STATE());
-    }
 
     function createDistributorType(
         string memory name,
@@ -148,14 +69,23 @@ contract DistributionService is
         external
         returns (DistributorType distributorType)
     {
-        (NftId distributionNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(DISTRIBUTION());
+        (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
+        InstanceReader instanceReader = instance.getInstanceReader();
 
         {
-            ISetup.DistributionSetupInfo memory setupInfo = instance.getInstanceReader().getDistributionSetupInfo(distributionNftId);
-            UFixed variableFeesPartsTotal = setupInfo.minDistributionOwnerFee.fractionalFee.add(commissionPercentage);
-            UFixed maxDiscountPercentageLimit = setupInfo.distributionFee.fractionalFee.sub(variableFeesPartsTotal);
+            NftId productNftId = _getProductNftId(distributionNftId);
+            IComponents.ProductInfo memory productInfo = instance.getInstanceReader().getProductInfo(productNftId);
+
+            UFixed variableDistributionFees = productInfo.distributionFee.fractionalFee;
+            UFixed variableFeesPartsTotal = productInfo.minDistributionOwnerFee.fractionalFee + commissionPercentage;
+
+            if (variableFeesPartsTotal > variableDistributionFees) {
+                revert ErrorDistributionServiceVariableFeesTooHight(variableDistributionFees.toInt1000(), variableFeesPartsTotal.toInt1000());
+            }
+            UFixed maxDiscountPercentageLimit = variableDistributionFees - variableFeesPartsTotal;
+
             if (maxDiscountPercentage.gt(maxDiscountPercentageLimit)) {
-                revert ErrorIDistributionServiceMaxDiscountTooHigh(maxDiscountPercentage.toInt(), maxDiscountPercentageLimit.toInt());
+                revert ErrorDistributionServiceMaxDiscountTooHigh(maxDiscountPercentage.toInt1000(), maxDiscountPercentageLimit.toInt1000());
             }
         }
 
@@ -184,11 +114,11 @@ contract DistributionService is
         virtual
         returns (NftId distributorNftId)
     {
-        (NftId distributionNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(DISTRIBUTION());
+        (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
 
-        distributorNftId = getRegistryService().registerDistributor(
+        distributorNftId = _registryService.registerDistributor(
             IRegistry.ObjectInfo(
-                zeroNftId(), 
+                NftIdLib.zero(), 
                 distributionNftId,
                 DISTRIBUTOR(),
                 true, // intercepting property for bundles is defined on pool
@@ -201,7 +131,6 @@ contract DistributionService is
             distributorType,
             true, // active
             data,
-            AmountLib.zero(),
             0);
 
         instance.getInstanceStore().createDistributor(distributorNftId, info);
@@ -234,9 +163,10 @@ contract DistributionService is
     )
         external
         virtual
+        onlyNftOfType(distributorNftId, DISTRIBUTOR())
         returns (ReferralId referralId)
     {
-        (NftId distributionNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(DISTRIBUTION());
+        (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
 
         if (bytes(code).length == 0) {
             revert ErrorIDistributionServiceInvalidReferral(code);
@@ -245,90 +175,159 @@ contract DistributionService is
             revert ErrorIDistributionServiceExpirationInvalid(expiryAt);
         }
 
-        InstanceReader instanceReader = instance.getInstanceReader();
-        DistributorType distributorType = instanceReader.getDistributorInfo(distributorNftId).distributorType;
-        IDistribution.DistributorTypeInfo memory distributorTypeData = instanceReader.getDistributorTypeInfo(distributorType);
+        {
+            InstanceReader instanceReader = instance.getInstanceReader();
+            DistributorType distributorType = instanceReader.getDistributorInfo(distributorNftId).distributorType;
+            IDistribution.DistributorTypeInfo memory distributorTypeData = instanceReader.getDistributorTypeInfo(distributorType);
 
-        if (distributorTypeData.maxReferralCount < maxReferrals) {
-            revert ErrorIDistributionServiceMaxReferralsExceeded(distributorTypeData.maxReferralCount);
-        }
-        if (distributorTypeData.minDiscountPercentage > discountPercentage) {
-            revert ErrorIDistributionServiceDiscountTooLow(distributorTypeData.minDiscountPercentage.toInt(), discountPercentage.toInt());
-        }
-        if (distributorTypeData.maxDiscountPercentage < discountPercentage) {
-            revert ErrorIDistributionServiceDiscountTooHigh(distributorTypeData.maxDiscountPercentage.toInt(), discountPercentage.toInt());
+            if (distributorTypeData.maxReferralCount < maxReferrals) {
+                revert ErrorIDistributionServiceMaxReferralsExceeded(distributorTypeData.maxReferralCount);
+            }
+            if (distributorTypeData.minDiscountPercentage > discountPercentage) {
+                revert ErrorIDistributionServiceDiscountTooLow(distributorTypeData.minDiscountPercentage.toInt(), discountPercentage.toInt());
+            }
+            if (distributorTypeData.maxDiscountPercentage < discountPercentage) {
+                revert ErrorIDistributionServiceDiscountTooHigh(distributorTypeData.maxDiscountPercentage.toInt(), discountPercentage.toInt());
+            }
+            if (expiryAt.toInt() - TimestampLib.blockTimestamp().toInt() > distributorTypeData.maxReferralLifetime) {
+                revert ErrorIDistributionServiceExpiryTooLong(distributorTypeData.maxReferralLifetime, expiryAt.toInt());
+            }
         }
-        if (expiryAt.toInt() - TimestampLib.blockTimestamp().toInt() > distributorTypeData.maxReferralLifetime) {
-            revert ErrorIDistributionServiceExpiryTooLong(distributorTypeData.maxReferralLifetime, expiryAt.toInt());
+
+        {
+            referralId = ReferralLib.toReferralId(distributionNftId, code);
+            IDistribution.ReferralInfo memory info = IDistribution.ReferralInfo(
+                distributorNftId,
+                code,
+                discountPercentage,
+                maxReferrals,
+                0, // used referrals
+                expiryAt,
+                data
+            );
+
+            instance.getInstanceStore().createReferral(referralId, info);
         }
+    }
 
-        referralId = ReferralLib.toReferralId(distributionNftId, code);
-        IDistribution.ReferralInfo memory info = IDistribution.ReferralInfo(
-            distributorNftId,
-            code,
-            discountPercentage,
-            maxReferrals,
-            0, // used referrals
-            expiryAt,
-            data
-        );
-
-        instance.getInstanceStore().createReferral(referralId, info);
-        return referralId;
+    /// @inheritdoc IDistributionService
+    function processReferral(
+        NftId distributionNftId, 
+        ReferralId referralId
+    ) 
+        external
+        virtual
+        restricted()
+        onlyNftOfType(distributionNftId, DISTRIBUTION())
+    {
+        if (referralIsValid(distributionNftId, referralId)) {
+            IRegistry registry = getRegistry();
+            IRegistry.ObjectInfo memory distributionInfo = registry.getObjectInfo(distributionNftId);
+            IInstance instance = _getInstanceForComponent(registry, distributionInfo);
+
+            // update book keeping for referral info
+            IDistribution.ReferralInfo memory referralInfo = instance.getInstanceReader().getReferralInfo(referralId);
+            referralInfo.usedReferrals += 1;
+            instance.getInstanceStore().updateReferral(referralId, referralInfo, KEEP_STATE());
+        }
     }
 
     function processSale(
         NftId distributionNftId, // assume always of distribution type
         ReferralId referralId,
-        IPolicy.Premium memory premium,
-        Amount transferredDistributionFeeAmount
+        IPolicy.PremiumInfo memory premium
     )
         external
         virtual
-        restricted
+        restricted()
+        onlyNftOfType(distributionNftId, DISTRIBUTION())
     {
-        bool isReferral = ! referralId.eqz();
-        bool referralValid = referralIsValid(distributionNftId, referralId);
+        IRegistry registry = getRegistry();
+        IRegistry.ObjectInfo memory distributionInfo = registry.getObjectInfo(distributionNftId);
+        IInstance instance = _getInstanceForComponent(registry, distributionInfo);
+        InstanceReader reader = instance.getInstanceReader();
+        InstanceStore store = instance.getInstanceStore();
+
+        // get distribution owner fee amount
+        Amount distributionOwnerFee = premium.distributionOwnerFeeFixAmount + premium.distributionOwnerFeeVarAmount;
+
+        // update referral/distributor info if applicable
+        if (referralIsValid(distributionNftId, referralId)) {
 
-        if (isReferral && ! referralValid) {
-            revert ErrorIDistributionServiceReferralInvalid(distributionNftId, referralId);
+            // increase distribution balance by commission amount and distribution owner fee
+            Amount commissionAmount = premium.commissionAmount;
+            _componentService.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);
+
+            // update book keeping for distributor info
+            IDistribution.DistributorInfo memory distributorInfo = reader.getDistributorInfo(referralInfo.distributorNftId);
+            distributorInfo.numPoliciesSold += 1;
+            store.updateDistributor(referralInfo.distributorNftId, distributorInfo, KEEP_STATE());
+        } else {
+            // increase distribution balance by distribution owner fee
+            _componentService.increaseDistributionBalance(store, distributionNftId, AmountLib.zero(), distributionOwnerFee);
         }
+    }
 
-        IInstance instance = _getInstanceForDistribution(distributionNftId);
+    /// @inheritdoc IDistributionService
+    function withdrawCommission(NftId distributorNftId, Amount amount) 
+        public 
+        virtual
+        // TODO: restricted() (once #462 is done)
+        onlyNftOfType(distributorNftId, DISTRIBUTOR())
+        returns (Amount withdrawnAmount) 
+    {
+        (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
         InstanceReader reader = instance.getInstanceReader();
-        InstanceStore store = instance.getInstanceStore();
-        IDistribution.ReferralInfo memory referralInfo = reader.getReferralInfo(referralId);
-        IDistribution.DistributorInfo memory distributorInfo = reader.getDistributorInfo(referralInfo.distributorNftId);
-        ISetup.DistributionSetupInfo memory setupInfo = reader.getDistributionSetupInfo(distributionNftId);
         
-        Amount distributionOwnerFee = AmountLib.toAmount(premium.distributionOwnerFeeFixAmount + premium.distributionOwnerFeeVarAmount);
-        Amount commissionAmount = AmountLib.toAmount(premium.commissionAmount);
-
-        if (!(transferredDistributionFeeAmount == distributionOwnerFee + commissionAmount)) {
-            revert ErrorDistributionServiceInvalidFeeTransferred(transferredDistributionFeeAmount, distributionOwnerFee + commissionAmount);
+        IComponents.ComponentInfo memory distributionInfo = reader.getComponentInfo(distributionNftId);
+        address distributionWallet = distributionInfo.wallet;
+        
+        Amount commissionAmount = reader.getFeeAmount(distributorNftId);
+        
+        // determine withdrawn amount
+        withdrawnAmount = amount;
+        if (withdrawnAmount.gte(AmountLib.max())) {
+            withdrawnAmount = commissionAmount;
+        } else {
+            if (withdrawnAmount.gt(commissionAmount)) {
+                revert ErrorDistributionServiceCommissionWithdrawAmountExceedsLimit(withdrawnAmount, commissionAmount);
+            }
         }
 
-
-        if (distributionOwnerFee.gtz()) {
-            setupInfo.sumDistributionOwnerFees += distributionOwnerFee.toInt();
-            store.updateDistributionSetup(distributionNftId, setupInfo, KEEP_STATE());
+        // decrease fee counters by withdrawnAmount and update distributor info
+        {
+            InstanceStore store = instance.getInstanceStore();
+            // decrease fee counter for distribution balance
+            _componentService.decreaseDistributionBalance(store, distributionNftId, withdrawnAmount, AmountLib.zero());
+            // decrease fee counter for distributor fee
+            _componentService.decreaseDistributorBalance(store, distributorNftId, AmountLib.zero(), withdrawnAmount);
         }
 
-        if (isReferral) {
-            referralInfo.usedReferrals += 1;
-            store.updateReferral(referralId, referralInfo, KEEP_STATE());
-
-            if (commissionAmount.gtz()) {
-                distributorInfo.commissionAmount = distributorInfo.commissionAmount + commissionAmount;
-                distributorInfo.numPoliciesSold += 1;
-                store.updateDistributor(referralInfo.distributorNftId, distributorInfo, KEEP_STATE());
-            }
+        // transfer amount to distributor
+        {
+            address distributor = getRegistry().ownerOf(distributorNftId);
+            emit LogDistributionServiceCommissionWithdrawn(distributorNftId, distributor, address(distributionInfo.token), withdrawnAmount);
+            distributionInfo.tokenHandler.distributeTokens(distributionWallet, distributor, withdrawnAmount);
         }
     }
 
-    // TODO: zero should return false
-    function referralIsValid(NftId distributionNftId, ReferralId referralId) public view returns (bool isValid) {
-        IInstance instance = _getInstanceForDistribution(distributionNftId);
+    function referralIsValid(NftId distributionNftId, ReferralId referralId) 
+        public 
+        view 
+        returns (bool isValid) 
+    {
+        if (distributionNftId.eqz() || referralId.eqz()) {
+            return false;
+        }
+
+        IRegistry registry = getRegistry();
+        IRegistry.ObjectInfo memory distributionInfo = registry.getObjectInfo(distributionNftId);
+        IInstance instance = _getInstanceForComponent(registry, distributionInfo);
         IDistribution.ReferralInfo memory info = instance.getInstanceReader().getReferralInfo(referralId);
 
         if (info.distributorNftId.eqz()) {
@@ -345,7 +344,11 @@ contract DistributionService is
         returns(IInstance instance)
     {
         NftId instanceNftId = getRegistry().getObjectInfo(distributionNftId).parentNftId;
-        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
+        address instanceAddress = getRegistry().getObjectAddress(instanceNftId);
         return IInstance(instanceAddress);
     }
+
+    function _getDomain() internal pure override returns(ObjectType) {
+        return DISTRIBUTION();
+    }
 }

package/contracts/distribution/DistributionServiceManager.sol

@@ -1,12 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {DistributionService} from "./DistributionService.sol";
-import {Registry} from "../registry/Registry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
-import {REGISTRY} from "../type/ObjectType.sol";
 
 contract DistributionServiceManager is ProxyManager {
 
@@ -15,31 +12,19 @@ contract DistributionServiceManager is ProxyManager {
     /// @dev initializes proxy manager with distribution service implementation and deploys instance
     constructor(
         address authority, 
-        address registryAddress,
+        address registry,
         bytes32 salt
     ) 
-        ProxyManager(registryAddress)
     {
-        DistributionService distSrv = new DistributionService{salt: salt}();
-        bytes memory data = abi.encode(registryAddress, address(this), authority);
-        IVersionable versionable = deployDetermenistic(
-            address(distSrv), 
+        DistributionService svc = new DistributionService{salt: salt}();
+        bytes memory data = abi.encode(registry, authority);
+        IVersionable versionable = initialize(
+            registry,
+            address(svc), 
             data,
             salt);
 
         _distributionService = DistributionService(address(versionable));
-        
-        // TODO `thi` must have a role or own nft to register service
-        //Registry registry = Registry(registryAddress);
-        //address registryServiceAddress = registry.getServiceAddress(REGISTRY(), _distributionService.getMajorVersion());
-        //RegistryService registryService = RegistryService(registryServiceAddress);
-        //registryService.registerService(_distributionService);
-        
-        // TODO no nft to link yet
-        // link ownership of instance service manager ot nft owner of instance service
-        //_linkToNftOwnable(
-        //    address(registryAddress),
-        //    address(_distributionService));
     }
 
     //--- view functions ----------------------------------------------------//

package/contracts/distribution/IDistributionComponent.sol

@@ -1,71 +1,52 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {Fee} from "../type/Fee.sol";
-import {IComponent} from "../shared/IComponent.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
-import {ReferralId, ReferralStatus} from "../type/Referral.sol";
+import {Amount} from "../type/Amount.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 import {NftId} from "../type/NftId.sol";
-import {DistributorType} from "../type/DistributorType.sol";
+import {ReferralId, ReferralStatus} from "../type/Referral.sol";
 import {UFixed} from "../type/UFixed.sol";
-import {Timestamp} from "../type/Timestamp.sol";
 
-interface IDistributionComponent is IComponent {
+interface IDistributionComponent is IInstanceLinkedComponent {
 
-    event LogDistributorUpdated(address to, address caller);
+    error ErrorDistributionNotDistributor(address distributor);
+    error ErrorDistributionAlreadyDistributor(address distributor, NftId distributorNftId);
 
-    function getSetupInfo() external view returns (ISetup.DistributionSetupInfo memory setupInfo);
+    event LogDistributorUpdated(address to, address caller);
 
-    function setFees(
-        Fee memory minDistributionOwnerFee,
-        Fee memory distributionFee
-    ) external;
+    /// @dev Returns true iff the provided address is registered as a distributor with this distribution component.
+    function isDistributor(address candidate) external view returns (bool);
 
-    function createDistributorType(
-        string memory name,
-        UFixed minDiscountPercentage,
-        UFixed maxDiscountPercentage,
-        UFixed commissionPercentage,
-        uint32 maxReferralCount,
-        uint32 maxReferralLifetime,
-        bool allowSelfReferrals,
-        bool allowRenewals,
-        bytes memory data
-    ) external returns (DistributorType distributorType);
+    /// @dev Returns the distributor Nft Id for the provided address
+    function getDistributorNftId(address distributor) external view returns (NftId distributorNftId);
 
-    function createDistributor(
-        address distributor,
-        DistributorType distributorType,
-        bytes memory data
-    ) external returns(NftId distributorNftId);
+    function getDiscountPercentage(
+        string memory referralCode
+    ) external view returns (UFixed discountPercentage, ReferralStatus status);
 
-    function updateDistributorType(
-        NftId distributorNftId,
-        DistributorType distributorType,
-        bytes memory data
-    ) external;
+    function getReferralId(
+        string memory referralCode
+    ) external returns (ReferralId referralId);
 
     function calculateRenewalFeeAmount(
         ReferralId referralId,
         uint256 netPremiumAmount
     ) external view returns (uint256 feeAmount);
 
-    /// @dev callback from product service when a policy is renews for a specific referralId
+    /// @dev Callback function to process a renewal of a policy.
+    /// The default implementation is empty.
+    /// Overwrite this function to implement a use case specific behaviour.
     function processRenewal(
         ReferralId referralId,
         uint256 feeAmount
     ) external;
 
-    function getDiscountPercentage(
-        string memory referralCode
-    ) external view returns (UFixed discountPercentage, ReferralStatus status);
-
-    function getDistributionFee() external view returns (Fee memory distibutionFee);
-
-    function getReferralId(
-        string memory referralCode
-    ) external returns (ReferralId referralId);
-
-    /// @dev returns true iff the component needs to be called when selling/renewing policis
+    /// @dev Returns true to ensure component is called when transferring distributor Nft Ids.
     function isVerifying() external view returns (bool verifying);
+
+    /// @dev Withdraw commission for the distributor
+    /// @param distributorNftId the distributor Nft Id
+    /// @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);
 }