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

341 Commits

Author SHA1 Message Date
Christian Decker
024f695bd1 Shutting the spellchecker up 2017-09-13 13:03:21 +02: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
Fabrice Drouin
700b5e7a5d update test vectors
maximum error payload size is now 128 bytes, see #227
2017-09-13 13:02:46 +02:00
Johan T. Halseth
5a60b03174 Bolt11: specify that bech32 should allow addresses > 90 characters 2017-09-05 14:49:13 +09:30
Conner Fromknecht
e1652819a0 BOLT 5: clarifies penalty txn weight calculation
Attempts to clarify the weight calculation of penalty
  transactions, and makes sweeping the `to_remote` output
  optional without breaking any existing constraints. Assuming
  these figures are correct, the decision to sweep the
  `to_remote` _does not_ change the current unidirectional
  limit of 483 HTLCs.  Thus, the option to do so can be made
  independently by either party/implemenation.

  The previous equation used to calculate `max_num_htlcs`
  slightly underestimated the theoretical maximum weight,
  since non-witness data was treated as 1:1 with witness
  data.  Ultimately, this had no effect on the computed
  results, but figured we should be more specific here for
  the purpose of properly estimating transaction fees.

  This commit also modifies the `to_local_script` to use the
  latest construction; the derived weights have been updated
  accordingly.
2017-09-05 14:47:58 +09:30
Rusty Russell
6204374dff BOLT 11: p is payment hash, not preimage (in annotated examples).
Reported-by: Andy Schroder <info@AndySchroder.com>
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-09-04 21:23:20 +09:30
Janus Troelsen
49edc5417f Fix link to localkey-remotekey-local_delayedkey-and-remote_delayedkey-derivation 2017-08-26 16:42:32 +09:30
Rusty Russell
955e874acc BOLT 11: recommend URI schemes.
This is unofficial, since we don't have IANA tag, but it doesn't
clash with any existing one.  We'll see if this turns out to be something
people want.

Closes: #206
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-08-22 10:05:09 +09:30
Rusty Russell
4bcf9dde7e BOLT 2: clarify HTLC handling, esp w/ on-chain.
1. We say you can't fail an HTLC until it's removed outgoing; make it clear
   that this could also be on-chain.
2. Insist that you fail an expired HTLC (we never actually said this!)
3. You MUST fulfill an incoming HTLC for which the output was fulfilled
   (otherwise you'll lose money), and of course, even if fulfilled on-chain.

Add an explanation paragraph to BOLT 5 as well, where it discusses on-chain
HTLC output cases (though the requirements about what to do about incoming
HTLCs is actually in BOLT 2).

[ Extra wording clarification thanks to roasbeef ]
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-08-22 09:59:47 +09:30
Rusty Russell
b3b7a96872 BOLT 5: clarify exactly when to use HTLC transactions.
TL;DR: we only need to do it if it's our commitment tx.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-08-22 09:59:47 +09:30
Rusty Russell
68d53822bd Spelling: expand wildcard to cover all []() patterns. (#228)
Otherwise it complains about "[BOLT #10](10-dns-bootstrap.md)".

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-08-22 09:53:34 +09:30
Olaoluwa Osuntokun
876b93151f BOLT 04: increase max size of onion payload messages (#227)
* BOLT 04: increase max size of onion payload messages

This commit increases the max size of the encapsulated onion error
messages. This is a follow up change to the recent change that added a
`chain_hash` field to the `channel_update` message. With the addition of
this field, the largest payload encoded within the onion errors has
expanded to 138 bytes:

  * msat_amount || 2_byte_len || channel_update.

As a result, the old fixed limit (including padding) is now
insufficient. We use 256 bytes here in order to give us room for future
message expansions.
2017-08-22 09:37:02 +09:30
Rusty Russell
eb30bedbb9 Index: add BOLT 10.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-08-22 09:33:44 +09:30
Rusty Russell
a42b31797e BOLT 11: signature is of single SHA256, not double.
Closes: #223
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-08-22 09:28:27 +09:30
Christian Decker
017b16ee33 bolt10: shutting the spellchecker up once more 2017-08-21 22:53:18 +02:00
Christian Decker
e2a2021b4b bolt10: Add reference to BTC seed policy 2017-08-21 22:53:18 +02:00
Christian Decker
565ed92581 bolt10: Add condition querying and bech32 encoding 2017-08-21 22:53:18 +02:00
Christian Decker
5c022cca0f bolt10: Typo in sup 2017-08-21 22:53:18 +02:00
Christian Decker
e9ce66b49b bolt10: Added some initial policies 2017-08-21 22:53:18 +02:00
Christian Decker
51115481dd bolt10: Initial draft of the subdomain structure. 2017-08-21 22:53:18 +02:00
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
Olaoluwa Osuntokun
956e8809d9 BOLT 7: add chain_hashes values to channel_update and channel_announcment
This commit adds a 32-byte `chain_hash` value to both the
`channel_update` and `channel_announcement` messages. The rationale for
this change is that this value is already present within the
`open_channel` for identifying _which_ chain to open the channel
within. As is now, if a pair of peers had channels open on two chains
which somehow are encoded using the same `short_channel_id`, then the
announcements would be ambitious. We resolve this by explicitly
including the `chain_hash` is all channel related announcement
messages.

Note that with this change, we now require 40-bytes to uniquely
identify a channel globally.

Additionally, this modification of the channel announcement messages
allows peers to start building up a heterogenous network graph.
2017-08-08 10:06:21 +09:30
Rusty Russell
094a86ecdb BOLT 2: rework and specify exact shutdown retransmission semantics.
1. Change descriptions of closing tx construction to references to BOLT 3.
2. Recipient *should* check the fee offer has improved in closing_signed.
3. Therefore, sender *must* improve closing offer.
4. Offers do not persist across reconnection, so no state req'd, and
   also helps if fee has changed.
5. You don't need to re-send `shutdown` if you received `closing_signed`
   (implicit acknowledgement).
6. You don't have to accept a `channel_reestablish` which requests the last
   revoke_and_ack be retransmitted if you've already received `closing_signed`
   (which is an implicit acknowledgement).

Closes: #201
Closes: #199
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-08-08 10:05:18 +09:30
Rusty Russell
4dc97605cc BOLT 3: define closing transaction.
The only surprise here (maybe?) is that we use the commitment number encoding.
I think that makes sense, but it was unspecified before.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-08-08 10:05:18 +09:30
Rusty Russell
a49543e8ea BOLT 11: change r to hold multiple entries.
Allows us to put multiple routes in; there was previous confusion.

Closes: #215
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-08-08 09:55:19 +09:30
kek-coin
3274087bd4 Reword proportional fee explanation. 2017-08-07 22:03:58 +09:30
Christian Decker
059125dda4 tools: Add CLTV acronyms 2017-07-30 15:15:24 +02:00
Christian Decker
170cb318a1 BOLT7: Add shadow route extension in the recommendations
This is a recommendation to fuzz the CLTV on the HTLCs such that nodes
along the route have a harder time identifying the intended
recipient. We can either add a random offset or we can start a random
walk from the intended recipient and create a shadow route extension.

Closes #185
2017-07-30 15:15:24 +02:00
Christian Decker
964527158e tools: Adding 'BOLTs' to the dictionary 2017-07-24 13:25:15 -07:00
Christian Decker
efd8096fa6 BOLT4: clarify that failure_code may reuse message type numbers
We reuse the numeric values that we previously assigned to message
types in the failure_code, but there is no possibility for a mixup
since the latter is not transmitted directly on the transport layer
but wrapped in a return packet. Hence there is no way of confusing the
two. Added a short clarification.

Reported-by: Janus Troelsen @ysangkok
Signed-off-by: Christian Decker <decker.christian@gmail.com>
2017-07-24 13:25:15 -07:00
Pierre-Marie Padiou
df66a4e85a BOLT 11: fix formatting typo, r length value, and channel_id->short_channel_id (#212)
* BOLT 11: fix formatting typo, and `r` length value.

The r field is 408 bytes long, which is 82 characters encoded;
this should have been updated when the fee and cltv sizes were
updated (prior to merge into repo).

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

* BOLT 11: `channel_id`->`short_channel_id`
2017-07-24 10:26:49 +02:00
Pierre-Marie Padiou
80688d7900 BOLT 11: Clarify that providing a payment description or description hash is mandatory (#200)
Added a `d` or `h` field to test vectors
2017-07-15 10:30:26 +09:30
Christian Decker
d67a28227c tools: Update formatting of python tools 2017-07-11 12:11:12 +02:00
Janus
22544d7789 Script for extracting structured protocol messages
This changes extract-formats.py so that other scripts can use it, but retains normal functionality.
The new script (structured.py) parses the CSV variant and shows a representation of an OrderedMap.
This could be used to write parsers.
2017-07-11 12:11:12 +02:00
Christian Decker
a11d234e18 tools: Disable alignment check when we have a variable length field
If we have a variable length field we should not check the alignment
of the following fields, the check will be off anyway.
2017-07-11 11:09:03 +02:00
Christian Decker
a257554456 BOLT7: Reorder feature bitmaps in order to allow future changes
Appending new fields to the end of the messages allows us to add new
fields to an existing message, however it does not allow removing
existing fields, e.g., dropping the pubkeys like #187 proposes. Moving
the features bitmap at the beginning of the signed payload allows
this type of change in the future. Nodes verify the integrity of the
message and then check whether there are any even bits they don't
implement. These even bits being required features would then result
in the message being discarded.

In addition to what we discussed during the call I also went ahead and
did the same reordering on `node_announcement`, which I think has the
same issue.

There is a subtle change in semantics, i.e., previously we would
add channels with unknown bits to our local view, but then ignore them
when computing a route. Now we no longer add them to our view, and may
discard the announcement altogether, stopping the broadcast. This is
safe I think since otherwise we'd be forwarding things we can only
verify the signatures of, but nothing else.
2017-07-11 11:09:03 +02:00
Rusty Russell
365a5a0f9f BOLT 4: channel_id -> short_channel_id
Consistency with BOLT 7 makes this much clearer.

Closes: #195
Reported-by: https://github.com/nayuta-ueno
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-07-11 10:41:01 +09:30
Rusty Russell
b574c18f24 BOLT 2: closing fee is based on final commitment "base fee" not actual fee.
The actual fee of the final tx may include eliminated outputs, which can
differ between one side and the other (since they have different thresholds).

Simplify this corner case by using our base fee calculation as the upper bound;
it should be close enough we don't care, but disagreement here could cause
negotiation breakdown.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-07-11 10:40:30 +09:30
Rusty Russell
83aaaedcd5 BOLT 2: make it clear that we set fee, *then* eliminate outputs.
You can't eliminate an output and also guarantee a certain fee, so
we need to define exactly how to do this.

Since the output is (presumably) dust, we might as well just discard it
(effectively increasing the fee).  This avoids the peer directly benefiting
from the elimination as well.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-07-11 10:40:30 +09:30
Christian Decker
a537af3d62 BOLT7: Refer to announce_channel bit, not channels_public
This was changed a while ago, but not reflected here.
2017-07-11 10:39:54 +09:30
Christian Decker
f2d03e707b BOLT7: Allow channel_updates for non-public channels
This was pointed out by @btcontract in #188: we need to communicate
our forwarding parameters even for private channels since otherwise
the other endpoint cannot use the private channel for incoming
routes. So we also accept `channel_update`s for our own channels even
for channels that were not announced publicly. Adds a bit of special
handling for our own channels in the gossip, but it is needed since
private channels would be completely unusable otherwise.
2017-07-11 10:39:54 +09:30
Christian Decker
a5437d065b BOLT7: Add network view pruning (#191)
Explicitly mentions that nodes SHOULD monitor the chain for channel
closes, and that a node MAY be removed if no open channels for that
node remain open.

Also mentions the 2 week lazy pruning we discussed on the call.

Closes #186
2017-07-11 10:13:09 +09:30
Rusty Russell
46848dcf21 BOLT 7: fix outdated description of channel announce.
The requirements were updated in 667ca1fdd6
but not the discussion above.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-06-28 11:36:04 +09:30
Rusty Russell
ac8b830598 BOLT 2: channel_reestablish message, retransmission simplification.
This adds a message for each channel reconnect (after we've
sent/received `funding_signed`, ie. when we rememeber the channel),
which says exactly how many `commitment_signed` and `revoke_and_ack`
we've received.  Really, we could use one bit for each (they could
only be missing the last one), but better to be clear.

This leaves the "rollback if didn't get commitment_signed"
requirement, but avoids any need to handle update duplicates or wonder
what update number a `commitment_signed` applies to after reconnect.

Many thanks to pm47 and roasbeef especially for constructive feedback
which made this far better than I originally had.

Closes: #172
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-06-28 06:46:26 +09:30
Rusty Russell
8424535e1f BOLT 2: don't insist we atomically send and commit to disk.
We can't do that, so allow "write, then send".  That fails on the side of
timing out, rather than having a channel which can't be used.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-06-28 06:46:26 +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
Olaoluwa Osuntokun
5e666b6c99 BOLT 9: remove feature bit for channels_public
This commit removes the feature bit for channels_public as they have
been deprecated by the addition of the `announce_channel` field in the
`open_channel` message.
2017-05-27 10:30:42 +09:30
Olaoluwa Osuntokun
667ca1fdd6 BOLT 2: allow peers to conditionally signal channel announcement in open_channel
This commit gives peers the ability to signal their intent to make a
channel private in the `open_channel` message. This differs from the
current method as now peers are able to create multiple channels with
heterogeneous announcement policies _without_ disconnecting and
re-connecting in-between each channel funding. The prior requirement
for the nodes to re-connect was burdensome and unnecessary.

[ Minor tweaks from feedback folded in -- RR ]
2017-05-27 10:30:42 +09:30
Olaoluwa Osuntokun
38601f6edb BOLT 2: link to BOLT 7 when referring announcement_signature msg
This commit modifies the “Normal Operation” summarization by including
a link to BOLT #7 when mentioning the `announcement_signature` message.
Previously a reader would need to search other documents to figure out
what an `announcement_signature` was, and its purpose.
2017-05-27 10:30:42 +09:30
ZmnSCPxj
13326cca3c Enable travis to spellcheck BOLT#10 to 99. 2017-05-26 14:31:50 +09:30