@etherisc/gif-next 0.0.2-299fe4a-464 → 0.0.2-2b0ce11-013

package/contracts/components/BaseComponent.sol

@@ -1,40 +1,46 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
-import {IRegisterable} from "../shared/IRegisterable.sol";
 import {Registerable} from "../shared/Registerable.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IInstance} from "../instance/IInstance.sol";
-import {IServiceLinked} from "../instance/IServiceLinked.sol";
 
 import {IInstance} from "../instance/IInstance.sol";
-import {IComponent, IComponentModule} from "../instance/module/component/IComponent.sol";
 import {IComponentOwnerService} from "../instance/service/IComponentOwnerService.sol";
 import {IBaseComponent} from "./IBaseComponent.sol";
-import {NftId} from "../types/NftId.sol";
+import {NftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
+import {ObjectType} from "../types/ObjectType.sol";
 
 abstract contract BaseComponent is
     Registerable,
     IBaseComponent
 {
+    using NftIdLib for NftId;
+
     IComponentOwnerService internal _componentOwnerService;
 
     address internal _deployer;
     address internal _wallet;
     IERC20Metadata internal _token;
     IInstance internal _instance;
+    NftId internal _productNftId;
 
     constructor(
         address registry,
         NftId instanceNftId,
-        address token
+        address token,
+        ObjectType componentType,
+        bool isInterceptor,
+        address initialOwner
     )
-        Registerable(registry, instanceNftId)
     {
-        IRegistry.ObjectInfo memory instanceInfo = _registry.getObjectInfo(instanceNftId);
+        bytes memory data = "";
+        _initializeRegisterable(registry, instanceNftId, componentType, isInterceptor, initialOwner, data);
+
+        IRegistry.ObjectInfo memory instanceInfo = getRegistry().getObjectInfo(instanceNftId);
         _instance = IInstance(instanceInfo.objectAddress);
         require(
             _instance.supportsInterface(type(IInstance).interfaceId),
@@ -44,21 +50,8 @@ abstract contract BaseComponent is
         _componentOwnerService = _instance.getComponentOwnerService();
         _wallet = address(this);
         _token = IERC20Metadata(token);
-    }
-
-    // from registerable
-    function register() public override(IRegisterable, Registerable) returns (NftId componentId) {
-        require(msg.sender == getOwner(), "");
-        require(
-            address(_registry) != address(0),
-            "ERROR:COB-001:REGISTRY_ZERO"
-        );
-        require(
-            _registry.isRegistered(address(_instance)),
-            "ERROR:COB:INSTANCE_NOT_REGISTERED"
-        );
 
-        componentId = _componentOwnerService.register(this);
+        _registerInterface(type(IBaseComponent).interfaceId);
     }
 
     // from component contract
@@ -79,11 +72,20 @@ abstract contract BaseComponent is
         return _wallet;
     }
 
-    function getToken() external view override returns (IERC20Metadata token) {
+    function getToken() public view override returns (IERC20Metadata token) {
         return _token;
     }
 
-    function getInstance() external view override returns (IInstance instance) {
+    function getInstance() public view override returns (IInstance instance) {
         return _instance;
     }
+
+    function setProductNftId(NftId productNftId) public override onlyOwner {
+        require(_productNftId.eq(zeroNftId()), "product nft id already set");
+        _productNftId = productNftId;
+    }
+
+    function getProductNftId() public view override returns (NftId productNftId) {
+        return _productNftId;
+    }
 }

package/contracts/components/Distribution.sol

@@ -0,0 +1,159 @@
+// 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";
+
+contract Distribution is
+    BaseComponent,
+    IDistributionComponent
+{
+    using NftIdLib for NftId;
+
+    Fee internal _initialDistributionFee;
+    bool internal _isVerifying;
+
+    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;
+
+        _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(
+                ISetup.DistributionSetupInfo(
+                    _productNftId,
+                    TokenHandler(address(_token)),
+                    _initialDistributionFee,
+                    _isVerifying,
+                    address(this)
+                )
+            )
+        );
+    }
+}

package/contracts/components/IBaseComponent.sol

@@ -1,12 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IInstanceLinked} from "../instance/IInstanceLinked.sol";
+import {IInstance} from "../instance/IInstance.sol";
+import {NftId} from "../types/NftId.sol";
 
