@etherisc/gif-next 0.0.2-9d3eab3-323 → 0.0.2-9dc4419-573

package/contracts/registry/IRegistry.sol

@@ -3,22 +3,26 @@ pragma solidity ^0.8.20;
 
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
-import {ChainNft} from "./ChainNft.sol";
 import {NftId} from "../types/NftId.sol";
 import {ObjectType} from "../types/ObjectType.sol";
 import {VersionPart} from "../types/Version.sol";
+import {Timestamp} from "../types/Timestamp.sol";
 
 interface IRegistry is IERC165 {
 
     event LogRegistration(NftId nftId, NftId parentNftId, ObjectType objectType, bool isInterceptor, address objectAddress, address initialOwner);
+    event LogServiceRegistration(VersionPart majorVersion, ObjectType domain);
 
+    // registerService()
+    error CallerNotReleaseManager();
+    error ServiceAlreadyRegistered(address service);
 
     // register()
     error CallerNotRegistryService();
     error ServiceRegistration();
 
-    // registerService()
-    error CallerNotReleaseManager();
+    // registerWithCustomTypes()
+    error CoreTypeRegistration();
 
     // _register()
     error ZeroParentAddress();
@@ -36,15 +40,29 @@ interface IRegistry is IERC165 {
     }// TODO delete nftId and initialOwner(if not used) from struct
     // TODO strong disagree, keep nftId there (lets keep get object info return object consistent)
 
-    function registerService(ObjectInfo memory serviceInfo) external returns(NftId nftId);
+    struct ReleaseInfo {
+        ObjectType[] domains;
+        Timestamp createdAt;
+        //Timestamp updatedAt;
+    }
+
+    function registerService(
+        ObjectInfo memory serviceInfo, 
+        VersionPart serviceVersion, 
+        ObjectType serviceDomain
+    ) external returns(NftId nftId);
 
     function register(ObjectInfo memory info) external returns (NftId nftId);
 
-    function getMajorVersionMin() external view returns (VersionPart);
+    function registerWithCustomType(ObjectInfo memory info) external returns (NftId nftId);
 
-    function getMajorVersionMax() external view returns (VersionPart);
+    function getInitialVersion() external view returns (VersionPart);
 
-    function getMajorVersion() external view returns (VersionPart);
+    function getNextVersion() external view returns (VersionPart);
+
+    function getLatestVersion() external view returns (VersionPart);
+
+    function getReleaseInfo(VersionPart version) external view returns (ReleaseInfo memory);
 
     function getObjectCount() external view returns (uint256);
 
@@ -66,12 +84,18 @@ interface IRegistry is IERC165 {
 
     function isRegisteredService(address contractAddress) external view returns (bool);
 
+    function isRegisteredComponent(address object) external view returns (bool);
+
+    function isValidRelease(VersionPart version) external view returns (bool);
+
     function getServiceAddress(
-        ObjectType serviceType, 
+        ObjectType serviceDomain, 
         VersionPart releaseVersion
     ) external view returns (address serviceAddress);
 
-    function getChainNft() external view returns (ChainNft);
+    function getReleaseManagerAddress() external view returns (address);
+
+    function getChainNftAddress() external view returns (address);
 
     function getOwner() external view returns (address);
 }

package/contracts/registry/IRegistryService.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+// import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
 import {NftId} from "../types/NftId.sol";
 import {ObjectType} from "../types/ObjectType.sol";
@@ -10,11 +10,12 @@ import {IService} from "../shared/IService.sol";
 import {IRegistry} from "./IRegistry.sol";
 
 import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IBaseComponent} from "../components/IBaseComponent.sol";
+import {IComponent} from "../components/IComponent.sol";
 
 interface IRegistryService is 
-     IService, 
-     IAccessManaged 
+     IService
+     // TODO cleanup
+     // IAccessManaged 
 {
      error SelfRegistration();
      error NotRegistryOwner();
@@ -35,21 +36,30 @@ interface IRegistryService is
      struct FunctionConfig
      {
           ObjectType serviceDomain;
-          bytes4[] selector;
+          bytes4[] selectors;
      }
 
+     function getFunctionConfigs()
+          external
+          pure
+          returns(
+               FunctionConfig[] memory config
+          );
+
      // TODO used by service -> add owner arg 
-     function registerInstance(IRegisterable instance)
-          external returns(IRegistry.ObjectInfo memory info, bytes memory data); 
+     function registerInstance(IRegisterable instance, address owner)
+          external returns(IRegistry.ObjectInfo memory info); 
+
+     function registerProduct(IComponent product, address owner)
+          external returns(IRegistry.ObjectInfo memory info);
 
-     function registerProduct(IBaseComponent product, address owner)
-          external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+     function registerPool(IComponent pool, address owner)
+          external returns(IRegistry.ObjectInfo memory info);
 
-     function registerPool(IBaseComponent pool, address owner)
-          external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+     function registerDistribution(IComponent distribution, address owner)
+          external returns(IRegistry.ObjectInfo memory info);
 
-     function registerDistribution(IBaseComponent distribution, address owner)
-          external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+     function registerDistributor(IRegistry.ObjectInfo memory info) external returns(NftId nftId);
 
      function registerPolicy(IRegistry.ObjectInfo memory info) external returns(NftId nftId);
 

package/contracts/registry/ITransferInterceptor.sol

@@ -2,5 +2,6 @@
 pragma solidity ^0.8.20;
 
 interface ITransferInterceptor {
+    function nftMint(address to, uint256 tokenId) external;
     function nftTransferFrom(address from, address to, uint256 tokenId) external;
 }

package/contracts/registry/Registry.sol

@@ -1,54 +1,50 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
-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 {NftId, toNftId, zeroNftId} from "../types/NftId.sol";
+import {VersionPart} from "../types/Version.sol";
+import {ObjectType, PROTOCOL, REGISTRY, TOKEN, SERVICE, INSTANCE, STAKE, PRODUCT, DISTRIBUTION, DISTRIBUTOR, ORACLE, POOL, POLICY, BUNDLE} from "../types/ObjectType.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)
+// IMPORTANT
 // 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)
+// 1) IService address by release manager (SERVICE of domain SERVICE aka registry service aka release creation)
+// 2) IService address by release manager (SERVICE of domain !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(NftId nftId => ObjectInfo info) private _info;
+    mapping(address object => NftId nftId) private _nftIdByAddress;
+
+    mapping(VersionPart version => mapping(ObjectType serviceDomain => address)) private _service;
+
+    mapping(ObjectType objectType => bool) private _coreTypes;
 
     mapping(ObjectType objectType => mapping(
-            ObjectType parentType => bool)) internal _isValidContractCombination;
+            ObjectType parentType => bool)) private _coreContractCombinations;
 
     mapping(ObjectType objectType => mapping(
-            ObjectType parentType => bool)) internal _isValidObjectCombination;
+            ObjectType parentType => bool)) private _coreObjectCombinations;
 
-    NftId internal _registryNftId;
-    ChainNft internal _chainNft;
+    NftId private _registryNftId;
+    ChainNft private _chainNft;
 
