https://github.com/ccdle12/rust-stratum-v2

A library implementation in Rust of the Stratum V2 Protocol.
https://github.com/ccdle12/rust-stratum-v2

bitcoin bitcoin-mining rust stratum stratum-pool stratum-protocol stratum-proxy

Last synced: about 9 hours ago
JSON representation

A library implementation in Rust of the Stratum V2 Protocol.

• Host: GitHub
• URL: https://github.com/ccdle12/rust-stratum-v2
• Owner: ccdle12
• Created: 2020-11-07T09:17:16.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-10-15T14:12:25.000Z (about 3 years ago)
• Last Synced: 2023-03-23T01:06:45.230Z (almost 2 years ago)
• Topics: bitcoin, bitcoin-mining, rust, stratum, stratum-pool, stratum-protocol, stratum-proxy
• Language: Rust
• Homepage:
• Size: 85 MB
• Stars: 15
• Watchers: 3
• Forks: 4
• Open Issues: 30
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![workflow](https://github.com/ccdle12/rust-stratum-v2/actions/workflows/rust.yml/badge.svg)

# Rust Stratum V2

A WIP library implementation of the [Stratum V2 Protocol](https://braiins.com/stratum-v2).

The detailed spec can be found [here](https://docs.google.com/document/d/1FadCWj-57dvhxsnFM_7X806qyvhR0u3i85607bGHxvg/edit#heading=h.we2r5emgsjcx).

## Building

The library can be built and tested using [`cargo`](https://github.com/rust-lang/cargo/):

```

git clone [email protected]:ccdle12/rust-stratum-v2.git

cd rust-stratum-v2

cargo build

```

## Tests

You can run tests with:

```

cargo test

```

Please refer to the [`cargo` documentation](https://doc.rust-lang.org/stable/cargo/) for more detailed instructions.

See [fuzz tests](/fuzz/README.md) for instructions on how to run fuzzing.

## Documentation

Documentation can be built locally using cargo:

```

cargo doc --no-deps --open

```

## Examples

Examples can be found [here](/examples) and the [README](/examples/README.md)

contains instructions on how to run the examples.