@etherisc/gif-next 0.0.2-d5522f6-712 → 0.0.2-d57a2ff-383

package/contracts/components/Distribution.sol

@@ -1,164 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {DISTRIBUTION} from "../types/ObjectType.sol";
-import {IDistributionService} from "../instance/service/IDistributionService.sol";
-import {IProductService} from "../instance/service/IProductService.sol";
-import {NftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
-import {ReferralId} from "../types/Referral.sol";
-import {Fee, FeeLib} from "../types/Fee.sol";
-import {BaseComponent} from "./BaseComponent.sol";
-import {IDistributionComponent} from "./IDistributionComponent.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {IRegisterable} from "../shared/IRegisterable.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
-import {Registerable} from "../shared/Registerable.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
-
-abstract contract Distribution is
-    BaseComponent,
-    IDistributionComponent
-{
-    using NftIdLib for NftId;
-
-    Fee internal _initialDistributionFee;
-    bool internal _isVerifying;
-
-    TokenHandler internal _tokenHandler;
-
-    IDistributionService private _distributionService;
-    IProductService private _productService;
-
-    modifier onlyProductService() {
-        require(
-            msg.sender == address(_productService), 
-            "ERROR:POL-002:NOT_PRODUCT_SERVICE");
-        _;
-    }
-
-    constructor(
-        address registry,
-        NftId instanceNftId,
-        // TODO refactor into tokenNftId
-        address token,
-        bool verifying,
-        Fee memory distributionFee,
-        address initialOwner
-    )
-        BaseComponent(registry, instanceNftId, token, DISTRIBUTION(), true, initialOwner)
-    {
-        _isVerifying = verifying;
-        _initialDistributionFee = distributionFee;
-
-        _tokenHandler = TokenHandler(token);
-
-        _distributionService = _instance.getDistributionService();
-        _productService = _instance.getProductService();
-
-        _registerInterface(type(IDistributionComponent).interfaceId);
-    }
-
-
-    function setFees(
-        Fee memory distributionFee
-    )
-        external
-        override
-    {
-        _distributionService.setFees(distributionFee);
-    }
-
-    function calculateFeeAmount(
-        ReferralId referralId,
-        uint256 netPremiumAmount
-    )
-        external
-        view
-        virtual override
-        returns (uint256 feeAmount)
-    {
-        ISetup.DistributionSetupInfo memory setupInfo = getSetupInfo();
-        Fee memory fee = setupInfo.distributionFee;
-        (feeAmount,) = FeeLib.calculateFee(fee, netPremiumAmount);
-    }
-
-
-    function calculateRenewalFeeAmount(
-        ReferralId referralId,
-        uint256 netPremiumAmount
-    )
-        external
-        view
-        virtual override
-        returns (uint256 feeAmount)
-    {
-        // default is no fees
-        return 0 * netPremiumAmount;
-    }
-
-    function processSale(
-        ReferralId referralId,
-        uint256 feeAmount
-    )
-        external
-        onlyProductService
-        virtual override
-    {
-        // default is no action
-    }
-
-    function processRenewal(
-        ReferralId referralId,
-        uint256 feeAmount
-    )
-        external
-        onlyProductService
-        virtual override
-    {
-        // default is no action
-    }
-
-    function referralIsValid(ReferralId referralId) external view returns (bool isValid) {
-        // default is invalid
-        return false;
-    }
-
-    function getSetupInfo() public view returns (ISetup.DistributionSetupInfo memory setupInfo) {
-        InstanceReader reader = _instance.getInstanceReader();
-        return reader.getDistributionSetupInfo(getNftId());
-    }
-    
-
-    /// @dev returns true iff the component needs to be called when selling/renewing policis
-    function isVerifying() external view returns (bool verifying) {
-        return _isVerifying;
-    }
-
-    // from IRegisterable
-
-    function getInitialInfo() 
-        public 
-        view
-        override (IRegisterable, Registerable)
-        returns(IRegistry.ObjectInfo memory, bytes memory)
-    {
-        (
-            IRegistry.ObjectInfo memory info, 
-        ) = super.getInitialInfo();
-
-        return (
-            info,
-            abi.encode(
-                getName(),
-                ISetup.DistributionSetupInfo(
-                    _productNftId,
-                    _tokenHandler,
-                    _initialDistributionFee,
-                    _isVerifying,
-                    address(this)
-                )
-            )
-        );
-    }
-}

package/contracts/components/IBaseComponent.sol

@@ -1,34 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
-import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IInstance} from "../instance/IInstance.sol";
-import {NftId} from "../types/NftId.sol";
-
-interface IBaseComponent is IRegisterable {
-    error ErrorBaseComponentWalletAddressIsSameAsCurrent(address newWallet);
-    error ErrorBaseComponentWalletAllowanceTooSmall(address oldWallet, address newWallet, uint256 allowance, uint256 balance);
-    error ErrorBaseComponentUnauthorized(address caller, uint64 requiredRoleIdNum);
-
-    event LogBaseComponentWalletAddressChanged(address newWallet);
-    event LogBaseComponentWalletTokensTransferred(address from, address to, uint256 amount);
-
-    function getName() external pure virtual returns (string memory name);
-
-    function lock() external;
-
-    function unlock() external;
-
-    function getToken() external view returns (IERC20Metadata token);
-
-    function setWallet(address walletAddress) external;
-    function getWallet() external view returns (address walletAddress);
-
-    function getInstance() external view returns (IInstance instance);
-
-    function setProductNftId(NftId productNftId) external;
-    function getProductNftId() external view returns (NftId productNftId);
-
-}

