Class RouteParameters


  • public class RouteParameters
    extends Object
    Parameters needed to find a [`Route`] for paying a [`Payee`]. Passed to [`find_route`] and also provided in [`Event::PaymentPathFailed`] for retrying a failed payment path. [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
    • Method Detail

      • get_payee

        public Payee get_payee()
        The recipient of the failed payment path.
      • set_payee

        public void set_payee​(Payee val)
        The recipient of the failed payment path.
      • get_final_value_msat

        public long get_final_value_msat()
        The amount in msats sent on the failed payment path.
      • set_final_value_msat

        public void set_final_value_msat​(long val)
        The amount in msats sent on the failed payment path.
      • get_final_cltv_expiry_delta

        public int get_final_cltv_expiry_delta()
        The CLTV on the final hop of the failed payment path.
      • set_final_cltv_expiry_delta

        public void set_final_cltv_expiry_delta​(int val)
        The CLTV on the final hop of the failed payment path.
      • of

        public static RouteParameters of​(Payee payee_arg,
                                         long final_value_msat_arg,
                                         int final_cltv_expiry_delta_arg)
        Constructs a new RouteParameters given each field
      • write

        public byte[] write()
        Serialize the RouteParameters object into a byte array which can be read by RouteParameters_read