diff --git a/cmd/lncli/commands.go b/cmd/lncli/commands.go index b4d2f318f..3ef2eec6c 100644 --- a/cmd/lncli/commands.go +++ b/cmd/lncli/commands.go @@ -2480,7 +2480,7 @@ var verifyChanBackupCommand = cli.Command{ * A packed multi-channel SCB, which couples several individual static channel backups in single blob. - + * A file path which points to a packed single-channel backup within a file, using the same format that lnd does in its channel.backup file. diff --git a/lnrpc/lightning.proto b/lnrpc/lightning.proto index 8a41a5a2e..358b421ab 100644 --- a/lnrpc/lightning.proto +++ b/lnrpc/lightning.proto @@ -341,13 +341,13 @@ service Lightning { */ rpc ListPayments (ListPaymentsRequest) returns (ListPaymentsResponse); - /* + /* lncli: `deletepayments` DeletePayment deletes an outgoing payment from DB. Note that it will not attempt to delete an In-Flight payment, since that would be unsafe. */ rpc DeletePayment (DeletePaymentRequest) returns (DeletePaymentResponse); - /* + /* lncli: `deletepayments --all` DeleteAllPayments deletes all outgoing payments from DB. Note that it will not attempt to delete In-Flight payments, since that would be unsafe. */ @@ -479,7 +479,7 @@ service Lightning { rpc ExportAllChannelBackups (ChanBackupExportRequest) returns (ChanBackupSnapshot); - /* + /* lncli: `verifychanbackup` VerifyChanBackup allows a caller to verify the integrity of a channel backup snapshot. This method will accept either a packed Single or a packed Multi. Specifying both will result in an error. diff --git a/lnrpc/lightning.swagger.json b/lnrpc/lightning.swagger.json index 99bd01e13..09ac788c4 100644 --- a/lnrpc/lightning.swagger.json +++ b/lnrpc/lightning.swagger.json @@ -383,7 +383,7 @@ }, "/v1/channels/backup/verify": { "post": { - "summary": "VerifyChanBackup allows a caller to verify the integrity of a channel backup\nsnapshot. This method will accept either a packed Single or a packed Multi.\nSpecifying both will result in an error.", + "summary": "lncli: `verifychanbackup`\nVerifyChanBackup allows a caller to verify the integrity of a channel backup\nsnapshot. This method will accept either a packed Single or a packed Multi.\nSpecifying both will result in an error.", "operationId": "Lightning_VerifyChanBackup", "responses": { "200": { @@ -2075,7 +2075,7 @@ }, "/v1/payment": { "delete": { - "summary": "DeletePayment deletes an outgoing payment from DB. Note that it will not\nattempt to delete an In-Flight payment, since that would be unsafe.", + "summary": "lncli: `deletepayments`\nDeletePayment deletes an outgoing payment from DB. Note that it will not\nattempt to delete an In-Flight payment, since that would be unsafe.", "operationId": "Lightning_DeletePayment", "responses": { "200": { @@ -2191,7 +2191,7 @@ ] }, "delete": { - "summary": "DeleteAllPayments deletes all outgoing payments from DB. Note that it will\nnot attempt to delete In-Flight payments, since that would be unsafe.", + "summary": "lncli: `deletepayments --all`\nDeleteAllPayments deletes all outgoing payments from DB. Note that it will\nnot attempt to delete In-Flight payments, since that would be unsafe.", "operationId": "Lightning_DeleteAllPayments", "responses": { "200": { diff --git a/lnrpc/lightning_grpc.pb.go b/lnrpc/lightning_grpc.pb.go index 229cb64c4..78e6c430e 100644 --- a/lnrpc/lightning_grpc.pb.go +++ b/lnrpc/lightning_grpc.pb.go @@ -241,9 +241,11 @@ type LightningClient interface { // lncli: `listpayments` // ListPayments returns a list of all outgoing payments. ListPayments(ctx context.Context, in *ListPaymentsRequest, opts ...grpc.CallOption) (*ListPaymentsResponse, error) + // lncli: `deletepayments` // DeletePayment deletes an outgoing payment from DB. Note that it will not // attempt to delete an In-Flight payment, since that would be unsafe. DeletePayment(ctx context.Context, in *DeletePaymentRequest, opts ...grpc.CallOption) (*DeletePaymentResponse, error) + // lncli: `deletepayments --all` // DeleteAllPayments deletes all outgoing payments from DB. Note that it will // not attempt to delete In-Flight payments, since that would be unsafe. DeleteAllPayments(ctx context.Context, in *DeleteAllPaymentsRequest, opts ...grpc.CallOption) (*DeleteAllPaymentsResponse, error) @@ -337,6 +339,7 @@ type LightningClient interface { // as well, which contains a single encrypted blob containing the backups of // each channel. ExportAllChannelBackups(ctx context.Context, in *ChanBackupExportRequest, opts ...grpc.CallOption) (*ChanBackupSnapshot, error) + // lncli: `verifychanbackup` // VerifyChanBackup allows a caller to verify the integrity of a channel backup // snapshot. This method will accept either a packed Single or a packed Multi. // Specifying both will result in an error. @@ -1545,9 +1548,11 @@ type LightningServer interface { // lncli: `listpayments` // ListPayments returns a list of all outgoing payments. ListPayments(context.Context, *ListPaymentsRequest) (*ListPaymentsResponse, error) + // lncli: `deletepayments` // DeletePayment deletes an outgoing payment from DB. Note that it will not // attempt to delete an In-Flight payment, since that would be unsafe. DeletePayment(context.Context, *DeletePaymentRequest) (*DeletePaymentResponse, error) + // lncli: `deletepayments --all` // DeleteAllPayments deletes all outgoing payments from DB. Note that it will // not attempt to delete In-Flight payments, since that would be unsafe. DeleteAllPayments(context.Context, *DeleteAllPaymentsRequest) (*DeleteAllPaymentsResponse, error) @@ -1641,6 +1646,7 @@ type LightningServer interface { // as well, which contains a single encrypted blob containing the backups of // each channel. ExportAllChannelBackups(context.Context, *ChanBackupExportRequest) (*ChanBackupSnapshot, error) + // lncli: `verifychanbackup` // VerifyChanBackup allows a caller to verify the integrity of a channel backup // snapshot. This method will accept either a packed Single or a packed Multi. // Specifying both will result in an error. diff --git a/lnrpc/routerrpc/router.proto b/lnrpc/routerrpc/router.proto index df3355a58..62b3f3a77 100644 --- a/lnrpc/routerrpc/router.proto +++ b/lnrpc/routerrpc/router.proto @@ -34,7 +34,7 @@ service Router { */ rpc SendPaymentV2 (SendPaymentRequest) returns (stream lnrpc.Payment); - /* + /* lncli: `trackpayment` TrackPaymentV2 returns an update stream for the payment identified by the payment hash. */ diff --git a/lnrpc/routerrpc/router.swagger.json b/lnrpc/routerrpc/router.swagger.json index f3bf68320..8c42de893 100644 --- a/lnrpc/routerrpc/router.swagger.json +++ b/lnrpc/routerrpc/router.swagger.json @@ -434,7 +434,7 @@ }, "/v2/router/track/{payment_hash}": { "get": { - "summary": "TrackPaymentV2 returns an update stream for the payment identified by the\npayment hash.", + "summary": "lncli: `trackpayment`\nTrackPaymentV2 returns an update stream for the payment identified by the\npayment hash.", "operationId": "Router_TrackPaymentV2", "responses": { "200": { diff --git a/lnrpc/routerrpc/router_grpc.pb.go b/lnrpc/routerrpc/router_grpc.pb.go index 3a314bdcb..2e61b5f85 100644 --- a/lnrpc/routerrpc/router_grpc.pb.go +++ b/lnrpc/routerrpc/router_grpc.pb.go @@ -23,6 +23,7 @@ type RouterClient interface { // PaymentRequest to the final destination. The call returns a stream of // payment updates. SendPaymentV2(ctx context.Context, in *SendPaymentRequest, opts ...grpc.CallOption) (Router_SendPaymentV2Client, error) + // lncli: `trackpayment` // TrackPaymentV2 returns an update stream for the payment identified by the // payment hash. TrackPaymentV2(ctx context.Context, in *TrackPaymentRequest, opts ...grpc.CallOption) (Router_TrackPaymentV2Client, error) @@ -451,6 +452,7 @@ type RouterServer interface { // PaymentRequest to the final destination. The call returns a stream of // payment updates. SendPaymentV2(*SendPaymentRequest, Router_SendPaymentV2Server) error + // lncli: `trackpayment` // TrackPaymentV2 returns an update stream for the payment identified by the // payment hash. TrackPaymentV2(*TrackPaymentRequest, Router_TrackPaymentV2Server) error