Packages

final case class SendRequest(dest: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, destString: String = "", amt: Long = 0L, amtMsat: Long = 0L, paymentHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, paymentHashString: String = "", paymentRequest: String = "", finalCltvDelta: Int = 0, feeLimit: Option[FeeLimit] = _root_.scala.None, outgoingChanId: UInt64 = lnrpc.SendRequest._typemapper_outgoingChanId.toCustom(0L), lastHopPubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, cltvLimit: UInt32 = lnrpc.SendRequest._typemapper_cltvLimit.toCustom(0), destCustomRecords: Map[UInt64, ByteString] = _root_.scala.collection.immutable.Map.empty, allowSelfPayment: Boolean = false, destFeatures: Seq[FeatureBit] = _root_.scala.Seq.empty, paymentAddr: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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. If not specified, lnd will use a default value of 100% fees for small amounts (<=1k sat) or 5% fees for larger amounts.

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()
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SendRequest
  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 SendRequest(dest: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, destString: String = "", amt: Long = 0L, amtMsat: Long = 0L, paymentHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, paymentHashString: String = "", paymentRequest: String = "", finalCltvDelta: Int = 0, feeLimit: Option[FeeLimit] = _root_.scala.None, outgoingChanId: UInt64 = lnrpc.SendRequest._typemapper_outgoingChanId.toCustom(0L), lastHopPubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, cltvLimit: UInt32 = lnrpc.SendRequest._typemapper_cltvLimit.toCustom(0), destCustomRecords: Map[UInt64, ByteString] = _root_.scala.collection.immutable.Map.empty, allowSelfPayment: Boolean = false, destFeatures: Seq[FeatureBit] = _root_.scala.Seq.empty, paymentAddr: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    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. If not specified, lnd will use a default value of 100% fees for small amounts (<=1k sat) or 5% fees for larger amounts.

    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

  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[(UInt64, ByteString)]): SendRequest
  5. def addAllDestFeatures(__vs: Iterable[FeatureBit]): SendRequest
  6. def addDestCustomRecords(__vs: (UInt64, ByteString)*): SendRequest
  7. def addDestFeatures(__vs: FeatureBit*): SendRequest
  8. val allowSelfPayment: Boolean
  9. val amt: Long
  10. val amtMsat: Long
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clearDestCustomRecords: SendRequest
  13. def clearDestFeatures: SendRequest
  14. def clearFeeLimit: SendRequest
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  16. val cltvLimit: UInt32
  17. def companion: SendRequest.type
    Definition Classes
    SendRequest → GeneratedMessage
  18. val dest: ByteString
  19. val destCustomRecords: Map[UInt64, ByteString]
  20. val destFeatures: Seq[FeatureBit]
  21. def discardUnknownFields: SendRequest
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. val feeLimit: Option[FeeLimit]
  24. val finalCltvDelta: Int
  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  26. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def getFeeLimit: FeeLimit
  28. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    SendRequest → GeneratedMessage
  29. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    SendRequest → GeneratedMessage
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. val lastHopPubkey: ByteString
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. val outgoingChanId: UInt64
  36. val paymentAddr: ByteString
  37. val paymentHash: ByteString
  38. val paymentRequest: String
  39. def productElementNames: Iterator[String]
    Definition Classes
    Product
  40. def serializedSize: Int
    Definition Classes
    SendRequest → GeneratedMessage
  41. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  42. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  43. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  44. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  45. def toProtoString: String
    Definition Classes
    SendRequest → GeneratedMessage
  46. val unknownFields: UnknownFieldSet
  47. def update(ms: (Lens[SendRequest, SendRequest]) => Mutation[SendRequest]*): SendRequest
    Definition Classes
    Updatable
  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  51. def withAllowSelfPayment(__v: Boolean): SendRequest
  52. def withAmt(__v: Long): SendRequest
  53. def withAmtMsat(__v: Long): SendRequest
  54. def withCltvLimit(__v: UInt32): SendRequest
  55. def withDest(__v: ByteString): SendRequest
  56. def withDestCustomRecords(__v: Map[UInt64, ByteString]): SendRequest
  57. def withDestFeatures(__v: Seq[FeatureBit]): SendRequest
  58. def withDestString(__v: String): SendRequest
  59. def withFeeLimit(__v: FeeLimit): SendRequest
  60. def withFinalCltvDelta(__v: Int): SendRequest
  61. def withLastHopPubkey(__v: ByteString): SendRequest
  62. def withOutgoingChanId(__v: UInt64): SendRequest
  63. def withPaymentAddr(__v: ByteString): SendRequest
  64. def withPaymentHash(__v: ByteString): SendRequest
  65. def withPaymentHashString(__v: String): SendRequest
  66. def withPaymentRequest(__v: String): SendRequest
  67. def withUnknownFields(__v: UnknownFieldSet): SendRequest
  68. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  69. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    SendRequest → GeneratedMessage
  70. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. val destString: String
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

  2. val paymentHashString: String
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

Inherited from Updatable[SendRequest]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped