Skip to content

Fix documentation in unified address and fvk modules #2190

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.

Sign up for GitHub

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

Open
Cosmos-Harry wants to merge 2 commits into
base: main
Choose a base branch
from
+4 −1
Open

Fix documentation in unified address and fvk modules #2190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f8859e
Added comments to mention the source of the Receiver enum and the int…
Cosmos-Harry Mar 4, 2026
78ed942
Fix incorrect method reference in Ufvk::items_as_parsed doc comment
Cosmos-Harry Mar 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions components/zcash_address/src/kind/unified/address.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ use alloc::vec::Vec;
use core::convert::{TryFrom, TryInto};

/// The set of known Receivers for Unified Addresses.
///
/// Defined in [ZIP 316][zip-0316].
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub enum Receiver {
Orchard([u8; 43]),
Expand All @@ -24,6 +26,7 @@ impl TryFrom<(u32, &[u8])> for Receiver {
Typecode::P2sh => addr.try_into().map(Receiver::P2sh),
Typecode::Sapling => addr.try_into().map(Receiver::Sapling),
Typecode::Orchard => addr.try_into().map(Receiver::Orchard),
// Preserve unknown typecodes for forward compatibility.
Typecode::Unknown(_) => Ok(Receiver::Unknown {
typecode,
data: addr.to_vec(),
Expand Down
2 changes: 1 addition & 1 deletion components/zcash_address/src/kind/unified/fvk.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ impl Container for Ufvk {
/// Returns the FVKs contained within this UFVK, in the order they were
/// parsed from the string encoding.
///
/// This API is for advanced usage; in most cases you should use `Ufvk::receivers`.
/// This API is for advanced usage; in most cases you should use `Ufvk::items`.
fn items_as_parsed(&self) -> &[Fvk] {
&self.0
}
Expand Down
⚡