Skip to content

Commit 1400616

Browse files
committed
Remove LdkLite prefixes, resolve warnings
1 parent 78eb34d commit 1400616

File tree

6 files changed

+86
-117
lines changed

6 files changed

+86
-117
lines changed

src/access.rs

+10-12
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
use crate::error::LdkLiteError as Error;
2-
#[allow(unused_imports)]
31
use crate::logger::{
4-
log_error, log_given_level, log_info, log_internal, log_trace, log_warn, FilesystemLogger,
5-
Logger,
2+
log_error, log_given_level, log_internal, log_trace, FilesystemLogger, Logger,
63
};
4+
use crate::Error;
75

86
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
97
use lightning::chain::WatchedOutput;
@@ -22,7 +20,7 @@ use std::sync::{Arc, Mutex};
2220
/// The minimum feerate we are allowed to send, as specify by LDK.
2321
const MIN_FEERATE: u32 = 253;
2422

25-
pub struct LdkLiteChainAccess<D>
23+
pub struct ChainAccess<D>
2624
where
2725
D: BatchDatabase,
2826
{
@@ -36,7 +34,7 @@ where
3634
logger: Arc<FilesystemLogger>,
3735
}
3836

39-
impl<D> LdkLiteChainAccess<D>
37+
impl<D> ChainAccess<D>
4038
where
4139
D: BatchDatabase,
4240
{
@@ -275,7 +273,7 @@ where
275273
}
276274
}
277275

278-
impl<D> FeeEstimator for LdkLiteChainAccess<D>
276+
impl<D> FeeEstimator for ChainAccess<D>
279277
where
280278
D: BatchDatabase,
281279
{
@@ -288,7 +286,7 @@ where
288286
}
289287
}
290288

291-
impl<D> BroadcasterInterface for LdkLiteChainAccess<D>
289+
impl<D> BroadcasterInterface for ChainAccess<D>
292290
where
293291
D: BatchDatabase,
294292
{
@@ -303,7 +301,7 @@ where
303301
}
304302
}
305303

306-
impl<D> Filter for LdkLiteChainAccess<D>
304+
impl<D> Filter for ChainAccess<D>
307305
where
308306
D: BatchDatabase,
309307
{
@@ -317,7 +315,7 @@ where
317315
}
318316
}
319317

320-
impl<D> GetHeight for LdkLiteChainAccess<D>
318+
impl<D> GetHeight for ChainAccess<D>
321319
where
322320
D: BatchDatabase,
323321
{
@@ -326,7 +324,7 @@ where
326324
}
327325
}
328326

329-
impl<D> GetBlockHash for LdkLiteChainAccess<D>
327+
impl<D> GetBlockHash for ChainAccess<D>
330328
where
331329
D: BatchDatabase,
332330
{
@@ -335,7 +333,7 @@ where
335333
}
336334
}
337335

338-
impl<D> GetTx for LdkLiteChainAccess<D>
336+
impl<D> GetTx for ChainAccess<D>
339337
where
340338
D: BatchDatabase,
341339
{

src/error.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use std::fmt;
33

44
#[derive(Debug)]
55
/// An error that possibly needs to be handled by the user.
6-
pub enum LdkLiteError {
6+
pub enum Error {
77
/// Returned when trying to start LdkLite while it is already running.
88
AlreadyRunning,
99
/// Returned when trying to stop LdkLite while it is not running.
@@ -36,7 +36,7 @@ pub enum LdkLiteError {
3636
ChainAccessFailed,
3737
}
3838

39-
impl fmt::Display for LdkLiteError {
39+
impl fmt::Display for Error {
4040
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
4141
match *self {
4242
Self::AlreadyRunning => write!(f, "LDKLite is already running."),
@@ -60,9 +60,9 @@ impl fmt::Display for LdkLiteError {
6060
}
6161
}
6262

63-
impl std::error::Error for LdkLiteError {}
63+
impl std::error::Error for Error {}
6464

65-
impl From<bdk::Error> for LdkLiteError {
65+
impl From<bdk::Error> for Error {
6666
fn from(e: bdk::Error) -> Self {
6767
match e {
6868
bdk::Error::Signer(_) => Self::WalletSigningFailed,
@@ -71,7 +71,7 @@ impl From<bdk::Error> for LdkLiteError {
7171
}
7272
}
7373

74-
impl From<esplora::EsploraError> for LdkLiteError {
74+
impl From<esplora::EsploraError> for Error {
7575
fn from(_e: esplora::EsploraError) -> Self {
7676
Self::ChainAccessFailed
7777
}

src/event.rs

+32-54
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
use crate::{
2-
hex_utils, ChannelManager, Error, FilesystemPersister, LdkLiteChainAccess, LdkLiteConfig,
3-
NetworkGraph, PaymentInfo, PaymentInfoStorage, PaymentStatus,
2+
hex_utils, ChainAccess, ChannelManager, Config, Error, FilesystemPersister, NetworkGraph,
3+
PaymentInfo, PaymentInfoStorage, PaymentStatus,
44
};
55

6-
#[allow(unused_imports)]
7-
use crate::logger::{
8-
log_error, log_given_level, log_info, log_internal, log_trace, log_warn, FilesystemLogger,
9-
Logger,
10-
};
6+
use crate::logger::{log_error, log_given_level, log_info, log_internal, FilesystemLogger, Logger};
117

128
use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
139
use lightning::chain::keysinterface::KeysManager;
@@ -33,7 +29,7 @@ pub(crate) const EVENTS_PERSISTENCE_KEY: &str = "events";
3329
///
3430
/// [`LdkLite`]: [`crate::LdkLite`]
3531
#[derive(Debug, Clone)]
36-
pub enum LdkLiteEvent {
32+
pub enum Event {
3733
/// A payment we sent was successful.
3834
PaymentSuccessful {
3935
/// The hash of the payment.
@@ -66,7 +62,7 @@ pub enum LdkLiteEvent {
6662
//}
6763
}
6864

69-
impl Readable for LdkLiteEvent {
65+
impl Readable for Event {
7066
fn read<R: lightning::io::Read>(
7167
reader: &mut R,
7268
) -> Result<Self, lightning::ln::msgs::DecodeError> {
@@ -102,7 +98,7 @@ impl Readable for LdkLiteEvent {
10298
}
10399
}
104100

105-
impl Writeable for LdkLiteEvent {
101+
impl Writeable for Event {
106102
fn write<W: Writer>(&self, writer: &mut W) -> Result<(), lightning::io::Error> {
107103
match self {
108104
Self::PaymentSuccessful { payment_hash } => {
@@ -138,19 +134,19 @@ impl Writeable for LdkLiteEvent {
138134
}
139135
}
140136

141-
pub(crate) struct LdkLiteEventQueue<K: KVStorePersister> {
137+
pub(crate) struct EventQueue<K: KVStorePersister> {
142138
queue: Mutex<EventQueueSerWrapper>,
143139
notifier: Condvar,
144140
persister: Arc<K>,
145141
}
146142

147-
impl<K: KVStorePersister> LdkLiteEventQueue<K> {
143+
impl<K: KVStorePersister> EventQueue<K> {
148144
pub(crate) fn new(persister: Arc<K>) -> Self {
149145
let queue: Mutex<EventQueueSerWrapper> = Mutex::new(EventQueueSerWrapper(VecDeque::new()));
150146
let notifier = Condvar::new();
151147
Self { queue, notifier, persister }
152148
}
153-
pub(crate) fn add_event(&self, event: LdkLiteEvent) -> Result<(), Error> {
149+
pub(crate) fn add_event(&self, event: Event) -> Result<(), Error> {
154150
let mut locked_queue = self.queue.lock().unwrap();
155151
locked_queue.0.push_back(event);
156152

@@ -162,7 +158,7 @@ impl<K: KVStorePersister> LdkLiteEventQueue<K> {
162158
Ok(())
163159
}
164160

165-
pub(crate) fn next_event(&self) -> LdkLiteEvent {
161+
pub(crate) fn next_event(&self) -> Event {
166162
let locked_queue = self
167163
.notifier
168164
.wait_while(self.queue.lock().unwrap(), |queue| queue.0.is_empty())
@@ -181,7 +177,7 @@ impl<K: KVStorePersister> LdkLiteEventQueue<K> {
181177
}
182178
}
183179

184-
impl<K: KVStorePersister> ReadableArgs<Arc<K>> for LdkLiteEventQueue<K> {
180+
impl<K: KVStorePersister> ReadableArgs<Arc<K>> for EventQueue<K> {
185181
#[inline]
186182
fn read<R: lightning::io::Read>(
187183
reader: &mut R, persister: Arc<K>,
@@ -192,7 +188,7 @@ impl<K: KVStorePersister> ReadableArgs<Arc<K>> for LdkLiteEventQueue<K> {
192188
}
193189
}
194190

195-
struct EventQueueSerWrapper(VecDeque<LdkLiteEvent>);
191+
struct EventQueueSerWrapper(VecDeque<Event>);
196192

197193
impl Readable for EventQueueSerWrapper {
198194
fn read<R: lightning::io::Read>(
@@ -217,26 +213,25 @@ impl Writeable for EventQueueSerWrapper {
217213
}
218214
}
219215

220-
pub(crate) struct LdkLiteEventHandler {
221-
chain_access: Arc<LdkLiteChainAccess<bdk::sled::Tree>>,
222-
event_queue: Arc<LdkLiteEventQueue<FilesystemPersister>>,
216+
pub(crate) struct EventHandler {
217+
chain_access: Arc<ChainAccess<bdk::sled::Tree>>,
218+
event_queue: Arc<EventQueue<FilesystemPersister>>,
223219
channel_manager: Arc<ChannelManager>,
224220
network_graph: Arc<NetworkGraph>,
225221
keys_manager: Arc<KeysManager>,
226222
inbound_payments: Arc<PaymentInfoStorage>,
227223
outbound_payments: Arc<PaymentInfoStorage>,
228224
logger: Arc<FilesystemLogger>,
229-
_config: Arc<LdkLiteConfig>,
225+
_config: Arc<Config>,
230226
}
231227

232-
impl LdkLiteEventHandler {
228+
impl EventHandler {
233229
pub fn new(
234-
chain_access: Arc<LdkLiteChainAccess<bdk::sled::Tree>>,
235-
event_queue: Arc<LdkLiteEventQueue<FilesystemPersister>>,
236-
channel_manager: Arc<ChannelManager>, network_graph: Arc<NetworkGraph>,
237-
keys_manager: Arc<KeysManager>, inbound_payments: Arc<PaymentInfoStorage>,
238-
outbound_payments: Arc<PaymentInfoStorage>, logger: Arc<FilesystemLogger>,
239-
_config: Arc<LdkLiteConfig>,
230+
chain_access: Arc<ChainAccess<bdk::sled::Tree>>,
231+
event_queue: Arc<EventQueue<FilesystemPersister>>, channel_manager: Arc<ChannelManager>,
232+
network_graph: Arc<NetworkGraph>, keys_manager: Arc<KeysManager>,
233+
inbound_payments: Arc<PaymentInfoStorage>, outbound_payments: Arc<PaymentInfoStorage>,
234+
logger: Arc<FilesystemLogger>, _config: Arc<Config>,
240235
) -> Self {
241236
Self {
242237
event_queue,
@@ -252,7 +247,7 @@ impl LdkLiteEventHandler {
252247
}
253248
}
254249

255-
impl LdkEventHandler for LdkLiteEventHandler {
250+
impl LdkEventHandler for EventHandler {
256251
fn handle_event(&self, event: &LdkEvent) {
257252
match event {
258253
LdkEvent::FundingGenerationReady {
@@ -299,14 +294,12 @@ impl LdkEventHandler for LdkLiteEventHandler {
299294
amount_msat,
300295
);
301296
let payment_preimage = match purpose {
302-
PaymentPurpose::InvoicePayment { payment_preimage, .. } => {
303-
*payment_preimage
304-
}
297+
PaymentPurpose::InvoicePayment { payment_preimage, .. } => *payment_preimage,
305298
PaymentPurpose::SpontaneousPayment(preimage) => Some(*preimage),
306299
};
307300
self.channel_manager.claim_funds(payment_preimage.unwrap());
308301
self.event_queue
309-
.add_event(LdkLiteEvent::PaymentReceived {
302+
.add_event(Event::PaymentReceived {
310303
payment_hash: *payment_hash,
311304
amount_msat: *amount_msat,
312305
})
@@ -320,14 +313,10 @@ impl LdkEventHandler for LdkLiteEventHandler {
320313
amount_msat,
321314
);
322315
let (payment_preimage, payment_secret) = match purpose {
323-
PaymentPurpose::InvoicePayment {
324-
payment_preimage,
325-
payment_secret,
326-
..
327-
} => (*payment_preimage, Some(*payment_secret)),
328-
PaymentPurpose::SpontaneousPayment(preimage) => {
329-
(Some(*preimage), None)
316+
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
317+
(*payment_preimage, Some(*payment_secret))
330318
}
319+
PaymentPurpose::SpontaneousPayment(preimage) => (Some(*preimage), None),
331320
};
332321
let mut payments = self.inbound_payments.lock().unwrap();
333322
match payments.entry(*payment_hash) {
@@ -347,12 +336,7 @@ impl LdkEventHandler for LdkLiteEventHandler {
347336
}
348337
}
349338
}
350-
LdkEvent::PaymentSent {
351-
payment_preimage,
352-
payment_hash,
353-
fee_paid_msat,
354-
..
355-
} => {
339+
LdkEvent::PaymentSent { payment_preimage, payment_hash, fee_paid_msat, .. } => {
356340
let mut payments = self.outbound_payments.lock().unwrap();
357341
for (hash, payment) in payments.iter_mut() {
358342
if *hash == *payment_hash {
@@ -374,9 +358,7 @@ impl LdkEventHandler for LdkLiteEventHandler {
374358
}
375359
}
376360
self.event_queue
377-
.add_event(LdkLiteEvent::PaymentSuccessful {
378-
payment_hash: *payment_hash,
379-
})
361+
.add_event(Event::PaymentSuccessful { payment_hash: *payment_hash })
380362
.unwrap();
381363
}
382364
LdkEvent::PaymentFailed { payment_hash, .. } => {
@@ -392,9 +374,7 @@ impl LdkEventHandler for LdkLiteEventHandler {
392374
payment.status = PaymentStatus::Failed;
393375
}
394376
self.event_queue
395-
.add_event(LdkLiteEvent::PaymentFailed {
396-
payment_hash: *payment_hash,
397-
})
377+
.add_event(Event::PaymentFailed { payment_hash: *payment_hash })
398378
.unwrap();
399379
}
400380

@@ -506,9 +486,7 @@ impl LdkEventHandler for LdkLiteEventHandler {
506486
reason
507487
);
508488
self.event_queue
509-
.add_event(LdkLiteEvent::ChannelClosed {
510-
channel_id: *channel_id,
511-
})
489+
.add_event(Event::ChannelClosed { channel_id: *channel_id })
512490
.unwrap();
513491
}
514492
LdkEvent::DiscardFunding { .. } => {}

src/io_utils.rs

+5-12
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,16 @@
1-
use crate::error::LdkLiteError as Error;
2-
3-
use crate::{FilesystemLogger, LdkLiteConfig, NetworkGraph, PeerInfo, Scorer};
1+
use crate::{Config, Error, FilesystemLogger, NetworkGraph, Scorer};
42

53
use lightning::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringParameters};
64
use lightning::util::ser::ReadableArgs;
75

8-
use bitcoin::secp256k1::PublicKey;
9-
106
use rand::{thread_rng, RngCore};
117

12-
use std::collections::HashMap;
13-
use std::convert::TryFrom;
148
use std::fs;
15-
use std::io::{BufRead, BufReader, Write};
16-
use std::net::SocketAddr;
9+
use std::io::{BufReader, Write};
1710
use std::path::Path;
1811
use std::sync::Arc;
1912

20-
pub(crate) fn read_or_generate_seed_file(config: Arc<LdkLiteConfig>) -> [u8; 32] {
13+
pub(crate) fn read_or_generate_seed_file(config: Arc<Config>) -> [u8; 32] {
2114
let keys_seed_path = format!("{}/keys_seed", config.storage_dir_path);
2215
let keys_seed = if Path::new(&keys_seed_path).exists() {
2316
let seed = fs::read(keys_seed_path.clone()).expect("Failed to read keys seed file");
@@ -40,7 +33,7 @@ pub(crate) fn read_or_generate_seed_file(config: Arc<LdkLiteConfig>) -> [u8; 32]
4033
}
4134

4235
pub(crate) fn read_network_graph(
43-
config: Arc<LdkLiteConfig>, logger: Arc<FilesystemLogger>,
36+
config: Arc<Config>, logger: Arc<FilesystemLogger>,
4437
) -> Result<NetworkGraph, Error> {
4538
let ldk_data_dir = format!("{}/ldk", &config.storage_dir_path.clone());
4639
let network_graph_path = format!("{}/network_graph", ldk_data_dir.clone());
@@ -57,7 +50,7 @@ pub(crate) fn read_network_graph(
5750
}
5851

5952
pub(crate) fn read_scorer(
60-
config: Arc<LdkLiteConfig>, network_graph: Arc<NetworkGraph>, logger: Arc<FilesystemLogger>,
53+
config: Arc<Config>, network_graph: Arc<NetworkGraph>, logger: Arc<FilesystemLogger>,
6154
) -> Scorer {
6255
let ldk_data_dir = format!("{}/ldk", &config.storage_dir_path.clone());
6356
let scorer_path = format!("{}/scorer", ldk_data_dir.clone());

0 commit comments

Comments
 (0)