varun-r-mallya/py-libp2p
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/py-libp2p.git synced 2026-02-12 16:10:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix ci not running lint, bump pre-commit-hooks version

Browse Source
This commit is contained in:
pacrob
2025-02-24 19:17:27 -07:00
committed by Paul Robinson
parent d7eab27564
commit 0f0d51305c
4 changed files with 57 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/tox.yml vendored
View File

@ -30,7 +30,7 @@ jobs:
if [[ "$toxenv" == 'docs' ]]; then if [[ "$toxenv" == 'docs' ]]; then
echo 'TOXENV=docs' | tee -a $GITHUB_ENV echo 'TOXENV=docs' | tee -a $GITHUB_ENV
else else
echo "TOXENV=${python}-${toxenv}" | tr -d '.' | tee -a $GITHUB_ENV echo "TOXENV=py${python}-${toxenv}" | tr -d '.' | tee -a $GITHUB_ENV
fi fi
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- uses: actions/setup-python@v5 - uses: actions/setup-python@v5

4
.pre-commit-config.yaml
View File

@ -1,7 +1,7 @@
exclude: '.project-template|docs/conf.py|.*pb2\..*' exclude: '.project-template|docs/conf.py|.*pb2\..*'
repos: repos:
- repo: https://github.com/pre-commit/pre-commit-hooks - repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0 rev: v5.0.0
hooks: hooks:
- id: check-yaml - id: check-yaml
- id: check-toml - id: check-toml
@ -38,7 +38,7 @@ repos:
additional_dependencies: additional_dependencies:
- tomli # required until >= python311 - tomli # required until >= python311
- repo: https://github.com/executablebooks/mdformat - repo: https://github.com/executablebooks/mdformat
rev: 0.7.17 rev: 0.7.22
hooks: hooks:
- id: mdformat - id: mdformat
additional_dependencies: additional_dependencies:

106
README.md
View File

@ -31,92 +31,92 @@ py-libp2p aims for conformity with [the standard libp2p modules](https://libp2p.
| libp2p Node | Status | | libp2p Node | Status |
| ------------ | :----: | | ------------ | :----: |
| **`libp2p`** | ✅ | | **`libp2p`** | ✅ |
| Core Protocols | Status | | Core Protocols | Status |
| -------------- | :----: | | -------------- | :----: |
| **`Ping`** | ✅ | | **`Ping`** | ✅ |
| **`Identify`** | ✅ | | **`Identify`** | ✅ |
| Transport Protocols | Status | | Transport Protocols | Status |
| ------------------- | :----: | | ------------------- | :----: |
| **`TCP`** | ✅ | | **`TCP`** | ✅ |
| **`QUIC`** | 🛠️ | | **`QUIC`** | 🛠️ |
| **`UDP`** | 🚫 | | **`UDP`** | 🚫 |
| **`WebSockets`** | ❌ | | **`WebSockets`** | ❌ |
| **`UTP`** | ❌ | | **`UTP`** | ❌ |
| **`WebRTC`** | ❌ | | **`WebRTC`** | ❌ |
| **`SCTP`** | ❌ | | **`SCTP`** | ❌ |
| **`Tor`** | ❌ | | **`Tor`** | ❌ |
| **`i2p`** | ❌ | | **`i2p`** | ❌ |
| **`cjdns`** | ❌ | | **`cjdns`** | ❌ |
| **`Bluetooth LE`** | ❌ | | **`Bluetooth LE`** | ❌ |
| **`Audio TP`** | ❌ | | **`Audio TP`** | ❌ |
| **`Zerotier`** | ❌ | | **`Zerotier`** | ❌ |
| Stream Muxers | Status | | Stream Muxers | Status |
| ---------------- | :----: | | ---------------- | :----: |
| **`multiplex`** | ✅ | | **`multiplex`** | ✅ |
| **`yamux`** | 🚫 | | **`yamux`** | 🚫 |
| **`benchmarks`** | ❌ | | **`benchmarks`** | ❌ |
| **`muxado`** | ❌ | | **`muxado`** | ❌ |
| **`spdystream`** | ❌ | | **`spdystream`** | ❌ |
| **`spdy`** | ❌ | | **`spdy`** | ❌ |
| **`http2`** | ❌ | | **`http2`** | ❌ |
| **`QUIC`** | ❌ | | **`QUIC`** | ❌ |
| Protocol Muxers | Status | | Protocol Muxers | Status |
| ----------------- | :----: | | ----------------- | :----: |
| **`multiselect`** | ✅ | | **`multiselect`** | ✅ |
| Switch (Swarm) | Status | | Switch (Swarm) | Status |
| ------------------ | :----: | | ------------------ | :----: |
| **`Switch`** | ✅ | | **`Switch`** | ✅ |
| **`Dialer stack`** | ✅ | | **`Dialer stack`** | ✅ |
| Peer Discovery | Status | | Peer Discovery | Status |
| -------------------- | :----: | | -------------------- | :----: |
| **`bootstrap list`** | 🚫 | | **`bootstrap list`** | 🚫 |
| **`Kademlia DHT`** | ❌ | | **`Kademlia DHT`** | ❌ |
| **`mDNS`** | ❌ | | **`mDNS`** | ❌ |
| **`PEX`** | ❌ | | **`PEX`** | ❌ |
| **`DNS`** | ❌ | | **`DNS`** | ❌ |
| Content Routing | Status | | Content Routing | Status |
| ------------------ | :----: | | ------------------ | :----: |
| **`Kademlia DHT`** | ❌ | | **`Kademlia DHT`** | ❌ |
| **`floodsub`** | ✅ | | **`floodsub`** | ✅ |
| **`gossipsub`** | ✅ | | **`gossipsub`** | ✅ |
| **`PHT`** | ❌ | | **`PHT`** | ❌ |
| Peer Routing | Status | | Peer Routing | Status |
| ------------------ | :----: | | ------------------ | :----: |
| **`Kademlia DHT`** | ❌ | | **`Kademlia DHT`** | ❌ |
| **`floodsub`** | ✅ | | **`floodsub`** | ✅ |
| **`gossipsub`** | ✅ | | **`gossipsub`** | ✅ |
| **`PHT`** | ❌ | | **`PHT`** | ❌ |
| NAT Traversal | Status | | NAT Traversal | Status |
| ------------------------ | :----: | | ------------------------ | :----: |
| **`nat-pmp`** | ❌ | | **`nat-pmp`** | ❌ |
| **`upnp`** | ❌ | | **`upnp`** | ❌ |
| **`ext addr discovery`** | ❌ | | **`ext addr discovery`** | ❌ |
| **`STUN-like`** | ❌ | | **`STUN-like`** | ❌ |
| **`line-switch relay`** | ❌ | | **`line-switch relay`** | ❌ |
| **`pkt-switch relay`** | ❌ | | **`pkt-switch relay`** | ❌ |
| Exchange | Status | | Exchange | Status |
| ---------------- | :----: | | ---------------- | :----: |
| **`HTTP`** | ❌ | | **`HTTP`** | ❌ |
| **`Bitswap`** | ❌ | | **`Bitswap`** | ❌ |
| **`Bittorrent`** | ❌ | | **`Bittorrent`** | ❌ |
| Consensus | Status | | Consensus | Status |
| -------------- | :----: | | -------------- | :----: |
| **`Paxos`** | ❌ | | **`Paxos`** | ❌ |
| **`Raft`** | ❌ | | **`Raft`** | ❌ |
| **`PBTF`** | ❌ | | **`PBTF`** | ❌ |
| **`Nakamoto`** | ❌ | | **`Nakamoto`** | ❌ |
## Explanation of Basic Two Node Communication ## 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)_ _(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. **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.

1
newsfragments/522.internal.rst Normal file
View File

@ -0,0 +1 @@
Fixes broken CI lint run, bumps ``pre-commit-hooks`` version to ``5.0.0`` and ``mdformat`` to ``0.7.22``.