doc: comment to notice compatible LST token type

[adu-web3]

Description

closes: #1

we should notice the contract caller the compatible types of LST tokens and escape incompatible LST tokens, but also notice caller to add virtual token address to activate native restaking

Summary by CodeRabbit

• Documentation
  • Enhanced documentation for the token whitelist function, clarifying acceptable token types and restrictions.
  • Added comments in the Vault to specify that it exclusively supports standard ERC20 reward-bearing tokens and outlines limitations regarding rebasing and fee-on-transfer tokens.

[coderabbitai]

Walkthrough

The recent updates to the ExocoreGateway and Vault contracts enhance documentation to clarify the types of tokens eligible for whitelisting. The changes specify that only standard, reward-bearing ERC20 tokens are acceptable, explicitly excluding fee-on-transfer and rebasing tokens. This aims to prevent confusion among developers and users, thus improving the usability and security of the contracts without altering their core functionalities.

Changes

File	Change Summary
src/core/ExocoreGateway.sol src/core/Vault.sol	Added documentation comments clarifying that only reward-bearing ERC20 tokens are supported, while explicitly excluding fee-on-transfer and rebasing tokens.

Assessment against linked issues

Objective	Addressed	Explanation
Specify that whitelisted tokens should not be fee-on-transfer tokens (#[1])	✅

🐇 In the code where tokens play,
Clarity shines, guiding the way.
Whitelist rules now clear and bright,
No fees to burn, all feels just right.
A safe domain for tokens to grow,
With every change, our trust will flow.
✨

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 654c9e9 and f62434f.

Files selected for processing (2)

• src/core/ExocoreGateway.sol (1 hunks)
• src/core/Vault.sol (1 hunks)

Files skipped from review due to trivial changes (1)

• src/core/Vault.sol

Additional context used

Learnings (2)

Common learnings

Learnt from: adu-web3
PR: ExocoreNetwork/exocore-contracts#39
File: test/foundry/unit/ExocoreGateway.t.sol:360-366
Timestamp: 2024-07-02T01:45:58.683Z
Learning: The `updateWhitelistedTokens` function in `ExocoreGateway` interacts solely with the trusted `ASSET_CONTRACT` precompile, mitigating the need for a reentrancy guard.

src/core/ExocoreGateway.sol (1)

Learnt from: adu-web3
PR: ExocoreNetwork/exocore-contracts#39
File: test/foundry/unit/ExocoreGateway.t.sol:360-366
Timestamp: 2024-07-02T01:45:58.683Z
Learning: The `updateWhitelistedTokens` function in `ExocoreGateway` interacts solely with the trusted `ASSET_CONTRACT` precompile, mitigating the need for a reentrancy guard.

Additional comments not posted (1)

src/core/ExocoreGateway.sol (1)

173-179: LGTM! Documentation enhances clarity.

The added documentation provides clear guidelines on the acceptable types of tokens and those that should be excluded. This aligns with the PR objectives and the linked issue to prevent the inclusion of fee-on-transfer tokens.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f62434f and 5c00ab0.

Files selected for processing (2)

• src/core/ExocoreGateway.sol (1 hunks)
• src/core/Vault.sol (1 hunks)

Files skipped from review due to trivial changes (2)

• src/core/ExocoreGateway.sol
• src/core/Vault.sol

Additional context used

Learnings (1)

Common learnings

Learnt from: adu-web3
PR: ExocoreNetwork/exocore-contracts#39
File: test/foundry/unit/ExocoreGateway.t.sol:360-366
Timestamp: 2024-07-02T01:45:58.683Z
Learning: The `updateWhitelistedTokens` function in `ExocoreGateway` interacts solely with the trusted `ASSET_CONTRACT` precompile, mitigating the need for a reentrancy guard.