RPC API

RPC API

CHAIN

get_info

返回包含区块链的各种详细信息的对象。

1
POST http://127.0.0.1:8888/v1/chain/get_info

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/chain/get_info

执行结果：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "server_version":"8f0f54cf",
  "chain_id":"6aa7bd33b6b45192465afa3553dedb531acaaff8928cf64b70bd4c5e49b7ec6a",
  "head_block_num":14880710,
  "last_irreversible_block_num":14880380,
  "last_irreversible_block_id":"00e30e7c94815385d5edb134f88a1a40bf6c9342a01763cdad44b250641bf0a8",
  "head_block_id":"00e30fc6c584a6c2090a91fc34eaa05d8e3a392f910c757c6c22376b68b9bd84",
  "head_block_time":"2018-11-23T03:42:20.500",
  "head_block_producer":"eosteaeostea",
  "virtual_block_cpu_limit":200000000,
  "virtual_block_net_limit":1048576000,
  "block_cpu_limit":199900,
  "block_net_limit":1048576,
  "server_version_string":"v1.3.1.6"
}

get_block

返回一个对象，其中包含有关区块链上特定块的各种详细信息。

1
POST http://127.0.0.1:8888/v1/chain/get_block

示例：

1
2
3
curl --request POST \
  --url http://127.0.0.1:8888/v1/chain/get_block \
  --data '{"block_num_or_id": "5"}'

主体参数

参数 类型 描述
block_num_or_id string Provide a block number or a block id REQUIRED

执行结果：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "timestamp":"2018-08-28T00:00:02.000",
  "producer":"eosio",
  "confirmed":0,
  "previous":"000000046fedbd93f736747cd5c5f1de844d1fb9b1076dc967b6344016e5fa16",
  "transaction_mroot":"0000000000000000000000000000000000000000000000000000000000000000",
  "action_mroot":"d0f15919364427f0f51e6b421929815bcafa0081bb3a1825fa7c2e16818931c6",
  "schedule_version":0,
  "new_producers":null,
  "header_extensions":[],
  "producer_signature":"SIG_K1_Ki4tfnaYVYdfT7Lh9iffU7zNw3qusUPMtEMbpxqrNYwQcHtmfdFc35jicervubFQN3R37bbGt5k6zZojzU77Ya2KneUBxg",
  "transactions":[],
  "block_extensions":[],
  "id":"00000005ebf9997c1924f5f79d63e699da5db5ebdc72c4df4b7c213602cd11e1",
  "block_num":5,
  "ref_block_prefix":4160037913
}

get_block_header_state

获取可逆区块头状态。

1
POST http://127.0.0.1:8888/v1/chain/get_block_header_state

示例：

1
2
3
curl --request POST \
  --url http://127.0.0.1:8888/v1/chain/get_block_header_state \
  --data '{"block_num_or_id":"118"}'

主体参数

参数 类型 描述
block_num_or_id string Provide a block number or a block id /

get_account

返回一个对象，其中包含有关区块链上特定帐户的各种详细信息。

1
POST http://127.0.0.1:8888/v1/chain/get_account

示例：

1
2
3
curl --request POST \
  --url http://127.0.0.1:8888/v1/chain/get_account \
  --data '{"account_name": "eosio"}'

主体参数

参数 类型 描述
account_name string Provide an account name REQUIRED

执行结果：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
{
  "account_name":"eosio",
  "head_block_num":14882625,
  "head_block_time":"2018-11-23T03:58:18.500",
  "privileged":true,
  "last_code_update":"2018-09-15T17:48:36.000",
  "created":"2018-08-28T00:00:00.000",
  "ram_quota":-1,
  "net_weight":-1,
  "cpu_weight":-1,
  "net_limit":{
    "used":-1,
    "available":-1,
    "max":-1
  },
  "cpu_limit":{
    "used":-1,
    "available":-1,
    "max":-1
  },
  "ram_usage":1229057,
  "permissions":[
    {
      "perm_name":"active",
      "parent":"owner",
      "required_auth":{
        "threshold":1,
        "keys":[],
        "accounts":[
          {
            "permission":{
              "actor":"eosio.prods",
              "permission":"active"
            },
            "weight":1
          }
        ],
        "waits":[]
      }
    },
    {
      "perm_name":"owner",
      "parent":"",
      "required_auth":{
        "threshold":1,
        "keys":[],
        "accounts":[
          {
            "permission":{
              "actor":"eosio.prods",
              "permission":"active"
            },
            "weight":1
          }
        ],
        "waits":[]
      }
    }
  ],
  "total_resources":null,
  "self_delegated_bandwidth":null,
  "refund_request":null,
  "voter_info":null
}

get_abi

获取账户的 abi 数据。

1
POST http://127.0.0.1:8888/v1/chain/get_abi

示例：

1
2
3
curl --request POST \
  --url http://127.0.0.1:8888/v1/chain/get_abi \
  --data '{"account_name": "hello"}'

主体参数

参数 类型 描述
account_name string name of account to retrieve ABI for /

执行结果：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
  "account_name":"hello",
  "abi":{
    "version":"eosio::abi/1.0",
    "types":[],
    "structs":[
      {
        "name":"player",
        "base":"",
        "fields":[
          {
            "name":"title",
            "type":"string"
          },
          {
            "name":"age",
            "type":"int64"
          }
        ]
      },
      {
        "name":"hi",
        "base":"",
        "fields":[
          {
            "name":"user",
            "type":"name"
          }
        ]
      }
    ],
    "actions":[
      {
        "name":"hi",
        "type":"hi",
        "ricardian_contract":""
      }
    ],
    "tables":[],
    "ricardian_clauses":[],
    "error_messages":[],
    "abi_extensions":[],
    "variants":[]
  }
}

get_raw_code_and_abi

获取账户的原始 code 和 abi 数据。

1
POST http://127.0.0.1:8888/v1/chain/get_raw_code_and_abi

示例：

1
2
3
curl --request POST \
  --url http://127.0.0.1:8888/v1/chain/get_raw_code_and_abi \
  --data '{"account_name":"hello"}'

主体参数

参数 类型 描述
account_name string Account name to get code and abi for /

执行结果：

1
2
3
4
5
{
  "account_name":"hello"
  "wasm":"UEsDBC0AAAAIAPCEd01qlACiNgAAADkAAAAIABQAaW5kZXguanMBABAAAAAAAAAAAAAAAAAAAAAAAEutKMgvKinWy8hUsFUoLU4tUrC1U0jOzyvOz0nVSy0qyi/SUM/MA4mUFCUml1ip64BVaVoDAFBLAQIAABQAAAAIAPCEd01qlACiNgAAADkAAAAIAAAAAAAAAAEAAAAAAAAAAABpbmRleC5qc1BLBQYAAAAAAQABADYAAABwAAAAAAA=="
  "abi":"DmVvc2lvOjphYmkvMS4wAAIGcGxheWVyAAIFdGl0bGUGc3RyaW5nA2FnZQVpbnQ2NAJoaQABBHVzZXIEbmFtZQEAAAAAAACAawJoaQAAAAAA="
}

get_table_rows

返回包含指定表中行的对象。

1
POST http://127.0.0.1:8888/v1/chain/get_table_rows

示例：

1
2
3
curl --request POST \
  --url http://127.0.0.1:8888/v1/chain/get_table_rows \
  --data '{"scope":"dabingguozi","code":"eosio.token","table":"accounts","json":true}'

主体参数

参数 类型 描述
scope string Provide the account name REQUIRED
code string Provide the smart contract name REQUIRED
table string Provide the table name REQUIRED
json boolean return result in JSON format REQUIRED
lower_bound int32 Provide the lower bound /
upper_bound int32 Provide the upper bound /
limit int32 Provide the limit /

执行结果：

1
2
3
4
5
6
{
  "rows": [{
    "balance": "554.0000 SYS"
    }],
  "more": false
}

abi_json_to_bin

将 json 序列化为二进制十六进制。 生成的二进制十六进制通常用于 push_transaction 中的数据字段。

1
POST http://127.0.0.1:8888/v1/chain/abi_json_to_bin

