@etherisc/gif-next 0.0.2-f5a74cc-201 → 0.0.2-f626d92-602

package/contracts/instance/service/PoolService.sol

@@ -6,41 +6,46 @@ 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 {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} from "../../types/Amount.sol";
+import {Fee, FeeLib} from "../../types/Fee.sol";
 import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
-import {POOL, BUNDLE} from "../../types/ObjectType.sol";
-import {POOL_OWNER_ROLE, RoleId} from "../../types/RoleId.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 {ComponentServiceBase} from "../base/ComponentServiceBase.sol";
+import {ComponentService} from "../base/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";
 
 string constant POOL_SERVICE_NAME = "PoolService";
 
 contract PoolService is 
-    ComponentServiceBase, 
+    ComponentService, 
     IPoolService 
 {
     using NftIdLib for NftId;
 
-    string public constant NAME = "PoolService";
-
-    address internal _registryAddress;
+    IBundleService internal _bundleService;
 
     function _initialize(
         address owner, 
@@ -50,238 +55,249 @@ contract PoolService is
         initializer
         virtual override
     {
-        address initialOwner = address(0);
-        (_registryAddress, initialOwner) = abi.decode(data, (address, address));
+        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, owner);
+        initializeService(registryAddress, address(0), owner);
 
-        _registerInterface(type(IService).interfaceId);
-        _registerInterface(type(IPoolService).interfaceId);
+        _bundleService = IBundleService(getRegistry().getServiceAddress(BUNDLE(), getVersion().toMajorPart()));
+
+        registerInterface(type(IPoolService).interfaceId);
+    }
+
+    function getDomain() public pure override returns(ObjectType) {
+        return POOL();
+    }
+
+    function register(address poolAddress) 
+        external
+        returns(NftId poolNftId)
+    {
+        (
+            IComponent component,
+            address owner,
+            IInstance instance,
+            NftId instanceNftId
+        ) = _checkComponentForRegistration(
+            poolAddress,
+            POOL(),
+            POOL_OWNER_ROLE());
+
+        IPoolComponent pool = IPoolComponent(poolAddress);
+        IRegistry.ObjectInfo memory registryInfo = getRegistryService().registerPool(pool, owner);
+        pool.linkToRegisteredNftId();
+        poolNftId = registryInfo.nftId;
+
+        // amend component info with pool specific token handler
+        IComponents.ComponentInfo memory componentInfo = pool.getComponentInfo();
+        componentInfo.tokenHandler = new TokenHandler(address(componentInfo.token));
+
+        // save amended component info with instance
+        instance.createPoolSetup(poolNftId, componentInfo);
+
+        bytes4[][] memory selectors = new bytes4[][](2);
+        selectors[0] = new bytes4[](1);
+        selectors[1] = new bytes4[](1);
+
+        selectors[0][0] = IPoolComponent.setFees.selector;
+        selectors[1][0] = IPoolComponent.verifyApplication.selector;
+
+        RoleId[] memory roles = new RoleId[](2);
+        roles[0] = POOL_OWNER_ROLE();
+        roles[1] = POLICY_SERVICE_ROLE();
+
+        getInstanceService().createGifTarget(
+            instanceNftId, 
+            poolAddress, 
+            pool.getName(), 
+            selectors, 
+            roles);
     }
 
-    function getName() public pure override(Service, IService) returns(string memory name) {
-        return NAME;
+
+    function setMaxCapitalAmount(uint256 maxCapitalAmount)
+        external
+        virtual
+    {
+        (NftId poolNftId, IRegistry.ObjectInfo memory registryInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(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;
+
+        poolInfo.maxCapitalAmount = maxCapitalAmount;
+        componentInfo.data = abi.encode(poolInfo);
+        instance.updatePoolSetup(poolNftId, componentInfo, KEEP_STATE());
+
+        emit LogPoolServiceMaxCapitalAmountUpdated(poolNftId, previousMaxCapitalAmount, maxCapitalAmount);
     }
 
-    function _finalizeComponentRegistration(NftId componentNftId, bytes memory initialObjData, IInstance instance) internal override {
-        ISetup.PoolSetupInfo memory initialSetup = abi.decode(
-            initialObjData,
-            (ISetup.PoolSetupInfo)
-        );
-        instance.createPoolSetup(componentNftId, initialSetup);
+    function setBundleOwnerRole(RoleId bundleOwnerRole)
+        external
+        virtual
+    {
+        (NftId poolNftId, IRegistry.ObjectInfo memory registryInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        InstanceReader instanceReader = instance.getInstanceReader();
+
+        IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
+        IComponents.PoolInfo memory poolInfo = abi.decode(componentInfo.data, (IComponents.PoolInfo));
+
+        // bundle owner role may only be set once per pool
+        if(poolInfo.bundleOwnerRole != PUBLIC_ROLE()) {
+            revert ErrorPoolServiceBundleOwnerRoleAlreadySet(poolNftId);
+        }
+
+        poolInfo.bundleOwnerRole = bundleOwnerRole;
+        componentInfo.data = abi.encode(poolInfo);
+        instance.updatePoolSetup(poolNftId, componentInfo, KEEP_STATE());
+
+        emit LogPoolServiceBundleOwnerRoleSet(poolNftId, bundleOwnerRole);
     }
 
+
     function setFees(
         Fee memory poolFee,
         Fee memory stakingFee,
         Fee memory performanceFee
     )
         external
-        override
+        virtual
     {
-        (IRegistry.ObjectInfo memory poolInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        (NftId poolNftId, IRegistry.ObjectInfo memory registryInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
         InstanceReader instanceReader = instance.getInstanceReader();
-        NftId poolNftId = poolInfo.nftId;
-
-        ISetup.PoolSetupInfo memory poolSetupInfo = instanceReader.getPoolSetupInfo(poolNftId);
-        poolSetupInfo.poolFee = poolFee;
-        poolSetupInfo.stakingFee = stakingFee;
-        poolSetupInfo.performanceFee = performanceFee;
-        
-        instance.updatePoolSetup(poolNftId, poolSetupInfo, KEEP_STATE());
+
+        IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
+        IComponents.PoolInfo memory poolInfo = abi.decode(componentInfo.data, (IComponents.PoolInfo));
+
+        poolInfo.poolFee = poolFee;
+        poolInfo.stakingFee = stakingFee;
+        poolInfo.performanceFee = performanceFee;
+        componentInfo.data = abi.encode(poolInfo);
+        instance.updatePoolSetup(poolNftId, componentInfo, KEEP_STATE());
+
+        // TODO add logging
     }
 
+
     function createBundle(
-        address owner, 
-        Fee memory fee, 
-        uint256 stakingAmount, 
-        uint256 lifetime, 
-        bytes calldata filter
+        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
-        override
+        external 
+        virtual
         returns(NftId bundleNftId)
     {
-        (IRegistry.ObjectInfo memory info, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        (NftId poolNftId,, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
         InstanceReader instanceReader = instance.getInstanceReader();
-        NftId poolNftId = info.nftId;
 
-        IBundle.BundleInfo  memory bundleInfo = IBundle.BundleInfo(
+        // TODO add implementation that takes care of staking fees
+        Amount stakingAfterFeesAmount = stakingAmount;
+
+        bundleNftId = _bundleService.create(
+            instance,
             poolNftId,
+            owner,
             fee,
-            filter,
-            stakingAmount,
-            0,
-            stakingAmount,
+            stakingAfterFeesAmount,
             lifetime,
-            zeroTimestamp(),
-            zeroTimestamp()
-        );
-
-        // register bundle with registry
-        bundleNftId = getRegistryService().registerBundle(
-            IRegistry.ObjectInfo(
-                zeroNftId(), 
-                poolNftId,
-                BUNDLE(),
-                false, // intercepting property for bundles is defined on pool
-                address(0),
-                owner,
-                abi.encode(bundleInfo)
-            )
-        );
-
-        // create bundle info in instance
-        instance.createBundle(bundleNftId, bundleInfo);
-
-        BundleManager bundleManager = instance.getBundleManager();
-        bundleManager.add(bundleNftId);
-        
-        _processStakingByTreasury(
-            instanceReader,
-            poolNftId,
-            bundleNftId,
-            stakingAmount);
+            filter);
 
-        // TODO add logging
+        emit LogPoolServiceBundleCreated(instance.getNftId(), poolNftId, bundleNftId);
     }
 
-    function setBundleFee(
-        NftId bundleNftId,
-        Fee memory fee
-    )
+
+    function closeBundle(NftId bundleNftId)
         external
-        override
+        virtual
     {
-        (IRegistry.ObjectInfo memory info , IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-        InstanceReader instanceReader = instance.getInstanceReader();
-        NftId poolNftId = info.nftId;
+        (NftId poolNftId,, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
 
-        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");
+        // TODO book keeping for pool collateral released outside of retention level
 
-        bundleInfo.fee = fee;
+        // releasing collateral in bundle
+        _bundleService.close(instance, bundleNftId);
 
-        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
-    }
-
-    function updateBundle(NftId instanceNftId, NftId bundleNftId, IBundle.BundleInfo memory bundleInfo, StateId state) 
-        external
-        onlyService
-    {
-        IRegistry.ObjectInfo memory instanceInfo = getRegistry().getObjectInfo(instanceNftId);
-        IInstance instance = IInstance(instanceInfo.objectAddress);
-        instance.updateBundle(bundleNftId, bundleInfo, state);
-    } 
+        // TODO get performance fee for pool, transfer of remaining funds + bundle fees to bundle owner
 
-    function lockBundle(NftId bundleNftId) 
-        external
-    {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-        BundleManager bundleManager = instance.getBundleManager();
-        bundleManager.lock(bundleNftId);
+        emit LogPoolServiceBundleClosed(instance.getNftId(), poolNftId, bundleNftId);
     }
 
-    function unlockBundle(NftId bundleNftId) 
-        external
-    {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-        BundleManager bundleManager = instance.getBundleManager();
-        bundleManager.unlock(bundleNftId);
-    }
 
-    function underwritePolicy(IInstance instance,
-        NftId policyNftId, 
-        NftId bundleNftId, 
-        uint256 collateralAmount,
-        uint256 netPremiumAmount
-    ) 
+    function lockCollateral(
+        IInstance instance, 
+        NftId productNftId,
+        NftId applicationNftId,
+        IPolicy.PolicyInfo memory applicationInfo,
+        uint256 premiumAmount // premium amount after product and distribution fees
+    )
         external
-        onlyService 
+        virtual
+        // TODO add restricted and granting for policy service
     {
         InstanceReader instanceReader = instance.getInstanceReader();
+        NftId poolNftId = instanceReader.getProductSetupInfo(productNftId).poolNftId;
+        NftId bundleNftId = applicationInfo.bundleNftId;
+
+        // TODO move this check to application creation and don't repeat this here
+        // ensure that pool for bundle from application matches with pool for product of application
         IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
+        if(bundleInfo.poolNftId != poolNftId) {
+            revert ErrorPoolServiceBundlePoolMismatch(bundleInfo.poolNftId, poolNftId);
+        }
 
-        // lock collateral
-        bundleInfo.lockedAmount += collateralAmount;
-        bundleInfo.balanceAmount += netPremiumAmount;
+        IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
+        IComponents.PoolInfo memory poolInfo = abi.decode(componentInfo.data, (IComponents.PoolInfo));
 
-        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
-        
-        linkPolicy(instance, policyNftId);
-    }
+        // TODO add correct required collateral calculation (collateralization level mibht be != 1, retention level might be < 1)
+        uint256 collateralAmount = applicationInfo.sumInsuredAmount;
 
-    /// @dev links policy to bundle
-    function linkPolicy(IInstance instance, NftId policyNftId) 
-        internal
-        onlyService 
-    {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
+        // TODO add correct net premium calculation (pool fee might be > 0)
+        uint256 premiumAfterPoolFeeAmount = premiumAmount;
 
-        // ensure policy has not yet been activated
-        if (policyInfo.activatedAt.gtz()) {
-            revert BundleManager.ErrorBundleManagerErrorPolicyAlreadyActivated(policyNftId);
+        // lock collateral amount from involvedd bundle
+        _bundleService.lockCollateral(
+            instance,
+            applicationNftId, 
+            bundleNftId,
+            collateralAmount,
+            premiumAfterPoolFeeAmount);
+
+        // also verify/confirm application by pool if necessary
+        if(poolInfo.isVerifyingApplications) {
+            address poolAddress = getRegistry().getObjectInfo(poolNftId).objectAddress;
+            IPoolComponent(poolAddress).verifyApplication(
+                applicationNftId, 
+                applicationInfo.applicationData, 
+                bundleNftId,
+                bundleInfo.filter,
+                collateralAmount);
         }
-        
-        BundleManager bundleManager = instance.getBundleManager();
-        bundleManager.linkPolicy(policyNftId);
     }
 
-        /// @dev unlinks policy from bundle
-    function unlinkPolicy(IInstance instance, NftId policyNftId) 
-        internal
-        onlyService 
-    {
-        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 (policyInfo.expiredAt < TimestampLib.blockTimestamp()
-            || policyInfo.payoutAmount < policyInfo.sumInsuredAmount)
-        {
-            revert BundleManager.ErrorBundleManagerPolicyNotCloseable(policyNftId);
-        }
-        
-        BundleManager bundleManager = instance.getBundleManager();
-        bundleManager.unlinkPolicy(policyNftId);
-    }
-
-    function _processStakingByTreasury(
-        InstanceReader instanceReader,
-        NftId poolNftId,
-        NftId bundleNftId,
-        uint256 stakingAmount
+    /// @dev releases the remaining collateral linked to the specified policy
+    /// may only be called by the policy service for unlocked pool components
+    function releaseCollateral(
+        IInstance instance, 
+        NftId policyNftId, 
+        IPolicy.PolicyInfo memory policyInfo
     )
-        internal
+        external
+        virtual
+        // TODO add restricted and granting for policy service
     {
-        // process token transfer(s)
-        if(stakingAmount > 0) {
-            ISetup.PoolSetupInfo memory poolInfo = instanceReader.getPoolSetupInfo(poolNftId);
-            TokenHandler tokenHandler = poolInfo.tokenHandler;
-            address bundleOwner = getRegistry().ownerOf(bundleNftId);
-            Fee memory stakingFee = poolInfo.stakingFee;
-
-            tokenHandler.transfer(
-                bundleOwner,
-                poolInfo.wallet,
-                stakingAmount
-            );
-
-
-            if (! FeeLib.feeIsZero(stakingFee)) {
-                (uint256 stakingFeeAmount, uint256 netAmount) = FeeLib.calculateFee(stakingFee, stakingAmount);
-                // TODO: track staking fees in pool's state (issue #177)
-            }
-        }
+        // release collateral from involved bundle
+        _bundleService.releaseCollateral(
+            instance, 
+            policyNftId, 
+            policyInfo.bundleNftId, 
+            policyInfo.sumInsuredAmount);
     }
+
 }

package/contracts/instance/service/PoolServiceManager.sol

@@ -6,7 +6,7 @@ import {ProxyManager} from "../../shared/ProxyManager.sol";
 import {PoolService} from "./PoolService.sol";
 import {Registry} from "../../registry/Registry.sol";
 import {RegistryService} from "../../registry/RegistryService.sol";
-import {VersionLib} from "../../types/Version.sol";
+import {REGISTRY} from "../../types/ObjectType.sol";
 
 contract PoolServiceManager is ProxyManager {
 
@@ -16,7 +16,7 @@ contract PoolServiceManager is ProxyManager {
     constructor(
         address registryAddress
     )
-        ProxyManager()
+        ProxyManager(registryAddress)
     {
         PoolService poolSrv = new PoolService();
         bytes memory data = abi.encode(registryAddress, address(this));
@@ -26,10 +26,10 @@ contract PoolServiceManager is ProxyManager {
 
         _poolService = PoolService(address(versionable));
 
-        Registry registry = Registry(registryAddress);
-        address registryServiceAddress = registry.getServiceAddress("RegistryService", VersionLib.toVersion(3, 0, 0).toMajorPart());
-        RegistryService registryService = RegistryService(registryServiceAddress);
-        // TODO this must have a role or own nft to register service
+        // TODO `this` must have a role or own nft to register service
+        //Registry registry = Registry(registryAddress);
+        //address registryServiceAddress = registry.getServiceAddress(REGISTRY(), _poolService.getMajorVersion());
+        //RegistryService registryService = RegistryService(registryServiceAddress);
         //registryService.registerService(_poolService);
         
         // TODO no nft to link yet
@@ -37,9 +37,6 @@ contract PoolServiceManager is ProxyManager {
         //_linkToNftOwnable(
         //    address(registryAddress),
         //    address(_poolService));
-
-        // implies that after this constructor call only upgrade functionality is available
-        _isDeployed = true;
     }
 
     //--- view functions ----------------------------------------------------//