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, long send_amt_msat, Option_u64Z channel_capacity_msat, NodeId source, NodeId target)
      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​(RouteHop[] path, long short_channel_id)
      Handles updating channel penalties after failing to route through a channel.
      void payment_path_successful​(RouteHop[] path)
      Handles updating channel penalties after successfully routing along a path.
      byte[] write()
      Serialize the object into a byte array
    • Method Detail

      • channel_penalty_msat

        long channel_penalty_msat​(long short_channel_id,
                                  long send_amt_msat,
                                  Option_u64Z channel_capacity_msat,
                                  NodeId source,
                                  NodeId target)
        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 which are also being considered for use in the same payment) is given by `channel_capacity_msat`. It may be guessed from various sources or assumed from no data at all. For hints provided in the invoice, we assume the channel has sufficient capacity to accept the invoice's full amount, and provide a `channel_capacity_msat` of `None`. In all other cases it is set to `Some`, even if we're guessing at the channel value. Your code should be overflow-safe through a `channel_capacity_msat` of 21 million BTC.
      • payment_path_failed

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

        void payment_path_successful​(RouteHop[] path)
        Handles updating channel penalties after successfully routing along a path.
      • write

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