Packages

final case class QueryRoutesRequest(pubKey: String = "", amt: Long = 0L, amtMsat: Long = 0L, finalCltvDelta: Int = 0, feeLimit: Option[FeeLimit] = _root_.scala.None, ignoredNodes: Seq[ByteString] = _root_.scala.Seq.empty, ignoredEdges: Seq[EdgeLocator] = _root_.scala.Seq.empty, sourcePubKey: String = "", useMissionControl: Boolean = false, ignoredPairs: Seq[NodePair] = _root_.scala.Seq.empty, cltvLimit: UInt32 = lnrpc.QueryRoutesRequest._typemapper_cltvLimit.toCustom(0), destCustomRecords: Map[UInt64, ByteString] = _root_.scala.collection.immutable.Map.empty, outgoingChanId: UInt64 = lnrpc.QueryRoutesRequest._typemapper_outgoingChanId.toCustom(0L), lastHopPubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, routeHints: Seq[RouteHint] = _root_.scala.Seq.empty, destFeatures: Seq[FeatureBit] = _root_.scala.Seq.empty, timePref: Double = 0.0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[QueryRoutesRequest] with Product with Serializable

pubKey

The 33-byte hex-encoded public key for the payment destination

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.

finalCltvDelta

An optional CLTV delta from the current height that should be used for the timelock of the final hop. Note that unlike SendPayment, QueryRoutes does not add any additional block padding on top of final_ctlv_delta. This padding of a few blocks needs to be added manually or otherwise failures may happen when a block comes in while the payment is in flight.

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.

ignoredNodes

A list of nodes to ignore during path finding. When using REST, these fields must be encoded as base64.

ignoredEdges

Deprecated. A list of edges to ignore during path finding.

sourcePubKey

The source node where the request route should originated from. If empty, self is assumed.

useMissionControl

If set to true, edge probabilities from mission control will be used to get the optimal route.

ignoredPairs

A list of directed node pairs that will be ignored during path finding.

cltvLimit

An optional maximum total time lock for the route. If the source is empty or ourselves, this should not exceed lnd's --max-cltv-expiry setting. If zero, then the value of --max-cltv-expiry is used as the limit.

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. If the destination does not support the specified records, an error will be returned. Record types are required to be in the custom range >= 65536. When using REST, the values must be encoded as base64.

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.

routeHints

Optional route hints to reach the destination through private channels.

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.

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. QueryRoutesRequest
  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 QueryRoutesRequest(pubKey: String = "", amt: Long = 0L, amtMsat: Long = 0L, finalCltvDelta: Int = 0, feeLimit: Option[FeeLimit] = _root_.scala.None, ignoredNodes: Seq[ByteString] = _root_.scala.Seq.empty, ignoredEdges: Seq[EdgeLocator] = _root_.scala.Seq.empty, sourcePubKey: String = "", useMissionControl: Boolean = false, ignoredPairs: Seq[NodePair] = _root_.scala.Seq.empty, cltvLimit: UInt32 = lnrpc.QueryRoutesRequest._typemapper_cltvLimit.toCustom(0), destCustomRecords: Map[UInt64, ByteString] = _root_.scala.collection.immutable.Map.empty, outgoingChanId: UInt64 = lnrpc.QueryRoutesRequest._typemapper_outgoingChanId.toCustom(0L), lastHopPubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, routeHints: Seq[RouteHint] = _root_.scala.Seq.empty, destFeatures: Seq[FeatureBit] = _root_.scala.Seq.empty, timePref: Double = 0.0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    pubKey

    The 33-byte hex-encoded public key for the payment destination

    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.

    finalCltvDelta

    An optional CLTV delta from the current height that should be used for the timelock of the final hop. Note that unlike SendPayment, QueryRoutes does not add any additional block padding on top of final_ctlv_delta. This padding of a few blocks needs to be added manually or otherwise failures may happen when a block comes in while the payment is in flight.

    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.

    ignoredNodes

    A list of nodes to ignore during path finding. When using REST, these fields must be encoded as base64.

    ignoredEdges

    Deprecated. A list of edges to ignore during path finding.

    sourcePubKey

    The source node where the request route should originated from. If empty, self is assumed.

    useMissionControl

    If set to true, edge probabilities from mission control will be used to get the optimal route.

    ignoredPairs

    A list of directed node pairs that will be ignored during path finding.

    cltvLimit

    An optional maximum total time lock for the route. If the source is empty or ourselves, this should not exceed lnd's --max-cltv-expiry setting. If zero, then the value of --max-cltv-expiry is used as the limit.

    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. If the destination does not support the specified records, an error will be returned. Record types are required to be in the custom range >= 65536. When using REST, the values must be encoded as base64.

    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.

    routeHints

    Optional route hints to reach the destination through private channels.

    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.

    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[(UInt64, ByteString)]): QueryRoutesRequest
  5. def addAllDestFeatures(__vs: Iterable[FeatureBit]): QueryRoutesRequest
  6. def addAllIgnoredEdges(__vs: Iterable[EdgeLocator]): QueryRoutesRequest
  7. def addAllIgnoredNodes(__vs: Iterable[ByteString]): QueryRoutesRequest
  8. def addAllIgnoredPairs(__vs: Iterable[NodePair]): QueryRoutesRequest
  9. def addAllRouteHints(__vs: Iterable[RouteHint]): QueryRoutesRequest
  10. def addDestCustomRecords(__vs: (UInt64, ByteString)*): QueryRoutesRequest
  11. def addDestFeatures(__vs: FeatureBit*): QueryRoutesRequest
  12. def addIgnoredEdges(__vs: EdgeLocator*): QueryRoutesRequest
  13. def addIgnoredNodes(__vs: ByteString*): QueryRoutesRequest
  14. def addIgnoredPairs(__vs: NodePair*): QueryRoutesRequest
  15. def addRouteHints(__vs: RouteHint*): QueryRoutesRequest
  16. val amt: Long
  17. val amtMsat: Long
  18. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  19. def clearDestCustomRecords: QueryRoutesRequest
  20. def clearDestFeatures: QueryRoutesRequest
  21. def clearFeeLimit: QueryRoutesRequest
  22. def clearIgnoredEdges: QueryRoutesRequest
  23. def clearIgnoredNodes: QueryRoutesRequest
  24. def clearIgnoredPairs: QueryRoutesRequest
  25. def clearRouteHints: QueryRoutesRequest
  26. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  27. val cltvLimit: UInt32
  28. def companion: QueryRoutesRequest.type
    Definition Classes
    QueryRoutesRequest → GeneratedMessage
  29. val destCustomRecords: Map[UInt64, ByteString]
  30. val destFeatures: Seq[FeatureBit]
  31. def discardUnknownFields: QueryRoutesRequest
  32. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. val feeLimit: Option[FeeLimit]
  34. val finalCltvDelta: Int
  35. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  36. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  37. def getFeeLimit: FeeLimit
  38. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    QueryRoutesRequest → GeneratedMessage
  39. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    QueryRoutesRequest → GeneratedMessage
  40. val ignoredNodes: Seq[ByteString]
  41. val ignoredPairs: Seq[NodePair]
  42. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  43. val lastHopPubkey: ByteString
  44. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  46. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  47. val outgoingChanId: UInt64
  48. def productElementNames: Iterator[String]
    Definition Classes
    Product
  49. val pubKey: String
  50. val routeHints: Seq[RouteHint]
  51. def serializedSize: Int
    Definition Classes
    QueryRoutesRequest → GeneratedMessage
  52. val sourcePubKey: String
  53. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  54. val timePref: Double
  55. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  56. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  57. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  58. def toProtoString: String
    Definition Classes
    QueryRoutesRequest → GeneratedMessage
  59. val unknownFields: UnknownFieldSet
  60. def update(ms: (Lens[QueryRoutesRequest, QueryRoutesRequest]) => Mutation[QueryRoutesRequest]*): QueryRoutesRequest
    Definition Classes
    Updatable
  61. val useMissionControl: Boolean
  62. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  64. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  65. def withAmt(__v: Long): QueryRoutesRequest
  66. def withAmtMsat(__v: Long): QueryRoutesRequest
  67. def withCltvLimit(__v: UInt32): QueryRoutesRequest
  68. def withDestCustomRecords(__v: Map[UInt64, ByteString]): QueryRoutesRequest
  69. def withDestFeatures(__v: Seq[FeatureBit]): QueryRoutesRequest
  70. def withFeeLimit(__v: FeeLimit): QueryRoutesRequest
  71. def withFinalCltvDelta(__v: Int): QueryRoutesRequest
  72. def withIgnoredEdges(__v: Seq[EdgeLocator]): QueryRoutesRequest
  73. def withIgnoredNodes(__v: Seq[ByteString]): QueryRoutesRequest
  74. def withIgnoredPairs(__v: Seq[NodePair]): QueryRoutesRequest
  75. def withLastHopPubkey(__v: ByteString): QueryRoutesRequest
  76. def withOutgoingChanId(__v: UInt64): QueryRoutesRequest
  77. def withPubKey(__v: String): QueryRoutesRequest
  78. def withRouteHints(__v: Seq[RouteHint]): QueryRoutesRequest
  79. def withSourcePubKey(__v: String): QueryRoutesRequest
  80. def withTimePref(__v: Double): QueryRoutesRequest
  81. def withUnknownFields(__v: UnknownFieldSet): QueryRoutesRequest
  82. def withUseMissionControl(__v: Boolean): QueryRoutesRequest
  83. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  84. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    QueryRoutesRequest → GeneratedMessage
  85. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. val ignoredEdges: Seq[EdgeLocator]
    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