@etherisc/gif-next 0.0.2-9b97b55 → 0.0.2-9d3eab3-323

package/contracts/registry/Registry.sol

@@ -1,182 +1,385 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
+
+
+import {NftId, toNftId, zeroNftId, NftIdLib} from "../types/NftId.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 {IRegisterable} from "../shared/IRegisterable.sol";
+import {IService} from "../shared/IService.sol";
+import {ERC165} from "../shared/ERC165.sol";
+
+import {ChainNft} from "./ChainNft.sol";
+import {IRegistry} from "./IRegistry.sol";
+import {IRegistryService} from "./IRegistryService.sol";
+import {ITransferInterceptor} from "./ITransferInterceptor.sol";
+import {ReleaseManager} from "./ReleaseManager.sol";
+
+// IMPORTANT (OPTION 1)
+// Each NFT minted by registry is accosiated with:
+// 1) NFT owner
+// 2) registred contract OR object stored in registered (parent) contract
+// Four registration flows:
+// 1) IService address by release manager (SERVICE of type SERVICE aka registry service)
+// 2) IService address by release manager (SERVICE of type !SERVICE aka regular service)
+// 3) IRegisterable address by regular service (INSTANCE, PRODUCT, POOL, DISTRIBUTION, ORACLE)
+// 4) state object by regular service (POLICY, BUNDLE, STAKE)
+
+contract Registry is
+    ERC165,
+    IRegistry
+{
+    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) internal _info;
+    mapping(address object => NftId nftId) internal _nftIdByAddress;
+
+    mapping(ObjectType objectType => mapping(
+            ObjectType parentType => bool)) internal _isValidContractCombination;
+
+    mapping(ObjectType objectType => mapping(
+            ObjectType parentType => bool)) internal _isValidObjectCombination;
 
-import {IChainNft} from "./IChainNft.sol";
-import {IRegistry, IRegistryLinked, IRegisterable} from "./IRegistry.sol";
-import {NftId, toNftId} from "../types/NftId.sol";
-import {NftIdLib} from "../types/NftId.sol";
+    NftId internal _registryNftId;
+    ChainNft internal _chainNft;
 
-contract RegistryLinked is IRegistryLinked {
+    ReleaseManager internal _releaseManager;
 
-    IRegistry internal _registry;
-    
-    constructor(address registry) {
-        _registry = IRegistry(registry);
+    modifier onlyRegistryService() {
+        if(!_releaseManager.isActiveRegistryService(msg.sender)) {
+            revert CallerNotRegistryService();
+        }
+        _;
     }
 
-    function getRegistry() external view override returns(IRegistry registry) {
-        return _registry;
+    modifier onlyReleaseManager() {
+        if(msg.sender != address(_releaseManager)) {
+            revert CallerNotReleaseManager();
+        }
+        _;
     }
 
-}
+    constructor(address releaseManager, VersionPart initialVersion)
+    {
+        require(releaseManager > address(0), "Registry: release manager is 0");
+        require(initialVersion.toInt() > 0, "Registry: initial version is 0");
 
+        _releaseManager = ReleaseManager(releaseManager);
 
-abstract contract Registerable is 
-    RegistryLinked,
-    IRegisterable
-{
-    using NftIdLib for NftId;
+        // deploy NFT 
+        _chainNft = new ChainNft(address(this));// adds 10kb to deployment size
 
-    address private _initialOwner;
-    
-    constructor(address registry)
-        RegistryLinked(registry)
+        // initial registry setup
+        _registerProtocol();
+        _registerRegistry();
+
+        // set object parent relations
+        _setupValidObjectParentCombinations();
+
+        _registerInterface(type(IRegistry).interfaceId);
+    }
+
+    function registerService(ObjectInfo memory info)
+        external
+        onlyReleaseManager
+        returns(NftId nftId)
     {
-        _initialOwner = msg.sender;
+        /* must be guaranteed by release manager
+        if(info.objectType != SERVICE()) {
+            revert();
+        }
+        info.initialOwner = NFT_LOCK_ADDRESS <- if services are access managed
+        */
+        nftId = _register(info);
     }
 
-    // getType, getData and register need to be implemented by concrete contract
+    function register(ObjectInfo memory info)
+        external
+        onlyRegistryService
+        returns(NftId nftId)
+    {
+        // no service registrations
+        if(info.objectType == SERVICE()) {
+            revert ServiceRegistration();
+        }
 
-    function isRegisterable() external pure override returns(bool) {
-        return true;
+        nftId = _register(info);
     }
 
-    function getInitialOwner() public view override returns(address deployer) {
-        return _initialOwner;
+    /// @dev earliest GIF major version 
+    function getMajorVersionMin() external view returns (VersionPart) {
+        return _releaseManager.getInitialVersion();
     }
 
-    function isRegistered() public view override returns(bool) {
-        NftId nftId = _registry.getNftId(address(this));
-        return nftId.gtz();
+    // 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 _releaseManager.getNextVersion();
     }
 
-    function getNftId() public view override returns(NftId nftId) {
-        return _registry.getNftId(address(this));
+    /// @dev latest active GIF release version 
+    function getMajorVersion() external view returns (VersionPart) { 
+        return _releaseManager.getLatestVersion();
     }
 
-    function getOwner() public view override returns(address owner) {
-        NftId id = _registry.getNftId(address(this));
-        owner = _registry.getOwner(id);
-        return owner != address(0) ? owner : _initialOwner;
+    function getObjectCount() external view override returns (uint256) {
+        return _chainNft.totalSupply();
     }
 
-}
+    function getNftId() external view returns (NftId nftId) {
+        return _registryNftId;
+    }
 
-contract Registry is IRegistry {
-    using NftIdLib for NftId;
-    string public constant EMPTY_URI = "";
+    function getNftId(address object) external view override returns (NftId id) {
+        return _nftIdByAddress[object];
+    }
 
-    mapping(NftId nftId => RegistryInfo info) private _info;
-    mapping(NftId nftId => address owner) private _owner;
-    mapping(address object => NftId nftId) private _nftIdByAddress;
+    function ownerOf(NftId nftId) public view override returns (address) {
+        return _chainNft.ownerOf(nftId.toInt());
+    }
 
-    IChainNft private _chainNft;
+    function ownerOf(address contractAddress) public view returns (address) {
+        return _chainNft.ownerOf(_nftIdByAddress[contractAddress].toInt());
+    }
 
-    function initialize(address chainNft) external {
-        require(address(_chainNft) == address(0), "ERROR:REG-001:ALREADY_INITIALIZED");
-        _chainNft = IChainNft(chainNft);
+    function getObjectInfo(NftId nftId) external view override returns (ObjectInfo memory) {
+        return _info[nftId];
     }
 
-    function TOKEN() public pure override returns(uint256) { return 30; }
-    function INSTANCE() public pure override returns(uint256) { return 40; }
-    function PRODUCT() public pure override returns(uint256) { return 50; }
-    function ORACLE() public pure override returns(uint256) { return 60; }
-    function POOL() public pure override returns(uint256) { return 70; }
-    function POLICY() public pure override returns(uint256) { return 80; }
-    function BUNDLE() public pure override returns(uint256) { return 90; }
+    function getObjectInfo(address object) external view override returns (ObjectInfo memory) {
+        return _info[_nftIdByAddress[object]];
+    }
 
-    function register(address objectAddress) external override returns(NftId nftId) {
-        require(_nftIdByAddress[objectAddress].eqz(), "ERROR:REG-002:ALREADY_REGISTERED");
+    function isRegistered(NftId nftId) public view override returns (bool) {
+        return _info[nftId].objectType.gtz();
+    }
 
-        IRegisterable registerable = IRegisterable(objectAddress);
-        require(registerable.isRegisterable(), "ERROR:REG-003:NOT_REGISTERABLE");
+    function isRegistered(address object) external view override returns (bool) {
+        return _nftIdByAddress[object].gtz();
+    }
 
-        // check parent exists (for objects not instances)
-        if(registerable.getType() != INSTANCE()) {
-            RegistryInfo memory parentInfo = _info[registerable.getParentNftId()];
-            require(parentInfo.nftId.gtz(), "ERROR:REG-004:PARENT_NOT_FOUND");
-            // check validity of parent relation, valid relations are
-            // policy -> product, bundle -> pool, product -> instance, pool -> instance
-        }
+    function isRegisteredService(address object) external view override returns (bool) {
+        return _nftIdByAddress[object].gtz() && _info[_nftIdByAddress[object]].objectType == SERVICE();
+    }
 
-        uint256 mintedTokenId = _chainNft.mint(
-            registerable.getInitialOwner(), 
-            EMPTY_URI);
-        nftId = toNftId(mintedTokenId);
-    
-        RegistryInfo memory info = RegistryInfo(
-            nftId,
-            registerable.getParentNftId(),
-            registerable.getType(),
-            objectAddress,
-            registerable.getInitialOwner()
-        );
+    function getServiceAddress(
+        ObjectType serviceType, 
+        VersionPart releaseVersion
+    ) external view returns (address)
+    {
+        return _releaseManager.getService(releaseVersion, serviceType);
+    }
 
-        _info[nftId] = info;
-        _nftIdByAddress[objectAddress] = nftId;
+    function getChainNft() external view override returns (ChainNft) {
+        return _chainNft;
+    }
 
-        // add logging
+    function getOwner() public view returns (address owner) {
+        return ownerOf(address(this));
     }
 
+    // Internals
 
-    function registerObjectForInstance(
-        NftId parentNftId,
-        uint256 objectType,
-        address initialOwner
-    )
-        external 
-        override
-        // TODO add onlyRegisteredInstance
+    /// @dev registry protects only against tampering existing records, registering with invalid types pairs and 0 parent address
+    // TODO registration of precompile addresses
+    function _register(ObjectInfo memory info)
+        internal
         returns(NftId nftId)
     {
-        // TODO add more validation
-        require(
-            objectType == POLICY() || objectType == BUNDLE(),
-            "ERROR:REG-005:TYPE_INVALID");
+        ObjectType objectType = info.objectType;
+        NftId parentNftId = info.parentNftId;
+        ObjectInfo memory parentInfo = _info[parentNftId];
+        ObjectType parentType = parentInfo.objectType; // see function header
+        address parentAddress = parentInfo.objectAddress;
+
+        // parent is contract -> need to check? -> check before minting
+        // special case: global registry nft as parent when not on mainnet -> global registry address is 0
+        // special case: when parentNftId == _chainNft.mint(), check for zero parent address before mint
+        // special case: when parentNftId == _chainNft.mint() && objectAddress == initialOwner
+        if(parentAddress == address(0)) {
+            revert ZeroParentAddress();
+        }
 
+        address interceptor = _getInterceptor(info.isInterceptor, info.objectAddress, parentInfo.isInterceptor, parentAddress);
+
+        // TODO does external call
+        // compute next nftId, do all checks and stores, mint() at most end...
         uint256 mintedTokenId = _chainNft.mint(
-            initialOwner,
+            info.initialOwner,
+            interceptor,
             EMPTY_URI);
         nftId = toNftId(mintedTokenId);
 
-        RegistryInfo memory info = RegistryInfo(
-            nftId,
-            parentNftId,
-            objectType,
-            address(0),
-            initialOwner
-        );
-
+        // TODO move nftId out of info struct
+        // getters by nftId -> return struct without nftId
+        // getters by address -> return nftId AND struct
+        info.nftId = nftId;
         _info[nftId] = info;
 
-        // add logging
-    }
+        if(info.objectAddress > address(0)) 
+        {
+            // parent is registered + object-parent types are valid
+            if(_isValidContractCombination[objectType][parentType] == false) {
+                revert InvalidTypesCombination(objectType, parentType);
+            }
 
+            address contractAddress = info.objectAddress;
 
-    function getObjectCount() external view override returns(uint256) {
-        return _chainNft.totalSupply();
+            if(_nftIdByAddress[contractAddress].gtz()) { 
+                revert ContractAlreadyRegistered(contractAddress);
+            }
+
+            _nftIdByAddress[contractAddress] = nftId;
+        }
+        else
+        {
+            if(_isValidObjectCombination[objectType][parentType] == false) {
+                revert InvalidTypesCombination(objectType, parentType);
+            }
+        }
+
+        emit LogRegistration(nftId, parentNftId, objectType, info.isInterceptor, info.objectAddress, info.initialOwner);
     }
 
+    /// @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;
+        }
 
-    function getNftId(address object) external view override returns(NftId id) {
-        return _nftIdByAddress[object];
+        return address(0);
     }
 
+    // Internals called only in constructor
 
-    function isRegistered(address object) external view override returns(bool) {
-        return _nftIdByAddress[object].gtz();
+    /// @dev protocol registration used to anchor the dip ecosystem relations
+    function _registerProtocol() 
+        private
+    {
+        uint256 protocolId = _chainNft.PROTOCOL_NFT_ID();
+        NftId protocolNftId = toNftId(protocolId);
+
+        _info[protocolNftId] = ObjectInfo({
+            nftId: protocolNftId,
+            parentNftId: zeroNftId(),
+            objectType: PROTOCOL(),
+            isInterceptor: false, 
+            objectAddress: address(0),
+            initialOwner: NFT_LOCK_ADDRESS,
+            data: ""
+        });
+
+        _chainNft.mint(NFT_LOCK_ADDRESS, protocolId);
     }
 
+    /// @dev registry registration
+    /// might also register the global registry when not on mainnet
+    function _registerRegistry() 
+        private
+    {
+        uint256 registryId = _chainNft.calculateTokenId(REGISTRY_TOKEN_SEQUENCE_ID);
+        NftId registryNftId = toNftId(registryId);
+        NftId parentNftId;
+
+        if(registryId != _chainNft.GLOBAL_REGISTRY_ID()) 
+        {// we're not the global registry
+            _registerGlobalRegistry();
+            parentNftId = toNftId(_chainNft.GLOBAL_REGISTRY_ID());
+        }
+        else 
+        {// we are global registry
+            parentNftId = toNftId(_chainNft.PROTOCOL_NFT_ID());
+        }
 
-    function getInfo(NftId nftId) external view override returns(RegistryInfo memory info) {
-        return _info[nftId];
+        _info[registryNftId] = ObjectInfo({
+            nftId: registryNftId,
+            parentNftId: parentNftId,
+            objectType: REGISTRY(),
+            isInterceptor: false,
+            objectAddress: address(this), 
+            initialOwner: NFT_LOCK_ADDRESS,
+            data: "" 
+        });
+        _nftIdByAddress[address(this)] = registryNftId;
+        _registryNftId = registryNftId;
+
+        _chainNft.mint(NFT_LOCK_ADDRESS, registryId);
     }
 
-    function getOwner(NftId nftId) external view override returns(address) {
-        return _chainNft.ownerOf(nftId.toInt());
+    /// @dev global registry registration for non mainnet registries
+    function _registerGlobalRegistry() 
+        private
+    {
+        uint256 globalRegistryId = _chainNft.GLOBAL_REGISTRY_ID();
+        NftId globalRegistryNftId = toNftId(globalRegistryId);
+
+        _info[globalRegistryNftId] = ObjectInfo({
+            nftId: globalRegistryNftId,
+            parentNftId: toNftId(_chainNft.PROTOCOL_NFT_ID()),
+            objectType: REGISTRY(),
+            isInterceptor: false,
+            objectAddress: address(0),
+            initialOwner: NFT_LOCK_ADDRESS,
+            data: ""
+        });
+
+        _chainNft.mint(NFT_LOCK_ADDRESS, globalRegistryId);
     }
 
-    function getNftAddress() external view override returns(address nft) {
-        return address(_chainNft);
+    /// @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
+    // 2) DO NOT use object type (e.g. POLCY, BUNDLE, STAKE) as parent type
+    // 3) DO NOT use REGISTRY as object type
+    // 2) DO NOT use PROTOCOL and "zeroObjectType"
+    function _setupValidObjectParentCombinations() 
+        private 
+    {
+        // registry as parent, ONLY registry owner
+        _isValidContractCombination[TOKEN()][REGISTRY()] = true;
+        _isValidContractCombination[SERVICE()][REGISTRY()] = true;
+
+        // registry as parent, ONLY approved
+        _isValidContractCombination[INSTANCE()][REGISTRY()] = true;
+
+        // instance as parent, ONLY approved
+        _isValidContractCombination[PRODUCT()][INSTANCE()] = true;
+        _isValidContractCombination[DISTRIBUTION()][INSTANCE()] = true;
+        _isValidContractCombination[ORACLE()][INSTANCE()] = true;
+        _isValidContractCombination[POOL()][INSTANCE()] = true;
+
+        // product as parent, ONLY approved
+        _isValidObjectCombination[POLICY()][PRODUCT()] = true;
+
+        // pool as parent, ONLY approved
+        _isValidObjectCombination[BUNDLE()][POOL()] = true;
+        _isValidObjectCombination[STAKE()][POOL()] = true;
     }
-}
+}