From 37c32e9c94014671be78a461fcf4cea814f9d4c8 Mon Sep 17 00:00:00 2001 From: Deirdre Connolly Date: Fri, 26 Mar 2021 15:52:53 -0400 Subject: [PATCH] Apply docstring suggestions from code review Co-authored-by: teor --- zebra-chain/src/orchard/action.rs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/zebra-chain/src/orchard/action.rs b/zebra-chain/src/orchard/action.rs index ee4d6ed55..33dfcb56c 100644 --- a/zebra-chain/src/orchard/action.rs +++ b/zebra-chain/src/orchard/action.rs @@ -33,11 +33,14 @@ pub struct Action { /// The x-coordinate of the note commitment for the output note. #[serde(with = "serde_helpers::Base")] pub cm_x: pallas::Base, - /// An encoding of an ephemeral Pallas public key. + /// An encoding of an ephemeral Pallas public key corresponding to the + /// encrypted private key in `out_ciphertext`. pub ephemeral_key: keys::EphemeralPublicKey, /// A ciphertext component for the encrypted output note. pub enc_ciphertext: note::EncryptedNote, - /// A ciphertext component for the encrypted output note. + /// A ciphertext component that allows the holder of a full viewing key to + /// recover the recipient diversified transmission key and the ephemeral + /// private key (and therefore the entire note plaintext). pub out_ciphertext: note::WrappedNoteKey, }