@etherisc/gif-next 0.0.2-e922e07-736 → 0.0.2-e94f4c7-084

package/contracts/instance/service/BundleService.sol

@@ -1,22 +1,24 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {Pool} from "../../components/Pool.sol";
+import {IBundle} from "../../instance/module/IBundle.sol";
+import {IComponents} from "../module/IComponents.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 {ISetup} from "../module/ISetup.sol";
 import {IPolicy} from "../module/IPolicy.sol";
 
 import {IVersionable} from "../../shared/IVersionable.sol";
 import {INftOwnable} from "../../shared/INftOwnable.sol";
-
 import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
 import {ObjectType, POOL, BUNDLE} from "../../types/ObjectType.sol";
 import {POOL_OWNER_ROLE, RoleId} from "../../types/RoleId.sol";
+import {Pool} from "../../components/Pool.sol";
+
+import {Amount, AmountLib} from "../../types/Amount.sol";
 import {Fee, FeeLib} from "../../types/Fee.sol";
-import {KEEP_STATE, StateId} from "../../types/StateId.sol";
+import {StateId, ACTIVE, PAUSED, CLOSED, KEEP_STATE} from "../../types/StateId.sol";
 import {Seconds} from "../../types/Seconds.sol";
 import {TimestampLib, zeroTimestamp} from "../../types/Timestamp.sol";
 import {Version, VersionLib} from "../../types/Version.sol";
@@ -56,38 +58,85 @@ contract BundleService is
         (registryAddress, initialOwner) = abi.decode(data, (address, address));
         // TODO while PoolService is not deployed in PoolServiceManager constructor
         //      owner is PoolServiceManager deployer
-        initializeService(registryAddress, owner);
+        initializeService(registryAddress, address(0), owner);
         registerInterface(type(IBundleService).interfaceId);
     }
 
-    function getDomain() public pure override(Service, IService) returns(ObjectType) {
+    function getDomain() public pure override returns(ObjectType) {
         return BUNDLE();
     }
 
-    function createBundle(
+    // TODO staking/unstaking as well as collateralize need to go to pool service
+    // it will also be the pool service that is updating the pool info data
+    // collateralize -> potentially accumulate pool fees
+    // collateralize: additional reason to move to pool, pool might has retential level < 1 ...
+    // staking -> potentially accumulate staking fees
+    // unstaking -> potentially accumulate performance fees
+    function _updatePoolWithStakes(
+        IInstance instance,
+        NftId poolNftId,
+        uint256 stakingAmount
+    )
+        internal
+        returns (
+            TokenHandler tokenHandler,
+            address wallet,
+            uint256 netStakingAmount
+        )
+    {
+        if(stakingAmount > 0) {
+            InstanceReader instanceReader = instance.getInstanceReader();
+            IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
+
+            tokenHandler = componentInfo.tokenHandler;
+            wallet = componentInfo.wallet;
+
+            IComponents.PoolInfo memory poolInfo = abi.decode(componentInfo.data, (IComponents.PoolInfo));
+            uint256 poolFeeAmount;
+
+            // calculate pool fee and net staking amount
+            (poolFeeAmount, netStakingAmount) = FeeLib.calculateFee(poolInfo.stakingFee, stakingAmount);
+
+            // update pool balance and fee amount
+            poolInfo.balanceAmount += netStakingAmount;
+
+            if(poolFeeAmount > 0) {
+                poolInfo.feeAmount += poolFeeAmount;
+            }
+
+            // save updated pool info
+            componentInfo.data = abi.encode(poolInfo);
+            instance.updatePoolSetup(poolNftId, componentInfo, KEEP_STATE());
+        }
+    }
+
+
+    function create(
+        IInstance instance,
+        NftId poolNftId,
         address owner, 
         Fee memory fee, 
-        uint256 stakingAmount, 
+        Amount stakingAmount, 
         Seconds lifetime, 
         bytes calldata filter
     )
         external
         override
+        // TODO add restricted and add authz for pool service
         returns(NftId bundleNftId)
     {
-        (IRegistry.ObjectInfo memory info, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
         InstanceReader instanceReader = instance.getInstanceReader();
-        NftId poolNftId = info.nftId;
 
+        // create initial bundle info
         IBundle.BundleInfo  memory bundleInfo = IBundle.BundleInfo(
             poolNftId,
             fee,
             filter,
             stakingAmount,
-            0,
-            stakingAmount,
+            AmountLib.zero(),
+            AmountLib.zero(),
             lifetime,
-            zeroTimestamp(),
+            TimestampLib.blockTimestamp().addSeconds(lifetime),
             zeroTimestamp()
         );
 
@@ -100,100 +149,190 @@ contract BundleService is
                 false, // intercepting property for bundles is defined on pool
                 address(0),
                 owner,
-                abi.encode(bundleInfo)
+                "" // bundle data to be stored in registry
             )
         );
 
         // create bundle info in instance
         instance.createBundle(bundleNftId, bundleInfo);
 
+        // put bundle under bundle managemet
         BundleManager bundleManager = instance.getBundleManager();
         bundleManager.add(bundleNftId);
         
-        _processStakingByTreasury(
-            instanceReader,
-            poolNftId,
-            bundleNftId,
-            stakingAmount);
+        // transfer full staking amount to pool wallet
+        IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
+        componentInfo.tokenHandler.transfer(
+            owner,
+            componentInfo.wallet,
+            stakingAmount.toInt()
+        );
 
         // TODO add logging
     }
 
-    function setBundleFee(
+    function setFee(
         NftId bundleNftId,
         Fee memory fee
     )
         external
         override
     {
-        (IRegistry.ObjectInfo memory info , IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        (NftId poolNftId, IRegistry.ObjectInfo memory info , IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
         InstanceReader instanceReader = instance.getInstanceReader();
-        NftId poolNftId = info.nftId;
 
         IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-        require(bundleInfo.poolNftId.gtz(), "ERROR:PLS-010:BUNDLE_UNKNOWN");
-        require(poolNftId == bundleInfo.poolNftId, "ERROR:PLS-011:BUNDLE_POOL_MISMATCH");
+        if(bundleInfo.poolNftId.eqz()) {
+            revert ErrorBundleServiceBundleUnknown(bundleNftId);
+        }
+
+        if(bundleInfo.poolNftId != poolNftId) {
+            revert ErrorBundleServiceBundlePoolMismatch(poolNftId, bundleInfo.poolNftId );
+        }
 
         bundleInfo.fee = fee;
 
         instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
     }
 
-    function updateBundle(NftId instanceNftId, NftId bundleNftId, IBundle.BundleInfo memory bundleInfo, StateId state) 
+
+    // the bundle MUST be unlocked (active) for linking (underwriting) and registered with this instance
+    function lockCollateral(
+        IInstance instance,
+        NftId policyNftId, 
+        NftId bundleNftId, 
+        uint256 collateralAmount, // required amount to collateralize policy
+        uint256 premiumAmount // premium part that reaches bundle for this policy
+    ) 
+        external
+        onlyService // TODO replace with restricted + appropriate granting
+    {
+        InstanceReader instanceReader = instance.getInstanceReader();
+        StateId bundleState = instanceReader.getMetadata(bundleNftId.toKey32(BUNDLE())).state;
+        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
+
+        // ensure bundle is active and not yet expired
+        if(bundleState != ACTIVE() || bundleInfo.expiredAt < TimestampLib.blockTimestamp()) {
+            revert ErrorBundleServiceBundleNotOpen(bundleNftId, bundleState, bundleInfo.expiredAt);
+        }
+
+        // ensure bundle capacity is sufficent to collateralize policy
+        uint capacity = bundleInfo.capitalAmount.toInt() + premiumAmount - bundleInfo.lockedAmount.toInt();
+        if(capacity < collateralAmount) {
+            revert ErrorBundleServiceCapacityInsufficient(bundleNftId, capacity, collateralAmount);
+        }
+
+        // TODO add more validation
+        
+        // updated locked amount
+        bundleInfo.lockedAmount = AmountLib.toAmount(bundleInfo.lockedAmount.toInt() + collateralAmount);
+
+        // update capital and fees when premiums are involved
+        _updateBundleWithPremium(instance, bundleNftId, bundleInfo, premiumAmount);
+        
+        // link policy to bundle in bundle manger
+        _linkPolicy(instance, policyNftId);
+    }
+
+
+    function _updateBundleWithPremium(
+        IInstance instance,
+        NftId bundleNftId,
+        IBundle.BundleInfo memory bundleInfo,
+        uint256 premiumAmount
+    )
+        internal
+    {
+        // update bundle capital and fee amounts
+        if(premiumAmount > 0) {
+            // calculate fees and net premium amounts
+            (
+                , 
+                uint256 netPremiumAmount
+            ) = FeeLib.calculateFee(bundleInfo.fee, premiumAmount);
+
+            // update bundle info with additional capital
+            bundleInfo.capitalAmount = AmountLib.toAmount(bundleInfo.capitalAmount.toInt() + netPremiumAmount);
+        }
+
+        // save updated bundle info
+        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+    }
+
+    function updateBundleFees(
+        IInstance instance,
+        NftId bundleNftId,
+        Amount feeAmount
+    )
         external
-        onlyService
     {
-        IRegistry.ObjectInfo memory instanceInfo = getRegistry().getObjectInfo(instanceNftId);
-        IInstance instance = IInstance(instanceInfo.objectAddress);
-        instance.updateBundle(bundleNftId, bundleInfo, state);
-    } 
+        IBundle.BundleInfo memory bundleInfo = instance.getInstanceReader().getBundleInfo(bundleNftId);
+        bundleInfo.feeAmount = bundleInfo.feeAmount.add(feeAmount);
+        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+    }
+
 
-    function lockBundle(NftId bundleNftId) 
+    function lock(NftId bundleNftId) 
         external
+        virtual
     {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        (,, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+
+        // udpate bundle state
+        instance.updateBundleState(bundleNftId, PAUSED());
+
+        // update set of active bundles
         BundleManager bundleManager = instance.getBundleManager();
         bundleManager.lock(bundleNftId);
+
+        emit LogBundleServiceBundleLocked(bundleNftId);
     }
 
-    function unlockBundle(NftId bundleNftId) 
+
+    function unlock(NftId bundleNftId) 
         external
+        virtual
     {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        (,, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+
+        // udpate bundle state
+        instance.updateBundleState(bundleNftId, ACTIVE());
+
+        // update set of active bundles
         BundleManager bundleManager = instance.getBundleManager();
         bundleManager.unlock(bundleNftId);
+
+        emit LogBundleServiceBundleActivated(bundleNftId);
     }
 
-    function lockCollateral(
+
+    function close(
         IInstance instance,
-        NftId policyNftId, 
-        NftId bundleNftId, 
-        uint256 collateralAmount,
-        uint256 netPremiumAmount
+        NftId bundleNftId
     ) 
         external
-        onlyService
-        returns (
-            IBundle.BundleInfo memory bundleInfo
-        )
+        virtual
+        // TODO add restricted and autz for pool service
     {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-
-        // TODO add validation
+        // udpate bundle state
+        instance.updateBundleState(bundleNftId, CLOSED());
 
-        // lock collateral
-        bundleInfo.lockedAmount += collateralAmount;
-        bundleInfo.balanceAmount += netPremiumAmount;
+        // ensure no open policies attached to bundle
+        BundleManager bundleManager = instance.getBundleManager();
+        uint256 openPolicies = bundleManager.activePolicies(bundleNftId);
+        if(openPolicies > 0) {
+            revert ErrorBundleServiceBundleWithOpenPolicies(bundleNftId, openPolicies);
+        }
 
-        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
-        
-        linkPolicy(instance, policyNftId);
+        // update set of active bundles
+        bundleManager.lock(bundleNftId);
     }
 
-    function increaseBalance(IInstance instance,
+
+    function increaseBalance(
+        IInstance instance,
         NftId bundleNftId, 
-        uint256 amount
+        uint256 premiumAmount
     ) 
         external
         onlyService 
@@ -201,12 +340,13 @@ contract BundleService is
         InstanceReader instanceReader = instance.getInstanceReader();
         IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
 
-        bundleInfo.balanceAmount += amount;
+        // update capital and fees when premiums are involved
+        _updateBundleWithPremium(instance, bundleNftId, bundleInfo, premiumAmount);
 
-        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+        // TODO add logging (?)
     }
 
-    function closePolicy(IInstance instance,
+    function releaseCollateral(IInstance instance,
         NftId policyNftId, 
         NftId bundleNftId, 
         uint256 collateralAmount
@@ -217,25 +357,24 @@ contract BundleService is
         InstanceReader instanceReader = instance.getInstanceReader();
         IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
 
-        // lock collateral
-        bundleInfo.lockedAmount -= collateralAmount;
+        // reduce locked amount by released collateral amount
+        bundleInfo.lockedAmount = AmountLib.toAmount(bundleInfo.lockedAmount.toInt() - collateralAmount);
 
         instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
         
-        unlinkPolicy(instance, policyNftId);
+        _unlinkPolicy(instance, policyNftId);
     }
 
     /// @dev links policy to bundle
-    function linkPolicy(IInstance instance, NftId policyNftId) 
+    function _linkPolicy(IInstance instance, NftId policyNftId) 
         internal
-        onlyService 
     {
         InstanceReader instanceReader = instance.getInstanceReader();
         IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
 
-        // ensure policy has not yet been activated
-        if (policyInfo.activatedAt.gtz()) {
-            revert BundleManager.ErrorBundleManagerErrorPolicyAlreadyActivated(policyNftId);
+        // ensure policy has not yet been activated in a previous tx already
+        if (policyInfo.activatedAt.gtz() && policyInfo.activatedAt < TimestampLib.blockTimestamp()) {
+            revert BundleManager.ErrorBundleManagerPolicyAlreadyActivated(policyNftId);
         }
         
         BundleManager bundleManager = instance.getBundleManager();
@@ -243,9 +382,8 @@ contract BundleService is
     }
 
         /// @dev unlinks policy from bundle
-    function unlinkPolicy(IInstance instance, NftId policyNftId) 
+    function _unlinkPolicy(IInstance instance, NftId policyNftId) 
         internal
-        onlyService 
     {
         InstanceReader instanceReader = instance.getInstanceReader();
         IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
@@ -259,7 +397,7 @@ contract BundleService is
 
         // ensure policy is closeable
         if ( TimestampLib.blockTimestamp() < policyInfo.expiredAt
-            && policyInfo.payoutAmount < policyInfo.sumInsuredAmount)
+            && policyInfo.payoutAmount.toInt() < policyInfo.sumInsuredAmount)
         {
             revert BundleManager.ErrorBundleManagerPolicyNotCloseable(policyNftId);
         }
@@ -268,32 +406,38 @@ contract BundleService is
         bundleManager.unlinkPolicy(policyNftId);
     }
 
+    // TODO move this to pool service
     function _processStakingByTreasury(
         InstanceReader instanceReader,
         NftId poolNftId,
         NftId bundleNftId,
-        uint256 stakingAmount
+        Amount stakingAmount
     )
         internal
     {
         // process token transfer(s)
-        if(stakingAmount > 0) {
-            ISetup.PoolSetupInfo memory poolInfo = instanceReader.getPoolSetupInfo(poolNftId);
-            TokenHandler tokenHandler = poolInfo.tokenHandler;
+        if(stakingAmount.gtz()) {
+            IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
+            IComponents.PoolInfo memory poolInfo = abi.decode(componentInfo.data, (IComponents.PoolInfo));
+
+            TokenHandler tokenHandler = componentInfo.tokenHandler;
             address bundleOwner = getRegistry().ownerOf(bundleNftId);
             Fee memory stakingFee = poolInfo.stakingFee;
 
-            tokenHandler.transfer(
-                bundleOwner,
-                poolInfo.wallet,
-                stakingAmount
-            );
+            // pool fee and bundle capital book keeping
+            if (FeeLib.gtz(stakingFee)) {
+                (uint256 stakingFeeAmount, uint256 netAmount) = FeeLib.calculateFee(stakingFee, stakingAmount.toInt());
 
 
-            if (! FeeLib.feeIsZero(stakingFee)) {
-                (uint256 stakingFeeAmount, uint256 netAmount) = FeeLib.calculateFee(stakingFee, stakingAmount);
                 // TODO: track staking fees in pool's state (issue #177)
             }
+
+            // transfer full staking amount to pool wallet
+            tokenHandler.transfer(
+                bundleOwner,
+                componentInfo.wallet,
+                stakingAmount.toInt()
+            );
         }
     }
 }