Skip to content

Commit

Permalink
Merge pull request stratum-mining#1198 from GitGab19/update-readme-co…
Browse files Browse the repository at this point in the history
…nst-sv2

`const_sv2` - README update to comply with docs standards
  • Loading branch information
GitGab19 authored Oct 10, 2024
2 parents e65cb32 + 09b2833 commit 94b9ead
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
2 changes: 1 addition & 1 deletion protocols/v2/const-sv2/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "const_sv2"
version = "2.0.0"
authors = ["fi3 <[email protected]>"]
edition = "2018"
description = "Sv2 constatnts"
description = "This crate holds all of the shared constants used across the different Stratum V2 protocols and roles crates"
license = "MIT"
repository = "https://github.com/stratum-mining/stratum"

Expand Down
17 changes: 9 additions & 8 deletions protocols/v2/const-sv2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,21 @@

[![crates.io](https://img.shields.io/crates/v/const_sv2.svg)](https://crates.io/crates/const_sv2)
[![docs.rs](https://docs.rs/const_sv2/badge.svg)](https://docs.rs/const_sv2)
[![rustc+](https://img.shields.io/badge/rustc-1.75.0%2B-lightgrey.svg)](https://blog.rust-lang.org/2023/12/28/Rust-1.75.0.html)
[![license](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](https://github.com/stratum-mining/stratum/blob/main/LICENSE.md)

`const_sv2` is a Rust crate that provides essential constants for the SV2 (Stratum V2) protocol. These constants are crucial for message framing, encryption, and protocol-specific identifiers across various SV2 components, including Mining, Job Declaration, and Template Distribution protocols.
`const_sv2` is a Rust crate that provides essential constants for the Sv2 (Stratum V2) protocol. These constants are crucial for message framing, encryption, and protocol-specific identifiers across various Sv2 components, including Mining, Job Declaration, and Template Distribution protocols.

## Main Components
## Key Capabilities

- **Protocol Constants**: Define key protocol discriminants, message types, and sizes for the SV2 binary protocol.
- **Encryption Support**: Includes constants for encryption using ChaChaPoly and ElligatorSwift encoding.
- **Protocol Constants**: Define key protocol discriminants, message types, and sizes for the Sv2 binary protocol.
- **Encryption Support**: Includes constants for encryption using `ChaChaPoly` and `ElligatorSwift` encoding.
- **Channel Bits**: Defines whether specific messages are associated with a channel, simplifying protocol handling.
- **Modular**: Supports a `no_std` environment, enabling use in embedded systems or environments without a standard library.

## Usage

To use this crate, add it to your `Cargo.toml`:
To include this crate in your project, run:

```toml
[dependencies]
const_sv2 = "2.0.0"
```sh
cargo add const_sv2

0 comments on commit 94b9ead

Please sign in to comment.