better naming and update API

Author: Prabhat1308

lightning/src/util/persist.rs

@@ -449,7 +449,7 @@ where
 ///
 /// # Size-based persistence optimization
 ///
-/// For small channel monitors (below `minimum_monitor_size_for_updates` bytes when serialized),
+/// For small channel monitors (below `min_monitor_size_for_updates_bytes` bytes when serialized),
 /// this persister will always write the full monitor instead of individual updates. This avoids
 /// the overhead of managing update files and later compaction for tiny monitors that don't benefit
 /// from differential updates.
@@ -465,7 +465,7 @@ where
 	kv_store: K,
 	logger: L,
 	maximum_pending_updates: u64,
-	minimum_monitor_size_for_updates: usize,
+	min_monitor_size_for_updates_bytes: usize,
 	entropy_source: ES,
 	signer_provider: SP,
 	broadcaster: BI,
@@ -483,7 +483,7 @@ where
 	BI::Target: BroadcasterInterface,
 	FE::Target: FeeEstimator,
 {
-	/// Constructs a new [`MonitorUpdatingPersister`].
+	/// Constructs a new [`MonitorUpdatingPersister`] with a default minimum monitor size threshold.
 	///
 	/// The `maximum_pending_updates` parameter controls how many updates may be stored before a
 	/// [`MonitorUpdatingPersister`] consolidates updates by writing a full monitor. Note that
@@ -500,49 +500,49 @@ where
 	///   - [`MonitorUpdatingPersister`] will potentially have more listing to do if you need to run
 	/// [`MonitorUpdatingPersister::cleanup_stale_updates`].
 	///
-	/// The `minimum_monitor_size_for_updates` parameter sets the minimum serialized size (in bytes)
-	/// for a [`ChannelMonitor`] to use update-based persistence. Monitors smaller than this threshold
-	/// will always be persisted in full, avoiding the overhead of managing update files for tiny
-	/// monitors. A reasonable default is 4096 bytes (4 KiB). Set to 0 to always use update-based
-	/// persistence regardless of size.
+	/// This sets `min_monitor_size_for_updates_bytes` to 4096 bytes (4 KiB), which is a reasonable
+	/// default for most use cases. Monitors smaller than this will be persisted in full rather than
+	/// using update-based persistence. Use [`MonitorUpdatingPersister::new_with_monitor_size_threshold`]
+	/// if you need a custom threshold.
 	pub fn new(
-		kv_store: K, logger: L, maximum_pending_updates: u64,
-		minimum_monitor_size_for_updates: usize, entropy_source: ES, signer_provider: SP,
-		broadcaster: BI, fee_estimator: FE,
+		kv_store: K, logger: L, maximum_pending_updates: u64, entropy_source: ES,
+		signer_provider: SP, broadcaster: BI, fee_estimator: FE,
 	) -> Self {
-		MonitorUpdatingPersister {
+		Self::new_with_monitor_size_threshold(
 			kv_store,
 			logger,
 			maximum_pending_updates,
-			minimum_monitor_size_for_updates,
+			4096,
 			entropy_source,
 			signer_provider,
 			broadcaster,
 			fee_estimator,
-		}
+		)
 	}
 
-	/// Constructs a new [`MonitorUpdatingPersister`] with a default minimum monitor size threshold.
+	/// Constructs a new [`MonitorUpdatingPersister`] with a custom minimum monitor size threshold.
 	///
-	/// This is a convenience method that sets `minimum_monitor_size_for_updates` to 4096 bytes (4 KiB),
-	/// which is a reasonable default for most use cases. Monitors smaller than this will be persisted
-	/// in full rather than using update-based persistence.
+	/// The `min_monitor_size_for_updates_bytes` parameter sets the minimum serialized size (in bytes)
+	/// for a [`ChannelMonitor`] to use update-based persistence. Monitors smaller than this threshold
+	/// will always be persisted in full, avoiding the overhead of managing update files for tiny
+	/// monitors. Set to 0 to always use update-based persistence regardless of size.
 	///
 	/// For other parameters, see [`MonitorUpdatingPersister::new`].
-	pub fn new_with_default_threshold(
-		kv_store: K, logger: L, maximum_pending_updates: u64, entropy_source: ES,
-		signer_provider: SP, broadcaster: BI, fee_estimator: FE,
+	pub fn new_with_monitor_size_threshold(
+		kv_store: K, logger: L, maximum_pending_updates: u64,
+		min_monitor_size_for_updates_bytes: usize, entropy_source: ES, signer_provider: SP,
+		broadcaster: BI, fee_estimator: FE,
 	) -> Self {
-		Self::new(
+		MonitorUpdatingPersister {
 			kv_store,
 			logger,
 			maximum_pending_updates,
-			4096,
+			min_monitor_size_for_updates_bytes,
 			entropy_source,
 			signer_provider,
 			broadcaster,
 			fee_estimator,
-		)
+		}
 	}
 
 	/// Reads all stored channel monitors, along with any stored updates for them.
@@ -793,7 +793,7 @@ where
 		if let Some(update) = update {
 			// Check if monitor is too small for update-based persistence
 			let monitor_size = monitor.serialized_length();
-			let use_full_persistence = monitor_size < self.minimum_monitor_size_for_updates;
+			let use_full_persistence = monitor_size < self.min_monitor_size_for_updates_bytes;
 
 			let persist_update = !use_full_persistence
 				&& update.update_id != LEGACY_CLOSED_CHANNEL_UPDATE_ID
@@ -1200,7 +1200,7 @@ mod tests {
 			kv_store: &TestStore::new(false),
 			logger: &TestLogger::new(),
 			maximum_pending_updates: persister_0_max_pending_updates,
-			minimum_monitor_size_for_updates: 0,
+			min_monitor_size_for_updates_bytes: 0,
 			entropy_source: &chanmon_cfgs[0].keys_manager,
 			signer_provider: &chanmon_cfgs[0].keys_manager,
 			broadcaster: &chanmon_cfgs[0].tx_broadcaster,
@@ -1210,7 +1210,7 @@ mod tests {
 			kv_store: &TestStore::new(false),
 			logger: &TestLogger::new(),
 			maximum_pending_updates: persister_1_max_pending_updates,
-			minimum_monitor_size_for_updates: 0,
+			min_monitor_size_for_updates_bytes: 0,
 			entropy_source: &chanmon_cfgs[1].keys_manager,
 			signer_provider: &chanmon_cfgs[1].keys_manager,
 			broadcaster: &chanmon_cfgs[1].tx_broadcaster,
@@ -1376,7 +1376,7 @@ mod tests {
 				kv_store: &TestStore::new(true),
 				logger: &TestLogger::new(),
 				maximum_pending_updates: 11,
-				minimum_monitor_size_for_updates: 0,
+				min_monitor_size_for_updates_bytes: 0,
 				entropy_source: node_cfgs[0].keys_manager,
 				signer_provider: node_cfgs[0].keys_manager,
 				broadcaster: node_cfgs[0].tx_broadcaster,
@@ -1423,7 +1423,7 @@ mod tests {
 			kv_store: &TestStore::new(false),
 			logger: &TestLogger::new(),
 			maximum_pending_updates: test_max_pending_updates,
-			minimum_monitor_size_for_updates: 0,
+			min_monitor_size_for_updates_bytes: 0,
 			entropy_source: &chanmon_cfgs[0].keys_manager,
 			signer_provider: &chanmon_cfgs[0].keys_manager,
 			broadcaster: &chanmon_cfgs[0].tx_broadcaster,
@@ -1433,7 +1433,7 @@ mod tests {
 			kv_store: &TestStore::new(false),
 			logger: &TestLogger::new(),
 			maximum_pending_updates: test_max_pending_updates,
-			minimum_monitor_size_for_updates: 0,
+			min_monitor_size_for_updates_bytes: 0,
 			entropy_source: &chanmon_cfgs[1].keys_manager,
 			signer_provider: &chanmon_cfgs[1].keys_manager,
 			broadcaster: &chanmon_cfgs[1].tx_broadcaster,
@@ -1512,7 +1512,7 @@ mod tests {
 			kv_store: &TestStore::new(false),
 			logger: &TestLogger::new(),
 			maximum_pending_updates: 5,
-			minimum_monitor_size_for_updates: 100_000, // 100KB threshold - way larger than any monitor
+			min_monitor_size_for_updates_bytes: 100_000, // 100KB threshold - way larger than any monitor
 			entropy_source: &chanmon_cfgs[0].keys_manager,
 			signer_provider: &chanmon_cfgs[0].keys_manager,
 			broadcaster: &chanmon_cfgs[0].tx_broadcaster,
@@ -1525,7 +1525,7 @@ mod tests {
 			kv_store: &TestStore::new(false),
 			logger: &TestLogger::new(),
 			maximum_pending_updates: 5,
-			minimum_monitor_size_for_updates: 0, // 0 byte threshold - allows all monitors to use updates
+			min_monitor_size_for_updates_bytes: 0, // 0 byte threshold - allows all monitors to use updates
 			entropy_source: &chanmon_cfgs[1].keys_manager,
 			signer_provider: &chanmon_cfgs[1].keys_manager,
 			broadcaster: &chanmon_cfgs[1].tx_broadcaster,