@etherisc/gif-next 0.0.2-b9b3e89 → 0.0.2-c336201-668

package/contracts/registry/IRegistry.sol

@@ -1,66 +1,57 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-interface IOwnable {
-    function getOwner() external view returns(address owner);
-}
+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";
+
+interface IRegistry is IERC165 {
+    struct ObjectInfo {
+        NftId nftId;
+        NftId parentNftId;
+        ObjectType objectType;
+        address objectAddress;
+        address initialOwner;
+        bytes data;
+    }
 
-interface IRegistryLinked {
+    function register(address objectAddress) external returns (NftId nftId);
 
-    event LogDebug(uint256 idx, address module, string comment);
+    function registerObjectForInstance(
+        NftId parentNftid,
+        ObjectType objectType,
+        address initialOwner,
+        bytes memory data
+    ) external returns (NftId nftId);
 
-    function getRegistry() external view returns(IRegistry registry);
-}
+    function getServiceAddress(string memory serviceName, VersionPart majorVersion) external view returns (address serviceAddress);
 
-interface IRegisterable is 
-    IOwnable,
-    IRegistryLinked
-{
-
-    function register() external returns(uint256 nftId);
-    
-    function getNftId() external view returns(uint256 nftId);
-    function getParentNftId() external view returns(uint256 parentNftId);
-    function getType() external view returns(uint256 objectType);
-    function getData() external view returns(bytes memory data);
-    function isRegisterable() external pure returns(bool);
-    function getInitialOwner() external view returns(address initialOwner);
-
-    function isRegistered() external view returns(bool);
-}
+    function getObjectCount() external view returns (uint256);
 
+    function getNftId() external view returns (NftId nftId);
 
-interface IRegistry {
+    function getNftId(
+        address objectAddress
+    ) external view returns (NftId nftId);
 
-    struct RegistryInfo {
-        uint256 nftId;
-        uint256 parentNftId;
-        uint256 objectType;
-        address objectAddress;
-        address initialOwner;
-    }
+    function getObjectInfo(
+        NftId nftId
+    ) external view returns (ObjectInfo memory info);
 
-    function TOKEN() external pure returns(uint256);
-    function INSTANCE() external pure returns(uint256);
-    function PRODUCT() external pure returns(uint256);
-    function ORACLE() external pure returns(uint256);
-    function POOL() external pure returns(uint256);
-    function POLICY() external pure returns(uint256);
-    function BUNDLE() external pure returns(uint256);
+    function getName(
+        NftId nftId
+    ) external view returns (string memory name);
 
-    function register(address objectAddress) external returns(uint256 nftId);
-    function registerObjectForInstance(
-        uint256 parentNftid,
-        uint256 objectType,
-        address initialOwner
-    )
-        external returns(uint256 nftId);
+    function getProtocolOwner() external view returns (address);
+
+    function getOwner(NftId nftId) external view returns (address ownerAddress);
 
-    function transfer(uint256 nftId, address newOwner) external;
+    function isRegistered(NftId nftId) external view returns (bool);
 
-    function getNftId(address objectAddress) external view returns(uint256 nftId);
-    function getInfo(uint256 nftId) external view returns(RegistryInfo memory info);
-    function getOwner(uint256 nftId) external view returns(address ownerAddress);
+    function isRegistered(address objectAddress) external view returns (bool);
 
-    function isRegistered(address objectAddress) external view returns(bool);
+    function getChainNft() external view returns (IChainNft);
 }

package/contracts/registry/IRegistryLinked.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRegistry} from "../registry/IRegistry.sol";
+
+interface IRegistryLinked {
+    function getRegistry() external view returns (IRegistry registry);
+}

package/contracts/registry/Registry.sol

@@ -1,149 +1,173 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IRegistry, IRegistryLinked, IRegisterable} from "./IRegistry.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";
+
+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 {VersionPart} from "../types/Version.sol";
+import {ObjectType, PROTOCOL, REGISTRY, TOKEN, SERVICE, INSTANCE, STAKE, PRODUCT, DISTRIBUTOR, ORACLE, POOL, POLICY, BUNDLE} from "../types/ObjectType.sol";
+
+// TODO make registry upgradable
+contract Registry is
+    IRegisterable,
+    IRegistry
+{
+    using NftIdLib for NftId;
 
-    // function setRegistry(address registry) public override {
-    //     require(address(_registry) == address(0), "ERROR:RGL-001:REGISTRY_ALREADY_SET");
-    //     _registry = IRegistry(registry);
-    // }
+    string public constant EMPTY_URI = "";
 
-    function getRegistry() external view override returns(IRegistry registry) {
-        return _registry;
-    }
+    mapping(NftId nftId => ObjectInfo info) private _info;
+    mapping(NftId nftId => address owner) private _owner;
+    mapping(address object => NftId nftId) private _nftIdByAddress;
+    mapping(ObjectType objectType => bool) private _isValidType;
+    mapping(ObjectType objectType => mapping(ObjectType objectParentType => bool)) private _isValidParentType;
 
-}
+    mapping(NftId nftId => string stringValue) private _string;
+    mapping(bytes32 serviceNameHash => mapping(VersionPart majorVersion => address service)) _service;
 
+    NftId private _nftId;
+    IChainNft private _chainNft;
+    ChainNft private _chainNftInternal;
+    address private _initialOwner;
 
-abstract contract Registerable is 
-    RegistryLinked,
-    IRegisterable
-{
+    // @dev will own protocol nft and registry nft(s) minted during initialize
+    address private _protocolOwner;
 
-    address private _initialOwner;
-    
-    constructor(address registry)
-        RegistryLinked(registry)
+    // TODO refactor once registry becomes upgradable
+    // @Dev the protocol owner will get ownership of the
+    // protocol nft and the global registry nft minted in this 
+    // initializer function 
+    function initialize(
+        address chainNft, 
+        address protocolOwner
+    )
+        public 
     {
-        _initialOwner = msg.sender;
-    }
+        require(
+            address(_chainNft) == address(0),
+            "ERROR:REG-001:ALREADY_INITIALIZED"
+        );
 
-    // getType, getData and register need to be implemented by concrete contract
+        _initialOwner = msg.sender;
+        _protocolOwner = protocolOwner;
 
-    function isRegisterable() external pure override returns(bool) {
-        return true;
-    }
+        _chainNft = IChainNft(chainNft);
+        _chainNftInternal = ChainNft(chainNft);
 
-    function getInitialOwner() public view override returns(address deployer) {
-        return _initialOwner;
-    }
+        // initial registry setup
+        _registerProtocol();
+        _nftId = _registerRegistry();
 
-    function isRegistered() public view override returns(bool) {
-        return _registry.getNftId(address(this)) > 0;
+        // setup rules for further registrations
+        _setupValidTypes();
+        _setupValidParentTypes();
     }
 
-    function getNftId() public view override returns(uint256 id) {
-        return _registry.getNftId(address(this));
-    }
 
-    function getOwner() public view override returns(address owner) {
-        uint256 id = _registry.getNftId(address(this));
-        owner = _registry.getOwner(id);
-        return owner != address(0) ? owner : _initialOwner;
-    }
+    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) {
+        require(
+            _nftIdByAddress[objectAddress].eqz(),
+            "ERROR:REG-002:ALREADY_REGISTERED"
+        );
 
-}
+        IRegisterable registerable = IRegisterable(objectAddress);
+        require(
+            registerable.supportsInterface(type(IRegisterable).interfaceId),
+            "ERROR:REG-003:NOT_REGISTERABLE"
+        );
 
-    // struct RegistryInfo {
-    //     bytes32 id;
-    //     uint256 objectType;
-    //     address objectAddress;
-    //     address initialOwner;
-    // }
+        ObjectType objectType = registerable.getType();
+        require(
+            _isValidType[objectType],
+            "ERROR:REG-004:TYPE_INVALID"
+        );
 
