@etherisc/gif-next 0.0.2-93de5de-423 → 0.0.2-94237b7-984

package/contracts/components/Pool.sol

@@ -1,20 +1,20 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-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 {Amount, AmountLib} from "../types/Amount.sol";
+import {Component} from "./Component.sol";
 import {Fee, FeeLib} from "../types/Fee.sol";
-import {UFixed} from "../types/UFixed.sol";
+import {IBundleService} from "../instance/service/IBundleService.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IPoolComponent} from "./IPoolComponent.sol";
-import {Component} from "./Component.sol";
+import {IPoolService} from "../instance/service/IPoolService.sol";
+import {IComponents} from "../instance/module/IComponents.sol";
+import {NftId, NftIdLib} from "../types/NftId.sol";
+import {POOL} from "../types/ObjectType.sol";
+import {RoleId, PUBLIC_ROLE} from "../types/RoleId.sol";
+import {Seconds} from "../types/Seconds.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
-
-import {ISetup} from "../instance/module/ISetup.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
-
+import {UFixed, UFixedLib} from "../types/UFixed.sol";
 
 abstract contract Pool is
     Component, 
@@ -24,24 +24,19 @@ abstract contract Pool is
     bytes32 public constant POOL_STORAGE_LOCATION_V1 = 0x25e3e51823fbfffb988e0a2744bb93722d9f3e906c07cc0a9e77884c46c58300;
 
     struct PoolStorage {
-        UFixed _collateralizationLevel;
-        UFixed _retentionLevel;
-
-        bool _isExternallyManaged;
-        bool _isInterceptingBundleTransfers;
-        bool _isVerifyingApplications;
-
-        Fee _initialPoolFee;
-        Fee _initialStakingFee;
-        Fee _initialPerformanceFee;
-
-        TokenHandler _tokenHandler;
-
-        // may be used to interact with instance by derived contracts
         IPoolService _poolService;
         IBundleService _bundleService;
     }
 
