Lightning Network Daemon
Go to file
Olaoluwa Osuntokun 0e96d273d9
peer: enforce strict timeout on opening handshake
This commit modifies the logic around the opening p2p handshake to
enforce a strict timeout around the receipt of the responding init
message. Before this commit, it was possible for the daemon and certain
RPC calls to deadlock as if a peer connected, but didn’t respond with
an init msg, then we’d be sitting there waiting for them to respond.
With this commit, we’ll now time out, kill the connection and then
possible attempt to re-connect if the connection was persistent.
2017-03-29 19:00:40 -07:00
brontide multi: fix formatting issues in packge README's 2017-03-27 16:25:25 -07:00
chainntnfs multi: fix formatting issues in packge README's 2017-03-27 16:25:25 -07:00
channeldb lnwire: add support for Features in NodeAnnouncement 2017-03-29 12:03:43 -07:00
cmd/lncli cmd/lncli: convert queryRoute to queryRoutes 2017-03-21 12:20:50 -07:00
contrib contrib: add basic bash completion for lncli 2017-01-29 18:12:53 -08:00
docker multi: various formatting fixes after changes to Github flavored markdown 2017-03-27 16:20:31 -07:00
docs doc: update INSTALL.md with latest btcd commit hash 2017-03-29 19:00:24 -07:00
lnrpc lnwire: update NodeAnnouncement to handle multiple addresses 2017-03-29 12:03:43 -07:00
lnwallet multi: fix formatting issues in packge README's 2017-03-27 16:25:25 -07:00
lnwire server+lnwire: pre-allocate address slices 2017-03-29 19:00:31 -07:00
routing lnwire: add support for Features in NodeAnnouncement 2017-03-29 12:03:43 -07:00
shachain lnd: fix latest goclean.sh lint warning 2017-03-13 16:30:23 -07:00
zpay32 multi: fix formatting issues in packge README's 2017-03-27 16:25:25 -07:00
.gitignore gitignore: add profile.[cov|tmp] 2017-03-13 16:30:23 -07:00
.travis.yml gotest: add gofmt, govet, golint, gosimple, unconvert, race detector, test coverage in travis 2017-03-13 16:30:23 -07:00
breacharbiter.go minor: fixed arbiter spelling and comment/error messages in funding rpc messages 2017-02-24 11:37:33 -08:00
config.go multi: fix a variety of typos throughout the repo 2017-01-17 17:02:56 -08:00
doc.go add some daemon related skeleton files 2015-12-26 00:09:17 -06:00
features.go features: add shachain required feature flag 2017-02-22 16:49:29 -08:00
fundingmanager.go fundingmgr: fix logging message, correct column line wrap violation 2017-03-24 16:12:10 -07:00
glide.lock build: pin btcd fork against particular commit hash in glide 2017-03-29 19:00:28 -07:00
glide.yaml build: pin btcd fork against particular commit hash in glide 2017-03-29 19:00:28 -07:00
gotest.sh gotest: remove slow linters 2017-03-21 14:56:23 -07:00
htlcswitch.go htlcswitch: add HTLC overflow flow-control via bounded channels 2017-03-24 16:40:02 -07:00
invoiceregistry.go multi: replace usage of fastsha256 with crypto/sha256 2017-03-15 18:56:41 -07:00
LICENSE add copyright, license and discouragement in readme 2016-01-16 00:13:11 -08:00
lnd_test.go test: expand timeout for peer restart+reconnect in persistent funding test 2017-03-29 19:00:34 -07:00
lnd.go lnd: partially fix golint warnings 2017-03-13 16:30:23 -07:00
log.go multi: fix a variety of typos throughout the repo 2017-01-17 17:02:56 -08:00
networktest_test.go netharness: remove test for the node restart method 2016-11-16 12:46:45 -08:00
networktest.go server: user NodeAnnouncement addresses and ports for reconnect 2017-03-29 12:03:43 -07:00
params.go lnd: remove support for the now obsolete SegNet4 2017-01-05 13:08:15 -08:00
peer_test.go plasma: rough draft of peer struct 2015-12-20 15:16:38 -06:00
peer.go peer: enforce strict timeout on opening handshake 2017-03-29 19:00:40 -07:00
README.md Fixing badges in README 2017-03-22 11:44:29 -07:00
release.sh build: add release script 2017-01-12 18:30:47 -08:00
rpcserver.go lnwire: update NodeAnnouncement to handle multiple addresses 2017-03-29 12:03:43 -07:00
server.go peer: enforce strict timeout on opening handshake 2017-03-29 19:00:40 -07:00
signal.go create signal.go to handle SIGINT's 2016-03-22 18:42:01 -07:00
utxonursery_test.go lnd: fix gofmt warnings 2017-03-13 16:30:23 -07:00
utxonursery.go lnd: fix unconvert warnings 2017-03-13 16:30:23 -07:00
version.go lnd: bump version to v0.1.1-alpha 2017-01-17 18:36:31 -08:00

Lightning Network Daemon

Build Status MIT licensed Irc Godoc Coverage Status

The Lightning Network Daemon (lnd) - is a complete implementation of a Lightning Network node and currently deployed on testnet4 - the Bitcoin Test Network. It utilizes an upcoming upgrade to Bitcoin: Segregated Witness (segwit). The project's codebase uses the btcsuite set of Bitcoin libraries, and is currently dependant on btcd. 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

Lightning Network Specification Compliance

lnd doesn't yet fully conform to the Lightning Network specification (BOLT's). BOLT stands for: Basic of Lightning Technologies. 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, lnd the current status of lnd's BOLT compliance is:

  • BOLT 1: Base Protocol
    • lnd currently utilizes a distinct wire format which was created before the emgergence of the current draft of BOLT specifications. We don't have an init message, but we do have analogues to all the other defined message types.
  • BOLT 2: Peer Protocol for Channel Management
    • lnd implements all the functionality defined within the document, however we currently use a different set of wire messages. Additionally,lnd uses a distinct commitment update state-machine and doesn't yet support dynamically updating commitment fees.
  • BOLT 3: Bitcoin Transaction and Script Formats
    • lnd currently uses a commitment design from a prior iteration of the protocol. Revocation secret generation is handled by elkrem and our scripts are slightly different.
  • 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

Installation

In order to build from source, the following build dependencies are required:

  • Go: Installation instructions can be found here.

    It is recommended to add $GOPATH/bin to your PATH at this point. Note: If you are building with Go 1.5, then you'll need to enable the vendor experiment by setting the GO15VENDOREXPERIMENT environment variable to 1. If you're using Go 1.6 or later, then it is safe to skip this step.

  • Glide: This project uses Glide to manage dependencies as well as to provide reproducible builds. To install Glide, execute the following command (assumes you already have Go properly installed):

    $ go get -u github.com/Masterminds/glide
    
  • btcd: This project currently requires btcd with segwit support, which is not yet merged into the master branch. Instead, roasbeef maintains a fork with his segwit implementation applied. To install, please see the installation instructions.

With the preliminary steps completed, to install lnd, lncli, and all related dependencies run the following commands:

$ git clone https://github.com/lightningnetwork/lnd $GOPATH/src/github.com/lightningnetwork/lnd
$ cd $GOPATH/src/github.com/lightningnetwork/lnd
$ glide install
$ go install . ./cmd/...

Updating

To update your version of lnd to the latest version run the following commands:

$ cd $GOPATH/src/github.com/lightningnetwork/lnd
$ git pull && glide install
$ go install . ./cmd/...

Tests

To check that lnd was installed properly run the following command:

go install; go test -v -p 1 $(go list ./... | grep -v  '/vendor/')

IRC

  • irc.freenode.net
  • channel #lnd
  • webchat

Further reading