Lightning Network Daemon
Go Other
Permalink
Failed to load latest commit information.
brontide multi: add link to LICENSE in README license badges (#100) Jan 13, 2017
chainntnfs multi: add link to LICENSE in README license badges (#100) Jan 13, 2017
channeldb multi: add link to LICENSE in README license badges (#100) Jan 13, 2017
cmd/lncli cmd/lncli: add parsing+dispatch for the `debuglevel` command Jan 15, 2017
docker docker: add example output to commands in workflow Jan 13, 2017
docs docs: update INSTALL.md with new btcd commit hash, correct instructions Jan 15, 2017
elkrem multi: update btcsuite API's to latest upstream changes Jan 5, 2017
lnrpc lnrpc: add DebugLevel command Jan 15, 2017
lnwallet lnwallet+lnd: ensure curve parameters are set to avoid panics Jan 15, 2017
lnwire lnwire+lnd: Make Logging Messages Great Again Jan 15, 2017
routing multi: add link to LICENSE in README license badges (#100) Jan 13, 2017
shachain multi: update btcsuite API's to latest upstream changes Jan 5, 2017
zpay32 multi: add link to LICENSE in README license badges (#100) Jan 13, 2017
.gitignore Add RPC to show current total available channel capacity #29 (#35) Sep 15, 2016
.travis.yml travis: update build to go1.7.4 Jan 13, 2017
LICENSE add copyright, license and discouragement in readme Jan 16, 2016
README.md README: reformat and add IRC badge Jan 13, 2017
breacharbiter.go breacharbiter: ensure failure to retrieve channels triggers start-up … Jan 15, 2017
config.go config+test: use default port for RPC server if one isn't specified Jan 5, 2017
doc.go add some daemon related skeleton files Dec 26, 2015
fundingmanager.go lnwire+lnd: Make Logging Messages Great Again Jan 15, 2017
glide.lock build: update glide.lock to latest commit hashes Jan 15, 2017
glide.yaml build: update glide dependancies since roasbeef/btcsuite upstream merge Jan 5, 2017
htlcswitch.go peer+htlcswitch: add support for multi-hop HTLC error propagation Jan 8, 2017
invoiceregistry.go lnd: add additional logging statement on payment recv Jan 15, 2017
lnd.go config+test: use default port for RPC server if one isn't specified Jan 5, 2017
lnd_test.go test: add ability to push funds during funding to OpenChannel Jan 10, 2017
log.go lnd: fix lingering connmgr import Jan 5, 2017
networktest.go test: fix typos Jan 13, 2017
networktest_test.go netharness: remove test for the node restart method Nov 16, 2016
params.go lnd: remove support for the now obsolete SegNet4 Jan 5, 2017
peer.go lnwire+lnd: Make Logging Messages Great Again Jan 15, 2017
peer_test.go plasma: rough draft of peer struct Dec 20, 2015
release.sh build: add release script Jan 13, 2017
rpcserver.go rpcsever: implement DebugLevel command Jan 15, 2017
server.go lnwallet+lnd: ensure curve parameters are set to avoid panics Jan 15, 2017
signal.go create signal.go to handle SIGINT's Mar 23, 2016
utxonursery.go utxonursery: add additional comments to new sections Jan 8, 2017
utxonursery_test.go multi: update btcsuite API's to latest upstream changes Jan 5, 2017
version.go create version.go file Mar 23, 2016

README.md

Lightning Network Daemon

Build Status      MIT licensed      Irc      Godoc

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 form 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