-interface IBaseComponent is IRegisterable, IInstanceLinked {
+interface IBaseComponent is IRegisterable {
 
     function lock() external;
 
@@ -16,4 +17,9 @@ interface IBaseComponent is IRegisterable, IInstanceLinked {
 
     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

@@ -0,0 +1,44 @@
+// 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,24 +1,35 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {NftId} from "../types/NftId.sol";
 import {Fee} from "../types/Fee.sol";
 import {UFixed} from "../types/UFixed.sol";
-import {IBaseComponent} from "./IBaseComponent.sol";
 
-interface IPoolComponent is IBaseComponent {
+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.
@@ -48,10 +59,4 @@ interface IPoolComponent is IBaseComponent {
 
     function getCollateralizationLevel() external view returns (UFixed collateralizationLevel);
 
-    function getStakingFee() external view returns (Fee memory stakingFee);
-
-    function getPerformanceFee()
-        external
-        view
-        returns (Fee memory performanceFee);
 }

package/contracts/components/IProductComponent.sol

@@ -1,19 +1,35 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {NftId} from "../types/NftId.sol";
 import {Fee} from "../types/Fee.sol";
-import {IBaseComponent} from "./IBaseComponent.sol";
+import {NftId} from "../types/NftId.sol";
+import {ReferralId} from "../types/Referral.sol";
+import {RiskId} from "../types/RiskId.sol";
+
+interface IProductComponent {
 
-interface IProductComponent is IBaseComponent {
     function setFees(
-        Fee memory policyFee,
+        Fee memory productFee,
         Fee memory processingFee
     ) external;
 
-    function getPoolNftId() external view returns (NftId poolNftId);
-    
-    function getPolicyFee() external view returns (Fee memory policyFee);
+    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 getProcessingFee() external view returns (Fee memory processingFee);
+    
+    function getPoolNftId() external view returns (NftId poolNftId);
+    function getDistributionNftId() external view returns (NftId distributionNftId);
 }

package/contracts/components/Pool.sol

@@ -1,20 +1,37 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+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 {NftId} from "../types/NftId.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";
 
 contract Pool is BaseComponent, IPoolComponent {
+    using NftIdLib for NftId;
 
     bool internal _isVerifying;
     UFixed internal _collateralizationLevel;
 
+    Fee internal _initialPoolFee;
+    Fee internal _initialStakingFee;
+    Fee internal _initialPerformanceFee;
+
     // may be used to interact with instance by derived contracts
     IPoolService internal _poolService;
 
@@ -40,20 +57,31 @@ contract Pool is BaseComponent, IPoolComponent {
         NftId instanceNftId,
         // TODO refactor into tokenNftId
         address token,
+        bool isInterceptor,
         bool verifying,
-        UFixed collateralizationLevel
+        UFixed collateralizationLevel,
+        Fee memory poolFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee,
+        address initialOwner
     )
-        BaseComponent(registry, instanceNftId, token)
+        BaseComponent(registry, instanceNftId, token, POOL(), isInterceptor, initialOwner)
     {
         _isVerifying = verifying;
         // TODO add validation
         _collateralizationLevel = collateralizationLevel;
+        _initialPoolFee = poolFee;
+        _initialStakingFee = stakingFee;
+        _initialPerformanceFee = performanceFee;
 
         _poolService = _instance.getPoolService();
         _productService = _instance.getProductService();
+
+        _registerInterface(type(IPoolComponent).interfaceId);
     }
 
     function createBundle(
+        Fee memory fee,
         uint256 initialAmount,
         uint256 lifetime,
         bytes memory filter
@@ -65,6 +93,7 @@ contract Pool is BaseComponent, IPoolComponent {
         address owner = msg.sender;
         bundleNftId = _poolService.createBundle(
             owner,
+            fee,
             initialAmount,
             lifetime,
             filter
@@ -115,6 +144,67 @@ contract Pool is BaseComponent, IPoolComponent {
         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
+    {
+        _poolService.setBundleFee(bundleNftId, fee);
+    }
+
+    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(
+                ISetup.PoolSetupInfo(
+                    _productNftId,
+                    TokenHandler(address(_token)),
+                    _collateralizationLevel,
+                    _initialPoolFee,
+                    _initialStakingFee,
+                    _initialPerformanceFee,
+                    _isVerifying,
+                    _wallet
+                )
+            )
+        );
+    }
+
+    // Internals
+
     function _underwrite(
         NftId policyNftId, 
         bytes memory policyData,
@@ -133,6 +223,7 @@ contract Pool is BaseComponent, IPoolComponent {
 
     function _createBundle(
         address bundleOwner,
+        Fee memory fee,
         uint256 amount,
         uint256 lifetime, 
         bytes calldata filter
@@ -142,33 +233,10 @@ contract Pool is BaseComponent, IPoolComponent {
     {
         bundleNftId = _poolService.createBundle(
             bundleOwner,
+            fee,
             amount,
             lifetime,
             filter
         );
     }
-
-    // from pool component
-    function getStakingFee()
-        external
-        view
-        override
-        returns (Fee memory stakingFee)
-    {
-        return _instance.getPoolSetup(getNftId()).stakingFee;
-    }
-
-    function getPerformanceFee()
-        external
-        view
-        override
-        returns (Fee memory performanceFee)
-    {
-        return _instance.getPoolSetup(getNftId()).performanceFee;
-    }
-
-    // from registerable
-    function getType() public pure override returns (ObjectType) {
-        return POOL();
-    }
 }