Skip to content

Latest commit

 

History

History
118 lines (87 loc) · 4.89 KB

nft_metadata_zh.md

File metadata and controls

118 lines (87 loc) · 4.89 KB
Raw

元数据标准

如何在你的CRC721或CRC1155 NFT 中添加丰富的元数据？

为了让OneSwap能够方便的拉取、展示你的NFT Token，你的CRC721 NFTs或者CRC1155 NFTs除了提供唯一的标识符（例如：CRC721 中的token_id）之外，还需要提供额外的元数据属性，比如：名称、描述和图像。

实现token URI

对于OneSwap来说，要拉取CRC721和CRC1155资产的链外元数据，你的合约需要返回一个我们可以找到元数据的URI。我们调用CRC721的tokenURI方法和CRC1155的uri方法去查找这个 URI。首先，让我们看一下一个demo合约的tokenURI方法。

/**
 * @dev Returns an URI for a given token ID
 */
function tokenURI(uint256 _tokenId) public view returns (string) {
  return Strings.strConcat(
      baseTokenURI(),
      Strings.uint2str(_tokenId)
  );
}

你的CRC721中的tokenURI函数或CRC1155合约中的uri函数应该返回一个HTTP/HTTPS URL或IPFS URL。调用这个URL应该返回你的NFT token的元数据，数据格式必须是JSON格式。

关于如何处理去中心化的元数据 URI，见下面关于 IPFS URI 的部分。

元数据结构

OneSwap支持根据 官方 CRC721 元数据标准 或 Enjin 元数据建议 进行结构化的元数据。

下面是OneSwap上一个系列的元数据的例子。

{
  "name": "Asset Metadata",
  "description": "This is metadata of your NFT token", 
  "external_url": "https://www.oneswap.net/images/common/logo-all-white.svg", 
  "image": "", 
  "attributes": [ ... ], 
}

以下是这些属性的各自工作原理：

属性 工作原理
image 这是该NFT图像的URL。可以是几乎任何类型的图片，可以是IPFS URL或其他路径。我们建议使用 350 x 350 的图片。
image_data 原始的SVG图像数据，如果你想即时生成图像（不推荐）。只有在不包含image参数时才使用这个。
external_url 这是出现在OneSwap上资产的图片下面的URL，将允许用户离开OneSwap，在你的网站上查看该项目。
description 该NFT的可读描述。支持 Markdown。
name 该NFT的名称。
attributes 这些是该NFT的属性，它们将显示在OneSwap上NFT的详情页面上。(见下文)
background_color 该NFT在OneSwap上的背景颜色。必须是六位数的十六进制，没有预留 #。
animation_url 一个指向该NFT的多媒体附件的URL。支持GLTF、GLB、WEBM、MP4、M4V、OGV 和 OGG等文件扩展名，以及纯音频扩展名MP3、WAV 和 OGA。Animation_url 也支持HTML页面，允许你使用 JavaScript 画布、WebGL 等建立丰富的体验和互动的NFTs。现在支持HTML页面内的脚本和相对路径。然而，不支持对浏览器扩展的访问。
youtube_url 一个指向YouTube视频的 URL。

属性

为了让您的项目更有魅力，我们支持在每个资产下方展示元数据中添加自定义“属性”。

为了生成这些属性，在元数据中包含了以下属性列表。

...
{
"attributes": [
    {
      "trait_type": "Base", 
      "value": "Starfish"
    }, 
    {
      "trait_type": "Eyes", 
      "value": "Big"
    }, 
    {
      "trait_type": "Mouth", 
      "value": "Surprised"
    }, 
    {
      "trait_type": "Level", 
      "value": 5
    }, 
    {
      "trait_type": "Stamina", 
      "value": 1.4
    }, 
    {
      "trait_type": "Personality", 
      "value": "Sad"
    }
  ]
}

这里trait_type是属性的名称，value是属性的值。

在设置属性时需要注意几点！你应该把字符串属性写成字符串（记住引号）， 把数字属性写成浮点数或整数，这样 OneSwap 就可以正确地显示它们。 字符串属性应该是人类可读的字符串。

元数据存储

你可以把元数据托管在IPFS、云存储或你自己的服务器上。

IPFS

OneSwap 支持在去中心化的文件网络中存储NFT元数据，这样它们就不会被某个中心化的机构修改。

如果你使用 IPFS 来托管你的元数据，你的 URL 应该是 ipfs://<hash> 这样的格式。

例如，ipfs://QmTy8w65yBXgyfG2ZBg5TrfB2hPjrDQH3RCQFJGkARStJb。

如果你打算在 IPFS 上存储，我们推荐使用 Pinata 来轻松存储数据。这里有一个 Chainlink 的入门教程。