Update README #26
Update README #26
Conversation
… with setup instructions
…stem dependencies
There was a problem hiding this comment.
Pull Request Overview
Updates the README with comprehensive build instructions, example configurations, and usage documentation for the qlean blockchain node client. The PR adds detailed setup steps including dependency installation, vcpkg configuration, and CMake build process.
- Added complete build instructions with system dependency setup for both macOS and Linux
- Created example configurations for single-node and 4-node networks with genesis files
- Added Shadow network simulation example with configuration files
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Complete rewrite with detailed build instructions, quick start guide, and usage examples |
| example/0-single/README.md | Single-node network example with step-by-step instructions |
| example/1-network/README.md | 4-validator network example with multi-node setup |
| shadow/README.md | Shadow network simulation setup instructions |
| shadow/shadow.yaml | Shadow configuration for 4-node network simulation |
| example//genesis/.yaml | Genesis configuration files for validator registries, bootnodes, and network settings |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
shadow/shadow.yaml
Outdated
| expected_final_state: running | ||
|
|
||
| node1: | ||
| network_node_id: 0 |
There was a problem hiding this comment.
All nodes are configured with the same network_node_id: 0. Each node should have a unique network_node_id (0, 1, 2, 3) to properly simulate different network positions in Shadow.
shadow/shadow.yaml
Outdated
| expected_final_state: running | ||
|
|
||
| node2: | ||
| network_node_id: 0 |
There was a problem hiding this comment.
All nodes are configured with the same network_node_id: 0. Each node should have a unique network_node_id (0, 1, 2, 3) to properly simulate different network positions in Shadow.
shadow/shadow.yaml
Outdated
| expected_final_state: running | ||
|
|
||
| node3: | ||
| network_node_id: 0 |
There was a problem hiding this comment.
All nodes are configured with the same network_node_id: 0. Each node should have a unique network_node_id (0, 1, 2, 3) to properly simulate different network positions in Shadow.
| Open four terminals (or run in background) and launch each node with its own key and ports. | ||
|
|
||
| Node 0: | ||
|
|
There was a problem hiding this comment.
[nitpick] Shell code blocks should use 'bash' instead of 'zsh' for better compatibility, as the commands shown are standard bash commands that work across different shells.
| ``` | ||
|
|
||
| Example CLI command: | ||
|
|
There was a problem hiding this comment.
[nitpick] Shell code blocks should use 'bash' instead of 'zsh' for better compatibility, as the commands shown are standard bash commands.
| ``` | ||
|
|
||
| ### 1) Install and bootstrap vcpkg | ||
|
|
There was a problem hiding this comment.
[nitpick] Shell code blocks should use 'bash' instead of 'zsh' for better compatibility. While zsh-specific features like export commands work in bash, using 'bash' as the language identifier is more universally compatible.
shadow/README.md
Outdated
|
|
||
| ```bash | ||
| cd /path/to/qlean-mini | ||
| sed -i "s|/path/to/qlean-mini|$(pwd)|g" shadow/shadow.yaml |
There was a problem hiding this comment.
May make template shadow.yaml.in with some placeholders/variables instead of "/path/to/qlean-mini"
shadow/README.md
Outdated
| 3) Run the example | ||
|
|
||
| ```bash | ||
| shadow --progress true --parallelism $(nproc) shadow/shadow.yaml |
There was a problem hiding this comment.
May put rm -rf shadow.data here before running shadow (may chain with &&),
instead of step "4) Cleanup"
Uh oh!
There was an error while loading. Please reload this page.