lit

lit - a lightning node you can run on your own

Under development, not for use with real money.

Setup

Prerequisites

• Git

• Go

• Go

• (Optional, Windows) a Cygwin environment might make things easier for you.

Downloading

1. Clone this repo with git clone https://github.com/mit-dci/lit or do go get github.com/mit-dci/lit

2. cd into the lit directory (either inside your GOPATH or your cloned directory)

3. Run make lit to build lit and make test to run the tests. make test with-python=true will include the python tests (requires bitcoind). Alternatively, you can run go build to build lit if you're building inside your GOPATH.

Installing

1. Set your Go variables to match your installed paths are set correctly:

• .../go/bin (your install location) is in $PATH (Windows: Add the install location into your PATH System Variable)
• $GOPATH is set the location of where you want lit (and other projects) to be
• optional: If you want to have packages download in a separate location than your installation add $GOROOT set to another location

1. Download the lit project with go get github.com/mit-dci/lit

2. Run ./lit --tn3 1 to start lit

The words yup, yes, y, true, 1, ok, enable, on can be used to specify that lit automatically connect to a set of populated seeds. It can also be replaced by the ip of the remote node you wish to connect to.

Building

1. Go to the location of your lit installation with your defined gopath variable ($GOPATH on Linux and %GOPATH% Windows) to the lit location

cd [gopath]/src/github.com/mit-dci/lit

1. If you try to build now with go build you will receive several errors such as

cannot find package "golang.org/x/crypto/nacl/secretbox"
...
cannot find package "golang.org/x/crypto/scrypt"
...
cannot find package [packageName]
...

1. In order to download all missing packages, do go get ./... or go get .

2. Go back to location of the lit folder if you are not already there (Step 1) and try to rebuild the project.

3. You may now want to build lit-af, the text based client which controls the lit node using

cd cmd/lit-af
go build

1. To run lit use:

(Note: Windows users can take off ./ but may need to change lit to lit.exe in the second line.)

cd GOPATH/src/github.com/mit-dci/lit
./lit --tn3 true

The words true, yes, 1 can be used to specify that lit automatically connect to a set of populated seeds. It can also be replaced by the ip of the remote node you wish to connect to.

Using Lightning

Great! Now that you are all done setting up lit, you can

• read about the arguments for starting lit here
• read about the folders for the code and what does what here
• head over to the Walkthrough to create some lit nodes or
• check out how to Contribute.

Command line arguments

When starting lit, the following command line arguments are available. The following commands may also be specified in lit.conf which is automatically generated on startup.

connecting to networks:

other settings:

Folders

Hierarchy of packages

One instance of lit has one litNode (package qln).

LitNodes manage lndc connections to other litnodes, manage all channels, rpc listener, and the ln.db. Litnodes then initialize and contol wallits.

A litNode can have multiple wallits; each must have different params. For example, there can be a testnet3 wallit, and a regtest wallit. Eventually it might make sense to support a root key per wallit, but right now the litNode gives a rootPrivkey to each wallet on startup. Wallits each have a db file which tracks utxos, addresses, and outpoints to watch for the upper litNode. Wallits do not directly do any network communication. Instead, wallits have one or more chainhooks; a chainhook is an interface that talks to the blockchain.

One package that implements the chainhook interface is uspv. Uspv deals with headers, wire messages to fullnodes, filters, and all the other mess that is contemporary SPV.

(in theory it shouldn't be too hard to write a package that implements the chainhook interface and talks to some block explorer. Maybe if you ran your own explorer and authed and stuff that'd be OK.)

Dependency graph

License

MIT