projects
/
rust-lightning
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
f9acac8
)
Update `rapid-gossip-sync` docs to not reference `std`-only methods
author
Matt Corallo
<git@bluematt.me>
Thu, 6 Oct 2022 19:38:17 +0000
(19:38 +0000)
committer
Matt Corallo
<git@bluematt.me>
Thu, 6 Oct 2022 23:59:30 +0000
(23:59 +0000)
lightning-rapid-gossip-sync/src/lib.rs
patch
|
blob
|
history
diff --git
a/lightning-rapid-gossip-sync/src/lib.rs
b/lightning-rapid-gossip-sync/src/lib.rs
index b3d1f0133dd37822c50ee722e6701cad74df0738..06ce7eb2075574df38c2b9cbf44813235e1fba1c 100644
(file)
--- a/
lightning-rapid-gossip-sync/src/lib.rs
+++ b/
lightning-rapid-gossip-sync/src/lib.rs
@@
-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
//!
//! 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;
//!
//! ```
//! 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 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)]
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]