Skip to content

Commit

Permalink
Merge pull request lightningdevkit#3419 from arik-so/rgs-timestamp-docs
Browse files Browse the repository at this point in the history
Document RGS timestamp usage
  • Loading branch information
jkczyz authored Nov 22, 2024
2 parents 0c31021 + f6a9078 commit 2d6720e
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions lightning-rapid-gossip-sync/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 2d6720e

Please sign in to comment.