@etherisc/gif-next 0.0.2-d437d8d-974 → 0.0.2-d43ca2d-657

package/contracts/pool/PoolService.sol

@@ -1,42 +1,41 @@
 // SPDX-License-Identifier: Apache-2.0
 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 {IInstanceService} from "../instance/IInstanceService.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
+import {IPoolComponent} from "../pool/IPoolComponent.sol";
 import {IPoolService} from "./IPoolService.sol";
+import {IProductComponent} from "../product/IProductComponent.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
-import {IRegistryService} from "../registry/IRegistryService.sol";
 import {IStaking} from "../staking/IStaking.sol";
 
 import {Amount, AmountLib} from "../type/Amount.sol";
+import {ClaimId} from "../type/ClaimId.sol";
+import {ContractLib} from "../shared/ContractLib.sol";
 import {Fee, FeeLib} from "../type/Fee.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, POOL, BUNDLE, COMPONENT, INSTANCE, REGISTRY} from "../type/ObjectType.sol";
-import {RoleId, PUBLIC_ROLE} from "../type/RoleId.sol";
+import {ObjectType, ACCOUNTING, POOL, BUNDLE, PRODUCT, POLICY, COMPONENT} from "../type/ObjectType.sol";
 import {Fee, FeeLib} from "../type/Fee.sol";
 import {KEEP_STATE} from "../type/StateId.sol";
-import {Seconds} from "../type/Seconds.sol";
 import {UFixed} from "../type/UFixed.sol";
-import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
+import {Service} from "../shared/Service.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
 
 string constant POOL_SERVICE_NAME = "PoolService";
 
 contract PoolService is 
-    ComponentVerifyingService, 
+    Service, 
     IPoolService 
 {
+    IAccountingService private _accountingService;
     IBundleService internal _bundleService;
     IComponentService internal _componentService;
-    IInstanceService private _instanceService;
-    IRegistryService private _registryService;
-
     IStaking private _staking;
 
     function _initialize(
@@ -48,29 +47,27 @@ contract PoolService is
         initializer()
     {
         (
-            address registryAddress,, 
-            //address managerAddress
-            address authority
-        ) = abi.decode(data, (address, address, address));
+            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()));
         _bundleService = IBundleService(_getServiceAddress(BUNDLE()));
-        _instanceService = IInstanceService(_getServiceAddress(INSTANCE()));
         _componentService = IComponentService(_getServiceAddress(COMPONENT()));
-
         _staking = IStaking(getRegistry().getStakingAddress());
 
         _registerInterface(type(IPoolService).interfaceId);
     }
 
+
     /// @inheritdoc IPoolService
     function setMaxBalanceAmount(Amount maxBalanceAmount)
         external
         virtual
     {
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        (NftId poolNftId, IInstance instance) = _getAndVerifyActivePool();
         InstanceReader instanceReader = instance.getInstanceReader();
         IComponents.PoolInfo memory poolInfo = instanceReader.getPoolInfo(poolNftId);
 
@@ -81,75 +78,21 @@ contract PoolService is
         emit LogPoolServiceMaxBalanceAmountUpdated(poolNftId, previousMaxBalanceAmount, maxBalanceAmount);
     }
 
-    function setBundleOwnerRole(RoleId bundleOwnerRole)
-        external
-        virtual
-    {
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
-        InstanceReader instanceReader = instance.getInstanceReader();
-
-        IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
-        IComponents.PoolInfo memory poolInfo = abi.decode(componentInfo.data, (IComponents.PoolInfo));
-
-        // bundle owner role may only be set once per pool
-        if(poolInfo.bundleOwnerRole != PUBLIC_ROLE()) {
-            revert ErrorPoolServiceBundleOwnerRoleAlreadySet(poolNftId);
-        }
-
-        poolInfo.bundleOwnerRole = bundleOwnerRole;
-        instance.getInstanceStore().updatePool(poolNftId, poolInfo, KEEP_STATE());
-
-        emit LogPoolServiceBundleOwnerRoleSet(poolNftId, bundleOwnerRole);
-    }
-
-    /// @inheritdoc IPoolService
-    function createBundle(
-        address bundleOwner, // initial bundle owner
-        Fee memory fee, // fees deducted from premium that go to bundle owner
-        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 
-        virtual
-        returns(NftId bundleNftId)
-    {
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
-
-        // create the empty bundle
-        bundleNftId = _bundleService.create(
-            instance,
-            poolNftId,
-            bundleOwner,
-            fee,
-            AmountLib.zero(), 
-            lifetime,
-            filter);
-
-        emit LogPoolServiceBundleCreated(instance.getNftId(), poolNftId, bundleNftId);
-    }
-
-    function _getStakingFee(InstanceReader instanceReader, NftId poolNftId)
-        internal
-        virtual
-        view
-        returns (Fee memory stakingFee)
-    {
-        NftId productNftId = instanceReader.getComponentInfo(poolNftId).productNftId;
-        return instanceReader.getProductInfo(productNftId).stakingFee;
-    }
 
     function closeBundle(NftId bundleNftId)
         external
         virtual
     {
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        _checkNftType(bundleNftId, BUNDLE());
+
+        (NftId poolNftId, IInstance instance) = _getAndVerifyActivePool();
 
         // TODO get performance fee for pool (#477)
 
         // releasing collateral in bundle
         (Amount unstakedAmount, Amount feeAmount) = _bundleService.close(instance, bundleNftId);
 
-        _componentService.decreasePoolBalance(
+        _accountingService.decreasePoolBalance(
             instance.getInstanceStore(), 
             poolNftId, 
             unstakedAmount +  feeAmount, 
@@ -160,12 +103,47 @@ contract PoolService is
         if ((unstakedAmount + feeAmount).gtz()){
             IComponents.ComponentInfo memory poolComponentInfo = instance.getInstanceReader().getComponentInfo(poolNftId);
             poolComponentInfo.tokenHandler.distributeTokens(
-                poolComponentInfo.wallet, 
+                poolComponentInfo.tokenHandler.getWallet(), 
                 getRegistry().ownerOf(bundleNftId), 
                 unstakedAmount + feeAmount);
         }
     }
 
+
+    /// @inheritdoc IPoolService
+    function processFundedClaim(
+        NftId policyNftId, 
+        ClaimId claimId, 
+        Amount availableAmount
+    ) 
+        external
+        virtual
+    {
+        _checkNftType(policyNftId, POLICY());
+
+        (NftId poolNftId, IInstance instance) = _getAndVerifyActivePool();
+        InstanceReader instanceReader = instance.getInstanceReader();
+        NftId productNftId = getRegistry().getObjectInfo(poolNftId).parentNftId;
+
+        // check policy matches with calling pool
+        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
+        if(policyInfo.productNftId != productNftId) {
+            revert ErrorPoolServicePolicyPoolMismatch(
+                policyNftId, 
+                policyInfo.productNftId, 
+                productNftId);
+        }
+
+        emit LogPoolServiceProcessFundedClaim(policyNftId, claimId, availableAmount);
+
+        // callback to product component if applicable
+        if (instanceReader.getProductInfo(productNftId).isProcessingFundedClaims) {
+            address productAddress = getRegistry().getObjectAddress(productNftId);
+            IProductComponent(productAddress).processFundedClaim(policyNftId, claimId, availableAmount);
+        }
+    }
+
+
     /// @inheritdoc IPoolService
     function stake(NftId bundleNftId, Amount amount) 
         external 
@@ -173,7 +151,9 @@ contract PoolService is
         // TODO: restricted() (once #462 is done)
         returns(Amount netAmount) 
     {
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        _checkNftType(bundleNftId, BUNDLE());
+
+        (NftId poolNftId, IInstance instance) = _getAndVerifyActivePool();
         InstanceReader instanceReader = instance.getInstanceReader();
         IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
         IComponents.PoolInfo memory poolInfo = instanceReader.getPoolInfo(poolNftId);
@@ -190,16 +170,22 @@ contract PoolService is
         }
 
         // calculate fees
+        IRegistry registry = getRegistry();
         Amount feeAmount;
-        (
-            feeAmount,
-            netAmount
-        ) = FeeLib.calculateFee(
-            _getStakingFee(instanceReader, poolNftId), 
-            amount);
 
-        // do all the bookkeeping
-        _componentService.increasePoolBalance(
+        {
+            NftId productNftId = registry.getObjectInfo(poolNftId).parentNftId;
+            Fee memory stakingFee = instanceReader.getProductInfo(productNftId).stakingFee;
+            (
+                feeAmount,
+                netAmount
+            ) = FeeLib.calculateFee(
+                stakingFee, 
+                amount);
+        }
+
+        // do all the book keeping
+        _accountingService.increasePoolBalance(
             instance.getInstanceStore(), 
             poolNftId, 
             netAmount, 
@@ -207,18 +193,22 @@ contract PoolService is
 
         _bundleService.stake(instance, bundleNftId, netAmount);
 
-        // collect tokens from bundle owner
-        address bundleOwner = getRegistry().ownerOf(bundleNftId);
         emit LogPoolServiceBundleStaked(instance.getNftId(), poolNftId, bundleNftId, amount, netAmount);
 
-        // TODO only collect staking token when pool is not externally managed 
-        _collectStakingAmount(
-            instanceReader, 
-            poolNftId, 
-            bundleOwner, 
-            amount);
+        // only collect staking amount when pool is not externally managed
+        if (!poolInfo.isExternallyManaged) {
+
+            // collect tokens from bundle owner
+            address bundleOwner = getRegistry().ownerOf(bundleNftId);
+            _collectStakingAmount(
+                instanceReader,
+                poolNftId, 
+                bundleOwner, 
+                amount);
+        }
     }
 
+
     /// @inheritdoc IPoolService
     function unstake(NftId bundleNftId, Amount amount) 
         external 
@@ -226,11 +216,13 @@ contract PoolService is
         // TODO: restricted() (once #462 is done)
         returns(Amount netAmount) 
     {
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        _checkNftType(bundleNftId, BUNDLE());
+
+        (NftId poolNftId, IInstance instance) = _getAndVerifyActivePool();
         InstanceReader instanceReader = instance.getInstanceReader();
         InstanceStore instanceStore = instance.getInstanceStore();
         IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-        
+
         if (bundleInfo.poolNftId != poolNftId) {
             revert ErrorPoolServiceBundlePoolMismatch(bundleNftId, poolNftId);
         }
@@ -242,46 +234,86 @@ contract PoolService is
         // if amount was max, this was set to the available amount
 
         // TODO: handle performance fees (issue #477)
+        netAmount = unstakedAmount;
 
         // update pool bookkeeping - performance fees stay in the pool, but as fees 
-        _componentService.decreasePoolBalance(
+        _accountingService.decreasePoolBalance(
             instanceStore, 
             poolNftId, 
             unstakedAmount, 
             AmountLib.zero());
 
-        IComponents.ComponentInfo memory poolComponentInfo = instanceReader.getComponentInfo(poolNftId);
-        address poolWallet = poolComponentInfo.wallet;
-        // transfer amount to bundle owner
-        address owner = getRegistry().ownerOf(bundleNftId);
-        emit LogPoolServiceBundleUnstaked(instance.getNftId(), poolNftId, bundleNftId, unstakedAmount);
-        poolComponentInfo.tokenHandler.distributeTokens(
-            poolWallet, 
-            owner, 
-            unstakedAmount);
-        return unstakedAmount;
+
+        emit LogPoolServiceBundleUnstaked(instance.getNftId(), poolNftId, bundleNftId, unstakedAmount, netAmount);
+
+        // only distribute staking amount when pool is not externally managed
+        if (!instanceReader.getPoolInfo(poolNftId).isExternallyManaged) {
+
+            // transfer amount to bundle owner
+            address bundleOwner = getRegistry().ownerOf(bundleNftId);
+            _distributeUnstakingAmount(
+                instanceReader,
+                poolNftId, 
+                bundleOwner, 
+                netAmount);
+        }
     }
 
 
-    function fundPoolWallet(NftId poolNftId, Amount amount)
+    function fundPoolWallet(Amount amount)
         external
         virtual
-        restricted()
+        // restricted()
     {
-        // TODO check that poolNftId is externally managed
-        // TODO implement
+        (
+            NftId poolNftId,
+            IInstance instance
+        ) = _getAndVerifyActivePool();
+
+        // check that pool is externally managed
+        InstanceReader reader = instance.getInstanceReader();
+        if (!reader.getPoolInfo(poolNftId).isExternallyManaged) {
+            revert ErrorPoolServicePoolNotExternallyManaged(poolNftId);
+        }
+
+        address poolOwner = getRegistry().ownerOf(poolNftId);
+        emit LogPoolServiceWalletFunded(poolNftId, poolOwner, amount);
+
+        _collectStakingAmount(
+            reader,
+            poolNftId, 
+            poolOwner, 
+            amount);
     }
 
 
-    function defundPoolWallet(NftId poolNftId, Amount amount)
+    function defundPoolWallet(Amount amount)
         external
         virtual
-        restricted()
+        // restricted()
     {
-        // TODO check that poolNftId is externally managed
-        // TODO implement
+        (
+            NftId poolNftId,
+            IInstance instance
+        ) = _getAndVerifyActivePool();
+
+        // check that pool is externally managed
+        InstanceReader reader = instance.getInstanceReader();
+        if (!reader.getPoolInfo(poolNftId).isExternallyManaged) {
+            revert ErrorPoolServicePoolNotExternallyManaged(poolNftId);
+        }
+
+        address poolOwner = getRegistry().ownerOf(poolNftId);
+        emit LogPoolServiceWalletDefunded(poolNftId, poolOwner, amount);
+
+        _distributeUnstakingAmount(
+            reader,
+            poolNftId, 
+            poolOwner, 
+            amount);
     }
 
+
     function processSale(
         NftId bundleNftId, 
         IPolicy.PremiumInfo memory premium 
@@ -290,26 +322,27 @@ contract PoolService is
         virtual
         restricted()
     {
+        _checkNftType(bundleNftId, BUNDLE());
+
         IRegistry registry = getRegistry();
-        IRegistry.ObjectInfo memory bundleObjectInfo = registry.getObjectInfo(bundleNftId);
-        IRegistry.ObjectInfo memory poolObjectInfo = registry.getObjectInfo(bundleObjectInfo.parentNftId);
-        IRegistry.ObjectInfo memory instanceObjectInfo = registry.getObjectInfo(poolObjectInfo.parentNftId);
-        IInstance instance = IInstance(instanceObjectInfo.objectAddress);
+        NftId poolNftId = registry.getObjectInfo(bundleNftId).parentNftId;
+        (, address instanceAddress) = ContractLib.getInfoAndInstance(registry, poolNftId, true);
+        IInstance instance = IInstance(instanceAddress);
 
         Amount poolFeeAmount = premium.poolFeeFixAmount + premium.poolFeeVarAmount;
         Amount bundleFeeAmount = premium.bundleFeeFixAmount + premium.bundleFeeVarAmount;
         Amount bundleNetAmount = premium.netPremiumAmount;
 
         InstanceStore instanceStore = instance.getInstanceStore();
-        _componentService.increasePoolBalance(
+        _accountingService.increasePoolBalance(
             instanceStore,
-            poolObjectInfo.nftId,
+            poolNftId,
             bundleNetAmount + bundleFeeAmount, 
             poolFeeAmount);
 
-        _componentService.increaseBundleBalance(
+        _accountingService.increaseBundleBalanceForPool(
             instanceStore,
-            bundleObjectInfo.nftId,
+            bundleNftId,
             bundleNetAmount, 
             bundleFeeAmount);
     }
@@ -327,13 +360,21 @@ contract PoolService is
         virtual
         restricted()
         returns (
-            Amount localCollateralAmount,
-            Amount totalCollateralAmount
+            Amount totalCollateralAmount,
+            Amount localCollateralAmount
         )
     {
+        _checkNftType(productNftId, PRODUCT());
+        _checkNftType(applicationNftId, POLICY());
+        _checkNftType(bundleNftId, BUNDLE());
+
+        NftId poolNftId;
+        bool poolIsVerifyingApplications;
         (
+            poolNftId,
+            totalCollateralAmount,
             localCollateralAmount,
-            totalCollateralAmount
+            poolIsVerifyingApplications
         ) = calculateRequiredCollateral(
             instance.getInstanceReader(),
             productNftId, 
@@ -352,15 +393,23 @@ contract PoolService is
             token,
             totalCollateralAmount);
 
-        // hierarhical riskpool setup
-        // TODO loop in with pool component to guarantee availability of external capital
-        if(totalCollateralAmount > localCollateralAmount) {
+        // pool callback when required
+        if (poolIsVerifyingApplications) {
+            IPoolComponent pool = IPoolComponent(
+                getRegistry().getObjectAddress(poolNftId));
 
+            pool.verifyApplication(
+                applicationNftId, 
+                bundleNftId, 
+                totalCollateralAmount);
+
+            // TODO add logging
         }
-    }
 
+        // TODO add logging
+    }
 
-    function reduceCollateral(
+    function processPayout(
         IInstance instance, 
         address token,
         NftId policyNftId, 
@@ -371,6 +420,24 @@ contract PoolService is
         virtual
         restricted()
     {
+        _checkNftType(policyNftId, POLICY());
+
+        NftId bundleNftId = policyInfo.bundleNftId;
+        NftId poolNftId = getRegistry().getObjectInfo(bundleNftId).parentNftId;
+        InstanceStore instanceStore = instance.getInstanceStore();
+        
+        _accountingService.decreasePoolBalance(
+            instanceStore,
+            poolNftId,
+            payoutAmount, 
+            AmountLib.zero());
+
+        _accountingService.decreaseBundleBalanceForPool(
+            instanceStore,
+            bundleNftId,
+            payoutAmount, 
+            AmountLib.zero());
+
         _bundleService.releaseCollateral(
             instance, 
             policyNftId, 
@@ -397,6 +464,8 @@ contract PoolService is
         virtual
         restricted()
     {
+        _checkNftType(policyNftId, POLICY());
+
         Amount remainingCollateralAmount = policyInfo.sumInsuredAmount - policyInfo.claimAmount;
 
         _bundleService.releaseCollateral(
@@ -405,10 +474,6 @@ contract PoolService is
             policyInfo.bundleNftId, 
             remainingCollateralAmount);
 
-        _bundleService.unlinkPolicy(
-            instance, 
-            policyNftId);
-
         // update value locked with staking service
         _staking.decreaseTotalValueLocked(
             instance.getNftId(),
@@ -425,16 +490,21 @@ contract PoolService is
         public
         view 
         returns(
+            NftId poolNftId,
+            Amount totalCollateralAmount,
             Amount localCollateralAmount,
-            Amount totalCollateralAmount
+            bool poolIsVerifyingApplications
         )
     {
-        NftId poolNftId = instanceReader.getProductInfo(productNftId).poolNftId;
+        _checkNftType(productNftId, PRODUCT());
+
+        poolNftId = instanceReader.getProductInfo(productNftId).poolNftId;
         IComponents.PoolInfo memory poolInfo = instanceReader.getPoolInfo(poolNftId);
+        poolIsVerifyingApplications = poolInfo.isVerifyingApplications;
 
         (
-            localCollateralAmount,
-            totalCollateralAmount
+            totalCollateralAmount,
+            localCollateralAmount
         ) = calculateRequiredCollateral(
             poolInfo.collateralizationLevel,
             poolInfo.retentionLevel,
@@ -450,18 +520,17 @@ contract PoolService is
         public
         pure 
         returns(
-            Amount localCollateralAmount,
-            Amount totalCollateralAmount
+            Amount totalCollateralAmount,
+            Amount localCollateralAmount
         )
     {
-        // TODO define if only applies to local collateral
-        // TODO add minimalistic implementation
-
-        // assumptions 
-        // - collateralizationLevel == 1.0
-        // - retentionLevel == 1.0
-        localCollateralAmount = sumInsuredAmount;
-        totalCollateralAmount = 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());
     }
 
 
@@ -470,6 +539,7 @@ contract PoolService is
         Amount stakingAmount
     )
         internal
+        pure
         returns (Amount stakingNetAmount)
     {
         stakingNetAmount = stakingAmount;
@@ -484,25 +554,61 @@ contract PoolService is
     }
 
 
-    /// @dev transfers the specified amount from the bundle owner to the pool's wallet
+    /// @dev transfers the specified amount from the "from account" to the pool's wallet
     function _collectStakingAmount(
-        InstanceReader instanceReader,
+        InstanceReader reader,
         NftId poolNftId,
-        address bundleOwner,
+        address from,
         Amount amount
     )
         internal
     {
+        IComponents.ComponentInfo memory info = reader.getComponentInfo(poolNftId);
+        info.tokenHandler.collectTokens(
+            from,
+            amount);
+    }
 
-        // collecting investor token
-        IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
-        address poolWallet = componentInfo.wallet;
-        componentInfo.tokenHandler.collectTokens(
-            bundleOwner,
-            poolWallet,
+    /// @dev distributes the specified amount from the pool's wallet to the "to account"
+    function _distributeUnstakingAmount(
+        InstanceReader reader,
+        NftId poolNftId,
+        address to,
+        Amount amount
+    )
+        internal
+    {
+        IComponents.ComponentInfo memory info = reader.getComponentInfo(poolNftId);
+        info.tokenHandler.distributeTokens(
+            info.tokenHandler.getWallet(), 
+            to, 
             amount);
     }
 
+
+    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();
     }