Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stabilize namings cardano transactions #1542

Merged
merged 12 commits into from
Feb 29, 2024

Conversation

dlachaume
Copy link
Collaborator

@dlachaume dlachaume commented Feb 28, 2024

Content

This PR includes a refactor after the recent implementation of Cardano transactions.

  • Cardano transaction commitment has been renamed Cardano transaction snapshot globally in the repository.
  • Mithril client CLI command snapshot has been renamed cardano-db. The snapshot command still exists to avoid breaking changes but is deprecated.

Pre-submit checklist

  • Branch
    • Tests are provided (if possible)
    • Crates versions are 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 #1535

Copy link

github-actions bot commented Feb 28, 2024

Test Results

  3 files  ±0   42 suites  ±0   8m 54s ⏱️ +26s
878 tests ±0  878 ✅ ±0  0 💤 ±0  0 ❌ ±0 
967 runs  ±0  967 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 8c6d72c. ± Comparison against base commit a15369c.

This pull request removes 13 and adds 13 tests. Note that renamed tests count towards both.
mithril-aggregator ‑ services::signed_entity::tests::build_cardano_transactions_commitment_artifact_when_given_cardano_transactions_type
mithril-aggregator-fake::bin/mithril-aggregator-fake ‑ application::tests::get_ctx
mithril-aggregator-fake::bin/mithril-aggregator-fake ‑ application::tests::get_no_ctx
mithril-aggregator-fake::bin/mithril-aggregator-fake ‑ handlers::tests::existing_ctx_commitment_hash
mithril-aggregator-fake::bin/mithril-aggregator-fake ‑ handlers::tests::invalid_ctx_commitment_hash
mithril-client ‑ cardano_transaction_client::tests::get_cardano_transactions_commitment
mithril-client ‑ cardano_transaction_client::tests::get_cardano_transactions_commitment_list
mithril-client-cli ‑ commands::snapshot::download::tests::verify_snapshot_signature_should_remove_db_dir_if_messages_mismatch
mithril-client-cli ‑ utils::snapshot::test::check_disk_space_error_should_return_error_if_error_is_not_error_not_enough_space
mithril-client-cli ‑ utils::snapshot::test::check_disk_space_error_should_return_warning_message_if_error_is_not_enough_space
…
mithril-aggregator ‑ services::signed_entity::tests::build_cardano_transactions_snapshot_artifact_when_given_cardano_transactions_type
mithril-aggregator-fake::bin/mithril-aggregator-fake ‑ application::tests::get_ctx_snapshot
mithril-aggregator-fake::bin/mithril-aggregator-fake ‑ application::tests::get_no_ctx_snapshot
mithril-aggregator-fake::bin/mithril-aggregator-fake ‑ handlers::tests::existing_ctx_snapshot_hash
mithril-aggregator-fake::bin/mithril-aggregator-fake ‑ handlers::tests::invalid_ctx_snapshot_hash
mithril-client ‑ cardano_transaction_client::tests::get_cardano_transactions_snapshot
mithril-client ‑ cardano_transaction_client::tests::get_cardano_transactions_snapshot_list
mithril-client-cli ‑ commands::cardano_db::download::tests::verify_cardano_db_signature_should_remove_db_dir_if_messages_mismatch
mithril-client-cli ‑ utils::cardano_db::test::check_disk_space_error_should_return_error_if_error_is_not_error_not_enough_space
mithril-client-cli ‑ utils::cardano_db::test::check_disk_space_error_should_return_warning_message_if_error_is_not_enough_space
…

♻️ This comment has been updated with latest results.

Copy link
Member

@jpraynaud jpraynaud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall. As seen together, we should probably have the following commands/sub-commands:

  • snapshot list => cardano-db snapshot list
  • snapshot show => cardano-db snapshot show
  • snapshot download => cardano-db download or cardano-db restore

mithril-client-wasm/src/client_wasm.rs Outdated Show resolved Hide resolved
@Alenar Alenar temporarily deployed to testing-preview February 29, 2024 11:48 — with GitHub Actions Inactive
@Alenar Alenar temporarily deployed to testing-sanchonet February 29, 2024 11:48 — with GitHub Actions Inactive
Updated commands now become:
* `snapshot list` => `cardano-db snapshot list`
* `snapshot show` => `cardano-db snapshot show`
* `snapshot download` => `cardano-db download`
@Alenar Alenar force-pushed the ensemble/1535/stabilize-namings-cardano-transactions branch from 603bc8c to 420c6d3 Compare February 29, 2024 11:53
@Alenar Alenar temporarily deployed to testing-preview February 29, 2024 12:03 — with GitHub Actions Inactive
@Alenar Alenar temporarily deployed to testing-sanchonet February 29, 2024 12:03 — with GitHub Actions Inactive
@Alenar Alenar force-pushed the ensemble/1535/stabilize-namings-cardano-transactions branch from 420c6d3 to 8c6d72c Compare February 29, 2024 12:17
@Alenar Alenar temporarily deployed to testing-preview February 29, 2024 12:23 — with GitHub Actions Inactive
@Alenar Alenar temporarily deployed to testing-sanchonet February 29, 2024 12:23 — with GitHub Actions Inactive
Copy link
Member

@jpraynaud jpraynaud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

mithril-client-cli/src/main.rs Show resolved Hide resolved
@Alenar Alenar merged commit 3f93e35 into main Feb 29, 2024
42 of 43 checks passed
@Alenar Alenar deleted the ensemble/1535/stabilize-namings-cardano-transactions branch February 29, 2024 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Stabilize namings in Cardano Transactions API
4 participants