@etherisc/gif-next 0.0.2-8d47fa1-080 → 0.0.2-90f8ffc-398

package/contracts/components/Distribution.sol

@@ -4,59 +4,66 @@ 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} from "../types/NftId.sol";
-import {ReferralId} from "../types/ReferralId.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 {Component} from "./Component.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,
+abstract contract Distribution is
+    Component,
     IDistributionComponent
 {
+    using NftIdLib for NftId;
 
-    Fee internal _initialDistributionFee;
     bool internal _isVerifying;
+    Fee internal _initialDistributionFee;
 
-    IDistributionService private _distributionService;
-    IProductService private _productService;
+    TokenHandler internal _tokenHandler;
 
-    modifier onlyProductService() {
-        require(
-            msg.sender == address(_productService), 
-            "ERROR:POL-002:NOT_PRODUCT_SERVICE");
-        _;
-    }
+    IDistributionService private _distributionService;
 
     constructor(
         address registry,
         NftId instanceNftId,
         // TODO refactor into tokenNftId
+        string memory name,
         address token,
         bool verifying,
         Fee memory distributionFee,
-        address initialOwner
-    )
-        BaseComponent(registry, instanceNftId, token, DISTRIBUTION(), true, initialOwner)
-    {
+        address initialOwner,
+        bytes memory data
+    ) Component (
+        registry, 
+        instanceNftId, 
+        name, token, 
+        DISTRIBUTION(), 
+        true, 
+        initialOwner, 
+        data
+    ) {
         _isVerifying = verifying;
         _initialDistributionFee = distributionFee;
 
-        _distributionService = _instance.getDistributionService();
-        _productService = _instance.getProductService();
+        _tokenHandler = new TokenHandler(token);
+        _distributionService = getInstance().getDistributionService();
 
         _registerInterface(type(IDistributionComponent).interfaceId);
     }
 
-
     function setFees(
         Fee memory distributionFee
     )
         external
         override
+        onlyOwner
+        restricted()
     {
         _distributionService.setFees(distributionFee);
     }
@@ -70,7 +77,8 @@ contract Distribution is
         virtual override
         returns (uint256 feeAmount)
     {
-        Fee memory fee = getDistributionFee();
+        ISetup.DistributionSetupInfo memory setupInfo = getSetupInfo();
+        Fee memory fee = setupInfo.distributionFee;
         (feeAmount,) = FeeLib.calculateFee(fee, netPremiumAmount);
     }
 
@@ -93,7 +101,8 @@ contract Distribution is
         uint256 feeAmount
     )
         external
-        onlyProductService
+        onlyOwner
+        restricted()
         virtual override
     {
         // default is no action
@@ -104,7 +113,8 @@ contract Distribution is
         uint256 feeAmount
     )
         external
-        onlyProductService
+        onlyOwner
+        restricted()
         virtual override
     {
         // default is no action
@@ -115,41 +125,29 @@ contract Distribution is
         return false;
     }
 
-    /// @dev default distribution fee, ie when not using any valid referralId
-    function getDistributionFee() public view returns (Fee memory distributionFee) {
-        NftId productNftId = _instance.getProductNftId(getNftId());
-        if (_instance.hasTreasuryInfo(productNftId)) {
-            return _instance.getTreasuryInfo(productNftId).distributionFee;
-        } else {
-            return _initialDistributionFee;
+    function getSetupInfo() public view returns (ISetup.DistributionSetupInfo memory setupInfo) {
+        InstanceReader reader = getInstance().getInstanceReader();
+        setupInfo = reader.getDistributionSetupInfo(getNftId());
+
+        // fallback to initial setup info (wallet is always != address(0))
+        if(setupInfo.wallet == address(0)) {
+            setupInfo = _getInitialSetupInfo();
         }
     }
 
+    function _getInitialSetupInfo() internal view returns (ISetup.DistributionSetupInfo memory setupInfo) {
+        return ISetup.DistributionSetupInfo(
+            zeroNftId(),
+            _tokenHandler,
+            _initialDistributionFee,
+            _isVerifying,
+            address(this)
+        );
+    }
+    
 
     /// @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, 
-            bytes memory data
-        ) = super.getInitialInfo();
-
-        return (
-            info,
-            abi.encode(
-                _initialDistributionFee,
-                _isVerifying
-            )
-        );
-    }
 }

package/contracts/components/IComponent.sol

@@ -0,0 +1,43 @@
+// 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 {IInstanceService} from "../instance/IInstanceService.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {NftId} from "../types/NftId.sol";
+
+interface IComponent is IRegisterable {
+
+    error ErrorComponentNotInstance(NftId instanceNftId, address instance);
+    error ErrorComponentProductNftAlreadySet();
+    error ErrorComponentWalletAddressZero();
+    error ErrorComponentWalletAddressIsSameAsCurrent(address newWallet);
+    error ErrorComponentWalletAllowanceTooSmall(address oldWallet, address newWallet, uint256 allowance, uint256 balance);
+    error ErrorComponentUnauthorized(address caller, uint64 requiredRoleIdNum);
+    error ErrorComponentNotProductService(address caller);
+
+    event LogComponentWalletAddressChanged(address newWallet);
+    event LogComponentWalletTokensTransferred(address from, address to, uint256 amount);
+
+    function getName() external view returns (string memory name);
+
+    // TODO remove and replace with accessmanaged target locking mechanism
+    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);
+
+    function getInstanceService() external view returns (IInstanceService);
+    function getProductService() external view returns (IProductService);
+}

