feat(cardano-chain-follower): Implementation (#43)

* chore: cardano-node-follower crate API design

* chore: allow Blue Oak license (need for minicbor crate)

* chore: drop node-to-client support and make rollback chain update return a block

* feat: Add chain follower config and builder

* chore: Remove chain follower crate example (hard to keep up to date)

* chore: Remove chain follower struct fields (implementation specific)

* feat: Add chain follower block fetch methods

* chore: Add fetch block and fetch block range examples

* chore: Fix lint and fmt

* chore: Add chain reader struct and refactor some methods

* chore: Add words to cspell project dictionary

* chore: fix fmt

* chore: Change read_block point type

* chore: Fix lint

* chore: Update rust CI version

* feat: Chain reader implemetation

* feat: Chain follower implemetation

* chore: Add tracing-subscriber to examples (logging enabled by default env)

* chore: Fix lint

* chore: Fix lint

* chore: Remove Cargo.lock

* feat: Cardano chain follower Mithril snapshots integration (#60)

* feat(cardano-chain-follower): Split reader and follower and reader now supports reading single block and block ranges from Mithril snapshots

* feat(cardano-chain-follower): Follower now uses request-response to communicate with its background task

* feat(cardano-chain-follower): Follower reads blocks from Mithril
snapshot (if configured)

* chore(cardano-chain-follower): Cleanup traces and add missing docs

* chore(cardano-chain-follower): Fix linter issues

* chore(cardano-chain-follower): Fix formatting

* chore(cardano-chain-follower): Fix spelling and cspell config

* chore(cardano-chain-follower): Use pallas_hardano as a separate crate to avoid license issues

* chore: Add cleanup comment to Cargo.toml

* chore: Update CI files

---------

Co-authored-by: Steven Johnson <stevenj@users.noreply.github.com>

Author: Felipe Rosa

.config/dictionaries/project.dic

@@ -3,10 +3,13 @@ addrr
 adminer
 asyncio
 auditability
+backpressure
+blockfetch
 BROTLI
 cardano
 cbor
 CEST
+chainsync
 chrono
 ciphertext
 codepoints
@@ -25,6 +28,7 @@ fontawesome
 fsgr
 genhtml
 gmtime
+hardano
 ideascale
 Intellij
 iohk
@@ -38,6 +42,7 @@ Leshiy
 localizable
 mdlint
 miniprotocols
+mithril
 mitigations
 moderations
 multiera

cspell.json

@@ -215,7 +215,7 @@
         //.config/dictionaries/cspell/sv/cspell-ext.json
         //.config/dictionaries/cspell/tr_TR/cspell-ext.json
         //.config/dictionaries/cspell/uk_UA/cspell-ext.json
-        //.config/dictionaries/cspell/vi_VN/cspell-ext.json        
+        //.config/dictionaries/cspell/vi_VN/cspell-ext.json
     ],
     "ignorePaths": [
         ".config/dictionaries/**",
@@ -225,6 +225,7 @@
         "**/.gitignore",
         ".vscode/**",
         "**/.idea/**",
-        "hermes/wasm/*/**"
+        "hermes/wasm/*/**",
+        "hermes/crates/cardano-chain-follower/examples/snapshot_data"
     ]
-}
+}

docs/Earthfile

@@ -11,7 +11,7 @@ src:
     # Now copy into that any artifacts we pull from the builds.
     COPY --dir ../+repo-docs/repo /docs/includes
     # copy Rust docs
-    COPY ./../hermes+hosted-build/doc /docs/src/api/rust-docs
+    COPY ./../hermes+build/doc /docs/src/api/rust-docs
 
 # Build the docs here.
 docs:

hermes/.cargo/config.toml

@@ -1,7 +1,7 @@
 # Use MOLD linker where possible, but ONLY in CI applicable targets.
 # cspell: words rustflags armv gnueabihf msvc nextest idents rustdocflags
 # cspell: words rustdoc lintfix lintrestrict testfast testdocs codegen testci testunit
-# cspell: words fmtchk fmtfix
+# cspell: words fmtchk fmtfix testcov
 
 # Configure how Docker container targets build.
 
@@ -28,6 +28,8 @@ rustflags = [
     "-C", "target-feature=-crt-static"
 ]
 
+[target.wasm32-unknown-unknown]
+rustflags = ["--cap-lints", "warn"]
 
 [build]
 
@@ -110,23 +112,21 @@ codegen-units = 16
 [alias]
 lint = "clippy --all-targets -- -D warnings -D clippy::pedantic -D clippy::unwrap_used -D clippy::expect_used -D clippy::exit -D clippy::get_unwrap -D clippy::index_refutable_slice -D clippy::indexing_slicing -D clippy::match_on_vec_items -D clippy::match_wild_err_arm -D clippy::missing_panics_doc -D clippy::panic -D clippy::string_slice -D clippy::unchecked_duration_subtraction -D clippy::unreachable -D clippy::missing_docs_in_private_items"
 lintfix = "clippy --all-targets --fix --allow-dirty -- -D warnings -D clippy::pedantic -D clippy::unwrap_used -D clippy::expect_used -D clippy::exit -D clippy::get_unwrap -D clippy::index_refutable_slice -D clippy::indexing_slicing -D clippy::match_on_vec_items -D clippy::match_wild_err_arm -D clippy::missing_panics_doc -D clippy::panic -D clippy::string_slice -D clippy::unchecked_duration_subtraction -D clippy::unreachable -D clippy::missing_docs_in_private_items"
-lintrestrict = "clippy -- -D warnings -D clippy::pedantic -D clippy::restriction -D clippy::missing_docs_in_private_items"
-lint-vscode = "clippy --workspace --message-format=json-diagnostic-rendered-ansi --all-targets -- -D warnings -D clippy::pedantic -D clippy::unwrap_used -D clippy::expect_used -D clippy::exit -D clippy::get_unwrap -D clippy::index_refutable_slice -D clippy::indexing_slicing -D clippy::match_on_vec_items -D clippy::match_wild_err_arm -D clippy::missing_panics_doc -D clippy::panic -D clippy::string_slice -D clippy::unchecked_duration_subtraction -D clippy::unreachable -D clippy::missing_docs_in_private_items"
+lint-vscode = "clippy --message-format=json-diagnostic-rendered-ansi --all-targets -- -D warnings -D clippy::pedantic -D clippy::unwrap_used -D clippy::expect_used -D clippy::exit -D clippy::get_unwrap -D clippy::index_refutable_slice -D clippy::indexing_slicing -D clippy::match_on_vec_items -D clippy::match_wild_err_arm -D clippy::missing_panics_doc -D clippy::panic -D clippy::string_slice -D clippy::unchecked_duration_subtraction -D clippy::unreachable -D clippy::missing_docs_in_private_items"
 
-docs = "doc --workspace -r --all-features --no-deps --bins --document-private-items --examples --locked"
+docs = "doc --release --no-deps --document-private-items --bins --lib --examples"
 # nightly docs build broken... when they are'nt we can enable these docs... --unit-graph --timings=html,json -Z unstable-options"
-testfast = "nextest run --release --workspace --locked"
-testunit = "nextest run --release --bins --lib --workspace --locked -P ci"
-testci = "nextest run --release --workspace --locked -P ci"
-testdocs = "test --doc --release --workspace --locked"
+testunit = "nextest run --release --bins --lib -P ci"
+testcov = "llvm-cov nextest --release --bins --lib -P ci"
+testdocs = "test --doc --release"
 
 # Rust formatting, MUST be run with +nightly
 fmtchk = "fmt -- --check -v --color=always"
 fmtfix = "fmt -- -v"
 
 [term]
-quiet = false          # whether cargo output is quiet
-verbose = true         # whether cargo provides verbose output
-color = 'always'       # whether cargo colorizes output use `CARGO_TERM_COLOR="off"` to disable.
-progress.when = 'auto' # whether cargo shows progress bar
-progress.width = 80    # width of progress bar
+quiet = false           # whether cargo output is quiet
+verbose = false         # whether cargo provides verbose output
+color = 'auto'          # whether cargo colorizes output use `CARGO_TERM_COLOR="off"` to disable.
+progress.when = 'never' # whether cargo shows progress bar
+progress.width = 80     # width of progress bar

hermes/.config/nextest.toml

@@ -35,7 +35,7 @@ path = "junit.xml"
 # The name of the top-level "report" element in JUnit report. If aggregating
 # reports across different test runs, it may be useful to provide separate names
 # for each report.
-report-name = "cat-gateway"
+report-name = "nextest"
 
 # Whether standard output and standard error for passing tests should be stored in the JUnit report.
 # Output is stored in the <system-out> and <system-err> elements of the <testcase> element.