使用Go语言构建Tendermint内置应用教程

使用Go语言构建Tendermint内置应用教程

tendermint ⟁ Tendermint Core (BFT Consensus) in Go 项目地址: https://gitcode.com/gh_mirrors/te/tendermint

前言

本教程面向希望从零开始构建Tendermint Core应用的初学者。Tendermint Core是一个拜占庭容错(BFT)中间件，它可以将任何编程语言编写的状态转换机安全地复制到多台机器上。

内置应用 vs 外部应用

在Tendermint Core同一进程中运行应用可以获得最佳性能。对于其他语言，应用需要通过TCP、Unix域套接字或gRPC与Tendermint Core通信。

开发环境准备

安装Go语言

确保已安装最新版本的Go语言环境，并正确设置了GOPATH环境变量。

go version
echo $GOPATH

创建新项目

创建一个名为kvstore的新项目目录，这是我们将要构建的简单分布式BFT键值存储应用。

mkdir kvstore
cd kvstore

编写Tendermint Core应用

ABCI接口简介

Tendermint Core通过应用区块链接口(ABCI)与应用通信。所有消息类型都在protobuf文件中定义，这使得Tendermint Core可以运行任何编程语言编写的应用。

应用基础结构

创建app.go文件，定义KVStoreApplication结构体并实现ABCI接口的所有方法：

type KVStoreApplication struct {
    db           *badger.DB
    currentBatch *badger.Txn
}

var _ abcitypes.Application = (*KVStoreApplication)(nil)

关键方法实现

CheckTx方法

当新交易添加到Tendermint Core时，会调用此方法验证交易格式和签名等。

func (app *KVStoreApplication) CheckTx(req abcitypes.RequestCheckTx) abcitypes.ResponseCheckTx {
    code := app.isValid(req.Tx)
    return abcitypes.ResponseCheckTx{Code: code, GasWanted: 1}
}

交易处理流程

Tendermint Core将区块分为三部分传递给应用：

1. BeginBlock - 开始处理新块
2. DeliverTx - 处理每个交易
3. EndBlock - 结束块处理
4. Commit - 提交状态变更

func (app *KVStoreApplication) BeginBlock(req abcitypes.RequestBeginBlock) abcitypes.ResponseBeginBlock {
    app.currentBatch = app.db.NewTransaction(true)
    return abcitypes.ResponseBeginBlock{}
}

func (app *KVStoreApplication) DeliverTx(req abcitypes.RequestDeliverTx) abcitypes.ResponseDeliverTx {
    // 处理交易逻辑
}

func (app *KVStoreApplication) Commit() abcitypes.ResponseCommit {
    app.currentBatch.Commit()
    return abcitypes.ResponseCommit{Data: []byte{}}
}

查询功能

客户端通过Tendermint Core RPC的/abci_query端点查询键值对，最终调用应用的Query方法。

func (app *KVStoreApplication) Query(reqQuery abcitypes.RequestQuery) abcitypes.ResponseQuery {
    // 查询逻辑
}

启动应用与Tendermint Core

主程序结构

在main.go中，我们需要：

1. 初始化Badger数据库
2. 创建应用实例
3. 配置并启动Tendermint节点
4. 设置信号处理

func main() {
    db, err := badger.Open(badger.DefaultOptions("/tmp/badger"))
    app := NewKVStoreApplication(db)
    
    node, err := newTendermint(app, configFile)
    node.Start()
    
    // 信号处理
    c := make(chan os.Signal, 1)
    signal.Notify(c, os.Interrupt, syscall.SIGTERM)
    <-c
    os.Exit(0)
}

节点配置

使用viper读取配置文件，创建日志记录器，加载私钥验证器和节点密钥：

func newTendermint(app abci.Application, configFile string) (*nm.Node, error) {
    config := cfg.DefaultConfig()
    // 配置读取和验证逻辑
    
    logger := log.NewTMLogger(log.NewSyncWriter(os.Stdout))
    pv := privval.LoadFilePV(config.PrivValidatorKeyFile(), config.PrivValidatorStateFile())
    nodeKey, err := p2p.LoadNodeKey(config.NodeKeyFile())
    
    // 创建节点实例
    node, err := nm.NewNode(
        config,
        pv,
        nodeKey,
        proxy.NewLocalClientCreator(app),
        // 其他参数...
    )
    return node, nil
}

构建与运行

依赖管理

使用Go模块管理依赖：

go mod init github.com/me/example
go get github.com/tendermint/tendermint/@v0.34.0

初始化配置

初始化Tendermint配置文件和密钥：

rm -rf /tmp/example
TMHOME="/tmp/example" tendermint init

启动应用

构建并运行应用：

go build
./example -config "/tmp/example/config/config.toml"

测试交易

在另一个终端发送测试交易：

curl -s 'localhost:26657/broadcast_tx_commit?tx="tendermint=rocks"'

总结

通过本教程，我们实现了一个简单的内置键值存储应用，展示了如何与Tendermint Core集成。这种内置模式提供了最佳性能，适合对延迟敏感的应用场景。

tendermint ⟁ Tendermint Core (BFT Consensus) in Go 项目地址: https://gitcode.com/gh_mirrors/te/tendermint