@etherisc/gif-next 0.0.2-f30e0eb-805 → 0.0.2-f398177-971

package/contracts/instance/service/DistributionService.sol

@@ -8,11 +8,12 @@ import {InstanceReader} from "../../instance/InstanceReader.sol";
 import {ISetup} from "../../instance/module/ISetup.sol";
 import {IPolicy} from "../module/IPolicy.sol";
 
+import {Amount, AmountLib} from "../../types/Amount.sol";
 import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
 import {Fee, FeeLib} from "../../types/Fee.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 {ObjectType, DISTRIBUTION, INSTANCE, DISTRIBUTION, DISTRIBUTOR, PRICE} from "../../types/ObjectType.sol";
 import {Version, VersionLib} from "../../types/Version.sol";
 import {RoleId} from "../../types/RoleId.sol";
 
@@ -26,6 +27,7 @@ import {InstanceService} from "../InstanceService.sol";
 import {IComponent} from "../../components/IComponent.sol";
 import {IDistributionComponent} from "../../components/IDistributionComponent.sol";
 import {IDistributionService} from "./IDistributionService.sol";
+import {IPricingService} from "./IPricingService.sol";
 
 import {UFixed, UFixedLib} from "../../types/UFixed.sol";
 import {DistributorType, DistributorTypeLib} from "../../types/DistributorType.sol";
@@ -33,6 +35,7 @@ import {ReferralId, ReferralStatus, ReferralLib} from "../../types/Referral.sol"
 import {Timestamp, TimestampLib, zeroTimestamp} from "../../types/Timestamp.sol";
 import {Key32} from "../../types/Key32.sol";
 import {IDistribution} from "../module/IDistribution.sol";
+import {InstanceStore} from "../InstanceStore.sol";
 
 
 contract DistributionService is
@@ -60,11 +63,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();
     }
 
@@ -87,7 +90,7 @@ contract DistributionService is
         distribution.linkToRegisteredNftId();
         distributionNftId = distributionInfo.nftId;
 
-        instance.createDistributionSetup(distributionNftId, distribution.getSetupInfo());
+        instance.getInstanceStore().createDistributionSetup(distributionNftId, distribution.getSetupInfo());
         // TODO move to distribution?
         bytes4[][] memory selectors = new bytes4[][](2);
         selectors[0] = new bytes4[](1);
@@ -119,15 +122,14 @@ contract DistributionService is
             revert ErrorIDistributionServiceMinFeeTooHigh(minDistributionOwnerFee.fractionalFee.toInt(), distributionFee.fractionalFee.toInt());
         }
 
-        (IRegistry.ObjectInfo memory info , IInstance instance) = _getAndVerifyComponentInfoAndInstance(DISTRIBUTION());
+        (NftId distributionNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(DISTRIBUTION());
         InstanceReader instanceReader = instance.getInstanceReader();
-        NftId distributionNftId = info.nftId;
 
         ISetup.DistributionSetupInfo memory distSetupInfo = instanceReader.getDistributionSetupInfo(distributionNftId);
         distSetupInfo.minDistributionOwnerFee = minDistributionOwnerFee;
         distSetupInfo.distributionFee = distributionFee;
         
-        instance.updateDistributionSetup(distributionNftId, distSetupInfo, KEEP_STATE());
+        instance.getInstanceStore().updateDistributionSetup(distributionNftId, distSetupInfo, KEEP_STATE());
     }
 
     function createDistributorType(
@@ -144,7 +146,7 @@ contract DistributionService is
         external
         returns (DistributorType distributorType)
     {
-        (,NftId distributionNftId, IInstance instance) = _getAndVerifyCallingDistribution();
+        (NftId distributionNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(DISTRIBUTION());
 
         {
             ISetup.DistributionSetupInfo memory setupInfo = instance.getInstanceReader().getDistributionSetupInfo(distributionNftId);
@@ -154,33 +156,33 @@ contract DistributionService is
                 revert ErrorIDistributionServiceMaxDiscountTooHigh(maxDiscountPercentage.toInt(), maxDiscountPercentageLimit.toInt());
             }
         }
-        
+
         distributorType = DistributorTypeLib.toDistributorType(distributionNftId, name);
-        Key32 key32 = distributorType.toKey32();
-
-        if(!instance.exists(key32)) {
-            IDistribution.DistributorTypeInfo memory info = IDistribution.DistributorTypeInfo(
-                name,
-                minDiscountPercentage,
-                maxDiscountPercentage,
-                commissionPercentage,
-                maxReferralCount,
-                maxReferralLifetime,
-                allowSelfReferrals,
-                allowRenewals,
-                data);
-
-            instance.createDistributorType(key32, info);
-        }
+        IDistribution.DistributorTypeInfo memory info = IDistribution.DistributorTypeInfo(
+            name,
+            minDiscountPercentage,
+            maxDiscountPercentage,
+            commissionPercentage,
+            maxReferralCount,
+            maxReferralLifetime,
+            allowSelfReferrals,
+            allowRenewals,
+            data);
+
+        instance.getInstanceStore().createDistributorType(distributorType, info);
     }
 
+
     function createDistributor(
         address distributor,
         DistributorType distributorType,
         bytes memory data
-    ) external returns (NftId distributorNftId)
+    )
+        external 
+        virtual
+        returns (NftId distributorNftId)
     {
-        (, NftId distributionNftId, IInstance instance) = _getAndVerifyCallingDistribution();
+        (NftId distributionNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(DISTRIBUTION());
 
         distributorNftId = getRegistryService().registerDistributor(
             IRegistry.ObjectInfo(
@@ -197,25 +199,27 @@ contract DistributionService is
             distributorType,
             true, // active
             data,
-            0,
+            AmountLib.zero(),
             0);
 
-        instance.createDistributor(distributorNftId, info);
+        instance.getInstanceStore().createDistributor(distributorNftId, info);
     }
 
-    function updateDistributorType(
-        NftId distributorNftId,
-        DistributorType distributorType,
-        bytes memory data
-    ) external virtual
-    {
-        (,, IInstance instance) = _getAndVerifyCallingDistribution();
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IDistribution.DistributorInfo memory distributorInfo = instanceReader.getDistributorInfo(distributorNftId);
-        distributorInfo.distributorType = distributorType;
-        distributorInfo.data = data;
-        instance.updateDistributor(distributorNftId, distributorInfo, KEEP_STATE());
-    }
+    // function updateDistributorType(
+    //     NftId distributorNftId,
+    //     DistributorType distributorType,
+    //     bytes memory data
+    // )
+    //     external
+    //     virtual
+    // {
+    //     (, IInstance instance) = _getAndVerifyCallingDistribution();
+    //     InstanceReader instanceReader = instance.getInstanceReader();
+    //     IDistribution.DistributorInfo memory distributorInfo = instanceReader.getDistributorInfo(distributorNftId);
+    //     distributorInfo.distributorType = distributorType;
+    //     distributorInfo.data = data;
+    //     instance.updateDistributor(distributorNftId, distributorInfo, KEEP_STATE());
+    // }
 
 
     function createReferral(
@@ -230,7 +234,7 @@ contract DistributionService is
         virtual
         returns (ReferralId referralId)
     {
-        (,NftId distributionNftId, IInstance instance) = _getAndVerifyCallingDistribution();
+        (NftId distributionNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(DISTRIBUTION());
 
         if (bytes(code).length == 0) {
             revert ErrorIDistributionServiceInvalidReferral(code);
@@ -240,8 +244,7 @@ contract DistributionService is
         }
 
         InstanceReader instanceReader = instance.getInstanceReader();
-        IDistribution.DistributorInfo memory distributorInfo = instanceReader.getDistributorInfo(distributorNftId);
-        DistributorType distributorType = distributorInfo.distributorType;
+        DistributorType distributorType = instanceReader.getDistributorInfo(distributorNftId).distributorType;
         IDistribution.DistributorTypeInfo memory distributorTypeData = instanceReader.getDistributorTypeInfo(distributorType);
 
         if (distributorTypeData.maxReferralCount < maxReferrals) {
@@ -268,15 +271,15 @@ contract DistributionService is
             data
         );
 
-        instance.createReferral(referralId.toKey32(), info);
+        instance.getInstanceStore().createReferral(referralId, info);
         return referralId;
     }
 
     function processSale(
-        NftId distributionNftId,
+        NftId distributionNftId, // assume always of distribution type
         ReferralId referralId,
         IPolicy.Premium memory premium,
-        uint256 transferredDistributionFeeAmount
+        Amount transferredDistributionFeeAmount
     )
         external
         virtual
@@ -288,109 +291,41 @@ contract DistributionService is
             revert ErrorIDistributionServiceReferralInvalid(distributionNftId, referralId);
         }
 
-        (, IInstance instance) = _getAndVerifyDistribution(distributionNftId);
+        IInstance instance = _getInstanceForDistribution(distributionNftId);
         InstanceReader reader = instance.getInstanceReader();
+        InstanceStore store = instance.getInstanceStore();
         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;
+        Amount distributionOwnerFee = AmountLib.toAmount(premium.distributionOwnerFeeFixAmount + premium.distributionOwnerFeeVarAmount);
+        Amount commissionAmount = AmountLib.toAmount(premium.commissionAmount);
 
-        if (transferredDistributionFeeAmount != distributionOwnerFee + commissionAmount) {
-            revert ErrorIDistributionServiceInvalidFeeTransferred(transferredDistributionFeeAmount, distributionOwnerFee + commissionAmount);
+        if (!(transferredDistributionFeeAmount == distributionOwnerFee + commissionAmount)) {
+            revert ErrorDistributionServiceInvalidFeeTransferred(transferredDistributionFeeAmount, distributionOwnerFee + commissionAmount);
         }
 
 
-        if (distributionOwnerFee > 0) {
-            setupInfo.sumDistributionOwnerFees += distributionOwnerFee;
-            instance.updateDistributionSetup(distributionNftId, setupInfo, KEEP_STATE());
+        if (distributionOwnerFee.gtz()) {
+            setupInfo.sumDistributionOwnerFees += distributionOwnerFee.toInt();
+            store.updateDistributionSetup(distributionNftId, setupInfo, KEEP_STATE());
         }
 
         if (isReferral) {
             referralInfo.usedReferrals += 1;
-            instance.updateReferral(referralId.toKey32(), referralInfo, KEEP_STATE());
+            store.updateReferral(referralId, referralInfo, KEEP_STATE());
 
-            if (commissionAmount > 0) {
-                distributorInfo.sumCommisions += commissionAmount;
+            if (commissionAmount.gtz()) {
+                distributorInfo.commissionAmount = distributorInfo.commissionAmount + commissionAmount;
                 distributorInfo.numPoliciesSold += 1;
-                instance.updateDistributor(referralInfo.distributorNftId, distributorInfo, KEEP_STATE());
+                store.updateDistributor(referralInfo.distributorNftId, distributorInfo, KEEP_STATE());
             }
         }
     }
 
-    function calculateFeeAmount(
-        NftId distributionNftId,
-        ReferralId referralId,
-        IPolicy.Premium memory premium
-    )
-        external
-        virtual
-        view 
-        returns (IPolicy.Premium memory finalPremium)
-    {
-        (, IInstance instance) = _getAndVerifyDistribution(distributionNftId);
-        InstanceReader reader = instance.getInstanceReader();
-        
-        // first calculate all fixed and variable fees for the distribution - this will defined the fullPremium
-        ISetup.DistributionSetupInfo memory setupInfo = reader.getDistributionSetupInfo(distributionNftId);
-        Fee memory distributionFee = setupInfo.distributionFee;
-        Fee memory minDistributionOwnerFee = setupInfo.minDistributionOwnerFee;
-        uint256 distributionFeeVarAmount = (UFixedLib.toUFixed(premium.netPremiumAmount) * distributionFee.fractionalFee).toInt();
-        premium.distributionFeeVarAmount = distributionFeeVarAmount;
-        premium.fullPremiumAmount += distributionFeeVarAmount;
-            
-        // if the referral is not valid, then the distribution owner gets everything
-        if (! referralIsValid(distributionNftId, referralId)) {
-            premium.distributionOwnerFeeFixAmount = premium.distributionFeeFixAmount;
-            premium.distributionOwnerFeeVarAmount = premium.distributionFeeVarAmount;
-            premium.premiumAmount = premium.fullPremiumAmount;
-            return premium;
-        }
-
-        // 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;
-        }
-
-        // 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()) {
@@ -401,67 +336,13 @@ contract DistributionService is
         isValid = isValid && info.usedReferrals < info.maxReferrals;
     }
 
-    function _getAndVerifyCallingDistribution()
-        internal
-        view
-        returns(
-            address distributionAddress,
-            NftId distributionNftId,
-            IInstance instance
-        )
-    {
-        ObjectType objectType;
-        (
-            distributionAddress,
-            distributionNftId,
-            objectType,
-            instance
-        ) = _getAndVerifyCaller();
-
-        if(objectType != DISTRIBUTION()) {
-            revert ErrorIDistributionServiceCallerNotDistributor(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);
-        }
-        instance = IInstance(parentInfo.objectAddress);
-    }
-
-    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

@@ -2,31 +2,28 @@
 pragma solidity ^0.8.19;
 
 import {IPolicy} from "../module/IPolicy.sol";
-import {IRisk} from "../module/IRisk.sol";
 import {IService} from "../../shared/IService.sol";
 
+import {Amount} from "../../types/Amount.sol";
 import {NftId} from "../../types/NftId.sol";
+import {ObjectType} from "../../types/ObjectType.sol";
 import {ReferralId} from "../../types/Referral.sol";
 import {RiskId} from "../../types/RiskId.sol";
 import {Seconds} from "../../types/Seconds.sol";
-import {StateId} from "../../types/StateId.sol";
-import {Timestamp} from "../../types/Timestamp.sol";
-import {UFixed} from "../../types/UFixed.sol";
-import {Fee} from "../../types/Fee.sol";
 
 /// @dev gif service responsible for creating applications
 /// only product components may call transaction functions
 interface IApplicationService is IService {
     
-    error IApplicationServicePolicyNotApplied(NftId applicationNftId);
-    error IApplicationServiceBundlePoolMismatch(NftId bundleNftId, NftId bundlePoolNftId, NftId poolNftId);
+    error ErrorApplicationServiceNotProduct(NftId callerNftId, ObjectType callerType);
+    error ErrorApplicationServiceBundlePoolMismatch(NftId bundleNftId, NftId bundlePoolNftId, NftId poolNftId);
 
     /// @dev creates a new application based on the specified attributes
     /// may only be called by a product component
     function create(
         address applicationOwner,
         RiskId riskId,
-        uint256 sumInsuredAmount,
+        Amount sumInsuredAmount,
         Seconds lifetime,
         NftId bundleNftId,
         ReferralId referralId,
@@ -41,8 +38,8 @@ interface IApplicationService is IService {
         RiskId riskId,
         NftId bundleNftId,
         ReferralId referralId,
-        uint256 sumInsuredAmount,
-        uint256 lifetime,
+        Amount sumInsuredAmount,
+        Seconds lifetime,
         bytes memory applicationData
     ) external;
 
@@ -62,21 +59,4 @@ interface IApplicationService is IService {
     /// an application can only be revoked in applied state
     /// only the application holder may revoke an application
     function revoke(NftId policyNftId) external;
-
-    /// @dev calculates the premium amount for the specified attributes
-    /// also returns the various fee components involved with creating a policy
-    function calculatePremium(
-        NftId productNftId,
-        RiskId riskId,
-        uint256 sumInsuredAmount,
-        Seconds lifetime,
-        bytes memory applicationData,
-        NftId bundleNftId,
-        ReferralId referralId
-    )
-        external
-        view
-        returns (
-            IPolicy.Premium memory premium
-        );
-}
+}

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,110 @@ 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 ErrorBundleServiceInsufficientAllowance(address bundleOwner, address tokenHandlerAddress, Amount amount);
+    error ErrorBundleServiceBundleNotOpen(NftId bundleNftId, StateId state, Timestamp expiredAt);
+    error ErrorBundleServiceCapacityInsufficient(NftId bundleNftId, Amount capacityAmount, Amount collateralAmount);
     error ErrorBundleServiceBundleWithOpenPolicies(NftId bundleNftId, uint256 openPoliciesCount);
 
+    error ErrorBundleServiceBundleUnknown(NftId bundleNftId);
+    error ErrorBundleServiceBundlePoolMismatch(NftId bundleNftId, NftId expectedPool, NftId actualPool);
+
+    error ErrorBundleServicePolicyNotCloseable(NftId policyNftId);
+
+    /// @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 increase bundle stakes by the specified amount
+    /// may only be called by the bundle owner
+    // function stake(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
+
+    // function unstake(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
+
+    /// @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
-        );
-
-    function increaseBalance(IInstance instance, NftId bundleNftId,  uint256 amount) external;
-
-    function closePolicy(IInstance instance, NftId policyNftId, NftId bundleNftId, uint256 collateralAmount) external;
-
-    // function stake(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
+        Amount collateralAmount, 
+        Amount premiumAmount // premium after pool fee
+    ) external;
 
-    // function unstake(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, 
+        Amount collateralAmount
+    ) external;
 
-    function lock(NftId bundleNftId) external;
+    /// @dev unlink policy from bundle
+    /// policy may only be unlinked if policy is closeable
+    /// may only be called by pool service
+    function unlinkPolicy(
+        IInstance instance, 
+        NftId policyNftId
+    ) external;
 
-    function unlock(NftId bundleNftId) external;
+    /// @dev updates the bundle's fees of with the provided fee amount
+    function updateBundleFees(
+        IInstance instance,
+        NftId bundleNftId,
+        Amount feeAmount
+    ) external;
 
-    function close(NftId bundleNftId) external;
+    function increaseBalance(
+        IInstance instance, 
+        NftId bundleNftId,  
+        Amount amount) external;
 }