当前位置：首页 > news >正文

Venus API完整参考：RPC接口与开发者指南

news 2026/5/2 18:34:21

Venus API完整参考：RPC接口与开发者指南

【免费下载链接】venusFilecoin Full Node Implementation in Go项目地址: https://gitcode.com/gh_mirrors/ve/venus

Venus作为Filecoin的Go语言全节点实现，提供了丰富的RPC接口供开发者与Filecoin网络交互。本文将详细介绍Venus的RPC接口体系、核心功能模块及实用开发指南，帮助开发者快速上手Venus API开发。

一、Venus RPC接口概览

Venus的RPC系统采用模块化设计，主要通过app/node/rpc.go实现API注册与版本管理。目前支持v0和v1两个版本的API接口，其中v1版本新增了对Ethereum兼容层的支持，可通过以太坊风格的RPC方法与Filecoin网络交互。

1.1 API版本管理

Venus RPC接口通过版本控制确保兼容性，主要版本区别如下：

v0 API：传统Filecoin接口，定义于venus-shared/api/chain/v0
v1 API：增强版接口，支持Ethereum兼容层，定义于venus-shared/api/chain/v1

版本切换通过RPCBuilder的Build方法实现，代码示例如下：

// 构建v1版本RPC服务器 server := builder.Build("v1", limiter)

1.2 命名空间与服务注册

Venus采用命名空间机制组织API方法，核心命名空间包括：

Filecoin：Filecoin原生接口
Eth：Ethereum兼容接口

服务注册通过Register方法完成，例如：

// 注册Filecoin命名空间服务 server.Register("Filecoin", &fullNode)

二、核心RPC接口详解

2.1 区块相关接口

Venus提供了完整的区块查询功能，支持通过区块号、哈希等多种方式获取区块信息。

EthGetBlockByNumber

该方法通过区块号获取区块详情，定义于app/submodule/eth/eth_api.go：

func (a *ethAPI) EthGetBlockByNumber(ctx context.Context, blkParam string, fullTxInfo bool) (types.EthBlock, error) { ts, err := getTipsetByBlockNumber(ctx, a.em.chainModule.ChainReader, blkParam, true) if err != nil { return types.EthBlock{}, err } return a.getBlockByTipset(ctx, ts, fullTxInfo, "EthGetBlockByNumber:"+blkParam) }

参数说明：

blkParam：区块参数，支持"latest"、"pending"或具体区块号
fullTxInfo：是否返回完整交易信息

使用示例：

curl -X POST http://localhost:1234/rpc/v1 \ -H "Content-Type: application/json" \ -d '{"jsonrpc":"2.0","id":1,"method":"Filecoin.EthGetBlockByNumber","params":["latest", true]}'

2.2 交易相关接口

EthGetTransactionByHash

通过交易哈希查询交易详情，定义于app/submodule/eth/eth_api.go：

func (a *ethAPI) EthGetTransactionByHash(ctx context.Context, txHash *types.EthHash) (*types.EthTx, error) { return a.EthGetTransactionByHashLimited(ctx, txHash, constants.LookbackNoLimit) }

EthSendRawTransaction

发送原始交易，定义于app/submodule/eth/eth_api.go，支持以太坊格式的交易：

func (a *ethAPI) EthSendRawTransaction(ctx context.Context, data types.EthHexString) (types.EthHash, error) { // 实现逻辑... }

2.3 事件相关接口

Venus提供了事件过滤与订阅功能，通过app/submodule/eth/eth_event_api.go实现：

EthGetLogs

查询事件日志：

func (a *ethEventAPI) EthGetLogs(ctx context.Context, req types.EthFilterLogRequest) ([]types.EthLog, error) { // 实现逻辑... }

EthSubscribe

订阅实时事件：

func (a *ethEventAPI) EthSubscribe(ctx context.Context, params []json.RawMessage) (types.EthSubID, error) { // 实现逻辑... }

三、开发者实用指南

3.1 环境搭建

克隆仓库：

git clone https://gitcode.com/gh_mirrors/ve/venus cd venus

构建项目：

make

启动节点：

./venus daemon

3.2 API调用示例

Go语言客户端

package main import ( "context" "fmt" "github.com/filecoin-project/venus/venus-shared/api/chain/v1" "github.com/filecoin-project/go-jsonrpc" ) func main() { var api v1.FullNodeStruct _, err := jsonrpc.NewClient(context.Background(), "http://localhost:1234/rpc/v1", "Filecoin", &api) if err != nil { panic(err) } head, err := api.ChainHead(context.Background()) if err != nil { panic(err) } fmt.Printf("Current chain head: %s\n", head.Cids) }

curl调用

# 获取区块高度 curl -X POST http://localhost:1234/rpc/v1 \ -H "Content-Type: application/json" \ -d '{"jsonrpc":"2.0","id":1,"method":"Filecoin.EthBlockNumber","params":[]}'