Skip to content

Commit 2070af9

Browse files
committed
Document when someone should want to use store_id
1 parent e4fff57 commit 2070af9

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
@@ -593,6 +593,11 @@ impl NodeBuilder {
593593
///
594594
/// `fixed_headers` are included as it is in all the requests made to VSS.
595595
///
596+
/// `store_id` allows you to segment LDK Node storage from other storage accessed with
597+
/// [`VssStoreBuilder`] using the same [`NodeEntropy`] (as storage with different keys is
598+
/// obviously segmented to prevent wallets from reading data for unrelated wallets). It can be
599+
/// any value.
600+
///
596601
/// **Caution**: VSS support is in **alpha** and is considered experimental.
597602
/// Using VSS (or any remote persistence) may cause LDK to panic if persistence failures are
598603
/// unrecoverable, i.e., if they remain unresolved after internal retries are exhausted.
@@ -621,6 +626,11 @@ impl NodeBuilder {
621626
/// The returned JWT token in response to the signed LNURL request, will be used for
622627
/// authentication/authorization of all the requests made to VSS.
623628
///
629+
/// `store_id` allows you to segment LDK Node storage from other storage accessed with
630+
/// [`VssStoreBuilder`] using the same authentication (as storage with different keys is
631+
/// obviously segmented to prevent wallets from reading data for unrelated wallets). It can be
632+
/// any value.
633+
///
624634
/// `fixed_headers` are included as it is in all the requests made to VSS and LNURL auth server.
625635
///
626636
/// **Caution**: VSS support is in **alpha** and is considered experimental.
@@ -992,6 +1002,11 @@ impl ArcedNodeBuilder {
9921002
///
9931003
/// `fixed_headers` are included as it is in all the requests made to VSS and LNURL auth server.
9941004
///
1005+
/// `store_id` allows you to segment LDK Node storage from other storage accessed with
1006+
/// [`VssStoreBuilder`] using the same [`NodeEntropy`] (as storage with different keys is
1007+
/// obviously segmented to prevent wallets from reading data for unrelated wallets). It can be
1008+
/// any value.
1009+
///
9951010
/// **Caution**: VSS support is in **alpha** and is considered experimental.
9961011
/// Using VSS (or any remote persistence) may cause LDK to panic if persistence failures are
9971012
/// unrecoverable, i.e., if they remain unresolved after internal retries are exhausted.
@@ -1019,6 +1034,11 @@ impl ArcedNodeBuilder {
10191034
///
10201035
/// `fixed_headers` are included as it is in all the requests made to VSS and LNURL auth server.
10211036
///
1037+
/// `store_id` allows you to segment LDK Node storage from other storage accessed with
1038+
/// [`VssStoreBuilder`] using the same authentication (as storage with different keys is
1039+
/// obviously segmented to prevent wallets from reading data for unrelated wallets). It can be
1040+
/// any value.
1041+
///
10221042
/// **Caution**: VSS support is in **alpha** and is considered experimental.
10231043
/// Using VSS (or any remote persistence) may cause LDK to panic if persistence failures are
10241044
/// unrecoverable, i.e., if they remain unresolved after internal retries are exhausted.

0 commit comments

Comments
 (0)