final case class SendRequest(dest: ByteString = ..., destString: String = "", amt: Long = 0L, amtMsat: Long = 0L, paymentHash: ByteString = ..., paymentHashString: String = "", paymentRequest: String = "", finalCltvDelta: Int = 0, feeLimit: Option[FeeLimit] = _root_.scala.None, outgoingChanId: Long = 0L, lastHopPubkey: ByteString = ..., cltvLimit: Int = 0, destCustomRecords: Map[Long, ByteString] = ..., allowSelfPayment: Boolean = false, destFeatures: Seq[FeatureBit] = _root_.scala.Seq.empty, paymentAddr: ByteString = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[SendRequest] with Product with Serializable
- dest
The identity pubkey of the payment recipient. When using REST, this field must be encoded as base64.
- destString
The hex-encoded identity pubkey of the payment recipient. Deprecated now that the REST gateway supports base64 encoding of bytes fields.
- amt
The amount to send expressed in satoshis. The fields amt and amt_msat are mutually exclusive.
- amtMsat
The amount to send expressed in millisatoshis. The fields amt and amt_msat are mutually exclusive.
- paymentHash
The hash to use within the payment's HTLC. When using REST, this field must be encoded as base64.
- paymentHashString
The hex-encoded hash to use within the payment's HTLC. Deprecated now that the REST gateway supports base64 encoding of bytes fields.
- 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.
- finalCltvDelta
The CLTV delta from the current height that should be used to set the timelock for the final hop.
- feeLimit
The maximum number of satoshis that will be paid as a fee of the payment. This value can be represented either as a percentage of the amount being sent, or as a fixed amount of the maximum fee the user is willing the pay to send the payment.
- outgoingChanId
The channel id of the channel that must be taken to the first hop. If zero, 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.- 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.
- paymentAddr
The payment address of the generated invoice.
- Annotations
- @SerialVersionUID()
- Alphabetic
- By Inheritance
- SendRequest
- Updatable
- GeneratedMessage
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
SendRequest(dest: ByteString = ..., destString: String = "", amt: Long = 0L, amtMsat: Long = 0L, paymentHash: ByteString = ..., paymentHashString: String = "", paymentRequest: String = "", finalCltvDelta: Int = 0, feeLimit: Option[FeeLimit] = _root_.scala.None, outgoingChanId: Long = 0L, lastHopPubkey: ByteString = ..., cltvLimit: Int = 0, destCustomRecords: Map[Long, ByteString] = ..., allowSelfPayment: Boolean = false, destFeatures: Seq[FeatureBit] = _root_.scala.Seq.empty, paymentAddr: ByteString = ..., unknownFields: UnknownFieldSet = ...)
- dest
The identity pubkey of the payment recipient. When using REST, this field must be encoded as base64.
- destString
The hex-encoded identity pubkey of the payment recipient. Deprecated now that the REST gateway supports base64 encoding of bytes fields.
- amt
The amount to send expressed in satoshis. The fields amt and amt_msat are mutually exclusive.
- amtMsat
The amount to send expressed in millisatoshis. The fields amt and amt_msat are mutually exclusive.
- paymentHash
The hash to use within the payment's HTLC. When using REST, this field must be encoded as base64.
- paymentHashString
The hex-encoded hash to use within the payment's HTLC. Deprecated now that the REST gateway supports base64 encoding of bytes fields.
- 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.
- finalCltvDelta
The CLTV delta from the current height that should be used to set the timelock for the final hop.
- feeLimit
The maximum number of satoshis that will be paid as a fee of the payment. This value can be represented either as a percentage of the amount being sent, or as a fixed amount of the maximum fee the user is willing the pay to send the payment.
- outgoingChanId
The channel id of the channel that must be taken to the first hop. If zero, 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.- 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.
- paymentAddr
The payment address of the generated invoice.
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)]): SendRequest
- def addAllDestFeatures(__vs: Iterable[FeatureBit]): SendRequest
- def addDestCustomRecords(__vs: (Long, ByteString)*): SendRequest
- def addDestFeatures(__vs: FeatureBit*): SendRequest
- val allowSelfPayment: Boolean
- val amt: Long
- val amtMsat: Long
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearDestCustomRecords: SendRequest
- def clearDestFeatures: SendRequest
- def clearFeeLimit: SendRequest
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val cltvLimit: Int
-
def
companion: SendRequest.type
- Definition Classes
- SendRequest → GeneratedMessage
- val dest: ByteString
- val destCustomRecords: Map[Long, ByteString]
- val destFeatures: Seq[FeatureBit]
- def discardUnknownFields: SendRequest
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val feeLimit: Option[FeeLimit]
- val finalCltvDelta: Int
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getFeeLimit: FeeLimit
-
def
getField(__field: FieldDescriptor): PValue
- Definition Classes
- SendRequest → GeneratedMessage
-
def
getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- SendRequest → GeneratedMessage
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val lastHopPubkey: ByteString
-
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 outgoingChanId: Long
- val paymentAddr: ByteString
- val paymentHash: ByteString
- val paymentRequest: String
-
def
serializedSize: Int
- Definition Classes
- SendRequest → GeneratedMessage
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
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
- SendRequest → GeneratedMessage
- val unknownFields: UnknownFieldSet
-
def
update(ms: (Lens[SendRequest, SendRequest]) ⇒ Mutation[SendRequest]*): SendRequest
- 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 withAllowSelfPayment(__v: Boolean): SendRequest
- def withAmt(__v: Long): SendRequest
- def withAmtMsat(__v: Long): SendRequest
- def withCltvLimit(__v: Int): SendRequest
- def withDest(__v: ByteString): SendRequest
- def withDestCustomRecords(__v: Map[Long, ByteString]): SendRequest
- def withDestFeatures(__v: Seq[FeatureBit]): SendRequest
- def withDestString(__v: String): SendRequest
- def withFeeLimit(__v: FeeLimit): SendRequest
- def withFinalCltvDelta(__v: Int): SendRequest
- def withLastHopPubkey(__v: ByteString): SendRequest
- def withOutgoingChanId(__v: Long): SendRequest
- def withPaymentAddr(__v: ByteString): SendRequest
- def withPaymentHash(__v: ByteString): SendRequest
- def withPaymentHashString(__v: String): SendRequest
- def withPaymentRequest(__v: String): SendRequest
- def withUnknownFields(__v: UnknownFieldSet): SendRequest
-
final
def
writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
-
def
writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- SendRequest → GeneratedMessage
-
final
def
writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage