Merge branch 'main' into docs/browser-extension

Author: syrettaman

.github/workflows/deploy.yml

@@ -1,17 +1,17 @@
-name: Documentation Deployment
-run-name: Deploying to GitHub Pages
-on:
-  push:
-    branches:
-      - main
-permissions:
-    contents: write
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-      - run: pip install --upgrade pip
-      - run: pip install mkdocs pymdown-extensions mkdocs-material
+name: Documentation Deployment
+run-name: Deploying to GitHub Pages
+on:
+  push:
+    branches:
+      - main
+permissions:
+    contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - run: pip install --upgrade pip
+      - run: pip install mkdocs pymdown-extensions mkdocs-material
       - run: mkdocs gh-deploy --force

.github/workflows/pr-preview.yml

@@ -3,13 +3,16 @@ name: 🚀 Preview
 concurrency: preview-${{ github.ref }}
 
 on:
+  workflow_dispatch:
   pull_request:
     types:
       - opened
       - reopened
       - synchronize
       - closed
-
+permissions:
+  contents: write
+  pull-requests: write
 jobs:
   preview:
     name: 🚀 Preview
@@ -34,4 +37,3 @@ jobs:
         uses: rossjrw/pr-preview-action@v1
         with:
           source-dir: ./site/
-

docs/getting_started/installation.md

@@ -1,54 +1,54 @@
----
-tags:
-  - pchain-client
----
-
-# Installation
-
-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.
-
-## Installation Instructions
----
-
-### Windows 
-
-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).
-2. Unzip the file to extract the executable `pchain_client.exe`.
-3. Open Powershell by pressing *WIN+R* and typing `powershell`.
-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`.
-5. Follow the instructions in Section [Prepare Environment](prepare_env.md) to get ready for interacting with the blockchain.
-
-### Linux / macOS
-
-The installation process for Linux and macOS is similar. To install pchain_client:
-
-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).
-
-2. Head to the directory where the downloaded file is located and extract it using `tar`. For example:
-
-    === "Linux"
-        ```bash
-        tar -xvf pchain_client_linux_v0.4.3.tar.gz 
-        ```
-    === "macOS"
-        ```bash
-        tar -xvf pchain_client_mac_v0.4.3.tar.gz 
-        ```
-
-3. Follow the instructions in Section [Prepare Environment](prepare_env.md) to get ready for interacting with the blockchain.
-
-
-!!! Tips
-    - 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:
-    ```bash
-    sudo xattr -rd com.apple.quarantine ./pchain_client
-    ```
-    This is an elevated action, so you will need to enter your password to continue. `pchain_client` can now be used as normal.
-
-    - 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:
-    ```bash
-    $ mkdir -p /home/my_user/parallelchain_client
-    $ cp pchain_client /home/my_user/parallelchain_client/
-    $ cd /home/my_user/parallelchain_client
-    $ ./pchain_client
-    ```
+---
+tags:
+  - pchain-client
+---
+
+# Installation
+
+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.
+
+## Installation Instructions
+---
+
+### Windows 
+
+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).
+2. Unzip the file to extract the executable `pchain_client.exe`.
+3. Open Powershell by pressing *WIN+R* and typing `powershell`.
+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`.
+5. Follow the instructions in Section [Prepare Environment](prepare_env.md) to get ready for interacting with the blockchain.
+
+### Linux / macOS
+
+The installation process for Linux and macOS is similar. To install pchain_client:
+
+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).
+
+2. Head to the directory where the downloaded file is located and extract it using `tar`. For example:
+
+    === "Linux"
+        ```bash
+        tar -xvf pchain_client_linux_v0.4.3.tar.gz 
+        ```
+    === "macOS"
+        ```bash
+        tar -xvf pchain_client_mac_v0.4.3.tar.gz 
+        ```
+
+3. Follow the instructions in Section [Prepare Environment](prepare_env.md) to get ready for interacting with the blockchain.
+
+
+!!! Tips
+    - 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:
+    ```bash
+    sudo xattr -rd com.apple.quarantine ./pchain_client
+    ```
+    This is an elevated action, so you will need to enter your password to continue. `pchain_client` can now be used as normal.
+
+    - 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:
+    ```bash
+    $ mkdir -p /home/my_user/parallelchain_client
+    $ cp pchain_client /home/my_user/parallelchain_client/
+    $ cd /home/my_user/parallelchain_client
+    $ ./pchain_client
+    ```

docs/getting_started/prepare_env.md

@@ -1,82 +1,82 @@
----
-tags:
-  - pchain-client
-  - mainnet
-  - testnet
-  - explorer
----
-
-## Setting Environmental Variables
----
-
-Specify the location of the directory for storing your config and keypair by setting the environmental variable `PCHAIN_CLI_HOME`. 
-
-Always remember the location that you set, if you forget the location, it means you forget where your keypair is being placed.
-
-!!! Tips
-    For security reasons, you may want to set environmental **temporarily**, so that after you close the terminal session, it will forget the keypair location.
-
-The following command will set the environmental variable **temporarily**:
-
-=== "Linux / macOS"
-    ```bash
-    # For example, "/home/user/pchain_cli_home"
-    export PCHAIN_CLI_HOME="<PATH_TO_DIRECTORY>"
-    ```
-=== "Windows PowerShell"
-    ```PowerShell
-    # For example, "C:\Users\user\pchain_cli_home"
-    $Env:PCHAIN_CLI_HOME="<PATH_TO_DIRECTORY>"
-    ```
-
-For convenience reasons, you may alternatively want to set environmental **permanently**. Even in that case, we still suggest you remember the storage location.
-
-The following command will set the environmental variable **permanently**:
-
-=== "Linux / macOS"
-    ```bash
-    ##########################################################
-    ## Append this line to $Home/.bashrc and $Home/.profile ##
-    ##########################################################
-    export PCHAIN_CLI_HOME="<PATH_TO_DIRECTORY>"
-    ```
-=== "Windows (restart shell to pick up change)"
-    ```PowerShell
-    setx PCHAIN_CLI_HOME "<PATH_TO_DIRECTORY>"
-    ```
-
-## Creating Password
----
-
-For the first time to use `pchain_client`, you need to create your password for using it. The terminal should prompt you as follows:
-
-```text
-First time using ParallelChain Client CLI. Please set up a password to protect your keypairs.
-Your password: 
-```
-
-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.
-
-## Setting Endpoint Interacting with Parallelchain
----
-
-After installation of `pchain_client`, you had to update the Mainnet / Testnet endpoint to communicate with the Mainnet / Testnet. 
-
-=== "Linux / macOS"
-    ```bash
-    # Mainnet
-    ./pchain_client config setup --url https://pchain-main-rpc02.parallelchain.io
-    # Testnet
-    ./pchain_client config setup --url https://pchain-test-rpc02.parallelchain.io
-    ```
-=== "Windows"
-    ```PowerShell
-    # Mainnet
-    ./pchain_client.exe config setup --url https://pchain-main-rpc02.parallelchain.io
-    # Testnet
-    ./pchain_client.exe config setup --url https://pchain-test-rpc02.parallelchain.io
-    ```
-
-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.
-
-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.
+---
+tags:
+  - pchain-client
+  - mainnet
+  - testnet
+  - explorer
+---
+
+## Setting Environmental Variables
+---
+
+Specify the location of the directory for storing your config and keypair by setting the environmental variable `PCHAIN_CLI_HOME`. 
+
+Always remember the location that you set, if you forget the location, it means you forget where your keypair is being placed.
+
+!!! Tips
+    For security reasons, you may want to set environmental **temporarily**, so that after you close the terminal session, it will forget the keypair location.
+
+The following command will set the environmental variable **temporarily**:
+
+=== "Linux / macOS"
+    ```bash
+    # For example, "/home/user/pchain_cli_home"
+    export PCHAIN_CLI_HOME="<PATH_TO_DIRECTORY>"
+    ```
+=== "Windows PowerShell"
+    ```PowerShell
+    # For example, "C:\Users\user\pchain_cli_home"
+    $Env:PCHAIN_CLI_HOME="<PATH_TO_DIRECTORY>"
+    ```
+
+For convenience reasons, you may alternatively want to set environmental **permanently**. Even in that case, we still suggest you remember the storage location.
+
+The following command will set the environmental variable **permanently**:
+
+=== "Linux / macOS"
+    ```bash
+    ##########################################################
+    ## Append this line to $Home/.bashrc and $Home/.profile ##
+    ##########################################################
+    export PCHAIN_CLI_HOME="<PATH_TO_DIRECTORY>"
+    ```
+=== "Windows PowerShell (restart shell to pick up change)"
+    ```PowerShell
+    setx PCHAIN_CLI_HOME "<PATH_TO_DIRECTORY>"
+    ```
+
+## Creating Password
+---
+
+For the first time to use `pchain_client`, you need to create your password for using it. The terminal should prompt you as follows:
+
+```text
+First time using ParallelChain Client CLI. Please set up a password to protect your keypairs.
+Your password: 
+```
+
+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.
+
+## Setting Endpoint Interacting with Parallelchain
+---
+
+After installation of `pchain_client`, you had to update the Mainnet / Testnet endpoint to communicate with the Mainnet / Testnet. 
+
+=== "Linux / macOS"
+    ```bash
+    # Mainnet
+    ./pchain_client config setup --url https://pchain-main-rpc02.parallelchain.io
+    # Testnet
+    ./pchain_client config setup --url https://pchain-test-rpc02.parallelchain.io
+    ```
+=== "Windows PowerShell"
+    ```PowerShell
+    # Mainnet
+    ./pchain_client.exe config setup --url https://pchain-main-rpc02.parallelchain.io
+    # Testnet
+    ./pchain_client.exe config setup --url https://pchain-test-rpc02.parallelchain.io
+    ```
+
+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.
+
+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.

docs/introduction/why_parallelchain.md

@@ -6,12 +6,16 @@ tags:
 
 # Why ParallelChain?
 
-ParallelChain excels where most other blockchains stumble, and that is driving near instant transactions on its dual-blockchain ecosystem, its scalability, and network security.
+ParallelChain excels where most other blockchains stumble, providing:
 
-Both blockchains that make up ParallelChain operate at a **high transaction speed**, with the public ParallelChain Mainnet operating at an average of **80,000 transactions per second**, while the permissioned ParallelChain Enterprise operates at **130,000 transactions per second** with a 3 millisecond finality.
+  1. speed, 
+  2. scalability, and 
+  3. connectivity.
 
-This contributes to the ease of scalability for public decentralised applications and enterprise solutions alike, as both networks can help projects and companies scale up the amount of bandwidth needed especially during peak usage where on-chain activities such as NFT minting periods could easily clog up the network and raise transaction gas fees.
+ParallelChain's dual-blockchain ecosystem drives near instant transactions. The public ParallelChain Mainnet and permissioned ParallelChain Enterprise both offer extremely **high transaction speed**—the latter operating at 130,000 transactions per second with a 3 millisecond finality.
 
-Moreover, heterogenous blockchains are unable to inter-communicate meaningfully due to their difference in architecture and consensus mechanism. With ParallelChain, the blockchain network achieves true native chain communication between permissioned and permissionless chains for deep level interoperability and allow enterprise users to tap into the decentralised space in a private, secure manner with Inter-ParallelChain Communication (IPC).
+This speed brings **scalability** to public decentralised applications and enterprise solutions alike. Both networks help projects and companies scale up the amount of bandwidth needed, especially during peak usage where on-chain activities such as NFT minting periods could otherwise clog up the network and raise transaction gas fees.
 
-IPC essentially acts as the bridge that connects the enterprise chain to DeFi networks built on the ParallelChain Mainnet, and this enables decentralised applications (dApps) to work across both layers. By doing so, we create wider accessibility between communities that are traditionally isolated.
+Moreover, heterogenous blockchains are unable to inter-communicate meaningfully due to their difference in architecture and consensus mechanism. With ParallelChain, the blockchain network achieves true **native chain communication** between permissioned and permissionless chains for deep level interoperability and allow enterprise users to tap into the decentralised space in a private, secure manner with Inter-ParallelChain Protocol (IPP).
+
+IPP essentially acts as the bridge that connects the enterprise chain to DeFi networks built on the ParallelChain Mainnet, and this enables decentralised applications (dApps) to work across both layers. By doing so, we create wider accessibility between communities that are traditionally isolated.

docs/smart_contract_sdk/build_contract.md

@@ -48,7 +48,7 @@ In order to build a `WASM` binary of the smart contract, run the following comma
     ```bash
     ./pchain_compile build --source <PATH_TO_SMART_CONTRACT_CODE>
     ```
-=== "Windows"
+=== "Windows PowerShell"
     ```PowerShell
     ./pchain_compile.exe build --source <PATH_TO_SMART_CONTRACT_CODE>
     ```

docs/smart_contract_sdk/call_contract.md

@@ -54,7 +54,7 @@ Here is the command to call a contract:
     --arguments <CALL_ARGUMENT_FILE_PATH_WITH_FILE_NAME>
     --amount <AMOUNT_TO_CONTRACT> \
     ```
-=== "Windows"
+=== "Windows PowerShell"
     ```PowerShell
     ./pchain_client.exe transaction create `
     --nonce <NONCE> `
@@ -78,7 +78,7 @@ To query the resulting receipt of the transaction,
     ```bash
     ./pchain_client query tx --hash <TRANSACTION_HASH> 
     ```
-=== "Windows"
+=== "Windows PowerShell"
     ```PowerShell
     ./pchain_client.exe query tx --hash <TRANSACTION_HASH>
     ```
@@ -96,7 +96,7 @@ For example, if the contract method returns a u32 integer, the `return value` is
     ```bash
     pchain_client parse call-result --value BAAAAAUAAAA --data-type u32
     ```
-=== "Windows"
+=== "Windows PowerShell"
     ```PowerShell
     ./pchain_client.exe parse call-result --value BAAAAAUAAAA --data-type u32
     ```