status-go API使用手册：从C绑定到HTTP服务的完整接口指南

status-go API使用手册：从C绑定到HTTP服务的完整接口指南

【免费下载链接】status-goThe "backend" library for Status Apps项目地址: https://gitcode.com/gh_mirrors/st/status-go

status-go作为Status应用的核心后端库，提供了从C语言绑定到HTTP服务的全方位接口支持。本文将详细介绍status-go的API体系，帮助开发者快速掌握从底层C绑定到高层HTTP服务的使用方法，轻松构建基于Status生态的应用和服务。

一、C语言绑定：底层接口的无缝对接

1.1 C绑定生成工具概述

status-go提供了专门的C绑定生成工具，位于tools/generate-cbindings/目录下。该工具通过解析mobile/目录下的Go文件，识别公共函数并生成等效的C语言签名，实现了Go代码与C语言的无缝对接。

1.2 支持的数据类型

目前C绑定工具支持以下数据类型：

• C.int：整数类型
• *C.char：字符串类型
• unsafer.Pointer：指针类型

函数如果使用了不支持的类型，将被自动忽略。

1.3 实现原理

C绑定生成工具通过解析Go代码，为每个符合条件的公共函数生成对应的C语言包装函数。这些包装函数会直接调用mobile/目录下的原始Go函数，从而实现了C语言对Go代码的直接调用。

这种方法虽然简单直接，但也存在一定的局限性，主要是类型支持有限。不过对于大多数基础功能的调用已经足够，为移动应用等需要C语言接口的场景提供了便利。

二、HTTP服务：高层接口的便捷使用

2.1 服务初始化与登录

status-go提供了完整的HTTP服务接口，位于cmd/status-backend/server/目录。使用HTTP服务的第一步是初始化应用并登录账户。

初始化应用

POST /statusgo/InitializeApplication { "dataDir": "/path/to/data" }

响应将包含数据目录中已有的账户列表，如果账户列表为空，则需要创建新账户。

创建账户并登录

POST /statusgo/CreateAccountAndLogin { "rootDataDir": "/path/to/data", "displayName": "MyBot", "password": "...", "customizationColor": "primary" }

登录现有账户

POST /statusgo/LoginAccount { "keyUID": "0xabc...", "password": "..." }

[!IMPORTANT] 登录操作是异步的，HTTP响应仅表示请求已接收，实际登录结果需要通过WebSocket信号node.login获取。

2.2 WebSocket信号：实时事件通知

status-go使用WebSocket提供实时事件通知，连接地址为ws://<host>:<port>/signals。

关键信号类型

登录信号示例

{ "type": "node.login", "event": { "error": "", "settings": {...}, "account": {...} } }

2.3 JSON-RPC接口：核心功能调用

所有核心功能都通过POST /statusgo/CallRPC接口以JSON-RPC格式调用。

启动信使服务

{ "jsonrpc": "2.0", "id": 1, "method": "wakuext_startMessenger", "params": [] }

获取已加入社区

{ "jsonrpc": "2.0", "id": 2, "method": "wakuext_joinedCommunities", "params": [] }

响应示例：

[ { "id": "0x03abc...", "name": "Community Name", "joined": true, "isMember": true, "verified": true, "members": { "0x04pubkey...": {"roles": [1]} }, "chats": { "chat-uuid": { "name": "general", "canPost": true } } } ]

[!NOTE]joined表示本地已加入，isMember表示网络层面已成为成员，只有isMember: true才能发布消息。

发送聊天消息

{ "jsonrpc": "2.0", "id": 3, "method": "wakuext_sendChatMessage", "params": [ { "chatId": "0x03ab2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b28a805944-9f5d-4219-a104-5d2047f5572a", "text": "Hello, status-go!", "contentType": 1 } ] }

三、API使用流程：从启动到消息发送

3.1 完整启动流程

1. 连接WebSocket到/signals
2. 调用POST /statusgo/InitializeApplication获取现有账户
3. 根据情况选择登录或创建账户
4. 等待node.login信号确认登录成功
5. 调用wakuext_startMessenger启动信使服务
6. 开始使用其他RPC方法

status-go API使用流程示意图

3.2 加入社区流程

1. 获取钱包地址：调用accounts_getAccounts找到wallet: true的账户
2. 获取社区描述：调用wakuext_fetchCommunity
3. 发送加入请求：调用wakuext_requestToJoinCommunity
4. 等待社区所有者批准（开放社区会自动批准）
5. 确认isMember变为true后即可发送消息

四、常见错误与解决方案

五、总结

status-go提供了从C语言绑定到HTTP服务的完整API体系，满足了不同层级的开发需求。通过C绑定，开发者可以在底层与status-go进行交互；通过HTTP服务和WebSocket，开发者可以轻松构建高层应用。

无论是移动应用开发还是后端服务集成，status-go的API都提供了便捷、高效的接口。希望本文能够帮助开发者快速掌握status-go API的使用，为Status生态的发展贡献力量。

要开始使用status-go，请先克隆仓库：git clone https://gitcode.com/gh_mirrors/st/status-go，然后参考docs/目录下的文档获取更多详细信息。

【免费下载链接】status-goThe "backend" library for Status Apps项目地址: https://gitcode.com/gh_mirrors/st/status-go