@etherisc/gif-next 0.0.2-d16f92c-416 → 0.0.2-d1ee1ae-450

package/contracts/product/RiskService.sol

@@ -0,0 +1,157 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IInstance} from "../instance/IInstance.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, COMPONENT, PRODUCT, RISK} from "../type/ObjectType.sol";
+import {ACTIVE, PAUSED, KEEP_STATE} from "../type/StateId.sol";
+import {NftId} from "../type/NftId.sol";
+import {RiskId, RiskIdLib} from "../type/RiskId.sol";
+import {StateId} from "../type/StateId.sol";
+import {RiskSet} from "../instance/RiskSet.sol";
+import {Service} from "../shared/Service.sol";
+import {TimestampLib} from "../type/Timestamp.sol";
+
+contract RiskService is
+    Service,
+    IRiskService 
+{
+
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        initializer
+        virtual override
+    {
+        (
+            address authority,
+            address registry
+        ) = abi.decode(data, (address, address));
+
+        __Service_init(authority, registry, owner);
+        _registerInterface(type(IRiskService).interfaceId);
+    }
+
+    /// @inheritdoc IRiskService
+    function createRisk(
+        bytes32 id,
+        bytes memory data
+    )
+        external 
+        virtual
+        restricted()
+        returns (RiskId riskId)
+    {
+        // checks
+        (NftId productNftId, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
+
+        // effects
+        riskId = RiskIdLib.toRiskId(productNftId, id);
+        IRisk.RiskInfo memory riskInfo = IRisk.RiskInfo({
+            productNftId: productNftId, 
+            createdAt: TimestampLib.blockTimestamp(),
+            data: data});
+
+        instance.getInstanceStore().createRisk(
+            riskId,
+            riskInfo
+        );
+
+        // add risk to RiskSet
+        RiskSet riskSet = instance.getRiskSet();
+        riskSet.add(riskId);
+    }
+
+
+    function updateRisk(
+        RiskId riskId,
+        bytes memory data
+    )
+        external 
+        virtual
+        restricted()
+    {
+        // 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());
+    }
+
+
+    function updateRiskState(
+        RiskId riskId,
+        StateId state
+    )
+        external 
+        virtual
+        restricted()
+    {
+        // checks
+        (NftId productNftId, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
+
+        NftId riskProductNftId = instance.getInstanceReader().getRiskInfo(riskId).productNftId;
+        if (riskProductNftId != productNftId) {
+            revert ErrorRiskServiceRiskProductMismatch(riskId, riskProductNftId, productNftId);
+        }
+
+        // effects
+        instance.getInstanceStore().updateRiskState(riskId, state);
+
+        if (state == ACTIVE()) {
+            instance.getRiskSet().activate(riskId);
+        } else if (state == PAUSED()) {
+            instance.getRiskSet().pause(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);
+    }
+
+
+    function _getDomain() internal pure override returns(ObjectType) {
+        return RISK();
+    }
+}

package/contracts/product/RiskServiceManager.sol

@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
+import {RiskService} from "./RiskService.sol";
+
+contract RiskServiceManager is ProxyManager {
+
+    RiskService private _riskService;
+
+    /// @dev initializes proxy manager with product service implementation 
+    constructor(
+        address authority, 
+        address registry,
+        bytes32 salt
+    ) 
+    {
+        RiskService svc = new RiskService{salt: salt}();
+        bytes memory data = abi.encode(authority, registry);
+        IVersionable versionable = initialize(
+            registry,
+            address(svc), 
+            data,
+            salt);
+
+        _riskService = RiskService(address(versionable));
+    }
+
+    //--- view functions ----------------------------------------------------//
+    function getRiskService()
+        external
+        view
+        returns (RiskService riskService)
+    {
+        return _riskService;
+    }
+
+}

package/contracts/registry/ChainNft.sol

@@ -8,6 +8,8 @@ import {ITransferInterceptor} from "./ITransferInterceptor.sol";
 
 contract ChainNft is ERC721Enumerable {
 
+    event LogTokenInterceptorAddress(uint256 tokenId, address interceptor);
+
     // constants
     string public constant NAME = "Dezentralized Insurance Protocol NFT";
     string public constant SYMBOL = "DIPNFT";
@@ -15,12 +17,11 @@ contract ChainNft is ERC721Enumerable {
     uint256 public constant PROTOCOL_NFT_ID = 1101;
     uint256 public constant GLOBAL_REGISTRY_ID = 2101;
 
-    // TODO rename errors to error pattern: CallerNotRegistry -> ErrorCallerNotRegistry etc.
     // custom errors
-    error CallerNotRegistry(address caller);
-    error RegistryAddressZero();
-    error NftUriEmpty();
-    error NftUriAlreadySet();
+    error ErrorChainNftCallerNotRegistry(address caller);
+    error ErrorChainNftRegistryAddressZero();
+    error ErrorChainNftUriEmpty();
+    error ErrorChainNftUriAlreadySet();
 
     // contract state
 
@@ -34,31 +35,25 @@ contract ChainNft is ERC721Enumerable {
     address private _registry;
 
     // only used for _getNextTokenId
-    uint256 internal _chainIdInt;
     uint256 internal _chainIdDigits;
     uint256 internal _chainIdMultiplier;
     uint256 internal _idNext;
     uint256 internal _totalMinted;
 
     modifier onlyRegistry() {
-        if (msg.sender != _registry) { revert CallerNotRegistry(msg.sender); }
+        if (msg.sender != _registry) { revert ErrorChainNftCallerNotRegistry(msg.sender); }
         _;
     }
 
-    constructor(address registry) ERC721(NAME, SYMBOL) {
-        if (registry == address(0)) { revert RegistryAddressZero(); }
+    constructor(address registry)
+        ERC721(NAME, SYMBOL)
+    {
+        if (registry == address(0)) { revert ErrorChainNftRegistryAddressZero(); }
 
+        // NFT contract is deployed by the registry
         _registry = registry;
-        _chainIdInt = block.chainid;
-        _chainIdDigits = 0;
-
-        // count digis
-        uint256 num = _chainIdInt;
-        while (num != 0) {
-            _chainIdDigits++;
-            num /= 10;
-        }
 
+        _chainIdDigits = _calculateChainIdDigits(block.chainid);
         _chainIdMultiplier = 10 ** _chainIdDigits;
 
         // the first object registered through normal registration starts with id 4
@@ -67,6 +62,7 @@ contract ChainNft is ERC721Enumerable {
         // 3 -> staking
         // >= 4 -> all other objects
         _idNext = 4;
+        _totalMinted = 0;
     }
 
     /**
@@ -74,12 +70,16 @@ contract ChainNft is ERC721Enumerable {
     * not part of the IRegistry interface only needed for
     * initial registry setup (protocol and global registry objects)
     */
-    function mint(address to, uint256 tokenId) external onlyRegistry {
-        _totalMinted++;
-        _safeMint(to, tokenId);
+    function mint(
+        address to, 
+        uint256 tokenId
+    )
+        external
+        onlyRegistry()
+    {
+        _safeMintWithInterceptorAddress(to, tokenId, address(0));
     }
 
-
     /**
     * @dev mints the next token to register new objects
     * non-zero transferInterceptors are recorded and called during nft token transfers.
@@ -89,7 +89,11 @@ contract ChainNft is ERC721Enumerable {
         address to,
         address interceptor,
         string memory uri
-    ) public onlyRegistry returns (uint256 tokenId) {
+    )
+        public
+        onlyRegistry()
+        returns (uint256 tokenId) 
+    {
         tokenId = _getNextTokenId();
 
         if (interceptor != address(0)) {
@@ -100,24 +104,21 @@ contract ChainNft is ERC721Enumerable {
             _uri[tokenId] = uri;
         }
 
-        _totalMinted++;
-        _safeMint(to, tokenId);
-
-        if(interceptor != address(0)) {
-            ITransferInterceptor(interceptor).nftMint(to, tokenId);
-        }
+        _safeMintWithInterceptorAddress(to, tokenId, interceptor);
     }
 
 
     /**
-     * @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 (ERC721, IERC721) {
+    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)) {
-            ITransferInterceptor(_interceptor[tokenId]).nftTransferFrom(from, to, tokenId);
+            address operator = msg.sender;
+            ITransferInterceptor(_interceptor[tokenId]).nftTransferFrom(from, to, tokenId, operator);
         }
     }
 
@@ -132,8 +133,8 @@ contract ChainNft is ERC721Enumerable {
         uint256 tokenId,
         string memory uri
     ) external onlyRegistry {
-        if (bytes(uri).length == 0) { revert NftUriEmpty(); }
-        if (bytes(_uri[tokenId]).length > 0) { revert NftUriAlreadySet(); }
+        if (bytes(uri).length == 0) { revert ErrorChainNftUriEmpty(); }
+        if (bytes(_uri[tokenId]).length > 0) { revert ErrorChainNftUriAlreadySet(); }
 
         _requireOwned(tokenId);
         _uri[tokenId] = uri;
@@ -199,19 +200,50 @@ contract ChainNft is ERC721Enumerable {
     * (42 * 10 ** 10 + 9876543210) * 100 + 10
     * (index * 10 ** digits + chainid) * 100 + digits (1 < digits < 100)
     */
-    function calculateTokenId(uint256 idIndex) public view returns (uint256 id) {
-        id =
-            (idIndex * _chainIdMultiplier + _chainIdInt) *
-            100 +
-            _chainIdDigits;
+    function calculateTokenId(uint256 idIndex, uint256 chainId) public view returns (uint256 id) {
+        if(chainId == block.chainid) {
+            return 100 * (idIndex * _chainIdMultiplier + chainId) + _chainIdDigits;
+        } else {
+            uint256 chainIdDigits = _calculateChainIdDigits(chainId);
+            return 100 * (idIndex * (10 ** chainIdDigits) + chainId) + chainIdDigits;
+        }
+    }
+
+    function calculateTokenId(uint256 idIndex) public view returns (uint256) {
+        return 100 * (idIndex * _chainIdMultiplier + block.chainid) + _chainIdDigits;
     }
 
     function getNextTokenId() external view returns (uint256) {
         return calculateTokenId(_idNext);
     }
 
+    // ---------------- private functions ----------------- //
+
     function _getNextTokenId() private returns (uint256 id) {
         id = calculateTokenId(_idNext);
         _idNext++;
     }
+
+    function _calculateChainIdDigits(uint256 chainId) private pure returns (uint256) {
+        uint256 num = chainId;
+        uint256 digits = 0;
+        while (num != 0) {
+            digits++;
+            num /= 10;
+        }
+        return digits;
+    }
+
+    function _safeMintWithInterceptorAddress(
+        address to,
+        uint256 tokenId,
+        address interceptor
+    )
+        private
+    {        
+        _totalMinted++;
+        _safeMint(to, tokenId);
+
+        emit LogTokenInterceptorAddress(tokenId, interceptor);
+    }
 }

package/contracts/registry/IRegistry.sol

@@ -3,67 +3,94 @@ 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 {RoleId} from "../type/RoleId.sol";
 
-interface IRegistry is IERC165 {
+/// @title Chain Registry interface.
+/// A chain registry holds all protocol relevant objects with basic metadata.
+/// Registered objects include services, instances, products, pools, policies, bundles, stakes and more.
+/// 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
+{
 
     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);
 
-    // registerService()
-    error ErrorRegistryCallerNotReleaseManager();
-    error ErrorRegistryDomainZero(address service);
-    error ErrorRegistryDomainAlreadyRegistered(address service, VersionPart version, ObjectType domain);
+    // initialize
+    error ErrorRegistryCallerNotDeployer();
 
-    // register()
-    error ErrorRegistryCallerNotRegistryService();
+    // registerRegistry()
+    error ErrorRegistryNotOnMainnet(uint256 chainId);
+    error ErrorRegistryChainRegistryChainIdZero(NftId nftId);
+    error ErrorRegistryChainRegistryAddressZero(NftId nftId, uint256 chainId);
+    error ErrorRegistryChainRegistryNftIdInvalid(NftId nftId, uint256 chainId);
+    error ErrorRegistryChainRegistryAlreadyRegistered(NftId nftId, uint256 chainId);
+
+    // 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);
+    error ErrorRegistryServiceDomainAlreadyRegistered(address service, VersionPart version, ObjectType domain);
 
     // registerWithCustomTypes()
     error ErrorRegistryCoreTypeRegistration();
 
     // _register()
-    error ErrorRegistryParentAddressZero();
-    error ErrorRegistryTypesCombinationInvalid(ObjectType objectType, ObjectType parentType);
+    error ErrorRegistryGlobalRegistryAsParent(address objectAddress, ObjectType objectType);
+    error ErrorRegistryTypesCombinationInvalid(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 {
-        VersionPart version;
-        bytes32 salt;
-        address[] addresses;
-        string[] names;
-        RoleId[][] serviceRoles;
-        string[][] serviceRoleNames;
-        RoleId[][] functionRoles;
-        string[][] functionRoleNames;
-        bytes4[][][] selectors;
-        ObjectType[] domains;
-        Timestamp activatedAt;
-        Timestamp disabledAt;
-    }
-
+    /// @dev Registers a registry contract for a specified chain.
+    /// Only one chain registry may be registered per chain
+    function registerRegistry(
+        NftId nftId, 
+        uint256 chainId, 
+        address chainRegistryAddress
+    ) external;
+
+    /// @dev Register a service with using the provided domain and version.
+    /// The function returns a newly minted service NFT ID.
+    /// May only be used to register services.
     function registerService(
         ObjectInfo memory serviceInfo, 
         VersionPart serviceVersion, 
         ObjectType serviceDomain
     ) external returns(NftId nftId);
 
+    /// @dev Register an object with a known core type.
+    /// The function returns a newly minted object NFT ID.
+    /// May not be used to register services.
     function register(ObjectInfo memory info) external returns (NftId nftId);
 
+    /// @dev Register an object with a custom type.
+    /// The function returns a newly minted object NFT ID.
+    /// This function is reserved for GIF releases > 3.
+    /// May not be used to register known core types.
     function registerWithCustomType(ObjectInfo memory info) external returns (NftId nftId);
 
     function getInitialVersion() external view returns (VersionPart);
@@ -72,18 +99,39 @@ interface IRegistry is IERC165 {
 
     function getLatestVersion() 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);
+
+    /// @dev Returns the chain id at the specified index.
+    function getChainId(uint256 idx) external view returns (uint256);
+
+    /// @dev Returns the NFT ID of the registry for the specified chain.
+    function getRegistryNftId(uint256 chainId) external returns (NftId nftId); 
 
     function getObjectCount() external view returns (uint256);
 
-    function getNftId(address objectAddress) external view returns (NftId nftId);
+    function getNftIdForAddress(address objectAddress) external view returns (NftId nftId);
 
     function ownerOf(NftId nftId) external view returns (address);
 
+    function isOwnerOf(NftId nftId, address expectedOwner) external view returns (bool);
+
     function ownerOf(address contractAddress) external view returns (address);
 
     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);
+
+    function getObjectAddress(NftId nftId) external view returns (address objectAddress);
+
+    /// @dev Returns the object info for the specified object address.
+    //  MUST not be used with chain registry address (resides on different chan id)
     function getObjectInfo(address object) external view returns (ObjectInfo memory info);
 
     function isRegistered(NftId nftId) external view returns (bool);
@@ -110,9 +158,7 @@ interface IRegistry is IERC165 {
     // TODO refactor the address getters below to contract getters
     function getChainNftAddress() external view returns (address);
 
-    function getReleaseManagerAddress() external view returns (address);
-
-    function getReleaseAccessManagerAddress(VersionPart version) external view returns (address);
+    function getReleaseRegistryAddress() external view returns (address);
 
     function getStakingAddress() external view returns (address);
 

package/contracts/registry/IRegistryService.sol

@@ -21,10 +21,9 @@ interface IRegistryService is
 
      error ErrorRegistryServiceNotService(address notService);
      error ErrorRegistryServiceNotInstance(address notInstance);
-     error ErrorRegistryServiceNotComponent(address notComponent);
      error ErrorRegistryServiceNotProduct(address notProduct);
-     error ErrorRegistryServiceNotPool(address notPool);
-     error ErrorRegistryServiceNotDistribution(address notDistribution);
+     error ErrorRegistryServiceNotComponent(address notComponent);
+     error ErrorRegistryServiceNotProductLinkedComponent(address notProductLinkedComponent);
 
      error ErrorRegistryServiceRegisterableAddressInvalid(IRegisterable registerable, address found);
      error ErrorRegistryServiceRegisterableTypeInvalid(IRegisterable registerable, ObjectType expected, ObjectType found);
@@ -47,16 +46,10 @@ interface IRegistryService is
      function registerInstance(IRegisterable instance, address owner)
           external returns(IRegistry.ObjectInfo memory info); 
 
-     function registerComponent(IComponent component, ObjectType objectType, address owner)
-          external returns(IRegistry.ObjectInfo memory info);
-
      function registerProduct(IComponent product, address owner)
           external returns(IRegistry.ObjectInfo memory info);
 
-     function registerPool(IComponent pool, address owner)
-          external returns(IRegistry.ObjectInfo memory info);
-
-     function registerDistribution(IComponent distribution, address owner)
+     function registerProductLinkedComponent(IComponent component, ObjectType objectType, address owner)
           external returns(IRegistry.ObjectInfo memory info);
 
      function registerDistributor(IRegistry.ObjectInfo memory info) external returns(NftId nftId);

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/ITransferInterceptor.sol

@@ -2,6 +2,5 @@
 pragma solidity ^0.8.20;
 
 interface ITransferInterceptor {
-    function nftMint(address to, uint256 tokenId) external;
-    function nftTransferFrom(address from, address to, uint256 tokenId) external;
+    function nftTransferFrom(address from, address to, uint256 tokenId, address operator) external;
 }