Electrum params (3.0)

[reez]

Description

#1010 for 3.0 branch

Notes to the reviewers

Documentation

• bdk_wallet
• bitcoin
• uniffi
• Other:

Changelog

Checklists

All Submissions:

• I've signed all my commits
• I followed the contribution guidelines
• I ran cargo fmt and cargo clippy before committing
• I've added exactly one changelog:* label
• I've linked the relevant upstream docs or specs above

New Features:

• I've added tests for the new feature
• I've added docs for the new feature

Bugfixes:

• This pull request breaks the existing API
• I've added tests to reproduce the issue which are now passing
• I'm linking the issue being fixed by this PR

[thunderbiscuit]

@reez could you add a commit for the bump of bdk_electrum to 0.24.0 to this PR?

[thunderbiscuit]

The Rust docs make the mistake of not defining what the unit is on the timeout, but I don't think we should make that same mistake because ffi users have an even harder time digging into the source code that is used to generate the bindings (you can't "command+click" into a type/method and see the Rust source).

I suggest you make the correction here and we open a PR on Electrum to fix it too.

// Optional: Set the timeout (in seconds) of the builder

https://docs.rs/electrum-client/0.24.1/src/electrum_client/config.rs.html#57-61

[thunderbiscuit]

Ok actually this API changed in the 0.25.0 release, and the timeout method takes a Duration argument rather than a u8.

So there is no documentation problem on the Rust side anymore, but I suggest we keep the u8 argument (and the docs mentioning this is defined in seconds) here and you transform it into a Duration in the loop, something like

Duration::from_secs(timeout)

[reez]

bdk_electrum updated & changelog reflected

[thunderbiscuit]

ACK 69c29f9.