@etherisc/gif-next 0.0.2-90f8ffc-398 → 0.0.2-9105e58-225

package/contracts/components/Pool.sol

@@ -5,7 +5,7 @@ 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";
@@ -16,75 +16,83 @@ import {ISetup} from "../instance/module/ISetup.sol";
 import {InstanceReader} from "../instance/InstanceReader.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;
 
-    bool internal _isConfirmingApplication;
-    UFixed internal _collateralizationLevel;
+    struct PoolStorage {
+        UFixed _collateralizationLevel;
+        UFixed _retentionLevel;
 
-    Fee internal _initialPoolFee;
-    Fee internal _initialStakingFee;
-    Fee internal _initialPerformanceFee;
+        bool _isExternallyManaged;
+        bool _isInterceptingBundleTransfers;
+        bool _isVerifyingApplications;
 
-    TokenHandler internal _tokenHandler;
+        Fee _initialPoolFee;
+        Fee _initialStakingFee;
+        Fee _initialPerformanceFee;
 
-    // may be used to interact with instance by derived contracts
-    IPoolService internal _poolService;
-    IBundleService private _bundleService;
+        TokenHandler _tokenHandler;
+
+        // 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,
+        UFixed retentionLevel,
         address initialOwner,
         bytes memory data
-    ) Component(
-        registry, 
-        instanceNftId, 
-        name, 
-        token, 
-        POOL(), 
-        isInterceptor, 
-        initialOwner, 
-        data
-    ) {
-        _isConfirmingApplication = isConfirmingApplication;
-        // TODO add validation
-        _collateralizationLevel = collateralizationLevel;
-        _initialPoolFee = poolFee;
-        _initialStakingFee = stakingFee;
-        _initialPerformanceFee = performanceFee;
-
-        _tokenHandler = new TokenHandler(token);
-
-        _poolService = getInstance().getPoolService();
-        _bundleService = getInstance().getBundleService();
+    )
+        public
+        virtual
+        onlyInitializing()
+    {
+        initializeComponent(registry, instanceNftId, name, token, POOL(), isInterceptingNftTransfers, initialOwner, data);
 
-        _registerInterface(type(IPoolComponent).interfaceId);
+        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
     )
