orb.lnd.grpc_generated.v0_14_1_beta.router_pb2_grpc module

Client and server classes corresponding to protobuf-defined services.

class orb.lnd.grpc_generated.v0_14_1_beta.router_pb2_grpc.Router

Bases: object

Router is a service that offers advanced interaction with the router subsystem of the daemon.

static BuildRoute(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static EstimateRouteFee(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static GetMissionControlConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static HtlcInterceptor(request_iterator, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static QueryMissionControl(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static QueryProbability(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static ResetMissionControl(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SendPayment(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SendPaymentV2(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SendToRoute(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SendToRouteV2(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SetMissionControlConfig(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static SubscribeHtlcEvents(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static TrackPayment(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static TrackPaymentV2(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static UpdateChanStatus(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static XImportMissionControl(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

class orb.lnd.grpc_generated.v0_14_1_beta.router_pb2_grpc.RouterServicer

Bases: object

Router is a service that offers advanced interaction with the router subsystem of the daemon.

BuildRoute(request, context)

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.

EstimateRouteFee(request, context)

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.

GetMissionControlConfig(request, context)

GetMissionControlConfig returns mission control’s current config.

HtlcInterceptor(request_iterator, context)

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.

QueryMissionControl(request, context)

QueryMissionControl exposes the internal mission control state to callers. It is a development feature.

QueryProbability(request, context)

QueryProbability returns the current success probability estimate for a given node pair and amount.

ResetMissionControl(request, context)

ResetMissionControl clears all mission control state and starts with a clean slate.

SendPayment(request, context)

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.

SendPaymentV2(request, context)

SendPaymentV2 attempts to route a payment described by the passed PaymentRequest to the final destination. The call returns a stream of payment updates.

SendToRoute(request, context)

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.

SendToRouteV2(request, context)

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.

SetMissionControlConfig(request, context)

SetMissionControlConfig will set mission control’s config, if the config provided is valid.

SubscribeHtlcEvents(request, context)

SubscribeHtlcEvents creates a uni-directional stream from the server to the client which delivers a stream of htlc events.

TrackPayment(request, context)

Deprecated, use TrackPaymentV2. TrackPayment returns an update stream for the payment identified by the payment hash.

TrackPaymentV2(request, context)

TrackPaymentV2 returns an update stream for the payment identified by the payment hash.

UpdateChanStatus(request, context)

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”.

XImportMissionControl(request, context)

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.

class orb.lnd.grpc_generated.v0_14_1_beta.router_pb2_grpc.RouterStub(channel)

Bases: object

Router is a service that offers advanced interaction with the router subsystem of the daemon.

orb.lnd.grpc_generated.v0_14_1_beta.router_pb2_grpc.add_RouterServicer_to_server(servicer, server)