From 23cd346f28b8c2b7d5b102c01e37f056dee36b49 Mon Sep 17 00:00:00 2001 From: Deirdre Connolly Date: Tue, 7 Apr 2020 17:54:56 -0400 Subject: [PATCH] Add missing doc comment for sapling addresses --- zebra-chain/src/addresses/sapling.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/zebra-chain/src/addresses/sapling.rs b/zebra-chain/src/addresses/sapling.rs index 306a819bd..f3a29e064 100644 --- a/zebra-chain/src/addresses/sapling.rs +++ b/zebra-chain/src/addresses/sapling.rs @@ -19,7 +19,12 @@ mod human_readable_parts { pub const TESTNET: &str = "ztestsapling"; } +/// A Sapling _shielded payment address_. /// +/// Also known as a _diversified payment address_ for Sapling, as +/// defined in [ยง4.2.2][4.2.2]. +/// +/// [4.2.2]: https://zips.z.cash/protocol/protocol.pdf#saplingkeycomponents #[derive(Clone, Copy, PartialEq)] pub struct SaplingShieldedAddress { diversifier: sapling::Diversifier,