From 57ff7d59a08ea6565fe85036df99c251b8718a38 Mon Sep 17 00:00:00 2001 From: Kay Date: Mon, 6 May 2024 13:51:38 +0330 Subject: [PATCH] Adding testnet node/wallet guide (#226) * Adding testnet node/wallet guide * Fix wrong file names * Fix missing key on en.yml * Fix missing keys for ar.yml and zh.yml * Fix missing files * Fix md rules * Fix requested changes --- website/_i18n/ar.yml | 1 + .../ar/user-guides/pactus-testnet/index.md | 3 + website/_i18n/en.yml | 1 + .../en/user-guides/pactus-testnet/index.md | 99 +++++++++++++++++++ website/_i18n/zh.yml | 1 + .../zh/user-guides/pactus-testnet/index.md | 3 + website/user-guides/pactus-testnet/index.md | 8 ++ 7 files changed, 116 insertions(+) create mode 100644 website/_i18n/ar/user-guides/pactus-testnet/index.md create mode 100644 website/_i18n/en/user-guides/pactus-testnet/index.md create mode 100644 website/_i18n/zh/user-guides/pactus-testnet/index.md create mode 100644 website/user-guides/pactus-testnet/index.md diff --git a/website/_i18n/ar.yml b/website/_i18n/ar.yml index d9e46b148..e9f737c67 100644 --- a/website/_i18n/ar.yml +++ b/website/_i18n/ar.yml @@ -450,6 +450,7 @@ dict: run_pactus_docker: كيفية تشغيل بكتوس باستخدام دوكر؟ send_transactions_gui: كيفية إرسال المعاملات في الوضع الرسومي؟ use_wallet_cli: كيفية استخدام المحفظة في وضع سطر الأوامر؟ + pactus_testnet: كيفية الاستخدام والتفاعل مع Pactus Testnet (Phoenix)؟ reduce_network: How to reduce the network usage? run_pactus_metrics: How to run Pactus Metrics? grpc-sign-transactions: How to sign transaction using gRPC? diff --git a/website/_i18n/ar/user-guides/pactus-testnet/index.md b/website/_i18n/ar/user-guides/pactus-testnet/index.md new file mode 100644 index 000000000..12cf220f6 --- /dev/null +++ b/website/_i18n/ar/user-guides/pactus-testnet/index.md @@ -0,0 +1,3 @@ +--- +version: 2 +--- diff --git a/website/_i18n/en.yml b/website/_i18n/en.yml index 467251f05..341d7ae18 100644 --- a/website/_i18n/en.yml +++ b/website/_i18n/en.yml @@ -450,6 +450,7 @@ dict: run_pactus_docker: How to run Pactus using Docker? send_transactions_gui: How to send transactions in Graphic Mode? use_wallet_cli: How to use wallet in Command Line Mode? + pactus_testnet: How to use and interact with Pactus Testnet (Phoenix)? reduce_network: How to reduce the network usage? run_pactus_metrics: How to run Pactus Metrics? grpc-sign-transactions: How to sign transaction using gRPC? diff --git a/website/_i18n/en/user-guides/pactus-testnet/index.md b/website/_i18n/en/user-guides/pactus-testnet/index.md new file mode 100644 index 000000000..f9ecbe4e0 --- /dev/null +++ b/website/_i18n/en/user-guides/pactus-testnet/index.md @@ -0,0 +1,99 @@ +--- +version: 8 +--- + +## Preface + +Pactus Blockchain has introduced a Test network called Phoenix for developers and users to test their +software utilizing Pactus technology. This guide will demonstrate how to connect and interact with +Phoenix using official Pactus software designed for the main network. + +## Download + +To get started, download and extract the Pactus software +[here]({{ site.baseurl }}/download). +Once you have downloaded and extracted the Pactus software file, you can proceed to the next step. + +--- + +## Phoenix Network + +Pactus offers three distinct genesis block types for mainnet, testnet, and localnet +(used for developing a dev environment). The genesis type is defined within your Pactus working +directory and wallet file once it has been created or initialized. Subsequent commands will +automatically determine the network type based on this information, eliminating the need to specify +the network being used. + +## CLI Softwares + +To interact with phoenix using wallet, daemon CLI, there is a flag called `--testnet` provided on +all CLI softwares. + +{% tabs create_wallet ltr %} + +{% tab create_wallet linux-mac Linux / macOS %} + +```text +./pactus-wallet create --testnet +./pactus-daemon init --testnet +``` + +{% endtab %} + +{% tab create_wallet windows Windows %} + +```text +pactus-wallet.exe create --testnet +pactus-daemon.exe init --testnet +``` + +{% endtab %} + +{% endtabs %} + +You can use this flag for recover command as well. + +{% alert_start info %} +Wallet Address +

+Pactus addresses have pc HRP on Mainnet and a tpc HRP on testnet. +Addresses with pc prefix are invalid on Testnet. +on testnet. +

+You can check pip-8 for more details on Pactus address. +{% alert_end %} + +## GUI Node and Wallet + +Pactus also offers a GUI to run a node, if you want to use GUI as a testnet node you have to run it +with the same flag in your terminal. + +{% tabs gui_node ltr %} + +{% tab gui_node linux-mac Linux / macOS %} + +```text +./pactus-gui --testnet +``` + +{% endtab %} + +{% tab gui_node windows Windows %} + +```text +pactus-gui.exe --testnet +``` + +{% endtab %} + +{% endtabs %} + +## Notes + +As it's mentioned, the rest of work will be handled by the software which read the network type from +wallet file and working directory. the rest of the commands and instructions can be found in mainnet +docs. + +When you make multiple wallets and nodes, you may get conflicts with old wallet file or working +directories. +You have to specify a new path for them using `--path` flag or just remove the old one. diff --git a/website/_i18n/zh.yml b/website/_i18n/zh.yml index f50d78d4a..7f2c307d5 100644 --- a/website/_i18n/zh.yml +++ b/website/_i18n/zh.yml @@ -419,6 +419,7 @@ dict: run_pactus_docker: 如何使用Docker运行帕图斯？ send_transactions_gui: 如何在图形模式下发送交易？ use_wallet_cli: 如何在命令行模式下使用钱包？ + pactus_testnet: 如何使用 Pactus 测试网（Phoenix）并与之交互？ reduce_network: 如何减少网络使用量？ run_pactus_metrics: 如何运行Pactus Metrics指标？ grpc-sign-transactions: 如何使用 gRPC 签署交易？ diff --git a/website/_i18n/zh/user-guides/pactus-testnet/index.md b/website/_i18n/zh/user-guides/pactus-testnet/index.md new file mode 100644 index 000000000..15e99ca83 --- /dev/null +++ b/website/_i18n/zh/user-guides/pactus-testnet/index.md @@ -0,0 +1,3 @@ +--- +version: 3 +--- diff --git a/website/user-guides/pactus-testnet/index.md b/website/user-guides/pactus-testnet/index.md new file mode 100644 index 000000000..ad58f7b23 --- /dev/null +++ b/website/user-guides/pactus-testnet/index.md @@ -0,0 +1,8 @@ +--- +layout: guide +title: dict.guide.pactus_testnet +--- + +# {% t dict.guide.pactus_testnet %} + +{% translate_with_version user-guides/pactus-testnet/index.md %}