|
9 | 9 |
|
10 | 10 | //! Utilities for scoring payment channels.
|
11 | 11 | //!
|
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. |
14 | 14 | //!
|
15 | 15 | //! # Example
|
16 | 16 | //!
|
|
19 | 19 | //! #
|
20 | 20 | //! # use lightning::routing::network_graph::NetworkGraph;
|
21 | 21 | //! # use lightning::routing::router::{RouteParameters, find_route};
|
22 |
| -//! # use lightning::routing::scoring::{Scorer, ScoringParameters}; |
| 22 | +//! # use lightning::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringParameters, Scorer, ScoringParameters}; |
23 | 23 | //! # use lightning::util::logger::{Logger, Record};
|
24 | 24 | //! # use secp256k1::key::PublicKey;
|
25 | 25 | //! #
|
|
31 | 31 | //! # let logger = FakeLogger {};
|
32 | 32 | //! #
|
33 | 33 | //! // Use the default channel penalties.
|
34 |
| -//! let scorer = Scorer::default(); |
| 34 | +//! let params = ProbabilisticScoringParameters::default(); |
| 35 | +//! let scorer = ProbabilisticScorer::new(params, &payer, &network_graph); |
35 | 36 | //!
|
36 | 37 | //! // 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); |
42 | 43 | //!
|
43 | 44 | //! let route = find_route(&payer, ¶ms, &network_graph, None, &logger, &scorer);
|
44 | 45 | //! # }
|
|
0 commit comments