@etherisc/gif-next 0.0.2-e922e07-736 → 0.0.2-e94f4c7-084

package/contracts/components/Component.sol

@@ -1,11 +1,13 @@
 // 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 {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
 import {IComponent} from "./IComponent.sol";
+import {IComponents} from "../instance/module/IComponents.sol";
 import {IProductService} from "../instance/service/IProductService.sol";
 import {IInstanceService} from "../instance/IInstanceService.sol";
 import {IInstance} from "../instance/IInstance.sol";
@@ -47,6 +49,13 @@ abstract contract Component is
         }
     }
 
+    modifier onlyChainNft() {
+        if(msg.sender != getRegistry().getChainNftAddress()) {
+            revert ErrorComponentNotChainNft(msg.sender);
+        }
+        _;
+    }
+
     function initializeComponent(
         address registry,
         NftId instanceNftId,
@@ -82,15 +91,16 @@ abstract contract Component is
         $._wallet = address(this);
         $._token = IERC20Metadata(token);
 
+        registerInterface(type(IAccessManaged).interfaceId);
         registerInterface(type(IComponent).interfaceId);
     }
 
     function lock() external onlyOwner override {
-        IInstanceService(_getServiceAddress(INSTANCE())).setTargetLocked(getName(), true);
+        IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(true);
     }
     
     function unlock() external onlyOwner override {
-        IInstanceService(_getServiceAddress(INSTANCE())).setTargetLocked(getName(), false);
+        IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(false);
     }
 
     function setWallet(address newWallet)
@@ -160,18 +170,21 @@ abstract contract Component is
         $._productNftId = productNftId;
     }
 
+    function nftMint(address to, uint256 tokenId) 
+        external 
+        virtual
+        onlyChainNft
+    {}
+
     /// @dev callback function for nft transfers
     /// may only be called by chain nft contract.
     /// do not override this function to implement business logic for handling transfers
     /// override internal function _nftTransferFrom instead
     function nftTransferFrom(address from, address to, uint256 tokenId)
         external
-        virtual override
+        virtual
+        onlyChainNft
     {
-        if(msg.sender != getRegistry().getChainNftAddress()) {
-            revert ErrorComponentNotChainNft(msg.sender);
-        }
-
         _nftTransferFrom(from, to, tokenId);
     }
 
@@ -200,6 +213,25 @@ abstract contract Component is
         return _getComponentStorage()._productNftId;
     }
 
+    function getComponentInfo() public view returns (IComponents.ComponentInfo memory info) {
+        info = _getInstanceReader().getComponentInfo(getNftId());
+
+        // fallback to initial info (wallet is always != address(0))
+        if(info.wallet == address(0)) {
+            info = _getInitialInfo();
+        }
+    }
+
+    /// @dev defines initial component specification
+    /// overwrite this function according to your use case
+    function _getInitialInfo()
+        internal
+        view 
+        virtual
+        returns (IComponents.ComponentInfo memory info)
+    { }
+
+
     /// @dev internal function for nft transfers.
     /// handling logic that deals with nft transfers need to overwrite this function
     function _nftTransferFrom(address from, address to, uint256 tokenId)
@@ -218,4 +250,4 @@ abstract contract Component is
         VersionPart majorVersion = _getComponentStorage()._instance.getMajorVersion();
         return getRegistry().getServiceAddress(domain, majorVersion);
     }
-}
+}

package/contracts/components/Distribution.sol

@@ -37,6 +37,8 @@ abstract contract Distribution is
         mapping(address distributor => NftId distributorNftId) _distributorNftId;
     }
 
+    error ErrorDistributionAlreadyDistributor(address distributor, NftId distributorNftId);
+
     function initializeDistribution(
         address registry,
         NftId instanceNftId,
@@ -58,7 +60,7 @@ abstract contract Distribution is
         $._minDistributionOwnerFee = minDistributionOwnerFee;
         $._distributionFee = distributionFee;
         $._tokenHandler = new TokenHandler(token);
-        $._distributionService = getInstance().getDistributionService();
+        $._distributionService = IDistributionService(_getServiceAddress(DISTRIBUTION())); 
 
         registerInterface(type(IDistributionComponent).interfaceId);
     }
