mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-01-18 21:34:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document RGS timestamp usage.

Browse Source
This commit is contained in:
Arik Sosman 2024-11-21 08:24:14 -08:00
parent 8da30df223
commit f6a9078150
No known key found for this signature in database
GPG Key ID: CFF795E7811C0093
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lightning-rapid-gossip-sync/README.md
View File

@ -4,6 +4,16 @@ This crate exposes functionality for rapid gossip graph syncing, aimed primarily
Its server counterpart is the
[rapid-gossip-sync-server](https://github.com/lightningdevkit/rapid-gossip-sync-server) repository.
## Usage
To kick off Rapid Gossip Sync from the beginning, retrieve a snapshot from an RGS server instance with the initial
timestamp being 0.
Applying that snapshot using the `RapidGossipSync` instance will extract and retrieve the subsequent timestamp to
request from the server instance. The methods `sync_network_graph_with_file_path`, `update_network_graph`, and
`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.
## Mechanism
The (presumed) server sends a compressed gossip response containing gossip data. The gossip data is