@etherisc/gif-next 0.0.2-f30e0eb-805 → 0.0.2-f4f2d93-430

package/contracts/instance/service/IBundleService.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+import {Amount} from "../../types/Amount.sol";
 import {NftId} from "../../types/NftId.sol";
 import {Fee} from "../../types/Fee.sol";
 import {IService} from "../../shared/IService.sol";
@@ -8,55 +9,85 @@ import {IBundle} from "../module/IBundle.sol";
 import {IInstance} from "../../instance/IInstance.sol";
 import {Seconds} from "../../types/Seconds.sol";
 import {StateId} from "../../types/StateId.sol";
+import {Timestamp} from "../../types/Timestamp.sol";
 
 interface IBundleService is IService {
 
     event LogBundleServiceBundleActivated(NftId bundleNftId);
     event LogBundleServiceBundleLocked(NftId bundleNftId);
-    event LogBundleServiceBundleClosed(NftId bundleNftId);
 
     error ErrorBundleServiceInsufficientAllowance(address bundleOwner, address tokenHandlerAddress, uint256 amount);
-    error ErrorBundleServiceBundleNotOpen(NftId bundleNftId, StateId state);
+    error ErrorBundleServiceBundleNotOpen(NftId bundleNftId, StateId state, Timestamp expiredAt);
+    error ErrorBundleServiceCapacityInsufficient(NftId bundleNftId, uint capacityAmount, uint collateralAmount);
     error ErrorBundleServiceBundleWithOpenPolicies(NftId bundleNftId, uint256 openPoliciesCount);
 
+    /// @dev create a new bundle for the specified attributes
+    /// may only be called by pool service
     function create(
-        address owner,
-        Fee memory fee, 
-        uint256 amount,
-        Seconds lifetime, 
-        bytes calldata filter
-    ) external returns(NftId bundleNftId);
+        IInstance instance, // instance relevant for bundle
+        NftId poolNftId, // the pool the bundle will be linked to
+        address owner, // initial bundle owner
+        Fee memory fee, // fees deducted from premium that go to bundle owner
+        Amount stakingAmount, // staking amount - staking fees result in initial bundle capital
+        Seconds lifetime, // initial duration for which new policies are covered
+        bytes calldata filter // optional use case specific criteria that define if a policy may be covered by this bundle
+    )
+        external 
+        returns(NftId bundleNftId); // the nft id of the newly created bundle
+
+    /// @dev locks the specified bundle, locked bundles are not available to collateralize new policies
+    /// only active bundles may be locked
+    /// may only be called by registered and unlocked pool components
+    function lock(NftId bundleNftId) external;
+
+    /// @dev activates the specified bundle
+    /// only locked bundles may be unlocked
+    /// may only be called by registered and unlocked pool components
+    function unlock(NftId bundleNftId) external;
 
+    /// @dev closes the specified bundle
+    /// only open bundles (active or locked) may be closed
+    /// to close a bundle it may not have any non-closed polices attached to it
+    /// may only be called by registered and unlocked pool components
+    function close(
+        IInstance instance, 
+        NftId bundleNftId
+    ) external;
 
+    /// @dev set bundle fee to provided value
+    /// may only be called by registered and unlocked pool components
     function setFee(
         NftId bundleNftId,
         Fee memory fee
     ) external;
 
 
+    /// @dev locks the specified collateral in the bundle
+    /// the locked collateral is added to the bundle locked capital
+    /// the bundles' fees are updated with the fees for this premium
+    /// the premium (minus bundle fee) is added to the bundle capital
+    /// may only be called by pool service
     function lockCollateral(
         IInstance instanceNftId, 
         NftId policyNftId, 
         NftId bundleNftId, 
         uint256 collateralAmount, 
-        uint256 netPremium
-    )
-        external
-        returns (
-            IBundle.BundleInfo memory bundleInfo
-        );
+        uint256 premium // premium amount after pool fee
+    ) external;
 
-    function increaseBalance(IInstance instance, NftId bundleNftId,  uint256 amount) external;
 
-    function closePolicy(IInstance instance, NftId policyNftId, NftId bundleNftId, uint256 collateralAmount) external;
+    /// @dev releases the specified collateral in the bundle
+    /// may only be called by pool service
+    function releaseCollateral(
+        IInstance instance, 
+        NftId policyNftId, 
+        NftId bundleNftId, 
+        uint256 collateralAmount
+    ) external;
+
+    function increaseBalance(IInstance instance, NftId bundleNftId,  uint256 amount) external;
 
     // function stake(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
 
     // function unstake(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
-
-    function lock(NftId bundleNftId) external;
-
-    function unlock(NftId bundleNftId) external;
-
-    function close(NftId bundleNftId) external;
 }

package/contracts/instance/service/IDistributionService.sol

