@etherisc/gif-next 0.0.2-aaa8646-641 → 0.0.2-aac44b0-298

package/contracts/instance/service/IBundleService.sol

@@ -1,102 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Amount} from "../../types/Amount.sol";
-import {NftId} from "../../types/NftId.sol";
-import {Fee} from "../../types/Fee.sol";
-import {IService} from "../../shared/IService.sol";
-import {IBundle} from "../module/IBundle.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {Seconds} from "../../types/Seconds.sol";
-import {StateId} from "../../types/StateId.sol";
-import {Timestamp} from "../../types/Timestamp.sol";
-
-interface IBundleService is IService {
-
-    event LogBundleServiceBundleActivated(NftId bundleNftId);
-    event LogBundleServiceBundleLocked(NftId bundleNftId);
-
-    error ErrorBundleServiceInsufficientAllowance(address bundleOwner, address tokenHandlerAddress, uint256 amount);
-    error ErrorBundleServiceBundleNotOpen(NftId bundleNftId, StateId state, Timestamp expiredAt);
-    error ErrorBundleServiceCapacityInsufficient(NftId bundleNftId, uint capacityAmount, uint collateralAmount);
-    error ErrorBundleServiceBundleWithOpenPolicies(NftId bundleNftId, uint256 openPoliciesCount);
-
-    error ErrorBundleServiceBundleUnknown(NftId bundleNftId);
-    error ErrorBundleServiceBundlePoolMismatch(NftId bundleNftId, NftId expectedPool, NftId actualPool);
-
-    /// @dev create a new bundle for the specified attributes
-    /// may only be called by pool service
-    function create(
-        IInstance instance, // instance relevant for bundle
-        NftId poolNftId, // the pool the bundle will be linked to
-        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 locks the specified bundle, locked bundles are not available to collateralize new policies
-    /// only active bundles may be locked
-    /// may only be called by registered and unlocked pool components
-    function lock(NftId bundleNftId) external;
-
-    /// @dev activates the specified bundle
-    /// only locked bundles may be unlocked
-    /// may only be called by registered and unlocked pool components
-    function unlock(NftId bundleNftId) external;
-
-    /// @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
-    /// may only be called by registered and unlocked pool components
-    function close(
-        IInstance instance, 
-        NftId bundleNftId
-    ) external;
-
-    /// @dev set bundle fee to provided value
-    /// may only be called by registered and unlocked pool components
-    function setFee(
-        NftId bundleNftId,
-        Fee memory fee
-    ) external;
-
-
-    /// @dev locks the specified collateral in the bundle
-    /// the locked collateral is added to the bundle locked capital
-    /// the bundles' fees are updated with the fees for this premium
-    /// the premium (minus bundle fee) is added to the bundle capital
-    /// may only be called by pool service
-    function lockCollateral(
-        IInstance instanceNftId, 
-        NftId policyNftId, 
-        NftId bundleNftId, 
-        uint256 collateralAmount, 
-        uint256 premium // premium amount after pool fee
-    ) external;
-
-    /// @dev updates the bundle's fees of with the provided fee amount
-    function updateBundleFees(
-        IInstance instance,
-        NftId bundleNftId,
-        Amount feeAmount
-    ) external;
-
-    /// @dev releases the specified collateral in the bundle
-    /// may only be called by pool service
-    function releaseCollateral(
-        IInstance instance, 
-        NftId policyNftId, 
-        NftId bundleNftId, 
-        uint256 collateralAmount
-    ) external;
-
-    function increaseBalance(IInstance instance, NftId bundleNftId,  uint256 amount) external;
-
-    // function stake(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
-
-    // function unstake(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
-}

package/contracts/instance/service/IClaimService.sol

@@ -1,92 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IInstance} from "../IInstance.sol";
-import {InstanceReader} from "../InstanceReader.sol";
-import {IService} from "../../shared/IService.sol";
-
-import {Amount} from "../../types/Amount.sol";
-import {ClaimId} from "../../types/ClaimId.sol";
-import {PayoutId} from "../../types/PayoutId.sol";
-import {NftId} from "../../types/NftId.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 claims and payouts
-/// only product components may call transaction functions
-interface IClaimService is
-    IService
-{
-
-    error ErrorClaimServiceClaimWithOpenPayouts(NftId policyNftId, ClaimId claimId, uint8 openPayouts);
-    error ErrorClaimServiceClaimWithMissingPayouts(NftId policyNftId, ClaimId claimId, Amount claimAmount, Amount paidAmount);
-    error ErrorClaimServiceClaimNotInExpectedState(NftId policyNftId, ClaimId claimId, StateId expectedState, StateId actualState);
-
-    /// @dev create a new claim for the specified policy
-    /// function can only be called by product, policy needs to match with calling product
-    function submit(
-        IInstance instance,
-        NftId policyNftId, 
-        ClaimId claimId,
-        Amount claimAmount,
-        bytes memory claimData
-    ) external;
-
-    /// @dev confirms the specified claim and fixes the final claim amount
-    /// function can only be called by product, policy needs to match with calling product
-    function confirm(
-        IInstance instance,
-        InstanceReader instanceReader,
-        NftId policyNftId, 
-        ClaimId claimId, 
-        Amount claimAmount
-    ) external;
-
-    /// @dev declares the claim as invalid, no payout(s) will be made
-    /// function can only be called by product, policy needs to match with calling product
-    function decline(
-        IInstance instance,
-        InstanceReader instanceReader,
-        NftId policyNftId, 
-        ClaimId claimId
-    ) external;
-
-    /// @dev closes the claim
-    /// a claim may only be closed once all existing payouts have been executed and the sum of the paid out amounts has reached the claim amount
-    /// function can only be called by product, policy needs to match with calling product
-    function close(
-        IInstance instance,
-        InstanceReader instanceReader,
-        NftId policyNftId, 
-        ClaimId claimId
-    ) external; 
-
-    /// @dev create a new payout for the specified policy
-    /// payoutId may be constructed using PayoutIdLib(claimId, payoutNo)
-    /// function can only be called by product, policy needs to match with calling product
-    function createPayout(
-        IInstance instance,
-        NftId policyNftId, 
-        PayoutId payoutId,
-        Amount payoutAmount,
-        bytes calldata payoutData
-    ) external; 
-
-    /// @dev callback function to confirm transfer of payout token to beneficiary
-    /// allows claim service to update claims/payout book keeping
-    /// only pool service can confirm executed payout
-    function processPayout(
-        IInstance instance,
-        InstanceReader instanceReader,
-        NftId policyNftId, 
-        PayoutId payoutId
-    )
-        external 
-        returns (
-            Amount amount,
-            bool payoutIsClosingClaim
-        );
-
-}

