final case class SendPaymentRequest(dest: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, amt: Long = 0L, amtMsat: Long = 0L, paymentHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, finalCltvDelta: Int = 0, paymentAddr: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, paymentRequest: String = "", timeoutSeconds: Int = 0, feeLimitSat: Long = 0L, feeLimitMsat: Long = 0L, outgoingChanId: Long = 0L, outgoingChanIds: Seq[Long] = _root_.scala.Seq.empty, lastHopPubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, cltvLimit: Int = 0, routeHints: Seq[RouteHint] = _root_.scala.Seq.empty, destCustomRecords: Map[Long, ByteString] = _root_.scala.collection.immutable.Map.empty, allowSelfPayment: Boolean = false, destFeatures: Seq[FeatureBit] = _root_.scala.Seq.empty, maxParts: Int = 0, noInflightUpdates: Boolean = false, maxShardSizeMsat: Long = 0L, amp: Boolean = false, timePref: Double = 0.0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SendPaymentRequest] with Product with Serializable

dest

The identity pubkey of the payment recipient

amt

Number of satoshis to send. The fields amt and amt_msat are mutually exclusive.

amtMsat

Number of millisatoshis to send. The fields amt and amt_msat are mutually exclusive.

paymentHash

The hash to use within the payment's HTLC

finalCltvDelta

The CLTV delta from the current height that should be used to set the timelock for the final hop.

paymentAddr

An optional payment addr to be included within the last hop of the route.

paymentRequest

A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient. The amount in the payment request may be zero. In that case it is required to set the amt field as well. If no payment request is specified, the following fields are required: dest, amt and payment_hash.

timeoutSeconds

An upper limit on the amount of time we should spend when attempting to fulfill the payment. This is expressed in seconds. If we cannot make a successful payment within this time frame, an error will be returned. This field must be non-zero.

feeLimitSat

The maximum number of satoshis that will be paid as a fee of the payment. If this field is left to the default value of 0, only zero-fee routes will be considered. This usually means single hop routes connecting directly to the destination. To send the payment without a fee limit, use max int here. The fields fee_limit_sat and fee_limit_msat are mutually exclusive.

feeLimitMsat

The maximum number of millisatoshis that will be paid as a fee of the payment. If this field is left to the default value of 0, only zero-fee routes will be considered. This usually means single hop routes connecting directly to the destination. To send the payment without a fee limit, use max int here. The fields fee_limit_sat and fee_limit_msat are mutually exclusive.

outgoingChanId

Deprecated, use outgoing_chan_ids. The channel id of the channel that must be taken to the first hop. If zero, any channel may be used (unless outgoing_chan_ids are set).

outgoingChanIds

The channel ids of the channels are allowed for the first hop. If empty, any channel may be used.

lastHopPubkey

The pubkey of the last hop of the route. If empty, any hop may be used.

cltvLimit

An optional maximum total time lock for the route. This should not exceed lnd's --max-cltv-expiry setting. If zero, then the value of --max-cltv-expiry is enforced.

routeHints

Optional route hints to reach the destination through private channels.

destCustomRecords

An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records. This can be used to pass application specific data during the payment attempt. Record types are required to be in the custom range >= 65536. When using REST, the values must be encoded as base64.

allowSelfPayment

If set, circular payments to self are permitted.

destFeatures

Features assumed to be supported by the final node. All transitive feature dependencies must also be set properly. For a given feature bit pair, either optional or remote may be set, but not both. If this field is nil or empty, the router will try to load destination features from the graph as a fallback.

maxParts

The maximum number of partial payments that may be use to complete the full amount.

noInflightUpdates

If set, only the final payment update is streamed back. Intermediate updates that show which htlcs are still in flight are suppressed.

maxShardSizeMsat

The largest payment split that should be attempted when making a payment if splitting is necessary. Setting this value will effectively cause lnd to split more aggressively, vs only when it thinks it needs to. Note that this value is in milli-satoshis.

amp

If set, an AMP-payment will be attempted.

timePref

The time preference for this payment. Set to -1 to optimize for fees only, to 1 to optimize for reliability only or a value inbetween for a mix.

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

Instance Constructors

  1. new SendPaymentRequest(dest: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, amt: Long = 0L, amtMsat: Long = 0L, paymentHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, finalCltvDelta: Int = 0, paymentAddr: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, paymentRequest: String = "", timeoutSeconds: Int = 0, feeLimitSat: Long = 0L, feeLimitMsat: Long = 0L, outgoingChanId: Long = 0L, outgoingChanIds: Seq[Long] = _root_.scala.Seq.empty, lastHopPubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, cltvLimit: Int = 0, routeHints: Seq[RouteHint] = _root_.scala.Seq.empty, destCustomRecords: Map[Long, ByteString] = _root_.scala.collection.immutable.Map.empty, allowSelfPayment: Boolean = false, destFeatures: Seq[FeatureBit] = _root_.scala.Seq.empty, maxParts: Int = 0, noInflightUpdates: Boolean = false, maxShardSizeMsat: Long = 0L, amp: Boolean = false, timePref: Double = 0.0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    dest

    The identity pubkey of the payment recipient

    amt

    Number of satoshis to send. The fields amt and amt_msat are mutually exclusive.

    amtMsat

    Number of millisatoshis to send. The fields amt and amt_msat are mutually exclusive.

    paymentHash

    The hash to use within the payment's HTLC

    finalCltvDelta

    The CLTV delta from the current height that should be used to set the timelock for the final hop.

    paymentAddr

    An optional payment addr to be included within the last hop of the route.

    paymentRequest

    A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient. The amount in the payment request may be zero. In that case it is required to set the amt field as well. If no payment request is specified, the following fields are required: dest, amt and payment_hash.

    timeoutSeconds

    An upper limit on the amount of time we should spend when attempting to fulfill the payment. This is expressed in seconds. If we cannot make a successful payment within this time frame, an error will be returned. This field must be non-zero.

    feeLimitSat

    The maximum number of satoshis that will be paid as a fee of the payment. If this field is left to the default value of 0, only zero-fee routes will be considered. This usually means single hop routes connecting directly to the destination. To send the payment without a fee limit, use max int here. The fields fee_limit_sat and fee_limit_msat are mutually exclusive.

    feeLimitMsat

    The maximum number of millisatoshis that will be paid as a fee of the payment. If this field is left to the default value of 0, only zero-fee routes will be considered. This usually means single hop routes connecting directly to the destination. To send the payment without a fee limit, use max int here. The fields fee_limit_sat and fee_limit_msat are mutually exclusive.

    outgoingChanId

    Deprecated, use outgoing_chan_ids. The channel id of the channel that must be taken to the first hop. If zero, any channel may be used (unless outgoing_chan_ids are set).

    outgoingChanIds

    The channel ids of the channels are allowed for the first hop. If empty, any channel may be used.

    lastHopPubkey

    The pubkey of the last hop of the route. If empty, any hop may be used.

    cltvLimit

    An optional maximum total time lock for the route. This should not exceed lnd's --max-cltv-expiry setting. If zero, then the value of --max-cltv-expiry is enforced.

    routeHints

    Optional route hints to reach the destination through private channels.

    destCustomRecords

    An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records. This can be used to pass application specific data during the payment attempt. Record types are required to be in the custom range >= 65536. When using REST, the values must be encoded as base64.

    allowSelfPayment

    If set, circular payments to self are permitted.

    destFeatures

    Features assumed to be supported by the final node. All transitive feature dependencies must also be set properly. For a given feature bit pair, either optional or remote may be set, but not both. If this field is nil or empty, the router will try to load destination features from the graph as a fallback.

    maxParts

    The maximum number of partial payments that may be use to complete the full amount.

    noInflightUpdates

    If set, only the final payment update is streamed back. Intermediate updates that show which htlcs are still in flight are suppressed.

    maxShardSizeMsat

    The largest payment split that should be attempted when making a payment if splitting is necessary. Setting this value will effectively cause lnd to split more aggressively, vs only when it thinks it needs to. Note that this value is in milli-satoshis.

    amp

    If set, an AMP-payment will be attempted.

    timePref

    The time preference for this payment. Set to -1 to optimize for fees only, to 1 to optimize for reliability only or a value inbetween for a mix.

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 addAllDestCustomRecords(__vs: Iterable[(Long, ByteString)]): SendPaymentRequest
  5. def addAllDestFeatures(__vs: Iterable[FeatureBit]): SendPaymentRequest
  6. def addAllOutgoingChanIds(__vs: Iterable[Long]): SendPaymentRequest
  7. def addAllRouteHints(__vs: Iterable[RouteHint]): SendPaymentRequest
  8. def addDestCustomRecords(__vs: (Long, ByteString)*): SendPaymentRequest
  9. def addDestFeatures(__vs: FeatureBit*): SendPaymentRequest
  10. def addOutgoingChanIds(__vs: Long*): SendPaymentRequest
  11. def addRouteHints(__vs: RouteHint*): SendPaymentRequest
  12. val allowSelfPayment: Boolean
  13. val amp: Boolean
  14. val amt: Long
  15. val amtMsat: Long
  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. def clearDestCustomRecords: SendPaymentRequest
  18. def clearDestFeatures: SendPaymentRequest
  19. def clearOutgoingChanIds: SendPaymentRequest
  20. def clearRouteHints: SendPaymentRequest
  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  22. val cltvLimit: Int
  23. def companion: SendPaymentRequest.type
    Definition Classes
    SendPaymentRequest → GeneratedMessage
  24. val dest: ByteString
  25. val destCustomRecords: Map[Long, ByteString]
  26. val destFeatures: Seq[FeatureBit]
  27. def discardUnknownFields: SendPaymentRequest
  28. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. val feeLimitMsat: Long
  30. val feeLimitSat: Long
  31. val finalCltvDelta: Int
  32. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  33. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    SendPaymentRequest → GeneratedMessage
  35. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    SendPaymentRequest → GeneratedMessage
  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. val lastHopPubkey: ByteString
  38. val maxParts: Int
  39. val maxShardSizeMsat: Long
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. val noInflightUpdates: Boolean
  42. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  44. val outgoingChanIds: Seq[Long]
  45. val paymentAddr: ByteString
  46. val paymentHash: ByteString
  47. val paymentRequest: String
  48. def productElementNames: Iterator[String]
    Definition Classes
    Product
  49. val routeHints: Seq[RouteHint]
  50. def serializedSize: Int
    Definition Classes
    SendPaymentRequest → GeneratedMessage
  51. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  52. val timePref: Double
  53. val timeoutSeconds: Int
  54. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  55. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  56. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  57. def toProtoString: String
    Definition Classes
    SendPaymentRequest → GeneratedMessage
  58. val unknownFields: UnknownFieldSet
  59. def update(ms: (Lens[SendPaymentRequest, SendPaymentRequest]) => Mutation[SendPaymentRequest]*): SendPaymentRequest
    Definition Classes
    Updatable
  60. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  61. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  62. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  63. def withAllowSelfPayment(__v: Boolean): SendPaymentRequest
  64. def withAmp(__v: Boolean): SendPaymentRequest
  65. def withAmt(__v: Long): SendPaymentRequest
  66. def withAmtMsat(__v: Long): SendPaymentRequest
  67. def withCltvLimit(__v: Int): SendPaymentRequest
  68. def withDest(__v: ByteString): SendPaymentRequest
  69. def withDestCustomRecords(__v: Map[Long, ByteString]): SendPaymentRequest
  70. def withDestFeatures(__v: Seq[FeatureBit]): SendPaymentRequest
  71. def withFeeLimitMsat(__v: Long): SendPaymentRequest
  72. def withFeeLimitSat(__v: Long): SendPaymentRequest
  73. def withFinalCltvDelta(__v: Int): SendPaymentRequest
  74. def withLastHopPubkey(__v: ByteString): SendPaymentRequest
  75. def withMaxParts(__v: Int): SendPaymentRequest
  76. def withMaxShardSizeMsat(__v: Long): SendPaymentRequest
  77. def withNoInflightUpdates(__v: Boolean): SendPaymentRequest
  78. def withOutgoingChanId(__v: Long): SendPaymentRequest
  79. def withOutgoingChanIds(__v: Seq[Long]): SendPaymentRequest
  80. def withPaymentAddr(__v: ByteString): SendPaymentRequest
  81. def withPaymentHash(__v: ByteString): SendPaymentRequest
  82. def withPaymentRequest(__v: String): SendPaymentRequest
  83. def withRouteHints(__v: Seq[RouteHint]): SendPaymentRequest
  84. def withTimePref(__v: Double): SendPaymentRequest
  85. def withTimeoutSeconds(__v: Int): SendPaymentRequest
  86. def withUnknownFields(__v: UnknownFieldSet): SendPaymentRequest
  87. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  88. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    SendPaymentRequest → GeneratedMessage
  89. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. val outgoingChanId: Long
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped