Improve txout listing and balance APIs for redesigned structures
#975
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
Instead of relying on a `OwnedIndexer` trait to filter for relevant txouts, we move the listing and balance methods from `IndexedTxGraph` to `TxGraph` and add an additional input (list of relevant outpoints) to these methods. This provides a simpler implementation and a more flexible API.
evanlinjin
force-pushed
the
improve_txout_listing_api
branch
from
fb065e9
to
e01d17d
Compare
LLFourn
requested changes
May 11, 2023
Previously, regardless of whether writing to persistence backend is successful or not, the logic always cleared `self.staged`. This is changed to only clear `self.staged` after successful write. Additionally, the written changeset (if any) is returned, and `PersistBackend::write_changes` will not be called if `self.staged` is empty.
Rename the `S` trait bound to `OI` (outpoint index) to emphasize it's not only for spk indexing.
LLFourn
approved these changes
May 11, 2023
|
ACK ed89de7 |
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
As noted in #971 (comment).
Instead of relying on a
OwnedIndexertrait to filter for relevant txouts, we move the listing and balance methods fromIndexedTxGraphtoTxGraphand add an additional input (list of relevant outpoints) to these methods.This provides a simpler implementation and a more flexible API.
Other Fixes
The
Persist::commitmethod is fixed in 96b1075.Previously, regardless of whether writing to persistence backend is successful or not, the logic always cleared
self.staged. This is changed to only clearself.stagedafter successful write.Additionally, the written changeset (if any) is returned, and
PersistBackend::write_changeswill not be called ifself.stagedis empty.Notes to the reviewers
Yes, slightly more boilerplate to do the same things, but less code to maintain and a much more flexible API. Very worth it IMO.
Changelog notice
Checklists
All Submissions:
cargo fmtandcargo clippybefore committingNew Features: