lnvis

nanovg lightning network visualizer
git clone git://jb55.com/lnvis
Log | Files | Refs | README | LICENSE

README.md (1516B)


      1 
      2 # LNvis
      3 
      4 [![Build Status](https://travis-ci.org/jb55/lnvis.svg)](https://travis-ci.org/jb55/lnvis)
      5 
      6 A Lightning Network Visualizer
      7 
      8 <!-- <img src="https://jb55.com/s/abe49a248360d41c.png"/> -->
      9 <img src="https://jb55.com/s/a50cb0ae69cd2032.png"/>
     10 
     11 ## Usage
     12 
     13 LNvis requires a json dump of nodes and channels. Currently only clightning
     14 channel/node output is supported
     15 
     16     lightning-cli listnodes > clightning-nodes.json && \
     17     lightning-cli listchannels > clightning-channels.json && \
     18     ./lnvis --channels clightning-channels.json \
     19             --nodes clightning-nodes.json \
     20             --filter <starting-node-id>
     21 
     22 ## Controls
     23 
     24 ```
     25 b             view multiple channels between nodes
     26 t             toggle dark/light theme
     27 f             toggle fps
     28 a             toggle aliases
     29 g             toggle grid
     30 s             toggle stroked nodes (small perf boost)
     31 left click    move + focus node
     32 right click   filter node
     33 ```
     34 
     35 ## How it works
     36 
     37 LNvis renders the Lightning Network channel gossip, which include nodes and the
     38 edges (channels) between those nodes.
     39 
     40 * Channels are colored by the node that opened the channel
     41 
     42 * Channel widths are rendered proportional to the capacity
     43 
     44 * Right clicking a node filters the view to that node and its neighbors
     45 
     46 * Dragging a node in any view will focus that node and its neihbors
     47 
     48 ## Building
     49 
     50 Install dependencies (`glfw3`, `pkg-config`)
     51 
     52     # Debian / Ubuntu
     53     $ sudo apt-get install libglfw3-dev pkg-config
     54     
     55     # MacOS
     56     brew install glfw3
     57 
     58 Build
     59 
     60     $ make