Cosmos SDK 高级教程：深入理解 gRPC、REST 和 CometBFT 端点-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01117/article/details/148466071

Cosmos SDK 高级教程：深入理解 gRPC、REST 和 CometBFT 端点

cosmos-sdk :chains: A Framework for Building High Value Public Blockchains :sparkles: 项目地址: https://gitcode.com/gh_mirrors/co/cosmos-sdk

前言

在 Cosmos SDK 生态系统中，节点提供了多种交互方式，包括 gRPC、REST 和 CometBFT RPC 等端点。理解这些端点的特性和适用场景对于开发者构建高效的去中心化应用至关重要。本文将深入解析这些端点的技术细节、配置方式和使用场景。

端点概览

Cosmos SDK 节点默认提供三类主要端点，分别运行在不同的端口上：

gRPC 服务器（默认端口：9090）
REST 服务器（默认端口：1317）
CometBFT RPC 端点（默认端口：26657）

需要注意的是，这些端点默认只绑定到本地主机（localhost），如果需要公开访问，必须修改相关配置。

gRPC 服务器详解

技术背景

gRPC 是 Google 开发的高性能 RPC 框架，基于 HTTP/2 协议和 Protocol Buffers 序列化协议。在 Cosmos SDK 中，gRPC 作为主要的远程调用接口，提供了高效的通信能力。

实现机制

每个 Cosmos SDK 模块都会暴露一个 Protobuf Query 服务，用于定义状态查询接口。这些查询服务和交易广播服务通过以下方式连接到 gRPC 服务器：

func (app *App) RegisterGRPCServer(grpcSvr *grpc.Server) {
    // 注册模块查询服务
    authtypes.RegisterQueryServer(grpcSvr, app.AccountKeeper)
    banktypes.RegisterQueryServer(grpcSvr, app.BankKeeper)
    // 注册其他模块服务...
}

重要限制

需要注意的是，gRPC 端点不能直接暴露 Protobuf Msg 服务。交易必须通过 CLI 或编程方式生成并签名后，才能通过 gRPC 广播。

配置选项

在 ~/.{app_name}/config/app.toml 中可以配置 gRPC 服务器：

[grpc]
enable = true  # 是否启用 gRPC 服务器
address = "localhost:9090"  # 绑定地址

使用场景

gRPC 特别适合：

需要高性能通信的场景
服务间通信
需要流式传输的场景
使用强类型接口的应用

REST 服务器深度解析

架构设计

Cosmos SDK 通过 gRPC-gateway 提供 RESTful 接口，这是一种将 gRPC 服务映射为 REST API 的网关模式。

核心配置

在 ~/.{app_name}/config/app.toml 中配置 REST 服务器：

[api]
enable = true  # 是否启用 REST 服务器
address = "tcp://localhost:1317"  # 绑定地址
swagger = true  # 是否启用 Swagger 文档

路由映射原理

每个 Protobuf Query 服务中的 RPC 方法都会自动生成对应的 REST 端点。例如：

service Query {
  rpc AllBalances(QueryAllBalancesRequest) returns (QueryAllBalancesResponse) {
    option (google.api.http) = {
      get: "/cosmos/bank/v1beta1/balances/{address}"
    };
  }
}

这个定义会同时生成 gRPC 和 REST 两种访问方式。

Swagger 集成

启用 Swagger 后，可以通过 /swagger 路径访问 API 文档。对于自定义模块，可以使用 Cosmos SDK 提供的脚本生成 Swagger 定义。

CometBFT RPC 技术剖析

基础架构

CometBFT RPC 是底层共识引擎提供的原生接口，独立于 Cosmos SDK 实现。

关键端点

ABCI 查询 (/abci_query)：
- 支持多种查询路径格式
- 可以直接查询存储状态
- 可以调用应用层方法
交易广播：
- /broadcast_tx_async：异步广播
- /broadcast_tx_sync：同步广播
- /broadcast_tx_commit：等待交易提交

配置方式

在 ~/.{app_name}/config/config.toml 中配置：

[rpc]
laddr = "tcp://localhost:26657"  # 监听地址

技术选型指南

| 端点类型 | 优势 | 劣势 | |----------------|----------------------------------------------------------------------|----------------------------------------------------------------------| | gRPC | 高性能、多语言支持、二进制传输、流式通信 | 浏览器支持有限、学习曲线较陡峭 | | REST | 通用性强、开发简单、工具生态丰富 | 仅支持请求-响应模式、JSON 传输效率较低 | | CometBFT RPC | 直接访问底层功能、简单易用 | JSON 传输效率较低、功能相对基础 |