Merge pull request #284 from solidstate-network/erc721-extension-interfaces

ItsNickBarry · web-flow · commit 96121950f935 · 2025-03-17T18:14:41.000Z
Add `ERC721` and `ERC1155` extension interfaces
diff --git a/contracts/interfaces/IERC1155Metadata.sol b/contracts/interfaces/IERC1155Metadata.sol
@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.20;
+
+import { _IERC1155Metadata } from './_IERC1155Metadata.sol';
+
+interface IERC1155Metadata is _IERC1155Metadata {
+    /**
+     * @notice get generated URI for given token
+     * @return token URI
+     */
+    function uri(uint256 tokenId) external view returns (string memory);
+}
diff --git a/contracts/interfaces/IERC721Enumerable.sol b/contracts/interfaces/IERC721Enumerable.sol
@@ -0,0 +1,33 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.20;
+
+import { _IERC721Enumerable } from './_IERC721Enumerable.sol';
+
+interface IERC721Enumerable is _IERC721Enumerable {
+    /**
+     * @notice get total token supply
+     * @return total supply
+     */
+    function totalSupply() external view returns (uint256);
+
+    /**
+     * @notice get token of given owner at given internal storage index
+     * @param owner token holder to query
+     * @param index position in owner's token list to query
+     * @return tokenId id of retrieved token
+     */
+    function tokenOfOwnerByIndex(
+        address owner,
+        uint256 index
+    ) external view returns (uint256 tokenId);
+
+    /**
+     * @notice get token at given internal storage index
+     * @param index position in global token list to query
+     * @return tokenId id of retrieved token
+     */
+    function tokenByIndex(
+        uint256 index
+    ) external view returns (uint256 tokenId);
+}
diff --git a/contracts/interfaces/IERC721Metadata.sol b/contracts/interfaces/IERC721Metadata.sol
@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.20;
+
+import { _IERC721Metadata } from './_IERC721Metadata.sol';
+
+interface IERC721Metadata is _IERC721Metadata {
+    /**
+     * @notice get token name
+     * @return token name
+     */
+    function name() external view returns (string memory);
+
+    /**
+     * @notice get token symbol
+     * @return token symbol
+     */
+    function symbol() external view returns (string memory);
+
+    /**
+     * @notice get generated URI for given token
+     * @return token URI
+     */
+    function tokenURI(uint256 tokenId) external view returns (string memory);
+}
diff --git a/contracts/interfaces/_IERC1155Metadata.sol b/contracts/interfaces/_IERC1155Metadata.sol
@@ -0,0 +1,7 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.20;
+
+interface _IERC1155Metadata {
+    event URI(string value, uint256 indexed tokenId);
+}
diff --git a/contracts/interfaces/_IERC721Enumerable.sol b/contracts/interfaces/_IERC721Enumerable.sol
@@ -0,0 +1,5 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.20;
+
+interface _IERC721Enumerable {}
diff --git a/contracts/interfaces/_IERC721Metadata.sol b/contracts/interfaces/_IERC721Metadata.sol
@@ -0,0 +1,5 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.20;
+
+interface _IERC721Metadata {}
diff --git a/contracts/token/common/royalty/NFTRoyalty.sol b/contracts/token/common/royalty/NFTRoyalty.sol
@@ -2,17 +2,17 @@
 
 pragma solidity ^0.8.20;
 
+import { IERC2981 } from '../../../interfaces/IERC2981.sol';
 import { Introspectable } from '../../../introspection/Introspectable.sol';
 import { INFTRoyalty } from './INFTRoyalty.sol';
