Add architecture and sequence diagrams #328
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cam-schultz
requested review from
michaelkaplan13,
minghinmatthewlam,
geoff-vball and
bernard-avalabs
as code owners
| ```mermaid | ||
| classDiagram | ||
| Listener o-- "per RelayerID" ApplicationRelayer | ||
| Listener *-- "1" Subscriber |
There was a problem hiding this comment.
What does the "1" represent here in the composition link?
There was a problem hiding this comment.
It's meant to represent the number of objects per composition. So an individual Listener has one ApplicationRelayer per RelayerID, and a single Subscriber.
There was a problem hiding this comment.
For clarity, the same notation applies to compositions as well as aggregations. In the above example, Listeners aggregate ApplicationRelayers
geoff-vball
approved these changes
Jun 25, 2024
iansuvak
approved these changes
Jun 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why this should be merged
Adds architecture and sequence diagrams pertaining to online message relaying. Does not cover the catch up mechanism or manual Warp messages for simplicity.
How this works
How this was tested
How is this documented
Adds mermaid diagrams