@etherisc/gif-next 0.0.2-e1f23dc-329 → 0.0.2-e2a57af-971

package/contracts/components/Pool.sol

@@ -1,42 +1,36 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {ObjectType, POOL} from "../types/ObjectType.sol";
-import {IProductService} from "../instance/service/IProductService.sol";
+import {POOL} from "../types/ObjectType.sol";
 import {IPoolService} from "../instance/service/IPoolService.sol";
-import {NftId, zeroNftId, NftIdLib} from "../types/NftId.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 {BaseComponent} from "./BaseComponent.sol";
+import {Component} from "./Component.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 import {ISetup} from "../instance/module/ISetup.sol";
 
-import {IRegistry} from "../registry/IRegistry.sol";
-
-// import {IPool} from "../instance/module/pool/IPoolModule.sol";
-import {ITreasury} from "../instance/module/ITreasury.sol";
 import {ISetup} from "../instance/module/ISetup.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 
-import {IRegisterable} from "../shared/IRegisterable.sol";
-import {Registerable} from "../shared/Registerable.sol";
 
-contract Pool is BaseComponent, IPoolComponent {
+abstract contract Pool is Component, IPoolComponent {
     using NftIdLib for NftId;
 
-    bool internal _isVerifying;
+    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;
-
-    // only relevant to protect callback functions for "active" pools
-    IProductService private _productService;
+    IBundleService private _bundleService;
 
     modifier onlyPoolService() {
         require(
@@ -45,67 +39,50 @@ contract Pool is BaseComponent, IPoolComponent {
         _;
     }
 
-    modifier onlyProductService() {
-        require(
-            msg.sender == address(_productService), 
-            "ERROR:POL-002:NOT_PRODUCT_SERVICE");
-        _;
-    }
-
     constructor(
         address registry,
         NftId instanceNftId,
+        string memory name,
         // TODO refactor into tokenNftId
         address token,
         bool isInterceptor,
-        bool verifying,
+        bool isConfirmingApplication,
         UFixed collateralizationLevel,
         Fee memory poolFee,
         Fee memory stakingFee,
         Fee memory performanceFee,
-        address initialOwner
-    )
-        BaseComponent(registry, instanceNftId, token, POOL(), isInterceptor, initialOwner)
-    {
-        _isVerifying = verifying;
+        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;
 
-        _poolService = _instance.getPoolService();
-        _productService = _instance.getProductService();
-
-        _registerInterface(type(IPoolComponent).interfaceId);
-    }
+        _tokenHandler = new TokenHandler(token);
 
-    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
-        );
+        _poolService = getInstance().getPoolService();
+        _bundleService = getInstance().getBundleService();
 
-        // TODO add logging
+        _registerInterface(type(IPoolComponent).interfaceId);
     }
 
     /**
      * @dev see {IPool.underwrite}. 
      * Default implementation that only writes a {LogUnderwrittenByPool} entry.
      */
+    // FIXME: remove this function .. only _internal
     function underwrite(
         NftId policyNftId, 
         bytes memory policyData,
@@ -113,7 +90,7 @@ contract Pool is BaseComponent, IPoolComponent {
         uint256 collateralizationAmount
     )
         external
-        onlyProductService
+        restricted()
         virtual override 
     {
         _underwrite(policyNftId, policyData, bundleFilter, collateralizationAmount);
@@ -136,8 +113,8 @@ contract Pool is BaseComponent, IPoolComponent {
     }
 
 
-    function isVerifying() external view override returns (bool verifying) {
-        return _isVerifying;
+    function isConfirmingApplication() external view override returns (bool isConfirmingApplication) {
+        return _isConfirmingApplication;
     }
 
     function getCollateralizationLevel() external view override returns (UFixed collateralizationLevel) {
@@ -150,7 +127,7 @@ contract Pool is BaseComponent, IPoolComponent {
         Fee memory performanceFee
     )
         external
-        onlyOwner
+        restricted()
         override
     {
         _poolService.setFees(poolFee, stakingFee, performanceFee);
@@ -162,44 +139,52 @@ contract Pool is BaseComponent, IPoolComponent {
     )
         external
         override
-        // TODO add onlyBundleOwner
+        // TODO: add onlyBundleOwner
     {
-        _poolService.setBundleFee(bundleNftId, fee);
+        _bundleService.setBundleFee(bundleNftId, fee);
     }
 
-    function getSetupInfo() public view returns (ISetup.PoolSetupInfo memory setupInfo) {
-        InstanceReader reader = _instance.getInstanceReader();
-        return reader.getPoolSetupInfo(getNftId());
+    function lockBundle(
+        NftId bundleNftId
+    )
+        external
+        override
+        // TODO: add onlyBundleOwner
+    {
+        _bundleService.lockBundle(bundleNftId);
     }
 
-    // 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)
+    function unlockBundle(
+        NftId bundleNftId
+    )
+        external
+        override
+        // TODO: add onlyBundleOwner
     {
-        (
-            IRegistry.ObjectInfo memory info, 
-        ) = super.getInitialInfo();
-
-        return (
-            info,
-            abi.encode(
-                ISetup.PoolSetupInfo(
-                    _productNftId,
-                    TokenHandler(address(_token)),
-                    _collateralizationLevel,
-                    _initialPoolFee,
-                    _initialStakingFee,
-                    _initialPerformanceFee,
-                    _isVerifying,
-                    _wallet
-                )
-            )
+        _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()
         );
     }
 
@@ -231,7 +216,7 @@ contract Pool is BaseComponent, IPoolComponent {
         internal
         returns(NftId bundleNftId)
     {
-        bundleNftId = _poolService.createBundle(
+        bundleNftId = _bundleService.createBundle(
             bundleOwner,
             fee,
             amount,

package/contracts/components/Product.sol

@@ -4,21 +4,17 @@ pragma solidity ^0.8.19;
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {IRisk} from "../instance/module/IRisk.sol";
-import {ITreasury} from "../instance/module/ITreasury.sol";
-import {IProductService} from "../instance/service/IProductService.sol";
+import {IPolicyService} from "../instance/service/IPolicyService.sol";
 import {IProductComponent} from "./IProductComponent.sol";
-import {NftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
-import {ObjectType, PRODUCT} from "../types/ObjectType.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, FeeLib} from "../types/Fee.sol";
-import {BaseComponent} from "./BaseComponent.sol";
+import {Fee} from "../types/Fee.sol";
+import {Component} from "./Component.sol";
 
-import {IRegistry} from "../registry/IRegistry.sol";
-import {IRegisterable} from "../shared/IRegisterable.sol";
-import {Registerable} from "../shared/Registerable.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 
 import {InstanceReader} from "../instance/InstanceReader.sol";
@@ -26,16 +22,15 @@ import {ISetup} from "../instance/module/ISetup.sol";
 import {Pool} from "../components/Pool.sol";
 import {Distribution} from "../components/Distribution.sol";
 
-import {zeroNftId} from "../types/NftId.sol";
-
-contract Product is BaseComponent, IProductComponent {
+abstract contract Product is Component, IProductComponent {
     using NftIdLib for NftId;
 
-    IProductService internal _productService;
+    IPolicyService internal _policyService;
     Pool internal _pool;
     Distribution internal _distribution;
     Fee internal _initialProductFee;
     Fee internal _initialProcessingFee;
+    TokenHandler internal _tokenHandler;
 
     NftId internal _poolNftId;
     NftId internal _distributionNftId;
@@ -43,21 +38,34 @@ contract Product is BaseComponent, IProductComponent {
     constructor(
         address registry,
         NftId instanceNftid,
+        string memory name,
         address token,
         bool isInterceptor,
         address pool,
         address distribution,
         Fee memory productFee,
         Fee memory processingFee,
-        address initialOwner
-    ) BaseComponent(registry, instanceNftid, token, PRODUCT(), isInterceptor, initialOwner) {
+        address initialOwner,
+        bytes memory data
+    ) Component (
+        registry, 
+        instanceNftid, 
+        name, 
+        token, 
+        PRODUCT(), 
+        isInterceptor, 
+        initialOwner, 
+        data
+    ) {
         // TODO add validation
-        _productService = _instance.getProductService();
+        _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));
 
@@ -70,15 +78,15 @@ contract Product is BaseComponent, IProductComponent {
         RiskId riskId,
         uint256 lifetime,
         bytes memory applicationData,
-        ReferralId referralId,
-        NftId bundleNftId
+        NftId bundleNftId,
+        ReferralId referralId
     )
         external 
         view 
         override 
         returns (uint256 premiumAmount)
     {
-        (premiumAmount,,,,) = _productService.calculatePremium(
+        (premiumAmount,,,,) = _policyService.calculatePremium(
             riskId,
             sumInsuredAmount,
             lifetime,
@@ -112,7 +120,7 @@ contract Product is BaseComponent, IProductComponent {
         RiskId id,
         bytes memory data
     ) internal {
-        _productService.createRisk(
+        getProductService().createRisk(
             id,
             data
         );
@@ -122,7 +130,7 @@ contract Product is BaseComponent, IProductComponent {
         RiskId id,
         bytes memory data
     ) internal {
-        _productService.updateRisk(
+        getProductService().updateRisk(
             id,
             data
         );
@@ -132,14 +140,14 @@ contract Product is BaseComponent, IProductComponent {
         RiskId id,
         StateId state
     ) internal {
-        _productService.updateRiskState(
+        getProductService().updateRiskState(
             id,
             state
         );
     }
 
     function _getRiskInfo(RiskId id) internal view returns (IRisk.RiskInfo memory info) {
-        return _instance.getInstanceReader().getRiskInfo(id);
+        return getInstance().getInstanceReader().getRiskInfo(id);
     }
 
     function _createApplication(
@@ -151,7 +159,7 @@ contract Product is BaseComponent, IProductComponent {
         NftId bundleNftId,
         ReferralId referralId
     ) internal returns (NftId nftId) {
-        nftId = _productService.createApplication(
+        nftId = _policyService.createApplication(
             applicationOwner,
             riskId,
             sumInsuredAmount,
@@ -169,7 +177,7 @@ contract Product is BaseComponent, IProductComponent {
     )
         internal
     {
-        _productService.underwrite(
+        _policyService.underwrite(
             policyNftId, 
             requirePremiumPayment, 
             activateAt);
@@ -181,7 +189,7 @@ contract Product is BaseComponent, IProductComponent {
     )
         internal
     {
-        _productService.collectPremium(
+        _policyService.collectPremium(
             policyNftId, 
             activateAt);
     }
@@ -192,11 +200,19 @@ contract Product is BaseComponent, IProductComponent {
     )
         internal
     {
-        _productService.activate(
+        _policyService.activate(
             policyNftId, 
             activateAt);
     }
 
+    function _close(
+        NftId policyNftId
+    )
+        internal
+    {
+        _policyService.close(policyNftId);
+    }
+
     function getPoolNftId() external view override returns (NftId poolNftId) {
         return getRegistry().getNftId(address(_pool));
     }
@@ -214,71 +230,36 @@ contract Product is BaseComponent, IProductComponent {
         onlyOwner
         override
     {
-        _productService.setFees(productFee, processingFee);
+        getProductService().setFees(productFee, processingFee);
     }
 
     function getSetupInfo() public view returns (ISetup.ProductSetupInfo memory setupInfo) {
-        InstanceReader reader = _instance.getInstanceReader();
-        return reader.getProductSetupInfo(getNftId());
-    }
+        InstanceReader reader = getInstance().getInstanceReader();
+        setupInfo = reader.getProductSetupInfo(getNftId());
 
-    // from IRegisterable
+        // fallback to initial setup info (wallet is always != address(0))
+        if(setupInfo.wallet == address(0)) {
+            setupInfo = _getInitialSetupInfo();
+        }
+    }
 
-    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
-        (
-            , 
-            bytes memory poolData
-        ) = _pool.getInitialInfo();
-        
-        (
-            ISetup.PoolSetupInfo memory poolSetupInfo
-        )  = abi.decode(poolData, (ISetup.PoolSetupInfo));
-
-        // from DistributionComponent
-        (
-            , 
-            bytes memory distributionData
-        ) = _distribution.getInitialInfo();
-
-        (
-            ISetup.DistributionSetupInfo memory distributionSetupInfo
-        )  = abi.decode(distributionData, (ISetup.DistributionSetupInfo));
-
-        return (
-            productInfo,
-            abi.encode(
-                ISetup.ProductSetupInfo(
-                    _token,
-                    TokenHandler(address(_token)),
-                    _distributionNftId,
-                    _poolNftId,
-                    distributionSetupInfo.distributionFee, 
-                    _initialProductFee,
-                    _initialProcessingFee,
-                    poolSetupInfo.poolFee, 
-                    poolSetupInfo.stakingFee, 
-                    poolSetupInfo.performanceFee 
-                )
-            )
+    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()
         );
     }
 }

package/contracts/instance/BundleManager.sol

@@ -0,0 +1,125 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IInstance} from "./IInstance.sol";
+import {INSTANCE} from "../types/ObjectType.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {IPolicy} from "../instance/module/IPolicy.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {LibNftIdSet} from "../types/NftIdSet.sol";
+import {NftId} from "../types/NftId.sol";
+import {TimestampLib} from "../types/Timestamp.sol";
+
+import {ObjectManager} from "./ObjectManager.sol";
+
+contract BundleManager is 
+    ObjectManager
+{
+
+    event LogBundleManagerPolicyLinked(NftId bundleNftId, NftId policyNftId);
+    event LogBundleManagerPolicyUnlinked(NftId bundleNftId, NftId policyNftId);
+
+    event LogBundleManagerBundleAdded(NftId poolNftId, NftId bundleNftId);
+    event LogBundleManagerBundleUnlocked(NftId poolNftId, NftId bundleNftId);
+    event LogBundleManagerBundleLocked(NftId poolNftId, NftId bundleNftId);
+
+    error ErrorBundleManagerErrorPolicyAlreadyActivated(NftId policyNftId);
+    error ErrorBundleManagerErrorBundleLocked(NftId bundleNftId, NftId policyNftId);
+    error ErrorBundleManagerPolicyWithOpenClaims(NftId policyNftId, uint256 openClaimsCount);
+    error ErrorBundleManagerPolicyNotCloseable(NftId policyNftId);
+    error ErrorBundleManagerBundleUnknown(NftId bundleNftId);
+    error ErrorBundleManagerBundleNotRegistered(NftId bundleNftId);
+
+    mapping(NftId bundleNftId => LibNftIdSet.Set policies) internal _activePolicies;
+
+    /// @dev links a policy with its bundle
+    // to link a policy it MUST NOT yet have been activated
+    // the bundle MUST be unlocked (active) for linking (underwriting) and registered with this instance
+    function linkPolicy(NftId policyNftId) external restricted() {
+        NftId bundleNftId = _instance.getInstanceReader().getPolicyInfo(policyNftId).bundleNftId;
+        // decision will likely depend on the decision what to check here and what in the service
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+
+        // ensure bundle is unlocked (in active set) and registered with this instance
+        if (!_isActive(poolNftId, bundleNftId)) {
+            revert ErrorBundleManagerErrorBundleLocked(bundleNftId, policyNftId);
+        }
+
+        LibNftIdSet.add(_activePolicies[bundleNftId], policyNftId);
+        emit LogBundleManagerPolicyLinked(bundleNftId, policyNftId);
+    }
+
+
+    /// @dev unlinks a policy from its bundle
+    // to unlink a policy it must closable, ie. meet one of the following criterias
+    // - the policy MUST be past its expiry period and it MUST NOT have any open claims
+    // - the policy's payoutAmount MUST be equal to its sumInsuredAmount and MUST NOT have any open claims
+    function unlinkPolicy(NftId policyNftId) external restricted() {
+        IPolicy.PolicyInfo memory policyInfo = _instance.getInstanceReader().getPolicyInfo(policyNftId);
+
+        NftId bundleNftId = policyInfo.bundleNftId;
+        // decision will likely depend on the decision what to check here and what in the service
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+
+        // ensure bundle is registered with this instance
+        if (!_contains(poolNftId, bundleNftId)) {
+            revert ErrorBundleManagerBundleUnknown(bundleNftId);
+        }
+
+        LibNftIdSet.remove(_activePolicies[bundleNftId], policyNftId);
+        emit LogBundleManagerPolicyUnlinked(policyInfo.bundleNftId, policyNftId);
+    }
+
+
+    /// @dev add a new bundle to a riskpool registerd with this instance
+    // the corresponding pool is fetched via instance reader
+    function add(NftId bundleNftId) external restricted() {
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+
+        // ensure pool is registered with instance
+        if(poolNftId.eqz()) {
+            revert ErrorBundleManagerBundleNotRegistered(bundleNftId);
+        }
+
+        _add(poolNftId, bundleNftId);
+        emit LogBundleManagerBundleAdded(poolNftId, bundleNftId);
+    }
+
+    /// @dev unlocked (active) bundles are available to underwrite new policies
+    function unlock(NftId bundleNftId) external restricted() {
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+        _activate(poolNftId, bundleNftId);
+        emit LogBundleManagerBundleUnlocked(poolNftId, bundleNftId);
+    }
+
+    /// @dev locked (deactivated) bundles may not underwrite any new policies
+    function lock(NftId bundleNftId) external restricted() {
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+        _deactivate(poolNftId, bundleNftId);
+        emit LogBundleManagerBundleLocked(poolNftId, bundleNftId);
+    }
+
+    function bundles(NftId poolNftId) external view returns(uint256) {
+        return _objects(poolNftId);
+    }
+
+    function getBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId bundleNftId) {
+        return _getObject(poolNftId, idx);
+    }
+
+    function activeBundles(NftId poolNftId) external view returns(uint256) {
+        return _activeObjs(poolNftId);
+    }
+
+    function getActiveBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId bundleNftId) {
+        return _getActiveObject(poolNftId, idx);
+    }
+
+    function activePolicies(NftId bundleNftId) external view returns(uint256) {
+        return LibNftIdSet.size(_activePolicies[bundleNftId]);
+    }
+
+    function getActivePolicy(NftId bundleNftId, uint256 idx) external view returns(NftId policyNftId) {
+        return LibNftIdSet.getElementAt(_activePolicies[bundleNftId], idx);
+    }
+}