@etherisc/gif-next 0.0.2-9b434da-265 → 0.0.2-9b4e378-274

package/contracts/registry/ChainNft.sol

@@ -1,19 +1,29 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {ERC721, ERC721Enumerable} from "@openzeppelin5/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
-import {IERC721} from "@openzeppelin5/contracts/token/ERC721/IERC721.sol";
+import {ERC721, ERC721Enumerable} from "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
+import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
 
-import {IChainNft} from "./IChainNft.sol";
 import {ITransferInterceptor} from "./ITransferInterceptor.sol";
 
-contract ChainNft is ERC721Enumerable, IChainNft {
-    string public constant NAME = "Dezentralized Insurance Protocol Registry";
-    string public constant SYMBOL = "DIPR";
+contract ChainNft is ERC721Enumerable {
+
+    // 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;
 
+    // TODO rename errors to error pattern: CallerNotRegistry -> ErrorCallerNotRegistry etc.
+    // custom errors
+    error CallerNotRegistry(address caller);
+    error RegistryAddressZero();
+    error NftUriEmpty();
+    error NftUriAlreadySet();
+
+    // contract state
+
     // remember interceptors
     mapping(uint256 tokenId => address interceptor) private _interceptor;
 
@@ -31,18 +41,31 @@ contract ChainNft is ERC721Enumerable, IChainNft {
     uint256 internal _totalMinted;
 
     modifier onlyRegistry() {
-        require(msg.sender == _registry, "ERROR:NFT-001:CALLER_NOT_REGISTRY");
+        if (msg.sender != _registry) { revert CallerNotRegistry(msg.sender); }
         _;
     }
 
     constructor(address registry) ERC721(NAME, SYMBOL) {
-        require(registry != address(0), "ERROR:NFT-010:REGISTRY_ZERO");
+        if (registry == address(0)) { revert RegistryAddressZero(); }
 
         _registry = registry;
-
         _chainIdInt = block.chainid;
-        _chainIdDigits = _countDigits(_chainIdInt);
+        _chainIdDigits = 0;
+
+        // count digis
+        uint256 num = _chainIdInt;
+        while (num != 0) {
+            _chainIdDigits++;
+            num /= 10;
+        }
+
         _chainIdMultiplier = 10 ** _chainIdDigits;
+
+        // the first object registered through normal registration starts with id 4
+        // 1 -> protocol
+        // 2 -> registry
+        // 3 -> staking
+        // >= 4 -> all other objects
         _idNext = 4;
     }
 
@@ -77,8 +100,12 @@ contract ChainNft is ERC721Enumerable, IChainNft {
             _uri[tokenId] = uri;
         }
 
-        _safeMint(to, tokenId);
         _totalMinted++;
+        _safeMint(to, tokenId);
+
+        if(interceptor != address(0)) {
+            ITransferInterceptor(interceptor).nftMint(to, tokenId);
+        }
     }
 
 
@@ -95,7 +122,7 @@ contract ChainNft is ERC721Enumerable, IChainNft {
     }
 
 
-    function burn(uint256 tokenId) external override onlyRegistry {
+    function burn(uint256 tokenId) external onlyRegistry {
         _requireOwned(tokenId);
         _burn(tokenId);
         delete _uri[tokenId];
@@ -104,29 +131,36 @@ contract ChainNft is ERC721Enumerable, IChainNft {
     function setURI(
         uint256 tokenId,
         string memory uri
-    ) external override onlyRegistry {
-        require(bytes(uri).length > 0, "ERROR:CRG-011:URI_EMPTY");
+    ) external onlyRegistry {
+        if (bytes(uri).length == 0) { revert NftUriEmpty(); }
+        if (bytes(_uri[tokenId]).length > 0) { revert NftUriAlreadySet(); }
 
         _requireOwned(tokenId);
         _uri[tokenId] = uri;
     }
 
-    function exists(uint256 tokenId) external view override returns (bool) {
+    function exists(uint256 tokenId) external view returns (bool) {
         return _ownerOf(tokenId) != address(0);
     }
 
     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 getRegistryAddress() external view override returns (address) {
+    function getInterceptor(uint256 tokenId) external view returns (address) {
+        return _interceptor[tokenId];
+    }
+
+    function getRegistryAddress() external view returns (address) {
         return _registry;
     }
 
-    function totalMinted() external view override returns (uint256) {
+    function totalMinted() external view returns (uint256) {
         return _totalMinted;
     }
 
@@ -172,16 +206,12 @@ contract ChainNft is ERC721Enumerable, IChainNft {
             _chainIdDigits;
     }
 
+    function getNextTokenId() external view returns (uint256) {
+        return calculateTokenId(_idNext);
+    }
+
     function _getNextTokenId() private returns (uint256 id) {
         id = calculateTokenId(_idNext);
         _idNext++;
     }
-
-    function _countDigits(uint256 num) private pure returns (uint256 count) {
-        count = 0;
-        while (num != 0) {
-            count++;
-            num /= 10;
-        }
-    }
 }

package/contracts/registry/IRegistry.sol

@@ -1,20 +1,42 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC165} from "@openzeppelin5/contracts/utils/introspection/IERC165.sol";
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
-import {NftId} from "../types/NftId.sol";
-import {ObjectType} from "../types/ObjectType.sol";
-import {VersionPart} from "../types/Version.sol";
-import {IChainNft} from "./IChainNft.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";
 
+/// @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.
 interface IRegistry is IERC165 {
 
-    event LogRegistration(NftId indexed nftId, NftId parentNftId, ObjectType objectType, bool isInterceptor, address objectAddress, address initialOwner);
+    event LogRegistration(NftId nftId, NftId parentNftId, ObjectType objectType, bool isInterceptor, address objectAddress, address initialOwner);
+    event LogServiceRegistration(VersionPart majorVersion, ObjectType domain);
 
-    event LogServiceNameRegistration(string serviceName, VersionPart majorVersion); 
+    // register()
+    error ErrorRegistryCallerNotRegistryService();
+    error ErrorRegistryService(address service);
 
-    event LogApproval(NftId indexed nftId, ObjectType objectType);
+    // registerService()
+    error ErrorRegistryCallerNotReleaseRegistry();
+    error ErrorRegistryServiceAddressZero(); 
+    error ErrorRegistryServiceVersionZero(); 
+    error ErrorRegistryNotService(address service, ObjectType objectType);
+    error ErrorRegistryServiceParentNotRegistry(NftId parentNftId);
+    error ErrorRegistryDomainZero(address service);
+    error ErrorRegistryDomainAlreadyRegistered(address service, VersionPart version, ObjectType domain);
+
+    // registerWithCustomTypes()
+    error ErrorRegistryCoreTypeRegistration();
+
+    // _register()
+    error ErrorRegistryParentAddressZero();
+    error ErrorRegistryTypesCombinationInvalid(ObjectType objectType, ObjectType parentType);
+    error ErrorRegistryContractAlreadyRegistered(address objectAddress);
 
     struct ObjectInfo {
         NftId nftId;
@@ -24,29 +46,49 @@ interface IRegistry is IERC165 {
         address objectAddress;
         address initialOwner;
         bytes data;
-    }// TODO delete nftId and initialOwner(if not used) from struct
-
+    }
+
+    struct ReleaseInfo {
+        VersionPart version;
+        bytes32 salt;
+        address[] addresses;
+        string[] names;
+        ObjectType[] domains;
+        Timestamp activatedAt;
+        Timestamp disabledAt;
+    }
+
+    /// @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);
-    
-    function registerFrom(
-        address from, 
-        ObjectInfo memory info
-    ) external returns (NftId nftId);
-
-    function approve(
-        NftId registrar,
-        ObjectType object,
-        ObjectType parent
-    ) external;
-
-    function allowance(
-        NftId registrar,
-        ObjectType object
-    ) external view returns (bool);
+
+    /// @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 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);
+
+    function getNextVersion() external view returns (VersionPart);
+
+    function getLatestVersion() external view returns (VersionPart);
+
+    function getReleaseInfo(VersionPart version) external view returns (ReleaseInfo memory);
 
     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);
 
@@ -60,14 +102,33 @@ interface IRegistry is IERC165 {
 
     function isRegistered(address contractAddress) external view returns (bool);
 
-    function getServiceName(NftId nftId) external view returns (string memory name);
+    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(
-        string memory serviceName, 
-        VersionPart majorVersion
+        ObjectType serviceDomain, 
+        VersionPart releaseVersion
     ) external view returns (address serviceAddress);
 
-    function getChainNft() external view returns (IChainNft);
+    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 getReleaseRegistryAddress() external view returns (address);
+
+    function getStakingAddress() external view returns (address);
+
+    function getTokenRegistryAddress() external view returns (address);
+
+    function getRegistryAdminAddress() external view returns (address);
+
+    function getAuthority() external view returns (address);
 }

package/contracts/registry/IRegistryService.sol

@@ -1,29 +1,69 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {NftId} from "../../contracts/types/NftId.sol";
-import {ObjectType} from "../../contracts/types/ObjectType.sol";
-import {RoleId} from "../../contracts/types/RoleId.sol";
-import {IService} from "../../contracts/instance/base/IService.sol";
-import {IRegistry} from "../../contracts/registry/IRegistry.sol";
+// import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
-import {IRegisterable} from "../../contracts/shared/IRegisterable.sol";
-import {IBaseComponent} from "../../contracts/components/IBaseComponent.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";
 
-interface IRegistryService is IService {
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IComponent} from "../shared/IComponent.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 
-    function registerToken(address tokenAddress) external returns(NftId nftId);
 
-    function registerService(IService service)  external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+interface IRegistryService is 
+     IService
+{
+     error ErrorRegistryServiceNotRegistryOwner();
 
-    function registerComponent(IBaseComponent component, ObjectType componentType, address owner) 
-        external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+     error ErrorRegistryServiceNotService(address notService);
+     error ErrorRegistryServiceNotInstance(address notInstance);
+     error ErrorRegistryServiceNotComponent(address notComponent);
+     error ErrorRegistryServiceNotProduct(address notProduct);
+     error ErrorRegistryServiceNotPool(address notPool);
+     error ErrorRegistryServiceNotDistribution(address notDistribution);
 
-    function registerInstance(IRegisterable instance)
-        external returns(IRegistry.ObjectInfo memory info, bytes memory data); 
+     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);
 
-    function registerPolicy(IRegistry.ObjectInfo memory info) external returns(NftId nftId); // -> easy to upgrade
+     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 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)
+     //      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); 
 
-    function registerBundle(IRegistry.ObjectInfo memory info) external returns(NftId nftId); 
 }
 

package/contracts/registry/ITransferInterceptor.sol

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