@etherisc/gif-next 0.0.2-2a0a7d0-893 → 0.0.2-2a59cd5-352

package/contracts/components/Pool.sol

@@ -5,124 +5,143 @@ 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 {Fee, FeeLib} 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 {IRegistry} from "../registry/IRegistry.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";
 
-abstract contract Pool is Component, IPoolComponent {
-    using NftIdLib for NftId;
+abstract contract Pool is
+    Component, 
+    IPoolComponent 
+{
+    // keccak256(abi.encode(uint256(keccak256("etherisc.storage.Pool")) - 1)) & ~bytes32(uint256(0xff));
+    bytes32 public constant POOL_STORAGE_LOCATION_V1 = 0x25e3e51823fbfffb988e0a2744bb93722d9f3e906c07cc0a9e77884c46c58300;
+
+    struct PoolStorage {
+        UFixed _collateralizationLevel;
+        UFixed _retentionLevel;
 
-    bool internal _isConfirmingApplication;
-    UFixed internal _collateralizationLevel;
+        bool _isExternallyManaged;
+        bool _isInterceptingBundleTransfers;
+        bool _isVerifyingApplications;
 
-    Fee internal _initialPoolFee;
-    Fee internal _initialStakingFee;
-    Fee internal _initialPerformanceFee;
+        Fee _initialPoolFee;
+        Fee _initialStakingFee;
+        Fee _initialPerformanceFee;
 
-    TokenHandler internal _tokenHandler;
+        TokenHandler _tokenHandler;
 
-    // may be used to interact with instance by derived contracts
-    IPoolService internal _poolService;
-    IBundleService private _bundleService;
+        // may be used to interact with instance by derived contracts
+        IPoolService _poolService;
+        IBundleService _bundleService;
+    }
 
     modifier onlyPoolService() {
-        require(
-            msg.sender == address(_poolService), 
-            "ERROR:POL-001:NOT_POOL_SERVICE");
+        if(msg.sender != address(_getPoolStorage()._poolService)) {
+            revert ErrorPoolNotPoolService(msg.sender);
+        }
         _;
     }
 
-    constructor(
+
+    function initializePool(
         address registry,
         NftId instanceNftId,
+        string memory name,
         // TODO refactor into tokenNftId
         address token,
-        bool isInterceptor,
-        bool isConfirmingApplication,
+        bool isInterceptingNftTransfers,
+        bool isExternallyManaging,
+        bool isVerifying,
         UFixed collateralizationLevel,
-        Fee memory poolFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee,
-        address initialOwner
+        UFixed retentionLevel,
+        address initialOwner,
+        bytes memory data
     )
-        Component(registry, instanceNftId, token, POOL(), isInterceptor, initialOwner)
-    {
-        _isConfirmingApplication = isConfirmingApplication;
-        // TODO add validation
-        _collateralizationLevel = collateralizationLevel;
-        _initialPoolFee = poolFee;
-        _initialStakingFee = stakingFee;
-        _initialPerformanceFee = performanceFee;
-
-        _tokenHandler = new TokenHandler(token);
-
-        _poolService = _instance.getPoolService();
-        // _productService = _instance.getProductService();
-        _bundleService = _instance.getBundleService();
-
-        _registerInterface(type(IPoolComponent).interfaceId);
-    }
-
-    function createBundle(
-        Fee memory fee,
-        uint256 initialAmount,
-        uint256 lifetime,
-        bytes memory filter
-    )
-        external
-        virtual override
-        returns(NftId bundleNftId)
+        public
+        virtual
+        onlyInitializing()
     {
-        address owner = msg.sender;
-        bundleNftId = _bundleService.createBundle(
-            owner,
-            fee,
-            initialAmount,
-            lifetime,
-            filter
-        );
+        initializeComponent(registry, instanceNftId, name, token, POOL(), isInterceptingNftTransfers, initialOwner, data);
 
-        // TODO add logging
+        PoolStorage storage $ = _getPoolStorage();
+        // TODO add validation
+        $._tokenHandler = new TokenHandler(token);
+        $._isExternallyManaged = isExternallyManaging;
+        $._isVerifyingApplications = isVerifying;
+        $._collateralizationLevel = collateralizationLevel;
+        $._retentionLevel = retentionLevel;
+        $._initialPoolFee = FeeLib.zeroFee();
+        $._initialStakingFee = FeeLib.zeroFee();
+        $._initialPerformanceFee = FeeLib.zeroFee();
+        $._poolService = getInstance().getPoolService();
+        $._bundleService = getInstance().getBundleService();
+
+        registerInterface(type(IPoolComponent).interfaceId);
     }
 
     /**
-     * @dev see {IPool.underwrite}. 
+     * @dev see {IPool.verifyApplication}. 
      * Default implementation that only writes a {LogUnderwrittenByPool} entry.
      */
-    function underwrite(
-        NftId policyNftId, 
-        bytes memory policyData,
+    function verifyApplication(
+        NftId applicationNftId, 
+        bytes memory applicationData,
         bytes memory bundleFilter,
         uint256 collateralizationAmount
     )
         external
-        onlyProductService
+        restricted()
         virtual override 
     {
-        _underwrite(policyNftId, policyData, bundleFilter, collateralizationAmount);
+        require(
+            policyMatchesBundle(applicationData, bundleFilter),
+            "ERROR:POL-020:POLICY_BUNDLE_MISMATCH"
+        );
+
+        emit LogUnderwrittenByPool(applicationNftId, collateralizationAmount, address(this));
     }
 
-    /**
-     * @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 _getPoolStorage()._isExternallyManaged;
+    }
+
+
+    function getRetentionLevel() external view override returns (UFixed retentionLevel) {
+        return _getPoolStorage()._retentionLevel;
+    }
+
+
+    function getCollateralizationLevel() external view override returns (UFixed collateralizationLevel) {
+        return _getPoolStorage()._collateralizationLevel;
+    }
+
+
+    function isVerifyingApplications() external view override returns (bool isConfirmingApplication) {
+        return _getPoolStorage()._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)
     {
@@ -130,14 +149,6 @@ abstract contract Pool is Component, IPoolComponent {
     }
 
 
-    function isConfirmingApplication() external view override returns (bool isConfirmingApplication) {
-        return _isConfirmingApplication;
-    }
-
-    function getCollateralizationLevel() external view override returns (UFixed collateralizationLevel) {
-        return _collateralizationLevel;
-    }
-
     function setFees(
         Fee memory poolFee,
         Fee memory stakingFee,
@@ -145,9 +156,10 @@ abstract contract Pool is Component, IPoolComponent {
     )
         external
         onlyOwner
+        restricted()
         override
     {
-        _poolService.setFees(poolFee, stakingFee, performanceFee);
+        _getPoolStorage()._poolService.setFees(poolFee, stakingFee, performanceFee);
     }
 
     function setBundleFee(
@@ -158,7 +170,7 @@ abstract contract Pool is Component, IPoolComponent {
         override
         // TODO add onlyBundleOwner
     {
-        _bundleService.setBundleFee(bundleNftId, fee);
+        _getPoolStorage()._bundleService.setBundleFee(bundleNftId, fee);
     }
 
     function lockBundle(
@@ -168,7 +180,7 @@ abstract contract Pool is Component, IPoolComponent {
         override
         // TODO add onlyBundleOwner
     {
-        _bundleService.lockBundle(bundleNftId);
+        _getPoolStorage()._bundleService.lockBundle(bundleNftId);
     }
 
     function unlockBundle(
@@ -178,81 +190,65 @@ abstract contract Pool is Component, IPoolComponent {
         override
         // TODO add onlyBundleOwner
     {
-        _bundleService.unlockBundle(bundleNftId);
+        _getPoolStorage()._bundleService.unlockBundle(bundleNftId);
     }
 
     function getSetupInfo() public view returns (ISetup.PoolSetupInfo memory setupInfo) {
-        InstanceReader reader = _instance.getInstanceReader();
-        return reader.getPoolSetupInfo(getNftId());
-    }
+        InstanceReader reader = getInstance().getInstanceReader();
+        setupInfo = reader.getPoolSetupInfo(getNftId());
 
-    // from IRegisterable
+        // fallback to initial setup info (wallet is always != address(0))
+        if(setupInfo.wallet == address(0)) {
+            setupInfo = _getInitialSetupInfo();
+        }
+    }
 
-    // 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, 
-        ) = super.getInitialInfo();
-
-        return (
-            info,
-            abi.encode(
-                getName(),
-                ISetup.PoolSetupInfo(
-                    _productNftId,
-                    _tokenHandler,
-                    _collateralizationLevel,
-                    _initialPoolFee,
-                    _initialStakingFee,
-                    _initialPerformanceFee,
-                    false,
-                    _isConfirmingApplication,
-                    _wallet
-                )
-            )
+    function _getInitialSetupInfo() internal view returns (ISetup.PoolSetupInfo memory) {
+        PoolStorage storage $ = _getPoolStorage();
+        return ISetup.PoolSetupInfo(
+            getProductNftId(),
+            $._tokenHandler,
+            isNftInterceptor(),
+            $._isExternallyManaged,
+            $._isVerifyingApplications,
+            $._collateralizationLevel,
+            $._retentionLevel,
+            $._initialPoolFee,
+            $._initialStakingFee,
+            $._initialPerformanceFee,
+            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
+        bytes memory filter
     )
         internal
         returns(NftId bundleNftId)
     {
-        bundleNftId = _bundleService.createBundle(
+        bundleNftId = _getPoolStorage()._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 _getPoolStorage() private pure returns (PoolStorage storage $) {
+        assembly {
+            $.slot := POOL_STORAGE_LOCATION_V1
+        }
     }
 }

package/contracts/components/Product.sol

@@ -15,9 +15,6 @@ import {Timestamp} from "../types/Timestamp.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";
@@ -25,43 +22,55 @@ 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;
-
-    NftId internal _poolNftId;
-    NftId internal _distributionNftId;
+abstract contract Product is
+    Component, 
+    IProductComponent
+{
+    // keccak256(abi.encode(uint256(keccak256("etherisc.storage.Product")) - 1)) & ~bytes32(uint256(0xff));
+    bytes32 public constant PRODUCT_STORAGE_LOCATION_V1 = 0x0bb7aafdb8e380f81267337bc5b5dfdf76e6d3a380ecadb51ec665246d9d6800;
+
+    struct ProductStorage {
+        IPolicyService _policyService;
+        Pool _pool;
+        Distribution _distribution;
+        Fee _initialProductFee;
+        Fee _initialProcessingFee;
+        TokenHandler _tokenHandler;
+        NftId _poolNftId;
+        NftId _distributionNftId;
+    }
 
-    constructor(
+    function initializeProduct(
         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
-    ) Component(registry, instanceNftid, token, PRODUCT(), isInterceptor, initialOwner) {
-        // TODO add validation
-        _policyService = _instance.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));
+        address initialOwner,
+        bytes memory data
+    )
+        public
+        virtual
+        onlyInitializing()
+    {
+        initializeComponent(registry, instanceNftId, name, token, PRODUCT(), isInterceptor, initialOwner, data);
 
-        _registerInterface(type(IProductComponent).interfaceId);  
+        ProductStorage storage $ = _getProductStorage();
+        // TODO add validation
+        $._policyService = getInstance().getPolicyService(); 
+        $._pool = Pool(pool);
+        $._distribution = Distribution(distribution);
+        $._initialProductFee = productFee;
+        $._initialProcessingFee = processingFee;  
+        $._tokenHandler = new TokenHandler(token);
+        $._poolNftId = getRegistry().getNftId(pool);
+        $._distributionNftId = getRegistry().getNftId(distribution);
+
+        registerInterface(type(IProductComponent).interfaceId);  
     }
 
 
@@ -78,7 +87,7 @@ abstract contract Product is Component, IProductComponent {
         override 
         returns (uint256 premiumAmount)
     {
-        (premiumAmount,,,,) = _policyService.calculatePremium(
+        (premiumAmount,,,,) = _getProductStorage()._policyService.calculatePremium(
             riskId,
             sumInsuredAmount,
             lifetime,
@@ -112,7 +121,7 @@ abstract contract Product is Component, IProductComponent {
         RiskId id,
         bytes memory data
     ) internal {
-        _productService.createRisk(
+        getProductService().createRisk(
             id,
             data
         );
@@ -122,7 +131,7 @@ abstract contract Product is Component, IProductComponent {
         RiskId id,
         bytes memory data
     ) internal {
-        _productService.updateRisk(
+        getProductService().updateRisk(
             id,
             data
         );
@@ -132,14 +141,14 @@ abstract contract Product is Component, 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(
@@ -150,8 +159,11 @@ abstract contract Product is Component, IProductComponent {
         bytes memory applicationData,
         NftId bundleNftId,
         ReferralId referralId
-    ) internal returns (NftId nftId) {
-        nftId = _policyService.createApplication(
+    )
+        internal
+        returns (NftId nftId) 
+    {
+        return _getProductStorage()._policyService.createApplication(
             applicationOwner,
             riskId,
             sumInsuredAmount,
@@ -169,7 +181,7 @@ abstract contract Product is Component, IProductComponent {
     )
         internal
     {
-        _policyService.underwrite(
+        _getProductStorage()._policyService.underwrite(
             policyNftId, 
             requirePremiumPayment, 
             activateAt);
@@ -181,7 +193,7 @@ abstract contract Product is Component, IProductComponent {
     )
         internal
     {
-        _policyService.collectPremium(
+        _getProductStorage()._policyService.collectPremium(
             policyNftId, 
             activateAt);
     }
@@ -192,7 +204,7 @@ abstract contract Product is Component, IProductComponent {
     )
         internal
     {
-        _policyService.activate(
+        _getProductStorage()._policyService.activate(
             policyNftId, 
             activateAt);
     }
@@ -202,15 +214,15 @@ abstract contract Product is Component, IProductComponent {
     )
         internal
     {
-        _policyService.close(policyNftId);
+        _getProductStorage()._policyService.close(policyNftId);
     }
 
     function getPoolNftId() external view override returns (NftId poolNftId) {
-        return getRegistry().getNftId(address(_pool));
+        return getRegistry().getNftId(address(_getProductStorage()._pool));
     }
 
     function getDistributionNftId() external view override returns (NftId distributionNftId) {
-        return getRegistry().getNftId(address(_distribution));
+        return getRegistry().getNftId(address(_getProductStorage()._distribution));
     }
 
     // from product component
@@ -220,76 +232,47 @@ abstract contract Product is Component, IProductComponent {
     )
         external
         onlyOwner
+        restricted()
         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, (string, ISetup.PoolSetupInfo));
-
-        // from DistributionComponent
-        (
-            , 
-            bytes memory distributionData
-        ) = _distribution.getInitialInfo();
-
-        (
-            , ISetup.DistributionSetupInfo memory distributionSetupInfo
-        )  = abi.decode(distributionData, (string, ISetup.DistributionSetupInfo));
-
-        return (
-            productInfo,
-            abi.encode(
-                getName(),
-                ISetup.ProductSetupInfo(
-                    _token,
-                    _tokenHandler,
-                    _distributionNftId,
-                    _poolNftId,
-                    distributionSetupInfo.distributionFee, 
-                    _initialProductFee,
-                    _initialProcessingFee,
-                    poolSetupInfo.poolFee, 
-                    poolSetupInfo.stakingFee, 
-                    poolSetupInfo.performanceFee,
-                    false,
-                    _wallet
-                )
-            )
+    function _getInitialSetupInfo() internal view returns (ISetup.ProductSetupInfo memory setupInfo) {
+        ProductStorage storage $ = _getProductStorage();
+
+        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()
         );
     }
+
+    function _getProductStorage() private pure returns (ProductStorage storage $) {
+        assembly {
+            $.slot := PRODUCT_STORAGE_LOCATION_V1
+        }
+    }
 }