From 5f3fbb164bca6dab5dd946e4bba50d88a4f2654a Mon Sep 17 00:00:00 2001 From: SmartFlow Developer Date: Sun, 14 Dec 2025 11:49:02 +0100 Subject: [PATCH 1/2] docs: add Contributing section to README.md Add a dedicated Contributing section to the README.md that links to the detailed CONTRIBUTING.md guide and provides information about joining the community. This makes it easier for potential contributors to find contribution guidelines. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 9f8f38c4d13..000fe7144d0 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,12 @@ You can also read the technical papers: - ["PoX: Proof of Transfer Mining with Bitcoin"](https://community.stacks.org/pox), May 2020 - ["Stacks 2.0: Apps and Smart Contracts for Bitcoin"](https://stacks.org/stacks), Dec 2020 +## Contributing + +We welcome contributions to the Stacks blockchain! Please see our [Contributing Guide](CONTRIBUTING.md) for detailed information on development workflows, coding standards, and how to submit pull requests. + +For questions or discussions, join our [Discord community](https://stacks.chat). + ## Copyright and License The code and documentation copyright are attributed to stacks.org. From 33525f17fcf2bc2f21ac1ac91515f81904499b40 Mon Sep 17 00:00:00 2001 From: SmartFlow Developer Date: Sun, 14 Dec 2025 11:58:03 +0100 Subject: [PATCH 2/2] docs: add module-level documentation to Nakamoto relayer Add comprehensive module-level documentation to the Nakamoto relayer module explaining its purpose, key responsibilities, architecture, and integration points within the Stacks blockchain system. --- stacks-node/src/nakamoto_node/relayer.rs | 28 ++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/stacks-node/src/nakamoto_node/relayer.rs b/stacks-node/src/nakamoto_node/relayer.rs index 59691d39fa8..294474017c3 100644 --- a/stacks-node/src/nakamoto_node/relayer.rs +++ b/stacks-node/src/nakamoto_node/relayer.rs @@ -13,6 +13,34 @@ // // You should have received a copy of the GNU General Public License // along with this program. If not, see . + +//! # Nakamoto Relayer Module +//! +//! This module implements the relayer thread for the Nakamoto consensus protocol in the Stacks blockchain. +//! The relayer is responsible for coordinating between the network, chainstate, and mining components. +//! +//! ## Key Responsibilities +//! +//! - Processing network messages and relaying blocks/transactions +//! - Managing sortition processing and miner coordination +//! - Handling VRF key registration for mining +//! - Issuing block commits and tenure management +//! - Coordinating with the burnchain for consensus operations +//! +//! ## Architecture +//! +//! The relayer runs as a dedicated thread that communicates with other node components through +//! channels and shared state. It processes directives from the main node loop and manages +//! the lifecycle of mining operations in the Nakamoto epoch. +//! +//! ## Integration +//! +//! This module integrates with: +//! - `stacks-common` for shared types and utilities +//! - `stacks-chainstate` for blockchain state management +//! - `stacks-burnchains` for burnchain operations +//! - `stacks-node` for node configuration and networking +//! - Mining and consensus coordination modules use core::fmt; use std::io::Read; use std::sync::atomic::{AtomicBool, Ordering};