routerrpc: make use of fee limit obvious in SendPaymentV2

This commit is contained in:
Oliver Gugger 2024-01-29 13:42:12 +02:00
parent 59feec44ca
commit eb08a6f004
No known key found for this signature in database
GPG Key ID: 8E4256593F177720
3 changed files with 13 additions and 4 deletions

View File

@ -30,7 +30,10 @@ service Router {
/* /*
SendPaymentV2 attempts to route a payment described by the passed SendPaymentV2 attempts to route a payment described by the passed
PaymentRequest to the final destination. The call returns a stream of PaymentRequest to the final destination. The call returns a stream of
payment updates. payment updates. When using this RPC, make sure to set a fee limit, as the
default routing fee limit is 0 sats. Without a non-zero fee limit only
routes without fees will be attempted which often fails with
FAILURE_REASON_NO_ROUTE.
*/ */
rpc SendPaymentV2 (SendPaymentRequest) returns (stream lnrpc.Payment); rpc SendPaymentV2 (SendPaymentRequest) returns (stream lnrpc.Payment);

View File

@ -392,7 +392,7 @@
}, },
"/v2/router/send": { "/v2/router/send": {
"post": { "post": {
"summary": "SendPaymentV2 attempts to route a payment described by the passed\nPaymentRequest to the final destination. The call returns a stream of\npayment updates.", "summary": "SendPaymentV2 attempts to route a payment described by the passed\nPaymentRequest to the final destination. The call returns a stream of\npayment updates. When using this RPC, make sure to set a fee limit, as the\ndefault routing fee limit is 0 sats. Without a non-zero fee limit only\nroutes without fees will be attempted which often fails with\nFAILURE_REASON_NO_ROUTE.",
"operationId": "Router_SendPaymentV2", "operationId": "Router_SendPaymentV2",
"responses": { "responses": {
"200": { "200": {

View File

@ -21,7 +21,10 @@ const _ = grpc.SupportPackageIsVersion7
type RouterClient interface { type RouterClient interface {
// SendPaymentV2 attempts to route a payment described by the passed // SendPaymentV2 attempts to route a payment described by the passed
// PaymentRequest to the final destination. The call returns a stream of // PaymentRequest to the final destination. The call returns a stream of
// payment updates. // payment updates. When using this RPC, make sure to set a fee limit, as the
// default routing fee limit is 0 sats. Without a non-zero fee limit only
// routes without fees will be attempted which often fails with
// FAILURE_REASON_NO_ROUTE.
SendPaymentV2(ctx context.Context, in *SendPaymentRequest, opts ...grpc.CallOption) (Router_SendPaymentV2Client, error) SendPaymentV2(ctx context.Context, in *SendPaymentRequest, opts ...grpc.CallOption) (Router_SendPaymentV2Client, error)
// lncli: `trackpayment` // lncli: `trackpayment`
// TrackPaymentV2 returns an update stream for the payment identified by the // TrackPaymentV2 returns an update stream for the payment identified by the
@ -454,7 +457,10 @@ func (c *routerClient) UpdateChanStatus(ctx context.Context, in *UpdateChanStatu
type RouterServer interface { type RouterServer interface {
// SendPaymentV2 attempts to route a payment described by the passed // SendPaymentV2 attempts to route a payment described by the passed
// PaymentRequest to the final destination. The call returns a stream of // PaymentRequest to the final destination. The call returns a stream of
// payment updates. // payment updates. When using this RPC, make sure to set a fee limit, as the
// default routing fee limit is 0 sats. Without a non-zero fee limit only
// routes without fees will be attempted which often fails with
// FAILURE_REASON_NO_ROUTE.
SendPaymentV2(*SendPaymentRequest, Router_SendPaymentV2Server) error SendPaymentV2(*SendPaymentRequest, Router_SendPaymentV2Server) error
// lncli: `trackpayment` // lncli: `trackpayment`
// TrackPaymentV2 returns an update stream for the payment identified by the // TrackPaymentV2 returns an update stream for the payment identified by the