@etherisc/gif-next 0.0.2-c96f882-016 → 0.0.2-ca84135-795

package/contracts/components/Component.sol

@@ -0,0 +1,177 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IComponent} from "./IComponent.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {IInstanceService} from "../instance/IInstanceService.sol";
+import {IInstance} from "../instance/IInstance.sol";
+import {InstanceAccessManager} from "../instance/InstanceAccessManager.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {NftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
+import {ObjectType, INSTANCE, PRODUCT} from "../types/ObjectType.sol";
+import {VersionLib} from "../types/Version.sol";
+import {Registerable} from "../shared/Registerable.sol";
+import {RoleId, RoleIdLib} from "../types/RoleId.sol";
+import {IAccess} from "../instance/module/IAccess.sol";
+
+// TODO discuss to inherit from oz accessmanaged
+// TODO make contract upgradeable, then add ComponentUpradeable that also intherits from Versionable
+// same pattern as for Service which is also upgradeable
+abstract contract Component is
+    Registerable,
+    IComponent
+{
+    IInstanceService internal _instanceService;
+    IProductService internal _productService;
+
+    IInstance internal _instance;
+    IERC20Metadata internal _token;
+    address internal _wallet;
+    NftId internal _productNftId;
+
+    modifier onlyProductService() {
+        if(msg.sender != address(_productService)) {
+            revert ErrorComponentNotProductService(msg.sender);
+        }
+        _;
+    }
+
+    // TODO discuss replacement with modifier restricted from accessmanaged
+    modifier onlyInstanceRole(uint64 roleIdNum) {
+        RoleId roleId = RoleIdLib.toRoleId(roleIdNum);
+        InstanceAccessManager accessManager = InstanceAccessManager(_instance.authority());
+        if( !accessManager.hasRole(roleId, msg.sender)) {
+            revert ErrorComponentUnauthorized(msg.sender, roleIdNum);
+        }
+        _;
+    }
+
+    // TODO discuss replacement with modifier restricted from accessmanaged
+    modifier isNotLocked() {
+        InstanceAccessManager accessManager = InstanceAccessManager(_instance.authority());
+        if (accessManager.isTargetLocked(address(this))) {
+            revert IAccess.ErrorIAccessTargetLocked(address(this));
+        }
+        _;
+    }
+
+    constructor(
+        address registry,
+        NftId instanceNftId,
+        address token,
+        ObjectType componentType,
+        bool isInterceptor,
+        address initialOwner
+    )
+    {
+        bytes memory data = "";
+        _initializeRegisterable(registry, instanceNftId, componentType, isInterceptor, initialOwner, data);
+
+        IRegistry.ObjectInfo memory instanceInfo = _registry.getObjectInfo(instanceNftId);
+        _instance = IInstance(instanceInfo.objectAddress);
+        require(
+            _instance.supportsInterface(type(IInstance).interfaceId),
+            ""
+        );
+
+        _instanceService = IInstanceService(_registry.getServiceAddress(INSTANCE(), VersionLib.toVersion(3, 0, 0).toMajorPart()));
+        _productService = IProductService(_registry.getServiceAddress(PRODUCT(), VersionLib.toVersion(3, 0, 0).toMajorPart()));
+        _wallet = address(this);
+        _token = IERC20Metadata(token);
+
+        _registerInterface(type(IComponent).interfaceId);
+    }
+
+    // TODO discuss replacement with modifier restricted from accessmanaged
+    function lock() external onlyOwner override {
+        _instanceService.setTargetLocked(getName(), true);
+    }
+    
+    // TODO discuss replacement with modifier restricted from accessmanaged
+    function unlock() external onlyOwner override {
+        _instanceService.setTargetLocked(getName(), false);
+    }
+
+    // TODO discuss to split this base contract into a minimal component base (eg oracle)
+    // and a component base that is linked to a product component (all others in v3)
+    function setProductNftId(NftId productNftId)
+        external
+        override
+        onlyProductService() 
+    {
+        if(_productNftId.gtz()) {
+            revert ErrorComponentProductNftAlreadySet();
+        }
+
+        _productNftId = productNftId;
+    }
+
+    /// @dev Sets the wallet address for the component. 
+    /// if the current wallet has tokens, these will be transferred. 
+    /// if the new wallet address is externally owned, an approval from the 
+    /// owner of the external wallet for the component to move all tokens must exist. 
+    function setWallet(address newWallet) external override onlyOwner {
+        address currentWallet = _wallet;
+        uint256 currentBalance = _token.balanceOf(currentWallet);
+
+        // checks
+        if (newWallet == currentWallet) {
+            revert ErrorComponentWalletAddressIsSameAsCurrent(newWallet);
+        }
+
+        if (currentBalance > 0) {
+            if (currentWallet == address(this)) {
+                // move tokens from component smart contract to external wallet
+            } else {
+                // move tokens from external wallet to component smart contract or another external wallet
+                uint256 allowance = _token.allowance(currentWallet, address(this));
+                if (allowance < currentBalance) {
+                    revert ErrorComponentWalletAllowanceTooSmall(currentWallet, newWallet, allowance, currentBalance);
+                }
+            }
+        }
+
+        // effects
+        _wallet = newWallet;
+        emit LogComponentWalletAddressChanged(newWallet);
+
+        // interactions
+        if (currentBalance > 0) {
+            // transfer tokens from current wallet to new wallet
+            if (currentWallet == address(this)) {
+                // transferFrom requires self allowance too
+                _token.approve(address(this), currentBalance);
+            }
+            
+            SafeERC20.safeTransferFrom(_token, currentWallet, newWallet, currentBalance);
+            emit LogComponentWalletTokensTransferred(currentWallet, newWallet, currentBalance);
+        }
+    }
+
+    // TODO set name via constructor or initialization, pure function likely too restrictive
+    function getName() public pure virtual returns (string memory name);
+
+    function getWallet()
+        external
+        view
+        override
+        returns (address walletAddress)
+    {
+        return _wallet;
+    }
+
+    function getToken() public view override returns (IERC20Metadata token) {
+        return _token;
+    }
+
+    function getInstance() public view override returns (IInstance instance) {
+        return _instance;
+    }
+
+    function getProductNftId() public view override returns (NftId productNftId) {
+        return _productNftId;
+    }
+}

