@etherisc/gif-next 0.0.2-ff8087d-237 → 0.0.2-ffa91a6-022

package/contracts/instance/service/IPoolService.sol

@@ -1,114 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Amount} from "../../types/Amount.sol";
-import {Fee} from "../../types/Fee.sol";
-import {NftId} from "../../types/NftId.sol";
-import {PayoutId} from "../../types/PayoutId.sol";
-import {IBundle} from "../module/IBundle.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {IPolicy} from "../module/IPolicy.sol";
-import {IService} from "../../shared/IService.sol";
-import {RoleId} from "../../types/RoleId.sol";
-import {Seconds} from "../../types/Seconds.sol";
-import {StateId} from "../../types/StateId.sol";
-
-interface IPoolService is IService {
-
-    event LogPoolServiceMaxCapitalAmountUpdated(NftId poolNftId, Amount previousMaxCapitalAmount, Amount currentMaxCapitalAmount);
-    event LogPoolServiceBundleOwnerRoleSet(NftId poolNftId, RoleId bundleOwnerRole);
-
-    event LogPoolServiceBundleCreated(NftId instanceNftId, NftId poolNftId, NftId bundleNftId);
-    event LogPoolServiceBundleClosed(NftId instanceNftId, NftId poolNftId, NftId bundleNftId);
-
-    error ErrorPoolServiceBundleOwnerRoleAlreadySet(NftId poolNftId);
-    error ErrorPoolServiceBundlePoolMismatch(NftId bundlePoolNftId, NftId productPoolNftId);
-    error ErrorPoolServiceInvalidTransferAmount(Amount expectedAmount, Amount actualAmount);
-
-    /// @dev registers a new pool with the registry service
-    function register(address poolAddress) external returns(NftId);
-
-    /// @dev defines the required role for bundle owners for the calling pool
-    /// default implementation returns PUBLIC ROLE
-    function setBundleOwnerRole(RoleId bundleOwnerRole) external;
-
-    /// @dev sets the max capital amount for the calling pool
-    function setMaxCapitalAmount(Amount maxCapitalAmount) external;
-
-    /// @dev set pool sepecific fees
-    function setFees(
-        Fee memory poolFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external;
-
-
-    /// @dev locks required collateral to cover the specified application (and turn it into a policy)
-    /// - retention level == 1: the full collateral amount will be locked by the specified bundle
-    /// - retention level < 1: a part of the coverage is provided by the specified bundle, the rest by the pool component
-    /// in which case the pool component might hold a re-insurance policy
-    /// may only be called by the policy service for unlocked pool components
-    function lockCollateral(
-        IInstance instance, 
-        NftId productNftId,
-        NftId applicationNftId,
-        IPolicy.PolicyInfo memory applicationInfo,
-        Amount premiumAmount
-    ) external;
-
-
-    /// @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
-    ) external;
-
-
-    /// @dev reduces the locked collateral in the bundle associated with the specified policy
-    /// every payout of a policy reduces the collateral by the payout amount
-    /// may only be called by the claim service for unlocked pool components
-    function reduceCollateral(
-        IInstance instance, 
-        NftId policyNftId, 
-        IPolicy.PolicyInfo memory policyInfo,
-        Amount payoutAmount
-    ) external;
-
-
-    /// @dev create a new bundle for the provided parameters
-    /// staking fees will be deducted by the pool service from the staking amount
-    /// may only be called by registered and unlocked pool components
-    function createBundle(
-        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 
-        returns(NftId bundleNftId); // the nft id of the newly created bundle
-
-
-    /// @dev closes the specified bundle
-    /// only open bundles (active or locked) may be closed
-    /// to close a bundle it may not have any non-closed polices attached to it
-    /// bundle fees and remaining capital (after deduction of the performance fee) will be transferred to the bundle owner
-    /// may only be called by registered and unlocked pool components
-    function closeBundle(NftId bundleNftId) external;
-
-    /// @dev processes the sale of a bundle and track the pool fee and bundle fee amounts
-    function processSale(NftId bundleNftId, IPolicy.Premium memory premium, Amount actualAmountTransferred) external;
-
-    /// @dev increase stakes for bundle
-    /// staking fees will be deducted by the pool service from the staking amount
-    /// may only be called by registered and unlocked pool components
-    // function stake(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
-
-
-    /// @dev decrease stakes for bundle
-    /// performance fees will be deducted by the pool service from the staking amount
-    /// may only be called by registered and unlocked pool components
-    // function unstake(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
-}

package/contracts/instance/service/IProductService.sol

@@ -1,40 +0,0 @@
-// 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";
-
-interface IProductService is IService {
-    
-    function register(address productAddress) external returns(NftId);
-
-    function setFees(
-        Fee memory productFee,
-        Fee memory processingFee
-    ) external;
-
-    function createRisk(
-        RiskId riskId,
-        bytes memory data
-    ) external;
-
-
-    function updateRisk(
-        RiskId riskId,
-        bytes memory data
-    ) external;
-
-
-    function updateRiskState(
-        RiskId riskId,
-        StateId newState
-    ) external;
-}

package/contracts/instance/service/PolicyService.sol

@@ -1,372 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {Product} from "../../components/Product.sol";
-import {IComponents} from "../module/IComponents.sol";
-import {IDistributionComponent} from "../../components/IDistributionComponent.sol";
-import {IInstance} from "../IInstance.sol";
-import {IPolicy} from "../module/IPolicy.sol";
-import {IPoolComponent} from "../../components/IPoolComponent.sol";
-import {IRisk} from "../module/IRisk.sol";
-import {IBundle} from "../module/IBundle.sol";
-import {ISetup} from "../module/ISetup.sol";
-
-import {TokenHandler} from "../../shared/TokenHandler.sol";
-
-import {Amount, AmountLib} from "../../types/Amount.sol";
-import {ClaimId, ClaimIdLib} from "../../types/ClaimId.sol";
-import {Timestamp, TimestampLib, zeroTimestamp} from "../../types/Timestamp.sol";
-import {UFixed, UFixedLib} from "../../types/UFixed.sol";
-import {ObjectType, APPLICATION, DISTRIBUTION, PRODUCT, POOL, POLICY, BUNDLE, CLAIM} from "../../types/ObjectType.sol";
-import {APPLIED, COLLATERALIZED, ACTIVE, KEEP_STATE, CLOSED, DECLINED, CONFIRMED} from "../../types/StateId.sol";
-import {NftId, NftIdLib} from "../../types/NftId.sol";
-import {PayoutId, PayoutIdLib} from "../../types/PayoutId.sol";
-import {StateId} from "../../types/StateId.sol";
-import {VersionPart} from "../../types/Version.sol";
-
-import {ComponentService} from "../base/ComponentService.sol";
-import {IApplicationService} from "./IApplicationService.sol";
-import {IBundleService} from "./IBundleService.sol";
-import {IClaimService} from "./IClaimService.sol";
-import {IDistributionService} from "./IDistributionService.sol";
-import {InstanceReader} from "../InstanceReader.sol";
-import {IPolicyService} from "./IPolicyService.sol";
-import {IPoolService} from "./IPoolService.sol";
-import {IService} from "../../shared/IService.sol";
-import {Service} from "../../shared/Service.sol";
-
-
-contract PolicyService is
-    ComponentService, 
-    IPolicyService
-{
-    using NftIdLib for NftId;
-    using TimestampLib for Timestamp;
-
-    IApplicationService internal _applicationService;
-    IBundleService internal _bundleService;
-    IClaimService internal _claimService;
-    IDistributionService internal _distributionService;
-    IPoolService internal _poolService;
-
-    event LogProductServiceSender(address sender);
-
-    function _initialize(
-        address owner, 
-        bytes memory data
-    )
-        internal
-        virtual override
-        initializer
-    {
-        address registryAddress;
-        address initialOwner;
-        (registryAddress, initialOwner) = abi.decode(data, (address, address));
-
-        initializeService(registryAddress, address(0), owner);
-
-        VersionPart majorVersion = getVersion().toMajorPart();
-        _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), majorVersion));
-        _bundleService = IBundleService(getRegistry().getServiceAddress(BUNDLE(), majorVersion));
-        _claimService = IClaimService(getRegistry().getServiceAddress(CLAIM(), majorVersion));
-        _applicationService = IApplicationService(getRegistry().getServiceAddress(APPLICATION(), majorVersion));
-        _distributionService = IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), majorVersion));
-
-        registerInterface(type(IPolicyService).interfaceId);
-    }
-
-
-    function getDomain() public pure override returns(ObjectType) {
-        return POLICY();
-    }
-
-
-    function _getAndVerifyInstanceAndProduct() internal view returns (Product product) {
-        IRegistry.ObjectInfo memory productInfo;
-        (, productInfo,) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        product = Product(productInfo.objectAddress);
-    }
-
-
-    function decline(
-        NftId policyNftId
-    )
-        external
-        override
-    {
-        revert();
-    }
-
-
-    /// @dev underwites application which includes the locking of the required collateral from the pool.
-    function collateralize(
-        NftId applicationNftId, // = policyNftId
-        bool requirePremiumPayment,
-        Timestamp activateAt
-    )
-        external 
-        virtual override
-    {
-        // check caller is registered product
-        (NftId productNftId,, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        InstanceReader instanceReader = instance.getInstanceReader();
-
-        // check policy matches with calling product
-        IPolicy.PolicyInfo memory applicationInfo = instanceReader.getPolicyInfo(applicationNftId);
-        
-        if (applicationInfo.productNftId != productNftId) {
-            revert ErrorPolicyServiceProductMismatch(applicationNftId, applicationInfo.productNftId, productNftId);
-        }
-
-        // check policy is in state applied
-        if (instanceReader.getPolicyState(applicationNftId) != APPLIED()) {
-            revert ErrorPolicyServicePolicyStateNotApplied(applicationNftId);
-        }
-        
-        StateId newPolicyState = COLLATERALIZED();
-
-        // optional activation of policy
-        if(activateAt > zeroTimestamp()) {
-            newPolicyState = ACTIVE();
-            applicationInfo.activatedAt = activateAt;
-            applicationInfo.expiredAt = activateAt.addSeconds(applicationInfo.lifetime);
-        }
-
-        // lock bundle collateral
-        Amount netPremiumAmount = AmountLib.zero(); // > 0 if immediate premium payment 
-
-        // optional collection of premium
-        if(requirePremiumPayment) {
-            netPremiumAmount = _processPremiumByTreasury(
-                instance, 
-                applicationNftId, 
-                applicationInfo.premiumAmount);
-
-            applicationInfo.premiumPaidAmount = applicationInfo.premiumPaidAmount + applicationInfo.premiumAmount;
-        }
-
-        // store updated policy info
-        instance.updatePolicy(applicationNftId, applicationInfo, newPolicyState);
-
-        // lock collateral and update pool and bundle book keeping
-        // pool 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
-        // might also call pool component (for isVerifyingApplications pools)
-        _poolService.lockCollateral(
-            instance,
-            productNftId,
-            applicationNftId, 
-            applicationInfo,
-            netPremiumAmount); // for pool book keeping (fee + additional capital)
-
-        // TODO: add logging
-    }
-
-
-    function calculateRequiredCollateral(
-        UFixed collateralizationLevel, 
-        Amount sumInsuredAmount
-    )
-        public 
-        pure 
-        virtual 
-        returns(Amount collateralAmount)
-    {
-        UFixed collateralUFixed =  collateralizationLevel * sumInsuredAmount.toUFixed();
-        return AmountLib.toAmount(collateralUFixed.toInt());
-    } 
-
-    function collectPremium(
-        NftId policyNftId, 
-        Timestamp activateAt
-    )
-        external 
-        virtual
-    {
-        // check caller is registered product
-        (NftId productNftId,, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
-
-        if (policyInfo.premiumPaidAmount == policyInfo.premiumAmount) {
-            revert ErrorPolicyServicePremiumAlreadyPaid(policyNftId, policyInfo.premiumPaidAmount);
-        }
-
-        Amount unpaidPremiumAmount = policyInfo.premiumAmount - policyInfo.premiumPaidAmount;
-
-        Amount netPremiumAmount = _processPremiumByTreasury(
-                instance, 
-                policyNftId, 
-                unpaidPremiumAmount);
-
-        policyInfo.premiumPaidAmount = policyInfo.premiumPaidAmount + unpaidPremiumAmount;
-
-        _bundleService.increaseBalance(instance, policyInfo.bundleNftId, netPremiumAmount);
-        instance.updatePolicy(policyNftId, policyInfo, KEEP_STATE());
-
-        if(activateAt.gtz() && policyInfo.activatedAt.eqz()) {
-            activate(policyNftId, activateAt);
-        }
-
-        // TODO: add logging
-    }
-
-    function activate(NftId policyNftId, Timestamp activateAt) public override {
-        // check caller is registered product
-        (,, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        InstanceReader instanceReader = instance.getInstanceReader();
-
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
-
-        require(
-            policyInfo.activatedAt.eqz(),
-            "ERROR:PRS-020:ALREADY_ACTIVATED");
-
-        policyInfo.activatedAt = activateAt;
-        policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
-
-        instance.updatePolicy(policyNftId, policyInfo, ACTIVE());
-
-        // TODO: add logging
-    }
-
-
-    function expire(
-        NftId policyNftId
-    )
-        external
-        override
-        // solhint-disable-next-line no-empty-blocks
-    {
-        
-    }
-
-    function close(
-        NftId policyNftId
-    )
-        external 
-        override
-    {
-        (,, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        InstanceReader instanceReader = instance.getInstanceReader();
-
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
-
-        if (policyInfo.activatedAt.eqz()) {
-            revert ErrorIPolicyServicePolicyNotActivated(policyNftId);
-        }
-
-        StateId state = instanceReader.getPolicyState(policyNftId);
-        if (state != ACTIVE()) {
-            revert ErrorIPolicyServicePolicyNotActive(policyNftId, state);
-        }
-
-        if (policyInfo.closedAt.gtz()) {
-            revert ErrorIPolicyServicePolicyAlreadyClosed(policyNftId);
-        }
-
-        // 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);
-        }
-
-        if (policyInfo.openClaimsCount > 0) {
-            revert ErrorIPolicyServiceOpenClaims(policyNftId, policyInfo.openClaimsCount);
-        }
-
-        policyInfo.closedAt = TimestampLib.blockTimestamp();
-
-        _poolService.releaseCollateral(
-            instance, 
-            policyNftId, 
-            policyInfo);
-
-        instance.updatePolicy(policyNftId, policyInfo, CLOSED());
-    }
-
-
-    function _processPremiumByTreasury(
-        IInstance instance,
-        NftId policyNftId,
-        Amount premiumExpectedAmount
-    )
-        internal
-        returns (Amount netPremiumAmount)
-    {
-        // process token transfer(s)
-        if(premiumExpectedAmount.eqz()) {
-            return AmountLib.zero();
-        }
-
-        NftId productNftId = getRegistry().getObjectInfo(policyNftId).parentNftId;
-        IPolicy.PolicyInfo memory policyInfo = instance.getInstanceReader().getPolicyInfo(policyNftId);
-        IPolicy.Premium memory premium = _applicationService.calculatePremium(
-            productNftId,
-            policyInfo.riskId,
-            policyInfo.sumInsuredAmount,
-            policyInfo.lifetime,
-            policyInfo.applicationData,
-            policyInfo.bundleNftId,
-            policyInfo.referralId
-            );
-
-        if (premium.premiumAmount != premiumExpectedAmount.toInt()) {
-            revert ErrorPolicyServicePremiumMismatch(
-                policyNftId, 
-                premiumExpectedAmount, 
-                AmountLib.toAmount(premium.premiumAmount));
-        }
-
-        address policyOwner = getRegistry().ownerOf(policyNftId);
-        ISetup.ProductSetupInfo memory productSetupInfo = instance.getInstanceReader().getProductSetupInfo(productNftId);
-        TokenHandler tokenHandler = productSetupInfo.tokenHandler;
-        if (tokenHandler.getToken().allowance(policyOwner, address(tokenHandler)) < premium.premiumAmount) {
-            revert ErrorIPolicyServiceInsufficientAllowance(policyOwner, address(tokenHandler), premium.premiumAmount);
-        }
-
-        Amount productFeeAmountToTransfer = AmountLib.toAmount(premium.productFeeFixAmount + premium.productFeeVarAmount);
-        Amount distributionFeeAmountToTransfer = AmountLib.toAmount(premium.distributionFeeFixAmount + premium.distributionFeeVarAmount - premium.discountAmount);
-        uint256 poolFeeAmountToTransfer = premium.poolFeeFixAmount + premium.poolFeeVarAmount;
-        uint256 bundleFeeAmountToTransfer = premium.bundleFeeFixAmount + premium.bundleFeeVarAmount;
-        Amount poolAmountToTransfer = AmountLib.toAmount(premium.netPremiumAmount + poolFeeAmountToTransfer + bundleFeeAmountToTransfer);
-
-        netPremiumAmount = AmountLib.toAmount(premium.netPremiumAmount);
-
-        // move product fee to product wallet
-        {
-            address productWallet = productSetupInfo.wallet;
-            tokenHandler.transfer(policyOwner, productWallet, productFeeAmountToTransfer);
-        }
-
-        // move distribution fee to distribution wallet
-        {
-            ISetup.DistributionSetupInfo memory distributionSetupInfo = instance.getInstanceReader().getDistributionSetupInfo(productSetupInfo.distributionNftId);
-            address distributionWallet = distributionSetupInfo.wallet;
-            tokenHandler.transfer(policyOwner, distributionWallet, distributionFeeAmountToTransfer);
-            _distributionService.processSale(productSetupInfo.distributionNftId, policyInfo.referralId, premium, distributionFeeAmountToTransfer);
-        }
-        
-        // move netpremium, bundleFee and poolFee to pool wallet
-        {
-            address poolWallet = instance.getInstanceReader().getComponentInfo(productSetupInfo.poolNftId).wallet;
-            tokenHandler.transfer(policyOwner, poolWallet, poolAmountToTransfer);
-            _poolService.processSale(policyInfo.bundleNftId, premium, poolAmountToTransfer);
-        }
-
-        // validate total amount transferred
-        {
-            Amount totalTransferred = distributionFeeAmountToTransfer + poolAmountToTransfer + productFeeAmountToTransfer;
-
-            if (premium.premiumAmount != totalTransferred.toInt()) {
-                revert ErrorPolicyServiceTransferredPremiumMismatch(
-                    policyNftId, 
-                    AmountLib.toAmount(premium.premiumAmount), 
-                    totalTransferred);
-            }
-        }
-
-        // TODO: add logging
-    }
-}

package/contracts/instance/service/PolicyServiceManager.sol

@@ -1,54 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {ProxyManager} from "../../shared/ProxyManager.sol";
-import {PolicyService} from "./PolicyService.sol";
-import {Registry} from "../../registry/Registry.sol";
-import {RegistryService} from "../../registry/RegistryService.sol";
-import {VersionLib} from "../../types/Version.sol";
-
-contract PolicyServiceManager is ProxyManager {
-
-    PolicyService private _policyService;
-
-    /// @dev initializes proxy manager with product service implementation 
-    constructor(
-        address registryAddress
-    )
-        ProxyManager(registryAddress)
-    {
-        PolicyService svc = new PolicyService();
-        bytes memory data = abi.encode(registryAddress, address(this));
-        IVersionable versionable = deploy(
-            address(svc), 
-            data);
-
-        _policyService = PolicyService(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
-        //registryService.registerService(_productService);
-        
-        // TODO no nft to link yet
-        // link ownership of instance service manager ot nft owner of instance service
-        //_linkToNftOwnable(
-        //    address(registryAddress),
-        //    address(_productService));
-
-        // implies that after this constructor call only upgrade functionality is available
-        // _isDeployed = true;
-    }
-
-    //--- view functions ----------------------------------------------------//
-    function getPolicyService()
-        external
-        view
-        returns (PolicyService policyService)
-    {
-        return _policyService;
-    }
-
-}