@etherisc/gif-next 0.0.2-dc95063-418 → 0.0.2-dd40550-413

package/contracts/instance/service/BundleService.sol

@@ -16,6 +16,7 @@ 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 {StateId, ACTIVE, PAUSED, CLOSED, KEEP_STATE} from "../../types/StateId.sol";
 import {Seconds} from "../../types/Seconds.sol";
@@ -57,41 +58,73 @@ 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();
     }
 
+    // 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,
+        Amount stakingAmount
+    )
+        internal
+        returns (
+            TokenHandler tokenHandler,
+            address wallet,
+            Amount netStakingAmount
+        )
+    {
+        if(stakingAmount.gtz()) {
+            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));
+            Amount poolFeeAmount;
+
+            // calculate pool fee and net staking amount
+            (poolFeeAmount, netStakingAmount) = FeeLib.calculateFee(poolInfo.stakingFee, stakingAmount);
+
+            // update pool balance and fee amount
+            poolInfo.balanceAmount = poolInfo.balanceAmount + netStakingAmount;
+
+            if(poolFeeAmount.gtz()) {
+                poolInfo.feeAmount = poolInfo.feeAmount + poolFeeAmount;
+            }
+
+            // save updated pool info
+            componentInfo.data = abi.encode(poolInfo);
+            instance.getInstanceStore().updatePoolSetup(poolNftId, componentInfo, KEEP_STATE());
+        }
+    }
+
+
     function create(
+        IInstance instance,
+        NftId poolNftId,
         address owner, 
-        Fee memory fee, 
-        uint256 stakingAmount, 
+        Fee memory bundleFee, 
+        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;
-
-        IBundle.BundleInfo  memory bundleInfo = IBundle.BundleInfo(
-            poolNftId,
-            fee,
-            filter,
-            stakingAmount,
-            0,
-            stakingAmount,
-            lifetime,
-            zeroTimestamp(),
-            zeroTimestamp()
-        );
-
         // register bundle with registry
         bundleNftId = getRegistryService().registerBundle(
             IRegistry.ObjectInfo(
@@ -101,25 +134,32 @@ 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);
-
+        instance.getInstanceStore().createBundle(
+            bundleNftId, 
+            IBundle.BundleInfo(
+                poolNftId,
+                bundleFee,
+                filter,
+                stakingAmount,
+                AmountLib.zero(),
+                AmountLib.zero(),
+                lifetime,
+                TimestampLib.blockTimestamp().addSeconds(lifetime),
+                zeroTimestamp()));
+
+        // put bundle under bundle managemet
         BundleManager bundleManager = instance.getBundleManager();
         bundleManager.add(bundleNftId);
-        
-        _processStakingByTreasury(
-            instanceReader,
-            poolNftId,
-            bundleNftId,
-            stakingAmount);
 
         // TODO add logging
     }
 
+
     function setFee(
         NftId bundleNftId,
         Fee memory fee
@@ -127,56 +167,105 @@ contract BundleService is
         external
         override
     {
-        (IRegistry.ObjectInfo memory info , IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        (NftId poolNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(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);
+        }
 
-        bundleInfo.fee = fee;
+        if(bundleInfo.poolNftId != poolNftId) {
+            revert ErrorBundleServiceBundlePoolMismatch(bundleNftId, bundleInfo.poolNftId, poolNftId);
+        }
 
-        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+        bundleInfo.fee = fee;
+        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_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,
-        uint256 netPremiumAmount
+        Amount collateralAmount, // required amount to collateralize policy
+        Amount premiumAmount // premium part that reaches bundle for this policy
     ) 
         external
-        onlyService
-        returns (
-            IBundle.BundleInfo memory bundleInfo
-        )
+        onlyService // TODO replace with restricted + appropriate granting
     {
         InstanceReader instanceReader = instance.getInstanceReader();
-        bundleInfo = instanceReader.getBundleInfo(bundleNftId);
+        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);
+        }
 
-        // TODO add validation
+        // ensure bundle capacity is sufficent to collateralize policy
+        Amount capacity = bundleInfo.capitalAmount + premiumAmount - bundleInfo.lockedAmount;
+        if(capacity < collateralAmount) {
+            revert ErrorBundleServiceCapacityInsufficient(bundleNftId, capacity, collateralAmount);
+        }
 
-        // lock collateral
-        bundleInfo.lockedAmount += collateralAmount;
-        bundleInfo.balanceAmount += netPremiumAmount;
+        // TODO add more validation
+        
+        // updated locked amount
+        bundleInfo.lockedAmount = bundleInfo.lockedAmount + collateralAmount;
 
-        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+        // update capital and fees when premiums are involved
+        _updateBundleWithPremium(instance, bundleNftId, bundleInfo, premiumAmount);
         
-        linkPolicy(instance, policyNftId);
+        // link policy to bundle in bundle manger
+        _linkPolicy(instance, policyNftId);
     }
 
 
+    function _updateBundleWithPremium(
+        IInstance instance,
+        NftId bundleNftId,
+        IBundle.BundleInfo memory bundleInfo,
+        Amount premiumAmount
+    )
+        internal
+    {
+        // update bundle capital and fee amounts
+        if(premiumAmount.gtz()) {
+            // calculate fees and net premium amounts
+            (
+                , 
+                Amount netPremiumAmount
+            ) = FeeLib.calculateFee(bundleInfo.fee, premiumAmount);
+
+            // update bundle info with additional capital
+            bundleInfo.capitalAmount = bundleInfo.capitalAmount + netPremiumAmount;
+        }
+
+        // save updated bundle info
+        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+    }
+
+    function updateBundleFees(
+        IInstance instance,
+        NftId bundleNftId,
+        Amount feeAmount
+    )
+        external
+    {
+        IBundle.BundleInfo memory bundleInfo = instance.getInstanceReader().getBundleInfo(bundleNftId);
+        bundleInfo.feeAmount = bundleInfo.feeAmount.add(feeAmount);
+        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+    }
+
     function lock(NftId bundleNftId) 
         external
         virtual
     {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        (,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(POOL());
 
         // udpate bundle state
-        instance.updateBundleState(bundleNftId, PAUSED());
+        instance.getInstanceStore().updateBundleState(bundleNftId, PAUSED());
 
         // update set of active bundles
         BundleManager bundleManager = instance.getBundleManager();
@@ -190,10 +279,10 @@ contract BundleService is
         external
         virtual
     {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        (,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(POOL());
 
         // udpate bundle state
-        instance.updateBundleState(bundleNftId, ACTIVE());
+        instance.getInstanceStore().updateBundleState(bundleNftId, ACTIVE());
 
         // update set of active bundles
         BundleManager bundleManager = instance.getBundleManager();
@@ -203,14 +292,16 @@ contract BundleService is
     }
 
 
-    function close(NftId bundleNftId) 
+    function close(
+        IInstance instance,
+        NftId bundleNftId
+    ) 
         external
         virtual
+        // TODO add restricted and autz for pool service
     {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-
         // udpate bundle state
-        instance.updateBundleState(bundleNftId, CLOSED());
+        instance.getInstanceStore().updateBundleState(bundleNftId, CLOSED());
 
         // ensure no open policies attached to bundle
         BundleManager bundleManager = instance.getBundleManager();
@@ -221,14 +312,13 @@ contract BundleService is
 
         // update set of active bundles
         bundleManager.lock(bundleNftId);
-
-        emit LogBundleServiceBundleClosed(bundleNftId);
     }
 
 
-    function increaseBalance(IInstance instance,
+    function increaseBalance(
+        IInstance instance,
         NftId bundleNftId, 
-        uint256 amount
+        Amount premiumAmount
     ) 
         external
         onlyService 
@@ -236,15 +326,16 @@ 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
+        Amount collateralAmount
     ) 
         external
         onlyService 
@@ -252,24 +343,20 @@ contract BundleService is
         InstanceReader instanceReader = instance.getInstanceReader();
         IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
 
-        // lock collateral
-        bundleInfo.lockedAmount -= collateralAmount;
-
-        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
-        
-        unlinkPolicy(instance, policyNftId);
+        // reduce locked amount by released collateral amount
+        bundleInfo.lockedAmount = bundleInfo.lockedAmount - collateralAmount;
+        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
     }
 
     /// @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()) {
+        // ensure policy has not yet been activated in a previous tx already
+        if (policyInfo.activatedAt.gtz() && policyInfo.activatedAt < TimestampLib.blockTimestamp()) {
             revert BundleManager.ErrorBundleManagerPolicyAlreadyActivated(policyNftId);
         }
         
@@ -277,60 +364,19 @@ contract BundleService is
         bundleManager.linkPolicy(policyNftId);
     }
 
-        /// @dev unlinks policy from bundle
-    function unlinkPolicy(IInstance instance, NftId policyNftId) 
-        internal
-        onlyService 
+    /// @dev unlinks policy from bundle
+    function unlinkPolicy(
+        IInstance instance, 
+        NftId policyNftId
+    ) 
+        external
+        virtual
     {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
-
-        // ensure policy has no open claims
-        if (policyInfo.openClaimsCount > 0) {
-            revert BundleManager.ErrorBundleManagerPolicyWithOpenClaims(
-                policyNftId, 
-                policyInfo.openClaimsCount);
-        }
-
         // ensure policy is closeable
-        if ( TimestampLib.blockTimestamp() < policyInfo.expiredAt
-            && policyInfo.payoutAmount < policyInfo.sumInsuredAmount)
-        {
-            revert BundleManager.ErrorBundleManagerPolicyNotCloseable(policyNftId);
+        if (!instance.getInstanceReader().policyIsCloseable(policyNftId)) {
+            revert ErrorBundleServicePolicyNotCloseable(policyNftId);
         }
-        
-        BundleManager bundleManager = instance.getBundleManager();
-        bundleManager.unlinkPolicy(policyNftId);
-    }
 
-    function _processStakingByTreasury(
-        InstanceReader instanceReader,
-        NftId poolNftId,
-        NftId bundleNftId,
-        uint256 stakingAmount
-    )
-        internal
-    {
-        // process token transfer(s)
-        if(stakingAmount > 0) {
-            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,
-                componentInfo.wallet,
-                stakingAmount
-            );
-
-            if (! FeeLib.feeIsZero(stakingFee)) {
-                (uint256 stakingFeeAmount, uint256 netAmount) = FeeLib.calculateFee(stakingFee, stakingAmount);
-                // TODO: track staking fees in pool's state (issue #177)
-            }
-        }
+        instance.getBundleManager().unlinkPolicy(policyNftId);
     }
 }