fixup: Add OurPeerStorage for serialized Peer Storage backups

Author: adi2011

lightning/src/ln/our_peer_storage.rs

@@ -33,20 +33,22 @@ use crate::prelude::*;
 /// ## Example
 /// ```ignore
 /// let key = [0u8; 32];
-/// let mut our_peer_storage = OurPeerStorage::create_from_data(key.clone(), vec![1,2,3]);
-/// let mut decrypted = vec![0u8; encrypted.len()];
-/// OurPeerStorage::decrypt_our_peer_storage(&mut decrypted, &our_peer_storage, key).unwrap();
+/// let our_peer_storage = OurPeerStorage::create_from_data(key.clone(), vec![1,2,3]);
+/// let decrypted_data = our_peer_storage.decrypt_our_peer_storage(key).unwrap();
+/// assert_eq!(decrypted_data, vec![1 , 2, 3]);
 /// ```
 #[derive(PartialEq)]
 pub struct OurPeerStorage {
 	encrypted_data: Vec<u8>,
 }
 
 impl OurPeerStorage {
+	/// Creates a new [`OurPeerStorage`] with given encrypted_data.
 	pub fn new(encrypted_data: Vec<u8>) -> Self {
 		Self { encrypted_data }
 	}
 
+	/// Get encrypted data stored inside [`OurPeerStorage`].
 	pub fn encrypted_data(&self) -> Vec<u8> {
 		self.encrypted_data.clone()
 	}
@@ -76,7 +78,7 @@ impl OurPeerStorage {
 
 	/// Decrypt `OurPeerStorage` using the `key`, result is stored inside the `res`.
 	/// Returns an error if the the `cyphertext` is not correct.
-	pub fn decrypt_our_peer_storage(&self, key: [u8; 32]) -> Result<Vec<u8>, ()> {
+	pub fn decrypt_our_peer_storage(self, key: [u8; 32]) -> Result<Vec<u8>, ()> {
 		const MIN_CYPHERTEXT_LEN: usize = 16;
 		let cyphertext = &self.encrypted_data[..];