@etherisc/gif-next 0.0.2-f74fcad-685 → 0.0.2-f7b8c9f-436

package/contracts/components/Pool.sol

@@ -1,52 +1,246 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {ObjectType, POOL} from "../types/ObjectType.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {IPoolService} from "../instance/service/IPoolService.sol";
+import {NftId} from "../types/NftId.sol";
 import {Fee} from "../types/Fee.sol";
-import {IPoolComponent} from "./IPool.sol";
-import {Component} from "./Component.sol";
+import {UFixed} from "../types/UFixed.sol";
+import {IPoolComponent} from "./IPoolComponent.sol";
+import {BaseComponent} from "./BaseComponent.sol";
 
-contract Pool is Component, IPoolComponent {
-    Fee private _stakingFee;
-    Fee private _performanceFee;
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IPool} from "../instance/module/pool/IPoolModule.sol";
+import {ITreasury} from "../instance/module/treasury/ITreasury.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {Registerable} from "../shared/Registerable.sol";
+
+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;
+
+    // only relevant to protect callback functions for "active" pools
+    IProductService private _productService;
+
+    modifier onlyPoolService() {
+        require(
+            msg.sender == address(_poolService), 
+            "ERROR:POL-001:NOT_POOL_SERVICE");
+        _;
+    }
+
+    modifier onlyProductService() {
+        require(
+            msg.sender == address(_productService), 
+            "ERROR:POL-002:NOT_PRODUCT_SERVICE");
+        _;
+    }
 
     constructor(
         address registry,
-        address instance,
+        NftId instanceNftId,
+        // TODO refactor into tokenNftId
         address token,
+        bool isInterceptor,
+        bool verifying,
+        UFixed collateralizationLevel,
+        Fee memory poolFee,
         Fee memory stakingFee,
-        Fee memory performanceFee
-    ) Component(registry, instance, token) {
-        _stakingFee = stakingFee;
-        _performanceFee = performanceFee;
+        Fee memory performanceFee,
+        address initialOwner
+    )
+        BaseComponent(registry, instanceNftId, token, POOL(), isInterceptor, initialOwner)
+    {
+        _isVerifying = verifying;
+        // TODO add validation
+        _collateralizationLevel = collateralizationLevel;
+        _initialPoolFee = poolFee;
+        _initialStakingFee = stakingFee;
+        _initialPerformanceFee = performanceFee;
+
+        _poolService = _instance.getPoolService();
+        _productService = _instance.getProductService();
+
+        _registerInterface(type(IPoolComponent).interfaceId);
+    }
+
+    function createBundle(
+        Fee memory fee,
+        uint256 initialAmount,
+        uint256 lifetime,
+        bytes memory filter
+    )
+        external
+        virtual override
+        returns(NftId bundleNftId)
+    {
+        address owner = msg.sender;
+        bundleNftId = _poolService.createBundle(
+            owner,
+            fee,
+            initialAmount,
+            lifetime,
+            filter
+        );
+
+        // TODO add logging
     }
 
-    // from pool component
-    function getStakingFee()
+    /**
+     * @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
+        onlyProductService
+        virtual override 
+    {
+        _underwrite(policyNftId, policyData, bundleFilter, collateralizationAmount);
+    }
+
+    /**
+     * @dev see {IPoolComponent.policyMatchesBundle}. 
+     * Default implementation always returns true
+     */
+    function policyMatchesBundle(
+        bytes memory, // policyData
+        bytes memory // bundleFilter
+    )
+        public
         view
+        virtual override
+        returns (bool isMatching)
+    {
+        return true;
+    }
+
+
+    function isVerifying() external view override returns (bool verifying) {
+        return _isVerifying;
+    }
+
+    function getCollateralizationLevel() external view override returns (UFixed collateralizationLevel) {
+        return _collateralizationLevel;
+    }
+
+    function setFees(
+        Fee memory poolFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    )
+        external
+        onlyOwner
         override
-        returns (Fee memory stakingFee)
     {
-        return _stakingFee;
+        _poolService.setFees(poolFee, stakingFee, performanceFee);
     }
 
-    function getPerformanceFee()
+    function setBundleFee(
+        NftId bundleNftId, 
+        Fee memory fee
+    )
+        external
+        override
+        // TODO add onlyBundleOwner
+    {
+        _poolService.setBundleFee(bundleNftId, fee);
+    }
+    // TODO delete, call instance instead
+    function getFees()
         external
         view
         override
-        returns (Fee memory performanceFee)
+        returns (Fee memory, Fee memory, Fee memory)
     {
-        return _performanceFee;
+        NftId productNftId = _instance.getProductNftId(getNftId());
+        //if (_instance.hasTreasuryInfo(productNftId)) {
+            ITreasury.TreasuryInfo memory info = _instance.getTreasuryInfo(productNftId);
+            return (info.poolFee, info.stakingFee, info.performanceFee);
+        //} else {
+        //    return (_initialPoolFee, _initialStakingFee, _initialPerformanceFee);
+        //}
     }
 