+
+    modifier onlyBundleOwner(NftId bundleNftId) {
+        if(msg.sender != getRegistry().ownerOf(bundleNftId)) {
+            revert ErrorPoolNotBundleOwner(bundleNftId, msg.sender);
+        }
+        _;
+    }
+
+
     modifier onlyPoolService() {
         if(msg.sender != address(_getPoolStorage()._poolService)) {
             revert ErrorPoolNotPoolService(msg.sender);
@@ -54,98 +49,124 @@ abstract contract Pool is
         address registry,
         NftId instanceNftId,
         string memory name,
-        // TODO refactor into tokenNftId
         address token,
         bool isInterceptingNftTransfers,
-        bool isExternallyManaging,
-        bool isVerifying,
-        UFixed collateralizationLevel,
-        UFixed retentionLevel,
         address initialOwner,
-        bytes memory data
+        bytes memory registryData // writeonly data that will saved in the object info record of the registry
     )
         public
         virtual
         onlyInitializing()
     {
-        initializeComponent(registry, instanceNftId, name, token, POOL(), isInterceptingNftTransfers, initialOwner, data);
+        initializeComponent(registry, instanceNftId, name, token, POOL(), isInterceptingNftTransfers, initialOwner, registryData);
 
         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.verifyApplication}. 
-     * Default implementation that only writes a {LogUnderwrittenByPool} entry.
-     */
-    function verifyApplication(
-        NftId applicationNftId, 
-        bytes memory applicationData,
-        bytes memory bundleFilter,
-        uint256 collateralizationAmount
+
+    function stake(
+        NftId bundleNftId, 
+        uint256 amount
     )
-        external
+        public
+        virtual
         restricted()
-        virtual override 
+        onlyBundleOwner(bundleNftId)
     {
-        require(
-            policyMatchesBundle(applicationData, bundleFilter),
-            "ERROR:POL-020:POLICY_BUNDLE_MISMATCH"
-        );
-
-        emit LogUnderwrittenByPool(applicationNftId, collateralizationAmount, address(this));
+        // TODO add implementation
     }
 
 
-    function isInterceptingBundleTransfers() external view override returns (bool) {
-        return isNftInterceptor();
+    function unstake(
+        NftId bundleNftId, 
+        uint256 amount
+    )
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
+    {
+        // TODO add implementation
     }
 
 
-    function isExternallyManaged() external view override returns (bool) {
-        return _getPoolStorage()._isExternallyManaged;
+    function extend(
+        NftId bundleNftId, 
+        Seconds lifetimeExtension
+    )
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
+    {
+        // TODO add implementation
     }
 
 
-    function getRetentionLevel() external view override returns (UFixed retentionLevel) {
-        return _getPoolStorage()._retentionLevel;
+    function lockBundle(NftId bundleNftId)
+        public
+        virtual
+        //restricted() // TODO consider adding this back
+        onlyBundleOwner(bundleNftId)
+    {
+        _getPoolStorage()._bundleService.lock(bundleNftId);
     }
 
 
-    function getCollateralizationLevel() external view override returns (UFixed collateralizationLevel) {
-        return _getPoolStorage()._collateralizationLevel;
+    function unlockBundle(NftId bundleNftId)
+        public
+        virtual
+        //restricted()
+        onlyBundleOwner(bundleNftId)
+    {
+        _getPoolStorage()._bundleService.unlock(bundleNftId);
     }
 
 
-    function isVerifyingApplications() external view override returns (bool isConfirmingApplication) {
-        return _getPoolStorage()._isVerifyingApplications;
+    function close(NftId bundleNftId)
+        public
+        virtual
+        //restricted()
+        onlyBundleOwner(bundleNftId)
+    {
+        _getPoolStorage()._poolService.closeBundle(bundleNftId);
     }
 
 
-    /// @dev see {IPoolComponent.policyMatchesBundle}. 
-    /// Default implementation always returns true
-    function policyMatchesBundle(
-        bytes memory, // policyData
-        bytes memory // bundleFilter
+    function setBundleFee(
+        NftId bundleNftId, 
+        Fee memory fee
     )
         public
-        pure
-        virtual override
-        returns (bool isMatching)
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
     {
-        return true;
+        _getPoolStorage()._bundleService.setFee(bundleNftId, fee);
+    }
+
+
+    function setMaxCapitalAmount(uint256 maxCapitalAmount)
+        public
+        virtual
+        restricted()
+        onlyOwner()
+    {
+        _getPoolStorage()._poolService.setMaxCapitalAmount(maxCapitalAmount);
+    }
+
+
+    function setBundleOwnerRole(RoleId bundleOwnerRole)
+        public
+        virtual
+        restricted()
+        onlyOwner()
+    {
+        _getPoolStorage()._poolService.setBundleOwnerRole(bundleOwnerRole);
     }
 
 
@@ -154,70 +175,63 @@ abstract contract Pool is
         Fee memory stakingFee,
         Fee memory performanceFee
     )
-        external
-        onlyOwner
+        public
+        virtual
         restricted()
-        override
+        onlyOwner()
     {
         _getPoolStorage()._poolService.setFees(poolFee, stakingFee, performanceFee);
     }
 
-    function setBundleFee(
+
+    /// @dev see {IPool.verifyApplication}
+    function verifyApplication(
+        NftId applicationNftId, 
+        bytes memory applicationData,
         NftId bundleNftId, 
-        Fee memory fee
+        bytes memory bundleFilter,
+        uint256 collateralizationAmount
     )
-        external
-        override
-        // TODO add onlyBundleOwner
+        public
+        virtual
+        restricted()
     {
-        _getPoolStorage()._bundleService.setBundleFee(bundleNftId, fee);
-    }
+        if(!applicationMatchesBundle(
+            applicationNftId,
+            applicationData, 
+            bundleNftId, 
+            bundleFilter,
+            collateralizationAmount)
+        )
+        {
+            revert ErrorPoolApplicationBundleMismatch(applicationNftId);
+        }
 
-    function lockBundle(
-        NftId bundleNftId
-    )
-        external
-        override
-        // TODO add onlyBundleOwner
-    {
-        _getPoolStorage()._bundleService.lockBundle(bundleNftId);
+        emit LogPoolVerifiedByPool(address(this), applicationNftId, collateralizationAmount);
     }
 
-    function unlockBundle(
-        NftId bundleNftId
+
+    /// @dev see {IPoolComponent.applicationMatchesBundle}
+    /// Override this function to implement any custom application verification 
+    /// Default implementation always returns true
+    function applicationMatchesBundle(
+        NftId applicationNftId, 
+        bytes memory applicationData,
+        NftId bundleNftId, 
+        bytes memory bundleFilter,
+        uint256 collateralizationAmount
     )
-        external
-        override
-        // TODO add onlyBundleOwner
+        public
+        view
+        virtual override
+        returns (bool isMatching)
     {
-        _getPoolStorage()._bundleService.unlockBundle(bundleNftId);
+        return true;
     }
 
-    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 $ = _getPoolStorage();
-        return ISetup.PoolSetupInfo(
-            getProductNftId(),
-            $._tokenHandler,
-            isNftInterceptor(),
-            $._isExternallyManaged,
-            $._isVerifyingApplications,
-            $._collateralizationLevel,
-            $._retentionLevel,
-            $._initialPoolFee,
-            $._initialStakingFee,
-            $._initialPerformanceFee,
-            getWallet()
-        );
+    function getPoolInfo() external view returns (IComponents.PoolInfo memory poolInfo) {
+        poolInfo = abi.decode(getComponentInfo().data, (IComponents.PoolInfo));
     }
 
     // Internals
@@ -225,14 +239,14 @@ abstract contract Pool is
     function _createBundle(
         address bundleOwner,
         Fee memory fee,
-        uint256 amount,
-        uint256 lifetime, 
+        Amount amount,
+        Seconds lifetime, 
         bytes memory filter
     )
         internal
         returns(NftId bundleNftId)
     {
-        bundleNftId = _getPoolStorage()._bundleService.createBundle(
+        bundleNftId = _getPoolStorage()._poolService.createBundle(
             bundleOwner,
             fee,
             amount,
@@ -242,10 +256,45 @@ abstract contract Pool is
         // TODO add logging
     }
 
+    // TODO remove function once this is no longer used to produce contract locations on the fly ...
     function getContractLocation(bytes memory name) external pure returns (bytes32 hash) {
         return keccak256(abi.encode(uint256(keccak256(name)) - 1)) & ~bytes32(uint256(0xff));
     }
 
+    /// @dev defines initial pool specification
+    /// overwrite this function according to your use case
+    function _getInitialInfo()
+        internal
+        view 
+        virtual override
+        returns (IComponents.ComponentInfo memory info)
+    {
+        return IComponents.ComponentInfo(
+            getName(),
+            getToken(),
+            TokenHandler(address(0)), // will be created by GIF service during registration
+            address(this), // contract is its own wallet
+            AmountLib.zero(), // balance amount
+            AmountLib.zero(), // fee amount
+            abi.encode(
+                IComponents.PoolInfo(
+                    NftIdLib.zero(), // will be set when GIF registers the related product
+                    PUBLIC_ROLE(), // bundleOwnerRole
+                    type(uint256).max, // maxCapitalAmount,
+                    0, // initial balance amount
+                    0, // initial fee amount
+                    isNftInterceptor(), // isInterceptingBundleTransfers
+                    false, // isExternallyManaged,
+                    false, // isVerifyingApplications,
+                    UFixedLib.toUFixed(1), // collateralizationLevel,
+                    UFixedLib.toUFixed(1), // retentionLevel,
+                    FeeLib.zeroFee(), // initialPoolFee,
+                    FeeLib.zeroFee(), // initialStakingFee,
+                    FeeLib.zeroFee() // initialPerformanceFee,
+                )));
+    }
+
+
     function _getPoolStorage() private pure returns (PoolStorage storage $) {
         assembly {
             $.slot := POOL_STORAGE_LOCATION_V1

package/contracts/components/Product.sol

@@ -6,12 +6,14 @@ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IER
 import {IRisk} from "../instance/module/IRisk.sol";
 import {IApplicationService} from "../instance/service/IApplicationService.sol";
 import {IPolicyService} from "../instance/service/IPolicyService.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
 import {IClaimService} from "../instance/service/IClaimService.sol";
 import {IProductComponent} from "./IProductComponent.sol";
 import {NftId, NftIdLib} from "../types/NftId.sol";
 import {PRODUCT, APPLICATION, POLICY, CLAIM } from "../types/ObjectType.sol";
 import {ReferralId} from "../types/Referral.sol";
 import {RiskId, RiskIdLib} from "../types/RiskId.sol";
+import {Seconds} from "../types/Seconds.sol";
 import {StateId} from "../types/StateId.sol";
 import {Timestamp} from "../types/Timestamp.sol";
 import {Fee} from "../types/Fee.sol";
@@ -20,7 +22,9 @@ import {Component} from "./Component.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 
 import {InstanceReader} from "../instance/InstanceReader.sol";
+import {IPolicy} from "../instance/module/IPolicy.sol";
 import {ISetup} from "../instance/module/ISetup.sol";
+import {IComponents} from "../instance/module/IComponents.sol";
 import {Pool} from "../components/Pool.sol";
 import {Distribution} from "../components/Distribution.sol";
 
@@ -32,6 +36,7 @@ abstract contract Product is
     bytes32 public constant PRODUCT_STORAGE_LOCATION_V1 = 0x0bb7aafdb8e380f81267337bc5b5dfdf76e6d3a380ecadb51ec665246d9d6800;
 
     struct ProductStorage {
+        IProductService _productService;
         IApplicationService _applicationService;
         IPolicyService _policyService;
         IClaimService _claimService;
@@ -55,20 +60,21 @@ abstract contract Product is
         Fee memory productFee,
         Fee memory processingFee,
         address initialOwner,
-        bytes memory data
+        bytes memory registryData // writeonly data that will saved in the object info record of the registry
     )
         public
         virtual
         onlyInitializing()
     {
-        initializeComponent(registry, instanceNftId, name, token, PRODUCT(), isInterceptor, initialOwner, data);
+        initializeComponent(registry, instanceNftId, name, token, PRODUCT(), isInterceptor, initialOwner, registryData);
 
         ProductStorage storage $ = _getProductStorage();
         // TODO add validation
         // TODO refactor to go via registry
-        $._applicationService = IApplicationService(getServiceAddress(APPLICATION())); 
-        $._policyService = IPolicyService(getServiceAddress(POLICY())); 
-        $._claimService = IClaimService(getServiceAddress(CLAIM())); 
+        $._productService = IProductService(_getServiceAddress(PRODUCT())); 
+        $._applicationService = IApplicationService(_getServiceAddress(APPLICATION())); 
+        $._policyService = IPolicyService(_getServiceAddress(POLICY())); 
+        $._claimService = IClaimService(_getServiceAddress(CLAIM())); 
         $._pool = Pool(pool);
         $._distribution = Distribution(distribution);
         $._initialProductFee = productFee;
@@ -84,7 +90,7 @@ abstract contract Product is
     function calculatePremium(
         uint256 sumInsuredAmount,
         RiskId riskId,
-        uint256 lifetime,
+        Seconds lifetime,
         bytes memory applicationData,
         NftId bundleNftId,
         ReferralId referralId
@@ -94,7 +100,8 @@ abstract contract Product is
         override 
         returns (uint256 premiumAmount)
     {
-        (premiumAmount,,,,) = _getProductStorage()._policyService.calculatePremium(
+        IPolicy.Premium memory premium = _getProductStorage()._applicationService.calculatePremium(
+            getNftId(),
             riskId,
             sumInsuredAmount,
             lifetime,
@@ -102,13 +109,14 @@ abstract contract Product is
             bundleNftId,
             referralId
         );
+        premiumAmount = premium.premiumAmount;
     }
 
 
     function calculateNetPremium(
         uint256 sumInsuredAmount,
         RiskId riskId,
-        uint256 lifetime,
+        Seconds lifetime,
         bytes memory applicationData
     )
         external
@@ -128,7 +136,7 @@ abstract contract Product is
         RiskId id,
         bytes memory data
     ) internal {
-        getProductService().createRisk(
+        _getProductService().createRisk(
             id,
             data
         );
@@ -138,7 +146,7 @@ abstract contract Product is
         RiskId id,
         bytes memory data
     ) internal {
-        getProductService().updateRisk(
+        _getProductService().updateRisk(
             id,
             data
         );
@@ -148,7 +156,7 @@ abstract contract Product is
         RiskId id,
         StateId state
     ) internal {
-        getProductService().updateRiskState(
+        _getProductService().updateRiskState(
             id,
             state
         );
@@ -162,7 +170,7 @@ abstract contract Product is
         address applicationOwner,
         RiskId riskId,
         uint256 sumInsuredAmount,
-        uint256 lifetime,
+        Seconds lifetime,
         NftId bundleNftId,
         ReferralId referralId,
         bytes memory applicationData
@@ -242,7 +250,7 @@ abstract contract Product is
         restricted()
         override
     {
-        getProductService().setFees(productFee, processingFee);
+        _getProductService().setFees(productFee, processingFee);
     }
 
     function getSetupInfo() public view returns (ISetup.ProductSetupInfo memory setupInfo) {
@@ -259,19 +267,15 @@ abstract contract Product is
         ProductStorage storage $ = _getProductStorage();
 
         ISetup.DistributionSetupInfo memory distributionSetupInfo = $._distribution.getSetupInfo();
-        ISetup.PoolSetupInfo memory poolSetupInfo = $._pool.getSetupInfo();
+        IComponents.PoolInfo memory poolInfo = $._pool.getPoolInfo();
 
         return ISetup.ProductSetupInfo(
             getToken(),
             $._tokenHandler,
             $._distributionNftId,
             $._poolNftId,
-            distributionSetupInfo.distributionFee, 
             $._initialProductFee,
             $._initialProcessingFee,
-            poolSetupInfo.poolFee, 
-            poolSetupInfo.stakingFee, 
-            poolSetupInfo.performanceFee,
             false,
             getWallet()
         );
@@ -282,4 +286,8 @@ abstract contract Product is
             $.slot := PRODUCT_STORAGE_LOCATION_V1
         }
     }
+
+    function _getProductService() internal view returns (IProductService) {
+        return _getProductStorage()._productService;
+    }
 }

package/contracts/instance/AccessManagerUpgradeableInitializeable.sol

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {AccessManagerUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagerUpgradeable.sol";
+
+
+contract AccessManagerUpgradeableInitializeable is AccessManagerUpgradeable {
+
+    function initialize(address initialAdmin) initializer public {
+        __AccessManager_init(initialAdmin);        
+    }
+
+}

package/contracts/instance/BundleManager.sol

@@ -22,9 +22,10 @@ contract BundleManager is
     event LogBundleManagerBundleAdded(NftId poolNftId, NftId bundleNftId);
     event LogBundleManagerBundleUnlocked(NftId poolNftId, NftId bundleNftId);
     event LogBundleManagerBundleLocked(NftId poolNftId, NftId bundleNftId);
+    event LogBundleManagerBundleClosed(NftId poolNftId, NftId bundleNftId);
 
-    error ErrorBundleManagerErrorPolicyAlreadyActivated(NftId policyNftId);
-    error ErrorBundleManagerErrorBundleLocked(NftId bundleNftId, NftId policyNftId);
+    error ErrorBundleManagerPolicyAlreadyActivated(NftId policyNftId);
+    error ErrorBundleManagerBundleLocked(NftId bundleNftId, NftId policyNftId);
     error ErrorBundleManagerPolicyWithOpenClaims(NftId policyNftId, uint256 openClaimsCount);
     error ErrorBundleManagerPolicyNotCloseable(NftId policyNftId);
     error ErrorBundleManagerBundleUnknown(NftId bundleNftId);
@@ -32,7 +33,7 @@ contract BundleManager is
 
     mapping(NftId bundleNftId => LibNftIdSet.Set policies) internal _activePolicies;
 
-    /// @dev links a policy with its bundle
+    /// @dev links a policy to 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() {
@@ -42,7 +43,7 @@ contract BundleManager is
 
         // ensure bundle is unlocked (in active set) and registered with this instance
         if (!_isActive(poolNftId, bundleNftId)) {
-            revert ErrorBundleManagerErrorBundleLocked(bundleNftId, policyNftId);
+            revert ErrorBundleManagerBundleLocked(bundleNftId, policyNftId);
         }
 
         LibNftIdSet.add(_activePolicies[bundleNftId], policyNftId);
@@ -71,7 +72,7 @@ contract BundleManager is
     }
 
 
-    /// @dev add a new bundle to a riskpool registerd with this instance
+    /// @dev add a new bundle to a pool 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;
@@ -85,6 +86,7 @@ contract BundleManager is
         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;

package/contracts/instance/Cloneable.sol

@@ -10,7 +10,8 @@ abstract contract Cloneable is
     AccessManagedUpgradeable
 {
     event CloneableInitialized(address authority, address registry);
-
+    
+    error CloneableAuthorityZero();
     error CloneableRegistryInvalid(address registry);
 
     IRegistry internal _registry;
@@ -25,9 +26,13 @@ abstract contract Cloneable is
         address registry
     )
         public 
-        initializer
+        onlyInitializing
     {
         // check/handle access managed
+        if(authority == address(0)) {
+            revert CloneableAuthorityZero();
+        }
+        
         __AccessManaged_init(authority);
 
         // check/handle registry