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

Incorporate docs feedback for axelar bridge docs. #2717

Open
oeggert opened this issue Aug 9, 2024 · 0 comments
Open

Incorporate docs feedback for axelar bridge docs. #2717

oeggert opened this issue Aug 9, 2024 · 0 comments
Assignees
Labels
content updates Updating, cleaning up, or rewriting existing content for better usability or new contexts

Comments

@oeggert
Copy link
Collaborator

oeggert commented Aug 9, 2024

Received feedback from zklend developers to improve docs on docs.xrplevm.org

Need for more detailed example and documentation

While the existing documentations and the assistance from Common Prefix team have been extremely helpful, it could have been even better if a fully functional code example was provided for a better developer onboarding and experience.

An ideal example would include:
1. Deploying a test contract to EVM chain
2. Creating and funding a test XRPL account
3. Initiating a transaction from that XRPL account to send to EVM chain
4. Waiting for the XRPL transaction to go through
5. Waiting for a new transaction & event to appear on AxelarGateway on EVM chain
6. Using a sufficiently funded EVM account to execute the transaction on EVM chain
7. Asserting that the transaction on EVM chain has been successful (token balance changes, etc)
8. A GMP call example written by Axelar can be a good inspiration for the example.

Furthermore, the existing documentation does not provide some important information that might be important to 
developers, such as  tokenDenom  of XRP and wETH
@oeggert oeggert self-assigned this Aug 9, 2024
@oeggert oeggert added the content updates Updating, cleaning up, or rewriting existing content for better usability or new contexts label Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content updates Updating, cleaning up, or rewriting existing content for better usability or new contexts
Projects
Status: In Progress
Development

No branches or pull requests

1 participant