Package org.ldk.structs
Class Score
- java.lang.Object
-
- org.ldk.structs.Score
-
public class Score extends Object
An interface used to score payment channels for path finding. \tScoring is in terms of fees willing to be paid in order to avoid routing through a channel.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Score.ScoreInterface
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description long
channel_penalty_msat(long short_channel_id, NodeId source, NodeId target, ChannelUsage usage)
Returns the fee in msats willing to be paid to avoid routing `send_amt_msat` through the given channel in the direction from `source` to `target`.void
destroy()
Destroys the object, freeing associated resources.protected void
finalize()
static Score
new_impl(Score.ScoreInterface arg)
void
payment_path_failed(Path path, long short_channel_id)
Handles updating channel penalties after failing to route through a channel.void
payment_path_successful(Path path)
Handles updating channel penalties after successfully routing along a path.void
probe_failed(Path path, long short_channel_id)
Handles updating channel penalties after a probe over the given path failed.void
probe_successful(Path path)
Handles updating channel penalties after a probe over the given path succeeded.byte[]
write()
Serialize the object into a byte array
-
-
-
Method Detail
-
finalize
protected void finalize() throws Throwable
-
destroy
public void destroy()
Destroys the object, freeing associated resources. After this call, any access to this object may result in a SEGFAULT or worse. You should generally NEVER call this method. You should let the garbage collector do this for you when it finalizes objects. However, it may be useful for types which represent locks and should be closed immediately to avoid holding locks until the GC runs.
-
new_impl
public static Score new_impl(Score.ScoreInterface arg)
-
channel_penalty_msat
public long channel_penalty_msat(long short_channel_id, NodeId source, NodeId target, ChannelUsage usage)
Returns the fee in msats willing to be paid to avoid routing `send_amt_msat` through the given channel in the direction from `source` to `target`. The channel's capacity (less any other MPP parts that are also being considered for use in the same payment) is given by `capacity_msat`. It may be determined from various sources such as a chain data, network gossip, or invoice hints. For invoice hints, a capacity near [`u64::max_value`] is given to indicate sufficient capacity for the invoice's full amount. Thus, implementations should be overflow-safe.
-
payment_path_failed
public void payment_path_failed(Path path, long short_channel_id)
Handles updating channel penalties after failing to route through a channel.
-
payment_path_successful
public void payment_path_successful(Path path)
Handles updating channel penalties after successfully routing along a path.
-
probe_failed
public void probe_failed(Path path, long short_channel_id)
Handles updating channel penalties after a probe over the given path failed.
-
probe_successful
public void probe_successful(Path path)
Handles updating channel penalties after a probe over the given path succeeded.
-
write
public byte[] write()
Serialize the object into a byte array
-
-