代币的链上记录持有一个最多 200 字节的 uri。它指向由创作者托管的 JSON 元数据文档;描述、图片、分类与链接都在文档里。应用的发行页会为你生成文档;本页面向任何手工制作文档的人给出规范。
字段#
| 字段 | 类型 | 限制 | 是否必需 |
|---|---|---|---|
name |
字符串 | 64 个字符 | 建议;缺省时回退到链上名称 |
name_en |
字符串 | 64 个字符 | 可选的英文名 |
description |
字符串 | 1,000 个字符(应用生成最多 500) | 建议 |
description_en |
字符串 | 1,000 个字符 | 可选 |
image |
字符串 | https:// 地址,或最长 1,200,000 个字符的 data:image/...;base64, 地址(png、jpeg、webp、gif 或 svg) |
建议 |
category |
字符串 | Culture、Art、Gaming、Animals 之一 |
可选 |
website |
字符串 | https:// 地址,400 个字符 |
可选 |
social |
字符串 | https:// 地址,400 个字符 |
可选 |
未知字段被忽略。超过限制的字符串被截断而不是拒绝。地址不是 https:// 的字段会被丢弃。
文档规则#
| 规则 | 数值 |
|---|---|
| 内容类型 | application/json |
| 最大大小 | 1,500,000 字节 |
| 抓取超时 | 6 秒 |
| 失败重试 | 每 15 分钟 |
| 内联替代 | 把 data:application/json,... 直接写在 uri 里,适合极小的文档 |
索引器抓取文档一次,保存上述字段,失败时重试。之后更改文档会在下一次抓取后改变应用的显示;链上 uri 本身不能更改。
托管#
- 从你控制的主机以
https://提供文档。主机服务商的静态文件服务就足够。 - 允许跨域读取(
Access-Control-Allow-Origin: *),让浏览器与第三方站点可以直接读取。 - 如果内嵌图片,把它保持在 data URL 限制之内;否则作为单独的
https://文件托管并引用。 - 不要把文档放在重定向链之后,或需要 JavaScript 的页面里。
示例#
json
{
"name": "爆发",
"name_en": "Baofa",
"description": "Baofa 协议代币。与平台上的每一枚代币一样,在同一条曲线上发行,毕业后在 PancakeSwap v2 上市,流动性永久销毁。",
"description_en": "The Baofa protocol token. Launched on the same curve as every coin on the platform, listed on PancakeSwap v2 at graduation with its liquidity burned.",
"image": "https://baofa.fun/token/baofa-1024.png",
"category": "Culture",
"website": "https://baofa.fun",
"social": "https://baofa.fun/#/app/social"
}文档做不到的事#
文档只负责展示。它不能更改代币的名称、符号、供应量或费用,不携带任何代码,应用把其中的字符串作为文本而非标记渲染。文档中的链接在新标签页打开且不发送来源信息。