配置说明

区块链是一个分布式对等网络，但是其配置需要集中生成。在CITA-Cloud中每个节点都要包含其他节点的信息，因此需要将所有节点的信息集中到一起，生成适用于各个节点的配置文件，然后再下发给各个节点分别运行。

CITA-Cloud的配置生成工具为cloud-config。

注意

当你计划使用 CITA-Cloud设计产品时，[环境准备] 好之后，不要着急启动节点，请仔细阅读本节内容，并选择最适合你产品需求的配置。

本文档会详细介绍链的各个可配置项。

链级配置

链级配置指的是链自身的一些属性，系统初始配置、创世块、节点网络地址等配置，用户需在起链前初始化链级配置，以下是生成链级配置的相关命令。

`init-chain`命令

根据指定的config-dir和chan-name,初始化一个链的文件目录结构。

参数：

--chain-name <CHAIN_NAME>
	set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
	set config file directory, default means current directory [default: .]

`init-chain-config`命令

初始化除admin(管理员账户)，validators(共识节点地址列表)，node_network_address_list（节点网络地址列表）之外的链级配置。因为前述三个操作需要一些额外的准备工作，且需要先对除此之外的链接配置信息在所有参与方之间达成共识。因此对于去中心化场景来说，这一步其实是一个公示的过程。执行之后会生成$(config-dir)/$(chain-name)/chain_config.toml。该命令有以下参数：

`--block_interval`

设置出块时间间隔，默认值为3。

`--block_limit`

设置内存中存储区块的上限，默认值为100，即内存中存储最近100个区块。

`--chain_name`

设置链的名字。

链的名字会作为文件夹的名称。以test-chain为例，按节点序号分别创建test-chain-0，test-chain-1，test-chain-2等节点文件夹，分别存放每个节点的配置文件。
如果没有传递 chain_name 参数，则默认链的名字为 test-chain。

`--chain_id`

设置链id，默认为空字符串。检测到为默认值时，自动替换为hex(sm3($(chain_name)))。

`--config-dir`

`--timestamp`

设置起链的时间戳，默认参数为0。检测到为默认值时，自动替换为当前时间对应的时间戳。

具体数值是指自 1970-1-1 以来的毫秒数，默认是取当前的时间。

`--prevhash`

设置创世块的父哈希值，默认为0x0000000000000000000000000000000000000000000000000000000000000000

`--version`

设置配置版本信息。

微服务选择相关参数

使用init-chain-config命令设置微服务的相关参数如下

--consensus_image <CONSENSUS_IMAGE>
	set consensus micro service image name (consensus_bft/consensus_raft) [default:consensus_raft]

--consensus_tag <CONSENSUS_TAG>
	set consensus micro service image tag [default: latest]

--controller_image <CONTROLLER_IMAGE>
	set controller micro service image name (controller)[default:controller]

--controller_tag <CONTROLLER_TAG>
	set controller micro service image tag [default: latest]

--executor_image <EXECUTOR_IMAGE>
	set executor micro service image name (executor_evm) [default: executor_evm]

--executor_tag <EXECUTOR_TAG>
	set executor micro service image tag [default: latest]

--kms_image <KMS_IMAGE>
	set kms micro service image name (kms_eth/kms_sm) [default: kms_sm]

--kms_tag <KMS_TAG>
	set kms micro service image tag [default: latest]

--network_image <NETWORK_IMAGE>
	set network micro service image name (network_tls/network_p2p) [default: network_p2p]

--network_tag <NETWORK_TAG>
	set network micro service image tag [default: latest]

--storage_image <STORAGE_IMAGE>
	set storage micro service image name (storage_rocksdb) [default: storage_rocksdb]

--storage_tag <STORAGE_TAG>
	set storage micro service image tag [default: latest]

`set-admin`命令

设置管理员账户。账户需要事先通过new-account子命令（见辅助命令一节）创建。如果网络微服务选择了network_tls，则还需要通过create-ca创建链的根证书。

参数：

--admin <ADMIN>              
	set admin
--chain-name <CHAIN_NAME>    
	set chain name [default: test-chain]
--config-dir <CONFIG_DIR>    
	set config file directory,default means currentdirectory[default:.]

admin为必选参数。值为之前用new-account创建的地址。

`set-validators`命令

设置共识节点账户列表。账户同样需要事先通过new-account子命令（见辅助命令一节），由各个共识节点分别创建，然后将账户地址集中到一起进行设置。

参数：

--chain-name <CHAIN_NAME>
	set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
	set config file directory,default means current directory[default:.]
--validators <VALIDATORS>
	validators account splited by ','

validators为必选参数。值为多个之前用new-account创建的地址,用逗号分隔。

`set-nodelist`命令

设置节点网络地址列表。各个节点参与方需要根据自己的网络环境，预先保留节点的ip，port和domain。然后将相关信息集中到一起进行设置。至此，链级配置信息设置完成，可以下发配置文件chain_config.toml到各个节点。如果网络微服务选择了network_tls，则需要通过create-csr根据节点的domain为各个节点创建证书和签名请求。然后请求CA通过sign-crs处理签名请求，并下发生成的cert.pem到各个节点。

参数：

--chain-name <CHAIN_NAME>
	set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
	set config file directory,default means current directory[default:.]
--nodelist <NODE_LIST>
	node list looks like localhost:40000:node0,localhost:40001:node1

nodelist为必选参数。值为多个节点的网络地址,用逗号分隔。每个节点的网络地址包含ip,port和domain，之间用冒号分隔。
domain为任意字符串，只需要确保节点之间不重复即可。

辅助命令

`create-ca`命令

创建链的根证书。会在$(config-dir)/$(chain-name)/ca_cert/下生成cert.pem和key.pem两个文件。

参数：

--chain-name <CHAIN_NAME>    
	set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
	set config file directory, default means current directory [default: .]

--chain-name设置链的名称，默认为test-chain。 --config-dir设置配置文件目录，默认为当前目录。

`create-csr`命令

为各个节点创建证书和签名请求。会在$(config-dir)/$(chain-name)/certs/$(domain)/下生成csr.pem和key.pem两个文件。

参数：

--chain-name <CHAIN_NAME>
	set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
	set config file directory, default means current directory [default: .]
--domain <DOMAIN>
	domain of node

--chain-name设置链的名称，默认为test-chain。 --config-dir设置配置文件目录，默认为当前目录。 --domain为必选参数。值为前面set-nodelist或者append-node时传递的节点的网络地址中的domain。

`sign-csr`命令

处理节点的签名请求。会在$(config-dir)/$(chain-name)/certs/$(domain)/下生成cert.pem。

参数：

--chain-name <CHAIN_NAME>
	set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
	set config file directory, default means current directory [default: .]
--domain <DOMAIN>
	domain of node

--chain-name设置链的名称，默认为test-chain。 --config-dir设置配置文件目录，默认为当前目录。 domain为必选参数。值为前面执行create-csr时节点的domain。

`new-account`命令

创建账户。会在$(config-dir)/$(chain-name)/accounts/下，创建以账户地址为名的文件夹，里面有key_id和kms.db两个文件。

参数：

--chain-name <CHAIN_NAME>
	set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
	set config file directory, default means current directory [default: .]
--kms-password <KMS_PASSWORD>
	kms db password [default: 123456]

--chain-name设置链的名称，默认为test-chain。 --config-dir设置配置文件目录，默认为当前目录。 --kms-password输入密钥库密码，默认为“123456”。

节点配置

节点配置指与链级配置无关的单个节点内部的配置，

`init-node`命令

设置节点配置信息。这步操作由各个节点的参与方独立设置，节点之间可以不同。执行之后会生成$(config-dir)/$(chain-name)-$(domain)/node_config.toml。有以下参数：

`--account`

account为必选参数，表示该节点要使用的账户地址。值为之前用new-account创建的地址。

`--chain-name`

设置链的名字，默认为test-chain，若生成链级配置时没有采用默认值这里也要对应。

`--config-dir`

设置配置文件目录，默认为当前文件夹，若生成链级配置时没有采用默认值这里也要对应。

`--key-id`

密钥库中的账户密钥id，默认为1。

`--kms-password`

密钥库密码，默认为”123456”。

`--log-level`

生成日志的等级，默认为info。

`--package-limit`

单个区块中包含交易量的上限，默认为30000。

`--network-listen-port`

本节点供区块链网络中其他节点连接的端口，默认为40000。

微服务grpc端口参数

通过以下参数设置节点内部各个微服务之间通信使用的grpc端口。

--network-port <NETWORK_PORT>
	grpc network_port of node [default: 50000]
--consensus-port <CONSENSUS_PORT>
	grpc consensus_port of node [default: 50001]
	--executor-port <EXECUTOR_PORT>
	grpc executor_port of node [default: 50002]
	--storage-port <STORAGE_PORT>
	grpc storage_port of node [default: 50003]
--controller-port <CONTROLLER_PORT>
	grpc controller_port of node [default: 50004]
--kms-port <KMS_PORT>
	grpc kms_port of node [default: 50005]

`update-node`命令

根据之前设置的链级配置和节点配置，生成每个节点所需的微服务配置文件。

`--chain-name`

设置链的名字，默认为test-chain，若生成链级配置时没有采用默认值这里也要对应。

`--config-dir`

设置配置文件目录，默认为当前文件夹，若生成链级配置时没有采用默认值这里也要对应。

`--config-name`

设置节点配置信息源，默认为config.toml，即保存init-node命令中生成的配置信息的文件。

`--domain`

domain为必选参数，作为节点的标识，表示要操作的节点。

各微服务内部参数

在生成配置时各个微服务中一些参数可能会采用默认值，这些参数在配置生成后也可以在各节点的config.toml文件中手动修改，以下是以各微服务为划分，关于这些参数的说明。

