fix: throw if no conn encryption module provided #665
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jacobheun
reviewed
Jun 11, 2020
Co-authored-by: Jacob Heun <jacobheun@gmail.com>
achingbrain
added a commit
to ipfs/js-ipfs
that referenced
this pull request
Jun 13, 2020
Since the `v0.28.1` point release, libp2p now requires a connection enryption module to be passed in config, otherwise it throws. See: libp2p/js-libp2p#665
|
*cough* *cough* breaking change *cough* *cough* |
achingbrain
added a commit
to ipfs/js-ipfs
that referenced
this pull request
Jun 13, 2020
Since the `v0.28.1` patch release, libp2p requires a connection encryption module to be passed in config, otherwise it throws. See: libp2p/js-libp2p#665
|
You're right, this is an api change. While this shouldn't break production applications as it is required for libp2p to function properly, it can break testing environments for people. I'll do a revert commit for this and move this to an 0.29 branch. |
jacobheun
added a commit
that referenced
this pull request
Jun 15, 2020
This reverts commit c038550.
jacobheun
added a commit
that referenced
this pull request
Jun 15, 2020
This reverts commit c038550.
|
Reverted in v0.28.2 |
jacobheun
added a commit
that referenced
this pull request
Jun 15, 2020
…)" This reapplies commit b621fbd.
|
Branch 0.29.x has been created for the next minor release. The change has been reapplied for that branch. |
jacobheun
added a commit
that referenced
this pull request
Jul 13, 2020
…)" This reapplies commit b621fbd.
jacobheun
added a commit
that referenced
this pull request
Jul 14, 2020
…)" This reapplies commit b621fbd.
vasco-santos
added a commit
that referenced
this pull request
Jul 15, 2020
…)" This reapplies commit b621fbd.
vasco-santos
added a commit
that referenced
this pull request
Jul 30, 2020
…)" This reapplies commit b621fbd.
jacobheun
pushed a commit
that referenced
this pull request
Aug 12, 2020
…)" This reapplies commit b621fbd.
jacobheun
pushed a commit
that referenced
this pull request
Aug 27, 2020
…)" This reapplies commit b621fbd.
oliveriosousa
pushed a commit
to ipfs-examples/js-ipfs-examples
that referenced
this pull request
Jul 26, 2021
Since the `v0.28.1` patch release, libp2p requires a connection encryption module to be passed in config, otherwise it throws. See: libp2p/js-libp2p#665
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The main focus of this PR is throwing an error if a connEncryption module is not provided.
With that in mind, it also improves the configuration docs visibility from the
Libp2p.createAPI doc, as well as that transports and connEncryption modules are required.It also changes the peerDiscovery example to use the discovery module tag and be coherent with the docs.
Fixes #664