rust-libp2p

mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-05-12 02:47:15 +00:00

History

Panagiotis Ganelis c8b5f49ec2

refactor(kad): rename to follow naming convention across repository

Renamed the following

`kad::Kademlia` -> `kad::Behaviour`
`kad::KademliaEvent` -> `kad::Event`
`kad::KademliaBucketInserts` -> `kad::BucketInserts`
`kad::KademliaStoreInserts` -> `kad::StoreInserts`
`kad::KademliaConfig` -> `kad::Config`
`kad::KademliaCaching` -> `kad::Caching`
`kad::KademliaEvent` -> `kad::Event`
`kad::KademliaConnectionType` -> `kad::ConnectionType`
`KademliaHandler` -> `Handler`
`KademliaHandlerEvent` -> `HandlerEvent`
`KademliaProtocolConfig` -> `ProtocolConfig`
`KademliaHandlerIn` -> `HandlerIn`
`KademliaRequestId` -> `RequestId`
`KademliaHandlerQueryErr` -> `HandlerQueryErr`

Resolves: #4485

Pull-Request: #4547.

2023-09-27 20:25:22 +00:00

src

refactor(kad): rename to follow naming convention across repository

2023-09-27 20:25:22 +00:00

Cargo.toml

examples: employ consistent naming

2023-09-21 01:10:24 +00:00

README.md

docs(examples): add a README to each example

2023-06-01 07:40:22 +00:00

README.md

Description

This example showcases a basic distributed key-value store implemented using libp2p, along with the mDNS and Kademlia protocols.

Usage

Key-Value Store

Open two terminal windows, type cargo run and press Enter.
In terminal one, type PUT my-key my-value and press Enter. This command will store the value my-value with the key my-key in the distributed key-value store.
In terminal two, type GET my-key and press Enter. This command will retrieve the value associated with the key my-key from the key-value store.
To exit, press Ctrl-c in each terminal window to gracefully close the instances.

Provider Records

You can also use provider records instead of key-value records in the distributed store.

Open two terminal windows and start two instances of the key-value store. If your local network supports mDNS, the instances will automatically connect.
In terminal one, type PUT_PROVIDER my-key and press Enter. This command will register the peer as a provider for the key my-key in the distributed key-value store.
In terminal two, type GET_PROVIDERS my-key and press Enter. This command will retrieve the list of providers for the key my-key from the key-value store.
To exit, press Ctrl-c in each terminal window to gracefully close the instances.

Feel free to explore and experiment with the distributed key-value store example, and observe how the data is distributed and retrieved across the network using libp2p, mDNS, and the Kademlia protocol.

Conclusion

This example demonstrates the implementation of a basic distributed key-value store using libp2p, mDNS, and the Kademlia protocol. By leveraging these technologies, peers can connect, store, and retrieve key-value pairs in a decentralized manner. The example provides a starting point for building more advanced distributed systems and exploring the capabilities of libp2p and its associated protocols.