Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dinxsh/prustdb
peer2peer key-value database in rust 🦀
https://github.com/dinxsh/prustdb
database key-value p2p peer-to-peer rust
Last synced: 12 days ago
JSON representation
peer2peer key-value database in rust 🦀
- Host: GitHub
- URL: https://github.com/dinxsh/prustdb
- Owner: dinxsh
- Created: 2024-09-07T10:01:03.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-12-19T22:05:19.000Z (22 days ago)
- Last Synced: 2024-12-22T02:33:45.671Z (20 days ago)
- Topics: database, key-value, p2p, peer-to-peer, rust
- Language: Rust
- Homepage:
- Size: 20.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
#### prustDB
peer-to-peer key-value database in rust
### Prerequisites
- Rust (latest stable version)
- Cargo (comes with Rust)
- OpenSSL development libraries (for cryptography support)
### Installation
1. Clone the repository:
```
git clone https://github.com/dinxsh/prustdb.git
cd p2p_key_db
```
2. Build the project:
```
cargo build --release
```
3. Run tests to ensure everything is working correctly:
```
cargo test
```
### Usage
1. Start a node:
```
cargo run --release -- --port 8000 --data-dir /path/to/data
```
2. Connect to an existing network:
```
cargo run --release -- --port 8001 --peer 127.0.0.1:8000 --data-dir /path/to/data
```
3. Use the API to interact with the database:
```rust
use prustdb_client::Client;
async fn example() -> Result<(), Box> {
let client = Client::connect("127.0.0.1:8000").await?;
// Set a value
client.set("key", "value").await?;
// Get a value
let value = client.get("key").await?;
println!("Value: {:?}", value);
Ok(())
}
```
### Architecture
Our P2P Key-Value Database is built on a distributed hash table (DHT) architecture, similar to Kademlia. Here's a high-level overview:
1. **Node Identification**: Each node in the network is assigned a unique ID using a cryptographically secure random number generator.
2. **Key-Value Storage**: Data is stored as key-value pairs, distributed across the network based on the proximity of the key to node IDs.
3. **Routing**: Nodes maintain a routing table of known peers, organized into k-buckets based on the XOR distance between node IDs.
4. **Lookup Protocol**: To find a key, nodes perform iterative lookups, querying progressively closer nodes until the key is found or the closest nodes are reached.
5. **Data Replication**: Key-value pairs are replicated across multiple nodes using a configurable replication factor to ensure data availability and fault tolerance.
6. **Network Joining**: New nodes join the network by bootstrapping through a known peer, and then performing lookups for their ID to populate their routing table.
7. **Load Balancing**: The DHT naturally distributes data and lookup load across the network, with additional active balancing mechanisms for hotspots.
8. **Consistency**: We implement tunable consistency levels, from eventual consistency to strong consistency, allowing users to choose the appropriate trade-off between performance and consistency for their use case.
9. **Caching**: An intelligent caching layer improves read performance for frequently accessed data.
10. **Compression**: Data is compressed before storage and transmission to reduce storage requirements and network usage.
### Performance
PrustDB is designed for high performance:
- Asynchronous I/O for efficient resource utilization
- Custom memory allocator for reduced memory fragmentation
- Bloom filters for rapid non-existence proofs
- Optimized data structures for fast lookups and insertions
- Benchmarking suite for continuous performance monitoring
### Security
Security is a top priority for PrustDB:
- End-to-end encryption for all data transmissions
- Authentication and authorization for all nodes and clients
- Regular security audits and penetration testing
- Sandboxing of untrusted code execution
- Detailed security documentation and best practices
### Contributing
We welcome contributions from the community! Please check out our [Contributing Guidelines](CONTRIBUTING.md) for details on how to get started, our code of conduct, and the process for submitting pull requests.
### License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
### For the latest updates, follow us on [Twitter](https://twitter.com/dinescodes) and star our [GitHub repository](https://github.com/dinxsh/prustdb)