@etherisc/gif-next 0.0.2-d911522 → 0.0.2-da06f3b-803

package/contracts/components/IDistributionComponent.sol

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Fee} from "../types/Fee.sol";
+import {IComponent} from "./IComponent.sol";
+import {ISetup} from "../instance/module/ISetup.sol";
+import {ReferralId} from "../types/Referral.sol";
+import {NftId} from "../types/NftId.sol";
+
+interface IDistributionComponent is IComponent {
+
+    function getSetupInfo() external view returns (ISetup.DistributionSetupInfo memory setupInfo);
+
+    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 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

@@ -0,0 +1,51 @@
+// SPDX-License-Identifier: Apache-2.0
+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 {UFixed} from "../types/UFixed.sol";
+
+interface IPoolComponent is IComponent {
+
+    event LogUnderwrittenByPool(NftId policyNftId, uint256 collateralizationAmount, address pool);
+
+    function getSetupInfo() external view returns (ISetup.PoolSetupInfo memory setupInfo);
+
+    function setFees(
+        Fee memory poolFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    ) 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, 
+        bytes memory policyData,
+        bytes memory bundleFilter,
+        uint256 collateralizationAmount
+    ) external;
+
+    /**
+     * @dev returns true iff the policy application data in policyData matches
+     * with the bundle filter criteria encoded in bundleFilter. 
+     */
+    function policyMatchesBundle(
+        bytes memory policyData,
+        bytes memory bundleFilter
+    )
+        external
+        view
+        returns (bool isMatching);
+
+    function isConfirmingApplication() external view returns (bool isConfirmingApplication);
+
+    function getCollateralizationLevel() external view returns (UFixed collateralizationLevel);
+
+}

package/contracts/components/IProductComponent.sol

@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: Apache-2.0
+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 is IComponent {
+
+    function getSetupInfo() external view returns (ISetup.ProductSetupInfo memory setupInfo);
+
+    function setFees(
+        Fee memory productFee,
+        Fee memory processingFee
+    ) external;
+
+    function calculatePremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        uint256 lifetime,
+        bytes memory applicationData,
+        NftId bundleNftId,
+        ReferralId referralId
+    ) external view returns (uint256 premiumAmount);
+
+    function calculateNetPremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        uint256 lifetime,
+        bytes memory applicationData
+    ) external view returns (uint256 netPremiumAmount);    
+
+    
+    function getPoolNftId() external view returns (NftId poolNftId);
+    function getDistributionNftId() external view returns (NftId distributionNftId);
+}

package/contracts/components/Pool.sol

@@ -1,29 +1,208 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {IPoolComponent} from "./IPool.sol";
+import {POOL} from "../types/ObjectType.sol";
+import {IPoolService} from "../instance/service/IPoolService.sol";
+import {IBundleService} from "../instance/service/IBundleService.sol";
+import {NftId, NftIdLib} from "../types/NftId.sol";
+import {Fee} from "../types/Fee.sol";
+import {UFixed} from "../types/UFixed.sol";
+import {IPoolComponent} from "./IPoolComponent.sol";
 import {Component} from "./Component.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
+import {ISetup} from "../instance/module/ISetup.sol";
 
+import {ISetup} from "../instance/module/ISetup.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
 
-contract Pool is
-    Component,
-    IPoolComponent
-{
+
+abstract contract Pool is Component, IPoolComponent {
+    using NftIdLib for NftId;
+
+    bool internal _isConfirmingApplication;
+    UFixed internal _collateralizationLevel;
+
+    Fee internal _initialPoolFee;
+    Fee internal _initialStakingFee;
+    Fee internal _initialPerformanceFee;
+
+    TokenHandler internal _tokenHandler;
+
+    // may be used to interact with instance by derived contracts
+    IPoolService internal _poolService;
+    IBundleService private _bundleService;
+
+    modifier onlyPoolService() {
+        require(
+            msg.sender == address(_poolService), 
+            "ERROR:POL-001:NOT_POOL_SERVICE");
+        _;
+    }
 
     constructor(
-        address registry, 
-        address instance
+        address registry,
+        NftId instanceNftId,
+        string memory name,
+        // TODO refactor into tokenNftId
+        address token,
+        bool isInterceptor,
+        bool isConfirmingApplication,
+        UFixed collateralizationLevel,
+        Fee memory poolFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee,
+        address initialOwner,
+        bytes memory data
+    ) Component(
+        registry, 
+        instanceNftId, 
+        name, 
+        token, 
+        POOL(), 
+        isInterceptor, 
+        initialOwner, 
+        data
+    ) {
+        _isConfirmingApplication = isConfirmingApplication;
+        // TODO add validation
+        _collateralizationLevel = collateralizationLevel;
+        _initialPoolFee = poolFee;
+        _initialStakingFee = stakingFee;
+        _initialPerformanceFee = performanceFee;
+
+        _tokenHandler = new TokenHandler(token);
+
+        _poolService = getInstance().getPoolService();
+        _bundleService = getInstance().getBundleService();
+
+        _registerInterface(type(IPoolComponent).interfaceId);
+    }
+
+    /**
+     * @dev see {IPool.underwrite}. 
+     * Default implementation that only writes a {LogUnderwrittenByPool} entry.
+     */
+    function underwrite(
+        NftId policyNftId, 
+        bytes memory policyData,
+        bytes memory bundleFilter,
+        uint256 collateralizationAmount
+    )
+        external
+        restricted()
+        virtual override 
+    {
+        _underwrite(policyNftId, policyData, bundleFilter, collateralizationAmount);
+    }
+
+    /**
+     * @dev see {IPoolComponent.policyMatchesBundle}. 
+     * Default implementation always returns true
+     */
+    function policyMatchesBundle(
+        bytes memory, // policyData
+        bytes memory // bundleFilter
     )
-        Component(registry, instance)
-    { }
+        public
+        view
+        virtual override
+        returns (bool isMatching)
+    {
+        return true;
+    }
+
 
-    // from registerable
-    function getType() public view override returns(uint256) {
-        return _registry.POOL();
+    function isConfirmingApplication() external view override returns (bool isConfirmingApplication) {
+        return _isConfirmingApplication;
     }
 
-    // from registerable
-    function getData() external view override returns(bytes memory data) {
-        return bytes(abi.encode(getInstance().getNftId()));
+    function getCollateralizationLevel() external view override returns (UFixed collateralizationLevel) {
+        return _collateralizationLevel;
+    }
+
+    function setFees(
+        Fee memory poolFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    )
+        external
+        onlyOwner
+        restricted()
+        override
+    {
+        _poolService.setFees(poolFee, stakingFee, performanceFee);
+    }
+
+    function _setBundleFee(NftId bundleNftId, Fee memory fee) internal {
+        _bundleService.setBundleFee(bundleNftId, fee);
+    }
+
+    function _lockBundle(NftId bundleNftId) internal {
+        _bundleService.lockBundle(bundleNftId);
+    }
+
+    function _unlockBundle(NftId bundleNftId) internal {
+        _bundleService.unlockBundle(bundleNftId);
+    }
+
+    function getSetupInfo() public view returns (ISetup.PoolSetupInfo memory setupInfo) {
+        InstanceReader reader = getInstance().getInstanceReader();
+        setupInfo = reader.getPoolSetupInfo(getNftId());
+
+        // fallback to initial setup info (wallet is always != address(0))
+        if(setupInfo.wallet == address(0)) {
+            setupInfo = _getInitialSetupInfo();
+        }
+    }
+
+    function _getInitialSetupInfo() internal view returns (ISetup.PoolSetupInfo memory) {
+        return ISetup.PoolSetupInfo(
+            getProductNftId(),
+            _tokenHandler,
+            _collateralizationLevel,
+            _initialPoolFee,
+            _initialStakingFee,
+            _initialPerformanceFee,
+            false,
+            _isConfirmingApplication,
+            getWallet()
+        );
+    }
+
+    // Internals
+
+    function _underwrite(
+        NftId policyNftId, 
+        bytes memory policyData,
+        bytes memory bundleFilter,
+        uint256 collateralizationAmount
+    )
+        internal 
+    {
+        require(
+            policyMatchesBundle(policyData, bundleFilter),
+            "ERROR:POL-020:POLICY_BUNDLE_MISMATCH"
+        );
+
+        emit LogUnderwrittenByPool(policyNftId, collateralizationAmount, address(this));
+    }
+
+    function _createBundle(
+        address bundleOwner,
+        Fee memory fee,
+        uint256 amount,
+        uint256 lifetime, 
+        bytes calldata filter
+    )
+        internal
+        returns(NftId bundleNftId)
+    {
+        bundleNftId = _bundleService.createBundle(
+            bundleOwner,
+            fee,
+            amount,
+            lifetime,
+            filter
+        );
     }
-}
+}

package/contracts/components/Product.sol

@@ -1,66 +1,266 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IProductService} from "../instance/product/IProductService.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IRisk} from "../instance/module/IRisk.sol";
+import {IPolicyService} from "../instance/service/IPolicyService.sol";
+import {IProductComponent} from "./IProductComponent.sol";
+import {NftId, NftIdLib} from "../types/NftId.sol";
+import {PRODUCT} from "../types/ObjectType.sol";
+import {ReferralId} from "../types/Referral.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 {Component} from "./Component.sol";
-import {IProductComponent} from "./IProduct.sol";
-import {NftId} from "../types/NftId.sol";
 
+import {TokenHandler} from "../shared/TokenHandler.sol";
+
+import {InstanceReader} from "../instance/InstanceReader.sol";
+import {ISetup} from "../instance/module/ISetup.sol";
+import {Pool} from "../components/Pool.sol";
+import {Distribution} from "../components/Distribution.sol";
+
+abstract contract Product is Component, IProductComponent {
+    using NftIdLib for NftId;
+
+    IPolicyService internal _policyService;
+    Pool internal _pool;
+    Distribution internal _distribution;
+    Fee internal _initialProductFee;
+    Fee internal _initialProcessingFee;
+    TokenHandler internal _tokenHandler;
 
-contract Product is
-    Component,
-    IProductComponent
-{
-    IProductService private _productService;
-    address private _pool;
+    NftId internal _poolNftId;
+    NftId internal _distributionNftId;
 
     constructor(
-        address registry, 
-        address instance, 
-        address pool
+        address registry,
+        NftId instanceNftid,
+        string memory name,
+        address token,
+        bool isInterceptor,
+        address pool,
+        address distribution,
+        Fee memory productFee,
+        Fee memory processingFee,
+        address initialOwner,
+        bytes memory data
+    ) Component (
+        registry, 
+        instanceNftid, 
+        name, 
+        token, 
+        PRODUCT(), 
+        isInterceptor, 
+        initialOwner, 
+        data
+    ) {
+        // TODO add validation
+        _policyService = getInstance().getPolicyService(); 
+        _pool = Pool(pool);
+        _distribution = Distribution(distribution);
+        _initialProductFee = productFee;
+        _initialProcessingFee = processingFee;  
+
+        _tokenHandler = new TokenHandler(token);
+
+        _poolNftId = getRegistry().getNftId(address(_pool));
+        _distributionNftId = getRegistry().getNftId(address(_distribution));
+
+        _registerInterface(type(IProductComponent).interfaceId);  
+    }
+
+
+    function calculatePremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        uint256 lifetime,
+        bytes memory applicationData,
+        NftId bundleNftId,
+        ReferralId referralId
     )
-        Component(registry, instance)
-    { 
-        _productService = _instance.getProductService();
-        _pool = pool;
+        external 
+        view 
+        override 
+        returns (uint256 premiumAmount)
+    {
+        (premiumAmount,,,,) = _policyService.calculatePremium(
+            riskId,
+            sumInsuredAmount,
+            lifetime,
+            applicationData,
+            bundleNftId,
+            referralId
+        );
     }
 
-    function _createApplication(
-        address applicationOwner,
+
+    function calculateNetPremium(
         uint256 sumInsuredAmount,
-        uint256 premiumAmount,
+        RiskId riskId,
         uint256 lifetime,
-        NftId bundleNftId
+        bytes memory applicationData
     )
-        internal
-        returns(NftId nftId)
+        external
+        view
+        virtual override
+        returns (uint256 netPremiumAmount)
     {
-        nftId = _productService.createApplication(
+        // 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 {
+        getProductService().createRisk(
+            id,
+            data
+        );
+    }
+
+    function _updateRisk(
+        RiskId id,
+        bytes memory data
+    ) internal {
+        getProductService().updateRisk(
+            id,
+            data
+        );
+    }
+
+    function _updateRiskState(
+        RiskId id,
+        StateId state
+    ) internal {
+        getProductService().updateRiskState(
+            id,
+            state
+        );
+    }
+
+    function _getRiskInfo(RiskId id) internal view returns (IRisk.RiskInfo memory info) {
+        return getInstance().getInstanceReader().getRiskInfo(id);
+    }
+
+    function _createApplication(
+        address applicationOwner,
+        RiskId riskId,
+        uint256 sumInsuredAmount,
+        uint256 lifetime,
+        bytes memory applicationData,
+        NftId bundleNftId,
+        ReferralId referralId
+    ) internal returns (NftId nftId) {
+        nftId = _policyService.createApplication(
             applicationOwner,
+            riskId,
             sumInsuredAmount,
-            premiumAmount,
             lifetime,
-            bundleNftId
+            applicationData,
+            bundleNftId,
+            referralId
         );
     }
 
-    function _underwrite(NftId nftId)
+    function _underwrite(
+        NftId policyNftId,
+        bool requirePremiumPayment,
+        Timestamp activateAt
+    )
+        internal
+    {
+        _policyService.underwrite(
+            policyNftId, 
+            requirePremiumPayment, 
+            activateAt);
+    }
+
+    function _collectPremium(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+    {
+        _policyService.collectPremium(
+            policyNftId, 
+            activateAt);
+    }
+
+    function _activate(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+    {
+        _policyService.activate(
+            policyNftId, 
+            activateAt);
+    }
+
+    function _close(
+        NftId policyNftId
+    )
         internal
     {
-        _productService.underwrite(nftId);
+        _policyService.close(policyNftId);
+    }
+
+    function getPoolNftId() external view override returns (NftId poolNftId) {
+        return getRegistry().getNftId(address(_pool));
+    }
+
+    function getDistributionNftId() external view override returns (NftId distributionNftId) {
+        return getRegistry().getNftId(address(_distribution));
     }
 
-    function getPoolNftId() external view override returns(NftId poolNftId) {
-        return _registry.getNftId(_pool);
+    // from product component
+    function setFees(
+        Fee memory productFee,
+        Fee memory processingFee
+    )
+        external
+        onlyOwner
+        restricted()
+        override
+    {
+        getProductService().setFees(productFee, processingFee);
     }
 
-    // from registerable
-    function getType() public view override returns(uint256) {
-        return _registry.PRODUCT();
+    function getSetupInfo() public view returns (ISetup.ProductSetupInfo memory setupInfo) {
+        InstanceReader reader = getInstance().getInstanceReader();
+        setupInfo = reader.getProductSetupInfo(getNftId());
+
+        // fallback to initial setup info (wallet is always != address(0))
+        if(setupInfo.wallet == address(0)) {
+            setupInfo = _getInitialSetupInfo();
+        }
     }
 
-    // from registerable
-    function getData() external view override returns(bytes memory data) {
-        return bytes(abi.encode(getInstance().getNftId()));
+    function _getInitialSetupInfo() internal view returns (ISetup.ProductSetupInfo memory setupInfo) {
+        ISetup.DistributionSetupInfo memory distributionSetupInfo = _distribution.getSetupInfo();
+        ISetup.PoolSetupInfo memory poolSetupInfo = _pool.getSetupInfo();
+
+        return ISetup.ProductSetupInfo(
+            getToken(),
+            _tokenHandler,
+            _distributionNftId,
+            _poolNftId,
+            distributionSetupInfo.distributionFee, 
+            _initialProductFee,
+            _initialProcessingFee,
+            poolSetupInfo.poolFee, 
+            poolSetupInfo.stakingFee, 
+            poolSetupInfo.performanceFee,
+            false,
+            getWallet()
+        );
     }
-}
+}