@etherisc/gif-next 0.0.2-d9bed37-033 → 0.0.2-d9d5e42-801

package/contracts/shared/ComponentServiceManager.sol

@@ -17,7 +17,7 @@ contract ComponentServiceManager is ProxyManager {
     )
     {
         ComponentService svc = new ComponentService();
-        bytes memory data = abi.encode(registry, authority);
+        bytes memory data = abi.encode(authority, registry);
         IVersionable versionable = initialize(
             registry,
             address(svc), 

package/contracts/shared/ContractLib.sol

@@ -2,17 +2,151 @@
 pragma solidity ^0.8.20;
 
 import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
+import {IAccessManager} from "@openzeppelin/contracts/access/manager/IAccessManager.sol";
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
-import {IPolicyHolder} from "./IPolicyHolder.sol";
+import {IPolicyHolder} from "../shared/IPolicyHolder.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IService} from "../shared/IService.sol";
+
+import {NftId} from "../type/NftId.sol";
+import {ObjectType, INSTANCE, PRODUCT, DISTRIBUTION, ORACLE, POOL} from "../type/ObjectType.sol";
+import {VersionPart} from "../type/Version.sol";
+
+interface ITargetHelper {
+    function isTargetLocked(address target) external view returns (bool);
+}
+
+interface IInstanceAdminHelper {
+    function getInstanceAdmin() external view returns (ITargetHelper);
+}
+
+interface ITokenRegistryHelper {
+    function isActive(uint256 chainId, address token, VersionPart release) external view returns (bool);
+}
 
 library ContractLib {
 
+    error ErrorContractLibCallerNotRegistered(address target);
+    error ErrorContractLibCallerNotComponent(NftId componentNftId, ObjectType objectType);
+    error ErrorContractLibParentNotInstance(NftId componentNftId, NftId parentNftId);
+    error ErrorContractLibParentNotProduct(NftId componentNftId, NftId parentNftId);
+    error ErrorContractLibComponentTypeMismatch(NftId componentNftId, ObjectType expectedType, ObjectType actualType);
+    error ErrorContractLibComponentInactive(NftId componentNftId);
+
+
+    function getInfoAndInstance(
+        IRegistry registry,
+        NftId componentNftId,
+        bool onlyActive
+    )
+        external
+        view
+        returns (
+            IRegistry.ObjectInfo memory info, 
+            address instance
+        )
+    {
+        info = registry.getObjectInfo(componentNftId);
+        return _getAndVerifyComponentAndInstance(registry, info, info.objectType, onlyActive);
+    }
+
+
+    function getAndVerifyAnyComponent(
+        IRegistry registry, 
+        address caller,
+        bool onlyActive
+    )
+        external
+        view
+        returns (
+            IRegistry.ObjectInfo memory callerInfo, 
+            address instance
+        )
+    {
+        // check caller is component
+        callerInfo = _getAndVerifyObjectInfo(registry, caller);
+        if(!(callerInfo.objectType == PRODUCT()
+            || callerInfo.objectType == POOL()
+            || callerInfo.objectType == DISTRIBUTION()
+            || callerInfo.objectType == ORACLE())
+        ) {
+            revert ErrorContractLibCallerNotComponent(
+                callerInfo.nftId,
+                callerInfo.objectType);
+        }
+
+        return _getAndVerifyComponentAndInstance(registry, callerInfo, callerInfo.objectType, onlyActive);
+    }
+
+
+    function getAndVerifyComponent(
+        IRegistry registry, 
+        address caller,
+        ObjectType expectedType,
+        bool onlyActive
+    )
+        external
+        view
+        returns (
+            IRegistry.ObjectInfo memory info, 
+            address instance
+        )
+    {
+        info = _getAndVerifyObjectInfo(registry, caller);
+        return _getAndVerifyComponentAndInstance(registry, info, expectedType, onlyActive);
+    }
+
+
+    function getInstanceForComponent(
+        IRegistry registry, 
+        NftId componentNftId
+    )
+        public
+        view
+        returns (address instance)
+    {
+        NftId productNftId = registry.getParentNftId(componentNftId);
+        NftId instanceNftId = registry.getParentNftId(productNftId);
+        return registry.getObjectInfo(instanceNftId).objectAddress;
+    }
+
+
+    function isActiveToken(
+        address tokenRegistryAddress,
+        address token,
+        uint256 chainId, 
+        VersionPart release
+    )
+        external 
+        view 
+        returns (bool)
+    {
+        return ITokenRegistryHelper(
+            tokenRegistryAddress).isActive(
+                chainId, token, release);
+    }
+
+
     function isPolicyHolder(address target) external view returns (bool) {
         return ERC165Checker.supportsInterface(target, type(IPolicyHolder).interfaceId);
     }
 
-    function isAccessManaged(address target) external view returns (bool) {
+
+    function isAuthority(address authority) public view returns (bool) {
+        if (!isContract(authority)) {
+            return false;
+        }
+
+        return supportsInterface(authority, type(IAccessManager).interfaceId);
+    }
+
+
+    function isAccessManaged(address target)
+        public
+        view
+        returns (bool)
+    {
         if (!isContract(target)) {
             return false;
         }
@@ -24,7 +158,40 @@ library ContractLib {
         return success;
     }
 
+
+    function isRegistered(address registry, address caller, ObjectType expectedType) public view returns (bool) {
+        NftId nftId = IRegistry(registry).getNftIdForAddress(caller);
+        if (nftId.eqz()) {
+            return false;
+        }
+
+        return IRegistry(registry).getObjectInfo(nftId).objectType == expectedType;
+    }
+
+
+    function isService(address service) public view returns (bool) {
+        if (!isContract(service)) {
+            return false;
+        }
+
+        return supportsInterface(service, type(IService).interfaceId);
+    }
+
+
+    function isRegistry(address registry) public view returns (bool) {
+        if (!isContract(registry)) {
+            return false;
+        }
+
+        return supportsInterface(registry, type(IRegistry).interfaceId);
+    }
+
+
     function isContract(address target) public view returns (bool) {
+        if (target == address(0)) {
+            return false;
+        }
+
         uint256 size;
         assembly {
             size := extcodesize(target)
@@ -32,7 +199,113 @@ library ContractLib {
         return size > 0;
     }
 
-    function supportsInterface(address target, bytes4 interfaceId)  external view returns (bool) {
+    function supportsInterface(address target, bytes4 interfaceId)  public view returns (bool) {
         return ERC165Checker.supportsInterface(target, interfaceId);
     }
+
+
+    function _getAndVerifyComponentAndInstance(
+        IRegistry registry, 
+        IRegistry.ObjectInfo memory info,
+        ObjectType expectedType,
+        bool onlyActive
+    )
+        internal
+        view
+        returns (
+            IRegistry.ObjectInfo memory, 
+            address instance
+        )
+    {
+        if(info.objectType != expectedType) {
+            revert ErrorContractLibComponentTypeMismatch(
+                info.nftId,
+                expectedType,
+                info.objectType);
+        }
+
+        // get instance and check component is active
+        instance = getAndVerifyInstance(registry, info);
+        _checkComponentActive(instance, info.objectAddress, info.nftId, onlyActive);
+
+        return (
+            info,
+            instance
+        );
+    }
+
+
+    function _checkComponentActive(
+        address instance, 
+        address target, 
+        NftId componentNftId, 
+        bool onlyActive
+    )
+        internal
+        view
+    {
+        if (onlyActive) {
+            if (IInstanceAdminHelper(
+                instance).getInstanceAdmin().isTargetLocked(
+                    target)
+            ) {
+                revert ErrorContractLibComponentInactive(componentNftId);
+            }
+        }
+    }
+
+
+    /// @dev Given an object info the function returns the instance address.
+    /// The info may represent a product or any other component.
+    /// If the parent of the provided info is not registered with the correct type, the function reverts.
+    function getAndVerifyInstance(
+        IRegistry registry,
+        IRegistry.ObjectInfo memory info
+    )
+        public
+        view
+        returns (address instance)
+    {
+        // get instance for product case
+        if (info.objectType == PRODUCT()) {
+            // verify that parent of product is registered instance
+            IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(info.parentNftId);
+            if (instanceInfo.objectType != INSTANCE()) {
+                revert ErrorContractLibParentNotInstance(
+                    info.nftId,
+                    info.parentNftId);
+            }
+
+            // we have verified that parent object is a registerd instance -> we return the instance address
+            return instanceInfo.objectAddress;
+        }
+
+        // not product: verify parent is registered product
+        info = registry.getObjectInfo(info.parentNftId);
+        if (info.objectType != PRODUCT()) {
+            revert ErrorContractLibParentNotProduct(
+                info.nftId,
+                info.parentNftId);
+        }
+
+        // we have verified that parent is registerd product -> we can rely on registry that its parent is an instance
+        return registry.getObjectAddress(info.parentNftId);
+    }
+
+
+    function _getAndVerifyObjectInfo(
+        IRegistry registry, 
+        address caller
+    )
+        internal
+        view
+        returns (IRegistry.ObjectInfo memory info)
+    {
+        NftId componentNftId = registry.getNftIdForAddress(caller);
+        if (componentNftId.eqz()) {
+            revert ErrorContractLibCallerNotRegistered(caller);
+        }
+
+        info = registry.getObjectInfo(componentNftId);
+    }
 }

package/contracts/shared/IComponent.sol

@@ -1,7 +1,6 @@
 // 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 {Amount} from "../type/Amount.sol";
@@ -13,7 +12,6 @@ import {TokenHandler} from "../shared/TokenHandler.sol";
 /// @dev component base class
 /// component examples are staking, product, distribution, pool and oracle
 interface IComponent is 
-    IAccessManaged,
     IRegisterable,
     ITransferInterceptor
 {
@@ -23,27 +21,13 @@ interface IComponent is
 
     error ErrorComponentNotChainNft(address caller);
 
-    error ErrorComponentTokenAddressNonzero();
-    error ErrorComponentTokenAddressZero();
     error ErrorComponentWalletAddressZero();
     error ErrorComponentWalletAddressIsSameAsCurrent();
     error ErrorComponentWalletNotComponent();
 
     event LogComponentWalletAddressChanged(address oldWallet, address newWallet);
     event LogComponentWalletTokensTransferred(address from, address to, uint256 amount);
-    event LogComponentTokenHandlerApproved(address token, Amount limit, bool isMaxAmount);
-
-    /// @dev approves token hanlder to spend up to the specified amount of tokens
-    /// reverts if component wallet is not component itself
-    /// only component owner (nft holder) is authorizes to call this function
-    function approveTokenHandler(Amount spendingLimitAmount) external;
-
-    /// @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 to the tokenhandler of the component that 
-    /// covers the current component balance must exist
-    function setWallet(address walletAddress) external;
+    event LogComponentTokenHandlerApproved(address tokenHandler, address token, Amount limit, bool isMaxAmount);
 
     /// @dev returns the name of this component
     /// to successfully register the component with an instance the name MUST be unique in the linked instance
@@ -56,7 +40,7 @@ interface IComponent is
     function getTokenHandler() external view returns (TokenHandler tokenHandler);
 
     /// @dev defines the wallet address used to hold the ERC20 tokens related to this component
-    /// the default address is the component token address
+    /// the default address is the token handler address
     function getWallet() external view returns (address walletAddress);
 
     /// @dev returns true iff this compoent intercepts nft minting and transfers for objects registered by this component

package/contracts/shared/IComponentService.sol

@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {Amount} from "../type/Amount.sol";
 import {Fee} from "../type/Fee.sol";
-import {InstanceStore} from "../instance/InstanceStore.sol";
 import {IService} from "../shared/IService.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
@@ -16,17 +16,21 @@ import {VersionPart} from "../type/Version.sol";
 interface IComponentService is 
     IService
 {
-    error ErrorComponentServiceNotInstanceLinkedComponent(address component);
-    error ErrorComponentServiceSenderNotRegistered(address sender);
+    // registerProduct
+    error ErrorComponentServiceCallerNotInstance(address caller);
+    error ErrorComponentServiceNotProduct(address product);
+    error ErrorComponentServiceTokenInvalid(address token);
+
+    // registerComponent
+    error ErrorComponentServiceCallerNotProduct(address caller);
     error ErrorComponentServiceNotComponent(address component);
-    error ErrorComponentServiceTypeNotSupported(address component, ObjectType invalidType);
-    error ErrorComponentServiceInvalidType(address component, ObjectType requiredType, ObjectType componentType);
-    error ErrorComponentServiceAlreadyRegistered(address component);
-    error ErrorComponentServiceReleaseMismatch(address component, VersionPart componentRelease, VersionPart parentRelease);
-    error ErrorComponentServiceSenderNotComponentParent(NftId senderNftId, NftId compnentParentNftId);
-    error ErrorComponentServiceParentNotInstance(NftId nftId, ObjectType objectType);
-    error ErrorComponentServiceParentNotProduct(NftId nftId, ObjectType objectType);
 
+    error ErrorComponentServiceNotInstanceLinkedComponent(address component);
+    error ErrorComponentServiceComponentTypeNotSupported(address component, ObjectType invalid);
+    error ErrorComponentServiceComponentParentInvalid(address component, NftId required, NftId actual);
+    error ErrorComponentServiceComponentReleaseMismatch(address component, VersionPart serviceRelease, VersionPart componentRelease);
+    error ErrorComponentServiceComponentAlreadyRegistered(address component);
+    
     error ErrorProductServiceNoDistributionExpected(NftId productNftId);
     error ErrorProductServiceDistributionAlreadyRegistered(NftId productNftId, NftId distributionNftId);
     error ErrorProductServiceNoOraclesExpected(NftId productNftId);
@@ -43,7 +47,7 @@ interface IComponentService is
 
     event LogComponentServiceRegistered(NftId instanceNftId, NftId componentNftId, ObjectType componentType, address component, address token, address initialOwner); 
     event LogComponentServiceWalletAddressChanged(NftId componentNftId, address currentWallet, address newWallet);
-    event LogComponentWalletTokensTransferred(address from, address to, uint256 amount);
+    event LogComponentServiceWalletTokensTransferred(NftId componentNftId, address currentWallet, address newWallet, uint256 currentBalance);
     event LogComponentServiceComponentFeesWithdrawn(NftId componentNftId, address recipient, address token, Amount withdrawnAmount);
     event LogComponentServiceProductFeesUpdated(NftId productNftId);
     event LogComponentServiceDistributionFeesUpdated(NftId distributionNftId);
@@ -52,21 +56,23 @@ interface IComponentService is
         NftId nftId, 
         string feeName, 
         UFixed previousFractionalFee, 
-        uint256 previousFixedFee,
+        Amount previousFixedFee,
         UFixed newFractionalFee, 
-        uint256 newFixedFee
+        Amount newFixedFee
     );
-
+    
     //-------- component ----------------------------------------------------//
 
-    /// @dev sets the components associated wallet address
-    function setWallet(address newWallet) external;
+    /// @dev Approves the callers token handler to spend up to the specified amount of tokens.
+    /// Reverts if the component's token handler wallet is not the token handler itself.
+    function approveTokenHandler(IERC20Metadata token, Amount amount) external;
 
-    /// @dev locks the component associated with the caller
-    function lock() external;
+    /// @dev Sets the components associated wallet address.
+    /// To set the wallet to the token handler contract, use address(0) as the new wallet adress.
+    function setWallet(address newWallet) external;
 
-    /// @dev unlocks the component associated with the caller
-    function unlock() external;
+    /// @dev Locks/Unlocks the calling component.
+    function setLocked(bool locked) external;
 
     /// @dev Withdraw fees from the distribution component. Only component owner is allowed to withdraw fees.
     /// @param withdrawAmount the amount to withdraw
@@ -79,16 +85,13 @@ interface IComponentService is
     //-------- product ------------------------------------------------------//
 
     /// @dev Registers the specified product component for the instance (sender)
-    function registerProduct(address product) external returns (NftId productNftId);
+    function registerProduct(address product, address token) external returns (NftId productNftId);
 
     function setProductFees(
         Fee memory productFee, // product fee on net premium
         Fee memory processingFee // product fee on payout amounts        
     ) external;
 
-    function increaseProductFees(InstanceStore instanceStore, NftId productNftId, Amount feeAmount) external;
-    function decreaseProductFees(InstanceStore instanceStore, NftId productNftId, Amount feeAmount) external;
-
     //-------- distribution -------------------------------------------------//
 
     function setDistributionFees(
@@ -96,13 +99,6 @@ interface IComponentService is
         Fee memory minDistributionOwnerFee // min fee required by distribution owner (not including commissions for distributors)
     ) external;
 
-    function increaseDistributionBalance(InstanceStore instanceStore, NftId distributionNftId, Amount amount, Amount feeAmount) external;
-    function decreaseDistributionBalance(InstanceStore instanceStore, NftId distributionNftId, Amount amount, Amount feeAmount) external;
-
-    //-------- distributor --------------------------------------------------//
-    function increaseDistributorBalance(InstanceStore instanceStore, NftId distributorNftId, Amount amount, Amount feeAmount) external;
-    function decreaseDistributorBalance(InstanceStore instanceStore, NftId distributorNftId, Amount amount, Amount feeAmount) external;
-
     //-------- pool ---------------------------------------------------------//
 
     function setPoolFees(
@@ -111,11 +107,4 @@ interface IComponentService is
         Fee memory performanceFee // pool fee on profits from capital investors
     ) external;
 
-    function increasePoolBalance(InstanceStore instanceStore, NftId poolNftId, Amount amount, Amount feeAmount) external;
-    function decreasePoolBalance(InstanceStore instanceStore, NftId poolNftId, Amount amount, Amount feeAmount) external;
-
-    //-------- bundle -------------------------------------------------------//
-    function increaseBundleBalance(InstanceStore instanceStore, NftId bundleNftId, Amount amount, Amount feeAmount) external;
-    function decreaseBundleBalance(InstanceStore instanceStore, NftId bundleNftId, Amount amount, Amount feeAmount) external;
-
 }

package/contracts/shared/IInstanceLinkedComponent.sol

@@ -1,9 +1,6 @@
 // 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 {Amount} from "../type/Amount.sol";
 import {IComponent} from "../shared/IComponent.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
@@ -19,14 +16,6 @@ interface IInstanceLinkedComponent is
     error ErrorInstanceLinkedComponentTypeMismatch(ObjectType requiredType, ObjectType objectType);
     error ErrorInstanceLinkedComponentNotProduct(NftId nftId, ObjectType objectType);
 
-    /// @dev locks component to disable functions that may change state related to this component, the only exception is function "unlock"
-    /// only component owner (nft holder) is authorizes to call this function
-    function lock() external;
-
-    /// @dev unlocks component to (re-)enable functions that may change state related to this component
-    /// only component owner (nft holder) is authorizes to call this function
-    function unlock() external;
-
     /// @dev Withdraw fees from the distribution component. Only component owner is allowed to withdraw fees.
     /// @param amount the amount to withdraw
     /// @return withdrawnAmount the amount that was actually withdrawn

package/contracts/shared/IRegisterable.sol

@@ -1,19 +1,29 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+
 import {INftOwnable} from "./INftOwnable.sol";
+import {IRelease} from "../registry/IRelease.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
-import {VersionPart} from "../type/Version.sol";
 
 /// @title IRegisterable
 /// @dev Marks contracts that are intended to be registered in the registry.
 /// 
 interface IRegisterable is
-    INftOwnable
+    IAccessManaged,
+    INftOwnable,
+    IRelease
 {
-    /// @dev retuns the GIF release version for this contract.
-    /// This 
-    function getRelease() external pure returns (VersionPart release);
+    // __Registerable_init
+    error ErrorAuthorityInvalid(address authority);
+
+    // onlyActive()
+    error ErrorRegisterableNotActive();
+
+    /// @dev Returns true iff this contract managed by its authority is active.
+    /// Queries the IAccessManaged.authority().
+    function isActive() external view returns (bool active);
 
     /// @dev retuns the object info relevant for registering for this contract 
     /// IMPORTANT information returned by this function may only be used

package/contracts/shared/IService.sol

@@ -9,17 +9,15 @@ import {ObjectType} from "../type/ObjectType.sol";
 import {RoleId} from "../type/RoleId.sol";
 
 interface IService is 
+    IAccessManaged,
     IRegisterable,
-    IVersionable,
-    IAccessManaged
+    IVersionable
 {
-    error ErrorServiceNotImplemented();
-
     /// @dev returns the domain for this service.
     /// In any GIF release only one service for any given domain may be deployed.
     function getDomain() external pure returns(ObjectType serviceDomain);
 
     /// @dev returns the GIF release specific role id.
     /// These role ids are used to authorize service to service communication.
-    function getRoleId() external pure returns(RoleId serviceRoleId);
+    function getRoleId() external view returns(RoleId serviceRoleId);
 }

package/contracts/shared/InitializableERC165.sol

@@ -11,13 +11,21 @@ contract InitializableERC165 is
     mapping(bytes4 => bool) private _isSupported;
 
     // @dev initializes with support for ERC165
-    function _initializeERC165() internal onlyInitializing() {
+    function __ERC165_init() internal onlyInitializing() {
+        _initializeERC165();
+    }
+
+    function _initializeERC165() internal {
         _isSupported[type(IERC165).interfaceId] = true;
     }
 
     // @dev register support for provided interfaceId
     // includes initialization for ERC165_ID if not yet done
     function _registerInterface(bytes4 interfaceId) internal onlyInitializing() {
+        _registerInterfaceNotInitializing(interfaceId);
+    }
+
+    function _registerInterfaceNotInitializing(bytes4 interfaceId) internal{
         _isSupported[interfaceId] = true;
     }