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.

Sign up for GitHub

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

Jump to bottom

All crates should have a consistent API & naming #2217

Open
14 of 19 tasks
thomaseizinger opened this issue Sep 7, 2021 Discussed in #2174 · 1 comment
Open
14 of 19 tasks

All crates should have a consistent API & naming #2217

thomaseizinger opened this issue Sep 7, 2021 Discussed in #2174 · 1 comment
Labels
tracking-issue Issues which are the entry point to bigger projects.

Comments

@thomaseizinger
Copy link
Contributor

thomaseizinger commented Sep 7, 2021 •
edited
Loading

Discussed in #2174.

Summary:

Rename symbols within libp2p- sub crates such that they can best be references via the module that is re-exported from the libp2p meta-crate. For example:

use libp2p::ping;

let behaviour = ping::Behaviour::new(ping::Config::default());

Crates

Tasks
Preview Give feedback
  1. Revise naming of libp2p-ping symbols #2215
  2. protocols/ping: Properly deprecate types with Ping prefix #2937
  3. protocols/identify: Revise symbol naming #2927
  4. transports/tcp: Unify symbol naming #2961
  5. refactor(request-response): revise public API to follow naming convention #3159
  6. refactor(relay): revise public API to follow naming convention #3238
  7. refactor(dcutr): reshape public API to follow naming guidelines #3214
  8. mdns: update if-watch to 3.0.0 #3096
    send-it
  9. refactor(gossipsub): revise symbol naming to follow conventions #3303
    send-it
  10. feat(yamux): rename symbols to follow module-based naming convention #3852
  11. feat(noise): deprecate all handshake patterns apart from XX #3768
  12. refactor(plaintext): rename symbols to follow naming convention #4535
    send-it
  13. kad: rename to follow naming convention across repository #4485
    difficulty:easy help wanted
    PanGan21
  14. dns: rename to follow naming convention across repositry #4486
    difficulty:easy help wanted
    whtsht
@thomaseizinger thomaseizinger mentioned this issue Aug 9, 2022
Merged
3 tasks
@thomaseizinger thomaseizinger mentioned this issue Sep 20, 2022
Closed
4 tasks
@jxs jxs mentioned this issue Sep 21, 2022
Merged
4 tasks
@thomaseizinger thomaseizinger mentioned this issue Sep 23, 2022
Merged
4 tasks
@thomaseizinger thomaseizinger added difficulty:easy help wanted getting-started Issues that can be tackled if you don't know the internals of libp2p very well labels Sep 23, 2022
@thomaseizinger
Copy link
Contributor Author

I followed the same approach outlined here in #2859 and introduced top-level dummy and keep_alive modules in libp2p-swarm. I think eventually, it would be great if we can also introduce these top-level modules in libp2p and re-export these kind of modules there. That would allow us to group things like dummy::Behaviour and dummy::ConnectionHandler together under libp2p::dummy which would be consistent with the re-export of sub-crates like libp2p::ping or libp2p::kad.

@thomaseizinger thomaseizinger mentioned this issue Sep 27, 2022
Merged
3 tasks
thomaseizinger added a commit that referenced this issue Sep 30, 2022
@thomaseizinger
Migrate libp2p_tcp to new naming convention
1091df7 
See #2217.
See #2173.
This was referenced Sep 30, 2022
Merged
Merged
elenaf9 added a commit to kpp/rust-libp2p that referenced this issue Oct 4, 2022
@elenaf9
transports/quic: follow naming convention of libp2p#2217
8e729bf
mxinden pushed a commit that referenced this issue Oct 5, 2022
@thomaseizinger
swarm: Split off "keep alive" functionality from `DummyConnectionHand…
bdf9209 
…ler` (#2859)

Previously, the `DummyConnectionHandler` offered a "keep alive" functionality,
i.e. it allowed users to set the value of what is returned from
`ConnectionHandler::keep_alive`. This handler is primarily used in tests or
`NetworkBehaviour`s that don't open any connections (like mDNS). In all of these
cases, it is statically known whether we want to keep connections alive. As
such, this functionality is better represented by a static
`KeepAliveConnectionHandler` that always returns `KeepAlive::Yes` and a
`DummyConnectionHandler` that always returns `KeepAlive::No`.

To follow the naming conventions described in
#2217, we introduce a top-level
`keep_alive` and `dummy` behaviour in `libp2p-swarm` that contains both the
`NetworkBehaviour` and `ConnectionHandler` implementation for either case.
@thomaseizinger thomaseizinger mentioned this issue Nov 8, 2022
Merged
4 tasks
@jxs jxs mentioned this issue Nov 22, 2022
Merged
4 tasks
thomaseizinger added a commit that referenced this issue Dec 8, 2022
@thomaseizinger
Rename public API symbols
160a9c6 
This follows the guidelines discussed in #2217.
This was referenced Dec 8, 2022
Merged
Merged
thomaseizinger added a commit that referenced this issue Dec 8, 2022
@thomaseizinger
Rename public API symbols
6995ff0 
This follows the guidelines discussed in #2217.
mergify bot pushed a commit that referenced this issue Dec 13, 2022
@thomaseizinger
fix(dcutr): rename error types to bypass cargo-semver-checks hickup (…
bffe415 
…#3213)

`cargo semver-checks` is still missing features in regards to properly detecting renamed exports. To make our CI pass again, we remove the renamed export, replace it with type-aliases and deprecate them to point users types exported under a module which now follows the conventions set in #2217.
@jxs jxs mentioned this issue Dec 13, 2022
Merged
4 tasks
mergify bot pushed a commit that referenced this issue Dec 20, 2022
@thomaseizinger
refactor(dcutr): reshape public API to follow naming guidelines (#3214)
93335b8 
With this patch, the naming of types follows the guidelines discussed in #2217.
@thomaseizinger thomaseizinger mentioned this issue Dec 21, 2022
Open
mergify bot pushed a commit that referenced this issue Jan 2, 2023
@jxs
refactor(relay): revise public API to follow naming convention (#3238)
9c96bbb 
Continues addressing #2217.
@StemCll StemCll mentioned this issue Jan 2, 2023
Merged
4 tasks
@thomaseizinger thomaseizinger mentioned this issue Jan 9, 2023
Closed
mergify bot pushed a commit that referenced this issue Jan 27, 2023
@StemCll
refactor(gossipsub): revise symbol naming to follow conventions (#3303)
ab59af4 
Changes regarding the  #2217
@thomaseizinger thomaseizinger mentioned this issue Mar 3, 2023
Merged
4 tasks
@thomaseizinger thomaseizinger mentioned this issue Mar 18, 2023
Closed
This was referenced Apr 6, 2023
Merged
Merged
This was referenced Apr 25, 2023
Merged
Closed
mergify bot pushed a commit that referenced this issue Apr 28, 2023
@thomaseizinger
feat(noise): deprecate all handshake patterns apart from XX
2f5270b 
In the libp2p specs, the only handshake pattern that is specified is the XX handshake. Support for other handshake patterns can be added through external modules. While we are at it, we rename the remaining types to following the laid out naming convention.

The tests for handshakes other than XX are removed. The handshakes still work as we don't touch them in this patch.

Related #2217.

Pull-Request: #3768.
@thomaseizinger thomaseizinger mentioned this issue Apr 28, 2023
Merged
4 tasks
mriise added a commit to mriise/rust-libp2p that referenced this issue Apr 29, 2023
@mriise
follow naming conventions from libp2p#2217
3b0be0a
mergify bot pushed a commit that referenced this issue May 1, 2023
@thomaseizinger
feat(yamux): rename symbols to follow module-based naming convention
b1cdf8d 
Implements our naming convention for the `libp2p-yamux` crate.

Related: #2217.

Pull-Request: #3852.
@thomaseizinger thomaseizinger mentioned this issue Jul 3, 2023
Closed
@thomaseizinger thomaseizinger mentioned this issue Aug 3, 2023
Merged
15 tasks
@thomaseizinger thomaseizinger mentioned this issue Sep 4, 2023
Merged
4 tasks
This was referenced Sep 12, 2023
Closed
Closed
@thomaseizinger thomaseizinger removed help wanted difficulty:easy getting-started Issues that can be tackled if you don't know the internals of libp2p very well labels Sep 12, 2023
@whtsht whtsht mentioned this issue Sep 15, 2023
Merged
4 tasks
@thomaseizinger thomaseizinger changed the title Tracking issue for renaming symbols across the repository Renaming symbols across the repository Sep 19, 2023
@thomaseizinger thomaseizinger changed the title Renaming symbols across the repository All crates should have a consistent API & naming Sep 19, 2023
@thomaseizinger thomaseizinger added the tracking-issue Issues which are the entry point to bigger projects. label Sep 19, 2023
@thomaseizinger thomaseizinger mentioned this issue Sep 21, 2023
Merged
4 tasks
mergify bot pushed a commit that referenced this issue Sep 24, 2023
@whtsht
refactor(dns): unify symbol naming
95890b5 
Renamed the following
- `dns::GenDnsConfig`  ->  `dns::Config`
- `dns::DnsConfig` -> `dns::async_std::Config`
- `dns::TokioDnsConfig` -> `dns::tokio::Config`

If async-std feature is enable, use `dns::async_std::Config`. When using tokio, import `dns::tokio::Config` . There is no need to use `dns::Config` directly.

Resolves #4486.
Related: #2217.

Pull-Request: #4505.
mergify bot pushed a commit that referenced this issue Sep 27, 2023
@thomaseizinger
refactor(plaintext): rename symbols to follow naming convention
fffd47b 
Related: #2217.

Pull-Request: #4535.
@romac romac mentioned this issue Sep 6, 2024
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
tracking-issue Issues which are the entry point to bigger projects.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@thomaseizinger