@@ -116,7 +118,9 @@ abstract contract Distribution is
         returns(NftId distributorNftId)
     {
         DistributionStorage storage $ = _getDistributionStorage();
-        require($._distributorNftId[distributor].eqz(), "ERROR:DST-030:ALREADY_DISTRIBUTOR");
+        if($._distributorNftId[distributor].gtz()) {
+            revert ErrorDistributionAlreadyDistributor(distributor, $._distributorNftId[distributor]);
+        }
 
         distributorNftId = $._distributionService.createDistributor(
             distributor,

package/contracts/components/IComponent.sol

@@ -1,8 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
+import {IComponents} from "../instance/module/IComponents.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {IInstanceService} from "../instance/IInstanceService.sol";
 import {IProductService} from "../instance/service/IProductService.sol";
@@ -15,7 +17,8 @@ import {ObjectType} from "../types/ObjectType.sol";
 /// component examples are product, distribution, pool and oracle
 interface IComponent is 
     IRegisterable,
-    ITransferInterceptor
+    ITransferInterceptor,
+    IAccessManaged
 {
     error ErrorComponentNotChainNft(address caller);
     error ErrorComponentNotProductService(address caller);
@@ -65,4 +68,9 @@ interface IComponent is
     function getProductNftId() external view returns (NftId productNftId);
 
     function isNftInterceptor() external view returns(bool isInterceptor);
+
+    /// @dev returns component 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 getComponentInfo() external view returns (IComponents.ComponentInfo memory info);
 }

package/contracts/components/IPoolComponent.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.20;
 
 import {Fee} from "../types/Fee.sol";
 import {IComponent} from "./IComponent.sol";
-import {ISetup} from "../instance/module/ISetup.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";
@@ -17,11 +17,8 @@ interface IPoolComponent is IComponent {
     error ErrorPoolNotPoolService(address caller);
 
     error ErrorPoolApplicationBundleMismatch(NftId applicationNftId);
-    error ErrorPoolBundleOwnerRoleAlreadySet();
 
     event LogPoolVerifiedByPool(address pool, NftId applicationNftId, uint256 collateralizationAmount);
-    event LogPoolBundleMaxCapitalAmountUpdated(uint256 previousMaxCapitalAmount, uint256 currentMaxCapitalAmount);
-    event LogPoolBundleOwnerRoleSet(RoleId bundleOwnerRole);
 
     /// @dev increases the staked tokens by the specified amount
     /// only the bundle owner may stake tokens
@@ -40,7 +37,7 @@ interface IPoolComponent is IComponent {
 
     /// @dev locks the specified bundle
     /// a bundle to be locked MUST be in active state
-    /// locked bundles may not be used to underwrite any new policy
+    /// locked bundles may not be used to collateralize any new policy
     function lockBundle(NftId bundleNftId) external;
 
     /// @dev unlocks the specified bundle
@@ -94,41 +91,6 @@ interface IPoolComponent is IComponent {
         uint256 collateralizationAmount
     ) external;
 
-    /// @dev defines the multiplier to calculate the required collateral to cover a given sum insured amount
-    /// default implementation returns 100%
-    function getCollateralizationLevel() external view returns (UFixed collateralizationLevel);
-
-    /// @dev defines the amount of collateral held in the pool.
-    /// if the value is < 100% the pool is required to hold a policy that covers the locally missing collateral
-    /// default implementation returns 100%
-    function getRetentionLevel() external view returns (UFixed retentionLevel);
-
-    /// @dev declares if pool relies on external management of collateral (yes/no): 
-    /// - yes: underwriting of new policies does not require an actual token balance, instead it is assumed that the pool owner will manage funds externally and inject enough tokens to allow process confirmed payouts
-    /// - no: the pool smart contract ensures that the necessary capacity of the pool prior to underwriting.
-    /// default implementation returns false (no)
-    function isExternallyManaged() external view returns (bool);
-
-    /// @dev declares if pool component is actively involved in underwriting (yes/no): 
-    /// - yes: verifying pools components actively confirm underwriting applications, ie the pool component logic explicitly needs to confirm the locking of collateral to cover the sum insured of the policy
-    /// - no: underwriting a policy does not require any interaction with the pool component if the covering bundle can provide the necessary captial
-    /// default implementation returnsfalse (no)
-    function isVerifyingApplications() external view returns (bool);
-
-    /// @dev returns the maximum overall capital amound held by this pool
-    function getMaxCapitalAmount() external view returns (uint256 maxCapitalAmount);
-
-    /// @dev declares if pool intercept transfers of bundle nft ids
-    /// - yes: pool may block transfer of bundle ownership or simply updates some bookkeeping related to bundle ownership. callback function is nftTransferFrom
-    /// - no: pool is not involved in transfer of bundle ownership
-    /// default implementation returns false (no)
-    function isInterceptingBundleTransfers() external view returns (bool);
-
-    /// @dev returns the required role for bundle owners
-    /// default emplementation returns PUBLIC_ROLE
-    /// the PUBLIC_ROLE role implies that no specific roole is required for bundle owners
-    function getBundleOwnerRole() external view returns (RoleId bundleOwnerRole);
-
     /// @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
@@ -143,9 +105,9 @@ interface IPoolComponent is IComponent {
         view
         returns (bool isMatching);
 
-    /// @dev returns setup infos for this pool
-    /// when registered with an instance the setup info is obtained from the data stored in the instance
-    /// when not registered the function returns the initial setup info
-    function getSetupInfo() external view returns (ISetup.PoolSetupInfo memory setupInfo);
+    /// @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/Pool.sol

@@ -1,20 +1,19 @@
 // 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 {InstanceReader} from "../instance/InstanceReader.sol";
 import {IPoolComponent} from "./IPoolComponent.sol";
 import {IPoolService} from "../instance/service/IPoolService.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
+import {IComponents} from "../instance/module/IComponents.sol";
 import {NftId, NftIdLib} from "../types/NftId.sol";
-import {POOL} from "../types/ObjectType.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} from "../types/UFixed.sol";
-
+import {UFixed, UFixedLib} from "../types/UFixed.sol";
 
 abstract contract Pool is
     Component, 
@@ -24,23 +23,6 @@ abstract contract Pool is
     bytes32 public constant POOL_STORAGE_LOCATION_V1 = 0x25e3e51823fbfffb988e0a2744bb93722d9f3e906c07cc0a9e77884c46c58300;
 
     struct PoolStorage {
-        UFixed _collateralizationLevel;
-        UFixed _retentionLevel;
-        uint256 _maxCapitalAmount;
-        
-        bool _isExternallyManaged;
-        bool _isVerifyingApplications;
-
-        RoleId _bundleOwnerRole;
-        bool _isInterceptingBundleTransfers;
-
-        Fee _initialPoolFee;
-        Fee _initialStakingFee;
-        Fee _initialPerformanceFee;
-
-        TokenHandler _tokenHandler;
-
-        // may be used to interact with instance by derived contracts
         IPoolService _poolService;
         IBundleService _bundleService;
     }
@@ -68,10 +50,6 @@ abstract contract Pool is
         string memory name,
         address token,
         bool isInterceptingNftTransfers,
-        bool isExternallyManaging,
-        bool isVerifying,
-        UFixed collateralizationLevel,
-        UFixed retentionLevel,
         address initialOwner,
         bytes memory registryData // writeonly data that will saved in the object info record of the registry
     )
@@ -82,19 +60,8 @@ abstract contract Pool is
         initializeComponent(registry, instanceNftId, name, token, POOL(), isInterceptingNftTransfers, initialOwner, registryData);
 
         PoolStorage storage $ = _getPoolStorage();
-        // TODO add validation
-        $._tokenHandler = new TokenHandler(token);
-        $._maxCapitalAmount = type(uint256).max;
-        $._isExternallyManaged = isExternallyManaging;
-        $._isVerifyingApplications = isVerifying;
-        $._bundleOwnerRole = PUBLIC_ROLE();
-        $._collateralizationLevel = collateralizationLevel;
-        $._retentionLevel = retentionLevel;
-        $._initialPoolFee = FeeLib.zeroFee();
-        $._initialStakingFee = FeeLib.zeroFee();
-        $._initialPerformanceFee = FeeLib.zeroFee();
-        $._poolService = getInstance().getPoolService();
-        $._bundleService = getInstance().getBundleService();
+        $._poolService = IPoolService(_getServiceAddress(POOL())); 
+        $._bundleService = IBundleService(_getServiceAddress(BUNDLE()));
 
         registerInterface(type(IPoolComponent).interfaceId);
     }
@@ -142,30 +109,30 @@ abstract contract Pool is
     function lockBundle(NftId bundleNftId)
         public
         virtual
-        restricted()
+        //restricted() // TODO consider adding this back
         onlyBundleOwner(bundleNftId)
     {
-        _getPoolStorage()._bundleService.lockBundle(bundleNftId);
+        _getPoolStorage()._bundleService.lock(bundleNftId);
     }
 
 
     function unlockBundle(NftId bundleNftId)
         public
         virtual
-        restricted()
+        //restricted()
         onlyBundleOwner(bundleNftId)
     {
-        _getPoolStorage()._bundleService.unlockBundle(bundleNftId);
+        _getPoolStorage()._bundleService.unlock(bundleNftId);
     }
 
 
     function close(NftId bundleNftId)
         public
         virtual
-        restricted()
+        //restricted()
         onlyBundleOwner(bundleNftId)
     {
-        // TODO add implementation
+        _getPoolStorage()._poolService.closeBundle(bundleNftId);
     }
 
 
@@ -178,7 +145,7 @@ abstract contract Pool is
         restricted()
         onlyBundleOwner(bundleNftId)
     {
-        _getPoolStorage()._bundleService.setBundleFee(bundleNftId, fee);
+        _getPoolStorage()._bundleService.setFee(bundleNftId, fee);
     }
 
 
@@ -188,13 +155,7 @@ abstract contract Pool is
         restricted()
         onlyOwner()
     {
-        // TODO refactor to use pool service
-        // _getPoolStorage()._poolService.setMaxCapitalAmount(...);
-
-        uint256 previousMaxCapitalAmount = _getPoolStorage()._maxCapitalAmount;
-        _getPoolStorage()._maxCapitalAmount = maxCapitalAmount;
-
-        emit LogPoolBundleMaxCapitalAmountUpdated(previousMaxCapitalAmount, maxCapitalAmount);
+        _getPoolStorage()._poolService.setMaxCapitalAmount(maxCapitalAmount);
     }
 
 
@@ -204,16 +165,7 @@ abstract contract Pool is
         restricted()
         onlyOwner()
     {
-        // TODO refactor to use pool service
-        // _getPoolStorage()._poolService.setBundleOwnerRole(...);
-
-        if(_getPoolStorage()._bundleOwnerRole != PUBLIC_ROLE()) {
-            revert ErrorPoolBundleOwnerRoleAlreadySet();
-        }
-
-        _getPoolStorage()._bundleOwnerRole = bundleOwnerRole;
-
-        emit LogPoolBundleOwnerRoleSet(bundleOwnerRole);
+        _getPoolStorage()._poolService.setBundleOwnerRole(bundleOwnerRole);
     }
 
 
@@ -243,7 +195,6 @@ abstract contract Pool is
         virtual
         restricted()
     {
-        // validate application data against bundle filter
         if(!applicationMatchesBundle(
             applicationNftId,
             applicationData, 
@@ -259,41 +210,6 @@ abstract contract Pool is
     }
 
 
-    function getCollateralizationLevel() public view virtual returns (UFixed collateralizationLevel) {
-        return _getPoolStorage()._collateralizationLevel;
-    }
-
-
-    function getRetentionLevel() public view virtual returns (UFixed retentionLevel) {
-        return _getPoolStorage()._retentionLevel;
-    }
-
-
-    function isExternallyManaged() public view virtual returns (bool) {
-        return _getPoolStorage()._isExternallyManaged;
-    }
-
-
-    function isVerifyingApplications() public view virtual returns (bool isConfirmingApplication) {
-        return _getPoolStorage()._isVerifyingApplications;
-    }
-
-
-    function getMaxCapitalAmount() public view virtual returns (uint256 maxCapitalAmount) {
-        return _getPoolStorage()._maxCapitalAmount;
-    }
-
-
-    function isInterceptingBundleTransfers() public view virtual returns (bool) {
-        return isNftInterceptor();
-    }
-
-
-    function getBundleOwnerRole() public view returns (RoleId bundleOwnerRole) {
-        return _getPoolStorage()._bundleOwnerRole;
-    }
-
-
     /// @dev see {IPoolComponent.applicationMatchesBundle}
     /// Override this function to implement any custom application verification 
     /// Default implementation always returns true
@@ -313,14 +229,8 @@ abstract contract Pool is
     }
 
 
-    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 getPoolInfo() external view returns (IComponents.PoolInfo memory poolInfo) {
+        poolInfo = abi.decode(getComponentInfo().data, (IComponents.PoolInfo));
     }
 
     // Internals
@@ -328,14 +238,14 @@ abstract contract Pool is
     function _createBundle(
         address bundleOwner,
         Fee memory fee,
-        uint256 amount,
+        Amount amount,
         Seconds lifetime, 
         bytes memory filter
     )
         internal
         returns(NftId bundleNftId)
     {
-        bundleNftId = _getPoolStorage()._bundleService.createBundle(
+        bundleNftId = _getPoolStorage()._poolService.createBundle(
             bundleOwner,
             fee,
             amount,
@@ -350,23 +260,37 @@ abstract contract Pool is
         return keccak256(abi.encode(uint256(keccak256(name)) - 1)) & ~bytes32(uint256(0xff));
     }
 
-
-    function _getInitialSetupInfo() internal view returns (ISetup.PoolSetupInfo memory) {
-        PoolStorage storage $ = _getPoolStorage();
-        return ISetup.PoolSetupInfo(
-            getProductNftId(),
-            $._tokenHandler,
-            $._maxCapitalAmount,
-            isNftInterceptor(),
-            $._isExternallyManaged,
-            $._isVerifyingApplications,
-            $._collateralizationLevel,
-            $._retentionLevel,
-            $._initialPoolFee,
-            $._initialStakingFee,
-            $._initialPerformanceFee,
-            getWallet()
-        );
+    /// @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
+                    type(uint256).max, // maxCapitalAmount,
+                    0, // initial balance amount
+                    0, // 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,
+                )));
     }