routerrpc
package routerrpc
- Alphabetic
- Public
- Protected
Type Members
- final case class AprioriParameters(halfLifeSeconds: Long = 0L, hopProbability: Double = 0.0, weight: Double = 0.0, capacityFraction: Double = 0.0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AprioriParameters] with Product with Serializable
- halfLifeSeconds
The amount of time mission control will take to restore a penalized node or channel back to 50% success probability, expressed in seconds. Setting this value to a higher value will penalize failures for longer, making mission control less likely to route through nodes and channels that we have previously recorded failures for.
- hopProbability
The probability of success mission control should assign to hop in a route where it has no other information available. Higher values will make mission control more willing to try hops that we have no information about, lower values will discourage trying these hops.
- weight
The importance that mission control should place on historical results, expressed as a value in [0;1]. Setting this value to 1 will ignore all historical payments and just use the hop probability to assess the probability of success for each hop. A zero value ignores hop probability completely and relies entirely on historical results, unless none are available.
- capacityFraction
The fraction of a channel's capacity that we consider to have liquidity. For amounts that come close to or exceed the fraction, an additional penalty is applied. A value of 1.0 disables the capacity factor. Allowed values are in [0.75, 1.0].
- Annotations
- @SerialVersionUID()
- final case class BimodalParameters(nodeWeight: Double = 0.0, scaleMsat: Long = 0L, decayTime: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BimodalParameters] with Product with Serializable
- nodeWeight
NodeWeight defines how strongly other previous forwardings on channels of a router should be taken into account when computing a channel's probability to route. The allowed values are in the range [0, 1], where a value of 0 means that only direct information about a channel is taken into account.
- scaleMsat
ScaleMsat describes the scale over which channels statistically have some liquidity left. The value determines how quickly the bimodal distribution drops off from the edges of a channel. A larger value (compared to typical channel capacities) means that the drop off is slow and that channel balances are distributed more uniformly. A small value leads to the assumption of very unbalanced channels.
- decayTime
DecayTime describes the information decay of knowledge about previous successes and failures in channels. The smaller the decay time, the quicker we forget about past forwardings.
- Annotations
- @SerialVersionUID()
- final case class BuildRouteRequest(amtMsat: Long = 0L, finalCltvDelta: Int = 0, outgoingChanId: Long = 0L, hopPubkeys: Seq[ByteString] = _root_.scala.Seq.empty, paymentAddr: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BuildRouteRequest] with Product with Serializable
- amtMsat
The amount to send expressed in msat. If set to zero, the minimum routable amount is used.
- finalCltvDelta
CLTV delta from the current height that should be used for the timelock of the final hop
- outgoingChanId
The channel id of the channel that must be taken to the first hop. If zero, any channel may be used.
- hopPubkeys
A list of hops that defines the route. This does not include the source hop pubkey.
- paymentAddr
An optional payment addr to be included within the last hop of the route.
- Annotations
- @SerialVersionUID()
- final case class BuildRouteResponse(route: Option[Route] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BuildRouteResponse] with Product with Serializable
- route
Fully specified route that can be used to execute the payment.
- Annotations
- @SerialVersionUID()
- sealed abstract class ChanStatusAction extends GeneratedEnum
- final case class CircuitKey(chanId: Long = 0L, htlcId: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CircuitKey] with Product with Serializable
- chanId
/ The id of the channel that the is part of this circuit.
- htlcId
/ The index of the incoming htlc in the incoming channel.
- Annotations
- @SerialVersionUID()
- sealed abstract class FailureDetail extends GeneratedEnum
- final case class FinalHtlcEvent(settled: Boolean = false, offchain: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FinalHtlcEvent] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class ForwardEvent(info: Option[HtlcInfo] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ForwardEvent] with Product with Serializable
- info
Info contains details about the htlc that was forwarded.
- Annotations
- @SerialVersionUID()
- final case class ForwardFailEvent(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ForwardFailEvent] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class ForwardHtlcInterceptRequest(incomingCircuitKey: Option[CircuitKey] = _root_.scala.None, incomingAmountMsat: Long = 0L, incomingExpiry: Int = 0, paymentHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, outgoingRequestedChanId: Long = 0L, outgoingAmountMsat: Long = 0L, outgoingExpiry: Int = 0, customRecords: Map[Long, ByteString] = _root_.scala.collection.immutable.Map.empty, onionBlob: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, autoFailHeight: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ForwardHtlcInterceptRequest] with Product with Serializable
- incomingCircuitKey
The key of this forwarded htlc. It defines the incoming channel id and the index in this channel.
- incomingAmountMsat
The incoming htlc amount.
- incomingExpiry
The incoming htlc expiry.
- paymentHash
The htlc payment hash. This value is not guaranteed to be unique per request.
- outgoingRequestedChanId
The requested outgoing channel id for this forwarded htlc. Because of non-strict forwarding, this isn't necessarily the channel over which the packet will be forwarded eventually. A different channel to the same peer may be selected as well.
- outgoingAmountMsat
The outgoing htlc amount.
- outgoingExpiry
The outgoing htlc expiry.
- customRecords
Any custom records that were present in the payload.
- onionBlob
The onion blob for the next hop
- autoFailHeight
The block height at which this htlc will be auto-failed to prevent the channel from force-closing.
- Annotations
- @SerialVersionUID()
- final case class ForwardHtlcInterceptResponse(incomingCircuitKey: Option[CircuitKey] = _root_.scala.None, action: ResolveHoldForwardAction = routerrpc.ResolveHoldForwardAction.SETTLE, preimage: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, failureMessage: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, failureCode: FailureCode = lnrpc.Failure.FailureCode.RESERVED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ForwardHtlcInterceptResponse] with Product with Serializable
* ForwardHtlcInterceptResponse enables the caller to resolve a previously hold forward.
* ForwardHtlcInterceptResponse enables the caller to resolve a previously hold forward. The caller can choose either to: -
Resume
: Execute the default behavior (usually forward). -Reject
: Fail the htlc backwards. -Settle
: Settle this htlc with a given preimage.- incomingCircuitKey
* The key of this forwarded htlc. It defines the incoming channel id and the index in this channel.
- action
The resolve action for this intercepted htlc.
- preimage
The preimage in case the resolve action is Settle.
- failureMessage
Encrypted failure message in case the resolve action is Fail. If failure_message is specified, the failure_code field must be set to zero.
- failureCode
Return the specified failure code in case the resolve action is Fail. The message data fields are populated automatically. If a non-zero failure_code is specified, failure_message must not be set. For backwards-compatibility reasons, TEMPORARY_CHANNEL_FAILURE is the default value for this field.
- Annotations
- @SerialVersionUID()
- final case class GetMissionControlConfigRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetMissionControlConfigRequest] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class GetMissionControlConfigResponse(config: Option[MissionControlConfig] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetMissionControlConfigResponse] with Product with Serializable
- config
Mission control's currently active config.
- Annotations
- @SerialVersionUID()
- final case class HtlcEvent(incomingChannelId: Long = 0L, outgoingChannelId: Long = 0L, incomingHtlcId: Long = 0L, outgoingHtlcId: Long = 0L, timestampNs: Long = 0L, eventType: EventType = routerrpc.HtlcEvent.EventType.UNKNOWN, event: Event = routerrpc.HtlcEvent.Event.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[HtlcEvent] with Product with Serializable
HtlcEvent contains the htlc event that was processed.
HtlcEvent contains the htlc event that was processed. These are served on a best-effort basis; events are not persisted, delivery is not guaranteed (in the event of a crash in the switch, forward events may be lost) and some events may be replayed upon restart. Events consumed from this package should be de-duplicated by the htlc's unique combination of incoming and outgoing channel id and htlc id. [EXPERIMENTAL]
- incomingChannelId
The short channel id that the incoming htlc arrived at our node on. This value is zero for sends.
- outgoingChannelId
The short channel id that the outgoing htlc left our node on. This value is zero for receives.
- incomingHtlcId
Incoming id is the index of the incoming htlc in the incoming channel. This value is zero for sends.
- outgoingHtlcId
Outgoing id is the index of the outgoing htlc in the outgoing channel. This value is zero for receives.
- timestampNs
The time in unix nanoseconds that the event occurred.
- eventType
The event type indicates whether the htlc was part of a send, receive or forward.
- Annotations
- @SerialVersionUID()
- final case class HtlcInfo(incomingTimelock: Int = 0, outgoingTimelock: Int = 0, incomingAmtMsat: Long = 0L, outgoingAmtMsat: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[HtlcInfo] with Product with Serializable
- incomingTimelock
The timelock on the incoming htlc.
- outgoingTimelock
The timelock on the outgoing htlc.
- incomingAmtMsat
The amount of the incoming htlc.
- outgoingAmtMsat
The amount of the outgoing htlc.
- Annotations
- @SerialVersionUID()
- final case class LinkFailEvent(info: Option[HtlcInfo] = _root_.scala.None, wireFailure: FailureCode = lnrpc.Failure.FailureCode.RESERVED, failureDetail: FailureDetail = routerrpc.FailureDetail.UNKNOWN, failureString: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[LinkFailEvent] with Product with Serializable
- info
Info contains details about the htlc that we failed.
- wireFailure
FailureCode is the BOLT error code for the failure.
- failureDetail
FailureDetail provides additional information about the reason for the failure. This detail enriches the information provided by the wire message and may be 'no detail' if the wire message requires no additional metadata.
- failureString
A string representation of the link failure.
- Annotations
- @SerialVersionUID()
- final case class MissionControlConfig(halfLifeSeconds: Long = 0L, hopProbability: Float = 0.0f, weight: Float = 0.0f, maximumPaymentResults: Int = 0, minimumFailureRelaxInterval: Long = 0L, model: ProbabilityModel = routerrpc.MissionControlConfig.ProbabilityModel.APRIORI, estimatorConfig: EstimatorConfig = routerrpc.MissionControlConfig.EstimatorConfig.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MissionControlConfig] with Product with Serializable
- halfLifeSeconds
Deprecated, use AprioriParameters. The amount of time mission control will take to restore a penalized node or channel back to 50% success probability, expressed in seconds. Setting this value to a higher value will penalize failures for longer, making mission control less likely to route through nodes and channels that we have previously recorded failures for.
- hopProbability
Deprecated, use AprioriParameters. The probability of success mission control should assign to hop in a route where it has no other information available. Higher values will make mission control more willing to try hops that we have no information about, lower values will discourage trying these hops.
- weight
Deprecated, use AprioriParameters. The importance that mission control should place on historical results, expressed as a value in [0;1]. Setting this value to 1 will ignore all historical payments and just use the hop probability to assess the probability of success for each hop. A zero value ignores hop probability completely and relies entirely on historical results, unless none are available.
- maximumPaymentResults
The maximum number of payment results that mission control will store.
- minimumFailureRelaxInterval
The minimum time that must have passed since the previously recorded failure before we raise the failure amount.
- model
ProbabilityModel defines which probability estimator should be used in pathfinding. Note that the bimodal estimator is experimental.
- Annotations
- @SerialVersionUID()
- final case class PairData(failTime: Long = 0L, failAmtSat: Long = 0L, failAmtMsat: Long = 0L, successTime: Long = 0L, successAmtSat: Long = 0L, successAmtMsat: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PairData] with Product with Serializable
- failTime
Time of last failure.
- failAmtSat
Lowest amount that failed to forward rounded to whole sats. This may be set to zero if the failure is independent of amount.
- failAmtMsat
Lowest amount that failed to forward in millisats. This may be set to zero if the failure is independent of amount.
- successTime
Time of last success.
- successAmtSat
Highest amount that we could successfully forward rounded to whole sats.
- successAmtMsat
Highest amount that we could successfully forward in millisats.
- Annotations
- @SerialVersionUID()
- final case class PairHistory(nodeFrom: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, nodeTo: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, history: Option[PairData] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PairHistory] with Product with Serializable
PairHistory contains the mission control state for a particular node pair.
PairHistory contains the mission control state for a particular node pair.
- nodeFrom
The source node pubkey of the pair.
- nodeTo
The destination node pubkey of the pair.
- Annotations
- @SerialVersionUID()
- sealed abstract class PaymentState extends GeneratedEnum
- final case class PaymentStatus(state: PaymentState = routerrpc.PaymentState.IN_FLIGHT, preimage: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, htlcs: Seq[HTLCAttempt] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PaymentStatus] with Product with Serializable
- state
Current state the payment is in.
- preimage
The pre-image of the payment when state is SUCCEEDED.
- htlcs
The HTLCs made in attempt to settle the payment [EXPERIMENTAL].
- Annotations
- @SerialVersionUID()
- final case class QueryMissionControlRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[QueryMissionControlRequest] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class QueryMissionControlResponse(pairs: Seq[PairHistory] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[QueryMissionControlResponse] with Product with Serializable
QueryMissionControlResponse contains mission control state.
QueryMissionControlResponse contains mission control state.
- pairs
Node pair-level mission control state.
- Annotations
- @SerialVersionUID()
- final case class QueryProbabilityRequest(fromNode: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, toNode: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, amtMsat: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[QueryProbabilityRequest] with Product with Serializable
- fromNode
The source node pubkey of the pair.
- toNode
The destination node pubkey of the pair.
- amtMsat
The amount for which to calculate a probability.
- Annotations
- @SerialVersionUID()
- final case class QueryProbabilityResponse(probability: Double = 0.0, history: Option[PairData] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[QueryProbabilityResponse] with Product with Serializable
- probability
The success probability for the requested pair.
- history
The historical data for the requested pair.
- Annotations
- @SerialVersionUID()
- final case class ResetMissionControlRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ResetMissionControlRequest] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class ResetMissionControlResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ResetMissionControlResponse] with Product with Serializable
- Annotations
- @SerialVersionUID()
- sealed abstract class ResolveHoldForwardAction extends GeneratedEnum
- final case class RouteFeeRequest(dest: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, amtSat: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RouteFeeRequest] with Product with Serializable
- dest
The destination once wishes to obtain a routing fee quote to.
- amtSat
The amount one wishes to send to the target destination.
- Annotations
- @SerialVersionUID()
- final case class RouteFeeResponse(routingFeeMsat: Long = 0L, timeLockDelay: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RouteFeeResponse] with Product with Serializable
- routingFeeMsat
A lower bound of the estimated fee to the target destination within the network, expressed in milli-satoshis.
- timeLockDelay
An estimate of the worst case time delay that can occur. Note that callers will still need to factor in the final CLTV delta of the last hop into this value.
- Annotations
- @SerialVersionUID()
- trait Router extends AnyRef
Router is a service that offers advanced interaction with the router subsystem of the daemon.
Router is a service that offers advanced interaction with the router subsystem of the daemon.
- Annotations
- @PekkoGrpcGenerated()
- trait RouterClient extends Router with RouterClientPowerApi with PekkoGrpcClient
- Annotations
- @PekkoGrpcGenerated()
- trait RouterClientPowerApi extends AnyRef
- Annotations
- @PekkoGrpcGenerated()
- 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()
- final case class SendToRouteRequest(paymentHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, route: Option[Route] = _root_.scala.None, skipTempErr: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SendToRouteRequest] with Product with Serializable
- paymentHash
The payment hash to use for the HTLC.
- route
Route that should be used to attempt to complete the payment.
- skipTempErr
Whether the payment should be marked as failed when a temporary error is returned from the given route. Set it to true so the payment won't be failed unless a terminal error is occurred, such as payment timeout, no routes, incorrect payment details, or insufficient funds.
- Annotations
- @SerialVersionUID()
- final case class SendToRouteResponse(preimage: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, failure: Option[Failure] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SendToRouteResponse] with Product with Serializable
- preimage
The preimage obtained by making the payment.
- failure
The failure message in case the payment failed.
- Annotations
- @SerialVersionUID()
- final case class SetMissionControlConfigRequest(config: Option[MissionControlConfig] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SetMissionControlConfigRequest] with Product with Serializable
- config
The config to set for mission control. Note that all values *must* be set, because the full config will be applied.
- Annotations
- @SerialVersionUID()
- final case class SetMissionControlConfigResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SetMissionControlConfigResponse] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class SettleEvent(preimage: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SettleEvent] with Product with Serializable
- preimage
The revealed preimage.
- Annotations
- @SerialVersionUID()
- final case class SubscribeHtlcEventsRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SubscribeHtlcEventsRequest] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class SubscribedEvent(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SubscribedEvent] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class TrackPaymentRequest(paymentHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, noInflightUpdates: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[TrackPaymentRequest] with Product with Serializable
- paymentHash
The hash of the payment to look up.
- noInflightUpdates
If set, only the final payment update is streamed back. Intermediate updates that show which htlcs are still in flight are suppressed.
- Annotations
- @SerialVersionUID()
- final case class TrackPaymentsRequest(noInflightUpdates: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[TrackPaymentsRequest] with Product with Serializable
- noInflightUpdates
If set, only the final payment updates are streamed back. Intermediate updates that show which htlcs are still in flight are suppressed.
- Annotations
- @SerialVersionUID()
- final case class UpdateChanStatusRequest(chanPoint: Option[ChannelPoint] = _root_.scala.None, action: ChanStatusAction = routerrpc.ChanStatusAction.ENABLE, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[UpdateChanStatusRequest] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class UpdateChanStatusResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[UpdateChanStatusResponse] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class XImportMissionControlRequest(pairs: Seq[PairHistory] = _root_.scala.Seq.empty, force: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[XImportMissionControlRequest] with Product with Serializable
- pairs
Node pair-level mission control state to be imported.
- force
Whether to force override MC pair history. Note that even with force override the failure pair is imported before the success pair and both still clamp existing failure/success amounts.
- Annotations
- @SerialVersionUID()
- final case class XImportMissionControlResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[XImportMissionControlResponse] with Product with Serializable
- Annotations
- @SerialVersionUID()
Value Members
- object AprioriParameters extends GeneratedMessageCompanion[AprioriParameters]
- object BimodalParameters extends GeneratedMessageCompanion[BimodalParameters]
- object BuildRouteRequest extends GeneratedMessageCompanion[BuildRouteRequest]
- object BuildRouteResponse extends GeneratedMessageCompanion[BuildRouteResponse]
- object ChanStatusAction extends GeneratedEnumCompanion[ChanStatusAction]
- object CircuitKey extends GeneratedMessageCompanion[CircuitKey]
- object FailureDetail extends GeneratedEnumCompanion[FailureDetail]
- object FinalHtlcEvent extends GeneratedMessageCompanion[FinalHtlcEvent]
- object ForwardEvent extends GeneratedMessageCompanion[ForwardEvent]
- object ForwardFailEvent extends GeneratedMessageCompanion[ForwardFailEvent]
- object ForwardHtlcInterceptRequest extends GeneratedMessageCompanion[ForwardHtlcInterceptRequest]
- object ForwardHtlcInterceptResponse extends GeneratedMessageCompanion[ForwardHtlcInterceptResponse]
- object GetMissionControlConfigRequest extends GeneratedMessageCompanion[GetMissionControlConfigRequest]
- object GetMissionControlConfigResponse extends GeneratedMessageCompanion[GetMissionControlConfigResponse]
- object HtlcEvent extends GeneratedMessageCompanion[HtlcEvent]
- object HtlcInfo extends GeneratedMessageCompanion[HtlcInfo]
- object LinkFailEvent extends GeneratedMessageCompanion[LinkFailEvent]
- object MissionControlConfig extends GeneratedMessageCompanion[MissionControlConfig]
- object PairData extends GeneratedMessageCompanion[PairData]
- object PairHistory extends GeneratedMessageCompanion[PairHistory]
- object PaymentState extends GeneratedEnumCompanion[PaymentState]
- object PaymentStatus extends GeneratedMessageCompanion[PaymentStatus]
- object QueryMissionControlRequest extends GeneratedMessageCompanion[QueryMissionControlRequest]
- object QueryMissionControlResponse extends GeneratedMessageCompanion[QueryMissionControlResponse]
- object QueryProbabilityRequest extends GeneratedMessageCompanion[QueryProbabilityRequest]
- object QueryProbabilityResponse extends GeneratedMessageCompanion[QueryProbabilityResponse]
- object ResetMissionControlRequest extends GeneratedMessageCompanion[ResetMissionControlRequest]
- object ResetMissionControlResponse extends GeneratedMessageCompanion[ResetMissionControlResponse]
- object ResolveHoldForwardAction extends GeneratedEnumCompanion[ResolveHoldForwardAction]
- object RouteFeeRequest extends GeneratedMessageCompanion[RouteFeeRequest]
- object RouteFeeResponse extends GeneratedMessageCompanion[RouteFeeResponse]
- object Router extends ServiceDescription
- Annotations
- @PekkoGrpcGenerated()
- object RouterClient
- Annotations
- @PekkoGrpcGenerated()
- object RouterHandler
- Annotations
- @ApiMayChange() @PekkoGrpcGenerated()
- object RouterProto extends GeneratedFileObject
- object SendPaymentRequest extends GeneratedMessageCompanion[SendPaymentRequest]
- object SendToRouteRequest extends GeneratedMessageCompanion[SendToRouteRequest]
- object SendToRouteResponse extends GeneratedMessageCompanion[SendToRouteResponse]
- object SetMissionControlConfigRequest extends GeneratedMessageCompanion[SetMissionControlConfigRequest]
- object SetMissionControlConfigResponse extends GeneratedMessageCompanion[SetMissionControlConfigResponse]
- object SettleEvent extends GeneratedMessageCompanion[SettleEvent]
- object SubscribeHtlcEventsRequest extends GeneratedMessageCompanion[SubscribeHtlcEventsRequest]
- object SubscribedEvent extends GeneratedMessageCompanion[SubscribedEvent]
- object TrackPaymentRequest extends GeneratedMessageCompanion[TrackPaymentRequest]
- object TrackPaymentsRequest extends GeneratedMessageCompanion[TrackPaymentsRequest]
- object UpdateChanStatusRequest extends GeneratedMessageCompanion[UpdateChanStatusRequest]
- object UpdateChanStatusResponse extends GeneratedMessageCompanion[UpdateChanStatusResponse]
- object XImportMissionControlRequest extends GeneratedMessageCompanion[XImportMissionControlRequest]
- object XImportMissionControlResponse extends GeneratedMessageCompanion[XImportMissionControlResponse]