Skip to content

Commit

Permalink
Add documentation.
Browse files Browse the repository at this point in the history
First up, a draft of a paper showing the differences between the LN draft
and this.

Signed-off-by: Rusty Russell <[email protected]>
  • Loading branch information
rustyrussell committed Jul 18, 2015
1 parent 8f64eb9 commit e4921b9
Show file tree
Hide file tree
Showing 21 changed files with 13,442 additions and 0 deletions.
8 changes: 8 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ $(CCAN_OBJS) $(HELPER_OBJS) $(PROGRAM_OBJS) $(BITCOIN_OBJS): ccan/config.h
ccan/config.h: ccan/tools/configurator/configurator
$< > $@

doc/deployable-lightning.pdf: doc/deployable-lightning.lyx doc/bitcoin.bib
lyx -E pdf $@ $<

doc/deployable-lightning.tex: doc/deployable-lightning.lyx
lyx -E latex $@ $<

update-ccan:
mv ccan ccan.old
DIR=$$(pwd)/ccan; cd ../ccan && ./tools/create-ccan-tree -a $$DIR `cd $$DIR.old/ccan && find * -name _info | sed s,/_info,, | sort` $(CCAN_NEW)
Expand All @@ -58,10 +64,12 @@ update-ccan:

distclean: clean
$(RM) lightning.pb-c.c lightning.pb-c.h ccan/config.h
$(RM) doc/deployable-lightning.pdf

clean:
$(RM) $(PROGRAMS) test-cli/leak-anchor-sigs
$(RM) bitcoin/*.o *.o $(CCAN_OBJS)
$(RM) doc/deployable-lightning.{aux,bbl,blg,dvi,log,out,tex}

ccan-tal.o: $(CCANDIR)/ccan/tal/tal.c
$(CC) $(CFLAGS) -c -o $@ $<
Expand Down
7 changes: 7 additions & 0 deletions doc/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
*.aux
*.bbl
*.blg
*.dvi
*.log
*.out
*.tex
64 changes: 64 additions & 0 deletions doc/bitcoin.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
@InProceedings{Decker2015Making,
author = {Christian Decker and James Guthrie and Jochen Seidel and Roger Wattenhofer},
note = {\tt decker@ethz.ch and wattenhofer@ethz.ch},
title = {{Making Bitcoin Exchanges Transparent}},
booktitle = {{20th European Symposium on Research in Computer Security (ESORICS), Vienna, Austria}},
month = {September},
year = {2015}
}
@misc{Poon2015Lightning,
author = {Joseph Poon and Thaddeus Dryja},
title = {The Bitcoin Lightning Network DRAFT Version 0.5},
note = {\url{http://lightning.network/lightning-network-paper-DRAFT-0.5.pdf}},
year = {2015},
urldate = {2015-02-28}
}
@misc{nakamoto2008bitcoin,
title={{Bitcoin: A peer-to-peer electronic cash system}},
author={Nakamoto, Satoshi},
year={2008}
}
@misc{BitcoinChannels,
title = {{Rapidly-adjusted (micro)payments to a pre-determined party}},
urldate = {2015-07-13},
note = {\url{https://en.bitcoin.it/wiki/Contract#Example_7:_Rapidly-adjusted_.28micro.29payments_to_a_pre-determined_party}}
}
@article{DBLP:journals/corr/DeckerW14,
author = {Christian Decker and
Roger Wattenhofer},
title = {Bitcoin Transaction Malleability and MtGox},
journal = {CoRR},
volume = {abs/1403.6676},
year = {2014},
url = {http://arxiv.org/abs/1403.6676},
timestamp = {Tue, 01 Apr 2014 11:56:46 +0200},
biburl = {http://dblp.uni-trier.de/rec/bib/journals/corr/DeckerW14},
bibsource = {dblp computer science bibliography, http://dblp.org}
}
@misc{BIP62,
author = { Pieter Wuille },
title = { Dealing with malleability },
urldate = {2015-07-13},
note = {\url{https://github.com/bitcoin/bips/blob/master/bip-0062.mediawiki}}
}
@misc{BIP65,
author = { Peter Todd },
title = {{OP\_CHECKLOCKTIMEVERIFY}},
urldate = {2015-07-13},
note = {\url{https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki}}
}
@misc{friedenbach_bitcoin-development_2015,
title = {[Bitcoin-development] [{BIP} draft] Consensus-enforced transaction replacement signalled via sequence numbers},
note = {\url{http://lists.linuxfoundation.org/pipermail/bitcoin-dev/2015-June/008452.html}},
type = {E-mail},
author = {Friedenbach, Mark},
urldate = {2015-07-13},
date = {2015-06-02}
}
@misc{nolan_alt,
title = {Alt chains and atomic transfers},
note = {\url{https://bitcointalk.org/index.php?topic=193281.msg2224949#msg2224949}},
author = {Nolan, Tier},
urldate = {2015-07-14},
file = {Alt chains and atomic transfers:/home/rusty/.mozilla/firefox/vfn6if9k.default/zotero/storage/PEHK469N/index.html:text/html}
}
581 changes: 581 additions & 0 deletions doc/commit-tx.eps

Large diffs are not rendered by default.

Loading

0 comments on commit e4921b9

Please sign in to comment.