@etherisc/gif-next 0.0.2-b3a9c97-695 → 0.0.2-b3e9a44-364

package/contracts/product/PolicyService.sol

@@ -10,18 +10,18 @@ import {IInstance} from "../instance/IInstance.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 
 import {TokenHandler} from "../shared/TokenHandler.sol";
-import {TokenTransferLib} from "../shared/TokenTransferLib.sol";
 
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {Timestamp, TimestampLib, zeroTimestamp} from "../type/Timestamp.sol";
 import {ObjectType, APPLICATION, COMPONENT, DISTRIBUTION, PRODUCT, POOL, POLICY, BUNDLE, CLAIM, PRICE} from "../type/ObjectType.sol";
-import {APPLIED, COLLATERALIZED, KEEP_STATE, CLOSED, DECLINED} from "../type/StateId.sol";
+import {APPLIED, COLLATERALIZED, KEEP_STATE, CLOSED, DECLINED, PAID} from "../type/StateId.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
 import {ReferralId} from "../type/Referral.sol";
 import {StateId} from "../type/StateId.sol";
 import {VersionPart} from "../type/Version.sol";
 
 import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
+import {ContractLib} from "../shared/ContractLib.sol";
 import {IApplicationService} from "./IApplicationService.sol";
 import {IBundleService} from "../pool/IBundleService.sol";
 import {IClaimService} from "./IClaimService.sol";
@@ -29,6 +29,7 @@ import {IComponentService} from "../shared/IComponentService.sol";
 import {IDistributionService} from "../distribution/IDistributionService.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
+import {IPolicyHolder} from "../shared/IPolicyHolder.sol";
 import {IPolicyService} from "./IPolicyService.sol";
 import {IPoolService} from "../pool/IPoolService.sol";
 import {IPricingService} from "./IPricingService.sol";
@@ -48,8 +49,6 @@ contract PolicyService is
     IPoolService internal _poolService;
     IPricingService internal _pricingService;
 
-    event LogProductServiceSender(address sender);
-
     function _initialize(
         address owner, 
         bytes memory data
@@ -59,12 +58,11 @@ contract PolicyService is
         initializer
     {
         (
-            address registryAddress,, 
-            //address managerAddress
+            address registryAddress,
             address authority
-        ) = abi.decode(data, (address, address, address));
+        ) = abi.decode(data, (address, address));
 
-        initializeService(registryAddress, authority, owner);
+        _initializeService(registryAddress, authority, owner);
 
         VersionPart majorVersion = getVersion().toMajorPart();
         _applicationService = IApplicationService(getRegistry().getServiceAddress(APPLICATION(), majorVersion));
@@ -75,7 +73,7 @@ contract PolicyService is
         _distributionService = IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), majorVersion));
         _pricingService = IPricingService(getRegistry().getServiceAddress(PRICE(), majorVersion));
 
-        registerInterface(type(IPolicyService).interfaceId);
+        _registerInterface(type(IPolicyService).interfaceId);
     }
 
 
@@ -83,7 +81,8 @@ contract PolicyService is
         NftId applicationNftId // = policyNftId
     )
         external
-        virtual override
+        virtual
+        nonReentrant()
     {
         (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
@@ -115,11 +114,11 @@ contract PolicyService is
     /// @inheritdoc IPolicyService
     function createPolicy(
         NftId applicationNftId, // = policyNftId
-        bool requirePremiumPayment,
         Timestamp activateAt
     )
         external 
-        virtual override
+        virtual
+        nonReentrant()
     {
         // check caller is registered product
         (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
@@ -139,13 +138,8 @@ contract PolicyService is
                 productNftId);
         }
         
-        StateId newPolicyState = COLLATERALIZED();
-
         // actual collateralizaion
-        (
-            Amount localCollateralAmount,
-            Amount totalCollateralAmount
-        ) = _poolService.lockCollateral(
+        _poolService.lockCollateral(
             instance,
             address(instanceReader.getComponentInfo(productNftId).token),
             productNftId,
@@ -155,38 +149,50 @@ contract PolicyService is
 
         // optional activation of policy
         if(activateAt > zeroTimestamp()) {
-            applicationInfo.activatedAt = activateAt;
-            applicationInfo.expiredAt = activateAt.addSeconds(applicationInfo.lifetime);
-        }
-
-        IPolicy.Premium memory premium;
-
-        // optional: calculate the premium and update counters for collection at the end of this function
-        if(requirePremiumPayment) {
-            premium = _calculateAndProcessPremium(
-                instance,
-                applicationNftId,
-                applicationInfo);
-
-            applicationInfo.premiumPaidAmount = AmountLib.toAmount(premium.premiumAmount);
+            applicationInfo = _activate(
+                applicationNftId, 
+                applicationInfo, 
+                activateAt);
         }
 
-        // store updated policy info
+        // update policy and set state to collateralized
         instance.getInstanceStore().updatePolicy(
             applicationNftId, 
             applicationInfo, 
-            newPolicyState);
+            COLLATERALIZED());
 
-        // TODO add calling pool contract if it needs to validate application
+        // calculate and store premium
+        IPolicy.PremiumInfo memory premium = _pricingService.calculatePremium(
+            productNftId,
+            applicationInfo.riskId,
+            applicationInfo.sumInsuredAmount,
+            applicationInfo.lifetime,
+            applicationInfo.applicationData,
+            applicationInfo.bundleNftId,
+            applicationInfo.referralId);
 
-        // TODO: add logging
+        instance.getInstanceStore().createPremium(
+            applicationNftId,
+            premium);
+
+        // update referral counter 
+        {
+            IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
 
-        // optional: transfer funds for premium 
-        if(requirePremiumPayment) {
-            _transferFunds(instanceReader, applicationNftId, applicationInfo.productNftId, premium);
+            if (! productInfo.distributionNftId.eqz()) { // only call distribution service if a distribution component is connected to the product    
+                _distributionService.processReferral(
+                    productInfo.distributionNftId, 
+                    applicationInfo.referralId);
+            }
         }
 
-        // TODO: add callback IPolicyHolder.policyActivated() if applicable
+        // log policy creation before interactions with token and policy holder
+        emit LogPolicyServicePolicyCreated(applicationNftId, premium.premiumAmount, activateAt);
+
+        // TODO add calling pool contract if it needs to validate application
+
+        // callback to policy holder if applicable
+        _policyHolderPolicyActivated(applicationNftId, activateAt);
     }
 
 
@@ -197,6 +203,7 @@ contract PolicyService is
     )
         external 
         virtual
+        nonReentrant()
     {
         // check caller is registered product
         (,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
@@ -208,20 +215,19 @@ contract PolicyService is
             revert ErrorPolicyServicePolicyStateNotCollateralized(policyNftId);
         }
 
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
-
         // check if premium is already collected
-        if (policyInfo.premiumPaidAmount.gtz()) {
-            revert ErrorPolicyServicePremiumAlreadyPaid(policyNftId, policyInfo.premiumPaidAmount);
+        if (instanceReader.getPremiumInfoState(policyNftId) == PAID()) {
+            revert ErrorPolicyServicePremiumAlreadyPaid(policyNftId);
         }
 
-        // calculate premium
-        IPolicy.Premium memory premium = _calculateAndProcessPremium(
-                instance,
-                policyNftId,
-                policyInfo);
-
-        policyInfo.premiumPaidAmount = AmountLib.toAmount(premium.premiumAmount);
+        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
+        IPolicy.PremiumInfo memory premium = instanceReader.getPremiumInfo(policyNftId); 
+        
+        _processPremium(
+            instance,
+            policyNftId,
+            policyInfo,
+            premium);
 
         // optionally activate policy
         if(activateAt.gtz()) {
@@ -229,16 +235,20 @@ contract PolicyService is
         }
 
         instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, KEEP_STATE());
+        instance.getInstanceStore().updatePremiumState(policyNftId, PAID());
 
-        // TODO: add logging
+        // log premium collection before interactions with token
+        emit LogPolicyServicePolicyPremiumCollected(policyNftId, premium.premiumAmount);
 
         _transferFunds(instanceReader, policyNftId, policyInfo.productNftId, premium);
-
-        // TODO: add callback IPolicyHolder.policyActivated() if applicable
     }
 
     /// @inheritdoc IPolicyService
-    function activate(NftId policyNftId, Timestamp activateAt) public override {
+    function activate(NftId policyNftId, Timestamp activateAt)
+        external
+        virtual
+        nonReentrant()
+    {
         // check caller is registered product
         (,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
@@ -248,9 +258,11 @@ contract PolicyService is
 
         instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, KEEP_STATE());
 
-        // TODO: add logging
+        // log policy activation before interactions with policy holder
+        emit LogPolicyServicePolicyActivated(policyNftId, activateAt);
 
-        // TODO: add callback IPolicyHolder.policyActivated() if applicable
+        // callback to policy holder if applicable
+        _policyHolderPolicyActivated(policyNftId, activateAt);
     }
 
 
@@ -260,15 +272,14 @@ contract PolicyService is
         Timestamp expireAt
     )
         external
-        override
         virtual
+        nonReentrant()
         returns (Timestamp expiredAt)
     {
         (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
-        InstanceReader instanceReader = instance.getInstanceReader();
-
+        
         // check policy matches with calling product
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
+        IPolicy.PolicyInfo memory policyInfo = instance.getInstanceReader().getPolicyInfo(policyNftId);
         if(policyInfo.productNftId != productNftId) {
             revert ErrorPolicyServicePolicyProductMismatch(
                 policyNftId, 
@@ -276,8 +287,44 @@ contract PolicyService is
                 productNftId);
         }
 
+        return _expire(
+            instance,
+            policyNftId,
+            expireAt
+        );
+    }
+
+    /// @inheritdoc IPolicyService
+    function expirePolicy(
+        IInstance instance,
+        NftId policyNftId,
+        Timestamp expireAt
+    )
+        external
+        virtual
+        nonReentrant()
+        returns (Timestamp expiredAt)
+    {
+        return _expire(
+            instance,
+            policyNftId,
+            expireAt
+        );
+    }
+
+    function _expire(
+        IInstance instance,
+        NftId policyNftId,
+        Timestamp expireAt
+    )
+        internal
+        returns (Timestamp expiredAt)
+    {
+        InstanceReader instanceReader = instance.getInstanceReader();
+        
         // check policy is active
         StateId policyState = instanceReader.getPolicyState(policyNftId);
+        IPolicy.PolicyInfo memory policyInfo = instance.getInstanceReader().getPolicyInfo(policyNftId);
         if (!_policyHasBeenActivated(policyState, policyInfo)) {
             revert ErrorPolicyServicePolicyNotActive(policyNftId, policyState);
         }
@@ -299,12 +346,14 @@ contract PolicyService is
         }
 
         // update policyInfo with new expiredAt timestamp
+        Timestamp originalExpiredAt = policyInfo.expiredAt;
         policyInfo.expiredAt = expiredAt;
         instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, KEEP_STATE());
 
-        emit LogPolicyServicePolicyExpirationUpdated(policyNftId, expiredAt);
+        emit LogPolicyServicePolicyExpirationUpdated(policyNftId, originalExpiredAt, expiredAt);
 
-        // TODO: add callback IPolicyHolder.policyExpired() if applicable
+        // callback to policy holder if applicable
+        _policyHolderPolicyExpired(policyNftId, expiredAt);
     }
 
 
@@ -312,7 +361,8 @@ contract PolicyService is
         NftId policyNftId
     )
         external 
-        override
+        virtual
+        nonReentrant()
     {
         (,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
@@ -335,8 +385,9 @@ contract PolicyService is
         }
 
         // TODO consider to allow for underpaid premiums (with the effects of reducing max payouts accordingly)
-        if (!(policyInfo.premiumAmount == policyInfo.premiumPaidAmount)) {
-            revert ErrorPolicyServicePremiumNotFullyPaid(policyNftId, policyInfo.premiumAmount, policyInfo.premiumPaidAmount);
+        // TODO consider to remove requirement for fully paid premiums altogether
+        if (! instanceReader.getPremiumInfoState(policyNftId).eq(PAID())) {
+            revert ErrorPolicyServicePremiumNotPaid(policyNftId, policyInfo.premiumAmount);
         }
 
         // release (remaining) collateral that was blocked by policy
@@ -346,37 +397,29 @@ contract PolicyService is
             policyNftId, 
             policyInfo);
 
+        // TODO consider to also set expiredAt to current block timestamp if that timestamp is still in the futue
+
         // update policy state to closed
         policyInfo.closedAt = TimestampLib.blockTimestamp();
         instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, CLOSED());
+
+        emit LogPolicyServicePolicyClosed(policyNftId);
     }
 
 
     /// @dev calculates the premium and updates all counters in the other services
-    function _calculateAndProcessPremium(
+    function _processPremium(
         IInstance instance,
         NftId applicationNftId,
-        IPolicy.PolicyInfo memory applicationInfo
+        IPolicy.PolicyInfo memory applicationInfo,
+        IPolicy.PremiumInfo memory premium
     )
         internal
         virtual
-        returns (
-            IPolicy.Premium memory premium
-        )
     {
         NftId productNftId = applicationInfo.productNftId;
         InstanceReader instanceReader = instance.getInstanceReader();
 
-        // calculate premium details
-        premium = _pricingService.calculatePremium(
-            productNftId,
-            applicationInfo.riskId,
-            applicationInfo.sumInsuredAmount,
-            applicationInfo.lifetime,
-            applicationInfo.applicationData,
-            applicationInfo.bundleNftId,
-            applicationInfo.referralId);
-
         // check if premium balance and allowance of policy holder is sufficient
         {
             TokenHandler tokenHandler = _getTokenHandler(instanceReader, productNftId);
@@ -386,7 +429,7 @@ contract PolicyService is
                 tokenHandler.getToken(), 
                 address(tokenHandler),
                 policyHolder, 
-                AmountLib.toAmount(premium.premiumAmount));
+                premium.premiumAmount);
         }
 
         // update the counters
@@ -399,7 +442,6 @@ contract PolicyService is
             premium);
     }
 
-
     function _activate(
         NftId policyNftId, 
         IPolicy.PolicyInfo memory policyInfo,
@@ -410,10 +452,16 @@ contract PolicyService is
         view 
         returns (IPolicy.PolicyInfo memory)
     {
-        if(! policyInfo.activatedAt.eqz()) {
+        // fail if policy has already been activated and activateAt is different
+        if(! policyInfo.activatedAt.eqz() && activateAt != policyInfo.activatedAt) {
             revert ErrorPolicyServicePolicyAlreadyActivated(policyNftId);
         }
 
+        // ignore if policy has already been activated and activateAt is the same
+        if (policyInfo.activatedAt == activateAt) {
+            return policyInfo;
+        }
+
         policyInfo.activatedAt = activateAt;
         policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
 
@@ -427,17 +475,12 @@ contract PolicyService is
         NftId productNftId,
         NftId bundleNftId,
         ReferralId referralId,
-        IPolicy.Premium memory premium
+        IPolicy.PremiumInfo memory premium
     )
         internal
         virtual
     {
-        (
-            NftId distributionNftId,
-            address distributionWallet,
-            address poolWallet,
-            address productWallet
-        ) = _getDistributionNftAndWallets(
+        (NftId distributionNftId, , , ) = _getDistributionNftAndWallets(
             instanceReader, 
             productNftId);
 
@@ -445,13 +488,15 @@ contract PolicyService is
         _componentService.increaseProductFees(
             instanceStore, 
             productNftId, 
-            AmountLib.toAmount(premium.productFeeVarAmount + premium.productFeeFixAmount));
+            premium.productFeeVarAmount + premium.productFeeFixAmount);
 
         // update distribution fees and distributor commission and pool fees 
-        _distributionService.processSale(
-            distributionNftId, 
-            referralId, 
-            premium);
+        if (!distributionNftId.eqz()) { // only call distribution service if a distribution component is connected to the product
+            _distributionService.processSale(
+                distributionNftId, 
+                referralId, 
+                premium);
+        }
 
         // update pool and bundle fees 
         _poolService.processSale(
@@ -465,7 +510,7 @@ contract PolicyService is
         InstanceReader instanceReader,
         NftId policyNftId,
         NftId productNftId,
-        IPolicy.Premium memory premium
+        IPolicy.PremiumInfo memory premium
     )
         internal
         virtual
@@ -482,27 +527,14 @@ contract PolicyService is
             instanceReader, 
             productNftId);
 
-        if (premium.productFeeAmount.gtz()) {
-            TokenTransferLib.collectTokens(
-                policyHolder,
-                productWallet,
-                premium.productFeeAmount,
-                tokenHandler);
-        }
-        if (premium.distributionFeeAndCommissionAmount.gtz()) {
-            TokenTransferLib.collectTokens(
-                policyHolder,
-                distributionWallet,
-                premium.distributionFeeAndCommissionAmount,
-                tokenHandler);
-        }
-        if (premium.poolPremiumAndFeeAmount.gtz()) {
-            TokenTransferLib.collectTokens(
-                policyHolder,
-                poolWallet,
-                premium.poolPremiumAndFeeAmount,
-                tokenHandler);
-        }
+        tokenHandler.collectTokensToThreeRecipients(
+            policyHolder,
+            productWallet,
+            premium.productFeeAmount,
+            distributionWallet,
+            premium.distributionFeeAndCommissionAmount,
+            poolWallet,
+            premium.poolPremiumAndFeeAmount);
     }
 
 
@@ -547,6 +579,64 @@ contract PolicyService is
     }
 
 
