Lightning Network Daemon
Go to file
Olaoluwa Osuntokun 9a50cc95b7
Merge pull request #6224 from Roasbeef/prometheus-latency-histograms
monitoring+cfg: add new option to export gRPC perf metrics
2022-02-16 16:38:51 -08:00
.github github: simplify PR template and add more sections [skip ci] 2022-01-28 09:50:02 +02:00
aezeed multi: run gosimports 2022-02-10 11:02:01 +01:00
amp amp: create amp.ShardTracker 2021-04-27 09:47:23 +02:00
autopilot multi: run gosimports 2022-02-10 11:02:01 +01:00
batch kvdb: move channeldb/kvdb to top level 2021-05-07 14:18:56 +02:00
blockcache blockcache: add blockcache package 2021-04-28 09:46:11 +02:00
brontide multi: run gosimports 2022-02-10 11:02:01 +01:00
buffer lnwire: remove unused MaxMessagePayload const 2021-08-10 05:36:07 +08:00
build mod+tools+Makefile:separate tools different module 2022-02-10 11:02:01 +01:00
cert Upgrade to go 1.16 for the left over packages 2021-10-19 03:55:13 +00:00
chainntnfs multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
chainreg multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
chanacceptor multi: fix newly detected linter issues 2022-02-10 11:02:02 +01:00
chanbackup chanbackup: support backup restore of script enforced leased channels 2021-10-19 18:30:50 -07:00
chanfitness multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
channeldb multi: fix issues reported by whitespace linter 2022-02-15 16:26:08 +01:00
channelnotifier multi: move all channelstate operations to ChannelStateDB 2021-09-29 17:00:03 +02:00
clock Upgrade to go 1.16 for the left over packages 2021-10-19 03:55:13 +00:00
cluster multi: Fix typos [skip ci] 2022-01-24 12:19:02 +02:00
cmd multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
contractcourt multi: fix issues reported by whitespace linter 2022-02-15 16:26:08 +01:00
contrib docs: remove PIDFile from example systemd service 2022-01-11 14:08:18 +01:00
discovery multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
docker multi: Remove GO111MODULE env variable in Makefile 2021-11-30 09:35:30 +01:00
docs Merge pull request #6224 from Roasbeef/prometheus-latency-histograms 2022-02-16 16:38:51 -08:00
feature multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
funding multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
fuzz multi: refactor SignDigestCompact into SignMessageCompact 2021-10-08 12:06:52 +02:00
healthcheck tor+healthcheck: fix healthcheck for multiple services 2021-11-23 09:53:36 +01:00
htlcswitch multi: fix issues reported by whitespace linter 2022-02-15 16:26:08 +01:00
input multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
invoices multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
keychain multi: run gosimports 2022-02-10 11:02:01 +01:00
kvdb kvdb: add ForAll 2022-01-12 19:11:53 +01:00
labels multi: add labels to lnd native transactions 2020-07-29 13:46:07 +02:00
lncfg Merge pull request #6224 from Roasbeef/prometheus-latency-histograms 2022-02-16 16:38:51 -08:00
lnpeer lnpeer/peer.go: modifying interface comment 2020-07-06 19:16:06 -04:00
lnrpc multi: fix issues reported by whitespace linter 2022-02-15 16:26:08 +01:00
lntest multi: fix issues reported by whitespace linter 2022-02-15 16:26:08 +01:00
lntypes lntypes: add ZeroHash 2019-06-05 12:41:41 +02:00
lnwallet multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
lnwire multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
macaroons multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
make build: bump release+build version to Go 1.17.3 2021-11-15 17:29:02 -08:00
mobile docs: fixed typos in mobile readme [skip ci] 2022-01-29 09:23:08 +11:00
monitoring Merge pull request #6224 from Roasbeef/prometheus-latency-histograms 2022-02-16 16:38:51 -08:00
multimutex multimutex: add hash mutex 2020-04-08 08:54:05 +02:00
nat multi: Fix typos [skip ci] 2022-01-24 12:19:02 +02:00
netann multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
peer multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
peernotifier multi: add shutdown logs in subservers 2021-09-15 19:52:03 +08:00
pool multi: Fix typos [skip ci] 2022-01-24 12:19:02 +02:00
queue multi: Fix typos [skip ci] 2022-01-24 12:19:02 +02:00
record multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
routing multi: fix issues reported by whitespace linter 2022-02-15 16:26:08 +01:00
rpcperms multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
scripts scripts+GitHub: check submodule version bump 2021-11-22 14:40:28 +01:00
shachain multi: remove dead code 2019-09-10 17:21:59 +02:00
signal multi: Update Licenses to 2022 [skip ci] 2022-02-09 00:25:20 +02:00
subscribe multi: add interface for subscribe client so it can be mocked 2020-09-08 13:47:13 +02:00
sweep multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
ticker Upgrade to go 1.16 for the left over packages 2021-10-19 03:55:13 +00:00
tlv multi: Fix typos [skip ci] 2022-01-24 12:19:02 +02:00
tools tools+golangci-lint: enable fixed version of whitespace linter 2022-02-15 11:16:19 +01:00
tor multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
walletunlocker multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
watchtower multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
zpay32 multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
.gitignore Ignore .vs/ folder 2022-01-19 00:34:52 +02:00
.golangci.yml tools+golangci-lint: enable fixed version of whitespace linter 2022-02-15 11:16:19 +01:00
.travis.yml script: update CI to bitcoind 22 2021-11-03 16:43:27 -07:00
channel_notifier.go channel_notifier: keep chan in SCB on local foce close 2021-08-09 13:55:33 +02:00
chanrestore.go multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
config_builder.go multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
config.go multi: fix newly detected linter issues 2022-02-10 11:02:02 +01:00
dev.Dockerfile build: bump release+build version to Go 1.17.3 2021-11-15 17:29:02 -08:00
doc.go
Dockerfile build: bump release+build version to Go 1.17.3 2021-11-15 17:29:02 -08:00
go.mod mod+tools+Makefile:separate tools different module 2022-02-10 11:02:01 +01:00
go.sum mod+tools+Makefile:separate tools different module 2022-02-10 11:02:01 +01:00
LICENSE multi: Update Licenses to 2022 [skip ci] 2022-02-09 00:25:20 +02:00
lnd.go multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
log.go multi: fix newly detected linter issues 2022-02-10 11:02:02 +01:00
logo.png
Makefile make+tools: dockerize linting 2022-02-10 16:03:00 +01:00
pilot.go lnd+pilot: use minHTLCIn instead of whole config 2021-10-08 12:06:54 +02:00
README.md trivial: link from readme to builder's guide 2021-09-10 05:42:26 +08:00
rpcserver_test.go Rpcserver: Add GetAllPermissions function for retrieving permissions for external macaroon baking 2021-10-01 16:51:16 -05:00
rpcserver.go multi: fix issues reported by whitespace linter 2022-02-15 16:26:08 +01:00
sample-lnd.conf monitoring+cfg: add new option to export gRPC perf metrics 2022-02-01 15:55:26 -08:00
server_test.go Merge pull request #6149 from bhandras/graph_import_rpc 2022-01-28 10:24:59 +01:00
server.go multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
subrpcserver_config.go lnrpc: add the devrpc development only subserver + devrpc.ImportGraph 2022-01-24 17:42:59 +01:00
witness_beacon.go witness_beacon: do not look up invoice preimages 2019-05-15 14:41:58 +02:00

