@etherisc/gif-next 0.0.2-e20063b-144 → 0.0.2-e25d641-064

package/contracts/registry/ChainNft.sol

@@ -8,6 +8,8 @@ import {ITransferInterceptor} from "./ITransferInterceptor.sol";
 
 contract ChainNft is ERC721Enumerable {
 
+    event LogTokenInterceptorAddress(uint256 tokenId, address interceptor);
+
     // constants
     string public constant NAME = "Dezentralized Insurance Protocol NFT";
     string public constant SYMBOL = "DIPNFT";
@@ -16,10 +18,10 @@ contract ChainNft is ERC721Enumerable {
     uint256 public constant GLOBAL_REGISTRY_ID = 2101;
 
     // custom errors
-    error CallerNotRegistry(address caller);
-    error RegistryAddressZero();
-    error NftUriEmpty();
-    error NftUriAlreadySet();
+    error ErrorChainNftCallerNotRegistry(address caller);
+    error ErrorChainNftRegistryAddressZero();
+    error ErrorChainNftUriEmpty();
+    error ErrorChainNftUriAlreadySet();
 
     // contract state
 
@@ -33,33 +35,34 @@ contract ChainNft is ERC721Enumerable {
     address private _registry;
 
     // only used for _getNextTokenId
-    uint256 internal _chainIdInt;
     uint256 internal _chainIdDigits;
     uint256 internal _chainIdMultiplier;
     uint256 internal _idNext;
     uint256 internal _totalMinted;
 
     modifier onlyRegistry() {
-        if (msg.sender != _registry) { revert CallerNotRegistry(msg.sender); }
+        if (msg.sender != _registry) { revert ErrorChainNftCallerNotRegistry(msg.sender); }
         _;
     }
 
-    constructor(address registry) ERC721(NAME, SYMBOL) {
-        if (registry == address(0)) { revert RegistryAddressZero(); }
+    constructor(address registry)
+        ERC721(NAME, SYMBOL)
+    {
+        if (registry == address(0)) { revert ErrorChainNftRegistryAddressZero(); }
 
+        // NFT contract is deployed by the registry
         _registry = registry;
-        _chainIdInt = block.chainid;
-        _chainIdDigits = 0;
-
-        // count digis
-        uint256 num = _chainIdInt;
-        while (num != 0) {
-            _chainIdDigits++;
-            num /= 10;
-        }
 
+        _chainIdDigits = _calculateChainIdDigits(block.chainid);
         _chainIdMultiplier = 10 ** _chainIdDigits;
-        _idNext = 3;
+
+        // the first object registered through normal registration starts with id 4
+        // 1 -> protocol
+        // 2 -> registry
+        // 3 -> staking
+        // >= 4 -> all other objects
+        _idNext = 4;
+        _totalMinted = 0;
     }
 
     /**
@@ -67,12 +70,16 @@ contract ChainNft is ERC721Enumerable {
     * not part of the IRegistry interface only needed for
     * initial registry setup (protocol and global registry objects)
     */
-    function mint(address to, uint256 tokenId) external onlyRegistry {
-        _totalMinted++;
-        _safeMint(to, tokenId);
+    function mint(
+        address to, 
+        uint256 tokenId
+    )
+        external
+        onlyRegistry()
+    {
+        _safeMintWithInterceptorAddress(to, tokenId, address(0));
     }
 
-
     /**
     * @dev mints the next token to register new objects
     * non-zero transferInterceptors are recorded and called during nft token transfers.
@@ -82,7 +89,11 @@ contract ChainNft is ERC721Enumerable {
         address to,
         address interceptor,
         string memory uri
-    ) public onlyRegistry returns (uint256 tokenId) {
+    )
+        public
+        onlyRegistry()
+        returns (uint256 tokenId) 
+    {
         tokenId = _getNextTokenId();
 
         if (interceptor != address(0)) {
@@ -93,24 +104,21 @@ contract ChainNft is ERC721Enumerable {
             _uri[tokenId] = uri;
         }
 
-        _totalMinted++;
-        _safeMint(to, tokenId);
-
-        if(interceptor != address(0)) {
-            ITransferInterceptor(interceptor).nftMint(to, tokenId);
-        }
+        _safeMintWithInterceptorAddress(to, tokenId, interceptor);
     }
 
 
     /**
-     * @dev amend the open zeppelin transferFrom function by an interceptor call if such an interceptor is defined for the nft token id
-     * this allows distribution, product and pool components to be notified when distributors, policies and bundles are transferred.
+     * @dev Amend the open zeppelin transferFrom function by an interceptor call if such an interceptor is defined for the nft token id.
+     * This allows distribution, product and pool components to be notified when distributors, policies and bundles are transferred.
      */
-    function transferFrom(address from, address to, uint256 tokenId) public override (ERC721, IERC721) {
+    function transferFrom(address from, address to, uint256 tokenId) public override (IERC721, ERC721) {
+        // default open zeppelin implementation of transferFrom
         super.transferFrom(from, to, tokenId);
 
         if (_interceptor[tokenId] != address(0)) {
-            ITransferInterceptor(_interceptor[tokenId]).nftTransferFrom(from, to, tokenId);
+            address operator = msg.sender;
+            ITransferInterceptor(_interceptor[tokenId]).nftTransferFrom(from, to, tokenId, operator);
         }
     }
 
@@ -125,8 +133,8 @@ contract ChainNft is ERC721Enumerable {
         uint256 tokenId,
         string memory uri
     ) external onlyRegistry {
-        if (bytes(uri).length == 0) { revert NftUriEmpty(); }
-        if (bytes(_uri[tokenId]).length > 0) { revert NftUriAlreadySet(); }
+        if (bytes(uri).length == 0) { revert ErrorChainNftUriEmpty(); }
+        if (bytes(_uri[tokenId]).length > 0) { revert ErrorChainNftUriAlreadySet(); }
 
         _requireOwned(tokenId);
         _uri[tokenId] = uri;
@@ -192,19 +200,50 @@ contract ChainNft is ERC721Enumerable {
     * (42 * 10 ** 10 + 9876543210) * 100 + 10
     * (index * 10 ** digits + chainid) * 100 + digits (1 < digits < 100)
     */
-    function calculateTokenId(uint256 idIndex) public view returns (uint256 id) {
-        id =
-            (idIndex * _chainIdMultiplier + _chainIdInt) *
-            100 +
-            _chainIdDigits;
+    function calculateTokenId(uint256 idIndex, uint256 chainId) public view returns (uint256 id) {
+        if(chainId == block.chainid) {
+            return 100 * (idIndex * _chainIdMultiplier + chainId) + _chainIdDigits;
+        } else {
+            uint256 chainIdDigits = _calculateChainIdDigits(chainId);
+            return 100 * (idIndex * (10 ** chainIdDigits) + chainId) + chainIdDigits;
+        }
+    }
+
+    function calculateTokenId(uint256 idIndex) public view returns (uint256) {
+        return 100 * (idIndex * _chainIdMultiplier + block.chainid) + _chainIdDigits;
     }
 
     function getNextTokenId() external view returns (uint256) {
         return calculateTokenId(_idNext);
     }
 
+    // ---------------- private functions ----------------- //
+
     function _getNextTokenId() private returns (uint256 id) {
         id = calculateTokenId(_idNext);
         _idNext++;
     }
+
+    function _calculateChainIdDigits(uint256 chainId) private pure returns (uint256) {
+        uint256 num = chainId;
+        uint256 digits = 0;
+        while (num != 0) {
+            digits++;
+            num /= 10;
+        }
+        return digits;
+    }
+
+    function _safeMintWithInterceptorAddress(
+        address to,
+        uint256 tokenId,
+        address interceptor
+    )
+        private
+    {        
+        _totalMinted++;
+        _safeMint(to, tokenId);
+
+        emit LogTokenInterceptorAddress(tokenId, interceptor);
+    }
 }

package/contracts/registry/IRegistry.sol

@@ -3,57 +3,99 @@ pragma solidity ^0.8.20;
 
 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 {Timestamp} from "../types/Timestamp.sol";
+import {IRelease} from "./IRelease.sol";
 
-interface IRegistry is IERC165 {
+import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {VersionPart} from "../type/Version.sol";
 
-    event LogRegistration(NftId nftId, NftId parentNftId, ObjectType objectType, bool isInterceptor, address objectAddress, address initialOwner);
-    event LogServiceRegistration(VersionPart majorVersion, ObjectType domain);
+/// @title Chain Registry interface.
+/// A chain registry holds all protocol relevant objects with basic metadata.
+/// Registered objects include services, instances, products, pools, policies, bundles, stakes and more.
+/// Registered objects are represented by NFTs.
+/// When on mainnet registry is global and keeps arbitrary number of chain registries residing on different chain ids.
+/// When not on mainnet registry keeps the only object residing on different chain id (on mainnet) - global registry.
+interface IRegistry is
+    IERC165
+{
 
-    // registerService()
-    error CallerNotReleaseManager();
-    error ServiceAlreadyRegistered(address service);
+    event LogRegistryObjectRegistered(NftId nftId, NftId parentNftId, ObjectType objectType, bool isInterceptor, address objectAddress, address initialOwner);
+    event LogRegistryServiceRegistered(VersionPart majorVersion, ObjectType domain);
+    event LogRegistryChainRegistryRegistered(NftId nftId, uint256 chainId, address chainRegistryAddress);
+
+    // initialize
+    error ErrorRegistryCallerNotDeployer();
 
     // register()
-    error CallerNotRegistryService();
-    error ServiceRegistration();
+    error ErrorRegistryObjectTypeNotSupported(ObjectType objectType);
+
+    // registerRegistry()
+    error ErrorRegistryNotOnMainnet(uint256 chainId);
+    error ErrorRegistryChainRegistryChainIdZero(NftId nftId);
+    error ErrorRegistryChainRegistryAddressZero(NftId nftId, uint256 chainId);
+    error ErrorRegistryChainRegistryNftIdInvalid(NftId nftId, uint256 chainId);
+    error ErrorRegistryChainRegistryAlreadyRegistered(NftId nftId, uint256 chainId);
+
+    // registerService()
+    error ErrorRegistryServiceAddressZero(); 
+    error ErrorRegistryServiceVersionZero(address service);
+
+    // TODO cleanup
+    //error ErrorRegistryServiceVersionMismatch(address service, VersionPart serviceVersion, VersionPart releaseVersion);
+    //error ErrorRegistryServiceVersionNotDeploying(address service, VersionPart version);
+    error ErrorRegistryServiceDomainZero(address service, VersionPart version);
+    error ErrorRegistryNotService(address service, ObjectType objectType);
+    error ErrorRegistryServiceParentNotRegistry(address service, VersionPart version, NftId parentNftId);
+    error ErrorRegistryServiceDomainAlreadyRegistered(address service, VersionPart version, ObjectType domain);
 
     // registerWithCustomTypes()
-    error CoreTypeRegistration();
+    error ErrorRegistryCoreTypeRegistration();
 
     // _register()
-    error ZeroParentAddress();
-    error InvalidTypesCombination(ObjectType objectType, ObjectType parentType);
-    error ContractAlreadyRegistered(address objectAddress);
+    error ErrorRegistryGlobalRegistryAsParent(address objectAddress, ObjectType objectType);
+    error ErrorRegistryTypeCombinationInvalid(address objectAddress, ObjectType objectType, ObjectType parentType);
+    error ErrorRegistryContractAlreadyRegistered(address objectAddress);
 
     struct ObjectInfo {
+        // slot 0
         NftId nftId;
         NftId parentNftId;
         ObjectType objectType;
         bool isInterceptor;
+        // slot 1
         address objectAddress;
+        // slot 2
         address initialOwner;
+        // slot 3
         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)
-
-    struct ReleaseInfo {
-        ObjectType[] domains;
-        Timestamp createdAt;
-        //Timestamp updatedAt;
     }
 
+    /// @dev Registers a registry contract for a specified chain.
+    /// Only one chain registry may be registered per chain
+    function registerRegistry(
+        NftId nftId, 
+        uint256 chainId, 
+        address chainRegistryAddress
+    ) external;
+
+    /// @dev Register a service with using the provided domain and version.
+    /// The function returns a newly minted service NFT ID.
+    /// May only be used to register services.
     function registerService(
         ObjectInfo memory serviceInfo, 
         VersionPart serviceVersion, 
         ObjectType serviceDomain
     ) external returns(NftId nftId);
 
+    /// @dev Register an object with a known core type.
+    /// The function returns a newly minted object NFT ID.
+    /// May not be used to register services.
     function register(ObjectInfo memory info) external returns (NftId nftId);
 
+    /// @dev Register an object with a custom type.
+    /// The function returns a newly minted object NFT ID.
+    /// This function is reserved for GIF releases > 3.
+    /// May not be used to register known core types.
     function registerWithCustomType(ObjectInfo memory info) external returns (NftId nftId);
 
     function getInitialVersion() external view returns (VersionPart);
@@ -62,20 +104,39 @@ interface IRegistry is IERC165 {
 
     function getLatestVersion() external view returns (VersionPart);
 
-    function getReleaseInfo(VersionPart version) external view returns (ReleaseInfo memory);
+    function getReleaseInfo(VersionPart release) external view returns (IRelease.ReleaseInfo memory);
 
-    function getObjectCount() external view returns (uint256);
+    /// @dev Returns the number of supported chains.
+    function chainIds() external view returns (uint256);
 
-    function getNftId() external view returns (NftId nftId);
+    /// @dev Returns the chain id at the specified index.
+    function getChainId(uint256 idx) external view returns (uint256);
+
+    /// @dev Returns the NFT ID of the registry for the specified chain.
+    function getRegistryNftId(uint256 chainId) external returns (NftId nftId); 
 
-    function getNftId(address objectAddress) external view returns (NftId nftId);
+    function getObjectCount() external view returns (uint256);
+
+    function getNftIdForAddress(address objectAddress) external view returns (NftId nftId);
 
     function ownerOf(NftId nftId) external view returns (address);
 
+    function isOwnerOf(NftId nftId, address expectedOwner) external view returns (bool);
+
     function ownerOf(address contractAddress) external view returns (address);
 
     function getObjectInfo(NftId nftId) external view returns (ObjectInfo memory info);
 
+    function getParentNftId(NftId nftId) external view returns (NftId parentNftId);
+
+    function isObjectType(NftId nftId, ObjectType expectedObjectType) external view returns (bool);
+
+    function isObjectType(address contractAddress, ObjectType expectedObjectType) external view returns (bool);
+
+    function getObjectAddress(NftId nftId) external view returns (address objectAddress);
+
+    /// @dev Returns the object info for the specified object address.
+    //  MUST not be used with chain registry address (resides on different chan id)
     function getObjectInfo(address object) external view returns (ObjectInfo memory info);
 
     function isRegistered(NftId nftId) external view returns (bool);
@@ -86,16 +147,29 @@ interface IRegistry is IERC165 {
 
     function isRegisteredComponent(address object) external view returns (bool);
 
-    function isValidRelease(VersionPart version) external view returns (bool);
+    function isActiveRelease(VersionPart version) external view returns (bool);
 
     function getServiceAddress(
         ObjectType serviceDomain, 
         VersionPart releaseVersion
     ) external view returns (address serviceAddress);
 
-    function getReleaseManagerAddress() external view returns (address);
+    function getProtocolNftId() external view returns (NftId protocolNftId);
 
-    function getChainNftAddress() external view returns (address);
+    function getNftId() external view returns (NftId nftId);
 
     function getOwner() external view returns (address);
+
+    // TODO refactor the address getters below to contract getters
+    function getChainNftAddress() external view returns (address);
+
+    function getReleaseRegistryAddress() external view returns (address);
+
+    function getStakingAddress() external view returns (address);
+
+    function getTokenRegistryAddress() external view returns (address);
+
+    function getRegistryAdminAddress() external view returns (address);
+
+    function getAuthority() external view returns (address);
 }

package/contracts/registry/IRegistryService.sol

@@ -3,60 +3,53 @@ pragma solidity ^0.8.20;
 
 // import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
-import {NftId} from "../types/NftId.sol";
-import {ObjectType} from "../types/ObjectType.sol";
-import {RoleId} from "../types/RoleId.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {RoleId} from "../type/RoleId.sol";
 import {IService} from "../shared/IService.sol";
 import {IRegistry} from "./IRegistry.sol";
 
 import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IComponent} from "../components/IComponent.sol";
+import {IComponent} from "../shared/IComponent.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+
 
 interface IRegistryService is 
      IService
-     // TODO cleanup
-     // IAccessManaged 
 {
-     error SelfRegistration();
-     error NotRegistryOwner();
-
-     error NotService();
-     error NotInstance();
-     error NotProduct();
-     error NotPool();
-     error NotDistribution();
-
-     error UnexpectedRegisterableType(ObjectType expected, ObjectType found);
-     error NotRegisterableOwner(address expectedOwner);
-     error RegisterableOwnerIsZero();   
-     error RegisterableOwnerIsRegistered();
-     error InvalidInitialOwner(address initialOwner);
-     error InvalidAddress(address registerableAddress);
-
-     struct FunctionConfig
-     {
-          ObjectType serviceDomain;
-          bytes4[] selectors;
-     }
-
-     function getFunctionConfigs()
-          external
-          pure
-          returns(
-               FunctionConfig[] memory config
-          );
-
-     // TODO used by service -> add owner arg 
+     error ErrorRegistryServiceNotRegistryOwner();
+
+     error ErrorRegistryServiceNotService(address notService);
+     error ErrorRegistryServiceNotInstance(address notInstance);
+     error ErrorRegistryServiceNotProduct(address notProduct);
+     error ErrorRegistryServiceNotComponent(address notComponent);
+     error ErrorRegistryServiceNotProductLinkedComponent(address notProductLinkedComponent);
+
+     error ErrorRegistryServiceRegisterableAddressInvalid(IRegisterable registerable, address found);
+     error ErrorRegistryServiceRegisterableTypeInvalid(IRegisterable registerable, ObjectType expected, ObjectType found);
+     error ErrorRegistryServiceRegisterableOwnerInvalid(IRegisterable registerable, address expected, address found);
+     error ErrorRegistryServiceRegisterableOwnerZero(IRegisterable registerable);   
+     error ErrorRegistryServiceRegisterableOwnerRegistered(IRegisterable registerable, address owner);
+     error ErrorRegistryServiceRegisterableSelfRegistration(IRegisterable registerable);
+
+     error ErrorRegistryServiceObjectAddressNotZero(ObjectType objectType);
+     error ErrorRegistryServiceObjectTypeInvalid(ObjectType expected, ObjectType found);
+     error ErrorRegistryServiceObjectOwnerRegistered(ObjectType objectType, address owner);
+     error ErrorRegistryServiceObjectOwnerZero(ObjectType objectType);
+
+     error ErrorRegistryServiceInvalidInitialOwner(address initialOwner);
+     error ErrorRegistryServiceInvalidAddress(address registerableAddress);
+
+     function registerStake(IRegistry.ObjectInfo memory info)
+          external returns(NftId nftId); 
+
      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 registerPool(IComponent pool, address owner)
-          external returns(IRegistry.ObjectInfo memory info);
-
-     function registerDistribution(IComponent distribution, address owner)
+     function registerProductLinkedComponent(IComponent component, ObjectType objectType, address owner)
           external returns(IRegistry.ObjectInfo memory info);
 
      function registerDistributor(IRegistry.ObjectInfo memory info) external returns(NftId nftId);
@@ -64,5 +57,6 @@ interface IRegistryService is
      function registerPolicy(IRegistry.ObjectInfo memory info) external returns(NftId nftId);
 
      function registerBundle(IRegistry.ObjectInfo memory info) external returns(NftId nftId); 
+
 }
 

package/contracts/registry/IRelease.sol

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IServiceAuthorization} from "../authorization/IServiceAuthorization.sol";
+
+import {StateId} from "../type/StateId.sol";
+import {Timestamp} from "../type/Timestamp.sol";
+import {VersionPart} from "../type/Version.sol";
+
+/// @title Marks contracts that are linked to a specific GIF release version.
+interface IRelease {
+
+    struct ReleaseInfo {
+        // slot 0
+        address releaseAdmin;
+        StateId state;
+        VersionPart version;
+        Timestamp activatedAt;
+        Timestamp disabledAt;
+        // slot 1
+        IServiceAuthorization auth;
+        // slot 2
+        bytes32 salt;
+    }
+
+    /// @dev Registers a registry contract for a specified chain.
+    /// Only one chain registry may be registered per chain
+    function getRelease() external view returns (VersionPart release);
+}

package/contracts/registry/ITransferInterceptor.sol

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