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

Update instructions with prerequisites

Browse Source
This commit is contained in:
Prathamesh Musale 2025-08-18 12:32:54 +05:30
parent 0e57539780
commit 37908aed84
3 changed files with 101 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
EXPERIMENT.md
View File

@ -4,8 +4,20 @@ This guide explains how to use the interactive notebook to experiment with diffe
## Prerequisites
- Ubuntu 22 or 24
- **Note**: Other platforms are not supported yet for deployment
- [Python3](https://wiki.python.org/moin/BeginnersGuide/Download) `3.12.x` >= `python3 --version` >= `3.8.10` (the Python3 shipped in Ubuntu 20+ is good to go)
- [pip](https://pip.pypa.io/en/stable/installation/) (Python package manager)
- Make sure that `ensurepip` is available for creating virtual environments:
```bash
python3 -m ensurepip --version
# Ubuntu/Debian
sudo apt-get install python3-venv
```
## Quick Start

49
README.md
View File

@ -64,6 +64,31 @@ The lockdrop simulation validates the Zenith Network's token distribution mechan
## Prerequisites
- Software Requirements
- Ubuntu 22 or 24
- **Note**: Other platforms are not supported yet for deployment
- [Python3](https://wiki.python.org/moin/BeginnersGuide/Download) `3.12.x` >= `python3 --version` >= `3.8.10` (the Python3 shipped in Ubuntu 20+ is good to go)
- Make sure that `ensurepip` is available for creating virtual environments:
```bash
python3 -m ensurepip --version
# Ubuntu/Debian
sudo apt-get install python3-venv
```
- Repository Access: SSH access to <https://git.vdb.to/LaconicNetwork/zenith-stack>
- If you are logging in to the host using SSH, make sure to use agent forwarding:
```bash
ssh -A <control-node-ip>
```
- Set zenith-stack version to use:
```bash
@ -96,13 +121,14 @@ The lockdrop simulation validates the Zenith Network's token distribution mechan
- **zenith-ansible binary**
**Note**: Set `OUTPUT_DIR` in the following command to output directory of your choice. Make sure that it exists and is in your [`PATH`](https://unix.stackexchange.com/a/26059).
**Note**: Set `OUTPUT_DIR` in the following command to output directory of your choice.
You may need to run the following commands with necessary permissions, as root or through sudo.
```bash
# Download the binary from generic package registry
OUTPUT_DIR=~/bin
mkdir -p $OUTPUT_DIR
curl -L -o $OUTPUT_DIR/zenith-ansible https://git.vdb.to/api/packages/LaconicNetwork/generic/zenith-stack/$ZENITH_STACK_VERSION/zenith-ansible
```
@ -113,6 +139,12 @@ The lockdrop simulation validates the Zenith Network's token distribution mechan
chmod +x $OUTPUT_DIR/zenith-ansible
```
Add `OUTPUT_DIR` to your PATH:
```bash
export PATH="$OUTPUT_DIR:$PATH"
```
Verify installation:
```bash
@ -210,19 +242,26 @@ configure-zenith-vars --stage stage1-lockdrop-simulation --list
## Setup
Create the data directory required for simulation (must be same as the path configured for `lockdrop simulation deployments directory` in previous step to configure variables):
First, create the data directory required for simulation (must be same as the path configured for `lockdrop simulation deployments directory` in previous step to configure variables):
```bash
# For example:
mkdir -p /home/$USER/stage1-lockdrop-simulation
```
Now, run required system setup (installs docker and laconic-so):
```bash
# Make sure you are in ansible directory
cd <path/to/zenith-stack>/ansible
# sudo access required for installing docker
zenith-ansible -i ./inventories/development/hosts.yml ./stage1-site.yml -e "mode=system-setup" -K
```
Setup the deployment directories and pull required docker images to generate base genesis file along with other artifacts:
```bash
# Make sure you are in ansible directory:
cd <path/to/zenith-stack>/ansible
zenith-ansible -i ./inventories/development/hosts.yml tge-site.yml -e "mode=setup"
```

49
test-runs/README.md
View File

@ -31,6 +31,31 @@ To reproduce the results from any one of the test runs, follow these steps to ru
## Prerequisites
- Software Requirements
- Ubuntu 22 or 24
- **Note**: Other platforms are not supported yet for deployment
- [Python3](https://wiki.python.org/moin/BeginnersGuide/Download) `3.12.x` >= `python3 --version` >= `3.8.10` (the Python3 shipped in Ubuntu 20+ is good to go)
- Make sure that `ensurepip` is available for creating virtual environments:
```bash
python3 -m ensurepip --version
# Ubuntu/Debian
sudo apt-get install python3-venv
```
- Repository Access: SSH access to <https://git.vdb.to/LaconicNetwork/zenith-stack>
- If you are logging in to the host using SSH, make sure to use agent forwarding:
```bash
ssh -A <control-node-ip>
```
- Set zenith-stack version to use:
```bash
@ -63,13 +88,14 @@ To reproduce the results from any one of the test runs, follow these steps to ru
- **zenith-ansible binary**
**Note**: Set `OUTPUT_DIR` in the following command to output directory of your choice. Make sure that it exists and is in your [`PATH`](https://unix.stackexchange.com/a/26059).
**Note**: Set `OUTPUT_DIR` in the following command to output directory of your choice.
You may need to run the following commands with necessary permissions, as root or through sudo.
```bash
# Download the binary from generic package registry
OUTPUT_DIR=~/bin
mkdir -p $OUTPUT_DIR
curl -L -o $OUTPUT_DIR/zenith-ansible https://git.vdb.to/api/packages/LaconicNetwork/generic/zenith-stack/$ZENITH_STACK_VERSION/zenith-ansible
```
@ -80,6 +106,12 @@ To reproduce the results from any one of the test runs, follow these steps to ru
chmod +x $OUTPUT_DIR/zenith-ansible
```
Add `OUTPUT_DIR` to your PATH:
```bash
export PATH="$OUTPUT_DIR:$PATH"
```
Verify installation:
```bash
@ -172,19 +204,26 @@ configure-zenith-vars --stage stage1-lockdrop-simulation --list
## Setup
Create the data directory required for simulation (must be same as the path configured for `lockdrop simulation deployments directory` in previous step to configure variables):
First, create the data directory required for simulation (must be same as the path configured for `lockdrop simulation deployments directory` in previous step to configure variables):
```bash
# For example:
mkdir -p /home/$USER/stage1-lockdrop-simulation
```
Now, run required system setup (installs docker and laconic-so):
```bash
# Make sure you are in ansible directory
cd <path/to/zenith-stack>/ansible
# sudo access required for installing docker
zenith-ansible -i ./inventories/development/hosts.yml ./stage1-site.yml -e "mode=system-setup" -K
```
Setup the deployment directories and pull required docker images to generate base genesis file along with other artifacts:
```bash
# Make sure you are in ansible directory:
cd <path/to/zenith-stack>/ansible
zenith-ansible -i ./inventories/development/hosts.yml tge-site.yml -e "mode=setup"
```