Lightning Network Daemon

Build Status MIT licensed Irc Godoc

The Lightning Network Daemon (lnd) - is a complete implementation of a Lightning Network node. lnd has several pluggable back-end chain services including btcd (a full-node), bitcoind, and neutrino (a new experimental light client). The project's codebase uses the btcsuite set of Bitcoin libraries, and also exports a large set of isolated re-usable Lightning Network related libraries within it. In the current state lnd is capable of:

  • Creating channels.
  • Closing channels.
  • Completely managing all channel states (including the exceptional ones!).
  • Maintaining a fully authenticated+validated channel graph.
  • Performing path finding within the network, passively forwarding incoming payments.
  • Sending outgoing onion-encrypted payments through the network.
  • Updating advertised fee schedules.
  • Automatic channel management (autopilot).

Lightning Network Specification Compliance

lnd fully conforms to the Lightning Network specification (BOLTs). BOLT stands for: Basis of Lightning Technology. The specifications are currently being drafted by several groups of implementers based around the world including the developers of lnd. The set of specification documents as well as our implementation of the specification are still a work-in-progress. With that said, the current status of lnd's BOLT compliance is:

  • BOLT 1: Base Protocol
  • BOLT 2: Peer Protocol for Channel Management
  • BOLT 3: Bitcoin Transaction and Script Formats
  • BOLT 4: Onion Routing Protocol
  • BOLT 5: Recommendations for On-chain Transaction Handling
  • BOLT 7: P2P Node and Channel Discovery
  • BOLT 8: Encrypted and Authenticated Transport
  • BOLT 9: Assigned Feature Flags
  • BOLT 10: DNS Bootstrap and Assisted Node Location
  • BOLT 11: Invoice Protocol for Lightning Payments

Developer Resources

The daemon has been designed to be as developer friendly as possible in order to facilitate application development on top of lnd. Two primary RPC interfaces are exported: an HTTP REST API, and a gRPC service. The exported API's are not yet stable, so be warned: they may change drastically in the near future.

An automatically generated set of documentation for the RPC APIs can be found at api.lightning.community. A set of developer resources including guides, articles, example applications and community resources can be found at: docs.lightning.engineering.

Finally, we also have an active Slack where protocol developers, application developers, testers and users gather to discuss various aspects of lnd and also Lightning in general.

Installation

In order to build from source, please see the installation instructions.

Docker

To run lnd from Docker, please see the main Docker instructions

IRC

  • irc.libera.chat
  • channel #lnd
  • webchat

Safety

When operating a mainnet lnd node, please refer to our operational safety guidelines. It is important to note that lnd is still beta software and that ignoring these operational guidelines can lead to loss of funds.

Security

The developers of lnd take security very seriously. The disclosure of security vulnerabilities helps us secure the health of lnd, privacy of our users, and also the health of the Lightning Network as a whole. If you find any issues regarding security or privacy, please disclose the information responsibly by sending an email to security at lightning dot engineering, preferably encrypted using our designated PGP key (91FE464CD75101DA6B6BAB60555C6465E5BCB3AF) which can be found here.

Further reading