本文来解读一下eosio.token合约，这个合约是官方提供的，它可以让任何人都可以发行自己的token。
eosio.token合约代码,在eos源代码目录下的contracts/eosio.token这个文件夹中。
概览
我们先看这个合约的.abi文件，当你编译成功后，在contracts/eosio.token里，会有这么个.abi文件: eosio.token.abi。你可以看到这个文件是个文本形式的，可以用任何文本编辑器打开，看下里面的内容，这是json格式的：
{
"version": "eosio::abi/1.0",
"types": [{
"new_type_name": "account_name",
"type": "name"
}],
"structs": [{
"name": "transfer",
"base": "",
"fields": [
{"name":"from", "type":"account_name"},
{"name":"to", "type":"account_name"},
{"name":"quantity", "type":"asset"},
{"name":"memo", "type":"string"}
]
},{
"name": "create",
"base": "",
"fields": [
{"name":"issuer", "type":"account_name"},
{"name":"maximum_supply", "type":"asset"}
]
},{
"name": "issue",
"base": "",
"fields": [
{"name":"to", "type":"account_name"},
{"name":"quantity", "type":"asset"},
{"name":"memo", "type":"string"}
]
},{
"name": "account",
"base": "",
"fields": [
{"name":"balance", "type":"asset"}
]
},{
"name": "currency_stats",
"base": "",
"fields": [
{"name":"supply", "type":"asset"},
{"name":"max_supply", "type":"asset"},
{"name":"issuer", "type":"account_name"}
]
}
],
"actions": [{
"name": "transfer",
"type": "transfer",
"ricardian_contract": ""
},{
"name": "issue",
"type": "issue",
"ricardian_contract": ""
}, {
"name": "create",
"type": "create",
"ricardian_contract": ""
}
],
"tables": [{
"name": "accounts",
"type": "account",
"index_type": "i64",
"key_names" : ["currency"],
"key_types" : ["uint64"]
},{
"name": "stat",
"type": "currency_stats",
"index_type": "i64",
"key_names" : ["currency"],
"key_types" : ["uint64"]
}
],
"ricardian_clauses": [],
"abi_extensions": []
}
可以看出，它有三个action：transfer, issue, create。structs可以看到这三个action的参数。我们也可以和eosio.token.hpp头文件对比一下三个action的声明：
void create( account_name issuer,
asset maximum_supply);
void issue( account_name to, asset quantity, string memo );
void transfer( account_name from,
account_name to,
asset quantity,
string memo );
可以看到这里的参数与头文件中的structs 是一一对应的。
再看下eosio.token.cpp底部，有这么一行：
EOSIO_ABI( eosio::token, (create)(issue)(transfer) )
可以发现，就是在这里把create, issue, transfer定义为action的。
下面我们对这三个action，逐个分析，注意看注释部分。
action: create
/*
** 对比下本action的触发命令：
cleos push action eosio.token create '[ "user", "1000000000.0000 EOS"]' \
-p eosio.token@active
** 看下参数部分：
** account_name实际就是uint64_t。
** 在eos的代码中，很多具有ID性质** 的字段都会被定义为uint64_t。
** asset 这样的结构体：
{
int64_t amount;
symbol_type symbol;
}
这里的symbol代表token的名字及其精度。
可以用下面的方法把一个token及其精度转化为整数类型：
eosio::string_to_symbol(uint8_t precision, const char* str )。
这里返回的整数可以直接转化为symbol_type。
它的第一个参数代表精度，第二个参数代表名字。还记得我们触发action时传进来的参数吗？我们给maximum_supply传递的是"1000000000.0000 EOS"
可以看到，我们在这里指定了4位的精度，token的名字叫做'EOS'。
现在你能把"1000000000.0000 EOS"和asset结构体对应起来了吧？
*/
void token::create( account_name issuer,
asset maximum_supply )
{
//这里的_self就是`eosio.token`
require_auth( _self );
auto sym = maximum_supply.symbol;
eosio_assert( sym.is_valid(), "invalid symbol name" );
eosio_assert( maximum_supply.is_valid(), "invalid supply");
eosio_assert( maximum_supply.amount > 0, "max-supply must be positive");
/*
* 头文件`eosio.token.hpp`中：typedef eosio::multi_index<N(stat), currency_stats> stats;
可以看出stats是个支持多索引的table类型，table类型的数据是直接保存在数据库中的，我们下次找个专题专门讲解一些table类型。这里的table的每一条记录都是currency_stats类型：
struct currency_stats {
asset supply;
asset max_supply;
account_name issuer;
uint64_t primary_key()const { return supply.symbol.name(); }
};
以token的名字作为主键。
*/
stats statstable( _self, sym.name() );
auto existing = statstable.find( sym.name() );
eosio_assert( existing == statstable.end(), "token with symbol already exists" );
//在表中增加一条记录，包含issuer、token信息及其总量
statstable.emplace( _self, [&]( auto& s ) {
s.supply.symbol = maximum_supply.symbol;
s.max_supply = maximum_supply;
s.issuer = issuer;
});
}
action: issue
/*
* 这是个issue的action，对比一下发行token的命令：
cleos push action eosio.token issue '[ "user", "1000.0000 EOS", "memo" ]' \
-p user@active
*/
void token::issue( account_name to, asset quantity, string memo )
{
auto sym = quantity.symbol;
eosio_assert( sym.is_valid(), "invalid symbol name" );
eosio_assert( memo.size() <= 256, "memo has more than 256 bytes" );
auto sym_name = sym.name();
stats statstable( _self, sym_name );
auto existing = statstable.find( sym_name );
eosio_assert( existing != statstable.end(), "token with symbol does not exist, create token before issue" );
const auto& st = *existing;
//检查是否有issuer的许可，假如我们执行的是上面的命令，那么这里的st.issuer就是user，可以对比下create函数的实现中，写入记录的部分。
require_auth( st.issuer );
eosio_assert( quantity.is_valid(), "invalid quantity" );
eosio_assert( quantity.amount > 0, "must issue positive quantity" );
eosio_assert( quantity.symbol == st.supply.symbol, "symbol precision mismatch" );
eosio_assert( quantity.amount <= st.max_supply.amount - st.supply.amount, "quantity exceeds available supply");
//修改当前的供应量，注意supply和max_supply的区别
statstable.modify( st, 0, [&]( auto& s ) {
s.supply += quantity;
});
//先给issuer
add_balance( st.issuer, quantity, st.issuer );
if( to != st.issuer ) {
//如果是发行给别人，在通过inline action transfer给to。这里的inline action是代表立即执行的action，与deferred action相反
SEND_INLINE_ACTION( *this, transfer, {st.issuer,N(active)}, {st.issuer, to, quantity, memo} );
}
}
action: transfter
/*
对比触发此action的命令：
cleos push action eosio.token transfer \
'[ "user", "tester", "0.5000 SYS", "2 you know how much i love you" ]' -p user@active
*/
void token::transfer( account_name from,
account_name to,
asset quantity,
string memo )
{
eosio_assert( from != to, "cannot transfer to self" );
//检查是否有发送方的许可权限
require_auth( from );
eosio_assert( is_account( to ), "to account does not exist");
auto sym = quantity.symbol.name();
stats statstable( _self, sym );
const auto& st = statstable.get( sym );
//加入通知列表，稍微后会把transfer action通知给这些账户。
//这也就是为什么我们之前做transfer的时候，总是会多出两条inline action的原因。
require_recipient( from );
require_recipient( to );
eosio_assert( quantity.is_valid(), "invalid quantity" );
eosio_assert( quantity.amount > 0, "must transfer positive quantity" );
eosio_assert( quantity.symbol == st.supply.symbol, "symbol precision mismatch" );
eosio_assert( memo.size() <= 256, "memo has more than 256 bytes" );
//这里就比较简单了，不做解释了
sub_balance( from, quantity );
add_balance( to, quantity, from );
}
这次就到这里了，明天见。
简介：不羁，一名程序员；专研EOS技术，玩转EOS智能合约开发。
微信公众号：know_it_well
知识星球地址：https://t.zsxq.com/QvbuzFM
网友评论