2
0
mirror of https://github.com/lnbook/lnbook synced 2024-11-01 03:20:53 +00:00
Go to file
Andreas M. Antonopoulos a36f5a6643
Merge pull request #853 from RandyMcMillan/10_onion_routing.asciidoc
10_onion_routing.asciidoc: fix enumerated list
2021-09-20 09:53:10 +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 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 Color screenshots 2021-08-11 11:32:21 +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 ch-01: mentino splicing as 3rd channel txn type 2021-09-16 20:00:59 -07:00
02_getting_started.asciidoc Merge pull request #672 from Zendo102/patch-7 2021-09-17 15:33:56 +02:00
03_how_ln_works.asciidoc Merge branch 'develop' into typo-fix 2021-09-17 15:43:20 +02:00
04_node_client.asciidoc Docker example fixes, upgrades and ch4 text edits 2021-09-12 16:12:43 +02:00
05_node_operations.asciidoc ch-05: mention rene as author of CL's autopilot plugin 2021-09-16 20:01:18 -07:00
06_lightning_architecture.asciidoc multi: typo fixes in ch 6+11 2021-09-16 19:46:56 -07:00
07_payment_channels.asciidoc Made small grammar corrections to chapters 7, 8, 9, 10, and 11. 2021-09-17 09:19:21 -04:00
08_routing_htlcs.asciidoc 08_routing_htlcs.asciidoc: fix enumerated list 2021-09-19 17:35:12 -04:00
09_channel_operation.asciidoc Made small grammar corrections to chapters 7, 8, 9, 10, and 11. 2021-09-17 09:19:21 -04:00
10_onion_routing.asciidoc 10_onion_routing.asciidoc: fix enumerated list 2021-09-19 17:35:53 -04:00
11_gossip_channel_graph.asciidoc Made small grammar corrections to chapters 7, 8, 9, 10, and 11. 2021-09-17 09:19:21 -04:00
12_path_finding.asciidoc fix typo (#827) 2021-09-10 21:11:51 +02:00
13_wire_protocol.asciidoc ch-13: fix grammar re attack surface 2021-09-16 19:58:10 -07:00
14_encrypted_transport.asciidoc Grammar fix, missing comma. 2021-09-16 03:29:28 -04:00
15_security_privacy_ln.asciidoc Fix #730 2021-09-17 16:00:39 +02:00
appendix_docker_basics.asciidoc Docker example fixes, upgrades and ch4 text edits 2021-09-12 16:12:43 +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_payment_requests.asciidoc Appendices and README update 2021-08-04 09:34:13 +02:00
appendix_wire_protocol.asciidoc wire_protocol+appendix: split portion of wire appendix into new chapter 2021-09-14 20:51:45 -07:00
appendix-bitcoin-fundamentals-review.asciidoc appendix-bitcion: mention lock time field by name 2021-09-16 20:01:43 -07: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
github_contributors.asciidoc Added contrib 2021-09-17 15:44:09 +02:00
glossary.asciidoc Merge branch 'develop' into develop 2021-09-17 15:37:35 +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 Update preface.asciidoc 2021-08-02 20:02:59 +02:00
README.md Appendices and README update 2021-08-04 09:34:13 +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 "IN PRODUCTION": ONLY COPY-EDIT CONTRIBUTIONS ARE ACCEPTED.

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

Total Word Count: 125288

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.