跳到主要内容

MTool在线教程

简介#

为了便于节点进行转账,质押,委托以及治理等相关的操作,PlatON提供了MTool来辅助用户:

  • PlatON MTool可支持Ubuntu 18.04和Windows 10,本文档分别描述Windows和Ubuntu环境下的安装和使用,用户可根据自己的资源进行选择。
  • PlatON MTool对质押等交易提供两种签名方式:在线签名和离线签名。此文档描述在线签名操作,离线签名操作请参考离线PlatON MTool教程

安装PlatON MTool#

另外,本文档分别介绍Windows和Ubuntu环境下PlatON MTool的操作,用户可根据自己的资源进行选择。

Windows下安装PlatON MTool#

安装前准备#

执行命令:

platon_mtool --version

如果执行结果显示无法将“platon_mtool”项识别为 cmdlet、函数、脚本文件或可运行程序的名称。请检查名称的拼写,如果包括路径,请确保路径正确,然后再试一次,表示没有安装旧版本不需要执行下面操作。

如果执行结果显示版本号,时间戳等信息表示已安装PlatON MTool,如果PlatON MTool是旧版本,此时需要备份重要信息,然后再手工卸载旧版本,操作步骤:

step1. 备份目录

C:\platon_mtool\mtool\current\keystoreC:\platon_mtool\mtool\current\validator 目录备份到其他目录下(请勿备份到 C:\platon_mtool下)。安装完新版本之后需要将备份目录拷贝回 C:\platon_mtool\mtool\current\ 目录下。 (如果安装目录为自定义目录,则以实际为准)

step2. 卸载旧版本

双击 C:\platon_mtool\unins000.exe 卸载所有旧版本的 PlatON MTool 及其他业务工具。

开始安装#

step1. 下载PlatON MTool安装包

在在线机器上,复制链接https://download.platon.network/platon/mtool/windows/1.1.1/platon_mtool.exe 到浏览器下载PlatON MTool安装包。

step2. 安装PlatON MTool

双击platon_mtool.exe进行安装。默认安装目录为 C:\platon_mtool,建议不要更改此安装目录。弹出界面显示Completing the mtool Setup Wizard信息表示安装成功,点击Finish即可。

step3. 重启终端

安装完成之后,需要重启终端(非重启服务器,关闭Cmd窗口或PowerShell窗口重新打开窗口即可),让新添加的环境变量生效。

Ubuntu下安装PlatON MTool#

安装前准备#

~/platon_mtool/keystore~/platon_mtool/validator 目录备份到其他目录下(请勿备份到 ~/platon_mtool下)。安装完新版本之后需要将备份目录拷贝回 ~/platon_mtool/ 目录下。 (如果安装目录为自定义目录,则以实际为准)

开始安装#

步骤如下:

step1. 下载PlatON MTool工具包

wget https://download.platon.network/platon/mtool/linux/1.1.1/platon_mtool.zip

step2. 解压PlatON MTool工具包

(if ! command -v unzip;then sudo apt install unzip; fi;) && unzip platon_mtool.zip && cd platon_mtool

step3. 下载脚本

脚本下载到platon_mtool 目录下,否则脚本无法找到新版本mtool的路径。

wget https://download.platon.network/platon/scripts/mtool_install.sh

step4. 执行命令

chmod +x mtool_install.sh && ./mtool_install.sh
  • 提示 Install platon mtool succeed. 时,表示 PlatON MTool 安装成功,未安装成功时,请通过我们的社区服务人员联系方式反馈具体问题。

step5. 重新启动会话窗口

安装完成之后,需要重新启动会话窗口(非重启服务器,关闭会话窗口或ssh工具重新打开窗口即可),让新添加的环境变量生效。

PlatON MTool环境变量说明#

Windows和Ubuntu下PlatON MTool目录使用环境变量有所区别:

  • PlatON MTool目录

    • Windows:%PLATON_MTOOLDIR%

    • Ubuntu:$PLATON_MTOOLDIR

说明:用户根据自己安装的系统进行选择环境变量。

PlatON MTool命令详解#

注意:

  • 后续命令是Ubuntu下的命令格式,Windows下需要把$PLATON_MTOOLDIR修改成%PLATON_MTOOLDIR%
  • 如果连接的是开发网,需要修改PlatON MTool安装目录下的config.properties配置文件的chainid为210309。

创建钱包#

  • 执行命令
platon_mtool account new staking
  • 参数说明

staking: 生成的钱包名称,输入两次相同密码之后,创建成功后会在目录$PLATON_MTOOLDIR/keystore下生成钱包文件staking.json,并打印如下信息:

-name: staking-type: NORMAL-address: lat124xmsmd0uf5cvk7v3s36eytqezqsjfcxfw2lmr-public key: 0x9521cd81ba28d5d1c23bb7ddb7042d146375203d35000c0289178027abd4dc09bca30257739df166201e73497485242f41d5f50d46bc3c7e4385f81bde560db0
Important write this Private Key in a safe place.It is the important way to recover your account if you ever forget your password.4630b6d86bc74bffd4ca8cfc18bceec562cb40fc5080c258452a04a69bc1ee07
Important write this mnemonic phrase in a safe place.It is the important way to recover your account if you ever forget your password.worry jewel penalty jealous expect embark outer eternal verb rebuild rice kidney

钱包地址格式调整为Bech32,其中:

lat124xmsmd0uf5cvk7v3s36eytqezqsjfcxfw2lmr:钱包地址;

4630b6d86bc74bffd4ca8cfc18bceec562cb40fc5080c258452a04a69bc1ee07 为钱包私钥;

worry jewel penalty jealous expect embark outer eternal verb rebuild rice kidney 为助记词。

出于安全考虑,用户需对钱包私钥或助记词进行备份(可都进行备份,也可备份其中一个),钱包丢失时,可用于恢复。建议用户将助记词或者私钥备份到安全的存储介质上,如离线机器等。

恢复钱包#

如果钱包文件丢失了,可以通过上述备份的私钥或助记词进行恢复,操作如下:

  • 执行命令

    通过私钥恢复:

    platon_mtool account recover -k staking

    提示输入新的钱包密码和备份的私钥,如下:

    Enter a passphrase to encrypt your key to disk:Repeat the passphrase:Enter your 64bit Private Key:4630b6d86bc74bffd4ca8cfc18bceec562cb40fc5080c258452a04a69bc1ee07

    通过助记词恢复:

    platon_mtool account recover -m staking

    提示输入新的钱包密码和备份的助记词,如下:

    Enter a passphrase to encrypt your key to disk:Repeat the passphrase:Enter your bip39 mnemonic:worry jewel penalty jealous expect embark outer eternal verb rebuild rice kidney
  • 参数说明

    staking:钱包名称。

    恢复成功后会在目录$PLATON_MTOOLDIR/keystore下生成钱包文件staking.json

普通转账操作#

  • 执行命令
platon_mtool tx transfer --keystore $PLATON_MTOOLDIR/keystore/staking.json --amount "1" --recipient $to_address --config $PLATON_MTOOLDIR/validator/validator_config.json
  • 参数说明

keystore:发送转账交易的钱包路径

amount:转账金额,单位:LAT

recipient:接收地址

config:验证节点信息文件路径

查看钱包列表#

  • 执行命令
platon_mtool account list

根据钱包名称查询余额#

  • 执行命令
platon_mtool account balance $keystorename --config $PLATON_MTOOLDIR/validator/validator_config.json
  • 变量说明

$keystorename:钱包文件名称,如staking.json

config:验证节点信息文件路径

根据地址查询余额#

  • 执行命令
platon_mtool account balance -a $address --config $PLATON_MTOOLDIR/validator/validator_config.json
  • 参数

a:钱包地址

config:验证节点信息文件路径

创建新的锁仓计划#

节点可以使用自己钱包内的资金,创建新的锁仓计划。在创建新的锁仓计划前,先要创建一个格式为json的锁仓计划描述文件。

  • 锁仓计划描述文件,retricting_plans.json
{  "account":"lat12jn6835z96ez93flwezrwu4xpv8e4zathsyxdn",  "plans":[    {"epoch": 5000,"amount": 100},    {"epoch": 6000,"amount": 100},    {"epoch": 7000,"amount": 100}  ]}

account:指锁仓资金的释放目标地址

epoch:释放等待的结算周期数量(大于等于1)

amount:释放资金,单位:LAT

  • 执行命令
platon_mtool create_restricting --config $PLATON_MTOOLDIR/validator/validator_config.json --keystore $PLATON_MTOOLDIR/keystore/staking.json --file ./restricting_plans.json
  • 参数说明,

config:验证节点信息文件路径

keystore:发送交易的冷钱包路径

file: 锁仓计划描述文件

发起质押操作#

如果共识节点部署完成,并且已经同步区块成功,您就可以使用PlatON MTool进行质押操作。质押资金申请完成后,确保质押账户余额足够,根据用户情况替换质押金额,质押最低门槛为10万LAT。

注意:请保持质押账户里面有足够LAT,以备后续发起节点管理的交易有足够的交易手续费,比如升级提案的投票,解质押等交易。

  • 执行命令
platon_mtool staking --config $PLATON_MTOOLDIR/validator/validator_config.json --keystore $PLATON_MTOOLDIR/keystore/staking.json --amount 100000 --benefit_address xxx196278ns22j23awdfj9f2d4vz0pedld8a2fzwwj --delegated_reward_rate 5000 --node_name myNode --website www.mywebsite.com --details myNodeDescription --external_id 121412312

提示:please input keystore password: 输入质押钱包的密码,然后回车,如果显示如下信息则代表质押成功:

operation finishedtransaction hash:0x89b964d27d0caf1d8bf268f721eb123c4af57aed36187bea90b262f4769eeb9bSUCCESS
  • 参数说明

config:验证节点信息文件路径

keystore:发送交易的冷钱包路径

amount: 质押数,不少于100000LAT-质押门槛,小数点不超过8位(使用自由金额质押)

restrictedamount: 不少于100000LAT-质押门槛,小数点不超过8位(使用锁仓余额质押)

autoamount:不少于100000LAT-优先使用锁仓余额质押,若锁仓余额不足质押金,再使用自由金额质押

benefit_address:验证节点收益地址

delegated_reward_rate:委托奖励比例,单位:万分比,整数,范围[0,10000],如输入5000,表示分红比例为50%

node_name:验证人名称,不超过30字节,支持字母、数字、空格、上下划线及#,必须字母开头

website:官网路径,不超过70字节,数字字母组成

details:简介,验证人简要介绍说明,不超过280字节

external_id:节点头像icon在keybase.io的ID,或者外部系统身份认证ID

修改验证人信息操作#

  • 执行命令
platon_mtool update_validator --config $PLATON_MTOOLDIR/validator/validator_config.json --keystore $PLATON_MTOOLDIR/keystore/staking.json --node_name myNode --website www.mywebsite.com --external_id 121412312 --delegated_reward_rate 6000 --benefit_address lat1x0f9xwr9steccekttqvml0d26zgsxwdnhq3fkv --details "Modify the verifier information operation"
  • 参数说明

config:验证节点信息文件路径

keystore:发送交易的冷钱包路径

node_name[可选]:验证人名称,不超过30字节,支持字母、数字、空格、上下划线及#,必须字母开头

website[可选]:官网路径,不超过70字节,数字字母组成

external_id[可选]:节点头像icon在keybase.io的ID,或者外部系统身份认证ID

delegated_reward_rate[可选]:委托奖励比例,单位:万分比,整数,范围[0,10000],如输入5000,表示分红比例为50%

benefit_address[可选]:验证节点收益地址,42字符(字母数字)

details[可选]:简介,验证人简要介绍说明,不超过280字节

解质押操作#

解质押需要168个结算周期才能退出完成,请谨慎操作!

  • 执行命令
platon_mtool unstaking --keystore $PLATON_MTOOLDIR/keystore/staking.json --config $PLATON_MTOOLDIR/validator/validator_config.json
  • 参数说明

keystore:发送交易的冷钱包路径

config:验证节点信息文件路径

增加质押操作#

  • 执行命令
platon_mtool increasestaking --amount 5000000 --keystore $PLATON_MTOOLDIR/keystore/staking.json --config $PLATON_MTOOLDIR/validator/validator_config.json
  • 参数说明

amount:用账户余额来增加质押量(LAT),不少于10最小增加值,小数点不超过8位

restrictedamount: 用账户锁仓余额来增加质押量,不少于10质押门槛,小数点不超过8位(使用锁仓余额质押)

keystore:发送交易的冷钱包路径

config:验证节点信息文件路径

提交文本提案操作#

  • 执行命令
platon_mtool submit_textproposal --pid_id 100 --keystore $PLATON_MTOOLDIR/keystore/staking.json --config $PLATON_MTOOLDIR/validator/validator_config.json
  • 参数说明

pid_id:GitHub ID

keystore:发送交易的冷钱包路径

config:验证节点信息文件路径

提交升级提案操作#

  • 执行命令
platon_mtool submit_versionproposal --newversion 1.0.0 --end_voting_rounds 345 --pid_id 100 --keystore $PLATON_MTOOLDIR/keystore/staking.json --config $PLATON_MTOOLDIR/validator/validator_config.json
  • 参数说明

newversion:目标升级版本,x.x.x,数字加标点

end_voting_rounds:投票共识轮数,投票共识轮数N,必须满足0 < N <= 4838(约为2周)

pid_id:GitHub ID

keystore:发送交易的冷钱包路径

config:验证节点信息文件路径

提交取消提案操作#

  • 执行命令
platon_mtool submit_cancelproposal --proposalid 0x444c3df404bc1ce4d869166623514b370046cd37cdfa6e932971bc2f98afd1a6 --end_voting_rounds 12 --pid_id 100 --keystore $PLATON_MTOOLDIR/keystore/staking.json --config $PLATON_MTOOLDIR/validator/validator_config.json
  • 参数说明

proposalid:需要被取消的提案ID,即发起提案交易的hash,66字符,字母数字组成

end_voting_rounds:投票共识轮数,投票共识轮数N,必须满足0 < N <= 4838(约为2周)

pid_id:GitHub ID

keystore:发送交易的冷钱包路径

config:验证节点信息文件路径

文本提案投票操作#

  • 执行命令
platon_mtool vote_textproposal --proposalid 0x444c3df404bc1ce4d869166623514b370046cd37cdfa6e932971bc2f98afd1a6 --opinion yes --keystore $PLATON_MTOOLDIR/keystore/staking.json --config $PLATON_MTOOLDIR/validator/validator_config.json
  • 参数说明

proposalid:文本提案ID,即发起提案交易的hash,66字符,字母数字组成

opinion:投票选项,yes、no、abstain-三选一

keystore:发送交易的冷钱包路径

config:验证节点信息文件路径

升级提案投票操作#

  • 执行命令
platon_mtool vote_versionproposal --proposalid 0x444c3df404bc1ce4d869166623514b370046cd37cdfa6e932971bc2f98afd1a6 --keystore $PLATON_MTOOLDIR/keystore/staking.json --config $PLATON_MTOOLDIR/validator/validator_config.json
  • 参数说明

proposalid:升级提案ID,即发起提案交易的hash,66字符,字母数字组成

keystore:发送交易的冷钱包路径

config:验证节点信息文件路径

取消提案投票操作#

  • 执行命令
platon_mtool vote_cancelproposal --proposalid 0x444c3df404bc1ce4d869166623514b370046cd37cdfa6e932971bc2f98afd1a6 --opinion yes --keystore $PLATON_MTOOLDIR/keystore/staking.json --config $PLATON_MTOOLDIR/validator/validator_config.json
  • 参数说明

proposalid:取消提案ID,即发起提案交易的hash,66字符,字母数字组成

opinion:投票选项,yes、no、abstain-三选一

keystore:发送交易的冷钱包路径

config:验证节点信息文件路径

提交参数提案操作#

  • 执行命令
platon_mtool submit_paramproposal --pid_id 200 --module $module --paramname $paramname --paramvalue $paramvalue --keystore $PLATON_MTOOLDIR/keystore/staking.json --config $PLATON_MTOOLDIR/validator/validator_config.json
  • 参数说明

module:治理模块参数

paramname:治理模块参数名,注意字母大小写

paramvalue:治理模块参数值

pid_id:GitHub ID

keystore:发送交易的冷钱包路径

config:验证节点信息文件路径

参数提案投票操作#

  • 执行命令
platon_mtool  vote_paramproposal --proposalid 0x444c3df404bc1ce4d869166623514b370046cd37cdfa6e932971bc2f98afd1a6 --opinion yes --keystore $PLATON_MTOOLDIR/keystore/staking.json --config $PLATON_MTOOLDIR/validator/validator_config.json
  • 参数说明

proposalid:取消提案ID,即发起提案交易的hash,66字符,字母数字组成

opinion:投票选项,yes、no、abstain-三选一

keystore:发送交易的冷钱包路径

config:验证节点信息文件路径

版本声明操作#

  • 执行命令
platon_mtool declare_version --keystore $PLATON_MTOOLDIR/keystore/staking.json --config $PLATON_MTOOLDIR/validator/validator_config.json
  • 参数说明

keystore:发送交易的冷钱包路径

config:验证节点信息文件路径

查看帮助#

  • 执行命令
platon_mtool -h
  • 参数说明