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

Doc: Handshake should pass TRUE for initiatorOnlyDiffusionMode #4790

Merged
merged 1 commit into from Jan 25, 2024

Conversation

AndrewWestberg
Copy link
Contributor

Description

The network-spec.pdf document describes the handshake protocol as passing a bool flag for initiatorAndResponderDiffusionMode. According to the haskell code, this should really be initiatorOnlyDiffusionMode since we should pass TRUE for requesting a unidirectional connection. I've confirmed with @karknu that this corrects a misunderstanding in the spec doc.

Screenshot from 2024-01-24 19-54-19

Checklist

  • Branch
    • Updated changelog files.
    • Commit sequence broadly makes sense
    • Commits have useful messages
    • The documentation has been properly updated
    • New tests are added if needed and existing tests are updated
    • If serialization changes, user-facing consequences (e.g. replay from genesis) are confirmed to be intentional.
  • Pull Request
    • Self-reviewed the diff
    • Useful pull request description at least containing the following information:
      • What does this PR change?
      • Why these changes were needed?
      • How does this affect downstream repositories and/or end-users?
      • Which ticket does this PR close (if any)? If it does, is it linked?
    • Reviewer requested

Copy link
Contributor

@karknu karknu left a comment

Choose a reason for hiding this comment

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

Good catch!
LGTM

Copy link
Contributor

@coot coot left a comment

Choose a reason for hiding this comment

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

LGTM

@coot coot added this pull request to the merge queue Jan 25, 2024
@coot coot added the documentation Network Documentation related tasks label Jan 25, 2024
Merged via the queue into IntersectMBO:master with commit 9896eda Jan 25, 2024
12 of 13 checks passed
@AndrewWestberg AndrewWestberg deleted the amw/fix_network_spec branch January 25, 2024 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Network Documentation related tasks
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants