Merge pull request #2347 from input-output-hk/sfa/2248/use_consistent_naming_in_the_client_cardano_database_api

Use consistent naming in the client cardano database api

Author: sfauvel

Cargo.lock

@@ -5,10 +5,10 @@ resolver = "2"
 members = [
   "demo/protocol-demo",
   "examples/client-cardano-database",
+  "examples/client-cardano-database-v2",
   "examples/client-cardano-stake-distribution",
   "examples/client-cardano-transaction",
   "examples/client-mithril-stake-distribution",
-  "examples/client-snapshot",
   "internal/mithril-build-script",
   "internal/mithril-doc",
   "internal/mithril-doc-derive",

Cargo.toml

@@ -0,0 +1,3 @@
+target/
+client-cardano-database
+.DS_Store

examples/client-cardano-database-v2/.gitignore

@@ -1,7 +1,7 @@
 [package]
-name = "client-snapshot"
-description = "Mithril client snapshot example"
-version = "0.1.25"
+name = "client-cardano-database-v2"
+description = "Mithril client Cardano database example"
+version = "0.0.2"
 authors = ["[email protected]", "[email protected]"]
 documentation = "https://mithril.network/doc"
 edition = "2021"
@@ -15,5 +15,5 @@ async-trait = "0.1.86"
 clap = { version = "4.5.28", features = ["derive", "env"] }
 futures = "0.3.31"
 indicatif = "0.17.11"
-mithril-client = { path = "../../mithril-client", features = ["fs"] }
+mithril-client = { path = "../../mithril-client", features = ["fs", "unstable"] }
 tokio = { version = "1.43.0", features = ["full"] }

examples/client-snapshot/Cargo.toml renamed to examples/client-cardano-database-v2/Cargo.toml

@@ -1,16 +1,16 @@
-# Mithril client library example: Snapshot
+# Mithril client library example: Cardano database
 
 ## Description
 
-This example shows how to implement a Mithril client and use its features related to the `Snapshot` type.
+This example shows how to implement a Mithril client and use its features related to the `Cardano database` type.
 
-In this example, the client interacts by default with a real aggregator on the network `release-preprod` to:
+In this example, the client interacts by default with a real aggregator on the network `testing-preview` to:
 
 - list the available snapshots
 - get a single snapshot
-- download and unpack a snapshot archive
-- verify a certificate chain
-- compute a message for a Snapshot
+- download and unpack snapshot archives tailored for a specific range
+- verify the associated certificate and its chain
+- compute a message for the retrieved artifact files
 - verify that the certificate signs the computed message
 - increments snapshot download statistics
 
@@ -32,7 +32,7 @@ cargo run
 AGGREGATOR_ENDPOINT=YOUR_AGGREGATOR_ENDPOINT GENESIS_VERIFICATION_KEY=YOUR_GENESIS_VERIFICATION_KEY cargo run
 
 # Example with 'release-preprod' network
-AGGREGATOR_ENDPOINT=https://aggregator.release-preprod.api.mithril.network/aggregator GENESIS_VERIFICATION_KEY=$(curl -s https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/genesis.vkey) cargo run
+AGGREGATOR_ENDPOINT=https://aggregator.testing-preview.api.mithril.network/aggregator GENESIS_VERIFICATION_KEY=$(curl -s https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/genesis.vkey) cargo run
 ```
 
 ## Links