@etherisc/gif-next 0.0.2-f79a517-071 → 0.0.2-f7a5beb-202

package/contracts/components/Pool.sol

@@ -1,100 +1,99 @@
 // 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} 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/treasury/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 
+{
+    // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.component.Pool.sol")) - 1)) & ~bytes32(uint256(0xff));
+    bytes32 public constant POOL_STORAGE_LOCATION_V1 = 0xecf35607b7e822969ee3625cd815bfc27031f3a93d0be2676e5bde943e2e2300;
 
-    bool internal _isVerifying;
-    UFixed internal _collateralizationLevel;
+    struct PoolStorage {
+        UFixed _collateralizationLevel;
 
-    Fee internal _initialPoolFee;
-    Fee internal _initialStakingFee;
-    Fee internal _initialPerformanceFee;
+        bool _isExternallyManaged;
+        bool _isInterceptingBundleTransfers;
+        bool _isVerifyingApplications;
 
-    // may be used to interact with instance by derived contracts
-    IPoolService internal _poolService;
+        Fee _initialPoolFee;
+        Fee _initialStakingFee;
+        Fee _initialPerformanceFee;
 
-    // only relevant to protect callback functions for "active" pools
-    IProductService private _productService;
+        TokenHandler _tokenHandler;
 
-    modifier onlyPoolService() {
-        require(
-            msg.sender == address(_poolService), 
-            "ERROR:POL-001:NOT_POOL_SERVICE");
-        _;
+        // may be used to interact with instance by derived contracts
+        IPoolService _poolService;
+        IBundleService _bundleService;
     }
 
-    modifier onlyProductService() {
-        require(
-            msg.sender == address(_productService), 
-            "ERROR:POL-002:NOT_PRODUCT_SERVICE");
+    modifier onlyPoolService() {
+        if(msg.sender != address(_getStorage()._poolService)) {
+            revert ErrorPoolNotPoolService(msg.sender);
+        }
         _;
     }
 
-    constructor(
+
+    function _initializePool(
         address registry,
         NftId instanceNftId,
+        string memory name,
         // TODO refactor into tokenNftId
         address token,
-        bool isInterceptor,
-        bool verifying,
         UFixed collateralizationLevel,
+        bool isInterceptingNftTransfers,
+        bool isExternallyManaging,
+        bool isVerifying,
         Fee memory poolFee,
         Fee memory stakingFee,
         Fee memory performanceFee,
-        address initialOwner
+        address initialOwner,
+        bytes memory data
     )
-        BaseComponent(registry, instanceNftId, token, POOL(), isInterceptor, initialOwner)
+        internal
+        //onlyInitializing//TODO uncomment when "fully" upgradeable
+        virtual
     {
-        _isVerifying = verifying;
+        _initializeComponent(registry, instanceNftId, name, token, POOL(), isInterceptingNftTransfers, initialOwner, data);
+
+        PoolStorage storage $ = _getStorage();
+
+        $._isExternallyManaged = isExternallyManaging;
+        $._isVerifyingApplications = isVerifying;
+
         // TODO add validation
-        _collateralizationLevel = collateralizationLevel;
-        _initialPoolFee = poolFee;
-        _initialStakingFee = stakingFee;
-        _initialPerformanceFee = performanceFee;
+        $._collateralizationLevel = collateralizationLevel;
+        $._initialPoolFee = poolFee;
+        $._initialStakingFee = stakingFee;
+        $._initialPerformanceFee = performanceFee;
+
+        $._tokenHandler = new TokenHandler(token);
 
-        _poolService = _instance.getPoolService();
-        _productService = _instance.getProductService();
+        $._poolService = getInstance().getPoolService();
+        $._bundleService = getInstance().getBundleService();
 
         _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
-    }
 
     /**
      * @dev see {IPool.underwrite}. 
@@ -113,31 +112,41 @@ contract Pool is BaseComponent, IPoolComponent {
         _underwrite(policyNftId, policyData, bundleFilter, collateralizationAmount);
     }
 
-    /**
-     * @dev see {IPoolComponent.policyMatchesBundle}. 
-     * Default implementation always returns true
-     */
+
+    function isInterceptingBundleTransfers() external view override returns (bool) {
+        return isNftInterceptor();
+    }
+
+
+    function isExternallyManaged() external view override returns (bool) {
+        return _getStorage()._isExternallyManaged;
+    }
+
+
+    function getCollateralizationLevel() external view override returns (UFixed collateralizationLevel) {
+        return _getStorage()._collateralizationLevel;
+    }
+
+
+    function isVerifyingApplications() external view override returns (bool isConfirmingApplication) {
+        return _getStorage()._isVerifyingApplications;
+    }
+
+
+    /// @dev see {IPoolComponent.policyMatchesBundle}. 
+    /// Default implementation always returns true
     function policyMatchesBundle(
         bytes memory, // policyData
         bytes memory // bundleFilter
     )
         public
-        view
+        pure
         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,
@@ -147,7 +156,7 @@ contract Pool is BaseComponent, IPoolComponent {
         onlyOwner
         override
     {
-        _poolService.setFees(poolFee, stakingFee, performanceFee);
+        _getStorage()._poolService.setFees(poolFee, stakingFee, performanceFee);
     }
 
     function setBundleFee(
@@ -158,52 +167,51 @@ contract Pool is BaseComponent, IPoolComponent {
         override
         // TODO add onlyBundleOwner
     {
-        _poolService.setBundleFee(bundleNftId, fee);
+        _getStorage()._bundleService.setBundleFee(bundleNftId, fee);
     }
-    // TODO delete, call instance instead
-    function getFees()
+
+    function lockBundle(
+        NftId bundleNftId
+    )
         external
-        view
         override
-        returns (Fee memory, Fee memory, Fee memory)
+        // TODO add onlyBundleOwner
     {
-        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);
-        //}
+        _getStorage()._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, 
-            bytes memory data
-        ) = super.getInitialInfo();
-
-        return (
-            info,
-            abi.encode(
-                IPool.PoolInfo(
-                    _isVerifying,
-                    _collateralizationLevel
-                ),
-                _wallet,
-                _token,
-                _initialPoolFee,
-                _initialStakingFee,
-                _initialPerformanceFee
-            )
+        _getStorage()._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) {
+        PoolStorage storage $ = _getStorage();
+        return ISetup.PoolSetupInfo(
+            getProductNftId(),
+            $._tokenHandler,
+            $._collateralizationLevel,
+            $._initialPoolFee,
+            $._initialStakingFee,
+            $._initialPerformanceFee,
+            isNftInterceptor(),
+            $._isVerifyingApplications,
+            getWallet()
         );
     }
 
@@ -230,17 +238,30 @@ contract Pool is BaseComponent, IPoolComponent {
         Fee memory fee,
         uint256 amount,
         uint256 lifetime, 
-        bytes calldata filter
+        bytes memory filter
     )
         internal
         returns(NftId bundleNftId)
     {
-        bundleNftId = _poolService.createBundle(
+        bundleNftId = _getStorage()._bundleService.createBundle(
             bundleOwner,
             fee,
             amount,
             lifetime,
-            filter
-        );
+            filter);
+
+        // TODO add logging
+    }
+
+    function getContractLocation(bytes memory name) external pure returns (bytes32 hash) {
+        return keccak256(abi.encode(uint256(keccak256(name)) - 1)) & ~bytes32(uint256(0xff));
     }
+
+
+    function _getStorage() private pure returns (PoolStorage storage $) {
+        assembly {
+            $.slot := POOL_STORAGE_LOCATION_V1
+        }
+    }
+
 }

package/contracts/components/Product.sol

@@ -3,56 +3,69 @@ pragma solidity ^0.8.19;
 
 import {IERC20Metadata} from "@openzeppelin/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 {IRisk} from "../instance/module/IRisk.sol";
+import {IPolicyService} from "../instance/service/IPolicyService.sol";
 import {IProductComponent} from "./IProductComponent.sol";
-import {NftId, zeroNftId} from "../types/NftId.sol";
-import {ObjectType, PRODUCT} from "../types/ObjectType.sol";
-import {ReferralId} from "../types/ReferralId.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 {IPool} from "../instance/module/pool/IPoolModule.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";
 
-contract Product is BaseComponent, IProductComponent {
-    IProductService internal _productService;
+abstract contract Product is
+    Component, 
+    IProductComponent
+{
+    IPolicyService internal _policyService;
     Pool internal _pool;
-    address internal _distribution;
+    Distribution internal _distribution;
     Fee internal _initialProductFee;
     Fee internal _initialProcessingFee;
+    TokenHandler internal _tokenHandler;
 
     NftId internal _poolNftId;
     NftId internal _distributionNftId;
 
     constructor(
         address registry,
-        NftId instanceNftid,
+        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
+    )
+    {
+        _initializeComponent(registry, instanceNftId, name, token, PRODUCT(), isInterceptor, initialOwner, data);
+
         // TODO add validation
-        _productService = _instance.getProductService();
+        _policyService = getInstance().getPolicyService(); 
         _pool = Pool(pool);
-        _distribution = distribution;
+        _distribution = Distribution(distribution);
         _initialProductFee = productFee;
         _initialProcessingFee = processingFee;  
 
+        _tokenHandler = new TokenHandler(token);
+
         _poolNftId = getRegistry().getNftId(address(_pool));
-        _distributionNftId = getRegistry().getNftId(_distribution);
+        _distributionNftId = getRegistry().getNftId(address(_distribution));
 
         _registerInterface(type(IProductComponent).interfaceId);  
     }
@@ -63,15 +76,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,
@@ -105,19 +118,19 @@ contract Product is BaseComponent, IProductComponent {
         RiskId id,
         bytes memory data
     ) internal {
-        _productService.createRisk(
+        getProductService().createRisk(
             id,
             data
         );
     }
 
-    function _setRiskInfo(
+    function _updateRisk(
         RiskId id,
-        IRisk.RiskInfo memory info
+        bytes memory data
     ) internal {
-        _productService.setRiskInfo(
+        getProductService().updateRisk(
             id,
-            info
+            data
         );
     }
 
@@ -125,14 +138,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.getRiskInfo(id);
+        return getInstance().getInstanceReader().getRiskInfo(id);
     }
 
     function _createApplication(
@@ -144,7 +157,7 @@ contract Product is BaseComponent, IProductComponent {
         NftId bundleNftId,
         ReferralId referralId
     ) internal returns (NftId nftId) {
-        nftId = _productService.createApplication(
+        nftId = _policyService.createApplication(
             applicationOwner,
             riskId,
             sumInsuredAmount,
@@ -162,7 +175,7 @@ contract Product is BaseComponent, IProductComponent {
     )
         internal
     {
-        _productService.underwrite(
+        _policyService.underwrite(
             policyNftId, 
             requirePremiumPayment, 
             activateAt);
@@ -174,7 +187,7 @@ contract Product is BaseComponent, IProductComponent {
     )
         internal
     {
-        _productService.collectPremium(
+        _policyService.collectPremium(
             policyNftId, 
             activateAt);
     }
@@ -185,17 +198,25 @@ 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));
     }
 
     function getDistributionNftId() external view override returns (NftId distributionNftId) {
-        return getRegistry().getNftId(_distribution);
+        return getRegistry().getNftId(address(_distribution));
     }
 
     // from product component
@@ -207,93 +228,36 @@ contract Product is BaseComponent, IProductComponent {
         onlyOwner
         override
     {
-        _productService.setFees(productFee, processingFee);
+        getProductService().setFees(productFee, processingFee);
     }
 
-    // TODO delete, call instance intead
-    function getProductFee()
-        external
-        view
-        override
-        returns (Fee memory productFee)
-    {
-        NftId productNftId = getNftId();
-        if (_instance.hasTreasuryInfo(productNftId)) {
-            return _instance.getTreasuryInfo(productNftId).productFee;
-        } else {
-            return _initialProductFee;
-        }
-    }
+    function getSetupInfo() public view returns (ISetup.ProductSetupInfo memory setupInfo) {
+        InstanceReader reader = getInstance().getInstanceReader();
+        setupInfo = reader.getProductSetupInfo(getNftId());
 
-    function getProcessingFee()
-        external
-        view
-        override
-        returns (Fee memory processingFee)
-    {
-        NftId productNftId = getNftId();
-        if (_instance.hasTreasuryInfo(productNftId)) {
-            return _instance.getTreasuryInfo(productNftId).processingFee;
-        } else {
-            return _initialProcessingFee;
+        // fallback to initial setup info (wallet is always != address(0))
+        if(setupInfo.wallet == address(0)) {
+            setupInfo = _getInitialSetupInfo();
         }
     }
 
-    // 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();
-
-        (
-            /*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
-            )
+    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()
         );
     }
 }