Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove doc hidden from some keys #1296

Merged
merged 1 commit into from
Mar 25, 2024
Merged

Conversation

AloeareV
Copy link
Contributor

No description provided.

Copy link
Contributor

@AArnott AArnott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fully in favor of this. I know USK is not a spec'd format. And for that matter, IMO it's a terrible structure to reverse engineer. But it is nonetheless necessary to be able to cross the interop layer, and pretending that it isn't needed is silly.

@@ -624,7 +622,6 @@ pub struct UnifiedFullViewingKey {
unknown: Vec<(u32, Vec<u8>)>,
}

#[doc(hidden)]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should have been done as part of #1245 but it was overlooked.

@nuttycom
Copy link
Contributor

The primary reason that these were #[doc(hidden)] is that in general USKs are intended to be opaque and not handled individually, and because the decision as to how to decide what components are included in the USK (currently, all for which feature flags are enabled) was not fully stabilized. That being said, for users of the API it's necessary to be able to derive the USK from the seed, so I agree with un-hiding the docs.

Copy link
Contributor

@nuttycom nuttycom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK

Copy link

codecov bot commented Mar 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.59%. Comparing base (e795174) to head (7cbfc1f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1296   +/-   ##
=======================================
  Coverage   63.59%   63.59%           
=======================================
  Files         121      121           
  Lines       13945    13945           
=======================================
  Hits         8869     8869           
  Misses       5076     5076           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nuttycom nuttycom merged commit a9c4bc1 into zcash:main Mar 25, 2024
21 of 25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants