@etherisc/gif-next 0.0.2-b244df3-779 → 0.0.2-b38343e-249

package/contracts/components/Distribution.sol

@@ -4,10 +4,10 @@ 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} from "../types/NftId.sol";
-import {ReferralId} from "../types/Referral.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 {BaseComponent} from "./BaseComponent.sol";
+import {Component} from "./Component.sol";
 import {IDistributionComponent} from "./IDistributionComponent.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
@@ -15,58 +15,152 @@ 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";
 
-contract Distribution is
-    BaseComponent,
+
+abstract contract Distribution is
+    Component,
     IDistributionComponent
 {
-    using NftIdLib for NftId;
-
-    Fee internal _initialDistributionFee;
-    bool internal _isVerifying;
-
-    TokenHandler internal _tokenHandler;
-
-    IDistributionService private _distributionService;
-    IProductService private _productService;
+    // keccak256(abi.encode(uint256(keccak256("etherisc.storage.Distribution")) - 1)) & ~bytes32(uint256(0xff));
+    bytes32 public constant DISTRIBUTION_STORAGE_LOCATION_V1 = 0xaab7c5ea03d290056d6c060e0833d3ebcbe647f7694616a2ec52738a64b2f900;
 
-    modifier onlyProductService() {
-        require(
-            msg.sender == address(_productService), 
-            "ERROR:POL-002:NOT_PRODUCT_SERVICE");
-        _;
+    struct DistributionStorage {
+        Fee _distributionFee;
+        TokenHandler _tokenHandler;
+        IDistributionService _distributionService;
+        mapping(address distributor => NftId distributorNftId) _distributorNftId;
     }
 
-    constructor(
+    function initializeDistribution(
         address registry,
         NftId instanceNftId,
-        // TODO refactor into tokenNftId
+        string memory name,
         address token,
-        bool verifying,
         Fee memory distributionFee,
-        address initialOwner
+        address initialOwner,
+        bytes memory data
     )
-        BaseComponent(registry, instanceNftId, token, DISTRIBUTION(), true, initialOwner)
+        public
+        virtual
+        onlyInitializing()
     {
-        _isVerifying = verifying;
-        _initialDistributionFee = distributionFee;
+        initializeComponent(registry, instanceNftId, name, token, DISTRIBUTION(), true, initialOwner, data);
 
-        _tokenHandler = TokenHandler(token);
+        DistributionStorage storage $ = _getDistributionStorage();
+        // TODO add validation
+        $._distributionFee = distributionFee;
+        $._tokenHandler = new TokenHandler(token);
+        $._distributionService = getInstance().getDistributionService();
 
-        _distributionService = _instance.getDistributionService();
-        _productService = _instance.getProductService();
-
-        _registerInterface(type(IDistributionComponent).interfaceId);
+        registerInterface(type(IDistributionComponent).interfaceId);
     }
 
-
     function setFees(
         Fee memory distributionFee
     )
         external
         override
+        onlyOwner
+        restricted()
+    {
+        _getDistributionStorage()._distributionService.setFees(distributionFee);
+    }
+
+    function getDistributionFee() external view returns (Fee memory distributionFee) {
+        DistributionStorage storage $ = _getDistributionStorage();
+        return $._distributionFee;
+    }
+
+    function createDistributorType(
+        string memory name,
+        UFixed minDiscountPercentage,
+        UFixed maxDiscountPercentage,
+        UFixed commissionPercentage,
+        uint32 maxReferralCount,
+        uint32 maxReferralLifetime,
+        bool allowSelfReferrals,
+        bool allowRenewals,
+        bytes memory data
+    )
+        public
+        returns (DistributorType distributorType)
+    {
+        DistributionStorage storage $ = _getDistributionStorage();
+        distributorType = $._distributionService.createDistributorType(
+            name,
+            minDiscountPercentage,
+            maxDiscountPercentage,
+            commissionPercentage,
+            maxReferralCount,
+            maxReferralLifetime,
+            allowSelfReferrals,
+            allowRenewals,
+            data);
+    }
+
+    function createDistributor(
+        address distributor,
+        DistributorType distributorType,
+        bytes memory data
+    )
+        public
+        returns(NftId distributorNftId)
+    {
+        DistributionStorage storage $ = _getDistributionStorage();
+        require($._distributorNftId[distributor].eqz(), "ERROR:DST-030:ALREADY_DISTRIBUTOR");
+
+        distributorNftId = $._distributionService.createDistributor(
+            distributor,
+            distributorType,
+            data);
+
+        $._distributorNftId[distributor] = distributorNftId;
+    }
+
+    function updateDistributorType(
+        NftId distributorNftId,
+        DistributorType distributorType,
+        bytes memory data
+    )
+        public
+        // TODO figure out what we need for authz
+        // and add it
     {
-        _distributionService.setFees(distributionFee);
+        DistributionStorage storage $ = _getDistributionStorage();
+        $._distributionService.updateDistributorType(
+            distributorNftId,
+            distributorType,
+            data);
+    }
+
+    /**
+     * @dev lets distributors create referral codes.
+     * referral codes need to be unique
+     */
+    function createReferral(
+        NftId distributorNftId,
+        string memory code,
+        UFixed discountPercentage,
+        uint32 maxReferrals,
+        Timestamp expiryAt,
+        bytes memory data
+    )
+        public
+        // TODO add authz (only active distributor)
+        returns (ReferralId referralId)
+    {
+        DistributionStorage storage $ = _getDistributionStorage();
+        referralId = $._distributionService.createReferral(
+            distributorNftId,
+            code,
+            discountPercentage,
+            maxReferrals,
+            expiryAt,
+            data);
     }
 
     function calculateFeeAmount(
@@ -81,9 +175,53 @@ contract Distribution is
         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
@@ -99,13 +237,15 @@ contract Distribution is
 
     function processSale(
         ReferralId referralId,
-        uint256 feeAmount
+        uint256 premiumAmount
     )
         external
-        onlyProductService
+        onlyOwner
+        restricted()
         virtual override
     {
-        // default is no action
+        DistributionStorage storage $ = _getDistributionStorage();
+        $._distributionService.processSale(referralId, premiumAmount);        
     }
 
     function processRenewal(
@@ -113,7 +253,8 @@ contract Distribution is
         uint256 feeAmount
     )
         external
-        onlyProductService
+        onlyOwner
+        restricted()
         virtual override
     {
         // default is no action
@@ -125,39 +266,43 @@ contract Distribution is
     }
 
     function getSetupInfo() public view returns (ISetup.DistributionSetupInfo memory setupInfo) {
-        InstanceReader reader = _instance.getInstanceReader();
-        return reader.getDistributionSetupInfo(getNftId());
+        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) external virtual override (Component, ITransferInterceptor) {
+        // keep track of distributor nft owner
+        emit LogDistributorUpdated(to, msg.sender);
+        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 _isVerifying;
+        return true;
     }
 
-    // from IRegisterable
-
-    function getInitialInfo() 
-        public 
-        view
-        override (IRegisterable, Registerable)
-        returns(IRegistry.ObjectInfo memory, bytes memory)
-    {
-        (
-            IRegistry.ObjectInfo memory info, 
-        ) = super.getInitialInfo();
-
-        return (
-            info,
-            abi.encode(
-                ISetup.DistributionSetupInfo(
-                    _productNftId,
-                    _tokenHandler,
-                    _initialDistributionFee,
-                    _isVerifying,
-                    address(this)
-                )
-            )
-        );
+    function _getDistributionStorage() private pure returns (DistributionStorage storage $) {
+        assembly {
+            $.slot := DISTRIBUTION_STORAGE_LOCATION_V1
+        }
     }
 }

package/contracts/components/IComponent.sol

@@ -0,0 +1,55 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IInstance} from "../instance/IInstance.sol";
+import {IInstanceService} from "../instance/IInstanceService.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
+import {NftId} from "../types/NftId.sol";
+import {ObjectType} from "../types/ObjectType.sol";
+
+interface IComponent is 
+    IRegisterable,
+    ITransferInterceptor
+{
+
+    error ErrorComponentNotChainNft(address caller);
+    error ErrorComponentNotProductService(address caller);
+    error ErrorComponentNotInstance(NftId instanceNftId, address instance);
+    error ErrorComponentProductNftAlreadySet();
+    error ErrorComponentWalletAddressZero();
+    error ErrorComponentWalletAddressIsSameAsCurrent(address newWallet);
+    error ErrorComponentWalletAllowanceTooSmall(address oldWallet, address newWallet, uint256 allowance, uint256 balance);
+    error ErrorComponentUnauthorized(address caller, uint64 requiredRoleIdNum);
+
+    event LogComponentWalletAddressChanged(address newWallet);
+    event LogComponentWalletTokensTransferred(address from, address to, uint256 amount);
+
+    function getName() external view returns (string memory name);
+
+    // TODO remove and replace with accessmanaged target locking mechanism
+    function lock() external;
+    function unlock() external;
+
+    function getToken() external view returns (IERC20Metadata token);
+
+    function setWallet(address walletAddress) external;
+    function getWallet() external view returns (address walletAddress);
+
+    function isNftInterceptor() external view returns(bool isInterceptor);
+
+    function getInstance() external view returns (IInstance instance);
+
+    /// @dev returns the service address for the specified domain
+    /// gets address via lookup from registry using the major version form the linked instance
+    function getServiceAddress(ObjectType domain) external view returns (address service);
+
+    function setProductNftId(NftId productNftId) external;
+    function getProductNftId() external view returns (NftId productNftId);
+
+    function getInstanceService() external view returns (IInstanceService);
+    function getProductService() external view returns (IProductService);
+}

package/contracts/components/IDistributionComponent.sol

@@ -2,16 +2,62 @@
 pragma solidity ^0.8.19;
 
 import {Fee} from "../types/Fee.sol";
-import {ReferralId} from "../types/Referral.sol";
-import {NftId} from "../types/NftId.sol";
+import {IComponent} from "./IComponent.sol";
 import {ISetup} from "../instance/module/ISetup.sol";
+import {ReferralId, ReferralStatus} from "../types/Referral.sol";
+import {NftId} from "../types/NftId.sol";
+import {DistributorType} from "../types/DistributorType.sol";
+import {UFixed} from "../types/UFixed.sol";
+import {Timestamp} from "../types/Timestamp.sol";
+
+interface IDistributionComponent is IComponent {
 
-interface IDistributionComponent {
+    event LogDistributorUpdated(address to, address caller);
+
+    function getSetupInfo() external view returns (ISetup.DistributionSetupInfo memory setupInfo);
 
     function setFees(
         Fee memory distributionFee
     ) external;
 
+    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);
+
+    function createDistributor(
+        address distributor,
+        DistributorType distributorType,
+        bytes memory data
+    ) external returns(NftId distributorNftId);
+
+    function updateDistributorType(
+        NftId distributorNftId,
+        DistributorType distributorType,
+        bytes memory data
+    ) external;
+
+    /**
+     * @dev lets distributors create referral codes.
+     * referral codes need to be unique
+     * distributor is identified via msg.sender.
+     */
+    function createReferral(
+        NftId distributorNftId,
+        string memory code,
+        UFixed discountPercentage,
+        uint32 maxReferrals,
+        Timestamp expiryAt,
+        bytes memory data
+    ) external returns (ReferralId referralId);
+
     function calculateFeeAmount(
         ReferralId referralId,
         uint256 netPremiumAmount
@@ -36,6 +82,16 @@ interface IDistributionComponent {
         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 referral id is valid
     function referralIsValid(ReferralId referralId) external view returns (bool isValid);
 

package/contracts/components/IPoolComponent.sol

@@ -1,43 +1,41 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {NftId} from "../types/NftId.sol";
 import {Fee} from "../types/Fee.sol";
+import {IComponent} from "./IComponent.sol";
+import {ISetup} from "../instance/module/ISetup.sol";
+import {NftId} from "../types/NftId.sol";
 import {UFixed} from "../types/UFixed.sol";
 
-interface IPoolComponent {
+/// @dev pool components hold and manage the collateral to cover active policies
+/// pools come in different flavors
+interface IPoolComponent is IComponent {
 
     event LogUnderwrittenByPool(NftId policyNftId, uint256 collateralizationAmount, address pool);
 
+    error ErrorPoolNotPoolService(address service);
+
+    function getSetupInfo() external view returns (ISetup.PoolSetupInfo memory setupInfo);
+
     function setFees(
         Fee memory poolFee,
         Fee memory stakingFee,
         Fee memory performanceFee
     ) external;
 
-    /**
-     * @dev creates a new bundle for this pool.
-     */
-    function createBundle(
-        Fee memory fee,
-        uint256 initialAmount,
-        uint256 lifetime,
-        bytes memory filter
-    ) external returns(NftId bundleNftId);
-
+    /// @dev sets an additional bundle fee, this fee is added on top of the poolFee and deducted from the premium amounts.
+    /// via these fees individual bundler owner may earn income per policy in the context of peer to peer pools
     function setBundleFee(
-        NftId policyNftId, 
+        NftId bundleNftId, 
         Fee memory fee
     ) external;
 
-    /** 
-     * @dev this is a callback function that is called by the product service when underwriting a policy.
-     * the pool has the option to check the details and object to underwriting by reverting.
-     * the function is only called for "active" pools that ask to be involved/notified
-     * by product related state changes.
-     */
-    function underwrite(
-        NftId policyNftId, 
+    /// @dev this is a callback function that is called by the product service when underwriting a policy.
+    /// the pool has the option to check the details and object to underwriting by reverting.
+    /// the function is only called for "active" pools that ask to be involved/notified
+    /// by product related state changes.
+    function verifyApplication(
+        NftId applicationNftId, 
         bytes memory policyData,
         bytes memory bundleFilter,
         uint256 collateralizationAmount
@@ -47,10 +45,37 @@ interface IPoolComponent {
 
     function unlockBundle(NftId bundleNftId) external;
 
-    /**
-     * @dev returns true iff the policy application data in policyData matches
-     * with the bundle filter criteria encoded in bundleFilter. 
-     */
+    /// @dev defines the multiplier to calculate the required collateral to cover a given sum insured amount
+    /// default implementation returns 100%
+    function getCollateralizationLevel() external view returns (UFixed collateralizationLevel);
+
+    /// @dev defines the amount of collateral held in the pool.
+    /// if the value is < 100% the pool is required to hold a policy that covers the locally missing collateral
+    /// default implementation returns 100%
+    function getRetentionLevel() external view returns (UFixed retentionLevel);
+
+    /// @dev declares if pool intercept transfers of bundle nft ids
+    /// - yes: pool may block transfer of bundle ownership or simply updates some bookkeeping related to bundle ownership. callback function is nftTransferFrom
+    /// - no: pool is not involved in transfer of bundle ownership
+    /// default implementation returns false (no)
+    function isInterceptingBundleTransfers() external view returns (bool);
+
+    /// @dev declares if pool relies on external management of collateral (yes/no): 
+    /// - yes: underwriting of new policies does not require an actual token balance, instead it is assumed that the pool owner will manage funds externally and inject enough tokens to allow process confirmed payouts
+    /// - no: the pool smart contract ensures that the necessary capacity of the pool prior to underwriting.
+    /// default implementation returns false (no)
+    function isExternallyManaged() external view returns (bool);
+
+    /// @dev declares if pool component is actively involved in underwriting (yes/no): 
+    /// - yes: verifying pools components actively confirm underwriting applications, ie the pool component logic explicitly needs to confirm the locking of collateral to cover the sum insured of the policy
+    /// - no: underwriting a policy does not require any interaction with the pool component if the covering bundle can provide the necessary captial
+    /// default implementation returnsfalse (no)
+    function isVerifyingApplications() external view returns (bool);
+
+    /// @dev returns true iff the policy application data in policyData matches
+    /// with the bundle filter criteria encoded in bundleFilter
+    /// this is a callback function that is only called if a pool declares itself as a verifying pool
+    /// default implementation returns true
     function policyMatchesBundle(
         bytes memory policyData,
         bytes memory bundleFilter
@@ -59,8 +84,4 @@ interface IPoolComponent {
         view
         returns (bool isMatching);
 
-    function isConfirmingApplication() external view returns (bool isConfirmingApplication);
-
-    function getCollateralizationLevel() external view returns (UFixed collateralizationLevel);
-
 }

package/contracts/components/IProductComponent.sol

@@ -2,11 +2,15 @@
 pragma solidity ^0.8.20;
 
 import {Fee} from "../types/Fee.sol";
+import {IComponent} from "./IComponent.sol";
+import {ISetup} from "../instance/module/ISetup.sol";
 import {NftId} from "../types/NftId.sol";
 import {ReferralId} from "../types/Referral.sol";
 import {RiskId} from "../types/RiskId.sol";
 
-interface IProductComponent {
+interface IProductComponent is IComponent {
+
+    function getSetupInfo() external view returns (ISetup.ProductSetupInfo memory setupInfo);
 
     function setFees(
         Fee memory productFee,
@@ -18,8 +22,8 @@ interface IProductComponent {
         RiskId riskId,
         uint256 lifetime,
         bytes memory applicationData,
-        ReferralId referralId,
-        NftId bundleNftId
+        NftId bundleNftId,
+        ReferralId referralId
     ) external view returns (uint256 premiumAmount);
 
     function calculateNetPremium(