-contract Registry is IRegistry {
+        NftId parentNftId = registerable.getParentNftId();
+        require(
+            isRegistered(parentNftId),
+            "ERROR:REG-005:PARENT_NOT_REGISTERED"
+        );
 
-    mapping(uint256 id => RegistryInfo info) private _info;
-    mapping(uint256 id => address owner) private _owner;
-    mapping(address object => uint256 id) private _idByAddress;
-    uint256 [] private _ids;
-    uint256 private _idNext;
+        require(
+            _isValidParentType[objectType][_info[parentNftId].objectType],
+            "ERROR:REG-006:PARENT_TYPE_INVALID"
+        );
 
+        // also check that nftId and parentNFtId are on the same chain if applicable
 
-    constructor() {
-        _idNext = 0;
-    }
+        // nft minting
+        uint256 mintedTokenId = _chainNft.mint(
+            registerable.getOwner(),
+            EMPTY_URI
+        );
 
-    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; }
+        nftId = toNftId(mintedTokenId);
 
-    function register(address objectAddress) external override returns(uint256 nftId) {
-        require(_idByAddress[objectAddress] == 0, "ERROR:REG-001:ALREADY_REGISTERED");
+        // special case services
+        if(registerable.getType() == SERVICE()) {
+            IService service = IService(objectAddress);
+            require(
+                service.supportsInterface(type(IService).interfaceId),
+                "ERROR:REG-007:NOT_SERVICE"
+            );
 
-        IRegisterable registerable = IRegisterable(objectAddress);
-        require(registerable.isRegisterable(), "ERROR:REG-002:NOT_REGISTERABLE");
-
-        // check parent exists (for objects not instances)
-        if(registerable.getType() != INSTANCE()) {
-            RegistryInfo memory parentInfo = _info[registerable.getParentNftId()];
-            require(parentInfo.nftId > 0, "ERROR:REG-003:PARENT_NOT_FOUND");
-            // check validity of parent relation, valid relations are
-            // policy -> product, bundle -> pool, product -> instance, pool -> instance
-        }
+            string memory serviceName = service.getName();
+            VersionPart majorVersion = service.getMajorVersion();
+            bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
 
-        nftId = _mint(registerable.getInitialOwner());
-    
-        RegistryInfo memory info = RegistryInfo(
-            nftId,
-            registerable.getParentNftId(),
-            registerable.getType(),
-            objectAddress,
-            registerable.getInitialOwner()
-        );
+            // service specific state
+            _string[nftId] = serviceName;
 
-        _info[nftId] = info;
-        _idByAddress[objectAddress] = nftId;
+            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(
-        uint256 parentNftId,
-        uint256 objectType,
-        address initialOwner
+        NftId parentNftId,
+        ObjectType objectType,
+        address initialOwner,
+        bytes memory data
     )
-        external 
+        external
         override
-        // TODO add onlyRegisteredInstance
-        returns(uint256 nftId)
+        returns (
+            // TODO add onlyRegisteredInstance
+            NftId nftId
+        )
     {
         // TODO add more validation
         require(
             objectType == POLICY() || objectType == BUNDLE(),
-            "ERROR:REG-005:TYPE_INVALID");
+            "ERROR:REG-010:TYPE_INVALID"
+        );
 
-        nftId = _mint(initialOwner);
+        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;
@@ -151,47 +175,207 @@ contract Registry is IRegistry {
         // add logging
     }
 
+    function getObjectCount() external view override returns (uint256) {
+        return _chainNft.totalSupply();
+    }
 
-    function transfer(uint256 id, address newOwner) external {
-        require(msg.sender == _owner[id], "ERROR:REG-010:NOT_OWNER");
-        _owner[id] = newOwner;
+    function getNftId(
+        address object
+    ) external view override returns (NftId id) {
+        return _nftIdByAddress[object];
+    }
 
-        // TODO logging
+    function isRegistered(
+        NftId nftId
+    ) public view override returns (bool) {
+        return _info[nftId].objectType.gtz();
     }
 
+    function isRegistered(
+        address object
+    ) external view override returns (bool) {
+        return _nftIdByAddress[object].gtz();
+    }
 
-    function getObjectCount() external view returns(uint256) {
-        return _ids.length;
+    function getObjectInfo(
+        NftId nftId
+    ) external view override returns (ObjectInfo memory info) {
+        return _info[nftId];
     }
 
+    function getName(
+        NftId nftId
+    ) external view returns (string memory name) {
+        return _string[nftId];
+    }
+
+    function getOwner(NftId nftId) external view override returns (address) {
+        return _chainNft.ownerOf(nftId.toInt());
+    }
 
-    function getNftId(address object) external view override returns(uint256 id) {
-        return _idByAddress[object];
+    function getChainNft() external view override returns (IChainNft) {
+        return _chainNft;
     }
 
+    // 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 _service[serviceNameHash][majorVersion];
+    }
 
-    function isRegistered(address object) external view override returns(bool) {
-        return _idByAddress[object] > 0;
+    // from IERC165
+    function supportsInterface(bytes4 interfaceId) external pure override returns (bool) {
+        return interfaceId == type(IRegistry).interfaceId;
     }
 
+    // from IRegistryLinked
+    function getRegistry() external view override returns (IRegistry registry) {
+        return this;
+    }
 
-    function getInfo(uint256 id) external view override returns(RegistryInfo memory info) {
-        return _info[id];
+    // from IRegisterable
+    function register() external pure override returns (NftId nftId) {
+        return zeroNftId();
     }
 
-    function getOwner(uint256 id) external view override returns(address) {
-        return _owner[id];
+    function getType() external pure override returns (ObjectType objectType) {
+        return REGISTRY();
     }
 
 
-    function _mint(address initialOwner)
-        internal
-        returns(uint256 id)
-    {
-        _idNext++;
+    function getOwner() public view override returns (address owner) {
+        return _nftId.gtz() ? this.getOwner(_nftId) : _initialOwner;
+    }
+
+    function getNftId() external view override (IRegisterable, IRegistry) returns (NftId nftId) {
+        return _nftId;
+    }
+
+    function getParentNftId() external view returns (NftId nftId) {
+        // we're the global registry
+        if(block.chainid == 1) {
+            return toNftId(_chainNftInternal.PROTOCOL_NFT_ID());
+        }
+        else {
+            return toNftId(_chainNftInternal.GLOBAL_REGISTRY_ID());
+        }
+    }
+
+    function getData() external pure returns (bytes memory data) {
+        return "";
+    }
+
+    // registry specific functions
+    function getProtocolOwner() external view override returns (address) {
+        return _protocolOwner;
+    }
+
+    /// @dev defines which types are allowed to register
+    function _setupValidTypes() internal {
+        _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[POLICY()] = true;
+        _isValidType[BUNDLE()] = true;
+    }
+
+    /// @dev defines which types - parent type relations are allowed to register
+    function _setupValidParentTypes() internal {
+        // registry as parent
+        _isValidParentType[TOKEN()][REGISTRY()] = true;
+        _isValidParentType[SERVICE()][REGISTRY()] = true;
+        _isValidParentType[INSTANCE()][REGISTRY()] = true;
+
+        // instance as parent
+        _isValidParentType[PRODUCT()][INSTANCE()] = true;
+        _isValidParentType[DISTRIBUTOR()][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;
+    }
 
-        id = _idNext;
-        _owner[id] = initialOwner;
-        _ids.push(id);
+    /// @dev protocol registration used to anchor the dip ecosystem relations
+    function _registerProtocol() virtual internal {
+        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
+        );
+
+        _info[protocolNftid] = protocolInfo;
     }
+
+    /// @dev registry registration
+    /// might also register the global registry when not on mainnet
+    function _registerRegistry() virtual internal returns (NftId registryNftId) {
+        uint256 registryId = _chainNftInternal.calculateTokenId(2);
+        registryNftId = toNftId(registryId);
+
+        // we're not the global registry
+        if(registryId != _chainNftInternal.GLOBAL_REGISTRY_ID()) {
+            _registerGlobalRegistry();
+        }
+
+        _chainNftInternal.mint(_protocolOwner, registryId);
+        _registerObjectInfo(this, registryNftId);
+    }
+
+
+    /// @dev global registry registration for non mainnet registries
+    function _registerGlobalRegistry() virtual internal {
+        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()
+        );
+
+        _info[nftId] = info;
+        _nftIdByAddress[objectAddress] = nftId;
+
+        // add logging
+    }
+
 }

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);
+}