File tree Expand file tree Collapse file tree 1 file changed +10
-0
lines changed
lightning-rapid-gossip-sync Expand file tree Collapse file tree 1 file changed +10
-0
lines changed Original file line number Diff line number Diff line change @@ -4,6 +4,16 @@ This crate exposes functionality for rapid gossip graph syncing, aimed primarily
4
4
Its server counterpart is the
5
5
[ rapid-gossip-sync-server] ( https://github.com/lightningdevkit/rapid-gossip-sync-server ) repository.
6
6
7
+ ## Usage
8
+
9
+ To kick off Rapid Gossip Sync from the beginning, retrieve a snapshot from an RGS server instance with the initial
10
+ timestamp being 0.
11
+
12
+ Applying that snapshot using the ` RapidGossipSync ` instance will extract and retrieve the subsequent timestamp to
13
+ request from the server instance. The methods ` sync_network_graph_with_file_path ` , ` update_network_graph ` , and
14
+ ` update_network_graph_no_std ` all return a ` Result<u32, GraphSyncError> ` , and that ` u32 ` success value
15
+ is the timestamp meant to be used for the next server request.
16
+
7
17
## Mechanism
8
18
9
19
The (presumed) server sends a compressed gossip response containing gossip data. The gossip data is
You can’t perform that action at this time.
0 commit comments