Document RGS timestamp usage #3419
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3419 +/- ##
==========================================
+ Coverage 89.61% 90.45% +0.84%
==========================================
Files 129 130 +1
Lines 105506 113415 +7909
Branches 105506 113415 +7909
==========================================
+ Hits 94544 102585 +8041
+ Misses 8208 8109 -99
+ Partials 2754 2721 -33 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
jkczyz
approved these changes
Nov 22, 2024
TheBlueMatt
reviewed
Nov 23, 2024
|
|
||
| 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 |
There was a problem hiding this comment.
Don't we generally expect users to instead call https://docs.rs/lightning/latest/lightning/routing/gossip/struct.NetworkGraph.html#method.get_last_rapid_gossip_sync_timestamp to fetch the timestamp when syncing?
There was a problem hiding this comment.
It's the same value with just an extra layer of indirection (and caching), but happy to change it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.