@etherisc/gif-next 0.0.2-9bfd86b-310 → 0.0.2-9c4663e-693

package/contracts/distribution/Distribution.sol

@@ -1,23 +1,21 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {COMPONENT, DISTRIBUTION} from "../type/ObjectType.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
+import {IDistributionComponent} from "./IDistributionComponent.sol";
 import {IDistributionService} from "./IDistributionService.sol";
-import {IProductService} from "../product/IProductService.sol";
-import {NftId, NftIdLib} from "../type/NftId.sol";
+
+import {Amount} from "../type/Amount.sol";
+import {COMPONENT, DISTRIBUTION, DISTRIBUTOR} from "../type/ObjectType.sol";
+import {DistributorType} from "../type/DistributorType.sol";
+import {Fee} from "../type/Fee.sol";
+import {NftId} from "../type/NftId.sol";
 import {ReferralId, ReferralStatus, ReferralLib} from "../type/Referral.sol";
-import {Fee, FeeLib} from "../type/Fee.sol";
 import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.sol";
-import {IComponentService} from "../shared/IComponentService.sol";
-import {IDistribution} from "../instance/module/IDistribution.sol";
-import {IDistributionComponent} from "./IDistributionComponent.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 import {UFixed} from "../type/UFixed.sol";
-import {DistributorType} from "../type/DistributorType.sol";
-import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
-import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
 
 
 abstract contract Distribution is
@@ -30,68 +28,135 @@ abstract contract Distribution is
     struct DistributionStorage {
         IComponentService _componentService;
         IDistributionService _distributionService;
-        mapping(address distributor => NftId distributorNftId) _distributorNftId;
     }
 
-    error ErrorDistributionAlreadyDistributor(address distributor, NftId distributorNftId);
+    function processRenewal(
+        ReferralId referralId,
+        uint256 feeAmount
+    )
+        external
+        virtual
+        restricted()
+    {
+        // default is no action
+    }
+
 
