Under development, not for use with real money.
-
Clone this repo with
git clone https://github.com/mit-dci/litor dogo get github.com/mit-dci/lit -
cdinto thelitdirectory (either inside your GOPATH or your cloned directory) -
Run
make litto build lit andmake testto run the tests.make test with-python=truewill include the python tests (requiresbitcoind). Alternatively, you can rungo buildto build lit if you're building inside your GOPATH.
- 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 yourPATHSystem Variable)$GOPATHis 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
$GOROOTset to another location
-
Download the lit project with
go get github.com/mit-dci/lit -
Run
./lit --tn3 1to 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.
- Go to the location of your lit installation with your defined gopath variable (
$GOPATHon Linux and%GOPATH%Windows) to the lit location
cd [gopath]/src/github.com/mit-dci/lit
- If you try to build now with
go buildyou 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]
...
-
In order to download all missing packages, do
go get ./...orgo get . -
Go back to location of the lit folder if you are not already there (Step 1) and try to rebuild the project.
-
You may now want to build
lit-af, the text based client which controls the lit node using
cd cmd/lit-af
go build
- 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.
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.
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.
| Arguments | Details | Default Port |
|---|---|---|
--tn3 <nodeHostName> |
connect to nodeHostName, which is a bitcoin testnet3 node. |
18333 |
--reg <nodeHostName> |
connect to nodeHostName, which is a bitcoin regtest node. |
18444 |
--lt4 <nodeHostName> |
connect to nodeHostName, which is a litecoin testnet4 node. |
19335 |
| Arguments | Details |
|---|---|
-v or --verbose |
Verbose; log everything to stdout as well as the lit.log file. Lots of text. |
--dir <folderPath> |
use folderPath as the directory. By default, saves to ~/.lit/ |
-p or --rpcport <portNumber> |
listen for RPC clients on port portNumber. Defaults to 8001. Useful when you want to run multiple lit nodes on the same computer (also need the --dir option) |
-r or --reSync |
try to re-sync to the blockchain |
| Folder Name | Details |
|---|---|
bech32 |
Util for the Bech32 spec |
btcutil |
Misc bitcoin-specific libraries |
build |
Tools used for building Lit |
cmd |
Has some rpc client code to interact with the lit node. Not much there yet |
coinparam |
Information and other constants for identifying currencies |
consts |
Global constants |
crypto |
Small utility cryptographic libraries |
dlc |
Discreet Log Contracts! |
docs |
Other walkthroughs for doing things in Lit, also misc pictures |
elkrem |
A hash-tree for storing log(n) items instead of n |
litbamf |
Lightning Network Browser Actuated Multi-Functionality -- web gui for lit |
litrpc |
Websocket based RPC connection |
lndc |
Lightning network data connection -- send encrypted / authenticated messages between nodes |
lnutil |
Some widely used utility functions |
portxo |
Portable utxo format, exchangable between node and base wallet (or between wallets). Should make this into a BIP once it's more stable. |
powless |
Introduces a web API chainhook in addition to the uspv one |
qln |
A quick channel implementation with databases. Doesn't do multihop yet. |
sig64 |
Library to make signatures 64 bytes instead of 71 or 72 or something |
snap |
Snapcraft metadata |
test |
Integration tests |
uspv |
Deals with the network layer, sending network messages and filtering what to hand over to wallit |
wallit |
Deals with storing and retrieving utxos, creating and signing transactions |
watchtower |
Unlinkable outsourcing of channel monitoring |
wire |
Tools for working with binary data structures in Bitcoin |
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.)