package/contracts/instance/service/IPolicyService.sol

@@ -1,142 +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 {Amount} from "../../types/Amount.sol";
-import {ClaimId} from "../../types/ClaimId.sol";
-import {Amount} from "../../types/Amount.sol";
-import {ClaimId} from "../../types/ClaimId.sol";
-import {NftId} from "../../types/NftId.sol";
-import {PayoutId} from "../../types/PayoutId.sol";
-import {PayoutId} from "../../types/PayoutId.sol";
-import {ReferralId} from "../../types/Referral.sol";
-import {RiskId} from "../../types/RiskId.sol";
-import {Seconds} from "../../types/Seconds.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 IPolicyService is IService {
-
-    event LogPolicyServiceClaimSubmitted(NftId policyNftId, ClaimId claimId, Amount claimAmount);
-    event LogPolicyServiceClaimConfirmed(NftId policyNftId, ClaimId claimId, Amount confirmedAmount);
-    event LogPolicyServiceClaimDeclined(NftId policyNftId, ClaimId claimId);
-    event LogPolicyServiceClaimClosed(NftId policyNftId, ClaimId claimId);
-
-    event LogPolicyServicePayoutCreated(NftId policyNftId, PayoutId payoutId, Amount amount);
-    event LogPolicyServicePayoutProcessed(NftId policyNftId, PayoutId payoutId, Amount amount);
-
-    error ErrorPolicyServicePolicyProductMismatch(NftId policyNftId, NftId expectedProduct, NftId actualProduct);
-    error ErrorPolicyServicePolicyNotOpen(NftId policyNftId);
-    error ErrorPolicyServiceClaimExceedsSumInsured(NftId policyNftId, Amount sumInsured, Amount payoutsIncludingClaimAmount);
-    error ErrorPolicyServicePolicyStateNotApplied(NftId applicationNftId);
-
-    error ErrorIPolicyServiceInsufficientAllowance(address customer, address tokenHandlerAddress, uint256 amount);
-    error ErrorIPolicyServicePremiumAlreadyPaid(NftId policyNftId, uint256 premiumPaidAmount);
-    error ErrorIPolicyServicePolicyNotActivated(NftId policyNftId);
-    error ErrorIPolicyServicePolicyAlreadyClosed(NftId policyNftId);
-    error ErrorIPolicyServicePolicyNotActive(NftId policyNftId, StateId state);
-    error ErrorIPolicyServicePremiumNotFullyPaid(NftId policyNftId, uint256 premiumAmount, uint256 premiumPaidAmount);
-    error ErrorIPolicyServiceOpenClaims(NftId policyNftId, uint16 openClaimsCount);
-    error ErrorIPolicyServicePolicyHasNotExpired(NftId policyNftId, Timestamp expiredAt);
-
-    error ErrorIPolicyServicePremiumMismatch(NftId policyNftId, uint256 expectedPremiumAmount, uint256 recalculatedPremiumAmount);
-    error ErrorPolicyServiceTransferredPremiumMismatch(NftId policyNftId, uint256 expectedPremiumAmount, uint256 transferredPremiumAmount);
-
-    /// @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 collateralizes the policy represented by {policyNftId}
-    /// sets the policy state to underwritten
-    /// may set the policy state to activated and set the activation date
-    /// 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 collateralize an application
-    function collateralize(
-        NftId policyNftId,
-        bool requirePremiumPayment,
-        Timestamp activateAt
-    ) external;
-
-    /// @dev collects the premium token for the specified policy
-    function collectPremium(NftId policyNftId, Timestamp activateAt) external;
-
-    /// @dev activates the specified policy and sets the activation date in the policy metadata
-    /// to activate a policy it needs to be in underwritten state
-    function activate(NftId policyNftId, Timestamp activateAt) external;
-
-    /// @dev expires the specified policy and sets the expiry date in the policy metadata
-    /// to expire a policy it must be in active state, policies may be expired even when the predefined expiry date is still in the future
-    /// a policy can only be closed when it has been expired. in addition, it must not have any open claims
-    /// this function can only be called by a product. the policy needs to match with the calling product
-    function expire(NftId policyNftId) external;
-
-    /// @dev closes the specified policy and sets the closed data in the policy metadata
-    /// a policy can only be closed when it has been expired. in addition, it must not have any open claims
-    /// this function can only be called by a product. the policy needs to match with the calling product
-    function close(NftId policyNftId) external;
-
-    /// @dev create a new claim for the specified policy
-    /// returns the id of the newly created claim
-    /// function can only be called by product, policy needs to match with calling product
-    function submitClaim(
-        NftId policyNftId, 
-        Amount claimAmount,
-        bytes memory claimData
-    ) external returns (ClaimId claimId);
-
-    /// @dev declines the specified claim
-    /// function can only be called by product, policy needs to match with calling product
-    function declineClaim(
-        NftId policyNftId, 
-        ClaimId claimId) external;
-
-    /// @dev confirms the specified claim and specifies the payout amount
-    /// function can only be called by product, policy needs to match with calling product
-    function confirmClaim(
-        NftId policyNftId, 
-        ClaimId claimId,
-        Amount confirmedAmount
-    ) external;
-
-    /// @dev closes the specified claim
-    /// function can only be called by product, policy needs to match with calling product
-    function closeClaim(
-        NftId policyNftId, 
-        ClaimId claimId
-    ) external;
-
-    /// @dev creates a new payout for the specified claim
-    /// returns the id of the newly created payout, this id is unique for the specified policy
-    /// function can only be called by product, policy needs to match with calling product
-    function createPayout(
-        NftId policyNftId, 
-        ClaimId claimId,
-        Amount amount,
-        bytes memory data
-    )
-        external
-        returns (PayoutId payoutId);
-
-    /// @dev processes the specified payout
-    /// this includes moving the payout token to the beneficiary (default: policy holder)
-    /// function can only be called by product, policy needs to match with calling product
-    function processPayout(
-        NftId policyNftId, 
-        PayoutId payoutId
-    ) external;
-
-    // TODO move function to pool service
-    function calculateRequiredCollateral(
-        UFixed collateralizationLevel, 
-        uint256 sumInsuredAmount
-    ) external pure returns(uint256 collateralAmount);
-
-}

