Skip to content

Commit

Permalink
Merge branch 'main' into docstring-sequences
Browse files Browse the repository at this point in the history
  • Loading branch information
average-gary authored Oct 9, 2024
2 parents d85f1f4 + c05d8cd commit 4902f16
Show file tree
Hide file tree
Showing 14 changed files with 256 additions and 117 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/clippy-lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@ on:
push:
branches:
- main
- dev
pull_request:
branches:
- main
- dev

name: Clippy Lint

Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/coverage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ name: Test Coverage

on:
push:
branches: [ main, dev ]
branches:
- main
pull_request:
branches: [ main, dev ]
branches:
- main

jobs:
tarpaulin-test:
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/fmt.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@ on:
push:
branches:
- main
- dev
pull_request:
branches:
- main
- dev

name: Rustfmt

Expand Down
4 changes: 1 addition & 3 deletions .github/workflows/lockfiles.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
name: Lockfiles

# Trigger the workflow on push or pull request events for the dev and main branches
# Trigger the workflow on push or pull request events for the main branch
on:
push:
branches:
- dev
- main
pull_request:
branches:
- dev
- main

jobs:
Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/mg.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ name: MG Test

on:
push:
branches: [ main, dev ]
branches:
- main
pull_request:
branches: [ main, dev ]
branches:
- main

jobs:
bad-pool-config-test:
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/rust-msrv.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@ on:
push:
branches:
- main
- dev
pull_request:
branches:
- main
- dev

name: MSRV 1.75 Check

Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/semver-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ on:
push:
branches:
- "main"
- "dev"
pull_request:
branches:
- "main"
- "dev"

jobs:
semver-check:
Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/sv2-header-check.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
on:
push:
branches: [ main, dev ]
branches:
- main
pull_request:
branches: [ main, dev ]
branches:
- main

# Check sv2.h file is up to date with commit
name: sv2.h Header Check
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@ on:
push:
branches:
- main
- dev
pull_request:
branches:
- main
- dev

name: Test, Prop Tests, Example Tests

Expand Down
21 changes: 21 additions & 0 deletions protocols/v2/const-sv2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# const_sv2

[![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)

`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

- **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`:

```toml
[dependencies]
const_sv2 = "2.0.0"
Loading

0 comments on commit 4902f16

Please sign in to comment.