@@ -92,19 +100,48 @@ abstract contract Pool is Component, IPoolComponent {
         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)
     {
@@ -112,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,
@@ -130,7 +159,7 @@ abstract contract Pool is Component, IPoolComponent {
         restricted()
         override
     {
-        _poolService.setFees(poolFee, stakingFee, performanceFee);
+        _getPoolStorage()._poolService.setFees(poolFee, stakingFee, performanceFee);
     }
 
     function setBundleFee(
@@ -139,17 +168,29 @@ abstract contract Pool is Component, IPoolComponent {
     )
         external
         override
-        // TODO: add onlyBundleOwner
+        // TODO add onlyBundleOwner
     {
-        _bundleService.setBundleFee(bundleNftId, fee);
+        _getPoolStorage()._bundleService.setBundleFee(bundleNftId, fee);
     }
 
-    function _lockBundle(NftId bundleNftId) internal {
-        _bundleService.lockBundle(bundleNftId);
+    function lockBundle(
+        NftId bundleNftId
+    )
+        external
+        override
+        // TODO add onlyBundleOwner
+    {
+        _getPoolStorage()._bundleService.lockBundle(bundleNftId);
     }
 
-    function _unlockBundle(NftId bundleNftId) internal {
-        _bundleService.unlockBundle(bundleNftId);
+    function unlockBundle(
+        NftId bundleNftId
+    )
+        external
+        override
+        // TODO add onlyBundleOwner
+    {
+        _getPoolStorage()._bundleService.unlockBundle(bundleNftId);
     }
 
     function getSetupInfo() public view returns (ISetup.PoolSetupInfo memory setupInfo) {
@@ -163,53 +204,51 @@ abstract contract Pool is Component, IPoolComponent {
     }
 
     function _getInitialSetupInfo() internal view returns (ISetup.PoolSetupInfo memory) {
+        PoolStorage storage $ = _getPoolStorage();
         return ISetup.PoolSetupInfo(
             getProductNftId(),
-            _tokenHandler,
-            _collateralizationLevel,
-            _initialPoolFee,
-            _initialStakingFee,
-            _initialPerformanceFee,
-            false,
-            _isConfirmingApplication,
+            $._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

@@ -4,10 +4,12 @@ pragma solidity ^0.8.19;
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {IRisk} from "../instance/module/IRisk.sol";
+import {IApplicationService} from "../instance/service/IApplicationService.sol";
 import {IPolicyService} from "../instance/service/IPolicyService.sol";
+import {IClaimService} from "../instance/service/IClaimService.sol";
 import {IProductComponent} from "./IProductComponent.sol";
 import {NftId, NftIdLib} from "../types/NftId.sol";
-import {PRODUCT} from "../types/ObjectType.sol";
+import {PRODUCT, APPLICATION, POLICY, CLAIM } from "../types/ObjectType.sol";
 import {ReferralId} from "../types/Referral.sol";
 import {RiskId, RiskIdLib} from "../types/RiskId.sol";
 import {StateId} from "../types/StateId.sol";
@@ -22,22 +24,29 @@ 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 {
+        IApplicationService _applicationService;
+        IPolicyService _policyService;
+        IClaimService _claimService;
+        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,
@@ -47,29 +56,28 @@ abstract contract Product is Component, IProductComponent {
         Fee memory processingFee,
         address initialOwner,
         bytes memory data
-    ) Component (
-        registry, 
-        instanceNftid, 
-        name, 
-        token, 
-        PRODUCT(), 
-        isInterceptor, 
-        initialOwner, 
-        data
-    ) {
-        // TODO add validation
-        _policyService = getInstance().getPolicyService(); 
-        _pool = Pool(pool);
-        _distribution = Distribution(distribution);
-        _initialProductFee = productFee;
-        _initialProcessingFee = processingFee;  
-
-        _tokenHandler = new TokenHandler(token);
-
-        _poolNftId = getRegistry().getNftId(address(_pool));
-        _distributionNftId = getRegistry().getNftId(address(_distribution));
+    )
+        public
+        virtual
+        onlyInitializing()
+    {
+        initializeComponent(registry, instanceNftId, name, token, PRODUCT(), isInterceptor, initialOwner, data);
 
-        _registerInterface(type(IProductComponent).interfaceId);  
+        ProductStorage storage $ = _getProductStorage();
+        // TODO add validation
+        // TODO refactor to go via registry
+        $._applicationService = IApplicationService(getServiceAddress(APPLICATION())); 
+        $._policyService = IPolicyService(getServiceAddress(POLICY())); 
+        $._claimService = IClaimService(getServiceAddress(CLAIM())); 
+        $._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);  
     }
 
 
@@ -86,7 +94,7 @@ abstract contract Product is Component, IProductComponent {
         override 
         returns (uint256 premiumAmount)
     {
-        (premiumAmount,,,,) = _policyService.calculatePremium(
+        (premiumAmount,,,,) = _getProductStorage()._policyService.calculatePremium(
             riskId,
             sumInsuredAmount,
             lifetime,
@@ -155,18 +163,21 @@ abstract contract Product is Component, IProductComponent {
         RiskId riskId,
         uint256 sumInsuredAmount,
         uint256 lifetime,
-        bytes memory applicationData,
         NftId bundleNftId,
-        ReferralId referralId
-    ) internal returns (NftId nftId) {
-        nftId = _policyService.createApplication(
+        ReferralId referralId,
+        bytes memory applicationData
+    )
+        internal
+        returns (NftId applicationNftId) 
+    {
+        return _getProductStorage()._applicationService.create(
             applicationOwner,
             riskId,
             sumInsuredAmount,
             lifetime,
-            applicationData,
             bundleNftId,
-            referralId
+            referralId,
+            applicationData
         );
     }
 
@@ -177,7 +188,7 @@ abstract contract Product is Component, IProductComponent {
     )
         internal
     {
-        _policyService.underwrite(
+        _getProductStorage()._policyService.underwrite(
             policyNftId, 
             requirePremiumPayment, 
             activateAt);
@@ -189,7 +200,7 @@ abstract contract Product is Component, IProductComponent {
     )
         internal
     {
-        _policyService.collectPremium(
+        _getProductStorage()._policyService.collectPremium(
             policyNftId, 
             activateAt);
     }
@@ -200,7 +211,7 @@ abstract contract Product is Component, IProductComponent {
     )
         internal
     {
-        _policyService.activate(
+        _getProductStorage()._policyService.activate(
             policyNftId, 
             activateAt);
     }
@@ -210,15 +221,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
@@ -245,17 +256,19 @@ abstract contract Product is Component, IProductComponent {
     }
 
     function _getInitialSetupInfo() internal view returns (ISetup.ProductSetupInfo memory setupInfo) {
-        ISetup.DistributionSetupInfo memory distributionSetupInfo = _distribution.getSetupInfo();
-        ISetup.PoolSetupInfo memory poolSetupInfo = _pool.getSetupInfo();
+        ProductStorage storage $ = _getProductStorage();
+
+        ISetup.DistributionSetupInfo memory distributionSetupInfo = $._distribution.getSetupInfo();
+        ISetup.PoolSetupInfo memory poolSetupInfo = $._pool.getSetupInfo();
 
         return ISetup.ProductSetupInfo(
             getToken(),
-            _tokenHandler,
-            _distributionNftId,
-            _poolNftId,
+            $._tokenHandler,
+            $._distributionNftId,
+            $._poolNftId,
             distributionSetupInfo.distributionFee, 
-            _initialProductFee,
-            _initialProcessingFee,
+            $._initialProductFee,
+            $._initialProcessingFee,
             poolSetupInfo.poolFee, 
             poolSetupInfo.stakingFee, 
             poolSetupInfo.performanceFee,
@@ -263,4 +276,10 @@ abstract contract Product is Component, IProductComponent {
             getWallet()
         );
     }
+
+    function _getProductStorage() private pure returns (ProductStorage storage $) {
+        assembly {
+            $.slot := PRODUCT_STORAGE_LOCATION_V1
+        }
+    }
 }

package/contracts/instance/IInstance.sol

@@ -19,6 +19,7 @@ import {IDistributionService} from "./service/IDistributionService.sol";
 import {InstanceAccessManager} from "./InstanceAccessManager.sol";
 import {IKeyValueStore} from "./base/IKeyValueStore.sol";
 import {IPolicy} from "./module/IPolicy.sol";
+import {IDistribution} from "./module/IDistribution.sol";
 import {IPolicyService} from "./service/IPolicyService.sol";
 import {IPoolService} from "./service/IPoolService.sol";
 import {IProductService} from "./service/IProductService.sol";
@@ -30,6 +31,7 @@ import {NftId} from "../types/NftId.sol";
 import {RiskId} from "../types/RiskId.sol";
 import {StateId} from "../types/StateId.sol";
 import {VersionPart} from "../types/Version.sol";
+import {Key32} from "../types/Key32.sol";
 
 
 
@@ -58,14 +60,32 @@ interface IInstance is IRegisterable, IKeyValueStore, IAccessManaged {
     function updateProductSetup(NftId productNftId, ISetup.ProductSetupInfo memory setup, StateId newState) external;
     function updateProductSetupState(NftId productNftId, StateId newState) external;
 
+    function createDistributorType(Key32 distributorKey, IDistribution.DistributorTypeInfo memory info) external;
+    function updateDistributorType(Key32 distributorKey, IDistribution.DistributorTypeInfo memory info, StateId newState) external;
+    function updateDistributorTypeState(Key32 distributorKey, StateId newState) external;
+
+    function createDistributor(NftId nftId, IDistribution.DistributorInfo memory info) external;
+    function updateDistributor(NftId nftId, IDistribution.DistributorInfo memory info, StateId newState) external;
+    function updateDistributorState(NftId nftId, StateId newState) external;
+
+    function createReferral(Key32 referralKey, IDistribution.ReferralInfo memory referralInfo) external;
+    function updateReferral(Key32 referralKey, IDistribution.ReferralInfo memory referralInfo, StateId newState) external;
+    function updateReferralState(Key32 referralKey, StateId newState) external;
+
     function createRisk(RiskId riskId, IRisk.RiskInfo memory risk) external;
     function updateRisk(RiskId riskId, IRisk.RiskInfo memory risk, StateId newState) external;
     function updateRiskState(RiskId riskId, StateId newState) external;
 
-    function createPolicy(NftId policyNftId, IPolicy.PolicyInfo memory policy) external;
+    function createApplication(NftId applicationNftId, IPolicy.PolicyInfo memory policy) external;
+    function updateApplication(NftId applicationNftId, IPolicy.PolicyInfo memory policy, StateId newState) external;
+    function updateApplicationState(NftId applicationNftId, StateId newState) external;
+
     function updatePolicy(NftId policyNftId, IPolicy.PolicyInfo memory policy, StateId newState) external;
     function updatePolicyState(NftId policyNftId, StateId newState) external;
 
+    // TODO add claims/payouts function to instance
+    // function updateClaims(NftId policyNftId, IPolicy.PolicyInfo memory policy, StateId newState) external;
+
     function getMajorVersion() external pure returns (VersionPart majorVersion);
     function getInstanceReader() external view returns (InstanceReader);
     function getBundleManager() external view returns (BundleManager);

package/contracts/instance/IInstanceService.sol

@@ -17,6 +17,24 @@ import {BundleManager} from "./BundleManager.sol";
 
 interface IInstanceService is IService {
 
+    error ErrorInstanceServiceMasterInstanceAlreadySet();
+    error ErrorInstanceServiceMasterInstanceAccessManagerAlreadySet();
+    error ErrorInstanceServiceMasterBundleManagerAlreadySet();
+    error ErrorInstanceServiceInstanceAddressZero();
+
+    error ErrorInstanceServiceMasterInstanceReaderNotSet();
+    error ErrorInstanceServiceInstanceReaderAddressZero();
+    error ErrorInstanceServiceInstanceReaderSameAsMasterInstanceReader();
+    error ErrorInstanceServiceInstanceReaderInstanceMismatch();
+
+    error ErrorInstanceServiceAccessManagerZero();
+    error ErrorInstanceServiceInstanceReaderZero();
+    error ErrorInstanceServiceBundleManagerZero();
+
+    error ErrorInstanceServiceInstanceAuthorityMismatch();
+    error ErrorInstanceServiceInstanceReaderInstanceMismatch2();
+    error ErrorInstanceServiceBundleMangerInstanceMismatch();
+
     error ErrorInstanceServiceRequestUnauhorized(address caller);
     error ErrorInstanceServiceNotInstanceOwner(address caller, NftId instanceNftId);
     error ErrorInstanceServiceComponentNotRegistered(address componentAddress);