2
0
mirror of https://github.com/lnbook/lnbook synced 2024-11-01 03:20:53 +00:00
Go to file
2021-07-06 16:57:36 +02:00
.github/ISSUE_TEMPLATE Update issue templates 2020-02-06 08:11:44 -06:00
.gitignore Update .gitignore 2019-08-22 13:33:44 -06:00
callouts O'Reilly templates 2020-02-01 10:14:27 -06:00
code/docker Changed comment, wrong implementation 2021-02-21 21:30:02 +01:00
contrib cleanup and reorg of chapters, README updated 2021-06-29 10:28:45 -04:00
images rest of channel operations 2021-07-06 16:57:36 +02:00
theme O'Reilly templates 2020-02-01 10:14:27 -06:00
tools Script to find any PR affecting a single file 2021-06-29 10:28:45 -04:00
.editorconfig Add trim_trailing_whitespace to .editorconfig 2020-02-09 08:35:06 -08:00
.travis.yml Relaxed Travis to avoid breaking builds while things are in flux 2020-04-19 17:51:38 -04:00
01_introduction.asciidoc introduction: fix link to "Bitcoin Fundamentals Review" appendix (#661) 2021-03-29 19:57:25 +02:00
02_getting_started.asciidoc Add reference to bitcoin fundamentals appendix 2021-03-23 11:23:39 -06:00
03_how_ln_works.asciidoc Message, connection, node ID 2021-06-29 10:28:45 -04:00
04_node_client.asciidoc Rename chapters 4,5 and updated README 2021-03-23 11:12:35 -06:00
05_node_operations.asciidoc Rename chapters 4,5 and updated README 2021-03-23 11:12:35 -06:00
06_lightning_architecture.asciidoc Chapters 6, 7 and README updates 2021-05-03 14:08:02 -05:00
07_payment_channels.asciidoc Added TIP on relative timelocks 2021-06-29 10:28:45 -04:00
08_routing_htlcs.asciidoc cleanup and reorg of chapters, README updated 2021-06-29 10:28:45 -04:00
appendix_license_notices.asciidoc Added subheading to license notice appendix 2020-02-08 10:33:10 -06:00
appendix-bitcoin-fundamentals-review.asciidoc asymmetric, delayed, revocable commitments 2021-06-29 10:28:45 -04:00
atlas.json Updated atlas.json 2021-02-11 06:02:57 -08:00
author_bio.html Edited author_bio.html with Atlas code editor 2021-02-12 13:13:12 -08:00
channel-graph.asciidoc Changing story/example names throughout 2021-02-08 16:22:58 -06:00
channel-operation.asciidoc rest of channel operations 2021-07-06 16:57:36 +02:00
colo.html Updates to O'Reilly files 2020-02-01 11:03:34 -06:00
CONTRIBUTING.md contributing: add US spelling instruction 2020-11-13 10:34:02 +02:00
copyright.html Edited copyright.html with Atlas code editor 2021-02-12 13:18:16 -08:00
cover.html Edited cover.html with Atlas code editor 2021-02-12 13:10:21 -08:00
e2e-presentation-layer.asciidoc Update e2e-presentation-layer.asciidoc 2020-12-27 18:11:44 +01:00
glossary.asciidoc Update glossary.asciidoc (#669) 2021-04-15 16:35:21 +02:00
gossip.asciidoc diverse minor typo 2021-04-05 17:26:32 +02:00
ix.html O'Reilly templates 2020-02-01 10:14:27 -06:00
LICENSE.md Initial LICENSE.md 2019-08-26 14:42:07 -06:00
onion-routing-htlc-forwarding.asciidoc Update onion-routing-htlc-forwarding.asciidoc 2020-07-30 15:28:24 +02:00
onion-routing.asciidoc Cleanup routing and add complete HTLC outline 2021-04-24 19:16:10 -05:00
p2p.asciidoc Update p2p.asciidoc 2020-11-30 15:43:19 +02:00
path-finding.asciidoc Renaming in scripts, image filename and other 2021-02-08 16:28:18 -06:00
preface.asciidoc Add name to contributors in preface 2021-05-19 23:15:12 -04:00
README.md cleanup and reorg of chapters, README updated 2021-06-29 10:28:45 -04:00
security_privacy_ln.asciidoc Deanonymization is not trivial 2021-01-24 11:22:24 +01:00
titlepage.html Edited titlepage.html with Atlas code editor 2021-02-12 13:15:10 -08:00
toc.html O'Reilly templates 2020-02-01 10:14:27 -06:00

Mastering the Lightning Network

Build Status

Mastering Lightning Cover

About

Mastering the Lightning Network is an O'Reilly Media book, due for publication in Q2'2021, and announced in August 2019 by authors Andreas M. Antonopoulos (@aantonop), Olaoluwa Osuntokun (@roasbeef), Rene Pickhardt (@renepickhardt).

The book describes the Lightning Network (LN), a Peer-to-Peer protocol running on top of Bitcoin and other blockchains, which provides near-instant, secure, micro-payments.

The book is suitable for technical readers with an understanding of the fundamentals of Bitcoin and other open blockchains.

Status

The current status of the book is "IN PROGRESS". See below for status of specific chapters and read the contribution guide to learn how and where to contribute.

Legend

  • 🔃 LIVE EDITS - Continuously changing: Submit focused/small Issues and PRs
  • 🔍 REVIEW - Ready for review: Submit Issues and PRs as needed
  • 🔏 EARLY DRAFT - In progress, changing often: Submit issues only, NO PRs or fixes
  • 📑 OUTLINE - Rough outline - Please contribute! PRs welcome.
  • 💭 PLANNED - Planned section - Do nothing yet.
  • ✔️ DRAFT PUBLISHED - Published in early release - Copy edit only.
Section Length (Word Count) Status
PART 1 PART 1 PART 1
Preface and Acknowledgments #### ✔️
Glossary ############## 🔃
Introduction ########## ✔️
Getting Started ############# ✔️
LN Basics (How LN Works) ########################### ✔️
Nodes (LN Clients) #################### ✔️
Operating a Node ############################# ✔️
PART 2 PART 2 PART2
Lightning Architecture # 🔍
Payment Channels in Detail ############### 🔍
Routing (HTLCs) ################ 🔍
Channel operation with HTLCs and Statemachine ###### 🔏
Payment Path Finding ############### 🔏
Onion Construction and Routing # 🔏
P2P Communication ### 📑
Channel Graph and Gossip Layer ### 📑
End-to-End Payment Presentation Layer ### 📑
Lightning Applications (LApps) # 💭
LN Security and Privacy # 🔏
LN's Future # 💭
APPENDICES APPENDICES APPENDICES
A1 - Bitcoin Fundamentals Review ########### ✔️
An - License Notices # ✔️

Total Word Count: 103616

Target Word Count: 100,000-120,000

Contributing

The authors welcome contributions to this book! Read the Guide to Contributing

Source and license

Mastering the Lightning Network is released under the Creative Commons CC-BY-NC-ND license, which allows sharing the source code for personal use only. You may read this book for free. You may not create derivatives (such as PDF copies), or distribute the book commercially. The full terms of the license can be found here:

Creative Commons License

Mastering the Lightning Network by Andreas M. Antonopoulos, Olaoluwa Osuntokun, Rene Pickhardt is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

It is expected that the book will be released under a more permissive CC-BY-SA license within a year of publication.