@etherisc/gif-next 0.0.2-cc253b3 → 0.0.2-cd89a0b-062

package/contracts/registry/ChainNft.sol

@@ -1,16 +1,22 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+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 {IChainNft} from "./IChainNft.sol";
+import {ITransferInterceptor} from "./ITransferInterceptor.sol";
 
-contract ChainNft is
-    ERC721Enumerable,
-    IChainNft
-{
+contract ChainNft is ERC721Enumerable, IChainNft {
     string public constant NAME = "Dezentralized Insurance Protocol Registry";
     string public constant SYMBOL = "DIPR";
 
+    uint256 public constant PROTOCOL_NFT_ID = 1101;
+    uint256 public constant GLOBAL_REGISTRY_ID = 2101;
+
+    // remember interceptors
+    mapping(uint256 tokenId => address interceptor) private _interceptor;
+
     // remember token uri
     mapping(uint256 tokenId => string uri) private _uri;
 
@@ -18,22 +24,18 @@ contract ChainNft is
     address private _registry;
 
     // only used for _getNextTokenId
-    uint256 internal _chainIdInt; 
+    uint256 internal _chainIdInt;
     uint256 internal _chainIdDigits;
     uint256 internal _chainIdMultiplier;
     uint256 internal _idNext;
     uint256 internal _totalMinted;
 
-
     modifier onlyRegistry() {
         require(msg.sender == _registry, "ERROR:NFT-001:CALLER_NOT_REGISTRY");
         _;
     }
 
-
-    constructor(address registry)
-        ERC721(NAME, SYMBOL)
-    {
+    constructor(address registry) ERC721(NAME, SYMBOL) {
         require(registry != address(0), "ERROR:NFT-010:REGISTRY_ZERO");
 
         _registry = registry;
@@ -41,129 +43,141 @@ contract ChainNft is
         _chainIdInt = block.chainid;
         _chainIdDigits = _countDigits(_chainIdInt);
         _chainIdMultiplier = 10 ** _chainIdDigits;
+        _idNext = 4;
+    }
 
-        // on mainnet/goerli start /1 (reserved for protocol nft) on other chains with 2
-        if(block.chainid == 1 || block.chainid == 5) {
-            _idNext = 1;
-        } else {
-            _idNext = 2;
-        }
+    /**
+    * @dev mints a token for a specified token id
+    * 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);
     }
 
 
+    /**
+    * @dev mints the next token to register new objects
+    * non-zero transferInterceptors are recorded and called during nft token transfers.
+    * the contract receiving such a notification may decides to revert or record the transfer
+    */
     function mint(
         address to,
+        address interceptor,
         string memory uri
-    )
-        external
-        override
-        onlyRegistry
-        returns(uint256 tokenId)
-    {
+    ) public onlyRegistry returns (uint256 tokenId) {
         tokenId = _getNextTokenId();
-        _totalMinted++;
 
-        _safeMint(to, tokenId);
+        if (interceptor != address(0)) {
+            _interceptor[tokenId] = interceptor;
+        }
 
-        if(bytes(uri).length > 0) {
+        if (bytes(uri).length > 0) {
             _uri[tokenId] = uri;
         }
+
+        _safeMint(to, tokenId);
+        _totalMinted++;
+    }
+
+
+    /**
+     * @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) {
+        super.transferFrom(from, to, tokenId);
+
+        if (_interceptor[tokenId] != address(0)) {
+            ITransferInterceptor(_interceptor[tokenId]).nftTransferFrom(from, to, tokenId);
+        }
     }
 
 
-    function burn(uint256 tokenId)
-        external
-        override
-        onlyRegistry
-    {
-        _requireMinted(tokenId);
+    function burn(uint256 tokenId) external override onlyRegistry {
+        _requireOwned(tokenId);
         _burn(tokenId);
         delete _uri[tokenId];
     }
 
-
-    function setURI(uint256 tokenId, string memory uri)
-        external
-        override
-        onlyRegistry
-    {
+    function setURI(
+        uint256 tokenId,
+        string memory uri
+    ) external override onlyRegistry {
         require(bytes(uri).length > 0, "ERROR:CRG-011:URI_EMPTY");
 
-        _requireMinted(tokenId);
+        _requireOwned(tokenId);
         _uri[tokenId] = uri;
     }
 
-
-    function exists(uint256 tokenId)
-        external
-        view
-        override
-        returns(bool)
-    {
-        return _exists(tokenId);
+    function exists(uint256 tokenId) external view override returns (bool) {
+        return _ownerOf(tokenId) != address(0);
     }
 
-
-    function tokenURI(uint256 tokenId)
-        public
-        view
-        override 
-        returns(string memory)
-    {
-        _requireMinted(tokenId);
+    function tokenURI(
+        uint256 tokenId
+    ) public view override returns (string memory) {
+        _requireOwned(tokenId);
         return _uri[tokenId];
     }
 
-
-    function getRegistryAddress()
-        external
-        view
-        override
-        returns(address)
-    {
+    function getRegistryAddress() external view override returns (address) {
         return _registry;
     }
 
-    function totalMinted() external override view returns(uint256) {
+    function totalMinted() external view override returns (uint256) {
         return _totalMinted;
     }
 
-    // requirement: each chain registry produces token ids that
-    // are guaranteed to not collide with any token id genereated
-    // on a different chain
-    //
-    // format concat(counter,chainid,2 digits for len-of-chain-id)
-    // restriction chainid up to 99 digits
-    // decode: from right to left:
-    // - 2 right most digits encode length of chainid
-    // - move number of digits to left as determined above (-> chainid)
-    // - the reminder to the left is the counter
-    // examples
-    // 1101
-    // ^^ ^
-    // || +- 1-digit chain id
-    // |+-- chain id = 1 (mainnet)
-    // +-- 1st token id on mainnet
-    // (1 * 10 ** 1 + 1) * 100 + 1
-    // 42987654321010
-    // ^ ^          ^
-    // | |          +- 10-digit chain id
-    // | +-- chain id = 9876543210 (hypothetical chainid)
-    // +-- 42nd token id on this chain
-    // (42 * 10 ** 10 + 9876543210) * 100 + 10
-    // (index * 10 ** digits + chainid) * 100 + digits (1 < digits < 100)
-
-    function _getNextTokenId() private returns(uint256 id) {
-        id = (_idNext * _chainIdMultiplier + _chainIdInt) * 100 + _chainIdDigits;
-        _idNext++;
+    /**
+    * @dev token id calculation based on an index value that is supposed
+    * to increase with every minted token
+    *
+    * requirement: each chain registry produces token ids that
+    * are guaranteed to not collide with any token id genereated
+    * on a different chain
+    *
+    * format concat(counter,chainid,2 digits for len-of-chain-id)
+    * restriction chainid up to 99 digits
+    * decode: from right to left:
+    * - 2 right most digits encode length of chainid
+    * - move number of digits to left as determined above (-> chainid)
+    * - the reminder to the left is the counter
+    *
+    * special cases
+    * 1101 -> decentralized insurance protocol
+    * 2102 -> global registry
+    * 2xxxxx -> chain registry, where xxxxx = <chain-part> 
+    *
+    * examples
+    * 1101
+    * ^^ ^
+    * || +- 1-digit chain id
+    * |+-- chain id = 1 (mainnet)
+    * +-- 1st token id on mainnet
+    * (1 * 10 ** 1 + 1) * 100 + 1
+    * 42987654321010
+    * ^ ^          ^
+    * | |          +- 10-digit chain id
+    * | +-- chain id = 9876543210 (hypothetical chainid)
+    * +-- 42nd token id on this chain
+    * (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 _getNextTokenId() private returns (uint256 id) {
+        id = calculateTokenId(_idNext);
+        _idNext++;
+    }
 
-    function _countDigits(uint256 num)
-        private 
-        pure 
-        returns (uint256 count)
-    {
+    function _countDigits(uint256 num) private pure returns (uint256 count) {
         count = 0;
         while (num != 0) {
             count++;

package/contracts/registry/IChainNft.sol

@@ -1,18 +1,22 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {IERC721Enumerable} from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Enumerable.sol";
+import {IERC721Enumerable} from "@openzeppelin5/contracts/token/ERC721/extensions/IERC721Enumerable.sol";
 
-interface IChainNft is 
-    IERC721Enumerable 
-{
+interface IChainNft is IERC721Enumerable {
+    function mint(
+        address to,
+        address interceptor,
+        string memory uri
+    ) external returns (uint256 tokenId);
 
-    function mint(address to, string memory uri) external returns(uint256 tokenId);
     function burn(uint256 tokenId) external;
+
     function setURI(uint256 tokenId, string memory uri) external;
 
-    function exists(uint256 tokenId) external view returns(bool);
-    function totalMinted() external view returns(uint256);
+    function exists(uint256 tokenId) external view returns (bool);
+
+    function totalMinted() external view returns (uint256);
 
-    function getRegistryAddress() external view returns(address registry);
+    function getRegistryAddress() external view returns (address registry);
 }

package/contracts/registry/IRegistry.sol

@@ -1,70 +1,73 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
+import {IERC165} from "@openzeppelin5/contracts/utils/introspection/IERC165.sol";
+
+import {IOwnable} from "../shared/IOwnable.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 IOwnable {
-    function getOwner() external view returns(address owner);
-}
+interface IRegistry is IERC165, IOwnable {
 
-interface IRegistryLinked {
+    event LogRegistration(NftId indexed nftId, NftId parentNftId, ObjectType objectType, address objectAddress, address initialOwner);
 
-    event LogDebug(uint256 idx, address module, string comment);
+    event LogServiceNameRegistration(string serviceName, VersionPart majorVersion); 
 
-    function getRegistry() external view returns(IRegistry registry);
-}
+    event LogApproval(NftId indexed nftId, ObjectType objectType);
 
-interface IRegisterable is 
-    IOwnable,
-    IRegistryLinked
-{
+    struct ObjectInfo {
+        NftId nftId;
+        NftId parentNftId;
+        ObjectType objectType;
+        bool isInterceptor;
+        address objectAddress;
+        address initialOwner;
+        bytes data;
+    }// TODO delete nftId and initialOwner(if not used) from struct
 
-    function register() external returns(NftId nftId);
+    function register(ObjectInfo memory info) external returns (NftId nftId);
     
-    function getNftId() external view returns(NftId nftId);
-    function getParentNftId() external view returns(NftId 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 registerFrom(
+        address from, 
+        ObjectInfo memory info
+    ) external returns (NftId nftId);
 
-    function isRegistered() external view returns(bool);
-}
+    function approve(
+        NftId registrar,
+        ObjectType object,
+        ObjectType parent
+    ) external;
 
+    function allowance(
+        NftId registrar,
+        ObjectType object
+    ) external view returns (bool);
 
-interface IRegistry {
+    function getObjectCount() external view returns (uint256);
 
-    struct RegistryInfo {
-        NftId nftId;
-        NftId parentNftId;
-        uint256 objectType;
-        address objectAddress;
-        address initialOwner;
-    }
-
-    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 register(address objectAddress) external returns(NftId nftId);
-    function registerObjectForInstance(
-        NftId parentNftid,
-        uint256 objectType,
-        address initialOwner
-    )
-        external returns(NftId nftId);
-
-    function getObjectCount() external view returns(uint256);
-
-    function getNftId(address objectAddress) external view returns(NftId nftId);
-    function getInfo(NftId nftId) external view returns(RegistryInfo memory info);
-    function getOwner(NftId nftId) external view returns(address ownerAddress);
-
-    function isRegistered(address objectAddress) external view returns(bool);
-
-    function getNftAddress() external view returns(address nft);
-}
+    //nftIdOf
+    function getNftId(address objectAddress) external view returns (NftId nftId);
+
+    function ownerOf(NftId nftId) external view returns (address);
+
+    function ownerOf(address contractAddress) external view returns (address);
+    // infoOf()
+    function getObjectInfo(NftId nftId) external view returns (ObjectInfo memory info);
+    // infoOf()
+    function getObjectInfo(address object) external view returns (ObjectInfo memory info);
+
+    function isRegistered(NftId nftId) external view returns (bool);
+
+    function isRegistered(address contractAddress) external view returns (bool);
+
+    function getServiceName(NftId nftId) external view returns (string memory name);
+
+    function getServiceAddress(
+        string memory serviceName, 
+        VersionPart majorVersion
+    ) external view returns (address serviceAddress);
+
+    function getChainNft() external view returns (IChainNft);
+}

package/contracts/registry/IRegistryService.sol

@@ -0,0 +1,29 @@
+// 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 {IRegisterable} from "../../contracts/shared/IRegisterable.sol";
+import {IBaseComponent} from "../../contracts/components/IBaseComponent.sol";
+
+interface IRegistryService is IService {
+
+    function registerToken(address tokenAddress) external returns(NftId nftId);
+
+    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 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/ITransferInterceptor.sol

@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+interface ITransferInterceptor {
+    function nftTransferFrom(address from, address to, uint256 tokenId) external;
+}