Archives/lnbook
2
0
Fork 0
mirror of https://github.com/lnbook/lnbook synced 2024-11-01 03:20:53 +00:00
Code Issues Projects Releases Wiki Activity
a42827c2a7
lnbook/contrib/topics.asciidoc

218 lines
6.4 KiB
Plaintext
Raw Normal View History

added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
[preface]
Fix incorrect capitalization
2019-09-21 22:46:40 +00:00
== List of topics
added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
This is a list of grouped topics that might be covered in the book.
Fix missing end-of-line punctuation
2019-09-25 21:52:13 +00:00
It will lead to the creation of an index.
added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
The grouping is obviously not unique and there is no notion of priority compiled to this proposal.
Some topics occur in several groups.
=== Review of Bitcoin
Review of some mechanics and terms from Mastering Bitcoin. This would probably be rather technical.
* address
* Asymmetric Cryptographic System
* bech32
* bip
* bitcoin
* Bitcoin Mining
* block
* Blockchain
* coinbase
* coinbase transaction
* cold storage
* confirmations
* Digital Signature
* double-spending
* ECDSA
* fees
* hash
* Hash Function
Added few extra topics (#48) * Added few extra topics @renepickhardt Nice work on the outline. Here are the changes that I have done. Would appreciate your feedback. I have added a couple of topics like `nLocktime`, `CLTV`, `CSV`, and `nSequence` to the "Review of Bitcoin" section as I feel they form the foundation of the transactions in Lightning Network. Also, I have added the topic "Need for a payment receipt" in the "Motivation of Lightning Network" section as invoice payments gives us a cryptographic proof of payment that is generally lacking in a normal on-chain transaction. I changed the name of `Breach Remedy Transaction` to `Penalty transaction` as the BRT term does not appear anywhere outside Joseph Poon's whitepaper. I think you should also rethink the RSMC term as that term also does not appear in the BOLTs and outside the whitepaper. I think it would be worthwhile to add scriptless scripts and benefits Taproot can provide to Lightning Network in BOLT 1.1 /2.0 section. With Taproot, we would be able to do wonderful things with Lightning onion and as the book gets published in 2H20, we would be might be much closer to Taproot implementation on mainchain. * Update topics.asciidoc * Update topics.asciidoc * Update topics.asciidoc
2019-09-12 13:35:52 +00:00
* Locktime and CLTV
added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
* multisignature
* output
* P2PKH
* P2SH
* P2SH address
* P2WPKH
* P2WSH
* Proof-of-Work
* RIPEMD-160
Added few extra topics (#48) * Added few extra topics @renepickhardt Nice work on the outline. Here are the changes that I have done. Would appreciate your feedback. I have added a couple of topics like `nLocktime`, `CLTV`, `CSV`, and `nSequence` to the "Review of Bitcoin" section as I feel they form the foundation of the transactions in Lightning Network. Also, I have added the topic "Need for a payment receipt" in the "Motivation of Lightning Network" section as invoice payments gives us a cryptographic proof of payment that is generally lacking in a normal on-chain transaction. I changed the name of `Breach Remedy Transaction` to `Penalty transaction` as the BRT term does not appear anywhere outside Joseph Poon's whitepaper. I think you should also rethink the RSMC term as that term also does not appear in the BOLTs and outside the whitepaper. I think it would be worthwhile to add scriptless scripts and benefits Taproot can provide to Lightning Network in BOLT 1.1 /2.0 section. With Taproot, we would be able to do wonderful things with Lightning onion and as the book gets published in 2H20, we would be might be much closer to Taproot implementation on mainchain. * Update topics.asciidoc * Update topics.asciidoc * Update topics.asciidoc
2019-09-12 13:35:52 +00:00
* Sequence and CSV
added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
* Script
* ScriptPubKey (aka pubkey script)
* ScriptSig (aka signature script)
* secret key (aka private key)
* Segregated Witness
* SHA
* Simplified Payment Verification (SPV)
* soft fork
* Transaction
* unspent transaction output (UTXO)
* wallet
=== Motivation: Why the Lightning Network
travis: Add linter to make sure Unix style line endings are used. Add trailing whitespace linter. Fix typos. (#60) * travis: Add linter to make sure Unix style line endings are used * Fix typos * travis: Add linter to detect trailing spaces at end of line * Remove trailing whitespace * Use consistent indentation * travis: Add linter guarding against use of tabs
2019-09-16 16:38:23 +00:00
* clear definition what does scaling of a computer system mean? (I realize that discussions often fail because that term is not well defined among participants. A similar definition might be necessary for Decentralized and trustless)
added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
* Scale Payments (amount of possible payments independent of block size / data base size)
* increase privacy (not all payments stored on chain)
* decrease settlement time (get rid of confirmations)
=== Using / transacting Bitcoin with the Lightning Network
Fix missing end-of-line punctuation
2019-09-25 21:52:13 +00:00
This group of topics would be end user oriented and is rather non technical.
added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
* channels:
** Balance
** Capacity
** Closing
** Maximal channel size
** Opening
** Peer
* install a wallet / node
** cellphone
** desktop
** specialized hardware (RaspiBlitz)
** server / full node
* make a payment
** fees
** invoice
** maximal payment size
** payment hash
** Preimage
* pitfalls
** don't double pay!
** stay online / connected
=== Operating and securing a Lightning Network node
Fixed grammar and small typos (#21) Thanks
2019-09-06 14:05:18 +00:00
While also important for end users to be aware of some of the topics here it is primarily meant for professionals and developers.
added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
* backup & restore a Lightning Network node
Fix typos (#63)
2019-09-16 19:59:02 +00:00
* configure a Lightning network Node
added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
** max concurrent htlc in flight
travis: Add linter for lexical illusions (duplicate words) (#64)
2019-09-16 22:32:07 +00:00
** min channel size
added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
** max channel size
** cltv_expiry delta
** routing fees
** min / max htlc msat
** network (mainnet, testnet, regtest)
** address / port / tor
** funding confirm
** logging
* Denial of service attack vectors
* hardware wallet
* hot wallet hot wallet risk
* uptime
* watchtowers
=== BOLT 1.0
A summary of how the Lightning Network protocol works.
* BOLT
Added few extra topics (#48) * Added few extra topics @renepickhardt Nice work on the outline. Here are the changes that I have done. Would appreciate your feedback. I have added a couple of topics like `nLocktime`, `CLTV`, `CSV`, and `nSequence` to the "Review of Bitcoin" section as I feel they form the foundation of the transactions in Lightning Network. Also, I have added the topic "Need for a payment receipt" in the "Motivation of Lightning Network" section as invoice payments gives us a cryptographic proof of payment that is generally lacking in a normal on-chain transaction. I changed the name of `Breach Remedy Transaction` to `Penalty transaction` as the BRT term does not appear anywhere outside Joseph Poon's whitepaper. I think you should also rethink the RSMC term as that term also does not appear in the BOLTs and outside the whitepaper. I think it would be worthwhile to add scriptless scripts and benefits Taproot can provide to Lightning Network in BOLT 1.1 /2.0 section. With Taproot, we would be able to do wonderful things with Lightning onion and as the book gets published in 2H20, we would be might be much closer to Taproot implementation on mainchain. * Update topics.asciidoc * Update topics.asciidoc * Update topics.asciidoc
2019-09-12 13:35:52 +00:00
* Penalty Transaction
added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
* Closing Transaction
* Commitment Transaction
* Contract
* Diffie Hellman Key Exchange
* Ephemeral Key
* features
** local
** global
* Funding Transaction
* Gossip Protocol
* Hashlocks
* HTLC
* Invoice
* It's ok to be odd rule
* Locktime
* Millisatoshi
* Noise_XK
* Onion Routing
* Penalty Transaction
* Relative Timelock
* Revocable Sequence Maturity Contract
* Revocation Key
* Second stage HTLC
* Source-Based Routing
* SPHINX Mix Format
* Transaction Malleability
* Transport Layer
=== BOLT 1.1 / 2.0
Fixed grammar and small typos (#21) Thanks
2019-09-06 14:05:18 +00:00
Future trends and developments on the Lightning Network.
added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
* discreet log contracts
* dual funded channels
* eltoo Channels
** multiparty channels
** Channel Factories
* multipath Payments
Added few extra topics (#48) * Added few extra topics @renepickhardt Nice work on the outline. Here are the changes that I have done. Would appreciate your feedback. I have added a couple of topics like `nLocktime`, `CLTV`, `CSV`, and `nSequence` to the "Review of Bitcoin" section as I feel they form the foundation of the transactions in Lightning Network. Also, I have added the topic "Need for a payment receipt" in the "Motivation of Lightning Network" section as invoice payments gives us a cryptographic proof of payment that is generally lacking in a normal on-chain transaction. I changed the name of `Breach Remedy Transaction` to `Penalty transaction` as the BRT term does not appear anywhere outside Joseph Poon's whitepaper. I think you should also rethink the RSMC term as that term also does not appear in the BOLTs and outside the whitepaper. I think it would be worthwhile to add scriptless scripts and benefits Taproot can provide to Lightning Network in BOLT 1.1 /2.0 section. With Taproot, we would be able to do wonderful things with Lightning onion and as the book gets published in 2H20, we would be might be much closer to Taproot implementation on mainchain. * Update topics.asciidoc * Update topics.asciidoc * Update topics.asciidoc
2019-09-12 13:35:52 +00:00
* scriptless scripts
added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
* splicing
* watchtowers
* wumbo
* Rendez vous Routing
More ideas could be taken from https://github.com/lightningnetwork/lightning-rfc/wiki/Lightning-Specification-1.1-Proposal-States
=== Lightning Network as a Data Set & Software System
Everything about the Lightning Network that is not covered by the BOLTs but important for developers.
* Autopilot
* centrality
* c-lightning
* Eclair
* graph (theory)
* lnd
* privacy
* social network analysis
* Topology
* Traffic analysis
* pathfinding
** AMP https://lists.linuxfoundation.org/pipermail/lightning-dev/2018-February/000993.html
** JIT https://lists.linuxfoundation.org/pipermail/lightning-dev/2019-March/001891.html
** Trampoline routing https://lists.linuxfoundation.org/pipermail/lightning-dev/2019-April/001950.html
** permuteroute https://github.com/ElementsProject/lightning/pull/2890
travis: Add linter to detect "Satoshi style" double spacing (#61) * Remove double spaces * travis: Add linter to detect double spacing
2019-09-16 16:47:01 +00:00
** Real time strategy games https://lists.linuxfoundation.org/pipermail/lightning-dev/2019-August/002095.html
added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
=== Building on top of the Lightning Network
Fix missing end-of-line punctuation
2019-09-25 21:52:13 +00:00
Creating Lightning Network Applications:
added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
* Client libraries
* Common pitfalls
** concurrent payments in custodial settings
* example lapps
** paywall Example https://github.com/renepickhardt/HackALapp
LN applications - streaming service
2019-10-06 02:53:50 +00:00
** streaming example: currently working on a dollar cost averaging (DCA) streaming service to your own custody, that allows one to be able stack sats on lightning network. Will provide links to example soonish.
added a tentative list of topics which are already grouped a little bit towards potential chapters. this list will most likely be extended in the future before it will be prioritized and filtered and structured. Now is the best time to propose topics and make inputs
2019-09-05 13:31:19 +00:00
** more ideas: https://bitcoingames2019.devpost.com/submissions
* btc pay server
added turbo channels not sure about the section
2019-09-20 19:57:20 +00:00
* Turbo Channels https://medium.com/@akumaigorodski/instant-channels-enable-safe-lightning-payments-with-unconfirmed-funding-8d640defa183
added a few comparisons that the book should cover
2019-09-11 19:07:44 +00:00
Fix incorrect capitalization
2019-09-21 22:46:40 +00:00
=== Comparisons and examples
added a few comparisons that the book should cover
2019-09-11 19:07:44 +00:00
The following is a loose list of potential infoboxes, tables and dropins which will most likely make it to some part of the book.
travis: Add linter to make sure Unix style line endings are used. Add trailing whitespace linter. Fix typos. (#60) * travis: Add linter to make sure Unix style line endings are used * Fix typos * travis: Add linter to detect trailing spaces at end of line * Remove trailing whitespace * Use consistent indentation * travis: Add linter guarding against use of tabs
2019-09-16 16:38:23 +00:00
They have particular illustrative purpose and are therefore collected separately to keep better track of them.
added a few comparisons that the book should cover
2019-09-11 19:07:44 +00:00
Fix incorrect capitalization
2019-09-21 22:46:40 +00:00
==== Comparisons
added a few comparisons that the book should cover
2019-09-11 19:07:44 +00:00
* payment process on Bitcoin vs payment process on the lightning network
* transaction vs payment
* capacity vs balance
* routing fees vs mining fees
travis: Add linter to make sure Unix style line endings are used. Add trailing whitespace linter. Fix typos. (#60) * travis: Add linter to make sure Unix style line endings are used * Fix typos * travis: Add linter to detect trailing spaces at end of line * Remove trailing whitespace * Use consistent indentation * travis: Add linter guarding against use of tabs
2019-09-16 16:38:23 +00:00
* private vs public channel (difficulty to have truly private channels that don't reveal over time on the blockchain?)
added a few comparisons that the book should cover
2019-09-11 19:07:44 +00:00
* source based routing vs best effort routing (onion routing vs IP forwarding)
* eltoo vs RSMC (?)
* private key vs fully signed transaction (it can be seen as almost the same in the sense of ownership)
Replace "onchain" and "On-Chain" with on-chain fix #105
2020-01-23 23:14:07 +00:00
* locked bitcoin vs freely movable bitcoin (on-chain vs. off-chain bitcoin)
comparison routing vs path finding
2019-09-12 21:25:49 +00:00
* routing vs path finding
added a few comparisons that the book should cover
2019-09-11 19:07:44 +00:00
Fix incorrect capitalization
2019-09-21 22:46:40 +00:00
==== Examples
TBA.
added 7 ingredients for a payment channel protocol
2019-09-16 15:02:59 +00:00
Fix incorrect capitalization
2019-09-21 22:46:40 +00:00
==== Properties
added 7 ingredients for a payment channel protocol
2019-09-16 15:02:59 +00:00
* the seven ingredients for a payment channel c.f: https://youtu.be/AcP3czefanM
** 2-2 musig address
** funding transaction to open the channel (without possibility to malleate the transaction)
** commitment transaction to encode the balance of the channel
** a time lock to remove trust
** a communication protocol for partners exchange data outside of the bitcoin network
** asymmetrical information (unless we switch to eltoo but even there not all keys are shared but channel state is symmetric)
** game theoretic and economical incentives to follow the protocol
Reference in New Issue Copy Permalink