File tree Expand file tree Collapse file tree 3 files changed +14
-5
lines changed
Expand file tree Collapse file tree 3 files changed +14
-5
lines changed Original file line number Diff line number Diff line change @@ -76,8 +76,11 @@ use crate::wallet::persist::KVStoreWalletPersister;
7676use crate :: wallet:: Wallet ;
7777use crate :: { Node , NodeMetrics } ;
7878
79- const VSS_HARDENED_CHILD_INDEX : u32 = 877 ;
80- const VSS_LNURL_AUTH_HARDENED_CHILD_INDEX : u32 = 138 ;
79+ /// Child index used for deriving the VSS XPriv from the wallet seed.
80+ pub const VSS_HARDENED_CHILD_INDEX : u32 = 877 ;
81+ /// Child index used for deriving the LNURL-auth XPriv from the VSS XPriv.
82+ pub const VSS_LNURL_AUTH_HARDENED_CHILD_INDEX : u32 = 138 ;
83+
8184const LSPS_HARDENED_CHILD_INDEX : u32 = 577 ;
8285const PERSISTER_MAX_PENDING_UPDATES : u64 = 100 ;
8386
Original file line number Diff line number Diff line change @@ -11,7 +11,7 @@ pub mod sqlite_store;
1111#[ cfg( test) ]
1212pub ( crate ) mod test_utils;
1313pub ( crate ) mod utils;
14- pub ( crate ) mod vss_store;
14+ pub mod vss_store;
1515
1616/// The event queue will be persisted under this key.
1717pub ( crate ) const EVENT_QUEUE_PERSISTENCE_PRIMARY_NAMESPACE : & str = "" ;
Original file line number Diff line number Diff line change 55// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
66// accordance with one or both of these licenses.
77
8+ //! Objects related to [`VssStore`] live here.
9+
810use std:: boxed:: Box ;
911use std:: collections:: HashMap ;
1012use std:: future:: Future ;
@@ -36,7 +38,6 @@ use vss_client::util::retry::{
3638 MaxAttemptsRetryPolicy , MaxTotalDelayRetryPolicy , RetryPolicy ,
3739} ;
3840use vss_client:: util:: storable_builder:: { EntropySource , StorableBuilder } ;
39-
4041use crate :: io:: utils:: check_namespace_key_validity;
4142
4243type CustomRetryPolicy = FilteredRetryPolicy <
@@ -84,7 +85,12 @@ pub struct VssStore {
8485}
8586
8687impl VssStore {
87- pub ( crate ) fn new (
88+ /// Constructs a new [`VssStore`].
89+ ///
90+ /// **Caution**: VSS support is in **alpha** and is considered experimental.
91+ /// Using VSS (or any remote persistence) may cause LDK to panic if persistence failures are
92+ /// unrecoverable, i.e., if they remain unresolved after internal retries are exhausted.
93+ pub fn new (
8894 base_url : String , store_id : String , vss_seed : [ u8 ; 32 ] ,
8995 header_provider : Arc < dyn VssHeaderProvider > ,
9096 ) -> io:: Result < Self > {
You can’t perform that action at this time.
0 commit comments