Skip to content

Edits for BOLT-07#308

Merged
rustyrussell merged 2 commits into
lightning:masterfrom
shannona:bolt7-edit
Dec 10, 2017
Merged

Edits for BOLT-07#308
rustyrussell merged 2 commits into
lightning:masterfrom
shannona:bolt7-edit

Conversation

@shannona
Copy link
Copy Markdown
Collaborator

@shannona shannona commented Dec 6, 2017

A variety of edits for clarity and our styles sheets for BOLT-7. The one other issue for BOLT-7 has been filed as issue #302.

Comment thread 07-routing-gossip.md Outdated
but multiple `node_announcement` messages are possible (to update node
information), and at least two `channel_update` messages are expected.
To support node discovery, peers exchange `node_announcement`
messages, which supply additional information about nodes There can be
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing period between "about nodes" and "There can be"

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

Comment thread 07-routing-gossip.md Outdated
index which pays to the channel.
index that pays to the channel.

If the `open_channel` message had the `announce_channel` bit set, then both nodes must send the `announcement_signatures` message, otherwise they MUST NOT.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

must -> MUST.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

Comment thread 07-routing-gossip.md
1. D: 400 base + 4000 millionths
2. B: 200 base + 2000 millionths
3. C: 300 base + 3000 millionths
4. D: 400 base + 4000 millionths
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine, but FYI, markdown turns these into an enumerated list when rendering anyway :)

Comment thread 07-routing-gossip.md Outdated
If the `open_channel` message had the `announce_channel` bit set, then both nodes must send the `announcement_signatures` message, otherwise they MUST NOT.

If sent, `announcement_signatures` messages MUST NOT be sent until `funding_locked` has been sent and the funding transaction has at least 6 confirmations.
The `announcement_signatures` message is created by constructing a `channel_announcement` message corresponding to the newly established channel and signing it with the secrets matching an endpoint's `node_id` and `bitcoin_key`. The message is then sent using an `announcement_signatures`.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...message, corresponding...channel, and...

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, clearer. Fixed.

Comment thread 07-routing-gossip.md Outdated

If the `open_channel` message had the `announce_channel` bit set, then both nodes must send the `announcement_signatures` message, otherwise they MUST NOT.

If sent, `announcement_signatures` messages MUST NOT be sent until `funding_locked` has been sent and the funding transaction has at least 6 confirmations.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

six

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

Comment thread 07-routing-gossip.md Outdated
`node_2` requires:

1. Prove that the funding transaction pays to `bitcoin_key_1` and
1. Proving that the funding transaction pays to `bitcoin_key_1` and
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

proving...bitcoin_key_1 <--(no 'and')

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The whole line is actually: "1. Proving that the funding transaction pays to bitcoin_key_1 and
bitcoin_key_2."Unless there's a style I'm missing, kept.

Comment thread 07-routing-gossip.md Outdated
2. Prove `node_1` owns `bitcoin_key_1`
3. Prove `node_2` owns `bitcoin_key_2`
2. Proving that `node_1` owns `bitcoin_key_1`
3. Proving that `node_2` owns `bitcoin_key_2`
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

proving...

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I didn't have that style update when I did 07, so keep an eye out when you get there. In any case, I've fixed all three of these lines to be no initial cap and no end period,

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Actually, I reskimmed, and this is the only list with fragments, so we should have this now.

Comment thread 07-routing-gossip.md Outdated
We also need to prove that `node_1` and `node_2` both agree on this
announcement message; that is done by having a signature from each
It is also necessary to prove that `node_1` and `node_2` both agree on this
announcement message; that is accomplished by having a signature from each
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...message; this is...

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Comment thread 07-routing-gossip.md Outdated
announces the fees and minimum expiry delta it requires to relay HTLCs
through this channel. It uses the 8-byte
channel shortid which matches the `channel_announcement` and one bit
through this channel. They use the 8-byte
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...channel. Each uses the...

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed.

Comment thread 07-routing-gossip.md Outdated
through this channel. It uses the 8-byte
channel shortid which matches the `channel_announcement` and one bit
through this channel. They use the 8-byte
channel shortid that matches the `channel_announcement` and one bit
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... and 1 bit

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

@shannona
Copy link
Copy Markdown
Collaborator Author

shannona commented Dec 8, 2017

Updated commit: (1) addresses all reviews from @rustyrussell and @toadlyBroodle ; (2) Correctly capitalizes a few sections that had been missed; and (3) incorporates table of contents courtesy of @bcongdon in #310

@rustyrussell rustyrussell merged commit 27cc354 into lightning:master Dec 10, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants