Merge #95: chore: upgrade and bump some CI dependencies

1a4d5cf chore(rust+clippy): bump `edition` to 2021, and add `.clippy.toml` (Leonardo Lima)
b7636e8 fix(fmt): apply suggested fixes from `rustfmt` (Leonardo Lima)
3f2ca2f refactor(ci)!: add new `fmt` and `clippy` jobs (Leonardo Lima)
9f888c1 chore(deps): bump `actions/checkout` from v3 to v4 (Leonardo Lima)

Pull request description:

  <!-- You can erase any parts of this template not applicable to your Pull Request. -->

  ### Description

  This PR does some improvements on CI, these are some changes that I ended up doing on other refactoring and feature PRs (making them too convoluted), but had a specific CI scope so I'm moving them to a specific PR.

  This PR does:

  - bump the `actions/checkout@v3` to `actions/checkout@v4`.
  - adds two new jobs for `fmt` and `clippy` (clippy has been moved to a specific job).
  - fix the newly found `fmt` problems.
  - bump the rust edition to `2021`.
  - adds `.clippy.toml` file with `msrv=1.63.0`.

  <!-- Describe the purpose of this PR, what's being adding and/or fixed -->

  ### Notes to the reviewers

  I hope this PR reduces the scope convolution from the other ones #67 #93, and makes the review easier.

  <!-- In this section you can include notes directed to the reviewers, like explaining why some parts
  of the PR were done in a specific way -->

  ### Changelog notice

  - Bump the `actions/checkout@v3` to `actions/checkout@v4`.
  - Adds two new jobs for `fmt` and `clippy` (clippy has been moved to a specific job).
  - Multiple fixes for the newly found `fmt` problems.
  - Bump the rust edition to `2021`.
  - Adds `.clippy.toml` file with `msrv=1.63.0`.

  <!-- Notice the release manager should include in the release tag message changelog -->
  <!-- See https://keepachangelog.com/en/1.0.0/ for examples -->

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
  * [x] I ran `cargo fmt` and `cargo clippy` before committing

ACKs for top commit:
  ValuedMammal:
    ACK 1a4d5cf
  notmandatory:
    ACK 1a4d5cf

Tree-SHA512: e693baeea112dffa12ccc576271f38f3188dc24669a70af7196e33e5eea08c5d82940792330682b8a4b1ec48ef98e1cbaa2f713736f393555744fdf44d79a26a

.clippy.toml

@@ -0,0 +1 @@
+msrv="1.63.0"

.github/workflows/cont_integration.yml

@@ -1,4 +1,4 @@
-name: Rust
+name: CI
 
 on:
   push:
@@ -11,13 +11,12 @@ env:
 
 jobs:
   build-test:
-
+    name: Build & Test
     runs-on: ubuntu-latest
     strategy:
       matrix:
         rust:
           - version: stable # STABLE
-            clippy: true
           - version: 1.63.0 # MSRV
         features:
           - default
@@ -32,27 +31,27 @@ jobs:
           - async-https-rustls
           - async-https-rustls-manual-roots
     steps:
-    - uses: actions/checkout@v3
+    - name: Checkout
+      uses: actions/checkout@v4
     - name: Generate cache key
       run: echo "${{ matrix.rust.version }} ${{ matrix.features }}" | tee .cache_key
-    - name: cache
+    - name: Rust Cache
       uses: actions/cache@v3
       with:
         path: |
           ~/.cargo/registry
           ~/.cargo/git
           target
         key: ${{ runner.os }}-cargo-${{ hashFiles('.cache_key') }}-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }}
-    - name: Set default toolchain
-      run: rustup default ${{ matrix.rust.version }}
+    - name: Install Rust Toolchain
+      uses: dtolnay/rust-toolchain@v1
+      with:
+        toolchain: ${{ matrix.rust.version }}
     - name: Set profile
       run: rustup set profile minimal
-    - name: Add clippy
-      if: ${{ matrix.rust.clippy }}
-      run: rustup component add clippy
     - name: Update toolchain
       run: rustup update
