Skip to content

Feat: documentation and CI tests for UTxO-HD ledger state snapshot conversion mithril-client CLI command #2554

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 9 commits into from
Jun 10, 2025
Merged

Feat: documentation and CI tests for UTxO-HD ledger state snapshot conversion mithril-client CLI command #2554

merged 9 commits into from
Jun 10, 2025
+116 −22

Conversation

dlachaume
Copy link
Collaborator

@dlachaume dlachaume commented Jun 6, 2025 •
edited
Loading

Content

This PR includes the documentation of the unstable mithril-client CLI command that converts a ledger state snapshot from the InMemory format to another flavor (LMDB or Legacy).
It also adds verification steps in the CI to ensure the command executes correctly across multiple environments (Ubuntu, macOS, and Windows).

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)

Relates to #2492

@dlachaume dlachaume self-assigned this Jun 6, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 6, 2025 •
edited
Loading

Test Results

    3 files  ±0     77 suites  ±0   13m 36s ⏱️ -52s
1 996 tests ±0  1 996 ✅ ±0  0 💤 ±0  0 ❌ ±0 
3 454 runs  ±0  3 454 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 35a2299. ± Comparison against base commit fb5e9cb.

♻️ This comment has been updated with latest results.

@dlachaume dlachaume temporarily deployed to testing-preview June 6, 2025 09:00 — with GitHub Actions Inactive
@dlachaume dlachaume force-pushed the dlachaume/2492/add-documentation-and-ci-tests-for-utxo-hd-ledger-state-snapshot-conversion branch from aad58d3 to a5a8bb1 Compare June 6, 2025 09:19
@dlachaume dlachaume temporarily deployed to testing-preview June 6, 2025 09:28 — with GitHub Actions Inactive
@dlachaume dlachaume force-pushed the dlachaume/2492/add-documentation-and-ci-tests-for-utxo-hd-ledger-state-snapshot-conversion branch from a5a8bb1 to 1a9169c Compare June 6, 2025 09:50
@dlachaume dlachaume temporarily deployed to testing-preview June 6, 2025 10:02 — with GitHub Actions Inactive
@dlachaume dlachaume force-pushed the dlachaume/2492/add-documentation-and-ci-tests-for-utxo-hd-ledger-state-snapshot-conversion branch from 1a9169c to ba16002 Compare June 6, 2025 10:17
@dlachaume dlachaume temporarily deployed to testing-preview June 6, 2025 12:24 — with GitHub Actions Inactive
@dlachaume dlachaume temporarily deployed to testing-preview June 6, 2025 13:22 — with GitHub Actions Inactive
@dlachaume dlachaume force-pushed the dlachaume/2492/add-documentation-and-ci-tests-for-utxo-hd-ledger-state-snapshot-conversion branch from e28261e to 9d7fd44 Compare June 6, 2025 13:34
@dlachaume dlachaume temporarily deployed to testing-preview June 6, 2025 13:43 — with GitHub Actions Inactive
@dlachaume dlachaume force-pushed the dlachaume/2492/add-documentation-and-ci-tests-for-utxo-hd-ledger-state-snapshot-conversion branch from 7d9a83c to 0d77e48 Compare June 6, 2025 14:34
@dlachaume dlachaume temporarily deployed to testing-preview June 6, 2025 14:44 — with GitHub Actions Inactive
@dlachaume dlachaume force-pushed the dlachaume/2492/add-documentation-and-ci-tests-for-utxo-hd-ledger-state-snapshot-conversion branch from f9dd8e1 to 28315f1 Compare June 6, 2025 15:07
@dlachaume dlachaume temporarily deployed to testing-preview June 6, 2025 15:22 — with GitHub Actions Inactive
@dlachaume dlachaume force-pushed the dlachaume/2492/add-documentation-and-ci-tests-for-utxo-hd-ledger-state-snapshot-conversion branch from 28315f1 to 2ab21d8 Compare June 10, 2025 07:00
@dlachaume dlachaume temporarily deployed to testing-preview June 10, 2025 07:09 — with GitHub Actions Inactive
@dlachaume dlachaume marked this pull request as ready for review June 10, 2025 07:25
jpraynaud
jpraynaud approved these changes Jun 10, 2025
View reviewed changes
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

