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

[CONTENT REQUEST] document peer ids more thoroughly #1849

Open
Tracked by #1827
autonome opened this issue Apr 18, 2024 · 3 comments
Open
Tracked by #1827

[CONTENT REQUEST] document peer ids more thoroughly #1849

autonome opened this issue Apr 18, 2024 · 3 comments
Labels
need/triage Needs initial labeling and prioritization

Comments

@autonome
Copy link
Contributor

I couldn't find documentation on peer ids, aside from a brief glossary entry which linked to the DHTs page. That page doesn't talk about the nature of peer ids themselves, just how they're used in the DHT.

At minimum, it should link to the libp2p documentation on the topic: https://docs.libp2p.io/concepts/fundamentals/peers/

A common topic I get questions about is peer id stability / life-cycle.

Here's a list of topics to cover off the top of my head:

  • how do the various mature implementations create peer ids? and when?
  • how are they managed, and where?
  • what are the conditions under which a peer id would change?
  • as a developer, what are some reasons i might want to change my peer id?
  • what are the repercussions of changing a peer id?
  • what are some common patterns/challenges in ipfs applications which use peer ids as identity?
@autonome
Copy link
Contributor Author

also, the docs are not consistent in how peer ids are referred to.

if you type peerid into search, you get zero results.

if you type peer id you get the glossary entry, which consistently uses peer id.

the glossary entry links to the dht page which doesn't use peer id at all, and only uses peerId.

@autonome
Copy link
Contributor Author

  • where's the key pair that the id is derived from?
  • can i use it for other things, like in dapps?
  • can i use it to encrypt and share stuff?
  • should i? what are benefits and risks of doing so?

@lidel lidel added the need/triage Needs initial labeling and prioritization label May 2, 2024
@Haosmozga Haosmozga mentioned this issue May 3, 2024
@2color
Copy link
Member

2color commented May 22, 2024

I was investigating the basics of PeerIDs and key types as part of basic research for this (and a related project), and had some questions which I posted in the libp2p forum: https://discuss.libp2p.io/t/questions-regarding-peerids-key-types-and/2330.

Sharing here as it's probably relevant for this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need/triage Needs initial labeling and prioritization
Projects
None yet
Development

No branches or pull requests

3 participants