Update main README with overview
This commit is contained in:
parent
b698140e20
commit
a7f26983ab
22
README.md
22
README.md
@ -2,3 +2,25 @@
|
||||
|
||||
- Follow [run-first-validator.md](docs/run-first-validator.md) to run the first validator node
|
||||
- Follow [run-validator.md](docs/run-validator.md) to run subsequent validator nodes
|
||||
|
||||
### Other Dependencies
|
||||
|
||||
- [laconic-so](https://github.com/cerc-io/stack-orchestrator/?tab=readme-ov-file#install)
|
||||
- [tmkms](https://github.com/iqlusioninc/tmkms?tab=readme-ov-file#installation) (for validator nodes)
|
||||
- Keplr wallet extension (for multisig app)
|
||||
|
||||
## Launch Laconic Mainnet
|
||||
|
||||
- Run [playbook](./playbooks/first-validator/README.md) to use exported state for generating mainnet genesis, submit gentx and setup the node
|
||||
- Generate the genesis file from testnet state
|
||||
- Set up the first validator node
|
||||
- Configure TMKMS for key management
|
||||
- Verify testnet state transfer and token distribution
|
||||
|
||||
- Run [playbook](./playbooks/validator/README.md) to start both validator nodes
|
||||
- Set up additional validator nodes with different ports
|
||||
- Configure TMKMS for each validator
|
||||
- Create validators on the running chain
|
||||
- Verify validator creation and participation
|
||||
|
||||
- Deploy the Cosmos Multisig application using the [cosmos-multisig-app playbook](./playbooks/cosmos-multisig-app/README.md)
|
||||
|
||||
@ -40,3 +40,65 @@
|
||||
ansible --version
|
||||
# ansible [core 2.17.2]
|
||||
```
|
||||
|
||||
# Laconic Stack Playbooks
|
||||
|
||||
This directory contains Ansible playbooks for setting up and managing various components of the Laconic stack.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- [laconic-so](https://github.com/cerc-io/stack-orchestrator/?tab=readme-ov-file#install)
|
||||
- [tmkms](https://github.com/iqlusioninc/tmkms?tab=readme-ov-file#installation) (for validator nodes)
|
||||
- Install with `softsign` feature
|
||||
```bash
|
||||
cargo install tmkms --features=softsign --version=0.14.0
|
||||
```
|
||||
- testnet-state.json (exported testnet state)
|
||||
- distribution.json (JSON containing the `lps_lockup` distribution)
|
||||
- Keplr wallet extension (for multisig app)
|
||||
|
||||
## Launch Laconic Mainnet
|
||||
|
||||
- Begin by setting up the first validator node using the [first-validator playbook](first-validator/README.md)
|
||||
|
||||
This playbook will:
|
||||
- Generate the genesis file from testnet state
|
||||
- Set up the first validator node
|
||||
- Configure TMKMS for key management
|
||||
- Verify testnet state transfer and token distribution
|
||||
|
||||
- Once the first validator node is running, set up additional validators using the [validator playbook](validator/README.md)
|
||||
|
||||
This playbook will:
|
||||
- Set up additional validator nodes with different ports
|
||||
- Configure TMKMS for each validator
|
||||
- Create validators on the running chain
|
||||
- Verify validator creation and participation
|
||||
|
||||
- Deploy the Cosmos Multisig application using the [cosmos-multisig-app playbook](cosmos-multisig-app/README.md)
|
||||
|
||||
This playbook will:
|
||||
- Set up the multisig web interface
|
||||
- Configure it to work with your validator nodes
|
||||
- Enable multisig wallet creation and management
|
||||
- Allow creation of multisig wallets with validator accounts
|
||||
- Enable transaction signing and broadcasting
|
||||
|
||||
## Common Environment Variables
|
||||
|
||||
Most playbooks require these environment variables:
|
||||
|
||||
```bash
|
||||
export CWD=$(pwd)
|
||||
export DATA_DIRECTORY=$CWD
|
||||
```
|
||||
|
||||
Additional variables are documented in each playbook's README.
|
||||
|
||||
## Cleanup
|
||||
|
||||
To clean up all deployments:
|
||||
|
||||
```bash
|
||||
rm -rf *-spec.yml *-deployment tmkms-* output
|
||||
```
|
||||
|
||||
Loading…
Reference in New Issue
Block a user