multiformats/rust-multiaddr

Mark `/wss` as deprecated

Open

#100 opened on Sep 12, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (55 forks)github user discovery
difficulty:easyhelp wanted

Repository metrics

Stars
 (101 stars)
PR merge metrics
 (PR metrics pending)

Description

According to the multiaddr spec, /wss is deprecated, see https://github.com/multiformats/multiaddr/blob/master/protocols.csv#L33.

We should reflect this in the code such that downstream users can upgrade accordingly. I'd suggest we mark it as #[deprecated] first, do a point release and remove it in 0.19.

Contributor guide

Research direction
Add the `#[deprecated]` attribute to the `/wss` protocol definition in the multiaddr codebase, and update any related documentation to indicate deprecation.
Tech stack
rust
Domain
networking
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70