Packages

final case class Hop(chanId: Long = 0L, chanCapacity: Long = 0L, amtToForward: Long = 0L, fee: Long = 0L, expiry: Int = 0, amtToForwardMsat: Long = 0L, feeMsat: Long = 0L, pubKey: String = "", tlvPayload: Boolean = false, mppRecord: Option[MPPRecord] = _root_.scala.None, customRecords: Map[Long, ByteString] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Hop] with Product with Serializable

chanId

The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.

pubKey

An optional public key of the hop. If the public key is given, the payment can be executed without relying on a copy of the channel graph.

tlvPayload

If set to true, then this hop will be encoded using the new variable length TLV format. Note that if any custom tlv_records below are specified, then this field MUST be set to true for them to be encoded properly.

mppRecord

An optional TLV record that signals the use of an MPP payment. If present, the receiver will enforce that that the same mpp_record is included in the final hop payload of all non-zero payments in the HTLC set. If empty, a regular single-shot payment is or was attempted.

customRecords

An optional set of key-value TLV records. This is useful within the context of the SendToRoute call as it allows callers to specify arbitrary K-V pairs to drop off at each hop within the onion.

Annotations
@SerialVersionUID()
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Hop
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Hop(chanId: Long = 0L, chanCapacity: Long = 0L, amtToForward: Long = 0L, fee: Long = 0L, expiry: Int = 0, amtToForwardMsat: Long = 0L, feeMsat: Long = 0L, pubKey: String = "", tlvPayload: Boolean = false, mppRecord: Option[MPPRecord] = _root_.scala.None, customRecords: Map[Long, ByteString] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    chanId

    The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.

    pubKey

    An optional public key of the hop. If the public key is given, the payment can be executed without relying on a copy of the channel graph.

    tlvPayload

    If set to true, then this hop will be encoded using the new variable length TLV format. Note that if any custom tlv_records below are specified, then this field MUST be set to true for them to be encoded properly.

    mppRecord

    An optional TLV record that signals the use of an MPP payment. If present, the receiver will enforce that that the same mpp_record is included in the final hop payload of all non-zero payments in the HTLC set. If empty, a regular single-shot payment is or was attempted.

    customRecords

    An optional set of key-value TLV records. This is useful within the context of the SendToRoute call as it allows callers to specify arbitrary K-V pairs to drop off at each hop within the onion.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllCustomRecords(__vs: Iterable[(Long, ByteString)]): Hop
  5. def addCustomRecords(__vs: (Long, ByteString)*): Hop
  6. val amtToForwardMsat: Long
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val chanCapacity: Long
  9. val chanId: Long
  10. def clearCustomRecords: Hop
  11. def clearMppRecord: Hop
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. def companion: Hop
    Definition Classes
    Hop → GeneratedMessage
  14. val customRecords: Map[Long, ByteString]
  15. def discardUnknownFields: Hop
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. val expiry: Int
  18. val feeMsat: Long
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Hop → GeneratedMessage
  22. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Hop → GeneratedMessage
  23. def getMppRecord: MPPRecord
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. val mppRecord: Option[MPPRecord]
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. def productElementNames: Iterator[String]
    Definition Classes
    Product
  30. val pubKey: String
  31. def serializedSize: Int
    Definition Classes
    Hop → GeneratedMessage
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. val tlvPayload: Boolean
  34. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  35. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  36. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  37. def toProtoString: String
    Definition Classes
    Hop → GeneratedMessage
  38. val unknownFields: UnknownFieldSet
  39. def update(ms: (Lens[Hop, Hop]) => Mutation[Hop]*): Hop
    Definition Classes
    Updatable
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  43. def withAmtToForward(__v: Long): Hop
  44. def withAmtToForwardMsat(__v: Long): Hop
  45. def withChanCapacity(__v: Long): Hop
  46. def withChanId(__v: Long): Hop
  47. def withCustomRecords(__v: Map[Long, ByteString]): Hop
  48. def withExpiry(__v: Int): Hop
  49. def withFee(__v: Long): Hop
  50. def withFeeMsat(__v: Long): Hop
  51. def withMppRecord(__v: MPPRecord): Hop
  52. def withPubKey(__v: String): Hop
  53. def withTlvPayload(__v: Boolean): Hop
  54. def withUnknownFields(__v: UnknownFieldSet): Hop
  55. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  56. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Hop → GeneratedMessage
  57. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. val amtToForward: Long
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

  2. val fee: Long
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

Inherited from Product

Inherited from Equals

Inherited from Updatable[Hop]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped