add support for open group channels with upstream node

Stabilize Pool

#106

Automatize version increment

Useful links:

https://towardsdatascience.com/setup-version-increment-and-automated-release-process-591d87ea1221

No Serde codec derive only support 'decoder lifetime name

Encodable and decodable only support struct that have no lifetimes parameters or only one lifetime parameter named decoder.
Encodable and decodable should support every struct, the only requirement should be that each struct's field must be encodable and decodable.

Realize Proxy For Alpha Trial

What

Intermediate phase of Realize Proxy. It consist in the realization of a proxy with all what is
needed in order to do an alpha trial of Sv2

Why

We want to prioritize the alpha trial as feedbacks and reviews of what has been done is very much
needed.

How

add test for the other examples

Improve tests

Add support for AES in Noise protocol:

https://github.com/braiins/braiins-open/blob/master/protocols/stratum/src/v2/noise.rs#L220

https://github.com/braiins/braiins-open/blob/master/protocols/stratum/src/v2/noise.rs#L419

https://github.com/stratum-mining/stratum/blob/main/protocols/v2/noise-sv2/src/lib.rs#L116

remove all the panic and unwrap

Remove panics

Useful links:

rustls/rustls#447

Realize Proxy

What

Realization of a proxy that is:

configurable (easy to configure for the wanted scenario via config files)
efficient (it must be fast)
expandable (it must be easy to modify the code in order to add new supported scenarios)
easy to use (deploy the proxy must be very easy)

Why

TODO

How

Start alpha trial

Tracking issue

Use `shrink` for prop tests

When implementing Arbitrary we should also implement shrink.

Example from @Fi3:

fn shrink(&self) -> Box<dyn Iterator<Item = Self>> {
           let value = self.clone().0;
           match value.template_id {
               0 => empty_shrinker(),
               _ => {
                   let mut shrinked_ids: Vec<NewTemplate> = vec![];
                   for id in 0..value.template_id {
                       let mut shrinked_value = value.clone();
                       shrinked_value.template_id = id;
                       shrinked_ids.push(shrinked_value);
                   };
                   Box::new(shrinked_ids.into_iter().map(|x| RandomNewTemplate(x)))
               }
           }
       }

No serde codec do not support enum

Is impossible to derive encodable and decodable for enums. Add this feature.
https://github.com/stratum-mining/stratum/blob/main/protocols/v2/binary-sv2/no-serde-sv2/derive_codec/src/lib.rs

add script to run before pull in order to run the github actions locally

Template Provider Implementation and Integration

What

Implement a Sv2 Template Provider in Bitcoin Core.

Why

Allows Bitcoin Core to act as a Template Provider to StratumV2 Proxies.

How

Always use property based testing where possible

add the Proxy role

remove all the TODOs

add test for interop cpp (it should try to build it and run the example)

Stabilize SV2 Proxy

Stabilize Proxy

add a new thread or process that manage the TP logic

Tracking issue (that will be realized in /stratum-mining/bitcoin)

add a way to calculate code coverage

Improve roles-logic-sv2 interface usability

Improve messages-sv2 interface usability

The crate messages-sv2 that is a crate that stay between the low levels crates (subprotocols, codec,
noise, binary, framing) and the high level roles implementation it export an interface that make some very
recurrent operation rather complex to execute. The exported interface should be refactored in order
to make this operations easier. (Performance must have priority on usability btw)

Implement the TP logic

Tracking issue (that will be realized in /stratum-mining/bitcoin)

add support for open standard channel upstream issue

refactor the errors

No Serder codec can not parse struct with docs comment

The derive macros that parse struct decodable and encodable should remove every doc comment from the token stream before to parse it.

Run GitHub Actions rustfmt on Examples

When running rustfmt on the examples, the compiler complains that async features are not permitted in Rust 2015 and suggests to update the Cargo.toml to the 2018 edition. However, the Cargo.toml does specify the 2018 edition. I do not know where this discrepancy is originating from.

$ rustfmt examples/sv1-client-and-server/src/*
error[E0670]: `async fn` is not permitted in Rust 2015
  --> /home/rrybarczyk/Dev/stratum-v2/stratum/examples/sv1-client-and-server/src/main.rs:43:1
   |
43 | async fn server_pool() {
   | ^^^^^ to use `async fn`, switch to Rust 2018 or later
   |
   = help: set `edition = "2018"` in `Cargo.toml`
   = note: for more on editions, read https://doc.rust-lang.org/edition-guide

error[E0670]: `async fn` is not permitted in Rust 2015
  --> /home/rrybarczyk/Dev/stratum-v2/stratum/examples/sv1-client-and-server/src/main.rs:55:9
   |
55 |     pub async fn new(stream: TcpStream) -> Arc<Mutex<Self>> {
   |         ^^^^^ to use `async fn`, switch to Rust 2018 or later
   |
   = help: set `edition = "2018"` in `Cargo.toml`
   = note: for more on editions, read https://doc.rust-lang.org/edition-guide

error: expected one of `!`, `)`, `,`, `.`, `::`, `?`, `{`, or an operator, found keyword `move`
  --> /home/rrybarczyk/Dev/stratum-v2/stratum/examples/sv1-client-and-server/src/main.rs:63:27
   |
63 |         task::spawn(async move {
   |                           ^^^^ expected one of 8 possible tokens

To solve this issue, the reason for edition discrepancy needs to be found and fixed, then the rustfmt lint action needs to be added to .github/workflows/rust.yaml for each example.

list all the most recurrent operations in the Proxy

Refactor Errors

Errors in the low level crates are not well designed. That because it would have been much more effective to
design them when the low level crates are functionally complete tested and used in other crates.
So all the Error(s) in the project must be refactored.