@etherisc/gif-next 0.0.2-c9711ab-345 → 0.0.2-c9ad04b-284

package/contracts/pool/IPoolService.sol

@@ -30,9 +30,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 ErrorPoolServiceWalletAllowanceTooSmall(address wallet, address spender, uint256 allowance, uint256 amount);
-    error ErrorPoolServiceAmountIsZero();
-
+    
     /// @dev defines the required role for bundle owners for the calling pool
     /// default implementation returns PUBLIC ROLE
     function setBundleOwnerRole(RoleId bundleOwnerRole) external;
@@ -82,19 +80,28 @@ interface IPoolService is IService {
     ) external;
 
 
-    /// @dev create a new bundle for the provided parameters
-    /// staking fees will be deducted by the pool service from the staking amount
+    /// @dev create a new empty bundle with the provided parameters
     /// may only be called by registered and unlocked pool components.
-    /// The pool balance is equal to the pool fees plus the capital of all bundles. 
     function createBundle(
         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, Amount netStakedAmount); // the nft id of the newly created bundle
+        returns(NftId bundleNftId); // the nft id of the newly created bundle
+
+
+    /// @dev increase stakes for bundle
+    /// staking fees will be deducted by the pool service from the staking amount
+    /// may only be called by registered and unlocked pool components
+    function stake(NftId bundleNftId, Amount amount) external returns(Amount netAmount);
+
+
+    /// @dev decrease stakes for bundle
+    /// performance fees will be deducted by the pool service from the staking amount
+    /// may only be called by registered and unlocked pool components
+    function unstake(NftId bundleNftId, Amount amount) external returns(Amount netAmount);
 
 
     /// @dev closes the specified bundle
@@ -105,18 +112,22 @@ 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) external;
+    /// @dev Fund the specified pool wallet with the provided amount.
+    /// This function will collect the amount from the sender address and transfers it to the pool wallet.
+    /// The function will not update balance amounts managed by the framework.
+    /// Only available for externally managed pools.
+    function fundPoolWallet(NftId poolNftId, Amount amount) external;
 
-    /// @dev increase stakes for bundle
-    /// staking fees will be deducted by the pool service from the staking amount
-    /// may only be called by registered and unlocked pool components
-    function stake(NftId bundleNftId, Amount amount) external returns(Amount netAmount);
 
-    /// @dev decrease stakes for bundle
-    /// performance fees will be deducted by the pool service from the staking amount
-    /// may only be called by registered and unlocked pool components
-    function unstake(NftId bundleNftId, Amount amount) external returns(Amount netAmount);
+    /// @dev Defund the specified pool wallet with the provided amount.
+    /// This function will transfer the amount from the pool wallet to the sender address.
+    /// The function will not update balance amounts managed by the framework.
+    /// Only available for externally managed pools.
+    function defundPoolWallet(NftId poolNftId, Amount amount) external;
+
+
+    /// @dev processes the sale of a bundle and track the pool fee and bundle fee amounts
+    function processSale(NftId bundleNftId, IPolicy.PremiumInfo memory premium) external;
 
 
     /// @dev calulate required collateral for the provided parameters

package/contracts/pool/Pool.sol

@@ -113,15 +113,15 @@ abstract contract Pool is
         view 
         returns (IComponents.PoolInfo memory poolInfo)
     {
-        return IComponents.PoolInfo(
-            PUBLIC_ROLE(), // bundleOwnerRole
-            AmountLib.max(), // maxCapitalAmount,
-            isNftInterceptor(), // isInterceptingBundleTransfers
-            false, // isExternallyManaged,
-            false, // isVerifyingApplications,
-            UFixedLib.toUFixed(1), // collateralizationLevel,
-            UFixedLib.toUFixed(1) // retentionLevel,
-        );
+        return IComponents.PoolInfo({
+            maxBalanceAmount: AmountLib.max(),
+            bundleOwnerRole: PUBLIC_ROLE(), 
+            isInterceptingBundleTransfers: isNftInterceptor(),
+            isExternallyManaged: false,
+            isVerifyingApplications: false,
+            collateralizationLevel: UFixedLib.toUFixed(1),
+            retentionLevel: UFixedLib.toUFixed(1)
+        });
     }
 
     // Internals
