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

fix: Rename Protocol::WebRTC string rep /webrtc to /webrtc-direct #84

Merged
merged 3 commits into from
Mar 23, 2023

Conversation

mxinden
Copy link
Member

@mxinden mxinden commented Mar 22, 2023

Considered non-breaking change as /webrtc will still be parsed to Protocol::WebRTC and no known production deployment of libp2p-webrtc known.

See multiformats/multiaddr#150 (comment) for context.

@melekes @thomaseizinger can you take a look?

Considered non-breaking change as `/webrtc` will still be parsed to
`Protocol::WebRTC` and no known production deployment of `libp2p-webrtc` known.

See multiformats/multiaddr#150 (comment)
for context.
Copy link
Contributor

@thomaseizinger thomaseizinger left a comment

Choose a reason for hiding this comment

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

LGTM!

CHANGELOG.md Outdated

- Rename string representation of `WebRTC` protocol from `/webrtc` to `/webrt-direct`.
For backwards compatibility `/webrtc` will still be decoded to `Protocol::WebRTC`, but `Protocol::WebRTC` will from now on always be encoded as `/webrtc-direct`.
See [multiformats/multiaddr discussion] for context.
Copy link
Contributor

Choose a reason for hiding this comment

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

Missing link.

src/protocol.rs Outdated
@@ -200,6 +200,7 @@ impl<'a> Protocol<'a> {
"p2p-websocket-star" => Ok(Protocol::P2pWebSocketStar),
"p2p-webrtc-star" => Ok(Protocol::P2pWebRtcStar),
"webrtc" => Ok(Protocol::WebRTC),
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we emit a log here that this variant is deprecated?

@mxinden mxinden merged commit 1b363b0 into multiformats:v0.17 Mar 23, 2023
@mxinden
Copy link
Member Author

mxinden commented Mar 23, 2023

Tagged and published.

mxinden added a commit to mxinden/rust-multiaddr that referenced this pull request Mar 23, 2023
…t` (multiformats#84)

Considered non-breaking change as `/webrtc` will still be parsed to
`Protocol::WebRTC` and no known production deployment of `libp2p-webrtc` known.

See multiformats/multiaddr#150 (comment)
for context.
mxinden added a commit that referenced this pull request Mar 23, 2023
…t` (#84) (#87)

Considered non-breaking change as `/webrtc` will still be parsed to
`Protocol::WebRTC` and no known production deployment of `libp2p-webrtc` known.

See multiformats/multiaddr#150 (comment)
for context.
melekes added a commit to melekes/substrate that referenced this pull request May 31, 2023
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.

2 participants