@etherisc/gif-next 0.0.2-d3ee0cc-268 → 0.0.2-d408403-475

package/contracts/components/Distribution.sol

@@ -0,0 +1,132 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {ObjectType, DISTRIBUTION} from "../types/ObjectType.sol";
+import {IDistributionService} from "../instance/service/IDistributionService.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {NftId} from "../types/NftId.sol";
+import {ReferralId} from "../types/ReferralId.sol";
+import {Fee, FeeLib} from "../types/Fee.sol";
+import {BaseComponent} from "./BaseComponent.sol";
+import {IDistributionComponent} from "./IDistributionComponent.sol";
+
+contract Distribution is
+    BaseComponent,
+    IDistributionComponent
+{
+
+    Fee internal _initialDistributionFee;
+    bool internal _isVerifying;
+
+    IDistributionService private _distributionService;
+    IProductService private _productService;
+
+    modifier onlyProductService() {
+        require(
+            msg.sender == address(_productService), 
+            "ERROR:POL-002:NOT_PRODUCT_SERVICE");
+        _;
+    }
+
+    constructor(
+        address registry,
+        NftId instanceNftId,
+        // TODO refactor into tokenNftId
+        address token,
+        bool verifying,
+        Fee memory distributionFee
+    )
+        BaseComponent(registry, instanceNftId, token)
+    {
+        _isVerifying = verifying;
+        _initialDistributionFee = distributionFee;
+
+        _distributionService = _instance.getDistributionService();
+        _productService = _instance.getProductService();
+    }
+
+
+    function setFees(
+        Fee memory distributionFee
+    )
+        external
+        override
+    {
+        _distributionService.setFees(distributionFee);
+    }
+
+    function calculateFeeAmount(
+        ReferralId referralId,
+        uint256 netPremiumAmount
+    )
+        external
+        view
+        virtual override
+        returns (uint256 feeAmount)
+    {
+        Fee memory fee = getDistributionFee();
+        (feeAmount,) = FeeLib.calculateFee(fee, netPremiumAmount);
+    }
+
+
+    function calculateRenewalFeeAmount(
+        ReferralId referralId,
+        uint256 netPremiumAmount
+    )
+        external
+        view
+        virtual override
+        returns (uint256 feeAmount)
+    {
+        // default is no fees
+        return 0 * netPremiumAmount;
+    }
+
+    function processSale(
+        ReferralId referralId,
+        uint256 feeAmount
+    )
+        external
+        onlyProductService
+        virtual override
+    {
+        // default is no action
+    }
+
+    function processRenewal(
+        ReferralId referralId,
+        uint256 feeAmount
+    )
+        external
+        onlyProductService
+        virtual override
+    {
+        // default is no action
+    }
+
+    function referralIsValid(ReferralId referralId) external view returns (bool isValid) {
+        // default is invalid
+        return false;
+    }
+
+    /// @dev default distribution fee, ie when not using any valid referralId
+    function getDistributionFee() public view returns (Fee memory distributionFee) {
+        NftId productNftId = _instance.getProductNftId(getNftId());
+        if (_instance.hasTreasuryInfo(productNftId)) {
+            return _instance.getTreasuryInfo(productNftId).distributionFee;
+        } else {
+            return _initialDistributionFee;
+        }
+    }
+
+
+    /// @dev returns true iff the component needs to be called when selling/renewing policis
+    function isVerifying() external view returns (bool verifying) {
+        return _isVerifying;
+    }
+
+    // from registerable
+    function getType() public pure override returns (ObjectType) {
+        return DISTRIBUTION();
+    }
+}

package/contracts/components/IDistributionComponent.sol

@@ -0,0 +1,48 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Fee} from "../types/Fee.sol";
+import {NftId} from "../types/NftId.sol";
+import {ReferralId} from "../types/ReferralId.sol";
+
+import {IBaseComponent} from "./IBaseComponent.sol";
+
+interface IDistributionComponent is IBaseComponent {
+
+    function setFees(
+        Fee memory distributionFee
+    ) external;
+
+    function calculateFeeAmount(
+        ReferralId referralId,
+        uint256 netPremiumAmount
+    ) external view returns (uint256 feeAmount);
+
+    function calculateRenewalFeeAmount(
+        ReferralId referralId,
+        uint256 netPremiumAmount
+    ) external view returns (uint256 feeAmount);
+
+    /// @dev callback from product service when selling a policy for a specific referralId
+    /// the used referral id and the collected fee are provided as parameters
+    /// the component implementation can then process this information accordingly
+    function processSale(
+        ReferralId referralId,
+        uint256 feeAmount
+    ) external;
+
+    /// @dev callback from product service when a policy is renews for a specific referralId
+    function processRenewal(
+        ReferralId referralId,
+        uint256 feeAmount
+    ) external;
+
+    /// @dev returns true iff the referral id is valid
+    function referralIsValid(ReferralId referralId) external view returns (bool isValid);
+
+    /// @dev default distribution fee, ie when not using any valid referralId
+    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 view returns (bool verifying);
+}

