diff --git a/justfile b/justfile new file mode 100644 index 0000000..6499980 --- /dev/null +++ b/justfile @@ -0,0 +1,34 @@ +alias b := build +alias c := check +alias f := fmt +alias t := test +alias p := pre-push + +_default: + @just --list + +# Build the project +build: + cargo build + +# Check code: formatting, compilation, linting, doc comments, and commit signature +check: + cargo +nightly fmt --all -- --check + cargo check --all-features --all-targets + cargo clippy --all-features --all-targets -- -D warnings + RUSTDOCFLAGS="-D warnings" cargo doc --all-features --no-deps + @[ "$(git log --pretty='format:%G?' -1 HEAD)" = "N" ] && \ + echo "\n⚠️ Unsigned commit: BDK requires that commits be signed." || \ + true + +# Format all code +fmt: + cargo +nightly fmt + +# Run all tests on the workspace with all features +test: + cargo test --all-features -- --test-threads=1 + +# Run pre-push suite: format, check, and test +pre-push: fmt check test + diff --git a/src/utils.rs b/src/utils.rs index fc02dfb..bcc3450 100644 --- a/src/utils.rs +++ b/src/utils.rs @@ -13,7 +13,7 @@ use bitcoin::Txid; /// otherwise. /// /// [`transaction_get_merkle`]: crate::ElectrumApi::transaction_get_merkle -/// [`BlockHeader`]: bitcoin::BlockHeader +/// [`BlockHeader`]: bitcoin::block::Header pub fn validate_merkle_proof( txid: &Txid, merkle_root: &TxMerkleNode,