作者:freewind
比原项目仓库:
Github地址:https://github.com/Bytom/bytom
Gitee地址:https://gitee.com/BytomBlockchain/bytom
人们常说,“阅读源代码”是学习编程的一种重要方法。作为程序员,我们在平时的学习工作中,都应该阅读过不少源代码。但是对于大多数人来说,阅读的可能更多是一些代码片断、示例,或者在老师、同事的指导下,先对要阅读的项目代码有了整体的了解之后,再进行针对性的阅读。
但是如果我们面对的是一个像比原这样比较庞大的项目,身边又没有人指导,只能靠自己去看,这时应该怎么来阅读呢?也许每个人也都能找到自己的办法,或高效,或低效,或放弃。
我在这次阅读比原源代码的过程中,尝试的是这样一种方法:从外部入手,通过与比原节点进行数据交互,来一步步了解比原的内部原理。就像剥石榴一样,一点点小心翼翼的下手,最后才能吃到鲜美的果肉。
所以这个文章系列叫作“剥开比原看代码”。
说明
在系列中的每一章,我通常都会由一个或者几个相关的问题入手,然后通过对源代码进行分析,来说明比原的代码是如何实现的。对于与当前问题关系不大的代码,则会简单带过,等真正需要它们出场的时候再详细解说。
为了保证文章中引用代码的稳定性,我将基于比原的v1.0.1代码进行分析。随着时间推移,比原的代码也将快速更新,但是我觉得,只要把这个版本的代码理解了,再去看新的代码,应该是一件很容易的事情。
在文章中,将会有一些直接指向github上bytom源代码的链接。为了方便,我专门将bytom v1.0.1的代码放到了一个新的仓库中,这样就不容易与比原官方的最新代码混淆。该仓库地址为:https://github.com/freewind/bytom-v1.0.1
当然,你不必clone这个仓库(clone官方仓库http://github.com/Bytom/bytom就够了),然后在必要的时候,使用以下命令将代码切换到v1.0.1
的tag,以便与本系列引用的代码一致:
git fetch git checkout -b v1.0.1
不论采用哪种阅读方法,我想第一步都应该先在本地把比原节点跑起来,试试各种功能。
对于如何下载、配置和安装的问题,请直接参看官方文档https://github.com/Bytom/bytom/tree/v1.0.1(注意我这里给出的是v1.0.1的文档),这里不多说。
本篇问题
当我们本地使用make bytomd
编译完比原后,我们可以使用下面的命令来进行初始化:
./bytomd init --chain_id testnet
这里指定了使用的chain是testnet
(还有别的选项,如mainnet
等等)。运行成功后,它将会在本地文件系统生成一些配置文件,供比原启动时使用。
所以我的问题是:
比原初始化时,产生了什么样的配置文件,放在了哪个目录下?
下面我将结合源代码,来回答这个问题。
目录位置
首先比原在本地会有一个目录专门用于放置各种数据,比如密钥、配置文件、数据库文件等。这个目录对应的代码位于config/config.go#L190-L205:
func DefaultDataDir() string { // Try to place the data folder in the user's home dir home := homeDir() dataDir := "./.bytom" if home != "" { switch runtime.GOOS { case "darwin": dataDir = filepath.Join(home, "Library", "Bytom") case "windows": dataDir = filepath.Join(home, "AppData", "Roaming", "Bytom") default: dataDir = filepath.Join(home, ".bytom") } } return dataDir }
可以看到,在不同的操作系统上,数据目录的位置也不同:
- 苹果系统(
darwin
):~/Library/Bytom
- Windows(
windows
):~/AppData/Roaming/Bytom
- 其它(如Linux):
~/.bytom
配置文件内容
我们根据自己的操作系统打开相应的目录(我的是~/Library/Bytom
),可以看到有一个config.toml
,内容大约如下:
$ cat config.toml # This is a TOML config file. # For more information, see https://github.com/toml-lang/toml fast_sync = true db_backend = "leveldb" api_addr = "0.0.0.0:9888" chain_id = "testnet" [p2p] laddr = "tcp://0.0.0.0:46656" seeds = "47.96.42.1:46656,172.104.224.219:46656,45.118.132.164:46656"
它已经把一些基本信息告诉我们了,比如:
db_backend = "leveldb"
:说明比原内部使用了leveldb作为数据库(用来保存块数据、帐号、交易信息等)api_addr = "0.0.0.0:9888"
:我们可以在浏览器中打开http://localhost:9888
来访问dashboard页面,进行查看与管理chain_id = "testnet"
:当前连接的是testnet
,即测试网,里面挖出来的比原币是不值钱的laddr = "tcp://0.0.0.0:46656"
:本地监听46656
端口,别的节点如果想连我,就需要访问我的46656
端口seeds = "47.96.42.1:46656,172.104.224.219:46656,45.118.132.164:46656"
:比原启动后,会主动连接这几个地址获取数据
内容模板
使用不同的chain_id
去初始化时,会生成不同内容的配置文件,那么这些内容来自于哪里呢?
原来在config/toml.go#L22-L45,预定义了不同的模板内容:
var defaultConfigTmpl = `# This is a TOML config file. # For more information, see https://github.com/toml-lang/toml fast_sync = true db_backend = "leveldb" api_addr = "0.0.0.0:9888" `