Skip to content

Commit ba3d4ff

Browse files
authored
Merge pull request #3421 from arik-so/rgs-cache-doc
Expand on RGS caching requirements
2 parents 2d6720e + 144340b commit ba3d4ff

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

lightning-rapid-gossip-sync/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ request from the server instance. The methods `sync_network_graph_with_file_path
1414
`update_network_graph_no_std` all return a `Result<u32, GraphSyncError>`, and that `u32` success value
1515
is the timestamp meant to be used for the next server request.
1616

17+
Note that running those methods also updates the timestamp stored in the `NetworkGraph` object, whence it can be easily
18+
retrieved by calling `get_last_rapid_gossip_sync_timestamp`, so using RGS does not impose any additional caching
19+
requirements beyond those already used for storing the network graph.
20+
1721
## Mechanism
1822

1923
The (presumed) server sends a compressed gossip response containing gossip data. The gossip data is

0 commit comments

Comments
 (0)