Document that Route::route_params will be required soon
What the developer wrote
Authored by Valentine Wallace
Document that Route::route_params will be required soon
This field was always set since 0.0.117, so in the next version we're going to
make it officially required.
What changed, and why it matters
This commit only updates a documentation comment in the source code. It warns developers that a field called route_params on the Route struct will become mandatory in a future release. There are no code changes, no bug fixes, and no security changes.
No security action needed. Treat as a normal documentation/deprecation-notice commit.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies a single doc comment in lightning/src/routing/router.rs for the Route::route_params field. It adds a sentence stating the field will soon be required and must always be set. No logic, serialization, API, or behavior changes are present.
Changed components
lightning/src/routing/router.rs documentationInspect captured patch +2 / −1
diff --git a/lightning/src/routing/router.rs b/lightning/src/routing/router.rs
index 364bd86..01889b2 100644
--- a/lightning/src/routing/router.rs
+++ b/lightning/src/routing/router.rs
@@ -683,7 +683,8 @@ pub struct Route {
///
/// This is used by `ChannelManager` to track information which may be required for retries.
///
- /// Will be `None` for objects serialized with LDK versions prior to 0.0.117.
+ /// Will be `None` for objects serialized with LDK versions prior to 0.0.117. This field will
+ /// soon move to being required and must always be set.
pub route_params: Option<RouteParameters>,
}
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.