feat: incremental cardano database restoration with client CLI

[dlachaume]

Content

This PR introduces a new unstable subcommand for cardano-db-v2 command in the client CLI.

It allows users to restore an Incremental Cardano DB snapshots using the following options:

• --start: set the first immutable file number to download
• --end: set the last immutable file number to download.
• --include-ancillary: specify if the ancillary file must be downloaded
• --allow-override: allow existing files in the download directory to be overridden.

The command must be run with a specific snapshot artifact_hash or using latest (fetch the latest produced artifact).

A rework of the IndicatifFeedbackReceiver has been done to handle and display the Cardano database events sent by the client library:

Additionally, the E2E test and the Mithril Client multi-platform test manual workflow have been updated to verify the command.

---

Examples:

Restore a full Cardano database:

mithril-client --unstable cardano-db-v2 download latest

Restore a Cardano database with ancillary files:

mithril-client --unstable cardano-db-v2 download latest --include-ancillary

Restore from a starting point:

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

Restore using a range:

mithril-client --unstable cardano-db-v2 snapshot list --start 17000 --end 18000

Restore until a end point:

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

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)

Closes #2246

[github-actions]

Test Results

    3 files  ±  0     52 suites  ±0   10m 40s ⏱️ -6s
1 698 tests + 41  1 698 ✅ + 41  0 💤 ±0  0 ❌ ±0 
2 086 runs  +123  2 086 ✅ +123  0 💤 ±0  0 ❌ ±0 

Results for commit a9c87ee. ± Comparison against base commit d7080eb.

This pull request removes 10 and adds 51 tests. Note that renamed tests count towards both.

mithril-client ‑ cardano_database_client::download_unpack::tests::download_unpack_ancillary_file::download_unpack_ancillary_files_sends_feedbacks
mithril-client ‑ cardano_database_client::download_unpack::tests::download_unpack_immutable_files::download_unpack_immutable_files_sends_feedbacks_when_fails
mithril-client ‑ cardano_database_client::download_unpack::tests::download_unpack_immutable_files::download_unpack_immutable_files_sends_feedbacks_when_succeeds
mithril-client ‑ cardano_database_client::proving::tests::download_unpack_digest_file::sends_feedbacks
mithril-client ‑ file_downloader::interface::tests::download_event_type_builds_correct_event
mithril-client ‑ snapshot_client::tests_download::download_unpack_send_feedbacks
mithril-client-cli ‑ utils::cardano_db::test::check_disk_space_error_should_return_warning_message_if_error_is_not_enough_space
mithril-client-cli ‑ utils::cardano_db_download_checker::test::return_error_if_not_enough_available_space
mithril-client-cli ‑ utils::cardano_db_download_checker::test::return_error_if_unpack_directory_exists_and_not_empty
mithril-client-cli ‑ utils::cardano_db_download_checker::test::return_ok_if_unpack_directory_exist_and_empty

mithril-client ‑ cardano_database_client::statistics::tests::add_statistics_do_not_increments_immutable_files_restored_when_no_immutable_files_restored
mithril-client ‑ cardano_database_client::statistics::tests::add_statistics_increments_immutable_files_restored
mithril-client ‑ cardano_database_client::statistics::tests::add_statistics_with_ancillary
mithril-client ‑ cardano_database_client::statistics::tests::add_statistics_with_full_restoration
mithril-client ‑ cardano_database_client::statistics::tests::add_statistics_with_partial_restoration
mithril-client ‑ cardano_database_client::statistics::tests::add_statistics_without_ancillary
mithril-client ‑ file_downloader::http::tests::test_download_http_file_send_feedback
mithril-client ‑ file_downloader::http::tests::test_download_local_file_send_feedback
mithril-client ‑ file_downloader::interface::tests::download_event_type_builds_completed_event
mithril-client ‑ file_downloader::interface::tests::download_event_type_builds_progress_event
…

♻️ This comment has been updated with latest results.