Skip to content

Stabilisation of cardano db v2 (aggregator) #2610

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

turmelclem
Copy link
Collaborator

@turmelclem turmelclem commented Jun 26, 2025

Content

This PR includes...

mithril aggragtor :

  • Remove CardanoImmutableFilesFull to keep only MithrilStakeDistribution in the DEFAULT_ALLOWED_DISCRIMINANTS
  • add CardanoImmutableFilesFull in allowed_discriminants (signed entity config) of aggregator's tests
  • add CardanoImmutableFilesFull in signed_entity_types of aggregator's integration tests

mithril signer :

  • add CardanoImmutableFilesFull in signed entities of signer's integration tests

test-lab :

  • add CardanoImmutableFilesFull in signed_entity_types of stress test

backward compatibility github action :

  • add CardanoImmutableFilesFull in signed_entity_types of stress test

mithril client CLI & test-client.yml :

  • rename cardano database directory from db_v2 to db when using cardano-db download --backend v2

and some documentation improvements

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
    • All check jobs of the CI have succeeded
    • 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)
    • Add ADR blog post or Dev ADR entry (if relevant)
    • No new TODOs introduced

Issue(s)

Closes #2577

@turmelclem turmelclem self-assigned this Jun 26, 2025
Copy link

github-actions bot commented Jun 26, 2025

Test Results

    3 files  ±0    102 suites  ±0   16m 16s ⏱️ -20s
2 048 tests ±0  2 048 ✅ ±0  0 💤 ±0  0 ❌ ±0 
4 229 runs  ±0  4 229 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 3438ccb. ± Comparison against base commit 63bc902.

This pull request removes 1 and adds 1 tests. Note that renamed tests count towards both.
mithril-aggregator ‑ runtime::runner::tests::test_get_current_non_certified_open_message_called_for_mithril_stake_distribution_and_then_for_immutable_file
mithril-aggregator ‑ runtime::runner::tests::test_get_current_non_certified_open_message_called_for_mithril_stake_distribution

♻️ This comment has been updated with latest results.

@turmelclem turmelclem force-pushed the ctl/2577-stabilize-cardano-db-v2-aggregator branch 2 times, most recently from c4ea96d to 683b515 Compare June 26, 2025 10:22
@turmelclem turmelclem temporarily deployed to testing-preview June 26, 2025 10:31 — with GitHub Actions Inactive
@turmelclem turmelclem force-pushed the ctl/2577-stabilize-cardano-db-v2-aggregator branch from b993cdb to 66a378d Compare June 26, 2025 15:55
@turmelclem turmelclem temporarily deployed to testing-preview June 26, 2025 16:18 — with GitHub Actions Inactive
@turmelclem turmelclem force-pushed the ctl/2577-stabilize-cardano-db-v2-aggregator branch from 66a378d to f10f9fc Compare June 27, 2025 07:46
@turmelclem turmelclem temporarily deployed to testing-preview June 27, 2025 08:03 — with GitHub Actions Inactive
@turmelclem turmelclem force-pushed the ctl/2577-stabilize-cardano-db-v2-aggregator branch from f10f9fc to 538b882 Compare June 27, 2025 10:10
@turmelclem turmelclem temporarily deployed to testing-preview June 27, 2025 10:27 — with GitHub Actions Inactive
@turmelclem turmelclem force-pushed the ctl/2577-stabilize-cardano-db-v2-aggregator branch from 538b882 to c825406 Compare June 27, 2025 12:57
@turmelclem turmelclem temporarily deployed to testing-preview June 27, 2025 13:14 — with GitHub Actions Inactive
@turmelclem turmelclem force-pushed the ctl/2577-stabilize-cardano-db-v2-aggregator branch 2 times, most recently from c4eeee6 to 191fa50 Compare June 27, 2025 14:27
@turmelclem turmelclem force-pushed the ctl/2577-stabilize-cardano-db-v2-aggregator branch from 191fa50 to e4324e0 Compare June 27, 2025 14:32
@turmelclem turmelclem temporarily deployed to testing-preview June 27, 2025 14:51 — with GitHub Actions Inactive
Copilot

This comment was marked as outdated.

@turmelclem turmelclem temporarily deployed to testing-preview June 27, 2025 15:30 — with GitHub Actions Inactive
@turmelclem turmelclem marked this pull request as ready for review June 27, 2025 15:30
@turmelclem turmelclem requested a review from Copilot June 27, 2025 15:39
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR stabilizes the Cardano DB v2 aggregator and signer tests by adjusting allowed discriminants and updating download directory parameters. Key changes include removing CardanoImmutableFilesFull from the default allowed discriminants, adding it explicitly in tests and configurations, and standardizing download directory naming with the new --download-dir option.

  • Updated allowed discriminants in various configuration and test files.
  • Revised CLI download commands to use a consistent directory naming scheme.
  • Improved documentation to reflect these changes.

Reviewed Changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated no comments.

Show a summary per file
File Description
mithril-test-lab/mithril-end-to-end/src/stress_test/aggregator_helpers.rs Adds CardanoImmutableFilesFull to test configuration.
mithril-test-lab/mithril-end-to-end/src/mithril/client.rs Introduces the --download-dir parameter for both v1 and v2 downloads.
mithril-test-lab/mithril-end-to-end/src/main.rs Updates the default signed_entity_types to include CardanoImmutableFilesFull.
mithril-signer/tests/create_cardano_transaction_single_signature.rs Updates tests to allow CardanoImmutableFilesFull as a signed entity.
mithril-common/src/entities/signed_entity_config.rs Removes CardanoImmutableFilesFull from DEFAULT_ALLOWED_DISCRIMINANTS.
mithril-client-cli/src/commands/cardano_db/download/* Refactors download commands to use a constant directory name (DB_DIRECTORY_NAME).
mithril-aggregator/tests/* & src/runtime/runner.rs Adapts test helpers to handle the explicit allowed discriminants configuration.
docs/website/* Adjusts documentation to reflect the new download directory logic and configuration changes.
.github/workflows/* Updates CI workflow commands to include --download-dir with the appropriate directory names.
Comments suppressed due to low confidence (2)

mithril-aggregator/src/configuration.rs:491

  • The documentation comment is unclear; consider rephrasing it to 'The value MithrilStakeDistribution is automatically prepended to the list.'
    /// The value `MithrilStakeDistribution` is prepended is automatically to the list.

docs/website/root/manual/develop/nodes/mithril-client.md:581

  • Please verify that updating the default backend to 'v2' in the documentation aligns with the actual default behavior in the client implementation.
| `backend`                  | `--backend`                  |         `-b`         | -                          | -                                                                               | `v2`          | -       |         -          |

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 Cardano DB v2 client CLI/library - Phase 2
1 participant