diff --git a/website/docs/Become_Validator.md b/website/docs/Become_Validator.md deleted file mode 100644 index d94a5b82f..000000000 --- a/website/docs/Become_Validator.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -id: Become_Validator -title: Staking -sidebar_label: Staking ---- - - - -This document will describe how to become a validator through staking after the node is deployed. - -## Overview - -Alaya is a blockchain project that implements democratic governance. Validator nodes are jointly selected by all ATP holders to maintain and develop the Alaya network. The 101 nodes with the most votes will become candidate nodes, from which 25 validator nodes will be randomly selected using VRF to participate in the management of the entire Alaya network. - -This section describes how to operate as a validator node. - -## Preparation - -Before becoming a validator, make sure that the server has the following conditions: - -- The Alaya node has been installed and synchronized according to the instructions of [Installing a Node](/alaya-devdocs/en/Run_a_fullnode/) - -## Configure Nginx - -For security reasons, it is not recommended to open the rpc port of the node directly (the node server defaults to Ubuntu 18.04). You can consider using Nginx for reverse proxy, and strengthen the security of Nginx ports through user authentication and HTTPS. If the user changes the node data directory when installing Alaya, the nginx_conf.sh script also needs to be modified to the same node data directory. - -### Switch to normal user - -- View current user - - ```shell - whoami - ``` - - > If it is displayed as a `root` user, you need to switch to a normal user. - -- Switch to normal user - - ```shell - su user - ``` - - > `user`: Indicates a normal user name, please modify it according to the actual user name. - -### Download nginx_conf.sh - -```bash -wget https://download.alaya.network/alaya/scripts/nginx_conf.sh -``` - -### Execute the script - -```bash -chmod +x nginx_conf.sh && ./nginx_conf.sh -``` - -> **Notes** -> -> - When the prompt shows `[sudo] password for`, enter the password of the current account. -> - When the prompt shows `Enter your name:`, enter the user name; when the prompt shows `Enter your password:`, enter the password. Be sure to keep in mind the user name and password (it is recommended not to include spaces in the password), and you will need to fill in the information in subsequent MTool configuration of validator information. -> - When the prompt shows `nginx conf succeed`, it means that nginx has been successfully configured. If not, please feed back specific problems to our customer service. - -## Install MTool - -Proceed as follows: - -**Step1. Download MTool Toolkit** - -```bash -wget http://download.alaya.network/alaya/mtool/linux/0.16.2/alaya_mtool.zip -``` - -**Step2. Unzip the MTool toolkit** - -```bash -(if ! command -v unzip;then sudo apt install unzip; fi;) && unzip alaya_mtool.zip && cd alaya_mtool -``` - -**Step3. Download script** - -> The script is downloaded to the mtool-client directory, otherwise the script cannot find the path of the new version of mtool. - -```bash -wget https://download.alaya.network/alaya/scripts/mtool_install.sh -``` - -**Step4. Execute the command to install Mtool** - -```bash -chmod +x mtool_install.sh && ./mtool_install.sh -``` - -> - When the prompt shows Install mtool succeed, it means that MTool has been successfully installed. If not, please feed back specific problems to our official customer service. - -**Step5. Restart the session window** - -After the installation is complete, you need to restart the session window to make the newly added environment variables take effect. - - - -## Configure MTool - -### Generate wallet - -In Alaya, two wallets are created for staking as a validator to generate blocks. If you already have a wallet, you can skip this step by copying the wallet file to the `$ALAYA_MTOOLDIR/keystore` directory. - -- Staking wallet: The staking wallet is used to stake tokens. Only after the staking is successful can a node becomes an alternative validator candidate. Run the following command to create a staking wallet: - -```bash -alaya_mtool account new staking -``` - -Enter the password once and enter it again for confirmation to create a wallet file. After the wallet file is created, a staking wallet file `staking.json` will be generated in the directory `$ALAYA_MTOOLDIR/keystore`. - -- Reward wallet: It is used to collect block rewards and staking rewards. Staking rewards are uniformly distributed to validators, which are distributed by the validators themselves. Run the following command to create a reward wallet: - -```bash -alaya_mtool account new reward -``` - -Enter the password once and enter it again for confirmation to create a wallet file. After the wallet file is created, a staking wallet file `staking.json` will be generated in the directory `$ALAYA_MTOOLDIR/keystore`. - - - -### Configure validator information - -#### Download the script - -```bash -cd $ALAYA_MTOOLDIR && wget https://download.alaya.network/alaya/scripts/validator_conf.sh -``` - -#### Run the script configuration - -```bash -$ chmod +x validator_conf.sh && ./validator_conf.sh -``` - -> **Notes:** -> -> - When the prompt shows "Please enter the platon node IP address:", please enter the Alaya node server ip address. -> - When the prompt shows "Enter your name:", please enter the username when configuring Alaya node nginx. -> - When the prompt shows "Enter your password:", please enter the password when configuring Alaya node nginx. -> - When the prompt shows "validator conf success", and when the validator_config.json content printed at the end is normal, it means that the script is executed successfully. If the script is not executed successfully, please contact our official customer service to feed back specific questions or use the non-http configuration below. - -#### Description of validator information configuration file - -After the validator information is configured, the validator information file validator_config.json will be generated in the validator subdirectory of the MTool installation directory. The file content is as follows: - -```json -{ - "nodePublicKey": "0abaf3219f454f3d07b6cbcf3c10b6b4ccf605202868e2043b6f5db12b745df0604ef01ef4cb523adc6d9e14b83a76dd09f862e3fe77205d8ac83df707969b47", - "blsPubKey": "82d740cbc0314ec558c5426f88fdad6f07a07f9846c6be4e40cd628b74b9f641ddad01e4c281a2c3693f8ff2a73a410297aff379ee0575127d51de99b97acc9a1b7bc8ca132ef6f0379a3ec9d76a603d623176e49e1c53e87fead36317895099", - "nodeAddress": "https://dd:dolphin2@domain3", - "nodePort": "16789", - "nodeRpcPort": "443", - "certificate": "/home/dolphintwo/mtool-client/ca.crt" -} -``` - -> If you don’t need https encryption for intranet access, you don’t need to perform the two operations of configuring Nginx or configuring validator information, and write manually in the `$ALAYA_MTOOLDIR/validator/validator_config.json` file (the content of the file can be modified according to the actual situation). - -``` -{ - "nodePublicKey": "Content in platon-node/data/nodeid", - "blsPubKey": "Content in platon-node/data/blspub", - "nodeAddress": "http://127.0.0.1 or other IP address of this machine", - "nodePort": "16789", - "nodeRpcPort": "6789", -} -``` - - - -> **Parameter description:** -> -> - nodePublicKey: Node ID, which can be viewed in the nodeid file under the node data directory data. -> - blsPubKey: BLS public key, which can be viewed in the blspub file under the node data directory data. -> - nodeAddress: The node address is divided into two cases: using Nginx and not using Nginx: -> - If you use Nginx, you need to use **https** protocol whose format is: `https://test:test@domain3`. Domain3 points to the IP address filled in when `validator_conf.sh` is executed in the hosts file. -> - If you do not use Nginx, you need to use the **http** protocol. If MTool and the node are on the same machine or in the same local area network, you can use the intranet IP, otherwise use the public IP whose format is: `http://18.238.183.12`. -> - nodePort: Node P2P port. The default is 16789. -> - nodeRpcPort: The node address is divided into two cases: using Nginx and not using Nginx: -> - If Nginx is used, the default port is 443. -> - If Nginx is not used, the default port is 6789. -> - certificate: ca certificate address, which can be deleted if Nginx reverse proxy is not used. - -## Custom AlayaScan avatar - -If users do not need to display their specified avatar on AlayaScan, they can skip this step. Otherwise, the following operations are required: - -- **Register a keybase account** - - Users first need to register on the official website of [keybase.io](https://keybase.io/) . If they have already registered, they can log on the official website of keybase. - -- **Upload specified avatar** - - Click the user avatar to upload the avatar. - -- **Generate PGP key** - - If the user has a `PGP key`, after a successful login, a series of 16-bit public keys will be displayed next to the user's avatar, such as: `EB621920A48D0699`; if the user does not have a `PGP key`, click `add a PGP key` next to the user's avatar to generate. - -- **Specify the externalId value** - - When initiating the staking operation, specify the `--external_id` parameter to be the `PGP key` generated in the previous step. - -> Tip: After the user completes the staking, the avatar customized by the user can be displayed on AlayaScan. - - - -## Initiate a staking operation - -If the consensus node is deployed and is catching up the block height of [AlayaScan](https://scan.alaya.network/), you can use MTool for staking. Please ensure that the balance of the staking account is sufficient before staking. The minimum threshold for staking is 10,000 ATP. - -Please do not stake all the ATP of the staking account. Keep at least 1 ATP for the payment of the transaction fees for initiating node management, such as voting for upgrade proposals, unstaking and other transactions. - -Excuting command - -```bash -alaya_mtool staking --config $ALAYA_MTOOLDIR/validator/validator_config.json --keystore $ALAYA_MTOOLDIR/keystore/staking.json --amount 10000 --benefit_address xxx196278ns22j23awdfj9f2d4vz0pedld8a2fzwwj --delegated_reward_rate 8500 --node_name myNode --website www.mywebsite.com --details myNodeDescription --external_id 121412312 -``` - -Enter the password of the staking wallet and press Enter. If the following information is displayed, the staking is successful: - -```bash -operation finished -transaction hash: -0x89b964d27d0caf1d8bf268f721eb123c4af57aed36187bea90b262f4769eeb9b -SUCCESS -``` - -> **Parameter description:** -> -> - config: The path of the validator information file. -> - keystore: The path of the cold wallet for sending transactions. -> - amount: Staking amount, not less than the staking threshold of 10,000 ATP, no more than 8 decimal places (unlocked balance is staked). -> - restrictedamount: Not less than the staking threshold of 10,000 ATP, no more than 8 decimal places (lock-up balance is staked). -> - autoamount: Not less than 10,000 ATP — The lock-up balance will be staked first; if the lock-up balance is not enough, then the unlocked balance will be staked. -> - benefit_address: The account to receive staking reward. -> - delegated_reward_rate: The proportion of delegation reward, unit: per ten thousand, integer, range \[0,10000]. For example, enter 8,500, and it means that the reward rate is 85%, and the node income is 15%. -> - node_name: Validator name, no more than 30 bytes, beginning with a letter, including letters, numbers, space, -, _, and #). -> - website: Official website path, no more than 70 bytes, composed of numbers and letters. -> - details: A brief introduction of the validator, no more than 280 bytes. English is recommended. -> - external_id: The ID of the node avatar icon in keybase.io, or the ID of external system authentication. diff --git a/website/i18n/zh-CN/docusaurus-plugin-content-docs/current/Become_Validator.md b/website/i18n/zh-CN/docusaurus-plugin-content-docs/current/Become_Validator.md deleted file mode 100644 index 5ac6cbe68..000000000 --- a/website/i18n/zh-CN/docusaurus-plugin-content-docs/current/Become_Validator.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -id: Become_Validator -title: 成为验证节点 -sidebar_label: 成为验证节点 ---- -本文档将描述如何在部署完节点之后，通过质押成为验证节点的过程。 - -## 准备 - -在成为验证节点前请确保服务器本地具备以下条件： - -- 已经按照[全节点部署](/alaya-devdocs/zh-CN/Run_a_fullnode)指引安装好 Alaya 节点并同步完成。 - -## 配置 Nginx - -出于安全考虑，不建议节点 rpc 端口对外直接开放（节点服务器默认 Ubuntu 18.04）。可以考虑使用 Nginx 进行反向代理，并通过用户鉴权和 HTTPS 加强 Nginx 端口的安全性。如果用户在安装 Alaya 做了节点数据目录的修改，nginx_conf.sh 脚本也需要修改成相同的节点数据目录。 - -> 以下使用普通用户执行 - -```bash -# 下载 nginx_conf.sh -wget https://download.alaya.network/alaya/scripts/nginx_conf.sh - -# 执行脚本 -chmod +x nginx_conf.sh && ./nginx_conf.sh -``` - -> 注意 -> -> - 提示 `[sudo] password for` 时，输入当前账户密码。 -> - 提示 `Enter your name:` 时，输入用户名，提示 `Enter your password:` 时，输入密码。务必牢记用户名和密码（密码中建议不要包含空格），后续 MTool 配置验证节点信息时需要填写。 -> - 提示 `nginx conf succeed` 时，表示配置 nginx 成功，未配置成功时，请通过我们的客服联系方式反馈具体问题。 - -## 安装 MTool - -```bash -# 下载MTool工具包 -wget http://download.alaya.network/alaya/mtool/linux/0.16.2/alaya_mtool.zip - -# 解压MTool工具包 -(if ! command -v unzip;then sudo apt install unzip; fi;) && unzip alaya_mtool.zip && cd alaya_mtool - -# 下载脚本，脚本下载到mtool-client目录下，否则脚本无法找到新版本 mtool 的路径。 -wget https://download.alaya.network/alaya/scripts/mtool_install.sh - -# 执行命令安装Mtool -chmod +x mtool_install.sh && ./mtool_install.sh - -# 提示 Install mtool succeed. 时，表示 MTool 安装成功，未安装成功时，请通过我们的官方客服联系方式反馈具体问题。 -``` - -安装完成之后，需要重新启动会话窗口，让新添加的环境变量生效。 - -## 配置 MTool - -### 创建钱包 - -Alaya 中，参与验证节点进行出块要创建两个钱包。如果已经有钱包，可通过将钱包文件拷贝到`$ALAYA_MTOOLDIR/keystore`目录下，跳过本步骤。 - -- 质押钱包：质押钱包用于质押 token，质押成功后才能成为备选节点候选人。 运行以下命令创建质押钱包 - -```bash -alaya_mtool account new staking -``` - -输入一次密码，再输入一次确认密码，即可创建钱包文件，创建成功后会在目录`$ALAYA_MTOOLDIR/keystore`下生成质押钱包文件`staking.json`。 - -- 收益钱包：用于收取区块奖励和 Staking 奖励，Staking 奖励统一发放给验证节点，由验证节点自行分配。 运行以下命令创建收益钱包 - -```bash -alaya_mtool account new reward -``` - -输入一次密码，再输入一次确认密码，即可创建钱包文件，创建成功后会在目录`$ALAYA_MTOOLDIR/keystore`下生成质押钱包文件`reward.json`。 - -### 配置验证节点信息 - -```bash -# 下载脚本 -cd $ALAYA_MTOOLDIR && wget https://download.alaya.network/alaya/scripts/validator_conf.sh - -# 运行脚本进行配置 -chmod +x validator_conf.sh && ./validator_conf.sh -``` - -> **注意：** -> -> - 提示 Please enter the platon node IP address: 时，请输入 Alaya 节点服务器 ip 地址。 -> - 提示 Enter your name: 时，请输入配置 Alaya 节点 nginx 时输入的用户名。 -> - 提示 Enter your password: 时，请输入配置 Alaya 节点 nginx 时输入的密码。 -> - 提示 validator conf success，并最后打印出的 validator_config.json 内容正常时，表示脚本执行成功，未执行成功时，请通过我们的官方客服联系方式反馈具体问题或使用下方的非http配置。 - -#### 验证节点信息配置文件说明 - -完成配置验证节点信息后，会在 MTool 的安装目录的 validator 子目录下，生成验证节点信息文件 validator_config.json，文件内容如下： - -> 以下为使用nginx的https访问的示例文件： - -```json -{ - "nodePublicKey": "0abaf3219f454f3d07b6cbcf3c10b6b4ccf605202868e2043b6f5db12b745df0604ef01ef4cb523adc6d9e14b83a76dd09f862e3fe77205d8ac83df707969b47", - "blsPubKey": "82d740cbc0314ec558c5426f88fdad6f07a07f9846c6be4e40cd628b74b9f641ddad01e4c281a2c3693f8ff2a73a410297aff379ee0575127d51de99b97acc9a1b7bc8ca132ef6f0379a3ec9d76a603d623176e49e1c53e87fead36317895099", - "nodeAddress": "https://dd:dolphin2@domain3", - "nodePort": "16789", - "nodeRpcPort": "443", - "certificate": "/home/dolphintwo/mtool-client/ca.crt" -} -``` - -> 如果在内网访问不需要https加密，可以不执行配置 Nginx和配置验证节点信息两个操作，手动写入`$ALAYA_MTOOLDIR/validator/validator_config.json`文件(文件内容按实际情况自行修改)。 - -```json -{ - "nodePublicKey": "alaya-node/data/nodeid 中的内容", - "blsPubKey": "alaya-node/data/blspub 中的内容", - "nodeAddress": "http://127.0.0.1 或本机其他IP地址", - "nodePort": "16789", - "nodeRpcPort": "6789", -} -``` - -> **参数说明：** -> -> - nodePublicKey: 节点 ID，可通过节点数据目录 data 下的 nodeid 文件查看； -> - blsPubKey: BLS 公钥，可通过节点数据目录 data 下的 blspub 文件查看； -> - nodeAddress: 节点地址，分使用 Nginx 和不使用 Nginx 两种情况: -> - 如果使用 Nginx，需要用 **https** 协议，格式为：`https://test:test@domain3`，domain3在hosts文件中指向`validator_conf.sh`执行时填写的IP地址。 -> - 如果不使用 Nginx，需要用 **http** 协议，如果 MTool 和节点在同一台机器或同一个局域网内，可以使用内网 IP，否则使用公网 IP，格式为：`http://18.238.183.12`。 -> - nodePort: 节点 P2P 端口，默认为 16789。 -> - nodeRpcPort: 分使用 Nginx 和不使用 Nginx 两种情况: -> - 如果使用了 Nginx，端口默认为 443。 -> - 如果不使用 Nginx，端口默认为 6789。 -> - certificate: ca 证书地址，如果不使用 Nginx 反向代理，可删除此参数。 - -## 自定义 AlayaScan 头像 - -如果用户不需要在 AlayaScan 显示自己指定的头像，可以忽略此步骤。否则需要如下操作： - -- **注册 keybase 账户** - - 用户首先需要在 [keybase.io](https://keybase.io/) 官网进行注册，如果已注册可登录 keybase 官网。 - -- **上传指定头像** - - 点击用户头像，即可上传头像。 - -- **生成 PGP key** - - 如果用户有`PGP key`，登录成功后，会在用户头像旁边显示一串 16 位的公钥，如：`EB621920A48D0699` ；如果用户还没有`PGP key` ，可以点击用户头像旁边的`add a PGP key`即可生成。 - -- **指定 externalId 值** - - 发起质押操作时，指定`--external_id`参数值为上一步生成的`PGP key`。 - -> 提示：用户完成质押操作后，即可在 AlayaScan 上显示用户自定义的头像。 - -## 发起质押操作 - -如果共识节点部署完成，并且节点已经追上 [AlayaScan](https://scan.alaya.network/) 网站上的块高，您就可以使用 MTool 进行质押操作。质押操作前请确确保质押账户余额足够，质押最低门槛为 1 万 ATP。 - -- 请不要将质押账户的所有 ATP 进行质押，至少保留 1 个 ATP，以备支付后续发起节点管理的交易手续费，比如升级提案的投票，解质押等交易。 - -执行命令 - -```bash -alaya_mtool staking --config $ALAYA_MTOOLDIR/validator/validator_config.json --keystore $ALAYA_MTOOLDIR/keystore/staking.json --amount 10000 --benefit_address xxx196278ns22j23awdfj9f2d4vz0pedld8a2fzwwj --delegated_reward_rate 8500 --node_name myNode --website www.mywebsite.com --details myNodeDescription --external_id 121412312 -``` - -提示：**please input keystore password:** 输入质押钱包的密码，然后回车，如果显示如下信息则代表质押成功： - -```bash -operation finished -transaction hash: -0x89b964d27d0caf1d8bf268f721eb123c4af57aed36187bea90b262f4769eeb9b -SUCCESS -``` - -> **参数说明：** -> -> - config：验证节点信息文件路径 -> - keystore：发送交易的冷钱包路径 -> - amount: 质押数，不少于 10000ATP-质押门槛，小数点不超过 8 位（使用自由金额质押） -> - restrictedamount: 不少于 10000ATP-质押门槛，小数点不超过 8 位（使用锁仓余额质押） -> - autoamount：不少于 10000ATP-优先使用锁仓余额质押，若锁仓余额不足质押金，再使用自由金额质押 -> - benefit_address：验证节点收益地址 -> - delegated_reward_rate：委托奖励比例，单位：万分比，整数，范围\[0,10000]，如输入 8500，表示分红比例为 85%，节点收益15% -> - node_name：验证人名称，不超过 30 字节，支持字母、数字、空格、上下划线及#，必须字母开头 -> - website：官网路径，不超过 70 字节，数字字母组成 -> - details：简介，验证人简要介绍说明，不超过 280 字节，建议英文 -> - external_id：节点头像 icon 在 keybase.io 的 ID，或者外部系统身份认证 ID diff --git a/website/sidebars.js b/website/sidebars.js index e41a18ada..736eb2d1c 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -23,7 +23,6 @@ module.exports = { items: [ 'Intro_to_validator', 'Run_a_fullnode', - 'Become_Validator', 'Data_snapshot', { type: 'category',