RPC¶

RPC(Remote Procedure Call，远程过程调用)是客户端与区块链系统交互的一套协议和接口。用户通过RPC接口可查询区块链相关信息（如块高、区块、节点连接等）和发送交易。

1 名词解释¶

JSON(JavaScript Object Notation)：一种轻量级的数据交换格式。它可以表示数字、字符串、有序序列和键值对。
JSON RPC：一种无状态、轻量级的远程过程调用协议。该规范主要定义了几个数据结构及其处理规则。它允许运行在基于socket，http等诸多不同消息传输环境的同一进程中。它使用JSON (RFC 4627)作为数据格式。FISCO BCOS采用JSON RPC2.0协议。

../../_images/rpc.png

RPC模块负责提供FISCO BCOS的外部接口，客户端通过RPC发送请求，RPC通过调用账本管理模块和p2p模块获取相关响应，并将响应返回给客户端。其中账本管理模块通过多账本机制管理区块链底层的相关模块，具体包括共识模块，同步模块，区块管理模块，交易池模块以及区块验证模块。

客户端请求发送至区块链节点会触发RPC调用，客户端请求包括下列数据成员：

RPC请求包格式示例:

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

注：

当发起一个RPC调用时，除通知之外，区块链节点都必须回复响应。响应表示为一个JSON对象，使用以下成员：

RPC响应包格式示例:

{"jsonrpc": "2.0", "result": "0x1", "id": 1}

注：服务端响应必须包含result或error成员，但两个成员不能同时包含。

当一个RPC调用遇到错误时，返回的响应对象必须包含error错误结果字段，该字段有下列成员参数：

错误对象包含两类错误码，分别是JSON RPC标准错误码和FISCO BCOS RPC错误码。

标准错误码及其对应的含义如下：

FISCO BCOS RPC接口错误码及其对应的含义如下：

code	message	含义
1	GroupID does not exist	GroupID不存在
2	Response json parse error	JSON RPC获取的json数据解析错误
3	BlockHash does not exist	区块哈希不存在
4	BlockNumber does not exist	区块高度不存在
5	TransactionIndex is out of range	交易索引越界
6	Call needs a ‘from’ field	call接口需要提供from字段
7	Only pbft consensus supports the view property	getPbftView接口，只有pbft共识机制有view属性
8	Invalid System Config	getSystemConfigByKey接口，查询无效的key
9	Don’t send requests to this group, the node doesn’t belong to the group	非群组内节点发起无效的请求

FISCO BCOS提供丰富的RPC接口供客户端调用。其中分为3类：