+    function _policyHolderPolicyActivated(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+        virtual
+    {
+        // immediately return if policy is not activated
+        if (activateAt.eqz()) {
+            return;
+        }
+
+        // get policy holder address
+        IPolicyHolder policyHolder = _getPolicyHolder(policyNftId);
+
+        // execute callback if policy holder implements IPolicyHolder
+        if (address(policyHolder) != address(0)) {
+            policyHolder.policyActivated(policyNftId, activateAt);
+        }
+    }
+
+
+    function _policyHolderPolicyExpired(
+        NftId policyNftId,
+        Timestamp expiredAt
+    )
+        internal
+        virtual
+    {
+        // immediately return if policy is not activated
+        if (expiredAt.eqz()) {
+            return;
+        }
+
+        // get policy holder address
+        IPolicyHolder policyHolder = _getPolicyHolder(policyNftId);
+
+        // execute callback if policy holder implements IPolicyHolder
+        if (address(policyHolder) != address(0)) {
+            policyHolder.policyExpired(policyNftId, expiredAt);
+        }
+    }
+
+
+    function _getPolicyHolder(NftId policyNftId)
+        internal 
+        view 
+        returns (IPolicyHolder policyHolder)
+    {
+        address policyHolderAddress = getRegistry().ownerOf(policyNftId);
+        policyHolder = IPolicyHolder(policyHolderAddress);
+
+        if (!ContractLib.isPolicyHolder(policyHolderAddress)) {
+            policyHolder = IPolicyHolder(address(0));
+        }
+    }
+
+
     function _getTokenHandler(
         InstanceReader instanceReader,
         NftId productNftId
@@ -561,6 +651,7 @@ contract PolicyService is
         tokenHandler = instanceReader.getComponentInfo(productNftId).tokenHandler;
     }
 
+
     function _getDistributionNftAndWallets(
         InstanceReader instanceReader,
         NftId productNftId

package/contracts/product/PolicyServiceManager.sol

@@ -12,14 +12,14 @@ contract PolicyServiceManager is ProxyManager {
     /// @dev initializes proxy manager with product service implementation 
     constructor(
         address authority, 
-        address registryAddress,
+        address registry,
         bytes32 salt
     ) 
-        ProxyManager(registryAddress)
     {
         PolicyService svc = new PolicyService{salt: salt}();
-        bytes memory data = abi.encode(registryAddress, address(this), authority);
-        IVersionable versionable = deployDetermenistic(
+        bytes memory data = abi.encode(registry, authority);
+        IVersionable versionable = initialize(
+            registry,
             address(svc), 
             data,
             salt);