Introduce bdk::Wallet builder API
#1250
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The wallet is currently created without setting any lookahead value for the keychain. This implicitly makes it a lookahead of 0. As this is a high-level interface we should avoid footguns and aim for a reasonable default. Instead of simply patching it for wallet, we alter `KeychainTxOutIndex` to have a default lookahead value. Additionally, instead of a per-keychain lookahead, the constructor asks for a `lookahead` value. This avoids the footguns of having methods which allows the caller the decrease the `lookahead` (and therefore panicing). This also simplifies the API. Co-authored-by: Antoine Poisot <darosior@protonmail.com> Co-authored-by: 志宇 <hello@evanlinjin.me>
Previously, the genesis block is not initialized properly. Thank you @notmandatory for identifying this bug.
7084501 to
514f5af
Compare
Wallet error types `NewError` and `NewOrLoadError` have been renamed to `InitError` and `InitOrLoadError`.
514f5af to
1662340
Compare
|
Concept ACK, this pattern should also be easier to extend to support future features like custom coin selection. But I'd like to push it to the alpha.4 release, alpha.3 is already long overdue. |
|
@notmandatory if we wish to make the |
24 tasks
|
Concept ACK |
| use super::{InitError, InitOrLoadError}; | ||
|
|
||
| /// Helper structure to initialize a fresh [`Wallet`] instance. | ||
| pub struct WalletBuilder<E> { |
There was a problem hiding this comment.
How do you feel about just calling this Builder, i.e. bdk::wallet::Builder ?
|
It makes sense to complete this AFTER #1203 is merged (as that PR also touches wallet constructors). |
|
This one needs a rebase after alpha.5 release. |
Closed
|
Builder pattern already introduced. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This changes the wallet-construction API to use the builder pattern. This is a simpler API and allows us to avoid multiple constructor methods.
I.e. previously, we had
Wallet::newandWallet::new_with_genesis_hash. If in the future, we added more parameters, it will turn into an absolute mess.Notes to the reviewers
This PR is based on #1229. Consider reviewing/merging that first!
I think it makes sense to have the
lookaheadconfigurable inbdk::Walletand persisted. However, @LLFourn is against this idea of persisting thelookahead. This can be of discussion for a future change.Changelog notice
NewErrortoInitErrorandNewOrLoadErrortoInitOrLoadError.Checklists
All Submissions:
cargo fmtandcargo clippybefore committingNew Features: