Skip to content

Commit cf7ca3c

Browse files
rustduderustdude
rustdude
authored and
rustdude
committed
several fixes
1 parent 1af4de4 commit cf7ca3c

File tree

20 files changed

+766
-574
lines changed

20 files changed

+766
-574
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
name: Documentation Deployment
2-
run-name: Deploying to GitHub Pages
3-
on:
4-
push:
5-
branches:
6-
- main
7-
permissions:
8-
contents: write
9-
jobs:
10-
deploy:
11-
runs-on: ubuntu-latest
12-
steps:
13-
- uses: actions/checkout@v2
14-
- uses: actions/setup-python@v2
15-
- run: pip install --upgrade pip
16-
- run: pip install mkdocs pymdown-extensions mkdocs-material
1+
name: Documentation Deployment
2+
run-name: Deploying to GitHub Pages
3+
on:
4+
push:
5+
branches:
6+
- main
7+
permissions:
8+
contents: write
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
- uses: actions/setup-python@v2
15+
- run: pip install --upgrade pip
16+
- run: pip install mkdocs pymdown-extensions mkdocs-material
1717
- run: mkdocs gh-deploy --force

‎docs/getting_started/create_account.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To create an account, type the following command below:
1717
```bash
1818
./pchain_client keys create --name <NAME>
1919
```
20-
=== "Windows"
20+
=== "Windows PowerShell"
2121
```PowerShell
2222
./pchain_client.exe keys create --name <NAME>
2323
```
@@ -30,7 +30,7 @@ This command generates a set of ed25519_dalek-compatible keys. A keypair file in
3030
```bash
3131
./pchain_client keys list
3232
```
33-
=== "Windows"
33+
=== "Windows PowerShell"
3434
```PowerShell
3535
./pchain_client.exe keys list
3636
```
@@ -50,7 +50,7 @@ You can check the account balance using the account address (public key).
5050
```bash
5151
./pchain_client query balance --address <PUBLIC_KEY>
5252
```
53-
=== "Windows"
53+
=== "Windows PowerShell"
5454
```PowerShell
5555
./pchain_client.exe query balance --address <PUBLIC_KEY>
5656
```
@@ -72,7 +72,7 @@ To secure your keypair and money, you must export it and save it somewhere secur
7272
```bash
7373
./pchain_client keys export --name <NAME>
7474
```
75-
=== "Windows"
75+
=== "Windows PowerShell"
7676
```PowerShell
7777
./pchain_client.exe keys export --name <NAME>
7878
```
@@ -86,7 +86,7 @@ To add your keypair, type the following command below:
8686
```bash
8787
./pchain_client keys import --public <PUBLIC_KEY> --private <PRIVATE_KEY> --name <NAME>
8888
```
89-
=== "Windows"
89+
=== "Windows PowerShell"
9090
```PowerShell
9191
./pchain_client.exe keys import --public <PUBLIC_KEY> --private <PRIVATE_KEY> --name <NAME>
9292
```