-    // from registerable
-    function getType() public pure override returns (ObjectType) {
-        return POOL();
+    // from IRegisterable
+
+    // TODO used only once, occupies space
+    // TODO do not use super
+    function getInitialInfo() 
+        public
+        view
+        override (IRegisterable, Registerable)
+        returns (IRegistry.ObjectInfo memory, bytes memory)
+    {
+        (
+            IRegistry.ObjectInfo memory info, 
+            bytes memory data
+        ) = super.getInitialInfo();
+
+        return (
+            info,
+            abi.encode(
+                IPool.PoolInfo(
+                    _isVerifying,
+                    _collateralizationLevel
+                ),
+                _wallet,
+                _token,
+                _initialPoolFee,
+                _initialStakingFee,
+                _initialPerformanceFee
+            )
+        );
     }
 
-    // from registerable
-    function getData() external view override returns (bytes memory data) {
-        return bytes(abi.encode(getInstance().getNftId()));
+    // 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 = _poolService.createBundle(
+            bundleOwner,
+            fee,
+            amount,
+            lifetime,
+            filter
+        );
     }
 }

package/contracts/components/Product.sol

@@ -1,71 +1,228 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IProductService} from "../instance/product/IProductService.sol";
-import {Component} from "./Component.sol";
-import {IProductComponent} from "./IProduct.sol";
-import {NftId} from "../types/NftId.sol";
+import {IERC20Metadata} from "@openzeppelin5/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+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, zeroNftId} from "../types/NftId.sol";
 import {ObjectType, PRODUCT} from "../types/ObjectType.sol";
-import {Fee} from "../types/Fee.sol";
-import {Component} from "./Component.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, FeeLib} from "../types/Fee.sol";
+import {BaseComponent} from "./BaseComponent.sol";
+
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {Registerable} from "../shared/Registerable.sol";
+
+import {IPool} from "../instance/module/pool/IPoolModule.sol";
+import {Pool} from "../components/Pool.sol";
+
+contract Product is BaseComponent, IProductComponent {
+    IProductService internal _productService;
+    Pool internal _pool;
+    address internal _distribution;
+    Fee internal _initialProductFee;
+    Fee internal _initialProcessingFee;
 
-contract Product is Component, IProductComponent {
-    IProductService private _productService;
-    address private _pool;
-    Fee private _policyFee;
-    Fee private _processingFee;
+    NftId internal _poolNftId;
+    NftId internal _distributionNftId;
 
     constructor(
         address registry,
-        address instance,
+        NftId instanceNftid,
         address token,
+        bool isInterceptor,
         address pool,
-        Fee memory policyFee,
-        Fee memory processingFee
-    ) Component(registry, instance, token) {
+        address distribution,
+        Fee memory productFee,
+        Fee memory processingFee,
+        address initialOwner
+    ) BaseComponent(registry, instanceNftid, token, PRODUCT(), isInterceptor, initialOwner) {
         // TODO add validation
         _productService = _instance.getProductService();
-        _pool = pool;
-        _policyFee = policyFee;
-        _processingFee = processingFee;
+        _pool = Pool(pool);
+        _distribution = distribution;
+        _initialProductFee = productFee;
+        _initialProcessingFee = processingFee;  
+
+        _poolNftId = getRegistry().getNftId(address(_pool));
+        _distributionNftId = getRegistry().getNftId(_distribution);
+
+        _registerInterface(type(IProductComponent).interfaceId);  
+    }
+
+
+    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
+        virtual 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
         );
     }
 
