Better doc comment for sapling::TranmissionKey

This commit is contained in:
Deirdre Connolly 2020-03-28 15:47:04 -04:00 committed by Deirdre Connolly
parent b175d1f1ba
commit ebe5cce3bb
1 changed files with 11 additions and 4 deletions

View File

@ -159,11 +159,18 @@ impl fmt::Debug for Diversifier {
} }
} }
/// Derived from an _IncomingViewingKey_ and a _Diversifier_ /// A (diversified) _TransmissionKey_
/// ///
/// Derived by multiplying the diversifier (converted to an affine /// In Sapling, secrets need to be transmitted to a recipient of funds
/// point on the Jubjub curve) by the incoming view key: /// in order for them to be later spent. To transmit these secrets
/// pkd = gd * ivk /// securely to a recipient without requiring an out-of-band
/// communication channel, the diversied transmission key is used to
/// encrypt them.
///
/// Derived by multiplying a JubJub point [derived][ps] from a
/// _Diversifier_ by the _IncomingViewingKey_ scalar.
///
/// [ps]: https://zips.z.cash/protocol/protocol.pdf#concretediversifyhash
pub type TransmissionKey = redjubjub::PublicKeyBytes; pub type TransmissionKey = redjubjub::PublicKeyBytes;
/// Full Viewing Keys /// Full Viewing Keys