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

noise: remove interface definition #452

Merged
merged 1 commit into from
Sep 15, 2022
Merged

Conversation

marten-seemann
Copy link
Contributor

The interface exposed by a libp2p Noise implementation is highly implementation-specific. Really, there’s no reason to even suggest something like SecureInbound and SecureOutbound, there are other ways to implement (and name) this that are equally conformant with this spec and interoperable with other implementations.

More importantly, the references made to early data in this section directly contradict what we’re planning to do with early data for WebTransport (#404), WebRTC (#412) and muxer negotiation (#446).

Copy link
Member

@mxinden mxinden left a comment

Choose a reason for hiding this comment

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

I am in favor of this change in particular and I am in favor of removal of programming API specifications in general. I don't think we should aim for libp2p implementations to be "compatible" on the API level, but only on the network level.

Thanks @marten-seemann.

I think it makes sense to bump the revision version, even though there is no change to the wire format. What do you think?

@marten-seemann
Copy link
Contributor Author

I think it makes sense to bump the revision version, even though there is no change to the wire format. What do you think?

I don't think so, this is just a (very large) editorial change. #453 will bump the version number anyway.

@marten-seemann marten-seemann merged commit 2f65a89 into master Sep 15, 2022
@marten-seemann marten-seemann deleted the noise-remove-interface branch September 15, 2022 18:16
Copy link
Contributor

@julian88110 julian88110 left a comment

Choose a reason for hiding this comment

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

I agree the interface implementation details dose not belong to the spec.

one general thought is that instead of defining the API, do we want to replace it with a brief general description of high level functions?

@marten-seemann
Copy link
Contributor Author

do we want to replace it with a brief general description of high level functions?

We describe that this is a secure channel? Is there anything you'd like to add to that?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants