Merge #399: jsonrpc: Depend on bitreq

4ef980d Depend on bitreq (Tobin C. Harding)
1998fed Fix stale fuzz target name (Tobin C. Harding)
fa402e9 Remove mention of minreq from rustdoc (Tobin C. Harding)
5b8b8cc bitreq: Fix stale crate docs heading (Tobin C. Harding)
6098528 bitreq: Rename MINREQ_TIMEOUT to BITREQ_TIMEOUT (Tobin C. Harding)

Pull request description:

  We just forked `minreq` into this repository to create an HTTP crate that is specifically designed to be used by Bitcoin projects. As such we called it `bitreq`.

  Depend on the local `bitreq` crate instead of `minreq`.

ACKs for top commit:
  jamillambert:
    ACK 4ef980d

Tree-SHA512: 170e745be5fb7f611f0e539d3f03e277a559895bd1d31d5a8f4178c6d5a2e56aa0c632a2dcbec5a5efff32987ec25a4f93616f42d997586afe0f503a84283647

Author: tcharding

.github/workflows/cron-daily-fuzz.yml

@@ -18,7 +18,7 @@ jobs:
         # We only get 20 jobs at a time, we probably don't want to go
         # over that limit with fuzzing because of the hour run time.
         fuzz_target: [
-          minreq_http,
+          bitreq_http,
           simple_http,
         ]
     steps:

Cargo-minimal.lock