@@ -12,6 +12,7 @@ import {Timestamp} from "../../types/Timestamp.sol";
 
 
 interface IDistributionService is IService {
+    error ErrorDistributionServiceCallerNotRegistered(address caller);
     error ErrorIDistributionServiceParentNftIdNotInstance(NftId nftId, NftId parentNftId);
     error ErrorIDistributionServiceCallerNotDistributor(address caller);
     error ErrorIDistributionServiceInvalidReferralId(ReferralId referralId);

package/contracts/instance/service/IPoolService.sol

@@ -1,12 +1,15 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+import {Amount} from "../../types/Amount.sol";
 import {Fee} from "../../types/Fee.sol";
 import {NftId} from "../../types/NftId.sol";
-import {IService} from "../../shared/IService.sol";
 import {IBundle} from "../module/IBundle.sol";
 import {IInstance} from "../../instance/IInstance.sol";
+import {IPolicy} from "../module/IPolicy.sol";
+import {IService} from "../../shared/IService.sol";
 import {RoleId} from "../../types/RoleId.sol";
+import {Seconds} from "../../types/Seconds.sol";
 import {StateId} from "../../types/StateId.sol";
 
 interface IPoolService is IService {
@@ -14,7 +17,11 @@ interface IPoolService is IService {
     event LogPoolServiceMaxCapitalAmountUpdated(NftId poolNftId, uint256 previousMaxCapitalAmount, uint256 currentMaxCapitalAmount);
     event LogPoolServiceBundleOwnerRoleSet(NftId poolNftId, RoleId bundleOwnerRole);
 
+    event LogPoolServiceBundleCreated(NftId instanceNftId, NftId poolNftId, NftId bundleNftId);
+    event LogPoolServiceBundleClosed(NftId instanceNftId, NftId poolNftId, NftId bundleNftId);
+
     error ErrorPoolServiceBundleOwnerRoleAlreadySet(NftId poolNftId);
+    error ErrorPoolServiceBundlePoolMismatch(NftId bundlePoolNftId, NftId productPoolNftId);
 
     /// @dev registers a new pool with the registry service
     function register(address poolAddress) external returns(NftId);
@@ -32,4 +39,61 @@ interface IPoolService is IService {
         Fee memory stakingFee,
         Fee memory performanceFee
     ) external;
+
+
+    /// @dev locks required collateral to cover the specified application (and turn it into a policy)
+    /// - retention level == 1: the full collateral amount will be locked by the specified bundle
+    /// - retention level < 1: a part of the coverage is provided by the specified bundle, the rest by the pool component
+    /// in which case the pool component might hold a re-insurance policy
+    /// may only be called by the policy service for unlocked pool components
+    function lockCollateral(
+        IInstance instance, 
+        NftId productNftId,
+        NftId applicationNftId,
+        IPolicy.PolicyInfo memory applicationInfo,
+        uint256 premiumAmount
+    ) external;
+
+
+    /// @dev releases the remaining collateral linked to the specified policy
+    /// may only be called by the policy service for unlocked pool components
+    function releaseCollateral(
+        IInstance instance, 
+        NftId policyNftId, 
+        IPolicy.PolicyInfo memory policyInfo
+    ) external;
+
+
+    /// @dev create a new bundle for the provided parameters
+    /// staking fees will be deducted by the pool service from the staking amount
+    /// may only be called by registered and unlocked pool components
+    function createBundle(
+        address owner, // initial bundle owner
+        Fee memory fee, // fees deducted from premium that go to bundle owner
+        Amount stakingAmount, // staking amount - staking fees result in initial bundle capital
+        Seconds lifetime, // initial duration for which new policies are covered
+        bytes calldata filter // optional use case specific criteria that define if a policy may be covered by this bundle
+    )
+        external 
+        returns(NftId bundleNftId); // the nft id of the newly created bundle
+
+
+    /// @dev closes the specified bundle
+    /// only open bundles (active or locked) may be closed
+    /// to close a bundle it may not have any non-closed polices attached to it
+    /// bundle fees and remaining capital (after deduction of the performance fee) will be transferred to the bundle owner
+    /// may only be called by registered and unlocked pool components
+    function closeBundle(NftId bundleNftId) external;
+
+
+    /// @dev increase stakes for bundle
+    /// staking fees will be deducted by the pool service from the staking amount
+    /// may only be called by registered and unlocked pool components
+    // function stake(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
+
+
+    /// @dev decrease stakes for bundle
+    /// performance fees will be deducted by the pool service from the staking amount
+    /// may only be called by registered and unlocked pool components
+    // function unstake(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
 }

package/contracts/instance/service/PolicyService.sol

@@ -20,6 +20,7 @@ import {ObjectType, APPLICATION, DISTRIBUTION, PRODUCT, POOL, POLICY, BUNDLE} fr
 import {APPLIED, UNDERWRITTEN, ACTIVE, KEEP_STATE, CLOSED} from "../../types/StateId.sol";
 import {NftId, NftIdLib} from "../../types/NftId.sol";
 import {StateId} from "../../types/StateId.sol";
+import {VersionPart} from "../../types/Version.sol";
 
 import {ComponentService} from "../base/ComponentService.sol";
 import {IApplicationService} from "./IApplicationService.sol";
@@ -58,58 +59,54 @@ contract PolicyService is
         address initialOwner;
         (registryAddress, initialOwner) = abi.decode(data, (address, address));
 
-        initializeService(registryAddress, owner);
+        initializeService(registryAddress, address(0), owner);
 
-        _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getMajorVersion()));
-        _bundleService = IBundleService(getRegistry().getServiceAddress(BUNDLE(), getMajorVersion()));
-        _applicationService = IApplicationService(getRegistry().getServiceAddress(APPLICATION(), getMajorVersion()));
-        _distributionService = IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), getMajorVersion()));
+        VersionPart majorVersion = getVersion().toMajorPart();
+        _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), majorVersion));
+        _bundleService = IBundleService(getRegistry().getServiceAddress(BUNDLE(), majorVersion));
+        _applicationService = IApplicationService(getRegistry().getServiceAddress(APPLICATION(), majorVersion));
+        _distributionService = IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), majorVersion));
 
         registerInterface(type(IPolicyService).interfaceId);
     }
 
 
-    function getDomain() public pure override(IService, Service) returns(ObjectType) {
+    function getDomain() public pure override returns(ObjectType) {
         return POLICY();
     }
 
 
     function _getAndVerifyInstanceAndProduct() internal view returns (Product product) {
         IRegistry.ObjectInfo memory productInfo;
-        (productInfo,) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        (, productInfo,) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
         product = Product(productInfo.objectAddress);
     }
 
-    function _getAndVerifyUnderwritingSetup(
-        IInstance instance,
-        InstanceReader instanceReader,
-        IPolicy.PolicyInfo memory policyInfo,
-        ISetup.ProductSetupInfo memory productSetupInfo
-    )
-        internal
-        view
-        returns (
-            NftId poolNftId,
-            NftId bundleNftId,
-            IBundle.BundleInfo memory bundleInfo,
-            uint256 collateralAmount
-        )
-    {
-        // check match between policy and bundle (via pool)
-        poolNftId = productSetupInfo.poolNftId;
-        bundleNftId = policyInfo.bundleNftId;
-        bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-        require(bundleInfo.poolNftId == poolNftId, "POLICY_BUNDLE_MISMATCH");
-
-        // calculate required collateral
-        IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
-        IComponents.PoolInfo memory poolInfo = abi.decode(
-            componentInfo.data, (IComponents.PoolInfo));
-
-        // obtain remaining return values
-        // TODO required collateral amount should be calculated by pool service, not policy service
-        collateralAmount = calculateRequiredCollateral(poolInfo.collateralizationLevel, policyInfo.sumInsuredAmount);
-    }
+    // function _getAndVerifyUnderwritingSetup(
+    //     IInstance instance,
+    //     InstanceReader instanceReader,
+    //     IPolicy.PolicyInfo memory policyInfo,
+    //     ISetup.ProductSetupInfo memory productSetupInfo
+    // )
+    //     internal
+    //     view
+    //     returns (
+    //         NftId poolNftId,
+    //         IComponents.PoolInfo memory poolInfo,
+    //         NftId bundleNftId,
+    //         IBundle.BundleInfo memory bundleInfo
+    //     )
+    // {
+    //     // check match between policy and bundle (via pool)
+    //     poolNftId = productSetupInfo.poolNftId;
+    //     bundleNftId = policyInfo.bundleNftId;
+    //     bundleInfo = instanceReader.getBundleInfo(bundleNftId);
+    //     require(bundleInfo.poolNftId == poolNftId, "BUNDLE_POOL_MISMATCH");
+
+    //     // calculate required collateral
+    //     IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
+    //     poolInfo = abi.decode(componentInfo.data, (IComponents.PoolInfo));
+    // }
 
 
     function decline(
@@ -132,42 +129,23 @@ contract PolicyService is
         virtual override
     {
         // check caller is registered product
-        IInstance instance;
-        InstanceReader instanceReader;
-        NftId productNftId;
-        {
-            IRegistry.ObjectInfo memory productInfo;
-            (productInfo, instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-            instanceReader = instance.getInstanceReader();
-            productNftId = productInfo.nftId;
-        }
+        (NftId productNftId,, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        InstanceReader instanceReader = instance.getInstanceReader();
 
         // check policy matches with calling product
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(applicationNftId);
-        require(policyInfo.productNftId == productNftId, "POLICY_PRODUCT_MISMATCH");
+        IPolicy.PolicyInfo memory applicationInfo = instanceReader.getPolicyInfo(applicationNftId);
+        require(applicationInfo.productNftId == productNftId, "POLICY_PRODUCT_MISMATCH");
 
         // check policy is in state applied
         require(instanceReader.getPolicyState(applicationNftId) == APPLIED(), "ERROR:PRS-021:STATE_NOT_APPLIED");
         
-        (
-            NftId poolNftId,
-            NftId bundleNftId,
-            IBundle.BundleInfo memory bundleInfo,
-            uint256 collateralAmount
-        ) = _getAndVerifyUnderwritingSetup(
-            instance,
-            instanceReader,
-            policyInfo,
-            instanceReader.getProductSetupInfo(productNftId)
-        );
-        
         StateId newPolicyState = UNDERWRITTEN();
 
         // optional activation of policy
         if(activateAt > zeroTimestamp()) {
             newPolicyState = ACTIVE();
-            policyInfo.activatedAt = activateAt;
-            policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
+            applicationInfo.activatedAt = activateAt;
+            applicationInfo.expiredAt = activateAt.addSeconds(applicationInfo.lifetime);
         }
 
         // lock bundle collateral
@@ -178,48 +156,25 @@ contract PolicyService is
             netPremiumAmount = _processPremiumByTreasury(
                 instance, 
                 applicationNftId, 
-                policyInfo.premiumAmount);
+                applicationInfo.premiumAmount);
 
-            policyInfo.premiumPaidAmount += policyInfo.premiumAmount;
+            applicationInfo.premiumPaidAmount += applicationInfo.premiumAmount;
         }
 
-        // lock collateral and update bundle book keeping
-        // TODO introduct indirection via pool service?
-        // well pool would only need to be involved when a part of the collateral
-        // is provided by a "re insurance policy" of the pool
-        // but then again the policiy would likely best be attached to the bundle. really? why?
-        // retention level: fraction of sum insured that product will cover from pool funds directly
+        // store updated policy info
+        instance.updatePolicy(applicationNftId, applicationInfo, newPolicyState);
+
+        // lock collateral and update pool and bundle book keeping
+        // pool retention level: fraction of sum insured that product will cover from pool funds directly
         // eg retention level 30%, payouts up to 30% of the sum insured will be made from the product's pool directly
         // for the remaining 70% the pool owns a policy that will cover claims that exceed the 30% of the sum insured
-        // open points:
-        // - do we need a link of a bundle to this policy or is it enough to know that the pool has an active policy?
-        // - when to buy such policies and for which amount? manual trigger or link to bundle creation and/or funding?
-        bundleInfo = _bundleService.lockCollateral(
+        // might also call pool component (for isVerifyingApplications pools)
+        _poolService.lockCollateral(
             instance,
+            productNftId,
             applicationNftId, 
-            bundleNftId,
-            collateralAmount,
-            netPremiumAmount);
-
-        instance.updatePolicy(applicationNftId, policyInfo, newPolicyState);
-
-        // also verify/confirm application by pool if necessary
-        if(abi.decode(
-            instanceReader.getComponentInfo(poolNftId).data, 
-            (IComponents.PoolInfo)
-            ).isVerifyingApplications
-        )
-        {
-            IPoolComponent pool = IPoolComponent(
-                getRegistry().getObjectInfo(poolNftId).objectAddress);
-
-            pool.verifyApplication(
-                applicationNftId, 
-                policyInfo.applicationData, 
-                bundleNftId,
-                bundleInfo.filter,
-                collateralAmount);
-        }
+            applicationInfo,
+            netPremiumAmount); // for pool book keeping (fee + additional capital)
 
         // TODO: add logging
     }
@@ -233,7 +188,7 @@ contract PolicyService is
 
     function collectPremium(NftId policyNftId, Timestamp activateAt) external override {
         // check caller is registered product
-        (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        (NftId productNftId,, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
         IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
 
@@ -262,7 +217,7 @@ contract PolicyService is
 
     function activate(NftId policyNftId, Timestamp activateAt) public override {
         // check caller is registered product
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        (,, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
 
         IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
@@ -296,7 +251,7 @@ contract PolicyService is
         external 
         override
     {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        (,, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
 
         IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
@@ -328,7 +283,11 @@ contract PolicyService is
 
         policyInfo.closedAt = TimestampLib.blockTimestamp();
 
-        _bundleService.closePolicy(instance, policyNftId, policyInfo.bundleNftId, policyInfo.sumInsuredAmount);
+        _poolService.releaseCollateral(
+            instance, 
+            policyNftId, 
+            policyInfo);
+
         instance.updatePolicy(policyNftId, policyInfo, CLOSED());
     }