Skip to content

Use consistent naming in the client cardano database api #2347

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 8 commits into from
Mar 6, 2025
Merged

Use consistent naming in the client cardano database api #2347

merged 8 commits into from
Mar 6, 2025

Conversation

sfauvel
Copy link
Collaborator

@sfauvel sfauvel commented Mar 4, 2025 •
edited
Loading

Content

Align function names in the client Cardano database APIs by deprecated legacy snapshot name.

  • snapshot() is deprecated and redirect to the new cardano_database() function
  • in the WASM client
  • get_snapshot() is deprecated and redirect to the new get_cardano_database_snapshot() function
  • list_snapshots() is deprecated and redirect to the new list_cardano_database_snapshots() function
  • rename example client-cardano-database to client-cardano-database-v2
  • rename example client-snapshot to client-cardano-database

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 #2248

@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 4, 2025 •
edited
Loading

Test Results

    3 files  ±0     55 suites  ±0   10m 8s ⏱️ -15s
1 683 tests ±0  1 683 ✅ ±0  0 💤 ±0  0 ❌ ±0 
2 075 runs  ±0  2 075 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 4ab55cd. ± Comparison against base commit 380cbba.

♻️ This comment has been updated with latest results.

@sfauvel sfauvel changed the title Sfa/2248/use consistent naming in the client cardano database api Use consistent naming in the client cardano database api Mar 5, 2025
@sfauvel sfauvel force-pushed the sfa/2248/use_consistent_naming_in_the_client_cardano_database_api branch 3 times, most recently from 055c6a8 to f06135c Compare March 5, 2025 10:37
@sfauvel sfauvel temporarily deployed to testing-preview March 5, 2025 10:45 — with GitHub Actions Inactive
@sfauvel sfauvel force-pushed the sfa/2248/use_consistent_naming_in_the_client_cardano_database_api branch 2 times, most recently from f76efec to 4eca453 Compare March 5, 2025 10:51
@sfauvel sfauvel temporarily deployed to testing-preview March 5, 2025 11:00 — with GitHub Actions Inactive
@sfauvel sfauvel marked this pull request as ready for review March 5, 2025 11:06
@sfauvel sfauvel requested review from dlachaume, Alenar and jpraynaud and removed request for dlachaume and Alenar March 5, 2025 11:06
@jpraynaud jpraynaud requested a review from Alenar March 5, 2025 13:06
jpraynaud
jpraynaud reviewed Mar 5, 2025
View reviewed changes
@sfauvel sfauvel force-pushed the sfa/2248/use_consistent_naming_in_the_client_cardano_database_api branch from 6c0b38a to af6bb8d Compare March 5, 2025 14:09
@sfauvel sfauvel temporarily deployed to testing-preview March 5, 2025 14:18 — with GitHub Actions Inactive
@sfauvel sfauvel force-pushed the sfa/2248/use_consistent_naming_in_the_client_cardano_database_api branch from af6bb8d to ddb8f3d Compare March 5, 2025 14:22
@sfauvel sfauvel temporarily deployed to testing-preview March 5, 2025 14:31 — with GitHub Actions Inactive
Alenar
Alenar approved these changes Mar 5, 2025
View reviewed changes
Copy link
Collaborator

@Alenar Alenar left a comment

Choose a reason for hiding this comment

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

LGTM

jpraynaud
jpraynaud approved these changes Mar 5, 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 👍

@sfauvel sfauvel force-pushed the sfa/2248/use_consistent_naming_in_the_client_cardano_database_api branch from ddb8f3d to 6f8fbdc Compare March 5, 2025 15:01
@sfauvel sfauvel temporarily deployed to testing-preview March 5, 2025 15:09 — with GitHub Actions Inactive
dlachaume
dlachaume approved these changes Mar 5, 2025
View reviewed changes
Copy link
Collaborator

@dlachaume dlachaume left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@sfauvel sfauvel force-pushed the sfa/2248/use_consistent_naming_in_the_client_cardano_database_api branch from 6f8fbdc to 8176db4 Compare March 5, 2025 15:49
@sfauvel sfauvel temporarily deployed to testing-preview March 5, 2025 15:58 — with GitHub Actions Inactive
@sfauvel sfauvel force-pushed the sfa/2248/use_consistent_naming_in_the_client_cardano_database_api branch from 8176db4 to a25c57c Compare March 5, 2025 16:41
@sfauvel sfauvel temporarily deployed to testing-preview March 5, 2025 16:49 — with GitHub Actions Inactive
@sfauvel sfauvel force-pushed the sfa/2248/use_consistent_naming_in_the_client_cardano_database_api branch from a25c57c to 3e1c627 Compare March 5, 2025 17:23
@sfauvel sfauvel temporarily deployed to testing-preview March 5, 2025 17:31 — with GitHub Actions Inactive
@sfauvel sfauvel force-pushed the sfa/2248/use_consistent_naming_in_the_client_cardano_database_api branch from 3e1c627 to b1ff08b Compare March 6, 2025 08:50
@sfauvel sfauvel temporarily deployed to testing-preview March 6, 2025 08:59 — with GitHub Actions Inactive
sfauvel added 3 commits March 6, 2025 11:01
@sfauvel
feat: rename example cardano-databaseto cardano-database-v2
8d1b51a
@sfauvel
feat: rename example snapshotto cardano-database
59c050d
@sfauvel
chore: upgrade crate versions
4ab55cd 
 * client-cardano-database-v2 from `0.0.1` to `0.0.2`
 * client-cardano-database from `0.1.25` to `0.1.26`
* mithril-client-cli from `0.11.8` to `0.11.9`
* mithril-client-wasm from `0.8.4` to `0.8.5`
* mithril-client from `0.11.10` to `0.11.11`
* [js] mithril-client-wasm from `0.8.4` to `0.8.5`
@sfauvel sfauvel force-pushed the sfa/2248/use_consistent_naming_in_the_client_cardano_database_api branch from b1ff08b to 4ab55cd Compare March 6, 2025 10:07
@sfauvel sfauvel temporarily deployed to testing-preview March 6, 2025 10:16 — with GitHub Actions Inactive
@sfauvel sfauvel merged commit 86c1e4f into main Mar 6, 2025
36 checks passed
@sfauvel sfauvel deleted the sfa/2248/use_consistent_naming_in_the_client_cardano_database_api branch March 6, 2025 10:52
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

@dlachaume dlachaume dlachaume approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Use consistent naming in the client Cardano database APIs
4 participants
@sfauvel @Alenar @jpraynaud @dlachaume