Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

minor: fixed hierarchy and added a table of content #7

Closed
wants to merge 7 commits into from

Conversation

pm47
Copy link
Collaborator

@pm47 pm47 commented Nov 16, 2016

I spotted some inconsistencies in naming between channel establishment and channel closing.

I'd like to do:

  • shutdown -> close_channel
  • close_signature -> closing_signed

what do you think?

Copy link
Collaborator

@Roasbeef Roasbeef left a comment

Choose a reason for hiding this comment

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

Your suggested renaming SGTM. Curious to see what the others think!


FIXME

* [Channel](#channel)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice addition with the table of contents! 👍

Copy link
Collaborator

Choose a reason for hiding this comment

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

Hmm, there's shutdown, which is where we don't add anything new, and closing, which is where we're negotiation the final close tx. I used to call shutdown "clearing" but that has a specific finance meaning which was deeply sucky.

Ah, I see you reverted that AFAICT? I'll squash and merge.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ah, I see you reverted that AFAICT? I'll squash and merge.

Yeah, I didn't want to mix two separate topics in the same PR. I am just OCDing on funding_signed vs close_signature 😵

@rustyrussell
Copy link
Collaborator

Squashed into three patches, and merged. Thanks!

@pm47 pm47 deleted the patch-2 branch November 18, 2016 09:26
rustyrussell referenced this pull request in rustyrussell/bolts Nov 21, 2016
Contents stolen from Christian's draft.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
@rustyrussell
Copy link
Collaborator

Pierre-Marie Padiou notifications@github.com writes:

pm47 commented on this pull request.

@@ -11,9 +11,25 @@ The messages described in this document are grouped logically into 4 groups by t

  • Routing (types 256-511): node and channel announcements, as well as any active route exploration.

# Table of Contents

-FIXME

Ah, I see you reverted that AFAICT? I'll squash and merge.

Yeah, I didn't want to mix two separate topics in the same PR. I am just OCDing on funding_signed vs close_signature 😵

Agreed. Pick one to change and submit another PR :)

Thanks!
Rusty.

BitfuryLightning added a commit that referenced this pull request Nov 22, 2016
BOLT #7: More complex proposal, using three separate message types.
Roasbeef referenced this pull request in Roasbeef/lightning-rfc May 15, 2017
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.
rustyrussell referenced this pull request in rustyrussell/bolts May 16, 2017
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.
rustyrussell pushed a commit that referenced this pull request May 25, 2017
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.
rustyrussell pushed a commit that referenced this pull request May 27, 2017
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.
Roasbeef referenced this pull request in Roasbeef/lightning-rfc Jul 24, 2017
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.
Roasbeef referenced this pull request in Roasbeef/lightning-rfc Jul 24, 2017
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.
rustyrussell referenced this pull request in Roasbeef/lightning-rfc Aug 8, 2017
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.
rustyrussell pushed a commit that referenced this pull request Aug 8, 2017
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.
@rustyrussell rustyrussell mentioned this pull request Aug 21, 2017
rustyrussell pushed a commit that referenced this pull request Feb 5, 2018
Fixed warnings:

.copy-edit-stylesheet-checklist.md: 49: MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 0]
.copy-edit-stylesheet-checklist.md: 1: MD041/first-line-h1 First line in file should be a top level header [Context: "Basic checklist/stylesheet use..."]
02-peer-protocol.md: 161: MD018/no-missing-space-atx No space after hash on atx style header [Context: "#7](07-routing-gossip.md#bolt-..."]
rustyrussell referenced this pull request in rustyrussell/bolts Mar 5, 2018
…ement/channel_update/node_announcement.

This makes discussing them simpler for the next patch.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
rustyrussell referenced this pull request in rustyrussell/bolts Mar 20, 2018
Suggested-by: @sstone
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
rustyrussell referenced this pull request in rustyrussell/bolts Jun 18, 2018
…ement/channel_update/node_announcement.

This makes discussing them simpler for the next patch.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
rustyrussell referenced this pull request in rustyrussell/bolts Jun 18, 2018
Suggested-by: @sstone
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
rustyrussell referenced this pull request in rustyrussell/bolts Jun 26, 2018
…ement/channel_update/node_announcement.

This makes discussing them simpler for the next patch.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
rustyrussell added a commit that referenced this pull request Jun 28, 2018
…ement/channel_update/node_announcement.

This makes discussing them simpler for the next patch.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
rustyrussell referenced this pull request in rustyrussell/bolts Nov 20, 2018
Reported-by: @Roasbeef
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
rustyrussell added a commit that referenced this pull request Nov 29, 2018
Reported-by: @Roasbeef
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
fjahr pushed a commit to fjahr/lightning-mw that referenced this pull request Dec 25, 2018
ugamkamat added a commit to ugamkamat/lightning-rfc that referenced this pull request Jun 16, 2019
…r channel_update message

While going through the BOLT lightning#7 I was confused by this receiving node requirement for `channel_update` message: "if the `timestamp` is equal to the last-received `channel_update` AND the fields (other than `signature`) differ: MAY blacklist this `node_id`; MAY forget all channels associated with it." On the outset it might read to "`timestamp` should be same, the `signature` should be same as previous but if the other data is different; then blacklist the `node_id`". However, if `signature` is same as previous update but data is different, then the `signature` would be rendered invalid. And since `signature` check is done prior to the `timestamp` check, this situation of checking may not arise. So this check seems to be redundant. However, Mark H corrected me on stackexchange (https://bitcoin.stackexchange.com/questions/88350/bolt-7-can-receiving-node-requirements-in-channel-update-message-give-rise-to) by saying that a valid signature must be provided for this update and timestamp to go through. This pull request corrects the language behind this check.

While creating this pull request, I also noticed a slight typo in the same section. The sentence prior to the one I mentioned above says that if the timestamp is not greater than the previous message, the node should ignore the message. And the second sentence is about comparing if timestamp is equal. But again, this check might not be processed as the message will be discarded if it is not greater. I have changed that to "greater than or equal to".
ugamkamat added a commit to ugamkamat/lightning-rfc that referenced this pull request Jun 16, 2019
While going through the BOLT lightning#7 I was confused by this receiving node requirement for `channel_update` message: "if the `timestamp` is equal to the last-received `channel_update` AND the fields (other than `signature`) differ: MAY blacklist this `node_id`; MAY forget all channels associated with it." On the outset it might read to "`timestamp` should be same, the `signature` should be same as previous but if the other data is different; then blacklist the `node_id`". However, if `signature` is same as previous update but data is different, then the `signature` would be rendered invalid. And since `signature` check is done prior to the `timestamp` check, this situation of checking may not arise. So this check seems to be redundant. However, Mark H corrected me on stackexchange (https://bitcoin.stackexchange.com/questions/88350/bolt-7-can-receiving-node-requirements-in-channel-update-message-give-rise-to) by saying that a valid signature must be provided for this update and timestamp to go through. This pull request corrects the language behind this check.

While creating this pull request, I also noticed a slight typo in the same section. The sentence prior to the one I mentioned above says that if the timestamp is not greater than the previous message, the node should ignore the message. And the second sentence is about comparing if timestamp is equal. But again, this check might not be processed as the message will be discarded if it is not greater. I have changed that to "greater than or equal to".
ugamkamat added a commit to ugamkamat/lightning-rfc that referenced this pull request Jun 16, 2019
…or channel_update message

While going through the BOLT lightning#7 I was confused by this receiving node requirement for `channel_update` message: "if the `timestamp` is equal to the last-received `channel_update` AND the fields (other than `signature`) differ: MAY blacklist this `node_id`; MAY forget all channels associated with it." On the outset it might read to "`timestamp` should be same, the `signature` should be same as previous but if the other data is different; then blacklist the `node_id`". However, if `signature` is same as previous update but data is different, then the `signature` would be rendered invalid. And since `signature` check is done prior to the `timestamp` check, this situation of checking may not arise. So this check seems to be redundant. However, Mark H corrected me on stackexchange (https://bitcoin.stackexchange.com/questions/88350/bolt-7-can-receiving-node-requirements-in-channel-update-message-give-rise-to) by saying that a valid signature must be provided for this update and timestamp to go through. This pull slightly corrects the language behind this check and adds a paragraph in the rationale to explain that point.

While creating this pull request, I also noticed a slight typo in the same section. The sentence prior to the one I mentioned above says that if the timestamp is not greater than the previous message, the node should ignore the message. And the second sentence is about comparing if timestamp is equal. But again, the equal to check might not be processed as the message will be discarded if it is not greater. I have changed that to "greater than or equal to".
ugamkamat added a commit to ugamkamat/lightning-rfc that referenced this pull request Jun 16, 2019
BOLT lightning#7 : Receiving node requirements related to timestamp for channel_update message
t-bast pushed a commit that referenced this pull request Jul 16, 2019
…_update message (#621)

Clarify timestamp requirements for channel_update messages.
ugamkamat added a commit to ugamkamat/lightning-rfc that referenced this pull request Jul 18, 2019
Related to pull lightning#621 

Corrected the indentation in the otherwise section in the `timestamp` check of the `channel_update` message. Both the if appeared at the same level of otherwise.
jnewbery added a commit to jnewbery/lightning-rfc that referenced this pull request Mar 24, 2020
'three gossip messages' should refer to node and channel discovery
messages, not just channel discovery messages.
jnewbery added a commit to jnewbery/lightning-rfc that referenced this pull request Mar 24, 2020
The introductory paragraph describes node discovery and channel
discovery, but changes the ordering. Keep the same ordering throughout
the paragraph for readability.
cdecker pushed a commit that referenced this pull request May 11, 2020
'three gossip messages' should refer to node and channel discovery
messages, not just channel discovery messages.
cdecker pushed a commit that referenced this pull request May 11, 2020
The introductory paragraph describes node discovery and channel
discovery, but changes the ordering. Keep the same ordering throughout
the paragraph for readability.
rustyrussell added a commit that referenced this pull request May 31, 2022
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
rustyrussell added a commit that referenced this pull request Jun 1, 2022
Suggested-by: @t-bast
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
ifuensan added a commit to ifuensan/bolts that referenced this pull request May 9, 2023
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