Skip to content

Commit dd09242

Browse files
p-shahiBigLepElPaisano
authored
Update libp2p.md to account for docs.libp2p.io changes (#1650)
* Update libp2p.md to account for docs.libp2p.io changes Co-authored-by: Steve Loeppky <[email protected]> Co-authored-by: ElPaisano <[email protected]>
1 parent c5b7983 commit dd09242

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

docs/concepts/libp2p.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,31 @@
11
---
22
title: libp2p
33
sidebarDepth: 0
4-
description: Learn about the Libp2p protocol and why it's an important ingredient in how IPFS works.
4+
description: Learn about the libp2p protocol and why it's an important ingredient in how IPFS works.
55
related:
6-
'What is Libp2p?': https://docs.libp2p.io/introduction/#what-is-libp2p
7-
'Foundational Libp2p concepts': https://docs.libp2p.io/concepts/
8-
'Getting started with Libp2p': https://docs.libp2p.io/guides/
9-
'Examples of Libp2p key features': https://docs.libp2p.io/guides/
6+
'What is libp2p?': https://docs.libp2p.io/concepts/introduction/overview/
7+
'Foundational libp2p concepts': https://docs.libp2p.io/concepts/
8+
'Getting started with libp2p': https://docs.libp2p.io/guides/
109
---
1110

1211
# libp2p
1312

14-
Libp2p, (short for “library peer-to-peer”) is a peer-to-peer (P2P) networking framework that enables the development of P2P applications. It consists of a collection of protocols, specifications, and libraries that facilitate P2P communication between network participants or, in other words, peers.
13+
libp2p, (short for “library peer-to-peer”) is a peer-to-peer (P2P) networking framework that enables the development of P2P applications. It consists of a collection of protocols, specifications, and libraries that facilitate P2P communication between network participants or, in other words, peers.
1514

1615
## P2P basics
1716

1817
P2P networks are _decentralized_, meaning that participants communicate directly with one another on equal footing. More specifically:
1918

2019
- P2P networks do not require a privileged set of servers that behave differently from their clients, as in the predominant client-server model.
2120
- No central server or authority controls the network.
22-
21+
2322

2423
P2P networks can take many forms, including file-sharing systems like BitTorrent, blockchain networks like Bitcoin and Ethereum, and decentralized communication standards like Matrix. These systems all have different challenges and tradeoffs,
2524
but they share the goal of improving upon the traditional client-server networking model.
2625

2726
## Background of libp2p and IPFS
2827

29-
Libp2p was initially developed as the wire protocol for the IPFS project, but has since phased out into a broader networking stack that a wide range of other projects use as a networking layer. It provides a set of specifications that can be adapted to support various protocols, allowing developers to create libp2p applications that can operate in multiple runtimes and networking environments.
28+
libp2p was initially developed as the wire protocol for the IPFS project, but has since phased out into a broader networking stack that a wide range of other projects use as a networking layer. It provides a set of specifications that can be adapted to support various protocols, allowing developers to create libp2p applications that can operate in multiple runtimes and networking environments.
3029

3130
Discovering and connecting with other peers is a key challenge in P2P networking. Before libp2p, each P2P application had to develop its own solution, leading to a lack of reusable, well-documented P2P protocols. The IPFS team looked at existing research and networking applications for inspiration, but found few code implementations that were usable and adaptable. Existing implementations had problems like:
3231

@@ -36,16 +35,16 @@ Discovering and connecting with other peers is a key challenge in P2P networking
3635
- No point of contact.
3736
- Being closed source, deprecated, or lacked specifications.
3837
- Unfriendly APIs.
39-
- Tight coupling with specific use cases.
40-
- Lack of upgradeability.
38+
- Tight coupling with specific use cases.
39+
- Lack of upgradeability.
4140

4241
As a result, developers often had to reinvent the wheel each time they needed P2P protocols rather than being able to reuse existing solutions.
4342

44-
Libp2p was designed to address these limitations.
43+
libp2p was designed to address these limitations.
4544

4645
## Features
4746

48-
The features of Libp2p are listed below. For more information on each feature, click the link to navigate to the appropriate page in the [official Libp2p documentation](https://docs.libp2p.io).
47+
The features of libp2p are listed below. For more information on each feature, click the link to navigate to the appropriate page in the [official libp2p documentation](https://docs.libp2p.io).
4948

5049
- [Flexible addressing](https://docs.libp2p.io/concepts/addressing/)
5150

@@ -55,9 +54,7 @@ The features of Libp2p are listed below. For more information on each feature, c
5554

5655
- [Peer identity](https://docs.libp2p.io/concepts/fundamentals/peers/#peer-id)
5756

58-
- [Peer routing](https://docs.libp2p.io/introduction/#peer-routing)
59-
60-
- [Content discovery](https://docs.libp2p.io/concepts/introduction/overview/#content-discovery)
57+
- [Peer routing](https://docs.libp2p.io/concepts/appendix/glossary/#peer-routing)
6158

6259
- [NAT traversal](https://docs.libp2p.io/concepts/nat/)
6360

@@ -74,6 +71,6 @@ Check out the [libp2p documentation](https://docs.libp2p.io/concepts/pubsub/over
7471
- [The libp2p documentation](https://docs.libp2p.io/)
7572
- [The libp2p website](https://libp2p.io/)
7673
- [The libp2p connectivity site](https://connectivity.libp2p.io/)
77-
- [The libp2p YouTube channel to Libp2p](https://www.youtube.com/@libp2p630)
74+
- [The libp2p YouTube channel to libp2p](https://www.youtube.com/@libp2p630)
7875
- [The libp2p technical specifications](https://github.com/libp2p/specs)
7976
- [Protocol Labs Research - ResNetLab on Tour](https://research.protocol.ai/tutorials/resnetlab-on-tour/)

0 commit comments

Comments
 (0)