zcash_client_sqlite: Start documenting the table structures #1429
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1429 +/- ##
==========================================
+ Coverage 63.01% 63.03% +0.02%
==========================================
Files 126 127 +1
Lines 14772 14784 +12
==========================================
+ Hits 9308 9319 +11
- Misses 5464 5465 +1 ☔ View full report in Codecov by Sentry. |
nuttycom
requested changes
Jun 18, 2024
| /// | ||
| /// - The `cached_transparent_receiver_address` column contains the transparent receiver | ||
| /// component of the UA. It is cached directly in the table to make account lookups for | ||
| /// transparent outputs more efficient, enabling joins to [`TABLE_UTXOS`]. |
There was a problem hiding this comment.
We'll need to figure out what to do here with respect to transparent addresses that are not associated with the seed, in order to support the import of zcashd wallets. Also this might be changing with the addition of ZIP 320? We need to end up being consistent about how we handle transparent addresses; it might ultimately make more sense to break those out into a separate table that has a nullable foreign key relationship to this one or something.
Co-authored-by: Kris Nuttycombe <kris@nutty.land>
nuttycom
approved these changes
Jun 18, 2024
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.
The existing pins for the current database structure are moved out of the
verify_schematest, so they can serve the dual purpose of documentating the database structure.The documentation needs significantly more detail than this PR currently includes; this is intended as a starting point from which we can continually improve our documentation going forward.