@etherisc/gif-next 0.0.2-de0a1d3-009 → 0.0.2-e37834a-021

package/contracts/registry/RegistryService.sol

@@ -0,0 +1,375 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC20Metadata} from "@openzeppelin5/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IInstance} from "../instance/IInstance.sol";
+
+import {ContractDeployerLib} from "../shared/ContractDeployerLib.sol";
+import {IComponent, IComponentModule} from "../../contracts/instance/module/component/IComponent.sol";
+import {IPool} from "../../contracts/instance/module/pool/IPoolModule.sol";
+import {IBaseComponent} from "../../contracts/components/IBaseComponent.sol";
+import {IPoolComponent} from "../../contracts/components/IPoolComponent.sol";
+import {IProductComponent} from "../../contracts/components/IProductComponent.sol";
+import {IDistributionComponent} from "../../contracts/components/IDistributionComponent.sol";
+
+import {IVersionable} from "../../contracts/shared/IVersionable.sol";
+import {Versionable} from "../../contracts/shared/Versionable.sol";
+import {IRegisterable} from "../../contracts/shared/IRegisterable.sol";
+
+import {RoleId, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../contracts/types/RoleId.sol";
+import {ObjectType, REGISTRY, TOKEN, SERVICE, PRODUCT, ORACLE, POOL, TOKEN, INSTANCE, DISTRIBUTION, POLICY, BUNDLE} from "../../contracts/types/ObjectType.sol";
+import {StateId, ACTIVE, PAUSED} from "../../contracts/types/StateId.sol";
+import {NftId, NftIdLib, zeroNftId} from "../../contracts/types/NftId.sol";
+import {Fee, FeeLib} from "../../contracts/types/Fee.sol";
+import {Version, VersionPart, VersionLib} from "../../contracts/types/Version.sol";
+
+import {ServiceBase} from "../../contracts/instance/base/ServiceBase.sol";
+import {IService} from "../../contracts/instance/base/IService.sol";
+import {IRegistryService} from "./IRegistryService.sol";
+import {Registry} from "../registry/Registry.sol";
+
+contract RegistryService is
+    ServiceBase,
+    IRegistryService
+{
+    using NftIdLib for NftId;
+
+    error NotRegistryOwner();
+    error MissingAllowance();
+
+    error NotToken();
+    error NotService();
+    error NotComponent();
+    error NotInstance();
+
+    error InvalidAddress(address registerableAddress);
+    error InvalidInitialOwner(address initialOwner);
+    error SelfRegistration();
+    error InvalidType(ObjectType objectType);
+
+    string public constant NAME = "RegistryService";
+
+    // TODO update to real hash when registry is stable
+    bytes32 public constant REGISTRY_CREATION_CODE_HASH = bytes32(0);
+
+    address constant public NFT_LOCK_ADDRESS = address(0x1);
+
+    /// @dev 
+    //  msg.sender - ONLY registry owner
+    //      CAN register ANY non IRegisterable address
+    //      CAN register ONLY valid object-parent types combinations for TOKEN
+    //      CAN NOT register itself
+    // IMPORTANT: MUST NOT call untrusted contract inbetween calls to registry/instance (trusted contracts)
+    // motivation: registry/instance state may change during external call
+    // TODO it may be usefull to have transferable token nft in order to delist token, make it invalid for new beginings
+    // TODO: MUST prohibit registration of precompiles addresses
+    function registerToken(address tokenAddress)
+        external 
+        returns(NftId nftId) 
+    {
+        IRegisterable registerable = IRegisterable(tokenAddress);
+        bool isRegisterable;
+
+        // registryOwner can not register IRegisterable as TOKEN
+        try registerable.supportsInterface(type(IRegisterable).interfaceId) returns(bool result) {
+            isRegisterable = result;
+        } catch {
+            isRegisterable = false;
+        }
+
+        if(isRegisterable) {
+            revert NotToken();
+        } 
+
+        IRegistry registry = getRegistry();
+
+        if(msg.sender != registry.ownerOf(address(registry))) {
+            revert NotRegistryOwner();
+        }
+
+        IRegistry.ObjectInfo memory info = IRegistry.ObjectInfo(
+            zeroNftId(), // any value
+            registry.getNftId(address(registry)),
+            TOKEN(),
+            false, // isInterceptor
+            tokenAddress,
+            NFT_LOCK_ADDRESS,
+            "" // any value
+        );
+
+        nftId = registry.register(info);
+    }
+
+    /// @dev 
+    //  msg.sender - ONLY registry owner
+    //      CAN register ONLY valid object-parent types combinations for SERVICE
+    //      CAN register ONLY IRegisterable address he owns
+    //      CAN NOT register itself
+    // IMPORTANT: MUST NOT check owner before calling external contract
+    function registerService(IService service)
+        external
+        returns(
+            IRegistry.ObjectInfo memory info,
+            bytes memory data
+        ) 
+    {
+        if(service.supportsInterface(type(IService).interfaceId) == false) {
+            revert NotService();
+        } 
+
+        (
+            info, 
+            data
+        ) = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
+
+        IRegistry registry = getRegistry();
+
+        if(msg.sender != registry.ownerOf(address(registry))) {
+            revert NotRegistryOwner();
+        }
+
+        info.initialOwner = NFT_LOCK_ADDRESS;//registry.getLockAddress();
+        info.nftId = registry.register(info);
+
+        return (
+            info,
+            data
+        );
+    }
+
+    // anybody can register component if instance gives a corresponding role
+    //function registerComponent(IBaseComponent component, ObjectType componentType)
+    function registerComponent(IBaseComponent component, ObjectType componentType, address owner)
+        external
+        returns(
+            IRegistry.ObjectInfo memory info,
+            bytes memory data
+        ) 
+    {
+        if(component.supportsInterface(type(IBaseComponent).interfaceId) == false) {
+            revert NotComponent();
+        }
+
+        (
+            info, 
+            data
+        ) = _getAndVerifyContractInfo(component, componentType, owner);
+
+        IRegistry registry = getRegistry();
+        NftId serviceNftId = registry.getNftId(msg.sender);
+
+        if(registry.allowance(serviceNftId, componentType) == false) {
+            revert MissingAllowance();
+        }      
+
+        info.nftId = registry.register(info);
+
+        return (
+            info,
+            data
+        );  
+    }
+
+    // TODO: when called by approved service: add owner arg (service must pass it's msg.sender as owner) & check service allowance
+    //function registerInstance(IRegisterable instance, address owner)
+    function registerInstance(IRegisterable instance)
+        external 
+        returns(
+            IRegistry.ObjectInfo memory info,
+            bytes memory data
+        ) 
+    {
+        if(instance.supportsInterface(type(IInstance).interfaceId) == false) {
+            revert NotInstance();
+        }
+
+        (
+            info, 
+            data
+        ) = _getAndVerifyContractInfo(instance, INSTANCE(), msg.sender);// owner);
+
+        IRegistry registry = getRegistry();
+
+        //if(registry.allowance(registry.getNftId(msg.sender), INSTANCE()) == false) {
+        //    revert MissingAllowance();
+        //}
+
+        info.nftId = registry.register(info);     
+        
+        return (
+            info,
+            data            
+        );
+    }
+
+    function registerPolicy(IRegistry.ObjectInfo memory info)
+        external 
+        returns(NftId nftId) 
+    {
+        IRegistry registry = getRegistry();
+        NftId senderNftId = registry.getNftId(msg.sender);
+
+        if(registry.allowance(senderNftId, POLICY()) == false) {
+            revert MissingAllowance();
+        }
+
+        _verifyObjectInfo(info, POLICY());
+
+        nftId = registry.register(info);
+    }
+
+    function registerBundle(IRegistry.ObjectInfo memory info)
+        external 
+        returns(NftId nftId) 
+    {
+        IRegistry registry = getRegistry();
+        NftId senderNftId = registry.getNftId(msg.sender);
+
+        if(registry.allowance(senderNftId, BUNDLE()) == false) {
+            revert MissingAllowance();
+        }
+
+        _verifyObjectInfo(info, BUNDLE());
+
+        nftId = registry.register(info);
+    }
+
+
+    // From IService
+    function getName() public pure override(IService, ServiceBase) returns(string memory) {
+        return NAME;
+    }
+
+
+    // from Versionable
+
+    /// @dev top level initializer
+    // 1) registry is non upgradeable -> don't need a proxy and uses constructor !
+    // 2) deploy registry service first -> from its initialization func it is easier to deploy registry then vice versa
+    // 3) deploy registry -> pass registry service address as constructor argument
+    // registry is getting instantiated and locked to registry service address forever
+    function _initialize(
+        address owner, 
+        bytes memory registryByteCodeWithInitCode
+    )
+        internal
+        initializer
+        virtual override
+    {
+        bytes memory encodedConstructorArguments = abi.encode(
+            owner,
+            getMajorVersion());
+
+        bytes memory registryCreationCode = ContractDeployerLib.getCreationCode(
+            registryByteCodeWithInitCode,
+            encodedConstructorArguments);
+
+        address registryAddress = ContractDeployerLib.deploy(
+            registryCreationCode,
+            REGISTRY_CREATION_CODE_HASH);
+
+        IRegistry registry = IRegistry(registryAddress);
+        NftId registryNftId = registry.getNftId(registryAddress);
+
+        _initializeServiceBase(registryAddress, registryNftId, owner);
+
+        _registerInterface(type(IRegistryService).interfaceId);
+    }
+
+    // parent check done in registry because of approve()
+    function _getAndVerifyContractInfo(
+        IRegisterable registerable,
+        ObjectType objectType,
+        address owner
+    )
+        internal
+        returns(
+            IRegistry.ObjectInfo memory info, 
+            bytes memory data
+        )
+    {
+        (
+            info, 
+            data
+        ) = registerable.getInitialInfo();
+
+        if(info.objectAddress != address(registerable)) {
+            revert InvalidAddress(info.objectAddress);
+        }
+
+        if(
+            getRegistry().isRegistered(owner) ||
+            info.initialOwner != owner) { // contract owner protection
+            revert InvalidInitialOwner(info.initialOwner);
+        }
+
+        if(msg.sender == address(registerable)) {
+            revert SelfRegistration();
+        }
+        
+        if(info.objectType != objectType) {
+            revert InvalidType(info.objectType);
+        }
+
+        /*NftId parentNftId = info.parentNftId;
+        IRegistry.ObjectInfo memory parentInfo = getRegistry().getObjectInfo(parentNftId);
+
+        if(parentInfo.objectType != parentType) { // parent registration + type
+            revert InvalidParent(parentNftId);
+        }*/
+
+        return(
+            info,
+            data
+        );
+    }
+
+    // parent checks done in registry because of approve()
+    function _verifyObjectInfo(
+        IRegistry.ObjectInfo memory info,
+        ObjectType objectType
+    )
+        internal
+        view
+    {
+        if(info.objectAddress > address(0)) {
+            revert InvalidAddress(info.objectAddress);
+        }
+
+        if(
+            getRegistry().isRegistered(info.initialOwner) ||
+            info.initialOwner == address(0)) {
+            // TODO non registered address can register object(e.g. POLICY()) and then transfer associated nft to registered contract
+            // what are motivations to do so?
+            // at least registered contract can not register objects by itself, SERVICE, 
+            revert InvalidInitialOwner(info.initialOwner); 
+        }
+
+        // can catch all 3 if check that initialOwner is not registered
+        /*if(info.initialOwner == msg.sender) {
+            revert InitialOwnerIsParent();
+        }
+
+        if(info.initialOwner == address(this)) {
+            revert InitialOwnerIsService();
+        }
+
+        if(info.initialOwner == address(getRegistry())) {
+            revert InitialOwnerIsRegistry();
+        }*/
+
+        
+        if(info.objectType != objectType) {
+            revert InvalidType(info.objectType);
+        }
+
+        /*NftId parentNftId = info.parentNftId;
+        IRegistry.ObjectInfo memory parentInfo = getRegistry().getObjectInfo(parentNftId);
+
+        if(parentInfo.objectType != parentType) { // parent registration + type
+            revert InvalidParent(parentNftId);
+        }*/        
+    }
+}

package/contracts/registry/RegistryServiceManager.sol

@@ -0,0 +1,52 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import {Registry} from "./Registry.sol";
+import {IRegistry} from "./IRegistry.sol";
+import {IVersionable} from "../shared/IVersionable.sol";
+import {ProxyManager} from "../shared/ProxyManager.sol";
+import {RegistryService} from "./RegistryService.sol";
+
+
+contract RegistryServiceManager is
+    ProxyManager
+{
+    error ErrorRegistryServiceWithZeroAddress();
+
+    RegistryService private _registryService;
+
+    /// @dev initializes proxy manager with registry service implementation and deploys registry
+    constructor(
+        // address registryServiceImplementationAddress, 
+        // bytes memory registryBytecodeWithInitCode // type(Registry).creationCode
+    )
+        ProxyManager()
+    {
+        // if (registryServiceImplementationAddress == address(0)) { 
+        //     revert ErrorRegistryServiceWithZeroAddress(); 
+        // }
+
+        IVersionable versionable = deploy(
+            address(new RegistryService()), 
+            type(Registry).creationCode);
+
+        _registryService = RegistryService(address(versionable));
+
+        // link ownership of registry service manager ot nft owner of registry service
+        linkToRegistry(
+            address(_registryService.getRegistry()),
+            address(_registryService));
+
+        // implies that after this constructor call only upgrade functionality is available
+        _isDeployed = true;
+    }
+
+    //--- view functions ----------------------------------------------------//
+    function getRegistryService()
+        external
+        view
+        returns (RegistryService registryService)
+    {
+        return _registryService;
+    }
+}

package/contracts/shared/ContractDeployerLib.sol

@@ -0,0 +1,72 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+library ContractDeployerLib {
+
+    event LogContractDeployed(address contractAddress);
+
+    error ErrorCreationCodeHashMismatch(bytes32 expectedHash, bytes32 actualHash);
+
+    /// @dev deploys a new contract using the provided creation code
+    function deploy(
+        bytes memory creationCode,
+        bytes32 expectedCreationCodeHash
+    ) 
+        public
+        returns (address contractAdress)
+    {
+        // check against expected hash, if provided
+        if (expectedCreationCodeHash != bytes32(0)) {
+            bytes32 creationCodeHash = getHash(creationCode);
+            if (creationCodeHash != expectedCreationCodeHash) {
+                revert ErrorCreationCodeHashMismatch(expectedCreationCodeHash, creationCodeHash);
+            }
+        }
+
+        // solhint-disable no-inline-assembly
+        assembly {
+            contractAdress := create(0, add(creationCode, 0x20), mload(creationCode))  
+
+            if iszero(extcodesize(contractAdress)) {
+                revert(0, 0)
+            }
+        }
+        // solhint enable
+
+        emit LogContractDeployed(contractAdress);
+    }
+
+    /// @dev gets the creation code for the new contract
+    // for terminology see eg https://www.rareskills.io/post/ethereum-contract-creation-code
+    function getCreationCode(
+        bytes memory byteCodeWithInitCode, // what you get with type(<Contract>).creationCode
+        bytes memory encodedConstructorArguments // what you get with 
+    )
+        public
+        pure
+        returns (bytes memory creationCode)
+    {
+        return abi.encodePacked(byteCodeWithInitCode, encodedConstructorArguments);
+    }
+
+
+    function matchesWithHash(
+        bytes memory creationCode,
+        bytes32 expectedHash
+    )
+        public
+        pure
+        returns (bool isMatching)
+    {
+        return getHash(creationCode) == expectedHash;
+    }
+
+
+    function getHash(bytes memory creationCode)
+        public
+        pure
+        returns (bytes32 hash)
+    {
+        return keccak256(creationCode);
+    }
+}

package/contracts/shared/ERC165.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import {IERC165} from "@openzeppelin5/contracts/utils/introspection/IERC165.sol";
 
 contract ERC165 is IERC165 {
     mapping(bytes4 => bool) private _isSupported;

package/contracts/shared/IRegisterable.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import {IERC165} from "@openzeppelin5/contracts/utils/introspection/IERC165.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId} from "../types/NftId.sol";
@@ -12,13 +12,11 @@ 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 getInitialInfo() 
+        external 
+        view
+        returns (IRegistry.ObjectInfo memory, bytes memory data);
 
-    function getData() external view returns (bytes memory data);
-}
+}

