Update docs from RSA to Ed25519 #2606
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
The docs for libp2p's `func New` say:
>If no peer identity is provided, it generates a random RSA 2048
key-pair and derives a new identity from it
Maybe I'm misinterpreting the docs, but I've observed
that the default is actually Ed25519:
```go
node, err := libp2p.New()
if err != nil {
panic(err)
}
fmt.Printf("Peer ID key type: %s\n", node.Peerstore().PrivKey(node.ID()).Type())
```
Which prints "Peer ID key type: Ed25519".
This is further supported by the [Peer Id spec](https://github.com/libp2p/specs/blob/d2106f43e878ae4c3a1c6465a7c329835290fe22/peer-ids/peer-ids.md?plain=1#L119):
>Implementations MUST support Ed25519. Implementations SHOULD support RSA…
This commit updates the function docs to express that the default is Ed25519,
not RSA.
sukunrt
force-pushed
the
docs-incorrect-key-type
branch
from
54a3493
to
af02349
Compare
sukunrt
approved these changes
Nov 11, 2023
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 docs for libp2p's
func Newsay:Maybe I'm misinterpreting the docs, but I've observed that the default is actually Ed25519:
Which prints "Peer ID key type: Ed25519".
This is further supported by the Peer Id spec:
This commit updates the function docs to express that the default is Ed25519, not RSA.