第四章 noduos

概述

UOSIO附带了许多程序。您将使用的主要部分以及此处涉及的部分是:noduos、cluos、kuosd。

noduos(node + uos) - 核心UOSIO 节点守护程序,可以配置插件来运行节点。如:生产区块,专用API节点和本地开发等。

cluos (cli + uos) - 命令行界面,用于与区块链交互并管理钱包。

kuosd (key + uos) - 将UOSIO密钥安全存储在钱包中的组件。

运行noduos

Noduos可以从命令行运行。行为noduos取决于使用的插件和每个插件的配置选项。Noduos本身有几个选项,这些选项允许您设置存储区块链数据的数据目录,并指向插件的配置文件和日志记录。

例如:

noduos -e -p uosio --plugin uosio::producer_plugin --plugin uosio::chain_api_plugin --plugin uosio::http_plugin --plugin uosio::state_history_plugin --data-dir /Users/mydir/uosio/data --config-dir /Users/mydir/uosio/config --access-control-allow-origin='*' --contracts-console --http-validate-host=false --state-history-dir /shpdata --trace-history --chain-state-history --verbose-http-errors --filter-on='*' --disable-replay-opts >> noduos.log 2>&1 &

Noduos配置

Noduos可以使用命令行界面(CLI)选项或配置文件进行配置config.ini。可以通过运行找到所有CLI选项$ noduos --help。

每个CLI选项都映射到一个config.ini的设置,例如--plugin uosio::chain_api_plugin可以通过添加plugin = uosio::chain_api_plugin来设置。

config.ini执行时可以使用自定义文件$ noduos –config-dir path/to/config.ini。

默认情况下,config.ini 可以在以下位置找到:

~/.local/share/uosio/noduos/config

Noduos选项

运行$ noduos –help,输出如下所示,实际输出将包括插件选项,但为清楚起见已排除这些选项。

Application Options:
Application Config Options:
  --plugin arg                          Plugin(s) to enable, may be specified
                                        multiple times
Application Command Line Options:
  -h [ --help ]                         Print this help message and exit.
  -v [ --version ]                      Print version information.
  --print-default-config                Print default configuration template
  -d [ --data-dir ] arg                 Directory containing program runtime
                                        data
  --config-dir arg                      Directory containing configuration
                                        files such as config.ini
  -c [ --config ] arg (=config.ini)     Configuration file name relative to
                                        config-dir
  -l [ --logconf ] arg (=logging.json)  Logging configuration file name/path
                                        for library users
Application Options:
Application Config Options:
  --plugin arg                          Plugin(s) to enable, may be specified
                                        multiple times
Application Command Line Options:
  -h [ --help ]                         Print this help message and exit.
  -v [ --version ]                      Print version information.
  --print-default-config                Print default configuration template
  -d [ --data-dir ] arg                 Directory containing program runtime
                                        data
  --config-dir arg                      Directory containing configuration
                                        files such as config.ini
  -c [ --config ] arg (=config.ini)     Configuration file name relative to
                                        config-dir
  -l [ --logconf ] arg (=logging.json)  Logging configuration file name/path
                                        for library users

插件选项

有关每个插件的详细信息,请参阅插件的文档:

bnet_plugin
chain_plugin
history_plugin
http_client_plugin
http_plugin
login_plugin
mongo_db_plugin
net_plugin
producer_plugin
state_history_plugin
txn_test_gen_plugin

noduos常用API

chain

get_info

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

URL:https://rpc1.uosio.org:8250/v1/chain/get_info

参数:

curl --request POST --url https://rpc1.uosio.org:8250/v1/chain/get_info
get_block

get_block

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

URL:https://rpc1.uosio.org:8250/v1/chain/get_block

参数:

block\_num\_or\_id : string类型,区块高度或区块ID
curl --request POST --url https://rpc1.uosio.org:8250 /v1/chain/get_block --data '{"block_num_or_id":"10000"}'

get_account

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

URL:https://rpc1.uosio.org:8250/v1/chain/get_account

参数:

account\_name :string类型,账户名
curl --request POST --url https://rpc1.uosio.org:8250/v1/chain/get_account --data '{"account_name":"uosio"}'

get_abi

返回某个账户下的智能合约abi信息。

URL:https://rpc1.uosio.org:8250/v1/chain/get_abi

参数:

account\_name :string类型,账户名
curl --request POST --url https://rpc1.uosio.org:8250/v1/chain/get_abi --data '{"account_name":"uosio"}'

get_code

返回一个对象,其中包含区块链上特定智能合约的各种详细信息。

URL:https://rpc1.uosio.org:8250/v1/chain/get_code

参数:

account\_name :string类型,账户名
curl --request POST --url https://rpc1.uosio.org:8250/v1/chain/get_code --data '{"account_name":"uosio","code_as_wasm":true}'

get_raw_code_and_abi

返回一个对象,其中包含区块链上特定智能合约的各种详细信息及abi。

URL:https://rpc1.uosio.org:8250/v1/chain/get_raw_code_and_abi

参数:

account\_name :string类型,账户名
curl --request POST --url https://rpc1.uosio.org:8250/v1/chain/get_raw_code_and_abi --data '{"account_name":"uosio"}'

get_table_rows

返回一个对象,该对象为指定表中的行。

URL:https://rpc1.uosio.org:8250/v1/chain/get_table_rows

参数:

scope : string类型,必填,帐户名称

code: string类型,必填,智能合约名称

table : string类型,必填,表名称

json : boolean类型,默认true

lower\_bound : string类型,可选,下限

upper\_bound : string类型,可选,上限

limit : int32类型,可选,限制返回数据条数,默认10

index\_position : string类型,要使用的索引序号,例如,主键索引为1或primary,次级索引为2或secondary,默认值:1

key\_type : string类型,索引键类型,例如i64

encode\_type : string类型,编码类型,dec或hex,默认值:dec
curl --request POST --url https://rpc1.uosio.org:8250/v1/chain/get_table_rows --data '{"scope":"uosio.token","code":"uosio.token","table":"accounts","json":"false","lower_bound":0,"upper_bound":100,"limit":10}'

get_currency_balance

获取指定账户下货币余额。

URL:https://rpc1.uosio.org:8250/v1/chain/get_currency_balance

参数:

code : string类型,合约名称

account\_name:string类型,所要查询的账户

symbol :string类型,可选,要查询的货币符号(不写则列出所有)
curl --request POST --url https://rpc1.uosio.org:8250/v1/chain/get_currency_balance --data '{"code":"uosio.token","account":"usera","smybol": "SYS"}'

get_currency_stats

返回指定货币的状态信息。

URL:https://rpc1.uosio.org:8250/v1/chain/get_currency_stats

参数:

code : string参数,合约名称

symbol : string类型,统计数据的货币符号
curl --request POST --url https://rpc1.uosio.org:8250/v1/chain/get_currency_stats --data '{"code":"uosio.token","symbol":"SYS"}'

get_producers

返回生产节点信息。

URL:https://rpc1.uosio.org:8250/v1/chain/get_producers

参数:

limit : uint32类型,要检索的生产者总数

lower\_bound : string类型,下限

json : boolean类型,以JSON格式返回结果
curl --request POST --url https://rpc1.uosio.org:8250/v1/chain/get_producers --data '{"limit":20,"lower_bound":"usera","json":"false"}'

get_required_kes

返回签名一个事务所需的公钥清单。

URL:https://rpc1.uosio.org:8250/v1/chain/ get_required_keys

参数:

transaction : json类型,事务

