mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2026-02-10 23:20:55 +00:00
fix ci not running lint, bump pre-commit-hooks version
This commit is contained in:
106
README.md
106
README.md
@ -31,92 +31,92 @@ py-libp2p aims for conformity with [the standard libp2p modules](https://libp2p.
|
||||
|
||||
| libp2p Node | Status |
|
||||
| ------------ | :----: |
|
||||
| **`libp2p`** | ✅ |
|
||||
| **`libp2p`** | ✅ |
|
||||
|
||||
| Core Protocols | Status |
|
||||
| -------------- | :----: |
|
||||
| **`Ping`** | ✅ |
|
||||
| **`Identify`** | ✅ |
|
||||
| **`Ping`** | ✅ |
|
||||
| **`Identify`** | ✅ |
|
||||
|
||||
| Transport Protocols | Status |
|
||||
| ------------------- | :----: |
|
||||
| **`TCP`** | ✅ |
|
||||
| **`TCP`** | ✅ |
|
||||
| **`QUIC`** | 🛠️ |
|
||||
| **`UDP`** | 🚫 |
|
||||
| **`WebSockets`** | ❌ |
|
||||
| **`UTP`** | ❌ |
|
||||
| **`WebRTC`** | ❌ |
|
||||
| **`SCTP`** | ❌ |
|
||||
| **`Tor`** | ❌ |
|
||||
| **`i2p`** | ❌ |
|
||||
| **`cjdns`** | ❌ |
|
||||
| **`Bluetooth LE`** | ❌ |
|
||||
| **`Audio TP`** | ❌ |
|
||||
| **`Zerotier`** | ❌ |
|
||||
| **`UDP`** | 🚫 |
|
||||
| **`WebSockets`** | ❌ |
|
||||
| **`UTP`** | ❌ |
|
||||
| **`WebRTC`** | ❌ |
|
||||
| **`SCTP`** | ❌ |
|
||||
| **`Tor`** | ❌ |
|
||||
| **`i2p`** | ❌ |
|
||||
| **`cjdns`** | ❌ |
|
||||
| **`Bluetooth LE`** | ❌ |
|
||||
| **`Audio TP`** | ❌ |
|
||||
| **`Zerotier`** | ❌ |
|
||||
|
||||
| Stream Muxers | Status |
|
||||
| ---------------- | :----: |
|
||||
| **`multiplex`** | ✅ |
|
||||
| **`yamux`** | 🚫 |
|
||||
| **`benchmarks`** | ❌ |
|
||||
| **`muxado`** | ❌ |
|
||||
| **`spdystream`** | ❌ |
|
||||
| **`spdy`** | ❌ |
|
||||
| **`http2`** | ❌ |
|
||||
| **`QUIC`** | ❌ |
|
||||
| **`multiplex`** | ✅ |
|
||||
| **`yamux`** | 🚫 |
|
||||
| **`benchmarks`** | ❌ |
|
||||
| **`muxado`** | ❌ |
|
||||
| **`spdystream`** | ❌ |
|
||||
| **`spdy`** | ❌ |
|
||||
| **`http2`** | ❌ |
|
||||
| **`QUIC`** | ❌ |
|
||||
|
||||
| Protocol Muxers | Status |
|
||||
| ----------------- | :----: |
|
||||
| **`multiselect`** | ✅ |
|
||||
| **`multiselect`** | ✅ |
|
||||
|
||||
| Switch (Swarm) | Status |
|
||||
| ------------------ | :----: |
|
||||
| **`Switch`** | ✅ |
|
||||
| **`Dialer stack`** | ✅ |
|
||||
| **`Switch`** | ✅ |
|
||||
| **`Dialer stack`** | ✅ |
|
||||
|
||||
| Peer Discovery | Status |
|
||||
| -------------------- | :----: |
|
||||
| **`bootstrap list`** | 🚫 |
|
||||
| **`Kademlia DHT`** | ❌ |
|
||||
| **`mDNS`** | ❌ |
|
||||
| **`PEX`** | ❌ |
|
||||
| **`DNS`** | ❌ |
|
||||
| **`bootstrap list`** | 🚫 |
|
||||
| **`Kademlia DHT`** | ❌ |
|
||||
| **`mDNS`** | ❌ |
|
||||
| **`PEX`** | ❌ |
|
||||
| **`DNS`** | ❌ |
|
||||
|
||||
| Content Routing | Status |
|
||||
| ------------------ | :----: |
|
||||
| **`Kademlia DHT`** | ❌ |
|
||||
| **`floodsub`** | ✅ |
|
||||
| **`gossipsub`** | ✅ |
|
||||
| **`PHT`** | ❌ |
|
||||
| **`Kademlia DHT`** | ❌ |
|
||||
| **`floodsub`** | ✅ |
|
||||
| **`gossipsub`** | ✅ |
|
||||
| **`PHT`** | ❌ |
|
||||
|
||||
| Peer Routing | Status |
|
||||
| ------------------ | :----: |
|
||||
| **`Kademlia DHT`** | ❌ |
|
||||
| **`floodsub`** | ✅ |
|
||||
| **`gossipsub`** | ✅ |
|
||||
| **`PHT`** | ❌ |
|
||||
| **`Kademlia DHT`** | ❌ |
|
||||
| **`floodsub`** | ✅ |
|
||||
| **`gossipsub`** | ✅ |
|
||||
| **`PHT`** | ❌ |
|
||||
|
||||
| NAT Traversal | Status |
|
||||
| ------------------------ | :----: |
|
||||
| **`nat-pmp`** | ❌ |
|
||||
| **`upnp`** | ❌ |
|
||||
| **`ext addr discovery`** | ❌ |
|
||||
| **`STUN-like`** | ❌ |
|
||||
| **`line-switch relay`** | ❌ |
|
||||
| **`pkt-switch relay`** | ❌ |
|
||||
| **`nat-pmp`** | ❌ |
|
||||
| **`upnp`** | ❌ |
|
||||
| **`ext addr discovery`** | ❌ |
|
||||
| **`STUN-like`** | ❌ |
|
||||
| **`line-switch relay`** | ❌ |
|
||||
| **`pkt-switch relay`** | ❌ |
|
||||
|
||||
| Exchange | Status |
|
||||
| ---------------- | :----: |
|
||||
| **`HTTP`** | ❌ |
|
||||
| **`Bitswap`** | ❌ |
|
||||
| **`Bittorrent`** | ❌ |
|
||||
| **`HTTP`** | ❌ |
|
||||
| **`Bitswap`** | ❌ |
|
||||
| **`Bittorrent`** | ❌ |
|
||||
|
||||
| Consensus | Status |
|
||||
| -------------- | :----: |
|
||||
| **`Paxos`** | ❌ |
|
||||
| **`Raft`** | ❌ |
|
||||
| **`PBTF`** | ❌ |
|
||||
| **`Nakamoto`** | ❌ |
|
||||
| **`Paxos`** | ❌ |
|
||||
| **`Raft`** | ❌ |
|
||||
| **`PBTF`** | ❌ |
|
||||
| **`Nakamoto`** | ❌ |
|
||||
|
||||
## Explanation of Basic Two Node Communication
|
||||
|
||||
@ -138,7 +138,7 @@ Several components of the libp2p stack take part when establishing a connection
|
||||
|
||||
_(non-normative, useful for team notes, not a reference)_
|
||||
|
||||
**Initiate the connection**: A host is simply a node in the libp2p network that is able to communicate with other nodes in the network. In order for X and Y to communicate with one another, one of the hosts must initiate the connection. Let's say that X is going to initiate the connection. X will first open a connection to Y. This connection is where all of the actual communication will take place.
|
||||
**Initiate the connection**: A host is simply a node in the libp2p network that is able to communicate with other nodes in the network. In order for X and Y to communicate with one another, one of the hosts must initiate the connection. Let's say that X is going to initiate the connection. X will first open a connection to Y. This connection is where all of the actual communication will take place.
|
||||
|
||||
**Communication over one connection with multiple protocols**: X and Y can communicate over the same connection using different protocols and the multiplexer will appropriately route messages for a given protocol to a particular handler function for that protocol, which allows for each host to handle different protocols with separate functions. Furthermore, we can use multiple streams for a given protocol that allow for the same protocol and same underlying connection to be used for communication about separate topics between nodes X and Y.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user