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

Update warp readme #765

Merged
merged 7 commits into from
Aug 16, 2023
Merged

Update warp readme #765

merged 7 commits into from
Aug 16, 2023

Conversation

aaronbuchwald
Copy link
Collaborator

Why this should be merged

This PR improves the README in x/warp and references the new Warp README in AvalancheGo instead of explaining everything in one place.

How this works

Updates the Warp README

How this was tested

n/a

How is this documented

This PR is documentation

@aaronbuchwald aaronbuchwald self-assigned this Jul 31, 2023
@aaronbuchwald aaronbuchwald marked this pull request as ready for review July 31, 2023 21:39
Copy link
Contributor

@martineckardt martineckardt left a comment

Choose a reason for hiding this comment

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

Very good as well. I am missing information on best practices or a reference implementation for the encoding/decoding of complex data structures in the message

x/warp/README.md Outdated Show resolved Hide resolved
x/warp/README.md Outdated Show resolved Hide resolved
x/warp/README.md Outdated Show resolved Hide resolved
x/warp/README.md Outdated Show resolved Hide resolved
x/warp/README.md Outdated Show resolved Hide resolved
x/warp/README.md Outdated Show resolved Hide resolved

However, when Subnet B receives a message from the C-Chain, it changes the semantics to the following:

1. Read the SourceChainID of the signed message (C-Chain)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we really only special case C-Chain or is it all of primary network?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Technically we special case the whole primary network, but only the C-Chain will originally support warp.

aaronbuchwald and others added 5 commits August 15, 2023 10:56
Co-authored-by: Darioush Jalali <[email protected]>
Signed-off-by: aaronbuchwald <[email protected]>
Co-authored-by: Darioush Jalali <[email protected]>
Signed-off-by: aaronbuchwald <[email protected]>
Co-authored-by: Darioush Jalali <[email protected]>
Signed-off-by: aaronbuchwald <[email protected]>
@aaronbuchwald aaronbuchwald merged commit 9f21235 into master Aug 16, 2023
7 checks passed
@aaronbuchwald aaronbuchwald deleted the warp-readme branch August 16, 2023 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants