Parity JSON-RPC API中文手册

Parity以太坊节点软件的JSON-RPC API中文手册由汇智网翻译整理, 访问地址:http://cw.hubwiz.com/card/c/parity-rpc-api/

JSON是轻量级的数据交换格式。它可以表示数值、字符串、有序值序列以及名/值对集合。

JSON-RPC是无状态的轻量级远程过程调用(RPC)协议。JSON-RPC规范定义了数据结构 以及其处理规则,它是传输无关的,因此可以应用于socket、HTTP、WebSocket或其他 消息传输环境。JSON-RPC采用JSON(RFC 4627)作为数据格式。

Parity的网络传输设置

  • HTTP:在8545端口监听
  • WebSocket:在8546端口监听
  • IPC Socket:监听路径为$BASE/jsonrpc.ipc ,在linux上其默认值为~/.local/share/io.parity.ethereum/jsonrpc.ipc

JSON RPC中的数据类型

有几种利用JSON传递的数据类型。由于JavaScript/JSON没有原生的字节数组和 大数类型,这两种类型是特别针对以太坊API而设计的,都是用16进制编码, 但是有不同的格式化要求。

当编码数量类型 (整数或数值)时,编码为最紧凑的16进制并使用0x前缀, 紧凑的意思是0应当编码为0x0而不是0x00。示例如下:

  • 0x41 :十进制的65
  • 0x400 :十进制的1024
  • 0x:错误!应当至少有一位数字,例如0x0
  • 0x0400:错误!不需要前导0
  • ff:错误!必须使用前缀0x

当编码未格式化的数据(字节数组、账户地址、哈希、字节码数组)时,编码为16进制,使用前缀0x, 每字节使用两个16进制数字表示。例如:

  • 0x41:表示“A”,1个字节
  • 0x004200 :表示“\0B\0”,3个字节
  • 0x:表示“”,零字节
  • 0xf0f0f:错误!必须为偶数长度
  • 004200:错误!必须使用前缀0x

除了数据和数量,也有标准的JSON类型,我们称之为STR(字符串)和INT(整数)。

启用Parity的JSON-RPC API

默认情况下,并非所有的API都会暴露出来。但是你可以在启动Parity时使用--jsonrpc-apis APIS 来启用相应的API。

APIS时以逗号区隔的API名称列表。可用的名称包括:all, safe, web3, eth, net, personal, parity, parity_set, traces, rpc, parity_accounts, signer。你可以使用-前缀禁用某个 特定的api,例如:all,-personal

默认开启的api为: web3,eth,pubsub,net,parity,parity_pubsub,traces,rpc,secretstore。

Parity的JSON-RPC API列表

账户管理基础API

Parity扩展API

保险库管理API

签名API

挖矿相关API

开发相关API

网络信息API

节点设置API

Parity账户管理扩展API

Parity配置API

Pairty订阅API

签名API

跟踪调试API

Whisper扩展API

密钥库API