Skip to content

Commit e88be8d

Browse files
committed
f - Update module docs
1 parent aeec07b commit e88be8d

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

lightning/src/routing/scoring.rs

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99

1010
//! Utilities for scoring payment channels.
1111
//!
12-
//! [`Scorer`] may be given to [`find_route`] to score payment channels during path finding when a
13-
//! custom [`Score`] implementation is not needed.
12+
//! [`ProbabilisticScorer`] may be given to [`find_route`] to score payment channels during path
13+
//! finding when a custom [`Score`] implementation is not needed.
1414
//!
1515
//! # Example
1616
//!
@@ -19,7 +19,7 @@
1919
//! #
2020
//! # use lightning::routing::network_graph::NetworkGraph;
2121
//! # use lightning::routing::router::{RouteParameters, find_route};
22-
//! # use lightning::routing::scoring::{Scorer, ScoringParameters};
22+
//! # use lightning::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringParameters, Scorer, ScoringParameters};
2323
//! # use lightning::util::logger::{Logger, Record};
2424
//! # use secp256k1::key::PublicKey;
2525
//! #
@@ -31,14 +31,15 @@
3131
//! # let logger = FakeLogger {};
3232
//! #
3333
//! // Use the default channel penalties.
34-
//! let scorer = Scorer::default();
34+
//! let params = ProbabilisticScoringParameters::default();
35+
//! let scorer = ProbabilisticScorer::new(params, &payer, &network_graph);
3536
//!
3637
//! // Or use custom channel penalties.
37-
//! let scorer = Scorer::new(ScoringParameters {
38-
//! base_penalty_msat: 1000,
39-
//! failure_penalty_msat: 2 * 1024 * 1000,
40-
//! ..ScoringParameters::default()
41-
//! });
38+
//! let params = ProbabilisticScoringParameters {
39+
//! liquidity_penalty_multiplier_msat: 2 * 1000,
40+
//! ..ProbabilisticScoringParameters::default()
41+
//! };
42+
//! let scorer = ProbabilisticScorer::new(params, &payer, &network_graph);
4243
//!
4344
//! let route = find_route(&payer, &params, &network_graph, None, &logger, &scorer);
4445
//! # }

0 commit comments

Comments
 (0)