EOS 区块链数据实时异构到 MySQL

0x00 背景

早在 6 月 7 日，kesar 在 EOSIO 提交了一个编号为 #3882 的 PR，但直至目前仍处于未合并状态。团队做一些开发需要取 EOS 链上数据，但无法直接从 EOS 区块链中获取。#3882 提供 EOS 链上数据导入 MySQL，可以很方便的读取历史数据。但问题来了，该 PR 未合并，EOSIO 也没有一个 sql_db_plugin 相关的 branch 或 tag，所以无法使用 git 自动合并。

0x01 解决

SuperONE 团队将 #3882 提交的内容打包，提交了个一个 repo，链接如下：

https://github.com/superoneio/eos_sql_db_plugin

接下来本文将讲解如何将 EOS 链上数据异构到 MySQL。

0x02 部署

部署的思路如下：

安装 MySQL 以及 client 库

安装 soci

修改 eos CMakeLists.txt

编译支持 sql_db_plugin 的 nodeos

创建数据库，分配用户名

导入 eos 表结构

启动 nodeos，同步主网数据

查看 MySQL，确认数据

接下来我们逐步讲解。

如果使用 Ubuntu，安装 MySQL 可以快速使用 apt-get 安装，笔者建议使用源码编译。

如果使用源码编译，mysql-client 相关库已经存在。如果使用 apt-get 或者 yum 安装 mysql-sever，需要执行如下命令安装 mysql-client，命令如下：

$ apt-get -y install mysql-client

接下来我们安装 soci。soci 是 C++ 连接 MySQL 的 Library。Ubuntu 可以快速安装，命令如下：

$ apt-get -y install libsoci-dev

当然，我们还可以源码编译，步骤如下：[1]

$ git clone clonehttps://github.com/SOCI/soci.git

$ cd soci && mkdir build && cd build

$ cmake -DWITH_BOOST=ON -WITH_MYSQL=ON -MYSQL_INCLUDE_DIR=/usr/local/mysql/include -MYSQL_LIBRARIES=/usr/local/mysql/lib/libmysqlclient.a /data/tmp/robin/soci

$ make

$ make install

当然 和 根据实际路径更改。[2]

接下来我们需要 clone eos 代码，命令如下：

$ cd /data

$ git clonehttps://github.com/EOSIO/eos--recursive

$ cd /data/eos

# 如果不想用 master 分支代码，可以使用 git checkout v1.0.8 使用其他分支

$ git submodule update –init –recursive

然后更改 CMakeLists.txt，总共有两个 CMakeLists.txt 需要更改。

eos/plugins/CMakeLists.txt

eos/programs/nodeos/CMakeLists.txt

在 eos/plugins/CMakeLists.txt 添加如下行：

add_subdirectory(sql_db_plugin)

在 eos/programs/nodeos/CMakeLists.txt 添加如下内容：

// 如果以下内容已经取消注释，可以忽略。

if(TARGET sql_db_plugin)

target_link_libraries( nodeos PRIVATE -Wl,$ sql_db_plugin -Wl,$ )

endif()

接着将 SuperONE 团队合并的 合并到 EOS 代码中。

$ cd /data

$ git clonehttps://github.com/superoneio/eos_sql_db_plugin

\cp -rv /data/eos_sql_db_plugin/sql_db_plugin/* /data/eos/plugins/sql_db_plugin

接下来编译支持 的 nodeos。

$ cd /data/eos

$ ./eosio_build.sh

待 nodeos 编译完成之后，我们执行如下命令确认是否编译成功。

$ /data/eos/build/programs/nodeos/nodeos --help | grep "sql_db-uri"

如果输出如下内容，证明编译成功。

--sql_db-uri arg Sql DB URI connection string If not

接下来在 MySQL 里创建数据库以及分配账号，SQL 如下：

CREATE DATABASE eos DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

GRANT ALL PRIVILEGES ON eos.* TO app_eos@'%' IDENTIFIED BY 'YOURPASS';

GRANT ALL PRIVILEGES ON eos.* TO app_eos@'127.0.0.1' IDENTIFIED BY 'YOURPASS';

然后我们导入 EOS 数据库表结构，如不想手动导入，可以在启动 nodeos 的时候添加 参数，该参数为 0 时会在数据库中创建表。表结构可以在点击 此处 下载。

接着我们启动 nodeos，主网 fullnode 相关的配置文件可以访问如下链接下载：

https://github.com/superoneio/eos-mainnet

启动 fullnode 相关命令如下：

$ mkdir /data/mainnet

$ cd /data/mainnet

$ git clonehttps://github.com/superoneio/eos-mainnet

$ mkdir -p data logs config

$ cp eos-mainnet/config.ini mainnet/config

$ cp eos-mainnet/genesis.json mainnet

$ cp eos-mainnet/*.sh mainnet

$ chmod +x mainnet

修改 config.ini 相关配置以及 start.sh 脚本，sql_db-uri 格式如下：

sql_db-uri="mysql://db=YOURDBuser=YOURUSER host=127.0.0.1 password='YOURPASS'

sql_db-uri 参数中的 YOURUSER 表示连接 EOS 区块链数据库的用户名，YOURPASS 表示连接 EOS 区块链数据库的用户密码，YOURDB 表示 EOS 区块链数据库名字。

需要注意的是 sql_db-uri 暂时不能写入 config.ini 配置文件，否则将会遇到 错误。另外，笔者的操作系统是 Ubuntu 16.04.4 LTS。

最后执行 start.sh，登录 MySQL 数据库就可以查看到相关数据。

[root@localhost][(none)]> USE eos

Database changed

[root@localhost][eos]> SHOW TABLES;

+------------------+

| Tables_in_eos |

+------------------+

| accounts |

| accounts_keys |

| actions |

| actions_accounts |

| blocks |

| stakes |

| tokens |

| transactions |

| votes |

+------------------+

9 rows in set (0.02 sec)

[root@localhost][eos]> SELECT * FROM tokens LIMIT 1 \G

*************************** 1. row ***************************

account: eosio

symbol: EOS

amount: 995314228.4771

1 row in set (0.00 sec)

0x03 小结

目前 #3882 暂未合并，具体原因未从得知。EOS 链上数据和传统的关系型数据库结合，将会大大降低开发者成本。待 #3882 merge 之后，读者将会更便利的使用到这个功能。

0x04 参考

[1] SOCI (2018-07-06). SOCI Installation. Retrieved fromhttp://soci.sourceforge.net/doc/master/installation.

[2] 太上绝情 (2016-07-14). soci-mysq 编译. Retrieved fromhttps://blog.csdn.net/bjrxyz/article/details/51912676.

「区块链技术指北」同名知识星球，二维码如下，欢迎加入。BTW，李笑来老师也加入了。

题图来自: © ChainONE / Article / chainone.xyz