akovalenko/lnd.xprv
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #5376 from de6df1re/lnrpc-doc-fix

Browse Source 
lnrpc: fix v1 switch API doc
This commit is contained in:
Olaoluwa Osuntokun 2021-06-18 14:13:39 -07:00 committed by GitHub
commit f9a51882c4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lnrpc/rpc.pb.go
View File

@ -20123,8 +20123,9 @@ type LightningClient interface {
// lncli: `fwdinghistory`
//ForwardingHistory allows the caller to query the htlcswitch for a record of
//all HTLCs forwarded within the target time range, and integer offset
//within that time range. If no time-range is specified, then the first chunk
//of the past 24 hrs of forwarding history are returned.
//within that time range, for a maximum number of events. If no maximum number
//of events is specified, up to 100 events will be returned. If no time-range
//is specified, then events will be returned in the order that they occured.
//
//A list of forwarding events are returned. The size of each forwarding event
//is 40 bytes, and the max message size able to be returned in gRPC is 4 MiB.
@ -21271,8 +21272,9 @@ type LightningServer interface {
// lncli: `fwdinghistory`
//ForwardingHistory allows the caller to query the htlcswitch for a record of
//all HTLCs forwarded within the target time range, and integer offset
//within that time range. If no time-range is specified, then the first chunk
//of the past 24 hrs of forwarding history are returned.
//within that time range, for a maximum number of events. If no maximum number
//of events is specified, up to 100 events will be returned. If no time-range
//is specified, then events will be returned in the order that they occured.
//
//A list of forwarding events are returned. The size of each forwarding event
//is 40 bytes, and the max message size able to be returned in gRPC is 4 MiB.

5
lnrpc/rpc.proto
View File

@ -426,8 +426,9 @@ service Lightning {
/* lncli: `fwdinghistory`
ForwardingHistory allows the caller to query the htlcswitch for a record of
all HTLCs forwarded within the target time range, and integer offset
within that time range. If no time-range is specified, then the first chunk
of the past 24 hrs of forwarding history are returned.
within that time range, for a maximum number of events. If no maximum number
of events is specified, up to 100 events will be returned. If no time-range
is specified, then events will be returned in the order that they occured.
A list of forwarding events are returned. The size of each forwarding event
is 40 bytes, and the max message size able to be returned in gRPC is 4 MiB.

2
lnrpc/rpc.swagger.json
View File

@ -1984,7 +1984,7 @@
},
"/v1/switch": {
"post": {
"summary": "lncli: `fwdinghistory`\nForwardingHistory allows the caller to query the htlcswitch for a record of\nall HTLCs forwarded within the target time range, and integer offset\nwithin that time range. If no time-range is specified, then the first chunk\nof the past 24 hrs of forwarding history are returned.",
"summary": "lncli: `fwdinghistory`\nForwardingHistory allows the caller to query the htlcswitch for a record of\nall HTLCs forwarded within the target time range, and integer offset\nwithin that time range, for a maximum number of events. If no maximum number\nof events is specified, up to 100 events will be returned. If no time-range\nis specified, then events will be returned in the order that they occured.",
"description": "A list of forwarding events are returned. The size of each forwarding event\nis 40 bytes, and the max message size able to be returned in gRPC is 4 MiB.\nAs a result each message can only contain 50k entries. Each response has\nthe index offset of the last entry. The index offset can be provided to the\nrequest to allow the caller to skip a series of records.",
"operationId": "ForwardingHistory",
"responses": {