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

spec/p2p: Document the methods offered by the p2p layer to reactors #758

Closed
1 of 3 tasks
Tracked by #599
cason opened this issue Apr 25, 2023 · 0 comments · Fixed by #851
Closed
1 of 3 tasks
Tracked by #599

spec/p2p: Document the methods offered by the p2p layer to reactors #758

cason opened this issue Apr 25, 2023 · 0 comments · Fixed by #851
Assignees
Labels
p2p spec Specification-related
Milestone

Comments

@cason
Copy link
Collaborator

cason commented Apr 25, 2023

Reactor is the generic name for a component that interacts with the p2p communication layer.

This issue aims to complement the documentation of the interaction between p2p layer and reactors introduced by #714, by focusing on the interface (methods) the p2p layer offers to a Reactor.

Once a Reactor registers with the p2p layer, it receives back from it a reference to the Switch, which is the main component of the p2p layer, with a vast interface. Some of the Switch methods can/should be used by reactors in order to control the operation of the p2p layer.

In addition, once a peer connects to the node, the p2p layer passes to all the registered reactors a Peer handle. This handler offers a number of methods with which the reactor can interact or configure the peer. The most important are the two sending methods, partially documented in the code and here.

Definition of done:

  • The documentation of the methods is more detailed and updated
  • The old documentation points to the new version of the documentation
  • Part of the operation of the documented methods, in particular the methods offered by Peer, are modeled using Quint
@cason cason changed the title Document the methods offered by the P2P layer to reactors spec/p2p: Document the methods offered by the p2p layer to reactors Apr 25, 2023
@cason cason added p2p spec Specification-related labels May 5, 2023
@cason cason added this to the 2023-Q2 milestone May 5, 2023
@cason cason self-assigned this May 5, 2023
@cason cason moved this from Todo to In Progress in CometBFT 2023 May 9, 2023
@cason cason linked a pull request May 17, 2023 that will close this issue
@cason cason moved this from In Progress to Ready for Review in CometBFT 2023 May 30, 2023
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in CometBFT 2023 Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p2p spec Specification-related
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant