LaconicNetwork/lockdrop-simulation
9
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update readme

Browse Source
This commit is contained in:
Shreerang Kale 2025-08-04 16:00:21 +05:30
parent 24ef1cc1ba
commit 680f5e45a1
1 changed files with 21 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -30,30 +30,34 @@ The lockdrop simulation validates the Zenith Network's token distribution mechan
**Note**: Replace `<path/to/zenith-stack>` in the commands below with the actual path where you cloned the zenith-stack repository.
Go to the directory where playbooks are located:
Run following commands with necessary permissions, as root or through sudo
```bash
cd <path/to/zenith-stack>/ansible
```
Install `zenith-ansible`:
Install `zenith-ansible` at `/usr/local/bin`:
```bash
# Download the binary from generic package registry
curl -OJ https://git.vdb.to/api/packages/LaconicNetwork/generic/zenith-stack/v0.2.4/zenith-ansible
curl -L https://git.vdb.to/api/packages/LaconicNetwork/generic/zenith-stack/v0.2.4/zenith-ansible -o /usr/local/bin/zenith-ansible
```
**NOTE**: Make sure `/usr/local/bin` is in your `$PATH`
Make it executable:
```bash
chmod +x ./zenith-ansible
chmod +x /usr/local/bin/zenith-ansible
```
For more details about `zenith-ansible` check this [doc](./ansible/zenith-ansible-shiv/README.md)
Verify installation:
```bash
which zenith-ansible
```
<!-- TODO: Update tag -->
For more details about `zenith-ansible` check this [doc](https://git.vdb.to/LaconicNetwork/zenith-stack/src/tag/v0.2.4/ansible/zenith-ansible-shiv/README.md)
2. **Configure Variables**
Configure variables required for this simulation by following [this guide](../ansible/zenith-config-cli/docs/stage1-lockdrop-simulation.md).
Configure variables required for this simulation by following [this guide](https://git.vdb.to/LaconicNetwork/zenith-stack/src/tag/v0.2.4/ansible/zenith-config-cli/docs/stage1-lockdrop-simulation.md).
The configuration tool allows flexible simulation parameters:
- **Participant count**: Configure the total number of mock participants
@ -78,13 +82,13 @@ The lockdrop simulation validates the Zenith Network's token distribution mechan
Setup the deployment directories and pull required docker images to generate base genesis file along with other artifacts:
```bash
./zenith-ansible -i ./inventories/development/hosts.yml tge-site.yml -e "mode=setup"
zenith-ansible -i ./inventories/development/hosts.yml tge-site.yml -e "mode=setup"
```
Setup the deployment directories and pull required docker images to sign the gentx and setup stage 1 validator node:
```bash
./zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=setup" --skip-tags onboarding
zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=setup" --skip-tags onboarding
```
## Run Simulation
@ -94,7 +98,7 @@ The lockdrop simulation validates the Zenith Network's token distribution mechan
Following command allows users to create the base genesis file while simulating lockdrop participants:
```bash
./zenith-ansible -i ./inventories/development/hosts.yml tge-site.yml -e "mode=simulate-lockdrop"
zenith-ansible -i ./inventories/development/hosts.yml tge-site.yml -e "mode=simulate-lockdrop"
```
This will generate base genesis file at `<path/to/zenith-stack>/base-genesis-file/genesis.json`
@ -127,7 +131,7 @@ Note this private key down as it will be required in next step.
Now run the playbook to sign the gentx and generate final genesis file:
```bash
./zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=sign"
zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=sign"
```
Use the private key noted above when prompted.
@ -144,7 +148,7 @@ This will:
Now, we can use this genesis file to run the stage 1 validator node:
```bash
./zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=start" --skip-tags onboarding
zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=start" --skip-tags onboarding
```
After starting the node, verify it's running correctly:
@ -284,13 +288,13 @@ cd <path/to/zenith-stack>/ansible
Stop validator deployment:
```bash
./zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=stop" --skip-tags onboarding
zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=stop" --skip-tags onboarding
```
Clean up validator deployment:
```bash
./zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=cleanup" --skip-tags onboarding -K
zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=cleanup" --skip-tags onboarding -K
```
### Python Virtual Environment Cleanup