EOSIO源码分析 - EOSIO简介

Posted 2023-04-02 whg1016

什么是EOSIO

EOS，可以理解为Enterprise Operation System，即为商用分布式应用设计的一款区块链操作系统。EOS是引入的一种新的区块链架构，旨在实现分布式应用的性能扩展。它并不是像比特币和以太坊那样的货币，而是基于EOS软件项目之上发布的代币，被称为区块链3.0。
EOS是提供智能合约计算的可编程区块链，他是由位于美国的一家名为block.one的公司开发，全程采用C++语言来实现，智能合约采用剪辑过的C++语言来实现，相比于以太坊，拥有更高的TPS，EOS没有手续费，它是按照用户所消耗的资源来间接收费的。

获取EOSIO

二进制安装

• MacOS：

brew tap eosio/eosio
brew install eosio

• Ubuntu：

wget https://github.com/eosio/eos/releases/download/v2.1.0/eosio_2.1.0-1-ubuntu-20.04_amd64.deb
sudo apt install ./eosio_2.1.0-1-ubuntu-20.04_amd64.deb

• CentOS：

wget https://github.com/eosio/eos/releases/download/v2.1.0/eosio-2.1.0-1.el8.x86_64.rpm
sudo yum install ./eosio-2.1.0-1.el8.x86_64.rpm

EOSIO代码结构

获取源代码

git clone https://github.com/EOSIO/eos.git --recursive
–recursive参数一定要加上，否则取到的代码只是最基本的框架代码，EOSIO引用的第三方代码取不到

源代码结构

EOSIO的整体代码结构比较简单，整体采用插件模式来组织代码(以V2.0.13为例)，核心结构如下

EOSIO 
   |-----CMakeModules 相关第三库的自动编译脚本，如最重要的VM
   |-----libraries
        |-----appbase: 插件框架库，负责整个程序的，特别是nodeos程序的初始化，插件的初始化及启动
        |-----builtins: 虚拟机内建对象，特别是对于浮点结构的支持
        |-----chain: 整个链最核心的代码，负责链初始化，交易鉴权，交易执行，块打包等核心任务
        |-----fc: 基础库代码，完成结构打包，json反射，压缩，加密解密等最基础任务
        |-----chainbase: 高效eosio设计的内存映射数据库，实现对数据的快速访问与修改，最重要是实现了和eosio对应的数据回滚机制
        |-----eos-vm: 支持合约运行的WASM虚拟机
        |-----softfloat: 提供对于浮点运算的支持
        |-----wabt: 工具软件包，拓展wasm应用
        |-----yubihsm: 一种安全库，提供对钱包的支持
        |-----CMakeLists.txt 编译清单文件
   |-----plugins
        |-----chain_plugin: 核心库，实现链的初始化，控制与访问等业务
        |-----net_plugin: 核心库，实现P2P，完成交易广播，块分布式存储等业务
        |-----producer_plugin: 核心库，完成块生产，共识，交易执行调度等核心业务
        |-----chain_api_plugin: 提供对chain_plugin的访问，如发送交易，查询用户等
        |-----net_api_plugin: 提供对net_plugin的访问，如链接节点，获取链接状态等
        |-----producer_api_plugin: 提供对producer_plugin的访问，如控制生产，设置给白名单等
        |-----http_plugin: 封装http基础服务功能
        |-----wallet_plugin: 实现钱包相关功能，如钱包创建，公私钥存储等
        |-----wallet_api_plugin: 实现对wallet_plugin的访问，如最核心的交易签名
        |-----CMakeLists.txt 编译清单文件
   |-----programs
        |-----cleos: 客户端命令行程序，使用此程序可以实现对链的访问，如发送交易，查询账号，生产投票，链接其他节点
        |-----keosd: 钱包服务程序，钱包服务可以启动多个，可以根据业务需求灵活部署，也可以自己开发钱包服务
        |-----nodeos: 节点服务程序，也是最核心的程序，负责区块同步，交易生产等
        |-----CMakeLists.txt 编译清单文件
   |-----scripts
        |-----eosio_build.sh: 编译shell脚本,根据系统自己编译出目标程序
        |-----generate_package.sh: 可以将编译出来的二进制程序，按照各自系统打包成如deb，rpm等安装包
   |--CMakeLists.txt 编译清单文件