package/contracts/components/IPoolComponent.sol

@@ -10,15 +10,27 @@ interface IPoolComponent is IBaseComponent {
 
     event LogUnderwrittenByPool(NftId policyNftId, uint256 collateralizationAmount, address pool);
 
+    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);
 
+    function setBundleFee(
+        NftId policyNftId, 
+        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.
@@ -48,6 +60,8 @@ interface IPoolComponent is IBaseComponent {
 
     function getCollateralizationLevel() external view returns (UFixed collateralizationLevel);
 
+    function getPoolFee() external view returns (Fee memory poolFee);
+
     function getStakingFee() external view returns (Fee memory stakingFee);
 
     function getPerformanceFee()

package/contracts/components/IProductComponent.sol

@@ -1,19 +1,38 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {NftId} from "../types/NftId.sol";
 import {Fee} from "../types/Fee.sol";
+import {NftId} from "../types/NftId.sol";
+import {ReferralId} from "../types/ReferralId.sol";
+import {RiskId} from "../types/RiskId.sol";
+
 import {IBaseComponent} from "./IBaseComponent.sol";
 
 interface IProductComponent is IBaseComponent {
     function setFees(
-        Fee memory policyFee,
+        Fee memory productFee,
         Fee memory processingFee
     ) external;
 
-    function getPoolNftId() external view returns (NftId poolNftId);
-    
-    function getPolicyFee() external view returns (Fee memory policyFee);
+    function calculatePremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        uint256 lifetime,
+        bytes memory applicationData,
+        ReferralId referralId,
+        NftId bundleNftId
+    ) external view returns (uint256 premiumAmount);
 
+    function calculateNetPremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        uint256 lifetime,
+        bytes memory applicationData
+    ) external view returns (uint256 netPremiumAmount);    
+
+    function getProductFee() external view returns (Fee memory productFee);
     function getProcessingFee() external view returns (Fee memory processingFee);
+
+    function getPoolNftId() external view returns (NftId poolNftId);
+    function getDistributionNftId() external view returns (NftId distributionNftId);
 }

package/contracts/components/Pool.sol

@@ -15,6 +15,10 @@ contract Pool is BaseComponent, IPoolComponent {
     bool internal _isVerifying;
     UFixed internal _collateralizationLevel;
 
+    Fee internal _initialPoolFee;
+    Fee internal _initialStakingFee;
+    Fee internal _initialPerformanceFee;
+
     // may be used to interact with instance by derived contracts
     IPoolService internal _poolService;
 
@@ -41,19 +45,38 @@ contract Pool is BaseComponent, IPoolComponent {
         // TODO refactor into tokenNftId
         address token,
         bool verifying,
-        UFixed collateralizationLevel
+        UFixed collateralizationLevel,
+        Fee memory poolFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee
     )
         BaseComponent(registry, instanceNftId, token)
     {
         _isVerifying = verifying;
         // TODO add validation
         _collateralizationLevel = collateralizationLevel;
+        _initialPoolFee = poolFee;
+        _initialStakingFee = stakingFee;
+        _initialPerformanceFee = performanceFee;
 
         _poolService = _instance.getPoolService();
         _productService = _instance.getProductService();
     }
 
+    function setFees(
+        Fee memory poolFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    )
+        external
+        onlyOwner
+        override
+    {
+        _poolService.setFees(poolFee, stakingFee, performanceFee);
+    }
+
     function createBundle(
+        Fee memory fee,
         uint256 initialAmount,
         uint256 lifetime,
         bytes memory filter
@@ -65,6 +88,7 @@ contract Pool is BaseComponent, IPoolComponent {
         address owner = msg.sender;
         bundleNftId = _poolService.createBundle(
             owner,
+            fee,
             initialAmount,
             lifetime,
             filter
@@ -73,6 +97,17 @@ contract Pool is BaseComponent, IPoolComponent {
         // TODO add logging
     }
 
+    function setBundleFee(
+        NftId bundleNftId, 
+        Fee memory fee
+    )
+        external
+        override
+        // TODO add onlyBundleOwner
+    {
+        _poolService.setBundleFee(bundleNftId, fee);
+    }
+
     /**
      * @dev see {IPool.underwrite}. 
      * Default implementation that only writes a {LogUnderwrittenByPool} entry.
@@ -133,6 +168,7 @@ contract Pool is BaseComponent, IPoolComponent {
 
     function _createBundle(
         address bundleOwner,
+        Fee memory fee,
         uint256 amount,
         uint256 lifetime, 
         bytes calldata filter
@@ -142,6 +178,7 @@ contract Pool is BaseComponent, IPoolComponent {
     {
         bundleNftId = _poolService.createBundle(
             bundleOwner,
+            fee,
             amount,
             lifetime,
             filter
@@ -149,13 +186,32 @@ contract Pool is BaseComponent, IPoolComponent {
     }
 
     // from pool component
+    function getPoolFee()
+        external
+        view
+        override
+        returns (Fee memory poolFee)
+    {
+        NftId productNftId = _instance.getProductNftId(getNftId());
+        if (_instance.hasTreasuryInfo(productNftId)) {
+            return _instance.getTreasuryInfo(productNftId).poolFee;
+        } else {
+            return _initialPoolFee;
+        }
+    }
+
     function getStakingFee()
         external
         view
         override
         returns (Fee memory stakingFee)
     {
-        return _instance.getPoolSetup(getNftId()).stakingFee;
+        NftId productNftId = _instance.getProductNftId(getNftId());
+        if (_instance.hasTreasuryInfo(productNftId)) {
+            return _instance.getTreasuryInfo(productNftId).stakingFee;
+        } else {
+            return _initialStakingFee;
+        }
     }
 
     function getPerformanceFee()
@@ -164,7 +220,12 @@ contract Pool is BaseComponent, IPoolComponent {
         override
         returns (Fee memory performanceFee)
     {
-        return _instance.getPoolSetup(getNftId()).performanceFee;
+        NftId productNftId = _instance.getProductNftId(getNftId());
+        if (_instance.hasTreasuryInfo(productNftId)) {
+            return _instance.getTreasuryInfo(productNftId).performanceFee;
+        } else {
+            return _initialPerformanceFee;
+        }
     }
 
     // from registerable

package/contracts/components/Product.sol

@@ -1,42 +1,138 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+import {IRisk} from "../instance/module/risk/IRisk.sol";
+import {ITreasury} from "../instance/module/treasury/ITreasury.sol";
 import {IProductService} from "../instance/service/IProductService.sol";
 import {IProductComponent} from "./IProductComponent.sol";
 import {NftId} from "../types/NftId.sol";
 import {ObjectType, PRODUCT} from "../types/ObjectType.sol";
+import {ReferralId} from "../types/ReferralId.sol";
+import {RiskId, RiskIdLib} from "../types/RiskId.sol";
+import {StateId} from "../types/StateId.sol";
 import {Timestamp} from "../types/Timestamp.sol";
 import {Fee} from "../types/Fee.sol";
 import {BaseComponent} from "./BaseComponent.sol";
 
 contract Product is BaseComponent, IProductComponent {
-    IProductService private _productService;
-    address private _pool;
+    IProductService internal _productService;
+    address internal _pool;
+    address internal _distribution;
+    Fee internal _initialProductFee;
+    Fee internal _initialProcessingFee;
 
     constructor(
         address registry,
         NftId instanceNftid,
         address token,
-        address pool
+        address pool,
+        address distribution,
+        Fee memory productFee,
+        Fee memory processingFee
     ) BaseComponent(registry, instanceNftid, token) {
         // TODO add validation
         _productService = _instance.getProductService();
         _pool = pool;
+        _distribution = distribution;
+        _initialProductFee = productFee;
+        _initialProcessingFee = processingFee;        
+    }
+
+
+    function calculatePremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        uint256 lifetime,
+        bytes memory applicationData,
+        ReferralId referralId,
+        NftId bundleNftId
+    )
+        external 
+        view 
+        override 
+        returns (uint256 premiumAmount)
+    {
+        (premiumAmount,,,,) = _productService.calculatePremium(
+            riskId,
+            sumInsuredAmount,
+            lifetime,
+            applicationData,
+            bundleNftId,
+            referralId
+        );
+    }
+
+
+    function calculateNetPremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        uint256 lifetime,
+        bytes memory applicationData
+    )
+        external
+        view
+        override
+        returns (uint256 netPremiumAmount)
+    {
+        // default 10% of sum insured
+        return sumInsuredAmount / 10;
+    }
+
+    function _toRiskId(string memory riskName) internal pure returns (RiskId riskId) {
+        return RiskIdLib.toRiskId(riskName);
+    }
+
+    function _createRisk(
+        RiskId id,
+        bytes memory data
+    ) internal {
+        _productService.createRisk(
+            id,
+            data
+        );
+    }
+
+    function _setRiskInfo(
+        RiskId id,
+        IRisk.RiskInfo memory info
+    ) internal {
+        _productService.setRiskInfo(
+            id,
+            info
+        );
+    }
+
+    function _updateRiskState(
+        RiskId id,
+        StateId state
+    ) internal {
+        _productService.updateRiskState(
+            id,
+            state
+        );
+    }
+
+    function _getRiskInfo(RiskId id) internal view returns (IRisk.RiskInfo memory info) {
+        return _instance.getRiskInfo(id);
     }
 
     function _createApplication(
         address applicationOwner,
+        RiskId riskId,
         uint256 sumInsuredAmount,
-        uint256 premiumAmount,
         uint256 lifetime,
-        NftId bundleNftId
+        bytes memory applicationData,
+        NftId bundleNftId,
+        ReferralId referralId
     ) internal returns (NftId nftId) {
         nftId = _productService.createApplication(
             applicationOwner,
+            riskId,
             sumInsuredAmount,
-            premiumAmount,
             lifetime,
-            bundleNftId
+            applicationData,
+            bundleNftId,
+            referralId
         );
     }
 
@@ -79,26 +175,35 @@ contract Product is BaseComponent, IProductComponent {
         return _registry.getNftId(_pool);
     }
 
+    function getDistributionNftId() external view override returns (NftId distributionNftId) {
+        return _registry.getNftId(_distribution);
+    }
+
     // from product component
     function setFees(
-        Fee memory policyFee,
+        Fee memory productFee,
         Fee memory processingFee
     )
         external
         onlyOwner
         override
     {
-        _productService.setFees(policyFee, processingFee);
+        _productService.setFees(productFee, processingFee);
     }
 
 
-    function getPolicyFee()
+    function getProductFee()
         external
         view
         override
-        returns (Fee memory policyFee)
+        returns (Fee memory productFee)
     {
-        return _instance.getProductSetup(getNftId()).policyFee;
+        NftId productNftId = getNftId();
+        if (_instance.hasTreasuryInfo(productNftId)) {
+            return _instance.getTreasuryInfo(productNftId).productFee;
+        } else {
+            return _initialProductFee;
+        }
     }
 
     function getProcessingFee()
@@ -107,7 +212,12 @@ contract Product is BaseComponent, IProductComponent {
         override
         returns (Fee memory processingFee)
     {
-        return _instance.getProductSetup(getNftId()).processingFee;
+        NftId productNftId = getNftId();
+        if (_instance.hasTreasuryInfo(productNftId)) {
+            return _instance.getTreasuryInfo(productNftId).processingFee;
+        } else {
+            return _initialProcessingFee;
+        }
     }
 
     // from registerable

package/contracts/instance/IInstance.sol

@@ -10,7 +10,7 @@ import {RoleId} from "../types/RoleId.sol";
 
 import {IAccessModule} from "./module/access/IAccess.sol";
 import {IBundleModule} from "./module/bundle/IBundle.sol";
-import {ICompensationModule} from "./module/compensation/ICompensation.sol";
+import {IDistributionModule} from "./module/distribution/IDistribution.sol";
 import {IComponentModule} from "./module/component/IComponent.sol";
 import {IPolicyModule} from "./module/policy/IPolicy.sol";
 import {IPoolModule} from "./module/pool/IPoolModule.sol";
@@ -21,6 +21,7 @@ import {IKeyValueStore} from "./base/IKeyValueStore.sol";
 import {IRegistry, IRegistryLinked} from "../registry/IRegistryLinked.sol";
 
 import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
+import {IDistributionService} from "./service/IDistributionService.sol";
 import {IProductService} from "./service/IProductService.sol";
 import {IPoolService} from "./service/IPoolService.sol";
 import {IInstanceBase} from "./base/IInstanceBase.sol";
@@ -33,19 +34,19 @@ interface IInstance is
     IAccessModule,
     IPolicyModule,
     IPoolModule,
+    IRiskModule,
     IBundleModule,
     IComponentModule,
     ITreasuryModule,
-    ICompensationModule,
+    IDistributionModule,
     IInstanceBase
 {
-    function getRegistry() external view override (IBundleModule, IComponentModule, IPolicyModule, IRegisterable) returns (IRegistry registry);
+    function getRegistry() external view override (IPolicyModule, IRegisterable) returns (IRegistry registry);
     function getOwner() external view override (IOwnable, IAccessModule) returns(address owner);
 
-    function hasRole(RoleId role, address member) external view override (IAccessModule, IComponentModule) returns (bool hasRole);    
-
-    function getKeyValueStore() external view override (IBundleModule, IInstanceBase) returns (IKeyValueStore keyValueStore);
+    function getKeyValueStore() external view override (IInstanceBase) returns (IKeyValueStore keyValueStore);
     function getComponentOwnerService() external view override (IInstanceBase, IComponentModule) returns(IComponentOwnerService);
+    function getDistributionService() external view override returns(IDistributionService);
     function getProductService() external view override (IInstanceBase, IBundleModule, IPolicyModule) returns(IProductService);
     function getPoolService() external view override (IInstanceBase, IBundleModule, IPoolModule) returns(IPoolService);