2
0
mirror of https://github.com/lnbook/lnbook synced 2024-11-15 00:15:05 +00:00
Go to file
2021-07-26 08:56:09 +02: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/docker Changed comment, wrong implementation 2021-02-21 21:30:02 +01:00
contrib onion routing path and payloads 2021-07-26 08:56:09 +02:00
images Unwrapping the onion diagrams 2021-07-26 08:56:09 +02:00
theme O'Reilly templates 2020-02-01 10:14:27 -06:00
tools indent 2021-07-26 08:56:09 +02:00
.editorconfig Add trim_trailing_whitespace to .editorconfig 2020-02-09 08:35:06 -08:00
.gitignore moved gitignore 2021-07-20 15:15:09 +02: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 "A lot of electricity" has political connotations (#749) 2021-07-23 10:26:22 +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 Typo (#744) 2021-07-23 10:20:15 +02:00
04_node_client.asciidoc Rename chapters 4,5 and updated README 2021-03-23 11:12:35 -06:00
05_node_operations.asciidoc Remove duplicated info about autopilot (#746) 2021-07-23 10:23:24 +02:00
06_lightning_architecture.asciidoc Chapters 6, 7 and README updates 2021-05-03 14:08:02 -05:00
07_payment_channels.asciidoc Ch07: Typos, fixes and attempts at improving clarity (#752) 2021-07-23 10:31:53 +02:00
08_routing_htlcs.asciidoc Ch8 typos (#742) 2021-07-23 10:19:26 +02:00
09_channel_operation.asciidoc Unwrapping the onion 2021-07-26 08:56:09 +02:00
10_onion_routing.asciidoc ch-10: explain the distinction between the outer and inner HMACs 2021-07-26 08:56:09 +02:00
appendix_failure_types.asciidoc Error return and conclusion 2021-07-26 08:56:09 +02: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
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
failure_types_table.asciidoc Updated failure_types table 2021-07-26 08:56:09 +02:00
glossary.asciidoc Update glossary.asciidoc (#667) 2021-07-23 10:55:52 +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
preface.asciidoc added name to preface 2021-07-25 14:40:10 +08:00
README.md misc edits and heading changes, README update 2021-07-26 08:56:09 +02: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 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.

Status

The current status of the book is "RELEASE PREP". 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 and HTLC settlement ####### 🔍
Onion Construction and Routing ########## 🔏
Payment Path Finding ############### 🔏
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: 86412

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.