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

docs: update roadmap #7197

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

docs: update roadmap #7197

wants to merge 4 commits into from

Conversation

crodriguezvega
Copy link
Contributor

@crodriguezvega crodriguezvega commented Aug 21, 2024

Description

I tried to write some kind of cohesive narrative around the changes for port router and eureka, since there are some touch points between them, and even though there is a lot of good information in the issues, I thought it would be nice to glue all this together in a document.

This is not meant to be exhaustive, but more illustrative instead, so that someone can in a 5-minute read understand the overall picture. I can add more detail if there are things that people think should be added.

closes: #XXXX


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against the correct branch (see CONTRIBUTING.md).
  • Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

Comment on lines +83 to +88
message PacketData {
string port_id = 1; // or app_name
string type = 2; // or version
string encoding = 3;
bytes value = 4; // the serialized bytes of the application's packet data
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I took the liberty to put all this together in the same message (I know in the issue it's separate in two different structures, but thought that for clarity it would be possible to put it all together).

Comment on lines +137 to +138
+ string destination_port = 3;
+ string destination_channel = 4;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure if we will need this, but added it for now (if we use channel aliasing, we should be able to find the counterparty channel ID; and if we use a client ID, we should be able also to get the counterparty client ID that was stored with MsgProvideCounterparty).

@crodriguezvega crodriguezvega marked this pull request as draft August 27, 2024 08:55
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.

1 participant