@etherisc/gif-next 0.0.2-9dd41ff-671 → 0.0.2-9ed3c41-176

package/contracts/pool/BundleService.sol

@@ -1,18 +1,18 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {IBundle} from "../instance/module/IBundle.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IInstance} from "../instance/IInstance.sol";
-import {TokenHandler} from "../instance/module/ITreasury.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
+import {InstanceStore} from "../instance/InstanceStore.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 
 import {IVersionable} from "../shared/IVersionable.sol";
 import {INftOwnable} from "../shared/INftOwnable.sol";
-import {NftId, NftIdLib, zeroNftId} from "../type/NftId.sol";
-import {ObjectType, POOL, BUNDLE} from "../type/ObjectType.sol";
+import {NftId, NftIdLib} from "../type/NftId.sol";
+import {ObjectType, COMPONENT, POOL, BUNDLE, REGISTRY} from "../type/ObjectType.sol";
 import {POOL_OWNER_ROLE, RoleId} from "../type/RoleId.sol";
 import {Pool} from "./Pool.sol";
 
@@ -26,8 +26,8 @@ import {Versionable} from "../shared/Versionable.sol";
 
 import {IService} from "../shared/IService.sol";
 import {Service} from "../shared/Service.sol";
-import {BundleManager} from "../instance/BundleManager.sol";
-import {ComponentService} from "../shared/ComponentService.sol";
+import {BundleSet} from "../instance/BundleSet.sol";
+import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
 import {IBundleService} from "./IBundleService.sol";
 import {IRegistryService} from "../registry/IRegistryService.sol";
 import {InstanceService} from "../instance/InstanceService.sol";
@@ -36,14 +36,16 @@ import {InstanceReader} from "../instance/InstanceReader.sol";
 string constant BUNDLE_SERVICE_NAME = "BundleService";
 
 contract BundleService is 
-    ComponentService, 
+    ComponentVerifyingService, 
     IBundleService 
 {
     using NftIdLib for NftId;
 
     string public constant NAME = "BundleService";
 
-    address internal _registryAddress;
+    address private _registryAddress;
+    IRegistryService private _registryService;
+    IComponentService private _componentService;
 
     function _initialize(
         address owner, 
@@ -53,62 +55,40 @@ contract BundleService is
         initializer
         virtual override
     {
-        (
-            address registryAddress,, 
-            //address managerAddress
-            address authority
-        ) = abi.decode(data, (address, address, address));
+        address registryAddress;
+        address initialOwner;
+        (registryAddress, initialOwner) = abi.decode(data, (address, address));
+        // TODO while PoolService is not deployed in PoolServiceManager constructor
+        //      owner is PoolServiceManager deployer
+        initializeService(registryAddress, address(0), owner);
+
+        _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
+        _componentService = IComponentService(_getServiceAddress(COMPONENT()));
 
-        initializeService(registryAddress, authority, owner);
         registerInterface(type(IBundleService).interfaceId);
     }
 
-    function getDomain() public pure override returns(ObjectType) {
-        return BUNDLE();
-    }
 
-    // TODO staking/unstaking as well as collateralize need to go to pool service
-    // it will also be the pool service that is updating the pool info data
-    // collateralize -> potentially accumulate pool fees
-    // collateralize: additional reason to move to pool, pool might has retential level < 1 ...
-    // staking -> potentially accumulate staking fees
-    // unstaking -> potentially accumulate performance fees
-    function _updatePoolWithStakes(
-        IInstance instance,
-        NftId poolNftId,
-        Amount stakingAmount
+    function setFee(
+        NftId bundleNftId,
+        Fee memory fee
     )
-        internal
-        returns (
-            TokenHandler tokenHandler,
-            address wallet,
-            Amount netStakingAmount
-        )
+        external
+        virtual
     {
-        if(stakingAmount.gtz()) {
-            InstanceReader instanceReader = instance.getInstanceReader();
-            IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
-
-            tokenHandler = componentInfo.tokenHandler;
-            wallet = componentInfo.wallet;
-
-            IComponents.PoolInfo memory poolInfo = abi.decode(componentInfo.data, (IComponents.PoolInfo));
-            Amount poolFeeAmount;
-
-            // calculate pool fee and net staking amount
-            (poolFeeAmount, netStakingAmount) = FeeLib.calculateFee(poolInfo.stakingFee, stakingAmount);
-
-            // update pool balance and fee amount
-            poolInfo.balanceAmount = poolInfo.balanceAmount + netStakingAmount;
-
-            if(poolFeeAmount.gtz()) {
-                poolInfo.feeAmount = poolInfo.feeAmount + poolFeeAmount;
-            }
+        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        InstanceReader instanceReader = instance.getInstanceReader();
+        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
+        if(bundleInfo.poolNftId.eqz()) {
+            revert ErrorBundleServiceBundleUnknown(bundleNftId);
+        }
 
-            // save updated pool info
-            componentInfo.data = abi.encode(poolInfo);
-            instance.getInstanceStore().updatePoolSetup(poolNftId, componentInfo, KEEP_STATE());
+        if(bundleInfo.poolNftId != poolNftId) {
+            revert ErrorBundleServiceBundlePoolMismatch(bundleNftId, bundleInfo.poolNftId, poolNftId);
         }
+
+        bundleInfo.fee = fee;
+        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
     }
 
 
@@ -127,9 +107,9 @@ contract BundleService is
         returns(NftId bundleNftId)
     {
         // register bundle with registry
-        bundleNftId = getRegistryService().registerBundle(
+        bundleNftId = _registryService.registerBundle(
             IRegistry.ObjectInfo(
-                zeroNftId(), 
+                NftIdLib.zero(), 
                 poolNftId,
                 BUNDLE(),
                 false, // intercepting property for bundles is defined on pool
@@ -140,60 +120,42 @@ contract BundleService is
         );
 
         // create bundle info in instance
-        instance.getInstanceStore().createBundle(
+        InstanceStore instanceStore = instance.getInstanceStore();
+        instanceStore.createBundle(
             bundleNftId, 
             IBundle.BundleInfo(
                 poolNftId,
                 bundleFee,
                 filter,
-                stakingAmount,
-                AmountLib.zero(),
-                AmountLib.zero(),
                 lifetime,
                 TimestampLib.blockTimestamp().addSeconds(lifetime),
                 zeroTimestamp()));
 
+        // bundle book keeping
+        _componentService.increaseBundleBalance(
+            instanceStore, 
+            bundleNftId, 
+            stakingAmount, 
+            AmountLib.zero()); // fee amount
+
         // put bundle under bundle managemet
-        BundleManager bundleManager = instance.getBundleManager();
+        BundleSet bundleManager = instance.getBundleSet();
         bundleManager.add(bundleNftId);
 
         // TODO add logging
     }
 
 
-    function setFee(
-        NftId bundleNftId,
-        Fee memory fee
-    )
-        external
-        override
-    {
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(POOL());
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-        if(bundleInfo.poolNftId.eqz()) {
-            revert ErrorBundleServiceBundleUnknown(bundleNftId);
-        }
-
-        if(bundleInfo.poolNftId != poolNftId) {
-            revert ErrorBundleServiceBundlePoolMismatch(bundleNftId, bundleInfo.poolNftId, poolNftId);
-        }
-
-        bundleInfo.fee = fee;
-        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
-    }
-
-
     // the bundle MUST be unlocked (active) for linking (underwriting) and registered with this instance
     function lockCollateral(
         IInstance instance,
         NftId policyNftId, 
         NftId bundleNftId, 
-        Amount collateralAmount, // required amount to collateralize policy
-        Amount premiumAmount // premium part that reaches bundle for this policy
+        Amount collateralAmount // required local amount to collateralize policy
     ) 
         external
-        restricted
+        virtual
+        restricted()
     {
         InstanceReader instanceReader = instance.getInstanceReader();
         StateId bundleState = instanceReader.getMetadata(bundleNftId.toKey32(BUNDLE())).state;
@@ -205,71 +167,37 @@ contract BundleService is
         }
 
         // ensure bundle capacity is sufficent to collateralize policy
-        Amount capacity = bundleInfo.capitalAmount + premiumAmount - bundleInfo.lockedAmount;
+        InstanceStore instanceStore = instance.getInstanceStore();
+        (
+            Amount balanceAmount,
+            Amount lockedAmount,
+            Amount feeAmount
+        ) = instanceStore.getAmounts(bundleNftId);
+
+        Amount capacity = balanceAmount - (lockedAmount + feeAmount);
         if(capacity < collateralAmount) {
             revert ErrorBundleServiceCapacityInsufficient(bundleNftId, capacity, collateralAmount);
         }
 
-        // TODO add more validation
-        
         // updated locked amount
-        bundleInfo.lockedAmount = bundleInfo.lockedAmount + collateralAmount;
-
-        // update capital and fees when premiums are involved
-        _updateBundleWithPremium(instance, bundleNftId, bundleInfo, premiumAmount);
+        instanceStore.increaseLocked(bundleNftId, collateralAmount);
         
         // link policy to bundle in bundle manger
         _linkPolicy(instance, policyNftId);
     }
 
 
-    function _updateBundleWithPremium(
-        IInstance instance,
-        NftId bundleNftId,
-        IBundle.BundleInfo memory bundleInfo,
-        Amount premiumAmount
-    )
-        internal
-    {
-        // update bundle capital and fee amounts
-        if(premiumAmount.gtz()) {
-            // calculate fees and net premium amounts
-            (
-                , 
-                Amount netPremiumAmount
-            ) = FeeLib.calculateFee(bundleInfo.fee, premiumAmount);
-
-            // update bundle info with additional capital
-            bundleInfo.capitalAmount = bundleInfo.capitalAmount + netPremiumAmount;
-        }
-
-        // save updated bundle info
-        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
-    }
-
-    function updateBundleFees(
-        IInstance instance,
-        NftId bundleNftId,
-        Amount feeAmount
-    )
-        external
-    {
-        IBundle.BundleInfo memory bundleInfo = instance.getInstanceReader().getBundleInfo(bundleNftId);
-        bundleInfo.feeAmount = bundleInfo.feeAmount.add(feeAmount);
-        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
-    }
-
     function lock(NftId bundleNftId) 
         external
         virtual
     {
-        (,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(POOL());
+        (,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
 
         // udpate bundle state
         instance.getInstanceStore().updateBundleState(bundleNftId, PAUSED());
 
         // update set of active bundles
-        BundleManager bundleManager = instance.getBundleManager();
+        BundleSet bundleManager = instance.getBundleSet();
         bundleManager.lock(bundleNftId);
 
         emit LogBundleServiceBundleLocked(bundleNftId);
@@ -280,13 +208,13 @@ contract BundleService is
         external
         virtual
     {
-        (,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(POOL());
+        (,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
 
         // udpate bundle state
         instance.getInstanceStore().updateBundleState(bundleNftId, ACTIVE());
 
         // update set of active bundles
-        BundleManager bundleManager = instance.getBundleManager();
+        BundleSet bundleManager = instance.getBundleSet();
         bundleManager.unlock(bundleNftId);
 
         emit LogBundleServiceBundleActivated(bundleNftId);
@@ -305,7 +233,7 @@ contract BundleService is
         instance.getInstanceStore().updateBundleState(bundleNftId, CLOSED());
 
         // ensure no open policies attached to bundle
-        BundleManager bundleManager = instance.getBundleManager();
+        BundleSet bundleManager = instance.getBundleSet();
         uint256 openPolicies = bundleManager.activePolicies(bundleNftId);
         if(openPolicies > 0) {
             revert ErrorBundleServiceBundleWithOpenPolicies(bundleNftId, openPolicies);
@@ -316,37 +244,34 @@ contract BundleService is
     }
 
 
-    function increaseBalance(
+    function releaseCollateral(
         IInstance instance,
+        NftId policyNftId, 
         NftId bundleNftId, 
-        Amount premiumAmount
+        Amount collateralAmount
     ) 
         external
-        restricted
+        virtual
+        restricted()
     {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-
-        // update capital and fees when premiums are involved
-        _updateBundleWithPremium(instance, bundleNftId, bundleInfo, premiumAmount);
-
-        // TODO add logging (?)
+        instance.getInstanceStore().decreaseLocked(bundleNftId, collateralAmount);
     }
 
-    function releaseCollateral(IInstance instance,
-        NftId policyNftId, 
-        NftId bundleNftId, 
-        Amount collateralAmount
+    /// @dev unlinks policy from bundle
+    function unlinkPolicy(
+        IInstance instance, 
+        NftId policyNftId
     ) 
         external
-        restricted 
+        virtual
+        restricted
     {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
+        // ensure policy is closeable
+        if (!instance.getInstanceReader().policyIsCloseable(policyNftId)) {
+            revert ErrorBundleServicePolicyNotCloseable(policyNftId);
+        }
 
-        // reduce locked amount by released collateral amount
-        bundleInfo.lockedAmount = bundleInfo.lockedAmount - collateralAmount;
-        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+        instance.getBundleSet().unlinkPolicy(policyNftId);
     }
 
     /// @dev links policy to bundle
@@ -358,27 +283,14 @@ contract BundleService is
 
         // ensure policy has not yet been activated in a previous tx already
         if (policyInfo.activatedAt.gtz() && policyInfo.activatedAt < TimestampLib.blockTimestamp()) {
-            revert BundleManager.ErrorBundleManagerPolicyAlreadyActivated(policyNftId);
+            revert BundleSet.ErrorBundleSetPolicyAlreadyActivated(policyNftId);
         }
         
-        BundleManager bundleManager = instance.getBundleManager();
+        BundleSet bundleManager = instance.getBundleSet();
         bundleManager.linkPolicy(policyNftId);
     }
 
-    /// @dev unlinks policy from bundle
-    function unlinkPolicy(
-        IInstance instance, 
-        NftId policyNftId
-    ) 
-        external
-        virtual
-        restricted
-    {
-        // ensure policy is closeable
-        if (!instance.getInstanceReader().policyIsCloseable(policyNftId)) {
-            revert ErrorBundleServicePolicyNotCloseable(policyNftId);
-        }
-
-        instance.getBundleManager().unlinkPolicy(policyNftId);
+    function _getDomain() internal pure override returns(ObjectType) {
+        return BUNDLE();
     }
 }

package/contracts/pool/IBundleService.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {Amount} from "../type/Amount.sol";
 import {NftId} from "../type/NftId.sol";
@@ -80,13 +80,13 @@ interface IBundleService is IService {
     /// the premium (minus bundle fee) is added to the bundle capital
     /// may only be called by pool service
     function lockCollateral(
-        IInstance instanceNftId, 
+        IInstance instance, 
         NftId policyNftId, 
         NftId bundleNftId, 
-        Amount collateralAmount, 
-        Amount premiumAmount // premium after pool fee
+        Amount collateralAmount
     ) external;
 
+
     /// @dev releases the specified collateral in the bundle
     /// may only be called by pool service
     function releaseCollateral(
@@ -103,16 +103,4 @@ interface IBundleService is IService {
         IInstance instance, 
         NftId policyNftId
     ) external;
-
-    /// @dev updates the bundle's fees of with the provided fee amount
-    function updateBundleFees(
-        IInstance instance,
-        NftId bundleNftId,
-        Amount feeAmount
-    ) external;
-
-    function increaseBalance(
-        IInstance instance, 
-        NftId bundleNftId,  
-        Amount amount) external;
 }

package/contracts/pool/IPoolComponent.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.20;
 
 import {Amount} from "../type/Amount.sol";
 import {Fee} from "../type/Fee.sol";
-import {IComponent} from "../shared/IComponent.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {NftId} from "../type/NftId.sol";
 import {RoleId} from "../type/RoleId.sol";
@@ -12,74 +12,14 @@ import {UFixed} from "../type/UFixed.sol";
 
 /// @dev pool components hold and manage the collateral to cover active policies
 /// pools come in different flavors
-interface IPoolComponent is IComponent {
+interface IPoolComponent is IInstanceLinkedComponent {
 
     error ErrorPoolNotBundleOwner(NftId bundleNftId, address caller);
     error ErrorPoolNotPoolService(address caller);
-
     error ErrorPoolApplicationBundleMismatch(NftId applicationNftId);
 
     event LogPoolVerifiedByPool(address pool, NftId applicationNftId, Amount collateralizationAmount);
 
-    /// @dev increases the staked tokens by the specified amount
-    /// only the bundle owner may stake tokens
-    /// bundle MUST be in active or locked state
-    function stake(NftId bundleNftId, Amount amount) external;
-
-    /// @dev decreases the staked tokens by the specified amount
-    /// only the bundle owner may unstake tokens from the bundle
-    /// bundle MUST be in active, locked or closed state
-    function unstake(NftId bundleNftId, Amount amount) external;
-
-    /// @dev extends the bundle lifetime of the bundle by the specified time
-    /// only the bundle owner may extend the bundle's lifetime
-    /// bundle MUST be in active or locked state
-    function extend(NftId bundleNftId, Seconds lifetimeExtension) external;
-
-    /// @dev locks the specified bundle
-    /// a bundle to be locked MUST be in active state
-    /// locked bundles may not be used to collateralize any new policy
-    function lockBundle(NftId bundleNftId) external;
-
-    /// @dev unlocks the specified bundle
-    /// a bundle to be unlocked MUST be in locked state
-    function unlockBundle(NftId bundleNftId) external;
-
-    /// @dev close the specified bundle
-    /// a bundle to be closed MUST be in active or locked state
-    /// to close a bundle all all linked policies MUST be in closed state as well
-    /// closing a bundle finalizes the bundle bookkeeping including overall profit calculation
-    /// once a bundle is closed this action cannot be reversed
-    function close(NftId bundleNftId) external;
-
-    /// @dev sets the fee for the specified bundle
-    /// the fee is added on top of the poolFee and deducted from the premium amounts
-    /// via these fees individual bundler owner may earn income per policy in the context of peer to peer pools
-    function setBundleFee(
-        NftId bundleNftId, 
-        Fee memory fee
-    ) external;
-
-    /// @dev sets the maximum overall capital amound held by this pool
-    /// function may only be called by pool owner
-    function setMaxCapitalAmount(Amount maxCapitalAmount) external;
-
-    /// @dev sets the required role to create/own bundles
-    /// may only be called once after setting up a pool
-    /// may only be called by pool owner 
-    function setBundleOwnerRole(RoleId bundleOwnerRole) external;
-
-    /// @dev update pool fees to the specified values
-    /// pool fees: are deducted from the premium amount and goes to the pool owner
-    /// staking fees: are deducted from the staked tokens by a bundle owner and goes to the pool owner
-    /// performance fees: when a bundle is closed a bundle specific profit is calculated
-    /// the performance fee is deducted from this profit and goes to the pool owner
-    function setFees(
-        Fee memory poolFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external;
-
     /// @dev this is a callback function that is called by the product service when underwriting a policy.
     /// the pool has the option to check the details and object to underwriting by reverting.
     /// the function is only called for "active" pools that ask to be involved/notified
@@ -106,9 +46,7 @@ interface IPoolComponent is IComponent {
         view
         returns (bool isMatching);
 
-    /// @dev returns pool specific infos for this pool
-    /// when registered with an instance the info is obtained from the data stored in the instance
-    /// when not registered the function returns the info from the component contract
-    function getPoolInfo() external view returns (IComponents.PoolInfo memory info);
+    /// @dev returns initial pool specific infos for this pool
+    function getInitialPoolInfo() external view returns (IComponents.PoolInfo memory info);
 
 }

package/contracts/pool/IPoolService.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {Amount} from "../type/Amount.sol";
 import {Fee} from "../type/Fee.sol";
@@ -7,11 +7,13 @@ import {NftId} from "../type/NftId.sol";
 import {PayoutId} from "../type/PayoutId.sol";
 import {IBundle} from "../instance/module/IBundle.sol";
 import {IInstance} from "../instance/IInstance.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 import {IService} from "../shared/IService.sol";
 import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {StateId} from "../type/StateId.sol";
+import {UFixed} from "../type/UFixed.sol";
 
 interface IPoolService is IService {
 
@@ -22,12 +24,8 @@ interface IPoolService is IService {
     event LogPoolServiceBundleClosed(NftId instanceNftId, NftId poolNftId, NftId bundleNftId);
 
     error ErrorPoolServiceBundleOwnerRoleAlreadySet(NftId poolNftId);
-    error ErrorPoolServiceBundlePoolMismatch(NftId bundlePoolNftId, NftId productPoolNftId);
     error ErrorPoolServiceInvalidTransferAmount(Amount expectedAmount, Amount actualAmount);
 
-    /// @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;
@@ -50,17 +48,24 @@ interface IPoolService is IService {
     /// may only be called by the policy service for unlocked pool components
     function lockCollateral(
         IInstance instance, 
+        address token,
         NftId productNftId,
         NftId applicationNftId,
-        IPolicy.PolicyInfo memory applicationInfo,
-        Amount premiumAmount
-    ) external;
+        NftId bundleNftId,
+        Amount sumInsuredAmount // premium amount after product and distribution fees
+    )
+        external
+        returns (
+            Amount localCollateralAmount,
+            Amount totalCollateralAmount
+        );
 
 
     /// @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, 
+        address token,
         NftId policyNftId, 
         IPolicy.PolicyInfo memory policyInfo
     ) external;
@@ -71,6 +76,7 @@ interface IPoolService is IService {
     /// may only be called by the claim service for unlocked pool components
     function reduceCollateral(
         IInstance instance, 
+        address token,
         NftId policyNftId, 
         IPolicy.PolicyInfo memory policyInfo,
         Amount payoutAmount
@@ -98,8 +104,9 @@ interface IPoolService is IService {
     /// may only be called by registered and unlocked pool components
     function closeBundle(NftId bundleNftId) external;
 
+
     /// @dev processes the sale of a bundle and track the pool fee and bundle fee amounts
-    function processSale(NftId bundleNftId, IPolicy.Premium memory premium, Amount actualAmountTransferred) external;
+    function processSale(NftId bundleNftId, IPolicy.Premium memory premium) external;
 
     /// @dev increase stakes for bundle
     /// staking fees will be deducted by the pool service from the staking amount
@@ -111,4 +118,33 @@ interface IPoolService is IService {
     /// 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);
+
+
+    /// @dev calulate required collateral for the provided parameters
+    function calculateRequiredCollateral(
+        InstanceReader instanceReader,
+        NftId productNftId, 
+        Amount sumInsuredAmount
+    )
+        external
+        view 
+        returns(
+            Amount localCollateralAmount,
+            Amount totalCollateralAmount
+        );
+
+
+    /// @dev calulate required collateral for the provided parameters
+    function calculateRequiredCollateral(
+        UFixed collateralizationLevel, 
+        UFixed retentionLevel, 
+        Amount sumInsuredAmount
+    )
+        external
+        pure 
+        returns(
+            Amount localCollateralAmount,
+            Amount totalCollateralAmount
+        );
+
 }