@dlachaume dlachaume force-pushed the dlachaume/2492/add-documentation-and-ci-tests-for-utxo-hd-ledger-state-snapshot-conversion branch 2 times, most recently from e592cd7 to aca1b39 Compare June 10, 2025 08:26
@dlachaume dlachaume temporarily deployed to testing-preview June 10, 2025 08:26 — with GitHub Actions Inactive
@dlachaume dlachaume temporarily deployed to testing-preview June 10, 2025 08:37 — with GitHub Actions Inactive
@dlachaume dlachaume force-pushed the dlachaume/2492/add-documentation-and-ci-tests-for-utxo-hd-ledger-state-snapshot-conversion branch 2 times, most recently from 7a7c6e1 to ec18bd0 Compare June 10, 2025 08:52
@dlachaume dlachaume temporarily deployed to testing-preview June 10, 2025 09:02 — with GitHub Actions Inactive
@dlachaume dlachaume force-pushed the dlachaume/2492/add-documentation-and-ci-tests-for-utxo-hd-ledger-state-snapshot-conversion branch from ec18bd0 to 674ae05 Compare June 10, 2025 09:03
turmelclem
turmelclem approved these changes Jun 10, 2025
View reviewed changes
Copy link
Collaborator

@turmelclem turmelclem left a comment

Choose a reason for hiding this comment

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

LGTM

@dlachaume dlachaume temporarily deployed to testing-preview June 10, 2025 09:11 — with GitHub Actions Inactive
@dlachaume dlachaume force-pushed the dlachaume/2492/add-documentation-and-ci-tests-for-utxo-hd-ledger-state-snapshot-conversion branch from 674ae05 to 743ca49 Compare June 10, 2025 10:26
dlachaume added 9 commits June 10, 2025 12:42
@dlachaume
feat(client-cli): add http response message when calling GitHub API
66b2c87
@dlachaume
feat(client-cli): add GitHub token support for authenticated API call…
a13053b 
…s in snapshot converter command
@dlachaume
refactor(client-cli): replace usage of prerelease with pre-release
a52fc71
@dlachaume
docs(website): add tools commands and parameters to Mithril client do…
eda42f1 
…cumentation
@dlachaume
docs(website): update bootstrap cardano node guide
c8f7d3a
@dlachaume
test: add ledger state snapshot conversion command in `Mithril Client…
9863d79 
… multi-platform test` workflow
@dlachaume
test: removal of the step that deletes the directory, as it's unneces…
e7c1655 
…sary since the Docker command removes the container after execution
@dlachaume
test: add artifact upload step for test-mithril-client-wasm job
0d75d2b
@dlachaume
chore: upgrade crate versions
35a2299 
* mithril-client-cli from `0.12.9` to `0.12.10`
@dlachaume dlachaume force-pushed the dlachaume/2492/add-documentation-and-ci-tests-for-utxo-hd-ledger-state-snapshot-conversion branch from 743ca49 to 35a2299 Compare June 10, 2025 10:42
@dlachaume dlachaume temporarily deployed to testing-preview June 10, 2025 10:51 — with GitHub Actions Inactive
@dlachaume dlachaume merged commit ce42d51 into main Jun 10, 2025
38 checks passed
@dlachaume dlachaume deleted the dlachaume/2492/add-documentation-and-ci-tests-for-utxo-hd-ledger-state-snapshot-conversion branch June 10, 2025 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Alenar Alenar Alenar approved these changes

@jpraynaud jpraynaud jpraynaud approved these changes

@turmelclem turmelclem turmelclem approved these changes

Assignees

@dlachaume dlachaume

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dlachaume @Alenar @jpraynaud @turmelclem