vacp2p
/
pmtree
mirror of https://github.com/vacp2p/pmtree.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1 from vacp2p/make-db-public 

Make db public, and fork to vacp2p_pmtree to publish to crates.io
This commit is contained in:
Aaryamann Challani 2023-07-28 14:16:30 +05:30 committed by GitHub
parent a6e15489ea b5c62d3a8d
commit a48c3d9400
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 42 additions and 405 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Cargo.toml
View File

@ -1,14 +1,15 @@
[package]
name = "pmtree"
name = "vacp2p_pmtree"
version = "1.0.0"
edition = "2021"
license = "MIT OR Apache-2.0"
description = "Persistent Merkle Tree in Rust"
[dev-dependencies]
hex-literal = "0.3.4"
tiny-keccak = { version = "2.0.2", features = ["keccak"] }
sled = "0.34.7"
rln = { git = "https://github.com/vacp2p/zerokit", rev = "490206a" }
ark-serialize = "0.3.0"
hex-literal = "=0.3.4"
tiny-keccak = { version = "=2.0.2", features = ["keccak"] }
sled = "=0.34.7"
ark-serialize = "=0.3.0"
[dependencies]
rayon = { version = "1.6.1", optional = false }
rayon = { version = "=1.7.0", optional = false }

3
src/database.rs
View File

@ -25,4 +25,7 @@ pub trait Database {
/// Puts the leaves batch to the db
fn put_batch(&mut self, subtree: HashMap<DBKey, Value>) -> PmtreeResult<()>;
/// Closes the db connection
fn close(&mut self) -> PmtreeResult<()>;
}

24
src/tree.rs
View File

@ -27,7 +27,7 @@ where
D: Database,
H: Hasher,
{
db: D,
pub db: D,
depth: usize,
next_index: usize,
cache: Vec<H::Fr>,
@ -90,14 +90,21 @@ where
let db = D::load(db_config)?;
// Load root
let root = H::deserialize(db.get(Key(0, 0).into())?.unwrap());
let root = match db.get(Key(0, 0).into())? {
Some(root) => H::deserialize(root),
None => H::default_leaf(),
};
// Load depth & next_index values from db
let depth = db.get(DEPTH_KEY)?.unwrap().try_into().unwrap();
let depth = usize::from_be_bytes(depth);
let depth = match db.get(DEPTH_KEY)? {
Some(depth) => usize::from_be_bytes(depth.try_into().unwrap()),
None => 20
};
let next_index = db.get(NEXT_INDEX_KEY)?.unwrap().try_into().unwrap();
let next_index = usize::from_be_bytes(next_index);
let next_index = match db.get(NEXT_INDEX_KEY)? {
Some(next_index) => usize::from_be_bytes(next_index.try_into().unwrap()),
None => 0,
};
// Load cache vec
let mut cache = vec![H::default_leaf(); depth + 1];
@ -115,6 +122,11 @@ where
})
}
/// Closes the db connection
pub fn close(&mut self) -> PmtreeResult<()> {
self.db.close()
}
/// Sets a leaf at the specified tree index
pub fn set(&mut self, key: usize, leaf: H::Fr) -> PmtreeResult<()> {
if key >= self.capacity() {

6
tests/memory_keccak.rs
View File

@ -1,5 +1,5 @@
use hex_literal::hex;
use pmtree::*;
use vacp2p_pmtree::*;
use std::collections::HashMap;
use tiny_keccak::{Hasher as _, Keccak};
@ -37,6 +37,10 @@ impl Database for MemoryDB {
Ok(())
}
fn close(&mut self) -> PmtreeResult<()> {
Ok(())
}
}
impl Hasher for MyKeccak {

389
tests/poseidon.rs
View File

@ -1,389 +0,0 @@
use pmtree::*;
use rln::circuit::Fr;
use rln::circuit::TEST_TREE_HEIGHT;
use rln::poseidon_hash::poseidon_hash;
use rln::protocol::hash_to_field;
use rln::utils::str_to_fr;
use std::collections::HashMap;
use std::fs;
use std::io::Cursor;
use ark_serialize::{CanonicalDeserialize, CanonicalSerialize};
struct MemoryDB(HashMap<DBKey, Value>);
struct MySled(sled::Db);
#[derive(Clone, Copy, PartialEq, Eq)]
struct PoseidonHash;
impl Hasher for PoseidonHash {
type Fr = Fr;
fn default_leaf() -> Self::Fr {
Fr::from(0)
}
fn serialize(value: Self::Fr) -> Value {
let mut buf = vec![];
Fr::serialize(&value, &mut buf).unwrap();
buf
}
fn deserialize(value: Value) -> Self::Fr {
let c = Cursor::new(value);
Fr::deserialize(c).unwrap()
}
fn hash(inputs: &[Self::Fr]) -> Self::Fr {
poseidon_hash(inputs)
}
}
#[derive(Default)]
struct MemoryDBConfig;
impl Database for MemoryDB {
type Config = MemoryDBConfig;
fn new(_db_config: MemoryDBConfig) -> PmtreeResult<Self> {
Ok(MemoryDB(HashMap::new()))
}
fn load(_db_config: MemoryDBConfig) -> PmtreeResult<Self> {
Err(PmtreeErrorKind::DatabaseError(
DatabaseErrorKind::CannotLoadDatabase,
))
}
fn get(&self, key: DBKey) -> PmtreeResult<Option<Value>> {
Ok(self.0.get(&key).cloned())
}
fn put(&mut self, key: DBKey, value: Value) -> PmtreeResult<()> {
self.0.insert(key, value);
Ok(())
}
fn put_batch(&mut self, subtree: HashMap<DBKey, Value>) -> PmtreeResult<()> {
self.0.extend(subtree.into_iter());
Ok(())
}
}
#[derive(Default)]
struct SledConfig {
path: String,
}
impl Database for MySled {
type Config = SledConfig;
fn new(db_config: SledConfig) -> PmtreeResult<Self> {
let db = sled::open(db_config.path).unwrap();
if db.was_recovered() {
return Err(PmtreeErrorKind::DatabaseError(
DatabaseErrorKind::DatabaseExists,
));
}
Ok(MySled(db))
}
fn load(db_config: SledConfig) -> PmtreeResult<Self> {
let db = sled::open(&db_config.path).unwrap();
if !db.was_recovered() {
fs::remove_dir_all(&db_config.path).expect("Error removing db");
return Err(PmtreeErrorKind::DatabaseError(
DatabaseErrorKind::CannotLoadDatabase,
));
}
Ok(MySled(db))
}
fn get(&self, key: DBKey) -> PmtreeResult<Option<Value>> {
Ok(self.0.get(key).unwrap().map(|val| val.to_vec()))
}
fn put(&mut self, key: DBKey, value: Value) -> PmtreeResult<()> {
self.0.insert(key, value).unwrap();
self.0.flush().unwrap();
Ok(())
}
fn put_batch(&mut self, subtree: HashMap<DBKey, Value>) -> PmtreeResult<()> {
let mut batch = sled::Batch::default();
for (key, value) in subtree {
batch.insert(&key, value);
}
self.0.apply_batch(batch).unwrap();
Ok(())
}
}
#[test]
fn poseidon_memory() -> PmtreeResult<()> {
let mut mt = MerkleTree::<MemoryDB, PoseidonHash>::new(TEST_TREE_HEIGHT, MemoryDBConfig)?;
let leaf_index = 3;
let identity_secret = hash_to_field(b"test-merkle-proof");
let id_commitment = poseidon_hash(&[identity_secret]);
// let default_leaf = Fr::from(0);
mt.set(leaf_index, id_commitment).unwrap();
// We check correct computation of the root
let root = mt.root();
assert_eq!(
root,
str_to_fr(
"0x21947ffd0bce0c385f876e7c97d6a42eec5b1fe935aab2f01c1f8a8cbcc356d2",
16
)
);
let merkle_proof = mt.proof(leaf_index).expect("proof should exist");
let path_elements = merkle_proof.get_path_elements();
let identity_path_index = merkle_proof.get_path_index();
// We check correct computation of the path and indexes
// These values refers to TEST_TREE_HEIGHT == 16
let expected_path_elements = vec![
str_to_fr(
"0x0000000000000000000000000000000000000000000000000000000000000000",
16,
),
str_to_fr(
"0x2098f5fb9e239eab3ceac3f27b81e481dc3124d55ffed523a839ee8446b64864",
16,
),
str_to_fr(
"0x1069673dcdb12263df301a6ff584a7ec261a44cb9dc68df067a4774460b1f1e1",
16,
),
str_to_fr(
"0x18f43331537ee2af2e3d758d50f72106467c6eea50371dd528d57eb2b856d238",
16,
),
str_to_fr(
"0x07f9d837cb17b0d36320ffe93ba52345f1b728571a568265caac97559dbc952a",
16,
),
str_to_fr(
"0x2b94cf5e8746b3f5c9631f4c5df32907a699c58c94b2ad4d7b5cec1639183f55",
16,
),
str_to_fr(
"0x2dee93c5a666459646ea7d22cca9e1bcfed71e6951b953611d11dda32ea09d78",
16,
),
str_to_fr(
"0x078295e5a22b84e982cf601eb639597b8b0515a88cb5ac7fa8a4aabe3c87349d",
16,
),
str_to_fr(
"0x2fa5e5f18f6027a6501bec864564472a616b2e274a41211a444cbe3a99f3cc61",
16,
),
str_to_fr(
"0x0e884376d0d8fd21ecb780389e941f66e45e7acce3e228ab3e2156a614fcd747",
16,
),
str_to_fr(
"0x1b7201da72494f1e28717ad1a52eb469f95892f957713533de6175e5da190af2",
16,
),
str_to_fr(
"0x1f8d8822725e36385200c0b201249819a6e6e1e4650808b5bebc6bface7d7636",
16,
),
str_to_fr(
"0x2c5d82f66c914bafb9701589ba8cfcfb6162b0a12acf88a8d0879a0471b5f85a",
16,
),
str_to_fr(
"0x14c54148a0940bb820957f5adf3fa1134ef5c4aaa113f4646458f270e0bfbfd0",
16,
),
str_to_fr(
"0x190d33b12f986f961e10c0ee44d8b9af11be25588cad89d416118e4bf4ebe80c",
16,
),
str_to_fr(
"0x22f98aa9ce704152ac17354914ad73ed1167ae6596af510aa5b3649325e06c92",
16,
),
str_to_fr(
"0x2a7c7c9b6ce5880b9f6f228d72bf6a575a526f29c66ecceef8b753d38bba7323",
16,
),
str_to_fr(
"0x2e8186e558698ec1c67af9c14d463ffc470043c9c2988b954d75dd643f36b992",
16,
),
str_to_fr(
"0x0f57c5571e9a4eab49e2c8cf050dae948aef6ead647392273546249d1c1ff10f",
16,
),
str_to_fr(
"0x1830ee67b5fb554ad5f63d4388800e1cfe78e310697d46e43c9ce36134f72cca",
16,
),
];
let expected_identity_path_index: Vec<u8> =
vec![1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
assert_eq!(path_elements, expected_path_elements);
assert_eq!(identity_path_index, expected_identity_path_index);
// We check correct verification of the proof
assert!(mt.verify(&id_commitment, &merkle_proof));
Ok(())
}
#[test]
fn poseidon_sled() -> PmtreeResult<()> {
let mut mt = MerkleTree::<MySled, PoseidonHash>::new(
TEST_TREE_HEIGHT,
SledConfig {
path: String::from("abacaba"),
},
)?;
let leaf_index = 3;
let identity_secret = hash_to_field(b"test-merkle-proof");
let id_commitment = poseidon_hash(&[identity_secret]);
// let default_leaf = Fr::from(0);
mt.set(leaf_index, id_commitment).unwrap();
// We check correct computation of the root
let root = mt.root();
assert_eq!(
root,
str_to_fr(
"0x21947ffd0bce0c385f876e7c97d6a42eec5b1fe935aab2f01c1f8a8cbcc356d2",
16
)
);
let merkle_proof = mt.proof(leaf_index).expect("proof should exist");
let path_elements = merkle_proof.get_path_elements();
let identity_path_index = merkle_proof.get_path_index();
// We check correct computation of the path and indexes
// These values refers to TEST_TREE_HEIGHT == 16
let expected_path_elements = vec![
str_to_fr(
"0x0000000000000000000000000000000000000000000000000000000000000000",
16,
),
str_to_fr(
"0x2098f5fb9e239eab3ceac3f27b81e481dc3124d55ffed523a839ee8446b64864",
16,
),
str_to_fr(
"0x1069673dcdb12263df301a6ff584a7ec261a44cb9dc68df067a4774460b1f1e1",
16,
),
str_to_fr(
"0x18f43331537ee2af2e3d758d50f72106467c6eea50371dd528d57eb2b856d238",
16,
),
str_to_fr(
"0x07f9d837cb17b0d36320ffe93ba52345f1b728571a568265caac97559dbc952a",
16,
),
str_to_fr(
"0x2b94cf5e8746b3f5c9631f4c5df32907a699c58c94b2ad4d7b5cec1639183f55",
16,
),
str_to_fr(
"0x2dee93c5a666459646ea7d22cca9e1bcfed71e6951b953611d11dda32ea09d78",
16,
),
str_to_fr(
"0x078295e5a22b84e982cf601eb639597b8b0515a88cb5ac7fa8a4aabe3c87349d",
16,
),
str_to_fr(
"0x2fa5e5f18f6027a6501bec864564472a616b2e274a41211a444cbe3a99f3cc61",
16,
),
str_to_fr(
"0x0e884376d0d8fd21ecb780389e941f66e45e7acce3e228ab3e2156a614fcd747",
16,
),
str_to_fr(
"0x1b7201da72494f1e28717ad1a52eb469f95892f957713533de6175e5da190af2",
16,
),
str_to_fr(
"0x1f8d8822725e36385200c0b201249819a6e6e1e4650808b5bebc6bface7d7636",
16,
),
str_to_fr(
"0x2c5d82f66c914bafb9701589ba8cfcfb6162b0a12acf88a8d0879a0471b5f85a",
16,
),
str_to_fr(
"0x14c54148a0940bb820957f5adf3fa1134ef5c4aaa113f4646458f270e0bfbfd0",
16,
),
str_to_fr(
"0x190d33b12f986f961e10c0ee44d8b9af11be25588cad89d416118e4bf4ebe80c",
16,
),
str_to_fr(
"0x22f98aa9ce704152ac17354914ad73ed1167ae6596af510aa5b3649325e06c92",
16,
),
str_to_fr(
"0x2a7c7c9b6ce5880b9f6f228d72bf6a575a526f29c66ecceef8b753d38bba7323",
16,
),
str_to_fr(
"0x2e8186e558698ec1c67af9c14d463ffc470043c9c2988b954d75dd643f36b992",
16,
),
str_to_fr(
"0x0f57c5571e9a4eab49e2c8cf050dae948aef6ead647392273546249d1c1ff10f",
16,
),
str_to_fr(
"0x1830ee67b5fb554ad5f63d4388800e1cfe78e310697d46e43c9ce36134f72cca",
16,
),
];
let expected_identity_path_index: Vec<u8> =
vec![1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
assert_eq!(path_elements, expected_path_elements);
assert_eq!(identity_path_index, expected_identity_path_index);
// We check correct verification of the proof
assert!(mt.verify(&id_commitment, &merkle_proof));
fs::remove_dir_all("abacaba").expect("Error removing db");
Ok(())
}

8
tests/sled_keccak.rs
View File

@ -1,5 +1,5 @@
use hex_literal::hex;
use pmtree::*;
use vacp2p_pmtree::*;
use std::collections::HashMap;
use std::fs;
use tiny_keccak::{Hasher as _, Keccak};
@ -62,6 +62,12 @@ impl Database for MySled {
Ok(())
}
fn close(&mut self) -> PmtreeResult<()> {
self.0.flush().unwrap();
Ok(())
}
}
impl Hasher for MyKeccak {