2
0
mirror of https://github.com/lnbook/lnbook synced 2024-11-15 00:15:05 +00:00
Go to file
2021-09-23 16:53:18 -04:00
.github/ISSUE_TEMPLATE Update issue templates 2020-02-06 08:11:44 -06:00
callouts O'Reilly templates 2020-02-01 10:14:27 -06:00
code Remove versions from lngraph requirements 2021-09-17 15:26:58 +02:00
contrib Fix typo 2021-09-16 19:38:02 -07:00
images converting image to png 2021-09-23 14:03:01 -04:00
theme Edited theme/pdf/pdf.css with Atlas code editor 2021-09-23 13:16:13 -07:00
tools Add script to reconcile references and anchors 2021-09-21 13:06:05 +02:00
.editorconfig Add trim_trailing_whitespace to .editorconfig 2020-02-09 08:35:06 -08:00
.gitignore gitignore: ignore some html files 2021-09-19 18:10:11 -04: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 Merge branch 'develop' 2021-09-21 17:15:01 +02:00
02_getting_started.asciidoc renaming draft figs 2021-09-23 13:54:29 -04:00
03_how_ln_works.asciidoc Edited 03_how_ln_works.asciidoc with Atlas code editor 2021-09-21 12:56:24 -07:00
04_node_client.asciidoc removing index terms 2021-09-23 16:53:18 -04:00
05_node_operations.asciidoc fixing latex 2021-09-23 14:28:27 -04:00
06_lightning_architecture.asciidoc fixing xrefs 2021-09-23 14:52:51 -04:00
07_payment_channels.asciidoc renaming draft figs 2021-09-23 13:54:29 -04:00
08_routing_htlcs.asciidoc removing index terms 2021-09-23 16:53:18 -04:00
09_channel_operation.asciidoc Fixin asciidoc errors 2021-09-23 14:09:48 -04:00
10_onion_routing.asciidoc fixing width problems 2021-09-23 15:42:01 -04:00
11_gossip_channel_graph.asciidoc renaming draft figs 2021-09-23 13:54:29 -04:00
12_path_finding.asciidoc fixing latex 2021-09-23 14:30:45 -04:00
13_wire_protocol.asciidoc renaming draft figs 2021-09-23 13:54:29 -04:00
14_encrypted_transport.asciidoc fixing xrefs 2021-09-23 14:52:51 -04:00
15_payment_requests.asciidoc fixing xrefs 2021-09-23 14:52:51 -04:00
16_security_privacy_ln.asciidoc fixing xrefs 2021-09-23 14:52:51 -04:00
17_conclusion.asciidoc Added wrap-up conclusion chapter 2021-09-21 17:12:09 +02:00
appendix_docker_basics.asciidoc Docker example fixes, upgrades and ch4 text edits 2021-09-12 16:12:43 +02:00
appendix_license_notices.asciidoc fixing xrefs 2021-09-23 14:52:51 -04:00
appendix_protocol_messages.asciidoc fix broken refs 3 2021-09-21 14:57:42 +02:00
appendix-bitcoin-fundamentals-review.asciidoc removing index terms 2021-09-23 16:53:18 -04:00
atlas.json Updated atlas.json 2021-09-23 11:35:09 -07:00
author_bio.html ran intake script 2021-09-23 13:48:37 -04:00
colo.html ran intake script 2021-09-23 13:48:37 -04:00
CONTRIBUTING.md contributing: add US spelling instruction 2020-11-13 10:34:02 +02:00
copyright.html ran intake script 2021-09-23 13:48:37 -04:00
cover.html Edited cover.html with Atlas code editor 2021-02-12 13:10:21 -08:00
failure_types_table.asciidoc Updated failure_types table 2021-07-26 08:56:09 +02:00
github_contributors.asciidoc github_contributors.asciidoc: add @RandyMcMillan 2021-09-19 17:47:26 -04:00
glossary.asciidoc removing index terms 2021-09-23 16:53:18 -04: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
part_1_divider.asciidoc Edited part_1_divider.asciidoc with Atlas code editor 2021-09-23 11:35:22 -07:00
part_2_divider.asciidoc Part 1/2 dividers 2021-09-20 11:12:41 +02:00
preface.asciidoc removing index terms 2021-09-23 16:53:18 -04:00
README.md Updated README, status highlight at top 2021-09-20 10:18:44 +02:00
titlepage.html ran intake script 2021-09-23 13:48:37 -04:00
toc.html ran intake script 2021-09-23 13:48:37 -04:00

Mastering the Lightning Network

Build Status

STATUS: IN PRODUCTION

NO EDITS OR PULL REQUESTS ARE ACCEPTED AT THIS TIME.

The book is currently (Sep 2021) in final production. No changes will be accepted.

Mastering Lightning Cover

About

Mastering the Lightning Network is an O'Reilly Media book, due for publication in Q4'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.

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 and HTLC settlement ####### ✔️
Onion Construction and Routing ################# ✔️
Channel Graph and Gossip Layer ############ ✔️
Payment Path Finding ############ ✔️
Wire Protocol ######### ✔️
Encrypted Message Transport (Brontide) ########## ✔️
Payment Requests (Invoices) #### ✔️
LN Security and Privacy ################# ✔️
APPENDICES APPENDICES APPENDICES
A1 - Bitcoin Fundamentals Review ############ ✔️
A2 - Docker Basics ## ✔️
A3 - Protocol Messages ######## ✔️
A4 - License Notices # ✔️

Total Word Count: 126530

Target Word Count: 100,000-120,000

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.