@etherisc/gif-next 0.0.2-ff282a4-523 → 0.0.2-ff3a8a0-504

package/contracts/pool/BundleService.sol

@@ -1,134 +1,108 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
+import {IAccountingService} from "../accounting/IAccountingService.sol";
 import {IBundle} from "../instance/module/IBundle.sol";
-import {IComponents} from "../instance/module/IComponents.sol";
+import {IBundleService} from "./IBundleService.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
+import {IRegistryService} from "../registry/IRegistryService.sol";
 import {IInstance} from "../instance/IInstance.sol";
-import {TokenHandler} from "../instance/module/ITreasury.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
-import {IPolicy} from "../instance/module/IPolicy.sol";
-
-import {IVersionable} from "../shared/IVersionable.sol";
-import {INftOwnable} from "../shared/INftOwnable.sol";
-import {NftId, NftIdLib, zeroNftId} from "../type/NftId.sol";
-import {ObjectType, POOL, BUNDLE} from "../type/ObjectType.sol";
-import {POOL_OWNER_ROLE, RoleId} from "../type/RoleId.sol";
-import {Pool} from "./Pool.sol";
+import {InstanceStore} from "../instance/InstanceStore.sol";
 
 import {Amount, AmountLib} from "../type/Amount.sol";
-import {Fee, FeeLib} from "../type/Fee.sol";
-import {StateId, ACTIVE, PAUSED, CLOSED, KEEP_STATE} from "../type/StateId.sol";
+import {BundleSet} from "../instance/BundleSet.sol";
+import {Fee} from "../type/Fee.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
+import {NftId, NftIdLib} from "../type/NftId.sol";
+import {ObjectType, ACCOUNTING, COMPONENT, POOL, BUNDLE, POLICY, REGISTRY} from "../type/ObjectType.sol";
+import {PoolLib} from "./PoolLib.sol";
 import {Seconds} from "../type/Seconds.sol";
-import {TimestampLib, zeroTimestamp} from "../type/Timestamp.sol";
-import {Version, VersionLib} from "../type/Version.sol";
-import {Versionable} from "../shared/Versionable.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 {IRegistryService} from "../registry/IRegistryService.sol";
-import {InstanceService} from "../instance/InstanceService.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
+import {StateId, ACTIVE, PAUSED, CLOSED, KEEP_STATE} from "../type/StateId.sol";
+import {Timestamp, TimestampLib, zeroTimestamp} from "../type/Timestamp.sol";
 
-string constant BUNDLE_SERVICE_NAME = "BundleService";
 
 contract BundleService is 
-    ComponentService, 
+    Service, 
     IBundleService 
 {
-    using NftIdLib for NftId;
-
+    
     string public constant NAME = "BundleService";
 
-    address internal _registryAddress;
+    address private _registryAddress;
+    IRegistryService private _registryService;
+    IAccountingService private _accountingService;
+    IComponentService private _componentService;
 
     function _initialize(
         address owner, 
         bytes memory data
     )
         internal
-        initializer
         virtual override
+        initializer()
     {
-        address registryAddress;
-        address initialOwner;
-        (registryAddress, initialOwner) = abi.decode(data, (address, address));
-        // TODO while PoolService is not deployed in PoolServiceManager constructor
-        //      owner is PoolServiceManager deployer
-        initializeService(registryAddress, address(0), owner);
-        registerInterface(type(IBundleService).interfaceId);
-    }
+        (
+            address authority,
+            address registry
+        ) = abi.decode(data, (address, address));
 
-    function getDomain() public pure override returns(ObjectType) {
-        return BUNDLE();
+        __Service_init(authority, registry, owner);
+
+        _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
+        _accountingService = IAccountingService(_getServiceAddress(ACCOUNTING()));
+        _componentService = IComponentService(_getServiceAddress(COMPONENT()));
+
+        _registerInterface(type(IBundleService).interfaceId);
     }
 
-    // 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
+
+    function setFee(
+        NftId bundleNftId,
+        Fee memory fee
     )
-        internal
-        returns (
-            TokenHandler tokenHandler,
-            address wallet,
-            Amount netStakingAmount
-        )
+        external
+        virtual
+        restricted()
     {
-        if(stakingAmount.gtz()) {
-            InstanceReader instanceReader = instance.getInstanceReader();
-            IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
-
-            tokenHandler = componentInfo.tokenHandler;
-            wallet = componentInfo.wallet;
+        _checkNftType(bundleNftId, BUNDLE());
 
-            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);
+        (NftId poolNftId, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
+        InstanceReader instanceReader = instance.getInstanceReader();
+        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
+        if(bundleInfo.poolNftId.eqz()) {
+            revert ErrorBundleServiceBundleUnknown(bundleNftId);
+        }
 
-            // update pool balance and fee amount
-            poolInfo.balanceAmount = poolInfo.balanceAmount + netStakingAmount;
+        if(bundleInfo.poolNftId != poolNftId) {
+            revert ErrorBundleServiceBundlePoolMismatch(bundleNftId, bundleInfo.poolNftId, poolNftId);
+        }
 
-            if(poolFeeAmount.gtz()) {
-                poolInfo.feeAmount = poolInfo.feeAmount + poolFeeAmount;
-            }
+        bundleInfo.fee = fee;
+        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
 
-            // save updated pool info
-            componentInfo.data = abi.encode(poolInfo);
-            instance.getInstanceStore().updatePoolSetup(poolNftId, componentInfo, KEEP_STATE());
-        }
+        emit LogBundleServiceBundleFeeUpdated(bundleNftId, fee.fixedFee, fee.fractionalFee);
     }
 
 
     function create(
-        IInstance instance,
-        NftId poolNftId,
         address owner, 
         Fee memory bundleFee, 
-        Amount stakingAmount, 
         Seconds lifetime, 
         bytes calldata filter
     )
         external
-        override
-        // TODO add restricted and add authz for pool service
+        virtual
+        restricted()
         returns(NftId bundleNftId)
     {
+        (NftId poolNftId, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
+
         // register bundle with registry
-        bundleNftId = getRegistryService().registerBundle(
+        bundleNftId = _registryService.registerBundle(
             IRegistry.ObjectInfo(
-                zeroNftId(), 
+                NftIdLib.zero(), 
                 poolNftId,
                 BUNDLE(),
                 false, // intercepting property for bundles is defined on pool
@@ -139,47 +113,24 @@ contract BundleService is
         );
 
         // create bundle info in instance
-        instance.getInstanceStore().createBundle(
+        InstanceStore instanceStore = instance.getInstanceStore();
+        instanceStore.createBundle(
             bundleNftId, 
-            IBundle.BundleInfo(
-                poolNftId,
-                bundleFee,
-                filter,
-                stakingAmount,
-                AmountLib.zero(),
-                AmountLib.zero(),
-                lifetime,
-                TimestampLib.blockTimestamp().addSeconds(lifetime),
-                zeroTimestamp()));
+            IBundle.BundleInfo({
+                poolNftId: poolNftId,
+                fee: bundleFee,
+                filter: filter,
+                activatedAt: TimestampLib.current(),
+                expiredAt: TimestampLib.current().addSeconds(lifetime),
+                closedAt: zeroTimestamp()
+            })
+        );
 
         // put bundle under bundle managemet
-        BundleManager bundleManager = instance.getBundleManager();
+        BundleSet bundleManager = instance.getBundleSet();
         bundleManager.add(bundleNftId);
 
-        // TODO add logging
-    }
-
-
-    function setFee(
-        NftId bundleNftId,
-        Fee memory fee
-    )
-        external
-        override
-    {
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(POOL());
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-        if(bundleInfo.poolNftId.eqz()) {
-            revert ErrorBundleServiceBundleUnknown(bundleNftId);
-        }
-
-        if(bundleInfo.poolNftId != poolNftId) {
-            revert ErrorBundleServiceBundlePoolMismatch(bundleNftId, bundleInfo.poolNftId, poolNftId);
-        }
-
-        bundleInfo.fee = fee;
-        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+        emit LogBundleServiceBundleCreated(bundleNftId, poolNftId, lifetime);
     }
 
 
@@ -188,109 +139,75 @@ contract BundleService is
         IInstance instance,
         NftId policyNftId, 
         NftId bundleNftId, 
-        Amount collateralAmount, // required amount to collateralize policy
-        Amount premiumAmount // premium part that reaches bundle for this policy
+        Amount collateralAmount // required local amount to collateralize policy
     ) 
         external
-        onlyService // TODO replace with restricted + appropriate granting
+        virtual
+        restricted()
     {
+        // checks
+        _checkNftType(policyNftId, POLICY());
+        _checkNftType(bundleNftId, BUNDLE());
+
         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);
-        }
+        {
+            StateId bundleState = instance.getInstanceReader().getBundleState(bundleNftId);
+            IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
 
-        // ensure bundle capacity is sufficent to collateralize policy
-        Amount capacity = bundleInfo.capitalAmount + premiumAmount - bundleInfo.lockedAmount;
-        if(capacity < collateralAmount) {
-            revert ErrorBundleServiceCapacityInsufficient(bundleNftId, capacity, collateralAmount);
+            // ensure bundle is active and not yet expired
+            if(bundleState != ACTIVE() || bundleInfo.expiredAt < TimestampLib.current()) {
+                revert ErrorBundleServiceBundleNotOpen(bundleNftId, bundleState, bundleInfo.expiredAt);
+            }
         }
 
-        // TODO add more validation
-        
-        // updated locked amount
-        bundleInfo.lockedAmount = bundleInfo.lockedAmount + collateralAmount;
-
-        // update capital and fees when premiums are involved
-        _updateBundleWithPremium(instance, bundleNftId, bundleInfo, premiumAmount);
-        
-        // link policy to bundle in bundle manger
-        _linkPolicy(instance, policyNftId);
-    }
-
+        InstanceStore instanceStore = instance.getInstanceStore();
 
-    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
+        {
+            // ensure bundle capacity is sufficent to collateralize policy
             (
-                , 
-                Amount netPremiumAmount
-            ) = FeeLib.calculateFee(bundleInfo.fee, premiumAmount);
-
-            // update bundle info with additional capital
-            bundleInfo.capitalAmount = bundleInfo.capitalAmount + netPremiumAmount;
+                Amount balanceAmount,
+                Amount lockedAmount,
+                Amount feeAmount
+            ) = instanceStore.getAmounts(bundleNftId);
+
+            Amount capacity = balanceAmount - (lockedAmount + feeAmount);
+            if(capacity < collateralAmount) {
+                revert ErrorBundleServiceCapacityInsufficient(bundleNftId, capacity, collateralAmount);
+            }
         }
 
-        // 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) = _getAndVerifyCallingComponentAndInstance(POOL());
-
-        // udpate bundle state
-        instance.getInstanceStore().updateBundleState(bundleNftId, PAUSED());
-
-        // update set of active bundles
-        BundleManager bundleManager = instance.getBundleManager();
-        bundleManager.lock(bundleNftId);
+        // effects
+        // updated locked amount
+        instanceStore.increaseLocked(bundleNftId, collateralAmount);
 
-        emit LogBundleServiceBundleLocked(bundleNftId);
+        emit LogBundleServiceCollateralLocked(bundleNftId, policyNftId, collateralAmount);
     }
 
 
