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

35 Commits

Author SHA1 Message Date
Rusty Russell
eb6f3084c5 Make it explicit when to send warnings, errors, fail channel and close connection.
And make most places warn or error.  Places where we're operating
on a channel tend to be "warn and close connection" since we want to
forget the mistake they just sent, and closing the connection does that.

We now use the same words everywhere:
1. "fail channel" means to go onchain (if necessary).
2. "send `error`" means to send an error message.
3. "send `warning`" means to send a warning message.
4. "close connection" means close the connection.

These are all spelled out explicitly, rather than having "fail channel"
imply sending an error packet, for example.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-12-14 10:32:22 +10:30
Hugo Doyon
ffeece3dab Bolt 00: Added Internal Links to Glossary (#637) 2019-07-15 10:01:15 +02:00
Hiroki Gondo
c423308886 BOLT 0,2,5: closing transaction not (mutual) close transaction.
Be consistent.
2019-01-07 20:17:45 +01:00
lisa neigut
f98689b598 intro glossary: add 'outpoint'
Add a short definition of an outpoint.
2018-11-29 04:12:06 +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
Shannon Appelcline
fb16dd0f5d Formatting fixes. 2018-05-24 04:09:54 +00:00
Christian Decker
ed62389520 BOLT0: Add route and invoice to glossay
Co-authored-by: Shannon Appelcline <shannon.appelcline@gmail.com>
Co-authored-by: Christian Decker <decker.christian@gmail.com>
2018-05-24 04:09:54 +00:00
Shannon Appelcline
31fdef56b3 Fixes per Rusty's comments
Some embarssing typos there! Anywho, here are you fixes.

I am out of town next week, but after I get back I will have some definite time on my schedule, and can draft an intro for the spec, if we're comfortable with all the terms here.
2018-05-24 04:09:54 +00:00
Shannon Appelcline
88ed1ac10c Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.

The overarcing changes are:

1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.

*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.

*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing,  node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.

(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-05-24 04:09:54 +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
eebd7fad6d BOLT 0: apply updated stylesheet rules 2017-12-21 04:08:33 +00:00
Shannon Appelcline
0d8a1a20c4 BOLT-2 Edit
Some slightly larger scale revisions for BOLT-2, notably including a reorganization of the "open_channel" function with the introduction of two missing arguments.

Also, the addition of MSAT to the glossary in BOLT-0.
2017-12-04 05:41:03 +00:00
Landon Mutch
c00df17214 BOLT 0,2: update stylesheet, apply associated changes, 2nd pass copy-edit
BOLT 0: Update style sheet to reflect correct Bitcoin capitalizations
BOLT 2: Complete second pass copy-edit according to stylesheet guidelines
2017-11-28 23:11:55 +00:00
Shannon Appelcline
c9a6d69385 Minor Typo fix. 2017-11-27 23:38:01 +00:00
Shannon Appelcline
46cf6ea1fe Line editing and some more extensive attempts to create clarity.. 2017-11-27 23:38:01 +00:00
Landon Mutch
c89a54a7da BOLT 0,1,2: fix requested changes;
update stylesheet to reflect appropriate structure of Requirement sub-items and format of digits, numerations, and quantities;
copy edit BOLTs 0,1,2 to adhere to these changes;
2017-11-15 02:55:16 -08:00
Landon Mutch
b475639f48 BOLT 0, 1, 2: copy edit
add stylesheet item: prefer typed, not written numbers;
updated BOLT 0, 1 to reflect change;
copy edit BOLT 2 up to line 674;
2017-11-10 14:05:21 -08:00
Landon Mutch
c3ef4cabe5 fix 00-introduction, 01-messaging section spacings for format consistency 2017-11-09 18:32:52 -08:00
Landon Mutch
2f6a629a03 minor grammar, punctuation, and capitalization fixes; 2017-11-09 13:30:31 -08:00
Landon Mutch
7e4611af2b copy-edit 00-introduction for appropriate grammer, punctuation, and style
Edit 00-introduction copy for clarity (minor rephrasing, punctuation),
correctness (grammar, capitalization, punctuation),
consision (minimizing wordiness, redundancy),
and consistency (document style, e.g. 1 space between sentences,
capitalization of headers, etc.)
2017-11-04 09:32:16 -07:00
Rusty Russell
ca713c8c6b Remove BOLT #6 from index, spelling list.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-10-17 10:33:12 +00:00
Christian Decker
813ce3e91f BOLT00: Fix the chain_hash description
This was changed in #237 so fix it here as well.
2017-09-13 13:03:21 +02:00
Rusty Russell
eb30bedbb9 Index: add BOLT 10.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-08-22 09:33:44 +09:30
Olaoluwa Osuntokun
25fc33bfbb glossary: move definition of chain_hash to BOLT #0
This commit modifies the glossary to add a new entry which defines the
usage of `chain_hash` throughout the remainder of the documents.
Additionally, we now also specify which chain hash we expect for
Bitcoin within the glossary.

This commit also modifies BOLT #2 and #7 to omit the definition of the
expected `chain_hash` value for Bitcoin.
2017-08-08 10:06:21 +09:30
Rusty Russell
01571c1e58 Bolt 11: Invoice Protocol for Lightning Payments (#183)
This specifies a draft invoice protocol for lightning payments.

Particular thanks for detailed feedback from:
* ZmnSCPxj <ZmnSCPxj@protonmail.com>
* @Saicere  
* @kallewoof
* @halseth 
* @cdecker 

Signed-off-by: Rusty Russell <rusty@blockstream.com>
2017-06-27 20:08:13 +09:30
Rusty Russell
4af8e18411 BOLT 0,1,2,7: use txout not channel-id for demuxing. (#119)
At cost of a few extra bytes between peers, this avoids the whole "oops, we were on a chain fork" problem, and simplifies generation of temporary channel-ids (just pick a random one).

Now we move the announcement_signature exchange to at least 6 confirms, which makes re-xmit tricky; I resolved that by insisting on reconnect that we send if we haven't received, and reply to the first one.

The term "channel shortid" wasn't used anywhere, so I removed it; it's now a gossip-only thing anyway.

One subtle change: pkt_error on unknown channels is now "MUST ignore"; this section was reworked anyway, and we'll want this if the #120 goes through, where one side might have forgotten unformed channels).

Closes: #114
Suggested-by: Olaoluwa Osuntokun <laolu32@gmail.com>
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>

* FIXUP! Two bytes for funding-output-index.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>

* FIXUP! Channel-id rework, temp ids, 32 bits only.

Re-add the idea of temporary channel ids: far simpler since they're now
big enough we can just fill with noise.

Remove the alignment issues by combining txid and outnum using XOR; we
could reduce to 128 bit if we really wanted to, but we don't.

Error handling is now simple again, but while editing I changed the
behaviour for unknown channels to MUST ignore (this is important for

Change the 8-byte gossip channel id to `short-channel-id`.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>

* FIXUP!  Minor text tweaks from Pierre-Marie and Christian

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-03-02 14:50:13 +10:30
Christian Decker
4e3ad54a90 BOLT 2&7: Cleaner separation of concerns wrt announcement signatures (#97)
* BOLT 2&7: Cleaner separation of concerns wrt announcement signatures

So far we did not have any indication on what to do if a node does not
allow announcing the channel and we had a mix of concerns in the
`funding_locked` message, which would also transfer the signatures
needed for the announcement. This is a proposal about splitting the
signatures into their own message, so that simple omission is an
opt-out of announcements, and it does not mix announcement/gossip
stuff into the peer-protocol.

(It also ended up adding a localfeatures flag to opt-into the channel-announcement, and thus creating BOLT 9)
2017-02-07 11:23:39 +10:30
Delo
37d1a0ad31 spelling typo 2017-01-11 20:15:21 +10:30
Christopher Jämthagen
9fff656d70 Some spelling and language fixes in BOLTs 0,1,2 2016-12-06 15:30:48 +01:00
Rusty Russell
04d5cbc96c BOLT 0: Fix up name and link for BOLT 1
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2016-12-04 10:36:34 +10:30
Rusty Russell
4a6201232d BOLT 0: update index to add BOLT 7 and 8.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2016-12-04 10:23:08 +10:30
Christian Decker
296075ec96 glossary: Added the _it's ok to be odd_ rule 2016-12-01 11:20:45 +01:00
Rusty Russell
193bbef972 Add CC-BY.
Closes: #2
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2016-11-23 06:22:59 +10:30
Rusty Russell
76dfd378ff Transfer from google doc.
Minimal markdown and consistency fixes, more to come.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2016-11-15 11:53:20 +10:30