@etherisc/gif-next 0.0.2-743affe-003 → 0.0.2-771d9e9-515

package/contracts/registry/Registry.sol

@@ -2,17 +2,15 @@
 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";
 
-import {IOwnable} from "../shared/IOwnable.sol";
 import {ERC165} from "../shared/ERC165.sol";
 
 
@@ -30,63 +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_SERVICE_TOKEN_SEQUENCE_ID = 3;
     string public constant EMPTY_URI = "";
 
-    address constant public NFT_LOCK_ADDRESS = address(0x1);
+    VersionPart internal _majorVersion;
 
-    mapping(NftId nftId => ObjectInfo info) _info;
-    mapping(address object => NftId nftId) _nftIdByAddress;
+    mapping(NftId nftId => ObjectInfo info) internal _info;
+    mapping(address object => NftId nftId) internal _nftIdByAddress;
 
     mapping(NftId registrator => mapping(
-            ObjectType objectType => bool)) _isApproved;
+            ObjectType objectType => bool)) internal _isApproved;
 
     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(address token => mapping(
+            VersionPart majorVersion => bool isActive)) internal _tokenIsActive;
 
-    mapping(NftId nftId => string name) _string;
+    mapping(NftId nftId => string name) internal _string;
     mapping(bytes32 serviceNameHash => mapping(
-            VersionPart majorVersion => address service)) _service;
-
-    NftId _registryNftId;
-    NftId _serviceNftId; // set in stone upon registry creation
-    IChainNft _chainNft;
-    ChainNft _chainNftInternal;
-
-    /// @dev will own protocol, global registry, registry and registry service nfts minted during creation
-    // TODO registry nft can be transfered while protocol, global registry and registry service nfts are not transferable
-    // TODO get owner from one place -> nft contract
-    address _protocolOwner;
-
-    /*
-    modifier onlyInitialOwner() {
-        if(
-            msg.sender != getOwner() ||
-            msg.sender != _info[_registryNftId].initialOwner) {
-            revert NotInitialOwner();
-        }
-    }*/
+            VersionPart majorVersion => address service)) internal _service;
+
+    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);
         }
         _;
     }
@@ -99,36 +74,49 @@ contract Registry is
         _;
     }
 
-    constructor(address protocolOwner, VersionPart majorVersion)
+    constructor(address registryOwner, VersionPart majorVersion)
     {
-        require(protocolOwner > address(0), "Registry: protocol owner is 0");
-        require(majorVersion.toInt() == MAJOR_VERSION_MIN, "Registry: initial major version of registry service is not MAJOR_VERSION_MIN");
+        require(registryOwner > address(0), "Registry: registry owner is 0");
 
-        // TODO registry owner can change, while protocol is not?
-        _protocolOwner = protocolOwner;
+        // 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();
-
-        _registerRegistry();
-
-        _registerRegistryService();
+        _registerRegistry(registryOwner);
+        _registerRegistryService(registryOwner);
 
         // set object parent relations
         _setupValidObjectParentCombinations();
 
         _registerInterface(type(IRegistry).interfaceId);
-        _registerInterface(type(IOwnable).interfaceId);
     }
 
-    /// @dev registry protects only from tampering existing records and invalid types pairs
-    // IMPORTANT: rare case when parentNftId is not registered and == next nftId -> technincally this is ZeroParentAddress error
-    // to catch this check parent address before minting !!!!
+    // 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
     function register(ObjectInfo memory info)
         external
         onlyRegistryService
@@ -150,6 +138,7 @@ contract Registry is
 
         address interceptor = _getInterceptor(info.isInterceptor, info.objectAddress, parentInfo.isInterceptor, parentAddress);
 
+        // TODO does external call
         uint256 mintedTokenId = _chainNft.mint(
             info.initialOwner,
             interceptor,
@@ -179,33 +168,8 @@ contract Registry is
             _nftIdByAddress[contractAddress] = nftId;
 
             // special case
-            if(objectType == SERVICE())
-            {
-                (
-                    string memory serviceName,
-                    VersionPart majorVersion
-                ) = abi.decode(info.data, (string, VersionPart));
-                bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
-
-                // TODO MUST guarantee consistency of registerable.getVersion() and majorVersion here
-                // TODO update _serviceNftId when registryService with new major version is registered? -> it is fixed in current setup
-                // 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) )
-                ) {
-                    revert InvalidServiceVersion(majorVersion);
-                }
-                
-                if(_service[serviceNameHash][majorVersion] != address(0)) {
-                    revert ServiceNameAlreadyRegistered(serviceName, majorVersion);
-                }
-
-                _string[nftId] = serviceName;
-                _service[serviceNameHash][majorVersion] = contractAddress;
-
-                emit LogServiceNameRegistration(serviceName, majorVersion); 
+            if(objectType == SERVICE()) {
+                _registerService(info);
             }
         }
         else