-import { ERC2981Storage } from '../../../storage/ERC2981Storage.sol';
 import { _NFTRoyalty } from './_NFTRoyalty.sol';
 
 /**
  * @title NFTRoyalty implementation
  */
 abstract contract NFTRoyalty is INFTRoyalty, _NFTRoyalty, Introspectable {
     /**
-     * @notice inheritdoc INFTRoyalty
+     * @inheritdoc IERC2981
      */
     function royaltyInfo(
         uint256 tokenId,
diff --git a/contracts/token/multi/metadata/IMultiTokenMetadata.sol b/contracts/token/multi/metadata/IMultiTokenMetadata.sol
@@ -2,15 +2,10 @@
 
 pragma solidity ^0.8.20;
 
+import { IERC1155Metadata } from '../../../interfaces/IERC1155Metadata.sol';
 import { _IMultiTokenMetadata } from './_IMultiTokenMetadata.sol';
 
 /**
  * @title MultiTokenMetadata interface
  */
-interface IMultiTokenMetadata is _IMultiTokenMetadata {
-    /**
-     * @notice get generated URI for given token
-     * @return token URI
-     */
-    function uri(uint256 tokenId) external view returns (string memory);
-}
+interface IMultiTokenMetadata is _IMultiTokenMetadata, IERC1155Metadata {}
diff --git a/contracts/token/multi/metadata/MultiTokenMetadata.sol b/contracts/token/multi/metadata/MultiTokenMetadata.sol
@@ -2,6 +2,7 @@
 
 pragma solidity ^0.8.20;
 
+import { IERC1155Metadata } from '../../../interfaces/IERC1155Metadata.sol';
 import { IMultiTokenMetadata } from './IMultiTokenMetadata.sol';
 import { _MultiTokenMetadata } from './_MultiTokenMetadata.sol';
 
@@ -13,7 +14,7 @@ abstract contract MultiTokenMetadata is
     _MultiTokenMetadata
 {
     /**
-     * @notice inheritdoc IMultiTokenMetadata
+     * @inheritdoc IERC1155Metadata
      */
     function uri(uint256 tokenId) external view returns (string memory) {
         return _uri(tokenId);
diff --git a/contracts/token/multi/metadata/_IMultiTokenMetadata.sol b/contracts/token/multi/metadata/_IMultiTokenMetadata.sol
@@ -2,9 +2,9 @@
 
 pragma solidity ^0.8.20;
 
+import { _IERC1155Metadata } from '../../../interfaces/_IERC1155Metadata.sol';
+
 /**
  * @title Partial MultiTokenMetadata interface needed by internal functions
  */
-interface _IMultiTokenMetadata {
-    event URI(string value, uint256 indexed tokenId);
-}
+interface _IMultiTokenMetadata is _IERC1155Metadata {}
diff --git a/contracts/token/multi/metadata/_MultiTokenMetadata.sol b/contracts/token/multi/metadata/_MultiTokenMetadata.sol
@@ -25,12 +25,26 @@ abstract contract _MultiTokenMetadata is _IMultiTokenMetadata {
         if (bytes(baseURI).length == 0) {
             return tokenURI;
         } else if (bytes(tokenURI).length == 0) {
-            return string(abi.encodePacked(baseURI, tokenId.toDecString()));
+            return
+                string(
+                    abi.encodePacked(baseURI, _generateDefaultTokenURI(tokenId))
+                );
         } else {
             return string(abi.encodePacked(baseURI, tokenURI));
         }
     }
 
+    /**
+     * @notice generate URI component for token id
+     * @dev padded hex string is used to match https://eips.ethereum.org/EIPS/eip-1155#metadata
+     * @return tokenURI token URI component
+     */
+    function _generateDefaultTokenURI(
+        uint256 tokenId
+    ) internal view virtual returns (string memory tokenURI) {
+        tokenURI = tokenId.toString(16, 64);
+    }
+
     /**
      * @notice set base metadata URI
      * @dev base URI is a non-standard feature adapted from the ERC721 specification
diff --git a/contracts/token/non_fungible/enumerable/INonFungibleTokenEnumerable.sol b/contracts/token/non_fungible/enumerable/INonFungibleTokenEnumerable.sol
@@ -2,36 +2,12 @@
 
 pragma solidity ^0.8.20;
 
+import { IERC721Enumerable } from '../../../interfaces/IERC721Enumerable.sol';
 import { INonFungibleToken } from '../INonFungibleToken.sol';
 import { _INonFungibleTokenEnumerable } from './_NonFungibleTokenEnumerable.sol';
 
 interface INonFungibleTokenEnumerable is
     _INonFungibleTokenEnumerable,
-    INonFungibleToken
-{
-    /**
-     * @notice get total token supply
-     * @return total supply
-     */
-    function totalSupply() external view returns (uint256);
-
-    /**
-     * @notice get token of given owner at given internal storage index
-     * @param owner token holder to query
-     * @param index position in owner's token list to query
-     * @return tokenId id of retrieved token
-     */
-    function tokenOfOwnerByIndex(
-        address owner,
-        uint256 index
-    ) external view returns (uint256 tokenId);
-
-    /**
-     * @notice get token at given internal storage index
-     * @param index position in global token list to query
-     * @return tokenId id of retrieved token
-     */
-    function tokenByIndex(
-        uint256 index
-    ) external view returns (uint256 tokenId);
-}
+    INonFungibleToken,
+    IERC721Enumerable
+{}
diff --git a/contracts/token/non_fungible/enumerable/NonFungibleTokenEnumerable.sol b/contracts/token/non_fungible/enumerable/NonFungibleTokenEnumerable.sol
@@ -5,6 +5,7 @@ pragma solidity ^0.8.20;
 import { EnumerableMap } from '../../../data/EnumerableMap.sol';
 import { EnumerableSet } from '../../../data/EnumerableSet.sol';
 import { ERC721Storage } from '../../../storage/ERC721Storage.sol';
+import { IERC721Enumerable } from '../../../interfaces/IERC721Enumerable.sol';
 import { NonFungibleToken } from '../NonFungibleToken.sol';
 import { INonFungibleTokenEnumerable } from './INonFungibleTokenEnumerable.sol';
 import { _NonFungibleTokenEnumerable } from './_NonFungibleTokenEnumerable.sol';
@@ -18,14 +19,14 @@ abstract contract NonFungibleTokenEnumerable is
     using EnumerableSet for EnumerableSet.UintSet;
 
     /**
-     * @inheritdoc INonFungibleTokenEnumerable
+     * @inheritdoc IERC721Enumerable
      */
     function totalSupply() external view returns (uint256) {
         return _totalSupply();
     }
 
     /**
-     * @inheritdoc INonFungibleTokenEnumerable
+     * @inheritdoc IERC721Enumerable
      */
     function tokenOfOwnerByIndex(
         address owner,
@@ -35,7 +36,7 @@ abstract contract NonFungibleTokenEnumerable is
     }
 
     /**
-     * @inheritdoc INonFungibleTokenEnumerable
+     * @inheritdoc IERC721Enumerable
      */
     function tokenByIndex(uint256 index) external view returns (uint256) {
         return _tokenByIndex(index);
diff --git a/contracts/token/non_fungible/enumerable/_INonFungibleTokenEnumerable.sol b/contracts/token/non_fungible/enumerable/_INonFungibleTokenEnumerable.sol
@@ -2,6 +2,10 @@
 
 pragma solidity ^0.8.20;
 
+import { _IERC721Enumerable } from '../../../interfaces/_IERC721Enumerable.sol';
 import { _INonFungibleToken } from '../_INonFungibleToken.sol';
 
-interface _INonFungibleTokenEnumerable is _INonFungibleToken {}
+interface _INonFungibleTokenEnumerable is
+    _INonFungibleToken,
+    _IERC721Enumerable
+{}
diff --git a/contracts/token/non_fungible/metadata/INonFungibleTokenMetadata.sol b/contracts/token/non_fungible/metadata/INonFungibleTokenMetadata.sol
@@ -2,27 +2,13 @@
 
 pragma solidity ^0.8.20;
 
+import { IERC721Metadata } from '../../../interfaces/IERC721Metadata.sol';
 import { _INonFungibleTokenMetadata } from './_INonFungibleTokenMetadata.sol';
 
 /**
  * @title NonFungibleTokenMetadata interface
  */
-interface INonFungibleTokenMetadata is _INonFungibleTokenMetadata {
-    /**
-     * @notice get token name
-     * @return token name
-     */
-    function name() external view returns (string memory);
-
-    /**
-     * @notice get token symbol
-     * @return token symbol
-     */
-    function symbol() external view returns (string memory);
-
-    /**
-     * @notice get generated URI for given token
-     * @return token URI
-     */
-    function tokenURI(uint256 tokenId) external view returns (string memory);
-}
+interface INonFungibleTokenMetadata is
+    _INonFungibleTokenMetadata,
+    IERC721Metadata
+{}
diff --git a/contracts/token/non_fungible/metadata/NonFungibleTokenMetadata.sol b/contracts/token/non_fungible/metadata/NonFungibleTokenMetadata.sol
@@ -2,6 +2,7 @@
 
 pragma solidity ^0.8.20;
 
+import { IERC721Metadata } from '../../../interfaces/IERC721Metadata.sol';
 import { _NonFungibleTokenMetadata } from './_NonFungibleTokenMetadata.sol';
 import { INonFungibleTokenMetadata } from './INonFungibleTokenMetadata.sol';
 
@@ -13,21 +14,21 @@ abstract contract NonFungibleTokenMetadata is
     _NonFungibleTokenMetadata
 {
     /**
-     * @notice inheritdoc INonFungibleTokenMetadata
+     * @inheritdoc IERC721Metadata
      */
     function name() external view returns (string memory) {
         return _name();
     }
 
     /**
-     * @notice inheritdoc INonFungibleTokenMetadata
+     * @inheritdoc IERC721Metadata
      */
     function symbol() external view returns (string memory) {
         return _symbol();
     }
 
     /**
-     * @notice inheritdoc INonFungibleTokenMetadata
+     * @inheritdoc IERC721Metadata
      */
     function tokenURI(uint256 tokenId) external view returns (string memory) {
         return _tokenURI(tokenId);
diff --git a/contracts/token/non_fungible/metadata/_INonFungibleTokenMetadata.sol b/contracts/token/non_fungible/metadata/_INonFungibleTokenMetadata.sol
@@ -2,11 +2,12 @@
 
 pragma solidity ^0.8.20;
 
-import { _INonFungibleToken } from '..//_INonFungibleToken.sol';
+import { _IERC721Metadata } from '../../../interfaces/_IERC721Metadata.sol';
+import { _INonFungibleToken } from '../_INonFungibleToken.sol';
 
 /**
  * @title NonFungibleTokenMetadata internal interface
  */
-interface _INonFungibleTokenMetadata is _INonFungibleToken {
+interface _INonFungibleTokenMetadata is _INonFungibleToken, _IERC721Metadata {
     error NonFungibleTokenMetadata__NonExistentToken();
 }
diff --git a/contracts/token/non_fungible/metadata/_NonFungibleTokenMetadata.sol b/contracts/token/non_fungible/metadata/_NonFungibleTokenMetadata.sol
@@ -55,12 +55,26 @@ abstract contract _NonFungibleTokenMetadata is
         if (bytes(baseURI).length == 0) {
             return tokenURI;
         } else if (bytes(tokenURI).length == 0) {
-            return string(abi.encodePacked(baseURI, tokenId.toDecString()));
+            return
+                string(
+                    abi.encodePacked(baseURI, _generateDefaultTokenURI(tokenId))
+                );
         } else {
             return string(abi.encodePacked(baseURI, tokenURI));
         }
     }
 
+    /**
+     * @notice generate URI component for token id
+     * @dev padded hex string is used to match https://eips.ethereum.org/EIPS/eip-1155#metadata
+     * @return tokenURI token URI component
+     */
+    function _generateDefaultTokenURI(
+        uint256 tokenId
+    ) internal view virtual returns (string memory tokenURI) {
+        tokenURI = tokenId.toString(16, 64);
+    }
+
     /**
      * @notice set token name
      * @param name token name
diff --git a/spec/token/multi/MultiTokenMetadata.behavior.ts b/spec/token/multi/MultiTokenMetadata.behavior.ts
diff --git a/spec/token/non_fungible/NonFungibleTokenEnumerable.behavior.ts b/spec/token/non_fungible/NonFungibleTokenEnumerable.behavior.ts
diff --git a/spec/token/non_fungible/NonFungibleTokenMetadata.behavior.ts b/spec/token/non_fungible/NonFungibleTokenMetadata.behavior.ts
diff --git a/test/token/multi/MultiTokenMetadata.ts b/test/token/multi/MultiTokenMetadata.ts
diff --git a/test/token/non_fungible/NonFungibleTokenMetadata.ts b/test/token/non_fungible/NonFungibleTokenMetadata.ts
