@etherisc/gif-next 0.0.2-b2e620f-736 → 0.0.2-b37fa8b-169

package/contracts/pool/Pool.sol

@@ -123,11 +123,10 @@ abstract contract Pool is
 
     // Internals
 
-    function _initializePool(
+    function __Pool_init(
         address registry,
         NftId productNftId,
         string memory name,
-        address token,
         IComponents.PoolInfo memory poolInfo,
         IAuthorization authorization,
         address initialOwner,
@@ -137,11 +136,10 @@ abstract contract Pool is
         virtual
         onlyInitializing()
     {
-        _initializeInstanceLinkedComponent(
+        __InstanceLinkedComponent_init(
             registry, 
             productNftId,  
             name, 
-            token, 
             POOL(), 
             authorization, 
             poolInfo.isInterceptingBundleTransfers, 
@@ -285,21 +283,11 @@ abstract contract Pool is
     /// @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)
+    function _setBundleLocked(NftId bundleNftId, bool locked)
         internal
         virtual
     {
-        _getPoolStorage()._bundleService.lock(bundleNftId);
-    }
-
-
-    /// @dev Unlocks the specified bundle.
-    /// A bundle to be unlocked MUST be in locked state.
-    function _unlockBundle(NftId bundleNftId)
-        internal
-        virtual
-    {
-        _getPoolStorage()._bundleService.unlock(bundleNftId);
+        _getPoolStorage()._bundleService.setLocked(bundleNftId, locked);
     }
 
 

package/contracts/pool/PoolLib.sol

@@ -15,6 +15,8 @@ import {InstanceReader} from "../instance/InstanceReader.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType, BUNDLE, POOL} from "../type/ObjectType.sol";
+import {PayoutId} from "../type/PayoutId.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
 import {UFixed} from "../type/UFixed.sol";
 
 library PoolLib {
@@ -105,7 +107,7 @@ library PoolLib {
         Amount payoutAmount,
         address payoutBeneficiary
     )
-        external
+        public
         view
         returns (
             Amount netPayoutAmount,
@@ -127,7 +129,7 @@ library PoolLib {
             // calculate processing fees if applicable
             IComponents.FeeInfo memory feeInfo = instanceReader.getFeeInfo(productNftId);
             if(FeeLib.gtz(feeInfo.processingFee)) {
-                // TODO calculate and set net payout and processing fees
+                (processingFeeAmount, netPayoutAmount) = FeeLib.calculateFee(feeInfo.processingFee, payoutAmount);
             }
         }
     }
@@ -204,6 +206,32 @@ library PoolLib {
         instance = IInstance(instanceAddress);
     }
 
+
+    function getAndVerifyActiveComponent(
+        IRegistry registry,
+        address sender,
+        ObjectType expectedComponentType
+    )
+        public
+        view
+        returns (
+            NftId componentNftId,
+            IInstance instance
+        )
+    {
+        (
+            IRegistry.ObjectInfo memory info, 
+            address instanceAddress
+        ) = ContractLib.getAndVerifyComponent(
+            registry, 
+            sender,
+            expectedComponentType,
+            true); // only active components
+
+        componentNftId = info.nftId;
+        instance = IInstance(instanceAddress);
+    }
+
     function checkNftType(
         IRegistry registry, 
         NftId nftId, 
@@ -213,4 +241,101 @@ library PoolLib {
             revert INftOwnable.ErrorNftOwnableInvalidType(nftId, expectedObjectType);
         }
     }
+
+    function transferTokenAndNotifyPolicyHolder(
+        IRegistry registry,
+        InstanceReader instanceReader,
+        TokenHandler poolTokenHandler,
+        NftId productNftId,
+        NftId policyNftId,
+        PayoutId payoutId,
+        Amount payoutAmount,
+        address payoutBeneficiary
+    )
+        external
+        returns (
+            Amount netPayoutAmount,
+            Amount processingFeeAmount
+        )
+    {
+        address beneficiary;
+
+        (
+            netPayoutAmount,
+            processingFeeAmount,
+            beneficiary
+        ) = calculatePayoutAmounts(
+            registry,
+            instanceReader,
+            productNftId, 
+            policyNftId,
+            payoutAmount,
+            payoutBeneficiary);
+
+        // 1st token tx to payout to beneficiary
+        poolTokenHandler.pushToken(
+            beneficiary, 
+            netPayoutAmount);
+
+        // 2nd token tx to transfer processing fees to product wallet
+        // if processingFeeAmount > 0
+        if (processingFeeAmount.gtz()) {
+            poolTokenHandler.pushToken(
+                instanceReader.getWallet(productNftId), 
+                processingFeeAmount);
+        }
+
+        // callback to policy holder if applicable
+        policyHolderPayoutExecuted(
+            registry,
+            policyNftId, 
+            payoutId, 
+            beneficiary, 
+            netPayoutAmount);
+    }
+
+    function policyHolderPayoutExecuted(
+        IRegistry registry,
+        NftId policyNftId, 
+        PayoutId payoutId,
+        address beneficiary,
+        Amount payoutAmount
+    )
+        private
+    {
+        IPolicyHolder policyHolder = getPolicyHolder(registry, policyNftId);
+        if(address(policyHolder) != address(0)) {
+            policyHolder.payoutExecuted(policyNftId, payoutId, payoutAmount, beneficiary);
+        }
+    }
+
+    /// @dev Transfers the specified amount from the "from account" to the pool's wallet
+    function pullStakingAmount(
+        InstanceReader reader,
+        NftId poolNftId,
+        address from,
+        Amount amount
+    )
+        external
+    {
+        IComponents.ComponentInfo memory info = reader.getComponentInfo(poolNftId);
+        info.tokenHandler.pullToken(
+            from,
+            amount);
+    }
+
+    /// @dev Transfers the specified amount from the pool's wallet to the "to account"
+    function pushUnstakingAmount(
+        InstanceReader reader,
+        NftId poolNftId,
+        address to,
+        Amount amount
+    )
+        external
+    {
+        IComponents.ComponentInfo memory info = reader.getComponentInfo(poolNftId);
+        info.tokenHandler.pushToken(
+            to, 
+            amount);
+    }
 }

package/contracts/pool/PoolService.sol

@@ -2,13 +2,11 @@
 pragma solidity ^0.8.20;
 
 import {IAccountingService} from "../accounting/IAccountingService.sol";
-import {IBundle} from "../instance/module/IBundle.sol";
 import {IBundleService} from "./IBundleService.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IComponentService} from "../shared/IComponentService.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
-import {IPolicyHolder} from "../shared/IPolicyHolder.sol";
 import {IPoolComponent} from "../pool/IPoolComponent.sol";
 import {IPoolService} from "./IPoolService.sol";
 import {IProductComponent} from "../product/IProductComponent.sol";
@@ -27,9 +25,6 @@ import {PayoutId} from "../type/PayoutId.sol";
 import {PoolLib} from "./PoolLib.sol";
 import {Service} from "../shared/Service.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
-import {UFixed} from "../type/UFixed.sol";
-
-string constant POOL_SERVICE_NAME = "PoolService";
 
 
 contract PoolService is 
@@ -69,6 +64,7 @@ contract PoolService is
     function setMaxBalanceAmount(Amount maxBalanceAmount)
         external
         virtual
+        restricted()
     {
         (NftId poolNftId, IInstance instance) = _getAndVerifyActivePool();
         InstanceReader instanceReader = instance.getInstanceReader();
@@ -84,6 +80,7 @@ contract PoolService is
 
     function closeBundle(NftId bundleNftId)
         external
+        restricted()
         virtual
     {
         _checkNftType(bundleNftId, BUNDLE());
@@ -119,6 +116,7 @@ contract PoolService is
         Amount availableAmount
     ) 
         external
+        restricted()
         virtual
     {
         _checkNftType(policyNftId, POLICY());
@@ -175,7 +173,7 @@ contract PoolService is
     function stake(NftId bundleNftId, Amount amount) 
         external 
         virtual
-        // TODO: restricted() (once #462 is done)
+        restricted()
         returns(
             Amount netAmount
         ) 
@@ -222,7 +220,7 @@ contract PoolService is
 
             // collect tokens from bundle owner
             address bundleOwner = getRegistry().ownerOf(bundleNftId);
-            _pullStakingAmount(
+            PoolLib.pullStakingAmount(
                 instanceReader,
                 poolNftId, 
                 bundleOwner, 
@@ -235,7 +233,7 @@ contract PoolService is
     function unstake(NftId bundleNftId, Amount amount) 
         external 
         virtual
-        // TODO: restricted() (once #462 is done)
+        restricted()
         returns(Amount netAmount) 
     {
         (
@@ -269,7 +267,7 @@ contract PoolService is
 
             // transfer amount to bundle owner
             address bundleOwner = getRegistry().ownerOf(bundleNftId);
-            _pushUnstakingAmount(
+            PoolLib.pushUnstakingAmount(
                 instanceReader,
                 poolNftId, 
                 bundleOwner, 
@@ -281,7 +279,7 @@ contract PoolService is
     function fundPoolWallet(Amount amount)
         external
         virtual
-        // restricted()
+        restricted()
     {
         (
             NftId poolNftId,
@@ -297,7 +295,7 @@ contract PoolService is
         address poolOwner = getRegistry().ownerOf(poolNftId);
         emit LogPoolServiceWalletFunded(poolNftId, poolOwner, amount);
 
-        _pullStakingAmount(
+        PoolLib.pullStakingAmount(
             reader,
             poolNftId, 
             poolOwner, 
@@ -308,7 +306,7 @@ contract PoolService is
     function defundPoolWallet(Amount amount)
         external
         virtual
-        // restricted()
+        restricted()
     {
         (
             NftId poolNftId,
@@ -324,7 +322,7 @@ contract PoolService is
         address poolOwner = getRegistry().ownerOf(poolNftId);
         emit LogPoolServiceWalletDefunded(poolNftId, poolOwner, amount);
 
-        _pushUnstakingAmount(
+        PoolLib.pushUnstakingAmount(
             reader,
             poolNftId, 
             poolOwner, 
@@ -363,6 +361,8 @@ contract PoolService is
             bundleNftId,
             bundleNetAmount, 
             bundleFeeAmount);
+
+        emit LogPoolServiceSaleProcessed(poolNftId, bundleNftId, bundleNetAmount, bundleFeeAmount, poolFeeAmount);
     }
 
 
@@ -421,10 +421,15 @@ contract PoolService is
                 bundleNftId, 
                 totalCollateralAmount);
 
-            // TODO add logging
+            emit LogPoolServiceApplicationVerified(poolNftId, bundleNftId, applicationNftId, totalCollateralAmount);
         }
 
-        // TODO add logging
+        emit LogPoolServiceCollateralLocked(
+            poolNftId,
+            bundleNftId, 
+            applicationNftId, 
+            totalCollateralAmount, 
+            localCollateralAmount);
     }
 
     function processPayout(
@@ -440,6 +445,10 @@ contract PoolService is
         external
         virtual
         restricted()
+        returns (
+            Amount netPayoutAmount,
+            Amount processingFeeAmount
+        )
     {
         // checks
         _checkNftType(policyNftId, POLICY());
@@ -466,9 +475,7 @@ contract PoolService is
             payoutAmount);
 
         // update value locked with staking service
-        TokenHandler poolTokenHandler = TokenHandler(
-            instanceReader.getTokenHandler(
-                poolNftId));
+        TokenHandler poolTokenHandler = instanceReader.getTokenHandler(poolNftId);
 
         _staking.decreaseTotalValueLocked(
             instanceReader.getInstanceNftId(), 
@@ -476,7 +483,8 @@ contract PoolService is
             payoutAmount);
 
         // interactions
-        _transferTokenAndNotifyPolicyHolder(
+        (netPayoutAmount, processingFeeAmount) = PoolLib.transferTokenAndNotifyPolicyHolder(
+            getRegistry(),
             instanceReader, 
             poolTokenHandler,
             productNftId, 
@@ -484,50 +492,22 @@ contract PoolService is
             payoutId, 
             payoutAmount, 
             payoutBeneficiary);
-    }
-
-    function _transferTokenAndNotifyPolicyHolder(
-        InstanceReader instanceReader,
-        TokenHandler poolTokenHandler,
-        NftId productNftId,
-        NftId policyNftId,
-        PayoutId payoutId,
-        Amount payoutAmount,
-        address payoutBeneficiary
-    )
-        internal
-    {
-        (
-            Amount netPayoutAmount,
-            Amount processingFeeAmount,
-            address beneficiary
-        ) = PoolLib.calculatePayoutAmounts(
-            getRegistry(),
-            instanceReader,
-            productNftId, 
-            policyNftId,
-            payoutAmount,
-            payoutBeneficiary);
-
-        // 1st token tx to payout to beneficiary
-        poolTokenHandler.pushToken(
-            beneficiary, 
-            netPayoutAmount);
-
-        // 2nd token tx to transfer processing fees to product wallet
-        // if processingFeeAmount > 0
+        
         if (processingFeeAmount.gtz()) {
-            poolTokenHandler.pushToken(
-                instanceReader.getWallet(productNftId), 
+            _accountingService.increaseProductFeesForPool(
+                instanceStore,
+                productNftId,
                 processingFeeAmount);
         }
 
-        // callback to policy holder if applicable
-        _policyHolderPayoutExecuted(
+        emit LogPoolServicePayoutProcessed(
+            poolNftId,
+            bundleNftId, 
             policyNftId, 
             payoutId, 
-            beneficiary, 
-            netPayoutAmount);
+            netPayoutAmount, 
+            processingFeeAmount,
+            payoutBeneficiary);
     }
 
 
@@ -607,112 +587,11 @@ contract PoolService is
             instanceReader.getInstanceNftId(),
             address(instanceReader.getToken(policyInfo.productNftId)),
             remainingCollateralAmount);
-    }
-
-
-    // function calculateRequiredCollateral(
-    //     InstanceReader instanceReader,
-    //     NftId productNftId, 
-    //     Amount sumInsuredAmount
-    // )
-    //     public
-    //     view 
-    //     returns(
-    //         NftId poolNftId,
-    //         Amount totalCollateralAmount,
-    //         Amount localCollateralAmount,
-    //         bool poolIsVerifyingApplications
-    //     )
-    // {
-    //     return CollateralLib.calculateRequiredCollateral(
-    //         instanceReader,
-    //         productNftId, 
-    //         sumInsuredAmount);
-    // }
 
-    //     _checkNftType(productNftId, PRODUCT());
-
-    //     poolNftId = instanceReader.getProductInfo(productNftId).poolNftId;
-    //     IComponents.PoolInfo memory poolInfo = instanceReader.getPoolInfo(poolNftId);
-    //     poolIsVerifyingApplications = poolInfo.isVerifyingApplications;
-
-    //     (
-    //         totalCollateralAmount,
-    //         localCollateralAmount
-    //     ) = calculateRequiredCollateral(
-    //         poolInfo.collateralizationLevel,
-    //         poolInfo.retentionLevel,
-    //         sumInsuredAmount);
-    // }
-
-
-    // function calculateRequiredCollateral(
-    //     UFixed collateralizationLevel, 
-    //     UFixed retentionLevel, 
-    //     Amount sumInsuredAmount
-    // )
-    //     public
-    //     pure 
-    //     returns(
-    //         Amount totalCollateralAmount,
-    //         Amount localCollateralAmount
-    //     )
-    // {
-    //     // collateralization is applied to sum insured
-    //     UFixed totalUFixed = collateralizationLevel * sumInsuredAmount.toUFixed();
-    //     totalCollateralAmount = AmountLib.toAmount(totalUFixed.toInt());
-
-    //     // retention level defines how much capital is required locally
-    //     localCollateralAmount = AmountLib.toAmount(
-    //         (retentionLevel * totalUFixed).toInt());
-    // }
-
-
-
-
-    function _policyHolderPayoutExecuted(
-        NftId policyNftId, 
-        PayoutId payoutId,
-        address beneficiary,
-        Amount payoutAmount
-    )
-        internal
-    {
-        IPolicyHolder policyHolder = PoolLib.getPolicyHolder(getRegistry(), policyNftId);
-        if(address(policyHolder) != address(0)) {
-            policyHolder.payoutExecuted(policyNftId, payoutId, payoutAmount, beneficiary);
-        }
-    }
-
-
-    /// @dev Transfers the specified amount from the "from account" to the pool's wallet
-    function _pullStakingAmount(
-        InstanceReader reader,
-        NftId poolNftId,
-        address from,
-        Amount amount
-    )
-        internal
-    {
-        IComponents.ComponentInfo memory info = reader.getComponentInfo(poolNftId);
-        info.tokenHandler.pullToken(
-            from,
-            amount);
-    }
-
-    /// @dev Transfers the specified amount from the pool's wallet to the "to account"
-    function _pushUnstakingAmount(
-        InstanceReader reader,
-        NftId poolNftId,
-        address to,
-        Amount amount
-    )
-        internal
-    {
-        IComponents.ComponentInfo memory info = reader.getComponentInfo(poolNftId);
-        info.tokenHandler.pushToken(
-            to, 
-            amount);
+        emit LogPoolServiceCollateralReleased(
+            policyInfo.bundleNftId, 
+            policyNftId, 
+            remainingCollateralAmount);
     }
 
 
@@ -728,28 +607,6 @@ contract PoolService is
         return PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
     }
 
-    // function _getAndVerifyActivePool()
-    //     internal
-    //     virtual
-    //     view
-    //     returns (
-    //         NftId poolNftId,
-    //         IInstance instance
-    //     )
-    // {
-    //     (
-    //         IRegistry.ObjectInfo memory info, 
-    //         address instanceAddress
-    //     ) = ContractLib.getAndVerifyComponent(
-    //         getRegistry(), 
-    //         msg.sender,
-    //         POOL(),
-    //         true); // only active pools
-
-    //     poolNftId = info.nftId;
-    //     instance = IInstance(instanceAddress);
-    // }
-
 
     function _getDomain() internal pure override returns(ObjectType) {
         return POOL();