@@ -215,75 +179,70 @@ contract Registry is
             }
         }
 
-        emit LogRegistration(nftId, info.parentNftId, info.objectType, info.objectAddress, info.initialOwner);
-    }
-
-    function registerFrom(
-        address from, 
-        ObjectInfo memory info
-    ) external returns (NftId nftId) 
-    {
-        revert();
+        emit LogRegistration(info);
     }
-    
 
-    /// @dev 
-    // msg.sender - registry owner 
-    //     CAN approve only registered service contract
-    //     CAN approve any combination specified in _isValidCombination
-    //     CAN NOT approve itself
-    // TODO in case where exists exactly one registered service per objectType (and major version):
-    // - registration and approve is a single operation, no need for separate approve() function
-    // - then approve can be used to adding new valid object-parent combinations???
-    function approve(
-        NftId serviceNftId,
-        ObjectType objectType,
-        ObjectType parentType 
-    ) 
-        public
-        onlyOwner()
+    /// @dev token state is informative, registry have no clue about used tokens
+    // component owner is responsible for token selection and operations
+    // service MUST deny registration of component with inactive token 
+    function setTokenActive(address token, VersionPart majorVersion, bool active)
+        external
+        onlyOwner
     {
-        address serviceAddress = _info[serviceNftId].objectAddress;
-            
-        if(_nftIdByAddress[serviceAddress].eqz()) {
-            revert NotRegisteredContract(serviceNftId);
+        // verify that token is registered
+        ObjectInfo memory info = _info[_nftIdByAddress[token]];
+        if (info.nftId.eqz()) {
+            revert TokenNotRegistered(token);
         }
 
-        if(_info[serviceNftId].objectType != SERVICE()) {
-            revert NotService(serviceNftId);
+        // verify provided address is a registered token
+        if (info.objectType != TOKEN()) {
+            revert NotToken(token);
         }
 
-        if(
-            _isValidContractCombination[objectType][parentType] == false &&
-            _isValidObjectCombination[objectType][parentType] == false) {
-            revert InvalidTypesCombination(objectType, parentType);
+        // verify valid major version
+        // ensure major version increments is one
+        uint256 version = majorVersion.toInt();
+        uint256 versionNow = _majorVersion.toInt();
+        if (version < GIF_MAJOR_VERSION_AT_DEPLOYMENT || version > versionNow) {
+            revert TokenMajorVersionInvalid(majorVersion);
         }
 
-        _isApproved[serviceNftId][objectType] = true;
+        _tokenIsActive[token][majorVersion] = active;
 
-        emit LogApproval(serviceNftId, objectType);
+        emit LogTokenStateSet(token, majorVersion, active);
     }
 
-    /// @dev returns false for registry owner nft
-    // TODO allowance by address?
-    // TODO checked by registry service -> but registry owner can upgrade registry service not to check allowance....
-    function allowance(
-        NftId nftId,
-        ObjectType object
-    ) 
-        public
-        view 
-        returns (bool)
-    {
-        return _isApproved[nftId][object];
+    /// @dev earliest GIF major version 
+    function getMajorVersionMin() external view returns (VersionPart) {
+        return VersionLib.toVersionPart(GIF_MAJOR_VERSION_AT_DEPLOYMENT);
     }
 
-    // from IRegistry
+    // 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;
+    }
+    
+
     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];
     }
@@ -314,6 +273,10 @@ contract Registry is
         return _nftIdByAddress[object].gtz();
     }
 
+    function isTokenActive(address token, VersionPart majorVersion) external view returns (bool) {
+        return _tokenIsActive[token][majorVersion];
+    }
+
     function getServiceName(NftId nftId) external view returns (string memory) {
         return _string[nftId];
     }
@@ -328,29 +291,76 @@ contract Registry is
         return _service[serviceNameHash][majorVersion];
     }
 