-    function _underwrite(NftId nftId) internal {
-        _productService.underwrite(nftId);
+    function _underwrite(
+        NftId policyNftId,
+        bool requirePremiumPayment,
+        Timestamp activateAt
+    )
+        internal
+    {
+        _productService.underwrite(
+            policyNftId, 
+            requirePremiumPayment, 
+            activateAt);
     }
 
-    function _collectPremium(NftId nftId) internal {
-        _productService.collectPremium(nftId);
+    function _collectPremium(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+    {
+        _productService.collectPremium(
+            policyNftId, 
+            activateAt);
+    }
+
+    function _activate(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+    {
+        _productService.activate(
+            policyNftId, 
+            activateAt);
     }
 
     function getPoolNftId() external view override returns (NftId poolNftId) {
-        return _registry.getNftId(_pool);
+        return getRegistry().getNftId(address(_pool));
+    }
+
+    function getDistributionNftId() external view override returns (NftId distributionNftId) {
+        return getRegistry().getNftId(_distribution);
     }
 
     // from product component
-    function getPolicyFee()
+    function setFees(
+        Fee memory productFee,
+        Fee memory processingFee
+    )
+        external
+        onlyOwner
+        override
+    {
+        _productService.setFees(productFee, processingFee);
+    }
+
+    // TODO delete, call instance intead
+    function getProductFee()
         external
         view
         override
-        returns (Fee memory policyFee)
+        returns (Fee memory productFee)
     {
-        return _policyFee;
+        NftId productNftId = getNftId();
+        if (_instance.hasTreasuryInfo(productNftId)) {
+            return _instance.getTreasuryInfo(productNftId).productFee;
+        } else {
+            return _initialProductFee;
+        }
     }
 
     function getProcessingFee()
@@ -74,16 +231,69 @@ contract Product is Component, IProductComponent {
         override
         returns (Fee memory processingFee)
     {
-        return _processingFee;
+        NftId productNftId = getNftId();
+        if (_instance.hasTreasuryInfo(productNftId)) {
+            return _instance.getTreasuryInfo(productNftId).processingFee;
+        } else {
+            return _initialProcessingFee;
+        }
     }
 
-    // from registerable
-    function getType() public pure override returns (ObjectType) {
-        return PRODUCT();
-    }
+    // from IRegisterable
+
+    // TODO used only once, occupies space
+    function getInitialInfo() 
+        public
+        view 
+        override (IRegisterable, Registerable)
+        returns (IRegistry.ObjectInfo memory, bytes memory)
+    {
+        // from Registerable
+        (
+            IRegistry.ObjectInfo memory productInfo, 
+            bytes memory data
+        ) = super.getInitialInfo();
+ 
+        // TODO read pool & distribution fees
+        // 1) from pool -> the only option -> pool must be registered first?
+        // 2) from instance -> all fees are set into instance at product registration which is ongoing here
+        // checks are done in registryProduct() where THIS function is called
+        //require(getRegistry().getObjectInfo(_poolNftId).objectType == POOL(), "POOL_NOT_REGISTERED");
+        //require(getRegistry().getObjectInfo(_distributionNftId).objectType == DISTRIBUTION(), "DISTRIBUTION_NOT_REGISTERED");
+        
+        // from PoolComponent
+        (
+            IRegistry.ObjectInfo memory poolInfo, 
+            bytes memory poolData
+        ) = _pool.getInitialInfo();
 
-    // from registerable
-    function getData() external view override returns (bytes memory data) {
-        return bytes(abi.encode(getInstance().getNftId()));
+        (
+            /*IPool.PoolInfo memory info*/,
+            /*address wallet*/,
+            /*IERC20Metadata token*/,
+            Fee memory initialPoolFee,
+            Fee memory initialStakingFee,
+            Fee memory initialPerformanceFee
+        )  = abi.decode(poolData, (IPool.PoolInfo, address, IERC20Metadata, Fee, Fee, Fee));
+
+        // TODO from DistributionComponent
+
+        return (
+            productInfo,
+            abi.encode(
+                ITreasury.TreasuryInfo(
+                    _poolNftId,
+                    _distributionNftId,
+                    _token,
+                    _initialProductFee,
+                    _initialProcessingFee,
+                    initialPoolFee,
+                    initialStakingFee,
+                    initialPerformanceFee,
+                    FeeLib.zeroFee()//_instance.getDistributionFee(_distributionNftId)
+                ),
+                _wallet
+            )
+        );
     }
 }

package/contracts/instance/IInstance.sol

@@ -1,25 +1,54 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IRegisterable} from "../registry/IRegistry.sol";
-import {IAccessModule} from "./access/IAccess.sol";
-import {ILifecycleModule} from "./lifecycle/ILifecycle.sol";
-import {IComponentModule} from "./component/IComponent.sol";
-import {IProductModule} from "./product/IProductService.sol";
-import {IPolicyModule} from "./policy/IPolicy.sol";
-import {IPoolModule} from "./pool/IPoolModule.sol";
-import {ITreasuryModule} from "./treasury/ITreasury.sol";
+import {IERC165} from "@openzeppelin5/contracts/utils/introspection/IERC165.sol";
+
+import {INftOwnable} from "../shared/INftOwnable.sol";
+import {IVersionable} from "../shared/IVersionable.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {RoleId} from "../types/RoleId.sol";
+
+import {IAccessModule} from "./module/access/IAccess.sol";
+import {IBundleModule} from "./module/bundle/IBundle.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";
+import {IRiskModule} from "./module/risk/IRisk.sol";
+import {ITreasuryModule} from "./module/treasury/ITreasury.sol";
+
+import {IKeyValueStore} from "./base/IKeyValueStore.sol";
+import {IRegistry} from "../registry/IRegistry.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";
 
 // solhint-disable-next-line no-empty-blocks
 interface IInstance is
+    IERC165,
+    IVersionable,
     IRegisterable,
     IAccessModule,
-    ILifecycleModule,
     IPolicyModule,
     IPoolModule,
+    IRiskModule,
+    IBundleModule,
     IComponentModule,
-    IProductModule,
-    ITreasuryModule
+    ITreasuryModule,
+    IDistributionModule,
+    IInstanceBase
 {
+    function getRegistry() external view override (INftOwnable) returns (IRegistry registry);
+    function getOwner() external view override (IAccessModule, INftOwnable) returns(address owner);
+
+    function getKeyValueStore() external view override (IInstanceBase) returns (IKeyValueStore keyValueStore);
+
+    function getComponentOwnerService() external view override (IInstanceBase, IComponentModule, IPoolModule, ITreasuryModule) 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);
 
 }

package/contracts/instance/IInstanceLinked.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IInstance} from "./IInstance.sol";
+
+interface IInstanceLinked {
+    function getInstance() external view returns (IInstance instance);
+}