-    function initializeDistribution(
+    /// @inheritdoc IDistributionComponent
+    function withdrawCommission(NftId distributorNftId, Amount amount) 
+        external 
+        virtual
+        restricted()
+        onlyNftOfType(distributorNftId, DISTRIBUTOR())
+        onlyNftOwner(distributorNftId)
+        returns (Amount withdrawnAmount) 
+    {
+        return _withdrawCommission(distributorNftId, amount);
+    }
+
+    function getDiscountPercentage(string memory referralCode)
+        external
+        view
+        returns (
+            UFixed discountPercentage, 
+            ReferralStatus status
+        )
+    {
+        ReferralId referralId = getReferralId(referralCode);
+        return _getInstanceReader().getDiscountPercentage(referralId);
+    }
+
+
+    function getReferralId(
+        string memory referralCode
+    )
+        public
+        view 
+        returns (ReferralId referralId)
+    {
+        return ReferralLib.toReferralId(
+            getNftId(), 
+            referralCode);      
+    }
+
+
+    function calculateRenewalFeeAmount(
+        ReferralId referralId,
+        uint256 netPremiumAmount
+    )
+        external
+        view
+        virtual override
+        returns (uint256 feeAmount)
+    {
+        // default is no fees
+        return 0 * netPremiumAmount;
+    }
+
+
+    /// @dev Returns true iff the component needs to be called when selling/renewing policis
+    function isVerifying() external pure returns (bool verifying) {
+        return true;
+    }
+
+
+    function _initializeDistribution(
         address registry,
-        NftId instanceNftId,
+        NftId productNftId,
+        IAuthorization authorization, 
+        bool isInterceptor,
         address initialOwner,
         string memory name,
-        address token,
-        bytes memory registryData, // writeonly data that will saved in the object info record of the registry
         bytes memory componentData // component specifidc data 
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
-        initializeInstanceLinkedComponent(registry, instanceNftId, name, token, DISTRIBUTION(), true, initialOwner, registryData, componentData);
+        _initializeInstanceLinkedComponent(
+            registry, 
+            productNftId, 
+            name, 
+            DISTRIBUTION(), 
+            authorization,
+            isInterceptor,
+            initialOwner, 
+            componentData);
 
         DistributionStorage storage $ = _getDistributionStorage();
         $._distributionService = IDistributionService(_getServiceAddress(DISTRIBUTION())); 
         $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
 
-        registerInterface(type(IDistributionComponent).interfaceId);
-    }
-
-    function register()
-        external
-        virtual
-        onlyOwner()
-    {
-        _getDistributionStorage()._componentService.registerDistribution();
+        _registerInterface(type(IDistributionComponent).interfaceId);
     }
 
-    function setFees(
+    /// @dev Sets the distribution fees to the provided values.
+    function _setFees(
         Fee memory distributionFee,
         Fee memory minDistributionOwnerFee
     )
-        external
-        override
-        onlyOwner()
-        restricted()
+        internal
+        virtual
     {
         _getDistributionStorage()._componentService.setDistributionFees(
             distributionFee, 
             minDistributionOwnerFee);
     }
 
-
-    function createDistributorType(
+    /// @dev Creates a new distributor type using the provided parameters.
+    function _createDistributorType(
         string memory name,
         UFixed minDiscountPercentage,
         UFixed maxDiscountPercentage,
         UFixed commissionPercentage,
         uint32 maxReferralCount,
-        uint32 maxReferralLifetime,
+        Seconds maxReferralLifetime,
         bool allowSelfReferrals,
         bool allowRenewals,
         bytes memory data
     )
-        public
+        internal
+        virtual
         returns (DistributorType distributorType)
     {
         DistributionStorage storage $ = _getDistributionStorage();
@@ -107,48 +172,41 @@ abstract contract Distribution is
             data);
     }
 
-    function createDistributor(
+    /// @dev Turns the provided account into a new distributor of the specified type.
+    function _createDistributor(
         address distributor,
         DistributorType distributorType,
         bytes memory data
     )
-        public
+        internal
+        virtual
         returns(NftId distributorNftId)
     {
         DistributionStorage storage $ = _getDistributionStorage();
-        if($._distributorNftId[distributor].gtz()) {
-            revert ErrorDistributionAlreadyDistributor(distributor, $._distributorNftId[distributor]);
-        }
 
         distributorNftId = $._distributionService.createDistributor(
             distributor,
             distributorType,
             data);
-
-        $._distributorNftId[distributor] = distributorNftId;
     }
 
-    function updateDistributorType(
+    /// @dev Uptates the distributor type for the specified distributor.
+    function _changeDistributorType(
         NftId distributorNftId,
         DistributorType distributorType,
         bytes memory data
     )
-        public
-        // TODO figure out what we need for authz
-        // and add it
+        internal
+        virtual
     {
         DistributionStorage storage $ = _getDistributionStorage();
-        // TODO re-enable once implemented
-        // $._distributionService.updateDistributorType(
-        //     distributorNftId,
-        //     distributorType,
-        //     data);
+        $._distributionService.changeDistributorType(
+            distributorNftId,
+            distributorType,
+            data);
     }
 
-    /**
-     * @dev lets distributors create referral codes.
-     * referral codes need to be unique
-     */
+    /// @dev Create a new referral code for the provided distributor.
     function _createReferral(
         NftId distributorNftId,
         string memory code,
@@ -158,6 +216,7 @@ abstract contract Distribution is
         bytes memory data
     )
         internal
+        virtual
         returns (ReferralId referralId)
     {
         DistributionStorage storage $ = _getDistributionStorage();
@@ -170,87 +229,11 @@ abstract contract Distribution is
             data);
     }
 
-    function isDistributor(address candidate)
-        public
-        view
-        returns (bool)
-    {
-        DistributionStorage storage $ = _getDistributionStorage();
-        return $._distributorNftId[candidate].gtz();
-    }
-
-    function getDistributorNftId(address distributor)
-        public
-        view
-        returns (NftId distributorNftId)
-    {
-        DistributionStorage storage $ = _getDistributionStorage();
-        return $._distributorNftId[distributor];
-    }
-
-    function getDiscountPercentage(string memory referralCode)
-        external
-        view
-        returns (
-            UFixed discountPercentage, 
-            ReferralStatus status
-        )
-    {
-        ReferralId referralId = getReferralId(referralCode);
-        return _getInstanceReader().getDiscountPercentage(referralId);
-    }
-
-
-    function getReferralId(
-        string memory referralCode
-    )
-        public
-        view 
-        returns (ReferralId referralId)
-    {
-        return ReferralLib.toReferralId(
-            getNftId(), 
-            referralCode);      
-    }
-
-    function calculateRenewalFeeAmount(
-        ReferralId referralId,
-        uint256 netPremiumAmount
-    )
-        external
-        view
-        virtual override
-        returns (uint256 feeAmount)
-    {
-        // default is no fees
-        return 0 * netPremiumAmount;
-    }
-
-    function processRenewal(
-        ReferralId referralId,
-        uint256 feeAmount
-    )
-        external
-        onlyOwner
-        restricted()
-        virtual override
+    function _withdrawCommission(NftId distributorNftId, Amount amount) 
+        internal
+        returns (Amount withdrawnAmount) 
     {
-        // default is no action
-    }
-
-
-    function _nftTransferFrom(address from, address to, uint256 tokenId) internal virtual override {
-        // keep track of distributor nft owner
-        emit LogDistributorUpdated(to, msg.sender);
-        DistributionStorage storage $ = _getDistributionStorage();
-        $._distributorNftId[from] = NftIdLib.zero();
-        $._distributorNftId[to] = NftIdLib.toNftId(tokenId);
-    }
-    
-
-    /// @dev returns true iff the component needs to be called when selling/renewing policis
-    function isVerifying() external pure returns (bool verifying) {
-        return true;
+        return _getDistributionStorage()._distributionService.withdrawCommission(distributorNftId, amount);
     }
 
     function _getDistributionStorage() private pure returns (DistributionStorage storage $) {