network_p2p

[network_p2p]
grpc_port = 50000
port = 40000

[[network_p2p.peers]]
address = '/dns4/127.0.0.1/tcp/40001'

[[network_p2p.peers]]
address = '/dns4/127.0.0.1/tcp/40002'

[[network_p2p.peers]]
address = '/dns4/127.0.0.1/tcp/40003'

说明：

[network_p2p]中是本节点的网络配置信息，grpc_port是本节点网络微服务和其他微服务通信的grpc端口，port是本节点供区块链网络中其他节点连接的端口。
[network_p2p.peers]中是本节点连接的其他网络节点的信息，以multiaddr标准记录，/dns4后是host信息，/tcp后是port信息。

network_tls

[network_tls]
grpc_port = 50000
listen_port = 40000
reconnect_timeout = 5

[[network_tls.peers]]
domain = 'test-chain-1'
host = '127.0.0.1'
port = 40001

[[network_tls.peers]]
domain = 'test-chain-2'
host = '127.0.0.1'
port = 40002

[[network_tls.peers]]
domain = 'test-chain-3'
host = '127.0.0.1'
port = 40003

说明：

[network_tls]中是本节点的网络配置信息，grpc_port是本节点网络微服务和其他微服务通信的grpc端口，listen_port是本节点供区块链网络中其他节点连接的端口，reconnect_timeout是超时重连时间。
[network_tls.peers]中是本节点连接的其他网络节点的信息，其中domain为任意字符串，只需要确保节点之间不重复即可。。

consensus_raft

[consensus_raft]
controller_port = 50004
grpc_listen_port = 50001
network_port = 50000
node_addr = 'c7e1fe8c89790ef0f4c0548e759c849806475a48'

说明：

grpc_listen_port是本节点共识微服务和其他微服务通信的grpc端口，controller_port是共识微服务的gRPC端口，network_port是网络微服务的gRPC端口，node_addr是本节点的地址。

consensus_bft

[consensus_bft]
consensus_port = 50001
controller_port = 50004
kms_port = 50005
network_port = 50000
node_address = '0x30bc783ff00ec6fb347a5b1c7b2480ae65dd007a'

说明：

consensus_port是本节点共识微服务和其他微服务通信的grpc端口，controller_port是共识微服务的gRPC端口，kms_port是kms微服务的gRPC端口，network_port是网络微服务的gRPC端口，node_addr是本节点的的地址。

executor_evm

[executor_evm]
executor_port = 50002

说明：

executor_port是执行器微服务的gRPC端口。

storage_rocksdb

[storage_rocksdb]
kms_port = 50005
storage_port = 50003

说明：

kms_port是kms微服务的gRPC端口，storage_port是存储微服务的gRPC端口。

controller

[controller]
consensus_port = 50001
controller_port = 50004
executor_port = 50002
key_id = 1
kms_port = 50005
network_port = 50000
node_address = 'c7e1fe8c89790ef0f4c0548e759c849806475a48'
package_limit = 30000
storage_port = 50003

说明：

consensus_port 是共识微服务的gRPC端口，controller_port 是控制器微服务的gRPC端口，executor_port 是执行器微服务的gRPC端口，kms_port 是kms微服务的gRPC端口，network_port 是网络微服务的gRPC端口，storage_port 是存储微服务的gRPC端口。

kms

db_key = '123456'
kms_port = 50005

说明：

kms_sm和kms_eth相同，db_key是密钥库的密码，kms_port 是kms微服务的gRPC端口。

配置说明

链级配置

init-chain命令

init-chain-config命令

--block_interval

--block_limit

--chain_name

--chain_id

--config-dir

--timestamp

--prevhash

--version

微服务选择相关参数

set-admin命令

set-validators命令

set-nodelist命令

辅助命令

create-ca命令

create-csr命令

sign-csr命令

new-account命令

节点配置

init-node命令

--account

--chain-name

--config-dir

--key-id

--kms-password

--log-level

--package-limit

--network-listen-port

微服务grpc端口参数

update-node命令

--chain-name

--config-dir

--config-name

--domain

各微服务内部参数

network_p2p

network_tls

consensus_raft

consensus_bft

executor_evm

storage_rocksdb

controller

kms

`init-chain`命令

`init-chain-config`命令

`--block_interval`

`--block_limit`

`--chain_name`

`--chain_id`

`--config-dir`

`--timestamp`

`--prevhash`

`--version`

`set-admin`命令

`set-validators`命令

`set-nodelist`命令

`create-ca`命令

`create-csr`命令

`sign-csr`命令

`new-account`命令

`init-node`命令

`--account`

`--chain-name`

`--config-dir`

`--key-id`

`--kms-password`

`--log-level`

`--package-limit`

`--network-listen-port`

`update-node`命令

`--chain-name`

`--config-dir`

`--config-name`

`--domain`