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

1044 Commits

Author SHA1 Message Date
lisa neigut
d923df5e43 peer-protocol: fixup punctuation to clarify meaning
The punctuation in this case made it hard to understand.
2018-11-29 04:12:06 +00:00
lisa neigut
9b5c3df9ce peer-protocol: explain what a commitment number is, in situ
Although commitment numbers are explained in the
[glossary](00-introduction.md#glossary-and-terminology-guide),
it's helpful to re-iterate at the place that it's first used.
2018-11-29 04:12:06 +00:00
lisa neigut
1bbcd5552b peer-protocol: fix tense use -> used 2018-11-29 04:12:06 +00:00
lisa neigut
c572c1c42a peer-protocol: add missing word
Missing `to`
2018-11-29 04:12:06 +00:00
lisa neigut
0087a64244 peer-protocol: Add link to channel failure in 05
To 'fail a channel' is mentioned multiple places in this
BOLT without any mention or definition of what that means.

This adds a link to the relevant text in BOLT 05 in the
first place that we mention 'fail the channel'.
2018-11-29 04:12:06 +00:00
lisa neigut
2f72c225ea peer-protocol: Add short note about channel_id
Clarify association between temp_id and channel_id, and make
explicit why we have to wait for the funding transaction.
2018-11-29 04:12:06 +00:00
lisa neigut
f98689b598 intro glossary: add 'outpoint'
Add a short definition of an outpoint.
2018-11-29 04:12:06 +00:00
lisa neigut
05a4d18c1e peer-protocol: Add links to referenced BOLTs
Add links to make it clearer that these two actions:
'authentication' and 'initialization' are specified elsewhere.
2018-11-29 04:12:06 +00:00
lisa neigut
5727c3dff0 peer-protocol: Add chan_reestablish message name to TOC
Make it easier to tell at a glance what messages this BOLT
concerns.
2018-11-29 04:12:06 +00:00
ZmnSCPxj
67b96de4ec 07-routing-gossip.md: Describe standard human-readable format for short channel ID. 2018-11-27 00:05:16 +08:00
ZmnSCPxj, ZmnSCPxj jxPCSmnZ
65753ff6fb 02-peer-protocol.md: Minor typo. (#505) 2018-11-12 16:47:57 +01:00
Hiroki Gondo
635a6a7df9 BOLT 8: fix a typo 2018-11-06 14:26:27 +11:00
Hiroki Gondo
1222fd1eca BOLT 8: fix s description
In this document `s` is not a public key but keypair.
Because there are expressions such as `s.priv`
2018-11-06 14:26:27 +11:00
Hiroki Gondo
6fea210458 BOLT 8: change the order of arguments of ECDH function
ref. http://noiseprotocol.org/noise.html#dh-functions
The order of arguments of DH function is the order of private key, public key.
Made the same order.
This order is reflected in the expressions of `ee`, `se`, `es`, `ss`.
2018-11-06 14:26:27 +11:00
Hiroki Gondo
46b616c142 BOLT 8: fix names of returned values of ECDH function
ref. http://noiseprotocol.org/noise.html#overview-of-handshake-state-machine
Change `ss` to `es`, `ee`, `se` according to each case.
2018-11-06 14:26:27 +11:00
lisa neigut
57dad8161b routing gossip: remove fixup statement
per rusty, this is left over from a previous editing
pass and can be removed.
2018-10-29 00:17:36 +00:00
lisa neigut
5a1dafb67f routing gossip: fixup final/endpoint nomenclature weirdness
'final' and 'endpoint' node don't make much sense out of
context of a payment (in the former case) or when referring to
a non-channel party node. this fixes this
2018-10-29 00:17:36 +00:00
lisa neigut
b4be990550 routing gossip: attempt to make timestamping mechanism for
channel_announcement clearer
2018-10-29 00:17:36 +00:00
lisa neigut
bae8f9c2c6 routing gossip: remove errant tick 2018-10-29 00:17:36 +00:00
lisa neigut
35cee93cee routing gossip: make channel_update singular 2018-10-29 00:17:36 +00:00
lisa neigut
74167366bb routing gossip, query message: attempt to clarify description of
`query_short_channel_ids`
2018-10-29 00:17:36 +00:00
lisa neigut
d88e58db90 routing gossip: add missing 'a' 2018-10-29 00:17:36 +00:00
lisa neigut
772e8b854a routing gossip: specify where gossip_queries is flagged on 2018-10-29 00:17:36 +00:00
lisa neigut
7d2c4d5542 routing gossip: re-order initial sync & rebroadcast so it matches table of contents 2018-10-29 00:17:36 +00:00
lisa neigut
b73c77ffe9 routing gosisp: use semi-colon, not colon 2018-10-29 00:17:36 +00:00
lisa neigut
1c6a00778e routing gossip: have Initial Sync be in present tense 2018-10-29 00:17:36 +00:00
lisa neigut
2427bdca7b routing-gossip: add clarifying statement to Initial Sync section
The Initial Sync section is hard to parse, as is, because it's presented
without context. This adds a small clarifying statement, in particular
highlighting where the mode is triggered from (init message features)
and what in particular is being synced (gossip messages)
2018-10-29 00:17:36 +00:00
lisa neigut
620b033dd6 routing gossip: clarify what 'redundant' means 2018-10-29 00:17:36 +00:00
ueno
1ddc1a54d7 BOLT2: both nodes send update_add_htlc
issue #472
2018-10-29 00:07:56 +00:00
Rusty Russell
bca814e270 BOLT 4: final_incorrect_htlc_amount should be 64-bits.
Fixes: #469
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-10-18 05:17:48 +00:00
lisa neigut
80eed319ab gossip: add additional clarification for 'discard'
It's unclear what it means to `discard` a channel.
This add a clarification that it's related to route-finding.
2018-10-18 05:17:26 +00:00
Chris Stewart
25a9debcf3 Make unit explicit encoded in BOLT11 invoice
Rewording
2018-10-18 05:15:48 +00:00
Pierre-Marie Padiou
1fd1e76f9e clarify that error should target the unkown channel 2018-10-18 05:15:22 +00:00
Pierre-Marie Padiou
1de095a0b3 reply to unknown channels with an error 2018-10-18 05:15:22 +00:00
sstone
6e6c28dae5 BOLT4: fix description of incorrect_cltv_expiry error
The explanation in the requirements section is correct but the
error message description was probably copy-pasted from
`final_incorrect_cltv_expiry`
2018-10-01 13:22:58 -07:00
Matt Corallo
8516beb2c4 Remove padding within node_announcement address data
This optional padding makes it very difficulty to deserialize
node_announcements into internal structs for storage and then
reconstruct the original node_announcement, plus are unused on the
network today and no known implementations construct
node_announcement messages with them.
2018-09-17 19:44:11 +00:00
Matt Corallo
2b253f7a61 Correct fee calculation in BOLT 7
The fee calculation in BOLT 7 appears to imply that proprtional
fees must be paid on the incoming amount, not the to_forward amount

This is inconsistent with what is actually implemented in the
field (which uses amount_to_forward) and also would make
pathfinding more complicated as the fee would depend on itself,
making calculation no longer simple.
2018-09-04 00:38:40 +00:00
Rusty Russell
0bb2739133 BOLT 7: advise against spamming with channel_updates.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-08-24 23:42:56 +02:00
Rusty Russell
b6ae60d241 BOLT 7: add maximum capacity field.
This helps lite nodes a little, but also gives a way of advertising a
lesser capacity than implied onchain.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-08-24 23:42:56 +02:00
Rusty Russell
0891374d47 BOLT 7: split flags field in channel_update.
This is not a semantic change: only the lower two bits were defined.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-08-24 23:42:56 +02:00
landonmutch
76b1ce9ae5 BOLT 10 copy edit (#440)
[ Squashed several commits: -- RR ]
* bolt10 copy edit to line 54;

* bolt10: add dns seed queries requirements section;

* bolt10: finish copy edit;

* bolt10: add Overview, ToC, and Authors sections;

* fix @shannonas suggestions;

* change naming of additional section in DNS seed requirements
2018-08-07 00:10:11 +00:00
ueno
3f2c747955 fix typos 2018-08-07 00:07:42 +00:00
Hajime Yamaguchi
a9195a84d0 BOLT 3/BOLT 7: Fix broken links. 2018-08-07 00:07:26 +00:00
Rusty Russell
4b62d26af9 BOLT 2: fix placement of chain_hash requirement.
Reported-by: Matthias Grundmann @mattias-g
Fixes: #453
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-07-26 03:11:01 +00:00
Rusty Russell
f971e0dbf2 BOLT 11: delete confusing-causing rationale sentence.
I was trying to compactly indicate that the considered alternative to
multiplier postfixes was just express everything in millisatoshi, but
it's just confusing, and anyway there are other notations we didn't use
so it seems like a weird thing to explain.

Reported-by: @cdecker
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-07-25 02:38:02 +00:00
Rusty Russell
21e3688e84 BOLT 11: reword Human-Readable Part Requirements in modern form.
a.k.a. landonmutch style, where requirements are explicit and bullet-pointed.

This also tightens requirements:
1. New requirement (previously implied) that writer use correct prefix.
2. Reader MUST rather than SHOULD fail malformed `amount`.

It also makes it clear that writer can omit the multiplier.

Fixes: #442
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-07-25 02:38:02 +00:00
Rusty Russell
d99b936bc4 fixup! BOLT 0: Attempt shorter introduction as informal index. 2018-07-23 11:26:40 +00:00
Rusty Russell
cd02353282 BOLT 0: Attempt shorter introduction as informal index.
This was inspired by @shannona's
https://github.com/lightningnetwork/lightning-rfc/pull/415

Especially the title line :)

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-07-23 11:26:40 +00:00
Rusty Russell
e0c436bd7a BOLT 8: remove extraneous ).
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-06-29 02:23:15 +00:00
Rusty Russell
fd9da9b95e BOLT 7: Add compressed (zlib) encoding.
[ Note: in retrospect, adding this in the initial draft without its
  own feature bit was a mistake.  It was a premature optimization,
  adds complexity and removes the ability to disable it if a problem
  is found without disabling gossip_queries entirely.  However, it
  is already deployed as-is. --RR ]
  
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-06-28 00:21:23 +00:00