Skip to content

Stabilize Cardano DB v2 client CLI/library - Phase 1 #2493

Open
@jpraynaud

Description

@jpraynaud

Why

We want to make the Cardano DB v2 certification stable and provide seamless forward/backward compatibility for users.

What

Use the the two backends (v1 and v2) in the cardano-db command (and cardano_database() in library).

How

  • Mithril client CLI:
    • Calibrate max_parallel_downloads in DownloadUnpackOptions for optimal download time on mainnet
    • Add an option for the Cardano database backend in the client CLI (by default use v1 and have an extra option --v2 or --backend=v2):
      • download command
      • list command
      • show command
    • Add all options of v2 in the command:
      • --start, --end and --allow-override for immutable range
      • Add an information for backend compatibility in the doc comments of the parameters
      • Ignore them in v1, and print a warning message stating they are not used
    • Deprecate cardano-db-v2 command:
      • Print a warning message to use the --v2 backend in the cardano-db command
    • Update documentation:
      • Mithril client node commands
      • Upgrade the guide for bootstrapping a Cardano node with restoration of a range of immutables
    • Run manual successful restoration of Cardano database + restart of the Cardano node:
      • Cardano DB v1
        • with ancillary
        • without ancillary
      • Cardano DB v2
        • with ancillary
        • without ancillary
  • Mithril client library:
    • Make the cardano_database_v2 function stable
  • Update the commands in the Mithril Client multi-platform test workflow in the CI
  • Add dev blog post to explain the transition
  • Make Discord announcement

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions