routerrpc.Router.scala Maven / Gradle / Ivy
The newest version!
// Generated by Pekko gRPC. DO NOT EDIT.
package routerrpc
import org.apache.pekko
import pekko.annotation.ApiMayChange
import pekko.grpc.PekkoGrpcGenerated
/**
* Router is a service that offers advanced interaction with the router
* subsystem of the daemon.
*/
@PekkoGrpcGenerated
trait Router {
/**
* SendPaymentV2 attempts to route a payment described by the passed
* PaymentRequest to the final destination. The call returns a stream of
* payment updates.
*/
def sendPaymentV2(in: routerrpc.SendPaymentRequest): org.apache.pekko.stream.scaladsl.Source[lnrpc.Payment, org.apache.pekko.NotUsed]
/**
* TrackPaymentV2 returns an update stream for the payment identified by the
* payment hash.
*/
def trackPaymentV2(in: routerrpc.TrackPaymentRequest): org.apache.pekko.stream.scaladsl.Source[lnrpc.Payment, org.apache.pekko.NotUsed]
/**
* 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.
*/
def trackPayments(in: routerrpc.TrackPaymentsRequest): org.apache.pekko.stream.scaladsl.Source[lnrpc.Payment, org.apache.pekko.NotUsed]
/**
* 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.
*/
def estimateRouteFee(in: routerrpc.RouteFeeRequest): scala.concurrent.Future[routerrpc.RouteFeeResponse]
/**
* 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.
*/
def sendToRoute(in: routerrpc.SendToRouteRequest): scala.concurrent.Future[routerrpc.SendToRouteResponse]
/**
* 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.
*/
def sendToRouteV2(in: routerrpc.SendToRouteRequest): scala.concurrent.Future[lnrpc.HTLCAttempt]
/**
* ResetMissionControl clears all mission control state and starts with a clean
* slate.
*/
def resetMissionControl(in: routerrpc.ResetMissionControlRequest): scala.concurrent.Future[routerrpc.ResetMissionControlResponse]
/**
* QueryMissionControl exposes the internal mission control state to callers.
* It is a development feature.
*/
def queryMissionControl(in: routerrpc.QueryMissionControlRequest): scala.concurrent.Future[routerrpc.QueryMissionControlResponse]
/**
* 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.
*/
def xImportMissionControl(in: routerrpc.XImportMissionControlRequest): scala.concurrent.Future[routerrpc.XImportMissionControlResponse]
/**
* GetMissionControlConfig returns mission control's current config.
*/
def getMissionControlConfig(in: routerrpc.GetMissionControlConfigRequest): scala.concurrent.Future[routerrpc.GetMissionControlConfigResponse]
/**
* SetMissionControlConfig will set mission control's config, if the config
* provided is valid.
*/
def setMissionControlConfig(in: routerrpc.SetMissionControlConfigRequest): scala.concurrent.Future[routerrpc.SetMissionControlConfigResponse]
/**
* 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.
*/
def queryProbability(in: routerrpc.QueryProbabilityRequest): scala.concurrent.Future[routerrpc.QueryProbabilityResponse]
/**
* 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.
*/
def buildRoute(in: routerrpc.BuildRouteRequest): scala.concurrent.Future[routerrpc.BuildRouteResponse]
/**
* SubscribeHtlcEvents creates a uni-directional stream from the server to
* the client which delivers a stream of htlc events.
*/
def subscribeHtlcEvents(in: routerrpc.SubscribeHtlcEventsRequest): org.apache.pekko.stream.scaladsl.Source[routerrpc.HtlcEvent, org.apache.pekko.NotUsed]
/**
* 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.
*/
def sendPayment(in: routerrpc.SendPaymentRequest): org.apache.pekko.stream.scaladsl.Source[routerrpc.PaymentStatus, org.apache.pekko.NotUsed]
/**
* Deprecated, use TrackPaymentV2. TrackPayment returns an update stream for
* the payment identified by the payment hash.
*/
def trackPayment(in: routerrpc.TrackPaymentRequest): org.apache.pekko.stream.scaladsl.Source[routerrpc.PaymentStatus, org.apache.pekko.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.
* In case of interception, the htlc can be either settled, cancelled or
* resumed later by using the ResolveHoldForward endpoint.
*/
def htlcInterceptor(in: org.apache.pekko.stream.scaladsl.Source[routerrpc.ForwardHtlcInterceptResponse, org.apache.pekko.NotUsed]): org.apache.pekko.stream.scaladsl.Source[routerrpc.ForwardHtlcInterceptRequest, org.apache.pekko.NotUsed]
/**
* 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".
*/
def updateChanStatus(in: routerrpc.UpdateChanStatusRequest): scala.concurrent.Future[routerrpc.UpdateChanStatusResponse]
}
@PekkoGrpcGenerated
object Router extends pekko.grpc.ServiceDescription {
val name = "routerrpc.Router"
val descriptor: com.google.protobuf.Descriptors.FileDescriptor =
routerrpc.RouterProto.javaDescriptor;
object Serializers {
import pekko.grpc.scaladsl.ScalapbProtobufSerializer
val SendPaymentRequestSerializer = new ScalapbProtobufSerializer(routerrpc.SendPaymentRequest.messageCompanion)
val TrackPaymentRequestSerializer = new ScalapbProtobufSerializer(routerrpc.TrackPaymentRequest.messageCompanion)
val TrackPaymentsRequestSerializer = new ScalapbProtobufSerializer(routerrpc.TrackPaymentsRequest.messageCompanion)
val RouteFeeRequestSerializer = new ScalapbProtobufSerializer(routerrpc.RouteFeeRequest.messageCompanion)
val SendToRouteRequestSerializer = new ScalapbProtobufSerializer(routerrpc.SendToRouteRequest.messageCompanion)
val ResetMissionControlRequestSerializer = new ScalapbProtobufSerializer(routerrpc.ResetMissionControlRequest.messageCompanion)
val QueryMissionControlRequestSerializer = new ScalapbProtobufSerializer(routerrpc.QueryMissionControlRequest.messageCompanion)
val XImportMissionControlRequestSerializer = new ScalapbProtobufSerializer(routerrpc.XImportMissionControlRequest.messageCompanion)
val GetMissionControlConfigRequestSerializer = new ScalapbProtobufSerializer(routerrpc.GetMissionControlConfigRequest.messageCompanion)
val SetMissionControlConfigRequestSerializer = new ScalapbProtobufSerializer(routerrpc.SetMissionControlConfigRequest.messageCompanion)
val QueryProbabilityRequestSerializer = new ScalapbProtobufSerializer(routerrpc.QueryProbabilityRequest.messageCompanion)
val BuildRouteRequestSerializer = new ScalapbProtobufSerializer(routerrpc.BuildRouteRequest.messageCompanion)
val SubscribeHtlcEventsRequestSerializer = new ScalapbProtobufSerializer(routerrpc.SubscribeHtlcEventsRequest.messageCompanion)
val ForwardHtlcInterceptResponseSerializer = new ScalapbProtobufSerializer(routerrpc.ForwardHtlcInterceptResponse.messageCompanion)
val UpdateChanStatusRequestSerializer = new ScalapbProtobufSerializer(routerrpc.UpdateChanStatusRequest.messageCompanion)
val lnrpc_PaymentSerializer = new ScalapbProtobufSerializer(lnrpc.Payment.messageCompanion)
val RouteFeeResponseSerializer = new ScalapbProtobufSerializer(routerrpc.RouteFeeResponse.messageCompanion)
val SendToRouteResponseSerializer = new ScalapbProtobufSerializer(routerrpc.SendToRouteResponse.messageCompanion)
val lnrpc_HTLCAttemptSerializer = new ScalapbProtobufSerializer(lnrpc.HTLCAttempt.messageCompanion)
val ResetMissionControlResponseSerializer = new ScalapbProtobufSerializer(routerrpc.ResetMissionControlResponse.messageCompanion)
val QueryMissionControlResponseSerializer = new ScalapbProtobufSerializer(routerrpc.QueryMissionControlResponse.messageCompanion)
val XImportMissionControlResponseSerializer = new ScalapbProtobufSerializer(routerrpc.XImportMissionControlResponse.messageCompanion)
val GetMissionControlConfigResponseSerializer = new ScalapbProtobufSerializer(routerrpc.GetMissionControlConfigResponse.messageCompanion)
val SetMissionControlConfigResponseSerializer = new ScalapbProtobufSerializer(routerrpc.SetMissionControlConfigResponse.messageCompanion)
val QueryProbabilityResponseSerializer = new ScalapbProtobufSerializer(routerrpc.QueryProbabilityResponse.messageCompanion)
val BuildRouteResponseSerializer = new ScalapbProtobufSerializer(routerrpc.BuildRouteResponse.messageCompanion)
val HtlcEventSerializer = new ScalapbProtobufSerializer(routerrpc.HtlcEvent.messageCompanion)
val PaymentStatusSerializer = new ScalapbProtobufSerializer(routerrpc.PaymentStatus.messageCompanion)
val ForwardHtlcInterceptRequestSerializer = new ScalapbProtobufSerializer(routerrpc.ForwardHtlcInterceptRequest.messageCompanion)
val UpdateChanStatusResponseSerializer = new ScalapbProtobufSerializer(routerrpc.UpdateChanStatusResponse.messageCompanion)
}
@ApiMayChange
@PekkoGrpcGenerated
object MethodDescriptors {
import pekko.grpc.internal.Marshaller
import io.grpc.MethodDescriptor
import Serializers._
val sendPaymentV2Descriptor: MethodDescriptor[routerrpc.SendPaymentRequest, lnrpc.Payment] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.SERVER_STREAMING
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "SendPaymentV2"))
.setRequestMarshaller(new Marshaller(SendPaymentRequestSerializer))
.setResponseMarshaller(new Marshaller(lnrpc_PaymentSerializer))
.setSampledToLocalTracing(true)
.build()
val trackPaymentV2Descriptor: MethodDescriptor[routerrpc.TrackPaymentRequest, lnrpc.Payment] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.SERVER_STREAMING
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "TrackPaymentV2"))
.setRequestMarshaller(new Marshaller(TrackPaymentRequestSerializer))
.setResponseMarshaller(new Marshaller(lnrpc_PaymentSerializer))
.setSampledToLocalTracing(true)
.build()
val trackPaymentsDescriptor: MethodDescriptor[routerrpc.TrackPaymentsRequest, lnrpc.Payment] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.SERVER_STREAMING
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "TrackPayments"))
.setRequestMarshaller(new Marshaller(TrackPaymentsRequestSerializer))
.setResponseMarshaller(new Marshaller(lnrpc_PaymentSerializer))
.setSampledToLocalTracing(true)
.build()
val estimateRouteFeeDescriptor: MethodDescriptor[routerrpc.RouteFeeRequest, routerrpc.RouteFeeResponse] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.UNARY
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "EstimateRouteFee"))
.setRequestMarshaller(new Marshaller(RouteFeeRequestSerializer))
.setResponseMarshaller(new Marshaller(RouteFeeResponseSerializer))
.setSampledToLocalTracing(true)
.build()
val sendToRouteDescriptor: MethodDescriptor[routerrpc.SendToRouteRequest, routerrpc.SendToRouteResponse] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.UNARY
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "SendToRoute"))
.setRequestMarshaller(new Marshaller(SendToRouteRequestSerializer))
.setResponseMarshaller(new Marshaller(SendToRouteResponseSerializer))
.setSampledToLocalTracing(true)
.build()
val sendToRouteV2Descriptor: MethodDescriptor[routerrpc.SendToRouteRequest, lnrpc.HTLCAttempt] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.UNARY
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "SendToRouteV2"))
.setRequestMarshaller(new Marshaller(SendToRouteRequestSerializer))
.setResponseMarshaller(new Marshaller(lnrpc_HTLCAttemptSerializer))
.setSampledToLocalTracing(true)
.build()
val resetMissionControlDescriptor: MethodDescriptor[routerrpc.ResetMissionControlRequest, routerrpc.ResetMissionControlResponse] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.UNARY
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "ResetMissionControl"))
.setRequestMarshaller(new Marshaller(ResetMissionControlRequestSerializer))
.setResponseMarshaller(new Marshaller(ResetMissionControlResponseSerializer))
.setSampledToLocalTracing(true)
.build()
val queryMissionControlDescriptor: MethodDescriptor[routerrpc.QueryMissionControlRequest, routerrpc.QueryMissionControlResponse] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.UNARY
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "QueryMissionControl"))
.setRequestMarshaller(new Marshaller(QueryMissionControlRequestSerializer))
.setResponseMarshaller(new Marshaller(QueryMissionControlResponseSerializer))
.setSampledToLocalTracing(true)
.build()
val xImportMissionControlDescriptor: MethodDescriptor[routerrpc.XImportMissionControlRequest, routerrpc.XImportMissionControlResponse] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.UNARY
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "XImportMissionControl"))
.setRequestMarshaller(new Marshaller(XImportMissionControlRequestSerializer))
.setResponseMarshaller(new Marshaller(XImportMissionControlResponseSerializer))
.setSampledToLocalTracing(true)
.build()
val getMissionControlConfigDescriptor: MethodDescriptor[routerrpc.GetMissionControlConfigRequest, routerrpc.GetMissionControlConfigResponse] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.UNARY
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "GetMissionControlConfig"))
.setRequestMarshaller(new Marshaller(GetMissionControlConfigRequestSerializer))
.setResponseMarshaller(new Marshaller(GetMissionControlConfigResponseSerializer))
.setSampledToLocalTracing(true)
.build()
val setMissionControlConfigDescriptor: MethodDescriptor[routerrpc.SetMissionControlConfigRequest, routerrpc.SetMissionControlConfigResponse] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.UNARY
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "SetMissionControlConfig"))
.setRequestMarshaller(new Marshaller(SetMissionControlConfigRequestSerializer))
.setResponseMarshaller(new Marshaller(SetMissionControlConfigResponseSerializer))
.setSampledToLocalTracing(true)
.build()
val queryProbabilityDescriptor: MethodDescriptor[routerrpc.QueryProbabilityRequest, routerrpc.QueryProbabilityResponse] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.UNARY
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "QueryProbability"))
.setRequestMarshaller(new Marshaller(QueryProbabilityRequestSerializer))
.setResponseMarshaller(new Marshaller(QueryProbabilityResponseSerializer))
.setSampledToLocalTracing(true)
.build()
val buildRouteDescriptor: MethodDescriptor[routerrpc.BuildRouteRequest, routerrpc.BuildRouteResponse] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.UNARY
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "BuildRoute"))
.setRequestMarshaller(new Marshaller(BuildRouteRequestSerializer))
.setResponseMarshaller(new Marshaller(BuildRouteResponseSerializer))
.setSampledToLocalTracing(true)
.build()
val subscribeHtlcEventsDescriptor: MethodDescriptor[routerrpc.SubscribeHtlcEventsRequest, routerrpc.HtlcEvent] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.SERVER_STREAMING
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "SubscribeHtlcEvents"))
.setRequestMarshaller(new Marshaller(SubscribeHtlcEventsRequestSerializer))
.setResponseMarshaller(new Marshaller(HtlcEventSerializer))
.setSampledToLocalTracing(true)
.build()
val sendPaymentDescriptor: MethodDescriptor[routerrpc.SendPaymentRequest, routerrpc.PaymentStatus] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.SERVER_STREAMING
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "SendPayment"))
.setRequestMarshaller(new Marshaller(SendPaymentRequestSerializer))
.setResponseMarshaller(new Marshaller(PaymentStatusSerializer))
.setSampledToLocalTracing(true)
.build()
val trackPaymentDescriptor: MethodDescriptor[routerrpc.TrackPaymentRequest, routerrpc.PaymentStatus] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.SERVER_STREAMING
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "TrackPayment"))
.setRequestMarshaller(new Marshaller(TrackPaymentRequestSerializer))
.setResponseMarshaller(new Marshaller(PaymentStatusSerializer))
.setSampledToLocalTracing(true)
.build()
val htlcInterceptorDescriptor: MethodDescriptor[routerrpc.ForwardHtlcInterceptResponse, routerrpc.ForwardHtlcInterceptRequest] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.BIDI_STREAMING
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "HtlcInterceptor"))
.setRequestMarshaller(new Marshaller(ForwardHtlcInterceptResponseSerializer))
.setResponseMarshaller(new Marshaller(ForwardHtlcInterceptRequestSerializer))
.setSampledToLocalTracing(true)
.build()
val updateChanStatusDescriptor: MethodDescriptor[routerrpc.UpdateChanStatusRequest, routerrpc.UpdateChanStatusResponse] =
MethodDescriptor.newBuilder()
.setType(
MethodDescriptor.MethodType.UNARY
)
.setFullMethodName(MethodDescriptor.generateFullMethodName("routerrpc.Router", "UpdateChanStatus"))
.setRequestMarshaller(new Marshaller(UpdateChanStatusRequestSerializer))
.setResponseMarshaller(new Marshaller(UpdateChanStatusResponseSerializer))
.setSampledToLocalTracing(true)
.build()
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy