1
0
mirror of https://github.com/lightning/bolts.git synced 2024-11-19 10:00:04 +01:00
Commit Graph

505 Commits

Author SHA1 Message Date
Shannon Appelcline
29ae44ec6e BOLT-4 Re-Edits
Minor edits, clarifications, and standardizations.
2018-01-30 03:33:48 +00:00
Pierre-Marie Padiou
46c454cb56 clarify that nodes may support early mutual close 2018-01-22 20:14:38 +01:00
Christian Decker
815182ea26 spell: Add BTC acronym to dictionary 2018-01-22 20:10:53 +01:00
Rusty Russell
7a7db363bb BOLT 11: make example separate, not re-use existing.
@roasbeef wanted to avoid breaking existing tests, so simply replicate it.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-22 20:10:53 +01:00
Rusty Russell
f360cff9d8 BOLT 11: spell out byte limit on d field, and note vagueness of h.
Our 10-bit length means up to 1023 5-bit words, or 639 bytes.  But `h`
is horribly underspecified since we don't have a general solution: using
a URL is a privacy problem, for example.  It might make sense for a future
transport standard (eg. lightning over HTML, or lightning-over-NFC), but
it's fairly unusable at the moment.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-22 20:10:53 +01:00
Rusty Russell
b547854073 BOLT 11: require valid UTF-8, provide example.
I'm clearly showing my age, suggesting ASCII; obviously UTF-8 makes
more sense.  We also didn't have a *requirement* that it be a valid
encoding, so add that.

We already have an example ASCII description ('Please consider
supporting this project'), so just modify the other one to UTF-8
as provided by Jonathan.

Reported-by: Jonathan Underwood <junderwood@bitcoinbank.co.jp>
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-22 20:10:53 +01:00
MeshCollider
4b5379b2ac Fix formatting of BOLT links 2018-01-22 14:02:01 +01:00
William Casarin
b2960b4267 transactions: fix broken anchor links
Signed-off-by: William Casarin <jb55@jb55.com>
2018-01-22 14:01:01 +01:00
Rusty Russell
64cf99d854 BOLT 7: channel_update timestamp must be a UNIX timestamp.
As agreed at the previous meeting, we use the timestamp to prune,
so it does have to be a valid timestamp.  We also suggest ignoring
if it's in the far future, too.

The minutes suggest we can prune for any reason, and that's really
true anyway; the requirements to keep it around are only SHOULD.

Note that this only applies to channel_update: node_announces
are not pruned (except, perhaps, by implication when all channels
are pruned)

Closes: #302
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-22 13:59:45 +01:00
Rusty Russell
47b8851037 BOLT 3: note that key derivation test vectors apply to HTLC keys too.
Reported-by: Matt Corallo
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-22 13:58:45 +01:00
Rusty Russell
7ab1665b2a BOLT 2: clarify that feerate is in *satoshi* per ksipa.
We don't actually say that!

Closes: #336
Reported-by: Matt Corallo
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-09 03:06:29 +00:00
practicalswift
d5b5284b3b Use Markdown numbered list syntax ("1." instead of "1)") 2018-01-08 02:30:34 +00:00
practicalswift
2d9a0b5793 Add missing closing parenthesis 2018-01-08 02:30:34 +00:00
Matt Corallo
2551b602c5 BOLT 3: fix secret gen requirements layout
It misrenders on GitHub. Matt had a patch which changed the actual
form of the requiremnt, this uses ``` instead.

Based-on-Patch-By: Matt Corallo @TheBlueMatt
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-22 00:40:29 +00:00
Landon Mutch
205d521682 BOLT 5: fixed requested changes by @shannona 2017-12-22 00:24:48 +00:00
Landon Mutch
a5fb3ed46b BOLT 5: fix change requests by @rustyrussell 2017-12-22 00:24:48 +00:00
Landon Mutch
b36d0bd9e3 make spellcheck happy 2017-12-22 00:24:48 +00:00
Landon Mutch
b704ed490d BOLT 5: finish first pass copy edit according to stylesheet guidelines 2017-12-22 00:24:48 +00:00
Landon Mutch
e20e5405b2 BOLT 5: copy edit to line 524, replace A/B with local/remote terminology 2017-12-22 00:24:48 +00:00
Landon Mutch
85f31e1b95 BOLT 5: first pass copy edit to line 400 2017-12-22 00:24:48 +00:00
Landon Mutch
572bbccaca BOLT 5: first pass copy edit to line 368 2017-12-22 00:24:48 +00:00
Rusty Russell
a83f2b42e9 BOLT 0, BOLT 3: minor typo fixes.
Reported-by: Shannon Appelcline <shannon.appelcline@gmail.com>
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-21 14:39:06 +10:30
Landon Mutch
4e6eb48e14 make spellcheck happy 2017-12-21 04:08:33 +00:00
Landon Mutch
214e5d7f57 BOLT 3: remove rogue a.k.a. 2017-12-21 04:08:33 +00:00
Landon Mutch
eebd7fad6d BOLT 0: apply updated stylesheet rules 2017-12-21 04:08:33 +00:00
Landon Mutch
34eec6ce14 BOLT 3: apply a.k.a. abbreviation 2017-12-21 04:08:33 +00:00
Landon Mutch
641c6ab7b1 stylesheet update and apply to BOLT 2,3 2017-12-21 04:08:33 +00:00
Landon Mutch
d600f07163 stylesheet: add common abbreviations, add header weight item; 2017-12-21 04:08:33 +00:00
Shannon Appelcline
ff2d8727fc Adjustments per reviews
Including some large-scale changes of punctuation in examples.
2017-12-20 02:55:43 +00:00
Shannon Appelcline
a630180d19 BOLT-11 Edits
More line editing and clarifications, also includes typo-fix from @dimitris-t in #306 and table of contents from @bcongdon in #310.
2017-12-20 02:55:43 +00:00
Rusty Russell
8618c8a74e BOLT 7: there's no htlc_expiry, it's called cltv_expiry.
Closes: #325
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-20 02:55:01 +00:00
Rusty Russell
1cb19fab70 BOLT 5: fix annotation for to-local weight (no change in result).
Closes: #314
Reported-by: nayuta-ueno (@ueno)
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-18 21:39:14 -06:00
Shannon Appelcline
176588fa0d Response to Review 2017-12-18 19:15:08 +00:00
Shannon Appelcline
71c14fab35 BOLT-10 Edits
Mostly simple copy-editing and clarity, though I have one query on address types before I can close this out.
2017-12-18 19:15:08 +00:00
practicalswift
276337a3cc Fix typo in spellchecker ¯\_(ツ)_/¯ 2017-12-18 19:14:25 +00:00
Rusty Russell
e7f34dc932 spelling: add incentivize to dictionary.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-18 19:13:21 +00:00
Landon Mutch
db336a0ed1 BOLT 5: first pass copy edit to line 320, replace we/they terminology with local/remote; 2017-12-18 19:13:21 +00:00
Landon Mutch
46fcc15756 BOLT 5: fix changes requested by @shannona, except for second half "us/them" terminology 2017-12-18 19:13:21 +00:00
Landon Mutch
bd1fc7dfef BOLT 5: fix requested changes by @rustyrussell 2017-12-18 19:13:21 +00:00
Landon Mutch
1a2021ea91 BOLT 5: first pass copy edit to line 248, further implement local/remote terminology; 2017-12-18 19:13:21 +00:00
Landon Mutch
6a2b1dd841 BOLT 5: change us/them terminology to local/remote; 2017-12-18 19:13:21 +00:00
Landon Mutch
9c6ca1b722 BOLT 5: first pass copy edit to line 177, further modify emphasis scheme; 2017-12-18 19:13:21 +00:00
Landon Mutch
11abe4724e BOLT 5: first pass copy edit to line 113, change ephasis scheme; 2017-12-18 19:13:21 +00:00
Landon Mutch
cc7811cea8 BOLT 5: copy edit ToC and headers 2017-12-18 19:13:21 +00:00
Landon Mutch
e085f0c036 BOLT 5: justify lines to ~81 character lengths for easier review, remove double spaces, remove double new lines; 2017-12-18 19:13:21 +00:00
Pierre-Marie Padiou
d622832d8e use remote's htlc_minimum_msat in channel_update
This is a consequence of commit d1fbfd30f8: we now only use *outgoing* `channel_update` messages to build a route.

Basically the node publishing the `channel_update` says: I can only send htlcs > `htlc_minimum_msat` through this channel.

I think this is consistent with the current definition of the `amount_below_minimum` error (BOLT 4):
> If the HTLC does not reach the current minimum amount, we tell them the amount of the incoming HTLC and the current channel setting for the outgoing channel:
2017-12-14 02:14:07 +00:00
Shannon Appelcline
c7c8691d30 BOLT-09 Edits (#321)
I regularized the descriptions in the localfeatures table, so keep a careful eye on the accuracy of those. Otherwise, fairly standard editing in this very short section.

Added text for lack of globalfeatures flags.
2017-12-14 02:08:43 +00:00
Landon Mutch
6586287d88 BOLT 4: fix requested changes by @rustyrussell 2017-12-14 02:07:36 +00:00
Landon Mutch
c4c77235ef BOLT 4: seperate out returning errors requirements, copy edit changes 2017-12-14 02:07:36 +00:00
Landon Mutch
91fbda6cb1 BOLT 4: seperate error messages from requirements 2017-12-14 02:07:36 +00:00