Skip to content

Commit 0ea6744

Browse files
authored
add(): documentation for join the rehearsal v930 miners network (#298)
1 parent fc8dd58 commit 0ea6744

File tree

2 files changed

+94
-0
lines changed

2 files changed

+94
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
id: dev-miners-rehearsal-v93-join
3+
title: Miners Rehearsal network v9.3 joinin procedure
4+
keywords:
5+
- miners
6+
- v9.3.0
7+
- rehearsal
8+
- join
9+
description: How to join the v9.3.0 miners' rehearsal network
10+
---
11+
12+
---
13+
14+
## Introduction
15+
16+
This is page collects the steps to configure a `Zilclient` mining node and join the `v930-miners` rehearsal network deployed to test the mining facility of the desharded Zilliqa version 1 network.
17+
18+
The procedure to deploy a mining node for the Zilliqa Mainnet is available at the following [link](https://dev.zilliqa.com/miners/mining/mining-zilclient/).
19+
20+
## Requirements
21+
22+
The [**Zilliqa Client**](https://github.com/Zilliqa/zilliqa) is officially supported on Ubuntu 22.04 OS.
23+
24+
The **minimum** requirements for running the **Zilliqa Client** are:
25+
26+
- Ubuntu Linux 22.04
27+
- Recent dual-core processor @ 2.2 GHZ. Examples: Intel Xeon (Skylake)
28+
- 8GB DRR3 RAM or higher
29+
- Public static IP address
30+
- 300GB Solid State Drive
31+
- 100MB/s upload and download bandwidth
32+
- Docker version 24+
33+
34+
## Joining steps
35+
36+
After you have your Ubuntu Linux up and running with Docker installed (you can install docker following the steps [here](https://docs.docker.com/install/linux/docker-ce/ubuntu/)), you can now bootstrap your mining node using the below procedure.
37+
38+
### 1. Create a working directory for your Zilclient node
39+
40+
```bash
41+
mkdir v930-miners-join
42+
```
43+
44+
### 2. Get the joining configuration
45+
46+
Get the joining configuration for our mining rehearsal network and extract it in the previous created directory.
47+
48+
```bash
49+
cd v930-miners-join && \
50+
curl -L https://v930-join.miners-rehearsal.zq1.network/configuration.tar.gz | tar xzf -
51+
```
52+
53+
### 3. Find out your current IP address in the command prompt and record it down
54+
55+
```bash
56+
curl ipconfig.io
57+
```
58+
59+
!!! note
60+
61+
NAT IP is not supported. Kindly use the public IP address during the
62+
launch step.
63+
64+
### 4. Run the shell script in your command prompt to launch your docker image
65+
66+
```bash
67+
./launch_docker.sh
68+
```
69+
70+
### 5. You will be prompted to enter some information as shown below:
71+
72+
- `Assign a name to your container (default: zilliqa):` <br/> [Press
73+
**Enter** to skip if using default]
74+
75+
- `Enter your IP address (*.*.*.*):` <br/> [Key in your IP address as
76+
found in step 5]
77+
78+
- `Enter your listening port (default: 33133):` <br/> [Press **Enter** to
79+
skip if using default]
80+
81+
### 6. Monitoring Progress
82+
83+
You are now a miner in the Zilliqa Mainnet. You can monitor your progress on your CPU node by using:
84+
85+
```shell
86+
tail -f zilliqa.log
87+
```
88+
89+
### 7. Stop the mining node
90+
91+
```shell
92+
sudo docker stop <zilliqa container name>
93+
```

products/developer-portal/mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,7 @@ nav:
288288
- Faucet: developers/developer-toolings/dev-tools-faucet.md
289289
- Other Developer Information:
290290
- Dev Wrapped Zil: developers/other-developer-information/dev-wrapped-tokens.md
291+
- v9.3.0 Miners rehearsal join: developers/other-developer-information/dev-miners-rehearsal-v93-join.md
291292
- Transaction Lifecycle:
292293
- Signing: developers/transaction-lifecycle/dev-txn-signing.md
293294
- Broadcasting: developers/transaction-lifecycle/dev-txn-broadcasting.md

0 commit comments

Comments
 (0)