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, ampRecord: Option[AMPRecord] = _root_.scala.None, customRecords: Map[Long, ByteString] = ..., unknownFields: UnknownFieldSet = ...) 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 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.
- ampRecord
An optional TLV record that signals the use of an AMP payment. If present, the receiver will treat all received payments including the same (payment_addr, set_id) pair as being part of one logical payment. The payment will be settled by XORing the root_share's together and deriving the child hashes and preimages according to BOLT XX. Must be used in conjunction with mpp_record.
- 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()
- Alphabetic
- By Inheritance
- Hop
- Updatable
- GeneratedMessage
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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, ampRecord: Option[AMPRecord] = _root_.scala.None, customRecords: Map[Long, ByteString] = ..., unknownFields: UnknownFieldSet = ...)
- 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 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.
- ampRecord
An optional TLV record that signals the use of an AMP payment. If present, the receiver will treat all received payments including the same (payment_addr, set_id) pair as being part of one logical payment. The payment will be settled by XORing the root_share's together and deriving the child hashes and preimages according to BOLT XX. Must be used in conjunction with mpp_record.
- 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
-
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 addAllCustomRecords(__vs: Iterable[(Long, ByteString)]): Hop
- def addCustomRecords(__vs: (Long, ByteString)*): Hop
- val ampRecord: Option[AMPRecord]
- val amtToForwardMsat: Long
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val chanId: Long
- def clearAmpRecord: Hop
- def clearCustomRecords: Hop
- def clearMppRecord: Hop
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
companion: Hop.type
- Definition Classes
- Hop → GeneratedMessage
- val customRecords: Map[Long, ByteString]
- def discardUnknownFields: Hop
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val expiry: Int
- val feeMsat: Long
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def getAmpRecord: AMPRecord
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getField(__field: FieldDescriptor): PValue
- Definition Classes
- Hop → GeneratedMessage
-
def
getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- Hop → GeneratedMessage
- def getMppRecord: MPPRecord
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val mppRecord: Option[MPPRecord]
-
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()
- val pubKey: String
-
def
serializedSize: Int
- Definition Classes
- Hop → GeneratedMessage
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val tlvPayload: Boolean
-
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
- Hop → GeneratedMessage
- val unknownFields: UnknownFieldSet
-
def
update(ms: (Lens[Hop, Hop]) ⇒ Mutation[Hop]*): Hop
- Definition Classes
- Updatable
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def withAmpRecord(__v: AMPRecord): Hop
- def withAmtToForward(__v: Long): Hop
- def withAmtToForwardMsat(__v: Long): Hop
- def withChanCapacity(__v: Long): Hop
- def withChanId(__v: Long): Hop
- def withCustomRecords(__v: Map[Long, ByteString]): Hop
- def withExpiry(__v: Int): Hop
- def withFee(__v: Long): Hop
- def withFeeMsat(__v: Long): Hop
- def withMppRecord(__v: MPPRecord): Hop
- def withPubKey(__v: String): Hop
- def withTlvPayload(__v: Boolean): Hop
- def withUnknownFields(__v: UnknownFieldSet): Hop
-
final
def
writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
-
def
writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- Hop → GeneratedMessage
-
final
def
writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
Deprecated Value Members
-
val
amtToForward: Long
- Annotations
- @deprecated
- Deprecated
(Since version ) Marked as deprecated in proto file
-
val
chanCapacity: Long
- Annotations
- @deprecated
- Deprecated
(Since version ) Marked as deprecated in proto file
-
val
fee: Long
- Annotations
- @deprecated
- Deprecated
(Since version ) Marked as deprecated in proto file