package/contracts/components/IDistributionComponent.sol

@@ -1,44 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Fee} from "../types/Fee.sol";
-import {ReferralId} from "../types/Referral.sol";
-import {NftId} from "../types/NftId.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
-
-interface IDistributionComponent {
-
-    function setFees(
-        Fee memory distributionFee
-    ) external;
-
-    function calculateFeeAmount(
-        ReferralId referralId,
-        uint256 netPremiumAmount
-    ) external view returns (uint256 feeAmount);
-
-    function calculateRenewalFeeAmount(
-        ReferralId referralId,
-        uint256 netPremiumAmount
-    ) external view returns (uint256 feeAmount);
-
-    /// @dev callback from product service when selling a policy for a specific referralId
-    /// the used referral id and the collected fee are provided as parameters
-    /// the component implementation can then process this information accordingly
-    function processSale(
-        ReferralId referralId,
-        uint256 feeAmount
-    ) external;
-
-    /// @dev callback from product service when a policy is renews for a specific referralId
-    function processRenewal(
-        ReferralId referralId,
-        uint256 feeAmount
-    ) external;
-
-    /// @dev returns true iff the referral id is valid
-    function referralIsValid(ReferralId referralId) external view returns (bool isValid);
-
-    /// @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,66 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {NftId} from "../types/NftId.sol";
-import {Fee} from "../types/Fee.sol";
-import {UFixed} from "../types/UFixed.sol";
-
-interface IPoolComponent {
-
-    event LogUnderwrittenByPool(NftId policyNftId, uint256 collateralizationAmount, address pool);
-
-    function setFees(
-        Fee memory poolFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external;
-
-    /**
-     * @dev creates a new bundle for this pool.
-     */
-    function createBundle(
-        Fee memory fee,
-        uint256 initialAmount,
-        uint256 lifetime,
-        bytes memory filter
-    ) external returns(NftId bundleNftId);
-
-    function setBundleFee(
-        NftId policyNftId, 
-        Fee memory fee
-    ) 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 underwrite(
-        NftId policyNftId, 
-        bytes memory policyData,
-        bytes memory bundleFilter,
-        uint256 collateralizationAmount
-    ) external;
-
-    function lockBundle(NftId bundleNftId) external;
-
-    function unlockBundle(NftId bundleNftId) external;
-
-    /**
-     * @dev returns true iff the policy application data in policyData matches
-     * with the bundle filter criteria encoded in bundleFilter. 
-     */
-    function policyMatchesBundle(
-        bytes memory policyData,
-        bytes memory bundleFilter
-    )
-        external
-        view
-        returns (bool isMatching);
-
-    function isConfirmingApplication() external view returns (bool isConfirmingApplication);
-
-    function getCollateralizationLevel() external view returns (UFixed collateralizationLevel);
-
-}

package/contracts/components/IProductComponent.sol

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

package/contracts/components/Pool.sol

@@ -1,272 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {ObjectType, POOL} from "../types/ObjectType.sol";
-import {IProductService} from "../instance/service/IProductService.sol";
-import {IPoolService} from "../instance/service/IPoolService.sol";
-import {IBundleService} from "../instance/service/IBundleService.sol";
-import {NftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
-import {Fee} from "../types/Fee.sol";
-import {UFixed} from "../types/UFixed.sol";
-import {IPoolComponent} from "./IPoolComponent.sol";
-import {BaseComponent} from "./BaseComponent.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
-
-import {IRegistry} from "../registry/IRegistry.sol";
-
-// import {IPool} from "../instance/module/pool/IPoolModule.sol";
-import {ITreasury} from "../instance/module/ITreasury.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
-
-import {IRegisterable} from "../shared/IRegisterable.sol";
-import {Registerable} from "../shared/Registerable.sol";
-
-abstract contract Pool is BaseComponent, IPoolComponent {
-    using NftIdLib for NftId;
-
-    bool internal _isConfirmingApplication;
-    UFixed internal _collateralizationLevel;
-
-    Fee internal _initialPoolFee;
-    Fee internal _initialStakingFee;
-    Fee internal _initialPerformanceFee;
-
-    TokenHandler internal _tokenHandler;
-
-    // may be used to interact with instance by derived contracts
-    IPoolService internal _poolService;
-
-    // only relevant to protect callback functions for "active" pools
-    IProductService private _productService;
-
-    IBundleService private _bundleService;
-
-    modifier onlyPoolService() {
-        require(
-            msg.sender == address(_poolService), 
-            "ERROR:POL-001:NOT_POOL_SERVICE");
-        _;
-    }
-
-    modifier onlyProductService() {
-        require(
-            msg.sender == address(_productService), 
-            "ERROR:POL-002:NOT_PRODUCT_SERVICE");
-        _;
-    }
-
-    constructor(
-        address registry,
-        NftId instanceNftId,
-        // TODO refactor into tokenNftId
-        address token,
-        bool isInterceptor,
-        bool isConfirmingApplication,
-        UFixed collateralizationLevel,
-        Fee memory poolFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee,
-        address initialOwner
-    )
-        BaseComponent(registry, instanceNftId, token, POOL(), isInterceptor, initialOwner)
-    {
-        _isConfirmingApplication = isConfirmingApplication;
-        // TODO add validation
-        _collateralizationLevel = collateralizationLevel;
-        _initialPoolFee = poolFee;
-        _initialStakingFee = stakingFee;
-        _initialPerformanceFee = performanceFee;
-
-        _tokenHandler = new TokenHandler(token);
-
-        _poolService = _instance.getPoolService();
-        _productService = _instance.getProductService();
-        _bundleService = _instance.getBundleService();
-
-        _registerInterface(type(IPoolComponent).interfaceId);
-    }
-
-    function createBundle(
-        Fee memory fee,
-        uint256 initialAmount,
-        uint256 lifetime,
-        bytes memory filter
-    )
-        external
-        virtual override
-        returns(NftId bundleNftId)
-    {
-        address owner = msg.sender;
-        bundleNftId = _bundleService.createBundle(
-            owner,
-            fee,
-            initialAmount,
-            lifetime,
-            filter
-        );
-
-        // TODO add logging
-    }
-
-    /**
-     * @dev see {IPool.underwrite}. 
-     * Default implementation that only writes a {LogUnderwrittenByPool} entry.
-     */
-    function underwrite(
-        NftId policyNftId, 
-        bytes memory policyData,
-        bytes memory bundleFilter,
-        uint256 collateralizationAmount
-    )
-        external
-        onlyProductService
-        virtual override 
-    {
-        _underwrite(policyNftId, policyData, bundleFilter, collateralizationAmount);
-    }
-
-    /**
-     * @dev see {IPoolComponent.policyMatchesBundle}. 
-     * Default implementation always returns true
-     */
-    function policyMatchesBundle(
-        bytes memory, // policyData
-        bytes memory // bundleFilter
-    )
-        public
-        view
-        virtual override
-        returns (bool isMatching)
-    {
-        return true;
-    }
-
-
-    function isConfirmingApplication() external view override returns (bool isConfirmingApplication) {
-        return _isConfirmingApplication;
-    }
-
-    function getCollateralizationLevel() external view override returns (UFixed collateralizationLevel) {
-        return _collateralizationLevel;
-    }
-
-    function setFees(
-        Fee memory poolFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    )
-        external
-        onlyOwner
-        override
-    {
-        _poolService.setFees(poolFee, stakingFee, performanceFee);
-    }
-
-    function setBundleFee(
-        NftId bundleNftId, 
-        Fee memory fee
-    )
-        external
-        override
-        // TODO add onlyBundleOwner
-    {
-        _bundleService.setBundleFee(bundleNftId, fee);
-    }
-
-    function lockBundle(
-        NftId bundleNftId
-    )
-        external
-        override
-        // TODO add onlyBundleOwner
-    {
-        _bundleService.lockBundle(bundleNftId);
-    }
-
-    function unlockBundle(
-        NftId bundleNftId
-    )
-        external
-        override
-        // TODO add onlyBundleOwner
-    {
-        _bundleService.unlockBundle(bundleNftId);
-    }
-
-    function getSetupInfo() public view returns (ISetup.PoolSetupInfo memory setupInfo) {
-        InstanceReader reader = _instance.getInstanceReader();
-        return reader.getPoolSetupInfo(getNftId());
-    }
-
-    // from IRegisterable
-
-    // TODO used only once, occupies space
-    // TODO do not use super
-    function getInitialInfo() 
-        public
-        view
-        override (IRegisterable, Registerable)
-        returns (IRegistry.ObjectInfo memory, bytes memory)
-    {
-        (
-            IRegistry.ObjectInfo memory info, 
-        ) = super.getInitialInfo();
-
-        return (
-            info,
-            abi.encode(
-                getName(),
-                ISetup.PoolSetupInfo(
-                    _productNftId,
-                    _tokenHandler,
-                    _collateralizationLevel,
-                    _initialPoolFee,
-                    _initialStakingFee,
-                    _initialPerformanceFee,
-                    false,
-                    _isConfirmingApplication,
-                    _wallet
-                )
-            )
-        );
-    }
-
-    // Internals
-
-    function _underwrite(
-        NftId policyNftId, 
-        bytes memory policyData,
-        bytes memory bundleFilter,
-        uint256 collateralizationAmount
-    )
-        internal 
-    {
-        require(
-            policyMatchesBundle(policyData, bundleFilter),
-            "ERROR:POL-020:POLICY_BUNDLE_MISMATCH"
-        );
-
-        emit LogUnderwrittenByPool(policyNftId, collateralizationAmount, address(this));
-    }
-
-    function _createBundle(
-        address bundleOwner,
-        Fee memory fee,
-        uint256 amount,
-        uint256 lifetime, 
-        bytes calldata filter
-    )
-        internal
-        returns(NftId bundleNftId)
-    {
-        bundleNftId = _bundleService.createBundle(
-            bundleOwner,
-            fee,
-            amount,
-            lifetime,
-            filter
-        );
-    }
-}