eosiolib文件解析
Source base on EOS version: 1.0.5,some photo except.
在eos源码中,eosiolib库在源码中的位置如下:
![](https://cdn.yuque.com/yuque/358/2018/png/127138/1530061060117-de62149e-f710-4e90-8ae3-9ba1dd08e174.png)
在\eos\contracts\eosiolib一共有46个文件,其中很大部分都为头文件,具体的实现都在 eos/libraries/chain/wasm_interface.cpp中,下面我们对每个文件都做一个较为简单的介绍。
action.h
此头文件为接口函数,这些C API函数是在 eos/libraries/chain/wasm_interface.cpp 中实现的,主要提供给四大合约使用。
主要包含有这些功能 :
-
action数据的读取;
-
事务提交后的通知消息(观察者模式实现);
-
执行action所需要的权限判断;
-
其它辅助函数;
action.hpp
在action.hpp中定义了action结构体,它是Action打包后的数据形式,即所有push action产生的数据根据各自不同的数据格式进行封装打包和传送。其中还涉及到一些执行权限相关的结构体的定义permission_level,它的处理流程如下图展示:
![](https://cdn.yuque.com/yuque/358/2018/png/127138/1530062993779-cd5e0f82-8ab5-4741-99ee-d7b1856a940f.png)
最后action将会放在对应的vector迭代器中。
asset.hpp
帐户资产的定义,即一个int64_t表示资金,symbol_type表示单位,目前被定义为SYS。
chain.h
查询区块链内部状态的API,目前用于获取活跃(Active)的生产者,是从controller中拿取的,源码在eos/libraries/chain/wasm_interface.cpp中实现。
compiler_builtins.h
工具链生成的编译器内嵌部件的API。
contract.hpp
定义所有智能合约的基类,如果自己写合约,需要从这个基类派生,然后使用eosiocpp工具将自己的头文件和源文件生成wasm文件及其相关的接口文件。编写智能合约需要注意各个文件名需要名称相同,因为加载智能合约时填写的参数是根据智能合约文件路径来的。
core_symbol.hpp
定义代币的单位。
crypto.h
对给定的数据进行各种hash运算并进行存储,或者对数据进行校验。源码在eos/libraries/chain/wasm_interface.cpp中实现。
currency.hpp
货币(token合约)的创建、发行、转帐、余额查询在里实现。
datastream.hpp & serialize.hpp
定义数据流操作,可以把自定义的类的数据成员放到vector<char>中,需要时可以再次读取出来,方便数据的传输。
db.h
函数都在eos/libraries/chain/wasm_interface.cpp中的database_api类中定义,部分直接定义,部分采用宏定义,源码实现在eos\libraries\chain\apply_context.cpp中。提供了数据库的存储与查询的基本功能。其中使用的数据库是controller类中定义的数据,在这里只是一个引用。
dispatcher.hpp
它定义了执行Action的函数模板execute_action,使用远程API调用Action时,会执行这个函数。其中有两个宏:
-
EOSIO_API_CALL 内部调用了execute_action函数,执行一个Action;
-
EOSIO_API 使用BOOST_PP_SEQ_FOR_EACH循环调用EOSIO_API_CALL,即调用多个Action;
-
EOSIO_ABI 里面是一个apply函数,后面还调用EOSIO_API这个宏,即它也是用来调用 execute_action来执行action的,在我们自行编写智能合约的时候在类内部最后会加上这个宏。所以当我们加载自己编写的智能合约时,会把编写好的指定的函数功能放到action上面去执行。
eosio.hpp
包含其它一些类型的定义。在开发智能合约时,一般都包含这个头文件进行智能合约的开发。
eosiolib.cpp & memory.h & memory.hpp
eosiolib中实现了eosio项目中自定义的内存管理,对常见的内存分配方式进行了重新编写(其实只是简单的封装而已)
fixed_key.hpp
固定大小的按键按字典顺序排序的key,使用数据成员std::array<word_t, num_words()>实现的。
fixedpoint.hpp
32/64/128/256位版本的不动点变量,暂时还不知道做什么用的。
multi_index.hpp
重新封装了多索引容器模板,最终里面还是使用的boost:multi_index,这一点没有变化,它具有以下几个特点:
-
Multi-Index表的二级索引数量不能超过16个;
-
Multi-Index表的表名不能超过12个字符;
-
Multi-Index表支持双向迭代,即const_iterator和const_reverse_iterator。
很多类型都使用了它来存放,如生产者,投票,单例等等。
optional.hpp
可选类型,与boost:optinal基本一致
permission.h & permission.hpp
在eos/libraries/chain/wasm_interface.cpp的permission_api类中实现,事务提交时需要检验执行者的权限在这里。具体的校验在controller定义的数据库去比对了。
print.h & print.hpp
eosio中各种参数类型打印函数的定义,最终使用的是std::ostringstream类型。
privileged.h & privileged.hpp、
定义特权用户的各种资源限制,事务相关参数,块相关参数,以及数据传输时间间隔的各种限制。
producer_schedule.hpp
出块者相关信息的封装。
public_key.hpp
公匙
reflect.hpp
c++实现的反射器,带有大量的宏,可以自行分析下,下面有一个博客对此有些讲解:
singleton.hpp
单例模式的封装,也存储在multi_index中。
stdlib.hpp
//nothing
symbol.hpp
代币符号,规定为SYS
system.h
系统时间函数和静态断言的定义
time.hpp
时间相关,类似boost中的实现
transaction.h & transaction.hpp
事务相关,主要是对action用vector封装,另外,对nsaction的数据传输也做了各种限制,如预期时间,带宽,cpu算力,延迟传输等等。还有一个get action函数的实现,可以获取当前区块相关的数据。
types.h & types.hpp
eosiolib所有使用到的类型都在这里定义,以及name标识符与std::string类型之间转换函数的定义;
所有文件相互间的引用关系如下:
![](https://cdn.yuque.com/yuque/358/2018/png/127138/1530071226314-e043b42f-d8b3-49f6-a77f-b8142d8f5f4a.png)
varint.hpp
整型的定义,在datastream中有应用。
vector.hpp
字节数组