@etherisc/gif-next 0.0.2-e1e92ab-754 → 0.0.2-e2d8c7d-942

package/contracts/registry/ChainNft.sol

@@ -4,16 +4,25 @@ pragma solidity ^0.8.20;
 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;
 
+    // custom errors
+    error CallerNotRegistry(address caller);
+    error RegistryAddressZero();
+    error NftUriEmpty();
+    error NftUriAlreadySet();
+
+    // contract state
+
     // remember interceptors
     mapping(uint256 tokenId => address interceptor) private _interceptor;
 
@@ -31,17 +40,24 @@ 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;
         _idNext = 4;
     }
@@ -77,8 +93,8 @@ contract ChainNft is ERC721Enumerable, IChainNft {
             _uri[tokenId] = uri;
         }
 
-        _safeMint(to, tokenId);
         _totalMinted++;
+        _safeMint(to, tokenId);
     }
 
 
@@ -95,7 +111,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 +120,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;
     }
 
@@ -176,12 +199,4 @@ contract ChainNft is ERC721Enumerable, IChainNft {
         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

@@ -3,17 +3,29 @@ pragma solidity ^0.8.20;
 
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
+import {ChainNft} from "./ChainNft.sol";
 import {NftId} from "../types/NftId.sol";
 import {ObjectType} from "../types/ObjectType.sol";
 import {VersionPart} from "../types/Version.sol";
-import {IChainNft} from "./IChainNft.sol";
 
 interface IRegistry is IERC165 {
 
+    event LogInitialMajorVersionSet(VersionPart majorVersion);
+    event LogMajorVersionSet(VersionPart majorVersionMax);
     event LogRegistration(ObjectInfo info);
-
     event LogServiceNameRegistration(string serviceName, VersionPart majorVersion); 
 
+    // setMajorVersion()
+    error NotOwner(address account);
+    error MajorVersionMaxIncreaseInvalid(VersionPart newMajorVersionMax, VersionPart existingMaxMajorVersion);
+
+    // register()
+    error NotRegistryService();
+    error ZeroParentAddress();
+    error InvalidTypesCombination(ObjectType objectType, ObjectType parentType);
+    error ContractAlreadyRegistered(address objectAddress);
+    error InvalidServiceVersion(VersionPart majorVersion);
+    error ServiceNameAlreadyRegistered(string name, VersionPart majorVersion);
 
     struct ObjectInfo {
         NftId nftId;
@@ -24,12 +36,22 @@ interface IRegistry is IERC165 {
         address initialOwner;
         bytes data;
     }// TODO delete nftId and initialOwner(if not used) from struct
+    // TODO strong disagree, keep nftId there (lets keep get object info return object consistent)
+
+    function setMajorVersion(VersionPart newMajorVersionMax) external;
 
     function register(ObjectInfo memory info) external returns (NftId nftId);
-    
+
+    function getMajorVersionMin() external view returns (VersionPart);
+
+    function getMajorVersionMax() external view returns (VersionPart);
+
+    function getMajorVersion() external view returns (VersionPart);
 
     function getObjectCount() external view returns (uint256);
 
+    function getNftId() external view returns (NftId nftId);
+
     function getNftId(address objectAddress) external view returns (NftId nftId);
 
     function ownerOf(NftId nftId) external view returns (address);
@@ -44,6 +66,8 @@ interface IRegistry is IERC165 {
 
     function isRegistered(address contractAddress) external view returns (bool);
 
+    function isRegisteredService(address contractAddress) external view returns (bool);
+
     function getServiceName(NftId nftId) external view returns (string memory name);
 
     function getServiceAddress(
@@ -51,7 +75,7 @@ interface IRegistry is IERC165 {
         VersionPart majorVersion
     ) external view returns (address serviceAddress);
 
-    function getChainNft() external view returns (IChainNft);
+    function getChainNft() external view returns (ChainNft);
 
     function getOwner() external view returns (address);
 }

package/contracts/registry/IRegistryService.sol

@@ -1,35 +1,50 @@
 // 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 {NftId} from "../types/NftId.sol";
+import {ObjectType} from "../types/ObjectType.sol";
+import {RoleId} from "../types/RoleId.sol";
+import {IService} from "../shared/IService.sol";
+import {IRegistry} from "./IRegistry.sol";
 
-import {IRegisterable} from "../../contracts/shared/IRegisterable.sol";
-import {IBaseComponent} from "../../contracts/components/IBaseComponent.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IBaseComponent} from "../components/IBaseComponent.sol";
 
 interface IRegistryService is IService {
 
-    function registerToken(address tokenAddress) external returns(NftId nftId);
+     error SelfRegistration();
+     error NotRegistryOwner();
 
-    function registerService(IService service)  external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+     error NotService();
+     error NotInstance();
+     error NotProduct();
+     error NotPool();
+     error NotDistribution();
 
-    function registerInstance(IRegisterable instance)
-        external returns(IRegistry.ObjectInfo memory info, bytes memory data); 
+     error UnexpectedRegisterableType(ObjectType expected, ObjectType found);
+     error NotRegisterableOwner(address expectedOwner);
+     error RegisterableOwnerIsZero();   
+     error RegisterableOwnerIsRegistered();
+     error InvalidInitialOwner(address initialOwner);
+     error InvalidAddress(address registerableAddress);
 
-    function registerProduct(IBaseComponent product, address owner)
-         external returns(IRegistry.ObjectInfo memory info, bytes memory data);
 
-    function registerPool(IBaseComponent pool, address owner)
-         external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+     function registerService(IService service)  external returns(IRegistry.ObjectInfo memory info, bytes memory data);
 
-    function registerDistribution(IBaseComponent distribution, address owner)
-         external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+     function registerInstance(IRegisterable instance)
+          external returns(IRegistry.ObjectInfo memory info, bytes memory data); 
 
-    function registerPolicy(IRegistry.ObjectInfo memory info) external returns(NftId nftId); // -> easy to upgrade
+     function registerProduct(IBaseComponent product, address owner)
+          external returns(IRegistry.ObjectInfo memory info, bytes memory data);
 
-    function registerBundle(IRegistry.ObjectInfo memory info) external returns(NftId nftId); 
+     function registerPool(IBaseComponent pool, address owner)
+          external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+
+     function registerDistribution(IBaseComponent distribution, address owner)
+          external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+
+     function registerPolicy(IRegistry.ObjectInfo memory info) external returns(NftId nftId); // -> easy to upgrade
+
+     function registerBundle(IRegistry.ObjectInfo memory info) external returns(NftId nftId); 
 }
 

package/contracts/registry/Registry.sol

@@ -2,13 +2,12 @@
 pragma solidity ^0.8.20;
 
 import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IService} from "../instance/base/IService.sol";
+import {IService} from "../shared/IService.sol";
 
-import {IChainNft} from "./IChainNft.sol";
 import {ChainNft} from "./ChainNft.sol";
 import {IRegistry} from "./IRegistry.sol";
 import {NftId, toNftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
-import {Version, VersionPart, VersionLib} from "../types/Version.sol";
+import {Version, VersionPart, VersionLib, VersionPartLib} from "../types/Version.sol";
 import {ObjectType, PROTOCOL, REGISTRY, TOKEN, SERVICE, INSTANCE, STAKE, PRODUCT, DISTRIBUTION, ORACLE, POOL, POLICY, BUNDLE} from "../types/ObjectType.sol";
 import {ITransferInterceptor} from "./ITransferInterceptor.sol";
 
@@ -29,55 +28,40 @@ contract Registry is
     ERC165,
     IRegistry
 {
-    // register
-    error NotRegistryService();
-    error ZeroParentAddress();
-    error ContractAlreadyRegistered(address objectAddress);
-    error InvalidServiceVersion(VersionPart majorVersion);
-    error ServiceNameAlreadyRegistered(string name, VersionPart majorVersion);
-            
-    // approve
-    error NotOwner();
-    error NotRegisteredContract(NftId registrarNftId);
-    error NotService(NftId registrarNftId);
-    error InvalidTypesCombination(ObjectType objectType, ObjectType parentType);
-
-    uint256 public constant MAJOR_VERSION_MIN = 3;
+    uint256 public constant GIF_MAJOR_VERSION_AT_DEPLOYMENT = 3;
     address public constant NFT_LOCK_ADDRESS = address(0x1);
+    uint256 public constant REGISTRY_TOKEN_SEQUENCE_ID = 2;
     uint256 public constant REGISTRY_SERVICE_TOKEN_SEQUENCE_ID = 3;
     string public constant EMPTY_URI = "";
 
-    mapping(NftId nftId => ObjectInfo info) _info;
-    mapping(address object => NftId nftId) _nftIdByAddress;
+    VersionPart internal _majorVersion;
 
-    mapping(NftId registrator => mapping(
-            ObjectType objectType => bool)) _isApproved;
+    mapping(NftId nftId => ObjectInfo info) internal _info;
+    mapping(address object => NftId nftId) internal _nftIdByAddress;
 
     mapping(ObjectType objectType => mapping(
-            ObjectType parentType => bool)) _isValidContractCombination;
+            ObjectType parentType => bool)) internal _isValidContractCombination;
 
     mapping(ObjectType objectType => mapping(
-            ObjectType parentType => bool)) _isValidObjectCombination;
+            ObjectType parentType => bool)) internal _isValidObjectCombination;
 
-    mapping(NftId nftId => string name) _string;
+    mapping(NftId nftId => string name) internal _string;
     mapping(bytes32 serviceNameHash => mapping(
-            VersionPart majorVersion => address service)) _service;
+            VersionPart majorVersion => address service)) internal _service;
 
-    NftId _registryNftId;
-    NftId _serviceNftId; // set in stone upon registry creation
-    IChainNft _chainNft;
-    ChainNft _chainNftInternal;
+    NftId internal _registryNftId;
+    NftId internal _serviceNftId; // set in stone upon registry creation
+    ChainNft internal _chainNft;
 
 
     modifier onlyOwner() {
         if(msg.sender != getOwner()) {
-            revert NotOwner();
+            revert NotOwner(msg.sender);
         }
         _;
     }
 
     modifier onlyRegistryService() {
-        
         if(msg.sender != _info[_serviceNftId].objectAddress) {
             revert NotRegistryService();
         }
@@ -87,11 +71,13 @@ contract Registry is
     constructor(address registryOwner, VersionPart majorVersion)
     {
         require(registryOwner > address(0), "Registry: registry owner is 0");
-        require(majorVersion.toInt() == MAJOR_VERSION_MIN, "Registry: initial major version of registry service is not MAJOR_VERSION_MIN");
+
+        // major version at constructor time
+        _majorVersion = VersionLib.toVersionPart(GIF_MAJOR_VERSION_AT_DEPLOYMENT);
+        emit LogInitialMajorVersionSet(_majorVersion);
 
         // deploy NFT 
-        _chainNftInternal = new ChainNft(address(this));// adds 10kb to deployment size
-        _chainNft = IChainNft(_chainNftInternal);
+        _chainNft = new ChainNft(address(this));// adds 10kb to deployment size
 
         // initial registry setup
         _registerProtocol();
@@ -104,6 +90,24 @@ contract Registry is
         _registerInterface(type(IRegistry).interfaceId);
     }
 
+    // from IRegistry
+
+    /// @dev latest GIF release version 
+    function setMajorVersion(VersionPart newMajorVersion)
+        external
+        onlyOwner
+    {
+        // ensure major version increments is one
+        uint256 oldMax = _majorVersion.toInt();
+        uint256 newMax = newMajorVersion.toInt();
+        if (newMax <= oldMax || newMax - oldMax != 1) {
+            revert MajorVersionMaxIncreaseInvalid(newMajorVersion, _majorVersion);
+        }
+
+        _majorVersion = newMajorVersion;
+        emit LogMajorVersionSet(_majorVersion);
+    }
+
     /// @dev registry protects only against tampering existing records, registering with invalid types pairs and 0 parent address
     // TODO service registration means its approval for some type?
     // TODO registration of precompile addresses
@@ -171,13 +175,35 @@ contract Registry is
 
         emit LogRegistration(info);
     }
