cleanup

Author: pragmaxim

.github/workflows/redbit.yml

@@ -61,7 +61,6 @@ jobs:
       - name: Run Criterion Benchmarks
         run: |
           cargo bench --package utxo --bench utxo
-          echo "function,ops/s" > benchmarks.csv
           find target/criterion -path "*/base/estimates.json" -print0 | while IFS= read -r -d '' file; do
             FUNCTION=$(basename $(dirname $(dirname "$file")))
             if [[ "$FUNCTION" == "criterion" ]]; then
@@ -86,7 +85,7 @@ jobs:
       - name: Update README
         run: |
           LIB_CONTENT=$(cat examples/utxo/src/lib.rs | sed 's/^/    /')
-          MAIN_CONTENT=$(cat examples/utxo/src/db_demo.rs | sed 's/^/    /')
+          MAIN_CONTENT=$(cat examples/utxo/src/demo.rs | sed 's/^/    /')
 
           # Update BEGIN_LIB and BEGIN_MAIN sections
           awk -v lib_content="$LIB_CONTENT" -v main_content="$MAIN_CONTENT" '
@@ -101,7 +100,7 @@ jobs:
           # Prepare formatted benchmark lines
           HEADER=$(printf "%-45s %10s\n" "function" "ops/s")
           BODY=$(tail -n +2 benchmarks.csv | awk -F, '{ printf "%-45s %10s\n", $1, $2 }')
-          FORMATTED_BENCH="$HEADER\n$BODY"
+          FORMATTED_BENCH="$HEADER\n-------------------------------------------------------------\n$BODY"
 
           # Escape double quotes and backslashes
           ESCAPED_BENCH=$(echo -e "$FORMATTED_BENCH" | sed 's/\\/\\\\/g; s/"/\\"/g')

.gitignore

@@ -1,4 +1,4 @@
 /.idea
-/target
+/target/
 todo
-Cargo.lock
+Cargo.lock

README.md

@@ -7,6 +7,7 @@ through auto-generated REST API.
 - ✅ Rust type and macro system and db engines at the byte level
 - ✅ decentralized persistence options to maximize indexing speed and minimize data size
 - ✅ meta space : self-tested and self-documented db & http layers of code derived from annotated structs
+- ✅ maximizing R/W speed while minimizing data size using hierarchical data structures of smart pointers
 
 ### Major Out-of-the-Box Features
 
@@ -170,7 +171,7 @@ Let's say we want to persist Utxo into Redb using Redbit, declare annotated Stru
 ```
 <!-- END_LIB -->
 
-And R/W entire instances efficiently using indexes and dictionaries `examples/utxo/src/main.rs`:  
+And R/W entire instances efficiently using indexes and dictionaries `examples/utxo/src/demo.rs`:
 
 <!-- BEGIN_MAIN -->
 ```rust
@@ -184,7 +185,7 @@ And R/W entire instances efficiently using indexes and dictionaries `examples/ut
 
         println!("Persisting blocks:");
         for block in blocks.iter() {
-            Block::store_unsafe_and_commit(&db, block)?
+            Block::store_and_commit(&db, block)?
         }
 
         let read_tx = db.begin_read()?;
@@ -306,63 +307,65 @@ BlockHeader__get                                  280582
 
 ### Http Endpoints generated
 ```
-Endpoint       /block/id/{value}
-Endpoint       /block?take=
-Endpoint       /block?first=
-Endpoint       /block?last=
-Endpoint       /block/id/{value}
-Endpoint       /block/id?from=&until=
-Endpoint       /block/{value}/header
-Endpoint       /block/{value}/transactions
+endpoint                                          description
+-------------------------------------------------------------
+GET:/block/id/{value}                             block_get
+GET:/block?take=                                  block_take
+GET:/block?first=                                 block_first
+GET:/block?last=                                  block_last
+HEAD:/block/id/{value}                            block_exists
+GET:/block/id?from=&until=                        block_range
+GET:/block/{value}/header                         block_get_header
+GET:/block/{value}/transactions                   block_get_transactions
 
-Endpoint       /blockheader/id/{value}
-Endpoint       /blockheader?take=
-Endpoint       /blockheader?first=
-Endpoint       /blockheader?last=
-Endpoint       /blockheader/id/{value}
-Endpoint       /blockheader/id?from=&until=
-Endpoint       /blockheader/hash/{value}
-Endpoint       /blockheader/timestamp/{value}
-Endpoint       /blockheader/timestamp?from=&until=
-Endpoint       /blockheader/merkle_root/{value}
+GET:/blockheader/id/{value}                       blockheader_get
+GET:/blockheader?take=                            blockheader_take
+GET:/blockheader?first=                           blockheader_first
+GET:/blockheader?last=                            blockheader_last
+HEAD:/blockheader/id/{value}                      blockheader_exists
+GET:/blockheader/id?from=&until=                  blockheader_range
+GET:/blockheader/hash/{value}                     blockheader_get_by_hash
+GET:/blockheader/timestamp/{value}                blockheader_get_by_timestamp
+GET:/blockheader/timestamp?from=&until=           blockheader_range_by_timestamp
+GET:/blockheader/merkle_root/{value}              blockheader_get_by_merkle_root
 
-Endpoint       /transaction/id/{value}
-Endpoint       /transaction?take=
-Endpoint       /transaction?first=
-Endpoint       /transaction?last=
-Endpoint       /transaction/id/{value}
-Endpoint       /transaction/id/{value}/parent_pk
-Endpoint       /transaction/id?from=&until=
-Endpoint       /transaction/hash/{value}
-Endpoint       /transaction/{value}/utxos
-Endpoint       /transaction/{value}/inputs
+GET:/transaction/id/{value}                       transaction_get
+GET:/transaction?take=                            transaction_take
+GET:/transaction?first=                           transaction_first
+GET:/transaction?last=                            transaction_last
+HEAD:/transaction/id/{value}                      transaction_exists
+GET:/transaction/id/{value}/parent_pk             transaction_parent_pk
+GET:/transaction/id?from=&until=                  transaction_range
+GET:/transaction/hash/{value}                     transaction_get_by_hash
+GET:/transaction/{value}/utxos                    transaction_get_utxos
+GET:/transaction/{value}/inputs                   transaction_get_inputs
 
-Endpoint       /utxo/id/{value}
-Endpoint       /utxo?take=
-Endpoint       /utxo?first=
-Endpoint       /utxo?last=
-Endpoint       /utxo/id/{value}
-Endpoint       /utxo/id/{value}/parent_pk
-Endpoint       /utxo/id?from=&until=
-Endpoint       /utxo/datum/{value}
-Endpoint       /utxo/address/{value}
-Endpoint       /utxo/{value}/assets
+GET:/utxo/id/{value}                              utxo_get
+GET:/utxo?take=                                   utxo_take
+GET:/utxo?first=                                  utxo_first
+GET:/utxo?last=                                   utxo_last
+HEAD:/utxo/id/{value}                             utxo_exists
+GET:/utxo/id/{value}/parent_pk                    utxo_parent_pk
+GET:/utxo/id?from=&until=                         utxo_range
+GET:/utxo/datum/{value}                           utxo_get_by_datum
+GET:/utxo/address/{value}                         utxo_get_by_address
+GET:/utxo/{value}/assets                          utxo_get_assets
 
-Endpoint       /inputref/id/{value}
-Endpoint       /inputref?take=
-Endpoint       /inputref?first=
-Endpoint       /inputref?last=
-Endpoint       /inputref/id/{value}
-Endpoint       /inputref/id/{value}/parent_pk
-Endpoint       /inputref/id?from=&until=
+GET:/inputref/id/{value}                          inputref_get
+GET:/inputref?take=                               inputref_take
+GET:/inputref?first=                              inputref_first
+GET:/inputref?last=                               inputref_last
+HEAD:/inputref/id/{value}                         inputref_exists
+GET:/inputref/id/{value}/parent_pk                inputref_parent_pk
+GET:/inputref/id?from=&until=                     inputref_range
 
