Skip to content

Commit

Permalink
doc: listpeers new attribute num_channels
Browse files Browse the repository at this point in the history
  • Loading branch information
m-schmoock authored and endothermicdev committed Feb 7, 2023
1 parent a418615 commit e736c4d
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
3 changes: 2 additions & 1 deletion doc/lightning-listpeers.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ On success, an object containing **peers** is returned. It is an array of objec

- **id** (pubkey): the public key of the peer
- **connected** (boolean): True if the peer is currently connected
- **num\_channels** (u32): The number of channels the peer has with this node *(added v23.02)*
- **log** (array of objects, optional): if *level* is specified, logs for this peer:
- **type** (string) (one of "SKIPPED", "BROKEN", "UNUSUAL", "INFO", "DEBUG", "IO\_IN", "IO\_OUT")

Expand Down Expand Up @@ -399,4 +400,4 @@ Main web site: <https://github.com/ElementsProject/lightning> Lightning
RFC site (BOLT \#9):
<https://github.com/lightning/bolts/blob/master/09-features.md>

[comment]: # ( SHA256STAMP:b89450ac6f27e051003bcf0a382b51e117e2832729e9d80b0015d9cebfacfa2c)
[comment]: # ( SHA256STAMP:227b5af94d1f299a4e88e450c074960ca8d109b634e24693ad389ef02f64f525)
3 changes: 2 additions & 1 deletion doc/lightning-sql.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,7 @@ The following tables are currently supported:
- `peers` indexed by `id` (see lightning-listpeers(7))
- `id` (type `pubkey`, sqltype `BLOB`)
- `connected` (type `boolean`, sqltype `INTEGER`)
- `num_channels` (type `u32`, sqltype `INTEGER`)
- related table `peers_netaddr`
- `row` (reference to `peers.rowid`, sqltype `INTEGER`)
- `arrindex` (index within array, sqltype `INTEGER`)
Expand Down Expand Up @@ -471,4 +472,4 @@ RESOURCES
---------

Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:dbb9286cf31dc82b33143d5274b1c4eecc75c5ba1dfc18bdf21b4baab585bd45)
[comment]: # ( SHA256STAMP:d25af4b0655ebd31db68932c5ea6b532bd134477e42df5d0c7428e4a03fd0335)
9 changes: 8 additions & 1 deletion doc/schemas/listpeers.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
"additionalProperties": true,
"required": [
"id",
"connected"
"connected",
"num_channels"
],
"properties": {
"id": {
Expand All @@ -24,6 +25,11 @@
"type": "boolean",
"description": "True if the peer is currently connected"
},
"num_channels": {
"type": "u32",
"description": "The number of channels the peer has with this node",
"added": "v23.02"
},
"log": {
"type": "array",
"description": "if *level* is specified, logs for this peer",
Expand Down Expand Up @@ -1091,6 +1097,7 @@
"id": {},
"channels": {},
"connected": {},
"num_channels": {},
"htlcs": {},
"log": {},
"netaddr": {
Expand Down

0 comments on commit e736c4d

Please sign in to comment.