Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Debug + better sqlite store #26

Merged
merged 3 commits into from
Nov 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "accumulators"
version = "0.1.0"
version = "0.1.1"
edition = "2021"
license-file = "LICENSE"
description = "Complete package of multiple Accumulators with Stores and hashing functions (Hashers)"
Expand Down
2 changes: 1 addition & 1 deletion benches/incremental_benchmark.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use tokio::runtime::Runtime;
async fn prepare_incremental(count: usize) -> IncrementalMerkleTree<StarkPoseidonHasher> {
let hasher = StarkPoseidonHasher::new(Some(false));

let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();

let store = Arc::new(store);

Expand Down
2 changes: 1 addition & 1 deletion benches/mmr_benchmark.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use tokio::runtime::Runtime;
async fn prepare_mmr(count: usize) -> MMR {
let hasher = Arc::new(StarkPoseidonHasher::new(Some(false)));

let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();

let store = Arc::new(store);

Expand Down
4 changes: 2 additions & 2 deletions src/hasher/core.rs
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
use anyhow::Result;
use std::str::FromStr;
use std::{fmt::Debug, str::FromStr};

// Default Hasher Options
pub const DEFAULT_BLOCK_SIZE_BITS: usize = 256;

pub trait Hasher: Send + Sync {
pub trait Hasher: Send + Sync + Debug {
fn hash(&self, data: Vec<String>) -> Result<String>;
fn is_element_size_valid(&self, element: &str) -> bool;
fn hash_single(&self, data: &str) -> String;
Expand Down
1 change: 1 addition & 0 deletions src/hasher/hashers/keccak.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use crate::hasher::HashingFunction;

use super::super::Hasher;

#[derive(Debug)]
pub struct KeccakHasher {
block_size_bits: usize,
}
Expand Down
3 changes: 2 additions & 1 deletion src/mmr/core.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ use crate::mmr::{
},
};

#[derive(Debug)]
pub struct MMR {
pub store: Arc<dyn Store>,
pub hasher: Arc<dyn Hasher>,
Expand All @@ -28,7 +29,7 @@ pub struct MMR {
pub sub_mmrs: SizesToMMRs,
}

#[derive(Clone)]
#[derive(Debug, Clone)]
pub struct MmrMetadata {
pub mmr_id: String,
pub store: Arc<dyn Store>,
Expand Down
4 changes: 2 additions & 2 deletions src/store/core.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
use anyhow::Result;
use async_trait::async_trait;
use std::collections::HashMap;
use std::{collections::HashMap, fmt::Debug};

#[async_trait]
pub trait Store: Send + Sync {
pub trait Store: Send + Sync + Debug {
async fn get(&self, key: &str) -> Result<Option<String>>;
async fn get_many(&self, keys: Vec<&str>) -> Result<HashMap<String, String>>;
async fn set(&self, key: &str, value: &str) -> Result<()>;
Expand Down
1 change: 1 addition & 0 deletions src/store/counter.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use std::sync::Arc;
use super::Store;
use anyhow::Result;

#[derive(Debug)]
pub struct InStoreCounter {
pub store: Arc<dyn Store>,
pub key: String,
Expand Down
1 change: 1 addition & 0 deletions src/store/stores/memory.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ use parking_lot::RwLock;

use crate::store::Store;

#[derive(Debug)]
pub struct InMemoryStore {
pub store: RwLock<HashMap<String, String>>,
}
Expand Down
15 changes: 12 additions & 3 deletions src/store/stores/sqlite.rs
Original file line number Diff line number Diff line change
@@ -1,19 +1,28 @@
use anyhow::Result;

use async_trait::async_trait;
use sqlx::{Pool, Row, Sqlite, SqlitePool};
use sqlx::{sqlite::SqliteConnectOptions, Pool, Row, Sqlite, SqlitePool};
use std::collections::HashMap;
use tokio::sync::Mutex;

use super::super::Store;

#[derive(Debug)]
pub struct SQLiteStore {
db: Mutex<Pool<Sqlite>>,
}

impl SQLiteStore {
pub async fn new(path: &str) -> Result<Self> {
let pool = SqlitePool::connect(path).await?;
pub async fn new(path: &str, create_file_if_not_exists: Option<bool>) -> Result<Self> {
let pool = if let Some(create_file_if_not_exists) = create_file_if_not_exists {
let options = SqliteConnectOptions::new()
.filename(path)
.create_if_missing(create_file_if_not_exists);
SqlitePool::connect_with(options).await?
} else {
SqlitePool::connect(path).await?
};

let store = SQLiteStore {
db: Mutex::new(pool),
};
Expand Down
4 changes: 2 additions & 2 deletions src/store/table.rs
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ pub type GetFullKeysAndStoresFn =
fn(&InStoreTable, Vec<SubKey>) -> Vec<(Arc<dyn Store>, Vec<String>)>;

#[cfg(feature = "stacked_mmr")]
#[derive(Clone)]
#[derive(Debug, Clone)]
pub struct SubMMR {
pub size: usize,
pub key: String,
pub store: Arc<dyn Store>,
}

#[derive(Clone)]
#[derive(Debug, Clone)]
pub struct InStoreTable {
/// Always use this store for setters
///
Expand Down
12 changes: 6 additions & 6 deletions tests/merkle_tree/incremental.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use accumulators::{

#[tokio::test]
async fn initialize() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();
let hasher = StarkPoseidonHasher::new(Some(false));

let store = Arc::new(store);
Expand All @@ -23,7 +23,7 @@ async fn initialize() {

#[tokio::test]
async fn get_path() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();
let hasher = StarkPoseidonHasher::new(Some(false));

let store = Arc::new(store);
Expand Down Expand Up @@ -51,7 +51,7 @@ async fn get_path() {

#[tokio::test]
async fn verify_proof() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();
let hasher = StarkPoseidonHasher::new(Some(false));

let store = Arc::new(store);
Expand All @@ -67,7 +67,7 @@ async fn verify_proof() {

#[tokio::test]
async fn update() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();
let hasher = StarkPoseidonHasher::new(Some(false));

let store = Arc::new(store);
Expand Down Expand Up @@ -95,7 +95,7 @@ async fn update() {

#[tokio::test]
async fn invalid_update() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();
let hasher = StarkPoseidonHasher::new(Some(false));

let store = Arc::new(store);
Expand All @@ -111,7 +111,7 @@ async fn invalid_update() {

#[tokio::test]
async fn generate_and_verify_multi_proof() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();
let hasher = StarkPoseidonHasher::new(Some(false));

let store = Arc::new(store);
Expand Down
4 changes: 2 additions & 2 deletions tests/mmr/core.rs
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ async fn should_append_to_mmr() {

#[tokio::test]
async fn should_append_duplicate_to_mmr() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();
let hasher = Arc::new(StarkPoseidonHasher::new(Some(false)));

let store = Arc::new(store);
Expand All @@ -208,7 +208,7 @@ async fn should_append_duplicate_to_mmr() {
#[tokio::test]
async fn test_new() {
// Arrange
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();
let hasher = Arc::new(StarkPoseidonHasher::new(Some(false)));

let store = Arc::new(store);
Expand Down
4 changes: 2 additions & 2 deletions tests/mmr/stacked.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use accumulators::{

#[tokio::test]
async fn should_stack_two_mmrs() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();
let hasher = Arc::new(StarkPoseidonHasher::new(Some(false)));

let store = Arc::new(store);
Expand Down Expand Up @@ -66,7 +66,7 @@ async fn should_stack_two_mmrs() {

#[tokio::test]
async fn should_stack_4_mmrs() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();
let hasher = Arc::new(StarkPoseidonHasher::new(Some(false)));

let store = Arc::new(store);
Expand Down
16 changes: 8 additions & 8 deletions tests/store/sqlite.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use std::{collections::HashMap, sync::Arc};

#[tokio::test]
async fn set_and_get_value() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();

let key_value = (
"6b9b77f2-a893-48bf-a52a-d5be5d0aaba3:RootHash",
Expand All @@ -24,7 +24,7 @@ async fn set_and_get_value() {

#[tokio::test]
async fn set_and_get_many_values() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();

let mut entries = HashMap::new();
entries.insert("key1".to_string(), "value1".to_string());
Expand All @@ -39,7 +39,7 @@ async fn set_and_get_many_values() {

#[tokio::test]
async fn get_many_values_in_correct_order() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();

let mut entries = HashMap::new();
entries.insert("a".to_string(), "value1".to_string());
Expand All @@ -61,7 +61,7 @@ async fn get_many_values_in_correct_order() {

#[tokio::test]
async fn should_delete_a_value() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();

store.set("key", "value").await.unwrap();
store.delete("key").await.unwrap();
Expand All @@ -72,7 +72,7 @@ async fn should_delete_a_value() {

#[tokio::test]
async fn test_in_store_counter() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();
let store = Arc::new(store);

// Create an in-store counter
Expand All @@ -86,7 +86,7 @@ async fn test_in_store_counter() {

#[tokio::test]
async fn test_get_none_in_store_table() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();

let store = Arc::new(store);

Expand All @@ -99,7 +99,7 @@ async fn test_get_none_in_store_table() {

#[tokio::test]
async fn test_get_many_none_in_store_table() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();

let store = Arc::new(store);

Expand All @@ -126,7 +126,7 @@ async fn test_get_many_none_in_store_table() {

#[tokio::test]
async fn test_get_some_in_store_table() {
let store = SQLiteStore::new(":memory:").await.unwrap();
let store = SQLiteStore::new(":memory:", None).await.unwrap();

let store = Arc::new(store);

Expand Down