Document pub code in pool #1542
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1542 +/- ##
=======================================
Coverage 21.91% 21.91%
=======================================
Files 135 135
Lines 9573 9573
=======================================
Hits 2098 2098
Misses 7475 7475
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Shourya742
force-pushed
the
2025-02-25-add-pool-doc
branch
from
3745562 to
7b07b56
Compare
GitGab19
reviewed
Mar 31, 2025
| @@ -4,7 +4,7 @@ use std::convert::TryFrom; | |||
|
|
|||
| /// Represents the configuration of a Pool. | |||
| /// | |||
| /// Pool acts an upstream throug hthe [`PoolConfig::listen_address`] and a downstream to the | |||
| /// Pool acts an upstream through the [`PoolConfig::listen_address`] and a downstream to the | |||
There was a problem hiding this comment.
Suggested change
| /// Pool acts an upstream through the [`PoolConfig::listen_address`] and a downstream to the | |
| /// Pool acts as an upstream through the [`PoolConfig::listen_address`] and as a downstream to the |
| @@ -77,6 +84,10 @@ pub struct Pool { | |||
| } | |||
|
|
|||
| impl Downstream { | |||
| /// Establishes a new connection with a downstream miner. | |||
There was a problem hiding this comment.
Suggested change
| /// Establishes a new connection with a downstream miner. | |
| /// Establishes a new connection with a downstream role. |
| @@ -176,6 +192,8 @@ impl Downstream { | |||
| Self::match_send_to(self_mutex, next_message_to_send).await | |||
| } | |||
|
|
|||
| /// This method is responsible for sending message to downstream, or | |||
| /// broadcasting messages to multiple downstream. | |||
There was a problem hiding this comment.
Suggested change
| /// broadcasting messages to multiple downstream. | |
| /// broadcasting messages to multiple downstreams. |
| @@ -218,6 +236,7 @@ impl Downstream { | |||
| Ok(()) | |||
| } | |||
|
|
|||
| /// This method is used to send message to downstream. | |||
There was a problem hiding this comment.
Suggested change
| /// This method is used to send message to downstream. | |
| /// This method is used to send messages to downstreams. |
| @@ -321,6 +344,8 @@ impl Pool { | |||
| Ok(()) | |||
| } | |||
|
|
|||
| // This method instantiates the downstream structures and updates the pools | |||
| // downstream snapshots. | |||
There was a problem hiding this comment.
What do you mean with snapshots?
| pub fn new() -> Self { | ||
| Self { header_only: None } | ||
| } | ||
|
|
||
| /// Handles the `SetupConnection` message from a downstream connection. |
There was a problem hiding this comment.
Suggested change
| /// Handles the `SetupConnection` message from a downstream connection. | |
| /// Handles the `SetupConnection` message coming from a downstream connection. |
| TemplateProviderShutdown(PoolError), | ||
| /// Indicates that a specific downstream miner instance has disconnected. | ||
| /// The `u32` value represents the ID of the disconnected instance. |
There was a problem hiding this comment.
Suggested change
| /// The `u32` value represents the ID of the disconnected instance. | |
| /// The `u32` value represents the channel ID of the disconnected instance. |
| DownstreamInstanceDropped(u32), | ||
| /// Represents a healthy state with an accompanying status message. |
There was a problem hiding this comment.
Is the status message always an "healthy" status?
This name always put some doubts in me ;)
| @@ -34,6 +40,7 @@ pub struct TemplateRx { | |||
| } | |||
|
|
|||
| impl TemplateRx { | |||
| /// Establishes a connection with the template provider and sets up communication channels. | |||
There was a problem hiding this comment.
Suggested change
| /// Establishes a connection with the template provider and sets up communication channels. | |
| /// Establishes a connection with the Template Provider and sets up communication channels. |
| @@ -91,12 +98,16 @@ impl TemplateRx { | |||
|
|
|||
| Self::send(self_.clone(), frame).await?; | |||
|
|
|||
| // This task intercept the NewTemplate and PrevHash message from template provider and | |||
There was a problem hiding this comment.
Suggested change
| // This task intercept the NewTemplate and PrevHash message from template provider and | |
| // This task intercept the NewTemplate and SetNewPrevHash message from Template Provider and |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes: #1471