@etherisc/gif-next 0.0.2-ffba655 → 3.0.0-06d5e8b-738

package/contracts/registry/ChainNft.sol

@@ -1,15 +1,32 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {ERC721, ERC721Enumerable} from "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
-import {IChainNft} from "./IChainNft.sol";
+import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
 
-contract ChainNft is
-    ERC721Enumerable,
-    IChainNft
-{
-    string public constant NAME = "Dezentralized Insurance Protocol Registry";
-    string public constant SYMBOL = "DIPR";
+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";
+
+    uint256 public constant PROTOCOL_NFT_ID = 1101;
+    uint256 public constant GLOBAL_REGISTRY_ID = 2101;
+
+    // custom errors
+    error ErrorChainNftCallerNotRegistry(address caller);
+    error ErrorChainNftRegistryAddressZero();
+    error ErrorChainNftUriEmpty();
+    error ErrorChainNftUriAlreadySet();
+
+    // contract state
+
+    // remember interceptors
+    mapping(uint256 tokenId => address interceptor) private _interceptor;
 
     // remember token uri
     mapping(uint256 tokenId => string uri) private _uri;
@@ -18,156 +35,215 @@ contract ChainNft is
     address private _registry;
 
     // only used for _getNextTokenId
-    uint256 internal _chainIdInt; 
     uint256 internal _chainIdDigits;
     uint256 internal _chainIdMultiplier;
     uint256 internal _idNext;
     uint256 internal _totalMinted;
 
-
     modifier onlyRegistry() {
-        require(msg.sender == _registry, "ERROR:NFT-001:CALLER_NOT_REGISTRY");
+        if (msg.sender != _registry) { revert ErrorChainNftCallerNotRegistry(msg.sender); }
         _;
     }
 
-
     constructor(address registry)
         ERC721(NAME, SYMBOL)
     {
-        require(registry != address(0), "ERROR:NFT-010:REGISTRY_ZERO");
+        if (registry == address(0)) { revert ErrorChainNftRegistryAddressZero(); }
 
+        // NFT contract is deployed by the registry
         _registry = registry;
 
-        _chainIdInt = block.chainid;
-        _chainIdDigits = _countDigits(_chainIdInt);
+        _chainIdDigits = _calculateChainIdDigits(block.chainid);
         _chainIdMultiplier = 10 ** _chainIdDigits;
 
-        // on mainnet/goerli start /1 (reserved for protocol nft) on other chains with 2
-        if(block.chainid == 1 || block.chainid == 5) {
-            _idNext = 1;
-        } else {
-            _idNext = 2;
-        }
+        // the first object registered through normal registration starts with id 4
+        // 1 -> protocol
+        // 2 -> registry
+        // 3 -> staking
+        // >= 4 -> all other objects
+        _idNext = 4;
+        _totalMinted = 0;
     }
 
+    /**
+    * @dev mints a token for a specified token id
+    * 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()
+    {
+        _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.
+    * the contract receiving such a notification may decides to revert or record the transfer
+    */
     function mint(
         address to,
+        address interceptor,
         string memory uri
     )
-        external
-        override
-        onlyRegistry
-        returns(uint256 tokenId)
+        public
+        onlyRegistry()
+        returns (uint256 tokenId) 
     {
         tokenId = _getNextTokenId();
-        _totalMinted++;
 
-        _safeMint(to, tokenId);
+        if (interceptor != address(0)) {
+            _interceptor[tokenId] = interceptor;
+        }
 
-        if(bytes(uri).length > 0) {
+        if (bytes(uri).length > 0) {
             _uri[tokenId] = uri;
         }
+
+        _safeMintWithInterceptorAddress(to, tokenId, interceptor);
     }
 
 
-    function burn(uint256 tokenId)
-        external
-        override
-        onlyRegistry
-    {
-        _requireMinted(tokenId);
+    /**
+     * @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)) {
+            address operator = msg.sender;
+            ITransferInterceptor(_interceptor[tokenId]).nftTransferFrom(from, to, tokenId, operator);
+        }
+    }
+
+
+    function burn(uint256 tokenId) external onlyRegistry {
+        _requireOwned(tokenId);
         _burn(tokenId);
         delete _uri[tokenId];
     }
 
+    function setURI(
+        uint256 tokenId,
+        string memory uri
+    ) external onlyRegistry {
+        if (bytes(uri).length == 0) { revert ErrorChainNftUriEmpty(); }
+        if (bytes(_uri[tokenId]).length > 0) { revert ErrorChainNftUriAlreadySet(); }
 
-    function setURI(uint256 tokenId, string memory uri)
-        external
-        override
-        onlyRegistry
-    {
-        require(bytes(uri).length > 0, "ERROR:CRG-011:URI_EMPTY");
-
-        _requireMinted(tokenId);
+        _requireOwned(tokenId);
         _uri[tokenId] = uri;
     }
 
-
-    function exists(uint256 tokenId)
-        external
-        view
-        override
-        returns(bool)
-    {
-        return _exists(tokenId);
+    function exists(uint256 tokenId) external view returns (bool) {
+        return _ownerOf(tokenId) != address(0);
     }
 
-
-    function tokenURI(uint256 tokenId)
-        public
-        view
-        override 
-        returns(string memory)
-    {
-        _requireMinted(tokenId);
+    function tokenURI(
+        uint256 tokenId
+    ) public view override returns (string memory) {
+        // gif generally does not revert for view functions
+        // this is an exception to keep the openzeppelin nft semantics
+        _requireOwned(tokenId);
         return _uri[tokenId];
     }
 
+    function getInterceptor(uint256 tokenId) external view returns (address) {
+        return _interceptor[tokenId];
+    }
 
-    function getRegistryAddress()
-        external
-        view
-        override
-        returns(address)
-    {
+    function getRegistryAddress() external view returns (address) {
         return _registry;
     }
 
-    function totalMinted() external override view returns(uint256) {
+    function totalMinted() external view returns (uint256) {
         return _totalMinted;
     }
 
-    // requirement: each chain registry produces token ids that
-    // are guaranteed to not collide with any token id genereated
-    // on a different chain
-    //
-    // format concat(counter,chainid,2 digits for len-of-chain-id)
-    // restriction chainid up to 99 digits
-    // decode: from right to left:
-    // - 2 right most digits encode length of chainid
-    // - move number of digits to left as determined above (-> chainid)
-    // - the reminder to the left is the counter
-    // examples
-    // 1101
-    // ^^ ^
-    // || +- 1-digit chain id
-    // |+-- chain id = 1 (mainnet)
-    // +-- 1st token id on mainnet
-    // (1 * 10 ** 1 + 1) * 100 + 1
-    // 42987654321010
-    // ^ ^          ^
-    // | |          +- 10-digit chain id
-    // | +-- chain id = 9876543210 (hypothetical chainid)
-    // +-- 42nd token id on this chain
-    // (42 * 10 ** 10 + 9876543210) * 100 + 10
-    // (index * 10 ** digits + chainid) * 100 + digits (1 < digits < 100)
-
-    function _getNextTokenId() private returns(uint256 id) {
-        id = (_idNext * _chainIdMultiplier + _chainIdInt) * 100 + _chainIdDigits;
-        _idNext++;
+    /**
+    * @dev token id calculation based on an index value that is supposed
+    * to increase with every minted token
+    *
+    * requirement: each chain registry produces token ids that
+    * are guaranteed to not collide with any token id genereated
+    * on a different chain
+    *
+    * format concat(counter,chainid,2 digits for len-of-chain-id)
+    * restriction chainid up to 99 digits
+    * decode: from right to left:
+    * - 2 right most digits encode length of chainid
+    * - move number of digits to left as determined above (-> chainid)
+    * - the reminder to the left is the counter
+    *
+    * special cases
+    * 1101 -> decentralized insurance protocol
+    * 2102 -> global registry
+    * 2xxxxx -> chain registry, where xxxxx = <chain-part> 
+    *
+    * examples
+    * 1101
+    * ^^ ^
+    * || +- 1-digit chain id
+    * |+-- chain id = 1 (mainnet)
+    * +-- 1st token id on mainnet
+    * (1 * 10 ** 1 + 1) * 100 + 1
+    * 42987654321010
+    * ^ ^          ^
+    * | |          +- 10-digit chain id
+    * | +-- chain id = 9876543210 (hypothetical chainid)
+    * +-- 42nd token id on this chain
+    * (42 * 10 ** 10 + 9876543210) * 100 + 10
+    * (index * 10 ** digits + chainid) * 100 + digits (1 < digits < 100)
+    */
+    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 _countDigits(uint256 num)
-        private 
-        pure 
-        returns (uint256 count)
-    {
-        count = 0;
+    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) {
-            count++;
+            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

@@ -1,70 +1,172 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {NftId} from "../types/NftId.sol";
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
-interface IOwnable {
-    function getOwner() external view returns(address owner);
-}
+import {IRelease} from "./IRelease.sol";
 
-interface IRegistryLinked {
+import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {VersionPart} from "../type/Version.sol";
 
-    event LogDebug(uint256 idx, address module, string comment);
+/// @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
+{
 
-    function getRegistry() external view returns(IRegistry registry);
-}
+    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);
 
-interface IRegisterable is 
-    IOwnable,
-    IRegistryLinked
-{
+    // initialize
+    error ErrorRegistryCallerNotDeployer();
+
+    // register()
+    error ErrorRegistryObjectTypeNotSupported(ObjectType objectType);
 
-    function register() external returns(NftId nftId);
-    
-    function getNftId() external view returns(NftId nftId);
-    function getParentNftId() external view returns(NftId parentNftId);
-    function getType() external view returns(uint256 objectType);
-    function getData() external view returns(bytes memory data);
-    function isRegisterable() external pure returns(bool);
-    function getInitialOwner() external view returns(address initialOwner);
+    // 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);
 
-    function isRegistered() external view returns(bool);
-}
+    // registerService()
+    error ErrorRegistryServiceAddressZero(); 
+    error ErrorRegistryServiceVersionZero(address service);
 
+    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);
 
-interface IRegistry {
+    // registerWithCustomTypes()
+    error ErrorRegistryCoreTypeRegistration();
 
-    struct RegistryInfo {
+    // _register()
+    error ErrorRegistryGlobalRegistryAsParent(address objectAddress, ObjectType objectType);
+    error ErrorRegistryTypeCombinationInvalid(address objectAddress, ObjectType objectType, ObjectType parentType);
+    error ErrorRegistryContractAlreadyRegistered(address objectAddress);
+
+    struct ObjectInfo {
+        // slot 0
         NftId nftId;
         NftId parentNftId;
-        uint256 objectType;
+        ObjectType objectType;
+        bool isInterceptor;
+        // slot 1
         address objectAddress;
+        // slot 2
         address initialOwner;
+        // slot 3
+        bytes data;
     }
 
-    function TOKEN() external pure returns(uint256);
-    function INSTANCE() external pure returns(uint256);
-    function PRODUCT() external pure returns(uint256);
-    function ORACLE() external pure returns(uint256);
-    function POOL() external pure returns(uint256);
-    function POLICY() external pure returns(uint256);
-    function BUNDLE() external pure returns(uint256);
+    /// @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 getInitialRelease() external view returns (VersionPart);
+
+    function getNextRelease() external view returns (VersionPart);
+
+    function getLatestRelease() external view returns (VersionPart);
+
+    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 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);
+
+    function isRegistered(address contractAddress) external view returns (bool);
+
+    function isRegisteredService(address contractAddress) external view returns (bool);
+
+    function isRegisteredComponent(address object) external view returns (bool);
+
+    function isActiveRelease(VersionPart version) external view returns (bool);
+
+    function getServiceAddress(
+        ObjectType serviceDomain, 
+        VersionPart releaseVersion
+    ) external view returns (address serviceAddress);
+
+    function getProtocolNftId() external view returns (NftId protocolNftId);
+
+    function getNftId() external view returns (NftId nftId);
+
+    function getOwner() external view returns (address);
+
+    // TODO refactor the address getters below to contract getters
+    function getChainNftAddress() external view returns (address);
 
-    function register(address objectAddress) external returns(NftId nftId);
-    function registerObjectForInstance(
-        NftId parentNftid,
-        uint256 objectType,
-        address initialOwner
-    )
-        external returns(NftId nftId);
+    function getReleaseRegistryAddress() external view returns (address);
 
-    function getObjectCount() external view returns(uint256);
+    function getStakingAddress() external view returns (address);
 
-    function getNftId(address objectAddress) external view returns(NftId nftId);
-    function getInfo(NftId nftId) external view returns(RegistryInfo memory info);
-    function getOwner(NftId nftId) external view returns(address ownerAddress);
+    function getTokenRegistryAddress() external view returns (address);
 
-    function isRegistered(address objectAddress) external view returns(bool);
+    function getRegistryAdminAddress() external view returns (address);
 
-    function getNftAddress() external view returns(address nft);
-}
+    function getAuthority() external view returns (address);
+}

package/contracts/registry/IRegistryService.sol

@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+// import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+
+import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {RoleId} from "../type/RoleId.sol";
+import {IService} from "../shared/IService.sol";
+import {IRegistry} from "./IRegistry.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IComponent} from "../shared/IComponent.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+
+
+interface IRegistryService is 
+     IService
+{
+     error ErrorRegistryServiceNotRegistryOwner();
+
+     error ErrorRegistryServiceNotService(address notService);
+     error ErrorRegistryServiceNotInstance(address notInstance);
+     error ErrorRegistryServiceNotProduct(address notProduct);
+     error ErrorRegistryServiceNotComponent(address notComponent);
+     error ErrorRegistryServiceNotProductLinkedComponent(address notProductLinkedComponent);
+
+     error ErrorRegistryServiceRegisterableAddressInvalid(IRegisterable registerable, address found);
+     error ErrorRegistryServiceRegisterableTypeInvalid(IRegisterable registerable, ObjectType expected, ObjectType found);
+     error ErrorRegistryServiceRegisterableOwnerInvalid(IRegisterable registerable, address expected, address found);
+     error ErrorRegistryServiceRegisterableOwnerZero(IRegisterable registerable);   
+     error ErrorRegistryServiceRegisterableOwnerRegistered(IRegisterable registerable, address owner);
+     error ErrorRegistryServiceRegisterableSelfRegistration(IRegisterable registerable);
+
+     error ErrorRegistryServiceObjectAddressNotZero(ObjectType objectType);
+     error ErrorRegistryServiceObjectTypeInvalid(ObjectType expected, ObjectType found);
+     error ErrorRegistryServiceObjectOwnerRegistered(ObjectType objectType, address owner);
+     error ErrorRegistryServiceObjectOwnerZero(ObjectType objectType);
+
+     error ErrorRegistryServiceInvalidInitialOwner(address initialOwner);
+     error ErrorRegistryServiceInvalidAddress(address registerableAddress);
+
+     function registerStake(IRegistry.ObjectInfo memory info)
+          external returns(NftId nftId); 
+
+     function registerInstance(IRegisterable instance, address owner)
+          external returns(IRegistry.ObjectInfo memory info); 
+
+     function registerProduct(IComponent product, address owner)
+          external returns(IRegistry.ObjectInfo memory info);
+
+     function registerProductLinkedComponent(IComponent component, ObjectType objectType, address owner)
+          external returns(IRegistry.ObjectInfo memory info);
+
+     function registerDistributor(IRegistry.ObjectInfo memory info) external returns(NftId nftId);
+
+     function registerPolicy(IRegistry.ObjectInfo memory info) external returns(NftId nftId);
+
+     function registerBundle(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

@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+interface ITransferInterceptor {
+    function nftTransferFrom(address from, address to, uint256 tokenId, address operator) external;
+}