available\_keys : string数组,公钥集合
curl --request POST --url https://rpc1.uosio.org:8250/v1/chain/get_required_keys --data '{"transaction":{"ref_block_num":"8280640","ref_block_prefix": "2197313158","expiration": "2019-04-09T09:06:43.500","actions":[{"account":"uosio","name":"delegatebw","authorization": [{"actor":"testaccount1","permission":"active"}],"data": "10f2d4142193b1ca10f2d4142193b1ca102700000000000004535953000000001027000000000000045359530000000000"}],"signatures": [],"authorizations": []},"available_keys":["UOS72shafjy5hHqaESGRCA7XQRtdkz2aos58wqKJZ7S4uqVc1VvQ7","UOS8TnAwmHfdZvWYgbCBGYmLscwASkba9fALELpQSugqh9HUfHHkP","UOS5PVr4cGoXfaciZLpWLie4ozdy8fnoHVT57Ea3XxjpebZ9DLVyJ"]}'

abi_json_to_bin

将json格式内容转换成十六进制字符串

URL:https://rpc1.uosio.org:8250/v1/chain/abi_json_to_bin

参数:

code : string类型,合约名称

action : string类型,action名称

args : json类型,action参数
curl --request POST --url https://rpc1.uosio.org:8250/v1/chain/abi_json_to_bin --data '{"code":"uosio","action":"delegatebw","args": {"from":"tobetioadmax","receiver":"testaccount2","stake_net_quantity":"100.0000 UOS","stake_cpu_quantity":"100.0000 UOS","transfer":0}}'

abi_bin_to_json

将十六进制字符串转换为json格式。

URL:https://rpc1.uosio.org:8250/v1/chain/abi_bin_to_json

参数:

code : string类型,合约名称

action : string类型,action名称

binargs : string类型,action的十六进制格式
curl --request POST --url https://rpc1.uosio.org:8250/v1/chain/abi_bin_to_json --data '{"code":"uosio","action":"delegatebw","binargs":"d08d4c86baac0ecd20f2d4142193b1ca40420f000000000004554f530000000040420f000000000004554f530000000000"}'

push_transaction

向链上推送事务。

URL:https://rpc1.uosio.org:8250/v1/chain/push_transaction

参数:

compression : string类型,是否压缩

transaction : json类型,事务

signatures : string类型,签名集合
curl --request POST --url https://rpc1.uosio.org:8250/v1/chain/push_transaction --data '{"compression":"none","transaction":{"expiration":"2018-12-28T04:38:28","ref_block_num":1872,"ref_block_prefix":1884381553,"context_free_actions":[],"actions":[{"account":"uosio","name":"delegatebw","authorization":[{"actor":"tobetioadmax","permission":"active"}],"data":"d08d4c86baac0ecd20f2d4142193b1ca40420f000000000004554f530000000040420f000000000004554f530000000000"}],"transaction_extensions":[]},"signatures":["SIG_K1_KZxLe83ERHU1QLBJeSuii4dZtpYdNnp3HTrN6CgnWnU7R54f3eQNoX1EM19ekY7Nk2isVR47Qbi1yro5EaeE7kzB53c8L5"]}'

history

get_actions

返回action详情。

URL:https://rpc1.uosio.org:8250/v1/history/get_actions

参数:

pos : int32类型

offset : int32类型

account\_name : string类型,账户名
curl --request POST --url https://rpc1.uosio.org:8250/v1/history/get_actions --data '{"pos":0,"offset":100,"account_name":"uosio"}'

get_transaction

返回事务详情。

URL:https://rpc1.uosio.org:8250/v1/history/get_transaction

参数:

id : string类型,事务ID
curl --request POST --url https://rpc1.uosio.org:8250/v1/history/get_transaction --data '{"id":"c7e8abec0d7c12622d59bcb11b8df0e08173f1e40ad0dfd741805f3aee320402"}'

get_key_accounts

返回给定某个公钥下的所有账户。

URL:https://rpc1.uosio.org:8250/v1/history/get_key_accounts

参数:

public\_key : string类型,公钥
curl --request POST --url https://rpc1.uosio.org:8250/v1/history/get_key_accounts --data '{"public_key":"UOS8VrEtzikkqQBokT5ECirQQZ4Qpkh1p31spGSgTCHX95T86tU7Y"}'

get_controlled_accounts

返回控制的账户。

URL:https://rpc1.uosio.org:8250/v1/history/get_controlled_accounts

参数:

controlling\_account : string类型,账户名
curl --request POST --url https://rpc1.uosio.org:8250/v1/history/get_controlled_accounts --data '{"controlling_account":"uosio"}'

net

connect

连接某个节点。

URL:https://rpc1.uosio.org:8250/v1/net/connect

参数:

string类型
curl --request POST --url https://rpc1.uosio.org:8250/v1/net/connect --data '"https://rpc3.uosio.org:8080"'

disconnect

断开与某个节点的连接。

URL:https://rpc1.uosio.org:8250/v1/net/disconnect

参数:

string类型
curl --request POST --url https://rpc1.uosio.org:8250/v1/net/disconnect --data '"https://rpc3.uosio.org:8080"'

status

返回与某个节点的连接状态。

URL:https://rpc1.uosio.org:8250/v1/net/status

参数:

curl --request POST --url https://rpc1.uosio.org:8250/v1/net/status --data '"https://rpc3.uosio.org:8080"'

connections

返回所有的连接节点的信息。

URL:https://rpc1.uosio.org:8250/v1/net/status

参数:

curl --request POST --url https://rpc1.uosio.org:8250/v1/net/connections

producer

pause

暂停。

URL:https://rpc1.uosio.org:8250/v1/producer/pause

参数:

curl --request POST --url https://rpc1.uosio.org:8250/v1/producer/pause

resume

重新提交。

URL:https://rpc1.uosio.org:8250/v1/producer/resume

参数:

curl --request POST --url https://rpc1.uosio.org:8250/v1/producer/resume

paused

返回暂停的生产节点。

URL:https://rpc1.uosio.org:8250/v1/producer/paused

参数:

curl --request POST --url https://rpc1.uosio.org:8250/v1/producer/paused

get_runtime_options

获取运行时选项。

URL:https://rpc1.uosio.org:8250/v1/producer/get_runtime_options

参数:

curl --request POST --url https://rpc1.uosio.org:8250/v1/producer/get_runtime_options

get_greylist

返回生产节点灰名单

URL:https://rpc1.uosio.org:8250/v1/producer/get_greylist

参数:

curl --request POST --url https://rpc1.uosio.org:8250/v1/producer/get_greylist

add_greylist_accounts

将账户添加到灰名单。

URL:https://rpc1.uosio.org:8250/v1/producer/add_greylist_accounts

参数:

 account\_name:string数组类型,帐户名
curl --request POST --url https://rpc1.uosio.org:8250/v1/producer/add_greylist_accounts --data '{"accounts":["usera"]}'

remove_greylist_accounts

将账户从灰名单移除。

URL:https://rpc1.uosio.org:8250/v1/producer/remove_greylist_accounts

参数:

account\_name:string数组类型,帐户名
curl --request POST --url https://rpc1.uosio.org:8250/v1/producer/remove_greylist_accounts --data '{"accounts":["usera"]}'

get_whitelist_blacklist

返回生产节点白名单和黑名单。

URL:https://rpc1.uosio.org:8250/v1/producer/get_whitelist_blacklist

参数:

curl --request POST --url https://rpc1.uosio.org:8250/v1/producer/get_whitelist_blacklist

set_whitelist_blacklist

设置生产节点白名单和黑名单。

URL:https://rpc1.uosio.org:8250/v1/producer/get_whitelist_blacklist

参数:

actor\_whitelist:string类型,账户名

actor\_blacklist:string类型,账户名

contract\_whitelist:string类型,合约名称

contract\_blacklist:string类型,合约名称

action\_blacklist:string类型,action名称

key\_blacklist:string类型,公钥
curl --request POST --url https://rpc1.uosio.org:8250/v1/producer/get_whitelist_blacklist --data '{"actor_whitelist":["usera"],"actor_blacklist":[],"contract_whitelist":[],"contract_blacklist":[],"action_blacklist":[],"key_blacklist":[]}'

Last updated