Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BIP40: Stratum wire protocol #1557

Draft
wants to merge 28 commits into
base: master
Choose a base branch
from
Draft

Conversation

ben221199
Copy link

The Stratum wire protocol has a long history since @slush0 introduced it. However, the protocol never got standardized in a formal way, so many implementations have been based on incomplete documents or on other implementations. With this document I finally want to give Stratum its place between the other BIPs, so that developers can just read this document and don't have to search through years of code or dead pages that need to be revived with Wayback Machine.

@ben221199 ben221199 marked this pull request as draft March 7, 2024 15:46
@ben221199
Copy link
Author

Yesterday, I sent two registration requests to IANA to get some information officially egistered. The registries are:

Today, I got a response that for both registrations some things have to be done first, before IANA can add these records to their registry. In case of the Media Types, this is process is a little bit more difficult. For the WebSocket Subprotocol Name Registry it is just letting them know when this pull request is merged and I have a permalink to the specification.

Also, it is possible that I will send more registration requests for other IANA registries too. For example, the Service Name and Transport Protocol Port Number Registry (https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml) is a possible candidate. In that case, I will post new comments about that too.

Copy link
Contributor

@jonatack jonatack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some editorial feedback.

bip-0040.mediawiki Outdated Show resolved Hide resolved
bip-0040.mediawiki Outdated Show resolved Hide resolved
bip-0040.mediawiki Outdated Show resolved Hide resolved
bip-0040.mediawiki Outdated Show resolved Hide resolved
bip-0040.mediawiki Outdated Show resolved Hide resolved
bip-0040.mediawiki Outdated Show resolved Hide resolved
bip-0040.mediawiki Outdated Show resolved Hide resolved
bip-0040.mediawiki Outdated Show resolved Hide resolved
bip-0040.mediawiki Outdated Show resolved Hide resolved
bip-0040.mediawiki Outdated Show resolved Hide resolved
@jonatack
Copy link
Contributor

jonatack commented May 6, 2024

This BIP refers to BIP41, The Stratum mining protocol, for which a BIP number was assigned and an entry exists in the README, but there doesn't seem to be pull request to add the BIP draft -- any update on that?

@ben221199
Copy link
Author

Hi @jonatack, thank you for feedback. I will take a look at it. I didn't have time to work on BIP 40 lately. Yes, both BIP 40 and BIP 41 are already assigned by the README and BIP 41 is also mentioned in this BIP 40. The goal is to finish BIP 40 (Stratum wire protocol) first and then start working on BIP 41 (Stratum mining protocol), referring back to BIP 40, because the mining protocol is based on the wire protocol.

Signed-off-by: Ben van Hartingsveldt <ben.vanhartingsveldt@yocto.com>
@ben221199
Copy link
Author

The media type application/stratum has been registered by IANA at Media Types (https://www.iana.org/assignments/media-types/media-types.xhtml).

Copy link
Contributor

@jonatack jonatack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating. Took a look at the new additions.

bip-0040.mediawiki Show resolved Hide resolved
bip-0040.mediawiki Show resolved Hide resolved
bip-0040.mediawiki Show resolved Hide resolved
bip-0040.mediawiki Show resolved Hide resolved
bip-0040/service-example.mediawiki Outdated Show resolved Hide resolved
bip-0040/service-example.mediawiki Outdated Show resolved Hide resolved
bip-0040.mediawiki Outdated Show resolved Hide resolved
bip-0040.mediawiki Show resolved Hide resolved
@jonatack
Copy link
Contributor

@ben221199 This draft might be missing the following:

- [ ] Backwards compatibility section describing incompatibilities, severity, and suggest mitigations
- [ ] Reference implementation (necessary before status "Final", but not necessary to be accepted)

@ben221199
Copy link
Author

Where should I place that?

@jonatack jonatack changed the title Add draft of BIP 40 BIP40: Stratum wire protocol May 21, 2024
@jonatack
Copy link
Contributor

Where should I place that?

They are generally the last two sections in other BIPs.

@murchandamus murchandamus added the PR Author action required Needs updates, has unaddressed review comments, or is otherwise waiting for PR author label May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
New BIP PR Author action required Needs updates, has unaddressed review comments, or is otherwise waiting for PR author
Projects
None yet
4 participants