Skip to content

Commit 4e3f7b9

Browse files
committed
Document when someone should want to use store_id
1 parent 4304ea4 commit 4e3f7b9

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/builder.rs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -575,6 +575,11 @@ impl NodeBuilder {
575575
///
576576
/// `fixed_headers` are included as it is in all the requests made to VSS.
577577
///
578+
/// `store_id` allows you to segment LDK Node storage from other storage accessed with
579+
/// [`VssStoreBuilder`] using the same [`NodeEntropy`] (as storage with different keys is
580+
/// obviously segmented to prevent wallets from reading data for unrelated wallets). It can be
581+
/// any value.
582+
///
578583
/// **Caution**: VSS support is in **alpha** and is considered experimental.
579584
/// Using VSS (or any remote persistence) may cause LDK to panic if persistence failures are
580585
/// unrecoverable, i.e., if they remain unresolved after internal retries are exhausted.
@@ -603,6 +608,11 @@ impl NodeBuilder {
603608
/// The returned JWT token in response to the signed LNURL request, will be used for
604609
/// authentication/authorization of all the requests made to VSS.
605610
///
611+
/// `store_id` allows you to segment LDK Node storage from other storage accessed with
612+
/// [`VssStoreBuilder`] using the same authentication (as storage with different keys is
613+
/// obviously segmented to prevent wallets from reading data for unrelated wallets). It can be
614+
/// any value.
615+
///
606616
/// `fixed_headers` are included as it is in all the requests made to VSS and LNURL auth server.
607617
///
608618
/// **Caution**: VSS support is in **alpha** and is considered experimental.

0 commit comments

Comments
 (0)