+    /// @dev earliest GIF major version 
+    function getMajorVersionMin() external view returns (VersionPart) {
+        return VersionLib.toVersionPart(GIF_MAJOR_VERSION_AT_DEPLOYMENT);
+    }
+
+    // TODO make distinction between active an not yet active version
+    // need to be thought trough, not yet clear if necessary
+    // need to answer question: what is the latest version during the upgrade process?
+    // likely setting up a new gif version does not fit into a single tx
+    // in this case we might want to have a period where the latest version is
+    // in the process of being set up while the latest active version is 1 major release smaller
+    /// @dev latest GIF major version (might not yet be active)
+    function getMajorVersionMax() external view returns (VersionPart) {
+        return _majorVersion;
+    }
+
+    /// @dev latest active GIF release version 
+    function getMajorVersion() external view returns (VersionPart) { 
+        return _majorVersion;
+    }
 
-    // from IRegistry
     function getObjectCount() external view override returns (uint256) {
-        
         return _chainNft.totalSupply();
     }
 
+    function getNftId() external view returns (NftId nftId) {
+        return _registryNftId;
+    }
+
     function getNftId(address object) external view override returns (NftId id) {
         return _nftIdByAddress[object];
     }
@@ -187,7 +213,6 @@ contract Registry is
     }
 
     function ownerOf(address contractAddress) public view returns (address) {
-        
         return _chainNft.ownerOf(_nftIdByAddress[contractAddress].toInt());
     }
 
@@ -196,7 +221,6 @@ contract Registry is
     }
 
     function getObjectInfo(address object) external view override returns (ObjectInfo memory) {
-        
         return _info[_nftIdByAddress[object]];
     }
 
@@ -208,6 +232,10 @@ contract Registry is
         return _nftIdByAddress[object].gtz();
     }
 
+    function isRegisteredService(address object) external view override returns (bool) {
+        return _nftIdByAddress[object].gtz() && _info[_nftIdByAddress[object]].objectType == SERVICE();
+    }
+
     function getServiceName(NftId nftId) external view returns (string memory) {
         return _string[nftId];
     }
@@ -222,7 +250,7 @@ contract Registry is
         return _service[serviceNameHash][majorVersion];
     }
 
-    function getChainNft() external view override returns (IChainNft) {
+    function getChainNft() external view override returns (ChainNft) {
         return _chainNft;
     }
 
@@ -241,14 +269,8 @@ contract Registry is
         ) = abi.decode(info.data, (string, VersionPart));
         bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
 
-        // TODO MUST guarantee consistency of service.getVersion() and majorVersion here
-        // TODO update _serviceNftId when registryService with new major version is registered? -> it is fixed in current setup -> can lock up
-        // TODO do not use names -> each object type is registered by corresponding service -> conflicting with approve()
-        if(
-            majorVersion.toInt() < MAJOR_VERSION_MIN ||
-            (majorVersion.toInt() > MAJOR_VERSION_MIN &&
-            _service[serviceNameHash][VersionLib.toVersionPart(majorVersion.toInt() - 1)] == address(0) )
-        ) {
+        // ensures consistency of service.getVersion() and majorVersion here
+        if(majorVersion != _majorVersion) {
             revert InvalidServiceVersion(majorVersion);
         }
         
@@ -294,10 +316,10 @@ contract Registry is
     function _registerProtocol() 
         internal
     {
-        uint256 protocolId = _chainNftInternal.PROTOCOL_NFT_ID();
+        uint256 protocolId = _chainNft.PROTOCOL_NFT_ID();
         NftId protocolNftId = toNftId(protocolId);
 
-        _chainNftInternal.mint(NFT_LOCK_ADDRESS, protocolId);
+        _chainNft.mint(NFT_LOCK_ADDRESS, protocolId);
 
         _info[protocolNftId] = ObjectInfo(
             protocolNftId,
@@ -315,22 +337,22 @@ contract Registry is
     function _registerRegistry(address registryOwner) 
         internal
     {
-        uint256 registryId = _chainNftInternal.calculateTokenId(2);
+        uint256 registryId = _chainNft.calculateTokenId(REGISTRY_TOKEN_SEQUENCE_ID);
         NftId registryNftId = toNftId(registryId);
 
         NftId parentNftId;
 
-        if(registryId != _chainNftInternal.GLOBAL_REGISTRY_ID()) 
+        if(registryId != _chainNft.GLOBAL_REGISTRY_ID()) 
         {// we're not the global registry
             _registerGlobalRegistry();
-            parentNftId = toNftId(_chainNftInternal.GLOBAL_REGISTRY_ID());
+            parentNftId = toNftId(_chainNft.GLOBAL_REGISTRY_ID());
         }
         else 
         {// we are global registry
-            parentNftId = toNftId(_chainNftInternal.PROTOCOL_NFT_ID());
+            parentNftId = toNftId(_chainNft.PROTOCOL_NFT_ID());
         }
 
-        _chainNftInternal.mint(registryOwner, registryId);
+        _chainNft.mint(registryOwner, registryId);
 
         _info[registryNftId] = ObjectInfo(
             registryNftId,
@@ -350,15 +372,15 @@ contract Registry is
     function _registerGlobalRegistry() 
         internal
     {
-        uint256 globalRegistryId = _chainNftInternal.GLOBAL_REGISTRY_ID();
+        uint256 globalRegistryId = _chainNft.GLOBAL_REGISTRY_ID();
 
-        _chainNftInternal.mint(NFT_LOCK_ADDRESS, globalRegistryId);
+        _chainNft.mint(NFT_LOCK_ADDRESS, globalRegistryId);
 
         NftId globalRegistryNftId = toNftId(globalRegistryId);
 
         _info[globalRegistryNftId] = ObjectInfo(
             globalRegistryNftId,
-            toNftId(_chainNftInternal.PROTOCOL_NFT_ID()), // parent
+            toNftId(_chainNft.PROTOCOL_NFT_ID()), // parent
             REGISTRY(),
             false, // isInterceptor
             address(0), // objectAddress
@@ -370,10 +392,10 @@ contract Registry is
     function _registerRegistryService(address registryOwner)
         internal
     {
-        uint256 serviceId = _chainNftInternal.calculateTokenId(REGISTRY_SERVICE_TOKEN_SEQUENCE_ID);
+        uint256 serviceId = _chainNft.calculateTokenId(REGISTRY_SERVICE_TOKEN_SEQUENCE_ID);
         NftId serviceNftId = toNftId(serviceId);        
 
-        _chainNftInternal.mint(registryOwner, serviceId);
+        _chainNft.mint(registryOwner, serviceId);
 
         _info[serviceNftId] = ObjectInfo(
             serviceNftId,
@@ -389,7 +411,7 @@ contract Registry is
 
         string memory serviceName = "RegistryService";
         bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
-        _service[serviceNameHash][VersionLib.toVersionPart(MAJOR_VERSION_MIN)] = msg.sender;
+        _service[serviceNameHash][VersionLib.toVersionPart(GIF_MAJOR_VERSION_AT_DEPLOYMENT)] = msg.sender;
         _string[serviceNftId] = serviceName;
         _serviceNftId = serviceNftId;
     }