-    ReleaseManager internal _releaseManager;
+    ReleaseManager private _releaseManager;
 
     modifier onlyRegistryService() {
         if(!_releaseManager.isActiveRegistryService(msg.sender)) {
@@ -64,27 +60,26 @@ contract Registry is
         _;
     }
 
-    constructor(address releaseManager, VersionPart initialVersion)
+    constructor()
     {
-        require(releaseManager > address(0), "Registry: release manager is 0");
-        require(initialVersion.toInt() > 0, "Registry: initial version is 0");
-
-        _releaseManager = ReleaseManager(releaseManager);
+        _releaseManager = ReleaseManager(msg.sender);
 
         // deploy NFT 
-        _chainNft = new ChainNft(address(this));// adds 10kb to deployment size
+        _chainNft = new ChainNft(address(this));
 
         // initial registry setup
         _registerProtocol();
         _registerRegistry();
 
-        // set object parent relations
-        _setupValidObjectParentCombinations();
-
-        _registerInterface(type(IRegistry).interfaceId);
+        // set object types and object parent relations
+        _setupValidCoreTypesAndCombinations();
     }
 
-    function registerService(ObjectInfo memory info)
+    function registerService(
+        ObjectInfo memory info, 
+        VersionPart version, 
+        ObjectType domain
+    )
         external
         onlyReleaseManager
         returns(NftId nftId)
@@ -93,9 +88,21 @@ contract Registry is
         if(info.objectType != SERVICE()) {
             revert();
         }
-        info.initialOwner = NFT_LOCK_ADDRESS <- if services are access managed
+        if(info.parentType != REGISTRY()) {
+            revert();
+        }        
+        info.initialOwner == NFT_LOCK_ADDRESS <- if services are access managed
         */
+
+        if(_service[version][domain] > address(0)) {
+            revert ServiceAlreadyRegistered(info.objectAddress);
+        }
+
+        _service[version][domain] = info.objectAddress; // nftId;
+
         nftId = _register(info);
+
+        emit LogServiceRegistration(version, domain);
     }
 
     function register(ObjectInfo memory info)
