Rectify documentation, fix clippy warnings and update dependencies #18
Conversation
This commit fixes bitcoindevkit#17
|
It appears there is some problem running clippy tests for PRs. Trust me, all clippy warnings are fixed :) |
|
And, about the dependencies, I don't think we even need requirements.txt. The |
Then we should update the CI so that it fails if there are annotations, as BDK does
Right, can you please remove everything from it but hwi (also, specify the hwi version) and test that it works? |
Can confirm. This works. |
I am sorry, I couldn't understand this. Could you explain it again, please. Regarding the problem with clippy, I was using a predefined Github action clippy-check. I didn't see it before, but it's kind of mentioned on the front page about the problem. |
Cargo.toml
Outdated
| serde = { version = "1.0.137", features = ["derive"] } | ||
| serde_json = { version = "1.0.81" } |
There was a problem hiding this comment.
It's better to leave ^1.0 here (for both serde and serde_json), it basically means "whatever version >= 1.0 but < 2.0". This way we still have all the fixes they might push after 1.0.137. BDK uses the same :)
Cargo.toml
Outdated
| serde = { version = "1.0", features = ["derive"] } | ||
| serde_json = { version = "1.0" } |
There was a problem hiding this comment.
You removed the ^, it should still be there
There was a problem hiding this comment.
https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#caret-requirements.
I did notice that, but was being lazy so I left it like that xD. Fixed now.
Documentation for some functions still contained the
testnetargument. I changed them to thechainargument.Clippy warnings were corrected, where possible. Otherwise, I suppressed them (at 1 place in total).
Dependencies were updated to the latest versions compatible with each other.