Skip to content

Commit 0c7829f

Browse files
committed
Document when someone should want to use store_id
1 parent 4b7a892 commit 0c7829f

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

src/builder.rs

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -591,6 +591,11 @@ impl NodeBuilder {
591591
///
592592
/// `fixed_headers` are included as it is in all the requests made to VSS.
593593
///
594+
/// `store_id` allows you to segment LDK Node storage from other storage accessed with
595+
/// [`VssStoreBuilder`] using the same [`NodeEntropy`] (as storage with different keys is
596+
/// obviously segmented to prevent wallets from reading data for unrelated wallets). It can be
597+
/// any value.
598+
///
594599
/// **Caution**: VSS support is in **alpha** and is considered experimental.
595600
/// Using VSS (or any remote persistence) may cause LDK to panic if persistence failures are
596601
/// unrecoverable, i.e., if they remain unresolved after internal retries are exhausted.
@@ -619,6 +624,11 @@ impl NodeBuilder {
619624
/// The returned JWT token in response to the signed LNURL request, will be used for
620625
/// authentication/authorization of all the requests made to VSS.
621626
///
627+
/// `store_id` allows you to segment LDK Node storage from other storage accessed with
628+
/// [`VssStoreBuilder`] using the same authentication (as storage with different keys is
629+
/// obviously segmented to prevent wallets from reading data for unrelated wallets). It can be
630+
/// any value.
631+
///
622632
/// `fixed_headers` are included as it is in all the requests made to VSS and LNURL auth server.
623633
///
624634
/// **Caution**: VSS support is in **alpha** and is considered experimental.
@@ -990,6 +1000,11 @@ impl ArcedNodeBuilder {
9901000
///
9911001
/// `fixed_headers` are included as it is in all the requests made to VSS and LNURL auth server.
9921002
///
1003+
/// `store_id` allows you to segment LDK Node storage from other storage accessed with
1004+
/// [`VssStoreBuilder`] using the same [`NodeEntropy`] (as storage with different keys is
1005+
/// obviously segmented to prevent wallets from reading data for unrelated wallets). It can be
1006+
/// any value.
1007+
///
9931008
/// **Caution**: VSS support is in **alpha** and is considered experimental.
9941009
/// Using VSS (or any remote persistence) may cause LDK to panic if persistence failures are
9951010
/// unrecoverable, i.e., if they remain unresolved after internal retries are exhausted.
@@ -1017,6 +1032,11 @@ impl ArcedNodeBuilder {
10171032
///
10181033
/// `fixed_headers` are included as it is in all the requests made to VSS and LNURL auth server.
10191034
///
1035+
/// `store_id` allows you to segment LDK Node storage from other storage accessed with
1036+
/// [`VssStoreBuilder`] using the same authentication (as storage with different keys is
1037+
/// obviously segmented to prevent wallets from reading data for unrelated wallets). It can be
1038+
/// any value.
1039+
///
10201040
/// **Caution**: VSS support is in **alpha** and is considered experimental.
10211041
/// Using VSS (or any remote persistence) may cause LDK to panic if persistence failures are
10221042
/// unrecoverable, i.e., if they remain unresolved after internal retries are exhausted.

0 commit comments

Comments
 (0)