@etherisc/gif-next 0.0.2-2a0a7d0-893 → 0.0.2-2a59cd5-352

package/contracts/instance/service/IApplicationService.sol

@@ -0,0 +1,82 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRisk} from "../module/IRisk.sol";
+import {IService} from "../../shared/IService.sol";
+
+import {NftId} from "../../types/NftId.sol";
+import {ReferralId} from "../../types/Referral.sol";
+import {RiskId} from "../../types/RiskId.sol";
+import {StateId} from "../../types/StateId.sol";
+import {Timestamp} from "../../types/Timestamp.sol";
+import {UFixed} from "../../types/UFixed.sol";
+import {Fee} from "../../types/Fee.sol";
+
+/// @dev gif service responsible for creating applications
+/// only product components may call transaction functions
+interface IApplicationService is IService {
+    
+    error IApplicationServicePolicyNotApplied(NftId applicationNftId);
+
+    /// @dev creates a new application based on the specified attributes
+    /// may only be called by a product component
+    function create(
+        address applicationOwner,
+        RiskId riskId,
+        NftId bundleNftId,
+        ReferralId referralId,
+        uint256 sumInsuredAmount,
+        uint256 lifetime,
+        bytes memory applicationData
+    ) external returns (NftId applicationNftId);
+
+    /// @dev updates application attributes
+    /// may only be called while the application is in applied state
+    /// may only be called by the referenced product related to applicationNftId
+    function ajust(
+        NftId applicationNftId,
+        RiskId riskId,
+        NftId bundleNftId,
+        ReferralId referralId,
+        uint256 sumInsuredAmount,
+        uint256 lifetime,
+        bytes memory applicationData
+    ) external;
+
+    /// @dev creates a new application that extends the provided policy
+    /// lifetime will seamlessly extend referenced policy, for closed policies
+    /// lifetime will start at underwriting time
+    /// product will need to limit the time window for renewal as underwriting
+    /// will lock the collateral at underwriting time which might be earlier than activation time
+    /// policyNftId needs to refer to an underwritten (or active or closed) policy
+    /// may only be called by the referenced product related to policyNftId
+    function renew(
+        NftId policyNftId, // policy to be renewd (renewal inherits policy attributes)
+        NftId bundleNftId // will likely need a newer bundle for underwriting
+    ) external returns (NftId applicationNftId);
+
+    /// @dev revokes the application represented by {policyNftId}
+    /// an application can only be revoked in applied state
+    /// only the application holder may revoke an application
+    function revoke(NftId policyNftId) external;
+
+    /// @dev calculates the premium amount for the specified attributes
+    /// also returns the various fee components involved with creating a policy
+    function calculatePremium(
+        RiskId riskId,
+        uint256 sumInsuredAmount,
+        uint256 lifetime,
+        bytes memory applicationData,
+        NftId bundleNftId,
+        ReferralId referralId
+    )
+        external
+        view
+        returns (
+            uint256 premiumAmount,
+            uint256 distributionFeeAmount,
+            uint256 productFeeAmount,
+            uint256 poolFeeAmount,
+            uint256 bundleFeeAmount
+        );
+}

package/contracts/instance/service/IBundleService.sol

@@ -26,7 +26,17 @@ interface IBundleService is IService {
 
     function updateBundle(NftId instanceNftId, NftId bundleNftId, IBundle.BundleInfo memory bundleInfo, StateId state) external;
 
-    function underwritePolicy(IInstance instanceNftId, NftId policyNftId, NftId bundleNftId, uint256 collateralAmount, uint256 netPremium) external;
+    function lockCollateral(
+        IInstance instanceNftId, 
+        NftId policyNftId, 
+        NftId bundleNftId, 
+        uint256 collateralAmount, 
+        uint256 netPremium
+    )
+        external
+        returns (
+            IBundle.BundleInfo memory bundleInfo
+        );
 
     function increaseBalance(IInstance instance, NftId bundleNftId,  uint256 amount) external;
 

package/contracts/instance/service/IDistributionService.sol

@@ -4,9 +4,62 @@ pragma solidity ^0.8.19;
 import {NftId} from "../../types/NftId.sol";
 import {Fee} from "../../types/Fee.sol";
 import {IService} from "../../shared/IService.sol";
+import {UFixed} from "../../types/UFixed.sol";
+import {DistributorType} from "../../types/DistributorType.sol";
+import {ReferralId} from "../../types/Referral.sol";
+import {Timestamp} from "../../types/Timestamp.sol";
+
 
 interface IDistributionService is IService {
     function setFees(
         Fee memory distributionFee
     ) external;
+    
+    function createDistributorType(
+        string memory name,
+        UFixed minDiscountPercentage,
+        UFixed maxDiscountPercentage,
+        UFixed commissionPercentage,
+        uint32 maxReferralCount,
+        uint32 maxReferralLifetime,
+        bool allowSelfReferrals,
+        bool allowRenewals,
+        bytes memory data
+    )
+        external
+        returns (DistributorType distributorType);
+
+    function createDistributor(
+        address distributor,
+        DistributorType distributorType,
+        bytes memory data
+    ) external returns (NftId distributorNftId);
+
+    function updateDistributorType(
+        NftId distributorNftId,
+        DistributorType distributorType,
+        bytes memory data
+    ) external;
+
+    function createReferral(
+        NftId distributorNftId,
+        string memory code,
+        UFixed discountPercentage,
+        uint32 maxReferrals,
+        Timestamp expiryAt,
+        bytes memory data
+    )
+        external
+        returns (ReferralId referralId);
+
+    /// @dev callback from product service when selling a policy for a specific referralId
+    function processSale(
+        ReferralId referralId,
+        uint256 premiumAmount
+    ) external;
+
+    function calculateFeeAmount(
+        ReferralId referralId,
+        uint256 premiumAmount
+    ) external view returns (uint256 feeAmount);
 }

package/contracts/instance/service/IPolicyService.sol

@@ -52,33 +52,27 @@ interface IPolicyService is IService {
         ReferralId referralId
     ) external returns (NftId nftId);
 
-    /**
-     * @dev revokes the application represented by {policyNftId}.
-     * an application can only be revoked in applied state.
-     * only the application holder may revoke an application.
-     */
-    function revoke(NftId policyNftId) external;
+    /// @dev declines an application represented by {policyNftId}
+    /// an application can only be declined in applied state
+    /// only the related product may decline an application
+    function decline(NftId policyNftId) external;
 
-    /**
-     * @dev underwrites the policy represented by {policyNftId}.
-     * optionally collects premiums and activates the policy.
-     * - premium payment is only attempted if requirePremiumPayment is set to true
-     * - activation is only done if activateAt is a non-zero timestamp
-     */
+    /// @dev underwrites the policy represented by {policyNftId}.
+    /// optionally collects premiums and activates the policy.
+    /// - premium payment is only attempted if requirePremiumPayment is set to true
+    /// - activation is only done if activateAt is a non-zero timestamp
+    /// an application can only be underwritten in applied state
+    /// only the related product may underwrite an application
     function underwrite(
         NftId policyNftId,
         bool requirePremiumPayment,
         Timestamp activateAt
     ) external;
 
-    // function decline(uint256 nftId) external;
-    // function expire(uint256 nftId) external;
-
     function collectPremium(NftId policyNftId, Timestamp activateAt) external;
 
     function activate(NftId policyNftId, Timestamp activateAt) external;
 
-
     function close(NftId nftId) external;
 
     // function createClaim(uint256 nftId, uint256 claimAmount) external;

package/contracts/instance/service/PolicyService.sol

@@ -41,7 +41,10 @@ import {IPoolService} from "./IPoolService.sol";
 import {IBundleService} from "./IBundleService.sol";
 
 
-contract PolicyService is ComponentService, IPolicyService {
+contract PolicyService is
+    ComponentService, 
+    IPolicyService
+{
     using NftIdLib for NftId;
     using TimestampLib for Timestamp;
 
@@ -62,12 +65,12 @@ contract PolicyService is ComponentService, IPolicyService {
         address initialOwner;
         (registryAddress, initialOwner) = abi.decode(data, (address, address));
 
-        _initializeService(registryAddress, owner);
+        initializeService(registryAddress, owner);
 
-        _poolService = IPoolService(_registry.getServiceAddress(POOL(), getMajorVersion()));
-        _bundleService = IBundleService(_registry.getServiceAddress(BUNDLE(), getMajorVersion()));
+        _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getMajorVersion()));
+        _bundleService = IBundleService(getRegistry().getServiceAddress(BUNDLE(), getMajorVersion()));
 
-        _registerInterface(type(IPolicyService).interfaceId);
+        registerInterface(type(IPolicyService).interfaceId);
     }
 
 
@@ -81,6 +84,7 @@ contract PolicyService is ComponentService, IPolicyService {
         (productInfo,) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
         product = Product(productInfo.objectAddress);
     }
+
     // TODO: no access restrictions
     function calculatePremium(
         RiskId riskId,
@@ -92,7 +96,7 @@ contract PolicyService is ComponentService, IPolicyService {
     )
         public
         view 
-        override
+        virtual override
         returns (
             uint256 premiumAmount,
             uint256 productFeeAmount,
@@ -177,7 +181,11 @@ contract PolicyService is ComponentService, IPolicyService {
         bytes memory applicationData,
         NftId bundleNftId,
         ReferralId referralId
-    ) external override returns (NftId policyNftId) {
+    )
+        external 
+        virtual override
+        returns (NftId policyNftId)
+    {
         (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
         // TODO: add validations (see create bundle in pool service)
 
@@ -236,118 +244,78 @@ contract PolicyService is ComponentService, IPolicyService {
         internal
         view
         returns (
+            NftId poolNftId,
             NftId bundleNftId,
             IBundle.BundleInfo memory bundleInfo,
             uint256 collateralAmount
         )
     {
         // check match between policy and bundle (via pool)
+        poolNftId = productSetupInfo.poolNftId;
         bundleNftId = policyInfo.bundleNftId;
         bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-        require(bundleInfo.poolNftId == productSetupInfo.poolNftId, "POLICY_BUNDLE_MISMATCH");
+        require(bundleInfo.poolNftId == poolNftId, "POLICY_BUNDLE_MISMATCH");
 
         // calculate required collateral
-        NftId poolNftId = productSetupInfo.poolNftId;
         ISetup.PoolSetupInfo memory poolInfo = instanceReader.getPoolSetupInfo(poolNftId);
 
         // obtain remaining return values
+        // TODO required collateral amount should be calculated by pool service, not policy service
         collateralAmount = calculateRequiredCollateral(poolInfo.collateralizationLevel, policyInfo.sumInsuredAmount);
     }
 
-    function _lockCollateralInBundle(
-        IInstance instance,
-        NftId bundleNftId, 
-        IBundle.BundleInfo memory bundleInfo,
-        NftId policyNftId, 
-        uint256 collateralAmount
-    )
-        internal
-        returns (IBundle.BundleInfo memory)
-    {
-        bundleInfo.lockedAmount += collateralAmount;
-        // TODO: track policy associated to bundle in bundlemanager (tbd) and how much is locked for it
-        return bundleInfo;
-    }
-
-    function _underwriteByPool(
-        NftId poolNftId,
-        NftId policyNftId,
-        IPolicy.PolicyInfo memory policyInfo,
-        bytes memory bundleFilter,
-        uint256 collateralAmount
-    )
-        internal
-    {
-        address poolAddress = getRegistry().getObjectInfo(poolNftId).objectAddress;
-        IPoolComponent pool = IPoolComponent(poolAddress);
-        pool.underwrite(
-            policyNftId, 
-            policyInfo.applicationData, 
-            bundleFilter,
-            collateralAmount);
-    }
-
 
-    function revoke(
+    function decline(
         NftId policyNftId
     )
         external
         override
     {
-        require(false, "ERROR:PRS-234:NOT_YET_IMPLEMENTED");
+        require(false, "ERROR:PRS-235:NOT_YET_IMPLEMENTED");
     }
 
 
+    /// @dev underwites application which includes the locking of the required collateral from the pool.
     function underwrite(
-        NftId policyNftId,
+        NftId applicationNftId, // = policyNftId
         bool requirePremiumPayment,
         Timestamp activateAt
     )
         external 
-        override
+        virtual override
     {
         // check caller is registered product
-        (
-            IRegistry.ObjectInfo memory productInfo, 
-            IInstance instance
-        ) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        InstanceReader instanceReader = instance.getInstanceReader();
+        IInstance instance;
+        InstanceReader instanceReader;
+        NftId productNftId;
+        {
+            IRegistry.ObjectInfo memory productInfo;
+            (productInfo, instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+            instanceReader = instance.getInstanceReader();
+            productNftId = productInfo.nftId;
+        }
 
-        // check match between policy and calling product
-        NftId productNftId = productInfo.nftId;
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
+        // check policy matches with calling product
+        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(applicationNftId);
         require(policyInfo.productNftId == productNftId, "POLICY_PRODUCT_MISMATCH");
-        require(instanceReader.getPolicyState(policyNftId) == APPLIED(), "ERROR:PRS-021:STATE_NOT_APPLIED");
 
-        NftId bundleNftId;
-        IBundle.BundleInfo memory bundleInfo;
-        uint256 collateralAmount;
-        uint256 netPremiumAmount = 0; // > 0 if immediate premium payment 
-        {
-            ISetup.ProductSetupInfo memory productSetupInfo = instanceReader.getProductSetupInfo(productNftId);
-            IBundle.BundleInfo memory bundleInfo;
-            
-            (
-                bundleNftId,
-                bundleInfo,
-                collateralAmount
-            ) = _getAndVerifyUnderwritingSetup(
-                instance,
-                instanceReader,
-                policyInfo,
-                productSetupInfo
-            );
-        }
+        // check policy is in state applied
+        require(instanceReader.getPolicyState(applicationNftId) == APPLIED(), "ERROR:PRS-021:STATE_NOT_APPLIED");
         
-        // lock bundle collateral
-        bundleInfo = _lockCollateralInBundle(
+        (
+            NftId poolNftId,
+            NftId bundleNftId,
+            IBundle.BundleInfo memory bundleInfo,
+            uint256 collateralAmount
+        ) = _getAndVerifyUnderwritingSetup(
             instance,
-            bundleNftId,
-            bundleInfo,
-            policyNftId, 
-            collateralAmount);
-        StateId newPolicyState = UNDERWRITTEN();
+            instanceReader,
+            policyInfo,
+            instanceReader.getProductSetupInfo(productNftId)
+        );
         
+        StateId newPolicyState = UNDERWRITTEN();
+
         // optional activation of policy
         if(activateAt > zeroTimestamp()) {
             newPolicyState = ACTIVE();
@@ -355,38 +323,56 @@ contract PolicyService is ComponentService, IPolicyService {
             policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
         }
 
+        // lock bundle collateral
+        uint256 netPremiumAmount = 0; // > 0 if immediate premium payment 
+
         // optional collection of premium
         if(requirePremiumPayment) {
             netPremiumAmount = _processPremiumByTreasury(
                 instance, 
-                productInfo.nftId,
-                policyNftId, 
+                productNftId,
+                applicationNftId, 
                 policyInfo.premiumAmount);
 
             policyInfo.premiumPaidAmount += policyInfo.premiumAmount;
         }
 
-        _bundleService.underwritePolicy(instance, policyNftId, bundleNftId, collateralAmount, netPremiumAmount);
-        instance.updatePolicy(policyNftId, policyInfo, newPolicyState);
+        // lock collateral and update bundle book keeping
+        // TODO introduct indirection via pool service?
+        // well pool would only need to be involved when a part of the collateral
+        // is provided by a "re insurance policy" of the pool
+        // but then again the policiy would likely best be attached to the bundle. really? why?
+        // retention level: fraction of sum insured that product will cover from pool funds directly
+        // eg retention level 30%, payouts up to 30% of the sum insured will be made from the product's pool directly
+        // for the remaining 70% the pool owns a policy that will cover claims that exceed the 30% of the sum insured
+        // open points:
+        // - do we need a link of a bundle to this policy or is it enough to know that the pool has an active policy?
+        // - when to buy such policies and for which amount? manual trigger or link to bundle creation and/or funding?
+        bundleInfo = _bundleService.lockCollateral(
+            instance,
+            applicationNftId, 
+            bundleNftId,
+            collateralAmount,
+            netPremiumAmount);
+
+        instance.updatePolicy(applicationNftId, policyInfo, newPolicyState);
 
-        // involve pool if necessary
-        {
-            ISetup.PoolSetupInfo memory poolInfo = instanceReader.getPoolSetupInfo(bundleInfo.poolNftId);
-
-            if(poolInfo.isConfirmingApplication) {
-                _underwriteByPool(
-                    bundleInfo.poolNftId,
-                    policyNftId,
-                    policyInfo,
-                    bundleInfo.filter,
-                    collateralAmount
-                );
-            }
+        // also verify/confirm application by pool if necessary
+        if(instanceReader.getPoolSetupInfo(poolNftId).isVerifyingApplications) {
+            IPoolComponent pool = IPoolComponent(
+                getRegistry().getObjectInfo(poolNftId).objectAddress);
+
+            pool.verifyApplication(
+                applicationNftId, 
+                policyInfo.applicationData, 
+                bundleInfo.filter,
+                collateralAmount);
         }
 
         // TODO: add logging
     }
 
+
     function calculateRequiredCollateral(UFixed collateralizationLevel, uint256 sumInsuredAmount) public pure override returns(uint256 collateralAmount) {
         UFixed sumInsuredUFixed = UFixedLib.toUFixed(sumInsuredAmount);
         UFixed collateralUFixed =  collateralizationLevel * sumInsuredUFixed;

package/contracts/instance/service/PoolService.sol

@@ -30,6 +30,7 @@ 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";
 
@@ -54,9 +55,8 @@ contract PoolService is
         (registryAddress, initialOwner) = abi.decode(data, (address, address));
         // TODO while PoolService is not deployed in PoolServiceManager constructor
         //      owner is PoolServiceManager deployer
-        _initializeService(registryAddress, owner);
-
-        _registerInterface(type(IPoolService).interfaceId);
+        initializeService(registryAddress, owner);
+        registerInterface(type(IPoolService).interfaceId);
     }
 
     function getDomain() public pure override(Service, IService) returns(ObjectType) {
@@ -68,7 +68,7 @@ contract PoolService is
         returns(NftId poolNftId)
     {
         (
-            IComponent pool,
+            IComponent component,
             address owner,
             IInstance instance,
             NftId instanceNftId
@@ -77,47 +77,14 @@ contract PoolService is
             POOL(),
             POOL_OWNER_ROLE());
 
-        (
-            IRegistry.ObjectInfo memory poolInfo,
-            bytes memory data
-        ) = getRegistryService().registerPool(pool, owner);
+        IPoolComponent pool = IPoolComponent(poolAddress);
+        IRegistry.ObjectInfo memory poolInfo = getRegistryService().registerPool(pool, owner);
         pool.linkToRegisteredNftId();
         poolNftId = poolInfo.nftId;
 
-        (
-            string memory name, 
-            ISetup.PoolSetupInfo memory initialSetup
-        ) = _decodeAndVerifyPoolData(data);
-        instance.createPoolSetup(poolNftId, initialSetup);
-
-        getInstanceService().createTarget(instanceNftId, poolAddress, name);
-    }
-
-    function _decodeAndVerifyPoolData(bytes memory data) 
-        internal 
-        returns(string memory name, ISetup.PoolSetupInfo memory setup)
-    {
-        (name, setup) = abi.decode(
-            data,
-            (string, ISetup.PoolSetupInfo)
-        );
-
-        // TODO add checks
-        /*IRegistry _registry = getRegistry();
-
-        if(wallet == address(0)) {
-            revert WalletIsZero();
-        }
-
-        ObjectType tokenType = _registry.getObjectInfo(address(token)).objectType;
-
-        if(tokenType != TOKEN()) {
-            revert InvalidToken();
-        } 
-
-        if(UFixedLib.eqz(info.collateralizationLevel)) { 
-            revert CollateralizationLevelIsZero();
-        }*/
+        instance.createPoolSetup(poolNftId, pool.getSetupInfo());
+        getInstanceService().createGifTarget(instanceNftId, poolAddress, pool.getName());
+        getInstanceService().grantPoolDefaultPermissions(instanceNftId, poolAddress, pool.getName());
     }
 
     function setFees(