Skip to content
This repository has been archived by the owner on Dec 10, 2020. It is now read-only.

Latest commit

 

History

History
350 lines (244 loc) · 17.8 KB

Join-ChainX-Mainnet.md

File metadata and controls

350 lines (244 loc) · 17.8 KB

加入 ChainX 主网


在开始以下步骤前,请了解以下内容:


0. 基础

ChainX为PoS区块链,具备staking的基础特征。

在ChainX中,定义如下概念:

  1. 物理运行的节点

    ​ 物理运行的节点指代实际运行中的节点进程。该进程可以以两种模式启动,可以通过配置文件中的"validator": true/false决定

    1. 同步节点:即只用于同步区块数据,没有出块功能。一般用于本地提供rpc服务,或同步区块数据
    2. 验证者节点:具备出块功能
  2. 链上定义的节点(即在ChainX钱包里显示的验证节点/同步节点/退选节点,注:这里的同步节点之前叫做候选节点,只是为了方便用户投票所以更名为同步节点)

    链上的节点首先需要在ChainX上注册成为节点,一切以链上数据为准

    链上的节点与staking相关,这里的验证节点和同步节点并不是指物理意义中的节点,是指这个地址处于staking中的状态。但请注意,若想参与staking,物理运行的节点必须为验证者节点,也就是"validator":true且设置了"validator-name":"xxx"对应于链上定义的节点的节点名称,若成为具备出块能力的验证着,需要保证keystore中的公钥为链上配置的出块公钥(详情见后文)

    1. 验证节点:注册成为节点,参选后,若当前该节点的总得票数达到前30则自动成为验证节点,参与出块,并能获取每个分红周期的收益。若此时物理节点未是验证者节点或出块公钥配置不正确,会因为无法出块而导致惩罚退选
    2. 同步节点:注册成为节点,参选后,若当前该节点的总得票数在30名之后则自动成为同步节点,不参与出块,但仍然能获取每个分红周期的收益,视作节点候选,若有验证节点跌落30名之后,同步节点会跟上转换为验证者节点进行出块。
    3. 退选节点:当参选后,奖池被惩罚为0或因为其他惩罚会将节点转变为退选节点。退选节点无收益,不参与任何staking活动。若想重新参与staking,则需要进行参选。
  3. 物理运行节点与链上定义节点的联系

    物理节点与链上节点通过启动物理节点的配置validator-name进行挂钩,而是否具备正常的出块权通过链上节点参选时注册的出块公钥与启动物理节点配置中的keystore相关信息进行挂钩

1. 下载节点运行程序

我们提供了以下两种途径:

2. 启动节点前准备

删除老旧测试网节点

ChainX 主网已经于 2019 年 5 月 25 日正式启动,如果之前有运行过测试网节点,请先删除所有测试网数据:

  • 若启动时通过 -d--base-path 指定了DB存放目录,则将这个目录完全删除即可。

  • 若启动时没有指定路径,则删除默认的DB目录:

    • Linux(ubuntu):

      $ rm -rf $HOME/.local/share/ChainX
    • macOS:

      $ rm -rf $HOME/Library/Application\ Support/ChainX

准备节点启动配置文件

当前ChainX已经提供了从配置文件读取参数启动节点的方式,完整的启动参数可参见 chainx --help:

./chainx --help

ChainX community
Fully Decentralized Interchain Crypto Asset Management on Polkadot

USAGE:
   chainx [FLAGS] [OPTIONS]
   chainx <SUBCOMMAND>

FLAGS:
   ......
......
OPTIONS:
   ......
   ......

help 中出现的所有命令均可在配置文件中进行配置,我们目前提供了 json 的配置文件格式。chainx 程序可选参数分为 [FLAGS][OPTIONS] 两部分, 示例如下:

  • FLAGStrue 表示启用该FLAG, false 表示不启用该FLAG, 如:
{
    // 等价于在命令行传入 --validator, `./chainx --validator`
    "validator": true,
}
  • OPTIONS。如:
{
    // 等价于在命令行传入 --base-path=<ChainX数据路径>, `./chainx --base-path=<ChainX数据存放路径>`
    "base-path": "<ChainX数据存放路径>",
}

不推荐使用命令行直接传参的方式启动节点,出于节点安全考虑,请使用 json 配置文件的方式启动节点。配置文件编写好后将该配置文件保存某处,请做好对应的安全策略

下文为简便,将启动配置文件命名为 config.json,并将其放置到与 chainx 二进制程序的同级目录下。

$ ls
├── chainx
├── chainx.md5
└── config.json

3. 启动节点

对于有意愿当验证人的节点,我们强烈建议至少运行两个节点,即一个同步节点和一个验证者节点。这样即使当验证者节点出现问题时,也可以随时将备用的同步节点切换为出块节点,避免因为没有按时出块导致节点被惩罚。

我们推荐使用 json 配置文件的方式启动节点, 下载配置文件模板,可通过以下方式下载:

$ curl https://gist.githubusercontent.com/liuchengxu/3b3ed4ce027e39fc89b5a5a6c289bfaf/raw/e51272a85e653c31763e97c6aaf6084c38c03c40/validator_config.json -o validator_config.json

!!! 请不要直接使用该文件启动节点,务必参照以下启动指引修改配置文件模板后运行, 各参数将在下文解释。

启动前注意事项:

  • 自v1.0.2版本起,chainx默认并没有将输出信息在终端进行打印,而是存储在chainx同级目录下的 log/chainx.log, 详情可通过chainx --help 查看 --log* 等相关选项。

1. 启动同步节点

对于同步节点的启动,我们推荐以下配置:

{
    "log": "info,runtime=info",    // 日志等级配置,若不需要runtime的打印可以配置为 "log": "info,runtime=warn",
    "name": "<Your-Node-Name>",    // 在监控台 https://stats.chainx.org 中显示的名称
    "port": 20222,                 // 节点的 p2p 端口
    "ws-port": 8087,               // 节点的 Websocket 端口
    "rpc-port": 8086,              // 节点的 RPC 端口
    "rpc-external": true,          // true 代表该RPC端口开放给外部访问,建议只能提供服务同步节点开启,验证节点及不提供服务的同步节点建议关闭
    "ws-external": true,           // true 代表该RPC端口开放给外部访问,建议只能提供服务同步节点开启,验证节点及不提供服务的同步节点建议关闭
    "base-path": "<Your-DB-Path>", // chainx 数据存放路径
    "other-execution": "NativeElseWasm",
    "syncing-execution": "NativeElseWasm",
    "block-construction-execution": "NativeElseWasm",
    "importing-execution": "NativeElseWasm",
    "pruning": "archive",  // 目前强烈建议加上该配置,以存档模式启动
    "db-cache": 1024,  // 设置节点数据库的缓存,单位MB,即这里为1GB,可根据自己机器配置情况调整
    "state-cache-size": 2147483648, // 设置节点状态树缓存,单位B,即这里为2GB (2GB = 2 * 1024 * 1024),可根据自己机器配置情况调整
    "no-mdns": true,  // 关闭libp2p自动在local network的自动发现
    "bootnodes": [
        // 填写引导节点,ChainX已经内置了一些种子节点,一般无需填写
    ]
}
  • name: 在 telemetry 显示的节点名
  • base-path: 数据存放路径,注意与启动节点步骤1中的相对应

另一方面,对于存储空间大的用户,我们目前强烈建议在上面的json文件里加上

{
    "pruning": "archive",  // 以存档模式启动
}

请注意若使用这个模式启动的节点产生的数据目录,今后必须永远一直有这个参数,不能移除。同理,若启动时没有加这个参数启动的数据目录,今后也永远也不能加这个参数。

这个"pruning": "archive"代表使用存档模式启动节点,会保存全量的状态树,否则,默认情况下将会裁剪256个块之前的状态树。

准备好启动参数的配置文件后,可采用以下命令启动同步节点:(注意,若没有添加--default-log则日志默认输出到log/chainx.log中)

./chainx --config=$(pwd)/config.json

若希望运行在后台,可使用如下命令进行启动:

nohup ./chainx --config=$(pwd)/config.json > error.log 2>&1 &

待同步节点同步到最新高度后,即可参考下一节内容,暂停同步节点并修改同步节点的启动配置文件,添加 validator, validator-name 等参数,再次启动节点进入验证人模式。

2. 启动验证者节点

1. 节点账户公钥生成与注册
  1. 如果还没有账户,请先到钱包 https:://wallet.chainx.org 点击创建账户,生成节点账户,账户地址形如 5HbT8...S9yg
  2. 在钱包投票选举页(新版钱包在资产信托页),点击注册节点,设置 节点名称,比如 NodeABC,注意:该节点名为即后面启动文件要用到的 validator-name 字段。
  3. 在投票选举页的候选节点里,可以看到你的节点处于 退选 状态。此时需要
2. 生成出块公钥

如果还不了解节点账户公钥和出块公钥的区别,请点击这里。以下内容均认为读者已经了解了账户公钥和出块公钥的区别。

ChainX 建议使用 chainx 执行文件通过以下命令生成 keystore,即生成出块地址公钥(session_key):

# 输入密码后即可断开节点
$ ./chainx --keystore-path=<keystore路径> -i --base-path=<数据存放路径> --default-log
Password:
Repeat again:
......
2019-05-15 11:26:50.510 INFO Roles: FULL
######### 下行打印即为节点生成的 keystore 信息,这串公钥即为出块地址公钥(session_key)
2019-05-15 11:26:50.514 INFO Generated a new keypair for keystore: 593a11d6d5930ab2e68fa5d07082ba0102fc7740eee38b79b2793d7d34a2442a (5E5hNNEi...)
......
2019-05-15 11:26:50.610 INFO [runtime|xrml_xdex_spot] [add_trading_pair] currency_pair: CurrencyPair: SDOT/PCX, point_precision: 4, tick_precision: 2, price: 100000, online: true
########## 看到下行打印后即可使用 <Ctrl-C> 断开节点
2019-05-15 11:26:50.624 INFO Initializing Genesis block/state (state: 0x9499…b6c3, header-hash: 0xdb82…e55d)
....

即看到生成keystore的信息后即可停止(ctrl+c或 kill )节点。

上述命令会在指定的 <keystore存放路径> 下生成一个文件名为 节点出块地址公钥 的文件,形如: d41bf5ce34ec4503e633ed0d003356e111186954ce6143d0cfeb6d0a3e51e662,该文件名即为出块地址公钥(sessin_key)。

文件中的内容为这个公钥对应的助记词,请注意该助记词体系与钱包中使用的助记词体系不一样,因此无法将该助记词导入到钱包中生成相同的公钥进行使用。

  • keystore助记词体系为:助记词+密码 ==> 私钥
  • 在线钱包中的助记词体系为:助记词 ==> 私钥

注意要保存好以下信息,启动节点时需要用到这些信息:

  • keystore-path
  • base-path
  • 输入的 password,

(可选)将该节点出块地址公钥(session_key)粘贴到浏览器 https://scan.chainx.org 搜索框获得该公钥对应的地址,该地址将用于更新出块地址。

image

3. 修改启动配置文件启动验证者出块节点

对于验证者节点,我们建议如下配置:

{
  "validator": true, //  验证者节点必须为 true
  "rpc-external": false, // 验证者节点建议关闭对外的rpc端口
  "ws-external": false, // 验证者节点建议关闭对外的ws端口
  "log": "info,runtime=info",
  "port": 20222,
  "ws-port": 8087,
  "rpc-port": 8086,
  "other-execution": "NativeElseWasm",
  "syncing-execution": "NativeElseWasm",
  "block-construction-execution": "NativeElseWasm",
  "pruning": "archive",  // 目前强烈建议加上该配置,以存档模式启动
  "db-cache": 1024,  // 设置节点数据库的缓存,单位MB,即这里为1GB
  "state-cache-size": 2147483648, // 设置节点状态树缓存,单位B,即这里为2GB (2GB = 2 * 1024 * 1024)
  "no-mdns": true, 
  "bootnodes": [],
  "name": "Your-Node-Name",             // 在节点浏览器中显示的节点名
  "validator-name": "Your-Validator-Name", // 注册节点时使用的名称
  "base-path": "<步骤2中指定的数据存放路径>",
  "keystore-path": "<步骤2中指定的keystore路径>",
  "keystore-password": "<步骤2中生成的keystore时使用的密码>"
}

在配置文件中一些关键配置解释:

  • name: 在 telemetry 显示的节点名
  • validator-name: 注册节点时使用的名称,请注意一定要与“验证者公钥生成与注册”步骤中注册的节点名字相同
  • base-path: 数据存放路径,注意与启动节点步骤1中的相对应
  • keystore-path: 启动节点步骤1中指定的keystore路径
  • keystore-password: 启动节点步骤1中输入的 password
  • validator: 如果设置为 true, 则启动验证节点,否则为同步节点。

对于硬盘性能高,且空间大的节点,ChainX同样建议在配置文件中加上"pruning": "archive"模式启动存档模式!(之前没有用存档模式启动的节点忽略这一点)

接下来可以通过命令启动节点:(注意,若没有添加--default-log则日志默认输出到log/chainx.log中)

./chainx --config=$(pwd)/config.json

若希望运行在后台,可使用命令进行启动

nohup ./chainx --config=$(pwd)/config.json > error.log 2>&1 &

启动后请观察日志(默认位于log/chainx.log 中):

2019-05-15 11:37:58.824 INFO load key from keystore. key:<该公钥为keystore的公钥,也就是出块地址公钥(session_key)>
2019-05-15 11:37:58.824 INFO Using authority key <该公钥为keystore的公钥,也就是出块地址公钥(session_key)>

请保证上面日志里的公钥为出块地址公钥(session_key),若不是,会导致后续无法出块

如何更新出块地址

在老版本桌面钱包或者在线钱包投票选举页(新版本的桌面钱包在资产信托页),点击更新节点,在出块地址处填写第一步中得到的出块地址公钥(session_key),注意这里既可以直接填写公钥,也可以填写从(可选)步骤中获取的地址:

image

更新出块地址完成后,验证出块地址与生成的节点公钥是否匹配:

首先进入区块链浏览器的节点详情页面,点击出块地址, 然后会看到该地址对应的公钥,检查是否与出块地址公钥(session_key)相一致。如果一致,则正确,否则出块地址不正确。

image

其他节点运维相关见:ChainX 节点运维

4. 出块节点正常运行后其他工作

确认出块节点成功运行后,如果节点处于退选状态,则需要在投票选举页点击更新节点,使节点进入参选状态:

  • 出块地址
  • 网址
  • 简介
  • 选择“参选”。

请求社区投票至前 30 名,每 60 分钟(1800块的整数倍)会进行一次验证人选举,如果在前 30 名就可以成为验证节点参与出块,如果看到命令行打印 Prepared block for proposing at 6467之类的,就代表在出块了 。

如果由于节点部署不当等导致的节点掉线,系统会在每个分红周期惩罚节点奖池,漏一个块的罚金是出一个块奖励的 3 倍,罚金从节点奖池扣除。如果奖池被惩罚至0,则会自动强制退选,节点需检查部署情况后,再次更新节点至参选状态,等待下一轮换届。

节点参选即可在节点换届时成为候选验证人,但候选验证人资格有最小总投票数限制,目前最小总投票数阈值为10PCX。当验证人正常换届时,如果候选验证人的总得票数小于10PCX时,会将该候选人强制退选,取消验证人候选资格。