package/contracts/shared/IVersionable.sol

@@ -1,9 +1,34 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {Blocknumber, blockNumber} from "../types/Blocknumber.sol";
-import {Timestamp, blockTimestamp} from "../types/Timestamp.sol";
-import {Version, VersionPart} from "../types/Version.sol";
+import {Blocknumber} from "../types/Blocknumber.sol";
+import {Timestamp} from "../types/Timestamp.sol";
+import {Version} from "../types/Version.sol";
+
+
+/// IMPORTANT
+// Upgradeable contract MUST:
+// 1) inherit from Versionable
+// 2) implement version() function
+// 3) implement internal _initialize() function with onlyInitializing modifier 
+// 4) implement internal _upgrade() function with onlyInitializing modifier (1st version MUST revert)
+// 5) have onlyInitialising modifier for each function callable inside _initialize()/_upgrade() (MUST use different functions for initialization/upgrade and normal operations)
+// 6) use default empty constructor -> _disableInitializer() is called from Versionable contructor
+// 7) use namespace storage
+// 8) since now inheritance is used for upgradability, contract MUST BE inherited ONLY by the next version 
+// Upgradeable contract SHOULD:
+// 9) define all non private methods as virtual (in order to be able to upgrade them latter)
+//    otherwise, it is still possible to upgrade contract, but everyone who is using it will have to switch to a new fucntions
+//    in some cases this ok but not in the others...
+//
+// IMPORTANT
+// Each version MUST:
+// 1) define namespace storage struct if accessing storage
+//      - DO NOT use structs inside, except
+//      - CAN use structs ONLY inside mappings
+// 2) ALWAYS define private getter if accessing storage
+//      - MUST use default implementation, CAN change ONLY return type
+//      - MUST use the same "LOCATION_V1"
 
 interface IVersionable {
 
@@ -15,13 +40,13 @@ interface IVersionable {
         Blocknumber activatedIn;
     }
 
-    event LogVersionableActivated(Version version, address implementation, address activatedBy);
+    event LogVersionableInitialized(Version version, address implementation, address activatedBy);
 
     // TODO uncomment when all implementations are ready
     /**
      * @dev IMPORTANT
      * implementation MUST be guarded by initializer modifier
-     * implementation MUST call internal function _activate() 
+     * implementation MUST call internal function Versionable._updateVersionHistory 
      * new version MUST inherit from previous version
      */
     function initialize(address implementation, address activatedBy, bytes memory activationData) external;
@@ -29,7 +54,7 @@ interface IVersionable {
     /**
      * @dev
      * implementation MUST be guarded by reinitializer(version().toUint64()) modifier
-     * implementation MUST call internal function _activate() 
+     * implementation MUST call internal function Versionable._updateVersionHistory
      * new version MUST inherit from previous version
      * the first verion MUST revert 
      */
@@ -38,10 +63,12 @@ interface IVersionable {
     /**
      * @dev returns true if the specified version has been activated for the current contract
      */
-    function isActivated(Version version) external view returns(bool);
+    function isInitialized(Version version) external view returns(bool);
 
     /**
-     * @dev returns currently active version of this contract
+     * @dev returns version of this contract
+     * each new implementation MUST implement this function
+     * version number MUST increase 
      */
     function getVersion() external pure returns(Version);
 
@@ -60,6 +87,10 @@ interface IVersionable {
      */
     function getVersionInfo(Version version) external view returns(VersionInfo memory versionInfo);
 
+    // TODO make sure it is needed here
+    /**
+     * @dev returns currently active version
+     */
     function getInitializedVersion() external view returns(uint64);
 
 }