You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Edouard c923d7ab57
Merge pull request #22 from mmilata/routing-view
6 days ago
app fix logger: use default development 2 years ago
cli cli: add usage 1 week ago
cmd/lntop cli: init app 2 years ago
config increase default pool capacity 6 days ago
docker update dependencies, remove vendor directory 2 weeks ago
events add routing view 6 days ago
logging fix logger: use default development 2 years ago
network increase default pool capacity 6 days ago
pubsub add routing view 6 days ago
ui add routing view 6 days ago
.gitignore goreleaser 2 years ago
.goreleaser.yml fix goreleaser 2 years ago
LICENSE Initial commit 2 years ago
README.md increase default pool capacity 6 days ago
doc.go add doc.go 2 years ago
go.mod update dependencies, remove vendor directory 2 weeks ago
go.sum update dependencies, remove vendor directory 2 weeks ago

README.md

lntop

MIT licensed Go Report Card Godoc tippin.me

lntop is an interactive text-mode channels viewer for Unix systems.

lntop-v0.1.0 lntop-v0.1.0

Install

Require the go programming language (version >= 1.11)

git clone https://github.com/edouardparis/lntop.git
cd lntop && export GO111MODULE=on && go install ./...

Config

First time lntop is used a config file .lntop/config.toml is created in the user home directory.

Change macaroon path according to your network.

[logger]
type = "production"
dest = "/root/.lntop/lntop.log"

[network]
name = "lnd"
type = "lnd"
address = "//127.0.0.1:10009"
cert = "/root/.lnd/tls.cert"
macaroon = "/root/.lnd/data/chain/bitcoin/mainnet/admin.macaroon"
macaroon_timeout = 60
max_msg_recv_size = 52428800
conn_timeout = 1000000
pool_capacity = 4

[views]
# views.channels is the view displaying channel list.
[views.channels]
# It is possible to add, remove and order columns of the
# table with the array columns. The available values are:
columns = [
	"STATUS",      # status of the channel
	"ALIAS",       # alias of the channel node
	"GAUGE",       # ascii bar with percent local/capacity
	"LOCAL",       # the local amount of the channel
	"CAP",         # the total capacity of the channel
	"SENT",        # the total amount sent
	"RECEIVED",    # the total amount received
	"HTLC",        # the number of pending HTLC
	"UNSETTLED",   # the amount unsettled in the channel
	"CFEE",        # the commit fee
	"LAST UPDATE", # last update of the channel
	"PRIVATE",     # true if channel is private
	"ID",          # the id of the channel
]

[views.transactions]
# It is possible to add, remove and order columns of the
# table with the array columns. The available values are:
columns = [
	"DATE",      # date of the transaction
	"HEIGHT",    # block height of the transaction
	"CONFIR",    # number of confirmations
	"AMOUNT",    # amount moved by the transaction
	"FEE",       # fee of the transaction
	"ADDRESSES", # number of transaction output addresses
]

[views.routing]
columns = [
	"DIR",            # event type:  send, receive, forward
	"STATUS",         # one of: active, settled, failed, linkfail
	"IN_CHANNEL",     # channel id of the incomming channel
	"IN_ALIAS",       # incoming channel node alias
	# "IN_HTLC",      # htlc id on incoming channel
	# "IN_TIMELOCK",  # incoming timelock height
	"OUT_CHANNEL",    # channel id of the outgoing channel
	"OUT_ALIAS",      # outgoing channel node alias
	# "OUT_HTLC",     # htlc id on outgoing channel
	# "OUT_TIMELOCK", # outgoing timelock height
	"AMOUNT",         # routed amount
	"FEE",            # routing fee
	"LAST UPDATE",    # last update
	"DETAIL",         # error description
]

Routing view

Routing view displays screenful of latest routing events. This information is not persisted in LND so the view always starts empty and is lost once you exit lntop.

The events are in one of four states:

  • active - HTLC pending
  • settled - preimage revealed, HTLC removed
  • failed - payment failed at a downstream node
  • linkfail - payment failed at this node

Docker

If you prefer to run lntop from a docker container, cd docker and follow README there.

Compatibility

lntop lightningnetwork/lnd
v0.0.1 v0.5.1