search

stratum-mining / sv2-spec

Stratum V2 Specification
57 stars 28 forks source link

V1 Specs #88

Open plebhash opened 2 weeks ago

plebhash commented 2 weeks ago

During BTC Prague, the team realized the opportunity to collaborate with industry players on coming up with a unified Specification for Stratum V1.

I propose we approach this way:

TheBlueMatt commented 2 weeks ago

This is a great initiative, and someone finally bothering to write down how stratum v1 works is a great idea, but I'd caution against spending too much time trying to document all the various random forks and extensions and wrappers and such that people have done to Sv1 because (a) there's lots to do for Sv2 and (b) there's a lot of them and most of them won't ever have more than one implementation. IMO it'd be great to document the parts of Sv1 that SRI implements, and no more.

plebhash commented 2 weeks ago

As suggested by @Fi3 https://github.com/stratum-mining/sv2-spec/pull/89#issuecomment-2171784473:

Why not having 2 separate repo? At the end sv1 and sv2 are very different

I don't have strong opinions, so I closed PR #89 in favor of github.com/stratum-mining/sv1-specs

This PR added some boilerplate markdown to v1 directory, which can be ported over to the new repo.

IMO it'd be great to document the parts of Sv1 that SRI implements, and no more.

This is quite aligned with the action plan we discussed in Prague. The idea is to cover the core SV1 messages living under sv1_api, which has already been mostly done as Rust Docs.

Then we want to invite community players to contribute with specs for the new features they are introducing.

The boilerplate for those custom features I introduced there is not opinionated, and they are free to propose alternative structures. Then, we would contribute as reviewers.

I'll avoid closing this issue in case anyone else wants to voice their ideas around SRI including SV1 specs.