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

refactor!: remove libp2p.keychain #2084

Merged
merged 5 commits into from
Oct 19, 2023
Merged

Conversation

wemeetagain
Copy link
Member

@wemeetagain wemeetagain commented Sep 27, 2023

Description

  • Remove keychain from the Libp2p interface and Libp2pNode implementation

During an in-person discussion, it was found that the keychain has limited use and value being bundled in libp2p.
The rationale is that libp2p should bundle with only functionality required to run its internal machinery related to managing connections, streams, protocols, etc.

The Keychain interface and implementation have NOT been removed, they've been kept. So, users of the Keychain can instantiate one in their application and continue using it.

Change checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation if necessary (this includes comments as well)
  • I have added tests that prove my fix is effective or that my feature works

@wemeetagain wemeetagain requested a review from a team as a code owner September 27, 2023 15:48
maschad
maschad previously approved these changes Oct 2, 2023
Copy link
Member

@maschad maschad left a comment

Choose a reason for hiding this comment

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

LGTM

@achingbrain
Copy link
Member

Please hold off merging breaking changes until we resolve WebRTC stream closing

@maschad maschad marked this pull request as draft October 9, 2023 19:57
@maschad maschad dismissed their stale review October 9, 2023 19:58

Let's review and merge this once #2104 is resolved.

@maschad maschad marked this pull request as ready for review October 9, 2023 19:58
@achingbrain achingbrain changed the base branch from master to release-v1.0 October 10, 2023 11:29
Copy link
Member

@achingbrain achingbrain left a comment

Choose a reason for hiding this comment

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

LGTM. I've targeted the v1 release branch - please can you add some copy to the migration guide to cover these breaking changes.

@achingbrain achingbrain self-requested a review October 12, 2023 12:59
Copy link
Member

@achingbrain achingbrain left a comment

Choose a reason for hiding this comment

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

Dismissed review by accident, just needs migration instructions to help people upgrade.

LGTM. I've targeted the v1 release branch - please can you add some copy to the migration guide to cover these breaking changes.

@wemeetagain wemeetagain merged commit c9be36f into release-v1.0 Oct 19, 2023
17 checks passed
@wemeetagain wemeetagain deleted the refactor/remove-keychain branch October 19, 2023 19:32
achingbrain added a commit that referenced this pull request Oct 31, 2023
* refactor!: remove libp2p.keychain

* chore: remove @libp2p/keychain dep from libp2p

* chore: add migration documentation

---------

Co-authored-by: Alex Potsides <alex@achingbrain.net>
achingbrain pushed a commit that referenced this pull request Oct 31, 2023
Extract the keychain into it's own package.
achingbrain pushed a commit that referenced this pull request Nov 3, 2023
Extract the keychain into it's own package.
achingbrain pushed a commit that referenced this pull request Nov 7, 2023
Extract the keychain into it's own package.
achingbrain pushed a commit that referenced this pull request Nov 8, 2023
Extract the keychain into it's own package.
achingbrain pushed a commit that referenced this pull request Nov 10, 2023
Extract the keychain into it's own package.
maschad pushed a commit to maschad/js-libp2p that referenced this pull request Nov 10, 2023
Extract the keychain into it's own package.
achingbrain pushed a commit that referenced this pull request Nov 15, 2023
Extract the keychain into it's own package.
@github-actions github-actions bot mentioned this pull request Nov 15, 2023
@github-actions github-actions bot mentioned this pull request Nov 17, 2023
@github-actions github-actions bot mentioned this pull request Nov 29, 2023
This was referenced Jan 18, 2024
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.

3 participants