refactor: make all generation key fields private

closes #193

makes all fields of GenerationSpendingKey and
GenerationReceivingAddress private and adds accessor methods for each.

updates code + tests to use the accessor methods.

src/mine_loop.rs

@@ -408,7 +408,7 @@ pub(crate) async fn make_coinbase_transaction(
         .await
         .wallet_state
         .wallet_secret
-        .generate_sender_randomness(next_block_height, receiving_address.privacy_digest);
+        .generate_sender_randomness(next_block_height, receiving_address.privacy_digest());
 
     let owned = true;
     let liquid_coinbase_output = TxOutput::offchain_native_currency(
@@ -470,13 +470,13 @@ pub(crate) async fn make_coinbase_transaction(
     let composer_utxo_not_timelocked = ExpectedUtxo::new(
         liquid_coinbase_output.utxo(),
         liquid_coinbase_output.sender_randomness(),
-        coinbase_recipient_spending_key.privacy_preimage,
+        coinbase_recipient_spending_key.privacy_preimage(),
         UtxoNotifier::OwnMinerComposeBlock,
     );
     let composer_utxo_timelocked = ExpectedUtxo::new(
         timelocked_coinbase_output.utxo(),
         timelocked_coinbase_output.sender_randomness(),
-        coinbase_recipient_spending_key.privacy_preimage,
+        coinbase_recipient_spending_key.privacy_preimage(),
         UtxoNotifier::OwnMinerComposeBlock,
     );
 

src/models/state/mempool.rs

@@ -1106,7 +1106,7 @@ mod tests {
             .add_expected_utxo(ExpectedUtxo::new(
                 coinbase_utxo_1,
                 cb_sender_randomness_1,
-                alice_spending_key.privacy_preimage,
+                alice_spending_key.privacy_preimage(),
                 UtxoNotifier::OwnMinerComposeBlock,
             ))
             .await;

src/models/state/mod.rs

@@ -1733,7 +1733,7 @@ mod global_state_tests {
             .add_expected_utxo(ExpectedUtxo::new(
                 cb_utxo,
                 cb_sender_randomness,
-                own_key.privacy_preimage,
+                own_key.privacy_preimage(),
                 UtxoNotifier::OwnMinerComposeBlock,
             ))
             .await;
@@ -1899,7 +1899,7 @@ mod global_state_tests {
                 vec![ExpectedUtxo::new(
                     coinbase_utxo,
                     coinbase_output_randomness,
-                    alice_spending_key.privacy_preimage,
+                    alice_spending_key.privacy_preimage(),
                     UtxoNotifier::OwnMinerComposeBlock,
                 )],
             )
@@ -2033,7 +2033,7 @@ mod global_state_tests {
                     vec![ExpectedUtxo::new(
                         coinbase_utxo_1,
                         cb_utxo_output_randomness_1,
-                        alice_spending_key.privacy_preimage,
+                        alice_spending_key.privacy_preimage(),
                         UtxoNotifier::OwnMinerComposeBlock,
                     )],
                 )
@@ -2353,7 +2353,7 @@ mod global_state_tests {
                         ExpectedUtxo::new(
                             expected_utxo.utxo,
                             expected_utxo.sender_randomness,
-                            genesis_spending_key.privacy_preimage,
+                            genesis_spending_key.privacy_preimage(),
                             UtxoNotifier::OwnMinerComposeBlock,
                         )
                     })
@@ -2792,7 +2792,7 @@ mod global_state_tests {
                     ExpectedUtxo::new(
                         cb_utxo,
                         cb_output_randomness,
-                        spending_key.privacy_preimage,
+                        spending_key.privacy_preimage(),
                         UtxoNotifier::OwnMinerComposeBlock,
                     ),
                 )
@@ -2874,7 +2874,7 @@ mod global_state_tests {
                     ExpectedUtxo::new(
                         cb_utxo,
                         cb_output_randomness,
-                        spending_key.privacy_preimage,
+                        spending_key.privacy_preimage(),
                         UtxoNotifier::OwnMinerComposeBlock,
                     ),
                 )
@@ -2982,7 +2982,7 @@ mod global_state_tests {
             let cb = ExpectedUtxo::new(
                 cb_utxo1,
                 cb_sender_randomness1,
-                spend_key.privacy_preimage,
+                spend_key.privacy_preimage(),
                 UtxoNotifier::OwnMinerComposeBlock,
             );
 

src/models/state/wallet/address/address_type.rs

@@ -146,7 +146,7 @@ impl ReceivingAddress {
     /// returns `receiver_identifer`
     pub fn receiver_identifier(&self) -> BFieldElement {
         match self {
-            Self::Generation(a) => a.receiver_identifier,
+            Self::Generation(a) => a.receiver_identifier(),
             Self::Symmetric(a) => a.receiver_identifier(),
         }
     }
@@ -194,16 +194,16 @@ impl ReceivingAddress {
     /// returns the `spending_lock`
     pub fn spending_lock(&self) -> Digest {
         match self {
-            Self::Generation(a) => a.spending_lock,
+            Self::Generation(a) => a.spending_lock(),
             Self::Symmetric(k) => k.spending_lock(),
         }
     }
 
-    /// returns a privacy digest which corresponds to the privacy_preimage
+    /// returns a privacy digest which corresponds to the.privacy_preimage(),
     /// of the matching [SpendingKey]
     pub fn privacy_digest(&self) -> Digest {
         match self {
-            Self::Generation(a) => a.privacy_digest,
+            Self::Generation(a) => a.privacy_digest(),
             Self::Symmetric(k) => k.privacy_digest(),
         }
     }
@@ -400,15 +400,15 @@ impl SpendingKey {
     /// as the privacy_digest
     pub fn privacy_preimage(&self) -> Digest {
         match self {
-            Self::Generation(k) => k.privacy_preimage,
+            Self::Generation(k) => k.privacy_preimage(),
             Self::Symmetric(k) => k.privacy_preimage(),
         }
     }
 
     /// returns the receiver_identifier, a public fingerprint
     pub fn receiver_identifier(&self) -> BFieldElement {
         match self {
-            Self::Generation(k) => k.receiver_identifier,
+            Self::Generation(k) => k.receiver_identifier(),
             Self::Symmetric(k) => k.receiver_identifier(),
         }
     }

src/models/state/wallet/address/generation_address.rs

@@ -49,16 +49,16 @@ pub const GENERATION_FLAG: BFieldElement = BFieldElement::new(GENERATION_FLAG_U8
 // keep the serialized (including bech32m) representation small.
 #[derive(Clone, Debug, Copy, PartialEq, Eq, Serialize)]
 pub struct GenerationSpendingKey {
-    pub seed: Digest,
+    seed: Digest,
 
     #[serde(skip)]
-    pub receiver_identifier: BFieldElement,
+    receiver_identifier: BFieldElement,
 
     #[serde(skip)]
-    pub decryption_key: lattice::kem::SecretKey,
+    decryption_key: lattice::kem::SecretKey,
 
     #[serde(skip)]
-    pub privacy_preimage: Digest,
+    privacy_preimage: Digest,
 
     #[serde(skip)]
     unlock_key: Digest,
@@ -77,11 +77,11 @@ impl<'de> serde::de::Deserialize<'de> for GenerationSpendingKey {
 
 #[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
 pub struct GenerationReceivingAddress {
-    pub receiver_identifier: BFieldElement,
-    pub encryption_key: lattice::kem::PublicKey,
+    receiver_identifier: BFieldElement,
+    encryption_key: lattice::kem::PublicKey,
 
-    pub privacy_digest: Digest,
-    pub spending_lock: Digest,
+    privacy_digest: Digest,
+    spending_lock: Digest,
 }
 
 impl<'a> Arbitrary<'a> for GenerationReceivingAddress {
@@ -97,7 +97,7 @@ impl GenerationSpendingKey {
         let (_sk, pk) = lattice::kem::keygen(randomness);
         let privacy_digest = self.privacy_preimage.hash();
         GenerationReceivingAddress {
-            receiver_identifier: self.receiver_identifier,
+            receiver_identifier: self.receiver_identifier(),
             encryption_key: pk,
             privacy_digest,
             spending_lock: self.generate_spending_lock(),
@@ -173,6 +173,19 @@ impl GenerationSpendingKey {
     fn generate_spending_lock(&self) -> Digest {
         self.unlock_key.hash()
     }
+
+    /// returns the privacy preimage.
+    ///
+    /// note: The hash of the preimage is available in the receiving address
+    /// as the privacy_digest
+    pub fn privacy_preimage(&self) -> Digest {
+        self.privacy_preimage
+    }
+
+    /// returns the receiver_identifier, a public fingerprint
+    pub fn receiver_identifier(&self) -> BFieldElement {
+        self.receiver_identifier
+    }
 }
 
 impl GenerationReceivingAddress {
@@ -300,18 +313,13 @@ impl GenerationReceivingAddress {
         LockScript::hash_lock(self.spending_lock)
     }
 
-    /// returns the privacy digest
-    pub fn privacy_digest(&self) -> Digest {
-        self.privacy_digest
-    }
-
     pub(crate) fn generate_public_announcement(
         &self,
         utxo_notification_payload: &UtxoNotificationPayload,
     ) -> PublicAnnouncement {
         let encrypted_utxo_notification = EncryptedUtxoNotification {
             flag: GENERATION_FLAG_U8.into(),
-            receiver_identifier: self.receiver_identifier,
+            receiver_identifier: self.receiver_identifier(),
             ciphertext: self.encrypt(utxo_notification_payload),
         };
 
@@ -325,10 +333,26 @@ impl GenerationReceivingAddress {
     ) -> String {
         let encrypted_utxo_notification = EncryptedUtxoNotification {
             flag: GENERATION_FLAG_U8.into(),
-            receiver_identifier: self.receiver_identifier,
+            receiver_identifier: self.receiver_identifier(),
             ciphertext: self.encrypt(utxo_notification_payload),
         };
 
         encrypted_utxo_notification.into_bech32m(network)
     }
+
+    /// returns the receiver_identifier, a public fingerprint
+    pub fn receiver_identifier(&self) -> BFieldElement {
+        self.receiver_identifier
+    }
+
+    /// returns a privacy digest which corresponds to the.privacy_preimage(),
+    /// of the matching [GenerationSpendingKey]
+    pub fn privacy_digest(&self) -> Digest {
+        self.privacy_digest
+    }
+
+    /// returns the `spending_lock`
+    pub fn spending_lock(&self) -> Digest {
+        self.spending_lock
+    }
 }

src/models/state/wallet/mod.rs

@@ -550,7 +550,7 @@ mod wallet_tests {
             .add_expected_utxo(ExpectedUtxo::new(
                 block_1_coinbase_utxo.clone(),
                 block_1_coinbase_sender_randomness,
-                alice_spending_key.privacy_preimage,
+                alice_spending_key.privacy_preimage(),
                 UtxoNotifier::OwnMinerComposeBlock,
             ))
             .await;
@@ -706,7 +706,7 @@ mod wallet_tests {
                 .add_expected_utxo(ExpectedUtxo::new(
                     cb_utxo,
                     cb_output_randomness,
-                    alice_spending_key.privacy_preimage,
+                    alice_spending_key.privacy_preimage(),
                     UtxoNotifier::OwnMinerComposeBlock,
                 ))
                 .await;
@@ -758,7 +758,7 @@ mod wallet_tests {
                     .add_expected_utxo(ExpectedUtxo::new(
                         cb_utxo_prime,
                         cb_output_randomness_prime,
-                        alice_spending_key.privacy_preimage,
+                        alice_spending_key.privacy_preimage(),
                         UtxoNotifier::OwnMinerComposeBlock,
                     ))
                     .await;
@@ -931,7 +931,7 @@ mod wallet_tests {
 
         let bob_sender_randomness = bob.wallet_state.wallet_secret.generate_sender_randomness(
             genesis_block.kernel.header.height,
-            alice_address.privacy_digest,
+            alice_address.privacy_digest(),
         );
         let receiver_data_12_to_alice = TxOutput::offchain_native_currency(
             NeptuneCoins::new(12),
@@ -1037,7 +1037,7 @@ mod wallet_tests {
             let expected_utxo = ExpectedUtxo::new(
                 cb_utxo,
                 cb_sender_randomness,
-                alice_spending_key.privacy_preimage,
+                alice_spending_key.privacy_preimage(),
                 UtxoNotifier::OwnMinerComposeBlock,
             );
             alice
@@ -1261,7 +1261,7 @@ mod wallet_tests {
                 ExpectedUtxo::new(
                     expected_utxo.utxo,
                     expected_utxo.sender_randomness,
-                    alice_spending_key.privacy_preimage,
+                    alice_spending_key.privacy_preimage(),
                     UtxoNotifier::OwnMinerComposeBlock,
                 )
             })
@@ -1276,7 +1276,7 @@ mod wallet_tests {
         let expected_utxo_for_alice = ExpectedUtxo::new(
             receiver_data_1_to_alice_new.utxo(),
             receiver_data_1_to_alice_new.sender_randomness(),
-            alice_spending_key.privacy_preimage,
+            alice_spending_key.privacy_preimage(),
             UtxoNotifier::Cli,
         );
         alice
@@ -1497,7 +1497,10 @@ mod wallet_tests {
             "_authority_wallet address: {}",
             address.to_bech32m(Network::Alpha).unwrap()
         );
-        println!("_authority_wallet spending_lock: {}", address.spending_lock);
+        println!(
+            "_authority_wallet spending_lock: {}",
+            address.spending_lock()
+        );
     }
 
     #[test]

src/models/state/wallet/transaction_output.rs

@@ -398,7 +398,7 @@ mod tests {
         let sender_randomness = state
             .wallet_state
             .wallet_secret
-            .generate_sender_randomness(block_height, address.privacy_digest);
+            .generate_sender_randomness(block_height, address.privacy_digest());
 
         for owned_utxo_notification_medium in [
             UtxoNotificationMedium::OffChain,
@@ -418,7 +418,7 @@ mod tests {
                 "Not owned UTXOs are, currently, always transmitted on-chain"
             );
             assert_eq!(tx_output.sender_randomness(), sender_randomness);
-            assert_eq!(tx_output.receiver_digest(), address.privacy_digest);
+            assert_eq!(tx_output.receiver_digest(), address.privacy_digest());
             assert_eq!(tx_output.utxo(), utxo);
         }
     }

src/models/state/wallet/wallet_state.rs

@@ -1528,7 +1528,7 @@ mod tests {
                 vec![ExpectedUtxo::new(
                     cb_utxo,
                     cb_sender_randomness,
-                    alice_key.privacy_preimage,
+                    alice_key.privacy_preimage(),
                     UtxoNotifier::OwnMinerComposeBlock,
                 )],
             )
@@ -1570,7 +1570,7 @@ mod tests {
             .add_expected_utxo(ExpectedUtxo::new(
                 cb_utxo,
                 cb_sender_randomness,
-                bob_spending_key.privacy_preimage,
+                bob_spending_key.privacy_preimage(),
                 UtxoNotifier::OwnMinerComposeBlock,
             ))
             .await;
@@ -1715,7 +1715,7 @@ mod tests {
             vec![ExpectedUtxo::new(
                 block_3a_coinbase_utxo,
                 block_3a_coinbase_sender_randomness,
-                bob_spending_key.privacy_preimage,
+                bob_spending_key.privacy_preimage(),
                 UtxoNotifier::OwnMinerComposeBlock,
             )],
         )

src/rpc_server.rs

@@ -2432,7 +2432,7 @@ mod rpc_server_tests {
                     let cb = ExpectedUtxo::new(
                         cb_utxo,
                         cb_sender_randomness,
-                        cb_key.privacy_preimage,
+                        cb_key.privacy_preimage(),
                         UtxoNotifier::OwnMinerComposeBlock,
                     );
                     rpc_server
@@ -2564,7 +2564,7 @@ mod rpc_server_tests {
                 let cb = ExpectedUtxo::new(
                     cb_utxo,
                     cb_sender_randomness,
-                    bob_key.privacy_preimage,
+                    bob_key.privacy_preimage(),
                     UtxoNotifier::OwnMinerComposeBlock,
                 );
                 bob_rpc_server