‎docs/getting_started/installation.md‎

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,54 @@
1-
---
2-
tags:
3-
- pchain-client
4-
---
5-
6-
# Installation
7-
8-
ParallelChain client (`pchain_client`) is a command-line tool that allows you to connect and interact with the ParallelChain Mainnet / Testnet. `pchain_client` supports both Windows and Linux/macOS. In this tutorial, we will provide you with step-by-step instructions on how to install and use `pchain_client` to transfer tokens, deploy smart contracts, and call contracts.
9-
10-
## Installation Instructions
11-
---
12-
13-
### Windows
14-
15-
1. Download the latest release as a compressed file from Assets of ParallelChain Lab's GitHub [release page](https://github.com/parallelchain-io/pchain-client-cli/releases).
16-
2. Unzip the file to extract the executable `pchain_client.exe`.
17-
3. Open Powershell by pressing *WIN+R* and typing `powershell`.
18-
4. Navigate to the directory where `pchain_client.exe` is located using the `cd` command. For example, if the executable is located at `C:\Development`, type `cd C:\Development`.
19-
5. Follow the instructions in Section [Prepare Environment](prepare_env.md) to get ready for interacting with the blockchain.
20-
21-
### Linux / macOS
22-
23-
The installation process for Linux and macOS is similar. To install pchain_client:
24-
25-
1. Download the latest release as a compressed file from Assets of ParallelChain Lab's GitHub [release page](https://github.com/parallelchain-io/pchain-client-cli/releases).
26-
27-
2. Head to the directory where the downloaded file is located and extract it using `tar`. For example:
28-
29-
=== "Linux"
30-
```bash
31-
tar -xvf pchain_client_linux_v0.4.3.tar.gz
32-
```
33-
=== "macOS"
34-
```bash
35-
tar -xvf pchain_client_mac_v0.4.3.tar.gz
36-
```
37-
38-
3. Follow the instructions in Section [Prepare Environment](prepare_env.md) to get ready for interacting with the blockchain.
39-
40-
41-
!!! Tips
42-
- If you're using macOS and encounter a [GateKeeper](https://support.apple.com/en-gb/guide/security/sec5599b66df/web) message when trying to run pchain_client, you can remove macOS' "GateKeeper" attributes from pchain_client using the following command:
43-
```bash
44-
sudo xattr -rd com.apple.quarantine ./pchain_client
45-
```
46-
This is an elevated action, so you will need to enter your password to continue. `pchain_client` can now be used as normal.
47-
48-
- You might want to store `pchain_client` in a directory of your choice so that it is easier to follow the commands in the tutorial. For example, we created a folder in our home directory called parallelchain_client:
49-
```bash
50-
$ mkdir -p /home/my_user/parallelchain_client
51-
$ cp pchain_client /home/my_user/parallelchain_client/
52-
$ cd /home/my_user/parallelchain_client
53-
$ ./pchain_client
54-
```
1+
---
2+
tags:
3+
- pchain-client
4+
---
5+
6+
# Installation
7+
8+
ParallelChain client (`pchain_client`) is a command-line tool that allows you to connect and interact with the ParallelChain Mainnet / Testnet. `pchain_client` supports both Windows and Linux/macOS. In this tutorial, we will provide you with step-by-step instructions on how to install and use `pchain_client` to transfer tokens, deploy smart contracts, and call contracts.
9+
10+
## Installation Instructions
11+
---
12+
13+
### Windows
14+
15+
1. Download the latest release as a compressed file from Assets of ParallelChain Lab's GitHub [release page](https://github.com/parallelchain-io/pchain-client-cli/releases).
16+
2. Unzip the file to extract the executable `pchain_client.exe`.
17+
3. Open Powershell by pressing *WIN+R* and typing `powershell`.
18+
4. Navigate to the directory where `pchain_client.exe` is located using the `cd` command. For example, if the executable is located at `C:\Development`, type `cd C:\Development`.
19+
5. Follow the instructions in Section [Prepare Environment](prepare_env.md) to get ready for interacting with the blockchain.
20+
21+
### Linux / macOS
22+
23+
The installation process for Linux and macOS is similar. To install pchain_client:
24+
25+
1. Download the latest release as a compressed file from Assets of ParallelChain Lab's GitHub [release page](https://github.com/parallelchain-io/pchain-client-cli/releases).
26+
27+
2. Head to the directory where the downloaded file is located and extract it using `tar`. For example:
28+
29+
=== "Linux"
30+
```bash
31+
tar -xvf pchain_client_linux_v0.4.3.tar.gz
32+
```
33+
=== "macOS"
34+
```bash
35+
tar -xvf pchain_client_mac_v0.4.3.tar.gz
36+
```
37+
38+
3. Follow the instructions in Section [Prepare Environment](prepare_env.md) to get ready for interacting with the blockchain.
39+
40+
41+
!!! Tips
42+
- If you're using macOS and encounter a [GateKeeper](https://support.apple.com/en-gb/guide/security/sec5599b66df/web) message when trying to run pchain_client, you can remove macOS' "GateKeeper" attributes from pchain_client using the following command:
43+
```bash
44+
sudo xattr -rd com.apple.quarantine ./pchain_client
45+
```
46+
This is an elevated action, so you will need to enter your password to continue. `pchain_client` can now be used as normal.
47+
48+
- You might want to store `pchain_client` in a directory of your choice so that it is easier to follow the commands in the tutorial. For example, we created a folder in our home directory called parallelchain_client:
49+
```bash
50+
$ mkdir -p /home/my_user/parallelchain_client
51+
$ cp pchain_client /home/my_user/parallelchain_client/
52+
$ cd /home/my_user/parallelchain_client
53+
$ ./pchain_client
54+
```

‎docs/getting_started/prepare_env.md‎

Lines changed: 82 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,82 @@
1-
---
2-
tags:
3-
- pchain-client
4-
- mainnet
5-
- testnet
6-
- explorer
7-
---
8-
9-
## Setting Environmental Variables
10-
---
11-
12-
Specify the location of the directory for storing your config and keypair by setting the environmental variable `PCHAIN_CLI_HOME`.
13-
14-
Always remember the location that you set, if you forget the location, it means you forget where your keypair is being placed.
15-
16-
!!! Tips
17-
For security reasons, you may want to set environmental **temporarily**, so that after you close the terminal session, it will forget the keypair location.
18-
19-
The following command will set the environmental variable **temporarily**:
20-
21-
=== "Linux / macOS"
22-
```bash
23-
# For example, "/home/user/pchain_cli_home"
24-
export PCHAIN_CLI_HOME="<PATH_TO_DIRECTORY>"
25-
```
26-
=== "Windows PowerShell"
27-
```PowerShell
28-
# For example, "C:\Users\user\pchain_cli_home"
29-
$Env:PCHAIN_CLI_HOME="<PATH_TO_DIRECTORY>"
30-
```
31-
32-
For convenience reasons, you may alternatively want to set environmental **permanently**. Even in that case, we still suggest you remember the storage location.
33-
34-
The following command will set the environmental variable **permanently**:
35-
36-
=== "Linux / macOS"
37-
```bash
38-
##########################################################
39-
## Append this line to $Home/.bashrc and $Home/.profile ##
40-
##########################################################
41-
export PCHAIN_CLI_HOME="<PATH_TO_DIRECTORY>"
42-
```
43-
=== "Windows (restart shell to pick up change)"
44-
```PowerShell
45-
setx PCHAIN_CLI_HOME "<PATH_TO_DIRECTORY>"
46-
```
47-
48-
## Creating Password
49-
---
50-
51-
For the first time to use `pchain_client`, you need to create your password for using it. The terminal should prompt you as follows:
52-
53-
```text
54-
First time using ParallelChain Client CLI. Please set up a password to protect your keypairs.
55-
Your password:
56-
```
57-
58-
This password is only used by the CLI, and **NOT** associated with the blockchain. It is used for encryption and decryption of your keypairs so that the keypairs are stored in your computer more securely.
59-
60-
## Setting Endpoint Interacting with Parallelchain
61-
---
62-
63-
After installation of `pchain_client`, you had to update the Mainnet / Testnet endpoint to communicate with the Mainnet / Testnet.
64-
65-
=== "Linux / macOS"
66-
```bash
67-
# Mainnet
68-
./pchain_client config setup --url https://pchain-main-rpc02.parallelchain.io
69-
# Testnet
70-
./pchain_client config setup --url https://pchain-test-rpc02.parallelchain.io
71-
```
72-
=== "Windows"
73-
```PowerShell
74-
# Mainnet
75-
./pchain_client.exe config setup --url https://pchain-main-rpc02.parallelchain.io
76-
# Testnet
77-
./pchain_client.exe config setup --url https://pchain-test-rpc02.parallelchain.io
78-
```
79-
80-
This command will write a `config.toml` file in the folder specified by the environment variable `PCHAIN_CLI_HOME`. It only needs to be executed once.
81-
82-
Now you can start the journey to play around with `pchain_client`, but there is still one thing you had to put in mind first.
1+
---
2+
tags:
3+
- pchain-client
4+
- mainnet
5+
- testnet
6+
- explorer
7+
---
8+
9+
## Setting Environmental Variables
10+
---
11+
12+
Specify the location of the directory for storing your config and keypair by setting the environmental variable `PCHAIN_CLI_HOME`.
13+
14+
Always remember the location that you set, if you forget the location, it means you forget where your keypair is being placed.
15+
16+
!!! Tips
17+
For security reasons, you may want to set environmental **temporarily**, so that after you close the terminal session, it will forget the keypair location.
18+
19+
The following command will set the environmental variable **temporarily**:
20+
21+
=== "Linux / macOS"
22+
```bash
23+
# For example, "/home/user/pchain_cli_home"
24+
export PCHAIN_CLI_HOME="<PATH_TO_DIRECTORY>"
25+
```
26+
=== "Windows PowerShell"
27+
```PowerShell
28+
# For example, "C:\Users\user\pchain_cli_home"
29+
$Env:PCHAIN_CLI_HOME="<PATH_TO_DIRECTORY>"
30+
```
31+
32+
For convenience reasons, you may alternatively want to set environmental **permanently**. Even in that case, we still suggest you remember the storage location.
33+
34+
The following command will set the environmental variable **permanently**:
35+
36+
=== "Linux / macOS"
37+
```bash
38+
##########################################################
39+
## Append this line to $Home/.bashrc and $Home/.profile ##
40+
##########################################################
41+
export PCHAIN_CLI_HOME="<PATH_TO_DIRECTORY>"
42+
```
43+
=== "Windows PowerShell (restart shell to pick up change)"
44+
```PowerShell
45+
setx PCHAIN_CLI_HOME "<PATH_TO_DIRECTORY>"
46+
```
47+
48+
## Creating Password
49+
---
50+
51+
For the first time to use `pchain_client`, you need to create your password for using it. The terminal should prompt you as follows:
52+
53+
```text
54+
First time using ParallelChain Client CLI. Please set up a password to protect your keypairs.
55+
Your password:
56+
```
57+
58+
This password is only used by the CLI, and **NOT** associated with the blockchain. It is used for encryption and decryption of your keypairs so that the keypairs are stored in your computer more securely.
59+
60+
## Setting Endpoint Interacting with Parallelchain
61+
---
62+
63+
After installation of `pchain_client`, you had to update the Mainnet / Testnet endpoint to communicate with the Mainnet / Testnet.
64+
65+
=== "Linux / macOS"
66+
```bash
67+
# Mainnet
68+
./pchain_client config setup --url https://pchain-main-rpc02.parallelchain.io
69+
# Testnet
70+
./pchain_client config setup --url https://pchain-test-rpc02.parallelchain.io
71+
```
72+
=== "Windows PowerShell"
73+
```PowerShell
74+
# Mainnet
75+
./pchain_client.exe config setup --url https://pchain-main-rpc02.parallelchain.io
76+
# Testnet
77+
./pchain_client.exe config setup --url https://pchain-test-rpc02.parallelchain.io
78+
```
79+
80+
This command will write a `config.toml` file in the folder specified by the environment variable `PCHAIN_CLI_HOME`. It only needs to be executed once.
81+
82+
Now you can start the journey to play around with `pchain_client`, but there is still one thing you had to put in mind first.

0 commit comments

Comments
 (0)