adds filtering to wallet/getNotes endpoint #3867
Merged
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
hughy
force-pushed
the
feature/ifl-769/getnotes-filter
branch
from
5a0c190 to
2e8ab76
Compare
hughy
force-pushed
the
feature/ifl-770/wallet-getnotes
branch
2 times, most recently
from
9439e5f to
6430e27
Compare
hughy
force-pushed
the
feature/ifl-769/getnotes-filter
branch
from
2e8ab76 to
abeb00a
Compare
ygao76
reviewed
May 5, 2023
supports filtering notes by value, assetId, assetName, memo, sender, noteHash, transactionHash, index, and spent. implements naive filtering: iterates over all notes and includes notes that meet the filter criteria. this doesn't make use of walletDb indexes that could be helpful depending on the filter. for example, if 'spent = false', we could use 'unspentNoteHashes' to avoid iterating over all of the spent notes.
filtering by note owner address seems unnecessary since we already filter by account
nests all filter fields in a 'filter' object in the request
hughy
force-pushed
the
feature/ifl-769/getnotes-filter
branch
from
abeb00a to
f3a051a
Compare
dguenther
reviewed
May 9, 2023
dguenther
approved these changes
May 9, 2023
Merged
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.
Summary
supports filtering notes by value, assetId, assetName, memo, sender, noteHash, transactionHash, index, and spent.
implements naive filtering: iterates over all notes and includes notes that meet the filter criteria. this doesn't make use of walletDb indexes that could be helpful depending on the filter. for example, if 'spent = false', we could use 'unspentNoteHashes' to avoid iterating over all of the spent notes.
Testing Plan
Documentation
Does this change require any updates to the Iron Fish Docs (ex. the RPC API
Reference)? If yes, link a
related documentation pull request for the website.
Breaking Change
Is this a breaking change? If yes, add notes below on why this is breaking and
what additional work is required, if any.