STRATUM

Stratum

Project page

..intro.. ..links..

The stratum monorepo is divided in:

protocols: implementation of Sv1 and all Sv2 subprotocol + utilities to work with them
roles: implementation of the Sv2 roles
utils: generic utilities (eg async adaptors)
examples: just example of how to use the crates inside this repo, each example is a binary repo and can be tested with cargo run
test: general tests (eg if crate x can be built on guix, if crate x can be called by C)

Roles

Protocols

Sv2

Stratum v2 is encrypted and it define his custom binary data format. Sv2 is composed by several crates:

serde_sv2: serde serializer and deserializer for the custom binary format, it also export the Sv2 primitive data types.
noise_sv2: used to encrypt and decrypt Sv2 messages.
codec_sv2: encode and decode Sv2 frames.
framing_sv2: Sv2 frame definition and helpers.
common_messages: connection messages used by every (sub)protocol.
mining-protocol: the miner protocol as defined by the Sv2 specs.
job-negotiation-protocol: the job negotiation protocol as defined by the Sv2 specs.
template-distribution-protocol: the template distribution protocol as defined by the Sv2 specs.

Sv1

Exports IsServer and IsClient traits. A client that implement IsClient will be a correct Sv1 client and a server implementing IsServer will be a correct Sv1 server. This library do not assume async framework and do not IO, the implementor must decide how to do IO and how to manage multiple connection. An example of implementation is in protocols/v1/examples/client-and-server, to run the example: cargo run v1. To run the test: cargo test v1

Stratum v1 do not use any kind of encryption. Stratum v1 data format is json so serde-json is imported. Stratum v1 is defined over json-rpc protocol so inside the v1 crate there is a very simple json-rpc module.

Examples

Ping pong with noise

To run ping pong with noise

clone this repo: git clone git@github.com:stratum-mining/stratum.git
go in the right directory: cd ./stratum/examples/ping-pong-with-noise
run with cargo: cargo run

Ping pong without noise

To run ping pong without noise

clone this repo: git clone git@github.com:stratum-mining/stratum.git
go in the right directory: cd ./stratum/examples/ping-pong-without-noise
run with cargo: cargo run

Sv1 client and server

To run Sv1 client and server

clone this repo: git clone git@github.com:stratum-mining/stratum.git
go in the right directory: cd ./stratum/examples/sv1-client-and-server
run with cargo: cargo run

Contrib

Merging policy

Usually an optimistic merging policy is adopted but in particular cases the contribution must be reviewed:

Code is not easy to understand, in this case the reviewer should indicate a simpler implementation.
It add a dependency, in this case a discussion about the new dependency is needed.
It modify the build or deploy process.

For everything else including performance an safety issues just accept the PR then amend the problematic code and do another PR tagging the author of the amended PR.

incker/stratum