Updated Documentation #75
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR, titled "Updated Documentation", introduces a variety of changes including documentation updates, refactoring in error handling and RPC functions, as well as several adjustments in consensus and mining-related modules. Key changes include updates to ChainSpec configuration fields, modifications to retry logic and signature checks in engine and Aura modules, and additions of new modules (e.g. block_hash_cache) alongside extended tests.
Reviewed Changes
Copilot reviewed 48 out of 48 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| app/src/spec.rs | Added required_btc_txn_confirmations and adjusted chain configuration values. |
| app/src/engine.rs | Reduced retry attempts in eth_getTransactionReceipt and updated JWT auth handling. |
| app/src/aura.rs | Modified slot comparison logic with an added condition. |
| app/src/auxpow_miner.rs | Updated ChainManager trait and error propagation in auxpow functions. |
| app/src/app.rs | Added new CLI flags and integrated jwt_secret in engine initialization. |
| Other files | Minor refactoring and dependency version updates across network, error, and documentation modules. |
Comments suppressed due to low confidence (3)
app/src/spec.rs:59
- The change in 'max_blocks_without_pow' from 20000 to 20 is significant; please verify that this reduction is intentional and correctly reflects the desired consensus parameters.
chain_id: 121212,
app/src/engine.rs:233
- The retry loop for 'eth_getTransactionReceipt' has been reduced from 50 to 1 iteration; please confirm that this change is intentional and does not compromise receipt availability.
for i in 0..1 {
app/src/aura.rs:90
- The additional condition 'slot > slot_with_3000_duration + 1' changes the criteria for future slot detection; please clarify if this new check is intended and document its purpose accordingly.
if slot > slot_now + 1 && slot > slot_with_3000_duration + 1 {
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation by adding new guides for both manual and Docker Compose setups and revising the README to improve clarity on testnet connection details.
- Added a new manual setup guide detailing step-by-step instructions for running a local Alys node and federation.
- Introduced a Docker Compose guide with multiple options for running Alys in different configurations.
- Updated the README to include clear testnet node connection information and removed outdated sections.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/guides/getting_started_manual_setup.md | New guide outlining the manual setup process for a single Alys node and federation. |
| docs/guides/getting_started_docker_setup.md | Detailed instructions for using Docker Compose to run various Alys configurations. |
| README.md | Revised instructions for connecting to the Alys testnet and removed deprecated sections. |
No description provided.