用Go语言建立一个简单的区块链part3:持久化和命令行接口
持久化和命令行接口
引言
到目前為止,我們已經(jīng)構(gòu)建了一個(gè)有工作量證明機(jī)制的區(qū)塊鏈。有了工作量證明,挖礦也就有了著落。雖然目前距離一個(gè)有著完整功能的區(qū)塊鏈越來越近了,但是它仍然缺少了一些重要的特性。在今天的內(nèi)容中,我們會(huì)將區(qū)塊鏈持久化到一個(gè)數(shù)據(jù)庫中,然后會(huì)提供一個(gè)簡單的命令行接口,用來完成一些與區(qū)塊鏈的交互操作。本質(zhì)上,區(qū)塊鏈?zhǔn)且粋€(gè)分布式數(shù)據(jù)庫,不過,我們暫時(shí)先忽略 “分布式” 這個(gè)部分,僅專注于 “存儲(chǔ)” 這一點(diǎn)。
選擇數(shù)據(jù)庫
目前,我們的區(qū)塊鏈實(shí)現(xiàn)里面并沒有用到數(shù)據(jù)庫,而是在每次運(yùn)行程序時(shí),簡單地將區(qū)塊鏈存儲(chǔ)在內(nèi)存中。那么一旦程序退出,所有的內(nèi)容就都消失了。我們沒有辦法再次使用這條鏈,也沒有辦法與其他人共享,所以我們需要把它存儲(chǔ)到磁盤上。
那么,我們要用哪個(gè)數(shù)據(jù)庫呢?實(shí)際上,任何一個(gè)數(shù)據(jù)庫都可以。在 比特幣原始論文 中,并沒有提到要使用哪一個(gè)具體的數(shù)據(jù)庫,它完全取決于開發(fā)者如何選擇。 Bitcoin Core ,最初由中本聰發(fā)布,現(xiàn)在是比特幣的一個(gè)參考實(shí)現(xiàn),它使用的是 LevelDB。而我們將要使用的是…
BoltDB
因?yàn)樗?#xff1a;
1、非常簡潔
2、用 Go 實(shí)現(xiàn)
3、不需要運(yùn)行一個(gè)服務(wù)器
4、能夠允許我們構(gòu)造想要的數(shù)據(jù)結(jié)構(gòu)
BoltDB GitHub 上的 README 是這么說的:
Bolt 是一個(gè)純鍵值存儲(chǔ)的 Go 數(shù)據(jù)庫,啟發(fā)自 Howard Chu 的 LMDB. 它旨在為那些無須一個(gè)像 Postgres 和 MySQL 這樣有著完整數(shù)據(jù)庫服務(wù)器的項(xiàng)目,提供一個(gè)簡單,快速和可靠的數(shù)據(jù)庫。
由于 Bolt 意在用于提供一些底層功能,簡潔便成為其關(guān)鍵所在。它的 API 并不多,并且僅關(guān)注值的獲取和設(shè)置。僅此而已。
聽起來跟我們的需求完美契合!來快速過一下:
Bolt 使用鍵值存儲(chǔ),這意味著它沒有像 SQL RDBMS (MySQL,PostgreSQL 等等)的表,沒有行和列。相反,數(shù)據(jù)被存儲(chǔ)為鍵值對(duì)(key-value pair,就像 Golang 的 map)。鍵值對(duì)被存儲(chǔ)在 bucket 中,這是為了將相似的鍵值對(duì)進(jìn)行分組(類似 RDBMS 中的表格)。因此,為了獲取一個(gè)值,你需要知道一個(gè) bucket 和一個(gè)鍵(key)。
需要注意的一個(gè)事情是,Bolt 數(shù)據(jù)庫沒有數(shù)據(jù)類型:鍵和值都是字節(jié)數(shù)組(byte array)。鑒于需要在里面存儲(chǔ) Go 的結(jié)構(gòu)(準(zhǔn)確來說,也就是存儲(chǔ)Block(塊)),我們需要對(duì)它們進(jìn)行序列化,也就說,實(shí)現(xiàn)一個(gè)從 Go struct 轉(zhuǎn)換到一個(gè) byte array 的機(jī)制,同時(shí)還可以從一個(gè) byte array 再轉(zhuǎn)換回 Go struct。雖然我們將會(huì)使用 encoding/gob 來完成這一目標(biāo),但實(shí)際上也可以選擇使用 JSON, XML, Protocol Buffers 等等。之所以選擇使用 encoding/gob, 是因?yàn)樗芎唵?#xff0c;而且是 Go 標(biāo)準(zhǔn)庫的一部分。
雖然 BoltDB 的作者出于個(gè)人原因已經(jīng)不在對(duì)其維護(hù)(見README), 不過關(guān)系不大,它已經(jīng)足夠穩(wěn)定了,況且也有活躍的 fork:coreos/bblot。
數(shù)據(jù)庫結(jié)構(gòu)
在開始實(shí)現(xiàn)持久化的邏輯之前,我們首先需要決定到底要如何在數(shù)據(jù)庫中進(jìn)行存儲(chǔ)。為此,我們可以參考 Bitcoin Core 的做法:
簡單來說,Bitcoin Core 使用兩個(gè) “bucket” 來存儲(chǔ)數(shù)據(jù):
其中一個(gè) bucket 是 blocks,它存儲(chǔ)了描述一條鏈中所有塊的元數(shù)據(jù)
另一個(gè) bucket 是 chainstate,存儲(chǔ)了一條鏈的狀態(tài),也就是當(dāng)前所有的未花費(fèi)的交易輸出,和一些元數(shù)據(jù)
此外,出于性能的考慮,Bitcoin Core 將每個(gè)區(qū)塊(block)存儲(chǔ)為磁盤上的不同文件。如此一來,就不需要僅僅為了讀取一個(gè)單一的塊而將所有(或者部分)的塊都加載到內(nèi)存中。但是,為了簡單起見,我們并不會(huì)實(shí)現(xiàn)這一點(diǎn)。
因?yàn)槟壳斑€沒有交易,所以我們只需要 blocks bucket。另外,正如上面提到的,我們會(huì)將整個(gè)數(shù)據(jù)庫存儲(chǔ)為單個(gè)文件,而不是將區(qū)塊存儲(chǔ)在不同的文件中。所以,我們也不會(huì)需要文件編號(hào)(file number)相關(guān)的東西。最終,我們會(huì)用到的鍵值對(duì)有:
1、32 字節(jié)的 block-hash -> block 結(jié)構(gòu)
2、l -> 鏈中最后一個(gè)塊的 hash
這就是實(shí)現(xiàn)持久化機(jī)制所有需要了解的內(nèi)容了。
序列化
上面提到,在 BoltDB 中,值只能是 []byte 類型,但是我們想要存儲(chǔ) Block 結(jié)構(gòu)。所以,我們需要使用 encoding/gob 來對(duì)這些結(jié)構(gòu)進(jìn)行序列化。
讓我們來實(shí)現(xiàn) Block 的 Serialize 方法(為了簡潔起見,此處略去了錯(cuò)誤處理):
func (b *Block) Serialize() []byte {var result bytes.Bufferencoder := gob.NewEncoder(&result)err := encoder.Encode(b)return result.Bytes() }這個(gè)部分比較直觀:首先,我們定義一個(gè) buffer 存儲(chǔ)序列化之后的數(shù)據(jù)。然后,我們初始化一個(gè) gob encoder 并對(duì) block 進(jìn)行編碼,結(jié)果作為一個(gè)字節(jié)數(shù)組返回。
接下來,我們需要一個(gè)解序列化的函數(shù),它會(huì)接受一個(gè)字節(jié)數(shù)組作為輸入,并返回一個(gè) Block. 它不是一個(gè)方法(method),而是一個(gè)單獨(dú)的函數(shù)(function):
func DeserializeBlock(d []byte) *Block {var block Blockdecoder := gob.NewDecoder(bytes.NewReader(d))err := decoder.Decode(&block)return &block }這就是序列化部分的內(nèi)容了。
持久化
讓我們從 NewBlockchain 函數(shù)開始。在之前的實(shí)現(xiàn)中,NewBlockchain 會(huì)創(chuàng)建一個(gè)新的 Blockchain 實(shí)例,并向其中加入創(chuàng)世塊。而現(xiàn)在,我們希望它做的事情有:
打開一個(gè)數(shù)據(jù)庫文件
檢查文件里面是否已經(jīng)存儲(chǔ)了一個(gè)區(qū)塊鏈
如果已經(jīng)存儲(chǔ)了一個(gè)區(qū)塊鏈:
創(chuàng)建一個(gè)新的 Blockchain 實(shí)例
設(shè)置 Blockchain 實(shí)例的 tip 為數(shù)據(jù)庫中存儲(chǔ)的最后一個(gè)塊的哈希
如果沒有區(qū)塊鏈:
創(chuàng)建創(chuàng)世塊
存儲(chǔ)到數(shù)據(jù)庫
將創(chuàng)世塊哈希保存為最后一個(gè)塊的哈希
創(chuàng)建一個(gè)新的 Blockchain 實(shí)例,初始時(shí) tip 指向創(chuàng)世塊(tip 有尾部,尖端的意思,在這里 tip 存儲(chǔ)的是最后一個(gè)塊的哈希)
代碼大概是這樣:
來一段一段地看下代碼:
db, err := bolt.Open(dbFile, 0600, nil)這是打開一個(gè) BoltDB 文件的標(biāo)準(zhǔn)做法。注意,即使不存在這樣的文件,它也不會(huì)返回錯(cuò)誤。
err = db.Update(func(tx *bolt.Tx) error { ... })在 BoltDB 中,數(shù)據(jù)庫操作通過一個(gè)事務(wù)(transaction)進(jìn)行操作。有兩種類型的事務(wù):只讀(read-only)和讀寫(read-write)。這里,打開的是一個(gè)讀寫事務(wù)(db.Update(…)),因?yàn)槲覀兛赡軙?huì)向數(shù)據(jù)庫中添加創(chuàng)世塊。
b := tx.Bucket([]byte(blocksBucket))if b == nil {genesis := NewGenesisBlock()b, err := tx.CreateBucket([]byte(blocksBucket))err = b.Put(genesis.Hash, genesis.Serialize())err = b.Put([]byte("l"), genesis.Hash)tip = genesis.Hash } else {tip = b.Get([]byte("l")) }這里是函數(shù)的核心。在這里,我們先獲取了存儲(chǔ)區(qū)塊的 bucket:如果存在,就從中讀取 l 鍵;如果不存在,就生成創(chuàng)世塊,創(chuàng)建 bucket,并將區(qū)塊保存到里面,然后更新 l 鍵以存儲(chǔ)鏈中最后一個(gè)塊的哈希。
另外,注意創(chuàng)建 Blockchain 一個(gè)新的方式:
bc := Blockchain{tip, db}這次,我們不在里面存儲(chǔ)所有的區(qū)塊了,而是僅存儲(chǔ)區(qū)塊鏈的 tip。另外,我們存儲(chǔ)了一個(gè)數(shù)據(jù)庫連接。因?yàn)槲覀兿胍坏┐蜷_它的話,就讓它一直運(yùn)行,直到程序運(yùn)行結(jié)束。因此,Blockchain 的結(jié)構(gòu)現(xiàn)在看起來是這樣:
type Blockchain struct {tip []bytedb *bolt.DB }接下來我們想要更新的是 AddBlock 方法:現(xiàn)在向鏈中加入?yún)^(qū)塊,就不是像之前向一個(gè)數(shù)組中加入一個(gè)元素那么簡單了。從現(xiàn)在開始,我們會(huì)將區(qū)塊存儲(chǔ)在數(shù)據(jù)庫里面:
func (bc *Blockchain) AddBlock(data string) {var lastHash []byteerr := bc.db.View(func(tx *bolt.Tx) error {b := tx.Bucket([]byte(blocksBucket))lastHash = b.Get([]byte("l"))return nil})newBlock := NewBlock(data, lastHash)err = bc.db.Update(func(tx *bolt.Tx) error {b := tx.Bucket([]byte(blocksBucket))err := b.Put(newBlock.Hash, newBlock.Serialize())err = b.Put([]byte("l"), newBlock.Hash)bc.tip = newBlock.Hashreturn nil}) }繼續(xù)來一段一段分解開來:
err := bc.db.View(func(tx *bolt.Tx) error {b := tx.Bucket([]byte(blocksBucket))lastHash = b.Get([]byte("l"))return nil })這是 BoltDB 事務(wù)的另一個(gè)類型(只讀)。在這里,我們會(huì)從數(shù)據(jù)庫中獲取最后一個(gè)塊的哈希,然后用它來挖出一個(gè)新的塊的哈希:
newBlock := NewBlock(data, lastHash) b := tx.Bucket([]byte(blocksBucket)) err := b.Put(newBlock.Hash, newBlock.Serialize()) err = b.Put([]byte("l"), newBlock.Hash) bc.tip = newBlock.Hash檢查區(qū)塊鏈
現(xiàn)在,產(chǎn)生的所有塊都會(huì)被保存到一個(gè)數(shù)據(jù)庫里面,所以我們可以重新打開一個(gè)鏈,然后向里面加入新塊。但是在實(shí)現(xiàn)這一點(diǎn)后,我們失去了之前一個(gè)非常好的特性:再也無法打印區(qū)塊鏈的區(qū)塊了,因?yàn)楝F(xiàn)在不是將區(qū)塊存儲(chǔ)在一個(gè)數(shù)組,而是放到了數(shù)據(jù)庫里面。讓我們來解決這個(gè)問題!
BoltDB 允許對(duì)一個(gè) bucket 里面的所有 key 進(jìn)行迭代,但是所有的 key 都以字節(jié)序進(jìn)行存儲(chǔ),而且我們想要以區(qū)塊能夠進(jìn)入?yún)^(qū)塊鏈中的順序進(jìn)行打印。此外,因?yàn)槲覀儾幌雽⑺械膲K都加載到內(nèi)存中(因?yàn)槲覀兊膮^(qū)塊鏈數(shù)據(jù)庫可能很大!或者現(xiàn)在可以假裝它可能很大),我們將會(huì)一個(gè)一個(gè)地讀取它們。故而,我們需要一個(gè)區(qū)塊鏈迭代器(BlockchainIterator):
type BlockchainIterator struct {currentHash []bytedb *bolt.DB }每當(dāng)要對(duì)鏈中的塊進(jìn)行迭代時(shí),我們就會(huì)創(chuàng)建一個(gè)迭代器,里面存儲(chǔ)了當(dāng)前迭代的塊哈希(currentHash)和數(shù)據(jù)庫的連接(db)。通過 db,迭代器邏輯上被附屬到一個(gè)區(qū)塊鏈上(這里的區(qū)塊鏈指的是存儲(chǔ)了一個(gè)數(shù)據(jù)庫連接的 Blockchain 實(shí)例),并且通過 Blockchain 方法進(jìn)行創(chuàng)建:
func (bc *Blockchain) Iterator() *BlockchainIterator {bci := &BlockchainIterator{bc.tip, bc.db}return bci }注意,迭代器的初始狀態(tài)為鏈中的 tip,因此區(qū)塊將從尾到頭(創(chuàng)世塊為頭),也就是從最新的到最舊的進(jìn)行獲取。實(shí)際上,選擇一個(gè) tip 就是意味著給一條鏈“投票”。一條鏈可能有多個(gè)分支,最長的那條鏈會(huì)被認(rèn)為是主分支。在獲得一個(gè) tip (可以是鏈中的任意一個(gè)塊)之后,我們就可以重新構(gòu)造整條鏈,找到它的長度和需要構(gòu)建它的工作。這同樣也意味著,一個(gè) tip 也就是區(qū)塊鏈的一種標(biāo)識(shí)符。
BlockchainIterator 只會(huì)做一件事情:返回鏈中的下一個(gè)塊。
func (i *BlockchainIterator) Next() *Block {var block *Blockerr := i.db.View(func(tx *bolt.Tx) error {b := tx.Bucket([]byte(blocksBucket))encodedBlock := b.Get(i.currentHash)block = DeserializeBlock(encodedBlock)return nil})i.currentHash = block.PrevBlockHashreturn block }這就是數(shù)據(jù)庫部分的內(nèi)容了!
CLI
到目前為止,我們的實(shí)現(xiàn)還沒有提供一個(gè)與程序交互的接口:目前只是在 main 函數(shù)中簡單執(zhí)行了 NewBlockchain 和 bc.AddBlock 。是時(shí)候改變了!現(xiàn)在我們想要擁有這些命令:
blockchain_go addblock "Pay 0.031337 for a coffee" blockchain_go printchain所有命令行相關(guān)的操作都會(huì)通過 CLI 結(jié)構(gòu)進(jìn)行處理:
type CLI struct {bc *Blockchain }它的 “入口” 是 Run 函數(shù):
func (cli *CLI) Run() {cli.validateArgs()addBlockCmd := flag.NewFlagSet("addblock", flag.ExitOnError)printChainCmd := flag.NewFlagSet("printchain", flag.ExitOnError)addBlockData := addBlockCmd.String("data", "", "Block data")switch os.Args[1] {case "addblock":err := addBlockCmd.Parse(os.Args[2:])case "printchain":err := printChainCmd.Parse(os.Args[2:])default:cli.printUsage()os.Exit(1)}if addBlockCmd.Parsed() {if *addBlockData == "" {addBlockCmd.Usage()os.Exit(1)}cli.addBlock(*addBlockData)}if printChainCmd.Parsed() {cli.printChain()} }我們會(huì)使用標(biāo)準(zhǔn)庫里面的 flag 包來解析命令行參數(shù):
addBlockCmd := flag.NewFlagSet("addblock", flag.ExitOnError) printChainCmd := flag.NewFlagSet("printchain", flag.ExitOnError) addBlockData := addBlockCmd.String("data", "", "Block data")首先,我們創(chuàng)建兩個(gè)子命令: addblock 和 printchain, 然后給 addblock 添加 -data 標(biāo)志。printchain 沒有任何標(biāo)志。
switch os.Args[1] { case "addblock":err := addBlockCmd.Parse(os.Args[2:]) case "printchain":err := printChainCmd.Parse(os.Args[2:]) default:cli.printUsage()os.Exit(1) }然后,我們檢查用戶提供的命令,解析相關(guān)的 flag 子命令:
if addBlockCmd.Parsed() {if *addBlockData == "" {addBlockCmd.Usage()os.Exit(1)}cli.addBlock(*addBlockData) }if printChainCmd.Parsed() {cli.printChain() }接著檢查解析是哪一個(gè)子命令,并調(diào)用相關(guān)函數(shù):
func (cli *CLI) addBlock(data string) {cli.bc.AddBlock(data)fmt.Println("Success!") }func (cli *CLI) printChain() {bci := cli.bc.Iterator()for {block := bci.Next()fmt.Printf("Prev. hash: %x\n", block.PrevBlockHash)fmt.Printf("Data: %s\n", block.Data)fmt.Printf("Hash: %x\n", block.Hash)pow := NewProofOfWork(block)fmt.Printf("PoW: %s\n", strconv.FormatBool(pow.Validate()))fmt.Println()if len(block.PrevBlockHash) == 0 {break}} }這部分內(nèi)容跟之前的很像,唯一的區(qū)別是我們現(xiàn)在使用的是 BlockchainIterator 對(duì)區(qū)塊鏈中的區(qū)塊進(jìn)行迭代:
記得不要忘了對(duì) main 函數(shù)作出相應(yīng)的修改:
func main() {bc := NewBlockchain()defer bc.db.Close()cli := CLI{bc}cli.Run() }注意,無論提供什么命令行參數(shù),都會(huì)創(chuàng)建一個(gè)新的鏈。
這就是今天的所有內(nèi)容了! 來看一下是不是如期工作:
$ blockchain_go printchain No existing blockchain found. Creating a new one... Mining the block containing "Genesis Block" 000000edc4a82659cebf087adee1ea353bd57fcd59927662cd5ff1c4f618109bPrev. hash: Data: Genesis Block Hash: 000000edc4a82659cebf087adee1ea353bd57fcd59927662cd5ff1c4f618109b PoW: true$ blockchain_go addblock -data "Send 1 BTC to Ivan" Mining the block containing "Send 1 BTC to Ivan" 000000d7b0c76e1001cdc1fc866b95a481d23f3027d86901eaeb77ae6d002b13Success!$ blockchain_go addblock -data "Pay 0.31337 BTC for a coffee" Mining the block containing "Pay 0.31337 BTC for a coffee" 000000aa0748da7367dec6b9de5027f4fae0963df89ff39d8f20fd7299307148Success!$ blockchain_go printchain Prev. hash: 000000d7b0c76e1001cdc1fc866b95a481d23f3027d86901eaeb77ae6d002b13 Data: Pay 0.31337 BTC for a coffee Hash: 000000aa0748da7367dec6b9de5027f4fae0963df89ff39d8f20fd7299307148 PoW: truePrev. hash: 000000edc4a82659cebf087adee1ea353bd57fcd59927662cd5ff1c4f618109b Data: Send 1 BTC to Ivan Hash: 000000d7b0c76e1001cdc1fc866b95a481d23f3027d86901eaeb77ae6d002b13 PoW: truePrev. hash: Data: Genesis Block Hash: 000000edc4a82659cebf087adee1ea353bd57fcd59927662cd5ff1c4f618109b PoW: true
我已經(jīng)在百度云盤上傳了本節(jié)和之前的代碼,需要的朋友可以點(diǎn)擊上面的鏈接進(jìn)行下載:(永久有效)
鏈接:https://pan.baidu.com/s/1uXnHD4xkKhlarwmy4FOwlQ 密碼:8fmw
注意:本demo需要自行下載Boltdb數(shù)據(jù)庫。
總結(jié)
以上是生活随笔為你收集整理的用Go语言建立一个简单的区块链part3:持久化和命令行接口的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 用Go语言建立一个简单的区块链part2
- 下一篇: 用Go语言建立一个简单的区块链part4