BUMO ATP 20 协议
简介
ATP 20(Account based Tokenization Protocol) 指基于 BUMO 智能合约发行 token 的标准协议。该协议提供了转移 token 的基本功能，并允许 token 授权给第三方使用。
目标
基于这套标准接口，可以让发行的 token 被其他应用程序和第三方快速对接和使用，比如钱包和交易所。
规则
BUMO 智能合约由 JavaScript 语言实现, 包含初始化函数 init 和两个入口函数 main、query 。init 函数用于合约创建时初始化; main 函数主要负责数据写入，query 函数负责数据查询。
Token 属性
Token 属性可以通过合约的 tokenInfo 功能函数查询到，存储在智能合约的账号里。包含以下内容
| 变量 | 描述 |
|---|---|
| name | Token 名称 |
| symbol | Token 符号 |
| decimals | Token 小数位数 |
| totalSupply | Token 总量 |
| version | ATP 版本 |
注意：
- name：推荐使用单词全拼，每个首字母大写。如 Demo Token
- symbol：推荐使用大写首字母缩写。如 DT
- decimals：小数位在 0~8 的范围，0 表示无小数位。
- totalSupply：范围是 (1~2 ^ 63 - 1)。假如，发行一笔数量是10000, 精度为8的ATP 20 Token，此时totalSupply = 10 ^ 8 * 10000, 结果是1000000000000。
- version：atp 的版本。如 ATP20
事件
函数transfer、transferFrom、approve会触发事件（详情请见各函数说明），事件是调用tlog接口，在区块链上记录一条交易日志，该日志记录了函数调用详情，方便用户阅读。
tlog定义如下:
tlog(topic,args...);
- tlog会产生一笔交易写在区块上
- topic: 日志主题，必须为字符串类型,参数长度(0,128]
- args...: 最多可以包含5个参数，参数类型可以是字符串、数值或者布尔类型,每个参数长度(0,1024]
功能函数
BUMO ATP 20 协议中的函数包括 transfer、transferFrom、approve、balanceOf、tokenInfo、allowance。
transfer
-
功能
转移 value 数量的 token 到目的地址 to，并且必须触发 log 事件。 如果资金转出账户余额没有足够的token来支出，该函数应该被throw。
-
入口函数
main -
参数 json 结构
{ "method":"transfer", "params":{ "to":"buQnTmK9iBFHyG2oLce7vcejPQ1g5xLVycsj", "value":"1000000" } } -
json参数
参数 描述 to 目标账户地址 value 转移数量（字符串类型） -
函数
function transfer(to, value) -
返回值
true或者抛异常
-
事件
tlog('transfer', sender, to, value);topic: 方法名，这里是transfer
sender: 合约调用账户地址
to: 目标账户地址
value: 转移数量(字符串类型)
approve
-
功能
授权账户 spender 可以从交易发送者账户转出数量为 value 的token。
-
入口函数
main -
参数json结构
{ "method":"approve", "params":{ "spender":"buQnTmK9iBFHyG2oLce7vcejPQ1g5xLVycsj", "value":"1000000" } } -
json参数
参数 描述 spender 账户地址 value 被授权可转移数量（字符串类型） -
函数
function approve(spender, value) -
返回值
true 或者抛异常
-
事件
tlog('approve', sender, spender, value);topic: 方法名，这里是'approve'
sender: 合约调用账户地址
spender: 被授权账户地址
value: 被授权可转移数量（字符串类型）
transferFrom
-
功能
从from发送数量为 value 的 token 到 to，必须触发 log 事件。 在 transferFrom 之前，from 必须给当前交易的发起者进行授权额度(即approve操作)。如果 from 余额没有足够的 token 来支出或者 from 授权给当前交易的发起者的额度不足，该函数应该被 throw。
-
入口函数
main -
参数json结构
{ "method":"transferFrom", "params":{ "from":"buQnTmK9iBFHyG2oLce7vcejPQ1g5xLVycsj", "to":"buQYH2VeL87svMuj2TdhgmoH9wSmcqrfBner", "value":"1000000" } } -
json参数
参数 描述 from 源账户地址 to 目标账户地址 value 转移数量（字符串类型） -
函数
function transferFrom(from,to,value) -
返回值
true或者抛异常
-
事件
tlog('transferFrom', sender, from, to, value); topic: 方法名，这里是'transferFrom'
sender: 合约调用账户地址
from: 源账户地址
to: 目标账户地址
value: 转移数量（字符串类型）
balanceOf
-
功能
返回指定账户的 token。
-
入口函数
query -
参数json结构
{ "method":"balanceOf", "params":{ "address":"buQnTmK9iBFHyG2oLce7vcejPQ1g5xLVycsj" } } -
json参数
参数 描述 address 账户地址 -
函数
function balanceOf(owner) -
返回值：指定地址的余额
{ "result":{ "balanceOf":"100000000000000", } }
tokenInfo
-
功能
返回 Token 的基本信息。
-
入口函数
query -
参数json结构
{ "method":"tokenInfo" } -
函数
function tokenInfo() -
返回值
{ "result":{ "type": "string", "value": { "tokenInfo": { "name": "DemoToken", "symbol": "DT", "decimals": 8, "totalSupply": "5000000000000", "version": "1.0" } } } }
allowance
-
功能
返回 spender 仍然被允许从 owner 提取的金额。
-
入口函数
query -
参数json结构
{ "method":"allowance", "params":{ "owner":"buQnTmK9iBFHyG2oLce7vcejPQ1g5xLVycsj", "spender":"buQYH2VeL87svMuj2TdhgmoH9wSmcqrfBner" } } -
json参数
参数 描述 owner 账户地址 spender 账户地址 -
函数
function allowance(owner, spender) -
返回值
{ "result":{ "allowance":"1000000", } }
合约入口
init
-
创建合约时候，触发合约
init入口函数，负责合约创建时的初始化。 -
函数
function init(input_str){ } -
参数Json结构
{ "params":{ "name":"DemoToken", "symbol":"DT", "decimals":8, "totalSupply":"5000000000000", "version": "1.0" } } -
返回值
true或者抛异常
main
-
负责数据写入，其中包含了 transfer、transferFrom、approve。
-
函数体
function main(input_str){ let input = JSON.parse(input_str); if(input.method === 'transfer'){ transfer(input.params.to, input.params.value); } else if(input.method === 'transferFrom'){ transferFrom(input.params.from, input.params.to, input.params.value); } else if(input.method === 'approve'){ approve(input.params.spender, input.params.value); } else{ throw '<Main interface passes an invalid operation type>'; } }
query
-
函数体
function query(input_str){ globalAttribute = JSON.parse(storageLoad(globalAttributeKey)); let result = {}; let input = JSON.parse(input_str); if(input.method === 'tokenInfo'){ result.tokenInfo = globalAttribute; } else if(input.method === 'allowance'){ result.allowance = allowance(input.params.owner, input.params.spender); } else{ throw '<Query interface passes an invalid operation type>'; } return JSON.stringify(result); }