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

kademlia: shrink public API of libp2p-kad #3533

Closed
thomaseizinger opened this issue Mar 1, 2023 · 3 comments
Closed

kademlia: shrink public API of libp2p-kad #3533

thomaseizinger opened this issue Mar 1, 2023 · 3 comments
Labels
difficulty:easy getting-started Issues that can be tackled if you don't know the internals of libp2p very well help wanted priority:nicetohave

Comments

@thomaseizinger
Copy link
Contributor

Description

Currently, libp2p-kad has several public modules like handler that don't need to be public. This makes it much more likely that a change is breaking in practice despite likely being irrelevant to users. See #3504 for an example.

Implementation suggestion

We want to ship this as a non-breaking change, thus we should adopt a similar approach as done in #3238 where we first deprecate these modules with a note that they will be made private.

Are you planning to do it yourself in a pull request?

No.
@thomaseizinger thomaseizinger mentioned this issue Mar 1, 2023
Closed
4 tasks
@thomaseizinger thomaseizinger added priority:nicetohave difficulty:easy help wanted getting-started Issues that can be tackled if you don't know the internals of libp2p very well labels Mar 1, 2023
@umgefahren
Copy link
Contributor

Should I get the grant filecoin-project/devgrants#1421, I would include that.

@tcoratger
Copy link
Contributor

@thomaseizinger Does #3738 solve this issue or is this issue more global and it therefore corresponds to the complete removal of the public modules for the moment notified as deprecated in #3738?

@thomaseizinger
Copy link
Contributor Author

It is resolved by #3738, well spotted!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
difficulty:easy getting-started Issues that can be tackled if you don't know the internals of libp2p very well help wanted priority:nicetohave
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@thomaseizinger @umgefahren @tcoratger