status-go API使用手册:从C绑定到HTTP服务的完整接口指南
status-go API使用手册从C绑定到HTTP服务的完整接口指南【免费下载链接】status-goThe backend library for Status Apps项目地址: https://gitcode.com/gh_mirrors/st/status-gostatus-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。关键信号类型信号触发时机关键事件字段node.login登录完成后error,settings,accountnode.started节点进程启动后—node.ready节点完全初始化后—messages.new收到新消息时messages[]— 消息对象数组登录信号示例{ 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 完整启动流程连接WebSocket到/signals调用POST /statusgo/InitializeApplication获取现有账户根据情况选择登录或创建账户等待node.login信号确认登录成功调用wakuext_startMessenger启动信使服务开始使用其他RPC方法status-go API使用流程示意图3.2 加入社区流程获取钱包地址调用accounts_getAccounts找到wallet: true的账户获取社区描述调用wakuext_fetchCommunity发送加入请求调用wakuext_requestToJoinCommunity等待社区所有者批准开放社区会自动批准确认isMember变为true后即可发送消息四、常见错误与解决方案错误含义解决方案does not existRPC处理器尚未注册等待startMessenger完成node is already running已登录状态下调用登录登录前检查settings_getSettings中的public-keycant post message type 1无发消息权限使用requestToJoinCommunity并等待成员资格确认community not found社区描述未获取先调用fetchCommunity五、总结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创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考