@etherisc/gif-next 0.0.2-e94f4c7-084 → 0.0.2-e964d24-516

package/contracts/{instance/service → pool}/IPoolService.sol

@@ -1,20 +1,21 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {Amount} from "../../types/Amount.sol";
-import {Fee} from "../../types/Fee.sol";
-import {NftId} from "../../types/NftId.sol";
-import {IBundle} from "../module/IBundle.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {IPolicy} from "../module/IPolicy.sol";
-import {IService} from "../../shared/IService.sol";
-import {RoleId} from "../../types/RoleId.sol";
-import {Seconds} from "../../types/Seconds.sol";
-import {StateId} from "../../types/StateId.sol";
+import {Amount} from "../type/Amount.sol";
+import {Fee} from "../type/Fee.sol";
+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 {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";
 
 interface IPoolService is IService {
 
-    event LogPoolServiceMaxCapitalAmountUpdated(NftId poolNftId, uint256 previousMaxCapitalAmount, uint256 currentMaxCapitalAmount);
+    event LogPoolServiceMaxCapitalAmountUpdated(NftId poolNftId, Amount previousMaxCapitalAmount, Amount currentMaxCapitalAmount);
     event LogPoolServiceBundleOwnerRoleSet(NftId poolNftId, RoleId bundleOwnerRole);
 
     event LogPoolServiceBundleCreated(NftId instanceNftId, NftId poolNftId, NftId bundleNftId);
@@ -32,7 +33,7 @@ interface IPoolService is IService {
     function setBundleOwnerRole(RoleId bundleOwnerRole) external;
 
     /// @dev sets the max capital amount for the calling pool
-    function setMaxCapitalAmount(uint256 maxCapitalAmount) external;
+    function setMaxCapitalAmount(Amount maxCapitalAmount) external;
 
     /// @dev set pool sepecific fees
     function setFees(
@@ -52,7 +53,7 @@ interface IPoolService is IService {
         NftId productNftId,
         NftId applicationNftId,
         IPolicy.PolicyInfo memory applicationInfo,
-        uint256 premiumAmount
+        Amount premiumAmount
     ) external;
 
 
@@ -65,6 +66,17 @@ interface IPoolService is IService {
     ) external;
 
 
+    /// @dev reduces the locked collateral in the bundle associated with the specified policy
+    /// 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 reduceCollateral(
+        IInstance instance, 
+        NftId policyNftId, 
+        IPolicy.PolicyInfo memory policyInfo,
+        Amount payoutAmount
+    ) external;
+
+
     /// @dev create a new bundle for the provided parameters
     /// staking fees will be deducted by the pool service from the staking amount
     /// may only be called by registered and unlocked pool components
@@ -87,7 +99,7 @@ interface IPoolService is IService {
     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, uint256 actualAmountTransferred) external;
+    function processSale(NftId bundleNftId, IPolicy.Premium memory premium, Amount actualAmountTransferred) external;
 
     /// @dev increase stakes for bundle
     /// staking fees will be deducted by the pool service from the staking amount

package/contracts/{components → pool}/Pool.sol

@@ -1,19 +1,19 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount, AmountLib} from "../types/Amount.sol";
-import {Component} from "./Component.sol";
-import {Fee, FeeLib} from "../types/Fee.sol";
-import {IBundleService} from "../instance/service/IBundleService.sol";
+import {Amount, AmountLib} from "../type/Amount.sol";
+import {Component} from "../shared/Component.sol";
+import {Fee, FeeLib} from "../type/Fee.sol";
+import {IBundleService} from "./IBundleService.sol";
 import {IPoolComponent} from "./IPoolComponent.sol";
-import {IPoolService} from "../instance/service/IPoolService.sol";
+import {IPoolService} from "./IPoolService.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
-import {NftId, NftIdLib} from "../types/NftId.sol";
-import {BUNDLE, POOL} from "../types/ObjectType.sol";
-import {RoleId, PUBLIC_ROLE} from "../types/RoleId.sol";
-import {Seconds} from "../types/Seconds.sol";
+import {NftId, NftIdLib} from "../type/NftId.sol";
+import {BUNDLE, POOL} from "../type/ObjectType.sol";
+import {RoleId, PUBLIC_ROLE} from "../type/RoleId.sol";
+import {Seconds} from "../type/Seconds.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
-import {UFixed, UFixedLib} from "../types/UFixed.sol";
+import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
 abstract contract Pool is
     Component, 
@@ -69,7 +69,7 @@ abstract contract Pool is
 
     function stake(
         NftId bundleNftId, 
-        uint256 amount
+        Amount amount
     )
         public
         virtual
@@ -82,7 +82,7 @@ abstract contract Pool is
 
     function unstake(
         NftId bundleNftId, 
-        uint256 amount
+        Amount amount
     )
         public
         virtual
@@ -149,7 +149,7 @@ abstract contract Pool is
     }
 
 
-    function setMaxCapitalAmount(uint256 maxCapitalAmount)
+    function setMaxCapitalAmount(Amount maxCapitalAmount)
         public
         virtual
         restricted()
@@ -189,7 +189,7 @@ abstract contract Pool is
         bytes memory applicationData,
         NftId bundleNftId, 
         bytes memory bundleFilter,
-        uint256 collateralizationAmount
+        Amount collateralizationAmount
     )
         public
         virtual
@@ -218,7 +218,7 @@ abstract contract Pool is
         bytes memory applicationData,
         NftId bundleNftId, 
         bytes memory bundleFilter,
-        uint256 collateralizationAmount
+        Amount collateralizationAmount
     )
         public
         view
@@ -279,9 +279,9 @@ abstract contract Pool is
                 IComponents.PoolInfo(
                     NftIdLib.zero(), // will be set when GIF registers the related product
                     PUBLIC_ROLE(), // bundleOwnerRole
-                    type(uint256).max, // maxCapitalAmount,
-                    0, // initial balance amount
-                    0, // initial fee amount
+                    AmountLib.max(), // maxCapitalAmount,
+                    AmountLib.zero(), // initial balance amount
+                    AmountLib.zero(), // initial fee amount
                     isNftInterceptor(), // isInterceptingBundleTransfers
                     false, // isExternallyManaged,
                     false, // isVerifyingApplications,

package/contracts/{instance/service → pool}/PoolService.sol

@@ -1,41 +1,41 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {Pool} from "../../components/Pool.sol";
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {IBundle} from "../../instance/module/IBundle.sol";
-import {TokenHandler} from "../../instance/module/ITreasury.sol";
-import {IComponents} from "../module/IComponents.sol";
-import {IPolicy} from "../module/IPolicy.sol";
-
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {Versionable} from "../../shared/Versionable.sol";
-import {INftOwnable} from "../../shared/INftOwnable.sol";
-
-import {Amount, AmountLib} from "../../types/Amount.sol";
-import {Fee, FeeLib} from "../../types/Fee.sol";
-import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
-import {ObjectType, POOL, BUNDLE} from "../../types/ObjectType.sol";
-import {PUBLIC_ROLE, POOL_OWNER_ROLE, POLICY_SERVICE_ROLE, RoleId} from "../../types/RoleId.sol";
-import {Fee, FeeLib} from "../../types/Fee.sol";
-import {Version, VersionLib} from "../../types/Version.sol";
-import {KEEP_STATE, StateId} from "../../types/StateId.sol";
-import {Seconds} from "../../types/Seconds.sol";
-import {TimestampLib, zeroTimestamp} from "../../types/Timestamp.sol";
-import {Version, VersionLib} from "../../types/Version.sol";
-
-import {IService} from "../../shared/IService.sol";
-import {Service} from "../../shared/Service.sol";
-import {BundleManager} from "../BundleManager.sol";
-import {ComponentService} from "../base/ComponentService.sol";
+import {Pool} from "./Pool.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IInstance} from "../instance/IInstance.sol";
+import {IBundle} from "../instance/module/IBundle.sol";
+import {TokenHandler} from "../instance/module/ITreasury.sol";
+import {IComponents} from "../instance/module/IComponents.sol";
+import {IPolicy} from "../instance/module/IPolicy.sol";
+
+import {IVersionable} from "../shared/IVersionable.sol";
+import {Versionable} from "../shared/Versionable.sol";
+import {INftOwnable} from "../shared/INftOwnable.sol";
+
+import {Amount, AmountLib} from "../type/Amount.sol";
+import {Fee, FeeLib} from "../type/Fee.sol";
+import {NftId, NftIdLib, zeroNftId} from "../type/NftId.sol";
+import {ObjectType, POOL, BUNDLE} from "../type/ObjectType.sol";
+import {PUBLIC_ROLE, POOL_OWNER_ROLE, POLICY_SERVICE_ROLE, RoleId} from "../type/RoleId.sol";
+import {Fee, FeeLib} from "../type/Fee.sol";
+import {Version, VersionLib} from "../type/Version.sol";
+import {KEEP_STATE, StateId} from "../type/StateId.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {TimestampLib, zeroTimestamp} from "../type/Timestamp.sol";
+import {Version, VersionLib} from "../type/Version.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 {IBundleService} from "./IBundleService.sol";
 import {IPoolService} from "./IPoolService.sol";
-import {IRegistryService} from "../../registry/IRegistryService.sol";
-import {InstanceService} from "../InstanceService.sol";
-import {InstanceReader} from "../InstanceReader.sol";
-import {IComponent} from "../../components/IComponent.sol";
-import {IPoolComponent} from "../../components/IPoolComponent.sol";
+import {IRegistryService} from "../registry/IRegistryService.sol";
+import {InstanceService} from "../instance/InstanceService.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
+import {IComponent} from "../shared/IComponent.sol";
+import {IPoolComponent} from "./IPoolComponent.sol";
 
 string constant POOL_SERVICE_NAME = "PoolService";
 
@@ -96,7 +96,7 @@ contract PoolService is
         componentInfo.tokenHandler = new TokenHandler(address(componentInfo.token));
 
         // save amended component info with instance
-        instance.createPoolSetup(poolNftId, componentInfo);
+        instance.getInstanceStore().createPoolSetup(poolNftId, componentInfo);
 
         bytes4[][] memory selectors = new bytes4[][](2);
         selectors[0] = new bytes4[](1);
@@ -118,20 +118,20 @@ contract PoolService is
     }
 
 
-    function setMaxCapitalAmount(uint256 maxCapitalAmount)
+    function setMaxCapitalAmount(Amount maxCapitalAmount)
         external
         virtual
     {
-        (NftId poolNftId, IRegistry.ObjectInfo memory registryInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        (NftId poolNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(POOL());
         InstanceReader instanceReader = instance.getInstanceReader();
 
         IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
         IComponents.PoolInfo memory poolInfo = abi.decode(componentInfo.data, (IComponents.PoolInfo));
-        uint256 previousMaxCapitalAmount = poolInfo.maxCapitalAmount;
+        Amount previousMaxCapitalAmount = poolInfo.maxCapitalAmount;
 
         poolInfo.maxCapitalAmount = maxCapitalAmount;
         componentInfo.data = abi.encode(poolInfo);
-        instance.updatePoolSetup(poolNftId, componentInfo, KEEP_STATE());
+        instance.getInstanceStore().updatePoolSetup(poolNftId, componentInfo, KEEP_STATE());
 
         emit LogPoolServiceMaxCapitalAmountUpdated(poolNftId, previousMaxCapitalAmount, maxCapitalAmount);
     }
@@ -140,7 +140,7 @@ contract PoolService is
         external
         virtual
     {
-        (NftId poolNftId, IRegistry.ObjectInfo memory registryInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        (NftId poolNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(POOL());
         InstanceReader instanceReader = instance.getInstanceReader();
 
         IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
@@ -153,7 +153,7 @@ contract PoolService is
 
         poolInfo.bundleOwnerRole = bundleOwnerRole;
         componentInfo.data = abi.encode(poolInfo);
-        instance.updatePoolSetup(poolNftId, componentInfo, KEEP_STATE());
+        instance.getInstanceStore().updatePoolSetup(poolNftId, componentInfo, KEEP_STATE());
 
         emit LogPoolServiceBundleOwnerRoleSet(poolNftId, bundleOwnerRole);
     }
@@ -167,7 +167,7 @@ contract PoolService is
         external
         virtual
     {
-        (NftId poolNftId, IRegistry.ObjectInfo memory registryInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        (NftId poolNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(POOL());
         InstanceReader instanceReader = instance.getInstanceReader();
 
         IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
@@ -177,7 +177,7 @@ contract PoolService is
         poolInfo.stakingFee = stakingFee;
         poolInfo.performanceFee = performanceFee;
         componentInfo.data = abi.encode(poolInfo);
-        instance.updatePoolSetup(poolNftId, componentInfo, KEEP_STATE());
+        instance.getInstanceStore().updatePoolSetup(poolNftId, componentInfo, KEEP_STATE());
 
         // TODO add logging
     }
@@ -194,21 +194,25 @@ contract PoolService is
         virtual
         returns(NftId bundleNftId)
     {
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        (NftId poolNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(POOL());
         InstanceReader instanceReader = instance.getInstanceReader();
 
-        // TODO add implementation that takes care of staking fees
-        Amount stakingAfterFeesAmount = stakingAmount;
+        // pool fee book keeping
+        IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
+        Amount stakingNetAmount = _processStakingFees(componentInfo, stakingAmount);
 
         bundleNftId = _bundleService.create(
             instance,
             poolNftId,
             owner,
             fee,
-            stakingAfterFeesAmount,
+            stakingNetAmount,
             lifetime,
             filter);
 
+        // collect tokens from bundle owner
+        _transferStakingAmount(componentInfo, owner, stakingAmount);
+
         emit LogPoolServiceBundleCreated(instance.getNftId(), poolNftId, bundleNftId);
     }
 
@@ -217,7 +221,7 @@ contract PoolService is
         external
         virtual
     {
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        (NftId poolNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(POOL());
 
         // TODO book keeping for pool collateral released outside of retention level
 
@@ -232,7 +236,7 @@ contract PoolService is
     function processSale(
         NftId bundleNftId, 
         IPolicy.Premium memory premium, 
-        uint256 actualAmountTransferred
+        Amount actualAmountTransferred
     ) 
         external
         virtual
@@ -245,16 +249,16 @@ contract PoolService is
 
         Amount poolFeeAmount = AmountLib.toAmount(premium.poolFeeFixAmount + premium.poolFeeVarAmount);
         Amount bundleFeeAmount = AmountLib.toAmount(premium.bundleFeeFixAmount + premium.bundleFeeVarAmount);
-        Amount expectedTransferAmount = AmountLib.toAmount(premium.netPremiumAmount).add(poolFeeAmount).add(bundleFeeAmount);
-        if (! AmountLib.toAmount(actualAmountTransferred).eq(expectedTransferAmount)) {
-            revert ErrorPoolServiceInvalidTransferAmount(expectedTransferAmount, AmountLib.toAmount(actualAmountTransferred));
+        Amount expectedTransferAmount = AmountLib.toAmount(premium.netPremiumAmount) + poolFeeAmount + bundleFeeAmount;
+        if (!(actualAmountTransferred == expectedTransferAmount)) {
+            revert ErrorPoolServiceInvalidTransferAmount(expectedTransferAmount, actualAmountTransferred);
         }
         
         // update pool fee balance
         if (poolFeeAmount.gtz()) {
             IComponents.ComponentInfo memory poolComponentInfo = instance.getInstanceReader().getComponentInfo(poolObjectInfo.nftId);
             poolComponentInfo.feeAmount = poolComponentInfo.feeAmount.add(poolFeeAmount);
-            instance.updatePoolSetup(poolObjectInfo.nftId, poolComponentInfo, KEEP_STATE());
+            instance.getInstanceStore().updatePoolSetup(poolObjectInfo.nftId, poolComponentInfo, KEEP_STATE());
         }
 
         if (bundleFeeAmount.gtz()) {
@@ -267,7 +271,7 @@ contract PoolService is
         NftId productNftId,
         NftId applicationNftId,
         IPolicy.PolicyInfo memory applicationInfo,
-        uint256 premiumAmount // premium amount after product and distribution fees
+        Amount premiumAmount // premium amount after product and distribution fees
     )
         external
         virtual
@@ -288,10 +292,10 @@ contract PoolService is
         IComponents.PoolInfo memory poolInfo = abi.decode(componentInfo.data, (IComponents.PoolInfo));
 
         // TODO add correct required collateral calculation (collateralization level mibht be != 1, retention level might be < 1)
-        uint256 collateralAmount = applicationInfo.sumInsuredAmount;
+        Amount collateralAmount = applicationInfo.sumInsuredAmount;
 
         // TODO add correct net premium calculation (pool fee might be > 0)
-        uint256 premiumAfterPoolFeeAmount = premiumAmount;
+        Amount premiumAfterPoolFeeAmount = premiumAmount;
 
         // lock collateral amount from involvedd bundle
         _bundleService.lockCollateral(
@@ -314,6 +318,24 @@ contract PoolService is
     }
 
 
+    function reduceCollateral(
+        IInstance instance, 
+        NftId policyNftId, 
+        IPolicy.PolicyInfo memory policyInfo,
+        Amount payoutAmount
+    )
+        external
+        virtual
+        // TODO add restricted and granting for claim service
+    {
+        _bundleService.releaseCollateral(
+            instance, 
+            policyNftId, 
+            policyInfo.bundleNftId, 
+            payoutAmount);
+    }
+
+
     /// @dev releases the remaining collateral linked to the specified policy
     /// may only be called by the policy service for unlocked pool components
     function releaseCollateral(
@@ -325,12 +347,57 @@ contract PoolService is
         virtual
         // TODO add restricted and granting for policy service
     {
-        // release collateral from involved bundle
         _bundleService.releaseCollateral(
             instance, 
             policyNftId, 
             policyInfo.bundleNftId, 
-            policyInfo.sumInsuredAmount);
+            policyInfo.sumInsuredAmount - policyInfo.claimAmount);
+
+        _bundleService.unlinkPolicy(
+            instance, 
+            policyNftId);
+    }
+
+
+    function _processStakingFees(
+        IComponents.ComponentInfo memory componentInfo, 
+        Amount stakingAmount
+    )
+        internal
+        returns (Amount stakingNetAmount)
+    {
+        stakingNetAmount = stakingAmount;
+
+        // check if any staking fees apply
+        Fee memory stakingFee = abi.decode(componentInfo.data, (IComponents.PoolInfo)).stakingFee;
+        if (FeeLib.gtz(stakingFee)) {
+            (Amount feeAmount, Amount netAmount) = FeeLib.calculateFee(stakingFee, stakingAmount);
+            stakingNetAmount = netAmount;
+
+            // TODO update fee balance for pool
+        }
+    }
+
+
+    // TODO create (I)TreasuryService that deals with all gif related token transfers
+    /// @dev transfers the specified amount from the bundle owner to the pool's wallet
+    function _transferStakingAmount(
+        IComponents.ComponentInfo memory componentInfo,
+        address bundleOwner,
+        Amount stakingAmount
+    )
+        internal
+    {
+        TokenHandler tokenHandler = componentInfo.tokenHandler;
+        address poolWallet = componentInfo.wallet;
+
+        if(stakingAmount.gtz()) {
+            tokenHandler.transfer(
+                bundleOwner,
+                poolWallet,
+                stakingAmount
+            );
+        }
     }
 
-}
+}

package/contracts/{instance/service → pool}/PoolServiceManager.sol

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {ProxyManager} from "../../shared/ProxyManager.sol";
+import {IVersionable} from "../shared/IVersionable.sol";
+import {ProxyManager} from "../shared/ProxyManager.sol";
 import {PoolService} from "./PoolService.sol";
-import {Registry} from "../../registry/Registry.sol";
-import {RegistryService} from "../../registry/RegistryService.sol";
-import {REGISTRY} from "../../types/ObjectType.sol";
+import {Registry} from "../registry/Registry.sol";
+import {RegistryService} from "../registry/RegistryService.sol";
+import {REGISTRY} from "../type/ObjectType.sol";
 
 contract PoolServiceManager is ProxyManager {