Lightning Network Daemon
Go to file
2017-05-12 14:21:19 -07:00
brontide brontide+lnwire: fix linter issues 2017-04-20 15:50:13 -07:00
chainntnfs lnwallet: use new ChainNotifier API, typo fixes 2017-05-11 15:21:05 -07:00
channeldb channeldb+funding: track opening height using MarkChannelAsOpen 2017-05-11 15:20:33 -07:00
cmd/lncli cmd/lncli: add signmessage and verifymessage commands 2017-05-12 14:21:19 -07:00
contrib contrib: add basic bash completion for lncli 2017-01-29 18:12:53 -08:00
discovery discovery+lnwallet: fix tests by making mock notifiers compliant to new interface 2017-05-11 15:58:41 -07:00
docker docker: update docker instructions to be aware of multi-chain config 2017-05-11 14:42:27 -07:00
docs docs: fix entry for externalip 2017-05-11 14:58:55 -07:00
lnrpc rpc: add SignMessage and VerifyMessage interface 2017-05-12 14:21:19 -07:00
lnwallet discovery+lnwallet: fix tests by making mock notifiers compliant to new interface 2017-05-11 15:58:41 -07:00
lnwire brontide+lnwire: fix linter issues 2017-04-20 15:50:13 -07:00
routing routing/chainview: linter fixes 2017-05-11 15:36:47 -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 git: add .DS_Store to .gitignore, remove obsolete entries 2017-05-04 17:39:15 -07:00
.travis.yml travis: update travis build to go1.8.1 2017-04-20 15:46:05 -07:00
breacharbiter.go peer+rpcserver+breacharbiter: usel latest ChainNotifier API 2017-05-11 15:20:55 -07:00
chainregistry.go lnd: add new chainRegistry struct for multi-chain dispatch 2017-05-02 19:57:46 -07:00
config.go config: set chain directory _after_ the command line+config has been parsed 2017-05-02 20:29:14 -07:00
doc.go add some daemon related skeleton files 2015-12-26 00:09:17 -06:00
features.go features: add new feature bits to guard recent changes 2017-04-16 18:19:09 -07:00
fundingmanager.go funding: modify ChainNotifier usage due to recent API change 2017-05-11 15:20:53 -07:00
glide.lock build: update glide to pull in github.com/ltcsuite/ltcd/chaincfg 2017-05-02 19:58:15 -07:00
glide.yaml build: update glide to pull in github.com/ltcsuite/ltcd/chaincfg 2017-05-02 19:58:15 -07:00
gotest.sh gotest: remove slow linters 2017-03-21 14:56:23 -07:00
htlcswitch.go lnd: switch over internal indexes to use the new Channel ID's 2017-04-16 15:41:19 -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 rpc: add SignMessage and VerifyMessage interface 2017-05-12 14:21:19 -07:00
lnd.go lnd: properly initialize ChannelRouter with FilteredChainView 2017-05-11 15:20:57 -07:00
log.go discovery+routing: split 'routing' package on 'routing' and 'discovery' 2017-03-29 19:49:05 -07:00
networktest_test.go netharness: remove test for the node restart method 2016-11-16 12:46:45 -08:00
networktest.go tests: add test case "disconnecting target peer" 2017-05-05 14:24:25 -07:00
nodesigner.go rpc: add SignMessage and VerifyMessage interface 2017-05-12 14:21:19 -07:00
params.go config: add litecoin testnet4 parameters to the set of RPC parameters 2017-05-02 19:57:52 -07:00
peer_test.go plasma: rough draft of peer struct 2015-12-20 15:16:38 -06:00
peer.go peer: ensure no messages are sent/processed _before_ all channels loaded 2017-05-11 15:21:00 -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 rpc: add SignMessage and VerifyMessage interface 2017-05-12 14:21:19 -07:00
server.go server: eliminate possible initial connection churn by ignoring duplicate inbound conns 2017-05-11 15:21:02 -07:00
signal.go lnrpc+rpc+lnd: add new Stop command for gracefully shutting down lnd 2017-05-11 14:55:56 -07:00
utxonursery_test.go utxonursery: store the chanPoint of the source channel in kidOutput 2017-05-04 17:39:29 -07:00
utxonursery.go utxonursery: modify ChainNotifier usage due to recent API change 2017-05-11 15:20:50 -07:00
version.go lnd: bump version to 0.2.1-alpha 2017-04-07 18:10:45 +02: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