Enhance Developer Documentation: Detailed Code Examples, Improved VAA Explanation, and Structure Refinement #48
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
eshaben
reviewed
Sep 3, 2024
There was a problem hiding this comment.
@404PJNotFound Thanks for opening this PR! 💜
Left some comments about items that need to be addressed. Thanks!
build/build-a-custom-multichain-protocol/get-started/choosing-a-relayer/specialized-relayer.md
Outdated
Show resolved
Hide resolved
| - **[Environment](https://github.com/wormhole-foundation/wormhole){target=\_blank}** - select the folder for the desired network to learn about the recommended native toolset | ||
| - **[Mock Guardian](https://github.com/wormhole-foundation/wormhole/blob/main/sdk/js/src/mock/wormhole.ts){target=\_blank}** - it's recommended to set up a mock Guardian or Emitter to provide signed VAAsFor any program methods that require some message be sent or received. | ||
| - **[Environment](https://github.com/wormhole-foundation/wormhole){target=\_blank}** - select the folder for the desired network to learn about the recommended native toolset | ||
| - **[Mock Guardian](https://github.com/wormhole-foundation/wormhole/blob/main/sdk/js/src/mock/wormhole.ts){target=\_blank}** - it's recommended to set up a mock Guardian or Emitter to provide signed VAAs for any program methods that require some message be sent or received. |
build/build-a-custom-multichain-protocol/get-started/dev-env.md
Outdated
Show resolved
Hide resolved
build/build-a-custom-multichain-protocol/get-started/choosing-a-relayer/specialized-relayer.md
Outdated
Show resolved
Hide resolved
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.
Description
Enhancement of Developer Documentation:
Added more detailed explanations, examples, and clearer instructions to guide developers through setting up and working with Wormhole’s protocol and tools.
Detailed Code References and Examples:
Added specific references to code snippets and examples in the documentation. These references provide concrete examples for developers to follow, making it easier to implement various functionalities in their applications.
For instance, in the "Specialized Relayer" section, detailed instructions on how to set up, fetch VAAs, and relay them on different environments (EVM and Solana) were provided. This includes precise code snippets that can be directly used by developers.
Improved Explanation of VAAs:
The documentation now includes a more detailed explanation of VAAs (Verified Action Approvals), including how they are created, signed, and relayed across chains.
The sections on "Actions" and "Lifetime of a Message" have been expanded to better explain how messages are emitted, signed by Guardians, and eventually processed on the target chain.
Checklist
wormhole-mkdocsrepo