-    function unlock(NftId bundleNftId) 
+    function setLocked(NftId bundleNftId, bool locked) 
         external
         virtual
+        restricted()
     {
-        (,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(POOL());
+        // checks
+        _checkNftType(bundleNftId, BUNDLE());
 
-        // udpate bundle state
-        instance.getInstanceStore().updateBundleState(bundleNftId, ACTIVE());
+        (, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
 
+        // effects
         // update set of active bundles
-        BundleManager bundleManager = instance.getBundleManager();
-        bundleManager.unlock(bundleNftId);
-
-        emit LogBundleServiceBundleActivated(bundleNftId);
+        BundleSet bundleManager = instance.getBundleSet();
+
+        if (locked) {
+            bundleManager.lock(bundleNftId);
+            emit LogBundleServiceBundleLocked(bundleNftId);
+        } else {
+            bundleManager.unlock(bundleNftId);
+            emit LogBundleServiceBundleUnlocked(bundleNftId);
+        }
     }
-
+    
 
     function close(
         IInstance instance,
@@ -298,85 +215,172 @@ contract BundleService is
     ) 
         external
         virtual
-        // TODO add restricted and autz for pool service
+        restricted()
+        returns (Amount unstakedAmount, Amount feeAmount)
     {
-        // udpate bundle state
-        instance.getInstanceStore().updateBundleState(bundleNftId, CLOSED());
+        // checks
+        _checkNftType(bundleNftId, BUNDLE());
+
+        InstanceReader instanceReader = instance.getInstanceReader();
 
         // ensure no open policies attached to bundle
-        BundleManager bundleManager = instance.getBundleManager();
+        BundleSet bundleManager = instance.getBundleSet();
         uint256 openPolicies = bundleManager.activePolicies(bundleNftId);
         if(openPolicies > 0) {
             revert ErrorBundleServiceBundleWithOpenPolicies(bundleNftId, openPolicies);
         }
 
-        // update set of active bundles
-        bundleManager.lock(bundleNftId);
-    }
+        // effects
+        {
+            // update bundle state
+            InstanceStore instanceStore = instance.getInstanceStore();
+            instanceStore.updateBundleState(bundleNftId, CLOSED());
+            bundleManager.lock(bundleNftId);
+
+            // decrease bundle counters
+            Amount balanceAmountWithFees = instanceReader.getBalanceAmount(bundleNftId);
+            feeAmount = instanceReader.getFeeAmount(bundleNftId);
+            unstakedAmount = balanceAmountWithFees - feeAmount;
+            _accountingService.decreaseBundleBalance(instanceStore, bundleNftId, unstakedAmount, feeAmount);
+        }
 
+        emit LogBundleServiceBundleClosed(bundleNftId);
+    }
 
-    function increaseBalance(
-        IInstance instance,
+    /// @inheritdoc IBundleService
+    function stake(
+        InstanceReader instanceReader,
+        InstanceStore instanceStore,
         NftId bundleNftId, 
-        Amount premiumAmount
+        Amount amount
     ) 
-        external
-        onlyService 
+        external 
+        virtual
+        restricted()
     {
-        InstanceReader instanceReader = instance.getInstanceReader();
+        // checks
+        _checkNftType(bundleNftId, BUNDLE());
+
         IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
+        StateId bundleState = instanceReader.getBundleState(bundleNftId);
+
+        if( (bundleState != ACTIVE() && bundleState != PAUSED()) // locked bundles can be staked
+            || bundleInfo.expiredAt < TimestampLib.current() 
+            || bundleInfo.closedAt.gtz()) {
+            revert ErrorBundleServiceBundleNotOpen(bundleNftId, bundleState, bundleInfo.expiredAt);
+        }
 
-        // update capital and fees when premiums are involved
-        _updateBundleWithPremium(instance, bundleNftId, bundleInfo, premiumAmount);
+        // effects
+        _accountingService.increaseBundleBalance(
+            instanceStore, 
+            bundleNftId, 
+            amount, 
+            AmountLib.zero());
 
-        // TODO add logging (?)
+        emit LogBundleServiceBundleStaked(bundleNftId, amount);
     }
 
-    function releaseCollateral(IInstance instance,
-        NftId policyNftId, 
+    /// @inheritdoc IBundleService
+    function unstake(
+        InstanceStore instanceStore,
         NftId bundleNftId, 
-        Amount collateralAmount
+        Amount amount
     ) 
-        external
-        onlyService 
+        external 
+        virtual
+        restricted()
+        returns (Amount unstakedAmount)
     {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
+        // checks
+        _checkNftType(bundleNftId, BUNDLE());
 
-        // reduce locked amount by released collateral amount
-        bundleInfo.lockedAmount = bundleInfo.lockedAmount - collateralAmount;
-        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+        (
+            Amount balanceAmount,
+            Amount lockedAmount,
+            Amount feeAmount
+        ) = instanceStore.getAmounts(bundleNftId);
+
+        unstakedAmount = amount;
+        Amount availableAmount = balanceAmount - (lockedAmount + feeAmount);
+
+        // if amount is max, then unstake all available 
+        if (amount.gte(AmountLib.max())) {
+            unstakedAmount = availableAmount;
+        }
+        
+        // ensure unstaked amount does not exceed available amount
+        if (unstakedAmount > availableAmount) {
+            revert ErrorBundleServiceUnstakeAmountExceedsLimit(amount, availableAmount);
+        }
+
+        // effects
+        _accountingService.decreaseBundleBalance(
+            instanceStore, 
+            bundleNftId, 
+            unstakedAmount, 
+            AmountLib.zero());
+        
+        emit LogBundleServiceBundleUnstaked(bundleNftId, unstakedAmount);
     }
 
-    /// @dev links policy to bundle
-    function _linkPolicy(IInstance instance, NftId policyNftId) 
-        internal
+    /// @inheritdoc IBundleService
+    function extend(NftId bundleNftId, Seconds lifetimeExtension) 
+        external 
+        virtual
+        restricted()
+        returns (Timestamp extendedExpiredAt) 
     {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
+        // checks
+        _checkNftType(bundleNftId, BUNDLE());
+
+        (NftId poolNftId, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
+        IBundle.BundleInfo memory bundleInfo = instance.getInstanceReader().getBundleInfo(bundleNftId);
+        StateId bundleState = instance.getInstanceReader().getBundleState(bundleNftId);
 
-        // ensure policy has not yet been activated in a previous tx already
-        if (policyInfo.activatedAt.gtz() && policyInfo.activatedAt < TimestampLib.blockTimestamp()) {
-            revert BundleManager.ErrorBundleManagerPolicyAlreadyActivated(policyNftId);
+        // ensure bundle belongs to the pool
+        if (bundleInfo.poolNftId != poolNftId) {
+            revert ErrorBundleServiceBundlePoolMismatch(bundleNftId, bundleInfo.poolNftId, poolNftId);
         }
-        
-        BundleManager bundleManager = instance.getBundleManager();
-        bundleManager.linkPolicy(policyNftId);
+
+        // ensure bundle is active and not yet expired
+        if(bundleState != ACTIVE() || bundleInfo.expiredAt < TimestampLib.current()) {
+            revert ErrorBundleServiceBundleNotOpen(bundleNftId, bundleState, bundleInfo.expiredAt);
+        }
+
+        if (lifetimeExtension.eqz()) {
+            revert ErrorBundleServiceExtensionLifetimeIsZero();
+        }
+
+        // effects
+        bundleInfo.expiredAt = bundleInfo.expiredAt.addSeconds(lifetimeExtension);
+        extendedExpiredAt = bundleInfo.expiredAt;
+
+        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+
+        emit LogBundleServiceBundleExtended(bundleNftId, lifetimeExtension, extendedExpiredAt);
     }
 
-    /// @dev unlinks policy from bundle
-    function unlinkPolicy(
-        IInstance instance, 
-        NftId policyNftId
+
+    function releaseCollateral(
+        InstanceStore instanceStore,
+        NftId policyNftId, 
+        NftId bundleNftId, 
+        Amount collateralAmount
     ) 
         external
         virtual
+        restricted()
     {
-        // ensure policy is closeable
-        if (!instance.getInstanceReader().policyIsCloseable(policyNftId)) {
-            revert ErrorBundleServicePolicyNotCloseable(policyNftId);
-        }
+        _checkNftType(policyNftId, POLICY());
+        _checkNftType(bundleNftId, BUNDLE());
 
-        instance.getBundleManager().unlinkPolicy(policyNftId);
+        instanceStore.decreaseLocked(bundleNftId, collateralAmount);
+
+        emit LogBundleServiceCollateralReleased(bundleNftId, policyNftId, collateralAmount);
+    }
+
+
+    function _getDomain() internal pure override returns(ObjectType) {
+        return BUNDLE();
     }
 }