@etherisc/gif-next 0.0.2-3087fdd-816 → 0.0.2-30a4eae-489

package/contracts/{components → distribution}/Distribution.sol

@@ -1,92 +1,194 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {DISTRIBUTION} from "../types/ObjectType.sol";
-import {IDistributionService} from "../instance/service/IDistributionService.sol";
-import {IProductService} from "../instance/service/IProductService.sol";
-import {NftId, zeroNftId, NftIdLib, toNftId} from "../types/NftId.sol";
-import {ReferralId, ReferralStatus, ReferralLib} from "../types/Referral.sol";
-import {Fee, FeeLib} from "../types/Fee.sol";
-import {Component} from "./Component.sol";
+pragma solidity ^0.8.20;
+
+import {IAuthorization} from "../authorization/IAuthorization.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
 import {IDistributionComponent} from "./IDistributionComponent.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {IRegisterable} from "../shared/IRegisterable.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
-import {Registerable} from "../shared/Registerable.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
-import {UFixed} from "../types/UFixed.sol";
-import {DistributorType} from "../types/DistributorType.sol";
-import {Timestamp} from "../types/Timestamp.sol";
-import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
+import {IDistributionService} from "./IDistributionService.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, NftIdLib} from "../type/NftId.sol";
+import {ReferralId, ReferralStatus, ReferralLib} from "../type/Referral.sol";
+import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {Timestamp} from "../type/Timestamp.sol";
+import {UFixed} from "../type/UFixed.sol";
 
 
 abstract contract Distribution is
