@etherisc/gif-next 0.0.2-da0f894-204 → 0.0.2-db1e1e4-828

package/contracts/instance/service/DistributionService.sol

@@ -10,10 +10,11 @@ import {IPolicy} from "../module/IPolicy.sol";
 
 import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
 import {Fee, FeeLib} from "../../types/Fee.sol";
-import {DISTRIBUTION_OWNER_ROLE} from "../../types/RoleId.sol";
+import {PRODUCT_SERVICE_ROLE, DISTRIBUTION_OWNER_ROLE} from "../../types/RoleId.sol";
 import {KEEP_STATE} from "../../types/StateId.sol";
 import {ObjectType, DISTRIBUTION, INSTANCE, DISTRIBUTION, DISTRIBUTOR} from "../../types/ObjectType.sol";
 import {Version, VersionLib} from "../../types/Version.sol";
+import {RoleId} from "../../types/RoleId.sol";
 
 import {IVersionable} from "../../shared/IVersionable.sol";
 import {Versionable} from "../../shared/Versionable.sol";
@@ -42,6 +43,7 @@ contract DistributionService is
     using TimestampLib for Timestamp;
     using UFixedLib for UFixed;
     using FeeLib for Fee;
+    using ReferralLib for ReferralId;
 
     address internal _registryAddress;
     
@@ -58,11 +60,11 @@ contract DistributionService is
         (registryAddress, initialOwner) = abi.decode(data, (address, address));
         // TODO while DistributionService is not deployed in DistributionServiceManager constructor
         //      owner is DistributionServiceManager deployer
-        initializeService(registryAddress, owner);
+        initializeService(registryAddress, address(0), owner);
         registerInterface(type(IDistributionService).interfaceId);
     }
 
-    function getDomain() public pure override(Service, IService) returns(ObjectType) {
+    function getDomain() public pure override returns(ObjectType) {
         return DISTRIBUTION();
     }
 
@@ -86,8 +88,24 @@ contract DistributionService is
         distributionNftId = distributionInfo.nftId;
 
         instance.createDistributionSetup(distributionNftId, distribution.getSetupInfo());
-        getInstanceService().createGifTarget(instanceNftId, distributionAddress, distribution.getName());
-        getInstanceService().grantDistributionDefaultPermissions(instanceNftId, distributionAddress, distribution.getName());
+        // TODO move to distribution?
+        bytes4[][] memory selectors = new bytes4[][](2);
+        selectors[0] = new bytes4[](1);
+        selectors[1] = new bytes4[](2);
+
+        selectors[0][0] = IDistributionComponent.setFees.selector;
+        selectors[1][0] = IDistributionComponent.processRenewal.selector;
+
+        RoleId[] memory roles = new RoleId[](2);
+        roles[0] = DISTRIBUTION_OWNER_ROLE();
+        roles[1] = PRODUCT_SERVICE_ROLE();
+
+        getInstanceService().createGifTarget(
+            instanceNftId, 
+            distributionAddress, 
+            distribution.getName(), 
+            selectors, 
+            roles);
     }
 
     function setFees(
@@ -101,9 +119,8 @@ contract DistributionService is
             revert ErrorIDistributionServiceMinFeeTooHigh(minDistributionOwnerFee.fractionalFee.toInt(), distributionFee.fractionalFee.toInt());
         }
 
-        (IRegistry.ObjectInfo memory info , IInstance instance) = _getAndVerifyComponentInfoAndInstance(DISTRIBUTION());
+        (NftId distributionNftId, IRegistry.ObjectInfo memory info , IInstance instance) = _getAndVerifyComponentInfoAndInstance(DISTRIBUTION());
         InstanceReader instanceReader = instance.getInstanceReader();
-        NftId distributionNftId = info.nftId;
 
         ISetup.DistributionSetupInfo memory distSetupInfo = instanceReader.getDistributionSetupInfo(distributionNftId);
         distSetupInfo.minDistributionOwnerFee = minDistributionOwnerFee;
@@ -126,7 +143,7 @@ contract DistributionService is
         external
         returns (DistributorType distributorType)
     {
-        (,NftId distributionNftId, IInstance instance) = _getAndVerifyCallingDistribution();
+        (NftId distributionNftId, IInstance instance) = _getAndVerifyCallingDistribution();
 
         {
             ISetup.DistributionSetupInfo memory setupInfo = instance.getInstanceReader().getDistributionSetupInfo(distributionNftId);
@@ -162,7 +179,7 @@ contract DistributionService is
         bytes memory data
     ) external returns (NftId distributorNftId)
     {
-        (, NftId distributionNftId, IInstance instance) = _getAndVerifyCallingDistribution();
+        (NftId distributionNftId, IInstance instance) = _getAndVerifyCallingDistribution();
 
         distributorNftId = getRegistryService().registerDistributor(
             IRegistry.ObjectInfo(
@@ -191,7 +208,7 @@ contract DistributionService is
         bytes memory data
     ) external virtual
     {
-        (,, IInstance instance) = _getAndVerifyCallingDistribution();
+        (, IInstance instance) = _getAndVerifyCallingDistribution();
         InstanceReader instanceReader = instance.getInstanceReader();
         IDistribution.DistributorInfo memory distributorInfo = instanceReader.getDistributorInfo(distributorNftId);
         distributorInfo.distributorType = distributorType;
@@ -212,7 +229,7 @@ contract DistributionService is
         virtual
         returns (ReferralId referralId)
     {
-        (,NftId distributionNftId, IInstance instance) = _getAndVerifyCallingDistribution();
+        (NftId distributionNftId, IInstance instance) = _getAndVerifyCallingDistribution();
 
         if (bytes(code).length == 0) {
             revert ErrorIDistributionServiceInvalidReferral(code);
@@ -255,20 +272,50 @@ contract DistributionService is
     }
 
     function processSale(
+        NftId distributionNftId,
         ReferralId referralId,
-        uint256 premiumAmount
+        IPolicy.Premium memory premium,
+        uint256 transferredDistributionFeeAmount
     )
         external
         virtual
     {
-        // TODO: fetch referral
-        // TODO: update referral usage numbers
-        // TODO: update bookkeeping
-        // TODO: calculate commission for distributor
-        // TODO: calculate fee for distribution owner
-        // TODO: updates sum of commission per distributor -> DistributorInfo
-        // TODO: updates sum of fee per distribution owner
-        revert("NOT_IMPLEMENTED_YET");
+        bool isReferral = ! referralId.eqz();
+        bool referralValid = referralIsValid(distributionNftId, referralId);
+
+        if (isReferral && ! referralValid) {
+            revert ErrorIDistributionServiceReferralInvalid(distributionNftId, referralId);
+        }
+
+        IInstance instance = _getInstanceForDistribution(distributionNftId);
+        InstanceReader reader = instance.getInstanceReader();
+        IDistribution.ReferralInfo memory referralInfo = reader.getReferralInfo(referralId);
+        IDistribution.DistributorInfo memory distributorInfo = reader.getDistributorInfo(referralInfo.distributorNftId);
+        ISetup.DistributionSetupInfo memory setupInfo = reader.getDistributionSetupInfo(distributionNftId);
+        
+        uint256 distributionOwnerFee = premium.distributionOwnerFeeFixAmount + premium.distributionOwnerFeeVarAmount;
+        uint256 commissionAmount = premium.commissionAmount;
+
+        if (transferredDistributionFeeAmount != distributionOwnerFee + commissionAmount) {
+            revert ErrorIDistributionServiceInvalidFeeTransferred(transferredDistributionFeeAmount, distributionOwnerFee + commissionAmount);
+        }
+
+
+        if (distributionOwnerFee > 0) {
+            setupInfo.sumDistributionOwnerFees += distributionOwnerFee;
+            instance.updateDistributionSetup(distributionNftId, setupInfo, KEEP_STATE());
+        }
+
+        if (isReferral) {
+            referralInfo.usedReferrals += 1;
+            instance.updateReferral(referralId.toKey32(), referralInfo, KEEP_STATE());
+
+            if (commissionAmount > 0) {
+                distributorInfo.sumCommisions += commissionAmount;
+                distributorInfo.numPoliciesSold += 1;
+                instance.updateDistributor(referralInfo.distributorNftId, distributorInfo, KEEP_STATE());
+            }
+        }
     }
 
     function calculateFeeAmount(
@@ -281,7 +328,7 @@ contract DistributionService is
         view 
         returns (IPolicy.Premium memory finalPremium)
     {
-        (, IInstance instance) = _getAndVerifyDistribution(distributionNftId);
+        IInstance instance = _getInstanceForDistribution(distributionNftId);
         InstanceReader reader = instance.getInstanceReader();
         
         // first calculate all fixed and variable fees for the distribution - this will defined the fullPremium
@@ -302,22 +349,47 @@ contract DistributionService is
 
         // if the referral is valid, the the commission and discount are calculated based in the full premium
         // the remaing amount goes to the distribution owner
-        IDistribution.ReferralInfo memory referralInfo = reader.getReferralInfo(referralId);
-        IDistribution.DistributorInfo memory distributorInfo = reader.getDistributorInfo(referralInfo.distributorNftId);
-        IDistribution.DistributorTypeInfo memory distributorTypeInfo = reader.getDistributorTypeInfo(distributorInfo.distributorType);
-
-        uint256 commissionAmount = UFixedLib.toUFixed(premium.netPremiumAmount).mul(distributorTypeInfo.commissionPercentage).toInt();
-        premium.commissionAmount = commissionAmount;
-        premium.discountAmount = UFixedLib.toUFixed(premium.fullPremiumAmount).mul(referralInfo.discountPercentage).toInt();
-        premium.distributionOwnerFeeFixAmount = minDistributionOwnerFee.fixedFee;
-        premium.distributionOwnerFeeVarAmount = distributionFeeVarAmount - commissionAmount - premium.discountAmount;
-        premium.premiumAmount = premium.fullPremiumAmount - premium.discountAmount;
+        {
+            IDistribution.ReferralInfo memory referralInfo = reader.getReferralInfo(referralId);
+            IDistribution.DistributorInfo memory distributorInfo = reader.getDistributorInfo(referralInfo.distributorNftId);
+            IDistribution.DistributorTypeInfo memory distributorTypeInfo = reader.getDistributorTypeInfo(distributorInfo.distributorType);
+
+            uint256 commissionAmount = UFixedLib.toUFixed(premium.netPremiumAmount).mul(distributorTypeInfo.commissionPercentage).toInt();
+            premium.commissionAmount = commissionAmount;
+            premium.discountAmount = UFixedLib.toUFixed(premium.fullPremiumAmount).mul(referralInfo.discountPercentage).toInt();
+            premium.distributionOwnerFeeFixAmount = minDistributionOwnerFee.fixedFee;
+            premium.distributionOwnerFeeVarAmount = distributionFeeVarAmount - commissionAmount - premium.discountAmount;
+            premium.premiumAmount = premium.fullPremiumAmount - premium.discountAmount;
+        }
+
+        // sanity check to validate the fee calculation
+        if (premium.distributionOwnerFeeFixAmount < minDistributionOwnerFee.fixedFee) {
+            revert ErrorIDistributionServiceFeeCalculationMismatch(
+                premium.distributionFeeFixAmount,
+                premium.distributionFeeVarAmount,
+                premium.distributionOwnerFeeFixAmount,
+                premium.distributionOwnerFeeVarAmount,
+                premium.commissionAmount,
+                premium.discountAmount
+            );
+        }
+        if ((premium.distributionFeeVarAmount) != (premium.discountAmount + premium.distributionOwnerFeeVarAmount + premium.commissionAmount)) {
+            revert ErrorIDistributionServiceFeeCalculationMismatch(
+                premium.distributionFeeFixAmount,
+                premium.distributionFeeVarAmount,
+                premium.distributionOwnerFeeFixAmount,
+                premium.distributionOwnerFeeVarAmount,
+                premium.commissionAmount,
+                premium.discountAmount
+            );
+        }
         
         return premium; 
     }
 
+    // TODO: zero should return false
     function referralIsValid(NftId distributionNftId, ReferralId referralId) public view returns (bool isValid) {
-        (address distributionAddress, IInstance instance) = _getAndVerifyDistribution(distributionNftId);
+        IInstance instance = _getInstanceForDistribution(distributionNftId);
         IDistribution.ReferralInfo memory info = instance.getInstanceReader().getReferralInfo(referralId);
 
         if (info.distributorNftId.eqz()) {
@@ -332,63 +404,32 @@ contract DistributionService is
         internal
         view
         returns(
-            address distributionAddress,
             NftId distributionNftId,
             IInstance instance
         )
     {
-        ObjectType objectType;
-        (
-            distributionAddress,
-            distributionNftId,
-            objectType,
-            instance
-        ) = _getAndVerifyCaller();
-
-        if(objectType != DISTRIBUTION()) {
-            revert ErrorIDistributionServiceCallerNotDistributor(msg.sender);
+        distributionNftId = getRegistry().getNftId(msg.sender);
+        if (distributionNftId.eqz()) {
+            revert ErrorDistributionServiceCallerNotRegistered(msg.sender);
         }
-    }
 
-    function _getAndVerifyDistribution(NftId distributionNftId)
-        internal
-        view
-        returns(
-            address distributionAddress,
-            IInstance instance
-        )
-    {
         IRegistry.ObjectInfo memory info = getRegistry().getObjectInfo(distributionNftId);
-        IRegistry.ObjectInfo memory parentInfo = getRegistry().getObjectInfo(info.parentNftId);
-        if (parentInfo.objectType != INSTANCE()) {
-            revert ErrorIDistributionServiceParentNftIdNotInstance(distributionNftId, info.parentNftId);
+        if(info.objectType != DISTRIBUTION()) {
+            revert ErrorIDistributionServiceCallerNotDistributor(msg.sender);
         }
-        instance = IInstance(parentInfo.objectAddress);
+
+        address instanceAddress = getRegistry().getObjectInfo(info.parentNftId).objectAddress;
+        instance = IInstance(instanceAddress);
     }
 
-    function _getAndVerifyCaller()
+
+    function _getInstanceForDistribution(NftId distributionNftId)
         internal
         view
-        returns(
-            address objectAddress,
-            NftId objectNftId,
-            ObjectType objectType,
-            IInstance instance
-        )
+        returns(IInstance instance)
     {
-        objectAddress = msg.sender;
-        objectNftId = getRegistry().getNftId(objectAddress);
-        if ( objectNftId.eqz()) {
-            revert ErrorIServiceCallerUnknown(objectAddress);
-        }
-        IRegistry.ObjectInfo memory info = getRegistry().getObjectInfo(objectNftId);
-        objectType = info.objectType;
-
-        IRegistry.ObjectInfo memory parentInfo = getRegistry().getObjectInfo(info.parentNftId);
-        if (parentInfo.objectType != INSTANCE()) {
-            revert ErrorIDistributionServiceParentNftIdNotInstance(objectNftId, info.parentNftId);
-        }
-        instance = IInstance(parentInfo.objectAddress);
+        NftId instanceNftId = getRegistry().getObjectInfo(distributionNftId).parentNftId;
+        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
+        return IInstance(instanceAddress);
     }
-
 }

package/contracts/instance/service/IApplicationService.sol

@@ -19,6 +19,7 @@ import {Fee} from "../../types/Fee.sol";
 interface IApplicationService is IService {
     
     error IApplicationServicePolicyNotApplied(NftId applicationNftId);
+    error IApplicationServiceBundlePoolMismatch(NftId bundleNftId, NftId bundlePoolNftId, NftId poolNftId);
 
     /// @dev creates a new application based on the specified attributes
     /// may only be called by a product component

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,48 +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 {
-    error ErrorIBundleServiceInsufficientAllowance(address bundleOwner, address tokenHandlerAddress, uint256 amount);
 
-    function createBundle(
-        address owner,
-        Fee memory fee, 
-        uint256 amount,
-        Seconds lifetime, 
-        bytes calldata filter
-    ) external returns(NftId bundleNftId);
+    event LogBundleServiceBundleActivated(NftId bundleNftId);
+    event LogBundleServiceBundleLocked(NftId bundleNftId);
 
-    function setBundleFee(
+    error ErrorBundleServiceInsufficientAllowance(address bundleOwner, address tokenHandlerAddress, uint256 amount);
+    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(
+        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;
 
-    function updateBundle(NftId instanceNftId, NftId bundleNftId, IBundle.BundleInfo memory bundleInfo, StateId state) 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
-        );
-
-    function increaseBalance(IInstance instance, NftId bundleNftId,  uint256 amount) external;
-
-    function closePolicy(IInstance instance, NftId policyNftId, NftId bundleNftId, uint256 collateralAmount) external;
+        uint256 premium // premium amount after pool fee
+    ) external;
 
-    // function fundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
 
-    // function defundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
+    /// @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 lockBundle(NftId bundleNftId) external;
+    function increaseBalance(IInstance instance, NftId bundleNftId,  uint256 amount) external;
 
-    function unlockBundle(NftId bundleNftId) external;
+    // function stake(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
 
-    // function closeBundle(NftId bundleNftId) external;
+    // function unstake(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
 }

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);
@@ -24,6 +25,16 @@ interface IDistributionService is IService {
     error ErrorIDistributionServiceCommissionTooHigh(uint256 commissionPercentage, uint256 maxCommissionPercentage);
     error ErrorIDistributionServiceMinFeeTooHigh(uint256 minFee, uint256 limit);
     error ErrorIDistributionServiceMaxDiscountTooHigh(uint256 maxDiscountPercentage, uint256 limit);
+    error ErrorIDistributionServiceFeeCalculationMismatch(
+                uint256 distributionFeeFixAmount,
+                uint256 distributionFeeVarAmount,
+                uint256 distributionOwnerFeeFixAmount,
+                uint256 distributionOwnerFeeVarAmount,
+                uint256 commissionAmount,
+                uint256 discountAmount
+            );
+    error ErrorIDistributionServiceReferralInvalid(NftId distributionNftId, ReferralId referralId);
+    error ErrorIDistributionServiceInvalidFeeTransferred(uint256 transferredDistributionFeeAmount, uint256 expectedDistributionFeeAmount);
 
     function setFees(
         Fee memory minDistributionOwnerFee,
@@ -69,8 +80,10 @@ interface IDistributionService is IService {
 
     /// @dev callback from product service when selling a policy for a specific referralId
     function processSale(
+        NftId distributionNftId,
         ReferralId referralId,
-        uint256 premiumAmount
+        IPolicy.Premium memory premium,
+        uint256 transferredDistributionFeeAmount
     ) external;
 
     function calculateFeeAmount(

package/contracts/instance/service/IPolicyService.sol

@@ -24,6 +24,8 @@ interface IPolicyService is IService {
     error ErrorIPolicyServiceOpenClaims(NftId policyNftId, uint16 openClaimsCount);
     error ErrorIPolicyServicePolicyHasNotExpired(NftId policyNftId, Timestamp expiredAt);
 
+    error ErrorIPolicyServicePremiumMismatch(NftId policyNftId, uint256 premiumAmount, uint256 recalculatedPremiumAmount);
+
     /// @dev declines an application represented by {policyNftId}
     /// an application can only be declined in applied state
     /// only the related product may decline an application

package/contracts/instance/service/IPoolService.sol

@@ -1,20 +1,99 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {NftId} from "../../types/NftId.sol";
+import {Amount} from "../../types/Amount.sol";
 import {Fee} from "../../types/Fee.sol";
-import {StateId} from "../../types/StateId.sol";
-import {IService} from "../../shared/IService.sol";
+import {NftId} from "../../types/NftId.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 {
 
+    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);
 
+    /// @dev defines the required role for bundle owners for the calling pool
+    /// default implementation returns PUBLIC ROLE
+    function setBundleOwnerRole(RoleId bundleOwnerRole) external;
+
+    /// @dev sets the max capital amount for the calling pool
+    function setMaxCapitalAmount(uint256 maxCapitalAmount) external;
+
+    /// @dev set pool sepecific fees
     function setFees(
         Fee memory poolFee,
         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);
 }