Skip to content

Commit

Permalink
Merge pull request lightningdevkit#3421 from arik-so/rgs-cache-doc
Browse files Browse the repository at this point in the history
Expand on RGS caching requirements
  • Loading branch information
TheBlueMatt authored Nov 25, 2024
2 parents 2d6720e + 144340b commit ba3d4ff
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions lightning-rapid-gossip-sync/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ request from the server instance. The methods `sync_network_graph_with_file_path
`update_network_graph_no_std` all return a `Result<u32, GraphSyncError>`, and that `u32` success value
is the timestamp meant to be used for the next server request.

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

## Mechanism

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

0 comments on commit ba3d4ff

Please sign in to comment.