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

Use consistent naming in the client Cardano database APIs #2248

Open
5 tasks
jpraynaud opened this issue Jan 27, 2025 · 0 comments
Open
5 tasks

Use consistent naming in the client Cardano database APIs #2248

jpraynaud opened this issue Jan 27, 2025 · 0 comments
Labels
refactoring 🛠️ Code refactoring and enhancements

Comments

@jpraynaud
Copy link
Member

Why

We need to align the usage of the function names in the client Cardano database APIs. In particular, we want to remove the usage of snapshot for the CardanoImmutableFilesFull signed entity type.

What

Deprecate current usage of snapshot for the CardanoImmutableFilesFull signed entity type.

How

  • Deprecate legacy snapshot name for CardanoImmutableFilesFull signed entity type:
    • Create cardano_database() client in the library
    • Deprecate the snapshot() client in the library (becomes an alias of cardano_database())
    • Deprecate the get_snapshot and list_snasphots function in the WASM client
    • Create the list_cardano_database and get_cardano_database to replace them in the WASM client
@jpraynaud jpraynaud added the refactoring 🛠️ Code refactoring and enhancements label Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring 🛠️ Code refactoring and enhancements
Projects
None yet
Development

No branches or pull requests

1 participant