diff --git a/blockchain_db/src/lib.rs b/blockchain_db/src/lib.rs index 7484a9e2..29c7dd68 100644 --- a/blockchain_db/src/lib.rs +++ b/blockchain_db/src/lib.rs @@ -13,6 +13,15 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . +//! +//! blockchain_db crates: +//! Contains the implementation of interaction between the blockchain and the database backend. +//! There is actually only one storage engine available: +//! - RocksDB +//! There is two other storage engine planned: +//! - HSE (Heteregeonous Storage Engine) +//! - LMDB (like monerod) + #![deny(unused_attributes)] #![forbid(unsafe_code)] #![allow(non_camel_case_types)] diff --git a/blockchain_db/src/rocksdb.rs b/blockchain_db/src/rocksdb.rs new file mode 100644 index 00000000..4af81922 --- /dev/null +++ b/blockchain_db/src/rocksdb.rs @@ -0,0 +1,8 @@ +//! +//! RocksDB implementation. +//! +//! Database structure: +//! ------------------------------------- +//! Column | Key | Data +//! ------------------------------------- +//! \ No newline at end of file diff --git a/readme.md b/readme.md index 14f7beac..4e1e702e 100644 --- a/readme.md +++ b/readme.md @@ -24,9 +24,8 @@ Releasing an alternative node will reinforce the Monero Network if a security vu ### Status -The project is actually handle by single guy that never really started a big project of this scale nor understand completely the monero codebase. But he really wants to learn and code it. - -I'm working on rewriting the blockchain_db part atm. +@SyntheticBird45 is working on the blockchain_db part. +@boog900 is working on the net/p2p part. ### Contributions @@ -38,7 +37,7 @@ For non-developers people, it is time for you to unleash your ideas. ### Code, Repository & Dependencies -No unsafe code is permitted in the project, and the codebase will never contain `.except()` or `panic!()`. We discourage the use +No unsafe code is permitted in the project, and the codebase will never contain `.expect()` or `panic!()`. We discourage the use of `.unwrap()`, as it implied that all errors are correctly handled. The organization of the repository is at the moment arbritrary. The blockchain database components can be found under the blockchain_db member. diff --git a/rustfmt.toml b/rustfmt.toml index 53d80476..4f219418 100644 --- a/rustfmt.toml +++ b/rustfmt.toml @@ -5,5 +5,4 @@ comment_width = 100 match_block_trailing_comma = true wrap_comments = true edition = "2021" -error_on_line_overflow = true version = "Two" \ No newline at end of file