【比原鏈】初始化時生成的配置檔案在哪兒
作者:freewind
比原專案倉庫:https://github.com/Bytom/bytom
人們常說,“閱讀原始碼”是學習程式設計的一種重要方法。作為程式設計師,我們在平時的學習工作中,都應該閱讀過不少原始碼。但是對於大多數人來說,閱讀的可能更多是一些程式碼片斷、示例,或者在老師、同事的指導下,先對要閱讀的專案程式碼有了整體的瞭解之後,再進行鍼對性的閱讀。
但是如果我們面對的是一個像比原這樣比較龐大的專案,身邊又沒有人指導,只能靠自己去看,這時應該怎麼來閱讀呢?也許每個人也都能找到自己的辦法,或高效,或低效,或放棄。
我在這次閱讀比原原始碼的過程中,嘗試的是這樣一種方法:從外部入手,通過與比原節點進行資料互動,來一步步瞭解比原的內部原理。就像剝石榴一樣,一點點小心翼翼的下手,最後才能吃到鮮美的果肉。
所以這個文章系列叫作“剝開比原看程式碼”。
說明
在系列中的每一章,我通常都會由一個或者幾個相關的問題入手,然後通過對原始碼進行分析,來說明比原的程式碼是如何實現的。對於與當前問題關係不大的程式碼,則會簡單帶過,等真正需要它們出場的時候再詳細解說。
為了保證文章中引用程式碼的穩定性,我將基於比原的v1.0.1程式碼進行分析。隨著時間推移,比原的程式碼也將快速更新,但是我覺得,只要把這個版本的程式碼理解了,再去看新的程式碼,應該是一件很容易的事情。
在文章中,將會有一些直接指向github上bytom原始碼的連結。為了方便,我專門將bytom v1.0.1的程式碼放到了一個新的倉庫中,這樣就不容易與比原官方的最新程式碼混淆。該倉庫地址為:
當然,你不必clone這個倉庫(clone官方倉庫http://github.com/Bytom/bytom就夠了),然後在必要的時候,使用以下命令將程式碼切換到v1.0.1
的tag,以便與本系列引用的程式碼一致:
git fetch
git checkout -b 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
去初始化時,會生成不同內容的配置檔案,那麼這些內容來自於哪裡呢?
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" ` var mainNetConfigTmpl = `chain_id = "mainnet" [p2p] laddr = "tcp://0.0.0.0:46657" seeds = "45.79.213.28:46657,198.74.61.131:46657,212.111.41.245:46657,47.100.214.154:46657,47.100.109.199:46657,47.100.105.165:46657" ` var testNetConfigTmpl = `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" ` var soloNetConfigTmpl = `chain_id = "solonet" [p2p] laddr = "tcp://0.0.0.0:46658" seeds = "" `
可以看到,原來這些埠號和seed的地址,都是事先寫好在模板裡的。
而且,通過觀察這些配置,我們可以發現,如果chain_id
不同,則監聽的埠和連線的種子都不同:
- mainnet(連線到主網):
46657
,會主動連線6個種子 - testnet(連線到測試網):
46656
,會主動連線3個種子 - solonet(本地單獨節點):
46658
,不會主動連線別人(也因此不會被別人連線上),適合單機研究
寫入檔案
這裡我們需要快速的把bytomd init
的執行流程過一遍,才能清楚配置檔案的寫入時機,也同時把前面的內容串在了一起。
func main() { cmd := cli.PrepareBaseCmd(commands.RootCmd, "TM", os.ExpandEnv(config.DefaultDataDir())) cmd.Execute() }
其中的config.DefaultDataDir()
就對應於前面提到資料目錄位置。
func initFiles(cmd *cobra.Command, args []string) { configFilePath := path.Join(config.RootDir, "config.toml") if _, err := os.Stat(configFilePath); !os.IsNotExist(err) { log.WithField("config", configFilePath).Info("Already exists config file.") return } if config.ChainID == "mainnet" { cfg.EnsureRoot(config.RootDir, "mainnet") } else if config.ChainID == "testnet" { cfg.EnsureRoot(config.RootDir, "testnet") } else { cfg.EnsureRoot(config.RootDir, "solonet") } log.WithField("config", configFilePath).Info("Initialized bytom") }
其中的configFilePath
,就是config.toml
的寫入地址,即我們前面所說的資料目錄下的config.toml
檔案。
cfg.EnsureRoot
將用來確認資料目錄是有效的,並且將根據傳入的chain_id
不同,來生成不同的內容寫入到配置檔案中。
func EnsureRoot(rootDir string, network string) { cmn.EnsureDir(rootDir, 0700) cmn.EnsureDir(rootDir+"/data", 0700) configFilePath := path.Join(rootDir, "config.toml") // Write default config file if missing. if !cmn.FileExists(configFilePath) { cmn.MustWriteFile(configFilePath, []byte(selectNetwork(network)), 0644) } }
可以看到,它對資料目錄進行了許可權上的確認,並且發現當配置檔案存在的時候,不會做任何更改。所以如果我們需要生成新的配置檔案,就需要把舊的刪除(或改名)。
其中的selectNetwork(network)
函式,實現了根據chain_id
的不同來組裝不同的配置檔案內容,它對應於master/config/toml.go#L48:
func selectNetwork(network string) string { if network == "testnet" { return defaultConfigTmpl + testNetConfigTmpl } else if network == "mainnet" { return defaultConfigTmpl + mainNetConfigTmpl } else { return defaultConfigTmpl + soloNetConfigTmpl } }
果然就是一個簡單的字串拼接,其中的defaultConfigTmpl
和*NetConfgTmpl
在前面已經出現,這裡不重複。
最後呼叫第三方函式cmn.MustWriteFile(configFilePath, []byte(selectNetwork(network)), 0644)
,把拼接出來的配置檔案內容以許可權0644
寫入到指定的檔案地址。
到這裡,我們這個問題就算回答完畢了。
加入比原開源社群,聯絡wechat ID:matrix2140