TON 元数据解析
元数据标准涵盖了 NFT、NFT 集合和 Jettons，在 TON 增强提案 64 TEP-64 中有所描述。
在 TON 上，实体可以有三种类型的元数据：链上、半链上和链下。
- 链上元数据： 存储在区块链内部，包括名称、属性和图像。
- 链下元数据： 使用链接存储到链外托管的元数据文件。
- 半链上元数据： 两者之间的混合体，允许在区块链上存储小字段，如名称或属性，而将图像托管在链外，并仅存储指向它的链接。
蛇形数据编码
蛇形编码格式允许部分数据存储在标准cell内，而剩余部分存储在子cell内（以递归方式）。蛇形编码格式必须使用 0x00 字节作为前缀。TL-B 方案：
tail#_ {bn:#} b:(bits bn) = SnakeData ~0;
cons#_ {bn:#} {n:#} b:(bits bn) next:^(SnakeData ~n) = SnakeData ~(n + 1);
当单个cell无法存储的数据超过最大大小时，使用 蛇形格式存储额外数据。这是通过在根cell中存储部分数据，其余部分存储在第一个子cell中，并继续 递归进行，直到所有数据都被存储。
以下是 TypeScript 中 蛇形格式编码和解码的示例：
export function makeSnakeCell(data: Buffer): Cell {
const chunks = bufferToChunks(data, 127)
if (chunks.length === 0) {
return beginCell().endCell()
}
if (chunks.length === 1) {
return beginCell().storeBuffer(chunks[0]).endCell()
}
let curCell = beginCell()
for (let i = chunks.length - 1; i >= 0; i--) {
const chunk = chunks[i]
curCell.storeBuffer(chunk)
if (i - 1 >= 0) {
const nextCell = beginCell()
nextCell.storeRef(curCell)
curCell = nextCell
}
}
return curCell.endCell()
}
export function flattenSnakeCell(cell: Cell): Buffer {
let c: Cell | null = cell;
const bitResult = new BitBuilder();
while (c) {
const cs = c.beginParse();
if (cs.remainingBits === 0) {
break;
}
const data = cs.loadBits(cs.remainingBits);
bitResult.writeBits(data);
c = c.refs && c.refs[0];
}
const endBits = bitResult.build();
const reader = new BitReader(endBits);
return reader.loadBuffer(reader.remaining / 8);
}
应该注意，使用 蛇形格式时在根cell中并不总是需要 0x00 字节前缀，就像链下 NFT 内容的情况一样。此外，cell中以字节而非位填充，以简化解析。为了避免在其父cell已经写入后再向下一个子cell添加引用的问题，snake cell是以反向顺序构造的。
分块编码
分块编码格式使用字典数据结构存储数据，从 chunk_index 到 chunk。分块编码必须使用 0x01 字节作为前缀。TL-B 方案：
chunked_data#_ data:(HashMapE 32 ^(SnakeData ~0)) = ChunkedData;
以下是使用 TypeScript 解码分块数据的示例：
interface ChunkDictValue {
content: Buffer;
}
export const ChunkDictValueSerializer = {
serialize(src: ChunkDictValue, builder: Builder) {},
parse(src: Slice): ChunkDictValue {
const snake = flattenSnakeCell(src.loadRef());
return { content: snake };
},
};
export function ParseChunkDict(cell: Slice): Buffer {
const dict = cell.loadDict(
Dictionary.Keys.Uint(32),
ChunkDictValueSerializer
);
let buf = Buffer.alloc(0);
for (const [_, v] of dict) {
buf = Buffer.concat([buf, v.content]);
}
return buf;
}
NFT 元数据属性
| 属性 | 类型 | 要求 | 描述 |
|---|---|---|---|
uri | ASCII 字符串 | 可选 | 指向由 "半链上内容布局" 使用的带有元数据的 JSON 文档的 URI。 |
name | UTF8 字符串 | 可选 | 标识资产。 |
description | UTF8 字符串 | 可选 | 描述资产。 |
image | ASCII 字符串 | 可选 | 指向带有图像 mime 类型的资源的 URI。 |
image_data | 二进制* | 可选 | 链上布局的图像的二进制表示，或链下布局的 base64。 |
Jetton 元数据属性
uri- 可选。由 "半链上内容布局" 使用。ASCII 字符串。指向带有元数据的 JSON 文档的 URI。name- 可选。UTF8 字符串。标识资产。description- 可选。UTF8 字符串。描述资产。image- 可选。ASCII 字符串。指向带有图像 mime 类型的资源的 URI。image_data- 可选。链上布局的图像的二进制表示，或链下布局的 base64。symbol- 可选。UTF8 字符串。代币的符号，例如 "XMPL"。使用格式 "你收到了 99 XMPL"。decimals- 可选。如未指定，默认使用 9。从 0 到 255 的数字的 UTF8 编码字符串。代币使用的小数位数，例如 8，意味着将代币数量除以 100000000 以获得其用户表示。amount_style- 可选。需要由外部应用程序来理解显示jettons数量的格式。
- "n" - jettons数量（默认值）。如果用户拥有 0 小数的 100 个代币，则显示用户拥有 100 个代币
- "n-of-total" - 总发行jettons数量中的jettons数量。例如，totalSupply Jetton = 1000。用户在jettons钱包中有 100 个jettons。例如，必须在用户的钱包中显示为 100 of 1000 或以任何其他文本或图形方式来表现从整体中的特定部分。
- "%" - 从总发行jettons数量中的百分比。例如，totalSupply Jetton = 1000。用户在jettons钱包中有 100 个jettons。例如，应该在用户的钱包中显示为 10%。
render_type- 可选。需要由外部应用程序来理解jettons属于哪个组，以及如何显示它。
- "currency" - 作为代币显示（默认值）。
- "game" - 游戏显示。应该显示为 NFT，但同时显示jettons的数量，考虑到
amount_style。
| 属性 | 类型 | 要求 | 描述 |
|---|---|---|---|
uri | ASCII 字符串 | 可选 | 指向用于“半链上内容布局”的元数据的 JSON 文档的 URI。 |
name | UTF8 字符串 | 可选 | 标识资产。 |
description | UTF8 字符串 | 可选 | 描述资产。 |
image | ASCII 字符串 | 可选 | 指向资源的 URI，该资源具有图像的 mime 类型。 |
image_data | 二进制* | 可选 | 链上布局的图像的二进制表示，或链外布局的 base64。 |
symbol | UTF8 字符串 | 可选 | 代币的符号 - 例如 "XMPL"，使用形式 "您收到了 99 XMPL"。 |
decimals | UTF8 字符串 | 可选 | 代币使用的小数位数。如果未指定，默认使用 9。UTF8 编码的字符串，数字在 0 到 255 之间。 - 例如，8，意味着代币数量必须除以 100000000 来获取其用户表示形式。 |
amount_style | 可选 | 外部应用需要了解显示什么样的 jettons 格式。定义为 n，n-of-total，%。 | |
render_type | 可选 | 外部应用需要了解 jetton 属于哪个组并如何显示它。"currency" - 作为货币显示（默认值）。“game” - 用于游戏的显示，显示为 NFT，但同时显示 jettons 的数量并考虑 amount_style 的值。 |
amount_style参数:
- n - jettons 的数量（默认值）。如果用户拥有 0 小数的 100 个代币，则显示用户拥有 100 个代币。
- n-of-total - 用户拥有的 jettons 数量与发行的总 jettons 数量之比。例如，如果 Jettons 的 totalSupply 是 1000，用户的钱包中有 100 jettons，那么它必须以用户钱包中的 100/1000 或以其他文字或图形方式显示，以展示用户代币与可用代币总量的比例。
- % - 从发行的总 jettons 数量中 jettons 的百分比。例如，如果 Jettons 的 totalSupply 是 1000，用户持有 100 jettons，百分比应在用户钱包余额显示 10%（100 ÷ 1000 = 0.1 或 10%）。
render_type参数:
- currency - 作为货币显示（默认值）。
- game - 用于游戏的显示，显示为 NFT，但同时显示 jettons 的数量并考虑
amount_style值。
解析元数据
要解析元数据，首先必须从区块链获取 NFT 数据。为了更好地理解这个过程，请考虑阅读我们的 TON 资产处理文档章节中的获取 NFT 数据部分。
在获得链上 NFT 数据后，必须对其进行解析。要执行此过程，必须通过读取构成 NFT 内部结构的第一个字节来确定 NFT 的内容类型。
链下
如果元数据字节字符串以 0x01 开始，它表示链外 NFT 内容类型。NFT 内容的其余部分使用Snake编码格式解码为 ASCII 字符串。在正确的 NFT URL 被实现，并且检索到 NFT 标识数据后，过程即完成。以下是使用链下 NFT 内容元数据解析的 URL 示例：
https://s.getgems.io/nft/b/c/62fba50217c3fe3cbaad9e7f/95/meta.json
URL 内容（从上面直接引用）:
{
"name": "TON Smart Challenge #2 Winners Trophy",
"description": "TON Smart Challenge #2 Winners Trophy 1 place out of 181",
"image": "https://s.getgems.io/nft/b/c/62fba50217c3fe3cbaad9e7f/images/943e994f91227c3fdbccbc6d8635bfaab256fbb4",
"content_url": "https://s.getgems.io/nft/b/c/62fba50217c3fe3cbaad9e7f/content/84f7f698b337de3bfd1bc4a8118cdfd8226bbadf",
"attributes": []
}
链上和半链上
如果元数据字节字符串以 0x00 开始，它表示 NFT 使用链上或半链上格式。
我们的 NFT 元数据存储在一个字典中，其中键是属性名称的 SHA256 哈希，值是以Snake或分块格式存储的数据。
为了确定正在使用哪种类型的 NFT，开发者需要读取已知的 NFT 属性，例如 uri、name、image、description 和 image_data。如果元数据中存在 uri 字段，则表示半链上布局。在这种情况下，应该下载 uri 字段中指定的链外内容，并与字典值合并。
链上 NFT 的示例：EQBq5z4N_GeJyBdvNh4tPjMpSkA08p8vWyiAX6LNbr3aLjI0
半链上 NFT 的示例： EQB2NJFK0H5OxJTgyQbej0fy5zuicZAXk2vFZEDrqbQ_n5YW
链上 Jetton Master 的示例：EQA4pCk0yK-JCwFD4Nl5ZE4pmlg4DkK-1Ou4HAUQ6RObZNMi
链上 NFT 解析器的示例：stackblitz/ton-onchain-nft-parser
NFT 元数据的重要说明
- 对于 NFT 元数据，
name、description和image（或image_data）字段是显示 NFT 所必需的。 - 对于 Jetton 元数据，
name、symbol、decimals和image（或image_data）是主要的。 - 重要的是要意识到，任何人都可以使用任何
name、description或image创建 NFT 或 Jetton。为避免混淆和潜在的骗局，用户应始终以一种清晰区分于其应用其他部分的方式显示他们的 NFT。恶意 NFT 和 Jettons 可以带有误导性或虚假信息被发送到用户的钱包。 - 一些项目可能有一个
video字段，链接到与 NFT 或 Jetton 相关联的视频内容。