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

package/contracts/components/IDistributionComponent.sol

@@ -1,71 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Fee} from "../types/Fee.sol";
-import {IComponent} from "./IComponent.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
-import {ReferralId, ReferralStatus} from "../types/Referral.sol";
-import {NftId} from "../types/NftId.sol";
-import {DistributorType} from "../types/DistributorType.sol";
-import {UFixed} from "../types/UFixed.sol";
-import {Timestamp} from "../types/Timestamp.sol";
-
-interface IDistributionComponent is IComponent {
-
-    event LogDistributorUpdated(address to, address caller);
-
-    function getSetupInfo() external view returns (ISetup.DistributionSetupInfo memory setupInfo);
-
-    function setFees(
-        Fee memory minDistributionOwnerFee,
-        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 calculateRenewalFeeAmount(
-        ReferralId referralId,
-        uint256 netPremiumAmount
-    ) external view returns (uint256 feeAmount);
-
-    /// @dev callback from product service when a policy is renews for a specific referralId
-    function processRenewal(
-        ReferralId referralId,
-        uint256 feeAmount
-    ) external;
-
-    function getDiscountPercentage(
-        string memory referralCode
-    ) external view returns (UFixed discountPercentage, ReferralStatus status);
-
-    function getDistributionFee() external view returns (Fee memory distibutionFee);
-
-    function getReferralId(
-        string memory referralCode
-    ) external returns (ReferralId referralId);
-
-    /// @dev returns true iff the component needs to be called when selling/renewing policis
-    function isVerifying() external view returns (bool verifying);
-}

package/contracts/components/IPoolComponent.sol

@@ -1,114 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Amount} from "../types/Amount.sol";
-import {Fee} from "../types/Fee.sol";
-import {IComponent} from "./IComponent.sol";
-import {IComponents} from "../instance/module/IComponents.sol";
-import {NftId} from "../types/NftId.sol";
-import {RoleId} from "../types/RoleId.sol";
-import {Seconds} from "../types/Seconds.sol";
-import {UFixed} from "../types/UFixed.sol";
-
-/// @dev pool components hold and manage the collateral to cover active policies
-/// pools come in different flavors
-interface IPoolComponent is IComponent {
-
-    error ErrorPoolNotBundleOwner(NftId bundleNftId, address caller);
-    error ErrorPoolNotPoolService(address caller);
-
-    error ErrorPoolApplicationBundleMismatch(NftId applicationNftId);
-
-    event LogPoolVerifiedByPool(address pool, NftId applicationNftId, Amount collateralizationAmount);
-
-    /// @dev increases the staked tokens by the specified amount
-    /// only the bundle owner may stake tokens
-    /// bundle MUST be in active or locked state
-    function stake(NftId bundleNftId, Amount amount) external;
-
-    /// @dev decreases the staked tokens by the specified amount
-    /// only the bundle owner may unstake tokens from the bundle
-    /// bundle MUST be in active, locked or closed state
-    function unstake(NftId bundleNftId, Amount amount) external;
-
-    /// @dev extends the bundle lifetime of the bundle by the specified time
-    /// only the bundle owner may extend the bundle's lifetime
-    /// bundle MUST be in active or locked state
-    function extend(NftId bundleNftId, Seconds lifetimeExtension) external;
-
-    /// @dev locks the specified bundle
-    /// a bundle to be locked MUST be in active state
-    /// locked bundles may not be used to collateralize any new policy
-    function lockBundle(NftId bundleNftId) external;
-
-    /// @dev unlocks the specified bundle
-    /// a bundle to be unlocked MUST be in locked state
-    function unlockBundle(NftId bundleNftId) external;
-
-    /// @dev close the specified bundle
-    /// a bundle to be closed MUST be in active or locked state
-    /// to close a bundle all all linked policies MUST be in closed state as well
-    /// closing a bundle finalizes the bundle bookkeeping including overall profit calculation
-    /// once a bundle is closed this action cannot be reversed
-    function close(NftId bundleNftId) external;
-
-    /// @dev sets the fee for the specified bundle
-    /// the fee is added on top of the poolFee and deducted from the premium amounts
-    /// via these fees individual bundler owner may earn income per policy in the context of peer to peer pools
-    function setBundleFee(
-        NftId bundleNftId, 
-        Fee memory fee
-    ) external;
-
-    /// @dev sets the maximum overall capital amound held by this pool
-    /// function may only be called by pool owner
-    function setMaxCapitalAmount(Amount maxCapitalAmount) external;
-
-    /// @dev sets the required role to create/own bundles
-    /// may only be called once after setting up a pool
-    /// may only be called by pool owner 
-    function setBundleOwnerRole(RoleId bundleOwnerRole) external;
-
-    /// @dev update pool fees to the specified values
-    /// pool fees: are deducted from the premium amount and goes to the pool owner
-    /// staking fees: are deducted from the staked tokens by a bundle owner and goes to the pool owner
-    /// performance fees: when a bundle is closed a bundle specific profit is calculated
-    /// the performance fee is deducted from this profit and goes to the pool owner
-    function setFees(
-        Fee memory poolFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external;
-
-    /// @dev this is a callback function that is called by the product service when underwriting a policy.
-    /// the pool has the option to check the details and object to underwriting by reverting.
-    /// the function is only called for "active" pools that ask to be involved/notified
-    /// by product related state changes.
-    function verifyApplication(
-        NftId applicationNftId, 
-        bytes memory applicationData,
-        NftId bundleNftId, 
-        bytes memory bundleFilter,
-        Amount collateralizationAmount
-    ) external;
-
-    /// @dev returns true iff the application matches with the bundle 
-    /// this is a callback function that is only called if a pool declares itself as a verifying pool
-    /// default implementation returns true
-    function applicationMatchesBundle(
-        NftId applicationNftId, 
-        bytes memory applicationData,
-        NftId bundleNftId, 
-        bytes memory bundleFilter,
-        Amount collateralizationAmount
-    )
-        external
-        view
-        returns (bool isMatching);
-
-    /// @dev returns pool specific infos for this pool
-    /// when registered with an instance the info is obtained from the data stored in the instance
-    /// when not registered the function returns the info from the component contract
-    function getPoolInfo() external view returns (IComponents.PoolInfo memory info);
-
-}

package/contracts/components/IProductComponent.sol

@@ -1,41 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Amount} from "../types/Amount.sol";
-import {Fee} from "../types/Fee.sol";
-import {IComponent} from "./IComponent.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
-import {NftId} from "../types/NftId.sol";
-import {ReferralId} from "../types/Referral.sol";
-import {RiskId} from "../types/RiskId.sol";
-import {Seconds} from "../types/Seconds.sol";
-
-interface IProductComponent is IComponent {
-
-    function getSetupInfo() external view returns (ISetup.ProductSetupInfo memory setupInfo);
-
-    function setFees(
-        Fee memory productFee,
-        Fee memory processingFee
-    ) external;
-
-    function calculatePremium(
-        Amount sumInsuredAmount,
-        RiskId riskId,
-        Seconds lifetime,
-        bytes memory applicationData,
-        NftId bundleNftId,
-        ReferralId referralId
-    ) external view returns (Amount premiumAmount);
-
-    function calculateNetPremium(
-        Amount sumInsuredAmount,
-        RiskId riskId,
-        Seconds lifetime,
-        bytes memory applicationData
-    ) external view returns (Amount netPremiumAmount);    
-
-    
-    function getPoolNftId() external view returns (NftId poolNftId);
-    function getDistributionNftId() external view returns (NftId distributionNftId);
-}

package/contracts/components/Pool.sol

@@ -1,302 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Amount, AmountLib} from "../types/Amount.sol";
-import {Component} from "./Component.sol";
-import {Fee, FeeLib} from "../types/Fee.sol";
-import {IBundleService} from "../instance/service/IBundleService.sol";
-import {IPoolComponent} from "./IPoolComponent.sol";
-import {IPoolService} from "../instance/service/IPoolService.sol";
-import {IComponents} from "../instance/module/IComponents.sol";
-import {NftId, NftIdLib} from "../types/NftId.sol";
-import {BUNDLE, POOL} from "../types/ObjectType.sol";
-import {RoleId, PUBLIC_ROLE} from "../types/RoleId.sol";
-import {Seconds} from "../types/Seconds.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
-import {UFixed, UFixedLib} from "../types/UFixed.sol";
-
-abstract contract Pool is
-    Component, 
-    IPoolComponent 
-{
-    // keccak256(abi.encode(uint256(keccak256("etherisc.storage.Pool")) - 1)) & ~bytes32(uint256(0xff));
-    bytes32 public constant POOL_STORAGE_LOCATION_V1 = 0x25e3e51823fbfffb988e0a2744bb93722d9f3e906c07cc0a9e77884c46c58300;
-
-    struct PoolStorage {
-        IPoolService _poolService;
-        IBundleService _bundleService;
-    }
-
-
-    modifier onlyBundleOwner(NftId bundleNftId) {
-        if(msg.sender != getRegistry().ownerOf(bundleNftId)) {
-            revert ErrorPoolNotBundleOwner(bundleNftId, msg.sender);
-        }
-        _;
-    }
-
-
-    modifier onlyPoolService() {
-        if(msg.sender != address(_getPoolStorage()._poolService)) {
-            revert ErrorPoolNotPoolService(msg.sender);
-        }
-        _;
-    }
-
-
-    function initializePool(
-        address registry,
-        NftId instanceNftId,
-        string memory name,
-        address token,
-        bool isInterceptingNftTransfers,
-        address initialOwner,
-        bytes memory registryData // writeonly data that will saved in the object info record of the registry
-    )
-        public
-        virtual
-        onlyInitializing()
-    {
-        initializeComponent(registry, instanceNftId, name, token, POOL(), isInterceptingNftTransfers, initialOwner, registryData);
-
-        PoolStorage storage $ = _getPoolStorage();
-        $._poolService = IPoolService(_getServiceAddress(POOL())); 
-        $._bundleService = IBundleService(_getServiceAddress(BUNDLE()));
-
-        registerInterface(type(IPoolComponent).interfaceId);
-    }
-
-
-    function stake(
-        NftId bundleNftId, 
-        Amount amount
-    )
-        public
-        virtual
-        restricted()
-        onlyBundleOwner(bundleNftId)
-    {
-        // TODO add implementation
-    }
-
-
-    function unstake(
-        NftId bundleNftId, 
-        Amount amount
-    )
-        public
-        virtual
-        restricted()
-        onlyBundleOwner(bundleNftId)
-    {
-        // TODO add implementation
-    }
-
-
-    function extend(
-        NftId bundleNftId, 
-        Seconds lifetimeExtension
-    )
-        public
-        virtual
-        restricted()
-        onlyBundleOwner(bundleNftId)
-    {
-        // TODO add implementation
-    }
-
-
-    function lockBundle(NftId bundleNftId)
-        public
-        virtual
-        //restricted() // TODO consider adding this back
-        onlyBundleOwner(bundleNftId)
-    {
-        _getPoolStorage()._bundleService.lock(bundleNftId);
-    }
-
-
-    function unlockBundle(NftId bundleNftId)
-        public
-        virtual
-        //restricted()
-        onlyBundleOwner(bundleNftId)
-    {
-        _getPoolStorage()._bundleService.unlock(bundleNftId);
-    }
-
-
-    function close(NftId bundleNftId)
-        public
-        virtual
-        //restricted()
-        onlyBundleOwner(bundleNftId)
-    {
-        _getPoolStorage()._poolService.closeBundle(bundleNftId);
-    }
-
-
-    function setBundleFee(
-        NftId bundleNftId, 
-        Fee memory fee
-    )
-        public
-        virtual
-        restricted()
-        onlyBundleOwner(bundleNftId)
-    {
-        _getPoolStorage()._bundleService.setFee(bundleNftId, fee);
-    }
-
-
-    function setMaxCapitalAmount(Amount maxCapitalAmount)
-        public
-        virtual
-        restricted()
-        onlyOwner()
-    {
-        _getPoolStorage()._poolService.setMaxCapitalAmount(maxCapitalAmount);
-    }
-
-
-    function setBundleOwnerRole(RoleId bundleOwnerRole)
-        public
-        virtual
-        restricted()
-        onlyOwner()
-    {
-        _getPoolStorage()._poolService.setBundleOwnerRole(bundleOwnerRole);
-    }
-
-
-    function setFees(
-        Fee memory poolFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    )
-        public
-        virtual
-        restricted()
-        onlyOwner()
-    {
-        _getPoolStorage()._poolService.setFees(poolFee, stakingFee, performanceFee);
-    }
-
-
-    /// @dev see {IPool.verifyApplication}
-    function verifyApplication(
-        NftId applicationNftId, 
-        bytes memory applicationData,
-        NftId bundleNftId, 
-        bytes memory bundleFilter,
-        Amount collateralizationAmount
-    )
-        public
-        virtual
-        restricted()
-    {
-        if(!applicationMatchesBundle(
-            applicationNftId,
-            applicationData, 
-            bundleNftId, 
-            bundleFilter,
-            collateralizationAmount)
-        )
-        {
-            revert ErrorPoolApplicationBundleMismatch(applicationNftId);
-        }
-
-        emit LogPoolVerifiedByPool(address(this), applicationNftId, collateralizationAmount);
-    }
-
-
-    /// @dev see {IPoolComponent.applicationMatchesBundle}
-    /// Override this function to implement any custom application verification 
-    /// Default implementation always returns true
-    function applicationMatchesBundle(
-        NftId applicationNftId, 
-        bytes memory applicationData,
-        NftId bundleNftId, 
-        bytes memory bundleFilter,
-        Amount collateralizationAmount
-    )
-        public
-        view
-        virtual override
-        returns (bool isMatching)
-    {
-        return true;
-    }
-
-
-    function getPoolInfo() external view returns (IComponents.PoolInfo memory poolInfo) {
-        poolInfo = abi.decode(getComponentInfo().data, (IComponents.PoolInfo));
-    }
-
-    // Internals
-
-    function _createBundle(
-        address bundleOwner,
-        Fee memory fee,
-        Amount amount,
-        Seconds lifetime, 
-        bytes memory filter
-    )
-        internal
-        returns(NftId bundleNftId)
-    {
-        bundleNftId = _getPoolStorage()._poolService.createBundle(
-            bundleOwner,
-            fee,
-            amount,
-            lifetime,
-            filter);
-
-        // TODO add logging
-    }
-
-    // TODO remove function once this is no longer used to produce contract locations on the fly ...
-    function getContractLocation(bytes memory name) external pure returns (bytes32 hash) {
-        return keccak256(abi.encode(uint256(keccak256(name)) - 1)) & ~bytes32(uint256(0xff));
-    }
-
-    /// @dev defines initial pool specification
-    /// overwrite this function according to your use case
-    function _getInitialInfo()
-        internal
-        view 
-        virtual override
-        returns (IComponents.ComponentInfo memory info)
-    {
-        return IComponents.ComponentInfo(
-            getName(),
-            getToken(),
-            TokenHandler(address(0)), // will be created by GIF service during registration
-            address(this), // contract is its own wallet
-            AmountLib.zero(), // balance amount
-            AmountLib.zero(), // fee amount
-            abi.encode(
-                IComponents.PoolInfo(
-                    NftIdLib.zero(), // will be set when GIF registers the related product
-                    PUBLIC_ROLE(), // bundleOwnerRole
-                    AmountLib.max(), // maxCapitalAmount,
-                    AmountLib.zero(), // initial balance amount
-                    AmountLib.zero(), // initial fee amount
-                    isNftInterceptor(), // isInterceptingBundleTransfers
-                    false, // isExternallyManaged,
-                    false, // isVerifyingApplications,
-                    UFixedLib.toUFixed(1), // collateralizationLevel,
-                    UFixedLib.toUFixed(1), // retentionLevel,
-                    FeeLib.zeroFee(), // initialPoolFee,
-                    FeeLib.zeroFee(), // initialStakingFee,
-                    FeeLib.zeroFee() // initialPerformanceFee,
-                )));
-    }
-
-
-    function _getPoolStorage() private pure returns (PoolStorage storage $) {
-        assembly {
-            $.slot := POOL_STORAGE_LOCATION_V1
-        }
-    }
-}