@etherisc/gif-next 0.0.2-b312c9a-831 → 0.0.2-b37fa8b-169

package/contracts/product/RiskService.sol

@@ -2,28 +2,25 @@
 pragma solidity ^0.8.20;
 
 import {IInstance} from "../instance/IInstance.sol";
-import {IInstanceService} from "../instance/IInstanceService.sol";
-import {IPoolService} from "../pool/PoolService.sol";
-import {IRiskService} from "./IRiskService.sol";
-import {IRegistryService} from "../registry/IRegistryService.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
 import {IRisk} from "../instance/module/IRisk.sol";
+import {IRiskService} from "./IRiskService.sol";
 
+import {ContractLib} from "../shared/ContractLib.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
-import {ObjectType, INSTANCE, PRODUCT, POOL, POLICY, REGISTRY, RISK} from "../type/ObjectType.sol";
-import {ACTIVE, PAUSED, KEEP_STATE} from "../type/StateId.sol";
+import {ObjectType, COMPONENT, PRODUCT, RISK} from "../type/ObjectType.sol";
+import {ACTIVE, KEEP_STATE, CLOSED} from "../type/StateId.sol";
 import {NftId} from "../type/NftId.sol";
-import {RiskId} from "../type/RiskId.sol";
+import {RiskId, RiskIdLib} from "../type/RiskId.sol";
 import {StateId} from "../type/StateId.sol";
 import {RiskSet} from "../instance/RiskSet.sol";
-import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
+import {Service} from "../shared/Service.sol";
+import {TimestampLib} from "../type/Timestamp.sol";
 
 contract RiskService is
-    ComponentVerifyingService,
+    Service,
     IRiskService 
 {
-    IInstanceService private _instanceService;
-    IPoolService internal _poolService;
-    IRegistryService private _registryService;
 
     function _initialize(
         address owner, 
@@ -34,31 +31,35 @@ contract RiskService is
         virtual override
     {
         (
-            address registryAddress,
-            address authority
+            address authority,
+            address registry
         ) = abi.decode(data, (address, address));
 
-        _initializeService(registryAddress, authority, owner);
-
-        _instanceService = IInstanceService(_getServiceAddress(INSTANCE()));
-        _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getVersion().toMajorPart()));
-        _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
-
+        __Service_init(authority, registry, owner);
         _registerInterface(type(IRiskService).interfaceId);
     }
 
-
+    /// @inheritdoc IRiskService
     function createRisk(
-        RiskId riskId,
+        bytes32 id,
         bytes memory data
     )
         external 