@@ -281,11 +281,11 @@ version = "0.10.0"
 dependencies = [
  "anyhow",
  "bitcoin_hashes",
+ "bitreq",
  "corepc-client",
  "env_logger",
  "flate2",
  "log",
- "minreq",
  "serde_json",
  "tar",
  "tempfile",
@@ -453,7 +453,7 @@ name = "jsonrpc"
 version = "0.18.0"
 dependencies = [
  "base64 0.22.1",
- "minreq",
+ "bitreq",
  "serde",
  "serde_json",
  "socks",
@@ -503,21 +503,6 @@ dependencies = [
  "adler2",
 ]
 
-[[package]]
-name = "minreq"
-version = "2.11.2"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6fdef521c74c2884a4f3570bcdb6d2a77b3c533feb6b27ac2ae72673cc221c64"
-dependencies = [
- "log",
- "once_cell",
- "rustls",
- "rustls-webpki",
- "serde",
- "serde_json",
- "webpki-roots",
-]
-
 [[package]]
 name = "mio"
 version = "1.0.2"

Cargo-recent.lock

@@ -281,11 +281,11 @@ version = "0.10.0"
 dependencies = [
  "anyhow",
  "bitcoin_hashes",
+ "bitreq",
  "corepc-client",
  "env_logger",
  "flate2",
  "log",
- "minreq",
  "serde_json",
  "tar",
  "tempfile",
@@ -458,7 +458,7 @@ name = "jsonrpc"
 version = "0.18.0"
 dependencies = [
  "base64 0.22.1",
- "minreq",
+ "bitreq",
  "serde",
  "serde_json",
  "socks",
@@ -508,21 +508,6 @@ dependencies = [
  "adler2",
 ]
 
-[[package]]
-name = "minreq"
-version = "2.13.2"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "da0c420feb01b9fb5061f8c8f452534361dd783756dcf38ec45191ce55e7a161"
-dependencies = [
- "log",
- "once_cell",
- "rustls",
- "rustls-webpki",
- "serde",
- "serde_json",
- "webpki-roots",
-]
-
 [[package]]
 name = "mio"
 version = "1.1.0"

bitreq/src/connection.rs

@@ -87,7 +87,7 @@ pub struct AsyncConnection {
 impl AsyncConnection {
     /// Creates a new `AsyncConnection`.
     pub(crate) fn new(request: ParsedRequest) -> AsyncConnection {
-        let timeout = request.config.timeout.or_else(|| match env::var("MINREQ_TIMEOUT") {
+        let timeout = request.config.timeout.or_else(|| match env::var("BITREQ_TIMEOUT") {
             Ok(t) => t.parse::<u64>().ok(),
             Err(_) => None,
         });
@@ -128,7 +128,7 @@ impl Connection {
     /// Creates a new `Connection`. See [Request] and [ParsedRequest]
     /// for specifics about *what* is being sent.
     pub(crate) fn new(request: ParsedRequest) -> Connection {
-        let timeout = request.config.timeout.or_else(|| match env::var("MINREQ_TIMEOUT") {
+        let timeout = request.config.timeout.or_else(|| match env::var("BITREQ_TIMEOUT") {
             Ok(t) => t.parse::<u64>().ok(),
             Err(_) => None,
         });

bitreq/src/lib.rs

@@ -1,4 +1,4 @@
-//! # Minreq
+//! # Bitreq
 //!
 //! Simple, minimal-dependency HTTP client.  The library has a very
 //! minimal API, so you'll probably know everything you need to after
@@ -207,16 +207,16 @@
 //!   ```text,ignore
 //!   bitreq::get("/").with_timeout(8).send();
 //!   ```
-//! - Set the environment variable `MINREQ_TIMEOUT` to the desired
+//! - Set the environment variable `BITREQ_TIMEOUT` to the desired
 //!   amount of seconds until timeout. Ie. if you have a program called
 //!   `foo` that uses bitreq, and you want all the requests made by that
 //!   program to timeout in 8 seconds, you launch the program like so:
 //!   ```text,ignore
-//!   $ MINREQ_TIMEOUT=8 ./foo
+//!   $ BITREQ_TIMEOUT=8 ./foo
 //!   ```
 //!   Or add the following somewhere before the requests in the code.
 //!   ```
-//!   std::env::set_var("MINREQ_TIMEOUT", "8");
+//!   std::env::set_var("BITREQ_TIMEOUT", "8");
 //!   ```
 //! If the timeout is set with `with_timeout`, the environment
 //! variable will be ignored.

client/Cargo.toml

@@ -27,6 +27,6 @@ serde = { version = "1.0.103", default-features = false, features = [ "derive",
 serde_json = { version = "1.0.117" }
 types = { package = "corepc-types", version = "0.10.0", path = "../types", default-features = false, features = ["std"] }
 
-jsonrpc = { version = "0.18.0", path = "../jsonrpc", features = ["minreq_http"], optional = true }
+jsonrpc = { version = "0.18.0", path = "../jsonrpc", features = ["bitreq_http"], optional = true }
 
 [dev-dependencies]

client/src/client_sync/mod.rs

@@ -55,9 +55,9 @@ impl Auth {
     }
 }
 
-/// Defines a `jsonrpc::Client` using `minreq`.
+/// Defines a `jsonrpc::Client` using `bitreq`.
 #[macro_export]
-macro_rules! define_jsonrpc_minreq_client {
+macro_rules! define_jsonrpc_bitreq_client {
     ($version:literal) => {
         use std::fmt;
 
@@ -81,7 +81,7 @@ macro_rules! define_jsonrpc_minreq_client {
         impl Client {
             /// Creates a client to a bitcoind JSON-RPC server without authentication.
             pub fn new(url: &str) -> Self {
-                let transport = jsonrpc::http::minreq_http::Builder::new()
+                let transport = jsonrpc::http::bitreq_http::Builder::new()
                     .url(url)
                     .expect("jsonrpc v0.18, this function does not error")
                     .timeout(std::time::Duration::from_secs(60))
@@ -98,7 +98,7 @@ macro_rules! define_jsonrpc_minreq_client {
                 }
                 let (user, pass) = auth.get_user_pass()?;
 
-                let transport = jsonrpc::http::minreq_http::Builder::new()
+                let transport = jsonrpc::http::bitreq_http::Builder::new()
                     .url(url)
                     .expect("jsonrpc v0.18, this function does not error")
                     .timeout(std::time::Duration::from_secs(60))

client/src/client_sync/v17/blockchain.rs

@@ -7,7 +7,7 @@
 //!
 //! All macros require `Client` to be in scope.
 //!
-//! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
+//! See or use the `define_jsonrpc_bitreq_client!` macro to define a `Client`.
 
 /// Implements Bitcoin Core JSON-RPC API method `getblockchaininfo`.
 #[macro_export]

client/src/client_sync/v17/control.rs

@@ -7,7 +7,7 @@
 //!
 //! All macros require `Client` to be in scope.
 //!
-//! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
+//! See or use the `define_jsonrpc_bitreq_client!` macro to define a `Client`.
 
 /// Implements Bitcoin Core JSON-RPC API method `getmemoryinfo`.
 #[macro_export]

client/src/client_sync/v17/generating.rs

@@ -7,7 +7,7 @@
 //!
 //! All macros require `Client` to be in scope.
 //!
-//! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
+//! See or use the `define_jsonrpc_bitreq_client!` macro to define a `Client`.
 
 /// Implements Bitcoin Core JSON-RPC API method `generatetoaddress`.
 #[macro_export]