@@ -103,16 +110,58 @@ contract Registry is
         onlyRegistryService
         returns(NftId nftId)
     {
+        ObjectType objectType = info.objectType;
+        ObjectType parentType = _info[info.parentNftId].objectType;
+
+        // TODO do not need it here -> SERVICE is no longer part of _coreContractCombinations
         // no service registrations
-        if(info.objectType == SERVICE()) {
+        if(objectType == SERVICE()) {
             revert ServiceRegistration();
         }
 
+        // only valid core types combinations
+        if(info.objectAddress == address(0)) 
+        {
+            if(_coreObjectCombinations[objectType][parentType] == false) {
+                revert InvalidTypesCombination(objectType, parentType);
+            }
+        }
+        else
+        {
+            if(_coreContractCombinations[objectType][parentType] == false) {
+                revert InvalidTypesCombination(objectType, parentType);
+            }
+        }
+
         nftId = _register(info);
     }
 
+    function registerWithCustomType(ObjectInfo memory info)
+        external
+        onlyRegistryService
+        returns(NftId nftId)
+    {
+        ObjectType objectType = info.objectType;
+        ObjectType parentType = _info[info.parentNftId].objectType;
+
+        if(_coreTypes[objectType]) {
+            revert CoreTypeRegistration();
+        }
+
+        if(
+            parentType == PROTOCOL() ||
+            parentType == REGISTRY() ||
+            parentType == SERVICE()
+        ) {
+            revert InvalidTypesCombination(objectType, parentType);
+        }
+
+        _register(info);
+    }
+
+
     /// @dev earliest GIF major version 
-    function getMajorVersionMin() external view returns (VersionPart) {
+    function getInitialVersion() external view returns (VersionPart) {
         return _releaseManager.getInitialVersion();
     }
 
@@ -123,28 +172,36 @@ contract Registry is
     // 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) {
+    function getNextVersion() external view returns (VersionPart) {
         return _releaseManager.getNextVersion();
     }
 
     /// @dev latest active GIF release version 
-    function getMajorVersion() external view returns (VersionPart) { 
+    function getLatestVersion() external view returns (VersionPart) { 
         return _releaseManager.getLatestVersion();
     }
 
-    function getObjectCount() external view override returns (uint256) {
+    function getReleaseInfo(VersionPart version) external view returns (ReleaseInfo memory) {
+        return _releaseManager.getReleaseInfo(version);
+    }
+
+    function getObjectCount() external view returns (uint256) {
         return _chainNft.totalSupply();
     }
 
+    function getReleaseManagerAddress() external view returns (address) {
+        return address(_releaseManager);
+    }
+
     function getNftId() external view returns (NftId nftId) {
         return _registryNftId;
     }
 
-    function getNftId(address object) external view override returns (NftId id) {
+    function getNftId(address object) external view returns (NftId id) {
         return _nftIdByAddress[object];
     }
 
-    function ownerOf(NftId nftId) public view override returns (address) {
+    function ownerOf(NftId nftId) public view returns (address) {
         return _chainNft.ownerOf(nftId.toInt());
     }
 
@@ -152,42 +209,65 @@ contract Registry is
         return _chainNft.ownerOf(_nftIdByAddress[contractAddress].toInt());
     }
 
-    function getObjectInfo(NftId nftId) external view override returns (ObjectInfo memory) {
+    function getObjectInfo(NftId nftId) external view returns (ObjectInfo memory) {
         return _info[nftId];
     }
 
-    function getObjectInfo(address object) external view override returns (ObjectInfo memory) {
+    function getObjectInfo(address object) external view returns (ObjectInfo memory) {
         return _info[_nftIdByAddress[object]];
     }
 
-    function isRegistered(NftId nftId) public view override returns (bool) {
+    function isRegistered(NftId nftId) public view returns (bool) {
         return _info[nftId].objectType.gtz();
     }
 
-    function isRegistered(address object) external view override returns (bool) {
+    function isRegistered(address object) external view returns (bool) {
         return _nftIdByAddress[object].gtz();
     }
 
-    function isRegisteredService(address object) external view override returns (bool) {
-        return _nftIdByAddress[object].gtz() && _info[_nftIdByAddress[object]].objectType == SERVICE();
+    function isRegisteredService(address object) external view returns (bool) {
+        return _info[_nftIdByAddress[object]].objectType == SERVICE();
+    }
+
+    function isRegisteredComponent(address object) external view returns (bool) {
+        NftId objectParentNftId = _info[_nftIdByAddress[object]].parentNftId;
+        return _info[objectParentNftId].objectType == INSTANCE();
+    }
+
+    function isValidRelease(VersionPart version) external view returns (bool)
+    {
+        return _releaseManager.isValidRelease(version);
     }
 
     function getServiceAddress(
-        ObjectType serviceType, 
+        ObjectType serviceDomain, 
         VersionPart releaseVersion
-    ) external view returns (address)
+    ) external view returns (address service)
     {
-        return _releaseManager.getService(releaseVersion, serviceType);
+        // TODO how can I get service address while release is not validated/activated ?!! -> user will check validity of release on its own
+        //if(_releaseManager.isValidRelease(releaseVersion)) { 
+            service =  _service[releaseVersion][serviceDomain]; 
+        //}
     }
 
-    function getChainNft() external view override returns (ChainNft) {
-        return _chainNft;
+    function getChainNftAddress() external view override returns (address) {
+        return address(_chainNft);
     }
 
     function getOwner() public view returns (address owner) {
         return ownerOf(address(this));
     }
 
+    // IERC165
+
+    function supportsInterface(bytes4 interfaceId) external pure returns (bool) {
+        if(interfaceId == type(IERC165).interfaceId || interfaceId == type(IRegistry).interfaceId) {
+            return true;
+        }
+
+        return false;
+    }
+
     // Internals
 
     /// @dev registry protects only against tampering existing records, registering with invalid types pairs and 0 parent address
@@ -211,28 +291,14 @@ contract Registry is
         }
 
         address interceptor = _getInterceptor(info.isInterceptor, info.objectAddress, parentInfo.isInterceptor, parentAddress);
+        uint256 tokenId = _chainNft.getNextTokenId();
+        nftId = toNftId(tokenId);
 
-        // TODO does external call
-        // compute next nftId, do all checks and stores, mint() at most end...
-        uint256 mintedTokenId = _chainNft.mint(
-            info.initialOwner,
-            interceptor,
-            EMPTY_URI);
-        nftId = toNftId(mintedTokenId);
-
-        // 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;
 
         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;
 
             if(_nftIdByAddress[contractAddress].gtz()) { 
@@ -241,14 +307,16 @@ contract Registry is
 
             _nftIdByAddress[contractAddress] = nftId;
         }
-        else
-        {
-            if(_isValidObjectCombination[objectType][parentType] == false) {
-                revert InvalidTypesCombination(objectType, parentType);
-            }
-        }
 
         emit LogRegistration(nftId, parentNftId, objectType, info.isInterceptor, info.objectAddress, info.initialOwner);
+
+        // calls nft receiver(1) and interceptor(2)
+        uint256 mintedTokenId = _chainNft.mint(
+            info.initialOwner,
+            interceptor,
+            EMPTY_URI);
+        assert(mintedTokenId == tokenId);
+        
     }
 
     /// @dev obtain interceptor address for this nft if applicable, address(0) otherwise
@@ -359,27 +427,41 @@ contract Registry is
     // 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() 
+    function _setupValidCoreTypesAndCombinations() 
         private 
     {
+        _coreTypes[REGISTRY()] = true;
+        _coreTypes[SERVICE()] = true;
+        _coreTypes[TOKEN()] = true;
+        _coreTypes[INSTANCE()] = true;
+        _coreTypes[PRODUCT()] = true;
+        _coreTypes[POOL()] = true;
+        _coreTypes[DISTRIBUTION()] = true;
+        _coreTypes[POLICY()] = true;
+        _coreTypes[BUNDLE()] = true;
+        _coreTypes[STAKE()] = true;
+        
         // registry as parent, ONLY registry owner
-        _isValidContractCombination[TOKEN()][REGISTRY()] = true;
-        _isValidContractCombination[SERVICE()][REGISTRY()] = true;
+        //_coreContractCombinations[REGISTRY()][REGISTRY()] = true; // only for global regstry
+        _coreContractCombinations[TOKEN()][REGISTRY()] = true;
+        //_coreContractCombinations[SERVICE()][REGISTRY()] = true;// do not need it here -> registerService() registers exactly this combination
 
         // registry as parent, ONLY approved
-        _isValidContractCombination[INSTANCE()][REGISTRY()] = true;
+        _coreContractCombinations[INSTANCE()][REGISTRY()] = true;
 
         // instance as parent, ONLY approved
-        _isValidContractCombination[PRODUCT()][INSTANCE()] = true;
-        _isValidContractCombination[DISTRIBUTION()][INSTANCE()] = true;
-        _isValidContractCombination[ORACLE()][INSTANCE()] = true;
-        _isValidContractCombination[POOL()][INSTANCE()] = true;
+        _coreContractCombinations[PRODUCT()][INSTANCE()] = true;
+        _coreContractCombinations[DISTRIBUTION()][INSTANCE()] = true;
+        _coreContractCombinations[ORACLE()][INSTANCE()] = true;
+        _coreContractCombinations[POOL()][INSTANCE()] = true;
+
+        _coreObjectCombinations[DISTRIBUTOR()][DISTRIBUTION()] = true;
 
         // product as parent, ONLY approved
-        _isValidObjectCombination[POLICY()][PRODUCT()] = true;
+        _coreObjectCombinations[POLICY()][PRODUCT()] = true;
 
         // pool as parent, ONLY approved
-        _isValidObjectCombination[BUNDLE()][POOL()] = true;
-        _isValidObjectCombination[STAKE()][POOL()] = true;
+        _coreObjectCombinations[BUNDLE()][POOL()] = true;
+        _coreObjectCombinations[STAKE()][POOL()] = true;
     }
-}
+}