Need Rust docs on protocols::v2::sv2-ffi

[rrybarczyk]

Background

Currently, the protocols::v2::sv2-ffi logic does not contain any in-line rust documentation, resulting in no documentation on its crates.io site.

Note: While this issue addresses the need for doc comments, it will also serve as a means to identify code debt that needs to be cleaned up and addressed in future issues.

Problem

When a user navigates to this crate crates.io, there is no useful information for the user. This impedes understanding and adoption.

Solution

Navigate through each crate in protocols::v2::sv2-ffi and add:

• Rust Docs comments (following the formatting structure in this on-going discussion), to be displayed in docs.rs
• a descriptive README.md file to be displayed in crates.io

While this work is being performed, specific code debt should be looked for and recorded to turn into future issues

[Shourya742]

@rrybarczyk May I take this on? I would like to explore FFI binding in Rust.

[rrybarczyk]

Added you as an assignee.

[Fi3]

@Shourya742 take a look at this https://github.com/stratum-mining/stratum/blob/main/examples/interop-cpp/README.md before starting

[rrybarczyk]

We are going to deprioritize docs on sv2-ffi because this crate does not have complete functionality (see #919) and the other protocols/ crates should be prioritized as they are more critical.