Interface Score.ScoreInterface

  • Enclosing class:
    Score

    public static interface Score.ScoreInterface
    • Method Summary

      All Methods Instance Methods Abstract 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 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

      • channel_penalty_msat

        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

        void payment_path_failed​(Path path,
                                 long short_channel_id)
        Handles updating channel penalties after failing to route through a channel.
      • payment_path_successful

        void payment_path_successful​(Path path)
        Handles updating channel penalties after successfully routing along a path.
      • probe_failed

        void probe_failed​(Path path,
                          long short_channel_id)
        Handles updating channel penalties after a probe over the given path failed.
      • probe_successful

        void probe_successful​(Path path)
        Handles updating channel penalties after a probe over the given path succeeded.
      • write

        byte[] write()
        Serialize the object into a byte array