Swap tutorial rewrite

[fadeev]

• using ZetaChain CLI and Foundry
• updated testnet and localnet examples
• updated to focus on ZetaChain specific aspects

Depends on zeta-chain/example-contracts#278

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
docs-v2	✅ Ready (Inspect)	Visit Preview	Aug 6, 2025 10:22am

[coderabbitai]

📝 Walkthrough

Walkthrough

The swap tutorial for ZetaChain was extensively rewritten and reorganized. The new version introduces a structured, user-oriented guide, adding prerequisites, detailed conceptual explanations, step-by-step environment setup, contract logic breakdowns, deployment, and usage instructions. The original code-focused content was replaced with a comprehensive, modern tutorial integrating both theory and practical examples.

Changes

Cohort / File(s)	Change Summary
Tutorial Rewrite src/pages/developers/tutorials/swap.mdx	Complete overhaul of the swap tutorial content: restructured introduction, detailed prerequisites, expanded setup steps, enriched contract logic explanations, explicit handling of gas, swapping, and withdrawal, inclusion of chain-agnostic design, practical deployment and usage instructions, and removal of full contract code in favor of conceptual and code excerpt explanations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

---

Issues & Suggestions:

• The removal of the full contract code may hinder readers seeking a reference implementation; consider linking to a canonical source repository.
• The new structure is clear, but ensure all code snippets are up-to-date with current best practices and maintain consistency in terminology.
• Verify all CLI commands and explorer links for accuracy and maintainability in a production documentation context.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch rewrite-swap

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 3

🧹 Nitpick comments (1)

src/pages/developers/tutorials/swap.mdx (1)

106-108: Heading uses snake_case while the function is camelCase

The section title on_call does not match the Solidity entry-point onCall.
Aligning terminology avoids confusion.

- ### Universal App entrypoint: on_call
+ ### Universal App entrypoint: onCall

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 782bb2d and 0666ce2.

📒 Files selected for processing (1)

• src/pages/developers/tutorials/swap.mdx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Cursor Bugbot