-
Notifications
You must be signed in to change notification settings - Fork 64
/
discv5.rs
740 lines (656 loc) · 26.6 KB
/
discv5.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
//! The Discovery v5 protocol. See the module level docs for further details.
//!
//! This provides the main struct for running and interfacing with a discovery v5 server.
//!
//! A [`Discv5`] struct needs to be created either with an [`crate::executor::Executor`] specified
//! in the [`Config`] via the [`crate::ConfigBuilder`] or in the presence of a tokio runtime that
//! has timing and io enabled.
//!
//! Once a [`Discv5`] struct has been created the service is started by running the [`Discv5::start`]
//! functions with a UDP socket. This will start a discv5 server in the background listening on the
//! specified UDP socket.
//!
//! The server can be shutdown using the [`Discv5::shutdown`] function.
use crate::{
error::{Error, QueryError, RequestError},
kbucket::{
self, ConnectionDirection, ConnectionState, FailureReason, InsertResult, KBucketsTable,
NodeStatus, UpdateResult,
},
node_info::NodeContact,
packet::ProtocolIdentity,
service::{QueryKind, Service, ServiceRequest, TalkRequest},
Config, DefaultProtocolId, Enr, IpMode,
};
use enr::{CombinedKey, EnrError, EnrKey, NodeId};
use parking_lot::RwLock;
use std::{
future::Future,
marker::PhantomData,
net::SocketAddr,
sync::Arc,
time::{Duration, Instant},
};
use tokio::sync::{mpsc, oneshot};
use tracing::{debug, warn};
#[cfg(feature = "libp2p")]
use libp2p::Multiaddr;
// Create lazy static variable for the global permit/ban list
use crate::{
metrics::{Metrics, METRICS},
service::Pong,
};
lazy_static! {
pub static ref PERMIT_BAN_LIST: RwLock<crate::PermitBanList> =
RwLock::new(crate::PermitBanList::default());
}
pub(crate) mod test;
/// Events that can be produced by the `Discv5` event stream.
#[derive(Debug)]
pub enum Event {
/// A node has been discovered from a FINDNODES request.
///
/// The ENR of the node is returned. Various properties can be derived from the ENR.
/// This happen spontaneously through queries as nodes return ENR's. These ENR's are not
/// guaranteed to be live or contactable.
Discovered(Enr),
/// A new ENR was added to the routing table.
EnrAdded { enr: Enr, replaced: Option<Enr> },
/// A new node has been added to the routing table.
NodeInserted {
node_id: NodeId,
replaced: Option<NodeId>,
},
/// A new session has been established with a node.
SessionEstablished(Enr, SocketAddr),
/// Our local ENR IP address has been updated.
SocketUpdated(SocketAddr),
/// A node has initiated a talk request.
TalkRequest(TalkRequest),
}
/// The main Discv5 Service struct. This provides the user-level API for performing queries and
/// interacting with the underlying service.
pub struct Discv5<P = DefaultProtocolId>
where
P: ProtocolIdentity,
{
config: Config,
/// The channel to make requests from the main service.
service_channel: Option<mpsc::Sender<ServiceRequest>>,
/// The exit channel to shutdown the underlying service.
service_exit: Option<oneshot::Sender<()>>,
/// The routing table of the discv5 service.
kbuckets: Arc<RwLock<KBucketsTable<NodeId, Enr>>>,
/// The local ENR of the server.
local_enr: Arc<RwLock<Enr>>,
/// The key associated with the local ENR, required for updating the local ENR.
enr_key: Arc<RwLock<CombinedKey>>,
// Type of socket we are using
ip_mode: IpMode,
/// Phantom for the protocol id.
_phantom: PhantomData<P>,
}
impl<P: ProtocolIdentity> Discv5<P> {
pub fn new(
local_enr: Enr,
enr_key: CombinedKey,
mut config: Config,
) -> Result<Self, &'static str> {
// ensure the keypair matches the one that signed the enr.
if local_enr.public_key() != enr_key.public() {
return Err("Provided keypair does not match the provided ENR");
}
// If an executor is not provided, assume a current tokio runtime is running. If not panic.
if config.executor.is_none() {
config.executor = Some(Box::<crate::executor::TokioExecutor>::default());
};
// NOTE: Currently we don't expose custom filter support in the configuration. Users can
// optionally use the IP filter via the ip_limit configuration parameter. In the future, we
// may expose this functionality to the users if there is demand for it.
let (table_filter, bucket_filter) = if config.ip_limit {
(
Some(Box::new(kbucket::IpTableFilter) as Box<dyn kbucket::Filter<Enr>>),
Some(Box::new(kbucket::IpBucketFilter) as Box<dyn kbucket::Filter<Enr>>),
)
} else {
(None, None)
};
let local_enr = Arc::new(RwLock::new(local_enr));
let enr_key = Arc::new(RwLock::new(enr_key));
let kbuckets = Arc::new(RwLock::new(KBucketsTable::new(
local_enr.read().node_id().into(),
Duration::from_secs(60),
config.incoming_bucket_limit,
table_filter,
bucket_filter,
)));
// Update the PermitBan list based on initial configuration
*PERMIT_BAN_LIST.write() = config.permit_ban_list.clone();
let ip_mode = IpMode::new_from_listen_config(&config.listen_config);
Ok(Discv5 {
config,
service_channel: None,
service_exit: None,
kbuckets,
local_enr,
enr_key,
ip_mode,
_phantom: Default::default(),
})
}
/// Starts the required tasks and begins listening on a given UDP SocketAddr.
pub async fn start(&mut self) -> Result<(), Error> {
if self.service_channel.is_some() {
warn!("Service is already started");
return Err(Error::ServiceAlreadyStarted);
}
// create the main service
let (service_exit, service_channel) = Service::spawn::<P>(
self.local_enr.clone(),
self.enr_key.clone(),
self.kbuckets.clone(),
self.config.clone(),
)
.await?;
self.service_exit = Some(service_exit);
self.service_channel = Some(service_channel);
Ok(())
}
/// Terminates the service.
pub fn shutdown(&mut self) {
if let Some(exit) = self.service_exit.take() {
if exit.send(()).is_err() {
debug!("Discv5 service already shutdown");
}
self.service_channel = None;
} else {
debug!("Service is already shutdown");
}
}
/// Adds a known ENR of a peer participating in Service to the
/// routing table.
///
/// This allows pre-populating the Kademlia routing table with known
/// addresses, so that they can be used immediately in following DHT
/// operations involving one of these peers, without having to dial
/// them upfront.
pub fn add_enr(&self, enr: Enr) -> Result<(), &'static str> {
// only add ENR's that have a valid udp socket.
if self.ip_mode.get_contactable_addr(&enr).is_none() {
warn!("ENR attempted to be added without an UDP socket compatible with configured IpMode has been ignored.");
return Err("ENR has no compatible UDP socket to connect to");
}
if !(self.config.table_filter)(&enr) {
warn!("ENR attempted to be added which is banned by the configuration table filter.");
return Err("ENR banned by table filter");
}
let key = kbucket::Key::from(enr.node_id());
match self.kbuckets.write().insert_or_update(
&key,
enr,
NodeStatus {
state: ConnectionState::Disconnected,
direction: ConnectionDirection::Incoming,
},
) {
InsertResult::Inserted
| InsertResult::Pending { .. }
| InsertResult::StatusUpdated { .. }
| InsertResult::ValueUpdated
| InsertResult::Updated { .. }
| InsertResult::UpdatedPending => Ok(()),
InsertResult::Failed(FailureReason::BucketFull) => Err("Table full"),
InsertResult::Failed(FailureReason::BucketFilter) => Err("Failed bucket filter"),
InsertResult::Failed(FailureReason::TableFilter) => Err("Failed table filter"),
InsertResult::Failed(FailureReason::InvalidSelfUpdate) => Err("Invalid self update"),
InsertResult::Failed(_) => Err("Failed to insert ENR"),
}
}
/// Removes a `node_id` from the routing table.
///
/// This allows applications, for whatever reason, to remove nodes from the local routing
/// table. Returns `true` if the node was in the table and `false` otherwise.
pub fn remove_node(&self, node_id: &NodeId) -> bool {
let key = &kbucket::Key::from(*node_id);
self.kbuckets.write().remove(key)
}
/// Returns a vector of closest nodes by the given distances.
pub fn nodes_by_distance(&self, mut distances: Vec<u64>) -> Vec<Enr> {
let mut nodes_to_send = Vec::new();
distances.sort_unstable();
distances.dedup();
if let Some(0) = distances.first() {
// if the distance is 0 send our local ENR
nodes_to_send.push(self.local_enr.read().clone());
distances.remove(0);
}
if !distances.is_empty() {
let mut kbuckets = self.kbuckets.write();
for node in kbuckets
.nodes_by_distances(distances.as_slice(), self.config.max_nodes_response)
.into_iter()
.map(|entry| entry.node.value.clone())
{
nodes_to_send.push(node);
}
}
nodes_to_send
}
/// Mark a node in the routing table as `Disconnected`.
///
/// A `Disconnected` node will be present in the routing table and will be only
/// used if there are no other `Connected` peers in the bucket.
/// Returns `true` if node was in table and `false` otherwise.
pub fn disconnect_node(&self, node_id: &NodeId) -> bool {
let key = &kbucket::Key::from(*node_id);
!matches!(
self.kbuckets
.write()
.update_node_status(key, ConnectionState::Disconnected, None),
UpdateResult::Failed(_)
)
}
/// Returns the number of connected peers that exist in the routing table.
pub fn connected_peers(&self) -> usize {
self.kbuckets
.write()
.iter()
.filter(|entry| entry.status.is_connected())
.count()
}
/// Gets the metrics associated with the Server
pub fn metrics(&self) -> Metrics {
Metrics::from(&METRICS)
}
/// Exposes the raw reference to the underlying internal metrics.
pub fn raw_metrics() -> &'static METRICS {
&METRICS
}
/// Returns the local ENR of the node.
pub fn local_enr(&self) -> Enr {
self.local_enr.read().clone()
}
/// Identical to `Discv5::local_enr` except that this exposes the `Arc` itself.
///
/// This is useful for synchronising views of the local ENR outside of `Discv5`.
pub fn external_enr(&self) -> Arc<RwLock<Enr>> {
self.local_enr.clone()
}
/// Returns the routing table of the discv5 service
pub fn kbuckets(&self) -> KBucketsTable<NodeId, Enr> {
self.kbuckets.read().clone()
}
/// Returns an ENR if one is known for the given NodeId.
pub fn find_enr(&self, node_id: &NodeId) -> Option<Enr> {
// check if we know this node id in our routing table
let key = kbucket::Key::from(*node_id);
if let kbucket::Entry::Present(entry, _) = self.kbuckets.write().entry(&key) {
return Some(entry.value().clone());
}
None
}
/// Sends a PING request to a node.
pub fn send_ping(
&self,
enr: Enr,
) -> impl Future<Output = Result<Pong, RequestError>> + 'static {
let (callback_send, callback_recv) = oneshot::channel();
let channel = self.clone_channel();
async move {
let channel = channel.map_err(|_| RequestError::ServiceNotStarted)?;
let event = ServiceRequest::Ping(enr, Some(callback_send));
// send the request
channel
.send(event)
.await
.map_err(|_| RequestError::ChannelFailed("Service channel closed".into()))?;
// await the response
callback_recv
.await
.map_err(|e| RequestError::ChannelFailed(e.to_string()))?
}
}
/// Bans a node from the server. This will remove the node from the routing table if it exists
/// and block all incoming packets from the node until the timeout specified. Setting the
/// timeout to `None` creates a permanent ban.
pub fn ban_node(&self, node_id: &NodeId, duration_of_ban: Option<Duration>) {
let time_to_unban = duration_of_ban.map(|v| Instant::now() + v);
self.remove_node(node_id);
PERMIT_BAN_LIST
.write()
.ban_nodes
.insert(*node_id, time_to_unban);
}
/// Removes a banned node from the banned list.
pub fn ban_node_remove(&self, node_id: &NodeId) {
PERMIT_BAN_LIST.write().ban_nodes.remove(node_id);
}
/// Permits a node, allowing the node to bypass the packet filter.
pub fn permit_node(&self, node_id: &NodeId) {
PERMIT_BAN_LIST.write().permit_nodes.insert(*node_id);
}
/// Removes a node from the permit list.
pub fn permit_node_remove(&self, node_id: &NodeId) {
PERMIT_BAN_LIST.write().permit_nodes.remove(node_id);
}
/// Bans an IP from the server. This will block all incoming packets from the IP.
pub fn ban_ip(&self, ip: std::net::IpAddr, duration_of_ban: Option<Duration>) {
let time_to_unban = duration_of_ban.map(|v| Instant::now() + v);
PERMIT_BAN_LIST.write().ban_ips.insert(ip, time_to_unban);
}
/// Removes a banned IP from the banned list.
pub fn ban_ip_remove(&self, ip: &std::net::IpAddr) {
PERMIT_BAN_LIST.write().ban_ips.remove(ip);
}
/// Permits an IP, allowing the all packets from the IP to bypass the packet filter.
pub fn permit_ip(&self, ip: std::net::IpAddr) {
PERMIT_BAN_LIST.write().permit_ips.insert(ip);
}
/// Removes an IP from the permit list.
pub fn permit_ip_remove(&self, ip: &std::net::IpAddr) {
PERMIT_BAN_LIST.write().permit_ips.remove(ip);
}
/// Updates the local ENR TCP/UDP socket.
pub fn update_local_enr_socket(&self, socket_addr: SocketAddr, is_tcp: bool) -> bool {
let mut local_enr = self.local_enr.write();
match (is_tcp, socket_addr) {
(false, SocketAddr::V4(specific_socket_addr)) => {
if Some(specific_socket_addr) != local_enr.udp4_socket() {
return local_enr
.set_udp_socket(socket_addr, &self.enr_key.read())
.is_ok();
}
}
(true, SocketAddr::V4(specific_socket_addr)) => {
if Some(specific_socket_addr) != local_enr.tcp4_socket() {
return local_enr
.set_tcp_socket(socket_addr, &self.enr_key.read())
.is_ok();
}
}
(false, SocketAddr::V6(specific_socket_addr)) => {
if Some(specific_socket_addr) != local_enr.udp6_socket() {
return local_enr
.set_udp_socket(socket_addr, &self.enr_key.read())
.is_ok();
}
}
(true, SocketAddr::V6(specific_socket_addr)) => {
if Some(specific_socket_addr) != local_enr.tcp6_socket() {
return local_enr
.set_tcp_socket(socket_addr, &self.enr_key.read())
.is_ok();
}
}
}
false
}
/// Allows application layer to insert an arbitrary field into the local ENR.
pub fn enr_insert<T: rlp::Encodable>(
&self,
key: &str,
value: &T,
) -> Result<Option<Vec<u8>>, EnrError> {
self.local_enr
.write()
.insert(key, value, &self.enr_key.read())
.map(|v| v.map(|v| v.to_vec()))
}
/// Returns an iterator over all ENR node IDs of nodes currently contained in the routing table.
pub fn table_entries_id(&self) -> Vec<NodeId> {
self.kbuckets
.write()
.iter()
.map(|entry| *entry.node.key.preimage())
.collect()
}
/// Takes only a read lock on the kbuckets. This means pending entries aren't added. Otherwise
/// same as [`Self::table_entries_id`]. Returns an iterator over all ENR node IDs of nodes
/// currently contained in the routing table.
pub fn table_entries_id_rlock(&self) -> Vec<NodeId> {
self.kbuckets
.read()
.iter_ref()
.map(|entry| *entry.node.key.preimage())
.collect()
}
/// Returns an iterator over all the ENR's of nodes currently contained in the routing table.
pub fn table_entries_enr(&self) -> Vec<Enr> {
self.kbuckets
.write()
.iter()
.map(|entry| entry.node.value.clone())
.collect()
}
/// Returns an iterator over all the entries in the routing table.
pub fn table_entries(&self) -> Vec<(NodeId, Enr, NodeStatus)> {
self.kbuckets
.write()
.iter()
.map(|entry| {
(
*entry.node.key.preimage(),
entry.node.value.clone(),
entry.status,
)
})
.collect()
}
/// Takes only a read lock on the kbuckets. This means pending entries aren't added. Otherwise
/// same as [`Self::table_entries`]. Returns an iterator over all ENR node IDs of nodes
/// currently contained in the routing table.
pub fn table_entries_rlock(&self) -> Vec<(NodeId, Enr, NodeStatus)> {
self.kbuckets
.read()
.iter_ref()
.map(|entry| {
(
*entry.node.key.preimage(),
entry.node.value.clone(),
entry.status,
)
})
.collect()
}
/// Requests the ENR of a node corresponding to multiaddr or multi-addr string.
///
/// Only `ed25519` and `secp256k1` key types are currently supported.
///
/// Note: The async syntax is forgone here in order to create `'static` futures, where the
/// underlying sending channel is cloned.
#[cfg(feature = "libp2p")]
#[cfg_attr(docsrs, doc(cfg(feature = "libp2p")))]
pub fn request_enr(
&self,
multiaddr: impl std::convert::TryInto<Multiaddr> + 'static,
) -> impl Future<Output = Result<Enr, RequestError>> + 'static {
let channel = self.clone_channel();
async move {
let channel = channel.map_err(|_| RequestError::ServiceNotStarted)?;
// Sanitize the multiaddr
// The multiaddr must support the udp protocol and be of an appropriate key type.
// The conversion logic is contained in the `TryFrom<MultiAddr>` implementation of a
// `NodeContact`.
let multiaddr: Multiaddr = multiaddr
.try_into()
.map_err(|_| RequestError::InvalidMultiaddr("Could not convert to multiaddr"))?;
let node_contact: NodeContact = NodeContact::try_from_multiaddr(multiaddr)
.map_err(RequestError::InvalidMultiaddr)?;
let (callback_send, callback_recv) = oneshot::channel();
let event =
ServiceRequest::FindNodeDesignated(node_contact.clone(), vec![0], callback_send);
// send the request
channel
.send(event)
.await
.map_err(|_| RequestError::ChannelFailed("Service channel closed".into()))?;
// await the response
match callback_recv
.await
.map_err(|e| RequestError::ChannelFailed(e.to_string()))?
{
Ok(mut nodes) => {
// This must be for asking for an ENR
if nodes.len() > 1 {
warn!(
"Peer returned more than one ENR for itself. {}",
node_contact
);
}
nodes
.pop()
.ok_or(RequestError::InvalidEnr("Peer did not return an ENR"))
}
Err(err) => Err(err),
}
}
}
/// Request a TALK message from a node, identified via the ENR.
pub fn talk_req(
&self,
enr: Enr,
protocol: Vec<u8>,
request: Vec<u8>,
) -> impl Future<Output = Result<Vec<u8>, RequestError>> + 'static {
// convert the ENR to a node_contact.
let (callback_send, callback_recv) = oneshot::channel();
let channel = self.clone_channel();
let ip_mode = self.ip_mode;
async move {
let node_contact = NodeContact::try_from_enr(enr, ip_mode)?;
let channel = channel.map_err(|_| RequestError::ServiceNotStarted)?;
let event = ServiceRequest::Talk(node_contact, protocol, request, callback_send);
// send the request
channel
.send(event)
.await
.map_err(|_| RequestError::ChannelFailed("Service channel closed".into()))?;
// await the response
callback_recv
.await
.map_err(|e| RequestError::ChannelFailed(e.to_string()))?
}
}
/// Send a FINDNODE request for nodes that fall within the given set of distances,
/// to the designated peer and wait for a response.
pub fn find_node_designated_peer(
&self,
enr: Enr,
distances: Vec<u64>,
) -> impl Future<Output = Result<Vec<Enr>, RequestError>> + 'static {
let (callback_send, callback_recv) = oneshot::channel();
let channel = self.clone_channel();
let ip_mode = self.ip_mode;
async move {
let node_contact = NodeContact::try_from_enr(enr, ip_mode)?;
let channel = channel.map_err(|_| RequestError::ServiceNotStarted)?;
let event = ServiceRequest::FindNodeDesignated(node_contact, distances, callback_send);
// send the request
channel
.send(event)
.await
.map_err(|_| RequestError::ChannelFailed("Service channel closed".into()))?;
// await the response
callback_recv
.await
.map_err(|e| RequestError::ChannelFailed(e.to_string()))?
}
}
/// Runs an iterative `FIND_NODE` request.
///
/// This will return peers containing contactable nodes of the DHT closest to the
/// requested `NodeId`.
///
/// Note: The async syntax is forgone here in order to create `'static` futures, where the
/// underlying sending channel is cloned.
pub fn find_node(
&self,
target_node: NodeId,
) -> impl Future<Output = Result<Vec<Enr>, QueryError>> + 'static {
let channel = self.clone_channel();
async move {
let channel = channel.map_err(|_| QueryError::ServiceNotStarted)?;
let (callback_send, callback_recv) = oneshot::channel();
let query_kind = QueryKind::FindNode { target_node };
let event = ServiceRequest::StartQuery(query_kind, callback_send);
channel
.send(event)
.await
.map_err(|_| QueryError::ChannelFailed("Service channel closed".into()))?;
callback_recv
.await
.map_err(|e| QueryError::ChannelFailed(e.to_string()))
}
}
/// Starts a `FIND_NODE` request.
///
/// This will return less than or equal to `num_nodes` ENRs which satisfy the
/// `predicate`.
///
/// The predicate is a boxed function that takes an ENR reference and returns a boolean
/// indicating if the record is applicable to the query or not.
///
/// Note: The async syntax is forgone here in order to create `'static` futures, where the
/// underlying sending channel is cloned.
///
/// ### Example
/// ```ignore
/// let predicate = Box::new(|enr: &Enr| enr.ip().is_some());
/// let target = NodeId::random();
/// let result = discv5.find_node_predicate(target, predicate, 5).await;
/// ```
pub fn find_node_predicate(
&self,
target_node: NodeId,
predicate: Box<dyn Fn(&Enr) -> bool + Send>,
target_peer_no: usize,
) -> impl Future<Output = Result<Vec<Enr>, QueryError>> + 'static {
let channel = self.clone_channel();
async move {
let channel = channel.map_err(|_| QueryError::ServiceNotStarted)?;
let (callback_send, callback_recv) = oneshot::channel();
let query_kind = QueryKind::Predicate {
target_node,
predicate,
target_peer_no,
};
let event = ServiceRequest::StartQuery(query_kind, callback_send);
channel
.send(event)
.await
.map_err(|_| QueryError::ChannelFailed("Service channel closed".into()))?;
callback_recv
.await
.map_err(|e| QueryError::ChannelFailed(e.to_string()))
}
}
/// Creates an event stream channel which can be polled to receive Discv5 events.
pub fn event_stream(
&self,
) -> impl Future<Output = Result<mpsc::Receiver<Event>, Error>> + 'static {
let channel = self.clone_channel();
async move {
let channel = channel?;
let (callback_send, callback_recv) = oneshot::channel();
let event = ServiceRequest::RequestEventStream(callback_send);
channel
.send(event)
.await
.map_err(|_| Error::ServiceChannelClosed)?;
callback_recv.await.map_err(|_| Error::ServiceChannelClosed)
}
}
/// Internal helper function to send events to the Service.
fn clone_channel(&self) -> Result<mpsc::Sender<ServiceRequest>, Error> {
if let Some(channel) = self.service_channel.as_ref() {
Ok(channel.clone())
} else {
Err(Error::ServiceNotStarted)
}
}
}
impl<P: ProtocolIdentity> Drop for Discv5<P> {
fn drop(&mut self) {
self.shutdown();
}
}