Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

GroveDB Tutorials

This directory contains a set of tutorials for GroveDB, the first database to enable cryptographic proofs for queries more complex than single-key retrievals. GroveDB was built for Dash Platform but exists as a standalone product, so it may be integrated into other projects as well.

Tutorials

Each tutorial contains just the commented code snippets taken from the in-depth explanatory article that can be found here.

  • Open - Covers how to open a GroveDB instance and perform basic operations.

  • Insert - Explains how to insert data into GroveDB, including inserting items and subtrees.

  • Delete - Demonstrates how to delete items and subtrees from GroveDB.

  • Query Simple - Introduces simple querying capabilities in GroveDB, including retrieving a set of items.

  • Query Complex - Covers more advanced querying in GroveDB, including conditional subqueries and sized queries.

  • Proofs - Demonstrates how to generate an inclusion proof for a simple query.

Getting Started

To get started with GroveDB, follow these steps:

  1. Clone the repository to your local machine:

    git clone https://github.com/dashpay/grovedb.git
  2. Navigate to the tutorials folder within the repo and build:

    cd grovedb/tutorials
    cargo build
  3. Run a tutorial:

    cargo run --bin <tutorial name>

    Where valid tutorial names are: open, insert, delete, query-simple, query-complex, proofs

Contributing

Contributions from the community are always welcome! If you find any issues or have suggestions for improvement, feel free to open an issue or submit a pull request.