@etherisc/gif-next 0.0.2-ce8407f-016 → 0.0.2-d243ae6-520

package/contracts/registry/ChainNft.sol

@@ -1,19 +1,28 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {ERC721, ERC721Enumerable} from "@openzeppelin5/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
-import {IERC721} from "@openzeppelin5/contracts/token/ERC721/IERC721.sol";
+import {ERC721, ERC721Enumerable} from "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
+import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
 
-import {IChainNft} from "./IChainNft.sol";
 import {ITransferInterceptor} from "./ITransferInterceptor.sol";
 
-contract ChainNft is ERC721Enumerable, IChainNft {
-    string public constant NAME = "Dezentralized Insurance Protocol Registry";
-    string public constant SYMBOL = "DIPR";
+contract ChainNft is ERC721Enumerable {
+
+    // constants
+    string public constant NAME = "Dezentralized Insurance Protocol NFT";
+    string public constant SYMBOL = "DIPNFT";
 
     uint256 public constant PROTOCOL_NFT_ID = 1101;
     uint256 public constant GLOBAL_REGISTRY_ID = 2101;
 
+    // custom errors
+    error CallerNotRegistry(address caller);
+    error RegistryAddressZero();
+    error NftUriEmpty();
+    error NftUriAlreadySet();
+
+    // contract state
+
     // remember interceptors
     mapping(uint256 tokenId => address interceptor) private _interceptor;
 
@@ -31,17 +40,24 @@ contract ChainNft is ERC721Enumerable, IChainNft {
     uint256 internal _totalMinted;
 
     modifier onlyRegistry() {
-        require(msg.sender == _registry, "ERROR:NFT-001:CALLER_NOT_REGISTRY");
+        if (msg.sender != _registry) { revert CallerNotRegistry(msg.sender); }
         _;
     }
 
     constructor(address registry) ERC721(NAME, SYMBOL) {
-        require(registry != address(0), "ERROR:NFT-010:REGISTRY_ZERO");
+        if (registry == address(0)) { revert RegistryAddressZero(); }
 
         _registry = registry;
-
         _chainIdInt = block.chainid;
-        _chainIdDigits = _countDigits(_chainIdInt);
+        _chainIdDigits = 0;
+
+        // count digis
+        uint256 num = _chainIdInt;
+        while (num != 0) {
+            _chainIdDigits++;
+            num /= 10;
+        }
+
         _chainIdMultiplier = 10 ** _chainIdDigits;
         _idNext = 4;
     }
@@ -77,8 +93,8 @@ contract ChainNft is ERC721Enumerable, IChainNft {
             _uri[tokenId] = uri;
         }
 
-        _safeMint(to, tokenId);
         _totalMinted++;
+        _safeMint(to, tokenId);
     }
 
 
@@ -95,7 +111,7 @@ contract ChainNft is ERC721Enumerable, IChainNft {
     }
 
 
-    function burn(uint256 tokenId) external override onlyRegistry {
+    function burn(uint256 tokenId) external onlyRegistry {
         _requireOwned(tokenId);
         _burn(tokenId);
         delete _uri[tokenId];
@@ -104,29 +120,36 @@ contract ChainNft is ERC721Enumerable, IChainNft {
     function setURI(
         uint256 tokenId,
         string memory uri
-    ) external override onlyRegistry {
-        require(bytes(uri).length > 0, "ERROR:CRG-011:URI_EMPTY");
+    ) external onlyRegistry {
+        if (bytes(uri).length == 0) { revert NftUriEmpty(); }
+        if (bytes(_uri[tokenId]).length > 0) { revert NftUriAlreadySet(); }
 
         _requireOwned(tokenId);
         _uri[tokenId] = uri;
     }
 
-    function exists(uint256 tokenId) external view override returns (bool) {
+    function exists(uint256 tokenId) external view returns (bool) {
         return _ownerOf(tokenId) != address(0);
     }
 
     function tokenURI(
         uint256 tokenId
     ) public view override returns (string memory) {
+        // gif generally does not revert for view functions
+        // this is an exception to keep the openzeppelin nft semantics
         _requireOwned(tokenId);
         return _uri[tokenId];
     }
 
-    function getRegistryAddress() external view override returns (address) {
+    function getInterceptor(uint256 tokenId) external view returns (address) {
+        return _interceptor[tokenId];
+    }
+
+    function getRegistryAddress() external view returns (address) {
         return _registry;
     }
 
-    function totalMinted() external view override returns (uint256) {
+    function totalMinted() external view returns (uint256) {
         return _totalMinted;
     }
 
@@ -176,12 +199,4 @@ contract ChainNft is ERC721Enumerable, IChainNft {
         id = calculateTokenId(_idNext);
         _idNext++;
     }
-
-    function _countDigits(uint256 num) private pure returns (uint256 count) {
-        count = 0;
-        while (num != 0) {
-            count++;
-            num /= 10;
-        }
-    }
 }

package/contracts/registry/IRegistry.sol

@@ -1,20 +1,19 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC165} from "@openzeppelin5/contracts/utils/introspection/IERC165.sol";
+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 {IChainNft} from "./IChainNft.sol";
 
 interface IRegistry is IERC165 {
 
-    event LogRegistration(NftId indexed nftId, NftId parentNftId, ObjectType objectType, bool isInterceptor, address objectAddress, address initialOwner);
+    event LogRegistration(ObjectInfo info);
 
     event LogServiceNameRegistration(string serviceName, VersionPart majorVersion); 
 
-    event LogApproval(NftId indexed nftId, ObjectType objectType);
 
     struct ObjectInfo {
         NftId nftId;
@@ -25,24 +24,10 @@ interface IRegistry is IERC165 {
         address initialOwner;
         bytes data;
     }// 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 register(ObjectInfo memory info) external returns (NftId nftId);
     
-    function registerFrom(
-        address from, 
-        ObjectInfo memory info
-    ) external returns (NftId nftId);
-
-    function approve(
-        NftId registrar,
-        ObjectType object,
-        ObjectType parent
-    ) external;
-
-    function allowance(
-        NftId registrar,
-        ObjectType object
-    ) external view returns (bool);
 
     function getObjectCount() external view returns (uint256);
 
@@ -67,7 +52,7 @@ interface IRegistry is IERC165 {
         VersionPart majorVersion
     ) external view returns (address serviceAddress);
 
-    function getChainNft() external view returns (IChainNft);
+    function getChainNft() external view returns (ChainNft);
 
     function getOwner() external view returns (address);
 }

package/contracts/registry/IRegistryService.sol

@@ -1,14 +1,14 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {NftId} from "../../contracts/types/NftId.sol";
-import {ObjectType} from "../../contracts/types/ObjectType.sol";
-import {RoleId} from "../../contracts/types/RoleId.sol";
-import {IService} from "../../contracts/instance/base/IService.sol";
-import {IRegistry} from "../../contracts/registry/IRegistry.sol";
+import {NftId} from "../types/NftId.sol";
+import {ObjectType} from "../types/ObjectType.sol";
+import {RoleId} from "../types/RoleId.sol";
+import {IService} from "../shared/IService.sol";
+import {IRegistry} from "./IRegistry.sol";
 
-import {IRegisterable} from "../../contracts/shared/IRegisterable.sol";
-import {IBaseComponent} from "../../contracts/components/IBaseComponent.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IBaseComponent} from "../components/IBaseComponent.sol";
 
 interface IRegistryService is IService {
 
@@ -16,12 +16,18 @@ interface IRegistryService is IService {
 
     function registerService(IService service)  external returns(IRegistry.ObjectInfo memory info, bytes memory data);
 
-    function registerComponent(IBaseComponent component, ObjectType componentType, address owner) 
-        external returns(IRegistry.ObjectInfo memory info, bytes memory data);
-
     function registerInstance(IRegisterable instance)
         external returns(IRegistry.ObjectInfo memory info, bytes memory data); 
 
+    function registerProduct(IBaseComponent product, address owner)
+         external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+
+    function registerPool(IBaseComponent pool, address owner)
+         external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+
+    function registerDistribution(IBaseComponent distribution, address owner)
+         external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+
     function registerPolicy(IRegistry.ObjectInfo memory info) external returns(NftId nftId); // -> easy to upgrade
 
     function registerBundle(IRegistry.ObjectInfo memory info) external returns(NftId nftId); 

package/contracts/registry/Registry.sol

@@ -2,9 +2,8 @@
 pragma solidity ^0.8.20;
 
 import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IService} from "../instance/base/IService.sol";
+import {IService} from "../shared/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";
@@ -47,35 +46,26 @@ contract Registry is
     uint256 public constant REGISTRY_SERVICE_TOKEN_SEQUENCE_ID = 3;
     string public constant EMPTY_URI = "";
 
-    mapping(NftId nftId => ObjectInfo info) _info;
-    mapping(address object => NftId nftId) _nftIdByAddress;
+    mapping(NftId nftId => ObjectInfo info) internal _info;
+    mapping(address object => NftId nftId) internal _nftIdByAddress;
 
     mapping(NftId registrator => mapping(
-            ObjectType objectType => bool)) _isApproved;
+            ObjectType objectType => bool)) internal _isApproved;
 
     mapping(ObjectType objectType => mapping(
-            ObjectType parentType => bool)) _isValidContractCombination;
+            ObjectType parentType => bool)) internal _isValidContractCombination;
 
     mapping(ObjectType objectType => mapping(
-            ObjectType parentType => bool)) _isValidObjectCombination;
+            ObjectType parentType => bool)) internal _isValidObjectCombination;
 
-    mapping(NftId nftId => string name) _string;
+    mapping(NftId nftId => string name) internal _string;
     mapping(bytes32 serviceNameHash => mapping(
-            VersionPart majorVersion => address service)) _service;
+            VersionPart majorVersion => address service)) internal _service;
 
-    NftId _registryNftId;
-    NftId _serviceNftId; // set in stone upon registry creation
-    IChainNft _chainNft;
-    ChainNft _chainNftInternal;
+    NftId internal _registryNftId;
+    NftId internal _serviceNftId; // set in stone upon registry creation
+    ChainNft internal _chainNft;
 
-    /*
-    modifier onlyInitialOwner() {
-        if(
-            msg.sender != getOwner() ||
-            msg.sender != _info[_registryNftId].initialOwner) {
-            revert NotInitialOwner();
-        }
-    }*/
 
     modifier onlyOwner() {
         if(msg.sender != getOwner()) {
@@ -98,8 +88,7 @@ contract Registry is
         require(majorVersion.toInt() == MAJOR_VERSION_MIN, "Registry: initial major version of registry service is not MAJOR_VERSION_MIN");
 
         // deploy NFT 
-        _chainNftInternal = new ChainNft(address(this));// adds 10kb to deployment size
-        _chainNft = IChainNft(_chainNftInternal);
+        _chainNft = new ChainNft(address(this));// adds 10kb to deployment size
 
         // initial registry setup
         _registerProtocol();
@@ -113,8 +102,6 @@ contract Registry is
     }
 
     /// @dev registry protects only against tampering existing records, registering with invalid types pairs and 0 parent address
-    // IMPORTANT: rare case when parentNftId is not registered and == next nftId -> technincally this is ZeroParentAddress error
-    // to catch this check parent address before minting !!!!
     // TODO service registration means its approval for some type?
     // TODO registration of precompile addresses
     function register(ObjectInfo memory info)
@@ -139,8 +126,6 @@ contract Registry is
         address interceptor = _getInterceptor(info.isInterceptor, info.objectAddress, parentInfo.isInterceptor, parentAddress);
 
         // TODO does external call
-        // check for receiver in registry service?
-        // use unsafe transfer?
         uint256 mintedTokenId = _chainNft.mint(
             info.initialOwner,
             interceptor,
@@ -170,33 +155,8 @@ contract Registry is
             _nftIdByAddress[contractAddress] = nftId;
 
             // special case
-            if(objectType == SERVICE())
-            {
-                (
-                    string memory serviceName,
-                    VersionPart majorVersion
-                ) = abi.decode(info.data, (string, VersionPart));
-                bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
-
-                // TODO MUST guarantee consistency of service.getVersion() and majorVersion here
-                // TODO update _serviceNftId when registryService with new major version is registered? -> it is fixed in current setup
-                // TODO do not use names -> each object type is registered by corresponding service -> conflicting with approve()
-                if(
-                    majorVersion.toInt() < MAJOR_VERSION_MIN ||
-                    (majorVersion.toInt() > MAJOR_VERSION_MIN &&
-                    _service[serviceNameHash][VersionLib.toVersionPart(majorVersion.toInt() - 1)] == address(0) )
-                ) {
-                    revert InvalidServiceVersion(majorVersion);
-                }
-                
-                if(_service[serviceNameHash][majorVersion] != address(0)) {
-                    revert ServiceNameAlreadyRegistered(serviceName, majorVersion);
-                }
-
-                _string[nftId] = serviceName;
-                _service[serviceNameHash][majorVersion] = contractAddress;
-
-                emit LogServiceNameRegistration(serviceName, majorVersion); 
+            if(objectType == SERVICE()) {
+                _registerService(info);
             }
         }
         else
@@ -206,67 +166,7 @@ contract Registry is
             }
         }
 
