Launch VSS, remove cfg flag for it.

Author: G8XSU

.github/workflows/vss-integration.yml

@@ -74,8 +74,8 @@ jobs:
         run: |
           cd ldk-node
           export TEST_VSS_BASE_URL="http://localhost:8080/vss"
-          RUSTFLAGS="--cfg vss_test --cfg vss" cargo build --verbose --color always
-          RUSTFLAGS="--cfg vss_test --cfg vss" cargo test --test integration_tests_vss
+          RUSTFLAGS="--cfg vss_test" cargo build --verbose --color always
+          RUSTFLAGS="--cfg vss_test" cargo test --test integration_tests_vss
 
       - name: Cleanup
         run: |

Cargo.toml

@@ -72,7 +72,6 @@ esplora-client = { version = "0.9", default-features = false }
 libc = "0.2"
 uniffi = { version = "0.26.0", features = ["build"], optional = true }
 
-[target.'cfg(vss)'.dependencies]
 vss-client = "0.3"
 prost = { version = "0.11.6", default-features = false}
 
@@ -109,7 +108,6 @@ panic = "abort"
 level = "forbid"
 # When adding a new cfg attribute, ensure that it is added to this list.
 check-cfg = [
-	"cfg(vss)",
 	"cfg(vss_test)",
 	"cfg(ldk_bench)",
 	"cfg(tokio_unstable)",

src/builder.rs

@@ -14,7 +14,6 @@ use crate::fee_estimator::OnchainFeeEstimator;
 use crate::gossip::GossipSource;
 use crate::io::sqlite_store::SqliteStore;
 use crate::io::utils::{read_node_metrics, write_node_metrics};
-#[cfg(any(vss, vss_test))]
 use crate::io::vss_store::VssStore;
 use crate::liquidity::LiquiditySource;
 use crate::logger::{log_error, log_info, FilesystemLogger, Logger};
@@ -30,7 +29,6 @@ use crate::wallet::persist::KVStoreWalletPersister;
 use crate::wallet::Wallet;
 use crate::{io, NodeMetrics};
 use crate::{LogLevel, Node};
-#[cfg(any(vss, vss_test))]
 use std::collections::HashMap;
 
 use lightning::chain::{chainmonitor, BestBlock, Watch};
@@ -66,7 +64,6 @@ use bip39::Mnemonic;
 use bitcoin::secp256k1::PublicKey;
 use bitcoin::{BlockHash, Network};
 
-#[cfg(any(vss, vss_test))]
 use bitcoin::bip32::{ChildNumber, Xpriv};
 use std::convert::TryInto;
 use std::default::Default;
@@ -76,7 +73,6 @@ use std::path::PathBuf;
 use std::sync::atomic::AtomicBool;
 use std::sync::{Arc, Mutex, RwLock};
 use std::time::SystemTime;
-#[cfg(any(vss, vss_test))]
 use vss_client::headers::{FixedHeaders, LnurlAuthToJwtProvider, VssHeaderProvider};
 
 #[derive(Debug, Clone)]
@@ -361,9 +357,14 @@ impl NodeBuilder {
 		self.build_with_store(kv_store)
 	}
 
-	/// Builds a [`Node`] instance with a [`VssStore`] backend and according to the options
+	/// Builds a [`Node`] instance with a [VSS] backend and according to the options
 	/// previously configured. Uses LnurlAuth as default method for authentication/authorization.
-	#[cfg(any(vss, vss_test))]
+	///
+	/// **Caution**: [VSS] support is in **alpha**. Using [VSS] (or any remote persistence) may
+	/// cause LDK to panic if persistence failures are unrecoverable, i.e., if they remain unresolved
+	/// after internal retries are exhausted.
+	///
+	/// [VSS]: https://github.com/lightningdevkit/vss-server/blob/main/README.md
 	pub fn build_with_vss_store(
 		&self, vss_url: String, store_id: String, lnurl_auth_server_url: String,
 		fixed_headers: HashMap<String, String>,
@@ -401,9 +402,14 @@ impl NodeBuilder {
 		self.build_with_vss_store_and_header_provider(vss_url, store_id, header_provider)
 	}
 
-	/// Builds a [`Node`] instance with a [`VssStore`] backend and according to the options
+	/// Builds a [`Node`] instance with a [VSS] backend and according to the options
 	/// previously configured. Uses only FixedHeaders as default method for authentication/authorization.
-	#[cfg(any(vss, vss_test))]
+	///
+	/// **Caution**: [VSS] support is in **alpha**. Using [VSS] (or any remote persistence) may
+	/// cause LDK to panic if persistence failures are unrecoverable, i.e., if they remain unresolved
+	/// after internal retries are exhausted.
+	///
+	/// [VSS]: https://github.com/lightningdevkit/vss-server/blob/main/README.md
 	pub fn build_with_vss_store_with_fixed_headers(
 		&self, vss_url: String, store_id: String, fixed_headers: HashMap<String, String>,
 	) -> Result<Node, BuildError> {
@@ -412,10 +418,16 @@ impl NodeBuilder {
 		self.build_with_vss_store_and_header_provider(vss_url, store_id, header_provider)
 	}
 
-	/// Builds a [`Node`] instance with a [`VssStore`] backend and according to the options
-	/// previously configured. Give `header_provider` is used to attach headers to every request made
-	/// to [VSS](https://github.com/lightningdevkit/vss-server/blob/main/README.md) backend.
-	#[cfg(any(vss, vss_test))]
+	/// Builds a [`Node`] instance with a [VSS] backend and according to the options
+	/// previously configured. Given `header_provider` is used to attach headers to every request made
+	/// to the [VSS] backend.
+	///
+	/// **Caution**: [VSS] support
+	/// is in **alpha**. Using [VSS] (or any remote persistence) may cause LDK to panic if persistence
+	/// failures are unrecoverable, i.e., if they remain unresolved after internal retries are
+	/// exhausted.
+	///
+	/// [VSS]: https://github.com/lightningdevkit/vss-server/blob/main/README.md
 	pub fn build_with_vss_store_and_header_provider(
 		&self, vss_url: String, store_id: String, header_provider: Arc<dyn VssHeaderProvider>,
 	) -> Result<Node, BuildError> {
@@ -445,7 +457,6 @@ impl NodeBuilder {
 		)
 	}
 
-	#[cfg(any(vss, vss_test))]
 	fn derive_vss_xprv(
 		&self, config: &Arc<Config>, seed_bytes: &[u8; 64], logger: &Arc<FilesystemLogger>,
 	) -> Result<Xpriv, BuildError> {
@@ -618,9 +629,14 @@ impl ArcedNodeBuilder {
 		self.inner.read().unwrap().build_with_fs_store().map(Arc::new)
 	}
 
-	/// Builds a [`Node`] instance with a [`VssStore`] backend and according to the options
+	/// Builds a [`Node`] instance with a [VSS] backend and according to the options
 	/// previously configured. Uses LnurlAuth as default method for authentication/authorization.
-	#[cfg(any(vss, vss_test))]
+	///
+	/// **Caution**: [VSS] support is in **alpha**. Using [VSS] (or any remote persistence) may
+	/// cause LDK to panic if persistence failures are unrecoverable, i.e., if they remain unresolved
+	/// after internal retries are exhausted.
+	///
+	/// [VSS]: https://github.com/lightningdevkit/vss-server/blob/main/README.md
 	pub fn build_with_vss_store(
 		&self, vss_url: String, store_id: String, lnurl_auth_server_url: String,
 		fixed_headers: HashMap<String, String>,
@@ -632,9 +648,14 @@ impl ArcedNodeBuilder {
 			.map(Arc::new)
 	}
 
-	/// Builds a [`Node`] instance with a [`VssStore`] backend and according to the options
+	/// Builds a [`Node`] instance with a [VSS] backend and according to the options
 	/// previously configured. Uses only FixedHeaders as default method for authentication/authorization.
-	#[cfg(any(vss, vss_test))]
+	///
+	/// **Caution**: [VSS] support is in **alpha**. Using [VSS] (or any remote persistence) may
+	/// cause LDK to panic if persistence failures are unrecoverable, i.e., if they remain unresolved
+	/// after internal retries are exhausted.
+	///
+	/// [VSS]: https://github.com/lightningdevkit/vss-server/blob/main/README.md
 	pub fn build_with_vss_store_with_fixed_headers(
 		&self, vss_url: String, store_id: String, fixed_headers: HashMap<String, String>,
 	) -> Result<Arc<Node>, BuildError> {
@@ -645,10 +666,15 @@ impl ArcedNodeBuilder {
 			.map(Arc::new)
 	}
 
-	/// Builds a [`Node`] instance with a [`VssStore`] backend and according to the options
+	/// Builds a [`Node`] instance with a [VSS] backend and according to the options
 	/// previously configured. Give `header_provider` is used to attach headers to every request made
 	/// to [VSS](https://github.com/lightningdevkit/vss-server/blob/main/README.md) backend.
-	#[cfg(any(vss, vss_test))]
+	///
+	/// **Caution**: [VSS] support is in **alpha**. Using [VSS] (or any remote persistence) may
+	/// cause LDK to panic if persistence failures are unrecoverable, i.e., if they remain unresolved
+	/// after internal retries are exhausted.
+	///
+	/// [VSS]: https://github.com/lightningdevkit/vss-server/blob/main/README.md
 	pub fn build_with_vss_store_and_header_provider(
 		&self, vss_url: String, store_id: String, header_provider: Arc<dyn VssHeaderProvider>,
 	) -> Result<Arc<Node>, BuildError> {

src/io/mod.rs

@@ -11,7 +11,6 @@ pub mod sqlite_store;
 #[cfg(test)]
 pub(crate) mod test_utils;
 pub(crate) mod utils;
-#[cfg(any(vss, vss_test))]
 pub(crate) mod vss_store;
 
 /// The event queue will be persisted under this key.

src/lib.rs

@@ -111,6 +111,8 @@ pub use io::utils::generate_entropy_mnemonic;
 
 #[cfg(feature = "uniffi")]
 use uniffi_types::*;
+#[cfg(feature = "uniffi")]
+use vss_client::headers::{VssHeaderProvider, VssHeaderProviderError};
 
 #[cfg(feature = "uniffi")]
 pub use builder::ArcedNodeBuilder as Builder;