-    - name: pin dependencies
+    - name: Pin dependencies for MSRV
       if: matrix.rust.version == '1.63.0'
       run: |
         cargo update -p zstd-sys --precise "2.0.8+zstd.1.5.5"
@@ -62,8 +61,44 @@ jobs:
         cargo update -p tokio --precise "1.38.1"
     - name: Build
       run: cargo build --features ${{ matrix.features }} --no-default-features
-    - name: Clippy
-      if: ${{ matrix.rust.clippy }}
-      run: cargo clippy --all-targets --features ${{ matrix.features }} --no-default-features -- -D warnings
     - name: Test
       run: cargo test --features ${{ matrix.features }} --no-default-features -- --test-threads=1
+
+  fmt:
+    name: Rust Formatting
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install Rust Toolchain
+        uses: dtolnay/rust-toolchain@v1
+        with:
+            toolchain: nightly
+            components: rustfmt
+      - name: Check fmt
+        run: cargo fmt --all --check
+
+  clippy:
+    name: Rust Clippy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install Rust Toolchain
+        uses: dtolnay/rust-toolchain@v1
+        with:
+            toolchain: stable
+            components: clippy
+      - name: Rust Cache
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: ${{ runner.os }}-cargo-${{ hashFiles('.cache_key') }}-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }}
+      - name: Check clippy
+        uses: actions-rs/clippy-check@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --all-features --all-targets -- -D warnings

.rustfmt.toml

@@ -0,0 +1,3 @@
+format_code_in_doc_comments=true
+wrap_comments=true
+comment_width=100

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "esplora-client"
 version = "0.9.0"
-edition = "2018"
+edition = "2021"
 authors = ["Alekos Filini <alekos.filini@gmail.com>"]
 license = "MIT"
 homepage = "https://github.com/bitcoindevkit/rust-esplora-client"

src/async.rs

@@ -100,7 +100,8 @@ impl AsyncClient {
         }
     }
 
-    /// Get a [`Txid`] of a transaction given its index in a block with a given hash.
+    /// Get a [`Txid`] of a transaction given its index in a block with a given
+    /// hash.
     pub async fn get_txid_at_block_index(
         &self,
         block_hash: &BlockHash,
@@ -222,7 +223,8 @@ impl AsyncClient {
         }
     }
 
-    /// Get a merkle inclusion proof for a [`Transaction`] with the given [`Txid`].
+    /// Get a merkle inclusion proof for a [`Transaction`] with the given
+    /// [`Txid`].
     pub async fn get_merkle_proof(&self, tx_hash: &Txid) -> Result<Option<MerkleProof>, Error> {
         let resp = self
             .client
@@ -244,7 +246,8 @@ impl AsyncClient {
         }
     }
 
-    /// Get a [`MerkleBlock`] inclusion proof for a [`Transaction`] with the given [`Txid`].
+    /// Get a [`MerkleBlock`] inclusion proof for a [`Transaction`] with the
+    /// given [`Txid`].
     pub async fn get_merkle_block(&self, tx_hash: &Txid) -> Result<Option<MerkleBlock>, Error> {
         let resp = self
             .client
@@ -267,7 +270,8 @@ impl AsyncClient {
         }
     }
 
-    /// Get the spending status of an output given a [`Txid`] and the output index.
+    /// Get the spending status of an output given a [`Txid`] and the output
+    /// index.
     pub async fn get_output_status(
         &self,
         txid: &Txid,
@@ -372,7 +376,8 @@ impl AsyncClient {
 
     /// Get confirmed transaction history for the specified address/scripthash,
     /// sorted with newest first. Returns 25 transactions per page.
-    /// More can be requested by specifying the last txid seen by the previous query.
+    /// More can be requested by specifying the last txid seen by the previous
+    /// query.
     pub async fn scripthash_txs(
         &self,
         script: &Script,
@@ -399,8 +404,8 @@ impl AsyncClient {
         }
     }
 
-    /// Get an map where the key is the confirmation target (in number of blocks)
-    /// and the value is the estimated feerate (in sat/vB).
+    /// Get an map where the key is the confirmation target (in number of
+    /// blocks) and the value is the estimated feerate (in sat/vB).
     pub async fn get_fee_estimates(&self) -> Result<HashMap<u16, f64>, Error> {
         let resp = self
             .client
@@ -418,10 +423,11 @@ impl AsyncClient {
         }
     }
 
-    /// Gets some recent block summaries starting at the tip or at `height` if provided.
+    /// Gets some recent block summaries starting at the tip or at `height` if
+    /// provided.
     ///
-    /// The maximum number of summaries returned depends on the backend itself: esplora returns `10`
-    /// while [mempool.space](https://mempool.space/docs/api) returns `15`.
+    /// The maximum number of summaries returned depends on the backend itself:
+    /// esplora returns `10` while [mempool.space](https://mempool.space/docs/api) returns `15`.
     pub async fn get_blocks(&self, height: Option<u32>) -> Result<Vec<BlockSummary>, Error> {
         let url = match height {
             Some(height) => format!("{}/blocks/{}", self.url, height),

src/blocking.rs

@@ -199,7 +199,8 @@ impl BlockingClient {
         }
     }
 
-    /// Get a [`Txid`] of a transaction given its index in a block with a given hash.
+    /// Get a [`Txid`] of a transaction given its index in a block with a given
+    /// hash.
     pub fn get_txid_at_block_index(
         &self,
         block_hash: &BlockHash,
@@ -233,17 +234,20 @@ impl BlockingClient {
         self.get_opt_response(&format!("/block/{}/raw", block_hash))
     }
 
-    /// Get a merkle inclusion proof for a [`Transaction`] with the given [`Txid`].
+    /// Get a merkle inclusion proof for a [`Transaction`] with the given
+    /// [`Txid`].
     pub fn get_merkle_proof(&self, txid: &Txid) -> Result<Option<MerkleProof>, Error> {
         self.get_opt_response_json(&format!("/tx/{}/merkle-proof", txid))
     }
 
-    /// Get a [`MerkleBlock`] inclusion proof for a [`Transaction`] with the given [`Txid`].
+    /// Get a [`MerkleBlock`] inclusion proof for a [`Transaction`] with the
+    /// given [`Txid`].
     pub fn get_merkle_block(&self, txid: &Txid) -> Result<Option<MerkleBlock>, Error> {
         self.get_opt_response_hex(&format!("/tx/{}/merkleblock-proof", txid))
     }
 
-    /// Get the spending status of an output given a [`Txid`] and the output index.
+    /// Get the spending status of an output given a [`Txid`] and the output
+    /// index.
     pub fn get_output_status(
         &self,
         txid: &Txid,
@@ -299,15 +303,16 @@ impl BlockingClient {
             .map(|s| BlockHash::from_str(s.as_str()).map_err(Error::HexToArray))?
     }
 
-    /// Get an map where the key is the confirmation target (in number of blocks)
-    /// and the value is the estimated feerate (in sat/vB).
+    /// Get an map where the key is the confirmation target (in number of
+    /// blocks) and the value is the estimated feerate (in sat/vB).
     pub fn get_fee_estimates(&self) -> Result<HashMap<u16, f64>, Error> {
         self.get_response_json("/fee-estimates")
     }
 
     /// Get confirmed transaction history for the specified address/scripthash,
     /// sorted with newest first. Returns 25 transactions per page.
-    /// More can be requested by specifying the last txid seen by the previous query.
+    /// More can be requested by specifying the last txid seen by the previous
+    /// query.
     pub fn scripthash_txs(
         &self,
         script: &Script,
@@ -321,10 +326,11 @@ impl BlockingClient {
         self.get_response_json(&path)
     }
 
-    /// Gets some recent block summaries starting at the tip or at `height` if provided.
+    /// Gets some recent block summaries starting at the tip or at `height` if
+    /// provided.
     ///
-    /// The maximum number of summaries returned depends on the backend itself: esplora returns `10`
-    /// while [mempool.space](https://mempool.space/docs/api) returns `15`.
+    /// The maximum number of summaries returned depends on the backend itself:
+    /// esplora returns `10` while [mempool.space](https://mempool.space/docs/api) returns `15`.
     pub fn get_blocks(&self, height: Option<u32>) -> Result<Vec<BlockSummary>, Error> {
         let path = match height {
             Some(height) => format!("/blocks/{}", height),

src/lib.rs

@@ -41,11 +41,12 @@
 //! specific features, set `default-features` to `false` in your `Cargo.toml`
 //! and specify the features you want. This will look like this:
 //!
-//! `esplora-client = { version = "*", default-features = false, features = ["blocking"] }`
+//! `esplora-client = { version = "*", default-features = false, features =
+//! ["blocking"] }`
 //!
 //! * `blocking` enables [`minreq`], the blocking client with proxy.
-//! * `blocking-https` enables [`minreq`], the blocking client with proxy and TLS (SSL)
-//!   capabilities using the default [`minreq`] backend.
+//! * `blocking-https` enables [`minreq`], the blocking client with proxy and TLS (SSL) capabilities
+//!   using the default [`minreq`] backend.
 //! * `blocking-https-rustls` enables [`minreq`], the blocking client with proxy and TLS (SSL)
 //!   capabilities using the `rustls` backend.
 //! * `blocking-https-native` enables [`minreq`], the blocking client with proxy and TLS (SSL)
@@ -62,8 +63,6 @@
 //! * `async-https-rustls-manual-roots` enables [`reqwest`], the async client with support for
 //!   proxying and TLS (SSL) using the `rustls` TLS backend without using its the default root
 //!   certificates.
-//!
-//!
 
 #![allow(clippy::result_large_err)]
 
@@ -89,7 +88,8 @@ pub use r#async::AsyncClient;
 /// Get a fee value in sats/vbytes from the estimates
 /// that matches the confirmation target set as parameter.
 ///
-/// Returns `None` if no feerate estimate is found at or below `target` confirmations.
+/// Returns `None` if no feerate estimate is found at or below `target`
+/// confirmations.
 pub fn convert_fee_rate(target: usize, estimates: HashMap<u16, f64>) -> Option<f32> {
     estimates
         .into_iter()
@@ -103,11 +103,13 @@ pub struct Builder {
     pub base_url: String,
     /// Optional URL of the proxy to use to make requests to the Esplora server
     ///
-    /// The string should be formatted as: `<protocol>://<user>:<password>@host:<port>`.
+    /// The string should be formatted as:
+    /// `<protocol>://<user>:<password>@host:<port>`.
     ///
-    /// Note that the format of this value and the supported protocols change slightly between the
-    /// blocking version of the client (using `minreq`) and the async version (using `reqwest`). For more
-    /// details check with the documentation of the two crates. Both of them are compiled with
+    /// Note that the format of this value and the supported protocols change
+    /// slightly between the blocking version of the client (using `minreq`)
+    /// and the async version (using `reqwest`). For more details check with
+    /// the documentation of the two crates. Both of them are compiled with
     /// the `socks` feature enabled.
     ///
     /// The proxy is ignored when targeting `wasm32`.
@@ -594,8 +596,8 @@ mod test {
     #[cfg(all(feature = "blocking", feature = "async"))]
     #[tokio::test]
     async fn test_get_non_existing_block_status() {
-        // Esplora returns the same status for orphaned blocks as for non-existing blocks:
-        // non-existing: https://blockstream.info/api/block/0000000000000000000000000000000000000000000000000000000000000000/status
+        // Esplora returns the same status for orphaned blocks as for non-existing
+        // blocks: non-existing: https://blockstream.info/api/block/0000000000000000000000000000000000000000000000000000000000000000/status
         // orphaned: https://blockstream.info/api/block/000000000000000000181b1a2354620f66868a723c0c4d5b24e4be8bdfc35a7f/status
         // (Here the block is cited as orphaned: https://bitcoinchain.com/block_explorer/block/000000000000000000181b1a2354620f66868a723c0c4d5b24e4be8bdfc35a7f/ )
         // For this reason, we only test for the non-existing case here.