2020-05-05 20:08:35 +00:00
|
|
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2020-08-28 12:09:57 +00:00
|
|
|
# Source: routerrpc/router.proto for package 'routerrpc'
|
2020-05-05 20:08:35 +00:00
|
|
|
|
|
|
|
require 'grpc'
|
2020-08-28 12:09:57 +00:00
|
|
|
require 'routerrpc/router_pb'
|
2020-05-05 20:08:35 +00:00
|
|
|
|
|
|
|
module Routerrpc
|
|
|
|
module Router
|
2020-08-28 12:09:57 +00:00
|
|
|
# Router is a service that offers advanced interaction with the router
|
|
|
|
# subsystem of the daemon.
|
2020-05-05 20:08:35 +00:00
|
|
|
class Service
|
|
|
|
|
2021-07-09 19:19:28 +00:00
|
|
|
include ::GRPC::GenericService
|
2020-05-05 20:08:35 +00:00
|
|
|
|
|
|
|
self.marshal_class_method = :encode
|
|
|
|
self.unmarshal_class_method = :decode
|
|
|
|
self.service_name = 'routerrpc.Router'
|
|
|
|
|
2020-08-28 12:09:57 +00:00
|
|
|
#
|
2020-05-05 20:08:35 +00:00
|
|
|
# SendPaymentV2 attempts to route a payment described by the passed
|
|
|
|
# PaymentRequest to the final destination. The call returns a stream of
|
|
|
|
# payment updates.
|
2021-07-09 19:19:28 +00:00
|
|
|
rpc :SendPaymentV2, ::Routerrpc::SendPaymentRequest, stream(::Lnrpc::Payment)
|
2020-08-28 12:09:57 +00:00
|
|
|
#
|
2020-05-05 20:08:35 +00:00
|
|
|
# TrackPaymentV2 returns an update stream for the payment identified by the
|
|
|
|
# payment hash.
|
2021-07-09 19:19:28 +00:00
|
|
|
rpc :TrackPaymentV2, ::Routerrpc::TrackPaymentRequest, stream(::Lnrpc::Payment)
|
2020-08-28 12:09:57 +00:00
|
|
|
#
|
2020-05-05 20:08:35 +00:00
|
|
|
# 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.
|
2021-07-09 19:19:28 +00:00
|
|
|
rpc :EstimateRouteFee, ::Routerrpc::RouteFeeRequest, ::Routerrpc::RouteFeeResponse
|
2020-08-28 12:09:57 +00:00
|
|
|
#
|
|
|
|
# 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.
|
2021-07-09 19:19:28 +00:00
|
|
|
rpc :SendToRoute, ::Routerrpc::SendToRouteRequest, ::Routerrpc::SendToRouteResponse
|
2020-08-28 12:09:57 +00:00
|
|
|
#
|
|
|
|
# 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.
|
2021-07-09 19:19:28 +00:00
|
|
|
rpc :SendToRouteV2, ::Routerrpc::SendToRouteRequest, ::Lnrpc::HTLCAttempt
|
2020-08-28 12:09:57 +00:00
|
|
|
#
|
2020-05-05 20:08:35 +00:00
|
|
|
# ResetMissionControl clears all mission control state and starts with a clean
|
|
|
|
# slate.
|
2021-07-09 19:19:28 +00:00
|
|
|
rpc :ResetMissionControl, ::Routerrpc::ResetMissionControlRequest, ::Routerrpc::ResetMissionControlResponse
|
2020-08-28 12:09:57 +00:00
|
|
|
#
|
2020-05-05 20:08:35 +00:00
|
|
|
# QueryMissionControl exposes the internal mission control state to callers.
|
|
|
|
# It is a development feature.
|
2021-07-09 19:19:28 +00:00
|
|
|
rpc :QueryMissionControl, ::Routerrpc::QueryMissionControlRequest, ::Routerrpc::QueryMissionControlResponse
|
2020-08-28 12:09:57 +00:00
|
|
|
#
|
2021-07-09 19:25:49 +00:00
|
|
|
# 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.
|
|
|
|
rpc :XImportMissionControl, ::Routerrpc::XImportMissionControlRequest, ::Routerrpc::XImportMissionControlResponse
|
|
|
|
#
|
|
|
|
# GetMissionControlConfig returns mission control's current config.
|
|
|
|
rpc :GetMissionControlConfig, ::Routerrpc::GetMissionControlConfigRequest, ::Routerrpc::GetMissionControlConfigResponse
|
|
|
|
#
|
|
|
|
# SetMissionControlConfig will set mission control's config, if the config
|
|
|
|
# provided is valid.
|
|
|
|
rpc :SetMissionControlConfig, ::Routerrpc::SetMissionControlConfigRequest, ::Routerrpc::SetMissionControlConfigResponse
|
|
|
|
#
|
2020-05-05 20:08:35 +00:00
|
|
|
# QueryProbability returns the current success probability estimate for a
|
|
|
|
# given node pair and amount.
|
2021-07-09 19:19:28 +00:00
|
|
|
rpc :QueryProbability, ::Routerrpc::QueryProbabilityRequest, ::Routerrpc::QueryProbabilityResponse
|
2020-08-28 12:09:57 +00:00
|
|
|
#
|
2020-05-05 20:08:35 +00:00
|
|
|
# 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.
|
2021-07-09 19:19:28 +00:00
|
|
|
rpc :BuildRoute, ::Routerrpc::BuildRouteRequest, ::Routerrpc::BuildRouteResponse
|
2020-08-28 12:09:57 +00:00
|
|
|
#
|
2020-05-05 20:08:35 +00:00
|
|
|
# SubscribeHtlcEvents creates a uni-directional stream from the server to
|
|
|
|
# the client which delivers a stream of htlc events.
|
2021-07-09 19:19:28 +00:00
|
|
|
rpc :SubscribeHtlcEvents, ::Routerrpc::SubscribeHtlcEventsRequest, stream(::Routerrpc::HtlcEvent)
|
2020-08-28 12:09:57 +00:00
|
|
|
#
|
2020-05-05 20:08:35 +00:00
|
|
|
# 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.
|
2021-07-09 19:19:28 +00:00
|
|
|
rpc :SendPayment, ::Routerrpc::SendPaymentRequest, stream(::Routerrpc::PaymentStatus)
|
2020-08-28 12:09:57 +00:00
|
|
|
#
|
2020-05-05 20:08:35 +00:00
|
|
|
# Deprecated, use TrackPaymentV2. TrackPayment returns an update stream for
|
|
|
|
# the payment identified by the payment hash.
|
2021-07-09 19:19:28 +00:00
|
|
|
rpc :TrackPayment, ::Routerrpc::TrackPaymentRequest, stream(::Routerrpc::PaymentStatus)
|
2020-08-28 12:09:57 +00:00
|
|
|
# *
|
|
|
|
# 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.
|
2021-07-09 19:19:28 +00:00
|
|
|
rpc :HtlcInterceptor, stream(::Routerrpc::ForwardHtlcInterceptResponse), stream(::Routerrpc::ForwardHtlcInterceptRequest)
|
2021-07-09 19:25:49 +00:00
|
|
|
#
|
|
|
|
# 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".
|
|
|
|
rpc :UpdateChanStatus, ::Routerrpc::UpdateChanStatusRequest, ::Routerrpc::UpdateChanStatusResponse
|
2020-05-05 20:08:35 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
Stub = Service.rpc_stub_class
|
|
|
|
end
|
|
|
|
end
|