Skip to content

Latest commit

 

History

History
59 lines (32 loc) · 1.89 KB

README.md

File metadata and controls

59 lines (32 loc) · 1.89 KB
Raw

Examples

A set of examples showcasing how to use rust-libp2p.

Getting started

  • Ping

    Small ping clone, sending a ping to a peer, expecting a pong as a response. See tutorial for a step-by-step guide building the example.

Individual libp2p features

  • Chat

    A basic chat application demonstrating libp2p and the mDNS and floodsub protocols.

    • Gossipsub chat

      Same as the chat example but using mDNS and the Gossipsub protocol.

    • Tokio based chat

      Same as the chat example but using tokio for all asynchronous tasks and I/O.

  • Distributed key-value store

    A basic key value store demonstrating libp2p and the mDNS and Kademlia protocol.

  • Identify

    Demonstrates how to use identify protocol to query peer information.

  • IPFS Kademlia

    Demonstrates how to perform Kademlia queries on the IPFS network.

  • IPFS Private

    Implementation using the gossipsub, ping and identify protocols to implement the ipfs private swarms feature.

  • Passive Discovery via MDNS

    Discover peers on the same network via the MDNS protocol.

  • Hole punching tutorial

    Tutorial on how to overcome firewalls and NATs with libp2p’s hole punching mechanism.

Integration into a larger application

  • File sharing application

    Basic file sharing application with peers either providing or locating and getting files by name.

    While obviously showcasing how to build a basic file sharing application with the Kademlia and Request-Response protocol, the actual goal of this example is to show how to integrate rust-libp2p into a larger application.