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()
- Alphabetic
- By Inheritance
- QueryRoutesRequest
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
- 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[(UInt64, ByteString)]): QueryRoutesRequest
- def addAllDestFeatures(__vs: Iterable[FeatureBit]): QueryRoutesRequest
- def addAllIgnoredEdges(__vs: Iterable[EdgeLocator]): QueryRoutesRequest
- def addAllIgnoredNodes(__vs: Iterable[ByteString]): QueryRoutesRequest
- def addAllIgnoredPairs(__vs: Iterable[NodePair]): QueryRoutesRequest
- def addAllRouteHints(__vs: Iterable[RouteHint]): QueryRoutesRequest
- def addDestCustomRecords(__vs: (UInt64, ByteString)*): QueryRoutesRequest
- def addDestFeatures(__vs: FeatureBit*): QueryRoutesRequest
- def addIgnoredEdges(__vs: EdgeLocator*): QueryRoutesRequest
- def addIgnoredNodes(__vs: ByteString*): QueryRoutesRequest
- def addIgnoredPairs(__vs: NodePair*): QueryRoutesRequest
- def addRouteHints(__vs: RouteHint*): QueryRoutesRequest
- val amt: Long
- val amtMsat: Long
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearDestCustomRecords: QueryRoutesRequest
- def clearDestFeatures: QueryRoutesRequest
- def clearFeeLimit: QueryRoutesRequest
- def clearIgnoredEdges: QueryRoutesRequest
- def clearIgnoredNodes: QueryRoutesRequest
- def clearIgnoredPairs: QueryRoutesRequest
- def clearRouteHints: QueryRoutesRequest
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val cltvLimit: UInt32
- def companion: QueryRoutesRequest.type
- Definition Classes
- QueryRoutesRequest → GeneratedMessage
- val destCustomRecords: Map[UInt64, ByteString]
- val destFeatures: Seq[FeatureBit]
- def discardUnknownFields: QueryRoutesRequest
- 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[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getFeeLimit: FeeLimit
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- QueryRoutesRequest → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- QueryRoutesRequest → GeneratedMessage
- val ignoredNodes: Seq[ByteString]
- val ignoredPairs: Seq[NodePair]
- 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: UInt64
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val pubKey: String
- val routeHints: Seq[RouteHint]
- def serializedSize: Int
- Definition Classes
- QueryRoutesRequest → GeneratedMessage
- val sourcePubKey: String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timePref: Double
- 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
- QueryRoutesRequest → GeneratedMessage
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[QueryRoutesRequest, QueryRoutesRequest]) => Mutation[QueryRoutesRequest]*): QueryRoutesRequest
- Definition Classes
- Updatable
- val useMissionControl: Boolean
- 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 withAmt(__v: Long): QueryRoutesRequest
- def withAmtMsat(__v: Long): QueryRoutesRequest
- def withCltvLimit(__v: UInt32): QueryRoutesRequest
- def withDestCustomRecords(__v: Map[UInt64, ByteString]): QueryRoutesRequest
- def withDestFeatures(__v: Seq[FeatureBit]): QueryRoutesRequest
- def withFeeLimit(__v: FeeLimit): QueryRoutesRequest
- def withFinalCltvDelta(__v: Int): QueryRoutesRequest
- def withIgnoredEdges(__v: Seq[EdgeLocator]): QueryRoutesRequest
- def withIgnoredNodes(__v: Seq[ByteString]): QueryRoutesRequest
- def withIgnoredPairs(__v: Seq[NodePair]): QueryRoutesRequest
- def withLastHopPubkey(__v: ByteString): QueryRoutesRequest
- def withOutgoingChanId(__v: UInt64): QueryRoutesRequest
- def withPubKey(__v: String): QueryRoutesRequest
- def withRouteHints(__v: Seq[RouteHint]): QueryRoutesRequest
- def withSourcePubKey(__v: String): QueryRoutesRequest
- def withTimePref(__v: Double): QueryRoutesRequest
- def withUnknownFields(__v: UnknownFieldSet): QueryRoutesRequest
- def withUseMissionControl(__v: Boolean): QueryRoutesRequest
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- QueryRoutesRequest → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
Deprecated Value Members
- val ignoredEdges: Seq[EdgeLocator]
- Annotations
- @deprecated
- Deprecated
(Since version ) Marked as deprecated in proto file