mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-03-15 15:39:09 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update rapid-gossip-sync docs to not reference std-only methods

Browse source
This commit is contained in:
Matt Corallo 2022-10-06 19:38:17 +00:00
parent f9acac8fec
commit 3852d52801
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lightning-rapid-gossip-sync/src/lib.rs
View file

@ -38,7 +38,7 @@
//!
//! After the gossip data snapshot has been downloaded, one of the client's graph processing
//! functions needs to be called. In this example, we process the update by reading its contents
//! from disk, which we do by calling [sync_network_graph_with_file_path]:
//! from disk, which we do by calling [`RapidGossipSync::update_network_graph`]:
//!
//! ```
//! use bitcoin::blockdata::constants::genesis_block;
@ -56,9 +56,9 @@
//! let block_hash = genesis_block(Network::Bitcoin).header.block_hash();
//! let network_graph = NetworkGraph::new(block_hash, &logger);
//! let rapid_sync = RapidGossipSync::new(&network_graph);
//! let new_last_sync_timestamp_result = rapid_sync.sync_network_graph_with_file_path("./rapid_sync.lngossip");
//! let snapshot_contents: &[u8] = &[0; 0];
//! let new_last_sync_timestamp_result = rapid_sync.update_network_graph(snapshot_contents);
//! ```
//! [sync_network_graph_with_file_path]: RapidGossipSync::sync_network_graph_with_file_path
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]