-        emit LogRegistration(nftId, info.parentNftId, info.objectType, info.isInterceptor, info.objectAddress, info.initialOwner);
-    }
-
-    function registerFrom(
-        address from, 
-        ObjectInfo memory info
-    ) external returns (NftId nftId) 
-    {
-        revert();
-    }
-    
-
-    /// @dev 
-    // msg.sender - registry owner 
-    //     CAN approve only registered service contract
-    //     CAN approve any combination specified in _isValidCombination
-    //     CAN NOT approve itself
-    // TODO in case where exists exactly one registered service per objectType (and major version):
-    // - registration and approve is a single operation, no need for separate approve() function
-    // - then approve can be used to adding new valid object-parent combinations???
-    function approve(
-        NftId serviceNftId,
-        ObjectType objectType,
-        ObjectType parentType 
-    ) 
-        public
-        onlyOwner()
-    {
-        address serviceAddress = _info[serviceNftId].objectAddress;
-            
-        if(_nftIdByAddress[serviceAddress].eqz()) {
-            revert NotRegisteredContract(serviceNftId);
-        }
-
-        if(_info[serviceNftId].objectType != SERVICE()) {
-            revert NotService(serviceNftId);
-        }
-
-        if(
-            _isValidContractCombination[objectType][parentType] == false &&
-            _isValidObjectCombination[objectType][parentType] == false) {
-            revert InvalidTypesCombination(objectType, parentType);
-        }
-
-        _isApproved[serviceNftId][objectType] = true;
-
-        emit LogApproval(serviceNftId, objectType);
-    }
-
-    /// @dev returns false for registry owner nft
-    // TODO allowance by address?
-    // TODO checked by registry service -> but registry owner can upgrade registry service not to check allowance....
-    function allowance(
-        NftId nftId,
-        ObjectType object
-    ) 
-        public
-        view 
-        returns (bool)
-    {
-        return _isApproved[nftId][object];
+        emit LogRegistration(info);
     }
 
     // from IRegistry
