mirror of
https://github.com/fluencelabs/rust-libp2p
synced 2025-05-10 01:56:56 +00:00
51 lines
1.9 KiB
Markdown
51 lines
1.9 KiB
Markdown
|
## Description
|
||
|
|
|
||
|
|
This example showcases the usage of **libp2p** to interact with the Kademlia protocol on the IPFS network.
|
||
|
|
The code demonstrates how to perform Kademlia queries to find the closest peers to a specific peer ID.
|
||
|
|
By running this example, users can gain a better understanding of how the Kademlia protocol operates and performs queries on the IPFS network.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
The example code demonstrates how to perform Kademlia queries on the IPFS network using the Rust P2P Library.
|
||
|
|
By specifying a peer ID as a parameter, the code will search for the closest peers to the given peer ID.
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Run the example code:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
cargo run [PEER_ID]
|
||
|
|
```
|
||
|
|
|
||
|
|
Replace `[PEER_ID]` with the base58-encoded peer ID you want to search for.
|
||
|
|
If no peer ID is provided, a random peer ID will be generated.
|
||
|
|
|
||
|
|
## Example Output
|
||
|
|
|
||
|
|
Upon running the example code, you will see the output in the console.
|
||
|
|
The output will display the result of the Kademlia query, including the closest peers to the specified peer ID.
|
||
|
|
|
||
|
|
### Successful Query Output
|
||
|
|
|
||
|
|
If the Kademlia query successfully finds closest peers, the output will be:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
Searching for the closest peers to [PEER_ID]
|
||
|
|
Query finished with closest peers: [peer1, peer2, peer3]
|
||
|
|
```
|
||
|
|
|
||
|
|
### Failed Query Output
|
||
|
|
|
||
|
|
If the Kademlia query times out or there are no reachable peers, the output will indicate the failure:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
Searching for the closest peers to [PEER_ID]
|
||
|
|
Query finished with no closest peers.
|
||
|
|
```
|
||
|
|
|
||
|
|
## Conclusion
|
||
|
|
|
||
|
|
In conclusion, this example provides a practical demonstration of using the Rust P2P Library to interact with the Kademlia protocol on the IPFS network.
|
||
|
|
By examining the code and running the example, users can gain insights into the inner workings of Kademlia and how it performs queries to find the closest peers.
|
||
|
|
This knowledge can be valuable when developing peer-to-peer applications or understanding decentralized networks.
|