Go to file
Olaoluwa Osuntokun 2263a6a1b7
lnwire: modify RevokeAndAck to remove NextRevocationHash
This commit modifies the RevokeAndAck message in order to bring it more
in line with the current draft of the specification. The prior version
was based on a version that used a revocation hash for HTLC’s and a
revocation key for commitment outputs. The current commitment design
uses revocation keys uniformly throughout.
2017-07-30 17:47:33 -07:00
brontide multi: run all test instances in parallel 2017-06-17 01:00:07 +02:00
chainntnfs chainntnfs: extend interface test to ensure initial conf height is correct 2017-07-11 17:38:43 -07:00
channeldb lnwallet: add update_fee message support. 2017-07-14 16:39:15 -07:00
cmd/lncli cmd/lncli: properly display errors when sending payments 2017-07-04 15:55:34 -07:00
contrib contrib: add basic bash completion for lncli 2017-01-29 18:12:53 -08:00
discovery lnd: remove seelog logger 2017-06-25 14:19:56 +01:00
docker docker: create distinct containers for blockchains 2017-07-05 10:41:31 -07:00
docs build: create parallel travis builds to isolate race condition tests 2017-07-04 16:05:22 -07:00
htlcswitch lnwire+htlcswitch: minor grammatical, formatting fixes after error PR 2017-07-14 20:08:37 -07:00
lnrpc lnrpc: WalletBalance now returns satoshis instead o fBTC 2017-07-04 15:50:33 -07:00
lnwallet lnwallet+lnwire: minor grammatical fixes after UpdateFee merge 2017-07-14 17:10:42 -07:00
lnwire lnwire: modify RevokeAndAck to remove NextRevocationHash 2017-07-30 17:47:33 -07:00
routing htlcswitch+router: add onion error obfuscation 2017-07-14 19:08:04 -07:00
shachain multi: run all test instances in parallel 2017-06-17 01:00:07 +02:00
zpay32 multi: run all test instances in parallel 2017-06-17 01:00:07 +02:00
.gitignore git: add .DS_Store to .gitignore, remove obsolete entries 2017-05-04 17:39:15 -07:00
.travis.yml build: create parallel travis builds to isolate race condition tests 2017-07-04 16:05:22 -07:00
LICENSE add copyright, license and discouragement in readme 2016-01-16 00:13:11 -08:00
README.md Fixing badges in README 2017-03-22 11:44:29 -07:00
breacharbiter.go test: update integration test set up to reflect recent RPC change 2017-07-04 15:53:06 -07:00
chainregistry.go chains: add default routing policy for current supported blockchains 2017-06-17 00:12:43 +02:00
config.go config: add regtest support to lnd 2017-07-11 16:54:43 -07:00
doc.go add some daemon related skeleton files 2015-12-26 00:09:17 -06:00
features.go features: add temporary feature for encrypted payment errors 2017-07-14 20:09:00 -07:00
fundingmanager.go funding: avoid dereferencing a nil localDiscoverySignal 2017-07-14 17:14:22 -07:00
glide.lock build: update to latest version of neutrino+btcwallet 2017-07-14 18:36:03 -07:00
glide.yaml build: update to latest version of neutrino+btcwallet 2017-07-14 18:36:03 -07:00
gotest.sh build: create parallel travis builds to isolate race condition tests 2017-07-04 16:05:22 -07:00
invoiceregistry.go multi: replace usage of fastsha256 with crypto/sha256 2017-03-15 18:56:41 -07:00
lnd.go config: Specify gRPC proxy port with --restport command line arg 2017-07-05 11:57:12 -07:00
lnd_test.go htlcswitch+router: add onion error obfuscation 2017-07-14 19:08:04 -07:00
log.go lnd: update logging interaction to latest API changes 2017-07-06 14:37:02 -07:00
networktest.go test: ensure the WaitForBlockchainSync grouting always exits 2017-07-11 16:29:35 -07:00
networktest_test.go netharness: remove test for the node restart method 2016-11-16 12:46:45 -08:00
nodesigner.go nodesigner: compact sigs should reference compact pubkeys 2017-05-12 14:21:19 -07:00
params.go config: add regtest support to lnd 2017-07-11 16:54:43 -07:00
peer.go lnd: hook up encrypted onion error scaffolding 2017-07-14 19:08:04 -07:00
peer_test.go plasma: rough draft of peer struct 2015-12-20 15:16:38 -06:00
release.sh build: add release script 2017-01-12 18:30:47 -08:00
rpcserver.go rpc: properly return satoshis in WalletBalance response 2017-07-04 15:51:08 -07:00
server.go lnwire+htlcswitch: minor grammatical, formatting fixes after error PR 2017-07-14 20:08:37 -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.go rpc: non-existence of a nursery report is no longer an error 2017-05-14 19:20:31 -07:00
utxonursery_test.go test: run utxo nursery tests serially 2017-06-19 14:28:19 +02:00
version.go lnd: bump version to 0.2.1-alpha 2017-04-07 18:10:45 +02:00

README.md

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