final case class Route(totalTimeLock: UInt32 = lnrpc.Route._typemapper_totalTimeLock.toCustom(0), totalFees: Long = 0L, totalAmt: Long = 0L, hops: Seq[Hop] = _root_.scala.Seq.empty, totalFeesMsat: Long = 0L, totalAmtMsat: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Route] with Product with Serializable
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.
- totalTimeLock
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.
- totalFees
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.
- totalAmt
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.
- hops
Contains details concerning the specific forwarding details at each hop.
- totalFeesMsat
The total fees in millisatoshis.
- totalAmtMsat
The total amount in millisatoshis.
- Annotations
- @SerialVersionUID()
- Alphabetic
- By Inheritance
- Route
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Route(totalTimeLock: UInt32 = lnrpc.Route._typemapper_totalTimeLock.toCustom(0), totalFees: Long = 0L, totalAmt: Long = 0L, hops: Seq[Hop] = _root_.scala.Seq.empty, totalFeesMsat: Long = 0L, totalAmtMsat: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)
- totalTimeLock
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.
- totalFees
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.
- totalAmt
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.
- hops
Contains details concerning the specific forwarding details at each hop.
- totalFeesMsat
The total fees in millisatoshis.
- totalAmtMsat
The total amount in millisatoshis.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllHops(__vs: Iterable[Hop]): Route
- def addHops(__vs: Hop*): Route
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearHops: Route
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def companion: Route.type
- Definition Classes
- Route → GeneratedMessage
- def discardUnknownFields: Route
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- Route → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- Route → GeneratedMessage
- val hops: Seq[Hop]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def serializedSize: Int
- Definition Classes
- Route → GeneratedMessage
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- final def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- final def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- def toProtoString: String
- Definition Classes
- Route → GeneratedMessage
- val totalAmtMsat: Long
- val totalFeesMsat: Long
- val totalTimeLock: UInt32
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[Route, Route]) => Mutation[Route]*): Route
- Definition Classes
- Updatable
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withHops(__v: Seq[Hop]): Route
- def withTotalAmt(__v: Long): Route
- def withTotalAmtMsat(__v: Long): Route
- def withTotalFees(__v: Long): Route
- def withTotalFeesMsat(__v: Long): Route
- def withTotalTimeLock(__v: UInt32): Route
- def withUnknownFields(__v: UnknownFieldSet): Route
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- Route → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage