@etherisc/gif-next 0.0.2-a7e19c7 → 0.0.2-a84e908-436

package/contracts/registry/Registry.sol

@@ -1,182 +1,456 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-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";
-
-contract RegistryLinked is IRegistryLinked {
-
-    IRegistry internal _registry;
-    
-    constructor(address registry) {
-        _registry = IRegistry(registry);
-    }
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IService} from "../instance/base/IService.sol";
 
-    function getRegistry() external view override returns(IRegistry registry) {
-        return _registry;
-    }
+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 {ObjectType, PROTOCOL, REGISTRY, TOKEN, SERVICE, INSTANCE, STAKE, PRODUCT, DISTRIBUTION, ORACLE, POOL, POLICY, BUNDLE} from "../types/ObjectType.sol";
 
-}
+import {Versionable} from "../shared/Versionable.sol";
 
 
-abstract contract Registerable is 
-    RegistryLinked,
-    IRegisterable
+contract Registry is
+    Versionable,
+    IRegisterable,
+    IRegistry
 {
     using NftIdLib for NftId;
 
-    address private _initialOwner;
-    
-    constructor(address registry)
-        RegistryLinked(registry)
-    {
-        _initialOwner = msg.sender;
-    }
-
-    // getType, getData and register need to be implemented by concrete contract
-
-    function isRegisterable() external pure override returns(bool) {
-        return true;
-    }
-
-    function getInitialOwner() public view override returns(address deployer) {
-        return _initialOwner;
-    }
-
-    function isRegistered() public view override returns(bool) {
-        NftId nftId = _registry.getNftId(address(this));
-        return nftId.gtz();
-    }
-
-    function getNftId() public view override returns(NftId nftId) {
-        return _registry.getNftId(address(this));
-    }
+    string public constant EMPTY_URI = "";
 
-    function getOwner() public view override returns(address owner) {
-        NftId id = _registry.getNftId(address(this));
-        owner = _registry.getOwner(id);
-        return owner != address(0) ? owner : _initialOwner;
+    // TODO do not use gif-next in namespace id
+    // TODO ask openzeppelin about public location
+    // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.registry.Registry.sol")) - 1)) & ~bytes32(uint256(0xff));
+    bytes32 public constant REGISTRY_LOCATION_V1 = 0x6548007c3f4340f82f348c576c0ff69f4f529cadd5ad41f96aae61abceeaa300;
+
+    // IMPORTANT Every new version with storage changes must implement its own struct
+    // copy paste previous version and add changes
+    // @custom:storage-location erc7201:gif-next.contracts.registry.Registry.sol
+    struct StorageV1 {
+
+        mapping(NftId nftId => ObjectInfo info) _info;
+        mapping(address object => NftId nftId) _nftIdByAddress;
+        mapping(ObjectType objectType => bool) _isValidType;
+        mapping(ObjectType objectType => mapping(ObjectType objectParentType => bool)) _isValidParentType;
+
+        mapping(NftId nftId => string stringValue) _string;
+        mapping(bytes32 serviceNameHash => mapping(VersionPart majorVersion => address service)) _service;
+
+        NftId _nftId;
+        IChainNft _chainNft;
+        ChainNft _chainNftInternal;
+        address _initialOwner;
+
+        /// @dev will own protocol nft and registry nft(s) minted during initialize
+        address _protocolOwner;
+        // if struct goes here
+        // then you cannot add new vars after
     }
 
-}
+    function register(
+        address objectAddress
+    )
+    // TODO add authz (only services may register components etc)
+    // we have to check how we do authz for registring services (just restrict to protocol owner/registry owner)
+    external override returns (NftId nftId) {
+        StorageV1 storage $ = _getStorage();
 
-contract Registry is IRegistry {
-    using NftIdLib for NftId;
-    string public constant EMPTY_URI = "";
+        require(
+            $._nftIdByAddress[objectAddress].eqz(),
+            "ERROR:REG-002:ALREADY_REGISTERED"
+        );
 
-    mapping(NftId nftId => RegistryInfo info) private _info;
-    mapping(NftId nftId => address owner) private _owner;
-    mapping(address object => NftId nftId) private _nftIdByAddress;
+        IRegisterable registerable = IRegisterable(objectAddress);
+        require(
+            registerable.supportsInterface(type(IRegisterable).interfaceId),
+            "ERROR:REG-003:NOT_REGISTERABLE"
+        );
 
-    IChainNft private _chainNft;
+        ObjectType objectType = registerable.getType();
+        require(
+            $._isValidType[objectType],
+            "ERROR:REG-004:TYPE_INVALID"
+        );
 
-    function initialize(address chainNft) external {
-        require(address(_chainNft) == address(0), "ERROR:REG-001:ALREADY_INITIALIZED");
-        _chainNft = IChainNft(chainNft);
-    }
+        NftId parentNftId = registerable.getParentNftId();
+        require(
+            isRegistered(parentNftId),
+            "ERROR:REG-005:PARENT_NOT_REGISTERED"
+        );
 
-    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; }
+        require(
+            $._isValidParentType[objectType][$._info[parentNftId].objectType],
+            "ERROR:REG-006:PARENT_TYPE_INVALID"
+        );
 
-    function register(address objectAddress) external override returns(NftId nftId) {
-        require(_nftIdByAddress[objectAddress].eqz(), "ERROR:REG-002:ALREADY_REGISTERED");
+        // also check that nftId and parentNFtId are on the same chain if applicable
 
-        IRegisterable registerable = IRegisterable(objectAddress);
-        require(registerable.isRegisterable(), "ERROR:REG-003:NOT_REGISTERABLE");
-
-        // 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
-        }
+        // nft minting
+        uint256 mintedTokenId = $._chainNft.mint(
+            registerable.getOwner(),
+            EMPTY_URI
+        );
 
-        uint256 mintedTokenId = _chainNft.mint(
-            registerable.getInitialOwner(), 
-            EMPTY_URI);
         nftId = toNftId(mintedTokenId);
-    
-        RegistryInfo memory info = RegistryInfo(
-            nftId,
-            registerable.getParentNftId(),
-            registerable.getType(),
-            objectAddress,
-            registerable.getInitialOwner()
-        );
 
-        _info[nftId] = info;
-        _nftIdByAddress[objectAddress] = nftId;
+        // special case services
+        if(registerable.getType() == SERVICE()) {
+            IService service = IService(objectAddress);
+            require(
+                service.supportsInterface(type(IService).interfaceId),
+                "ERROR:REG-007:NOT_SERVICE"
+            );
+
+            string memory serviceName = service.getName();
+            VersionPart majorVersion = service.getMajorVersion();
+            bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
+
+            // service specific state
+            $._string[nftId] = serviceName;
+
+            require(
+                $._service[serviceNameHash][majorVersion] == address(0),
+                "ERROR:REG-008:ALREADY_REGISTERED"
+            );
+            $._service[serviceNameHash][majorVersion] = objectAddress;
+        }
 
-        // add logging
+        // create object info and link nft id with it
+        _registerObjectInfo(registerable, nftId);
     }
 
 
     function registerObjectForInstance(
         NftId parentNftId,
-        uint256 objectType,
-        address initialOwner
+        ObjectType objectType,
+        address initialOwner,
+        bytes memory data
     )
-        external 
+        external
         override
-        // TODO add onlyRegisteredInstance
-        returns(NftId nftId)
+        returns (
+            // TODO add onlyRegisteredInstance
+            NftId nftId
+        )
     {
+        StorageV1 storage $ = _getStorage();
+
         // TODO add more validation
         require(
             objectType == POLICY() || objectType == BUNDLE(),
-            "ERROR:REG-005:TYPE_INVALID");
+            "ERROR:REG-010:TYPE_INVALID"
+        );
 
-        uint256 mintedTokenId = _chainNft.mint(
-            initialOwner,
-            EMPTY_URI);
+        uint256 mintedTokenId = $._chainNft.mint(initialOwner, EMPTY_URI);
         nftId = toNftId(mintedTokenId);
 
-        RegistryInfo memory info = RegistryInfo(
+        ObjectInfo memory info = ObjectInfo(
             nftId,
             parentNftId,
             objectType,
             address(0),
-            initialOwner
+            initialOwner,
+            data
         );
 
-        _info[nftId] = info;
+        $._info[nftId] = info;
 
         // add logging
     }
 
+    // from IRegistry
+    function getObjectCount() external view override returns (uint256) {
+        return _getStorage()._chainNft.totalSupply();
+    }
+
+    function getNftId(address object) external view override returns (NftId id) {
+        return _getStorage()._nftIdByAddress[object];
+    }
+
+    function getOwner(NftId nftId) external view override returns (address) {
+        return _getStorage()._chainNft.ownerOf(nftId.toInt());
+    }
+
+    function getName(NftId nftId) external view returns (string memory name) {
+        return _getStorage()._string[nftId];
+    }
+
+    function getObjectInfo(NftId nftId) external view override returns (ObjectInfo memory info) {
+        return _getStorage()._info[nftId];
+    }
+
+    function isRegistered(NftId nftId) public view override returns (bool) {
+        return _getStorage()._info[nftId].objectType.gtz();
+    }
+
+    function isRegistered(address object) external view override returns (bool) {
+        return _getStorage()._nftIdByAddress[object].gtz();
+    }
+
+    // special case to retrive a gif service
+    function getServiceAddress(
+        string memory serviceName, 
+        VersionPart majorVersion
+    ) external view override returns (address serviceAddress) 
+    {
+        bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
+        return _getStorage()._service[serviceNameHash][majorVersion];
+    }
+
+    function getProtocolOwner() external view override returns (address) {
+        return _getStorage()._protocolOwner;
+    }
+
+    function getChainNft() external view override returns (IChainNft) {
+        return _getStorage()._chainNft;
+    }
+
+    // from IERC165
+    function supportsInterface(bytes4 interfaceId) external pure override returns (bool) {
+        return interfaceId == type(IRegistry).interfaceId;
+    }
+
+    // from IVersionable
+    function getVersion() public pure virtual override returns (Version) {
+        return VersionLib.toVersion(1, 0, 0);
+    } 
+
+    // from IOwnable
+    function getOwner() public view override returns (address owner) {
+        StorageV1 storage $ = _getStorage();
+        return $._nftId.gtz() ? this.getOwner($._nftId) : $._initialOwner;
+    }
+
+    // from IRegisterable
+    function getRegistry() external view override returns (IRegistry registry) {
+        return this;
+    }
+    // TODO 
+    // 1) Registerable can not register itself -> otherwise register have to trust owner address provided by registerable
+    // registerable owner MUST call register and provide registerable address
+    // 2) Who is msg.sender here???
+    function register() external pure override returns (NftId nftId) {
+        return zeroNftId();
+    }
+
+    function getType() external pure override returns (ObjectType objectType) {
+        return REGISTRY();
+    }
+
+    function getNftId() public view override returns (NftId nftId) {
+        return _getStorage()._nftId;
+    }
+
+    function getParentNftId() public view returns (NftId nftId) {
+        StorageV1 storage $ = _getStorage();
+        nftId = $._info[$._nftId].parentNftId;
+    }
+
+    function getData() public pure returns (bytes memory data) {
+        return "";
+    }
+
+    // registry specific functions
+
+    /// @dev defines which types are allowed to register
+    function _setupValidTypes() internal onlyInitializing {
+        StorageV1 storage $ = _getStorage();
+        $._isValidType[REGISTRY()] = true; // only for global registry 
+        $._isValidType[TOKEN()] = true;
+        $._isValidType[SERVICE()] = true;
+        $._isValidType[INSTANCE()] = true;
+        $._isValidType[STAKE()] = true;
+        $._isValidType[PRODUCT()] = true;
+        $._isValidType[ORACLE()] = true;
+        $._isValidType[POOL()] = true;
+        $._isValidType[DISTRIBUTION()] = true;
+        $._isValidType[POLICY()] = true;
+        $._isValidType[BUNDLE()] = true;
+    }
+
+    /// @dev defines which types - parent type relations are allowed to register
+    function _setupValidParentTypes() internal onlyInitializing {
+        StorageV1 storage $ = _getStorage();
+        // registry as parent
+        $._isValidParentType[TOKEN()][REGISTRY()] = true;
+        $._isValidParentType[SERVICE()][REGISTRY()] = true;
+        $._isValidParentType[INSTANCE()][REGISTRY()] = true;
+
+        // instance as parent
+        $._isValidParentType[PRODUCT()][INSTANCE()] = true;
+        $._isValidParentType[DISTRIBUTION()][INSTANCE()] = true;
+        $._isValidParentType[ORACLE()][INSTANCE()] = true;
+        $._isValidParentType[POOL()][INSTANCE()] = true;
+
+        // product as parent
+        $._isValidParentType[POLICY()][PRODUCT()] = true;
+
+        // pool as parent
+        $._isValidParentType[BUNDLE()][POOL()] = true;
+        $._isValidParentType[STAKE()][POOL()] = true;
+    }
+
+    /// @dev protocol registration used to anchor the dip ecosystem relations
+    function _registerProtocol() 
+        internal
+        onlyInitializing 
+        virtual // TODO virtual?
+    {
+        StorageV1 storage $ = _getStorage();
+
+        uint256 protocolId = $._chainNftInternal.PROTOCOL_NFT_ID();
+        $._chainNftInternal.mint($._protocolOwner, protocolId);
+
+        NftId protocolNftid = toNftId(protocolId);
+        ObjectInfo memory protocolInfo = ObjectInfo(
+            protocolNftid,
+            zeroNftId(), // parent nft id
+            PROTOCOL(),
+            address(0), // contract address
+            $._protocolOwner,
+            "" // data
+        );
 
-    function getObjectCount() external view override returns(uint256) {
-        return _chainNft.totalSupply();
+        $._info[protocolNftid] = protocolInfo;
     }
 
+    /// @dev registry registration
+    /// might also register the global registry when not on mainnet
+    function _registerRegistry()  
+        internal
+        onlyInitializing 
+        virtual
+        returns (NftId registryNftId) 
+    {
+        StorageV1 storage $ = _getStorage();
+
+        uint256 registryId = $._chainNftInternal.calculateTokenId(2);
+        registryNftId = toNftId(registryId);
 
-    function getNftId(address object) external view override returns(NftId id) {
-        return _nftIdByAddress[object];
+        // we're not the global registry
+        if(registryId != $._chainNftInternal.GLOBAL_REGISTRY_ID()) {
+            _registerGlobalRegistry();
+        }
+
+        $._chainNftInternal.mint($._protocolOwner, registryId);
+
+        NftId parentNftId;
+        // we're the global registry
+        if(block.chainid == 1) {
+            parentNftId = toNftId($._chainNftInternal.PROTOCOL_NFT_ID());
+        }
+        else {
+            parentNftId = toNftId($._chainNftInternal.GLOBAL_REGISTRY_ID());
+        }
+
+        ObjectInfo memory registryInfo = ObjectInfo(
+            registryNftId,
+            parentNftId,
+            REGISTRY(),
+            address(this),  // proxy address
+            $._protocolOwner, // registry owner is different from proxy owner 
+            ""
+        );
+
+        $._info[registryNftId] = registryInfo;
+        $._nftIdByAddress[address(this)] = registryNftId;
+
+        // add logging
     }
 
 
-    function isRegistered(address object) external view override returns(bool) {
-        return _nftIdByAddress[object].gtz();
+    /// @dev global registry registration for non mainnet registries
+    function _registerGlobalRegistry() 
+        internal
+        onlyInitializing
+        virtual
+    {
+        StorageV1 storage $ = _getStorage();
+
+        uint256 globalRegistryId = $._chainNftInternal.GLOBAL_REGISTRY_ID();
+        $._chainNftInternal.mint($._protocolOwner, globalRegistryId);
+
+        NftId globalRegistryNftId = toNftId(globalRegistryId);
+        ObjectInfo memory globalRegistryInfo = ObjectInfo(
+            globalRegistryNftId,
+            toNftId($._chainNftInternal.PROTOCOL_NFT_ID()),
+            REGISTRY(),
+            address(0), // contract address
+            $._protocolOwner,
+            "" // data
+        );
+
+        $._info[globalRegistryNftId] = globalRegistryInfo;
     }
 
+    function _registerObjectInfo(
+        IRegisterable registerable,
+        NftId nftId
+    ) 
+        internal 
+        virtual
+    {
+        address objectAddress = address(registerable);
+        ObjectInfo memory info = ObjectInfo(
+            nftId,
+            registerable.getParentNftId(), 
+            registerable.getType(),
+            objectAddress,
+            registerable.getOwner(),
+            registerable.getData()
+        );
+
+        StorageV1 storage $ = _getStorage();
+        $._info[nftId] = info;
+        $._nftIdByAddress[objectAddress] = nftId;
 
-    function getInfo(NftId nftId) external view override returns(RegistryInfo memory info) {
-        return _info[nftId];
+        // add logging
     }
 
-    function getOwner(NftId nftId) external view override returns(address) {
-        return _chainNft.ownerOf(nftId.toInt());
+    // TODO check how usage of "$.data" influences gas costs 
+    // IMPORTANT Every new version must implement this function
+    // keep it private -> if unreachable from the next version then not included in its byte code
+    // each version MUST use the same REGISTRY_LOCATION_V1, just change return type
+    function _getStorage() private pure returns (StorageV1 storage $) {
+        assembly {
+            $.slot := REGISTRY_LOCATION_V1
+        }
     }
 
-    function getNftAddress() external view override returns(address nft) {
-        return address(_chainNft);
+    // from Versionable 
+
+    /// @dev the protocol owner will get ownership of the
+    // protocol nft and the global registry nft minted in this 
+    // initializer function 
+    function _initialize(bytes memory data) 
+        internal
+        onlyInitializing
+        virtual override
+    {
+        address protocolOwner = abi.decode(data, (address));
+        StorageV1 storage $ = _getStorage();
+
+         // TODO here delegate call from proxy constructor, msg.sender is proxy deployer -> Proxy.sol
+        $._initialOwner = msg.sender;
+        $._protocolOwner = protocolOwner;
+
+        // TODO deployment size is too big, call another contract which keeps and deploys ChainNft byte code  
+        // deploy NFT 
+        $._chainNftInternal = new ChainNft(address(this));// adds 10kb to deployment size
+        $._chainNft = IChainNft($._chainNftInternal);
+        
+        // initial registry setup
+        _registerProtocol();
+        $._nftId = _registerRegistry();
+
+        // setup rules for further registrations
+        _setupValidTypes();
+        _setupValidParentTypes();
     }
-}
+
+}

package/contracts/shared/ERC165.sol

@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+
+contract ERC165 is IERC165 {
+    mapping(bytes4 => bool) private _isSupported;
+
+    constructor() {
+        // register support for ERC165
+        _registerInterface(type(IERC165).interfaceId);
+    }
+
+    function supportsInterface(bytes4 interfaceId) external view override returns (bool) {
+        return _isSupported[interfaceId];
+    }
+
+    function _registerInterface(bytes4 interfaceId) internal {
+        _isSupported[interfaceId] = true;
+    }
+}

package/contracts/shared/IOwnable.sol

@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+interface IOwnable {
+    function getOwner() external view returns (address owner);
+}

package/contracts/shared/IRegisterable.sol

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+
+import {IRegistry} from "../registry/IRegistry.sol";
+import {NftId} from "../types/NftId.sol";
+import {ObjectType} from "../types/ObjectType.sol";
+
+import {IOwnable} from "./IOwnable.sol";
+
+interface IRegisterable is IERC165, IOwnable {
+    function getRegistry() external view returns (IRegistry registry);
+
+    function register() external returns (NftId nftId);
+
+    function getType() external pure returns (ObjectType objectType);
+
+    function getNftId() external view returns (NftId nftId);
+
+    function getParentNftId() external view returns (NftId nftId);
+
+    function getData() external view returns (bytes memory data);
+}