@etherisc/gif-next 0.0.2-f761c0d-394 → 0.0.2-f78c672-338

package/contracts/shared/ComponentService.sol

@@ -1,48 +1,72 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount, AmountLib} from "../type/Amount.sol";
-import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
-import {Fee, FeeLib} from "../type/Fee.sol";
-import {IInstanceLinkedComponent} from "./IInstanceLinkedComponent.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {IRegistryService} from "../registry/IRegistryService.sol";
-import {IInstance} from "../instance/IInstance.sol";
-import {IAccess} from "../instance/module/IAccess.sol";
-import {NftId} from "../type/NftId.sol";
-import {ObjectType, REGISTRY, COMPONENT, DISTRIBUTION, INSTANCE, ORACLE, POOL, PRODUCT} from "../type/ObjectType.sol";
-import {RoleId, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE} from "../type/RoleId.sol";
-import {KEEP_STATE} from "../type/StateId.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IAccountingService} from "../accounting/IAccountingService.sol";
+import {IComponent} from "../shared/IComponent.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IComponentService} from "./IComponentService.sol";
-import {IDistributionComponent} from "../distribution/IDistributionComponent.sol";
+import {IInstance} from "../instance/IInstance.sol";
+import {IInstanceLinkedComponent} from "./IInstanceLinkedComponent.sol";
+import {InstanceAdmin} from "../instance/InstanceAdmin.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
+import {InstanceStore} from "../instance/InstanceStore.sol";
 import {IInstanceService} from "../instance/IInstanceService.sol";
 import {IPoolComponent} from "../pool/IPoolComponent.sol";
 import {IProductComponent} from "../product/IProductComponent.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
-import {InstanceStore} from "../instance/InstanceStore.sol";
-import {TokenHandler} from "./TokenHandler.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IRegistryService} from "../registry/IRegistryService.sol";
+
+import {Amount, AmountLib} from "../type/Amount.sol";
+import {ContractLib} from "../shared/ContractLib.sol";
+import {Fee, FeeLib} from "../type/Fee.sol";
+import {KEEP_STATE} from "../type/StateId.sol";
+import {NftId, NftIdLib} from "../type/NftId.sol";
+import {ObjectType, ACCOUNTING, REGISTRY, COMPONENT, DISTRIBUTION, INSTANCE, ORACLE, POOL, PRODUCT} from "../type/ObjectType.sol";
+import {Service} from "../shared/Service.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
+import {TokenHandlerDeployerLib} from "../shared/TokenHandlerDeployerLib.sol";
+import {VersionPart} from "../type/Version.sol";
+
 
 contract ComponentService is
-    ComponentVerifyingService,
+    Service,
     IComponentService
 {
-
-    error ErrorComponentServiceAlreadyRegistered(address component);
-    error ErrorComponentServiceNotComponent(address component);
-    error ErrorComponentServiceInvalidType(address component, ObjectType requiredType, ObjectType componentType);
-    error ErrorComponentServiceSenderNotOwner(address component, address initialOwner, address sender);
-    error ErrorComponentServiceExpectedRoleMissing(NftId instanceNftId, RoleId requiredRole, address sender);
-    error ErrorComponentServiceComponentLocked(address component);
-    error ErrorComponentServiceSenderNotService(address sender);
-    error ErrorComponentServiceComponentTypeInvalid(address component, ObjectType expectedType, ObjectType foundType);
-
     bool private constant INCREASE = true;
     bool private constant DECREASE = false;
 
+    IAccountingService private _accountingService;
     IRegistryService private _registryService;
     IInstanceService private _instanceService;
 
+    modifier onlyComponent(address component) {
+        _checkSupportsInterface(component);
+        _;
+    }
+
+    modifier onlyInstance() {        
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        if (instanceNftId.eqz()) {
+            revert ErrorComponentServiceNotRegistered(msg.sender);
+        }
+
+        ObjectType objectType = getRegistry().getObjectInfo(instanceNftId).objectType;
+        if (objectType != INSTANCE()) {
+            revert ErrorComponentServiceNotInstance(msg.sender, objectType);
+        }
+
+        VersionPart instanceVersion = IInstance(msg.sender).getRelease();
+        if (instanceVersion != getVersion().toMajorPart()) {
+            revert ErrorComponentServiceInstanceVersionMismatch(msg.sender, instanceVersion);
+        }
+
+        _;
+    }
+
+
     function _initialize(
         address owner, 
         bytes memory data
@@ -51,75 +75,179 @@ contract ComponentService is
         virtual override
         initializer()
     {
-        // TODO check this, might no longer be the way, refactor if necessary
-        address registryAddress;
-        address initialOwner;
-        (registryAddress, initialOwner) = abi.decode(data, (address, address));
+        (
+            address authority,
+            address registry
+        ) = abi.decode(data, (address, address));
 
-        initializeService(registryAddress, address(0), owner);
+        __Service_init(authority, registry, owner);
 
+        _accountingService = IAccountingService(_getServiceAddress(ACCOUNTING()));
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
         _instanceService = IInstanceService(_getServiceAddress(INSTANCE()));
 
-        registerInterface(type(IComponentService).interfaceId);
+        _registerInterface(type(IComponentService).interfaceId);
     }
 
     //-------- component ----------------------------------------------------//
 
-    function setWallet(address newWallet) external virtual {
-        (NftId componentNftId,, IInstance instance) = _getAndVerifyActiveComponent(COMPONENT());
-        IComponents.ComponentInfo memory info = instance.getInstanceReader().getComponentInfo(componentNftId);
-        address currentWallet = info.wallet;
-
-        if (newWallet == address(0)) {
-            revert ErrorComponentServiceNewWalletAddressZero();
+    function registerComponent(address component)
+        external
+        virtual
+        onlyComponent(component)
+        returns (NftId componentNftId)
+    {
+        // type specific registration
+        ObjectType componentType = IInstanceLinkedComponent(component).getInitialInfo().objectType;
+        if (componentType == POOL()) {
+            return _registerPool(component);
         }
-
-        if (currentWallet == address(0)) {
-            revert ErrorComponentServiceWalletAddressZero();
+        if (componentType == DISTRIBUTION()) {
+            return _registerDistribution(component);
         }
-
-        if (newWallet == currentWallet) {
-            revert ErrorComponentServiceWalletAddressIsSameAsCurrent();
+        if (componentType == ORACLE()) {
+            return _registerOracle(component);
         }
 
-        info.wallet = newWallet;
-        instance.getInstanceStore().updateComponent(componentNftId, info, KEEP_STATE());
-        emit LogComponentServiceWalletAddressChanged(componentNftId, currentWallet, newWallet);
+        // fail
+        revert ErrorComponentServiceTypeNotSupported(component, componentType);
     }
 
-    // TODO implement
-    function lock() external virtual {}
+    function approveTokenHandler(
+        IERC20Metadata token,
+        Amount amount
+    )
+        external
+        virtual
+    {
+        // checks
+        (NftId componentNftId, IInstance instance) = _getAndVerifyActiveComponent(COMPONENT());
+        TokenHandler tokenHandler = instance.getInstanceReader().getComponentInfo(
+            componentNftId).tokenHandler;
 
-    // TODO implement
-    function unlock() external virtual {}
+        // effects
+        tokenHandler.approve(token, amount);
+    }
 
 
-    //-------- product ------------------------------------------------------//
+    function setWallet(address newWallet)
+        external
+        virtual
+    {
+        // checks
+        (NftId componentNftId, IInstance instance) = _getAndVerifyActiveComponent(COMPONENT());
+        TokenHandler tokenHandler = instance.getInstanceReader().getComponentInfo(
+            componentNftId).tokenHandler;
+
+        // effects
+        tokenHandler.setWallet(newWallet);
+    }
 
-    function registerProduct()
+    /// @inheritdoc IComponentService
+    function setLockedFromInstance(address componentAddress, bool locked) 
+        external 
+        virtual
+        onlyInstance()
+    {
+        address instanceAddress = msg.sender;
+        // NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        IInstance instance = IInstance(instanceAddress);
+        _setLocked(instance.getInstanceAdmin(), componentAddress, locked);
+    }
+
+    /// @inheritdoc IComponentService
+    function setLockedFromComponent(address componentAddress, bool locked) 
+        external
+        virtual
+        onlyComponent(msg.sender)
+    {
+        (, IInstance instance) = _getAndVerifyComponent(COMPONENT(), false);
+        _setLocked(instance.getInstanceAdmin(), componentAddress, locked);
+    }
+
+    /// @inheritdoc IComponentService
+    function withdrawFees(Amount amount)
         external
         virtual
+        returns (Amount withdrawnAmount)
     {
-        address contractAddress = msg.sender;
+        // checks
+        (NftId componentNftId, IInstance instance) = _getAndVerifyActiveComponent(COMPONENT());
+        InstanceReader instanceReader = instance.getInstanceReader();
+
+        // determine withdrawn amount
+        Amount maxAvailableAmount = instanceReader.getFeeAmount(componentNftId);
+        withdrawnAmount = amount;
+
+        // max amount -> withraw all available fees
+        if (amount == AmountLib.max()) {
+            withdrawnAmount = maxAvailableAmount;
+        }
+
+        // check modified withdrawn amount
+        if (withdrawnAmount.eqz()) {
+            revert ErrorComponentServiceWithdrawAmountIsZero();
+        } else if (withdrawnAmount > maxAvailableAmount) {
+            revert ErrorComponentServiceWithdrawAmountExceedsLimit(withdrawnAmount, maxAvailableAmount);
+        }
+
+        // effects
+        // decrease fee counters by withdrawnAmount
+        _accountingService.decreaseComponentFees(
+            instance.getInstanceStore(), 
+            componentNftId, 
+            withdrawnAmount);
+        
+        address componentOwner = getRegistry().ownerOf(componentNftId);
+        TokenHandler tokenHandler = instanceReader.getTokenHandler(componentNftId);
+        emit LogComponentServiceComponentFeesWithdrawn(
+            componentNftId, 
+            componentOwner, 
+            address(tokenHandler.TOKEN()), 
+            withdrawnAmount);
+
+        // interactions
+        // transfer amount to component owner
+        tokenHandler.pushFeeToken(
+            componentOwner, 
+            withdrawnAmount);
+    }
+
 
+    //-------- product ------------------------------------------------------//
+
+    function registerProduct(address productAddress)
+        external
+        virtual
+        nonReentrant()
+        onlyComponent(productAddress)
+        returns (NftId productNftId)
+    {
         // register/create component setup
-        (
-            InstanceReader instanceReader, 
-            InstanceStore instanceStore, 
-            NftId productNftId
-        ) = _register(
-            contractAddress,
-            PRODUCT(),
-            PRODUCT_OWNER_ROLE());
-
-        // create product info
-        IComponents.ProductInfo memory productInfo = IProductComponent(contractAddress).getInitialProductInfo();
-        instanceStore.createProduct(productNftId, productInfo);
-
-        // link distribution and pool to product
-        _linkToProduct(instanceReader, instanceStore, productInfo.distributionNftId, productNftId);
-        _linkToProduct(instanceReader, instanceStore, productInfo.poolNftId, productNftId);
+        InstanceAdmin instanceAdmin;
+        InstanceStore instanceStore;
+        (, instanceAdmin, instanceStore,, productNftId) = _register(
+            productAddress,
+            PRODUCT());
+
+        // get product
+        IProductComponent product = IProductComponent(productAddress);
+        
+        IComponents.ProductInfo memory initialProductInfo = product.getInitialProductInfo();
+        // force initialization of linked components with empty values to 
+        // ensure no components are linked upon initialization of the product
+        initialProductInfo.poolNftId = NftIdLib.zero();
+        initialProductInfo.distributionNftId = NftIdLib.zero();
+        initialProductInfo.oracleNftId = new NftId[](initialProductInfo.expectedNumberOfOracles);
+
+        // create info
+        instanceStore.createProduct(
+            productNftId, 
+            initialProductInfo);
+
+        instanceStore.createFee(
+            productNftId, 
+            product.getInitialFeeInfo());
     }
 
 
@@ -129,68 +257,62 @@ contract ComponentService is
     )
         external
         virtual
+        nonReentrant()
     {
-        (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
-        IComponents.ProductInfo memory productInfo = instance.getInstanceReader().getProductInfo(productNftId);
+        (NftId productNftId, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
+        IComponents.FeeInfo memory feeInfo = instance.getInstanceReader().getFeeInfo(productNftId);
         bool feesChanged = false;
 
         // update product fee if required
-        if(!FeeLib.eq(productInfo.productFee, productFee)) {
-            _logUpdateFee(productNftId, "ProductFee", productInfo.productFee, productFee);
-            productInfo.productFee = productFee;
+        if(!FeeLib.eq(feeInfo.productFee, productFee)) {
+            _logUpdateFee(productNftId, "ProductFee", feeInfo.productFee, productFee);
+            feeInfo.productFee = productFee;
             feesChanged = true;
         }
 
         // update processing fee if required
-        if(!FeeLib.eq(productInfo.processingFee, processingFee)) {
-            _logUpdateFee(productNftId, "ProcessingFee", productInfo.processingFee, processingFee);
-            productInfo.processingFee = processingFee;
+        if(!FeeLib.eq(feeInfo.processingFee, processingFee)) {
+            _logUpdateFee(productNftId, "ProcessingFee", feeInfo.processingFee, processingFee);
+            feeInfo.processingFee = processingFee;
             feesChanged = true;
         }
         
         if(feesChanged) {
-            instance.getInstanceStore().updateProduct(productNftId, productInfo, KEEP_STATE());
+            instance.getInstanceStore().updateFee(productNftId, feeInfo);
             emit LogComponentServiceProductFeesUpdated(productNftId);
         }
     }
 
-    function increaseProductFees(
-        InstanceStore instanceStore,
-        NftId productNftId, 
-        Amount feeAmount
-    ) 
-        external 
-        virtual 
-        // TODO re-enable once role granting is stable and fixed
-        // restricted()
-    {
-        _changeTargetBalance(INCREASE, instanceStore, productNftId, AmountLib.zero(), feeAmount);
-    }
-
-
-    function decreaseProductFees(InstanceStore instanceStore, NftId productNftId, Amount feeAmount)
-        external 
-        virtual 
-        // TODO re-enable once role granting is stable and fixed
-        // restricted()
-    {
-        _changeTargetBalance(DECREASE, instanceStore, productNftId, AmountLib.zero(), feeAmount);
-    }
-
     //-------- distribution -------------------------------------------------//
 
     /// @dev registers the sending component as a distribution component
-    function registerDistribution()
-        external
+    function _registerDistribution(address distributioAddress)
+        internal
         virtual
+        nonReentrant()
+        returns (NftId distributionNftId)
     {
-        address contractAddress = msg.sender;
-
         // register/create component info
-        _register(
-            contractAddress,
-            DISTRIBUTION(),
-            DISTRIBUTION_OWNER_ROLE());
+        InstanceReader instanceReader;
+        InstanceAdmin instanceAdmin;
+        InstanceStore instanceStore;
+        NftId productNftId;
+        (instanceReader, instanceAdmin, instanceStore, productNftId, distributionNftId) = _register(
+            distributioAddress,
+            DISTRIBUTION());
+
+        // check product is still expecting a distribution registration
+        IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
+        if (!productInfo.hasDistribution) {
+            revert ErrorProductServiceNoDistributionExpected(productNftId);
+        }
+        if (productInfo.distributionNftId.gtz()) {
+            revert ErrorProductServiceDistributionAlreadyRegistered(productNftId, productInfo.distributionNftId);
+        }
+
+        // set distribution in product info
+        productInfo.distributionNftId = distributionNftId;
+        instanceStore.updateProduct(productNftId, productInfo, KEEP_STATE());
     }
 
 
@@ -201,102 +323,95 @@ contract ComponentService is
         external
         virtual
     {
-        (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
-        (NftId productNftId, IComponents.ProductInfo memory productInfo) = _getLinkedProductInfo(
+        (NftId distributionNftId, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
+        (NftId productNftId, IComponents.FeeInfo memory feeInfo) = _getLinkedFeeInfo(
             instance.getInstanceReader(), distributionNftId);
         bool feesChanged = false;
 
         // update distributino fee if required
-        if(!FeeLib.eq(productInfo.distributionFee, distributionFee)) {
-            _logUpdateFee(productNftId, "DistributionFee", productInfo.distributionFee, distributionFee);
-            productInfo.distributionFee = distributionFee;
+        if(!FeeLib.eq(feeInfo.distributionFee, distributionFee)) {
+            _logUpdateFee(productNftId, "DistributionFee", feeInfo.distributionFee, distributionFee);
+            feeInfo.distributionFee = distributionFee;
             feesChanged = true;
         }
 
         // update min distribution owner fee if required
-        if(!FeeLib.eq(productInfo.minDistributionOwnerFee, minDistributionOwnerFee)) {
-            _logUpdateFee(productNftId, "MinDistributionOwnerFee", productInfo.minDistributionOwnerFee, minDistributionOwnerFee);
-            productInfo.minDistributionOwnerFee = minDistributionOwnerFee;
+        if(!FeeLib.eq(feeInfo.minDistributionOwnerFee, minDistributionOwnerFee)) {
+            _logUpdateFee(productNftId, "MinDistributionOwnerFee", feeInfo.minDistributionOwnerFee, minDistributionOwnerFee);
+            feeInfo.minDistributionOwnerFee = minDistributionOwnerFee;
             feesChanged = true;
         }
         
         if(feesChanged) {
-            instance.getInstanceStore().updateProduct(productNftId, productInfo, KEEP_STATE());
+            instance.getInstanceStore().updateFee(productNftId, feeInfo);
             emit LogComponentServiceDistributionFeesUpdated(distributionNftId);
         }
     }
 
-    function increaseDistributionBalance(
-        InstanceStore instanceStore, 
-        NftId distributionNftId, 
-        Amount amount,
-        Amount feeAmount
-    )
-        external
-        virtual
-        // TODO re-enable once role granting is stable and fixed
-        // restricted()
-    {
-        _changeTargetBalance(INCREASE, instanceStore, distributionNftId, amount, feeAmount);
-    }
-
-
-    function decreaseDistributionBalance(
-        InstanceStore instanceStore, 
-        NftId distributionNftId, 
-        Amount amount,
-        Amount feeAmount
-    )
-        external
-        virtual
-        // TODO re-enable once role granting is stable and fixed
-        // restricted()
-    {
-        _changeTargetBalance(DECREASE, instanceStore, distributionNftId, amount, feeAmount);
-    }
-
     //-------- oracle -------------------------------------------------------//
 
-    function registerOracle()
-        external
+    function _registerOracle(address oracleAddress)
+        internal
         virtual
+        returns (NftId oracleNftId)
     {
-        address contractAddress = msg.sender;
-
         // register/create component setup
-        (
-            , // instance reader
-            InstanceStore instanceStore, 
-            NftId componentNftId
-        ) = _register(
-            contractAddress,
-            ORACLE(),
-            ORACLE_OWNER_ROLE());            
+        InstanceReader instanceReader;
+        InstanceAdmin instanceAdmin;
+        InstanceStore instanceStore;
+        NftId productNftId;
+
+        (instanceReader, instanceAdmin, instanceStore, productNftId, oracleNftId) = _register(
+            oracleAddress,
+            ORACLE());
+
+        // check product is still expecting an oracle registration
+        IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
+        if (productInfo.expectedNumberOfOracles == 0) {
+            revert ErrorProductServiceNoOraclesExpected(productNftId);
+        }
+        if (productInfo.numberOfOracles == productInfo.expectedNumberOfOracles) {
+            revert ErrorProductServiceOraclesAlreadyRegistered(productNftId, productInfo.expectedNumberOfOracles);
+        }
+
+        // update/add oracle to product info
+        productInfo.oracleNftId[productInfo.numberOfOracles] = oracleNftId;
+        productInfo.numberOfOracles++;
+        instanceStore.updateProduct(productNftId, productInfo, KEEP_STATE());
     }
 
     //-------- pool ---------------------------------------------------------//
 
-    function registerPool()
-        external
+    function _registerPool(address poolAddress)
+        internal
         virtual
+        returns (NftId poolNftId)
     {
-        address contractAddress = msg.sender;
-
         // register/create component setup
-        (
-            , // instance reader
-            InstanceStore instanceStore, 
-            NftId componentNftId
-        ) = _register(
-            contractAddress,
-            POOL(),
-            POOL_OWNER_ROLE());            
+        InstanceReader instanceReader;
+        InstanceAdmin instanceAdmin;
+        InstanceStore instanceStore;
+        NftId productNftId;
+
+        (instanceReader, instanceAdmin, instanceStore, productNftId, poolNftId) = _register(
+            poolAddress,
+            POOL());
+
+        // check product is still expecting a pool registration
+        IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
+        if (productInfo.poolNftId.gtz()) {
+            revert ErrorProductServicePoolAlreadyRegistered(productNftId, productInfo.poolNftId);
+        }
 
         // create info
+        IPoolComponent pool = IPoolComponent(poolAddress);
         instanceStore.createPool(
-            componentNftId, 
-            IPoolComponent(
-                contractAddress).getInitialPoolInfo());
+            poolNftId, 
+            pool.getInitialPoolInfo());
+
+        // update pool in product info
+        productInfo.poolNftId = poolNftId;
+        instanceStore.updateProduct(productNftId, productInfo, KEEP_STATE());
     }
 
 
@@ -308,188 +423,105 @@ contract ComponentService is
         external
         virtual
     {
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
-        (NftId productNftId, IComponents.ProductInfo memory productInfo) = _getLinkedProductInfo(
+        (NftId poolNftId, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+
+        (NftId productNftId, IComponents.FeeInfo memory feeInfo) = _getLinkedFeeInfo(
             instance.getInstanceReader(), poolNftId);
         bool feesChanged = false;
 
         // update pool fee if required
-        if(!FeeLib.eq(productInfo.poolFee, poolFee)) {
-            _logUpdateFee(productNftId, "PoolFee", productInfo.poolFee, poolFee);
-            productInfo.poolFee = poolFee;
+        if(!FeeLib.eq(feeInfo.poolFee, poolFee)) {
+            _logUpdateFee(productNftId, "PoolFee", feeInfo.poolFee, poolFee);
+            feeInfo.poolFee = poolFee;
             feesChanged = true;
         }
 
         // update staking fee if required
-        if(!FeeLib.eq(productInfo.stakingFee, stakingFee)) {
-            _logUpdateFee(productNftId, "StakingFee", productInfo.stakingFee, stakingFee);
-            productInfo.stakingFee = stakingFee;
+        if(!FeeLib.eq(feeInfo.stakingFee, stakingFee)) {
+            _logUpdateFee(productNftId, "StakingFee", feeInfo.stakingFee, stakingFee);
+            feeInfo.stakingFee = stakingFee;
             feesChanged = true;
         }
 
         // update performance fee if required
-        if(!FeeLib.eq(productInfo.performanceFee, performanceFee)) {
-            _logUpdateFee(productNftId, "PerformanceFee", productInfo.performanceFee, performanceFee);
-            productInfo.performanceFee = performanceFee;
+        if(!FeeLib.eq(feeInfo.performanceFee, performanceFee)) {
+            _logUpdateFee(productNftId, "PerformanceFee", feeInfo.performanceFee, performanceFee);
+            feeInfo.performanceFee = performanceFee;
             feesChanged = true;
         }
         
         if(feesChanged) {
-            instance.getInstanceStore().updateProduct(productNftId, productInfo, KEEP_STATE());
+            instance.getInstanceStore().updateFee(productNftId, feeInfo);
             emit LogComponentServicePoolFeesUpdated(poolNftId);
         }
     }
 
-    function increasePoolBalance(
-        InstanceStore instanceStore, 
-        NftId poolNftId, 
-        Amount amount, 
-        Amount feeAmount
-    )
-        public 
-        virtual 
-        // TODO re-enable once role granting is stable and fixed
-        // restricted()
-    {
-        _changeTargetBalance(INCREASE, instanceStore, poolNftId, amount, feeAmount);
-    }
-
-    function decreasePoolBalance(
-        InstanceStore instanceStore, 
-        NftId poolNftId, 
-        Amount amount, 
-        Amount feeAmount
-    )
-        public 
-        virtual 
-        // TODO re-enable once role granting is stable and fixed
-        // restricted()
-    {
-        _changeTargetBalance(DECREASE, instanceStore, poolNftId, amount, feeAmount);
-    }
-
-    //-------- bundle -------------------------------------------------------//
-
-    function increaseBundleBalance(
-        InstanceStore instanceStore, 
-        NftId bundleNftId, 
-        Amount amount, 
-        Amount feeAmount
-    )
-        external
-        virtual
-        // TODO re-enable once role granting is stable and fixed
-        // restricted()
-    {
-        _changeTargetBalance(INCREASE, instanceStore, bundleNftId, amount, feeAmount);
-    }
-
-    function decreaseBundleBalance(
-        InstanceStore instanceStore, 
-        NftId bundleNftId, 
-        Amount amount, 
-        Amount feeAmount
-    )
-        external
-        virtual
-        // TODO re-enable once role granting is stable and fixed
-        // restricted()
-    {
-        _changeTargetBalance(DECREASE, instanceStore, bundleNftId, amount, feeAmount);
-    }
-
-
-    //-------- internal functions ------------------------------------------//
-
-    function _changeTargetBalance(
-        bool increase,
-        InstanceStore instanceStore, 
-        NftId targetNftId, 
-        Amount amount, 
-        Amount feeAmount
-    )
-        internal
-        virtual
-    {
-        Amount totalAmount = amount + feeAmount;
-
-        if(increase) {
-            if(totalAmount.gtz()) { instanceStore.increaseBalance(targetNftId, totalAmount); }
-            if(feeAmount.gtz()) { instanceStore.increaseFees(targetNftId, feeAmount); }
-        } else {
-            if(totalAmount.gtz()) { instanceStore.decreaseBalance(targetNftId, totalAmount); }
-            if(feeAmount.gtz()) { instanceStore.decreaseFees(targetNftId, feeAmount); }
-        }
-    }
-
-    /// @dev registers the component represented by the provided address
+    /// @dev Registers the component represented by the provided address.
     function _register(
         address componentAddress, // address of component to register
-        ObjectType requiredType, // required type for component for registration
-        RoleId requiredRole // role required for comonent owner for registration
+        ObjectType requiredType // required type for component for registration
     )
         internal
         virtual
         returns (
             InstanceReader instanceReader, 
+            InstanceAdmin instanceAdmin, 
             InstanceStore instanceStore, 
+            NftId parentNftId,
             NftId componentNftId
         )
     {
+        NftId instanceNftId;
+        IInstance instance;
+        IInstanceLinkedComponent component;
+        address initialOwner;
+
         (
-            IInstance instance,
-            IInstanceLinkedComponent component,
-            address owner
+            instanceNftId, 
+            instance, 
+            parentNftId, 
+            component, 
+            initialOwner
         ) = _getAndVerifyRegisterableComponent(
+            getRegistry(),
             componentAddress,
-            requiredType,
-            requiredRole);
-
-        // register component with registry
-        componentNftId = _registryService.registerComponent(
-            component, 
-            requiredType, 
-            owner).nftId;
+            requiredType);
 
-        component.linkToRegisteredNftId();
-
-        // setup initial component authorization
-        _instanceService.initializeAuthorization(
-            instance.getNftId(),
-            component);
-
-        // save amended component info with instance
+        // get instance supporting contracts (as function return values)
         instanceReader = instance.getInstanceReader();
+        instanceAdmin = instance.getInstanceAdmin();
         instanceStore = instance.getInstanceStore();
 
-        IComponents.ComponentInfo memory componentInfo = component.getComponentInfo();
-        componentInfo.tokenHandler = new TokenHandler(address(componentInfo.token));
+        // register with registry
+        if (requiredType == PRODUCT()) {
+            componentNftId = _registryService.registerProduct(
+                component, initialOwner).nftId;
+        } else {
+            componentNftId = _registryService.registerProductLinkedComponent(
+                component, requiredType, initialOwner).nftId;
+        }
 
+        // deploy and wire token handler
+        IComponents.ComponentInfo memory componentInfo = component.getInitialComponentInfo();
+        IERC20Metadata token = componentInfo.token;
+        componentInfo.tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(
+            address(getRegistry()),
+            address(component), // initially, component is its own wallet
+            address(token), 
+            address(instanceAdmin.authority()));
+        
+        // register component with instance
         instanceStore.createComponent(
-            component.getNftId(), 
+            componentNftId, 
             componentInfo);
 
-        // TODO add logging
-    }
+        // link component contract to nft id
+        component.linkToRegisteredNftId();
 
+        // authorize
+        instanceAdmin.initializeComponentAuthorization(component);
 
-    /// @dev link the component info corresponding to the componentNftId to the provided productNftId
-    function _linkToProduct(
-        InstanceReader instanceReader, 
-        InstanceStore instanceStore,
-        NftId componentNftId,
-        NftId productNftId
-    )
-        internal
-    {
-        // only link components that are registered
-        if(componentNftId.eqz()) {
-            return;
-        }
-    
-        IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(componentNftId);
-        componentInfo.productNftId = productNftId;
-        instanceStore.updateComponent(componentNftId, componentInfo, KEEP_STATE());
+        emit LogComponentServiceRegistered(instanceNftId, componentNftId, requiredType, address(component), address(token), initialOwner);
     }
 
 
@@ -508,13 +540,7 @@ contract ComponentService is
     }
 
 
-    function _createSelectors(bytes4 selector) internal pure returns (bytes4[] memory selectors) {
-        selectors = new bytes4[](1);
-        selectors[0] = selector;
-    }
-
-
-    function _getLinkedProductInfo(
+    function _getLinkedFeeInfo(
         InstanceReader instanceReader, 
         NftId componentNftId
     )
@@ -522,60 +548,145 @@ contract ComponentService is
         view 
         returns(
             NftId productNftId, 
-            IComponents.ProductInfo memory info
+            IComponents.FeeInfo memory info
         )
     {
-        productNftId = instanceReader.getComponentInfo(componentNftId).productNftId;
-        info = instanceReader.getProductInfo(productNftId);
+        productNftId = getRegistry().getParentNftId(componentNftId);
+        info = instanceReader.getFeeInfo(productNftId);
     }
 
 
-    /// @dev based on the provided component address required type and role returns the component and related instance contract
-    /// the function reverts iff:
-    /// - the component has already been registered
+    /// @dev Based on the provided component address required type the component 
+    /// and related instance contract this function reverts iff:
+    /// - the sender is not registered
     /// - the component contract does not support IInstanceLinkedComponent
     /// - the component type does not match with the required type
-    /// - the initial component owner misses the required role (with the instance access manager)
+    /// - the component has already been registered
     function _getAndVerifyRegisterableComponent(
+        IRegistry registry,
         address componentAddress,
-        ObjectType requiredType,
-        RoleId requiredRole
+        ObjectType requiredType
     )
         internal
         view
         returns (
+            NftId instanceNftId,
             IInstance instance,
+            NftId parentNftId,
             IInstanceLinkedComponent component,
-            address owner
+            address initialOwner
         )
     {
-        // check this is a component
-        component = IInstanceLinkedComponent(componentAddress);
-        if(!component.supportsInterface(type(IInstanceLinkedComponent).interfaceId)) {
-            revert ErrorComponentServiceNotComponent(componentAddress);
+        // check sender (instance or product) is registered
+        IRegistry.ObjectInfo memory senderInfo = registry.getObjectInfo(msg.sender);
+        if (senderInfo.nftId.eqz()) {
+            revert ErrorComponentServiceSenderNotRegistered(msg.sender);
         }
 
+        // the sender is the parent of the component to be registered
+        // an instance caller wanting to register a product - or -
+        // a product caller wantint go register a distribution, oracle or pool
+        parentNftId = senderInfo.nftId;
+
         // check component is of required type
+        component = IInstanceLinkedComponent(componentAddress);
         IRegistry.ObjectInfo memory info = component.getInitialInfo();
         if(info.objectType != requiredType) {
             revert ErrorComponentServiceInvalidType(componentAddress, requiredType, info.objectType);
         }
 
         // check component has not already been registered
-        if (getRegistry().getNftId(componentAddress).gtz()) {
+        if (getRegistry().getNftIdForAddress(componentAddress).gtz()) {
             revert ErrorComponentServiceAlreadyRegistered(componentAddress);
         }
 
-        // check instance has assigned required role to inital owner
-        instance = _getInstance(info.parentNftId);
-        owner = info.initialOwner;
+        // component release matches servie release
+        address parentAddress = registry.getObjectAddress(parentNftId);
+        if (component.getRelease() != getRelease()) {
+            revert ErrorComponentServiceReleaseMismatch(componentAddress, component.getRelease(), getRelease());
+        // component release matches parent release
+        } else if (component.getRelease() != IRegisterable(parentAddress).getRelease()){
+            revert ErrorComponentServiceReleaseMismatch(componentAddress, component.getRelease(), IRegisterable(parentAddress).getRelease());
+        }
 
-        if(!instance.getInstanceAdmin().hasRole(owner, requiredRole)) {
-            revert ErrorComponentServiceExpectedRoleMissing(info.parentNftId, requiredRole, owner);
+        // check component belongs to same product cluster 
+        // parent of product must be instance, parent of other componet types must be product
+        if (info.parentNftId != senderInfo.nftId) {
+            revert ErrorComponentServiceSenderNotComponentParent(senderInfo.nftId, info.parentNftId);
         }
+
+        // verify parent is registered instance
+        if (requiredType == PRODUCT()) {
+            if (senderInfo.objectType != INSTANCE()) {
+                revert ErrorComponentServiceParentNotInstance(senderInfo.nftId, senderInfo.objectType);
+            }
+
+            instanceNftId = senderInfo.nftId;
+        // verify parent is registered product
+        } else {
+            if (senderInfo.objectType != PRODUCT()) {
+                revert ErrorComponentServiceParentNotProduct(senderInfo.nftId, senderInfo.objectType);
+            }
+
+            instanceNftId = senderInfo.parentNftId;
+        }
+
+        // get initial owner and instance
+        initialOwner = info.initialOwner;
+        instance = IInstance(registry.getObjectAddress(instanceNftId));
+    }
+
+    function _setLocked(InstanceAdmin instanceAdmin, address componentAddress, bool locked) internal {
+        instanceAdmin.setTargetLocked(componentAddress, locked);
+    }
+
+    function _getAndVerifyActiveComponent(ObjectType expectedType) 
+        internal 
+        view 
+        returns (
+            NftId componentNftId,
+            IInstance instance
+        )
+    {
+        return _getAndVerifyComponent(expectedType, true); // only active
+    }
+
+    function _getAndVerifyComponent(ObjectType expectedType, bool isActive) 
+        internal 
+        view 
+        returns (
+            NftId componentNftId,
+            IInstance instance
+        )
+    {
+        IRegistry.ObjectInfo memory info;
+        address instanceAddress;
+
+        if (expectedType != COMPONENT()) {
+            (info, instanceAddress) = ContractLib.getAndVerifyComponent(
+                getRegistry(),
+                msg.sender, // caller
+                expectedType,
+                isActive); 
+        } else {
+            (info, instanceAddress) = ContractLib.getAndVerifyAnyComponent(
+                getRegistry(),
+                msg.sender,
+                isActive); 
+        }
+
+        // get component nft id and instance
+        componentNftId = info.nftId;
+        instance = IInstance(instanceAddress);
     }
 
     function _getDomain() internal pure virtual override returns(ObjectType) {
         return COMPONENT();
     }
+
+    function _checkSupportsInterface(address component) internal view {
+        if (!ContractLib.supportsInterface(component, type(IInstanceLinkedComponent).interfaceId)) {
+            revert ErrorComponentServiceNotInstanceLinkedComponent(component);
+        }
+    }
 }