docs: make comment clearer for revert context address

[lumtis]

As discussed since it can be a ZRC20 address as well

Summary by CodeRabbit

• Documentation
  • Updated comments for the RevertContext struct to provide clearer explanation of the asset parameter's behavior across different blockchain contexts.
• Refactor
  • Reordered entries in the ParamSymbol type for improved organization.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes involve updating the documentation for the RevertContext struct in the Revert.sol contract, specifically enhancing the explanation of the asset parameter. The updated comment clarifies that on a connected chain, the asset contains the fungible token address or is empty if it's a gas token, and specifies that on ZetaChain, it contains the address of the ZRC20. Additionally, the ParamSymbol type in v2/lib/types.ts has been modified to reorder the string literal "tBTC" to the beginning of the list, while the ParamChainName type remains unchanged.

Changes

File	Change Summary
v2/contracts/Revert.sol	Updated documentation comment for asset parameter in RevertContext struct, providing a detailed explanation of its usage across different blockchain contexts.
v2/lib/types.ts	Reordered the string literal "tBTC" in the ParamSymbol type, with no changes to the ParamChainName type.

The changes are purely documentational and involve reordering without affecting the functionality or structure of the code.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5202760 and 6e43239.

⛔ Files ignored due to path filters (42)

• v2/data/addresses.mainnet.json is excluded by !v2/data/**
• v2/data/addresses.testnet.json is excluded by !v2/data/**
• v2/docs/src/contracts/Revert.sol/struct.RevertContext.md is excluded by !v2/docs/**
• v2/pkg/erc20custody.sol/erc20custody.go is excluded by !v2/pkg/**
• v2/pkg/erc20custody.t.sol/erc20custodytest.go is excluded by !v2/pkg/**
• v2/pkg/erc20custodyupgradetest.sol/erc20custodyupgradetest.go is excluded by !v2/pkg/**
• v2/pkg/gatewayevm.sol/gatewayevm.go is excluded by !v2/pkg/**
• v2/pkg/gatewayevm.t.sol/gatewayevminboundtest.go is excluded by !v2/pkg/**
• v2/pkg/gatewayevm.t.sol/gatewayevmtest.go is excluded by !v2/pkg/**
• v2/pkg/gatewayevmupgradetest.sol/gatewayevmupgradetest.go is excluded by !v2/pkg/**
• v2/pkg/gatewayevmzevm.t.sol/gatewayevmzevmtest.go is excluded by !v2/pkg/**
• v2/pkg/gatewayzevm.sol/gatewayzevm.go is excluded by !v2/pkg/**
• v2/pkg/gatewayzevm.t.sol/gatewayzevminboundtest.go is excluded by !v2/pkg/**
• v2/pkg/gatewayzevm.t.sol/gatewayzevmoutboundtest.go is excluded by !v2/pkg/**
• v2/pkg/gatewayzevmupgradetest.sol/gatewayzevmupgradetest.go is excluded by !v2/pkg/**
• v2/pkg/receiverevm.sol/receiverevm.go is excluded by !v2/pkg/**
• v2/pkg/senderzevm.sol/senderzevm.go is excluded by !v2/pkg/**
• v2/pkg/systemcontract.sol/systemcontract.go is excluded by !v2/pkg/**
• v2/pkg/systemcontractmock.sol/systemcontractmock.go is excluded by !v2/pkg/**
• v2/pkg/testuniversalcontract.sol/testuniversalcontract.go is excluded by !v2/pkg/**
• v2/pkg/zetaconnectornative.sol/zetaconnectornative.go is excluded by !v2/pkg/**
• v2/pkg/zetaconnectornative.t.sol/zetaconnectornativetest.go is excluded by !v2/pkg/**
• v2/pkg/zetaconnectornativeupgradetest.sol/zetaconnectornativeupgradetest.go is excluded by !v2/pkg/**
• v2/pkg/zetaconnectornonnative.sol/zetaconnectornonnative.go is excluded by !v2/pkg/**
• v2/pkg/zetaconnectornonnative.t.sol/zetaconnectornonnativetest.go is excluded by !v2/pkg/**
• v2/pkg/zetaconnectornonnativeupgradetest.sol/zetaconnectornonnativeupgradetest.go is excluded by !v2/pkg/**
• v2/pkg/zrc20.t.sol/zrc20test.go is excluded by !v2/pkg/**
• v2/types/factories/ERC20CustodyUpgradeTest__factory.ts is excluded by !v2/types/**
• v2/types/factories/ERC20Custody__factory.ts is excluded by !v2/types/**
• v2/types/factories/GatewayEVMUpgradeTest__factory.ts is excluded by !v2/types/**
• v2/types/factories/GatewayEVM__factory.ts is excluded by !v2/types/**
• v2/types/factories/GatewayZEVMUpgradeTest__factory.ts is excluded by !v2/types/**
• v2/types/factories/GatewayZEVM__factory.ts is excluded by !v2/types/**
• v2/types/factories/ReceiverEVM__factory.ts is excluded by !v2/types/**
• v2/types/factories/SenderZEVM__factory.ts is excluded by !v2/types/**
• v2/types/factories/SystemContract.sol/SystemContract__factory.ts is excluded by !v2/types/**
• v2/types/factories/SystemContractMock.sol/SystemContractMock__factory.ts is excluded by !v2/types/**
• v2/types/factories/TestUniversalContract__factory.ts is excluded by !v2/types/**
• v2/types/factories/ZetaConnectorNativeUpgradeTest__factory.ts is excluded by !v2/types/**
• v2/types/factories/ZetaConnectorNative__factory.ts is excluded by !v2/types/**
• v2/types/factories/ZetaConnectorNonNativeUpgradeTest__factory.ts is excluded by !v2/types/**
• v2/types/factories/ZetaConnectorNonNative__factory.ts is excluded by !v2/types/**

📒 Files selected for processing (2)

• v2/contracts/Revert.sol (1 hunks)
• v2/lib/types.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• v2/lib/types.ts

🚧 Files skipped from review as they are similar to previous changes (1)

• v2/contracts/Revert.sol

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: generate
• GitHub Check: test
• GitHub Check: slither
• GitHub Check: Analyze (javascript)

Finishing Touches

• 📝 Generate Docstrings

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @coderabbitai modularize this function.
• 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 generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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. (Beta)
• @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.

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: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4cde560 and 5202760.

📒 Files selected for processing (1)

• v2/contracts/Revert.sol (1 hunks)

🧰 Additional context used

🪛 GitHub Actions: Lint TS/JS/Sol (V2)

v2/contracts/Revert.sol

[error] 20-21: Code formatting issue detected. Line breaks in comments do not match the expected format.

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: generate
• GitHub Check: test
• GitHub Check: slither
• GitHub Check: Analyze (javascript)

🔇 Additional comments (1)

v2/contracts/Revert.sol (1)

20-22: Documentation enhancement looks good!

The updated comment provides clear and accurate information about the asset parameter's behavior in both connected chain and ZetaChain contexts. This improvement helps developers better understand the dual nature of the address field.

🧰 Tools

🪛 GitHub Actions: Lint TS/JS/Sol (V2)

[error] 20-21: Code formatting issue detected. Line breaks in comments do not match the expected format.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.37%. Comparing base (4cde560) to head (6e43239).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #445   +/-   ##
=======================================
  Coverage   86.37%   86.37%           
=======================================
  Files           8        8           
  Lines         499      499           
  Branches      124      124           
=======================================
  Hits          431      431           
  Misses         68       68           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.