What is the purpose of this pull request?

• Bug fix
• Documentation update
• New feature
• Test
• Other:

Which crates are being modified?

• floresta-chain
• floresta-cli
• floresta-common
• floresta-compact-filters
• floresta-electrum
• floresta-watch-only
• floresta-wire
• floresta
• florestad
• Other:

Description

We have a couple of assert!(result.is_ok()) and assert!(result.is_err()) in our tests. These are very readable but whenever they fail they don't debug the Result value. We have recently seen this lack of debugging in some electrum tests CI fails:

  ---- electrum_protocol::test::test_blockchain_headers stdout ----
  thread 'electrum_protocol::test::test_blockchain_headers' panicked at crates/floresta-electrum/src/electrum_protocol.rs:1221:9:
  assertion failed: send_request(batch_req, port).await.is_ok()
  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

We could fix this with result.unwrap() or result.unwrap_err(), but it worsens readability. I find it nicer to use these new assert_ok and assert_err macros. Added a few unit and doc tests for them.

Notes to the reviewers

There's a clippy lint for this but it's on restriction mode because of the readability loss of using unwraps, which we solve with these macros. But the clippy lint doesn't catch all cases for some reason. I also saw there's an std::assert_matches macro but it's unstable.