@@ -319,7 +219,7 @@ contract Registry is
         return _service[serviceNameHash][majorVersion];
     }
 
-    function getChainNft() external view override returns (IChainNft) {
+    function getChainNft() external view override returns (ChainNft) {
         return _chainNft;
     }
 
@@ -327,16 +227,74 @@ contract Registry is
         return ownerOf(address(this));
     }
 
-    // Internals, called only in constructor
+    // Internals
+
+    function _registerService(ObjectInfo memory info)
+        internal
+    {
+        (
+            string memory serviceName,
+            VersionPart majorVersion
+        ) = abi.decode(info.data, (string, VersionPart));
+        bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
+
+        // TODO MUST guarantee consistency of service.getVersion() and majorVersion here
+        // TODO update _serviceNftId when registryService with new major version is registered? -> it is fixed in current setup -> can lock up
+        // TODO do not use names -> each object type is registered by corresponding service -> conflicting with approve()
+        if(
+            majorVersion.toInt() < MAJOR_VERSION_MIN ||
+            (majorVersion.toInt() > MAJOR_VERSION_MIN &&
+            _service[serviceNameHash][VersionLib.toVersionPart(majorVersion.toInt() - 1)] == address(0) )
+        ) {
+            revert InvalidServiceVersion(majorVersion);
+        }
+        
+        if(_service[serviceNameHash][majorVersion] != address(0)) {
+            revert ServiceNameAlreadyRegistered(serviceName, majorVersion);
+        }
+
+        _string[info.nftId] = serviceName;
+        _service[serviceNameHash][majorVersion] = info.objectAddress;
+
+        emit LogServiceNameRegistration(serviceName, majorVersion); 
+    }
+
+    /// @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;
+        }
+
+        return address(0);
+    }
+
+    // Internals called only in constructor
 
     /// @dev protocol registration used to anchor the dip ecosystem relations
     function _registerProtocol() 
         internal
     {
-        uint256 protocolId = _chainNftInternal.PROTOCOL_NFT_ID();
+        uint256 protocolId = _chainNft.PROTOCOL_NFT_ID();
         NftId protocolNftId = toNftId(protocolId);
 
-        _chainNftInternal.mint(NFT_LOCK_ADDRESS, protocolId);
+        _chainNft.mint(NFT_LOCK_ADDRESS, protocolId);
 
         _info[protocolNftId] = ObjectInfo(
             protocolNftId,
@@ -354,22 +312,22 @@ contract Registry is
     function _registerRegistry(address registryOwner) 
         internal
     {
-        uint256 registryId = _chainNftInternal.calculateTokenId(2);
+        uint256 registryId = _chainNft.calculateTokenId(2);
         NftId registryNftId = toNftId(registryId);
 
         NftId parentNftId;
 
-        if(registryId != _chainNftInternal.GLOBAL_REGISTRY_ID()) 
+        if(registryId != _chainNft.GLOBAL_REGISTRY_ID()) 
         {// we're not the global registry
             _registerGlobalRegistry();
-            parentNftId = toNftId(_chainNftInternal.GLOBAL_REGISTRY_ID());
+            parentNftId = toNftId(_chainNft.GLOBAL_REGISTRY_ID());
         }
         else 
         {// we are global registry
-            parentNftId = toNftId(_chainNftInternal.PROTOCOL_NFT_ID());
+            parentNftId = toNftId(_chainNft.PROTOCOL_NFT_ID());
         }
 
-        _chainNftInternal.mint(registryOwner, registryId);
+        _chainNft.mint(registryOwner, registryId);
 
         _info[registryNftId] = ObjectInfo(
             registryNftId,
@@ -389,15 +347,15 @@ contract Registry is
     function _registerGlobalRegistry() 
         internal
     {
-        uint256 globalRegistryId = _chainNftInternal.GLOBAL_REGISTRY_ID();
+        uint256 globalRegistryId = _chainNft.GLOBAL_REGISTRY_ID();
 
-        _chainNftInternal.mint(NFT_LOCK_ADDRESS, globalRegistryId);
+        _chainNft.mint(NFT_LOCK_ADDRESS, globalRegistryId);
 
         NftId globalRegistryNftId = toNftId(globalRegistryId);
 
         _info[globalRegistryNftId] = ObjectInfo(
             globalRegistryNftId,
-            toNftId(_chainNftInternal.PROTOCOL_NFT_ID()), // parent
+            toNftId(_chainNft.PROTOCOL_NFT_ID()), // parent
             REGISTRY(),
             false, // isInterceptor
             address(0), // objectAddress
@@ -409,10 +367,10 @@ contract Registry is
     function _registerRegistryService(address registryOwner)
         internal
     {
-        uint256 serviceId = _chainNftInternal.calculateTokenId(REGISTRY_SERVICE_TOKEN_SEQUENCE_ID);
+        uint256 serviceId = _chainNft.calculateTokenId(REGISTRY_SERVICE_TOKEN_SEQUENCE_ID);
         NftId serviceNftId = toNftId(serviceId);        
 
-        _chainNftInternal.mint(registryOwner, serviceId);
+        _chainNft.mint(registryOwner, serviceId);
 
         _info[serviceNftId] = ObjectInfo(
             serviceNftId,
@@ -433,32 +391,6 @@ contract Registry is
         _serviceNftId = serviceNftId;
     }
 
-    /// @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;
-        }
-
-        return address(0);
-    }
-
     /// @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