Package net.osslabz.lnd.dto

Class LnrpcRoute

java.lang.Object
net.osslabz.lnd.dto.LnrpcRoute
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-06-07T12:03:34.958542131Z[Etc/UTC]") public class LnrpcRoute extends Object
A path through the channel graph which runs over one or more channels in succession. This struct carries all the information required to craft the Sphinx onion packet, and send the payment along the first hop in the path. A route is only selected as valid if all the channels have sufficient capacity to carry the initial payment amount after fees are accounted for.

  • Field Details

  • Constructor Details

    • LnrpcRoute

      public LnrpcRoute()

  • Method Details

    • totalTimeLock

      public LnrpcRoute totalTimeLock(Long totalTimeLock)

    • getTotalTimeLock

      @Nullable public Long getTotalTimeLock()
      The cumulative (final) time lock across the entire route. This is the CLTV value that should be extended to the first hop in the route. All other hops will decrement the time-lock as advertised, leaving enough time for all hops to wait for or present the payment preimage to complete the payment.
      Returns:
      totalTimeLock

    • setTotalTimeLock

      public void setTotalTimeLock(Long totalTimeLock)

    • totalFees

      public LnrpcRoute totalFees(String totalFees)

    • getTotalFees

      @Nullable public String getTotalFees()
      The sum of the fees paid at each hop within the final route. In the case of a one-hop payment, this value will be zero as we don't need to pay a fee to ourselves.
      Returns:
      totalFees

    • setTotalFees

      public void setTotalFees(String totalFees)

    • totalAmt

      public LnrpcRoute totalAmt(String totalAmt)

    • getTotalAmt

      @Nullable public String getTotalAmt()
      The total amount of funds required to complete a payment over this route. This value includes the cumulative fees at each hop. As a result, the HTLC extended to the first-hop in the route will need to have at least this many satoshis, otherwise the route will fail at an intermediate node due to an insufficient amount of fees.
      Returns:
      totalAmt

    • setTotalAmt

      public void setTotalAmt(String totalAmt)

    • hops

      public LnrpcRoute hops(List<LnrpcHop> hops)

    • addHopsItem

      public LnrpcRoute addHopsItem(LnrpcHop hopsItem)

    • getHops

      @Nullable public List<LnrpcHop> getHops()
      Contains details concerning the specific forwarding details at each hop.
      Returns:
      hops

    • setHops

      public void setHops(List<LnrpcHop> hops)

    • totalFeesMsat

      public LnrpcRoute totalFeesMsat(String totalFeesMsat)

    • getTotalFeesMsat

      @Nullable public String getTotalFeesMsat()
      The total fees in millisatoshis.
      Returns:
      totalFeesMsat

    • setTotalFeesMsat

      public void setTotalFeesMsat(String totalFeesMsat)

    • totalAmtMsat

      public LnrpcRoute totalAmtMsat(String totalAmtMsat)

    • getTotalAmtMsat

      @Nullable public String getTotalAmtMsat()
      The total amount in millisatoshis.
      Returns:
      totalAmtMsat

    • setTotalAmtMsat

      public void setTotalAmtMsat(String totalAmtMsat)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object