Skip to content

Document pub code in pool#1542

Merged
GitGab19 merged 1 commit into
stratum-mining:mainfrom
Shourya742:2025-02-25-add-pool-doc
May 3, 2025
Merged

Document pub code in pool#1542
GitGab19 merged 1 commit into
stratum-mining:mainfrom
Shourya742:2025-02-25-add-pool-doc

Conversation

@Shourya742

@Shourya742 Shourya742 commented Mar 8, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

Closes #1471.

A detailed analysis of the Pool is available https://hackmd.io/@RDfBQ-d7RouOwG9UCv_w7g/HJuRLP1yex

@codecov

codecov Bot commented Mar 8, 2025 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 31.54%. Comparing base (08c877f) to head (d9c0c2b).
Report is 3 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1542   +/-   ##
=======================================
  Coverage   31.54%   31.54%           
=======================================
  Files          73       73           
  Lines        4809     4809           
=======================================
  Hits         1517     1517           
  Misses       3292     3292
Flag Coverage Δ
binary_codec_sv2-coverage 0.00% <ø> (ø)
binary_sv2-coverage 10.13% <ø> (ø)
bip32_derivation-coverage 0.00% <ø> (ø)
buffer_sv2-coverage 37.68% <ø> (ø)
codec_sv2-coverage 0.03% <ø> (ø)
common_messages_sv2-coverage 0.25% <ø> (ø)
error_handling-coverage 0.00% <ø> (ø)
framing_sv2-coverage 0.54% <ø> (ø)
job_declaration_sv2-coverage 0.00% <ø> (ø)
key-utils-coverage 3.61% <ø> (ø)
mining-coverage 5.02% <ø> (ø)
noise_sv2-coverage 8.64% <ø> (ø)
protocols 30.60% <ø> (ø)
roles_logic_sv2-coverage 15.17% <ø> (ø)
sv2_ffi-coverage 0.00% <ø> (ø)
template_distribution_sv2-coverage 0.00% <ø> (ø)
utils 36.39% <ø> (ø)
v1-coverage 4.37% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Shourya742 Shourya742 force-pushed the 2025-02-25-add-pool-doc branch from 3745562 to 7b07b56 Compare March 28, 2025 13:50
GitGab19
GitGab19 reviewed Mar 31, 2025
View reviewed changes
Comment thread roles/pool/src/lib/config.rs Outdated
Comment thread roles/pool/src/lib/mining_pool/mod.rs Outdated
Comment thread roles/pool/src/lib/mining_pool/mod.rs Outdated
Comment thread roles/pool/src/lib/mining_pool/mod.rs
Comment thread roles/pool/src/lib/mining_pool/mod.rs Outdated
Comment thread roles/pool/src/lib/mining_pool/setup_connection.rs
Comment thread roles/pool/src/lib/status.rs
Comment thread roles/pool/src/lib/status.rs
Comment thread roles/pool/src/lib/template_receiver/mod.rs Outdated
Comment thread roles/pool/src/lib/template_receiver/mod.rs Outdated
@Shourya742 Shourya742 force-pushed the 2025-02-25-add-pool-doc branch 2 times, most recently from c3cb97d to 04f9b14 Compare April 28, 2025 06:21
@Shourya742 Shourya742 requested a review from GitGab19 April 28, 2025 06:22
@Shourya742 Shourya742 force-pushed the 2025-02-25-add-pool-doc branch from 04f9b14 to c6d4363 Compare April 30, 2025 06:30
GitGab19
GitGab19 reviewed May 2, 2025
View reviewed changes

@GitGab19 GitGab19 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, left a few nits

Comment thread roles/pool/src/lib/mining_pool/message_handler.rs Outdated
Comment thread roles/pool/src/lib/mining_pool/setup_connection.rs Outdated
Comment thread roles/pool/src/lib/mod.rs Outdated
Comment thread roles/pool/src/lib/mod.rs Outdated
Comment thread roles/pool/src/lib/template_receiver/message_handler.rs Outdated
Comment thread roles/pool/src/lib/template_receiver/mod.rs Outdated
Comment thread roles/pool/src/lib/template_receiver/mod.rs Outdated
Comment thread roles/pool/src/lib/template_receiver/setup_connection.rs Outdated
Comment thread roles/pool/src/lib/template_receiver/setup_connection.rs Outdated
Comment thread roles/pool/src/lib/template_receiver/setup_connection.rs Outdated
@Shourya742 Shourya742 force-pushed the 2025-02-25-add-pool-doc branch 4 times, most recently from 68daf65 to bf2a4d9 Compare May 3, 2025 14:51
@Shourya742 Shourya742 force-pushed the 2025-02-25-add-pool-doc branch from bf2a4d9 to d9c0c2b Compare May 3, 2025 14:52
@GitGab19 GitGab19 merged commit 8f66c50 into stratum-mining:main May 3, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@GitGab19 GitGab19 GitGab19 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document Pool async primitives

2 participants

@Shourya742 @GitGab19