package/contracts/components/Distribution.sol

@@ -7,7 +7,7 @@ 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 {Component} from "./Component.sol";
 import {IDistributionComponent} from "./IDistributionComponent.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
@@ -16,8 +16,8 @@ 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;
@@ -25,34 +25,26 @@ contract Distribution is
     Fee internal _initialDistributionFee;
     bool internal _isVerifying;
 
-    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,
-        NftId productNftId,
         // TODO refactor into tokenNftId
         address token,
         bool verifying,
         Fee memory distributionFee,
         address initialOwner
     )
-        BaseComponent(registry, instanceNftId, productNftId, token, DISTRIBUTION(), true, initialOwner)
+        Component(registry, instanceNftId, token, DISTRIBUTION(), true, initialOwner)
     {
         _isVerifying = verifying;
         _initialDistributionFee = distributionFee;
 
-        // TODO: reactivate when services are available again
-        // _distributionService = _instance.getDistributionService();
-        // _productService = _instance.getProductService();
+        _tokenHandler = TokenHandler(token);
+        _distributionService = _instance.getDistributionService();
 
         _registerInterface(type(IDistributionComponent).interfaceId);
     }
@@ -123,19 +115,10 @@ contract Distribution is
     }
 
     function getSetupInfo() public view returns (ISetup.DistributionSetupInfo memory setupInfo) {
-        if (getNftId().eq(zeroNftId())) {
-            return ISetup.DistributionSetupInfo(
-                _productNftId,
-                TokenHandler(address(0)),
-                _initialDistributionFee,
-                _isVerifying,
-                address(0)
-            );
-        } 
-
         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) {
@@ -152,14 +135,19 @@ contract Distribution is
     {
         (
             IRegistry.ObjectInfo memory info, 
-            bytes memory data
         ) = super.getInitialInfo();
 
         return (
             info,
             abi.encode(
-                _initialDistributionFee,
-                _isVerifying
+                getName(),
+                ISetup.DistributionSetupInfo(
+                    _productNftId,
+                    _tokenHandler,
+                    _initialDistributionFee,
+                    _isVerifying,
+                    address(this)
+                )
             )
         );
     }

package/contracts/components/IComponent.sol

@@ -0,0 +1,37 @@
+// 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 IComponent is IRegisterable {
+
+    error ErrorComponentProductNftAlreadySet();
+    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 pure 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);
+
+}

package/contracts/components/IDistributionComponent.sol

@@ -4,6 +4,7 @@ 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 {
 

package/contracts/components/IPoolComponent.sol

@@ -43,6 +43,10 @@ interface IPoolComponent {
         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. 
@@ -55,7 +59,7 @@ interface IPoolComponent {
         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);
 

package/contracts/components/IProductComponent.sol

@@ -18,8 +18,8 @@ interface IProductComponent {
         RiskId riskId,
         uint256 lifetime,
         bytes memory applicationData,
-        ReferralId referralId,
-        NftId bundleNftId
+        NftId bundleNftId,
+        ReferralId referralId
     ) external view returns (uint256 premiumAmount);
 
     function calculateNetPremium(

package/contracts/components/Pool.sol

@@ -1,42 +1,40 @@
 // 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, zeroNftId, NftIdLib} 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/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(
@@ -45,39 +43,33 @@ contract Pool is BaseComponent, IPoolComponent {
         _;
     }
 
-    modifier onlyProductService() {
-        require(
-            msg.sender == address(_productService), 
-            "ERROR:POL-002:NOT_PRODUCT_SERVICE");
-        _;
-    }
-
     constructor(
         address registry,
         NftId instanceNftId,
-        NftId productNftId,
         // 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, productNftId, token, POOL(), isInterceptor, initialOwner)
+        Component(registry, instanceNftId, token, POOL(), isInterceptor, initialOwner)
     {
-        _isVerifying = verifying;
+        _isConfirmingApplication = isConfirmingApplication;
         // TODO add validation
         _collateralizationLevel = collateralizationLevel;
         _initialPoolFee = poolFee;
         _initialStakingFee = stakingFee;
         _initialPerformanceFee = performanceFee;
 
-        // TODO: reactivate when services are available again
-        // _poolService = _instance.getPoolService();
+        _tokenHandler = new TokenHandler(token);
+
+        _poolService = _instance.getPoolService();
         // _productService = _instance.getProductService();
+        _bundleService = _instance.getBundleService();
 
         _registerInterface(type(IPoolComponent).interfaceId);
     }
@@ -93,7 +85,7 @@ contract Pool is BaseComponent, IPoolComponent {
         returns(NftId bundleNftId)
     {
         address owner = msg.sender;
-        bundleNftId = _poolService.createBundle(
+        bundleNftId = _bundleService.createBundle(
             owner,
             fee,
             initialAmount,
@@ -138,8 +130,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) {
@@ -166,24 +158,30 @@ contract Pool is BaseComponent, IPoolComponent {
         override
         // TODO add onlyBundleOwner
     {
-        _poolService.setBundleFee(bundleNftId, fee);
+        _bundleService.setBundleFee(bundleNftId, fee);
     }
 
-    function getSetupInfo() public view returns (ISetup.PoolSetupInfo memory setupInfo) {
-        // TODO fix this
-        if (getNftId().eq(zeroNftId())) {
-            return ISetup.PoolSetupInfo(
-                _productNftId,
-                TokenHandler(address(0)),
-                _collateralizationLevel,
-                _initialPoolFee,
-                _initialStakingFee,
-                _initialPerformanceFee,
-                _isVerifying,
-                _wallet
-            );
-        } 
+    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());
     }
@@ -200,20 +198,21 @@ contract Pool is BaseComponent, IPoolComponent {
     {
         (
             IRegistry.ObjectInfo memory info, 
-            bytes memory data
         ) = super.getInitialInfo();
 
         return (
             info,
             abi.encode(
+                getName(),
                 ISetup.PoolSetupInfo(
-                    getProductNftId(),
-                    TokenHandler(address(0)),
+                    _productNftId,
+                    _tokenHandler,
                     _collateralizationLevel,
                     _initialPoolFee,
                     _initialStakingFee,
                     _initialPerformanceFee,
-                    _isVerifying,
+                    false,
+                    _isConfirmingApplication,
                     _wallet
                 )
             )
@@ -248,7 +247,7 @@ contract Pool is BaseComponent, IPoolComponent {
         internal
         returns(NftId bundleNftId)
     {
-        bundleNftId = _poolService.createBundle(
+        bundleNftId = _bundleService.createBundle(
             bundleOwner,
             fee,
             amount,