diff --git a/EIPS/eip-5489.md b/EIPS/eip-5489.md index 0586d78f447452..3013fad513da76 100644 --- a/EIPS/eip-5489.md +++ b/EIPS/eip-5489.md @@ -4,7 +4,7 @@ title: NFT Hyperlink Extension description: NFT Hyperlink Extension tries to make NFTs as decentralized medium for Web3. author: IronMan_CH (@coderfengyun) discussions-to: https://ethereum-magicians.org/t/eip-5489-nft-hyperlink-extension/10431 -status: Draft +status: Review type: Standards Track category: ERC created: 2022-08-16 @@ -89,7 +89,9 @@ interface IERC5489 { ) external; /** - * @dev + * @dev Throws if `tokenId` is not a valid NFT. URIs are defined in RFC 3986. + * The URI may point to a JSON file that confirms to the "EIP5489 Metadata JSON schema". + * * returns the latest uri of an slot on a token, which is indicated by `tokenId`, `slotManagerAddr` */ function getSlotUri(uint256 tokenId, address slotManagerAddr) @@ -131,6 +133,28 @@ We use addresses to represent the key of slots to ensure enough flexibility to d ### New URI format to enable redirect between hNFTs This extension adds a new URI scheme, `hnft://` so that the URI pointed to by the NFT is resolvable. +### EIP5489 Metadata JSON schema +``` +{ + "title": "AD Metadata", + "type": "object", + "properties": { + "icon": { + "type": "string", + "description": "A URI pointing to a resource with mime type image/* representing the slot's occupier. Consider making any images at a width between 48 and 1080 pixels and aspect ration between 1.91:1 and 4:5 inclusive. Suggest to show this as an thumbnail of the target resource" + }, + "description": { + "type": "string", + "description": "A paragraph which briefly introduce what is the target resource" + }, + "target": { + "type": "string", + "description": "A URI pointing to target resource, sugguest to follow 30X status code to support more redirections, the mime type and content rely on user's setting" + } + } +} +``` + ## Backwards Compatibility As mentioned in the specifications section, this standard can be fully EIP-721 compatible by adding an extension function set.