Stop migrating spendable outputs from pre-v0.3 format

As part of the version v0.3 release we switched to the upstreamed
`OutputSweeper` which slightly changed our serialization format, having
us run a migration step on startup for backwards compatibility ever
since. Here we drop the migration code running on startup, for
simplicity's sake, but also because it's going to be async going forward
and we currently don't have a runtime available on startup (which might
change soon, but still).

As the v0.3 release now well over a year ago, it's very unlikely that
there are any v0.2 (or even v0.3) users left. If there are any affected
users left, they'll first have to upgrade to any version pre-v0.7,
startup, and then upgrade to v0.7 or later.

Author: tnull

src/balance.rs

@@ -5,17 +5,16 @@
 // http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
 // accordance with one or both of these licenses.
 
-use crate::sweep::value_from_descriptor;
-
 use lightning::chain::channelmonitor::Balance as LdkBalance;
 use lightning::chain::channelmonitor::BalanceSource;
 use lightning::ln::types::ChannelId;
+use lightning::sign::SpendableOutputDescriptor;
 use lightning::util::sweep::{OutputSpendStatus, TrackedSpendableOutput};
 
 use lightning_types::payment::{PaymentHash, PaymentPreimage};
 
 use bitcoin::secp256k1::PublicKey;
-use bitcoin::{BlockHash, Txid};
+use bitcoin::{Amount, BlockHash, Txid};
 
 /// Details of the known available balances returned by [`Node::list_balances`].
 ///
@@ -385,3 +384,11 @@ impl PendingSweepBalance {
 		}
 	}
 }
+
+fn value_from_descriptor(descriptor: &SpendableOutputDescriptor) -> Amount {
+	match &descriptor {
+		SpendableOutputDescriptor::StaticOutput { output, .. } => output.value,
+		SpendableOutputDescriptor::DelayedPaymentOutput(output) => output.output.value,
+		SpendableOutputDescriptor::StaticPaymentOutput(output) => output.output.value,
+	}
+}

src/builder.rs

@@ -25,7 +25,7 @@ use crate::io::{
 use crate::liquidity::{
 	LSPS1ClientConfig, LSPS2ClientConfig, LSPS2ServiceConfig, LiquiditySourceBuilder,
 };
-use crate::logger::{log_error, log_info, LdkLogger, LogLevel, LogWriter, Logger};
+use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
 use crate::message_handler::NodeCustomMessageHandler;
 use crate::peer_store::PeerStore;
 use crate::runtime::Runtime;
@@ -1627,20 +1627,6 @@ fn build_with_store_internal(
 		},
 	};
 
-	match io::utils::migrate_deprecated_spendable_outputs(
-		Arc::clone(&output_sweeper),
-		Arc::clone(&kv_store),
-		Arc::clone(&logger),
-	) {
-		Ok(()) => {
-			log_info!(logger, "Successfully migrated OutputSweeper data.");
-		},
-		Err(e) => {
-			log_error!(logger, "Failed to migrate OutputSweeper data: {}", e);
-			return Err(BuildError::ReadFailed);
-		},
-	}
-
 	let event_queue = match io::utils::read_event_queue(Arc::clone(&kv_store), Arc::clone(&logger))
 	{
 		Ok(event_queue) => Arc::new(event_queue),

src/io/mod.rs

@@ -27,11 +27,6 @@ pub(crate) const PEER_INFO_PERSISTENCE_KEY: &str = "peers";
 pub(crate) const PAYMENT_INFO_PERSISTENCE_PRIMARY_NAMESPACE: &str = "payments";
 pub(crate) const PAYMENT_INFO_PERSISTENCE_SECONDARY_NAMESPACE: &str = "";
 
-/// The spendable output information used to persisted under this prefix until LDK Node v0.3.0.
-pub(crate) const DEPRECATED_SPENDABLE_OUTPUT_INFO_PERSISTENCE_PRIMARY_NAMESPACE: &str =
-	"spendable_outputs";
-pub(crate) const DEPRECATED_SPENDABLE_OUTPUT_INFO_PERSISTENCE_SECONDARY_NAMESPACE: &str = "";
-
 /// The node metrics will be persisted under this key.
 pub(crate) const NODE_METRICS_PRIMARY_NAMESPACE: &str = "";
 pub(crate) const NODE_METRICS_SECONDARY_NAMESPACE: &str = "";

src/io/utils.rs

@@ -15,7 +15,6 @@ use crate::io::{
 };
 use crate::logger::{log_error, LdkLogger, Logger};
 use crate::peer_store::PeerStore;
-use crate::sweep::DeprecatedSpendableOutputInfo;
 use crate::types::{Broadcaster, DynStore, KeysManager, Sweeper};
 use crate::wallet::ser::{ChangeSetDeserWrapper, ChangeSetSerWrapper};
 use crate::{Error, EventQueue, NodeMetrics, PaymentDetails};
@@ -33,7 +32,7 @@ use lightning::util::persist::{
 };
 use lightning::util::ser::{Readable, ReadableArgs, Writeable};
 use lightning::util::string::PrintableString;
-use lightning::util::sweep::{OutputSpendStatus, OutputSweeper};
+use lightning::util::sweep::OutputSweeper;
 
 use bdk_chain::indexer::keychain_txout::ChangeSet as BdkIndexerChangeSet;
 use bdk_chain::local_chain::ChangeSet as BdkLocalChainChangeSet;
@@ -258,103 +257,6 @@ pub(crate) fn read_output_sweeper(
 	})
 }
 
-/// Read previously persisted spendable output information from the store and migrate to the
-/// upstreamed `OutputSweeper`.
-///
-/// We first iterate all `DeprecatedSpendableOutputInfo`s and have them tracked by the new
-/// `OutputSweeper`. In order to be certain the initial output spends will happen in a single
-/// transaction (and safe on-chain fees), we batch them to happen at current height plus two
-/// blocks. Lastly, we remove the previously persisted data once we checked they are tracked and
-/// awaiting their initial spend at the correct height.
-///
-/// Note that this migration will be run in the `Builder`, i.e., at the time when the migration is
-/// happening no background sync is ongoing, so we shouldn't have a risk of interleaving block
-/// connections during the migration.
-pub(crate) fn migrate_deprecated_spendable_outputs<L: Deref>(
-	sweeper: Arc<Sweeper>, kv_store: Arc<DynStore>, logger: L,
-) -> Result<(), std::io::Error>
-where
-	L::Target: LdkLogger,
-{
-	let best_block = sweeper.current_best_block();
-
-	for stored_key in kv_store.list(
-		DEPRECATED_SPENDABLE_OUTPUT_INFO_PERSISTENCE_PRIMARY_NAMESPACE,
-		DEPRECATED_SPENDABLE_OUTPUT_INFO_PERSISTENCE_SECONDARY_NAMESPACE,
-	)? {
-		let mut reader = Cursor::new(kv_store.read(
-			DEPRECATED_SPENDABLE_OUTPUT_INFO_PERSISTENCE_PRIMARY_NAMESPACE,
-			DEPRECATED_SPENDABLE_OUTPUT_INFO_PERSISTENCE_SECONDARY_NAMESPACE,
-			&stored_key,
-		)?);
-		let output = DeprecatedSpendableOutputInfo::read(&mut reader).map_err(|e| {
-			log_error!(logger, "Failed to deserialize SpendableOutputInfo: {}", e);
-			std::io::Error::new(
-				std::io::ErrorKind::InvalidData,
-				"Failed to deserialize SpendableOutputInfo",
-			)
-		})?;
-		let descriptors = vec![output.descriptor.clone()];
-		let spend_delay = Some(best_block.height + 2);
-		sweeper
-			.track_spendable_outputs(descriptors, output.channel_id, true, spend_delay)
-			.map_err(|_| {
-				log_error!(logger, "Failed to track spendable outputs. Aborting migration, will retry in the future.");
-				std::io::Error::new(
-					std::io::ErrorKind::InvalidData,
-					"Failed to track spendable outputs. Aborting migration, will retry in the future.",
-				)
-			})?;
-
-		if let Some(tracked_spendable_output) =
-			sweeper.tracked_spendable_outputs().iter().find(|o| o.descriptor == output.descriptor)
-		{
-			match tracked_spendable_output.status {
-				OutputSpendStatus::PendingInitialBroadcast { delayed_until_height } => {
-					if delayed_until_height == spend_delay {
-						kv_store.remove(
-							DEPRECATED_SPENDABLE_OUTPUT_INFO_PERSISTENCE_PRIMARY_NAMESPACE,
-							DEPRECATED_SPENDABLE_OUTPUT_INFO_PERSISTENCE_SECONDARY_NAMESPACE,
-							&stored_key,
-							false,
-						)?;
-					} else {
-						debug_assert!(false, "Unexpected status in OutputSweeper migration.");
-						log_error!(logger, "Unexpected status in OutputSweeper migration.");
-						return Err(std::io::Error::new(
-							std::io::ErrorKind::Other,
-							"Failed to migrate OutputSweeper state.",
-						));
-					}
-				},
-				_ => {
-					debug_assert!(false, "Unexpected status in OutputSweeper migration.");
-					log_error!(logger, "Unexpected status in OutputSweeper migration.");
-					return Err(std::io::Error::new(
-						std::io::ErrorKind::Other,
-						"Failed to migrate OutputSweeper state.",
-					));
-				},
-			}
-		} else {
-			debug_assert!(
-				false,
-				"OutputSweeper failed to track and persist outputs during migration."
-			);
-			log_error!(
-				logger,
-				"OutputSweeper failed to track and persist outputs during migration."
-			);
-			return Err(std::io::Error::new(
-				std::io::ErrorKind::Other,
-				"Failed to migrate OutputSweeper state.",
-			));
-		}
-	}
-
-	Ok(())
-}
-
 pub(crate) fn read_node_metrics<L: Deref>(
 	kv_store: Arc<DynStore>, logger: L,
 ) -> Result<NodeMetrics, std::io::Error>

src/lib.rs

@@ -95,7 +95,6 @@ mod message_handler;
 pub mod payment;
 mod peer_store;
 mod runtime;
-mod sweep;
 mod tx_broadcaster;
 mod types;
 mod wallet;