package/contracts/components/IDistributionComponent.sol

@@ -2,11 +2,14 @@
 pragma solidity ^0.8.19;
 
 import {Fee} from "../types/Fee.sol";
-import {ReferralId} from "../types/ReferralId.sol";
+import {IComponent} from "./IComponent.sol";
+import {ISetup} from "../instance/module/ISetup.sol";
+import {ReferralId} from "../types/Referral.sol";
 import {NftId} from "../types/NftId.sol";
-import {IBaseComponent} from "./IBaseComponent.sol";
 
-interface IDistributionComponent is IBaseComponent {
+interface IDistributionComponent is IComponent {
+
+    function getSetupInfo() external view returns (ISetup.DistributionSetupInfo memory setupInfo);
 
     function setFees(
         Fee memory distributionFee
@@ -39,9 +42,6 @@ interface IDistributionComponent is IBaseComponent {
     /// @dev returns true iff the referral id is valid
     function referralIsValid(ReferralId referralId) external view returns (bool isValid);
 
-    /// @dev default distribution fee, ie when not using any valid referralId
-    function getDistributionFee() external view returns (Fee memory distributionFee);
-
     /// @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,31 +1,24 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {NftId} from "../types/NftId.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 {UFixed} from "../types/UFixed.sol";
-import {IBaseComponent} from "./IBaseComponent.sol";
 
-interface IPoolComponent is IBaseComponent {
+interface IPoolComponent is IComponent {
 
     event LogUnderwrittenByPool(NftId policyNftId, uint256 collateralizationAmount, address pool);
 
+    function getSetupInfo() external view returns (ISetup.PoolSetupInfo memory setupInfo);
+
     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
@@ -56,10 +49,8 @@ interface IPoolComponent is IBaseComponent {
         view
         returns (bool isMatching);
 
-    function isVerifying() external view returns (bool verifying);
+    function isConfirmingApplication() external view returns (bool isConfirmingApplication);
 
     function getCollateralizationLevel() external view returns (UFixed collateralizationLevel);
 
-    function getFees() external view returns (Fee memory poolFee, Fee memory stakingFee, Fee memory performanceFee);
-
 }

package/contracts/components/IProductComponent.sol

@@ -2,13 +2,15 @@
 pragma solidity ^0.8.20;
 
 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/ReferralId.sol";
+import {ReferralId} from "../types/Referral.sol";
 import {RiskId} from "../types/RiskId.sol";
 
-import {IBaseComponent} from "./IBaseComponent.sol";
+interface IProductComponent is IComponent {
 
-interface IProductComponent is IBaseComponent {
+    function getSetupInfo() external view returns (ISetup.ProductSetupInfo memory setupInfo);
 
     function setFees(
         Fee memory productFee,
@@ -20,8 +22,8 @@ interface IProductComponent is IBaseComponent {
         RiskId riskId,
         uint256 lifetime,
         bytes memory applicationData,
-        ReferralId referralId,
-        NftId bundleNftId
+        NftId bundleNftId,
+        ReferralId referralId
     ) external view returns (uint256 premiumAmount);
 
     function calculateNetPremium(
@@ -31,9 +33,7 @@ interface IProductComponent is IBaseComponent {
         bytes memory applicationData
     ) external view returns (uint256 netPremiumAmount);    
 
-    function getProductFee() external view returns (Fee memory productFee);
-    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,36 +1,36 @@
 // 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 {POOL} from "../types/ObjectType.sol";
 import {IPoolService} from "../instance/service/IPoolService.sol";
-import {NftId} from "../types/NftId.sol";
+import {IBundleService} from "../instance/service/IBundleService.sol";
+import {NftId, 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 {Component} from "./Component.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/treasury/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 {
+abstract contract Pool is Component, IPoolComponent {
+    using NftIdLib for NftId;
 
-    bool internal _isVerifying;
+    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(
@@ -39,61 +39,43 @@ contract Pool is BaseComponent, IPoolComponent {
         _;
     }
 
-    modifier onlyProductService() {
-        require(
-            msg.sender == address(_productService), 
-            "ERROR:POL-002:NOT_PRODUCT_SERVICE");
-        _;
-    }
-
     constructor(
         address registry,
         NftId instanceNftId,
+        string memory name,
         // TODO refactor into tokenNftId
         address token,
         bool isInterceptor,
-        bool verifying,
+        bool isConfirmingApplication,
         UFixed collateralizationLevel,
         Fee memory poolFee,
         Fee memory stakingFee,
         Fee memory performanceFee,
-        address initialOwner
-    )
-        BaseComponent(registry, instanceNftId, token, POOL(), isInterceptor, initialOwner)
-    {
-        _isVerifying = verifying;
+        address initialOwner,
+        bytes memory data
+    ) Component(
+        registry, 
+        instanceNftId, 
+        name, 
+        token, 
+        POOL(), 
+        isInterceptor, 
+        initialOwner, 
+        data
+    ) {
+        _isConfirmingApplication = isConfirmingApplication;
         // TODO add validation
         _collateralizationLevel = collateralizationLevel;
         _initialPoolFee = poolFee;
         _initialStakingFee = stakingFee;
         _initialPerformanceFee = performanceFee;
 
-        _poolService = _instance.getPoolService();
-        _productService = _instance.getProductService();
+        _tokenHandler = new TokenHandler(token);
 
-        _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 = _poolService.createBundle(
-            owner,
-            fee,
-            initialAmount,
-            lifetime,
-            filter
-        );
+        _poolService = getInstance().getPoolService();
+        _bundleService = getInstance().getBundleService();
 
-        // TODO add logging
+        _registerInterface(type(IPoolComponent).interfaceId);
     }
 
     /**
@@ -107,7 +89,7 @@ contract Pool is BaseComponent, IPoolComponent {
         uint256 collateralizationAmount
     )
         external
-        onlyProductService
+        restricted()
         virtual override 
     {
         _underwrite(policyNftId, policyData, bundleFilter, collateralizationAmount);
@@ -130,8 +112,8 @@ contract Pool is BaseComponent, IPoolComponent {
     }
 
 
-    function isVerifying() external view override returns (bool verifying) {
-        return _isVerifying;
+    function isConfirmingApplication() external view override returns (bool isConfirmingApplication) {
+        return _isConfirmingApplication;
     }
 
     function getCollateralizationLevel() external view override returns (UFixed collateralizationLevel) {
@@ -145,6 +127,7 @@ contract Pool is BaseComponent, IPoolComponent {
     )
         external
         onlyOwner
+        restricted()
         override
     {
         _poolService.setFees(poolFee, stakingFee, performanceFee);
@@ -156,54 +139,40 @@ contract Pool is BaseComponent, IPoolComponent {
     )
         external
         override
-        // TODO add onlyBundleOwner
+        // TODO: add onlyBundleOwner
     {
-        _poolService.setBundleFee(bundleNftId, fee);
+        _bundleService.setBundleFee(bundleNftId, fee);
     }
-    // TODO delete, call instance instead
-    function getFees()
-        external
-        view
-        override
-        returns (Fee memory, Fee memory, Fee memory)
-    {
-        NftId productNftId = _instance.getProductNftId(getNftId());
-        //if (_instance.hasTreasuryInfo(productNftId)) {
-            ITreasury.TreasuryInfo memory info = _instance.getTreasuryInfo(productNftId);
-            return (info.poolFee, info.stakingFee, info.performanceFee);
-        //} else {
-        //    return (_initialPoolFee, _initialStakingFee, _initialPerformanceFee);
-        //}
+
+    function _lockBundle(NftId bundleNftId) internal {
+        _bundleService.lockBundle(bundleNftId);
     }
 
-    // from IRegisterable
+    function _unlockBundle(NftId bundleNftId) internal {
+        _bundleService.unlockBundle(bundleNftId);
+    }
 
-    // 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, 
-            bytes memory data
-        ) = super.getInitialInfo();
-
-        return (
-            info,
-            abi.encode(
-                IPool.PoolInfo(
-                    _isVerifying,
-                    _collateralizationLevel
-                ),
-                _wallet,
-                _token,
-                _initialPoolFee,
-                _initialStakingFee,
-                _initialPerformanceFee
-            )
+    function getSetupInfo() public view returns (ISetup.PoolSetupInfo memory setupInfo) {
+        InstanceReader reader = getInstance().getInstanceReader();
+        setupInfo = reader.getPoolSetupInfo(getNftId());
+
+        // fallback to initial setup info (wallet is always != address(0))
+        if(setupInfo.wallet == address(0)) {
+            setupInfo = _getInitialSetupInfo();
+        }
+    }
+
+    function _getInitialSetupInfo() internal view returns (ISetup.PoolSetupInfo memory) {
+        return ISetup.PoolSetupInfo(
+            getProductNftId(),
+            _tokenHandler,
+            _collateralizationLevel,
+            _initialPoolFee,
+            _initialStakingFee,
+            _initialPerformanceFee,
+            false,
+            _isConfirmingApplication,
+            getWallet()
         );
     }
 
@@ -235,7 +204,7 @@ contract Pool is BaseComponent, IPoolComponent {
         internal
         returns(NftId bundleNftId)
     {
-        bundleNftId = _poolService.createBundle(
+        bundleNftId = _bundleService.createBundle(
             bundleOwner,
             fee,
             amount,