示例：

1
2
3
curl --request POST \
  --url http://127.0.0.1:8888/v1/chain/abi_json_to_bin \
  --data '{"code":"eosio.token","action":"transfer","args":{"from":"testnetyy111","to":"testneths111","quantity":"100.0000 EOS", "memo":"hi there"}}'

主体参数

参数 类型 描述
code string Provide the account name /
action string Provide the action arguments /
args json Provide the json arguments /

执行结果：

1
2
3
{
  "binargs": "1042f03eab99b1ca1042c02dab99b1ca40420f000000000004454f5300000000086869207468657265",
}

abi_bin_to_json

将二进制十六进制序列化为 json 格式。

1
POST http://127.0.0.1:8888/v1/chain/abi_bin_to_json

示例：

1
2
3
curl --request POST \
  --url http://127.0.0.1:8888/v1/chain/abi_bin_to_json \
  --data '{"code":"eosio.token","action":"transfer","binargs":"1042f03eab99b1ca1042c02dab99b1ca40420f000000000004454f5300000000086869207468657265"}'

主体参数

参数 类型 描述
code string Provide the smart contract account name REQUIRED
action string Provide the action name REQUIRED
binargs string Provide the binary arguments REQUIRED

执行结果：

1
2
3
4
5
6
7
8
{
  "args": {
    "from": "testnetyy111",
    "to": "testneths111",
    "quantity": "100.0000 EOS",
    "meno": "hi there"
  }
}

get_required_keys

返回签署事务所需的密钥。

1
POST http://127.0.0.1:8888/v1/chain/get_required_keys

示例：

1
2
3
curl --request POST \
  --url http://127.0.0.1:8888/v1/chain/get_required_keys \
  --data '{"transaction":transaction_object,"action":available_keys}'

主体参数

参数 类型 描述
transaction json Provide the transaction object REQUIRED
available_keys array of strings Provide the available keys REQUIRED

执行结果：

1
2
3
4
5
{
  "required_keys": [
    "EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV"
  ]
}

Example

transaction

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "ref_block_num": "100",
  "ref_block_prefix": "137469861",
  "expiration": "2017-09-25T06:28:49",
  "scope": ["initb", "initc"],
  "actions": [{
    "code": "currency",
    "type": "transfer",
    "recipients": ["initb", "initc"],
    "authorization": [{
      "account": "initb",
      "permission": "active"
    }],
    "data": "000000000041934b000000008041934be803000000000000"
  }],
  "signatures": [],
  "authorizations": []
}

available_keys

1
2
3
["EOS4toFS3YXEQCkuuw1aqDLrtHim86Gz9u3hBdcBw5KNPZcursVHq",
 "EOS7d9A3uLe6As66jzN8j44TXJUqJSK3bFjjEEqR4oTvNAB3iM9SA",
 "EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV"]

get_currency_stats

获取某种资产的详情。

1
POST http://127.0.0.1:8888/v1/chain/get_currency_stats

示例：

1
2
3
curl --request POST \
  --url http://127.0.0.1:8888/v1/chain/get_currency_stats \
  --data '{"code":"eosio.token","symbol":"EOS"}'

主体参数

参数 类型 描述
code string /
symbol string currency symbol to get the stats for /

get_producers

获取生产者信息。

1
POST http://127.0.0.1:8888/v1/chain/get_producers

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/chain/get_producers

主体参数

参数 类型 描述
limit string total number of producers to retrieve /
lower_bound string /
json boolean return result in JSON format? /

push_block

推送区块。

1
POST http://127.0.0.1:8888/v1/chain/push_block

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/chain/push_block

主体参数

参数 类型 描述
timestamp date-time /
producer string /
confirmed int32 /
previous string /
transaction_mroot string /
action_mroot int32 /
version string /
new_producers array of strings /
header_extensions array of strings /
producer_signature string /
transactions array /
block_extensions array of strings /

push_transaction

此方法需要JSON格式的事务，并尝试将其应用于区块链。

1
POST http://127.0.0.1:8888/v1/chain/push_transaction

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/chain/push_transaction

主体参数

参数 类型 描述
signatures array of strings array of signatures required to authorize transaction /
compression string compression used, usually false /
packed_context_free_data string json to hex /
packed_trx string json to hex /

执行结果：

1
2
3
{
	'transaction_id' = "1..."
}

Example

Note

这里的ref_block_num和ref_block_prefix是last_irreversible_block的/v1/chain/get_block的结果。 可以通过调用/v1/chain/get_info找到last_irreversible_block。 您还需要使用/v1/wallet/sign_transaction来获取正确的签名。

push_transactions

此方法需要JSON格式的事务，并尝试将其应用于区块链。 此方法一次推送多个事务。

1
POST http://127.0.0.1:8888/v1/chain/push_transaction

示例：

1
2
3
curl --request POST \
  --url http://127.0.0.1:8888/v1/chain/push_transaction \
  --data '{"body":transaction}'

主体参数

参数 类型 描述
body json Provide the authorizations for the transaction REQUIRED

执行结果：

1
2
3
{
	'transaction_id' = "1..."
}

Example

Note

这里的ref_block_num和ref_block_prefix是last_irreversible_block的/v1/chain/get_block的结果。 可以通过调用/v1/chain/get_info找到last_irreversible_block。 您还需要使用/v1/wallet/sign_transaction来获取正确的签名。

HISTORY

注意：需要启用 history-api 插件

get_key_accounts

根据公钥查询账户。

1
POST http://127.0.0.1:8888/v1/history/get_key_accounts

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/history/get_key_accounts

主体参数

参数 类型
public_key int32 /

NET

注意：需要启用 net 插件

connect

1
POST http://127.0.0.1:8888/v1/net/connect

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/net/connect

参数

string

disconnect

1
POST http://127.0.0.1:8888/v1/net/disconnect

示例：

1
2
3
curl --request POST \
  --url http://127.0.0.1:8888/v1/net/disconnect \
  --data '""'

参数

string

connections

1
POST http://127.0.0.1:8888/v1/net/connections

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/net/connections

status

1
POST http://127.0.0.1:8888/v1/net/status

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/net/status

PRODUCER

需要启用 producer 插件

pause

1
POST http://127.0.0.1:8888/v1/producer/pause

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/producer/pause

resume

1
POST http://127.0.0.1:8888/v1/producer/resume

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/producer/resume

paused

1
POST http://127.0.0.1:8888/v1/producer/paused

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/producer/resume

get_runtime_options

1
POST http://127.0.0.1:8888/v1/producer/get_runtime_options

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/producer/get_runtime_options

update_runtime_options

1
POST http://127.0.0.1:8888/v1/producer/update_runtime_options

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/producer/update_runtime_options

主体参数

参数 类型
max_transaction_time int32 /
max_irreversible_block_age int32 /
produce_time_offset_us int32 /
last_block_time_offset_us int32 /
incoming_defer_ratio int32 /
subjective_cpu_leeway_us int32 /

get_greylist

1
POST http://127.0.0.1:8888/v1/producer/get_greylist

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/producer/get_greylist

执行结果：

1
{"accounts":["a11111111111","aaa","bbb"]}

add_greylist_accounts

1
POST http://127.0.0.1:8888/v1/producer/add_greylist_accounts

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/producer/add_greylist_accounts

主体参数

参数 类型 描述
accounts array of strings Accounts to add to greylist /

remove_greylist_accounts

1
POST http://127.0.0.1:8888/v1/producer/remove_greylist_accounts

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/producer/remove_greylist_accounts

主体参数

参数 类型 描述
accounts array of strings Accounts to add to greylist /

get_whitelist_blacklist

1
POST http://127.0.0.1:8888/v1/producer/get_whitelist_blacklist

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/producer/get_whitelist_blacklist

set_whitelist_blacklist

1
POST http://127.0.0.1:8888/v1/producer/set_whitelist_blacklist

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/producer/set_whitelist_blacklist

DBSIZE

get

1
POST http://127.0.0.1:8888/v1/db_size/get

示例：

1
2
curl --request POST \
  --url http://127.0.0.1:8888/v1/db_size/get