package/contracts/instance/service/IPoolService.sol

@@ -1,102 +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 {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, uint256 previousMaxCapitalAmount, uint256 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(uint256 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,
-        uint256 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 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, uint256 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/IPricingService.sol

@@ -1,36 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Seconds} from "../../types/Seconds.sol";
-import {NftId} from "../../types/NftId.sol";
-import {ReferralId} from "../../types/Referral.sol";
-import {RiskId} from "../../types/RiskId.sol";
-
-import {IService} from "./IApplicationService.sol";
-import {IPolicy} from "../module/IPolicy.sol";
-
-interface IPricingService is IService
-{
-    error ErrorIPricingServiceBundlePoolMismatch(NftId bundleNftId, NftId bundlePoolNftId, NftId poolNftId);
-    error ErrorIPricingServiceFeeCalculationMismatch(
-                uint256 distributionFeeFixAmount,
-                uint256 distributionFeeVarAmount,
-                uint256 distributionOwnerFeeFixAmount,
-                uint256 distributionOwnerFeeVarAmount,
-                uint256 commissionAmount,
-                uint256 discountAmount
-            );
-
-    function calculatePremium(
-        NftId productNftId,
-        RiskId riskId,
-        uint256 sumInsuredAmount,
-        Seconds lifetime,
-        bytes memory applicationData,
-        NftId bundleNftId,
-        ReferralId referralId
-    )
-        external
-        view
-        returns (IPolicy.Premium memory premium);
-}

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;
-}