Lightning Network Daemon
Go to file
Olaoluwa Osuntokun f42b6a3949
scripts: update release notes check for merge queue usage
Without this commit, PRs can fail to be merged via the merge queue, as
it'll fail with this error:
```
Run scripts/check-release-notes.sh
PR gh-readonly-queue didn't update release notes
Error: Process completed with exit code 1.
```
2023-06-15 17:48:55 -05:00
.github github: run fuzz tests with unit tests 2023-05-19 15:48:11 -05:00
.vscode .vscode: add editor settings for VS Code 2022-07-06 10:25:19 +02:00
aezeed multi: add new build tag integration 2023-02-23 21:56:09 +08:00
aliasmgr multi: replace FundingLocked and funding_locked strings 2023-03-17 18:21:59 +08:00
amp multi: fix make fmt 2022-08-23 22:10:24 +08:00
autopilot autopilot: fix loop variables, use require 2022-10-13 14:40:43 +02:00
batch kvdb: move channeldb/kvdb to top level 2021-05-07 14:18:56 +02:00
blockcache multimutex: remove HashMutex, make Mutex type a type param 2023-06-01 17:39:49 -07:00
brontide brontide: derandomize fuzz tests 2023-05-23 08:32:13 -05:00
buffer lnwire: remove unused MaxMessagePayload const 2021-08-10 05:36:07 +08:00
build build: bump version to v0.16.99 2023-04-04 19:51:15 -07:00
cert cert: removed unused args from cert.GenCertPair 2023-02-06 17:11:56 +01:00
chainntnfs chainntnfs: remove subscriptions when the relevant tx is confirmed 2023-04-19 01:18:19 +08:00
chainreg chainreg: increase default CLTV value to 80 blocks (~13 hrs) 2023-04-19 11:39:37 -07:00
chanacceptor rpc: validate closing channel address in open channel requests 2023-01-04 04:42:39 -08:00
chanbackup chanbackup: replace defer cleanup with t.Cleanup 2022-10-13 17:01:35 +08:00
chanfitness fix typos [skip ci] 2022-04-11 18:26:54 +05:30
channeldb multi: update linter, fix new issues 2023-06-13 11:58:33 +02:00
channelnotifier channelnotifier: add InactiveLinkEvent 2023-01-18 03:46:16 +08:00
clock clock: add missing package require and replace assert [skip ci] 2022-08-23 03:27:42 +08:00
cluster cluster: replace defer cleanup with t.Cleanup 2022-10-13 17:47:03 +08:00
cmd walletrpc+btcwallet: no custom account with various key scopes 2023-06-14 09:58:53 +02:00
contractcourt contractcourt: improve logging for failing dangling htlcs 2023-06-07 17:34:06 +08:00
contrib docs: remove PIDFile from example systemd service 2022-01-11 14:08:18 +01:00
discovery multimutex: remove HashMutex, make Mutex type a type param 2023-06-01 17:39:49 -07:00
docker docker: add support for custom params RPCHOST and RPCCRTPATH 2023-06-13 11:58:34 +02:00
docs update release-notes-0.17 2023-06-14 09:58:54 +02:00
feature features: disallow unsetting of config-set features 2023-05-04 10:35:49 -04:00
funding Merge pull request #7689 from guggero/housekeeping 2023-06-13 17:42:53 +02:00
healthcheck build(deps): bump golang.org/x/sys in /healthcheck 2023-02-25 08:08:46 +00:00
htlcswitch multi: update linter, fix new issues 2023-06-13 11:58:33 +02:00
input Merge pull request #7473 from emilioziniades/realign-witness-types 2023-04-13 16:09:01 -07:00
internal/musig2v040 internal/musig2: rename to musig2v040 to avoid confusion 2023-02-03 18:30:09 +01:00
invoices multi: update linter, fix new issues 2023-06-13 11:58:33 +02:00
itest walletrpc+btcwallet: no custom account with various key scopes 2023-06-14 09:58:53 +02:00
keychain mod+keychain+lntest: bump btcd to version with tweak fix 2022-11-11 10:20:08 +01:00
kvdb build(deps): bump golang.org/x/net from 0.4.0 to 0.7.0 in /kvdb 2023-02-17 16:03:17 +00:00
labels multi: fix make fmt 2022-08-23 22:10:24 +08:00
lncfg server+lncfg: make max in-mem tasks configurable 2023-05-16 10:57:50 +02:00
lnencrypt lnencrypt: Moves the crypto functions in the chanbackup package into its own package called lnencrypt 2022-09-30 01:53:45 -05:00
lnmock lnmock: add new package lnmock to host mocks 2023-01-12 22:08:02 +08:00
lnpeer multi: use btcd's btcec/v2 and btcutil modules 2022-03-09 19:02:37 +01:00
lnrpc Merge pull request #7689 from guggero/housekeeping 2023-06-13 17:42:53 +02:00
lntest walletrpc+btcwallet: no custom account with various key scopes 2023-06-14 09:58:53 +02:00
lntypes lntypes+routing: add generic Min/Max functions 2022-12-12 13:22:28 +01:00
lnutils multi: update linter, fix new issues 2023-06-13 11:58:33 +02:00
lnwallet walletrpc+btcwallet: no custom account with various key scopes 2023-06-14 09:58:53 +02:00
lnwire multi: update linter, fix new issues 2023-06-13 11:58:33 +02:00
macaroons macaroons: let ChangePassword re-encrypt all root keys 2023-05-17 14:44:15 +02:00
make make: add benchmark tests 2023-05-09 16:47:47 +02:00
mobile make+docs: pull in modules patch 2023-03-31 10:15:21 -04:00
monitoring Merge pull request #6224 from Roasbeef/prometheus-latency-histograms 2022-02-16 16:38:51 -08:00
multimutex multimutex: remove HashMutex, make Mutex type a type param 2023-06-01 17:39:49 -07:00
nat multi: Fix typos [skip ci] 2022-01-24 12:19:02 +02:00
netann multi: update node announcement features in feature manager first 2023-05-04 10:35:46 -04:00
peer htlcswitch: add new LinkFailureDisconnect action 2023-05-23 12:25:11 -07:00
peernotifier multi: add shutdown logs in subservers 2021-09-15 19:52:03 +08:00
pool pool: replace defer cleanup with t.Cleanup 2022-10-13 17:47:03 +08:00
queue queue: replace defer cleanup with t.Cleanup 2022-10-13 17:47:04 +08:00
record routing+channeldb: send payment metadata from invoice 2022-04-13 22:55:40 +02:00
routing multimutex: remove HashMutex, make Mutex type a type param 2023-06-01 17:39:49 -07:00
rpcperms rpcserver: add debug log for rpc calls 2023-03-17 10:01:42 +08:00
scripts scripts: update release notes check for merge queue usage 2023-06-15 17:48:55 -05:00
shachain multi: fix make fmt 2022-08-23 22:10:24 +08: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 sweep: update fee estimator fee-below-floor test case 2023-05-26 11:16:51 -04:00
ticker multi: improve readability of goroutine defers 2022-11-21 13:54:24 +01:00
tlv multi: update to latest version of btcd in submodules 2022-11-16 17:50:34 -08:00
tools multi: update linter, fix new issues 2023-06-13 11:58:33 +02:00
tor build(deps): bump golang.org/x/net in /tor 2023-03-03 09:15:58 +00:00
walletunlocker walletunlocker: fix unit test flake by closing DB 2023-02-06 14:08:08 +01:00
watchtower multi: update linter, fix new issues 2023-06-13 11:58:33 +02:00
zpay32 multi: fix make lint 2022-11-18 20:48:23 +08:00
.editorconfig .editorconfig: add editor settings for most editors 2022-07-06 13:33:02 +02:00
.gitignore multi: move itest out of lntest 2023-02-23 21:56:08 +08:00
.golangci.yml multi: update linter, fix new issues 2023-06-13 11:58:33 +02:00
.travis.yml Merge pull request #7582 from Roasbeef/go-1-20-3 2023-04-06 11:38:49 -07:00
channel_notifier.go multi: use btcd's btcec/v2 and btcutil modules 2022-03-09 19:02:37 +01:00
chanrestore.go channeldb: BigSize migration, store zero-conf, scid-alias bits 2022-07-07 17:10:27 -04:00
config_builder.go lnd: generate default macaroons independently 2023-04-26 13:30:03 -04:00
config.go config+lnd: allow configuring gRPC keepalive settings 2023-06-09 10:57:36 +02:00
dev.Dockerfile build: update build system to Go 1.20.3 2023-04-05 11:28:34 -07:00
doc.go lnd: rename package main->lnd 2019-04-23 20:57:33 +02:00
Dockerfile build: update build system to Go 1.20.3 2023-04-05 11:28:34 -07:00
go.mod mod: update btcwallet's version 2023-05-19 16:36:21 +08:00
go.sum mod: update btcwallet's version 2023-05-19 16:36:21 +08:00
intercepted_forward.go contractcourt: add onchain interception 2022-04-13 11:31:33 +02:00
LICENSE multi: Update Licenses to 2022 [skip ci] 2022-02-09 00:25:20 +02:00
lnd.go config+lnd: allow configuring gRPC keepalive settings 2023-06-09 10:57:36 +02:00
log.go multi: add sub-server dep 2022-04-30 08:55:49 +02:00
logo.png README: add logo to top portion of page 2017-09-29 14:06:31 -07:00
Makefile make: add benchmark tests 2023-05-09 16:47:47 +02:00
pilot.go multi: use btcd's btcec/v2 and btcutil modules 2022-03-09 19:02:37 +01: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 Merge pull request #7689 from guggero/housekeeping 2023-06-13 17:42:53 +02:00
sample-lnd.conf sample-lnd.conf: fix typo in comment. 2023-06-13 11:58:34 +02:00
SECURITY.md lnd: add SECURITY.MD to bolster security entry in README 2022-10-17 12:05:15 -07:00
server_test.go multi: add new build tag integration 2023-02-23 21:56:09 +08:00
server.go server+lncfg: make max in-mem tasks configurable 2023-05-16 10:57:50 +02:00
subrpcserver_config.go multi: update node announcement features in feature manager first 2023-05-04 10:35:46 -04:00
sweeper_wallet.go lnd: skip canceling rebroadcast for neutrino backend 2023-04-26 10:38:13 +08:00
tls_manager_test.go lnd: Add ability to encrypt TLS key on disk 2023-01-26 13:32:11 -06:00
tls_manager.go multi: update linter, fix new issues 2023-06-13 11:58:33 +02:00
witness_beacon_test.go lnd: replace defer cleanup with t.Cleanup 2022-10-13 17:47:04 +08:00
witness_beacon.go lnd+contractcourt: add more debug logs 2023-04-19 01:18:19 +08: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