源码编译

./scripts/eosio_build.sh

运行此脚本时，系统会自动安装需要的第三方库，笔者在Ubunut18.04，20.04，CentOS7上测试过，如果想了解编译过程，可以详细查看scripts下的相关脚本
注意如果要编译Debug版本，系统资源最好大一点，特别是编译出来的nodeos程序大小达到1G以上

EOSIO框架

从框架图中我们可以看到：

• 对于链来说，只有一个nodeos程序，nodeos主动接入主网
• 用户通过cleos命令行来操作钱包keosd和nodeos，这两个程序都可以自己开发
• 钱包是用户的私产，和链没有互通关系，需要谨慎保存，防止丢失，用户可以创建多个钱包

启动与部署EOSIO

keosd 启动

./keosd \\
    --http-server-address=0.0.0.0:8900 \\
    --http-validate-host=false >>  ./logs/keosd.log 2>&1 &

钱包的数据文件默认存储在/root/eos-wallet目录下，每个钱包都有一个单独的钱包文件，默认为 default.wallet

nodeos 启动

./nodeos -e -p eosio \\
    --data-dir ./data/nodeos \\
    --signature-provider=EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV=KEY:5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3 \\
    --p2p-listen-endpoint=0.0.0.0:9878 \\
    --plugin eosio::producer_api_plugin --plugin eosio::chain_api_plugin --plugin eosio::net_api_plugin \\
    --http-server-address=0.0.0.0:8888 \\
    --http-validate-host=false
    --replay-blockchain >>  ./logs/nodeos.log 2>&1 &

对于创始节点的启动，生产名称一定要配制成eosio，否则会不生产。EOSIO默认0.5s一个块，要在某个节点发送交易，需要配置插件chain_api_plugin， 需要特别注意的是配置mongo_dn_plugin插件，nodeos程序需要开启支持mongo开关，然后重新编译程序。

EOSIO链部署

关于EOSIO的部署，因为整个EOSIO提供的是智能合约运行的基础架构机制，所以要完成某个具体的业务逻辑，是需要部署对应的合约才能完成。

EOSIO中最重要的两个合约是eosio.system,eosio.token两个合约，前者提供了生产投票相关的逻辑服务，后者则提供了代币服务。

eosio合约的编译，需要eosio.cdt工具，将开发的合约文件编译成wasm程序，同时生成ABI文件，生成合约文件后，才能完成部署。

下面给出一个基本的合约部署流程

wallet_url=0.0.0.0:8900
node_url=0.0.0.0:8888

# 创建钱包
WALLET_PASSWD=`./cleos --wallet-url $wallet_url -u $node_url wallet create --to-console`
export passeord=`echo $WALLET_PASSWD | awk -F"\\"" 'print $2'`
echo "$passeord" > key.txt
echo "get password : $passeord"

# 导入创世公私钥
./cleos --wallet-url $wallet_url -u $node_url wallet import --private-key 5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3

# 导入私钥，创建用户
ONE_ACCOUNT=eosio.token

echo "---- imports private ($ONE_ACCOUNT) keys ----"
key_OWNER=`./cleos  --wallet-url $wallet_url -u $node_url create key --to-console`
key_ACTIVE=`./cleos  --wallet-url $wallet_url -u $node_url create key --to-console`
a_owner=`echo $key_OWNER | awk -F" " 'print $3'`
./cleos --wallet-url $wallet_url -u $node_url wallet import --private-key $a_owner
a_ative=`echo $key_ACTIVE | awk -F" " 'print $3'`
./cleos --wallet-url $wallet_url -u $node_url wallet import --private-key $a_ative

a_private_owner=$a_owner
a_private_ative=$a_ative

a_owner=`echo $key_OWNER | awk -F" " 'print $6'`
a_ative=`echo $key_ACTIVE | awk -F" " 'print $6'`
./cleos --wallet-url $wallet_url -u $node_url create account eosio $ONE_ACCOUNT $a_owner $a_ative

# 部署合约， 发送交易
./cleos --wallet-url $wallet_url -u $node_url set contract eosio.token ./contracts/eosio.token/ -p eosio.token@active

./cleos --wallet-url $wallet_url -u $node_url push action eosio.token create '[ "eosio", "10000000000.0000 '$bioscurrencysymbol'" ]' -p eosio.token
./cleos --wallet-url $wallet_url -u $node_url push action eosio.token issue '[ "eosio", "1000000000.0000 '$bioscurrencysymbol'", "memo" ]' -p eosio

EOSIO源码分析 - CDT合约编译过程

智能合约代码举例

纵观整体代码有如下特点

1. 符合C++代码语法，包含相应的头文件，命名空间
2. 公有继承合约基类 contract
3. 在语法中出现了新的标签代码如：[eosio::contract], [eosio::action]等
4. 代码尾部出现新的宏EOSIO_DISPATCH

合约编译工具

• 工具名称：eosio-cpp
• 命令行：eosio-cpp -o hello.wasm hello.cpp –abigen
• 编译结果：生成hello.wasm和hello.abi文件

合约编译过程

命令行的解析过程，不做过多解释，在编译过程中使用ClangTool完成代码的分析与合约信息提取，Clang-7完成合约文件的编译过程，将cpp文件编译成wasm文件

ClangTool提取信息过程

1. 函数入口
   
   其中run函数最重要，前面准备好相关参数后，调用run进行代码分析
   在这里记住三个重要的初始化操作，后面做分析使用
   
   这三句话，相当于注册了代码分析结果的适配器，进入代码信息筛选使用
2. 通过run的调用，最终调用代码分析类Parser
   
   在parser类中，完成了代码的分析，分析语法格式是否正确，标签是否合法，从而确定在合约类中，我们怎么知道这个函数是个action， 就是通过[eosio::action]指定的，代码具体路径如下
   
   分析函数，类名过程中同步解析标签
   
   分析对标签名称，将标签名称转换成枚举类型kind
   代码文件AttrParsedAttrKinds.inc
   如果以后我们要增加或者修改标签，一定要改动这里
   
   
   上面的代码清晰的展示了标签的分析处理过程，最终依据标签创建了EOSIO相关的标标签类
   EosioActionAttr：标记合约执行的的Action
   EosioContractAttr：标记这个类是合约文件
   同时我们也可以看到EOSIO对clang编译器进行了定制，让它能编译合约

ABI结构的生成

在完成代码分析之后，生成相应的结构信息，接下来使用分析的结果，翻译出对应的abi文件。

1. ABI重要结构
   
   这个文件定义了abi相关的field,struct,action等重要结构
   
   Abi结构操作相关，如删除，添加action等
2. ABI结构信息提取过程
   在abi提取过程中，会有一系列相关的 MatchFinder 来做代码特征匹配，在工具刚开始的初始化中，注册了三个匹配器，在在信息翻译中，会进行信息回调
   
   回调处理代码如下
   
   
   最后把结构abi，转换成json格式，保存成abi文件

合约代码编译过程

调用编译的代码如下

使用编译出来的clang-7子程序，编译cpp合约代码，生成对应的wasm文件，这个文件供eosio工程进行合约调用

总结

• EOSIO合约是使用C++编写的，所以编写时语法要符合C++的规范
• EOSIO合约编写时使用的库是经过裁剪的，特别是boost库，系统类，文件类，线程类是无法使用的
• EOSIO合约的编译实际上是使用clang来进行的，最终目的是把C++代码编译成wasm格式的字节码程序，供WASM虚拟机执行使用