-    Component,
+    InstanceLinkedComponent,
     IDistributionComponent
 {
     // keccak256(abi.encode(uint256(keccak256("etherisc.storage.Distribution")) - 1)) & ~bytes32(uint256(0xff));
     bytes32 public constant DISTRIBUTION_STORAGE_LOCATION_V1 = 0xaab7c5ea03d290056d6c060e0833d3ebcbe647f7694616a2ec52738a64b2f900;
 
     struct DistributionStorage {
-        Fee _distributionFee;
-        TokenHandler _tokenHandler;
+        IComponentService _componentService;
         IDistributionService _distributionService;
         mapping(address distributor => NftId distributorNftId) _distributorNftId;
     }
 
-    function initializeDistribution(
-        address registry,
-        NftId instanceNftId,
-        string memory name,
-        address token,
-        Fee memory distributionFee,
-        address initialOwner,
-        bytes memory data
+    modifier onlyDistributor() {
+        if (!isDistributor(msg.sender)) {
+            revert ErrorDistributionNotDistributor(msg.sender);
+        }
+        _;
+    }
+
+
+    function processRenewal(
+        ReferralId referralId,
+        uint256 feeAmount
     )
-        public
+        external
         virtual
-        onlyInitializing()
+        restricted()
+    {
+        // default is no action
+    }
+
+
+    /// @inheritdoc IDistributionComponent
+    function withdrawCommission(NftId distributorNftId, Amount amount) 
+        external 
+        virtual
+        restricted()
+        onlyDistributor()
+        onlyNftOfType(distributorNftId, DISTRIBUTOR())
+        onlyNftOwner(distributorNftId)
+        returns (Amount withdrawnAmount) 
     {
-        initializeComponent(registry, instanceNftId, name, token, DISTRIBUTION(), true, initialOwner, data);
+        return _withdrawCommission(distributorNftId, amount);
+    }
+
 
+    function isDistributor(address candidate)
+        public
+        view
+        returns (bool)
+    {
         DistributionStorage storage $ = _getDistributionStorage();
-        // TODO add validation
-        $._distributionFee = distributionFee;
-        $._tokenHandler = new TokenHandler(token);
-        $._distributionService = getInstance().getDistributionService();
+        return $._distributorNftId[candidate].gtz();
+    }
+
 
-        registerInterface(type(IDistributionComponent).interfaceId);
+    function getDistributorNftId(address distributor)
+        public
+        view
+        returns (NftId distributorNftId)
+    {
+        DistributionStorage storage $ = _getDistributionStorage();
+        return $._distributorNftId[distributor];
     }
 
-    function setFees(
-        Fee memory distributionFee
+
+    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
-        override
-        onlyOwner
-        restricted()
+        view
+        virtual override
+        returns (uint256 feeAmount)
     {
-        _getDistributionStorage()._distributionService.setFees(distributionFee);
+        // default is no fees
+        return 0 * netPremiumAmount;
     }
 
-    function getDistributionFee() external view returns (Fee memory distributionFee) {
+
+    /// @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 productNftId,
+        IAuthorization authorization, 
+        address initialOwner,
+        string memory name,
+        address token,
+        bytes memory componentData // component specifidc data 
+    )
+        internal
+        virtual
+        onlyInitializing()
+    {
+        _initializeInstanceLinkedComponent(
+            registry, 
+            productNftId, 
+            name, 
+            token, 
+            DISTRIBUTION(), 
+            authorization,
+            true, 
+            initialOwner, 
+            componentData);
+
         DistributionStorage storage $ = _getDistributionStorage();
-        return $._distributionFee;
+        $._distributionService = IDistributionService(_getServiceAddress(DISTRIBUTION())); 
+        $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
+
+        _registerInterface(type(IDistributionComponent).interfaceId);
+    }
+
+    /// @dev Sets the distribution fees to the provided values.
+    function _setFees(
+        Fee memory distributionFee,
+        Fee memory minDistributionOwnerFee
+    )
+        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();
@@ -102,16 +204,20 @@ 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();
-        require($._distributorNftId[distributor].eqz(), "ERROR:DST-030:ALREADY_DISTRIBUTOR");
+        if($._distributorNftId[distributor].gtz()) {
+            revert ErrorDistributionAlreadyDistributor(distributor, $._distributorNftId[distributor]);
+        }
 
         distributorNftId = $._distributionService.createDistributor(
             distributor,
@@ -121,27 +227,24 @@ abstract contract Distribution is
         $._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();
-        $._distributionService.updateDistributorType(
+        $._distributionService.changeDistributorType(
             distributorNftId,
             distributorType,
             data);
     }
 
-    /**
-     * @dev lets distributors create referral codes.
-     * referral codes need to be unique
-     */
-    function createReferral(
+    /// @dev Create a new referral code for the provided distributor.
+    function _createReferral(
         NftId distributorNftId,
         string memory code,
         UFixed discountPercentage,
@@ -149,8 +252,8 @@ abstract contract Distribution is
         Timestamp expiryAt,
         bytes memory data
     )
-        public
-        // TODO add authz (only active distributor)
+        internal
+        virtual
         returns (ReferralId referralId)
     {
         DistributionStorage storage $ = _getDistributionStorage();
@@ -163,141 +266,19 @@ abstract contract Distribution is
             data);
     }
 
-    function calculateFeeAmount(
-        ReferralId referralId,
-        uint256 netPremiumAmount
-    )
-        external
-        view
-        virtual override
-        returns (uint256 feeAmount)
-    {
-        ISetup.DistributionSetupInfo memory setupInfo = getSetupInfo();
-        Fee memory fee = setupInfo.distributionFee;
-        (feeAmount,) = FeeLib.calculateFee(fee, netPremiumAmount);
-        // TODO: use this? 
-        // return _distributionService.calculateFeeAmount(referralId, premiumAmount);        
-    }
-
-    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)
+    function _withdrawCommission(NftId distributorNftId, Amount amount) 
+        internal
+        returns (Amount withdrawnAmount) 
     {
-        // default is no fees
-        return 0 * netPremiumAmount;
+        return _getDistributionStorage()._distributionService.withdrawCommission(distributorNftId, amount);
     }
 
-    function processSale(
-        ReferralId referralId,
-        uint256 premiumAmount
-    )
-        external
-        onlyOwner
-        restricted()
-        virtual override
-    {
-        DistributionStorage storage $ = _getDistributionStorage();
-        $._distributionService.processSale(referralId, premiumAmount);        
-    }
-
-    function processRenewal(
-        ReferralId referralId,
-        uint256 feeAmount
-    )
-        external
-        onlyOwner
-        restricted()
-        virtual override
-    {
-        // default is no action
-    }
-
-    function referralIsValid(ReferralId referralId) external view returns (bool isValid) {
-        // default is invalid
-        return false;
-    }
-
-    function getSetupInfo() public view returns (ISetup.DistributionSetupInfo memory setupInfo) {
-        InstanceReader reader = getInstance().getInstanceReader();
-        setupInfo = reader.getDistributionSetupInfo(getNftId());
-
-        // fallback to initial setup info (wallet is always != address(0))
-        if(setupInfo.wallet == address(0)) {
-            setupInfo = _getInitialSetupInfo();
-        }
-    }
-
-    function _getInitialSetupInfo() internal view returns (ISetup.DistributionSetupInfo memory setupInfo) {
-        DistributionStorage storage $ = _getDistributionStorage();
-        return ISetup.DistributionSetupInfo(
-            zeroNftId(),
-            $._tokenHandler,
-            $._distributionFee,
-            address(this)
-        );
-    }
-
-
-    function _nftTransferFrom(address from, address to, uint256 tokenId) internal virtual override {
+    function _nftTransferFrom(address from, address to, uint256 tokenId, address operator) internal virtual override {
         // keep track of distributor nft owner
-        emit LogDistributorUpdated(to, msg.sender);
+        emit LogDistributorUpdated(to, operator);
         DistributionStorage storage $ = _getDistributionStorage();
-        $._distributorNftId[from] = zeroNftId();
-        $._distributorNftId[to] = toNftId(tokenId);
-    }
-    
-
-    /// @dev returns true iff the component needs to be called when selling/renewing policis
-    function isVerifying() external view returns (bool verifying) {
-        return true;
+        $._distributorNftId[from] = NftIdLib.zero();
+        $._distributorNftId[to] = NftIdLib.toNftId(tokenId);
     }
 
     function _getDistributionStorage() private pure returns (DistributionStorage storage $) {