@etherisc/gif-next 0.0.2-3087fdd-816 → 0.0.2-30a4eae-489

package/contracts/instance/service/DistributionService.sol

@@ -1,277 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {InstanceAccessManager} from "../InstanceAccessManager.sol";
-import {InstanceReader} from "../../instance/InstanceReader.sol";
-import {ISetup} from "../../instance/module/ISetup.sol";
-
-import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
-import {Fee} from "../../types/Fee.sol";
-import {DISTRIBUTION_OWNER_ROLE} from "../../types/RoleId.sol";
-import {KEEP_STATE} from "../../types/StateId.sol";
-import {ObjectType, DISTRIBUTION, INSTANCE, DISTRIBUTION, DISTRIBUTOR} from "../../types/ObjectType.sol";
-import {Version, VersionLib} from "../../types/Version.sol";
-
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {Versionable} from "../../shared/Versionable.sol";
-
-import {IService} from "../../shared/IService.sol";
-import {Service} from "../../shared/Service.sol";
-import {ComponentService} from "../base/ComponentService.sol";
-import {InstanceService} from "../InstanceService.sol";
-import {IComponent} from "../../components/IComponent.sol";
-import {IDistributionComponent} from "../../components/IDistributionComponent.sol";
-import {IDistributionService} from "./IDistributionService.sol";
-
-import {UFixed} from "../../types/UFixed.sol";
-import {DistributorType, DistributorTypeLib} from "../../types/DistributorType.sol";
-import {ReferralId, ReferralStatus, ReferralLib} from "../../types/Referral.sol";
-import {Timestamp, TimestampLib, zeroTimestamp} from "../../types/Timestamp.sol";
-import {Key32} from "../../types/Key32.sol";
-import {IDistribution} from "../module/IDistribution.sol";
-
-
-contract DistributionService is
-    ComponentService,
-    IDistributionService
-{
-    using NftIdLib for NftId;
-
-    address internal _registryAddress;
-    
-    function _initialize(
-        address owner, 
-        bytes memory data
-    )
-        internal
-        initializer
-        virtual override
-    {
-        address initialOwner;
-        address registryAddress;
-        (registryAddress, initialOwner) = abi.decode(data, (address, address));
-        // TODO while DistributionService is not deployed in DistributionServiceManager constructor
-        //      owner is DistributionServiceManager deployer
-        initializeService(registryAddress, owner);
-        registerInterface(type(IDistributionService).interfaceId);
-    }
-
-    function getDomain() public pure override(Service, IService) returns(ObjectType) {
-        return DISTRIBUTION();
-    }
-
-    function register(address distributionAddress) 
-        external
-        returns(NftId distributionNftId)
-    {
-        (
-            IComponent component,
-            address owner,
-            IInstance instance,
-            NftId instanceNftId
-        ) = _checkComponentForRegistration(
-            distributionAddress,
-            DISTRIBUTION(),
-            DISTRIBUTION_OWNER_ROLE());
-
-        IRegistry.ObjectInfo memory distributionInfo = getRegistryService().registerDistribution(component, owner);
-        IDistributionComponent distribution = IDistributionComponent(distributionAddress);
-        distribution.linkToRegisteredNftId();
-        distributionNftId = distributionInfo.nftId;
-
-        instance.createDistributionSetup(distributionNftId, distribution.getSetupInfo());
-        getInstanceService().createGifTarget(instanceNftId, distributionAddress, distribution.getName());
-        getInstanceService().grantDistributionDefaultPermissions(instanceNftId, distributionAddress, distribution.getName());
-    }
-
-    function setFees(
-        Fee memory distributionFee
-    )
-        external
-        override
-    {
-        (IRegistry.ObjectInfo memory info , IInstance instance) = _getAndVerifyComponentInfoAndInstance(DISTRIBUTION());
-        InstanceReader instanceReader = instance.getInstanceReader();
-        NftId distributionNftId = info.nftId;
-
-        ISetup.DistributionSetupInfo memory distSetupInfo = instanceReader.getDistributionSetupInfo(distributionNftId);
-        distSetupInfo.distributionFee = distributionFee;
-        
-        instance.updateDistributionSetup(distributionNftId, distSetupInfo, KEEP_STATE());
-    }
-
-    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)
-    {
-        (,NftId distributionNftId, IInstance instance) = _getAndVerifyCallingDistribution();
-        distributorType = DistributorTypeLib.toDistributorType(distributionNftId, name);
-        Key32 key32 = distributorType.toKey32();
-
-        if(!instance.exists(key32)) {
-            IDistribution.DistributorTypeInfo memory info = IDistribution.DistributorTypeInfo(
-                name,
-                minDiscountPercentage,
-                maxDiscountPercentage,
-                commissionPercentage,
-                maxReferralCount,
-                maxReferralLifetime,
-                allowSelfReferrals,
-                allowRenewals,
-                data);
-
-            instance.createDistributorType(key32, info);
-        }
-    }
-
-    function createDistributor(
-        address distributor,
-        DistributorType distributorType,
-        bytes memory data
-    ) external returns (NftId distributorNftId)
-    {
-        (, NftId distributionNftId, IInstance instance) = _getAndVerifyCallingDistribution();
-
-        distributorNftId = getRegistryService().registerDistributor(
-            IRegistry.ObjectInfo(
-                zeroNftId(), 
-                distributionNftId,
-                DISTRIBUTOR(),
-                true, // intercepting property for bundles is defined on pool
-                address(0),
-                distributor,
-                ""
-            ));
-
-        IDistribution.DistributorInfo memory info = IDistribution.DistributorInfo(
-            distributorType,
-            true, // active
-            data);
-
-        instance.createDistributor(distributorNftId, info);
-    }
-
-    function updateDistributorType(
-        NftId distributorNftId,
-        DistributorType distributorType,
-        bytes memory data
-    ) external virtual
-    {
-        (,, IInstance instance) = _getAndVerifyCallingDistribution();
-
-        IDistribution.DistributorInfo memory info = IDistribution.DistributorInfo(
-            distributorType,
-            true, // active
-            data);
-
-        instance.updateDistributor(distributorNftId, info, KEEP_STATE());
-    }
-
-
-    function createReferral(
-        NftId distributorNftId,
-        string memory code,
-        UFixed discountPercentage,
-        uint32 maxReferrals,
-        Timestamp expiryAt,
-        bytes memory data
-    )
-        external
-        virtual
-        returns (ReferralId referralId)
-    {
-        (,NftId distributionNftId, IInstance instance) = _getAndVerifyCallingDistribution();
-        require(bytes(code).length > 0, "ERROR:DSV-030:CODE_INVALID");
-        require(expiryAt > zeroTimestamp(), "ERROR:DSV-031:EXPIRY_AT_ZERO");
-
-        referralId = ReferralLib.toReferralId(distributionNftId, code);
-        IDistribution.ReferralInfo memory info = IDistribution.ReferralInfo(
-            distributorNftId,
-            code,
-            discountPercentage,
-            maxReferrals,
-            0, // used referrals
-            expiryAt,
-            data
-        );
-
-        instance.createReferral(referralId.toKey32(), info);
-        return referralId;
-    }
-
-    function processSale(
-        ReferralId referralId,
-        uint256 premiumAmount
-    )
-        external
-        virtual
-    {
-        revert("NOT_IMPLEMENTED_YET");
-    }
-
-    function calculateFeeAmount(
-        ReferralId referralId,
-        uint256 premiumAmount
-    )
-        external
-        virtual
-        view 
-        returns (uint256 feeAmount)
-    {
-        revert("NOT_IMPLEMENTED_YET");
-    }
-
-    function _getAndVerifyCallingDistribution()
-        internal
-        view
-        returns(
-            address distributionAddress,
-            NftId distributionNftId,
-            IInstance instance
-        )
-    {
-        ObjectType objectType;
-        (
-            distributionAddress,
-            distributionNftId,
-            objectType,
-            instance
-        ) = _getAndVerifyCaller();
-
-        require(objectType == DISTRIBUTION(), "ERROR:PRS-031:CALLER_NOT_DISTRUBUTION");
-    }
-
-    function _getAndVerifyCaller()
-        internal
-        view
-        returns(
-            address objectAddress,
-            NftId objectNftId,
-            ObjectType objectType,
-            IInstance instance
-        )
-    {
-        objectAddress = msg.sender;
-        objectNftId = getRegistry().getNftId(objectAddress);
-        require(objectNftId.gtz(), "ERROR:SRV-030:CALLER_UNKNOWN");
-        IRegistry.ObjectInfo memory info = getRegistry().getObjectInfo(objectNftId);
-        objectType = info.objectType;
-
-        IRegistry.ObjectInfo memory parentInfo = getRegistry().getObjectInfo(info.parentNftId);
-        require(parentInfo.objectType == INSTANCE(), "ERROR:SRV-031:PARENT_NOT_INSTANCE");
-        instance = IInstance(parentInfo.objectAddress);
-    }
-
-}

package/contracts/instance/service/DistributionServiceManager.sol

@@ -1,51 +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 {DistributionService} from "./DistributionService.sol";
-import {Registry} from "../../registry/Registry.sol";
-import {RegistryService} from "../../registry/RegistryService.sol";
-import {REGISTRY} from "../../types/ObjectType.sol";
-
-contract DistributionServiceManager is ProxyManager {
-
-    DistributionService private _distributionService;
-
-    /// @dev initializes proxy manager with distribution service implementation and deploys instance
-    constructor(
-        address registryAddress
-    )
-        ProxyManager(registryAddress)
-    {
-        DistributionService distSrv = new DistributionService();
-        bytes memory data = abi.encode(registryAddress, address(this));
-        IVersionable versionable = deploy(
-            address(distSrv), 
-            data);
-
-        _distributionService = DistributionService(address(versionable));
-        
-        // TODO `thi` must have a role or own nft to register service
-        //Registry registry = Registry(registryAddress);
-        //address registryServiceAddress = registry.getServiceAddress(REGISTRY(), _distributionService.getMajorVersion());
-        //RegistryService registryService = RegistryService(registryServiceAddress);
-        //registryService.registerService(_distributionService);
-        
-        // TODO no nft to link yet
-        // link ownership of instance service manager ot nft owner of instance service
-        //_linkToNftOwnable(
-        //    address(registryAddress),
-        //    address(_distributionService));
-    }
-
-    //--- view functions ----------------------------------------------------//
-    function getDistributionService()
-        external
-        view
-        returns (DistributionService distributionService)
-    {
-        return _distributionService;
-    }
-
-}

package/contracts/instance/service/IBundleService.sol

@@ -1,54 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {NftId} from "../../types/NftId.sol";
-import {Fee} from "../../types/Fee.sol";
-import {StateId} from "../../types/StateId.sol";
-import {IService} from "../../shared/IService.sol";
-import {IBundle} from "../module/IBundle.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-
-interface IBundleService is IService {
-    error ErrorIBundleServiceInsufficientAllowance(address bundleOwner, address tokenHandlerAddress, uint256 amount);
-
-    function createBundle(
-        address owner,
-        Fee memory fee, 
-        uint256 amount,
-        uint256 lifetime, 
-        bytes calldata filter
-    ) external returns(NftId bundleNftId);
-
-    function setBundleFee(
-        NftId bundleNftId,
-        Fee memory fee
-    ) external;
-
-    function updateBundle(NftId instanceNftId, NftId bundleNftId, IBundle.BundleInfo memory bundleInfo, StateId state) 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;
-
-    function closePolicy(IInstance instance, NftId policyNftId, NftId bundleNftId, uint256 collateralAmount) external;
-
-    // function fundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
-
-    // function defundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
-
-    function lockBundle(NftId bundleNftId) external;
-
-    function unlockBundle(NftId bundleNftId) external;
-
-    // function closeBundle(NftId bundleNftId) external;
-}

package/contracts/instance/service/IClaimService.sol

@@ -1,61 +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 {ClaimId} from "../../types/ClaimId.sol";
-import {PayoutId} from "../../types/PayoutId.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 claims and payouts
-/// only product components may call transaction functions
-interface IClaimService is
-    IService
-{
-
-    /// @dev create a new claim for the specified policy
-    /// function can only be called by product, policy needs to match with calling product
-    function createClaim(
-        NftId policyNftId, 
-        uint256 claimAmount,
-        bytes memory claimData
-    ) external returns (ClaimId);
-
-    /// @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 confirmClaim(NftId policyNftId, ClaimId claimId, uint256 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 declineClaim(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 closeClaim(NftId policyNftId, ClaimId claimId) external; 
-
-    /// @dev create a new payout for the specified policy and claim
-    /// function can only be called by product, policy needs to match with calling product
-    function createPayout(
-        NftId policyNftId, 
-        ClaimId claimId,
-        uint256 payoutAmount,
-        bytes calldata payoutData
-    ) external returns (PayoutId payoutId);
-
-    /// @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 payoutExecuted(
-        NftId policyNftId, 
-        PayoutId payoutId
-    ) external;
-
-}

package/contracts/instance/service/IDistributionService.sol

@@ -1,65 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-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

@@ -1,89 +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 IPolicyService is IService {
-    
-    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);
-
-    /// @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}
-    /// 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 underwrite an application
-    function underwrite(
-        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 calculates the total premium amount for the specified attributes
-    /// also returns the various fees included in the total premium amount
-    function calculatePremium(
-        RiskId riskId,
-        uint256 sumInsuredAmount,
-        uint256 lifetime,
-        bytes memory applicationData,
-        NftId bundleNftId,
-        ReferralId referralId
-    )
-        external
-        view
-        returns (
-            uint256 premiumAmount,
-            uint256 productFeeAmount,
-            uint256 poolFeeAmount,
-            uint256 bundleFeeAmount,
-            uint256 distributionFeeAmount
-        );
-
-    // TODO move function to pool service
-    function calculateRequiredCollateral(
-        UFixed collateralizationLevel, 
-        uint256 sumInsuredAmount
-    ) external pure returns(uint256 collateralAmount);
-
-}

package/contracts/instance/service/IPoolService.sol

@@ -1,20 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {NftId} from "../../types/NftId.sol";
-import {Fee} from "../../types/Fee.sol";
-import {StateId} from "../../types/StateId.sol";
-import {IService} from "../../shared/IService.sol";
-import {IBundle} from "../module/IBundle.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-
-interface IPoolService is IService {
-
-    function register(address poolAddress) external returns(NftId);
-
-    function setFees(
-        Fee memory poolFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external;
-}

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