trait RouterClient extends Router with RouterClientPowerApi with PekkoGrpcClient
- Annotations
- @PekkoGrpcGenerated()
- Alphabetic
- By Inheritance
- RouterClient
- PekkoGrpcClient
- RouterClientPowerApi
- Router
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def buildRoute(in: BuildRouteRequest): Future[BuildRouteResponse]
BuildRoute builds a fully specified route based on a list of hop public keys.
BuildRoute builds a fully specified route based on a list of hop public keys. It retrieves the relevant channel policies from the graph in order to calculate the correct fees and time locks.
- Definition Classes
- Router
- abstract def close(): Future[Done]
- Definition Classes
- PekkoGrpcClient
- abstract def closed: Future[Done]
- Definition Classes
- PekkoGrpcClient
- abstract def estimateRouteFee(in: RouteFeeRequest): Future[RouteFeeResponse]
EstimateRouteFee allows callers to obtain a lower bound w.r.t how much it may cost to send an HTLC to the target end destination.
EstimateRouteFee allows callers to obtain a lower bound w.r.t how much it may cost to send an HTLC to the target end destination.
- Definition Classes
- Router
- abstract def getMissionControlConfig(in: GetMissionControlConfigRequest): Future[GetMissionControlConfigResponse]
GetMissionControlConfig returns mission control's current config.
GetMissionControlConfig returns mission control's current config.
- Definition Classes
- Router
- abstract def htlcInterceptor(in: Source[ForwardHtlcInterceptResponse, NotUsed]): Source[ForwardHtlcInterceptRequest, NotUsed]
* HtlcInterceptor dispatches a bi-directional streaming RPC in which Forwarded HTLC requests are sent to the client and the client responds with a boolean that tells LND if this htlc should be intercepted.
* HtlcInterceptor dispatches a bi-directional streaming RPC in which Forwarded HTLC requests are sent to the client and the client responds with a boolean that tells LND if this htlc should be intercepted. In case of interception, the htlc can be either settled, cancelled or resumed later by using the ResolveHoldForward endpoint.
- Definition Classes
- Router
- abstract def queryMissionControl(in: QueryMissionControlRequest): Future[QueryMissionControlResponse]
QueryMissionControl exposes the internal mission control state to callers.
QueryMissionControl exposes the internal mission control state to callers. It is a development feature.
- Definition Classes
- Router
- abstract def queryProbability(in: QueryProbabilityRequest): Future[QueryProbabilityResponse]
Deprecated.
Deprecated. QueryProbability returns the current success probability estimate for a given node pair and amount. The call returns a zero success probability if no channel is available or if the amount violates min/max HTLC constraints.
- Definition Classes
- Router
- abstract def resetMissionControl(in: ResetMissionControlRequest): Future[ResetMissionControlResponse]
ResetMissionControl clears all mission control state and starts with a clean slate.
ResetMissionControl clears all mission control state and starts with a clean slate.
- Definition Classes
- Router
- abstract def sendPayment(in: SendPaymentRequest): Source[PaymentStatus, NotUsed]
Deprecated, use SendPaymentV2.
Deprecated, use SendPaymentV2. SendPayment attempts to route a payment described by the passed PaymentRequest to the final destination. The call returns a stream of payment status updates.
- Definition Classes
- Router
- abstract def sendPaymentV2(in: SendPaymentRequest): Source[Payment, NotUsed]
SendPaymentV2 attempts to route a payment described by the passed PaymentRequest to the final destination.
SendPaymentV2 attempts to route a payment described by the passed PaymentRequest to the final destination. The call returns a stream of payment updates.
- Definition Classes
- Router
- abstract def sendToRoute(in: SendToRouteRequest): Future[SendToRouteResponse]
Deprecated, use SendToRouteV2.
Deprecated, use SendToRouteV2. SendToRoute attempts to make a payment via the specified route. This method differs from SendPayment in that it allows users to specify a full route manually. This can be used for things like rebalancing, and atomic swaps. It differs from the newer SendToRouteV2 in that it doesn't return the full HTLC information.
- Definition Classes
- Router
- abstract def sendToRouteV2(in: SendToRouteRequest): Future[HTLCAttempt]
SendToRouteV2 attempts to make a payment via the specified route.
SendToRouteV2 attempts to make a payment via the specified route. This method differs from SendPayment in that it allows users to specify a full route manually. This can be used for things like rebalancing, and atomic swaps.
- Definition Classes
- Router
- abstract def setMissionControlConfig(in: SetMissionControlConfigRequest): Future[SetMissionControlConfigResponse]
SetMissionControlConfig will set mission control's config, if the config provided is valid.
SetMissionControlConfig will set mission control's config, if the config provided is valid.
- Definition Classes
- Router
- abstract def subscribeHtlcEvents(in: SubscribeHtlcEventsRequest): Source[HtlcEvent, NotUsed]
SubscribeHtlcEvents creates a uni-directional stream from the server to the client which delivers a stream of htlc events.
SubscribeHtlcEvents creates a uni-directional stream from the server to the client which delivers a stream of htlc events.
- Definition Classes
- Router
- abstract def trackPayment(in: TrackPaymentRequest): Source[PaymentStatus, NotUsed]
Deprecated, use TrackPaymentV2.
Deprecated, use TrackPaymentV2. TrackPayment returns an update stream for the payment identified by the payment hash.
- Definition Classes
- Router
- abstract def trackPaymentV2(in: TrackPaymentRequest): Source[Payment, NotUsed]
TrackPaymentV2 returns an update stream for the payment identified by the payment hash.
TrackPaymentV2 returns an update stream for the payment identified by the payment hash.
- Definition Classes
- Router
- abstract def trackPayments(in: TrackPaymentsRequest): Source[Payment, NotUsed]
TrackPayments returns an update stream for every payment that is not in a terminal state.
TrackPayments returns an update stream for every payment that is not in a terminal state. Note that if payments are in-flight while starting a new subscription, the start of the payment stream could produce out-of-order and/or duplicate events. In order to get updates for every in-flight payment attempt make sure to subscribe to this method before initiating any payments.
- Definition Classes
- Router
- abstract def updateChanStatus(in: UpdateChanStatusRequest): Future[UpdateChanStatusResponse]
UpdateChanStatus attempts to manually set the state of a channel (enabled, disabled, or auto).
UpdateChanStatus attempts to manually set the state of a channel (enabled, disabled, or auto). A manual "disable" request will cause the channel to stay disabled until a subsequent manual request of either "enable" or "auto".
- Definition Classes
- Router
- abstract def xImportMissionControl(in: XImportMissionControlRequest): Future[XImportMissionControlResponse]
XImportMissionControl is an experimental API that imports the state provided to the internal mission control's state, using all results which are more recent than our existing values.
XImportMissionControl is an experimental API that imports the state provided to the internal mission control's state, using all results which are more recent than our existing values. These values will only be imported in-memory, and will not be persisted across restarts.
- Definition Classes
- Router
Concrete 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def buildRoute(): SingleResponseRequestBuilder[BuildRouteRequest, BuildRouteResponse]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer buildRoute(routerrpc.BuildRouteRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def estimateRouteFee(): SingleResponseRequestBuilder[RouteFeeRequest, RouteFeeResponse]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer estimateRouteFee(routerrpc.RouteFeeRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- 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 getMissionControlConfig(): SingleResponseRequestBuilder[GetMissionControlConfigRequest, GetMissionControlConfigResponse]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer getMissionControlConfig(routerrpc.GetMissionControlConfigRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def htlcInterceptor(): StreamResponseRequestBuilder[Source[ForwardHtlcInterceptResponse, NotUsed], ForwardHtlcInterceptRequest]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer htlcInterceptor(org.apache.pekko.stream.scaladsl.Source[routerrpc.ForwardHtlcInterceptResponse, org.apache.pekko.NotUsed]) if possible.
- Definition Classes
- RouterClientPowerApi
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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()
- def queryMissionControl(): SingleResponseRequestBuilder[QueryMissionControlRequest, QueryMissionControlResponse]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer queryMissionControl(routerrpc.QueryMissionControlRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- def queryProbability(): SingleResponseRequestBuilder[QueryProbabilityRequest, QueryProbabilityResponse]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer queryProbability(routerrpc.QueryProbabilityRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- def resetMissionControl(): SingleResponseRequestBuilder[ResetMissionControlRequest, ResetMissionControlResponse]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer resetMissionControl(routerrpc.ResetMissionControlRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- def sendPayment(): StreamResponseRequestBuilder[SendPaymentRequest, PaymentStatus]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer sendPayment(routerrpc.SendPaymentRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- def sendPaymentV2(): StreamResponseRequestBuilder[SendPaymentRequest, Payment]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer sendPaymentV2(routerrpc.SendPaymentRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- def sendToRoute(): SingleResponseRequestBuilder[SendToRouteRequest, SendToRouteResponse]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer sendToRoute(routerrpc.SendToRouteRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- def sendToRouteV2(): SingleResponseRequestBuilder[SendToRouteRequest, HTLCAttempt]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer sendToRouteV2(routerrpc.SendToRouteRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- def setMissionControlConfig(): SingleResponseRequestBuilder[SetMissionControlConfigRequest, SetMissionControlConfigResponse]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer setMissionControlConfig(routerrpc.SetMissionControlConfigRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- def subscribeHtlcEvents(): StreamResponseRequestBuilder[SubscribeHtlcEventsRequest, HtlcEvent]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer subscribeHtlcEvents(routerrpc.SubscribeHtlcEventsRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def trackPayment(): StreamResponseRequestBuilder[TrackPaymentRequest, PaymentStatus]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer trackPayment(routerrpc.TrackPaymentRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- def trackPaymentV2(): StreamResponseRequestBuilder[TrackPaymentRequest, Payment]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer trackPaymentV2(routerrpc.TrackPaymentRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- def trackPayments(): StreamResponseRequestBuilder[TrackPaymentsRequest, Payment]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer trackPayments(routerrpc.TrackPaymentsRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- def updateChanStatus(): SingleResponseRequestBuilder[UpdateChanStatusRequest, UpdateChanStatusResponse]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer updateChanStatus(routerrpc.UpdateChanStatusRequest) if possible.
- Definition Classes
- RouterClientPowerApi
- 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 xImportMissionControl(): SingleResponseRequestBuilder[XImportMissionControlRequest, XImportMissionControlResponse]
Lower level "lifted" version of the method, giving access to request metadata etc.
Lower level "lifted" version of the method, giving access to request metadata etc. prefer xImportMissionControl(routerrpc.XImportMissionControlRequest) if possible.
- Definition Classes
- RouterClientPowerApi