@etherisc/gif-next 0.0.2-4be7d72-071 → 0.0.2-4c19d89-776

package/contracts/shared/ComponentService.sol

@@ -42,6 +42,31 @@ contract ComponentService is
     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
@@ -66,38 +91,28 @@ contract ComponentService is
 
     //-------- component ----------------------------------------------------//
 
-    /// @inheritdoc IComponentService
-    function registerComponent(address componentAddress)
+    function registerComponent(address component)
         external
         virtual
+        onlyComponent(component)
         returns (NftId componentNftId)
     {
-        (NftId productNftId, IInstance instance) = _getAndVerifyActiveComponent(COMPONENT());
-
-        (
-            IInstanceLinkedComponent component,
-            IRegistry.ObjectInfo memory componentInfo // initial component info
-        ) = _getAndVerifyRegisterableComponent(
-            componentAddress,
-            productNftId);
-        ObjectType componentType = componentInfo.objectType;
-
+        // type specific registration
+        ObjectType componentType = IInstanceLinkedComponent(component).getInitialInfo().objectType;
         if (componentType == POOL()) {
-            IPoolComponent pool = IPoolComponent(componentAddress);
-            return _registerPool(instance, productNftId, pool, componentInfo);
+            return _registerPool(component);
         }
         if (componentType == DISTRIBUTION()) {
-            return _registerDistribution(instance, productNftId, component, componentInfo);
+            return _registerDistribution(component);
         }
         if (componentType == ORACLE()) {
-            return _registerOracle(instance, productNftId, component, componentInfo);
+            return _registerOracle(component);
         }
 
         // fail
-        revert ErrorComponentServiceComponentTypeNotSupported(componentAddress, componentType);
+        revert ErrorComponentServiceTypeNotSupported(component, componentType);
     }
 
-    /// @inheritdoc IComponentService
     function approveTokenHandler(
         IERC20Metadata token,
         Amount amount
@@ -132,10 +147,10 @@ contract ComponentService is
     function setLockedFromInstance(address componentAddress, bool locked) 
         external 
         virtual
+        onlyInstance()
     {
-        // TODO instance verification
-        //(NftId instanceNftId,, IInstance instance) = _getAndVerifyCallingInstance();
         address instanceAddress = msg.sender;
+        // NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
         IInstance instance = IInstance(instanceAddress);
         _setLocked(instance.getInstanceAdmin(), componentAddress, locked);
     }
@@ -144,6 +159,7 @@ contract ComponentService is
     function setLockedFromComponent(address componentAddress, bool locked) 
         external
         virtual
+        onlyComponent(msg.sender)
     {
         (, IInstance instance) = _getAndVerifyComponent(COMPONENT(), false);
         _setLocked(instance.getInstanceAdmin(), componentAddress, locked);
@@ -182,7 +198,6 @@ contract ComponentService is
             componentNftId, 
             withdrawnAmount);
         
-        // transfer amount to component owner
         address componentOwner = getRegistry().ownerOf(componentNftId);
         TokenHandler tokenHandler = instanceReader.getTokenHandler(componentNftId);
         emit LogComponentServiceComponentFeesWithdrawn(
@@ -205,32 +220,19 @@ contract ComponentService is
         external
         virtual
         nonReentrant()
+        onlyComponent(productAddress)
         returns (NftId productNftId)
     {
-        // TODO instance verification
-        //(NftId instanceNftId,, IInstance instance) = _getAndVerifyCallingInstance();
-        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
-        IInstance instance = IInstance(msg.sender);
-
-        (
-            ,
-            IRegistry.ObjectInfo memory productInfo // initial product info
-        ) = _getAndVerifyRegisterableComponent(
+        // register/create component setup
+        InstanceAdmin instanceAdmin;
+        InstanceStore instanceStore;
+        (, instanceAdmin, instanceStore,, productNftId) = _register(
             productAddress,
-            instanceNftId);
+            PRODUCT());
 
-        if(productInfo.objectType != PRODUCT()) {
-            revert ErrorComponentServiceComponentTypeNotSupported(productAddress, productInfo.objectType);
-        }
-
-        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
-        InstanceStore instanceStore = instance.getInstanceStore();
-
-        // register/create component info
+        // get product
         IProductComponent product = IProductComponent(productAddress);
-        productNftId = _register(instanceAdmin, instanceStore, product, productInfo);
-
-        // create product in instance instanceStore
+        
         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
@@ -284,26 +286,23 @@ contract ComponentService is
     //-------- distribution -------------------------------------------------//
 
     /// @dev registers the sending component as a distribution component
-    function _registerDistribution(
-        IInstance instance,
-        NftId productNftId,
-        IInstanceLinkedComponent distribution,
-        IRegistry.ObjectInfo memory info
-    )
+    function _registerDistribution(address distributioAddress)
         internal
         virtual
         nonReentrant()
         returns (NftId distributionNftId)
     {
-        InstanceReader reader = instance.getInstanceReader();
-        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
-        InstanceStore instanceStore = instance.getInstanceStore();
-
         // register/create component info
-        distributionNftId = _register(instanceAdmin, instanceStore, distribution, info);
+        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 = reader.getProductInfo(productNftId);
+        IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
         if (!productInfo.hasDistribution) {
             revert ErrorProductServiceNoDistributionExpected(productNftId);
         }
@@ -351,25 +350,23 @@ contract ComponentService is
 
     //-------- oracle -------------------------------------------------------//
 
-    function _registerOracle(
-        IInstance instance,
-        NftId productNftId,
-        IInstanceLinkedComponent oracle,
-        IRegistry.ObjectInfo memory info
-    )
+    function _registerOracle(address oracleAddress)
         internal
         virtual
         returns (NftId oracleNftId)
     {
-        InstanceReader reader = instance.getInstanceReader();
-        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
-        InstanceStore instanceStore = instance.getInstanceStore();
+        // register/create component setup
+        InstanceReader instanceReader;
+        InstanceAdmin instanceAdmin;
+        InstanceStore instanceStore;
+        NftId productNftId;
 
-        // register/create component info
-        oracleNftId = _register(instanceAdmin, instanceStore, oracle, info);
+        (instanceReader, instanceAdmin, instanceStore, productNftId, oracleNftId) = _register(
+            oracleAddress,
+            ORACLE());
 
         // check product is still expecting an oracle registration
-        IComponents.ProductInfo memory productInfo = reader.getProductInfo(productNftId);
+        IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
         if (productInfo.expectedNumberOfOracles == 0) {
             revert ErrorProductServiceNoOraclesExpected(productNftId);
         }
@@ -385,30 +382,29 @@ contract ComponentService is
 
     //-------- pool ---------------------------------------------------------//
 
-    function _registerPool(
-        IInstance instance,
-        NftId productNftId,
-        IPoolComponent pool,
-        IRegistry.ObjectInfo memory info
-    )
+    function _registerPool(address poolAddress)
         internal
         virtual
         returns (NftId poolNftId)
     {
-        InstanceReader reader = instance.getInstanceReader();
-        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
-        InstanceStore instanceStore = instance.getInstanceStore();
+        // register/create component setup
+        InstanceReader instanceReader;
+        InstanceAdmin instanceAdmin;
+        InstanceStore instanceStore;
+        NftId productNftId;
 
-        // register/create component info
-        poolNftId = _register(instanceAdmin, instanceStore, pool, info);
+        (instanceReader, instanceAdmin, instanceStore, productNftId, poolNftId) = _register(
+            poolAddress,
+            POOL());
 
         // check product is still expecting a pool registration
-        IComponents.ProductInfo memory productInfo = reader.getProductInfo(productNftId);
+        IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
         if (productInfo.poolNftId.gtz()) {
             revert ErrorProductServicePoolAlreadyRegistered(productNftId, productInfo.poolNftId);
         }
 
         // create info
+        IPoolComponent pool = IPoolComponent(poolAddress);
         instanceStore.createPool(
             poolNftId, 
             pool.getInitialPoolInfo());
@@ -462,23 +458,50 @@ contract ComponentService is
 
     /// @dev Registers the component represented by the provided address.
     function _register(
-        InstanceAdmin instanceAdmin,
-        InstanceStore instanceStore,
-        IInstanceLinkedComponent component,
-        IRegistry.ObjectInfo memory info
+        address componentAddress, // address of component to register
+        ObjectType requiredType // required type for component for registration
     )
         internal
         virtual
-        returns (NftId componentNftId)
+        returns (
+            InstanceReader instanceReader, 
+            InstanceAdmin instanceAdmin, 
+            InstanceStore instanceStore, 
+            NftId parentNftId,
+            NftId componentNftId
+        )
     {
-        // register component with registry
-        componentNftId =
-            info.objectType == PRODUCT() ?
-            _registryService.registerProduct(component, info.initialOwner).nftId :
-            _registryService.registerProductLinkedComponent(component, info.objectType, info.initialOwner).nftId;
+        NftId instanceNftId;
+        IInstance instance;
+        IInstanceLinkedComponent component;
+        address initialOwner;
+
+        (
+            instanceNftId, 
+            instance, 
+            parentNftId, 
+            component, 
+            initialOwner
+        ) = _getAndVerifyRegisterableComponent(
+            getRegistry(),
+            componentAddress,
+            requiredType);
+
+        // get instance supporting contracts (as function return values)
+        instanceReader = instance.getInstanceReader();
+        instanceAdmin = instance.getInstanceAdmin();
+        instanceStore = instance.getInstanceStore();
+
+        // 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
-        // TODO deploy token handler in instance contract ?!
         IComponents.ComponentInfo memory componentInfo = component.getInitialComponentInfo();
         IERC20Metadata token = componentInfo.token;
         componentInfo.tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(
@@ -498,12 +521,7 @@ contract ComponentService is
         // authorize
         instanceAdmin.initializeComponentAuthorization(component);
 
-        emit LogComponentServiceRegistered(
-            componentNftId, 
-            info.objectType, 
-            address(component), 
-            address(token), 
-            info.initialOwner);
+        emit LogComponentServiceRegistered(instanceNftId, componentNftId, requiredType, address(component), address(token), initialOwner);
     }
 
 
@@ -537,47 +555,85 @@ contract ComponentService is
         info = instanceReader.getFeeInfo(productNftId);
     }
 
+
     /// @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 parent does not match with the required parent
-    /// - the component version does not match with the service release
+    /// - the component type does not match with the required type
     /// - the component has already been registered
     function _getAndVerifyRegisterableComponent(
+        IRegistry registry,
         address componentAddress,
-        NftId requiredParent
+        ObjectType requiredType
     )
         internal
         view
         returns (
+            NftId instanceNftId,
+            IInstance instance,
+            NftId parentNftId,
             IInstanceLinkedComponent component,
-            IRegistry.ObjectInfo memory info
+            address initialOwner
         )
     {
-        // check component interface
-        if (!ContractLib.supportsInterface(componentAddress, type(IInstanceLinkedComponent).interfaceId)) {
-            revert ErrorComponentServiceNotInstanceLinkedComponent(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);
-        info = component.getInitialInfo();
+        IRegistry.ObjectInfo memory info = component.getInitialInfo();
+        if(info.objectType != requiredType) {
+            revert ErrorComponentServiceInvalidType(componentAddress, requiredType, info.objectType);
+        }
 
-        // check component parent
-        if(info.parentNftId != requiredParent) {
-            revert ErrorComponentServiceComponentParentInvalid(componentAddress, requiredParent, info.parentNftId);
+        // check component has not already been registered
+        if (getRegistry().getNftIdForAddress(componentAddress).gtz()) {
+            revert ErrorComponentServiceAlreadyRegistered(componentAddress);
         }
 
-        // check component release
-        // TODO check version with registry
-        //if(info.version != getRelease()) {
-        if(component.getRelease() != getRelease()) {
-            revert ErrorComponentServiceComponentReleaseMismatch(componentAddress, getRelease(), component.getRelease());
+        // 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());
         }
 
-        // check component has not already been registered
-        if (getRegistry().getNftIdForAddress(componentAddress).gtz()) {
-            revert ErrorComponentServiceComponentAlreadyRegistered(componentAddress);
+        // 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 {
@@ -627,4 +683,10 @@ contract ComponentService is
     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);
+        }
+    }
 }

package/contracts/shared/IComponentService.sol

@@ -17,10 +17,19 @@ interface IComponentService is
     IService
 {
     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 ErrorComponentServiceSenderNotRegistered(address sender);
+    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 ErrorComponentServiceNotRegistered(address instanceAddress);
+    error ErrorComponentServiceNotInstance(address instanceAddress, ObjectType objectType);
+    error ErrorComponentServiceInstanceVersionMismatch(address instanceAddress, VersionPart instanceVersion);
     
     error ErrorProductServiceNoDistributionExpected(NftId productNftId);
     error ErrorProductServiceDistributionAlreadyRegistered(NftId productNftId, NftId distributionNftId);
@@ -36,7 +45,7 @@ interface IComponentService is
     error ErrorComponentServiceWithdrawAmountExceedsLimit(Amount withdrawnAmount, Amount withdrawLimit);
     error ErrorComponentServiceWalletAllowanceTooSmall(address wallet, address spender, uint256 allowance, uint256 amount);
 
-    event LogComponentServiceRegistered(NftId componentNftId, ObjectType componentType, address component, address token, address initialOwner); 
+    event LogComponentServiceRegistered(NftId instanceNftId, NftId componentNftId, ObjectType componentType, address component, address token, address initialOwner); 
     event LogComponentServiceWalletAddressChanged(NftId componentNftId, address currentWallet, address newWallet);
     event LogComponentServiceWalletTokensTransferred(NftId componentNftId, address currentWallet, address newWallet, uint256 currentBalance);
     event LogComponentServiceComponentFeesWithdrawn(NftId componentNftId, address recipient, address token, Amount withdrawnAmount);

package/contracts/type/RiskId.sol

@@ -2,6 +2,7 @@
 pragma solidity ^0.8.20;
 
 import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {NftId} from "./NftId.sol";
 import {RISK} from "./ObjectType.sol";
 
 type RiskId is bytes8;
@@ -40,9 +41,9 @@ library RiskIdLib {
         return uint64(RiskId.unwrap(riskId));
     }
 
-    // @dev Converts a risk id string into a risk id.
-    function toRiskId(string memory risk) public pure returns (RiskId) {
-        return RiskId.wrap(bytes8(keccak256(abi.encode(risk))));
+    // @dev Converts a risk id string with a product NftId into a risk id.
+    function toRiskId(NftId productNftId, bytes32 risk) public pure returns (RiskId) {
+        return RiskId.wrap(bytes8(keccak256(abi.encode(productNftId, risk))));
     }
 
     /// @dev Returns the key32 value for the specified risk id.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-4be7d72-071",
+  "version": "0.0.2-4c19d89-776",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {
@@ -36,7 +36,7 @@
     "@typescript-eslint/parser": "^8.1.0",
     "antlr4ng-cli": "^2.0.0",
     "dotenv": "^16.3.1",
-    "eslint": "^8.50.0",
+    "eslint": "^9.9.1",
     "hardhat": "^2.17.2",
     "prettier": "^3.0.3",
     "prettier-plugin-solidity": "^1.1.3",