8000 Finishes rust docs for `channel_sv2` by lucasbalieiro · Pull Request #1817 · stratum-mining/stratum · GitHub
[go: up one dir, main page]
Skip to content

Finishes rust docs for channel_sv2 - #1817

Merged
plebhash merged 3 commits into
stratum-mining:mainfrom
lucasbalieiro:finishes-docs-channel-sv2
Aug 19, 2025
Merged

Finishes rust docs for channel_sv2#1817
plebhash merged 3 commits into
stratum-mining:mainfrom
lucasbalieiro:finishes-docs-channel-sv2

Conversation

@lucasbalieiro
@lucasbalieiro lucasbalieiro commented Jul 28, 2025 •
edited
Loading
Copy link
Copy Markdown
Collaborator

closes #1810

Add missing rust docs for:

  • protocols::v2::channels_sv2
  • protocols::v2::channels_sv2::server
  • protocols::v2::channels_sv2::client
  • removed set_active_job from trait JobStore and replace it with add_active_job where needed.

Addresses a few typos

@lucasbalieiro
lucasbalieiro force-pushed the finishes-docs-channel-sv2 branch 3 times, most recently from 4b2bf9c to 63c42f8 Compare July 28, 2025 18:12
@lucasbalieiro
lucasbalieiro marked this pull request as ready for review July 28, 2025 18:39
@lucasbalieiro
lucasbalieiro force-pushed the finishes-docs-channel-sv2 branch 3 times, most recently from 5ee1758 to 58c8739 Compare July 31, 2025 19:35
@plebhash
plebhash commented Jul 31, 2025
Copy link
Copy Markdown
Member

#1823 will introduce some changes to the APIs

let's wait for that, then adapt things here accordingly

@lucasbalieiro
lucasbalieiro marked this pull request as draft August 1, 2025 15:41
@lucasbalieiro
lucasbalieiro force-pushed the finishes-docs-channel-sv2 branch from 58c8739 to cd72569 Compare August 7, 2025 16:50
@lucasbalieiro lucasbalieiro mentioned this pull request Aug 7, 2025
Closed
@lucasbalieiro
lucasbalieiro force-pushed the finishes-docs-channel-sv2 branch from cd72569 to 060710f Compare August 8, 2025 04:15
@lucasbalieiro
lucasbalieiro commented Aug 8, 2025
Copy link
Copy Markdown
Collaborator Author

Rebased with the changes from #1824 ;

Awaiting for #1826 and #1828 to be merged

plebhash
plebhash reviewed Aug 12, 2025
View reviewed changes
Comment thread protocols/v2/channels-sv2/src/chain_tip.rs Resolved
plebhash
plebhash reviewed Aug 12, 2025
View reviewed changes
Comment thread protocols/v2/channels-sv2/src/chain_tip.rs Resolved
plebhash
plebhash reviewed Aug 12, 2025
View reviewed changes
Comment thread protocols/v2/channels-sv2/src/template.rs Resolved
plebhash
plebhash reviewed Aug 12, 2025
View reviewed changes
Comment thread protocols/v2/channels-sv2/src/lib.rs Resolved
plebhash
plebhash reviewed Aug 12, 2025
View reviewed changes
Comment thread protocols/v2/channels-sv2/src/lib.rs Resolved
plebhash
plebhash reviewed Aug 12, 2025
View reviewed changes
Comment thread protocols/v2/channels-sv2/src/server/error.rs Resolved
plebhash
plebhash reviewed Aug 12, 2025
View reviewed changes
Comment thread protocols/v2/channels-sv2/src/server/error.rs Resolved
plebhash
plebhash reviewed Aug 12, 2025
View reviewed changes
Comment thread protocols/v2/channels-sv2/src/server/error.rs Outdated
Comment on lines 47 to 31
/// The specified template ID was not found among future jobs.
TemplateIdNotFound,
/// The nominal hashrate provided is invalid.
InvalidNominalHashrate,
/// The requested maximum target is out of the allowed range.
RequestedMaxTargetOutOfRange,
/// The new extranonce prefix is too large and violates channel constraints.
NewExtranoncePrefixTooLarge,
/// Error occurred during job creation via the job factory.
JobFactoryError(JobFactoryError),
/// The chain tip is not set when required for the operation.
ChainTipNotSet,
@plebhash plebhash Aug 12, 2025
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.

these don't get rendered on Rust Docs, I'd remove them

@plebhash plebhash Aug 18, 2025
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.

my apologies, I just realized I was wrong here (and every other place where I wrote similar comments)

enum variants do get rendered on Rust Docs

overall they're kinda self-explanatory so I think it's not too important, so it's ok if @lucasbalieiro doesn't want to re-introduce them

plebhash
plebhash reviewed Aug 12, 2025
View reviewed changes
Comment thread protocols/v2/channels-sv2/src/server/group.rs Resolved
@lucasbalieiro
lucasbalieiro force-pushed the finishes-docs-channel-sv2 branch 2 times, most recently from faf8ef2 to 5aa3666 Compare August 12, 2025 18:49
@lucasbalieiro
lucasbalieiro commented Aug 12, 2025
Copy link
Copy Markdown
Collaborator Author

@plebhash , thanks for the time taken in this review.
I've addressed the points you raised.

Rebased with the changes #1826;

Now awaiting for #1828.

@lucasbalieiro
lucasbalieiro force-pushed the finishes-docs-channel-sv2 branch from 5aa3666 to cf629f3 Compare August 13, 2025 14:51
@lucasbalieiro
lucasbalieiro commented Aug 13, 2025
Copy link
Copy Markdown
Collaborator Author

Rebased with the changes from #1828.

Now awaiting for #1832

@lucasbalieiro
lucasbalieiro force-pushed the finishes-docs-channel-sv2 branch from cf629f3 to 24722cb Compare August 15, 2025 18:29
@lucasbalieiro
lucasbalieiro commented Aug 15, 2025
Copy link
Copy Markdown
Collaborator Author

Rebased with the changes from #1832 .

@lucasbalieiro
lucasbalieiro marked this pull request as ready for review August 15, 2025 18:33
@lucasbalieiro
lucasbalieiro force-pushed the finishes-docs-channel-sv2 branch from 24722cb to 7a4a018 Compare August 18, 2025 15:05
plebhash
plebhash reviewed Aug 18, 2025
View reviewed changes
Comment thread protocols/v2/channels-sv2/src/client/error.rs Resolved
plebhash
plebhash reviewed Aug 18, 2025
View reviewed changes
Comment thread protocols/v2/channels-sv2/src/client/group.rs Resolved
@lucasbalieiro
lucasbalieiro force-pushed the finishes-docs-channel-sv2 branch from 7a4a018 to 21c190b Compare August 19, 2025 02:16
@lucasbalieiro
lucasbalieiro force-pushed the finishes-docs-channel-sv2 branch from 21c190b to 72fbb10 Compare August 19, 2025 02:17
@lucasbalieiro
lucasbalieiro force-pushed the finishes-docs-channel-sv2 branch from 72fbb10 to 29e7de2 Compare August 19, 2025 02:33
@lucasbalieiro
lucasbalieiro commented Aug 19, 2025
Copy link
Copy Markdown
Collaborator Author

Rebase to get the changes from #1839 and added docs for the functions created in it.

Addressed the remaining points.

@plebhash
plebhash merged commit c6a45f4 into stratum-mining:main Aug 19, 2025
@lucasbalieiro lucasbalieiro mentioned this pull request Aug 19, 2025
Merged
@lucasbalieiro
lucasbalieiro deleted the finishes-docs-channel-sv2 branch December 5, 2025 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@plebhash plebhash plebhash 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.

finish Rust Docs for channels_sv2 crate

2 participants

@lucasbalieiro @plebhash
0