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
// Copyright 2023 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under The General Public License (GPL), version 3.
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. Please review the Licences for the specific language governing
// permissions and limitations relating to use of the SAFE Network Software.
use crate::{
driver::{PendingGetClosestType, SwarmDriver},
error::{Error, Result},
multiaddr_pop_p2p, sort_peers_by_address, GetRecordCfg, GetRecordError, MsgResponder,
NetworkEvent, CLOSE_GROUP_SIZE, REPLICATE_RANGE,
};
use bytes::Bytes;
use libp2p::{
kad::{store::RecordStore, Quorum, Record, RecordKey},
swarm::dial_opts::DialOpts,
Multiaddr, PeerId,
};
use sn_protocol::{
messages::{Request, Response},
storage::{RecordHeader, RecordKind, RecordType},
NetworkAddress, PrettyPrintRecordKey,
};
use sn_transfers::NanoTokens;
use std::{
collections::{BTreeMap, HashMap},
fmt::Debug,
};
use tokio::sync::oneshot;
use xor_name::XorName;
/// Commands to send to the Swarm
#[allow(clippy::large_enum_variant)]
pub enum SwarmCmd {
StartListening {
addr: Multiaddr,
sender: oneshot::Sender<Result<()>>,
},
Dial {
addr: Multiaddr,
sender: oneshot::Sender<Result<()>>,
},
DialWithOpts {
opts: DialOpts,
sender: oneshot::Sender<Result<()>>,
},
// Returns all the peers from all the k-buckets from the local Routing Table.
// This includes our PeerId as well.
GetAllLocalPeers {
sender: oneshot::Sender<Vec<PeerId>>,
},
/// Get a map where each key is the ilog2 distance of that Kbucket and each value is a vector of peers in that
/// bucket.
GetKBuckets {
sender: oneshot::Sender<BTreeMap<u32, Vec<PeerId>>>,
},
// Returns up to K_VALUE peers from all the k-buckets from the local Routing Table.
// And our PeerId as well.
GetClosestKLocalPeers {
sender: oneshot::Sender<Vec<PeerId>>,
},
// Get closest peers from the network
GetClosestPeersToAddressFromNetwork {
key: NetworkAddress,
sender: oneshot::Sender<Vec<PeerId>>,
},
// Get closest peers from the local RoutingTable
GetCloseGroupLocalPeers {
key: NetworkAddress,
sender: oneshot::Sender<Vec<PeerId>>,
},
GetSwarmLocalState(oneshot::Sender<SwarmLocalState>),
// Send Request to the PeerId.
SendRequest {
req: Request,
peer: PeerId,
// If a `sender` is provided, the requesting node will await for a `Response` from the
// Peer. The result is then returned at the call site.
//
// If a `sender` is not provided, the requesting node will not wait for the Peer's
// response. Instead we trigger a `NetworkEvent::ResponseReceived` which calls the common
// `response_handler`
sender: Option<oneshot::Sender<Result<Response>>>,
},
SendResponse {
resp: Response,
channel: MsgResponder,
},
/// Check if the local RecordStore contains the provided key
RecordStoreHasKey {
key: RecordKey,
sender: oneshot::Sender<bool>,
},
/// Get the Addresses of all the Records held locally
GetAllLocalRecordAddresses {
sender: oneshot::Sender<HashMap<NetworkAddress, RecordType>>,
},
/// Get Record from the Kad network
GetNetworkRecord {
key: RecordKey,
sender: oneshot::Sender<std::result::Result<Record, GetRecordError>>,
cfg: GetRecordCfg,
},
/// GetLocalStoreCost for this node
GetLocalStoreCost {
sender: oneshot::Sender<NanoTokens>,
},
/// Get data from the local RecordStore
GetLocalRecord {
key: RecordKey,
sender: oneshot::Sender<Option<Record>>,
},
/// Put record to network
PutRecord {
record: Record,
sender: oneshot::Sender<Result<()>>,
quorum: Quorum,
},
/// Put record to the local RecordStore
PutLocalRecord {
record: Record,
},
/// Remove a local record from the RecordStore
/// Typically because the write failed
RemoveFailedLocalRecord {
key: RecordKey,
},
/// Add a local record to the RecordStore's HashSet of stored records
/// This should be done after the record has been stored to disk
AddLocalRecordAsStored {
key: RecordKey,
record_type: RecordType,
},
/// The keys added to the replication fetcher are later used to fetch the Record from network
AddKeysToReplicationFetcher {
holder: PeerId,
keys: HashMap<NetworkAddress, RecordType>,
},
/// Subscribe to a given Gossipsub topic
GossipsubSubscribe(String),
/// Unsubscribe from a given Gossipsub topic
GossipsubUnsubscribe(String),
/// Publish a message through Gossipsub protocol
GossipsubPublish {
/// Topic to publish on
topic_id: String,
/// Raw bytes of the message to publish
msg: Bytes,
},
GossipHandler,
}
/// Debug impl for SwarmCmd to avoid printing full Record, instead only RecodKey
/// and RecordKind are printed.
impl Debug for SwarmCmd {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
SwarmCmd::StartListening { addr, .. } => {
write!(f, "SwarmCmd::StartListening {{ addr: {addr:?} }}")
}
SwarmCmd::Dial { addr, .. } => {
write!(f, "SwarmCmd::Dial {{ addr: {addr:?} }}")
}
SwarmCmd::GetNetworkRecord { key, cfg, .. } => {
write!(
f,
"SwarmCmd::GetNetworkRecord {{ key: {:?}, cfg: {cfg:?}",
PrettyPrintRecordKey::from(key)
)
}
SwarmCmd::PutRecord { record, .. } => {
write!(
f,
"SwarmCmd::PutRecord {{ key: {:?} }}",
PrettyPrintRecordKey::from(&record.key)
)
}
SwarmCmd::PutLocalRecord { record } => {
write!(
f,
"SwarmCmd::PutLocalRecord {{ key: {:?} }}",
PrettyPrintRecordKey::from(&record.key)
)
}
SwarmCmd::RemoveFailedLocalRecord { key } => {
write!(
f,
"SwarmCmd::RemoveFailedLocalRecord {{ key: {:?} }}",
PrettyPrintRecordKey::from(key)
)
}
SwarmCmd::AddLocalRecordAsStored { key, record_type } => {
write!(
f,
"SwarmCmd::AddLocalRecordAsStored {{ key: {:?}, record_type: {record_type:?} }}",
PrettyPrintRecordKey::from(key)
)
}
SwarmCmd::AddKeysToReplicationFetcher { holder, keys } => {
write!(
f,
"SwarmCmd::AddKeysToReplicationFetcher {{ holder: {holder:?}, keys_len: {:?} }}",
keys.len()
)
}
SwarmCmd::GossipsubSubscribe(topic) => {
write!(f, "SwarmCmd::GossipsubSubscribe({topic:?})")
}
SwarmCmd::GossipsubUnsubscribe(topic) => {
write!(f, "SwarmCmd::GossipsubUnsubscribe({topic:?})")
}
SwarmCmd::GossipsubPublish { topic_id, msg } => {
write!(
f,
"SwarmCmd::GossipsubPublish {{ topic_id: {topic_id:?}, msg len: {:?} }}",
msg.len()
)
}
SwarmCmd::DialWithOpts { opts, .. } => {
write!(f, "SwarmCmd::DialWithOpts {{ opts: {opts:?} }}")
}
SwarmCmd::GetClosestPeersToAddressFromNetwork { key, .. } => {
write!(f, "SwarmCmd::GetClosestPeers {{ key: {key:?} }}")
}
SwarmCmd::GetClosestKLocalPeers { .. } => {
write!(f, "SwarmCmd::GetClosestKLocalPeers")
}
SwarmCmd::GetCloseGroupLocalPeers { key, .. } => {
write!(f, "SwarmCmd::GetCloseGroupLocalPeers {{ key: {key:?} }}")
}
SwarmCmd::GetLocalStoreCost { .. } => {
write!(f, "SwarmCmd::GetLocalStoreCost")
}
SwarmCmd::GetLocalRecord { key, .. } => {
write!(
f,
"SwarmCmd::GetLocalRecord {{ key: {:?} }}",
PrettyPrintRecordKey::from(key)
)
}
SwarmCmd::GetAllLocalRecordAddresses { .. } => {
write!(f, "SwarmCmd::GetAllLocalRecordAddresses")
}
SwarmCmd::GetAllLocalPeers { .. } => {
write!(f, "SwarmCmd::GetAllLocalPeers")
}
SwarmCmd::GetKBuckets { .. } => {
write!(f, "SwarmCmd::GetKBuckets")
}
SwarmCmd::GetSwarmLocalState { .. } => {
write!(f, "SwarmCmd::GetSwarmLocalState")
}
SwarmCmd::RecordStoreHasKey { key, .. } => {
write!(
f,
"SwarmCmd::RecordStoreHasKey {:?}",
PrettyPrintRecordKey::from(key)
)
}
SwarmCmd::SendResponse { resp, .. } => {
write!(f, "SwarmCmd::SendResponse resp: {resp:?}")
}
SwarmCmd::SendRequest { req, peer, .. } => {
write!(f, "SwarmCmd::SendRequest req: {req:?}, peer: {peer:?}")
}
SwarmCmd::GossipHandler => {
write!(f, "SwarmCmd::GossipHandler")
}
}
}
}
/// Snapshot of information kept in the Swarm's local state
#[derive(Debug, Clone)]
pub struct SwarmLocalState {
/// List of currently connected peers
pub connected_peers: Vec<PeerId>,
/// List of addresses the node is currently listening on
pub listeners: Vec<Multiaddr>,
}
impl SwarmDriver {
/// Checks suggested records against what we hold, so we only
/// enqueue what we do not have
#[allow(clippy::mutable_key_type)] // for Bytes in NetworkAddress
fn select_non_existent_records_for_replications(
&mut self,
incoming_keys: &HashMap<NetworkAddress, RecordType>,
) -> Vec<(NetworkAddress, RecordType)> {
#[allow(clippy::mutable_key_type)]
let locally_stored_keys = self
.swarm
.behaviour_mut()
.kademlia
.store_mut()
.record_addresses_ref();
let non_existent_keys: Vec<_> = incoming_keys
.iter()
.filter(|(addr, record_type)| {
let key = addr.to_record_key();
let local = locally_stored_keys.get(&key);
// if we have a local value of matching record_type, we don't need to fetch it
if let Some((_, local_record_type)) = local {
&local_record_type != record_type
} else {
true
}
})
.collect();
let closest_k_peers = self.get_closest_k_value_local_peers();
non_existent_keys
.into_iter()
.filter_map(|(key, record_type)| {
if self.is_in_close_range(key, &closest_k_peers) {
Some((key.clone(), record_type.clone()))
} else {
warn!("not in close range for key {key:?}");
None
}
})
.collect()
}
pub(crate) fn handle_cmd(&mut self, cmd: SwarmCmd) -> Result<(), Error> {
match cmd {
SwarmCmd::AddKeysToReplicationFetcher { holder, keys } => {
// Only handle those non-exist and in close range keys
let keys_to_store = self.select_non_existent_records_for_replications(&keys);
if keys_to_store.is_empty() {
debug!("Empty keys to store after adding to");
return Ok(());
}
#[allow(clippy::mutable_key_type)]
let all_keys = self
.swarm
.behaviour_mut()
.kademlia
.store_mut()
.record_addresses_ref();
let keys_to_fetch =
self.replication_fetcher
.add_keys(holder, keys_to_store, all_keys);
if !keys_to_fetch.is_empty() {
self.send_event(NetworkEvent::KeysToFetchForReplication(keys_to_fetch));
} else {
trace!("no waiting keys to fetch from the network");
}
}
SwarmCmd::GetNetworkRecord { key, sender, cfg } => {
let query_id = self.swarm.behaviour_mut().kademlia.get_record(key.clone());
debug!(
"Record {:?} with task {query_id:?} expected to be held by {:?}",
PrettyPrintRecordKey::from(&key),
cfg.expected_holders
);
if self
.pending_get_record
.insert(query_id, (sender, Default::default(), cfg))
.is_some()
{
warn!("An existing get_record task {query_id:?} got replaced");
}
// Logging the status of the `pending_get_record`.
// We also interested in the status of `result_map` (which contains record) inside.
let total_records: usize = self
.pending_get_record
.iter()
.map(|(_, (_, result_map, _))| result_map.len())
.sum();
trace!("We now have {} pending get record attempts and cached {total_records} fetched copies",
self.pending_get_record.len());
}
SwarmCmd::GetLocalStoreCost { sender } => {
let cost = self.swarm.behaviour_mut().kademlia.store_mut().store_cost();
let _res = sender.send(cost);
}
SwarmCmd::GetLocalRecord { key, sender } => {
let record = self
.swarm
.behaviour_mut()
.kademlia
.store_mut()
.get(&key)
.map(|rec| rec.into_owned());
let _ = sender.send(record);
}
SwarmCmd::PutRecord {
record,
sender,
quorum,
} => {
let record_key = PrettyPrintRecordKey::from(&record.key).into_owned();
trace!(
"Putting record sized: {:?} to network {:?}",
record.value.len(),
record_key
);
let res = match self
.swarm
.behaviour_mut()
.kademlia
.put_record(record, quorum)
{
Ok(request_id) => {
trace!("Sent record {record_key:?} to network. Request id: {request_id:?} to network");
Ok(())
}
Err(error) => {
error!("Error sending record {record_key:?} to network");
Err(Error::from(error))
}
};
if let Err(err) = sender.send(res) {
error!("Could not send response to PutRecord cmd: {:?}", err);
}
}
SwarmCmd::PutLocalRecord { record } => {
let key = record.key.clone();
let record_key = PrettyPrintRecordKey::from(&key);
let record_type = match RecordHeader::from_record(&record) {
Ok(record_header) => {
match record_header.kind {
RecordKind::Chunk => RecordType::Chunk,
RecordKind::Spend | RecordKind::Register => {
let content_hash = XorName::from_content(&record.value);
RecordType::NonChunk(content_hash)
}
RecordKind::ChunkWithPayment | RecordKind::RegisterWithPayment => {
error!("Record {record_key:?} with payment shall not be stored locally.");
return Err(Error::InCorrectRecordHeader);
}
}
}
Err(err) => {
error!("For record {record_key:?}, failed to parse record_header {err:?}");
return Err(Error::InCorrectRecordHeader);
}
};
match self
.swarm
.behaviour_mut()
.kademlia
.store_mut()
.put_verified(record, record_type.clone())
{
Ok(_) => {
let new_keys_to_fetch = self
.replication_fetcher
.notify_about_new_put(key, record_type);
if !new_keys_to_fetch.is_empty() {
self.send_event(NetworkEvent::KeysToFetchForReplication(
new_keys_to_fetch,
));
}
}
Err(err) => return Err(err.into()),
};
}
SwarmCmd::AddLocalRecordAsStored { key, record_type } => self
.swarm
.behaviour_mut()
.kademlia
.store_mut()
.mark_as_stored(key, record_type),
SwarmCmd::RemoveFailedLocalRecord { key } => {
self.swarm.behaviour_mut().kademlia.store_mut().remove(&key)
}
SwarmCmd::RecordStoreHasKey { key, sender } => {
let has_key = self
.swarm
.behaviour_mut()
.kademlia
.store_mut()
.contains(&key);
let _ = sender.send(has_key);
}
SwarmCmd::GetAllLocalRecordAddresses { sender } => {
#[allow(clippy::mutable_key_type)] // for the Bytes in NetworkAddress
let addresses = self
.swarm
.behaviour_mut()
.kademlia
.store_mut()
.record_addresses();
let _ = sender.send(addresses);
}
SwarmCmd::StartListening { addr, sender } => {
let _ = match self.swarm.listen_on(addr) {
Ok(_) => sender.send(Ok(())),
Err(e) => sender.send(Err(e.into())),
};
}
SwarmCmd::Dial { addr, sender } => {
let mut addr_copy = addr.clone();
if let Some(peer_id) = multiaddr_pop_p2p(&mut addr_copy) {
// Only consider the dial peer is bootstrap node when proper PeerId is provided.
if let Some(kbucket) = self.swarm.behaviour_mut().kademlia.kbucket(peer_id) {
let ilog2 = kbucket.range().0.ilog2();
let peers = self.bootstrap_peers.entry(ilog2).or_default();
peers.insert(peer_id);
}
}
let _ = match self.dial(addr) {
Ok(_) => sender.send(Ok(())),
Err(e) => sender.send(Err(e.into())),
};
}
SwarmCmd::DialWithOpts { opts, sender } => {
let _ = match self.dial_with_opts(opts) {
Ok(_) => sender.send(Ok(())),
Err(e) => sender.send(Err(e.into())),
};
}
SwarmCmd::GetClosestPeersToAddressFromNetwork { key, sender } => {
let query_id = self
.swarm
.behaviour_mut()
.kademlia
.get_closest_peers(key.as_bytes());
let _ = self.pending_get_closest_peers.insert(
query_id,
(
PendingGetClosestType::FunctionCall(sender),
Default::default(),
),
);
}
SwarmCmd::GetAllLocalPeers { sender } => {
let _ = sender.send(self.get_all_local_peers());
}
SwarmCmd::GetKBuckets { sender } => {
let mut ilog2_kbuckets = BTreeMap::new();
for kbucket in self.swarm.behaviour_mut().kademlia.kbuckets() {
let range = kbucket.range();
if let Some(distance) = range.0.ilog2() {
let peers_in_kbucket = kbucket
.iter()
.map(|peer_entry| peer_entry.node.key.clone().into_preimage())
.collect::<Vec<PeerId>>();
let _ = ilog2_kbuckets.insert(distance, peers_in_kbucket);
} else {
// This shall never happen.
error!("bucket is ourself ???!!!");
}
}
let _ = sender.send(ilog2_kbuckets);
}
SwarmCmd::GetCloseGroupLocalPeers { key, sender } => {
let key = key.as_kbucket_key();
// calls `kbuckets.closest_keys(key)` internally, which orders the peers by
// increasing distance
// Note it will return all peers, heance a chop down is required.
let closest_peers = self
.swarm
.behaviour_mut()
.kademlia
.get_closest_local_peers(&key)
.map(|peer| peer.into_preimage())
.take(CLOSE_GROUP_SIZE)
.collect();
let _ = sender.send(closest_peers);
}
SwarmCmd::GetClosestKLocalPeers { sender } => {
let _ = sender.send(self.get_closest_k_value_local_peers());
}
SwarmCmd::SendRequest { req, peer, sender } => {
// If `self` is the recipient, forward the request directly to our upper layer to
// be handled.
// `self` then handles the request and sends a response back again to itself.
if peer == *self.swarm.local_peer_id() {
trace!("Sending query request to self");
if let Request::Query(query) = req {
self.send_event(NetworkEvent::QueryRequestReceived {
query,
channel: MsgResponder::FromSelf(sender),
});
} else {
// We should never receive a Replicate request from ourselves.
// we already hold this data if we do... so we can ignore
trace!("Replicate cmd to self received, ignoring");
}
} else {
let request_id = self
.swarm
.behaviour_mut()
.request_response
.send_request(&peer, req);
trace!("Sending request {request_id:?} to peer {peer:?}");
let _ = self.pending_requests.insert(request_id, sender);
trace!("Pending Requests now: {:?}", self.pending_requests.len());
}
}
SwarmCmd::SendResponse { resp, channel } => match channel {
// If the response is for `self`, send it directly through the oneshot channel.
MsgResponder::FromSelf(channel) => {
trace!("Sending response to self");
match channel {
Some(channel) => {
channel
.send(Ok(resp))
.map_err(|_| Error::InternalMsgChannelDropped)?;
}
None => {
// responses that are not awaited at the call site must be handled
// separately
self.send_event(NetworkEvent::ResponseReceived { res: resp });
}
}
}
MsgResponder::FromPeer(channel) => {
self.swarm
.behaviour_mut()
.request_response
.send_response(channel, resp)
.map_err(Error::OutgoingResponseDropped)?;
}
},
SwarmCmd::GetSwarmLocalState(sender) => {
let current_state = SwarmLocalState {
connected_peers: self.swarm.connected_peers().cloned().collect(),
listeners: self.swarm.listeners().cloned().collect(),
};
sender
.send(current_state)
.map_err(|_| Error::InternalMsgChannelDropped)?;
}
SwarmCmd::GossipsubSubscribe(topic_id) => {
let topic_id = libp2p::gossipsub::IdentTopic::new(topic_id);
if let Some(gossip) = self.swarm.behaviour_mut().gossipsub.as_mut() {
gossip.subscribe(&topic_id)?;
}
}
SwarmCmd::GossipsubUnsubscribe(topic_id) => {
let topic_id = libp2p::gossipsub::IdentTopic::new(topic_id);
if let Some(gossip) = self.swarm.behaviour_mut().gossipsub.as_mut() {
gossip.unsubscribe(&topic_id)?;
}
}
SwarmCmd::GossipsubPublish { topic_id, msg } => {
// If we publish a Gossipsub message, we might not receive the same message on our side.
// Hence push an event to notify that we've published a message
if self.is_gossip_handler {
self.send_event(NetworkEvent::GossipsubMsgPublished {
topic: topic_id.clone(),
msg: msg.clone(),
});
}
let topic_id = libp2p::gossipsub::IdentTopic::new(topic_id);
if let Some(gossip) = self.swarm.behaviour_mut().gossipsub.as_mut() {
gossip.publish(topic_id, msg)?;
}
}
SwarmCmd::GossipHandler => {
self.is_gossip_handler = true;
}
}
Ok(())
}
// A close target doesn't falls into the close peers range:
// For example, a node b11111X has an RT: [(1, b1111), (2, b111), (5, b11), (9, b1), (7, b0)]
// Then for a target bearing b011111 as prefix, all nodes in (7, b0) are its close_group peers.
// Then the node b11111X. But b11111X's close_group peers [(1, b1111), (2, b111), (5, b11)]
// are none among target b011111's close range.
// Hence, the ilog2 calculation based on close_range cannot cover such case.
// And have to sort all nodes to figure out whether self is among the close_group to the target.
fn is_in_close_range(&self, target: &NetworkAddress, all_peers: &Vec<PeerId>) -> bool {
if all_peers.len() <= REPLICATE_RANGE {
return true;
}
// Margin of 2 to allow our RT being bit lagging.
match sort_peers_by_address(all_peers, target, REPLICATE_RANGE) {
Ok(close_group) => close_group.contains(&&self.self_peer_id),
Err(err) => {
warn!("Could not get sorted peers for {target:?} with error {err:?}");
true
}
}
}
}