genosdb
Version:
GenosDB (GDB): distributed graph database in real-time, peer-to-peer, scalable storage - efficient querying of complex relationships.
225 lines (138 loc) • 12.6 kB
Markdown
# GenosDB (GDB) – Decentralized P2P Graph Database
A lightweight, decentralized graph database designed for modern web applications, offering real-time peer-to-peer synchronization, WebAuthn-based authentication, role-based access control (RBAC), and efficient local storage utilizing OPFS.
---
[](https://www.npmjs.org/package/genosdb)
[](https://github.com/estebanrfp/gdb/blob/main/LICENSE)
[](https://www.jsdelivr.com/package/npm/genosdb)
<!-- [](https://app.netlify.com/start/deploy?repository=https://github.com/estebanrfp/gdb&build=dist) -->
[](https://liberapay.com/estebanrfp/donate)
> ⚠️ Migration Guide: The class-based API `new GDB()` has been removed. Please migrate to the async factory function. See the guide: [MIGRATION.md](./MIGRATION.md)
<!-- ### Nostr.band Followers
 -->
<!--  -->
## Main Features
### ✅ **GenosDB Core**
- Efficient storage in OPFS.
- Real-time synchronization between tabs and devices.
- CRUD operations for nodes and relationships.
- Efficient serialization using MessagePack and compression with Pako.
- Enabling reverse or Radix Tree indexing through external modules.
- GenosDB supports external modules that extend its capabilities.
## Warning
This project is under active development. Do not use it in production environments until it reaches the beta or stable phase. Check the [Project Status](#project-status) section for more details.
## Project Status
- **Phase**: Beta
- **Completed Features**:
- Basic queries.
- Advanced queries.
- **Recursive Graph Traversal Queries:**
Execute complex, multi-hop graph traversals using the recursive $edge operator. This operator uses the source nodes as a starting point to discover and return all connected nodes that match a powerful sub-query, regardless of their relational distance. The entire traversal logic is resolved within a single, declarative query, eliminating the need for manual, multi-step lookups in the application code. The query engine is designed to handle deeply nested relational paths with exceptional speed.
- Modules for AI queries.
- Distributed storage.
- Conflict resolution module (LWW).
- Performance optimization.
- **Intelligent Hybrid Synchronization:**
GenosDB overcomes the limitations of naive P2P sync with an intelligent, dual-mode engine. It automatically exchanges tiny, compressed Deltas between active peers using a sliding-window Oplog for blazing-fast, low-latency updates. For peers that are too far out of sync, it seamlessly switches to a robust Full-State Fallback, guaranteeing absolute data consistency for everyone, no matter how long they've been offline.
- **Pending Features**:
- No major features are currently pending. The project has entered a hardening phase with a focus on rigorous testing and stability improvements.
> ⚠️ The API is under active development and may change without notice. Use fixed versions and check the [changelog](CHANGELOG.md) before upgrading.
### ✅ **Role Based Access Control (RBAC)**
- Customizable role hierarchy (`superadmin`, `admin`, etc)
- Biometric Registration and Authentication with WebAuthn
- Granular permissions (`read`/`write`/`delete`/`publish`)
- Role assignment with automatic expiration
- Cryptographic transaction verification
### ✅ **Security**
- Digital signature of critical operations
- Real-time permission validation
- Secure storage of roles in internal graph
- [Security Implementation](https://github.com/estebanrfp/gdb/wiki/RBAC-Security)
> **Important Notice**: This project has progressed from its active development phase and is now in the beta stage. While it is functional and stable in controlled environments, it is recommended to evaluate its suitability for production based on the specific needs of your environment. For more details, please refer to the [Project Status](#project-status)
## ⚠️ Reliability Notice
This is a distributed database (P2P + CRDT); therefore:
• In extreme conditions (network failures, partial synchronization, or unconventional usage), unexpected behavior may occur.
• Any reported issues will be prioritized and resolved in upcoming patch versions.
The project has achieved the expected stability goals (such as conflict resolution, synchronization, and distributed storage), without intending to ignore the limitations inherent to distributed technologies (P2P + CRDT).
GenosDB has been rigorously tested with our common usage examples in such environments, demonstrating greater stability than many other well-known distributed databases.
---
## Installation
### 1. Via NPM
```bash
npm install genosdb
```
```javascript
import { gdb } from "genosdb"
```
### 2. Direct use in browser from a CDN
```html
<script type="module">
import { gdb } from "https://cdn.jsdelivr.net/npm/genosdb@latest/dist/index.min.js"
</script>
```
## Documentation
Our formal API reference and technical guides are located in the [`/docs` folder](https://github.com/estebanrfp/gdb/tree/main/docs) of this repository.
For community-driven content, tutorials, and live examples, please visit our [GitHub Wiki](https://github.com/estebanrfp/gdb/wiki).
For detailed documentation, visit our [GitHub Wiki](https://github.com/estebanrfp/gdb/wiki).
For interactive, AI-assisted GenosDB documentation:
[](https://deepwiki.com/estebanrfp/gdb)
## Examples
We’ve created a collection of interactive examples to help you understand how GDB works in real-world scenarios. These examples cover everything from basic setup to advanced features like RBAC and P2P synchronization.
👉 [Explore Examples](https://github.com/estebanrfp/gdb/wiki/EXAMPLES.md)
### **Internal Dependencies**
Below is a list of internal dependencies and their purposes within the project:
| Dependency | Usage |
| ------------------ | ---------------------------------------------------------------------------------------|
| `@msgpack/msgpack` | Data serialization/deserialization in MessagePack format. |
| `pako` | Data compression/decompression using gzip. |
| `genosrtc` | New Internal Module for P2P synchronization for sharing changes in real-time between tabs/devices. |
| `BroadcastChannel` | Communication between browser tabs to notify local changes. |
#### Additional Information
- **`@msgpack/msgpack`**:
This library is used to efficiently serialize and deserialize data, reducing payload sizes for storage and transmission.
- **`pako`**:
Provides gzip compression to optimize data storage and network communication.
- **`GenosRTC`** (Internal Module for GenosDB) :
GenosRTC is the real-time communication module for GenosDB, implementing peer-to-peer connections via WebRTC with signaling over the Nostr protocol.
This module was developed internally for the specific needs of GenosDB and leverages state-of-the-art cryptographic dependencies, such as `@noble/curves`, to ensure maximum security and performance.
Enables peer-to-peer synchronization, ensuring real-time updates across multiple instances of the application.
> **Note**: Among the available networks supported by GenosRTC, this project specifically uses the **Nostr** protocol for decentralized communication.
>
> **What is Nostr?**
> Nostr (Notes and Other Stuff Transmitted by Relays) is a decentralized protocol designed for censorship-resistant global communication. It operates without relying on centralized servers, instead using a network of relays to transmit signed messages between peers. Nostr is particularly well-suited for applications requiring secure, private, and scalable peer-to-peer interactions, such as social networks, messaging systems, or collaborative tools.
- **`BroadcastChannel`**:
Facilitates lightweight communication between browser tabs, allowing seamless updates without relying on external servers.
> **General Note**: These dependencies are integral to the project's performance and functionality, ensuring efficient data handling and real-time synchronization while leveraging decentralized technologies like Nostr.
## Repository Diagram
The project includes an interactive visualization of the repository’s history and structure, which you can explore by clicking the following link: gdb repository diagram.
The project includes an interactive visualization of the repository's history and structure, which you can explore here:
[gdb repository diagram](https://gitdiagram.com/estebanrfp/gdb)
This graphical view is especially useful for new contributors or anyone looking to gain deeper insight into the project’s evolution and structure, providing a clear and visual understanding of the workflow.
## Contributing
We welcome contributions to improve this project! Please read our [Contribution Guidelines](CONTRIBUTING.md) for details on how to get started.
## Community
We value community contributions and discussions! Here's how you can get involved:
- **Ask questions or share ideas**: Join our [GitHub Discussions](https://github.com/estebanrfp/gdb/discussions).
- **Real-time chat**: For quick conversations, join us on [Gitter](https://app.gitter.im/#/room/#GDB:gitter.im).
Here’s how you can participate in the Gitter room:
- `[DEV]`: Discussions about project development, new features, and technical improvements.
- `[ANNOUNCEMENT]`: Official updates, new releases, and important news about GDB.
- `[HELP]`: Technical support and troubleshooting for GDB-related questions.
Feel free to ask questions, share ideas, or just say hello! 👋
For more details on contributing, check out our [Contributing Guidelines](CONTRIBUTING.md).
## Licenses
This project includes third-party dependencies with their respective licenses. For detailed information, see the [Licenses page](THIRD_PARTY_LICENSES.md).
The source code of this project is licensed under the [MIT License](https://opensource.org/licenses/MIT). For more information, see the [LICENSE](LICENSE) file.
## Maintenance
This repository provides minified builds of GenosDB (GDB), a decentralized P2P graph database designed for modern web applications. These builds are freely available for anyone to use and integrate into their projects. Please note that the source code is not publicly available at this time; only the minified versions are provided. The project is actively maintained by Esteban Fuster Pozzi ([@estebanrfp](https://github.com/estebanrfp))
## Author
[Esteban Fuster Pozzi (@estebanrfp)](https://estebanrfp.com) — Full Stack JavaScript Developer and creator of [GenosDB (GDB)](https://www.npmjs.com/package/genosdb), an open-source real-time graph database built entirely with modern vanilla JavaScript.
[](https://app.fossa.com/projects/git%2Bgithub.com%2Festebanrfp%2Fgdb?ref=badge_shield&issueType=security)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Festebanrfp%2Fgdb?ref=badge_large&issueType=license)
## 💖 Support This Project
If you find this project useful and would like to support its development, please consider making a donation:
[](https://liberapay.com/estebanrfp/donate)