-Endpoint       /asset/id/{value}
-Endpoint       /asset?take=
-Endpoint       /asset?first=
-Endpoint       /asset?last=
-Endpoint       /asset/id/{value}
-Endpoint       /asset/id/{value}/parent_pk
-Endpoint       /asset/id?from=&until=
-Endpoint       /asset/name/{value}
-Endpoint       /asset/policy_id/{value}
+GET:/asset/id/{value}                             asset_get
+GET:/asset?take=                                  asset_take
+GET:/asset?first=                                 asset_first
+GET:/asset?last=                                  asset_last
+HEAD:/asset/id/{value}                            asset_exists
+GET:/asset/id/{value}/parent_pk                   asset_parent_pk
+GET:/asset/id?from=&until=                        asset_range
+GET:/asset/name/{value}                           asset_get_by_name
+GET:/asset/policy_id/{value}                      asset_get_by_policy_id
 ```

examples/utxo/benches/utxo.rs

@@ -19,7 +19,7 @@ fn benchmark_persistence(c: &mut Criterion) {
     group.bench_function("Block::store_and_commit", |b| {
         b.iter(|| {
             for block in blocks.iter() {
-                Block::store_unsafe_and_commit(&db, block).unwrap();
+                Block::store_and_commit(&db, block).unwrap();
             }
         })
     });

examples/utxo/src/data.rs

@@ -24,7 +24,7 @@ pub fn empty_temp_db(name: &str) -> Database {
 pub fn init_temp_db(name: &str) -> (Vec<Block>, Database) {
     let db = empty_temp_db(name);
     let blocks = get_blocks(Height(4), 4, 4, 4);
-    blocks.iter().for_each(|block| Block::store_unsafe_and_commit(&db, &block).expect("Failed to persist blocks"));
+    blocks.iter().for_each(|block| Block::store_and_commit(&db, &block).expect("Failed to persist blocks"));
     (blocks, db)
 }
 

examples/utxo/src/demo.rs

@@ -8,7 +8,7 @@ pub fn run(db: Arc<Database>) -> Result<(), AppError> {
 
     println!("Persisting blocks:");
     for block in blocks.iter() {
-        Block::store_unsafe_and_commit(&db, block)?
+        Block::store_and_commit(&db, block)?
     }
 
     let read_tx = db.begin_read()?;
@@ -22,6 +22,9 @@ pub fn run(db: Arc<Database>) -> Result<(), AppError> {
     Block::range(&read_tx, &first_block.id, &last_block.id)?;
     Block::get_transactions(&read_tx, &first_block.id)?;
     Block::get_header(&read_tx, &first_block.id)?;
+    Block::exists(&read_tx, &first_block.id)?;
+    Block::first(&read_tx)?;
+    Block::last(&read_tx)?;
 
     println!("Querying block headers:");
     let first_block_header = BlockHeader::first(&read_tx)?.unwrap();
@@ -45,6 +48,7 @@ pub fn run(db: Arc<Database>) -> Result<(), AppError> {
     Transaction::range(&read_tx, &first_transaction.id, &last_transaction.id)?;
     Transaction::get_utxos(&read_tx, &first_transaction.id)?;
     Transaction::get_inputs(&read_tx, &first_transaction.id)?;
+    Transaction::parent_pk(&read_tx, &first_transaction.id)?;
 
     println!("Querying utxos:");
     let first_utxo = Utxo::first(&read_tx)?.unwrap();
@@ -56,6 +60,18 @@ pub fn run(db: Arc<Database>) -> Result<(), AppError> {
     Utxo::get_by_datum(&read_tx, &first_utxo.datum)?;
     Utxo::range(&read_tx, &first_utxo.id, &last_utxo.id)?;
     Utxo::get_assets(&read_tx, &first_utxo.id)?;
+    Utxo::parent_pk(&read_tx, &first_utxo.id)?;
+
+    println!("Querying input refs:");
+    let first_input_ref = InputRef::first(&read_tx)?.unwrap();
+    let last_input_ref = InputRef::last(&read_tx)?.unwrap();
+
+    InputRef::take(&read_tx, 1000)?;
+    InputRef::exists(&read_tx, &first_input_ref.id)?;
+    InputRef::get(&read_tx, &first_input_ref.id)?;
+    InputRef::range(&read_tx, &first_input_ref.id, &last_input_ref.id)?;
+    InputRef::parent_pk(&read_tx, &first_input_ref.id)?;
+
 
     println!("Querying assets:");
     let first_asset = Asset::first(&read_tx)?.unwrap();
@@ -66,6 +82,7 @@ pub fn run(db: Arc<Database>) -> Result<(), AppError> {
     Asset::get_by_name(&read_tx, &first_asset.name)?;
     Asset::get_by_policy_id(&read_tx, &first_asset.policy_id)?;
     Asset::range(&read_tx, &first_asset.id, &last_asset.id)?;
+    Asset::parent_pk(&read_tx, &first_asset.id)?;
 
     println!("Deleting blocks:");
     for block in blocks.iter() {

examples/utxo/target/macros/Asset

@@ -367,61 +367,6 @@ impl Asset {
             },
         })
     }
-    pub fn store(
-        write_tx: &::redb::WriteTransaction,
-        instance: &Asset,
-    ) -> Result<(), AppError> {
-        if is_one_to_many_child && instance.exists(id.parent()) {
-            let mut table_pk_1 = write_tx.open_table(ASSET_ID)?;
-            table_pk_1.insert(&instance.id, ())?;
-            let mut table_col_1 = write_tx.open_table(ASSET_AMOUNT_BY_ID)?;
-            table_col_1.insert(&instance.id, &instance.amount)?;
-            let mut dict_pk_by_pk = write_tx.open_table(ASSET_NAME_DICT_PK_BY_ID)?;
-            let mut value_to_dict_pk = write_tx.open_table(ASSET_NAME_TO_DICT_PK)?;
-            let mut value_by_dict_pk = write_tx.open_table(ASSET_NAME_BY_DICT_PK)?;
-            let mut dict_index = write_tx.open_multimap_table(ASSET_NAME_DICT_INDEX)?;
-            let (birth_id, newly_created) = {
-                if let Some(guard) = value_to_dict_pk.get(&instance.name)? {
-                    (guard.value().clone(), false)
-                } else {
-                    let new_birth = instance.id.clone();
-                    (new_birth, true)
-                }
-            };
-            if newly_created {
-                value_to_dict_pk.insert(&instance.name, &birth_id)?;
-                value_by_dict_pk.insert(&birth_id, &instance.name)?;
-            }
-            dict_pk_by_pk.insert(&instance.id, &birth_id)?;
-            dict_index.insert(&birth_id, &instance.id)?;
-            let mut dict_pk_by_pk = write_tx.open_table(ASSET_POLICY_ID_DICT_PK_BY_ID)?;
-            let mut value_to_dict_pk = write_tx.open_table(ASSET_POLICY_ID_TO_DICT_PK)?;
-            let mut value_by_dict_pk = write_tx.open_table(ASSET_POLICY_ID_BY_DICT_PK)?;
-            let mut dict_index = write_tx
-                .open_multimap_table(ASSET_POLICY_ID_DICT_INDEX)?;
-            let (birth_id, newly_created) = {
-                if let Some(guard) = value_to_dict_pk.get(&instance.policy_id)? {
-                    (guard.value().clone(), false)
-                } else {
-                    let new_birth = instance.id.clone();
-                    (new_birth, true)
-                }
-            };
-            if newly_created {
-                value_to_dict_pk.insert(&instance.policy_id, &birth_id)?;
-                value_by_dict_pk.insert(&birth_id, &instance.policy_id)?;
-            }
-            dict_pk_by_pk.insert(&instance.id, &birth_id)?;
-            dict_index.insert(&birth_id, &instance.id)?;
-            Ok(())
-        } else {
-            Err(
-                AppError::InvalidPrimaryKey(
-                    format!("Cannot store {} with no primary key", stringify!(Asset)),
-                ),
-            )
-        }
-    }
     pub fn store(
         write_tx: &::redb::WriteTransaction,
         instance: &Asset,
@@ -522,7 +467,7 @@ impl Asset {
         }
         Ok(())
     }
-    pub fn store_unsafe_and_commit(
+    pub fn store_and_commit(
         db: &::redb::Database,
         instance: &Asset,
     ) -> Result<(), AppError> {

examples/utxo/target/macros/Block

@@ -227,25 +227,6 @@ impl Block {
             },
         })
     }
-    pub fn store(
-        write_tx: &::redb::WriteTransaction,
-        instance: &Block,
-    ) -> Result<(), AppError> {
-        if is_one_to_many_child && instance.exists(id.parent()) {
-            let mut table_pk_1 = write_tx.open_table(BLOCK_ID)?;
-            table_pk_1.insert(&instance.id, ())?;
-            let child = &instance.header;
-            BlockHeader::store(&write_tx, child)?;
-            Transaction::store_many(&write_tx, &instance.transactions)?;
-            Ok(())
-        } else {
-            Err(
-                AppError::InvalidPrimaryKey(
-                    format!("Cannot store {} with no primary key", stringify!(Block)),
-                ),
-            )
-        }
-    }
     pub fn store(
         write_tx: &::redb::WriteTransaction,
         instance: &Block,
@@ -277,7 +258,7 @@ impl Block {
         Transaction::store_many(&write_tx, &children)?;
         Ok(())
     }
-    pub fn store_unsafe_and_commit(
+    pub fn store_and_commit(
         db: &::redb::Database,
         instance: &Block,
     ) -> Result<(), AppError> {