Make mithril-client examples full crates

Two seperates crates were created: - `mithril-client-snapshot-example` - `mithril-client-stake-distribution-example`
input-output-hk · Dec 1, 2023 · 34c1cd1 · 34c1cd1
1 parent 426b764
commit 34c1cd1
Show file tree

Hide file tree

Showing 10 changed files with 191 additions and 9 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -4,6 +4,8 @@ resolver = "2"
 
 members = [
   "demo/protocol-demo",
+  "examples/client-mithril-stake-distribution",
+  "examples/client-snapshot",
   "mithril-aggregator",
   "mithril-client",
   "mithril-client-cli",

diff --git a/examples/client-mithril-stake-distribution/.gitignore b/examples/client-mithril-stake-distribution/.gitignore
@@ -0,0 +1,3 @@
+target/
+client-mithril-stake-distribution
+.DS_Store
diff --git a/examples/client-mithril-stake-distribution/Cargo.toml b/examples/client-mithril-stake-distribution/Cargo.toml
@@ -0,0 +1,18 @@
+[package]
+name = "client-mithril-stake-distribution"
+description = "Mithril client stake distribution example"
+version = "0.1.0"
+authors = ["dev@iohk.io"]
+documentation = "https://mithril.network/doc"
+edition = "2021"
+homepage = "https://mithril.network"
+license = "Apache-2.0"
+repository = "https://github.com/input-output-hk/mithril/"
+
+[dependencies]
+anyhow = "1.0.75"
+mithril-client = "0.5.7"
+slog = "2.7.0"
+slog-async = "2.8.0"
+slog-term = "2.9.0"
+tokio = { version = "1.32.0", features = ["full"] }
diff --git a/examples/client-mithril-stake-distribution/README.md b/examples/client-mithril-stake-distribution/README.md
@@ -0,0 +1,15 @@
+# Mithril client library example: Mithril stake distribution
+
+## Build and run the example
+
+```bash
+# Build
+cargo build -p client-mithril-stake-distribution
+
+# Run
+cargo run -p client-mithril-stake-distribution
+```
+
+## Links
+- **Developer documentation**: https://docs.rs/mithril-client/0.5.7/mithril_client/
+- **Crates.io**: https://crates.io/crates/mithril-client
diff --git a/...ril_stake_distribution_list_get_verify.rs → ...nt-mithril-stake-distribution/src/main.rs b/...ril_stake_distribution_list_get_verify.rs → ...nt-mithril-stake-distribution/src/main.rs
diff --git a/examples/client-snapshot/.gitignore b/examples/client-snapshot/.gitignore
@@ -0,0 +1,3 @@
+target/
+client-snapshot
+.DS_Store
diff --git a/examples/client-snapshot/Cargo.toml b/examples/client-snapshot/Cargo.toml
@@ -0,0 +1,18 @@
+[package]
+name = "client-snapshot"
+description = "Mithril client snapshot example"
+version = "0.1.0"
+authors = ["dev@iohk.io"]
+documentation = "https://mithril.network/doc"
+edition = "2021"
+homepage = "https://mithril.network"
+license = "Apache-2.0"
+repository = "https://github.com/input-output-hk/mithril/"
+
+[dependencies]
+anyhow = "1.0.75"
+async-trait = "0.1.73"
+futures = "0.3.28"
+indicatif = "0.17.7"
+mithril-client = "0.5.7"
+tokio = { version = "1.32.0", features = ["full"] }
diff --git a/examples/client-snapshot/README.md b/examples/client-snapshot/README.md
@@ -0,0 +1,15 @@
+# Mithril client library example: Snapshot
+
+## Build and run the example
+
+```bash
+# Build
+cargo build -p client-snapshot
+
+# Run
+cargo run -p client-snapshot
+```
+
+## Links
+- **Developer documentation**: https://docs.rs/mithril-client/0.5.7/mithril_client/
+- **Crates.io**: https://crates.io/crates/mithril-client
diff --git a/...snapshot_list_get_show_download_verify.rs → examples/client-snapshot/src/main.rs b/...snapshot_list_get_show_download_verify.rs → examples/client-snapshot/src/main.rs