-        override
+        virtual
+        restricted()
+        returns (RiskId riskId)
     {
-        (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
-        IRisk.RiskInfo memory riskInfo = IRisk.RiskInfo(productNftId, data);
+        // checks
+        (NftId productNftId, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
+
+        // effects
+        riskId = RiskIdLib.toRiskId(productNftId, id);
+        IRisk.RiskInfo memory riskInfo = IRisk.RiskInfo({
+            productNftId: productNftId, 
+            createdAt: TimestampLib.current(),
+            data: data});
 
-        instance.getInstanceStore().createRisk(
+        instance.getProductStore().createRisk(
             riskId,
             riskInfo
         );
@@ -66,6 +67,8 @@ contract RiskService is
         // add risk to RiskSet
         RiskSet riskSet = instance.getRiskSet();
         riskSet.add(riskId);
+
+        emit LogRiskServiceRiskCreated(productNftId, riskId);
     }
 
 
@@ -73,31 +76,111 @@ contract RiskService is
         RiskId riskId,
         bytes memory data
     )
-        external
+        external 
+        virtual
+        restricted()
     {
-        (,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
-        InstanceReader instanceReader = instance.getInstanceReader();
+        // checks
+        (NftId productNftId, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
 
+        // effects
+        InstanceReader instanceReader = instance.getInstanceReader();
         IRisk.RiskInfo memory riskInfo = instanceReader.getRiskInfo(riskId);
+
+        if (riskInfo.productNftId != productNftId) {
+            revert ErrorRiskServiceRiskProductMismatch(riskId, riskInfo.productNftId, productNftId);
+        }
+
         riskInfo.data = data;
-        instance.getInstanceStore().updateRisk(riskId, riskInfo, KEEP_STATE());
+        instance.getProductStore().updateRisk(riskId, riskInfo, KEEP_STATE());
+
+        emit LogRiskServiceRiskUpdated(productNftId, riskId);
     }
 
 
-    function updateRiskState(
+    /// @inheritdoc IRiskService
+    function setRiskLocked(
         RiskId riskId,
-        StateId state
+        bool locked
     )
-        external
+        external 
+        virtual
+        restricted()
     {
-        (,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
-        instance.getInstanceStore().updateRiskState(riskId, state);
+        // checks
+        (NftId productNftId, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
+
+        if (!instance.getRiskSet().hasRisk(productNftId, riskId)) {
+            revert ErrorRiskServiceUnknownRisk(productNftId, riskId);
+        }
 
-        if (state == ACTIVE()) {
+        if (instance.getInstanceReader().getRiskState(riskId) != ACTIVE()) {
+            revert ErrorRiskServiceRiskNotActive(productNftId, riskId);
+        }
+
+        if (locked) {
+            instance.getRiskSet().deactivate(riskId);
+            emit LogRiskServiceRiskLocked(productNftId, riskId);
+        } else {
             instance.getRiskSet().activate(riskId);
-        } else if (state == PAUSED()) {
-            instance.getRiskSet().pause(riskId);
+            emit LogRiskServiceRiskUnlocked(productNftId, riskId);
+        }
+    }
+
+    /// @inheritdoc IRiskService
+    function closeRisk(
+        RiskId riskId
+    )
+        external 
+        virtual
+        restricted()
+    {
+        // checks
+        (NftId productNftId, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
+        (bool exists, bool active) = instance.getRiskSet().checkRisk(productNftId, riskId);
+
+        if (!exists) {
+            revert ErrorRiskServiceUnknownRisk(productNftId, riskId);
         }
+
+        if (active) {
+            revert ErrorRiskServiceRiskNotLocked(productNftId, riskId);
+        }
+
+        // effects
+        instance.getProductStore().updateRiskState(riskId, CLOSED());
+
+        emit LogRiskServiceRiskClosed(productNftId, riskId);
+    }
+
+    function _getAndVerifyActiveComponent(ObjectType expectedType) 
+        internal 
+        view 
+        returns (
+            NftId componentNftId,
+            IInstance instance
+        )
+    {
+        IRegistry.ObjectInfo memory info;
+        address instanceAddress;
+        bool isActive = true;
+
+        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);
     }
 
 

package/contracts/product/RiskServiceManager.sol

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

package/contracts/registry/ChainNft.sol

@@ -62,6 +62,7 @@ contract ChainNft is ERC721Enumerable {
         // 3 -> staking
         // >= 4 -> all other objects
         _idNext = 4;
+        _totalMinted = 0;
     }
 
     /**
@@ -108,10 +109,11 @@ contract ChainNft is ERC721Enumerable {
 
 
     /**
-     * @dev amend the open zeppelin transferFrom function by an interceptor call if such an interceptor is defined for the nft token id
-     * this allows distribution, product and pool components to be notified when distributors, policies and bundles are transferred.
+     * @dev Amend the open zeppelin transferFrom function by an interceptor call if such an interceptor is defined for the nft token id.
+     * This allows distribution, product and pool components to be notified when distributors, policies and bundles are transferred.
      */
     function transferFrom(address from, address to, uint256 tokenId) public override (IERC721, ERC721) {
+        // default open zeppelin implementation of transferFrom
         super.transferFrom(from, to, tokenId);
 
         if (_interceptor[tokenId] != address(0)) {

package/contracts/registry/IRegistry.sol

@@ -3,13 +3,11 @@ pragma solidity ^0.8.20;
 
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
+import {IRelease} from "./IRelease.sol";
+
 import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
 import {VersionPart} from "../type/Version.sol";
-import {Timestamp} from "../type/Timestamp.sol";
-import {StateId} from "../type/StateId.sol";
-
-import {IServiceAuthorization} from "../authorization/IServiceAuthorization.sol";
 
 /// @title Chain Registry interface.
 /// A chain registry holds all protocol relevant objects with basic metadata.
@@ -17,15 +15,20 @@ import {IServiceAuthorization} from "../authorization/IServiceAuthorization.sol"
 /// Registered objects are represented by NFTs.
 /// When on mainnet registry is global and keeps arbitrary number of chain registries residing on different chain ids.
 /// When not on mainnet registry keeps the only object residing on different chain id (on mainnet) - global registry.
-interface IRegistry is IERC165 {
+interface IRegistry is
+    IERC165
+{
 
-    event LogRegistration(NftId nftId, NftId parentNftId, ObjectType objectType, bool isInterceptor, address objectAddress, address initialOwner);
-    event LogServiceRegistration(VersionPart majorVersion, ObjectType domain);
-    event LogChainRegistryRegistration(NftId nftId, uint256 chainId, address chainRegistryAddress);
+    event LogRegistryObjectRegistered(NftId nftId, NftId parentNftId, ObjectType objectType, bool isInterceptor, address objectAddress, address initialOwner);
+    event LogRegistryServiceRegistered(VersionPart majorVersion, ObjectType domain);
+    event LogRegistryChainRegistryRegistered(NftId nftId, uint256 chainId, address chainRegistryAddress);
 
     // initialize
     error ErrorRegistryCallerNotDeployer();
 
+    // register()
+    error ErrorRegistryObjectTypeNotSupported(ObjectType objectType);
+
     // registerRegistry()
     error ErrorRegistryNotOnMainnet(uint256 chainId);
     error ErrorRegistryChainRegistryChainIdZero(NftId nftId);
@@ -36,8 +39,7 @@ interface IRegistry is IERC165 {
     // registerService()
     error ErrorRegistryServiceAddressZero(); 
     error ErrorRegistryServiceVersionZero(address service);
-    //error ErrorRegistryServiceVersionMismatch(address service, VersionPart serviceVersion, VersionPart releaseVersion);
-    //error ErrorRegistryServiceVersionNotDeploying(address service, VersionPart version);
+
     error ErrorRegistryServiceDomainZero(address service, VersionPart version);
     error ErrorRegistryNotService(address service, ObjectType objectType);
     error ErrorRegistryServiceParentNotRegistry(address service, VersionPart version, NftId parentNftId);
@@ -48,28 +50,23 @@ interface IRegistry is IERC165 {
 
     // _register()
     error ErrorRegistryGlobalRegistryAsParent(address objectAddress, ObjectType objectType);
-    error ErrorRegistryTypesCombinationInvalid(address objectAddress, ObjectType objectType, ObjectType parentType);
+    error ErrorRegistryTypeCombinationInvalid(address objectAddress, ObjectType objectType, ObjectType parentType);
     error ErrorRegistryContractAlreadyRegistered(address objectAddress);
 
     struct ObjectInfo {
+        // slot 0
         NftId nftId;
         NftId parentNftId;
         ObjectType objectType;
         bool isInterceptor;
+        // slot 1
         address objectAddress;
+        // slot 2
         address initialOwner;
+        // slot 3
         bytes data;
     }
 
-    struct ReleaseInfo {
-        StateId state;
-        VersionPart version;
-        bytes32 salt;
-        IServiceAuthorization auth;
-        Timestamp activatedAt;
-        Timestamp disabledAt;
-    }
-
     /// @dev Registers a registry contract for a specified chain.
     /// Only one chain registry may be registered per chain
     function registerRegistry(
@@ -98,13 +95,13 @@ interface IRegistry is IERC165 {
     /// May not be used to register known core types.
     function registerWithCustomType(ObjectInfo memory info) external returns (NftId nftId);
 
-    function getInitialVersion() external view returns (VersionPart);
+    function getInitialRelease() external view returns (VersionPart);
 
-    function getNextVersion() external view returns (VersionPart);
+    function getNextRelease() external view returns (VersionPart);
 
-    function getLatestVersion() external view returns (VersionPart);
+    function getLatestRelease() external view returns (VersionPart);
 
-    function getReleaseInfo(VersionPart version) external view returns (ReleaseInfo memory);
+    function getReleaseInfo(VersionPart release) external view returns (IRelease.ReleaseInfo memory);
 
     /// @dev Returns the number of supported chains.
     function chainIds() external view returns (uint256);
@@ -127,6 +124,8 @@ interface IRegistry is IERC165 {
 
     function getObjectInfo(NftId nftId) external view returns (ObjectInfo memory info);
 
+    function getParentNftId(NftId nftId) external view returns (NftId parentNftId);
+
     function isObjectType(NftId nftId, ObjectType expectedObjectType) external view returns (bool);
 
     function isObjectType(address contractAddress, ObjectType expectedObjectType) external view returns (bool);

package/contracts/registry/IRelease.sol

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IServiceAuthorization} from "../authorization/IServiceAuthorization.sol";
+
+import {StateId} from "../type/StateId.sol";
+import {Timestamp} from "../type/Timestamp.sol";
+import {VersionPart} from "../type/Version.sol";
+
+/// @title Marks contracts that are linked to a specific GIF release version.
+interface IRelease {
+
+    struct ReleaseInfo {
+        // slot 0
+        address releaseAdmin;
+        StateId state;
+        VersionPart version;
+        Timestamp activatedAt;
+        Timestamp disabledAt;
+        // slot 1
+        IServiceAuthorization auth;
+        // slot 2
+        bytes32 salt;
+    }
+
+    /// @dev Registers a registry contract for a specified chain.
+    /// Only one chain registry may be registered per chain
+    function getRelease() external view returns (VersionPart release);
+}

package/contracts/registry/Registry.sol

@@ -12,6 +12,7 @@ import {ObjectType, ObjectTypeLib, PROTOCOL, REGISTRY, SERVICE, INSTANCE, STAKE,
 
 import {ChainNft} from "./ChainNft.sol";
 import {IRegistry} from "./IRegistry.sol";
+import {IRelease} from "./IRelease.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
 import {IStaking} from "../staking/IStaking.sol";
 import {ReleaseRegistry} from "./ReleaseRegistry.sol";
@@ -171,7 +172,7 @@ contract Registry is
             revert ErrorRegistryChainRegistryNftIdInvalid(nftId, chainId);
         }
 
-        emit LogChainRegistryRegistration(nftId, chainId, registryAddress);
+        emit LogRegistryChainRegistryRegistered(nftId, chainId, registryAddress);
 
         _registerRegistryForNft(
             chainId,
@@ -230,7 +231,7 @@ contract Registry is
 
         _service[version][domain] = service;
 
-        emit LogServiceRegistration(version, domain);
+        emit LogRegistryServiceRegistered(version, domain);
 
         nftId = _register(info);
     }
@@ -245,6 +246,11 @@ contract Registry is
         address objectAddress = info.objectAddress;
         ObjectType objectType = info.objectType;
 
+        // specialized functions have to be used to register registries and services
+        if(objectType == REGISTRY() || objectType == STAKING() || objectType == SERVICE()) {
+            revert ErrorRegistryObjectTypeNotSupported(objectType);
+        }
+
         // this indidirectly enforces that the parent is registered
         // parentType would be zero for a non-registered parent which is never a valid type combination
         ObjectType parentType = _info[info.parentNftId].objectType;
@@ -252,13 +258,13 @@ contract Registry is
         // check type combinations for core objects
         if(objectAddress == address(0)) {
             if(_coreObjectCombinations[objectType][parentType] == false) {
-                revert ErrorRegistryTypesCombinationInvalid(objectAddress, objectType, parentType);
+                revert ErrorRegistryTypeCombinationInvalid(objectAddress, objectType, parentType);
             }
         }
         // check type combinations for contract objects
         else {
             if(_coreContractCombinations[objectType][parentType] == false) {
-                revert ErrorRegistryTypesCombinationInvalid(objectAddress, objectType, parentType);
+                revert ErrorRegistryTypeCombinationInvalid(objectAddress, objectType, parentType);
             }
         }
 
@@ -283,9 +289,10 @@ contract Registry is
             objectType == ObjectTypeLib.zero() ||
             parentType == ObjectTypeLib.zero() ||
             parentType == PROTOCOL() ||
+            parentType == STAKING() ||
             parentType == SERVICE()
         ) {
-            revert ErrorRegistryTypesCombinationInvalid(info.objectAddress, objectType, parentType);
+            revert ErrorRegistryTypeCombinationInvalid(info.objectAddress, objectType, parentType);
         }
 
         nftId = _register(info);
@@ -293,22 +300,22 @@ contract Registry is
 
 
     /// @dev earliest GIF major version 
-    function getInitialVersion() external view returns (VersionPart) {
+    function getInitialRelease() external view returns (VersionPart) {
         return VersionPartLib.toVersionPart(_releaseRegistry.INITIAL_GIF_VERSION());
     }
 
     /// @dev next GIF release version to be released
-    function getNextVersion() external view returns (VersionPart) {
+    function getNextRelease() external view returns (VersionPart) {
         return _releaseRegistry.getNextVersion();
     }
 
     /// @dev latest active GIF release version 
-    function getLatestVersion() external view returns (VersionPart) { 
+    function getLatestRelease() external view returns (VersionPart) { 
         return _releaseRegistry.getLatestVersion();
     }
 
-    function getReleaseInfo(VersionPart version) external view returns (ReleaseInfo memory) {
-        return _releaseRegistry.getReleaseInfo(version);
+    function getReleaseInfo(VersionPart release) external view returns (IRelease.ReleaseInfo memory) {
+        return _releaseRegistry.getReleaseInfo(release);
     }
 
     function chainIds() public view returns (uint256) {
@@ -355,6 +362,10 @@ contract Registry is
         return _info[nftId];
     }
 
+    function getParentNftId(NftId nftId) external view returns (NftId parentNftId) {
+        return _info[nftId].parentNftId;
+    }
+
     function isObjectType(address contractAddress, ObjectType expectedObjectType) external view returns (bool) {
         NftId nftId = _nftIdByAddress[contractAddress];
         return isObjectType(nftId, expectedObjectType);
@@ -490,7 +501,7 @@ contract Registry is
         _info[nftId] = info;
         _setAddressForNftId(nftId, objectAddress);
 
-        emit LogRegistration(nftId, parentNftId, objectType, isInterceptor, objectAddress, owner);
+        emit LogRegistryObjectRegistered(nftId, parentNftId, objectType, isInterceptor, objectAddress, owner);
 
         // calls nft receiver(1) and interceptor(2)
         uint256 mintedTokenId = CHAIN_NFT.mint(