Package net.osslabz.lnd.dto
Class LnrpcHop
java.lang.Object
net.osslabz.lnd.dto.LnrpcHop
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2023-06-07T12:03:34.958542131Z[Etc/UTC]")
public class LnrpcHop
extends Object
LnrpcHop
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionampRecord(LnrpcAMPRecord ampRecord) amtToForward(String amtToForward) amtToForwardMsat(String amtToForwardMsat) chanCapacity(String chanCapacity) customRecords(Map<String, byte[]> customRecords) booleanGet ampRecordGet amtToForwardGet amtToForwardMsatGet chanCapacityThe unique channel ID for the channel.An optional set of key-value TLV records.Get expirygetFee()Get feeGet feeMsatbyte[]The payment metadata to send along with the payment to the payee.Get mppRecordAn optional public key of the hop.If set to true, then this hop will be encoded using the new variable length TLV format.inthashCode()metadata(byte[] metadata) mppRecord(LnrpcMPPRecord mppRecord) putCustomRecordsItem(String key, byte[] customRecordsItem) voidsetAmpRecord(LnrpcAMPRecord ampRecord) voidsetAmtToForward(String amtToForward) voidsetAmtToForwardMsat(String amtToForwardMsat) voidsetChanCapacity(String chanCapacity) voidvoidsetCustomRecords(Map<String, byte[]> customRecords) voidvoidvoidsetFeeMsat(String feeMsat) voidsetMetadata(byte[] metadata) voidsetMppRecord(LnrpcMPPRecord mppRecord) voidvoidsetTlvPayload(Boolean tlvPayload) tlvPayload(Boolean tlvPayload) toString()
-
Field Details
-
SERIALIZED_NAME_CHAN_ID
- See Also:
-
SERIALIZED_NAME_CHAN_CAPACITY
- See Also:
-
SERIALIZED_NAME_AMT_TO_FORWARD
- See Also:
-
SERIALIZED_NAME_FEE
- See Also:
-
SERIALIZED_NAME_EXPIRY
- See Also:
-
SERIALIZED_NAME_AMT_TO_FORWARD_MSAT
- See Also:
-
SERIALIZED_NAME_FEE_MSAT
- See Also:
-
SERIALIZED_NAME_PUB_KEY
- See Also:
-
SERIALIZED_NAME_TLV_PAYLOAD
- See Also:
-
SERIALIZED_NAME_MPP_RECORD
- See Also:
-
SERIALIZED_NAME_AMP_RECORD
- See Also:
-
SERIALIZED_NAME_CUSTOM_RECORDS
- See Also:
-
SERIALIZED_NAME_METADATA
- See Also:
-
-
Constructor Details
-
LnrpcHop
public LnrpcHop()
-
-
Method Details
-
chanId
-
getChanId
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.- Returns:
- chanId
-
setChanId
-
chanCapacity
-
getChanCapacity
Get chanCapacity- Returns:
- chanCapacity
-
setChanCapacity
-
amtToForward
-
getAmtToForward
Get amtToForward- Returns:
- amtToForward
-
setAmtToForward
-
fee
-
getFee
Get fee- Returns:
- fee
-
setFee
-
expiry
-
getExpiry
Get expiry- Returns:
- expiry
-
setExpiry
-
amtToForwardMsat
-
getAmtToForwardMsat
Get amtToForwardMsat- Returns:
- amtToForwardMsat
-
setAmtToForwardMsat
-
feeMsat
-
getFeeMsat
Get feeMsat- Returns:
- feeMsat
-
setFeeMsat
-
pubKey
-
getPubKey
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.- Returns:
- pubKey
-
setPubKey
-
tlvPayload
-
getTlvPayload
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.- Returns:
- tlvPayload
-
setTlvPayload
-
mppRecord
-
getMppRecord
Get mppRecord- Returns:
- mppRecord
-
setMppRecord
-
ampRecord
-
getAmpRecord
Get ampRecord- Returns:
- ampRecord
-
setAmpRecord
-
customRecords
-
putCustomRecordsItem
-
getCustomRecords
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.- Returns:
- customRecords
-
setCustomRecords
-
metadata
-
getMetadata
@Nullable public byte[] getMetadata()The payment metadata to send along with the payment to the payee.- Returns:
- metadata
-
setMetadata
public void setMetadata(byte[] metadata) -
equals
-
hashCode
public int hashCode() -
toString
-