@etherisc/gif-next 0.0.2-a755cba-665 → 0.0.2-a7722ab-390

package/contracts/pool/BundleService.sol

@@ -45,11 +45,11 @@ contract BundleService is
         initializer()
     {
         (
-            address registryAddress,
-            address authority
+            address authority,
+            address registry
         ) = abi.decode(data, (address, address));
 
-        _initializeService(registryAddress, authority, owner);
+        __Service_init(authority, registry, owner);
 
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
         _accountingService = IAccountingService(_getServiceAddress(ACCOUNTING()));
@@ -144,6 +144,7 @@ contract BundleService is
         virtual
         restricted()
     {
+        // checks
         _checkNftType(policyNftId, POLICY());
         _checkNftType(bundleNftId, BUNDLE());
 
@@ -175,6 +176,7 @@ contract BundleService is
             }
         }
 
+        // effects
         // updated locked amount
         instanceStore.increaseLocked(bundleNftId, collateralAmount);
     }
@@ -185,6 +187,7 @@ contract BundleService is
         virtual
         restricted()
     {
+        // checks
         _checkNftType(bundleNftId, BUNDLE());
 
         (,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
@@ -192,6 +195,7 @@ contract BundleService is
         // udpate bundle state
         instance.getInstanceStore().updateBundleState(bundleNftId, PAUSED());
 
+        // effects
         // update set of active bundles
         BundleSet bundleManager = instance.getBundleSet();
         bundleManager.lock(bundleNftId);
@@ -205,10 +209,12 @@ contract BundleService is
         virtual
         restricted()
     {
+        // checks
         _checkNftType(bundleNftId, BUNDLE());
 
         (,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
 
+        // effects
         // udpate bundle state
         instance.getInstanceStore().updateBundleState(bundleNftId, ACTIVE());
 
@@ -229,6 +235,7 @@ contract BundleService is
         restricted()
         returns (Amount unstakedAmount, Amount feeAmount)
     {
+        // checks
         _checkNftType(bundleNftId, BUNDLE());
 
         InstanceReader instanceReader = instance.getInstanceReader();
@@ -240,6 +247,7 @@ contract BundleService is
             revert ErrorBundleServiceBundleWithOpenPolicies(bundleNftId, openPolicies);
         }
 
+        // effects
         {
             // update bundle state
             InstanceStore instanceStore = instance.getInstanceStore();
@@ -256,7 +264,8 @@ contract BundleService is
 
     /// @inheritdoc IBundleService
     function stake(
-        IInstance instance,
+        InstanceReader instanceReader,
+        InstanceStore instanceStore,
         NftId bundleNftId, 
         Amount amount
     ) 
@@ -264,10 +273,11 @@ contract BundleService is
         virtual
         restricted()
     {
+        // checks
         _checkNftType(bundleNftId, BUNDLE());
 
-        IBundle.BundleInfo memory bundleInfo = instance.getInstanceReader().getBundleInfo(bundleNftId);
-        StateId bundleState = instance.getInstanceReader().getBundleState(bundleNftId);
+        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
+        StateId bundleState = instanceReader.getBundleState(bundleNftId);
 
         if( (bundleState != ACTIVE() && bundleState != PAUSED()) // locked bundles can be staked
             || bundleInfo.expiredAt < TimestampLib.blockTimestamp() 
@@ -275,8 +285,9 @@ contract BundleService is
             revert ErrorBundleServiceBundleNotOpen(bundleNftId, bundleState, bundleInfo.expiredAt);
         }
 
+        // effects
         _accountingService.increaseBundleBalance(
-            instance.getInstanceStore(), 
+            instanceStore, 
             bundleNftId, 
             amount, 
             AmountLib.zero());
@@ -284,7 +295,7 @@ contract BundleService is
 
     /// @inheritdoc IBundleService
     function unstake(
-        IInstance instance, 
+        InstanceStore instanceStore,
         NftId bundleNftId, 
         Amount amount
     ) 
@@ -293,9 +304,9 @@ contract BundleService is
         restricted()
         returns (Amount unstakedAmount)
     {
+        // checks
         _checkNftType(bundleNftId, BUNDLE());
 
-        InstanceStore instanceStore = instance.getInstanceStore();
         (
             Amount balanceAmount,
             Amount lockedAmount,
@@ -315,6 +326,7 @@ contract BundleService is
             revert ErrorBundleServiceUnstakeAmountExceedsLimit(amount, availableAmount);
         }
 
+        // effects
         _accountingService.decreaseBundleBalance(
             instanceStore, 
             bundleNftId, 
@@ -329,6 +341,7 @@ contract BundleService is
         restricted()
         returns (Timestamp extendedExpiredAt) 
     {
+        // checks
         _checkNftType(bundleNftId, BUNDLE());
 
         (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
@@ -349,17 +362,18 @@ contract BundleService is
             revert ErrorBundleServiceExtensionLifetimeIsZero();
         }
 
+        // effects
         bundleInfo.expiredAt = bundleInfo.expiredAt.addSeconds(lifetimeExtension);
-        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+        extendedExpiredAt = bundleInfo.expiredAt;
 
-        emit LogBundleServiceBundleExtended(bundleNftId, lifetimeExtension, bundleInfo.expiredAt);
+        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
 
-        return bundleInfo.expiredAt;
+        emit LogBundleServiceBundleExtended(bundleNftId, lifetimeExtension, extendedExpiredAt);
     }
 
 
     function releaseCollateral(
-        IInstance instance,
+        InstanceStore instanceStore,
         NftId policyNftId, 
         NftId bundleNftId, 
         Amount collateralAmount
@@ -371,54 +385,10 @@ contract BundleService is
         _checkNftType(policyNftId, POLICY());
         _checkNftType(bundleNftId, BUNDLE());
 
-        instance.getInstanceStore().decreaseLocked(bundleNftId, collateralAmount);
+        instanceStore.decreaseLocked(bundleNftId, collateralAmount);
     }
 
 
-    /// @inheritdoc IBundleService
-    function withdrawBundleFees(NftId bundleNftId, Amount amount) 
-        public 
-        virtual
-        restricted()
-        returns (Amount withdrawnAmount) 
-    {
-        _checkNftType(bundleNftId, BUNDLE());
-
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
-        InstanceReader reader = instance.getInstanceReader();
-        
-        IComponents.ComponentInfo memory poolInfo = reader.getComponentInfo(poolNftId);
-        address poolWallet = poolInfo.tokenHandler.getWallet();
-        
-        // IBundle.BundleInfo memory bundleInfo = reader.getBundleInfo(bundleNftId);
-        
-        // determine withdrawn amount
-        withdrawnAmount = amount;
-        if (withdrawnAmount.gte(AmountLib.max())) {
-            withdrawnAmount = reader.getFeeAmount(bundleNftId);
-        } else {
-            if (withdrawnAmount.gt(reader.getFeeAmount(bundleNftId))) {
-                revert ErrorBundleServiceFeesWithdrawAmountExceedsLimit(withdrawnAmount, reader.getFeeAmount(bundleNftId));
-            }
-        }
-
-        // decrease fee counters by withdrawnAmount
-        {
-            InstanceStore store = instance.getInstanceStore();
-            // decrease fee amount of the bundle
-            _accountingService.decreaseBundleBalance(store, bundleNftId, AmountLib.zero(), withdrawnAmount);
-            // decrease pool balance 
-            _accountingService.decreasePoolBalance(store, poolNftId, withdrawnAmount, AmountLib.zero());
-        }
-
-        // transfer amount to bundle owner
-        {
-            address owner = getRegistry().ownerOf(bundleNftId);
-            emit LogBundleServiceFeesWithdrawn(bundleNftId, owner, address(poolInfo.token), withdrawnAmount);
-            poolInfo.tokenHandler.distributeTokens(poolWallet, owner, withdrawnAmount);
-        }
-    }
-
     function _getDomain() internal pure override returns(ObjectType) {
         return BUNDLE();
     }

package/contracts/pool/BundleServiceManager.sol

@@ -17,7 +17,7 @@ contract BundleServiceManager is ProxyManager {
     ) 
     {
         BundleService svc = new BundleService{salt: salt}();
-        bytes memory data = abi.encode(registry, authority);
+        bytes memory data = abi.encode(authority, registry);
         IVersionable versionable = initialize(
             registry,
             address(svc), 

package/contracts/pool/IBundleService.sol

@@ -1,11 +1,14 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IService} from "../shared/IService.sol";
+import {IInstance} from "../instance/IInstance.sol";
+
 import {Amount} from "../type/Amount.sol";
 import {NftId} from "../type/NftId.sol";
 import {Fee} from "../type/Fee.sol";
-import {IService} from "../shared/IService.sol";
-import {IInstance} from "../instance/IInstance.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
+import {InstanceStore} from "../instance/InstanceStore.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {StateId} from "../type/StateId.sol";
 import {Timestamp} from "../type/Timestamp.sol";
@@ -25,14 +28,11 @@ interface IBundleService is IService {
     error ErrorBundleServiceBundlePoolMismatch(NftId bundleNftId, NftId expectedPool, NftId actualPool);
 
     error ErrorBundleServicePolicyNotCloseable(NftId policyNftId);
-
-    error ErrorBundleServiceFeesWithdrawAmountExceedsLimit(Amount amount, Amount limit);
     
     error ErrorBundleServiceUnstakeAmountExceedsLimit(Amount amount, Amount limit);
 
     error ErrorBundleServiceExtensionLifetimeIsZero();
 
-    event LogBundleServiceFeesWithdrawn(NftId bundleNftId, address recipient, address tokenAddress, Amount amount);
     event LogBundleServiceBundleExtended(NftId bundleNftId, Seconds lifetimeExtension, Timestamp extendedExpiredAt);
 
     /// @dev Create a new bundle for the specified attributes.
@@ -48,15 +48,16 @@ interface IBundleService is IService {
 
     /// @dev increase bundle stakes by the specified amount. bundle must not be expired or closed
     /// may only be called by the pool service
-    function stake(IInstance instance, NftId bundleNftId, Amount amount) external;
+    function stake(
+        InstanceReader instanceReader,
+        InstanceStore instanceStore,
+        NftId bundleNftId, 
+        Amount amount
+    ) external;
 
     /// @dev decrease bundle stakes by the specified amount
     /// may only be called by the pool service
-    /// @param instance the instance relevant for the bundle
-    /// @param bundleNftId the bundle nft id
-    /// @param amount the amount to unstake (set to AmountLib.max() to unstake all available stakes)
-    /// @return unstakedAmount the effective unstaked amount
-    function unstake(IInstance instance, NftId bundleNftId, Amount amount) external returns (Amount unstakedAmount);
+    function unstake(InstanceStore instanceStore, NftId bundleNftId, Amount amount) external returns (Amount unstakedAmount);
 
     /// @dev extend the lifetime of the bundle by the specified time in seconds
     function extend(NftId bundleNftId, Seconds lifetimeExtension) external returns (Timestamp extendedExpiredAt);
@@ -106,16 +107,9 @@ interface IBundleService is IService {
     /// @dev releases the specified collateral in the bundle
     /// may only be called by pool service
     function releaseCollateral(
-        IInstance instance, 
+        InstanceStore instanceStore, 
         NftId policyNftId, 
         NftId bundleNftId, 
         Amount collateralAmount
     ) external;
-
-    // FIXME: move to pool service
-    /// @dev Withdraw bundle feeds for the given bundle
-    /// @param bundleNftId the bundle Nft Id
-    /// @param amount the amount to withdraw. If set to AMOUNT_MAX, the full commission available is withdrawn
-    /// @return withdrawnAmount the effective withdrawn amount
-    function withdrawBundleFees(NftId bundleNftId, Amount amount) external returns (Amount withdrawnAmount);
 }

package/contracts/pool/IPoolService.sol

@@ -1,13 +1,16 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount} from "../type/Amount.sol";
-import {ClaimId} from "../type/ClaimId.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 {Amount} from "../type/Amount.sol";
+import {ClaimId} from "../type/ClaimId.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
+import {InstanceStore} from "../instance/InstanceStore.sol";
 import {NftId} from "../type/NftId.sol";
+import {PayoutId} from "../type/PayoutId.sol";
 import {UFixed} from "../type/UFixed.sol";
 
 interface IPoolService is IService {
@@ -22,6 +25,8 @@ interface IPoolService is IService {
     event LogPoolServiceBundleStaked(NftId instanceNftId, NftId poolNftId, NftId bundleNftId, Amount amount, Amount netAmount);
     event LogPoolServiceBundleUnstaked(NftId instanceNftId, NftId poolNftId, NftId bundleNftId, Amount amount, Amount netAmount);
 
+    event LogPoolServiceFeesWithdrawn(NftId bundleNftId, address recipient, address tokenAddress, Amount amount);
+
     event LogPoolServiceProcessFundedClaim(NftId policyNftId, ClaimId claimId, Amount availableAmount);
 
     error ErrorPoolServicePoolNotExternallyManaged(NftId poolNftId);
@@ -30,6 +35,7 @@ interface IPoolService is IService {
     error ErrorPoolServiceInvalidTransferAmount(Amount expectedAmount, Amount actualAmount);
     error ErrorPoolServiceBundlePoolMismatch(NftId bundleNftId, NftId poolNftId);
     error ErrorPoolServiceMaxBalanceAmountExceeded(NftId poolNftId, Amount maxBalanceAmount, Amount currentBalanceAmount, Amount transferAmount);
+    error ErrorPoolServiceFeesWithdrawAmountExceedsLimit(Amount amount, Amount limit);
 
     /// @dev sets the max balance amount for the calling pool
     function setMaxBalanceAmount(Amount maxBalanceAmount) external;
@@ -58,7 +64,6 @@ interface IPoolService is IService {
     /// 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;
@@ -68,11 +73,14 @@ interface IPoolService is IService {
     /// every payout of a policy reduces the collateral by the payout amount
     /// may only be called by the claim service for unlocked pool components
     function processPayout(
-        IInstance instance, 
-        address token,
+        InstanceReader instanceReader,
+        InstanceStore instanceStore, 
+        NftId productNftId,
         NftId policyNftId, 
-        IPolicy.PolicyInfo memory policyInfo,
-        Amount payoutAmount
+        NftId bundleNftId,
+        PayoutId payoutId,
+        Amount payoutAmount,
+        address payoutBeneficiary
     ) external;
 
 
@@ -96,6 +104,10 @@ interface IPoolService is IService {
     function closeBundle(NftId bundleNftId) external;
 
 
+    /// @dev Withdraw bundle feeds for the specified bundle.
+    function withdrawBundleFees(NftId bundleNftId, Amount amount) external returns (Amount withdrawnAmount);
+
+
     /// @dev Informs product about available funds to process a confirmed claim.
     /// The function triggers a callback to the product component when the product's property isProcessingFundedClaims is set.
     function processFundedClaim(NftId policyNftId, ClaimId claimId, Amount availableAmount) external;
@@ -119,35 +131,35 @@ interface IPoolService is IService {
     function processSale(NftId bundleNftId, IPolicy.PremiumInfo memory premium) external;
 
 
-    /// @dev Calulate required collateral for the provided parameters.
-    function calculateRequiredCollateral(
-        InstanceReader instanceReader,
-        NftId productNftId, 
-        Amount sumInsuredAmount
-    )
-        external
-        view 
-        returns(
-            NftId poolNftId,
-            Amount totalCollateralAmount,
-            Amount localCollateralAmount,
-            bool poolIsVerifyingApplications
-        );
-
-
-    /// @dev calulate required collateral for the provided parameters.
-    /// Collateralization is applied to sum insured.
-    /// Retention level defines the fraction of the collateral that is required locally.
-    function calculateRequiredCollateral(
-        UFixed collateralizationLevel, 
-        UFixed retentionLevel, 
-        Amount sumInsuredAmount
-    )
-        external
-        pure 
-        returns(
-            Amount totalCollateralAmount,
-            Amount localCollateralAmount
-        );
+    // /// @dev Calulate required collateral for the provided parameters.
+    // function calculateRequiredCollateral(
+    //     InstanceReader instanceReader,
+    //     NftId productNftId, 
+    //     Amount sumInsuredAmount
+    // )
+    //     external
+    //     view 
+    //     returns(
+    //         NftId poolNftId,
+    //         Amount totalCollateralAmount,
+    //         Amount localCollateralAmount,
+    //         bool poolIsVerifyingApplications
+    //     );
+
+
+    // /// @dev calulate required collateral for the provided parameters.
+    // /// Collateralization is applied to sum insured.
+    // /// Retention level defines the fraction of the collateral that is required locally.
+    // function calculateRequiredCollateral(
+    //     UFixed collateralizationLevel, 
+    //     UFixed retentionLevel, 
+    //     Amount sumInsuredAmount
+    // )
+    //     external
+    //     pure 
+    //     returns(
+    //         Amount totalCollateralAmount,
+    //         Amount localCollateralAmount
+    //     );
 
 }

package/contracts/pool/Pool.sol

@@ -127,7 +127,6 @@ abstract contract Pool is
         address registry,
         NftId productNftId,
         string memory name,
-        address token,
         IComponents.PoolInfo memory poolInfo,
         IAuthorization authorization,
         address initialOwner,
@@ -141,7 +140,6 @@ abstract contract Pool is
             registry, 
             productNftId,  
             name, 
-            token, 
             POOL(), 
             authorization, 
             poolInfo.isInterceptingBundleTransfers, 
@@ -240,15 +238,6 @@ abstract contract Pool is
     }
 
 
-    /// @dev Withdraws the specified amount of fees from the bundle.
-    function _withdrawBundleFees(NftId bundleNftId, Amount amount) 
-        internal
-        returns (Amount withdrawnAmount) 
-    {
-        return _getPoolStorage()._bundleService.withdrawBundleFees(bundleNftId, amount);
-    }
-
-
     /// @dev increases the staked tokens by the specified amount
     /// bundle MUST be in active or locked state
     function _stake(
@@ -325,6 +314,15 @@ abstract contract Pool is
     }
 
 
+    /// @dev Withdraws the specified amount of fees from the bundle.
+    function _withdrawBundleFees(NftId bundleNftId, Amount amount) 
+        internal
+        returns (Amount withdrawnAmount) 
+    {
+        return _getPoolStorage()._poolService.withdrawBundleFees(bundleNftId, amount);
+    }
+
+
     function _processFundedClaim(
         NftId policyNftId, 
         ClaimId claimId,