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()
- Alphabetic
- By Inheritance
- SendPaymentRequest
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
- 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 addAllDestCustomRecords(__vs: Iterable[(Long, ByteString)]): SendPaymentRequest
- def addAllDestFeatures(__vs: Iterable[FeatureBit]): SendPaymentRequest
- def addAllOutgoingChanIds(__vs: Iterable[Long]): SendPaymentRequest
- def addAllRouteHints(__vs: Iterable[RouteHint]): SendPaymentRequest
- def addDestCustomRecords(__vs: (Long, ByteString)*): SendPaymentRequest
- def addDestFeatures(__vs: FeatureBit*): SendPaymentRequest
- def addOutgoingChanIds(__vs: Long*): SendPaymentRequest
- def addRouteHints(__vs: RouteHint*): SendPaymentRequest
- val allowSelfPayment: Boolean
- val amp: Boolean
- val amt: Long
- val amtMsat: Long
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearDestCustomRecords: SendPaymentRequest
- def clearDestFeatures: SendPaymentRequest
- def clearOutgoingChanIds: SendPaymentRequest
- def clearRouteHints: SendPaymentRequest
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val cltvLimit: Int
- def companion: SendPaymentRequest.type
- Definition Classes
- SendPaymentRequest → GeneratedMessage
- val dest: ByteString
- val destCustomRecords: Map[Long, ByteString]
- val destFeatures: Seq[FeatureBit]
- def discardUnknownFields: SendPaymentRequest
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val feeLimitMsat: Long
- val feeLimitSat: Long
- val finalCltvDelta: Int
- 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
- SendPaymentRequest → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- SendPaymentRequest → GeneratedMessage
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val lastHopPubkey: ByteString
- val maxParts: Int
- val maxShardSizeMsat: Long
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val noInflightUpdates: Boolean
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val outgoingChanIds: Seq[Long]
- val paymentAddr: ByteString
- val paymentHash: ByteString
- val paymentRequest: String
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val routeHints: Seq[RouteHint]
- def serializedSize: Int
- Definition Classes
- SendPaymentRequest → GeneratedMessage
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timePref: Double
- val timeoutSeconds: Int
- 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
- SendPaymentRequest → GeneratedMessage
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[SendPaymentRequest, SendPaymentRequest]) => Mutation[SendPaymentRequest]*): SendPaymentRequest
- 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 withAllowSelfPayment(__v: Boolean): SendPaymentRequest
- def withAmp(__v: Boolean): SendPaymentRequest
- def withAmt(__v: Long): SendPaymentRequest
- def withAmtMsat(__v: Long): SendPaymentRequest
- def withCltvLimit(__v: Int): SendPaymentRequest
- def withDest(__v: ByteString): SendPaymentRequest
- def withDestCustomRecords(__v: Map[Long, ByteString]): SendPaymentRequest
- def withDestFeatures(__v: Seq[FeatureBit]): SendPaymentRequest
- def withFeeLimitMsat(__v: Long): SendPaymentRequest
- def withFeeLimitSat(__v: Long): SendPaymentRequest
- def withFinalCltvDelta(__v: Int): SendPaymentRequest
- def withLastHopPubkey(__v: ByteString): SendPaymentRequest
- def withMaxParts(__v: Int): SendPaymentRequest
- def withMaxShardSizeMsat(__v: Long): SendPaymentRequest
- def withNoInflightUpdates(__v: Boolean): SendPaymentRequest
- def withOutgoingChanId(__v: Long): SendPaymentRequest
- def withOutgoingChanIds(__v: Seq[Long]): SendPaymentRequest
- def withPaymentAddr(__v: ByteString): SendPaymentRequest
- def withPaymentHash(__v: ByteString): SendPaymentRequest
- def withPaymentRequest(__v: String): SendPaymentRequest
- def withRouteHints(__v: Seq[RouteHint]): SendPaymentRequest
- def withTimePref(__v: Double): SendPaymentRequest
- def withTimeoutSeconds(__v: Int): SendPaymentRequest
- def withUnknownFields(__v: UnknownFieldSet): SendPaymentRequest
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- SendPaymentRequest → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage