Commit Graph

133 Commits (6eb8546cb4f60a90dfbb53ef954986841467354c)

Author SHA1 Message Date
8go 6eb8546cb4
minor improvements to chapter "Comparison with Bitcoin" part 4 (#207)
- bitcoin, not Bitcoin
- minor fixes
- etc
4 years ago
8go 85fed547c4
minor improvements to chapter "Comparison with Bitcoin" part 3 (#206)
* minor improvements to chapter "Comparison with Bitcoin" part 3

- commas
- more details
-

* remove exageration

- see https://github.com/lnbook/lnbook/pull/206#discussion_r420514935

* fixed typo and added more precise wording

Co-authored-by: Rene Pickhardt <r.pickhardt@gmail.com>
4 years ago
8go 9c65e490bb
minor improvements to chapter "Onion Routing" (#201)
* minor improvements to chapter "Onion Routing" 

- improvement of English
- some additions
- etc.

* removed portion that is in doubt

* put TOR stuff into footnote

* clarified analogy

* removed extreme, setting more realistic expectations

- https://github.com/lnbook/lnbook/pull/201#discussion_r420513603

* added the two requested changes

Co-authored-by: Rene Pickhardt <r.pickhardt@gmail.com>
4 years ago
8go ba64c16fee
minor improvements to chapter "Invoices" (#197)
* minor improvements to chapter "Invoices"

- changed the order a bit.
- since "invoice" is introduced it should be explained right away what it is
- addition, explaining differences in concepts to Bitcoin

* added payment hash

* added 1 sentence, tx vs payment

* minor tweek 

- see https://github.com/lnbook/lnbook/pull/197#discussion_r420512836

Co-authored-by: Rene Pickhardt <rene@rene-pickhardt.de>
4 years ago
8go 728ad2e4f9
minor addition to chapter "Examining the ugly way" (#196)
* minor addition to chapter "Examining the ugly way"

- an addendum explaining in more detail how to catch a cheat

* adjustments to reflect suggestions in comment

- to respond to comments in https://github.com/lnbook/lnbook/pull/196#discussion_r413152207

* incorporated suggestion

- see https://github.com/lnbook/lnbook/pull/196#discussion_r420512233
4 years ago
Rene Pichardt fd18f21a42 renamed ch03 so that PRs by 8go can be handled more easily 4 years ago
Andreas M. Antonopoulos feda3944ef Chapter 3 ready for review, updated README 4 years ago
Rene Pichardt 9c9fcaba49 added the hopefully last section of chapter 3 writing about the payment forwarding algorithm 4 years ago
Andreas M. Antonopoulos bdbed7436c
Merge pull request #230 from HugoDoyon/patch-16
netowrk should be network
4 years ago
Andreas M. Antonopoulos c6b1b404a0
Merge pull request #225 from HugoDoyon/patch-11
publicly insteat of pubicly
4 years ago
Andreas M. Antonopoulos 946dde2845
Merge pull request #224 from oneeman/loose-lose-fix
Fix 'loose' vs 'lose' mistakes
4 years ago
Hugo Doyon 0ed61d7dda
netowrk should be network
netowrk should be network
4 years ago
Andreas M. Antonopoulos faf57d79b0
Merge pull request #228 from HugoDoyon/patch-14
crucially instead of crucually
4 years ago
Andreas M. Antonopoulos 4bed8ff7c3
Merge pull request #229 from HugoDoyon/patch-15
channel typo: chennel
4 years ago
Hugo Doyon b697fb2711
channel typo: chennel
channel instead of chennel
4 years ago
Hugo Doyon f1e2f51b1e
crucially instead of crucually
crucually should be written crucially instead
4 years ago
Hugo Doyon a17cb0b527
payment instead of payement
payment instead of payement
4 years ago
Hugo Doyon da006d423f
publicly insteat of pubicly
publicly insteat of pubicly
4 years ago
Or Neeman b2848b25a5 Fix 'loose' vs 'lose' mistakes 4 years ago
Andreas M. Antonopoulos 7f211229e3
Merge branch 'develop' into patch-10 4 years ago
Andreas M. Antonopoulos 2d2f7285d1
Merge pull request #222 from HugoDoyon/patch-9
Minor correction when"S"
4 years ago
Andreas M. Antonopoulos 991398f494
Merge pull request #221 from HugoDoyon/patch-7
Implicitly (Minor correction)
4 years ago
Hugo Doyon 5c0b883a93
Minor correction
"anormality" should be written "abnormality"
4 years ago
Hugo Doyon 0c5a5a0468
Minor correction when"S"
When does not need "s"
4 years ago
Hugo Doyon 89cee83f81
Implicitly (Minor correction)
"implicitely" should be "implicitly"
4 years ago
Hugo Doyon 27046411dd
then
Instead of "theh", should be writtent "then"
4 years ago
8go cba3c55ff8
ch3: minor improvements to chapter "Thoughts about Trust"
- principal --> Major
- I would not call cost a risk. The opening fee IMHO is not a risk, it is simply a cost.
- commas
- in reference to time "immediately" better than "directly"
- added another example, to explain when not to create a channel
4 years ago
Olaoluwa Osuntokun e26eeb29ea
Merge pull request #209 from 8go/patch-35
addition to chapter "Comparison with Bitcoin" part 6
4 years ago
Olaoluwa Osuntokun a349340160
Merge pull request #205 from 8go/patch-30
minor improvements to chapter "Comparison with Bitcoin" part 2
4 years ago
8go f4688b692b
addition to chapter "Comparison with Bitcoin" part 6
- added new chapter
4 years ago
8go 5f876a4c59
minor improvements to chapter "Comparison with Bitcoin" part 2
- more details
- etc
4 years ago
8go e8bb86d45c
minor improvements to chapter "Comparison with Bitcoin" part 1
- no commas when subject is the same on both parts of sentence
- nothing seems to be gained by introducing concept of "traffic" --> removed it
- instead explained what the scarce resources are
- more explanations
- etc.
4 years ago
8go 3bfca36de6
minor improvements to chapter "Examining the ugly way" (#194)
- again, avoid extreme terms like "really high" that cannot be quantified.
- you do not gain the entire channel capacity, gain means "benefit", if 9 mBTC out of the 10 mBTC channel capacity were yours anyway, you would GET 10 mBTC but only GAIN 1 mBTC.
- additions
- mention of game theory
- etc
4 years ago
8go 1c3f3d7f52
minor improvements to chapter "Examining the bad way" (#193)
- simplified
- reduced sentence length
- comma after thus
- with respect to time "immediately" is better than "directly"
- avoid extremes, replaced "much higher" with "higher", later we specify the figure 5x anyway
- "additional" better than "more" 
- misc clarifications
- some additions
- etc
4 years ago
8go a7f830d7f1
minor improvements to chapter "Examining the good way - mutual close" (#192)
- closing tx, shutdown tx, etc:  to avoid any confusion I took the "shutdown tx" out and simply named it the "on-chain tx"
- replaced "party" with "channel partner" for consistency
- removed "as many people think". If the book does a good job, not many people will think that ! In any case, this phrase does not help. Better to just state the facts. 
- etc
4 years ago
8go ee3164c398
minor improvements to chapter "Closing the channel" (#191)
- Bitcoin: uppercase as it refers to fees on the Bitcoin protocol
- added more detail on importance of longevity of channel
- the last sentence was way too long and too complicated. restructured it.
- etc
4 years ago
8go 66f730a077
minor improvements to "Announcing the channel" (#190)
- added distinction between "public" and "private" channel, added the 2 terms
- rename 2-2 to 2-out-of-2 for consistency and to make it clearer
- simplified a few sentences
- added a few additional clarifying words
- etc
4 years ago
8go 97c8927d66
improvements to chapter "Commitment Transaction", part 2 (#189)
- comma after however
- when referring to time "immediately" is better and more meaningful than "directly"
- when referring to time duration "lasts" is better than "is"
- consistency: "channel partner" better than "party"
- etc
4 years ago
8go 05f8370259
Improvements to chapter "Commitment Transaction" (#188)
- replace "capacity" with "funds to reduce tech jargon
- replaced 2-2 with 2-out-of-2 for consistency and to clarify
- everyone --> singular  .. its funds .. not their funds
- "wallet" wrong, "address" better
- avoid "flaw", it might get misinterpreted, rephrased to clearly state that we present the design step-by-step
- "you probably have realized" and "hope you recognize that" puts the reader in a bind. If the reader does not see the problem we will feel "dumb" because the text implies "probably you realized". I suggest to rewrite it so, that the reader does not feel "dumb" just because he does not see the shortcut. --> see changes
- however requires comma
- avoid extremes like "rather high", use facts and measurable units, here simply "high"
- "to lose funds" incorrect, "loose" is correct
- took one long sentence and split it up into several short one making understanding a lot simpler
- etc
4 years ago
8go 5b3a4ab256
minor improvements to chapter "Payment Hash" and "Additional Meta Data" (#198)
- repeated use of "also", --> furthermore, ...
- minor clarifications
- etc
4 years ago
8go 114387e822
minor improvements to chapter "Delivering the payment" (#199)
- peer-to-peer better than "peer 2 peer" , in acronyms p2p is ok
- English language guidelines recommend numbers up to 12 to be spelled out. 4 --> four
- minor additions/clarifications
4 years ago
8go e2aaeca0df
minor improvements to chapter "Finding a path" (#200)
- added commas
- some sentences presented the ideas in the wrong order and the sentences were too long --> restructured sentences
- etc
4 years ago
8go e7fd91964b
minor improvements to chapter "Missing bits" (#202)
- repeated use of "following"
- peer-to-peer instead "peer to peer"
- minor clarifications
- etc
4 years ago
Kory Newton f226a5fb1a
fix typos in chapter 3 (#166)
* fix typos Chapter 3

* additional ch3 typo fixes

Co-authored-by: Rene Pickhardt <rene@rene-pickhardt.de>
4 years ago
Roman ae9d905f27
fix typos in ch1 and ch2 (#168)
* table indentation

* 'a' before consonant

* less commas

* wording

* unquote commas

* typo

* on chain -> on-chain

* need comma (IMHO)

* dot

* caps acronym

* wording

Co-authored-by: Rene Pickhardt <rene@rene-pickhardt.de>
4 years ago
8go e7ea91fe81
minor improvements in "Example of a poor channel opening procedure" (#184)
- replace "committing attack" with "performing attack" to avoid that the reader incorrectly concludes that the term "commitment tx" has anything to do with "committing an attack"
- signed by, not signed from
4 years ago
8go 58f282ee38
minor improvements to Funding Transaction paragraphs (#183)
- consistently sticking to "2-out-of-2"
- rephrasing some sentences to make them more palatable. "obviously a lie" is a bit aggressive. 
- avoid using exaggerating terms like "very expensive", just state the facts without too many emotions
4 years ago
8go a4e59ed614
improvements to Multisig addresses paragraphs (#182)
- as before "2-out-of-2" is more appropriate than "2-2" 
- "thus" is not what you wanted to express, "however" is what you wanted to say
- added missing comma
- etc
4 years ago
8go 26b0fb4e78
minor corrections in Payment channels paragraphs (#181)
- "the both of you": incorrect English, better "both of you"
- "cheat on you": spoken English, better "cheat you"
- "had to be", that sounds like you are guessing, better "was"
- if you give full names of some, give full names of all 
- added year to make it more precise
- etc.
4 years ago
8go bf44a80973
minor improvements, corrections (#180)
- comma must follow "additionally" and "however" as they are introductory words or phrases
- same for "last but not least", comma missing
- "nothing else than", not perfect English; better "nothing but" 
- "get most use", not perfect English; better "get more benefits"
4 years ago