Feat: Implement `cardano-db-v2` command in client CLI (`list` and `show`) #2266

dlachaume · 2025-01-30T17:06:09Z

Content

This PR introduces a new unstable command (cardano-db-v2 with alias cdbv2) for the Mithril client CLI, allowing users to list and show details of Incremental Cardano DB snapshots.

Example for snapshot list command:

mithril-client --unstable cardano-db-v2 snapshot list

Terminal output:

Example for snapshot show command:

mithril-client --unstable cardano-db-v2 snapshot show {ARTIFACT_HASH}

mithril-client --unstable cardano-db-v2 snapshot show latest

Terminal output:

Additionally, the E2E test and the Mithril Client multi-platform test manual workflow have been updated to verify both cardano-db-v2 commands (show and list).

Pre-submit checklist

Branch
- Tests are provided (if possible)
- Crates versions are updated (if relevant)
- CHANGELOG file is updated (if relevant)
- Commit sequence broadly makes sense
- Key commits have useful messages
PR
- No clippy warnings in the CI
- Self-reviewed the diff
- Useful pull request description
- Reviewer requested
Documentation
- Update README file (if relevant)
- Update documentation website (if relevant)
- Add dev blog post (if relevant)

Issue(s)

Relates to #2246

github-actions · 2025-01-30T17:13:37Z

Test Results

4 files ± 0 56 suites +4 10m 40s ⏱️ +10s
1 590 tests + 8 1 590 ✅ + 8 0 💤 ±0 0 ❌ ±0
1 888 runs +32 1 888 ✅ +32 0 💤 ±0 0 ❌ ±0

Results for commit 25a9fde. ± Comparison against base commit 3266e77.

♻️ This comment has been updated with latest results.

jpraynaud

LGTM 👍

jpraynaud · 2025-02-03T08:27:33Z

.github/workflows/test-client.yml

Maybe the namings should be a bit more consistent between Cardano Database v1 and v2

jpraynaud · 2025-02-03T08:28:19Z

mithril-client-cli/src/commands/cardano_db_v2/list.rs

+                        format!("{}", item.beacon.immutable_file_number).cell(),
+                        item.hash.cell(),
+                        item.merkle_root.cell(),
+                        item.total_db_size_uncompressed.cell(),


Can you display this size in a human readable format?

Should I use an external crate such as humansize?

Maybe displaying the size in GB is sufficient

jpraynaud · 2025-02-03T08:31:20Z

mithril-client-cli/src/commands/cardano_db_v2/show.rs

+                vec!["Merkle root".cell(), cardano_db_message.merkle_root.cell()],
+                vec![
+                    "Database size".cell(),
+                    format!("{}", &cardano_db_message.total_db_size_uncompressed).cell(),


Same comment here

sfauvel

LGTM

sfauvel · 2025-02-03T09:07:26Z

mithril-client-cli/src/commands/cardano_db_v2/show.rs

+        assert!(row.is_some());
+
+        let row = digest_location_row(456, DigestLocationDiscriminants::Aggregator, &locations);
+        assert!(row.is_some());


I wonder if a test that show the row rendering could be interesting

The code was refactored after your comment were posted.
Since CellStruct doesn't implement Eq or Display, I managed to test it by recreating a TableStruct. Is that ok for you?

- add 'cdbv2' alias for 'cardano-db-v2' - implement 'cardano-db-v2 list' command

…t` command

…ril Client multi-platform test

…nd v2 in Mithril Client multi-platform test

jpraynaud · 2025-02-03T12:22:07Z

mithril-client-cli/src/utils/cardano_db.rs

@@ -42,6 +42,12 @@ impl CardanoDbUtils {
            res = future => res,
        }
    }
+
+    pub fn format_bytes_to_gigabytes(bytes: u64) -> String {


The unit you are using is incorrect:

1 gibibyte (GiB) = 1024**3 bytes

1 gigabyte (GB) = 1000**3 bytes

I see. Should I update it to use GiB instead of GB and leave the calculation (1024**3 bytes) unchanged?
That way, it will match the unit used in the explorer.

Yes, you can use GiB as in the explorer 👍

…ple locations with commas.

* mithril-client-cli from `0.10.8` to `0.10.9` * mithril-common from `0.4.110` to `0.4.111` * mithril-end-to-end from `0.4.65` to `0.4.66`

Alenar

LGTM 🔥

dlachaume self-assigned this Jan 30, 2025

dlachaume temporarily deployed to testing-preview January 30, 2025 17:14 — with GitHub Actions Inactive

dlachaume temporarily deployed to testing-sanchonet January 30, 2025 17:14 — with GitHub Actions Inactive

dlachaume force-pushed the dlachaume/2246/implement-incremental-cardano-db-client-cli branch from 8b17d0a to 9fee61d Compare January 31, 2025 14:19

dlachaume temporarily deployed to testing-preview January 31, 2025 14:30 — with GitHub Actions Inactive

dlachaume temporarily deployed to testing-sanchonet January 31, 2025 14:30 — with GitHub Actions Inactive

dlachaume force-pushed the dlachaume/2246/implement-incremental-cardano-db-client-cli branch from 9fee61d to b9c7088 Compare January 31, 2025 14:59

dlachaume temporarily deployed to testing-preview January 31, 2025 15:09 — with GitHub Actions Inactive

dlachaume temporarily deployed to testing-sanchonet January 31, 2025 15:09 — with GitHub Actions Inactive

dlachaume force-pushed the dlachaume/2246/implement-incremental-cardano-db-client-cli branch from b9c7088 to 48c0b88 Compare January 31, 2025 15:15

dlachaume temporarily deployed to testing-preview January 31, 2025 15:23 — with GitHub Actions Inactive

dlachaume temporarily deployed to testing-sanchonet January 31, 2025 15:23 — with GitHub Actions Inactive

dlachaume changed the title ~~Feat: Implement cardano-db-v2 command in client CLI~~ Feat: Implement cardano-db-v2 command in client CLI (list and show) Jan 31, 2025

dlachaume force-pushed the dlachaume/2246/implement-incremental-cardano-db-client-cli branch from 48c0b88 to 91ebcaf Compare January 31, 2025 16:22

dlachaume temporarily deployed to testing-preview January 31, 2025 16:30 — with GitHub Actions Inactive

dlachaume temporarily deployed to testing-sanchonet January 31, 2025 16:30 — with GitHub Actions Inactive

dlachaume force-pushed the dlachaume/2246/implement-incremental-cardano-db-client-cli branch from 91ebcaf to d77b3f1 Compare January 31, 2025 16:39

dlachaume temporarily deployed to testing-preview January 31, 2025 16:47 — with GitHub Actions Inactive

dlachaume temporarily deployed to testing-sanchonet January 31, 2025 16:47 — with GitHub Actions Inactive

dlachaume marked this pull request as ready for review January 31, 2025 16:49

dlachaume requested review from Alenar, sfauvel and jpraynaud January 31, 2025 16:49

jpraynaud approved these changes Feb 3, 2025

View reviewed changes

sfauvel approved these changes Feb 3, 2025

View reviewed changes

dlachaume temporarily deployed to testing-preview February 3, 2025 10:00 — with GitHub Actions Inactive

dlachaume temporarily deployed to testing-sanchonet February 3, 2025 10:00 — with GitHub Actions Inactive

dlachaume added 2 commits February 3, 2025 12:49

feat: create unstable cardano-db-v2 command

86992c1

- add 'cdbv2' alias for 'cardano-db-v2' - implement 'cardano-db-v2 list' command

feat: implement show subcommand for unstable `cardano-db-v2 snapsho…

c10ca30

…t` command

dlachaume added 4 commits February 3, 2025 12:49

test: verify cardano-db-v2 commands in the E2E test

1aa79b1

chore: makes variable names clearer by removing abbreviations in Mith…

69fa57e

…ril Client multi-platform test

test: add new verification steps for cardano-db-v2 commands in Mith…

0aea1f7

…ril Client multi-platform test

test: rename step names for consistency between Cardano Database v1 a…

35f658f

…nd v2 in Mithril Client multi-platform test

dlachaume force-pushed the dlachaume/2246/implement-incremental-cardano-db-client-cli branch 3 times, most recently from c867e69 to 609d8f2 Compare February 3, 2025 11:57

dlachaume temporarily deployed to testing-preview February 3, 2025 12:09 — with GitHub Actions Inactive

dlachaume temporarily deployed to testing-sanchonet February 3, 2025 12:09 — with GitHub Actions Inactive

jpraynaud reviewed Feb 3, 2025

View reviewed changes

dlachaume added 2 commits February 3, 2025 14:46

refactor: display sizes in a human readable format

9cd2637

refactor: return one line per location instead of concatenating multi…

b7f3557

…ple locations with commas.

dlachaume force-pushed the dlachaume/2246/implement-incremental-cardano-db-client-cli branch from 609d8f2 to b7f3557 Compare February 3, 2025 13:46

chore: upgrade crate versions

25a9fde

* mithril-client-cli from `0.10.8` to `0.10.9` * mithril-common from `0.4.110` to `0.4.111` * mithril-end-to-end from `0.4.65` to `0.4.66`

Alenar approved these changes Feb 3, 2025

View reviewed changes

dlachaume deployed to testing-preview February 3, 2025 13:56 — with GitHub Actions Active

dlachaume deployed to testing-sanchonet February 3, 2025 13:56 — with GitHub Actions Active

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Implement `cardano-db-v2` command in client CLI (`list` and `show`) #2266

Feat: Implement `cardano-db-v2` command in client CLI (`list` and `show`) #2266

dlachaume commented Jan 30, 2025 •

edited

Loading

github-actions bot commented Jan 30, 2025 •

edited

Loading

jpraynaud left a comment

jpraynaud Feb 3, 2025

dlachaume Feb 3, 2025

jpraynaud Feb 3, 2025

dlachaume Feb 3, 2025

jpraynaud Feb 3, 2025 •

edited

Loading

dlachaume Feb 3, 2025

jpraynaud Feb 3, 2025

dlachaume Feb 3, 2025

sfauvel left a comment

sfauvel Feb 3, 2025

dlachaume Feb 3, 2025

jpraynaud Feb 3, 2025

dlachaume Feb 3, 2025 •

edited

Loading

jpraynaud Feb 3, 2025

Alenar left a comment

Feat: Implement cardano-db-v2 command in client CLI (list and show) #2266

Are you sure you want to change the base?

Feat: Implement cardano-db-v2 command in client CLI (list and show) #2266

Conversation

dlachaume commented Jan 30, 2025 • edited Loading

Content

Pre-submit checklist

Issue(s)

github-actions bot commented Jan 30, 2025 • edited Loading

Test Results

jpraynaud left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jpraynaud Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sfauvel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dlachaume Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Alenar left a comment

Choose a reason for hiding this comment

Feat: Implement `cardano-db-v2` command in client CLI (`list` and `show`) #2266

Feat: Implement `cardano-db-v2` command in client CLI (`list` and `show`) #2266

dlachaume commented Jan 30, 2025 •

edited

Loading

github-actions bot commented Jan 30, 2025 •

edited

Loading

jpraynaud Feb 3, 2025 •

edited

Loading

dlachaume Feb 3, 2025 •

edited

Loading