Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

Commit

Permalink
Adding testnet node/wallet guide (#226)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
kehiy authored May 6, 2024
1 parent bfb16af commit 57ff7d5
Show file tree
Hide file tree
Showing 7 changed files with 116 additions and 0 deletions.
1 change: 1 addition & 0 deletions website/_i18n/ar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
3 changes: 3 additions & 0 deletions website/_i18n/ar/user-guides/pactus-testnet/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
version: 2
---
1 change: 1 addition & 0 deletions website/_i18n/en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
99 changes: 99 additions & 0 deletions website/_i18n/en/user-guides/pactus-testnet/index.md
Original file line number Diff line number Diff line change
@@ -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 <i class="fa-brands fa-linux"></i> Linux / <i class="fa-brands fa-apple"></i> macOS %}

```text
./pactus-wallet create --testnet
./pactus-daemon init --testnet
```

{% endtab %}

{% tab create_wallet windows <i class="fa-brands fa-windows"></i> 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 %}
<b>Wallet Address</b>
<br><br>
Pactus addresses have pc HRP on Mainnet and a tpc HRP on testnet.
Addresses with pc prefix are invalid on Testnet.
on testnet.
<br><br>
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 <i class="fa-brands fa-linux"></i> Linux / <i class="fa-brands fa-apple"></i> macOS %}

```text
./pactus-gui --testnet
```

{% endtab %}

{% tab gui_node windows <i class="fa-brands fa-windows"></i> 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.
1 change: 1 addition & 0 deletions website/_i18n/zh.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 签署交易?
Expand Down
3 changes: 3 additions & 0 deletions website/_i18n/zh/user-guides/pactus-testnet/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
version: 3
---
8 changes: 8 additions & 0 deletions website/user-guides/pactus-testnet/index.md
Original file line number Diff line number Diff line change
@@ -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 %}

0 comments on commit 57ff7d5

Please sign in to comment.