-    function getProtocolOwner() external view override returns (address) {
-        return _protocolOwner;
-    }
-
-    function getChainNft() external view override returns (IChainNft) {
+    function getChainNft() external view override returns (ChainNft) {
         return _chainNft;
     }
 
-    // from IOwnable
     function getOwner() public view returns (address owner) {
         return ownerOf(address(this));
     }
 
-    // Internals, called only in constructor
+    // Internals
+
+    function _registerService(ObjectInfo memory info)
+        internal
+    {
+        (
+            string memory serviceName,
+            VersionPart majorVersion
+        ) = abi.decode(info.data, (string, VersionPart));
+        bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
+
+        // ensures consistency of service.getVersion() and majorVersion here
+        if(majorVersion != _majorVersion) {
+            revert InvalidServiceVersion(majorVersion);
+        }
+        
+        if(_service[serviceNameHash][majorVersion] != address(0)) {
+            revert ServiceNameAlreadyRegistered(serviceName, majorVersion);
+        }
+
+        _string[info.nftId] = serviceName;
+        _service[serviceNameHash][majorVersion] = info.objectAddress;
+
+        emit LogServiceNameRegistration(serviceName, majorVersion); 
+    }
+
+    /// @dev obtain interceptor address for this nft if applicable, address(0) otherwise
+    function _getInterceptor(
+        bool isInterceptor, 
+        address objectAddress,
+        bool parentIsInterceptor,
+        address parentObjectAddress
+    )
+        internal 
+        view 
+        returns (address interceptor) 
+    {
+        if (objectAddress == address(0)) {
+            if (parentIsInterceptor) {
+                return parentObjectAddress;
+            } else {
+                return address(0);
+            }
+        }
+
+        if (isInterceptor) {
+            return objectAddress;
+        }
+
+        return address(0);
+    }
+
+    // Internals called only in constructor
 
     /// @dev protocol registration used to anchor the dip ecosystem relations
     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,
@@ -365,25 +375,25 @@ contract Registry is
 
     /// @dev registry registration
     /// might also register the global registry when not on mainnet
-    function _registerRegistry() 
+    function _registerRegistry(address registryOwner) 
         internal
     {
-        uint256 registryId = _chainNftInternal.calculateTokenId(2);
+        uint256 registryId = _chainNft.calculateTokenId(2);
         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(_protocolOwner, registryId);
+        _chainNft.mint(registryOwner, registryId);
 
         _info[registryNftId] = ObjectInfo(
             registryNftId,
@@ -391,7 +401,7 @@ contract Registry is
             REGISTRY(),
             false, // isInterceptor
             address(this), 
-            _protocolOwner,
+            registryOwner,
             "" 
         );
         _nftIdByAddress[address(this)] = registryNftId;
@@ -403,15 +413,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
@@ -420,13 +430,13 @@ contract Registry is
         );
     }
 
-    function _registerRegistryService()
+    function _registerRegistryService(address registryOwner)
         internal
     {
-        uint256 serviceId = _chainNftInternal.calculateTokenId(3);
+        uint256 serviceId = _chainNft.calculateTokenId(REGISTRY_SERVICE_TOKEN_SEQUENCE_ID);
         NftId serviceNftId = toNftId(serviceId);        
 
-        _chainNftInternal.mint(NFT_LOCK_ADDRESS, serviceId);
+        _chainNft.mint(registryOwner, serviceId);
 
         _info[serviceNftId] = ObjectInfo(
             serviceNftId,
@@ -434,7 +444,7 @@ contract Registry is
             SERVICE(),
             false, // isInterceptor
             msg.sender, // service deploys registry
-            NFT_LOCK_ADDRESS, // initialOwner,
+            registryOwner, // initialOwner,
             "" 
         );
 
@@ -442,37 +452,11 @@ 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;
     }
 
-    /// @dev obtain interceptor address for this nft if applicable, address(0) otherwise
-    function _getInterceptor(
-        bool isInterceptor, 
-        address objectAddress,
-        bool parentIsInterceptor,
-        address parentObjectAddress
-    )
-        internal 
-        view 
-        returns (address interceptor) 
-    {
-        if (objectAddress == address(0)) {
-            if (parentIsInterceptor) {
-                return parentObjectAddress;
-            } else {
-                return address(0);
-            }
-        }
-
-        if (isInterceptor) {
-            return objectAddress;
-        }
-
-        return address(0);
-    }
-
     /// @dev defines which object - parent types relations are allowed to register
     // IMPORTANT: 
     // 1) EACH object type MUST have only one parent type across ALL mappings