BUMO ATP 30 协议
简介
ATP 30(Account based Tokenization Protocol) 是“Non-Fungible Tokens”，英文简写为 ”NFT”，可以翻译为不可互换的 tokens。简单地说，就是每个 token 都是独一无二的，是不能互换的；
注意：
- 在合约范围内 tokenId 是唯一的
- tokenId 只能被一个 owner (i.e. address) 所拥有
- 一个owner可以拥有多个 NFTs，它的 balance 只记数量
- ATP 30提供 approve, transfer, and transferFrom 接口用于所属权转移
标准
NTF ID
NTF ID，即 tokenId，在合约中用唯一标识符，每个NFT的ID在智能合约的生命周期内不允许改变。推荐的实现方式有：从0开始，每新加一个 NFT，NTF ID加1
Token 属性
Token 属性可以通过合约的 tokenInfo 功能函数查询到，存储在智能合约的账号里。包含以下内容
| 变量 | 描述 |
|---|---|
| id | Token 惟一标识符 |
| owner | Token 所有人 |
| description | Token 描述 |
| creationTime | Token 创建时间 |
注意：
- id：从0开始，每创建一个 Token，id 递增1。
- description：字符串长度范围是 1 ~ 200k。
事件
函数 issue、transfer、transferFrom、approve 会触发事件，事件是调用 tlog 接口，在区块链上记录一条交易日志，该日志记录了函数调用详情，方便用户阅读。
tlog定义如下:
tlog(topic,args...);
- tlog 会产生一笔交易写在区块上
- topic: 日志主题，必须为字符串类型,参数长度(0,128]
- args...: 最多可以包含5个参数，参数类型可以是字符串、数值或者布尔类型,每个参数长度(0,1024]
功能函数
BUMO ATP 30协议中的函数包括 issue、totalSupply、balanceOf、ownerOf、approve、transfer、transferFrom、tokensOfOwner、tokenInfo、name、symbol。
issue
-
功能
发行新 Token。
-
入口函数
main -
参数 json 结构
{ "method":"issue", "params": { "description": "demo" } } -
json 参数
参数 描述 description Token的描述 -
函数
function issue(description) -
返回值
true 或者抛异常
-
事件：
tlog('issue', sender, tokenId, description);topic: 方法名，这里是 'issue'
sender: 合约调用账户地址
tokenId: 转移的 tokenId
description：Token的描述
totalSupply
-
功能
返回发行的 token 的总数。
-
入口函数
query -
参数 json 结构
{ "method":"totalSupply" } -
函数：
function totalSupply() -
返回值：
{ "result":{ "type": "string", "value": { "totalSupply": "2" } } }
balanceOf
-
功能
返回指定账户的 token 的总和。
-
入口函数
query -
参数 json 结构
{ "method":"balanceOf", "params":{ "address":"buQnTmK9iBFHyG2oLce7vcejPQ1g5xLVycsj" } } -
json参数
参数 描述 address 账户地址 -
函数：
function balanceOf(address) -
返回值：指定地址的代币总和
{ "result":{ "type": "number", "value": { "count": 1 } } }
ownerOf
-
功能
返回 token的拥有者。
-
入口函数
query -
参数 json 结构
{ "method":"ownerOf", "params": { "tokenId": 1 } } -
json参数
参数 描述 tokenId Token 惟一标识 -
函数：
function ownerOf(tokenId) -
返回值：
{ "result":{ "type": "string", "value": { "owner": "buQnTmK9iBFHyG2oLce7vcejPQ1g5xLVycsj" } } }
approve
-
功能
授权账户 spender 可以从交易发送者账户转出指定 tokenId 的 token。只有 token 的拥有者才可以调用。
-
入口函数
main -
参数 json 结构
{ "method":"approve", "params":{ "spender":"buQnTmK9iBFHyG2oLce7vcejPQ1g5xLVycsj", "tokenId": 2 } } -
json 参数
参数 描述 spender 账户地址 tokenId Token 标识符 -
函数
function approve(spender, tokenId) -
返回值
true 或者抛异常
-
事件：
tlog('approve', sender, spender, tokenId);topic: 方法名，这里是 'approve'
sender: 合约调用账户地址
spender: 被授权账户地址
tokenId: 转移的 tokenId
transfer
-
功能
转移指定 tokenId 的 token 到目的地址 to，并且必须触发 log 事件。只有 token 的拥有者才可以调用。
-
入口函数
main -
参数 json 结构
{ "method":"transfer", "params":{ "to":"buQnTmK9iBFHyG2oLce7vcejPQ1g5xLVycsj", "tokenId": 0 } } -
json 参数
参数 描述 to 目标账户地址 tokenId Token 标识符 -
函数
function transfer(to, tokenId) -
返回值
true或者抛异常
-
事件：
tlog('transfer', sender, to, tokenId);topic: 方法名，这里是'transfer'
sender: 合约调用账户地址
to: 目标账户地址
tokenId: 转移的tokenId
transferFrom
-
功能
从 from 发送指定 tokenId 的 token 到 to，必须触发 log 事件。 在 transferFrom 之前，from 必须给当前交易的发起者进行授权额度(即 approve 操作)。只有 token 的授权地址才可以调用。
-
入口函数
main -
参数 json 结构
{ "method":"transferFrom", "params":{ "from":"buQnTmK9iBFHyG2oLce7vcejPQ1g5xLVycsj", "to":"buQYH2VeL87svMuj2TdhgmoH9wSmcqrfBner", "tokenId": 1 } } -
json 参数
参数 描述 from 源账户地址 to 目标账户地址 tokenId Token 标识符 -
函数
function transferFrom(from,to,tokenId) -
返回值
true或者抛异常
-
事件
tlog('transferFrom', sender, from, to, tokenId);topic: 方法名，这里是'transferFrom'
sender: 合约调用账户地址
from: 源账户地址
to: 目标账户地址
tokenId: 转移的tokenId
tokensOfOwner
-
功能
返回 owner 的所有 token。
-
入口函数
query -
参数 json 结构
{ "method":"ownerOf", "params": { "owner": "buQnTmK9iBFHyG2oLce7vcejPQ1g5xLVycsj" } } -
json参数
参数 描述 owner Token 拥有人 -
函数：
function ownerOf(tokenId) -
返回值：
{ "result":{ "type": "Array", "value": { "tokens": [0, 2] } } }
tokenInfo
-
功能
返回 Token 的基本信息。
-
入口函数
query -
参数 json 结构
{ "method":"tokenInfo", "params":{ "tokenId": 0 } } -
json参数
参数 描述 tokenId Token 惟一标识 -
函数：
function tokenInfo(tokenId) -
返回值：
{ "result":{ "type": "string", "value": { "tokenInfo": { "title": "demo", "author": "buQnTmK9iBFHyG2oLce7vcejPQ1g5xLVycsj", "info": "demo", "creationTime": "135665626565612" } } } }
name
-
功能
返回当前合约所含的代币集合的名称。
-
入口函数
query -
参数 json 结构
{ "method":"name" } -
函数：
function name() -
返回值：
{ "result":{ "type": "string", "value": { "name": "demo" } } }
symbol
-
功能
返回当前合约所含的代币集合的符号。
-
入口函数
query -
参数 json 结构
{ "method":"symbol" } -
函数：
function symbol() -
返回值：
{ "result":{ "type": "string", "value": { "symbol": "DM" } } }
合约入口
init
-
创建合约时候，触发合约
init入口函数，负责合约创建时的初始化。 -
函数
function init(input_str){ } -
参数Json结构
{ "params":{ "name":"DemoToken", "symbol":"DT" } } -
返回值
true或者抛异常
main
-
负责数据写入，其中包含了 issue、transfer、transferFrom、approve。
-
函数体
function main(arg) { const data = JSON.parse(arg); const operation = data.operation || ''; const param = data.param || {}; switch (operation) { case 'issue': issue(param); break; case 'approve': approve(param.to, param.tokenId); break; case 'transfer': transfer(param.to, param.tokenId); break; case 'transferFrom': transferFrom(param.from, param.to, param.tokenId); break; default: throw '<Main interface passes an invalid operation type>'; } }
query
-
负责数据查询，其中包含了totalSupply、balanceOf、ownerOf、tokensOfOwner、tokenInfo、name、symbol等接口。
-
函数体
function query(arg) { let result = {}; let input = JSON.parse(input_str); if(input.method === 'name'){ result.name = name(); } else if(input.method === 'symbol'){ result = symbol(); } else if(input.method === 'tokenInfo'){ result = tokenInfo(input.tokenId); } else if(input.method === 'totalSupply'){ result.totalSupply = totalSupply(); } else if(input.method === 'balanceOf'){ result.balance = balanceOf(input.owner); } else if(input.method === 'ownerOf'){ result.owner = ownerOf(input.tokenId); } else if(input.method === 'tokensOfOwner'){ result.tokens = tokensOfOwner(input.owner); } else{ throw '<Query interface passes an invalid operation type>'; } return JSON.stringify(result); }