@@ -158,7 +158,7 @@ abstract contract Pool is
         $._bundleService = IBundleService(_getServiceAddress(BUNDLE()));
         $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
 
-        registerInterface(type(IPoolComponent).interfaceId);
+        _registerInterface(type(IPoolComponent).interfaceId);
     }
 
     /// @dev increases the staked tokens by the specified amount
@@ -169,9 +169,9 @@ abstract contract Pool is
     )
         internal
         virtual
-        returns(Amount netAmount) 
+        returns(Amount) 
     {
-        _getPoolStorage()._poolService.stake(bundleNftId, amount);
+        return _getPoolStorage()._poolService.stake(bundleNftId, amount);
     }
 
 
@@ -287,21 +287,19 @@ abstract contract Pool is
         _getPoolStorage()._componentService.setPoolFees(poolFee, stakingFee, performanceFee);
     }
 
-    /// @dev Creates a new bundle using the provided parameter values.
+    /// @dev Creates a new empty bundle using the provided parameter values.
     function _createBundle(
         address bundleOwner,
         Fee memory fee,
-        Amount amount,
         Seconds lifetime, 
         bytes memory filter
     )
         internal
-        returns(NftId bundleNftId, Amount netStakedAmount)
+        returns(NftId bundleNftId)
     {
-        (bundleNftId, netStakedAmount) = _getPoolStorage()._poolService.createBundle(
+        bundleNftId = _getPoolStorage()._poolService.createBundle(
             bundleOwner,
             fee,
-            amount,
             lifetime,
             filter);
 

package/contracts/pool/PoolService.sol

@@ -1,8 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
 import {IBundle} from "../instance/module/IBundle.sol";
 import {IBundleService} from "./IBundleService.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
@@ -23,7 +21,6 @@ import {RoleId, PUBLIC_ROLE} from "../type/RoleId.sol";
 import {Fee, FeeLib} from "../type/Fee.sol";
 import {KEEP_STATE} from "../type/StateId.sol";
 import {Seconds} from "../type/Seconds.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
 import {UFixed} from "../type/UFixed.sol";
 import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
@@ -47,8 +44,8 @@ contract PoolService is
         bytes memory data
     )
         internal
-        initializer
         virtual override
+        initializer()
     {
         (
             address registryAddress,, 
@@ -56,7 +53,7 @@ contract PoolService is
             address authority
         ) = abi.decode(data, (address, address, address));
 
-        initializeService(registryAddress, authority, owner);
+        _initializeService(registryAddress, authority, owner);
 
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
         _bundleService = IBundleService(_getServiceAddress(BUNDLE()));
@@ -65,7 +62,7 @@ contract PoolService is
 
         _staking = IStaking(getRegistry().getStakingAddress());
 
-        registerInterface(type(IPoolService).interfaceId);
+        _registerInterface(type(IPoolService).interfaceId);
     }
 
     /// @inheritdoc IPoolService
@@ -109,55 +106,25 @@ contract PoolService is
     function createBundle(
         address bundleOwner, // 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 
         virtual
-        returns(NftId bundleNftId, Amount netStakedAmount)
+        returns(NftId bundleNftId)
     {
         (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
 
-        {
-            InstanceReader instanceReader = instance.getInstanceReader();
-            IComponents.PoolInfo memory poolInfo = instanceReader.getPoolInfo(poolNftId);
-            Amount currentPoolBalance = instanceReader.getBalanceAmount(poolNftId);
-            if (currentPoolBalance + stakingAmount > poolInfo.maxBalanceAmount) {
-                revert ErrorPoolServiceMaxBalanceAmountExceeded(poolNftId, poolInfo.maxBalanceAmount, currentPoolBalance, stakingAmount);
-            }
-        }
-
-
-        Amount stakingFeeAmount;
-        (stakingFeeAmount, netStakedAmount) = FeeLib.calculateFee(
-            _getStakingFee(instance.getInstanceReader(), poolNftId), 
-            stakingAmount);
-
-
+        // create the empty bundle
         bundleNftId = _bundleService.create(
             instance,
             poolNftId,
             bundleOwner,
             fee,
-            netStakedAmount,
+            AmountLib.zero(), 
             lifetime,
             filter);
 
-        // pool book keeping
-        _componentService.increasePoolBalance(
-            instance.getInstanceStore(), 
-            poolNftId, 
-            netStakedAmount, 
-            stakingFeeAmount);
-
-        // pool bookkeeping and collect tokens from bundle owner
-        _collectStakingAmount(
-            instance.getInstanceReader(), 
-            poolNftId, 
-            bundleOwner, 
-            stakingAmount);
-
         emit LogPoolServiceBundleCreated(instance.getNftId(), poolNftId, bundleNftId);
     }
 
@@ -192,24 +159,10 @@ contract PoolService is
 
         if ((unstakedAmount + feeAmount).gtz()){
             IComponents.ComponentInfo memory poolComponentInfo = instance.getInstanceReader().getComponentInfo(poolNftId);
-            TokenHandler tokenHandler = poolComponentInfo.tokenHandler;
-            IERC20Metadata token = IERC20Metadata(poolComponentInfo.token);
-
-            // TODO: centralize token handling (issue #471)
-            
-            // check allowance
-            uint256 tokenAllowance = token.allowance(poolComponentInfo.wallet, address(tokenHandler));
-            if (tokenAllowance < (unstakedAmount.toInt() +  feeAmount.toInt())) {
-                revert ErrorPoolServiceWalletAllowanceTooSmall(
-                    poolComponentInfo.wallet, 
-                    address(tokenHandler), 
-                    tokenAllowance, 
-                    unstakedAmount.toInt() + feeAmount.toInt());
-            }
-
-            // transfer amount to bundle owner
-            address bundleOwner = getRegistry().ownerOf(bundleNftId);
-            tokenHandler.transfer(poolComponentInfo.wallet, bundleOwner, unstakedAmount + feeAmount);
+            poolComponentInfo.tokenHandler.distributeTokens(
+                poolComponentInfo.wallet, 
+                getRegistry().ownerOf(bundleNftId), 
+                unstakedAmount + feeAmount);
         }
     }
 
@@ -256,13 +209,14 @@ contract PoolService is
 
         // 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);
-
-        emit LogPoolServiceBundleStaked(instance.getNftId(), poolNftId, bundleNftId, amount, netAmount);
     }
 
     /// @inheritdoc IPoolService
@@ -281,10 +235,6 @@ contract PoolService is
             revert ErrorPoolServiceBundlePoolMismatch(bundleNftId, poolNftId);
         }
 
-        if (amount.eqz()) {
-            revert ErrorPoolServiceAmountIsZero();
-        }
-
         // call bundle service for bookkeeping and additional checks
         Amount unstakedAmount = _bundleService.unstake(instance, bundleNftId, amount);
 
@@ -302,29 +252,39 @@ contract PoolService is
 
         IComponents.ComponentInfo memory poolComponentInfo = instanceReader.getComponentInfo(poolNftId);
         address poolWallet = poolComponentInfo.wallet;
-
-        // check allowance
-        {
-            IERC20Metadata token = IERC20Metadata(poolComponentInfo.token);
-            uint256 tokenAllowance = token.allowance(poolWallet, address(poolComponentInfo.tokenHandler));
-            if (tokenAllowance < unstakedAmount.toInt()) {
-                revert ErrorPoolServiceWalletAllowanceTooSmall(poolWallet, address(poolComponentInfo.tokenHandler), tokenAllowance, amount.toInt());
-            }
-        }
-
         // transfer amount to bundle owner
         address owner = getRegistry().ownerOf(bundleNftId);
-        // TODO: centralize token handling (issue #471)
-        poolComponentInfo.tokenHandler.transfer(poolWallet, owner, unstakedAmount);
-        
         emit LogPoolServiceBundleUnstaked(instance.getNftId(), poolNftId, bundleNftId, unstakedAmount);
-
+        poolComponentInfo.tokenHandler.distributeTokens(
+            poolWallet, 
+            owner, 
+            unstakedAmount);
         return unstakedAmount;
     }
 
+
+    function fundPoolWallet(NftId poolNftId, Amount amount)
+        external
+        virtual
+        restricted()
+    {
+        // TODO check that poolNftId is externally managed
+        // TODO implement
+    }
+
+
+    function defundPoolWallet(NftId poolNftId, Amount amount)
+        external
+        virtual
+        restricted()
+    {
+        // TODO check that poolNftId is externally managed
+        // TODO implement
+    }
+
     function processSale(
         NftId bundleNftId, 
-        IPolicy.Premium memory premium 
+        IPolicy.PremiumInfo memory premium 
     ) 
         external
         virtual
@@ -336,9 +296,9 @@ contract PoolService is
         IRegistry.ObjectInfo memory instanceObjectInfo = registry.getObjectInfo(poolObjectInfo.parentNftId);
         IInstance instance = IInstance(instanceObjectInfo.objectAddress);
 
-        Amount poolFeeAmount = AmountLib.toAmount(premium.poolFeeFixAmount + premium.poolFeeVarAmount);
-        Amount bundleFeeAmount = AmountLib.toAmount(premium.bundleFeeFixAmount + premium.bundleFeeVarAmount);
-        Amount bundleNetAmount = AmountLib.toAmount(premium.netPremiumAmount);
+        Amount poolFeeAmount = premium.poolFeeFixAmount + premium.poolFeeVarAmount;
+        Amount bundleFeeAmount = premium.bundleFeeFixAmount + premium.bundleFeeVarAmount;
+        Amount bundleNetAmount = premium.netPremiumAmount;
 
         InstanceStore instanceStore = instance.getInstanceStore();
         _componentService.increasePoolBalance(
@@ -524,7 +484,6 @@ contract PoolService is
     }
 
 
-    // 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 _collectStakingAmount(
         InstanceReader instanceReader,
@@ -537,23 +496,11 @@ contract PoolService is
 
         // collecting investor token
         IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
-        TokenHandler tokenHandler = componentInfo.tokenHandler;
         address poolWallet = componentInfo.wallet;
-
-        if(amount.gtz()) {
-            uint256 allowance = IERC20Metadata(componentInfo.token).allowance(bundleOwner, address(tokenHandler));
-            if (allowance < amount.toInt()) {
-                revert ErrorPoolServiceWalletAllowanceTooSmall(bundleOwner, address(tokenHandler), allowance, amount.toInt());
-            }
-
-            // TODO: centralize token handling (issue #471)
-            tokenHandler.transfer(
-                bundleOwner,
-                poolWallet,
-                amount);
-        } else {
-            revert ErrorPoolServiceAmountIsZero();
-        }
+        componentInfo.tokenHandler.collectTokens(
+            bundleOwner,
+            poolWallet,
+            amount);
     }
 
     function _getDomain() internal pure override returns(ObjectType) {

package/contracts/product/ApplicationService.sol

@@ -46,13 +46,13 @@ contract ApplicationService is
             address authority
         ) = abi.decode(data, (address, address, address));
 
-        initializeService(registryAddress, address(0), owner);
+        _initializeService(registryAddress, address(0), owner);
 
         _distributionService = IDistributionService(_getServiceAddress(DISTRIBUTION()));
         _pricingService = IPricingService(_getServiceAddress(PRICE()));
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
 
-        registerInterface(type(IApplicationService).interfaceId);
+        _registerInterface(type(IApplicationService).interfaceId);
     }
 
 
@@ -111,8 +111,7 @@ contract ApplicationService is
         view
         returns (Amount premiumAmount)
     {
-        return AmountLib.toAmount(
-            _pricingService.calculatePremium(
+        return _pricingService.calculatePremium(
                 info.productNftId,
                 info.riskId,
                 info.sumInsuredAmount,
@@ -120,7 +119,7 @@ contract ApplicationService is
                 info.applicationData,
                 info.bundleNftId,
                 info.referralId
-            ).premiumAmount);
+            ).premiumAmount;
     }
 
 
@@ -128,6 +127,7 @@ contract ApplicationService is
         address applicationOwner,
         RiskId riskId,
         Amount sumInsuredAmount,
+        Amount premiumAmount,
         Seconds lifetime,
         NftId bundleNftId,
         ReferralId referralId,
@@ -152,14 +152,45 @@ contract ApplicationService is
         applicationNftId = _registerApplication(productNftId, applicationOwner);
 
         // create policy info for application
-        IPolicy.PolicyInfo memory applicationInfo = IPolicy.PolicyInfo({
+        IPolicy.PolicyInfo memory applicationInfo = _createApplicationInfo(
+            productNftId,
+            riskId,
+            sumInsuredAmount,
+            premiumAmount,
+            lifetime,
+            bundleNftId,
+            referralId,
+            applicationData);
+
+        // register application with instance
+        instance.getInstanceStore().createApplication(
+            applicationNftId, 
+            applicationInfo);
+
+        // TODO: add logging
+    }
+
+    function _createApplicationInfo(
+        NftId productNftId,
+        RiskId riskId,
+        Amount sumInsuredAmount,
+        Amount premiumAmount,
+        Seconds lifetime,
+        NftId bundleNftId,
+        ReferralId referralId,
+        bytes memory applicationData
+    )
+        internal
+        virtual
+        returns (IPolicy.PolicyInfo memory applicationInfo)
+    {
+        return IPolicy.PolicyInfo({
             productNftId:       productNftId,
             bundleNftId:        bundleNftId,
             referralId:         referralId,
             riskId:             riskId,
             sumInsuredAmount:   sumInsuredAmount,
-            premiumAmount:      AmountLib.zero(),
-            premiumPaidAmount:  AmountLib.zero(),
+            premiumAmount:      premiumAmount,
             lifetime:           lifetime,
             applicationData:    applicationData,
             processData:        "",
@@ -171,21 +202,8 @@ contract ApplicationService is
             expiredAt:          zeroTimestamp(),
             closedAt:           zeroTimestamp()
         });
-
-        // TODO consider to provide this amount externally
-        // actual calculation is done 2nd time anyway for premium collection
-        // calculate premium amount
-        applicationInfo.premiumAmount = _calculatePremiumAmount(applicationInfo);
-
-        // register application with instance
-        instance.getInstanceStore().createApplication(
-            applicationNftId, 
-            applicationInfo);
-
-        // TODO: add logging
     }
 
-
     function renew(
         NftId policyNftId, // policy to be renewd (renewal inherits policy attributes)
         NftId bundleNftId // will likely need a newer bundle for underwriting
@@ -194,7 +212,7 @@ contract ApplicationService is
         virtual override
         returns (NftId applicationNftId)
     {
-
+        // TODO implement
     }
 
 
@@ -210,7 +228,7 @@ contract ApplicationService is
         external
         virtual override
     {
-
+        // TODO implement
     }
 
     function revoke(NftId applicationNftId)

package/contracts/product/BasicProduct.sol

@@ -21,6 +21,7 @@ abstract contract BasicProduct is
     {
         _setFees(productFee, processingFee);
     }
+
     function _initializeBasicProduct(
         address registry,
         NftId instanceNftId,