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

p2p-circuit v2 spec #325

Merged
merged 46 commits into from
Jun 29, 2021
Merged

p2p-circuit v2 spec #325

merged 46 commits into from
Jun 29, 2021

Conversation

vyzo
Copy link
Contributor

@vyzo vyzo commented May 5, 2021

No description provided.

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.

🙏 Thanks @vyzo for creating the draft!

relay/circuit-v2.md Outdated Show resolved Hide resolved
relay/circuit-v2.md Outdated Show resolved Hide resolved
relay/circuit-v2.md Outdated Show resolved Hide resolved
relay/circuit-v2.md Outdated Show resolved Hide resolved
relay/circuit-v2.md Outdated Show resolved Hide resolved
relay/circuit-v2.md Outdated Show resolved Hide resolved
relay/circuit-v2.md Outdated Show resolved Hide resolved
relay/circuit-v2.md Outdated Show resolved Hide resolved
optional int64 data = 2; // bytes
}

enum Status {
Copy link
Member

Choose a reason for hiding this comment

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

I would prefer to split Status in HopStatus and StopStatus, making invalid states impossible at the type level.

See libp2p/go-libp2p-circuit#125

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it's type pollution and these invalidities are very much trivial; I don't feel too strongly about it however.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also, implementations must be prepared to handle unknown error status codes anyway, to support future extensions.

relay/circuit-v1.md Outdated Show resolved Hide resolved
@mxinden mxinden linked an issue May 5, 2021 that may be closed by this pull request
vyzo and others added 7 commits May 5, 2021 21:04
Co-authored-by: Max Inden <mail@max-inden.de>
Co-authored-by: Max Inden <mail@max-inden.de>
Co-authored-by: Max Inden <mail@max-inden.de>
Co-authored-by: Max Inden <mail@max-inden.de>
Co-authored-by: Max Inden <mail@max-inden.de>
Co-authored-by: Max Inden <mail@max-inden.de>
Co-authored-by: Max Inden <mail@max-inden.de>
@vyzo vyzo changed the title [WIP] p2p-circuit v2 spec p2p-circuit v2 spec May 10, 2021
@vyzo
Copy link
Contributor Author

vyzo commented May 10, 2021

Fleshed out the remaining sections and turned the thorny integers into unsigned.

@mxinden this should be ready for review; note the changes in the vouchers, they are now signed envelopes (which means both our implementations will need to change).

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.

Fleshed out the remaining sections

Thank you for the detailed protocol description. Very much appreciated.

relay/circuit-v2.md Outdated Show resolved Hide resolved
relay/circuit-v2.md Outdated Show resolved Hide resolved
relay/circuit-v2.md Outdated Show resolved Hide resolved
relay/circuit-v2.md Outdated Show resolved Hide resolved
relay/circuit-v2.md Outdated Show resolved Hide resolved
relay/circuit-v2.md Outdated Show resolved Hide resolved
relay/circuit-v2.md Show resolved Hide resolved
relay/circuit-v2.md Show resolved Hide resolved
relay/circuit-v2.md Show resolved Hide resolved
relay/circuit-v2.md Show resolved Hide resolved
mxinden and others added 7 commits May 10, 2021 16:12
For the sake of consistency across the specifications use plantuml to
picture circuit relay v2 protocol interaction.
Co-authored-by: Max Inden <mail@max-inden.de>
Co-authored-by: Max Inden <mail@max-inden.de>
Co-authored-by: Max Inden <mail@max-inden.de>
Co-authored-by: Max Inden <mail@max-inden.de>
Co-authored-by: Max Inden <mail@max-inden.de>
relay/circuit-v2: Replace excalidraw with plantuml
@vyzo
Copy link
Contributor Author

vyzo commented May 11, 2021

summoning @Stebalien @raulk -- this is ready for your review.

relay/circuit-v2.md Outdated Show resolved Hide resolved
relay/circuit-v2.md Outdated Show resolved Hide resolved
vyzo and others added 11 commits May 18, 2021 17:12
Co-authored-by: raulk <raul@protocol.ai>
Co-authored-by: raulk <raul@protocol.ai>
Co-authored-by: raulk <raul@protocol.ai>
Co-authored-by: raulk <raul@protocol.ai>
Co-authored-by: raulk <raul@protocol.ai>
Co-authored-by: raulk <raul@protocol.ai>
Co-authored-by: raulk <raul@protocol.ai>
Co-authored-by: raulk <raul@protocol.ai>
Co-authored-by: raulk <raul@protocol.ai>
Co-authored-by: raulk <raul@protocol.ai>
Co-authored-by: raulk <raul@protocol.ai>
@jacobheun
Copy link
Contributor

@mxinden any concerns with landing this? The spec is still working draft so edits can still be subsequently pushed as needed until we hit Candidate Recommendation.

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.

@mxinden any concerns with landing this? The spec is still working draft so edits can still be subsequently pushed as needed until we hit Candidate Recommendation.

Merging and addressing all future changes through separate pull requests sounds good to me.

In general I am in favor of many small pull requests over one large pull request, as a single large pull request is at risk of being stalled due to a couple small discussion points.

@raulk raulk mentioned this pull request Jun 2, 2021
6 tasks
@mxinden
Copy link
Member

mxinden commented Jun 7, 2021

@vyzo friendly ping. Can this be merged?

@vyzo
Copy link
Contributor Author

vyzo commented Jun 7, 2021 via email

@vyzo
Copy link
Contributor Author

vyzo commented Jun 8, 2021

@raulk this should be ready for merge.

@mxinden
Copy link
Member

mxinden commented Jun 25, 2021

@vyzo @raulk friendly ping. Any objections to this being merged?

@vyzo
Copy link
Contributor Author

vyzo commented Jun 25, 2021

no objections from me, waiting on @raulk to green tick.

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.

Add spec fo circuit relay v2 protocol
4 participants